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"
15 #include "insettext.h"
18 #include "BufferView.h"
21 #include "FloatList.h"
22 #include "funcrequest.h"
24 #include "iterators.h"
25 #include "LaTeXFeatures.h"
32 #include "support/LOstream.h"
33 #include "support/lstrings.h"
34 #include "support/tostr.h"
36 #include "frontends/LyXView.h"
37 #include "frontends/Dialogs.h"
39 using namespace lyx::support;
45 // With this inset it will be possible to support the latex package
46 // float.sty, and I am sure that with this and some additional support
47 // classes we can support similar functionality in other formats
49 // By using float.sty we will have the same handling for all floats, both
50 // for those already in existance (table and figure) and all user created
51 // ones¹. So suddenly we give the users the possibility of creating new
52 // kinds of floats on the fly. (and with a uniform look)
55 // \newfloat{type}{placement}{ext}[within]
56 // type - The "type" of the new class of floats, like program or
57 // algorithm. After the appropriate \newfloat, commands
58 // such as \begin{program} or \end{algorithm*} will be
60 // placement - The default placement for the given class of floats.
61 // They are like in standard LaTeX: t, b, p and h for top,
62 // bottom, page, and here, respectively. On top of that
63 // there is a new type, H, which does not really correspond
64 // to a float, since it means: put it "here" and nowhere else.
65 // Note, however that the H specifier is special and, because
66 // of implementation details cannot be used in the second
67 // argument of \newfloat.
68 // ext - The file name extension of an auxiliary file for the list
69 // of figures (or whatever). LaTeX writes the captions to
71 // within - This (optional) argument determines whether floats of this
72 // class will be numbered within some sectional unit of the
73 // document. For example, if within is equal to chapter, the
74 // floats will be numbered within chapters.
76 // style - plain, boxed, ruled
77 // \floatname{float}{floatname}
80 // \floatplacement{float}{placement}
83 // \restylefloat{float}
85 // \listof{type}{title}
88 // ¹ the algorithm float is defined using the float.sty package. Like this
90 // \newfloat{algorithm}{htbp}{loa}[<sect>]
91 // \floatname{algorithm}{Algorithm}
93 // The intention is that floats should be definable from two places:
95 // - the "gui" (i.e. by the user)
98 // This should only be done for floats defined in a documentclass and that
99 // does not need any additional packages. The two most known floats in this
100 // category is "table" and "figure". Floats defined in layout files are only
101 // stored in lyx files if the user modifies them.
104 // There should be a gui dialog (and also a collection of lyxfuncs) where
105 // the user can modify existing floats and/or create new ones.
107 // The individual floats will also have some settable
108 // variables: wide and placement.
114 // this should not be hardcoded, but be part of the definition
115 // of the float (JMarc)
116 string const caplayout("Caption");
118 string floatname(string const & type, BufferParams const & bp)
120 FloatList const & floats = bp.getLyXTextClass().floats();
121 FloatList::const_iterator it = floats[type];
122 if (it == floats.end())
125 return _(it->second.name());
131 InsetFloat::InsetFloat(BufferParams const & bp, string const & type)
132 : InsetCollapsable(bp)
134 string lab(_("float: "));
135 lab += floatname(type, bp);
137 LyXFont font(LyXFont::ALL_SANE);
140 font.setColor(LColor::collapsable);
144 LyXTextClass const & tclass = bp.getLyXTextClass();
145 if (tclass.hasLayout(caplayout))
146 inset.paragraphs.begin()->layout(tclass[caplayout]);
150 InsetFloat::InsetFloat(InsetFloat const & in)
151 : InsetCollapsable(in), params_(in.params_)
155 InsetFloat::~InsetFloat()
157 InsetFloatMailer mailer(*this);
162 dispatch_result InsetFloat::localDispatch(FuncRequest const & cmd)
164 Inset::RESULT result = UNDISPATCHED;
166 switch (cmd.action) {
167 case LFUN_INSET_MODIFY: {
168 InsetFloatParams params;
169 InsetFloatMailer::string2params(cmd.argument, params);
171 params_.placement = params.placement;
172 params_.wide = params.wide;
174 wide(params_.wide, cmd.view()->buffer()->params);
175 cmd.view()->updateInset(this);
180 case LFUN_INSET_DIALOG_UPDATE: {
181 InsetFloatMailer mailer(*this);
182 mailer.updateDialog(cmd.view());
187 result = InsetCollapsable::localDispatch(cmd);
194 void InsetFloatParams::write(ostream & os) const
196 os << "Float " // getInsetName()
199 if (!placement.empty()) {
200 os << "placement " << placement << "\n";
205 os << "wide false\n";
210 void InsetFloatParams::read(LyXLex & lex)
214 string token = lex.getString();
215 if (token == "placement") {
217 placement = lex.getString();
219 // take countermeasures
220 lex.pushToken(token);
223 token = lex.getString();
224 if (token == "wide") {
226 string const tmptoken = lex.getString();
227 wide = (tmptoken == "true");
229 lyxerr << "InsetFloat::Read:: Missing wide!"
231 // take countermeasures
232 lex.pushToken(token);
238 void InsetFloat::write(Buffer const * buf, ostream & os) const
241 InsetCollapsable::write(buf, os);
245 void InsetFloat::read(Buffer const * buf, LyXLex & lex)
248 wide(params_.wide, buf->params);
249 InsetCollapsable::read(buf, lex);
253 void InsetFloat::validate(LaTeXFeatures & features) const
255 if (contains(params_.placement, "H")) {
256 features.require("float");
259 features.useFloat(params_.type);
260 InsetCollapsable::validate(features);
264 InsetBase * InsetFloat::clone() const
266 return new InsetFloat(*this);
270 string const InsetFloat::editMessage() const
272 return _("Opened Float Inset");
276 int InsetFloat::latex(Buffer const * buf, ostream & os,
277 LatexRunParams const & runparams) const
279 FloatList const & floats = buf->params.getLyXTextClass().floats();
280 string const tmptype = (params_.wide ? params_.type + "*" : params_.type);
281 // Figure out the float placement to use.
282 // From lowest to highest:
283 // - float default placement
284 // - document wide default placement
285 // - specific float placement
287 string const buf_placement = buf->params.float_placement;
288 string const def_placement = floats.defaultPlacement(params_.type);
289 if (!params_.placement.empty()
290 && params_.placement != def_placement) {
291 placement = params_.placement;
292 } else if (params_.placement.empty()
293 && !buf_placement.empty()
294 && buf_placement != def_placement) {
295 placement = buf_placement;
298 // The \n is used to force \begin{<floatname>} to appear in a new line.
299 // The % is needed to prevent two consecutive \n chars in the case
300 // when the current output line is empty.
301 os << "%\n\\begin{" << tmptype << '}';
302 // We only output placement if different from the def_placement.
303 if (!placement.empty()) {
304 os << '[' << placement << ']';
308 int const i = inset.latex(buf, os, runparams);
310 // The \n is used to force \end{<floatname>} to appear in a new line.
311 // In this case, we do not case if the current output line is empty.
312 os << "\n\\end{" << tmptype << "}\n";
318 int InsetFloat::docbook(Buffer const * buf, ostream & os, bool mixcont) const
320 os << '<' << params_.type << '>';
321 int const i = inset.docbook(buf, os, mixcont);
322 os << "</" << params_.type << '>';
328 bool InsetFloat::insetAllowed(Inset::Code code) const
330 if (code == Inset::FLOAT_CODE)
332 if (inset.getLockingInset() != const_cast<InsetFloat *>(this))
333 return inset.insetAllowed(code);
334 if ((code == Inset::FOOT_CODE) || (code == Inset::MARGIN_CODE))
340 bool InsetFloat::showInsetDialog(BufferView * bv) const
342 if (!inset.showInsetDialog(bv)) {
343 InsetFloat * tmp = const_cast<InsetFloat *>(this);
344 InsetFloatMailer mailer(*tmp);
345 mailer.showDialog(bv);
351 void InsetFloat::wide(bool w, BufferParams const & bp)
355 string lab(_("float:"));
356 lab += floatname(params_.type, bp);
365 void InsetFloat::addToToc(toc::TocList & toclist, Buffer const * buf) const
367 ParIterator pit(inset.paragraphs.begin(), inset.paragraphs);
368 ParIterator end(inset.paragraphs.end(), inset.paragraphs);
370 // Find a caption layout in one of the (child inset's) pars
371 for (; pit != end; ++pit) {
372 if (pit->layout()->name() == caplayout) {
373 string const name = floatname(params_.type, buf->params);
375 tostr(toclist[name].size() + 1)
376 + ". " + pit->asString(buf, false);
377 toc::TocItem const item(pit->id(), 0 , str);
378 toclist[name].push_back(item);
384 string const InsetFloatMailer::name_("float");
386 InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
391 string const InsetFloatMailer::inset2string(Buffer const &) const
393 return params2string(inset_.params());
397 void InsetFloatMailer::string2params(string const & in,
398 InsetFloatParams & params)
400 params = InsetFloatParams();
405 istringstream data(STRCONV(in));
411 string const token = lex.getString();
416 // This is part of the inset proper that is usually swallowed
417 // by Buffer::readInset
420 string const token = lex.getString();
421 if (token != "Float" || !lex.eatLine())
431 string const InsetFloatMailer::params2string(InsetFloatParams const & params)
434 data << name_ << ' ';
436 return STRCONV(data.str());