src/insets/insetfloat.C

   1 /**
   2  * \file insetfloat.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jürgen Vigna
   7  * \author Lars Gullik Bjønnes
   8  *
   9  * Full author contact details are available in file CREDITS
  10  */
  11
  12 #include <config.h>
  13
  14 #include "insetfloat.h"
  15 #include "insettext.h"
  16
  17 #include "buffer.h"
  18 #include "BufferView.h"
  19 #include "debug.h"
  20 #include "Floating.h"
  21 #include "FloatList.h"
  22 #include "funcrequest.h"
  23 #include "gettext.h"
  24 #include "iterators.h"
  25 #include "LaTeXFeatures.h"
  26 #include "Lsstream.h"
  27 #include "lyxfont.h"
  28 #include "lyxlex.h"
  29 #include "lyxtext.h"
  30 #include "Lsstream.h"
  31
  32 #include "support/LOstream.h"
  33 #include "support/lstrings.h"
  34 #include "support/tostr.h"
  35
  36 #include "frontends/LyXView.h"
  37 #include "frontends/Dialogs.h"
  38
  39 using std::ostream;
  40 using std::endl;
  41
  42
  43 // With this inset it will be possible to support the latex package
  44 // float.sty, and I am sure that with this and some additional support
  45 // classes we can support similar functionality in other formats
  46 // (read DocBook).
  47 // By using float.sty we will have the same handling for all floats, both
  48 // for those already in existance (table and figure) and all user created
  49 // ones¹. So suddenly we give the users the possibility of creating new
  50 // kinds of floats on the fly. (and with a uniform look)
  51 //
  52 // API to float.sty:
  53 //   \newfloat{type}{placement}{ext}[within]
  54 //     type      - The "type" of the new class of floats, like program or
  55 //                 algorithm. After the appropriate \newfloat, commands
  56 //                 such as \begin{program} or \end{algorithm*} will be
  57 //                 available.
  58 //     placement - The default placement for the given class of floats.
  59 //                 They are like in standard LaTeX: t, b, p and h for top,
  60 //                 bottom, page, and here, respectively. On top of that
  61 //                 there is a new type, H, which does not really correspond
  62 //                 to a float, since it means: put it "here" and nowhere else.
  63 //                 Note, however that the H specifier is special and, because
  64 //                 of implementation details cannot be used in the second
  65 //                 argument of \newfloat.
  66 //     ext       - The file name extension of an auxiliary file for the list
  67 //                 of figures (or whatever). LaTeX writes the captions to
  68 //                 this file.
  69 //     within    - This (optional) argument determines whether floats of this
  70 //                 class will be numbered within some sectional unit of the
  71 //                 document. For example, if within is equal to chapter, the
  72 //                 floats will be numbered within chapters.
  73 //   \floatstyle{style}
  74 //     style -  plain, boxed, ruled
  75 //   \floatname{float}{floatname}
  76 //     float     -
  77 //     floatname -
  78 //   \floatplacement{float}{placement}
  79 //     float     -
  80 //     placement -
  81 //   \restylefloat{float}
  82 //     float -
  83 //   \listof{type}{title}
  84 //     title -
  85
  86 // ¹ the algorithm float is defined using the float.sty package. Like this
  87 //   \floatstyle{ruled}
  88 //   \newfloat{algorithm}{htbp}{loa}[<sect>]
  89 //   \floatname{algorithm}{Algorithm}
  90 //
  91 // The intention is that floats should be definable from two places:
  92 //          - layout files
  93 //          - the "gui" (i.e. by the user)
  94 //
  95 // From layout files.
  96 // This should only be done for floats defined in a documentclass and that
  97 // does not need any additional packages. The two most known floats in this
  98 // category is "table" and "figure". Floats defined in layout files are only
  99 // stored in lyx files if the user modifies them.
 100 //
 101 // By the user.
 102 // There should be a gui dialog (and also a collection of lyxfuncs) where
 103 // the user can modify existing floats and/or create new ones.
 104 //
 105 // The individual floats will also have some settable
 106 // variables: wide and placement.
 107 //
 108 // Lgb
 109
 110 namespace {
 111
 112 // this should not be hardcoded, but be part of the definition
 113 // of the float (JMarc)
 114 string const caplayout("Caption");
 115
 116 string floatname(string const & type, BufferParams const & bp)
 117 {
 118         FloatList const & floats = bp.getLyXTextClass().floats();
 119         FloatList::const_iterator it = floats[type];
 120         if (it == floats.end())
 121                 return type;
 122
 123         return _(it->second.name());
 124 }
 125
 126 } // namespace anon
 127
 128
 129 InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
 130         : InsetCollapsable(bp)
 131 {
 132         string lab(_("float: "));
 133         lab += floatname(type, bp);
 134         setLabel(lab);
 135         LyXFont font(LyXFont::ALL_SANE);
 136         font.decSize();
 137         font.decSize();
 138         font.setColor(LColor::collapsable);
 139         setLabelFont(font);
 140         params_.type = type;
 141         setInsetName(type);
 142         LyXTextClass const & tclass = bp.getLyXTextClass();
 143         if (tclass.hasLayout(caplayout))
 144                 inset.paragraphs.begin()->layout(tclass[caplayout]);
 145 }
 146
 147
 148 InsetFloat::InsetFloat(InsetFloat const & in)
 149         : InsetCollapsable(in), params_(in.params_)
 150 {}
 151
 152
 153 // InsetFloat::InsetFloat(InsetFloat const & in, bool same_id)
 154 //      : InsetCollapsable(in, same_id), params_(in.params_)
 155 // {}
 156
 157
 158 InsetFloat::~InsetFloat()
 159 {
 160         InsetFloatMailer mailer(*this);
 161         mailer.hideDialog();
 162 }
 163
 164
 165 dispatch_result InsetFloat::localDispatch(FuncRequest const & cmd)
 166 {
 167         Inset::RESULT result = UNDISPATCHED;
 168
 169         switch (cmd.action) {
 170         case LFUN_INSET_MODIFY: {
 171                 InsetFloatParams params;
 172                 InsetFloatMailer::string2params(cmd.argument, params);
 173
 174                 params_.placement = params.placement;
 175                 params_.wide      = params.wide;
 176
 177                 wide(params_.wide, cmd.view()->buffer()->params);
 178                 cmd.view()->updateInset(this);
 179                 result = DISPATCHED;
 180         }
 181         break;
 182
 183         case LFUN_INSET_DIALOG_UPDATE: {
 184                 InsetFloatMailer mailer(*this);
 185                 mailer.updateDialog(cmd.view());
 186         }
 187         break;
 188
 189         default:
 190                 result = InsetCollapsable::localDispatch(cmd);
 191         }
 192
 193         return result;
 194 }
 195
 196
 197 void InsetFloatParams::write(ostream & os) const
 198 {
 199         os << "Float " // getInsetName()
 200            << type << '\n';
 201
 202         if (!placement.empty()) {
 203                 os << "placement " << placement << "\n";
 204         }
 205         if (wide) {
 206                 os << "wide true\n";
 207         } else {
 208                 os << "wide false\n";
 209         }
 210 }
 211
 212
 213 void InsetFloatParams::read(LyXLex & lex)
 214 {
 215         if (lex.isOK()) {
 216                 lex.next();
 217                 string token = lex.getString();
 218                 if (token == "placement") {
 219                         lex.next();
 220                         placement = lex.getString();
 221                 } else {
 222                         // take countermeasures
 223                         lex.pushToken(token);
 224                 }
 225                 lex.next();
 226                 token = lex.getString();
 227                 if (token == "wide") {
 228                         lex.next();
 229                         string const tmptoken = lex.getString();
 230                         wide = (tmptoken == "true");
 231                 } else {
 232                         lyxerr << "InsetFloat::Read:: Missing wide!"
 233                                << endl;
 234                         // take countermeasures
 235                         lex.pushToken(token);
 236                 }
 237         }
 238 }
 239
 240
 241 void InsetFloat::write(Buffer const * buf, ostream & os) const
 242 {
 243         params_.write(os);
 244         InsetCollapsable::write(buf, os);
 245 }
 246
 247
 248 void InsetFloat::read(Buffer const * buf, LyXLex & lex)
 249 {
 250         params_.read(lex);
 251         wide(params_.wide, buf->params);
 252         InsetCollapsable::read(buf, lex);
 253 }
 254
 255
 256 void InsetFloat::validate(LaTeXFeatures & features) const
 257 {
 258         if (contains(params_.placement, "H")) {
 259                 features.require("float");
 260         }
 261
 262         features.useFloat(params_.type);
 263         InsetCollapsable::validate(features);
 264 }
 265
 266
 267 Inset * InsetFloat::clone(Buffer const &) const
 268 {
 269         return new InsetFloat(*const_cast<InsetFloat *>(this));
 270 }
 271
 272
 273 // Inset * InsetFloat::clone(Buffer const &, bool same_id) const
 274 // {
 275 //      return new InsetFloat(*const_cast<InsetFloat *>(this), same_id);
 276 // }
 277
 278
 279 string const InsetFloat::editMessage() const
 280 {
 281         return _("Opened Float Inset");
 282 }
 283
 284
 285 int InsetFloat::latex(Buffer const * buf, ostream & os,
 286                       LatexRunParams const & runparams) const
 287 {
 288         FloatList const & floats = buf->params.getLyXTextClass().floats();
 289         string const tmptype = (params_.wide ? params_.type + "*" : params_.type);
 290         // Figure out the float placement to use.
 291         // From lowest to highest:
 292         // - float default placement
 293         // - document wide default placement
 294         // - specific float placement
 295         string placement;
 296         string const buf_placement = buf->params.float_placement;
 297         string const def_placement = floats.defaultPlacement(params_.type);
 298         if (!params_.placement.empty()
 299             && params_.placement != def_placement) {
 300                 placement = params_.placement;
 301         } else if (params_.placement.empty()
 302                    && !buf_placement.empty()
 303                    && buf_placement != def_placement) {
 304                 placement = buf_placement;
 305         }
 306
 307         // The \n is used to force \begin{<floatname>} to appear in a new line.
 308         // The % is needed to prevent two consecutive \n chars in the case
 309         // when the current output line is empty.
 310         os << "%\n\\begin{" << tmptype << '}';
 311         // We only output placement if different from the def_placement.
 312         if (!placement.empty()) {
 313                 os << '[' << placement << ']';
 314         }
 315         os << '\n';
 316
 317         int const i = inset.latex(buf, os, runparams);
 318
 319         // The \n is used to force \end{<floatname>} to appear in a new line.
 320         // In this case, we do not case if the current output line is empty.
 321         os << "\n\\end{" << tmptype << "}\n";
 322
 323         return i + 4;
 324 }
 325
 326
 327 int InsetFloat::docbook(Buffer const * buf, ostream & os, bool mixcont) const
 328 {
 329         os << '<' << params_.type << '>';
 330         int const i = inset.docbook(buf, os, mixcont);
 331         os << "</" << params_.type << '>';
 332
 333         return i;
 334 }
 335
 336
 337 bool InsetFloat::insetAllowed(Inset::Code code) const
 338 {
 339         if (code == Inset::FLOAT_CODE)
 340                 return false;
 341         if (inset.getLockingInset() != const_cast<InsetFloat *>(this))
 342                 return inset.insetAllowed(code);
 343         if ((code == Inset::FOOT_CODE) || (code == Inset::MARGIN_CODE))
 344                 return false;
 345         return true;
 346 }
 347
 348
 349 bool InsetFloat::showInsetDialog(BufferView * bv) const
 350 {
 351         if (!inset.showInsetDialog(bv)) {
 352                 InsetFloat * tmp = const_cast<InsetFloat *>(this);
 353                 InsetFloatMailer mailer(*tmp);
 354                 mailer.showDialog(bv);
 355         }
 356         return true;
 357 }
 358
 359
 360 void InsetFloat::wide(bool w, BufferParams const & bp)
 361 {
 362         params_.wide = w;
 363
 364         string lab(_("float:"));
 365         lab += floatname(params_.type, bp);
 366
 367         if (params_.wide)
 368                 lab += '*';
 369
 370         setLabel(lab);
 371 }
 372
 373
 374 void InsetFloat::addToToc(toc::TocList & toclist, Buffer const * buf) const
 375 {
 376         ParIterator pit(inset.paragraphs.begin(), inset.paragraphs);
 377         ParIterator end(inset.paragraphs.end(), inset.paragraphs);
 378
 379         // Find a caption layout in one of the (child inset's) pars
 380         for (; pit != end; ++pit) {
 381                 if (pit->layout()->name() == caplayout) {
 382                         string const name = floatname(params_.type, buf->params);
 383                         string const str =
 384                                 tostr(toclist[name].size() + 1)
 385                                 + ". " + pit->asString(buf, false);
 386                         toc::TocItem const item(pit->id(), 0 , str);
 387                         toclist[name].push_back(item);
 388                 }
 389         }
 390 }
 391
 392
 393 string const InsetFloatMailer::name_("float");
 394
 395 InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
 396         : inset_(inset)
 397 {}
 398
 399
 400 string const InsetFloatMailer::inset2string() const
 401 {
 402         return params2string(inset_.params());
 403 }
 404
 405
 406 void InsetFloatMailer::string2params(string const & in,
 407                                      InsetFloatParams & params)
 408 {
 409         params = InsetFloatParams();
 410
 411         if (in.empty())
 412                 return;
 413
 414         istringstream data(STRCONV(in));
 415         LyXLex lex(0,0);
 416         lex.setStream(data);
 417
 418         if (lex.isOK()) {
 419                 lex.next();
 420                 string const token = lex.getString();
 421                 if (token != name_)
 422                         return;
 423         }
 424
 425         // This is part of the inset proper that is usually swallowed
 426         // by Buffer::readInset
 427         if (lex.isOK()) {
 428                 lex.next();
 429                 string const token = lex.getString();
 430                 if (token != "Float" || !lex.eatLine())
 431                         return;
 432         }
 433
 434         if (lex.isOK()) {
 435                 params.read(lex);
 436         }
 437 }
 438
 439
 440 string const InsetFloatMailer::params2string(InsetFloatParams const & params)
 441 {
 442         ostringstream data;
 443         data << name_ << ' ';
 444         params.write(data);
 445         return STRCONV(data.str());
 446 }