src/insets/insetwrap.C

   1 /**
   2  * \file insetwrap.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Dekel Tsur
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "insetwrap.h"
  14
  15 #include "buffer.h"
  16 #include "bufferparams.h"
  17 #include "BufferView.h"
  18 #include "cursor.h"
  19 #include "debug.h"
  20 #include "dispatchresult.h"
  21 #include "Floating.h"
  22 #include "FloatList.h"
  23 #include "funcrequest.h"
  24 #include "gettext.h"
  25 #include "LaTeXFeatures.h"
  26 #include "LColor.h"
  27 #include "lyxlex.h"
  28 #include "outputparams.h"
  29 #include "paragraph.h"
  30
  31 #include "support/convert.h"
  32
  33 #include <sstream>
  34
  35 using std::string;
  36 using std::endl;
  37 using std::auto_ptr;
  38 using std::istringstream;
  39 using std::ostream;
  40 using std::ostringstream;
  41
  42
  43 namespace {
  44
  45 // this should not be hardcoded, but be part of the definition
  46 // of the float (JMarc)
  47 string const caplayout("Caption");
  48
  49 string floatname(string const & type, BufferParams const & bp)
  50 {
  51         FloatList const & floats = bp.getLyXTextClass().floats();
  52         FloatList::const_iterator it = floats[type];
  53         return (it == floats.end()) ? type : _(it->second.name());
  54 }
  55
  56 } // namespace anon
  57
  58
  59 InsetWrap::InsetWrap(BufferParams const & bp, string const & type)
  60         : InsetCollapsable(bp)
  61 {
  62         setLabel(_("wrap: ") + floatname(type, bp));
  63         LyXFont font(LyXFont::ALL_SANE);
  64         font.decSize();
  65         font.decSize();
  66         font.setColor(LColor::collapsable);
  67         setLabelFont(font);
  68         params_.type = type;
  69         params_.width = LyXLength(50, LyXLength::PCW);
  70         setInsetName(type);
  71         LyXTextClass const & tclass = bp.getLyXTextClass();
  72         if (tclass.hasLayout(caplayout))
  73                 paragraphs().begin()->layout(tclass[caplayout]);
  74 }
  75
  76
  77 InsetWrap::~InsetWrap()
  78 {
  79         InsetWrapMailer(*this).hideDialog();
  80 }
  81
  82
  83 void InsetWrap::doDispatch(LCursor & cur, FuncRequest & cmd)
  84 {
  85         switch (cmd.action) {
  86         case LFUN_INSET_MODIFY: {
  87                 InsetWrapParams params;
  88                 InsetWrapMailer::string2params(cmd.argument, params);
  89                 params_.placement = params.placement;
  90                 params_.width     = params.width;
  91                 cur.bv().update();
  92                 break;
  93         }
  94
  95         case LFUN_INSET_DIALOG_UPDATE:
  96                 InsetWrapMailer(*this).updateDialog(&cur.bv());
  97                 break;
  98
  99         case LFUN_MOUSE_RELEASE: {
 100                 if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
 101                         InsetWrapMailer(*this).showDialog(&cur.bv());
 102                         break;
 103                 }
 104                 InsetCollapsable::doDispatch(cur, cmd);
 105                 break;
 106         }
 107
 108         default:
 109                 InsetCollapsable::doDispatch(cur, cmd);
 110                 break;
 111         }
 112 }
 113
 114
 115 void InsetWrapParams::write(ostream & os) const
 116 {
 117         os << "Wrap " << type << '\n';
 118
 119         if (!placement.empty())
 120                 os << "placement " << placement << "\n";
 121
 122         os << "width \"" << width.asString() << "\"\n";
 123 }
 124
 125
 126 void InsetWrapParams::read(LyXLex & lex)
 127 {
 128         string token;
 129         lex >> token;
 130         if (token == "placement")
 131                 lex >> placement;
 132         else {
 133                 // take countermeasures
 134                 lex.pushToken(token);
 135         }
 136         if (!lex)
 137                 return;
 138         lex >> token;
 139         if (token == "width") {
 140                 lex.next();
 141                 width = LyXLength(lex.getString());
 142         } else {
 143                 lyxerr << "InsetWrap::Read:: Missing 'width'-tag!"
 144                         << endl;
 145                 // take countermeasures
 146                 lex.pushToken(token);
 147         }
 148 }
 149
 150
 151 void InsetWrap::write(Buffer const & buf, ostream & os) const
 152 {
 153         params_.write(os);
 154         InsetCollapsable::write(buf, os);
 155 }
 156
 157
 158 void InsetWrap::read(Buffer const & buf, LyXLex & lex)
 159 {
 160         params_.read(lex);
 161         InsetCollapsable::read(buf, lex);
 162 }
 163
 164
 165 void InsetWrap::validate(LaTeXFeatures & features) const
 166 {
 167         features.require("floatflt");
 168         InsetCollapsable::validate(features);
 169 }
 170
 171
 172 auto_ptr<InsetBase> InsetWrap::doClone() const
 173 {
 174         return auto_ptr<InsetBase>(new InsetWrap(*this));
 175 }
 176
 177
 178 string const InsetWrap::editMessage() const
 179 {
 180         return _("Opened Wrap Inset");
 181 }
 182
 183
 184 int InsetWrap::latex(Buffer const & buf, ostream & os,
 185                      OutputParams const & runparams) const
 186 {
 187         os << "\\begin{floating" << params_.type << '}';
 188         if (!params_.placement.empty())
 189                 os << '[' << params_.placement << ']';
 190         os << '{' << params_.width.asLatexString() << "}%\n";
 191         int const i = InsetText::latex(buf, os, runparams);
 192         os << "\\end{floating" << params_.type << "}%\n";
 193         return i + 2;
 194 }
 195
 196
 197 int InsetWrap::docbook(Buffer const & buf, ostream & os,
 198                        OutputParams const & runparams) const
 199 {
 200         os << '<' << params_.type << '>';
 201         int const i = InsetText::docbook(buf, os, runparams);
 202         os << "</" << params_.type << '>';
 203         return i;
 204 }
 205
 206
 207 bool InsetWrap::insetAllowed(InsetBase::Code code) const
 208 {
 209         switch(code) {
 210         case FLOAT_CODE:
 211         case FOOT_CODE:
 212         case MARGIN_CODE:
 213                 return false;
 214         default:
 215                 return InsetCollapsable::insetAllowed(code);
 216         }
 217 }
 218
 219
 220 bool InsetWrap::showInsetDialog(BufferView * bv) const
 221 {
 222         if (!InsetText::showInsetDialog(bv))
 223                 InsetWrapMailer(const_cast<InsetWrap &>(*this)).showDialog(bv);
 224         return true;
 225 }
 226
 227
 228 void InsetWrap::addToToc(lyx::toc::TocList & toclist, Buffer const & buf) const
 229 {
 230         // Now find the caption in the float...
 231         ParagraphList::const_iterator tmp = paragraphs().begin();
 232         ParagraphList::const_iterator end = paragraphs().end();
 233
 234         for (; tmp != end; ++tmp) {
 235                 if (tmp->layout()->name() == caplayout) {
 236                         string const name = floatname(params_.type, buf.params());
 237                         string const str =
 238                                 convert<string>(toclist[name].size() + 1)
 239                                 + ". " + tmp->asString(buf, false);
 240                         lyx::toc::TocItem const item(tmp->id(), 0 , str);
 241                         toclist[name].push_back(item);
 242                 }
 243         }
 244 }
 245
 246
 247 string const InsetWrapMailer::name_("wrap");
 248
 249 InsetWrapMailer::InsetWrapMailer(InsetWrap & inset)
 250         : inset_(inset)
 251 {}
 252
 253
 254 string const InsetWrapMailer::inset2string(Buffer const &) const
 255 {
 256         return params2string(inset_.params());
 257 }
 258
 259
 260 void InsetWrapMailer::string2params(string const & in, InsetWrapParams & params)
 261 {
 262         params = InsetWrapParams();
 263         if (in.empty())
 264                 return;
 265
 266         istringstream data(in);
 267         LyXLex lex(0,0);
 268         lex.setStream(data);
 269
 270         string name;
 271         lex >> name;
 272         if (!lex || name != name_)
 273                 return print_mailer_error("InsetWrapMailer", in, 1, name_);
 274
 275         // This is part of the inset proper that is usually swallowed
 276         // by LyXText::readInset
 277         string id;
 278         lex >> id;
 279         if (!lex || id != "Wrap")
 280                 return print_mailer_error("InsetBoxMailer", in, 2, "Wrap");
 281
 282         // We have to read the type here!
 283         lex >> params.type;
 284         params.read(lex);
 285 }
 286
 287
 288 string const InsetWrapMailer::params2string(InsetWrapParams const & params)
 289 {
 290         ostringstream data;
 291         data << name_ << ' ';
 292         params.write(data);
 293         return data.str();
 294 }