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"
32 #include "TextClass.h"
34 #include "support/debug.h"
35 #include "support/docstream.h"
36 #include "support/gettext.h"
37 #include "support/lstrings.h"
39 #include "frontends/Application.h"
46 // With this inset it will be possible to support the latex package
47 // float.sty, and I am sure that with this and some additional support
48 // classes we can support similar functionality in other formats
50 // By using float.sty we will have the same handling for all floats, both
51 // for those already in existance (table and figure) and all user created
52 // ones¹. So suddenly we give the users the possibility of creating new
53 // kinds of floats on the fly. (and with a uniform look)
56 // \newfloat{type}{placement}{ext}[within]
57 // type - The "type" of the new class of floats, like program or
58 // algorithm. After the appropriate \newfloat, commands
59 // such as \begin{program} or \end{algorithm*} will be
61 // placement - The default placement for the given class of floats.
62 // They are like in standard LaTeX: t, b, p and h for top,
63 // bottom, page, and here, respectively. On top of that
64 // there is a new type, H, which does not really correspond
65 // to a float, since it means: put it "here" and nowhere else.
66 // Note, however that the H specifier is special and, because
67 // of implementation details cannot be used in the second
68 // argument of \newfloat.
69 // ext - The file name extension of an auxiliary file for the list
70 // of figures (or whatever). LaTeX writes the captions to
72 // within - This (optional) argument determines whether floats of this
73 // class will be numbered within some sectional unit of the
74 // document. For example, if within is equal to chapter, the
75 // floats will be numbered within chapters.
77 // style - plain, boxed, ruled
78 // \floatname{float}{floatname}
81 // \floatplacement{float}{placement}
84 // \restylefloat{float}
86 // \listof{type}{title}
89 // ¹ the algorithm float is defined using the float.sty package. Like this
91 // \newfloat{algorithm}{htbp}{loa}[<sect>]
92 // \floatname{algorithm}{Algorithm}
94 // The intention is that floats should be definable from two places:
96 // - the "gui" (i.e. by the user)
99 // This should only be done for floats defined in a documentclass and that
100 // does not need any additional packages. The two most known floats in this
101 // category is "table" and "figure". Floats defined in layout files are only
102 // stored in lyx files if the user modifies them.
105 // There should be a gui dialog (and also a collection of lyxfuncs) where
106 // the user can modify existing floats and/or create new ones.
108 // The individual floats will also have some settable
109 // variables: wide and placement.
113 //FIXME: why do we set in stone the type here?
114 InsetFloat::InsetFloat(Buffer * buf, string const & type)
115 : InsetCollapsable(buf), name_(from_utf8(type))
117 setLabel(_("float: ") + floatName(type));
122 docstring InsetFloat::name() const
124 return "Float:" + name_;
128 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
130 if (InsetCollapsable::toolTip(bv, x, y).empty() || isOpen(bv))
133 OutputParams rp(&buffer().params().encoding());
134 return getCaptionText(rp);
138 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
140 switch (cmd.action) {
142 case LFUN_INSET_MODIFY: {
143 InsetFloatParams params;
144 string2params(to_utf8(cmd.argument()), params);
146 // placement, wide and sideways are not used for subfloats
147 if (!params_.subfloat) {
148 params_.placement = params.placement;
149 params_.wide = params.wide;
150 params_.sideways = params.sideways;
157 case LFUN_INSET_DIALOG_UPDATE: {
158 cur.bv().updateDialog("float", params2string(params()));
163 InsetCollapsable::doDispatch(cur, cmd);
169 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
170 FuncStatus & flag) const
172 switch (cmd.action) {
174 case LFUN_INSET_MODIFY:
175 case LFUN_INSET_DIALOG_UPDATE:
176 flag.setEnabled(true);
179 case LFUN_INSET_SETTINGS:
180 if (InsetCollapsable::getStatus(cur, cmd, flag)) {
181 flag.setEnabled(flag.enabled() && !params_.subfloat);
187 return InsetCollapsable::getStatus(cur, cmd, flag);
192 void InsetFloat::updateLabels(ParIterator const & it, UpdateType utype)
195 buffer().masterBuffer()->params().documentClass().counters();
196 if (utype == OutputUpdate) {
197 // counters are local to the float
198 cnts.saveLastCounter();
200 string const saveflt = cnts.current_float();
201 bool const savesubflt = cnts.isSubfloat();
203 bool const subflt = (it.innerInsetOfType(FLOAT_CODE)
204 || it.innerInsetOfType(WRAP_CODE));
205 // floats can only embed subfloats of their own kind
207 params_.type = saveflt;
210 // Tell to captions what the current float is
211 cnts.current_float(params().type);
212 cnts.isSubfloat(subflt);
214 InsetCollapsable::updateLabels(it, utype);
217 cnts.current_float(saveflt);
218 if (utype == OutputUpdate)
219 cnts.restoreLastCounter();
220 cnts.isSubfloat(savesubflt);
224 void InsetFloatParams::write(ostream & os) const
228 if (!placement.empty())
229 os << "placement " << placement << "\n";
234 os << "wide false\n";
237 os << "sideways true\n";
239 os << "sideways false\n";
243 void InsetFloatParams::read(Lexer & lex)
245 lex.setContext("InsetFloatParams::read");
246 if (lex.checkFor("placement"))
248 lex >> "wide" >> wide;
249 lex >> "sideways" >> sideways;
253 void InsetFloat::write(ostream & os) const
257 InsetCollapsable::write(os);
261 void InsetFloat::read(Lexer & lex)
264 InsetCollapsable::read(lex);
268 void InsetFloat::validate(LaTeXFeatures & features) const
270 if (support::contains(params_.placement, 'H'))
271 features.require("float");
273 if (params_.sideways)
274 features.require("rotfloat");
276 if (features.inFloat())
277 features.require("subfig");
279 features.useFloat(params_.type, features.inFloat());
280 features.inFloat(true);
281 InsetCollapsable::validate(features);
282 features.inFloat(false);
286 docstring InsetFloat::xhtml(XHTMLStream & xs, OutputParams const & rp) const
288 FloatList const & floats = buffer().params().documentClass().floats();
289 Floating const & ftype = floats.getType(params_.type);
290 string const & htmltype = ftype.htmlTag();
291 string const & attr = ftype.htmlAttrib();
293 odocstringstream ods;
294 XHTMLStream newxs(ods);
295 newxs << html::StartTag(htmltype, attr);
296 InsetText::XHTMLOptions const opts =
297 InsetText::WriteLabel | InsetText::WriteInnerTag;
298 docstring deferred = InsetText::insetAsXHTML(newxs, rp, opts);
299 newxs << html::EndTag(htmltype);
301 if (rp.inFloat == OutputParams::NONFLOAT)
302 // In this case, this float needs to be deferred, but we'll put it
303 // before anything the text itself deferred.
304 deferred = ods.str() + '\n' + deferred;
306 // In this case, the whole thing is already being deferred, so
307 // we can write to the stream.
308 // Note that things will already have been escaped, so we do not
309 // want to escape them again.
310 xs << XHTMLStream::NextRaw() << ods.str();
315 int InsetFloat::latex(odocstream & os, OutputParams const & runparams_in) const
317 if (runparams_in.inFloat != OutputParams::NONFLOAT) {
318 if (runparams_in.moving_arg)
322 OutputParams rp = runparams_in;
323 docstring const caption = getCaption(rp);
324 if (!caption.empty()) {
328 rp.inFloat = OutputParams::SUBFLOAT;
329 int const i = InsetText::latex(os, rp);
334 OutputParams runparams(runparams_in);
335 runparams.inFloat = OutputParams::MAINFLOAT;
337 FloatList const & floats = buffer().params().documentClass().floats();
338 string tmptype = params_.type;
339 if (params_.sideways)
340 tmptype = "sideways" + params_.type;
341 if (params_.wide && (!params_.sideways ||
342 params_.type == "figure" ||
343 params_.type == "table"))
345 // Figure out the float placement to use.
346 // From lowest to highest:
347 // - float default placement
348 // - document wide default placement
349 // - specific float placement
351 string const buf_placement = buffer().params().float_placement;
352 string const def_placement = floats.defaultPlacement(params_.type);
353 if (!params_.placement.empty()
354 && params_.placement != def_placement) {
355 placement = params_.placement;
356 } else if (params_.placement.empty()
357 && !buf_placement.empty()
358 && buf_placement != def_placement) {
359 placement = buf_placement;
362 // The \n is used to force \begin{<floatname>} to appear in a new line.
363 // The % is needed to prevent two consecutive \n chars in the case
364 // when the current output line is empty.
365 os << "%\n\\begin{" << from_ascii(tmptype) << '}';
366 // We only output placement if different from the def_placement.
367 // sidewaysfloats always use their own page
368 if (!placement.empty() && !params_.sideways) {
369 os << '[' << from_ascii(placement) << ']';
373 int const i = InsetText::latex(os, runparams);
375 // The \n is used to force \end{<floatname>} to appear in a new line.
376 // In this case, we do not case if the current output line is empty.
377 os << "\n\\end{" << from_ascii(tmptype) << "}\n";
383 int InsetFloat::plaintext(odocstream & os, OutputParams const & runparams) const
385 os << '[' << buffer().B_("float") << ' '
386 << floatName(params_.type) << ":\n";
387 InsetText::plaintext(os, runparams);
390 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
394 int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
396 // FIXME Implement subfloat!
398 os << '<' << from_ascii(params_.type) << '>';
399 int const i = InsetText::docbook(os, runparams);
400 os << "</" << from_ascii(params_.type) << '>';
406 bool InsetFloat::insetAllowed(InsetCode code) const
408 // The case that code == FLOAT_CODE is handled in Text3.cpp,
409 // because we need to know what type of float is meant.
416 return InsetCollapsable::insetAllowed(code);
421 bool InsetFloat::showInsetDialog(BufferView * bv) const
423 if (!InsetText::showInsetDialog(bv))
424 bv->showDialog("float");
429 void InsetFloat::setWide(bool w, bool update_label)
437 void InsetFloat::setSideways(bool s, bool update_label)
439 params_.sideways = s;
445 void InsetFloat::setSubfloat(bool s, bool update_label)
447 params_.subfloat = s;
453 void InsetFloat::setNewLabel()
455 docstring lab = _("float: ");
457 if (params_.subfloat)
458 lab = _("subfloat: ");
460 lab += floatName(params_.type);
465 if (params_.sideways)
466 lab += _(" (sideways)");
472 docstring InsetFloat::getCaption(OutputParams const & runparams) const
474 if (paragraphs().empty())
477 InsetCaption const * ins = getCaptionInset();
481 odocstringstream ods;
482 ins->getOptArg(ods, runparams);
484 ins->getArgument(ods, runparams);
490 void InsetFloat::string2params(string const & in, InsetFloatParams & params)
492 params = InsetFloatParams();
496 istringstream data(in);
499 lex.setContext("InsetFloat::string2params");
500 lex >> params.type; // We have to read the type here!
505 string InsetFloat::params2string(InsetFloatParams const & params)