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 "BufferView.h"
17 #include "bufferparams.h"
19 #include "FloatList.h"
20 #include "funcrequest.h"
23 #include "paragraph.h"
25 #include "insets/insetbibitem.h"
26 #include "insets/insetbibtex.h"
27 #include "insets/insetcaption.h"
28 #include "insets/insetcite.h"
29 #include "insets/insetcharstyle.h"
30 #include "insets/insetenv.h"
31 #include "insets/insetert.h"
32 #include "insets/insetexternal.h"
33 #include "insets/insetfloat.h"
34 #include "insets/insetfloatlist.h"
35 #include "insets/insetfoot.h"
36 #include "insets/insetgraphics.h"
37 #include "insets/insethfill.h"
38 #include "insets/insetinclude.h"
39 #include "insets/insetindex.h"
40 #include "insets/insetlabel.h"
41 #include "insets/insetline.h"
42 #include "insets/insetmarginal.h"
43 #include "insets/insetnote.h"
44 #include "insets/insetbox.h"
45 #include "insets/insetbranch.h"
46 #include "insets/insetoptarg.h"
47 #include "insets/insetpagebreak.h"
48 #include "insets/insetref.h"
49 #include "insets/insetspace.h"
50 #include "insets/insettabular.h"
51 #include "insets/insettoc.h"
52 #include "insets/inseturl.h"
53 #include "insets/insetvspace.h"
54 #include "insets/insetwrap.h"
56 #include "mathed/formulamacro.h"
57 #include "mathed/math_hullinset.h"
59 #include "frontends/Dialogs.h"
60 #include "frontends/LyXView.h"
62 #include "support/lstrings.h"
63 #include "support/std_sstream.h"
65 #include <boost/assert.hpp>
67 using lyx::support::compare_ascii_no_case;
74 InsetBase * createInset(BufferView * bv, FuncRequest const & cmd)
76 BufferParams const & params = bv->buffer()->params();
80 return new InsetHFill;
82 case LFUN_INSERT_LINE:
85 case LFUN_INSERT_PAGEBREAK:
86 return new InsetPagebreak;
88 case LFUN_INSERT_CHARSTYLE: {
89 string s = cmd.getArg(0);
90 CharStyles::iterator found_cs = params.getLyXTextClass().charstyle(s);
91 return new InsetCharStyle(params, found_cs);
94 case LFUN_INSERT_NOTE: {
95 string arg = cmd.getArg(0);
98 return new InsetNote(params, arg);
101 case LFUN_INSERT_BOX: {
102 string arg = cmd.getArg(0);
105 return new InsetBox(params, arg);
108 case LFUN_INSERT_BRANCH: {
109 string arg = cmd.getArg(0);
112 return new InsetBranch(params, InsetBranchParams(arg));
116 return new InsetERT(params);
118 case LFUN_INSET_FOOTNOTE:
119 return new InsetFoot(params);
121 case LFUN_INSET_MARGINAL:
122 return new InsetMarginal(params);
124 case LFUN_INSET_OPTARG:
125 return new InsetOptArg(params);
127 case LFUN_INSERT_BIBITEM:
128 return new InsetBibitem(InsetCommandParams("bibitem"));
130 case LFUN_INSET_FLOAT:
131 // check if the float type exists
132 if (params.getLyXTextClass().floats().typeExist(cmd.argument))
133 return new InsetFloat(params, cmd.argument);
134 lyxerr << "Non-existent float type: " << cmd.argument << endl;
137 case LFUN_INSET_WIDE_FLOAT:
138 // check if the float type exists
139 if (params.getLyXTextClass().floats().typeExist(cmd.argument)) {
140 auto_ptr<InsetFloat> p(new InsetFloat(params, cmd.argument));
141 p->wide(true, params);
144 lyxerr << "Non-existent float type: " << cmd.argument << endl;
147 case LFUN_INSET_WRAP:
148 if (cmd.argument == "figure")
149 return new InsetWrap(params, cmd.argument);
150 lyxerr << "Non-existent floatflt type: " << cmd.argument << endl;
153 case LFUN_INDEX_INSERT: {
154 // Try and generate a valid index entry.
155 InsetCommandParams icp("index");
156 string const contents = cmd.argument.empty() ?
157 bv->getLyXText()->getStringToIndex(bv->cursor()) :
159 icp.setContents(contents);
161 string data = InsetCommandMailer::params2string("index", icp);
162 LyXView * lv = bv->owner();
164 if (icp.getContents().empty()) {
165 lv->getDialogs().show("index", data, 0);
167 lv->dispatch(FuncRequest(LFUN_INSET_APPLY, data));
172 case LFUN_TABULAR_INSERT:
173 if (!cmd.argument.empty()) {
174 std::istringstream ss(cmd.argument);
179 return new InsetTabular(*bv->buffer(), r, c);
181 bv->owner()->getDialogs().show("tabularcreate");
184 case LFUN_INSET_CAPTION: {
185 UpdatableInset * up = bv->cursor().inset().asUpdatableInset();
187 auto_ptr<InsetCaption> inset(new InsetCaption(params));
188 inset->setAutoBreakRows(true);
189 inset->setDrawFrame(InsetText::LOCKED);
190 inset->setFrameColor(LColor::captionframe);
191 return inset.release();
196 case LFUN_INDEX_PRINT:
197 return new InsetPrintIndex(InsetCommandParams("printindex"));
199 case LFUN_TOC_INSERT:
200 return new InsetTOC(InsetCommandParams("tableofcontents"));
202 case LFUN_ENVIRONMENT_INSERT:
203 return new InsetEnvironment(params, cmd.argument);
206 case LFUN_INSET_LIST:
207 return new InsetList;
209 case LFUN_INSET_THEOREM:
210 return new InsetTheorem;
213 case LFUN_INSET_INSERT: {
214 string const name = cmd.getArg(0);
216 if (name == "bibitem") {
217 InsetCommandParams icp;
218 InsetCommandMailer::string2params(name, cmd.argument,
220 return new InsetBibitem(icp);
222 } else if (name == "bibtex") {
223 InsetCommandParams icp;
224 InsetCommandMailer::string2params(name, cmd.argument,
226 return new InsetBibtex(icp);
228 } else if (name == "citation") {
229 InsetCommandParams icp;
230 InsetCommandMailer::string2params(name, cmd.argument,
232 return new InsetCitation(icp);
234 } else if (name == "ert") {
235 InsetCollapsable::CollapseStatus st;
236 InsetERTMailer::string2params(cmd.argument, st);
237 return new InsetERT(params, st);
239 } else if (name == "external") {
240 Buffer const & buffer = *bv->buffer();
241 InsetExternalParams iep;
242 InsetExternalMailer::string2params(cmd.argument,
244 auto_ptr<InsetExternal> inset(new InsetExternal);
245 inset->setParams(iep, buffer);
246 return inset.release();
248 } else if (name == "graphics") {
249 Buffer const & buffer = *bv->buffer();
250 InsetGraphicsParams igp;
251 InsetGraphicsMailer::string2params(cmd.argument,
253 auto_ptr<InsetGraphics> inset(new InsetGraphics);
254 inset->setParams(igp);
255 return inset.release();
257 } else if (name == "include") {
258 InsetCommandParams iip;
259 InsetIncludeMailer::string2params(cmd.argument, iip);
260 return new InsetInclude(iip);
262 } else if (name == "index") {
263 InsetCommandParams icp;
264 InsetCommandMailer::string2params(name, cmd.argument,
266 return new InsetIndex(icp);
268 } else if (name == "label") {
269 InsetCommandParams icp;
270 InsetCommandMailer::string2params(name, cmd.argument,
272 return new InsetLabel(icp);
274 } else if (name == "ref") {
275 InsetCommandParams icp;
276 InsetCommandMailer::string2params(name, cmd.argument,
278 return new InsetRef(icp, *bv->buffer());
280 } else if (name == "toc") {
281 InsetCommandParams icp;
282 InsetCommandMailer::string2params(name, cmd.argument,
284 return new InsetTOC(icp);
286 } else if (name == "url") {
287 InsetCommandParams icp;
288 InsetCommandMailer::string2params(name, cmd.argument,
290 return new InsetUrl(icp);
292 } else if (name == "vspace") {
294 InsetVSpaceMailer::string2params(cmd.argument, vspace);
295 return new InsetVSpace(vspace);
299 case LFUN_SPACE_INSERT: {
300 string const name = cmd.argument;
301 if (name == "normal")
302 return new InsetSpace(InsetSpace::NORMAL);
303 else if (name == "protected")
304 return new InsetSpace(InsetSpace::PROTECTED);
305 else if (name == "thin")
306 return new InsetSpace(InsetSpace::THIN);
307 else if (name == "quad")
308 return new InsetSpace(InsetSpace::QUAD);
309 else if (name == "qquad")
310 return new InsetSpace(InsetSpace::QQUAD);
311 else if (name == "enspace")
312 return new InsetSpace(InsetSpace::ENSPACE);
313 else if (name == "enskip")
314 return new InsetSpace(InsetSpace::ENSKIP);
315 else if (name == "negthinspace")
316 return new InsetSpace(InsetSpace::NEGTHIN);
317 else if (name.empty())
318 lyxerr << "LyX function 'space' needs an argument." << endl;
320 lyxerr << "Wrong argument for LyX function 'space'." << endl;
333 InsetBase * readInset(LyXLex & lex, Buffer const & buf)
336 if (lex.getString() != "\\begin_inset") {
337 lyxerr << "Buffer::readInset: Consistency check failed."
341 auto_ptr<InsetBase> inset;
343 LyXTextClass tclass = buf.params().getLyXTextClass();
346 string tmptok = lex.getString();
348 // test the different insets
349 if (tmptok == "LatexCommand") {
350 InsetCommandParams inscmd;
353 string const cmdName = inscmd.getCmdName();
355 // This strange command allows LyX to recognize "natbib" style
356 // citations: citet, citep, Citet etc.
357 if (compare_ascii_no_case(cmdName.substr(0,4), "cite") == 0) {
358 inset.reset(new InsetCitation(inscmd));
359 } else if (cmdName == "bibitem") {
360 lex.printError("Wrong place for bibitem");
361 inset.reset(new InsetBibitem(inscmd));
362 } else if (cmdName == "bibtex") {
363 inset.reset(new InsetBibtex(inscmd));
364 } else if (cmdName == "index") {
365 inset.reset(new InsetIndex(inscmd));
366 } else if (cmdName == "include") {
367 inset.reset(new InsetInclude(inscmd));
368 } else if (cmdName == "label") {
369 inset.reset(new InsetLabel(inscmd));
370 } else if (cmdName == "url"
371 || cmdName == "htmlurl") {
372 inset.reset(new InsetUrl(inscmd));
373 } else if (cmdName == "ref"
374 || cmdName == "eqref"
375 || cmdName == "pageref"
377 || cmdName == "vpageref"
378 || cmdName == "prettyref") {
379 if (!inscmd.getOptions().empty()
380 || !inscmd.getContents().empty()) {
381 inset.reset(new InsetRef(inscmd, buf));
383 } else if (cmdName == "tableofcontents") {
384 inset.reset(new InsetTOC(inscmd));
385 } else if (cmdName == "listofalgorithms") {
386 inset.reset(new InsetFloatList("algorithm"));
387 } else if (cmdName == "listoffigures") {
388 inset.reset(new InsetFloatList("figure"));
389 } else if (cmdName == "listoftables") {
390 inset.reset(new InsetFloatList("table"));
391 } else if (cmdName == "printindex") {
392 inset.reset(new InsetPrintIndex(inscmd));
394 lyxerr << "unknown CommandInset '" << cmdName
396 while (lex.isOK() && lex.getString() != "\\end_inset")
401 if (tmptok == "Quotes") {
402 inset.reset(new InsetQuotes);
403 } else if (tmptok == "External") {
404 inset.reset(new InsetExternal);
405 } else if (tmptok == "FormulaMacro") {
406 inset.reset(new InsetFormulaMacro);
407 } else if (tmptok == "Formula") {
408 inset.reset(new MathHullInset);
409 } else if (tmptok == "Graphics") {
410 inset.reset(new InsetGraphics);
411 } else if (tmptok == "Note") {
412 inset.reset(new InsetNote(buf.params(), tmptok));
413 } else if (tmptok == "Box") {
414 inset.reset(new InsetBox(buf.params(), tmptok));
415 } else if (tmptok == "CharStyle") {
417 string s = lex.getString();
418 CharStyles::iterator found_cs = tclass.charstyle(s);
419 inset.reset(new InsetCharStyle(buf.params(), found_cs));
420 } else if (tmptok == "Branch") {
421 inset.reset(new InsetBranch(buf.params(),
422 InsetBranchParams()));
423 } else if (tmptok == "Include") {
424 InsetCommandParams p("Include");
425 inset.reset(new InsetInclude(p));
426 } else if (tmptok == "Environment") {
428 inset.reset(new InsetEnvironment(buf.params(), lex.getString()));
429 } else if (tmptok == "ERT") {
430 inset.reset(new InsetERT(buf.params()));
431 } else if (tmptok == "InsetSpace") {
432 inset.reset(new InsetSpace);
433 } else if (tmptok == "Tabular") {
434 inset.reset(new InsetTabular(buf));
435 } else if (tmptok == "Text") {
436 inset.reset(new InsetText(buf.params()));
437 } else if (tmptok == "VSpace") {
438 inset.reset(new InsetVSpace);
439 } else if (tmptok == "Foot") {
440 inset.reset(new InsetFoot(buf.params()));
441 } else if (tmptok == "Marginal") {
442 inset.reset(new InsetMarginal(buf.params()));
443 } else if (tmptok == "OptArg") {
444 inset.reset(new InsetOptArg(buf.params()));
445 } else if (tmptok == "Float") {
447 string tmptok = lex.getString();
448 inset.reset(new InsetFloat(buf.params(), tmptok));
449 } else if (tmptok == "Wrap") {
451 string tmptok = lex.getString();
452 inset.reset(new InsetWrap(buf.params(), tmptok));
454 } else if (tmptok == "List") {
455 inset.reset(new InsetList);
456 } else if (tmptok == "Theorem") {
457 inset.reset(new InsetList);
459 } else if (tmptok == "Caption") {
460 inset.reset(new InsetCaption(buf.params()));
461 } else if (tmptok == "FloatList") {
462 inset.reset(new InsetFloatList);
464 lyxerr << "unknown Inset type '" << tmptok
466 while (lex.isOK() && lex.getString() != "\\end_inset")
471 inset->read(buf, lex);
474 return inset.release();