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 "outputparams.h"
30 #include "paragraph.h"
32 #include "support/lstrings.h"
33 #include "support/tostr.h"
35 #include "support/std_sstream.h"
37 using lyx::support::contains;
42 using std::istringstream;
44 using std::ostringstream;
47 // With this inset it will be possible to support the latex package
48 // float.sty, and I am sure that with this and some additional support
49 // classes we can support similar functionality in other formats
51 // By using float.sty we will have the same handling for all floats, both
52 // for those already in existance (table and figure) and all user created
53 // ones¹. So suddenly we give the users the possibility of creating new
54 // kinds of floats on the fly. (and with a uniform look)
57 // \newfloat{type}{placement}{ext}[within]
58 // type - The "type" of the new class of floats, like program or
59 // algorithm. After the appropriate \newfloat, commands
60 // such as \begin{program} or \end{algorithm*} will be
62 // placement - The default placement for the given class of floats.
63 // They are like in standard LaTeX: t, b, p and h for top,
64 // bottom, page, and here, respectively. On top of that
65 // there is a new type, H, which does not really correspond
66 // to a float, since it means: put it "here" and nowhere else.
67 // Note, however that the H specifier is special and, because
68 // of implementation details cannot be used in the second
69 // argument of \newfloat.
70 // ext - The file name extension of an auxiliary file for the list
71 // of figures (or whatever). LaTeX writes the captions to
73 // within - This (optional) argument determines whether floats of this
74 // class will be numbered within some sectional unit of the
75 // document. For example, if within is equal to chapter, the
76 // floats will be numbered within chapters.
78 // style - plain, boxed, ruled
79 // \floatname{float}{floatname}
82 // \floatplacement{float}{placement}
85 // \restylefloat{float}
87 // \listof{type}{title}
90 // ¹ the algorithm float is defined using the float.sty package. Like this
92 // \newfloat{algorithm}{htbp}{loa}[<sect>]
93 // \floatname{algorithm}{Algorithm}
95 // The intention is that floats should be definable from two places:
97 // - the "gui" (i.e. by the user)
100 // This should only be done for floats defined in a documentclass and that
101 // does not need any additional packages. The two most known floats in this
102 // category is "table" and "figure". Floats defined in layout files are only
103 // stored in lyx files if the user modifies them.
106 // There should be a gui dialog (and also a collection of lyxfuncs) where
107 // the user can modify existing floats and/or create new ones.
109 // The individual floats will also have some settable
110 // variables: wide and placement.
116 // this should not be hardcoded, but be part of the definition
117 // of the float (JMarc)
118 string const caplayout("Caption");
120 string floatname(string const & type, BufferParams const & bp)
122 FloatList const & floats = bp.getLyXTextClass().floats();
123 FloatList::const_iterator it = floats[type];
124 if (it == floats.end())
127 return _(it->second.name());
133 InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
134 : InsetCollapsable(bp)
136 string lab(_("float: "));
137 lab += floatname(type, bp);
139 LyXFont font(LyXFont::ALL_SANE);
142 font.setColor(LColor::collapsable);
146 LyXTextClass const & tclass = bp.getLyXTextClass();
147 if (tclass.hasLayout(caplayout))
148 inset.paragraphs.begin()->layout(tclass[caplayout]);
152 InsetFloat::InsetFloat(InsetFloat const & in)
153 : InsetCollapsable(in), params_(in.params_)
157 InsetFloat::~InsetFloat()
159 InsetFloatMailer mailer(*this);
165 InsetFloat::priv_dispatch(FuncRequest const & cmd,
166 idx_type & idx, pos_type & pos)
168 switch (cmd.action) {
170 case LFUN_INSET_MODIFY: {
171 InsetFloatParams params;
172 InsetFloatMailer::string2params(cmd.argument, params);
174 params_.placement = params.placement;
175 params_.wide = params.wide;
177 wide(params_.wide, cmd.view()->buffer()->params());
178 cmd.view()->updateInset(this);
179 return DispatchResult(true, true);
182 case LFUN_INSET_DIALOG_UPDATE: {
183 InsetFloatMailer(*this).updateDialog(cmd.view());
184 return DispatchResult(true, true);
188 return InsetCollapsable::priv_dispatch(cmd, idx, pos);
193 void InsetFloatParams::write(ostream & os) const
195 os << "Float " // getInsetName()
198 if (!placement.empty())
199 os << "placement " << placement << "\n";
204 os << "wide false\n";
208 void InsetFloatParams::read(LyXLex & lex)
212 string token = lex.getString();
213 if (token == "placement") {
215 placement = lex.getString();
217 // take countermeasures
218 lex.pushToken(token);
221 token = lex.getString();
222 if (token == "wide") {
224 string const tmptoken = lex.getString();
225 wide = (tmptoken == "true");
227 lyxerr << "InsetFloat::Read:: Missing wide!"
229 // take countermeasures
230 lex.pushToken(token);
236 void InsetFloat::write(Buffer const & buf, ostream & os) const
239 InsetCollapsable::write(buf, os);
243 void InsetFloat::read(Buffer const & buf, LyXLex & lex)
246 wide(params_.wide, buf.params());
247 InsetCollapsable::read(buf, lex);
251 void InsetFloat::validate(LaTeXFeatures & features) const
253 if (contains(params_.placement, "H")) {
254 features.require("float");
257 features.useFloat(params_.type);
258 InsetCollapsable::validate(features);
262 auto_ptr<InsetBase> InsetFloat::clone() const
264 return auto_ptr<InsetBase>(new InsetFloat(*this));
268 string const InsetFloat::editMessage() const
270 return _("Opened Float Inset");
274 int InsetFloat::latex(Buffer const & buf, ostream & os,
275 OutputParams const & runparams) const
277 FloatList const & floats = buf.params().getLyXTextClass().floats();
278 string const tmptype = (params_.wide ? params_.type + "*" : params_.type);
279 // Figure out the float placement to use.
280 // From lowest to highest:
281 // - float default placement
282 // - document wide default placement
283 // - specific float placement
285 string const buf_placement = buf.params().float_placement;
286 string const def_placement = floats.defaultPlacement(params_.type);
287 if (!params_.placement.empty()
288 && params_.placement != def_placement) {
289 placement = params_.placement;
290 } else if (params_.placement.empty()
291 && !buf_placement.empty()
292 && buf_placement != def_placement) {
293 placement = buf_placement;
296 // The \n is used to force \begin{<floatname>} to appear in a new line.
297 // The % is needed to prevent two consecutive \n chars in the case
298 // when the current output line is empty.
299 os << "%\n\\begin{" << tmptype << '}';
300 // We only output placement if different from the def_placement.
301 if (!placement.empty()) {
302 os << '[' << placement << ']';
306 int const i = inset.latex(buf, os, runparams);
308 // The \n is used to force \end{<floatname>} to appear in a new line.
309 // In this case, we do not case if the current output line is empty.
310 os << "\n\\end{" << tmptype << "}\n";
316 int InsetFloat::linuxdoc(Buffer const & buf, ostream & os,
317 OutputParams const & runparams) const
319 FloatList const & floats = buf.params().getLyXTextClass().floats();
320 string const tmptype = params_.type;
321 // Figure out the float placement to use.
322 // From lowest to highest:
323 // - float default placement
324 // - document wide default placement
325 // - specific float placement
326 // This is the same as latex, as linuxdoc is modeled after latex.
329 string const buf_placement = buf.params().float_placement;
330 string const def_placement = floats.defaultPlacement(params_.type);
331 if (!params_.placement.empty()
332 && params_.placement != def_placement) {
333 placement = params_.placement;
334 } else if (params_.placement.empty()
335 && !buf_placement.empty()
336 && buf_placement != def_placement) {
337 placement = buf_placement;
340 os << "\n<" << tmptype ;
341 // We only output placement if different from the def_placement.
342 if (!placement.empty()) {
343 os << " loc=\"" << placement << '"';
347 int const i = inset.linuxdoc(buf, os, runparams);
348 os << "</" << tmptype << ">\n";
354 int InsetFloat::docbook(Buffer const & buf, ostream & os,
355 OutputParams const & runparams) const
357 os << '<' << params_.type << '>';
358 int const i = inset.docbook(buf, os, runparams);
359 os << "</" << params_.type << '>';
365 bool InsetFloat::insetAllowed(InsetOld::Code code) const
367 if (code == InsetOld::FLOAT_CODE)
369 if (code == InsetOld::FOOT_CODE || code == InsetOld::MARGIN_CODE)
375 bool InsetFloat::showInsetDialog(BufferView * bv) const
377 if (!inset.showInsetDialog(bv))
378 InsetFloatMailer(const_cast<InsetFloat &>(*this)).showDialog(bv);
383 void InsetFloat::wide(bool w, BufferParams const & bp)
386 string lab = _("float: ") + floatname(params_.type, bp);
393 void InsetFloat::addToToc(lyx::toc::TocList & toclist, Buffer const & buf) const
395 ParIterator pit(inset.paragraphs.begin(), inset.paragraphs);
396 ParIterator end(inset.paragraphs.end(), inset.paragraphs);
398 // Find a caption layout in one of the (child inset's) pars
399 for (; pit != end; ++pit) {
400 if (pit->layout()->name() == caplayout) {
401 string const name = floatname(params_.type, buf.params());
403 tostr(toclist[name].size() + 1)
404 + ". " + pit->asString(buf, false);
405 lyx::toc::TocItem const item(pit->id(), 0 , str);
406 toclist[name].push_back(item);
412 string const InsetFloatMailer::name_("float");
414 InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
419 string const InsetFloatMailer::inset2string(Buffer const &) const
421 return params2string(inset_.params());
425 void InsetFloatMailer::string2params(string const & in,
426 InsetFloatParams & params)
428 params = InsetFloatParams();
433 istringstream data(in);
439 string const token = lex.getString();
444 // This is part of the inset proper that is usually swallowed
445 // by Buffer::readInset
448 string const token = lex.getString();
449 if (token != "Float" || !lex.eatLine())
459 string const InsetFloatMailer::params2string(InsetFloatParams const & params)
462 data << name_ << ' ';