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"
21 #include "dispatchresult.h"
23 #include "FloatList.h"
24 #include "funcrequest.h"
25 #include "FuncStatus.h"
27 #include "LaTeXFeatures.h"
30 #include "outputparams.h"
31 #include "paragraph.h"
32 #include "pariterator.h"
34 #include "support/lstrings.h"
35 #include "support/convert.h"
39 using lyx::support::contains;
44 using std::istringstream;
46 using std::ostringstream;
49 // With this inset it will be possible to support the latex package
50 // float.sty, and I am sure that with this and some additional support
51 // classes we can support similar functionality in other formats
53 // By using float.sty we will have the same handling for all floats, both
54 // for those already in existance (table and figure) and all user created
55 // ones¹. So suddenly we give the users the possibility of creating new
56 // kinds of floats on the fly. (and with a uniform look)
59 // \newfloat{type}{placement}{ext}[within]
60 // type - The "type" of the new class of floats, like program or
61 // algorithm. After the appropriate \newfloat, commands
62 // such as \begin{program} or \end{algorithm*} will be
64 // placement - The default placement for the given class of floats.
65 // They are like in standard LaTeX: t, b, p and h for top,
66 // bottom, page, and here, respectively. On top of that
67 // there is a new type, H, which does not really correspond
68 // to a float, since it means: put it "here" and nowhere else.
69 // Note, however that the H specifier is special and, because
70 // of implementation details cannot be used in the second
71 // argument of \newfloat.
72 // ext - The file name extension of an auxiliary file for the list
73 // of figures (or whatever). LaTeX writes the captions to
75 // within - This (optional) argument determines whether floats of this
76 // class will be numbered within some sectional unit of the
77 // document. For example, if within is equal to chapter, the
78 // floats will be numbered within chapters.
80 // style - plain, boxed, ruled
81 // \floatname{float}{floatname}
84 // \floatplacement{float}{placement}
87 // \restylefloat{float}
89 // \listof{type}{title}
92 // ¹ the algorithm float is defined using the float.sty package. Like this
94 // \newfloat{algorithm}{htbp}{loa}[<sect>]
95 // \floatname{algorithm}{Algorithm}
97 // The intention is that floats should be definable from two places:
99 // - the "gui" (i.e. by the user)
101 // From layout files.
102 // This should only be done for floats defined in a documentclass and that
103 // does not need any additional packages. The two most known floats in this
104 // category is "table" and "figure". Floats defined in layout files are only
105 // stored in lyx files if the user modifies them.
108 // There should be a gui dialog (and also a collection of lyxfuncs) where
109 // the user can modify existing floats and/or create new ones.
111 // The individual floats will also have some settable
112 // variables: wide and placement.
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 setLabel(_("float: ") + floatname(type, bp));
135 LyXFont font(LyXFont::ALL_SANE);
138 font.setColor(LColor::collapsable);
145 InsetFloat::~InsetFloat()
147 InsetFloatMailer(*this).hideDialog();
151 void InsetFloat::doDispatch(LCursor & cur, FuncRequest & cmd)
153 switch (cmd.action) {
155 case LFUN_INSET_MODIFY: {
156 InsetFloatParams params;
157 InsetFloatMailer::string2params(cmd.argument, params);
158 params_.placement = params.placement;
159 params_.wide = params.wide;
160 params_.sideways = params.sideways;
161 wide(params_.wide, cur.buffer().params());
162 sideways(params_.sideways, cur.buffer().params());
167 case LFUN_INSET_DIALOG_UPDATE: {
168 InsetFloatMailer(*this).updateDialog(&cur.bv());
172 case LFUN_MOUSE_RELEASE: {
173 if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
174 InsetFloatMailer(*this).showDialog(&cur.bv());
177 InsetCollapsable::doDispatch(cur, cmd);
182 InsetCollapsable::doDispatch(cur, cmd);
188 bool InsetFloat::getStatus(LCursor & cur, FuncRequest const & cmd,
189 FuncStatus & flag) const
191 switch (cmd.action) {
193 case LFUN_INSET_MODIFY:
194 case LFUN_INSET_DIALOG_UPDATE:
199 return InsetCollapsable::getStatus(cur, cmd, flag);
205 void InsetFloatParams::write(ostream & os) const
207 os << "Float " << type << '\n';
209 if (!placement.empty())
210 os << "placement " << placement << "\n";
215 os << "wide false\n";
218 os << "sideways true\n";
220 os << "sideways false\n";
224 void InsetFloatParams::read(LyXLex & lex)
228 if (token == "placement") {
231 // take countermeasures
232 lex.pushToken(token);
235 if (token == "wide") {
238 lyxerr << "InsetFloat::Read:: Missing wide!"
240 // take countermeasures
241 lex.pushToken(token);
244 if (token == "sideways") {
247 lyxerr << "InsetFloat::Read:: Missing sideways!"
249 // take countermeasures
250 lex.pushToken(token);
255 void InsetFloat::write(Buffer const & buf, ostream & os) const
258 InsetCollapsable::write(buf, os);
262 void InsetFloat::read(Buffer const & buf, LyXLex & lex)
265 wide(params_.wide, buf.params());
266 sideways(params_.sideways, buf.params());
267 InsetCollapsable::read(buf, lex);
271 void InsetFloat::validate(LaTeXFeatures & features) const
273 if (contains(params_.placement, 'H')) {
274 features.require("float");
277 if (params_.sideways)
278 features.require("rotating");
280 features.useFloat(params_.type);
281 InsetCollapsable::validate(features);
285 auto_ptr<InsetBase> InsetFloat::doClone() const
287 return auto_ptr<InsetBase>(new InsetFloat(*this));
291 string const InsetFloat::editMessage() const
293 return _("Opened Float Inset");
297 int InsetFloat::latex(Buffer const & buf, ostream & os,
298 OutputParams const & runparams) const
300 FloatList const & floats = buf.params().getLyXTextClass().floats();
301 string tmptype = (params_.wide ? params_.type + "*" : params_.type);
302 if (params_.sideways) {
303 if (params_.type == "table")
304 tmptype = "sidewaystable";
305 else if (params_.type == "figure")
306 tmptype = "sidewaysfigure";
308 // Figure out the float placement to use.
309 // From lowest to highest:
310 // - float default placement
311 // - document wide default placement
312 // - specific float placement
314 string const buf_placement = buf.params().float_placement;
315 string const def_placement = floats.defaultPlacement(params_.type);
316 if (!params_.placement.empty()
317 && params_.placement != def_placement) {
318 placement = params_.placement;
319 } else if (params_.placement.empty()
320 && !buf_placement.empty()
321 && buf_placement != def_placement) {
322 placement = buf_placement;
325 // The \n is used to force \begin{<floatname>} to appear in a new line.
326 // The % is needed to prevent two consecutive \n chars in the case
327 // when the current output line is empty.
328 os << "%\n\\begin{" << tmptype << '}';
329 // We only output placement if different from the def_placement.
330 // sidewaysfloats always use their own page
331 if (!placement.empty() && !params_.sideways) {
332 os << '[' << placement << ']';
336 int const i = InsetText::latex(buf, os, runparams);
338 // The \n is used to force \end{<floatname>} to appear in a new line.
339 // In this case, we do not case if the current output line is empty.
340 os << "\n\\end{" << tmptype << "}\n";
346 int InsetFloat::linuxdoc(Buffer const & buf, ostream & os,
347 OutputParams const & runparams) const
349 FloatList const & floats = buf.params().getLyXTextClass().floats();
350 string const tmptype = params_.type;
351 // Figure out the float placement to use.
352 // From lowest to highest:
353 // - float default placement
354 // - document wide default placement
355 // - specific float placement
356 // This is the same as latex, as linuxdoc is modeled after latex.
359 string const buf_placement = buf.params().float_placement;
360 string const def_placement = floats.defaultPlacement(params_.type);
361 if (!params_.placement.empty()
362 && params_.placement != def_placement) {
363 placement = params_.placement;
364 } else if (params_.placement.empty()
365 && !buf_placement.empty()
366 && buf_placement != def_placement) {
367 placement = buf_placement;
370 os << "\n<" << tmptype ;
371 // We only output placement if different from the def_placement.
372 if (!placement.empty()) {
373 os << " loc=\"" << placement << '"';
377 int const i = InsetText::linuxdoc(buf, os, runparams);
378 os << "</" << tmptype << ">\n";
384 int InsetFloat::docbook(Buffer const & buf, ostream & os,
385 OutputParams const & runparams) const
387 os << '<' << params_.type << '>';
388 int const i = InsetText::docbook(buf, os, runparams);
389 os << "</" << params_.type << '>';
395 bool InsetFloat::insetAllowed(InsetBase::Code code) const
397 return code != InsetBase::FLOAT_CODE
398 && code != InsetBase::FOOT_CODE
399 && code != InsetBase::MARGIN_CODE;
403 bool InsetFloat::showInsetDialog(BufferView * bv) const
405 if (!InsetText::showInsetDialog(bv))
406 InsetFloatMailer(const_cast<InsetFloat &>(*this)).showDialog(bv);
411 void InsetFloat::wide(bool w, BufferParams const & bp)
414 string lab = _("float: ") + floatname(params_.type, bp);
421 void InsetFloat::sideways(bool s, BufferParams const & bp)
423 params_.sideways = s;
424 string lab = _("float: ") + floatname(params_.type, bp);
425 if (params_.sideways)
426 lab += _(" (sideways)");
431 void InsetFloat::addToToc(lyx::toc::TocList & toclist, Buffer const & buf) const
433 ParConstIterator pit = par_const_iterator_begin(*this);
434 ParConstIterator end = par_const_iterator_end(*this);
436 // Find a caption layout in one of the (child inset's) pars
437 for (; pit != end; ++pit) {
438 if (pit->layout()->labeltype == LABEL_SENSITIVE) {
439 string const name = floatname(params_.type, buf.params());
441 convert<string>(toclist[name].size() + 1)
442 + ". " + pit->asString(buf, false);
443 lyx::toc::TocItem const item(pit->id(), 0 , str);
444 toclist[name].push_back(item);
450 string const InsetFloatMailer::name_("float");
452 InsetFloatMailer::InsetFloatMailer(InsetFloat & inset)
457 string const InsetFloatMailer::inset2string(Buffer const &) const
459 return params2string(inset_.params());
463 void InsetFloatMailer::string2params(string const & in,
464 InsetFloatParams & params)
466 params = InsetFloatParams();
470 istringstream data(in);
476 if (!lex || name != name_)
477 return print_mailer_error("InsetFloatMailer", in, 1, name_);
479 // This is part of the inset proper that is usually swallowed
480 // by LyXText::readInset
483 if (!lex || id != "Float")
484 return print_mailer_error("InsetBoxMailer", in, 2, "Float");
486 // We have to read the type here!
492 string const InsetFloatMailer::params2string(InsetFloatParams const & params)
495 data << name_ << ' ';