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 "InsetList.h"
29 #include "LaTeXFeatures.h"
31 #include "OutputParams.h"
32 #include "ParIterator.h"
33 #include "TextClass.h"
35 #include "support/convert.h"
36 #include "support/debug.h"
37 #include "support/gettext.h"
38 #include "support/lstrings.h"
39 #include "support/docstream.h"
41 #include "frontends/Application.h"
48 // With this inset it will be possible to support the latex package
49 // float.sty, and I am sure that with this and some additional support
50 // classes we can support similar functionality in other formats
52 // By using float.sty we will have the same handling for all floats, both
53 // for those already in existance (table and figure) and all user created
54 // ones¹. So suddenly we give the users the possibility of creating new
55 // kinds of floats on the fly. (and with a uniform look)
58 // \newfloat{type}{placement}{ext}[within]
59 // type - The "type" of the new class of floats, like program or
60 // algorithm. After the appropriate \newfloat, commands
61 // such as \begin{program} or \end{algorithm*} will be
63 // placement - The default placement for the given class of floats.
64 // They are like in standard LaTeX: t, b, p and h for top,
65 // bottom, page, and here, respectively. On top of that
66 // there is a new type, H, which does not really correspond
67 // to a float, since it means: put it "here" and nowhere else.
68 // Note, however that the H specifier is special and, because
69 // of implementation details cannot be used in the second
70 // argument of \newfloat.
71 // ext - The file name extension of an auxiliary file for the list
72 // of figures (or whatever). LaTeX writes the captions to
74 // within - This (optional) argument determines whether floats of this
75 // class will be numbered within some sectional unit of the
76 // document. For example, if within is equal to chapter, the
77 // floats will be numbered within chapters.
79 // style - plain, boxed, ruled
80 // \floatname{float}{floatname}
83 // \floatplacement{float}{placement}
86 // \restylefloat{float}
88 // \listof{type}{title}
91 // ¹ the algorithm float is defined using the float.sty package. Like this
93 // \newfloat{algorithm}{htbp}{loa}[<sect>]
94 // \floatname{algorithm}{Algorithm}
96 // The intention is that floats should be definable from two places:
98 // - the "gui" (i.e. by the user)
100 // From layout files.
101 // This should only be done for floats defined in a documentclass and that
102 // does not need any additional packages. The two most known floats in this
103 // category is "table" and "figure". Floats defined in layout files are only
104 // stored in lyx files if the user modifies them.
107 // There should be a gui dialog (and also a collection of lyxfuncs) where
108 // the user can modify existing floats and/or create new ones.
110 // The individual floats will also have some settable
111 // variables: wide and placement.
116 InsetFloat::InsetFloat(Buffer const & buf, string const & type)
117 : InsetCollapsable(buf), name_(from_utf8(type))
119 setLabel(_("float: ") + floatName(type, buf.params()));
124 InsetFloat::~InsetFloat()
126 hideDialogs("float", this);
130 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
132 if (InsetCollapsable::toolTip(bv, x, y).empty())
135 docstring default_tip;
137 default_tip = _("Left-click to collapse the inset");
139 default_tip = _("Left-click to open the inset");
140 OutputParams rp(&buffer().params().encoding());
141 docstring caption_tip = getCaptionText(rp);
142 if (!isOpen() && !caption_tip.empty())
143 return caption_tip + '\n' + default_tip;
148 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
150 switch (cmd.action) {
152 case LFUN_INSET_MODIFY: {
153 InsetFloatParams params;
154 string2params(to_utf8(cmd.argument()), params);
155 params_.placement = params.placement;
156 params_.wide = params.wide;
157 params_.sideways = params.sideways;
158 params_.subfloat = params.subfloat;
159 setWide(params_.wide, cur.buffer().params());
160 setSideways(params_.sideways, cur.buffer().params());
164 case LFUN_INSET_DIALOG_UPDATE: {
165 cur.bv().updateDialog("float", params2string(params()));
170 InsetCollapsable::doDispatch(cur, cmd);
176 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
177 FuncStatus & flag) const
179 switch (cmd.action) {
181 case LFUN_INSET_MODIFY:
182 case LFUN_INSET_DIALOG_UPDATE:
187 return InsetCollapsable::getStatus(cur, cmd, flag);
192 void InsetFloat::updateLabels(ParIterator const & it)
194 Counters & cnts = buffer().params().documentClass().counters();
195 string const saveflt = cnts.current_float();
196 bool const savesubflt = cnts.isSubfloat();
198 bool const subflt = it.innerInsetOfType(FLOAT_CODE);
199 // floats can only embed subfloats of their own kind
201 params_.type = saveflt;
202 setSubfloat(subflt, buffer().params());
204 // Tell to captions what the current float is
205 cnts.current_float(params().type);
206 cnts.isSubfloat(subflt);
208 InsetCollapsable::updateLabels(it);
211 cnts.current_float(saveflt);
212 cnts.isSubfloat(savesubflt);
216 void InsetFloatParams::write(ostream & os) const
218 os << "Float " << type << '\n';
220 if (!placement.empty())
221 os << "placement " << placement << "\n";
226 os << "wide false\n";
229 os << "sideways true\n";
231 os << "sideways false\n";
235 void InsetFloatParams::read(Lexer & lex)
237 lex.setContext("InsetFloatParams::read");
238 if (lex.checkFor("placement"))
240 lex >> "wide" >> wide;
241 lex >> "sideways" >> sideways;
245 void InsetFloat::write(ostream & os) const
248 InsetCollapsable::write(os);
252 void InsetFloat::read(Lexer & lex)
255 setWide(params_.wide, buffer().params());
256 setSideways(params_.sideways, buffer().params());
257 setSubfloat(params_.subfloat, buffer().params());
258 InsetCollapsable::read(lex);
262 void InsetFloat::validate(LaTeXFeatures & features) const
264 if (support::contains(params_.placement, 'H'))
265 features.require("float");
267 if (params_.sideways)
268 features.require("rotfloat");
270 if (params_.subfloat)
271 features.require("subfig");
273 features.useFloat(params_.type, params_.subfloat);
274 InsetCollapsable::validate(features);
278 docstring InsetFloat::editMessage() const
280 return _("Opened Float Inset");
284 int InsetFloat::latex(odocstream & os, OutputParams const & runparams) const
286 if (params_.subfloat) {
287 if (runparams.moving_arg)
291 OutputParams rp = runparams;
292 docstring const caption = getCaption(rp);
293 if (!caption.empty()) {
297 int const i = InsetText::latex(os, runparams);
303 FloatList const & floats = buffer().params().documentClass().floats();
304 string tmptype = params_.type;
305 if (params_.sideways)
306 tmptype = "sideways" + params_.type;
307 if (params_.wide && (!params_.sideways ||
308 params_.type == "figure" ||
309 params_.type == "table"))
311 // Figure out the float placement to use.
312 // From lowest to highest:
313 // - float default placement
314 // - document wide default placement
315 // - specific float placement
317 string const buf_placement = buffer().params().float_placement;
318 string const def_placement = floats.defaultPlacement(params_.type);
319 if (!params_.placement.empty()
320 && params_.placement != def_placement) {
321 placement = params_.placement;
322 } else if (params_.placement.empty()
323 && !buf_placement.empty()
324 && buf_placement != def_placement) {
325 placement = buf_placement;
328 // The \n is used to force \begin{<floatname>} to appear in a new line.
329 // The % is needed to prevent two consecutive \n chars in the case
330 // when the current output line is empty.
331 os << "%\n\\begin{" << from_ascii(tmptype) << '}';
332 // We only output placement if different from the def_placement.
333 // sidewaysfloats always use their own page
334 if (!placement.empty() && !params_.sideways) {
335 os << '[' << from_ascii(placement) << ']';
339 int const i = InsetText::latex(os, runparams);
341 // The \n is used to force \end{<floatname>} to appear in a new line.
342 // In this case, we do not case if the current output line is empty.
343 os << "\n\\end{" << from_ascii(tmptype) << "}\n";
349 int InsetFloat::plaintext(odocstream & os, OutputParams const & runparams) const
351 os << '[' << buffer().B_("float") << ' '
352 << floatName(params_.type, buffer().params()) << ":\n";
353 InsetText::plaintext(os, runparams);
356 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
360 int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
362 // FIXME Implement subfloat!
364 os << '<' << from_ascii(params_.type) << '>';
365 int const i = InsetText::docbook(os, runparams);
366 os << "</" << from_ascii(params_.type) << '>';
372 bool InsetFloat::insetAllowed(InsetCode code) const
374 return code != FOOT_CODE
375 && code != MARGIN_CODE
376 && (code != FLOAT_CODE || !params_.subfloat);
380 bool InsetFloat::showInsetDialog(BufferView * bv) const
382 if (!InsetText::showInsetDialog(bv))
383 bv->showDialog("float", params2string(params()),
384 const_cast<InsetFloat *>(this));
389 void InsetFloat::setWide(bool w, BufferParams const & bp)
392 docstring lab = _("float: ") + floatName(params_.type, bp);
399 void InsetFloat::setSideways(bool s, BufferParams const & bp)
401 params_.sideways = s;
402 docstring lab = _("float: ") + floatName(params_.type, bp);
403 if (params_.sideways)
404 lab += _(" (sideways)");
409 void InsetFloat::setSubfloat(bool s, BufferParams const & bp)
411 params_.subfloat = s;
412 docstring lab = _("float: ") + floatName(params_.type, bp);
414 lab = _("subfloat: ") + floatName(params_.type, bp);
419 docstring InsetFloat::getCaption(OutputParams const & runparams) const
421 if (paragraphs().empty())
424 ParagraphList::const_iterator pit = paragraphs().begin();
425 for (; pit != paragraphs().end(); ++pit) {
426 InsetList::const_iterator it = pit->insetList().begin();
427 for (; it != pit->insetList().end(); ++it) {
428 Inset & inset = *it->inset;
429 if (inset.lyxCode() == CAPTION_CODE) {
430 odocstringstream ods;
432 static_cast<InsetCaption *>(it->inset);
433 ins->getOptArg(ods, runparams);
435 ins->getArgument(ods, runparams);
445 docstring InsetFloat::getCaptionText(OutputParams const & runparams) const
447 if (paragraphs().empty())
450 ParagraphList::const_iterator pit = paragraphs().begin();
451 for (; pit != paragraphs().end(); ++pit) {
452 InsetList::const_iterator it = pit->insetList().begin();
453 for (; it != pit->insetList().end(); ++it) {
454 Inset & inset = *it->inset;
455 if (inset.lyxCode() == CAPTION_CODE) {
456 odocstringstream ods;
458 static_cast<InsetCaption *>(it->inset);
459 ins->getCaptionText(ods, runparams);
468 void InsetFloat::string2params(string const & in, InsetFloatParams & params)
470 params = InsetFloatParams();
474 istringstream data(in);
477 lex.setContext("InsetFloat::string2params");
478 lex >> "float" >> "Float";
479 lex >> params.type; // We have to read the type here!
484 string InsetFloat::params2string(InsetFloatParams const & params)
487 data << "float" << ' ';