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
9 * Full author contact details are available in file CREDITS.
14 #include "insetfloat.h"
17 #include "bufferparams.h"
18 #include "BufferView.h"
20 #include "dispatchresult.h"
22 #include "FloatList.h"
23 #include "funcrequest.h"
25 #include "iterators.h"
26 #include "LaTeXFeatures.h"
29 #include "paragraph.h"
31 #include "support/lstrings.h"
32 #include "support/tostr.h"
34 #include "support/std_sstream.h"
36 using lyx::support::contains;
41 using std::istringstream;
43 using std::ostringstream;
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.
115 // this should not be hardcoded, but be part of the definition
116 // of the float (JMarc)
117 string const caplayout("Caption");
119 string floatname(string const & type, BufferParams const & bp)
121 FloatList const & floats = bp.getLyXTextClass().floats();
122 FloatList::const_iterator it = floats[type];
123 if (it == floats.end())
126 return _(it->second.name());
132 InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
133 : InsetCollapsable(bp)
135 string lab(_("float: "));
136 lab += floatname(type, bp);
138 LyXFont font(LyXFont::ALL_SANE);
141 font.setColor(LColor::collapsable);
145 LyXTextClass const & tclass = bp.getLyXTextClass();
146 if (tclass.hasLayout(caplayout))
147 inset.paragraphs.begin()->layout(tclass[caplayout]);
151 InsetFloat::InsetFloat(InsetFloat const & in)
152 : InsetCollapsable(in), params_(in.params_)
156 InsetFloat::~InsetFloat()
158 InsetFloatMailer mailer(*this);
164 InsetFloat::priv_dispatch(FuncRequest const & cmd,
165 idx_type & idx, pos_type & pos)
167 switch (cmd.action) {
169 case LFUN_INSET_MODIFY: {
170 InsetFloatParams params;
171 InsetFloatMailer::string2params(cmd.argument, params);
173 params_.placement = params.placement;
174 params_.wide = params.wide;
176 wide(params_.wide, cmd.view()->buffer()->params());
177 cmd.view()->updateInset(this);
181 case LFUN_INSET_DIALOG_UPDATE: {
182 InsetFloatMailer(*this).updateDialog(cmd.view());
187 return InsetCollapsable::priv_dispatch(cmd, idx, pos);
192 void InsetFloatParams::write(ostream & os) const
194 os << "Float " // getInsetName()
197 if (!placement.empty())
198 os << "placement " << placement << "\n";
203 os << "wide false\n";
207 void InsetFloatParams::read(LyXLex & lex)
211 string token = lex.getString();
212 if (token == "placement") {
214 placement = lex.getString();
216 // take countermeasures
217 lex.pushToken(token);
220 token = lex.getString();
221 if (token == "wide") {
223 string const tmptoken = lex.getString();
224 wide = (tmptoken == "true");
226 lyxerr << "InsetFloat::Read:: Missing wide!"
228 // take countermeasures
229 lex.pushToken(token);
235 void InsetFloat::write(Buffer const & buf, ostream & os) const
238 InsetCollapsable::write(buf, os);
242 void InsetFloat::read(Buffer const & buf, LyXLex & lex)
245 wide(params_.wide, buf.params());
246 InsetCollapsable::read(buf, lex);
250 void InsetFloat::validate(LaTeXFeatures & features) const
252 if (contains(params_.placement, "H")) {
253 features.require("float");
256 features.useFloat(params_.type);
257 InsetCollapsable::validate(features);
261 auto_ptr<InsetBase> InsetFloat::clone() const
263 return auto_ptr<InsetBase>(new InsetFloat(*this));
267 string const InsetFloat::editMessage() const
269 return _("Opened Float Inset");
273 int InsetFloat::latex(Buffer const & buf, ostream & os,
274 LatexRunParams const & runparams) const
276 FloatList const & floats = buf.params().getLyXTextClass().floats();
277 string const tmptype = (params_.wide ? params_.type + "*" : params_.type);
278 // Figure out the float placement to use.
279 // From lowest to highest:
280 // - float default placement
281 // - document wide default placement
282 // - specific float placement
284 string const buf_placement = buf.params().float_placement;
285 string const def_placement = floats.defaultPlacement(params_.type);
286 if (!params_.placement.empty()
287 && params_.placement != def_placement) {
288 placement = params_.placement;
289 } else if (params_.placement.empty()
290 && !buf_placement.empty()
291 && buf_placement != def_placement) {
292 placement = buf_placement;
295 // The \n is used to force \begin{<floatname>} to appear in a new line.
296 // The % is needed to prevent two consecutive \n chars in the case
297 // when the current output line is empty.
298 os << "%\n\\begin{" << tmptype << '}';
299 // We only output placement if different from the def_placement.
300 if (!placement.empty()) {
301 os << '[' << placement << ']';
305 int const i = inset.latex(buf, os, runparams);
307 // The \n is used to force \end{<floatname>} to appear in a new line.
308 // In this case, we do not case if the current output line is empty.
309 os << "\n\\end{" << tmptype << "}\n";
315 int InsetFloat::linuxdoc(Buffer const & buf, ostream & os) const
317 FloatList const & floats = buf.params().getLyXTextClass().floats();
318 string const tmptype = params_.type;
319 // Figure out the float placement to use.
320 // From lowest to highest:
321 // - float default placement
322 // - document wide default placement
323 // - specific float placement
324 // This is the same as latex, as linuxdoc is modeled after latex.
327 string const buf_placement = buf.params().float_placement;
328 string const def_placement = floats.defaultPlacement(params_.type);
329 if (!params_.placement.empty()
330 && params_.placement != def_placement) {
331 placement = params_.placement;
332 } else if (params_.placement.empty()
333 && !buf_placement.empty()
334 && buf_placement != def_placement) {
335 placement = buf_placement;
338 os << "\n<" << tmptype ;
339 // We only output placement if different from the def_placement.
340 if (!placement.empty()) {
341 os << " loc=\"" << placement << '"';
345 int const i = inset.linuxdoc(buf, os);
346 os << "</" << tmptype << ">\n";
352 int InsetFloat::docbook(Buffer const & buf, ostream & os, bool mixcont) const
354 os << '<' << params_.type << '>';
355 int const i = inset.docbook(buf, os, mixcont);
356 os << "</" << params_.type << '>';
362 bool InsetFloat::insetAllowed(InsetOld::Code code) const
364 if (code == InsetOld::FLOAT_CODE)
366 if (inset.getLockingInset() != const_cast<InsetFloat *>(this))
367 return inset.insetAllowed(code);
368 if ((code == InsetOld::FOOT_CODE) || (code == InsetOld::MARGIN_CODE))
374 bool InsetFloat::showInsetDialog(BufferView * bv) const
376 if (!inset.showInsetDialog(bv)) {
377 InsetFloat * tmp = const_cast<InsetFloat *>(this);
378 InsetFloatMailer mailer(*tmp);
379 mailer.showDialog(bv);
385 void InsetFloat::wide(bool w, BufferParams const & bp)
389 string lab(_("float: "));
390 lab += floatname(params_.type, bp);
399 void InsetFloat::addToToc(lyx::toc::TocList & toclist, Buffer const & buf) const
401 ParIterator pit(inset.paragraphs.begin(), inset.paragraphs);
402 ParIterator end(inset.paragraphs.end(), inset.paragraphs);
404 // Find a caption layout in one of the (child inset's) pars
405 for (; pit != end; ++pit) {
406 if (pit->layout()->name() == caplayout) {
407 string const name = floatname(params_.type, buf.params());
409 tostr(toclist[name].size() + 1)
410 + ". " + pit->asString(buf, false);
411 lyx::toc::TocItem const item(pit->id(), 0 , str);
412 toclist[name].push_back(item);
418 string const InsetFloatMailer::name_("float");
420 InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
425 string const InsetFloatMailer::inset2string(Buffer const &) const
427 return params2string(inset_.params());
431 void InsetFloatMailer::string2params(string const & in,
432 InsetFloatParams & params)
434 params = InsetFloatParams();
439 istringstream data(in);
445 string const token = lex.getString();
450 // This is part of the inset proper that is usually swallowed
451 // by Buffer::readInset
454 string const token = lex.getString();
455 if (token != "Float" || !lex.eatLine())
465 string const InsetFloatMailer::params2string(InsetFloatParams const & params)
468 data << name_ << ' ';