]> git.lyx.org Git - features.git/blob - src/insets/InsetFloat.cpp
Extended tooltips for floats:
[features.git] / src / insets / InsetFloat.cpp
1 /**
2  * \file InsetFloat.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Jürgen Vigna
7  * \author Lars Gullik Bjønnes
8  * \author Jürgen Spitzmüller
9  *
10  * Full author contact details are available in file CREDITS.
11  */
12
13 #include <config.h>
14
15 #include "InsetFloat.h"
16 #include "InsetCaption.h"
17
18 #include "Buffer.h"
19 #include "BufferParams.h"
20 #include "BufferView.h"
21 #include "Counters.h"
22 #include "Cursor.h"
23 #include "DispatchResult.h"
24 #include "Floating.h"
25 #include "FloatList.h"
26 #include "FuncRequest.h"
27 #include "FuncStatus.h"
28 #include "InsetList.h"
29 #include "LaTeXFeatures.h"
30 #include "Lexer.h"
31 #include "OutputParams.h"
32 #include "ParIterator.h"
33 #include "TextClass.h"
34
35 #include "support/convert.h"
36 #include "support/debug.h"
37 #include "support/gettext.h"
38 #include "support/lstrings.h"
39 #include "support/docstream.h"
40
41 #include "frontends/Application.h"
42
43 using namespace std;
44
45
46 namespace lyx {
47
48 // With this inset it will be possible to support the latex package
49 // float.sty, and I am sure that with this and some additional support
50 // classes we can support similar functionality in other formats
51 // (read DocBook).
52 // By using float.sty we will have the same handling for all floats, both
53 // for those already in existance (table and figure) and all user created
54 // ones¹. So suddenly we give the users the possibility of creating new
55 // kinds of floats on the fly. (and with a uniform look)
56 //
57 // API to float.sty:
58 //   \newfloat{type}{placement}{ext}[within]
59 //     type      - The "type" of the new class of floats, like program or
60 //                 algorithm. After the appropriate \newfloat, commands
61 //                 such as \begin{program} or \end{algorithm*} will be
62 //                 available.
63 //     placement - The default placement for the given class of floats.
64 //                 They are like in standard LaTeX: t, b, p and h for top,
65 //                 bottom, page, and here, respectively. On top of that
66 //                 there is a new type, H, which does not really correspond
67 //                 to a float, since it means: put it "here" and nowhere else.
68 //                 Note, however that the H specifier is special and, because
69 //                 of implementation details cannot be used in the second
70 //                 argument of \newfloat.
71 //     ext       - The file name extension of an auxiliary file for the list
72 //                 of figures (or whatever). LaTeX writes the captions to
73 //                 this file.
74 //     within    - This (optional) argument determines whether floats of this
75 //                 class will be numbered within some sectional unit of the
76 //                 document. For example, if within is equal to chapter, the
77 //                 floats will be numbered within chapters.
78 //   \floatstyle{style}
79 //     style -  plain, boxed, ruled
80 //   \floatname{float}{floatname}
81 //     float     -
82 //     floatname -
83 //   \floatplacement{float}{placement}
84 //     float     -
85 //     placement -
86 //   \restylefloat{float}
87 //     float -
88 //   \listof{type}{title}
89 //     title -
90
91 // ¹ the algorithm float is defined using the float.sty package. Like this
92 //   \floatstyle{ruled}
93 //   \newfloat{algorithm}{htbp}{loa}[<sect>]
94 //   \floatname{algorithm}{Algorithm}
95 //
96 // The intention is that floats should be definable from two places:
97 //          - layout files
98 //          - the "gui" (i.e. by the user)
99 //
100 // From layout files.
101 // This should only be done for floats defined in a documentclass and that
102 // does not need any additional packages. The two most known floats in this
103 // category is "table" and "figure". Floats defined in layout files are only
104 // stored in lyx files if the user modifies them.
105 //
106 // By the user.
107 // There should be a gui dialog (and also a collection of lyxfuncs) where
108 // the user can modify existing floats and/or create new ones.
109 //
110 // The individual floats will also have some settable
111 // variables: wide and placement.
112 //
113 // Lgb
114
115
116 InsetFloat::InsetFloat(Buffer const & buf, string const & type)
117         : InsetCollapsable(buf), name_(from_utf8(type))
118 {
119         setLabel(_("float: ") + floatName(type, buf.params()));
120         params_.type = type;
121 }
122
123
124 InsetFloat::~InsetFloat()
125 {
126         hideDialogs("float", this);
127 }
128
129
130 docstring InsetFloat::toolTip(BufferView const & bv, int x, int y) const
131 {
132         OutputParams rp(&buffer().params().encoding());
133         docstring default_tip = InsetCollapsable::toolTip(bv, x, y);
134         docstring caption_tip = getCaptionText(rp);
135         if (!isOpen() && !caption_tip.empty())
136                 return caption_tip + '\n' + default_tip;
137         return default_tip;
138 }
139
140
141 void InsetFloat::doDispatch(Cursor & cur, FuncRequest & cmd)
142 {
143         switch (cmd.action) {
144
145         case LFUN_INSET_MODIFY: {
146                 InsetFloatParams params;
147                 string2params(to_utf8(cmd.argument()), params);
148                 params_.placement = params.placement;
149                 params_.wide      = params.wide;
150                 params_.sideways  = params.sideways;
151                 params_.subfloat  = params.subfloat;
152                 setWide(params_.wide, cur.buffer().params());
153                 setSideways(params_.sideways, cur.buffer().params());
154                 break;
155         }
156
157         case LFUN_INSET_DIALOG_UPDATE: {
158                 cur.bv().updateDialog("float", params2string(params()));
159                 break;
160         }
161
162         default:
163                 InsetCollapsable::doDispatch(cur, cmd);
164                 break;
165         }
166 }
167
168
169 bool InsetFloat::getStatus(Cursor & cur, FuncRequest const & cmd,
170                 FuncStatus & flag) const
171 {
172         switch (cmd.action) {
173
174         case LFUN_INSET_MODIFY:
175         case LFUN_INSET_DIALOG_UPDATE:
176                 flag.enabled(true);
177                 return true;
178
179         default:
180                 return InsetCollapsable::getStatus(cur, cmd, flag);
181         }
182 }
183
184
185 void InsetFloat::updateLabels(ParIterator const & it)
186 {
187         Counters & cnts = buffer().params().documentClass().counters();
188         string const saveflt = cnts.current_float();
189         bool const savesubflt = cnts.isSubfloat();
190
191         bool const subflt = it.innerInsetOfType(FLOAT_CODE);
192         // floats can only embed subfloats of their own kind
193         if (subflt)
194                 params_.type = saveflt;
195         setSubfloat(subflt, buffer().params());
196
197         // Tell to captions what the current float is
198         cnts.current_float(params().type);
199         cnts.isSubfloat(subflt);
200
201         InsetCollapsable::updateLabels(it);
202
203         //reset afterwards
204         cnts.current_float(saveflt);
205         cnts.isSubfloat(savesubflt);
206 }
207
208
209 void InsetFloatParams::write(ostream & os) const
210 {
211         os << "Float " << type << '\n';
212
213         if (!placement.empty())
214                 os << "placement " << placement << "\n";
215
216         if (wide)
217                 os << "wide true\n";
218         else
219                 os << "wide false\n";
220
221         if (sideways)
222                 os << "sideways true\n";
223         else
224                 os << "sideways false\n";
225 }
226
227
228 void InsetFloatParams::read(Lexer & lex)
229 {
230         lex.setContext("InsetFloatParams::read");
231         if (lex.checkFor("placement"))
232                 lex >> placement;
233         lex >> "wide" >> wide;
234         lex >> "sideways" >> sideways;
235 }
236
237
238 void InsetFloat::write(ostream & os) const
239 {
240         params_.write(os);
241         InsetCollapsable::write(os);
242 }
243
244
245 void InsetFloat::read(Lexer & lex)
246 {
247         params_.read(lex);
248         setWide(params_.wide, buffer().params());
249         setSideways(params_.sideways, buffer().params());
250         setSubfloat(params_.subfloat, buffer().params());
251         InsetCollapsable::read(lex);
252 }
253
254
255 void InsetFloat::validate(LaTeXFeatures & features) const
256 {
257         if (support::contains(params_.placement, 'H'))
258                 features.require("float");
259
260         if (params_.sideways)
261                 features.require("rotfloat");
262
263         if (params_.subfloat)
264                 features.require("subfig");
265
266         features.useFloat(params_.type, params_.subfloat);
267         InsetCollapsable::validate(features);
268 }
269
270
271 docstring InsetFloat::editMessage() const
272 {
273         return _("Opened Float Inset");
274 }
275
276
277 int InsetFloat::latex(odocstream & os, OutputParams const & runparams) const
278 {
279         if (params_.subfloat) {
280                 if (runparams.moving_arg)
281                         os << "\\protect";
282                 os << "\\subfloat";
283         
284                 OutputParams rp = runparams;
285                 docstring const caption = getCaption(rp);
286                 if (!caption.empty()) {
287                         os << caption;
288                 }
289                 os << '{';
290                 int const i = InsetText::latex(os, runparams);
291                 os << "}";
292         
293                 return i + 1;
294         }
295
296         FloatList const & floats = buffer().params().documentClass().floats();
297         string tmptype = params_.type;
298         if (params_.sideways)
299                 tmptype = "sideways" + params_.type;
300         if (params_.wide && (!params_.sideways ||
301                              params_.type == "figure" ||
302                              params_.type == "table"))
303                 tmptype += "*";
304         // Figure out the float placement to use.
305         // From lowest to highest:
306         // - float default placement
307         // - document wide default placement
308         // - specific float placement
309         string placement;
310         string const buf_placement = buffer().params().float_placement;
311         string const def_placement = floats.defaultPlacement(params_.type);
312         if (!params_.placement.empty()
313             && params_.placement != def_placement) {
314                 placement = params_.placement;
315         } else if (params_.placement.empty()
316                    && !buf_placement.empty()
317                    && buf_placement != def_placement) {
318                 placement = buf_placement;
319         }
320
321         // The \n is used to force \begin{<floatname>} to appear in a new line.
322         // The % is needed to prevent two consecutive \n chars in the case
323         // when the current output line is empty.
324         os << "%\n\\begin{" << from_ascii(tmptype) << '}';
325         // We only output placement if different from the def_placement.
326         // sidewaysfloats always use their own page
327         if (!placement.empty() && !params_.sideways) {
328                 os << '[' << from_ascii(placement) << ']';
329         }
330         os << '\n';
331
332         int const i = InsetText::latex(os, runparams);
333
334         // The \n is used to force \end{<floatname>} to appear in a new line.
335         // In this case, we do not case if the current output line is empty.
336         os << "\n\\end{" << from_ascii(tmptype) << "}\n";
337
338         return i + 4;
339 }
340
341
342 int InsetFloat::plaintext(odocstream & os, OutputParams const & runparams) const
343 {
344         os << '[' << buffer().B_("float") << ' '
345                 << floatName(params_.type, buffer().params()) << ":\n";
346         InsetText::plaintext(os, runparams);
347         os << "\n]";
348
349         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
350 }
351
352
353 int InsetFloat::docbook(odocstream & os, OutputParams const & runparams) const
354 {
355         // FIXME Implement subfloat!
356         // FIXME UNICODE
357         os << '<' << from_ascii(params_.type) << '>';
358         int const i = InsetText::docbook(os, runparams);
359         os << "</" << from_ascii(params_.type) << '>';
360
361         return i;
362 }
363
364
365 bool InsetFloat::insetAllowed(InsetCode code) const
366 {
367         return code != FOOT_CODE
368             && code != MARGIN_CODE
369             && (code != FLOAT_CODE || !params_.subfloat);
370 }
371
372
373 bool InsetFloat::showInsetDialog(BufferView * bv) const
374 {
375         if (!InsetText::showInsetDialog(bv))
376                 bv->showDialog("float", params2string(params()),
377                         const_cast<InsetFloat *>(this));
378         return true;
379 }
380
381
382 void InsetFloat::setWide(bool w, BufferParams const & bp)
383 {
384         params_.wide = w;
385         docstring lab = _("float: ") + floatName(params_.type, bp);
386         if (params_.wide)
387                 lab += '*';
388         setLabel(lab);
389 }
390
391
392 void InsetFloat::setSideways(bool s, BufferParams const & bp)
393 {
394         params_.sideways = s;
395         docstring lab = _("float: ") + floatName(params_.type, bp);
396         if (params_.sideways)
397                 lab += _(" (sideways)");
398         setLabel(lab);
399 }
400
401
402 void InsetFloat::setSubfloat(bool s, BufferParams const & bp)
403 {
404         params_.subfloat = s;
405         docstring lab = _("float: ") + floatName(params_.type, bp);
406         if (s)
407                 lab = _("subfloat: ") + floatName(params_.type, bp);
408         setLabel(lab);
409 }
410
411
412 docstring InsetFloat::getCaption(OutputParams const & runparams) const
413 {
414         if (paragraphs().empty())
415                 return docstring();
416
417         ParagraphList::const_iterator pit = paragraphs().begin();
418         for (; pit != paragraphs().end(); ++pit) {
419                 InsetList::const_iterator it = pit->insetList().begin();
420                 for (; it != pit->insetList().end(); ++it) {
421                         Inset & inset = *it->inset;
422                         if (inset.lyxCode() == CAPTION_CODE) {
423                                 odocstringstream ods;
424                                 InsetCaption * ins =
425                                         static_cast<InsetCaption *>(it->inset);
426                                 ins->getOptArg(ods, runparams);
427                                 ods << '[';
428                                 ins->getArgument(ods, runparams);
429                                 ods << ']';
430                                 return ods.str();
431                         }
432                 }
433         }
434         return docstring();
435 }
436
437
438 docstring InsetFloat::getCaptionText(OutputParams const & runparams) const
439 {
440         if (paragraphs().empty())
441                 return docstring();
442
443         ParagraphList::const_iterator pit = paragraphs().begin();
444         for (; pit != paragraphs().end(); ++pit) {
445                 InsetList::const_iterator it = pit->insetList().begin();
446                 for (; it != pit->insetList().end(); ++it) {
447                         Inset & inset = *it->inset;
448                         if (inset.lyxCode() == CAPTION_CODE) {
449                                 odocstringstream ods;
450                                 InsetCaption * ins =
451                                         static_cast<InsetCaption *>(it->inset);
452                                 ins->getCaptionText(ods, runparams);
453                                 return ods.str();
454                         }
455                 }
456         }
457         return docstring();
458 }
459
460
461 void InsetFloat::string2params(string const & in, InsetFloatParams & params)
462 {
463         params = InsetFloatParams();
464         if (in.empty())
465                 return;
466
467         istringstream data(in);
468         Lexer lex;
469         lex.setStream(data);
470         lex.setContext("InsetFloat::string2params");
471         lex >> "float" >> "Float";
472         lex >> params.type; // We have to read the type here!
473         params.read(lex);
474 }
475
476
477 string InsetFloat::params2string(InsetFloatParams const & params)
478 {
479         ostringstream data;
480         data << "float" << ' ';
481         params.write(data);
482         return data.str();
483 }
484
485
486 } // namespace lyx