3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jürgen Spitzmüller
10 * Full author contact details are available in file CREDITS.
15 #include "InsetFloat.h"
16 #include "InsetCaption.h"
19 #include "BufferParams.h"
20 #include "BufferView.h"
23 #include "DispatchResult.h"
25 #include "FloatList.h"
26 #include "FuncRequest.h"
27 #include "FuncStatus.h"
28 #include "LaTeXFeatures.h"
30 #include "output_xhtml.h"
31 #include "ParIterator.h"
33 #include "texstream.h"
34 #include "TextClass.h"
36 #include "support/debug.h"
37 #include "support/docstream.h"
38 #include "support/gettext.h"
39 #include "support/lstrings.h"
41 #include "frontends/Application.h"
44 using namespace lyx::support;
49 // With this inset it will be possible to support the latex package
50 // float.sty, and I am sure that with this and some additional support
51 // classes we can support similar functionality in other formats
53 // By using float.sty we will have the same handling for all floats, both
54 // for those already in existance (table and figure) and all user created
55 // ones¹. So suddenly we give the users the possibility of creating new
56 // kinds of floats on the fly. (and with a uniform look)
59 // \newfloat{type}{placement}{ext}[within]
60 // type - The "type" of the new class of floats, like program or
61 // algorithm. After the appropriate \newfloat, commands
62 // such as \begin{program} or \end{algorithm*} will be
64 // placement - The default placement for the given class of floats.
65 // They are like in standard LaTeX: t, b, p and h for top,
66 // bottom, page, and here, respectively. On top of that
67 // there is a new type, H, which does not really correspond
68 // to a float, since it means: put it "here" and nowhere else.
69 // Note, however that the H specifier is special and, because
70 // of implementation details cannot be used in the second
71 // argument of \newfloat.
72 // ext - The file name extension of an auxiliary file for the list
73 // of figures (or whatever). LaTeX writes the captions to
75 // within - This (optional) argument determines whether floats of this
76 // class will be numbered within some sectional unit of the
77 // document. For example, if within is equal to chapter, the
78 // floats will be numbered within chapters.
80 // style - plain, boxed, ruled
81 // \floatname{float}{floatname}
84 // \floatplacement{float}{placement}
87 // \restylefloat{float}
89 // \listof{type}{title}
92 // ¹ the algorithm float is defined using the float.sty package. Like this
94 // \newfloat{algorithm}{htbp}{loa}[<sect>]
95 // \floatname{algorithm}{Algorithm}
97 // The intention is that floats should be definable from two places:
99 // - the "gui" (i.e. by the user)
101 // From layout files.
102 // This should only be done for floats defined in a documentclass and that
103 // does not need any additional packages. The two most known floats in this
104 // category is "table" and "figure". Floats defined in layout files are only
105 // stored in lyx files if the user modifies them.
108 // There should be a gui dialog (and also a collection of lyxfuncs) where
109 // the user can modify existing floats and/or create new ones.
111 // The individual floats will also have some settable
112 // variables: wide and placement.
116 //FIXME: why do we set in stone the type here?
117 InsetFloat::InsetFloat(Buffer * buf, string params_str)
118 : InsetCaptionable(buf)
120 string2params(params_str, params_);
121 setCaptionType(params_.type);
125 // Enforce equality of float type and caption type.
126 void InsetFloat::setCaptionType(std::string const & type)
128 InsetCaptionable::setCaptionType(type);
129 params_.type = captionType();
130 // check if the float type exists
131 if (buffer().params().documentClass().floats().typeExist(params_.type))
132 setLabel(_("float: ") + floatName(params_.type));
134 setLabel(bformat(_("ERROR: Unknown float type: %1$s"), from_utf8(params_.type)));
138 docstring InsetFloat::layoutName() const
140 return "Float:" + from_utf8(params_.type);
144 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
147 return InsetCaptionable::toolTip(bv, x, y);
149 OutputParams rp(&buffer().params().encoding());
150 return getCaptionText(rp);
154 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
156 switch (cmd.action()) {
158 case LFUN_INSET_MODIFY: {
159 InsetFloatParams params;
160 string2params(to_utf8(cmd.argument()), params);
161 cur.recordUndoInset(this);
163 // placement, wide and sideways are not used for subfloats
164 if (!params_.subfloat) {
165 params_.placement = params.placement;
166 params_.wide = params.wide;
167 params_.sideways = params.sideways;
170 if (params_.type != params.type)
171 setCaptionType(params.type);
172 // what we really want here is a TOC update, but that means
173 // a full buffer update
174 cur.forceBufferUpdate();
178 case LFUN_INSET_DIALOG_UPDATE: {
179 cur.bv().updateDialog("float", params2string(params()));
184 InsetCaptionable::doDispatch(cur, cmd);
190 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
191 FuncStatus & flag) const
193 switch (cmd.action()) {
195 case LFUN_INSET_MODIFY:
196 case LFUN_INSET_DIALOG_UPDATE:
197 flag.setEnabled(true);
200 case LFUN_INSET_SETTINGS:
201 if (InsetCaptionable::getStatus(cur, cmd, flag)) {
202 flag.setEnabled(flag.enabled() && !params_.subfloat);
207 case LFUN_NEWLINE_INSERT:
208 if (params_.subfloat) {
209 flag.setEnabled(false);
214 return InsetCaptionable::getStatus(cur, cmd, flag);
219 bool InsetFloat::hasSubCaptions(ParIterator const & it) const
221 return (it.innerInsetOfType(FLOAT_CODE) || it.innerInsetOfType(WRAP_CODE));
225 void InsetFloatParams::write(ostream & os) const
228 // Better this than creating a parse error. This in fact happens in the
229 // parameters dialog via InsetFloatParams::params2string.
230 os << "senseless" << '\n';
234 if (!placement.empty())
235 os << "placement " << placement << "\n";
240 os << "wide false\n";
243 os << "sideways true\n";
245 os << "sideways false\n";
249 void InsetFloatParams::read(Lexer & lex)
251 lex.setContext("InsetFloatParams::read");
253 if (lex.checkFor("placement"))
255 lex >> "wide" >> wide;
256 lex >> "sideways" >> sideways;
260 void InsetFloat::write(ostream & os) const
264 InsetCaptionable::write(os);
268 void InsetFloat::read(Lexer & lex)
271 InsetCaptionable::read(lex);
272 setCaptionType(params_.type);
276 void InsetFloat::validate(LaTeXFeatures & features) const
278 if (support::contains(params_.placement, 'H'))
279 features.require("float");
281 if (params_.sideways)
282 features.require("rotfloat");
284 if (features.inFloat())
285 features.require("subfig");
287 features.useFloat(params_.type, features.inFloat());
288 features.inFloat(true);
289 InsetCaptionable::validate(features);
290 features.inFloat(false);
294 docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
296 FloatList const & floats = buffer().params().documentClass().floats();
297 Floating const & ftype = floats.getType(params_.type);
298 string const & htmltype = ftype.htmlTag();
299 string const & attr = ftype.htmlAttrib();
301 odocstringstream ods;
302 XHTMLStream newxs(ods);
303 newxs << html::StartTag(htmltype, attr);
304 InsetText::XHTMLOptions const opts =
305 InsetText::WriteLabel | InsetText::WriteInnerTag;
306 docstring deferred = InsetText::insetAsXHTML(newxs, rp, opts);
307 newxs << html::EndTag(htmltype);
309 if (rp.inFloat == OutputParams::NONFLOAT)
310 // In this case, this float needs to be deferred, but we'll put it
311 // before anything the text itself deferred.
312 deferred = ods.str() + '\n' + deferred;
314 // In this case, the whole thing is already being deferred, so
315 // we can write to the stream.
316 // Note that things will already have been escaped, so we do not
317 // want to escape them again.
318 xs << XHTMLStream::ESCAPE_NONE << ods.str();
323 void InsetFloat::latex(otexstream & os, OutputParams const & runparams_in) const
325 if (runparams_in.inFloat != OutputParams::NONFLOAT) {
326 if (runparams_in.moving_arg)
330 OutputParams rp = runparams_in;
331 rp.moving_arg = true;
334 // The main argument is the contents of the float. This is not a moving argument.
335 if (!paragraphs().empty())
336 os.texrow().forceStart(paragraphs()[0].id(), 0);
337 rp.moving_arg = false;
338 rp.inFloat = OutputParams::SUBFLOAT;
339 InsetText::latex(os, rp);
344 OutputParams runparams(runparams_in);
345 runparams.inFloat = OutputParams::MAINFLOAT;
347 FloatList const & floats = buffer().params().documentClass().floats();
348 string tmptype = params_.type;
349 if (params_.sideways && floats.allowsSideways(params_.type))
350 tmptype = "sideways" + params_.type;
351 if (params_.wide && floats.allowsWide(params_.type)
352 && (!params_.sideways ||
353 params_.type == "figure" ||
354 params_.type == "table"))
356 // Figure out the float placement to use.
357 // From lowest to highest:
358 // - float default placement
359 // - document wide default placement
360 // - specific float placement
362 string const buf_placement = buffer().params().float_placement;
363 string const def_placement = floats.defaultPlacement(params_.type);
364 if (!params_.placement.empty()
365 && params_.placement != def_placement) {
366 tmpplacement = params_.placement;
367 } else if (params_.placement.empty()
368 && !buf_placement.empty()
369 && buf_placement != def_placement) {
370 tmpplacement = buf_placement;
373 // Check if placement is allowed by this float
374 string const allowed_placement =
375 floats.allowedPlacement(params_.type);
377 string::const_iterator lit = tmpplacement.begin();
378 string::const_iterator end = tmpplacement.end();
379 for (; lit != end; ++lit) {
380 if (contains(allowed_placement, *lit))
384 // Force \begin{<floatname>} to appear in a new line.
385 os << breakln << "\\begin{" << from_ascii(tmptype) << '}';
386 if (runparams.lastid != -1)
387 os.texrow().start(runparams.lastid, runparams.lastpos);
388 // We only output placement if different from the def_placement.
389 // sidewaysfloats always use their own page
390 if (!placement.empty() && !params_.sideways)
391 os << '[' << from_ascii(placement) << ']';
394 InsetText::latex(os, runparams);
396 // Force \end{<floatname>} to appear in a new line.
397 os << breakln << "\\end{" << from_ascii(tmptype) << "}\n";
401 int InsetFloat::plaintext(odocstringstream & os, OutputParams const & runparams, size_t max_length) const
403 os << '[' << buffer().B_("float") << ' '
404 << floatName(params_.type) << ":\n";
405 InsetText::plaintext(os, runparams, max_length);
408 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
412 int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
414 // FIXME Implement subfloat!
416 os << '<' << from_ascii(params_.type) << '>';
417 int const i = InsetText::docbook(os, runparams);
418 os << "</" << from_ascii(params_.type) << '>';
424 bool InsetFloat::insetAllowed(InsetCode code) const
426 // The case that code == FLOAT_CODE is handled in Text3.cpp,
427 // because we need to know what type of float is meant.
434 return InsetCaptionable::insetAllowed(code);
439 void InsetFloat::setWide(bool w, bool update_label)
441 if (!buffer().params().documentClass().floats().allowsWide(params_.type))
442 params_.wide = false;
450 void InsetFloat::setSideways(bool s, bool update_label)
452 if (!buffer().params().documentClass().floats().allowsSideways(params_.type))
453 params_.sideways = false;
455 params_.sideways = s;
461 void InsetFloat::setSubfloat(bool s, bool update_label)
463 params_.subfloat = s;
469 void InsetFloat::setNewLabel()
471 docstring lab = _("float: ");
473 if (params_.subfloat)
474 lab = _("subfloat: ");
476 lab += floatName(params_.type);
478 FloatList const & floats = buffer().params().documentClass().floats();
480 if (params_.wide && floats.allowsWide(params_.type))
483 if (params_.sideways && floats.allowsSideways(params_.type))
484 lab += _(" (sideways)");
490 bool InsetFloat::allowsCaptionVariation(std::string const & newtype) const
492 return !params_.subfloat && newtype != "Unnumbered";
496 docstring InsetFloat::getCaption(OutputParams const & runparams) const
498 odocstringstream ods;
499 otexstream os(ods, false);
500 getCaption(os, runparams);
505 void InsetFloat::getCaption(otexstream & os,
506 OutputParams const & runparams) const
508 if (paragraphs().empty())
511 InsetCaption const * ins = getCaptionInset();
515 ins->getArgs(os, runparams);
518 odocstringstream ods;
520 ins->getArgument(oss, runparams);
521 docstring arg = ods.str();
523 if (arg.find(']') != docstring::npos)
524 arg = '{' + arg + '}';
525 os.append(arg, move(oss.texrow()));
530 void InsetFloat::string2params(string const & in, InsetFloatParams & params)
532 params = InsetFloatParams();
536 istringstream data(in);
539 lex.setContext("InsetFloat::string2params");
544 string InsetFloat::params2string(InsetFloatParams const & params)