3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS.
16 #include "BufferParams.h"
17 #include "FloatList.h"
18 #include "FuncRequest.h"
21 #include "TextClass.h"
23 #include "insets/InsetBibitem.h"
24 #include "insets/InsetBibtex.h"
25 #include "insets/InsetCaption.h"
26 #include "insets/InsetCitation.h"
27 #include "insets/InsetFlex.h"
28 #include "insets/InsetEnvironment.h"
29 #include "insets/InsetERT.h"
30 #include "insets/InsetListings.h"
31 #include "insets/InsetExternal.h"
32 #include "insets/InsetFloat.h"
33 #include "insets/InsetFloatList.h"
34 #include "insets/InsetFoot.h"
35 #include "insets/InsetGraphics.h"
36 #include "insets/InsetHFill.h"
37 #include "insets/InsetInclude.h"
38 #include "insets/InsetIndex.h"
39 #include "insets/InsetInfo.h"
40 #include "insets/InsetNomencl.h"
41 #include "insets/InsetLabel.h"
42 #include "insets/InsetLine.h"
43 #include "insets/InsetMarginal.h"
44 #include "insets/InsetNote.h"
45 #include "insets/InsetBox.h"
46 #include "insets/InsetBranch.h"
47 #include "insets/InsetOptArg.h"
48 #include "insets/InsetNewpage.h"
49 #include "insets/InsetRef.h"
50 #include "insets/InsetSpace.h"
51 #include "insets/InsetTabular.h"
52 #include "insets/InsetTOC.h"
53 #include "insets/InsetHyperlink.h"
54 #include "insets/InsetVSpace.h"
55 #include "insets/InsetWrap.h"
57 #include "mathed/MathMacroTemplate.h"
58 #include "mathed/InsetMathHull.h"
60 #include "frontends/alert.h"
62 #include "support/debug.h"
63 #include "support/lstrings.h"
64 #include "support/ExceptionMessage.h"
66 #include <boost/assert.hpp>
71 using namespace lyx::support;
75 namespace Alert = frontend::Alert;
78 Inset * createInsetHelper(Buffer & buf, FuncRequest const & cmd)
80 BufferParams const & params = buf.params();
85 case LFUN_HFILL_INSERT:
86 return new InsetHFill;
88 case LFUN_LINE_INSERT:
91 case LFUN_NEWPAGE_INSERT:
92 return new InsetNewpage;
94 case LFUN_PAGEBREAK_INSERT:
95 return new InsetPagebreak;
97 case LFUN_CLEARPAGE_INSERT:
98 return new InsetClearPage;
100 case LFUN_CLEARDOUBLEPAGE_INSERT:
101 return new InsetClearDoublePage;
103 case LFUN_FLEX_INSERT: {
104 string s = cmd.getArg(0);
105 return new InsetFlex(params, params.textClassPtr(), s);
108 case LFUN_NOTE_INSERT: {
109 string arg = cmd.getArg(0);
112 return new InsetNote(params, arg);
115 case LFUN_BOX_INSERT: {
116 string arg = cmd.getArg(0);
119 return new InsetBox(params, arg);
122 case LFUN_BRANCH_INSERT: {
123 docstring arg = cmd.argument();
125 arg = from_ascii("none");
126 return new InsetBranch(params, InsetBranchParams(arg));
129 case LFUN_ERT_INSERT:
130 return new InsetERT(params);
132 case LFUN_LISTING_INSERT:
133 return new InsetListings(params);
135 case LFUN_FOOTNOTE_INSERT:
136 return new InsetFoot(params);
138 case LFUN_MARGINALNOTE_INSERT:
139 return new InsetMarginal(params);
141 case LFUN_OPTIONAL_INSERT:
142 return new InsetOptArg(params);
144 case LFUN_BIBITEM_INSERT:
145 return new InsetBibitem(InsetCommandParams(BIBITEM_CODE));
147 case LFUN_FLOAT_INSERT: {
148 // check if the float type exists
149 string const argument = to_utf8(cmd.argument());
150 if (params.textClass().floats().typeExist(argument))
151 return new InsetFloat(params, argument);
152 lyxerr << "Non-existent float type: " << argument << endl;
155 case LFUN_FLOAT_WIDE_INSERT: {
156 // check if the float type exists
157 string const argument = to_utf8(cmd.argument());
158 if (params.textClass().floats().typeExist(argument)) {
159 auto_ptr<InsetFloat> p(new InsetFloat(params, argument));
160 p->wide(true, params);
163 lyxerr << "Non-existent float type: " << argument << endl;
167 case LFUN_WRAP_INSERT: {
168 string const argument = to_utf8(cmd.argument());
169 if (argument == "figure" || argument == "table")
170 return new InsetWrap(params, argument);
171 lyxerr << "Non-existent wrapfig type: " << argument << endl;
175 case LFUN_INDEX_INSERT:
176 return new InsetIndex(params);
178 case LFUN_NOMENCL_INSERT: {
179 InsetCommandParams icp(NOMENCL_CODE);
180 icp["symbol"] = cmd.argument();
181 return new InsetNomencl(icp);
184 case LFUN_TABULAR_INSERT: {
185 if (cmd.argument().empty())
187 istringstream ss(to_utf8(cmd.argument()));
194 return new InsetTabular(buf, r, c);
197 case LFUN_CAPTION_INSERT: {
198 auto_ptr<InsetCaption> inset(new InsetCaption(params));
199 inset->setAutoBreakRows(true);
200 inset->setDrawFrame(true);
201 inset->setFrameColor(Color_captionframe);
202 return inset.release();
205 case LFUN_INDEX_PRINT:
206 return new InsetPrintIndex(InsetCommandParams(INDEX_PRINT_CODE));
208 case LFUN_NOMENCL_PRINT:
209 return new InsetPrintNomencl(InsetCommandParams(NOMENCL_PRINT_CODE));
211 case LFUN_TOC_INSERT:
212 return new InsetTOC(InsetCommandParams(TOC_CODE));
214 case LFUN_ENVIRONMENT_INSERT:
215 return new InsetEnvironment(params, cmd.argument());
217 case LFUN_INFO_INSERT:
218 return new InsetInfo(params, to_utf8(cmd.argument()));
220 case LFUN_THEOREM_INSERT:
221 return new InsetTheorem;
224 case LFUN_INSET_INSERT: {
225 string const name = cmd.getArg(0);
226 InsetCode code = insetCode(name);
229 lyxerr << "No such inset '" << name << "'.";
233 InsetCommandParams icp(code);
234 InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), icp);
235 return new InsetBibitem(icp);
239 InsetCommandParams icp(code);
240 InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), icp);
241 return new InsetBibtex(icp);
245 InsetCommandParams icp(code);
246 InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), icp);
247 return new InsetCitation(icp);
251 InsetCollapsable::CollapseStatus st;
252 InsetERTMailer::string2params(to_utf8(cmd.argument()), st);
253 return new InsetERT(params, st);
256 case LISTINGS_CODE: {
257 InsetListingsParams par;
258 InsetListingsMailer::string2params(to_utf8(cmd.argument()), par);
259 return new InsetListings(params, par);
262 case EXTERNAL_CODE: {
263 InsetExternalParams iep;
264 InsetExternalMailer::string2params(to_utf8(cmd.argument()), buf, iep);
265 auto_ptr<InsetExternal> inset(new InsetExternal);
266 inset->setParams(iep, buf);
267 return inset.release();
270 case GRAPHICS_CODE: {
271 InsetGraphicsParams igp;
272 InsetGraphicsMailer::string2params(to_utf8(cmd.argument()), buf, igp);
273 auto_ptr<InsetGraphics> inset(new InsetGraphics);
274 inset->setParams(igp);
275 return inset.release();
278 case HYPERLINK_CODE: {
279 InsetCommandParams icp(code);
280 InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), icp);
281 return new InsetHyperlink(icp);
285 InsetCommandParams icp(code);
286 InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), icp);
287 return new InsetInclude(icp);
291 return new InsetIndex(params);
294 InsetCommandParams icp(code);
295 InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()), icp);
296 return new InsetNomencl(icp);
300 InsetCommandParams icp(code);
301 InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), icp);
302 return new InsetLabel(icp);
306 InsetCommandParams icp(code);
307 InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), icp);
308 return new InsetRef(icp, buf);
312 InsetCommandParams icp(code);
313 InsetCommandMailer::string2params(name, to_utf8(cmd.argument()), icp);
314 return new InsetTOC(icp);
319 InsetVSpaceMailer::string2params(to_utf8(cmd.argument()), vspace);
320 return new InsetVSpace(vspace);
324 lyxerr << "Inset '" << name << "' not permitted with LFUN_INSET_INSERT."
329 } //end LFUN_INSET_INSERT
331 case LFUN_SPACE_INSERT: {
332 string const name = to_utf8(cmd.argument());
333 if (name == "normal")
334 return new InsetSpace(InsetSpace::NORMAL);
335 if (name == "protected")
336 return new InsetSpace(InsetSpace::PROTECTED);
338 return new InsetSpace(InsetSpace::THIN);
340 return new InsetSpace(InsetSpace::QUAD);
342 return new InsetSpace(InsetSpace::QQUAD);
343 if (name == "enspace")
344 return new InsetSpace(InsetSpace::ENSPACE);
345 if (name == "enskip")
346 return new InsetSpace(InsetSpace::ENSKIP);
347 if (name == "negthinspace")
348 return new InsetSpace(InsetSpace::NEGTHIN);
350 lyxerr << "LyX function 'space' needs an argument." << endl;
352 lyxerr << "Wrong argument for LyX function 'space'." << endl;
360 } catch (ExceptionMessage const & message) {
361 if (message.type_ == ErrorException) {
362 // This should never happen!
363 Alert::error(message.title_, message.details_);
365 } else if (message.type_ == WarningException) {
366 Alert::warning(message.title_, message.details_);
375 Inset * createInset(Buffer & buf, FuncRequest const & cmd)
377 Inset * inset = createInsetHelper(buf, cmd);
379 inset->setBuffer(&buf);
383 Inset * readInset(Lexer & lex, Buffer const & buf)
386 if (lex.getString() != "\\begin_inset") {
387 lyxerr << "Buffer::readInset: Consistency check failed."
391 auto_ptr<Inset> inset;
394 string tmptok = lex.getString();
396 // test the different insets
398 //FIXME It would be better if we did not have this branch and could
399 //just do one massive switch for all insets. But at present, it's easier
400 //to do it this way, and we can't do the massive switch until the conversion
402 //Note that if we do want to do a single switch, we need to remove
403 //this "CommandInset" line---or replace it with a single "InsetType" line
404 //that would be used in all insets.
405 if (tmptok == "CommandInset") {
407 string const insetType = lex.getString();
408 lex.pushToken(insetType);
410 InsetCode const code = insetCode(insetType);
412 //FIXME If we do the one massive switch, we cannot do this here, since
413 //we do not know in advance that we're dealing with a command inset.
414 //Worst case, we could put it in each case below. Better, we could
415 //pass the lexer to the constructor and let the params be built there.
416 InsetCommandParams inscmd(code);
421 inset.reset(new InsetBibitem(inscmd));
424 inset.reset(new InsetBibtex(inscmd));
427 inset.reset(new InsetCitation(inscmd));
430 inset.reset(new InsetHyperlink(inscmd));
433 inset.reset(new InsetInclude(inscmd));
435 case INDEX_PRINT_CODE:
436 inset.reset(new InsetPrintIndex(inscmd));
439 inset.reset(new InsetLabel(inscmd));
442 inset.reset(new InsetNomencl(inscmd));
444 case NOMENCL_PRINT_CODE:
445 inset.reset(new InsetPrintNomencl(inscmd));
448 if (!inscmd["name"].empty() || !inscmd["reference"].empty())
449 inset.reset(new InsetRef(inscmd, buf));
452 inset.reset(new InsetTOC(inscmd));
456 lyxerr << "unknown CommandInset '" << insetType
458 while (lex.isOK() && lex.getString() != "\\end_inset")
463 // FIXME This branch should be made to use inset codes as the preceding
464 // branch does. Unfortunately, that will take some doing. It requires
465 // converting the representation of the insets in LyX files so that they
466 // use the inset names listed in Inset.cpp. Then, as above, the inset names
467 // can be translated to inset codes using insetCode(). And the insets'
468 // write() routines should use insetName() rather than hardcoding it.
469 if (tmptok == "Quotes") {
470 inset.reset(new InsetQuotes);
471 } else if (tmptok == "External") {
472 inset.reset(new InsetExternal);
473 } else if (tmptok == "FormulaMacro") {
474 inset.reset(new MathMacroTemplate);
475 } else if (tmptok == "Formula") {
476 inset.reset(new InsetMathHull);
477 } else if (tmptok == "Graphics") {
478 inset.reset(new InsetGraphics);
479 } else if (tmptok == "Note") {
480 inset.reset(new InsetNote(buf.params(), tmptok));
481 } else if (tmptok == "Box") {
482 inset.reset(new InsetBox(buf.params(), tmptok));
483 } else if (tmptok == "Flex") {
485 string s = lex.getString();
486 inset.reset(new InsetFlex(buf.params(),
487 buf.params().textClassPtr(), s));
488 } else if (tmptok == "Branch") {
489 inset.reset(new InsetBranch(buf.params(),
490 InsetBranchParams()));
491 } else if (tmptok == "Environment") {
493 inset.reset(new InsetEnvironment(buf.params(), lex.getDocString()));
494 } else if (tmptok == "ERT") {
495 inset.reset(new InsetERT(buf.params()));
496 } else if (tmptok == "listings") {
497 inset.reset(new InsetListings(buf.params()));
498 } else if (tmptok == "InsetSpace") {
499 inset.reset(new InsetSpace);
500 } else if (tmptok == "Tabular") {
501 inset.reset(new InsetTabular(buf));
502 } else if (tmptok == "Text") {
503 inset.reset(new InsetText(buf.params()));
504 } else if (tmptok == "VSpace") {
505 inset.reset(new InsetVSpace);
506 } else if (tmptok == "Foot") {
507 inset.reset(new InsetFoot(buf.params()));
508 } else if (tmptok == "Marginal") {
509 inset.reset(new InsetMarginal(buf.params()));
510 } else if (tmptok == "OptArg") {
511 inset.reset(new InsetOptArg(buf.params()));
512 } else if (tmptok == "Float") {
514 string tmptok = lex.getString();
515 inset.reset(new InsetFloat(buf.params(), tmptok));
516 } else if (tmptok == "Wrap") {
518 string tmptok = lex.getString();
519 inset.reset(new InsetWrap(buf.params(), tmptok));
521 } else if (tmptok == "Theorem") {
522 inset.reset(new InsetList);
524 } else if (tmptok == "Caption") {
525 inset.reset(new InsetCaption(buf.params()));
526 } else if (tmptok == "Index") {
527 inset.reset(new InsetIndex(buf.params()));
528 } else if (tmptok == "FloatList") {
529 inset.reset(new InsetFloatList);
530 } else if (tmptok == "Info") {
531 inset.reset(new InsetInfo(buf.params()));
533 lyxerr << "unknown Inset type '" << tmptok
535 while (lex.isOK() && lex.getString() != "\\end_inset")
540 inset->read(buf, lex);
543 return inset.release();