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"
55 #include "mathed/formulamacro.h"
56 #include "mathed/formula.h"
58 #include "frontends/Dialogs.h"
59 #include "frontends/LyXView.h"
60 #include "support/lstrings.h"
61 #include "support/std_sstream.h"
63 #include <boost/assert.hpp>
65 using lyx::support::compare_ascii_no_case;
72 InsetOld * createInset(BufferView * bv, FuncRequest const & cmd)
74 BufferParams const & params = bv->buffer()->params();
78 return new InsetHFill;
80 case LFUN_INSERT_LINE:
83 case LFUN_INSERT_PAGEBREAK:
84 return new InsetPagebreak;
86 case LFUN_INSERT_CHARSTYLE: {
87 string s = cmd.getArg(0);
88 CharStyles::iterator found_cs = params.getLyXTextClass().charstyle(s);
89 return new InsetCharStyle(params, found_cs);
92 case LFUN_INSERT_NOTE: {
93 string arg = cmd.getArg(0);
96 return new InsetNote(params, arg);
99 case LFUN_INSERT_BOX: {
100 string arg = cmd.getArg(0);
103 return new InsetBox(params, arg);
106 case LFUN_INSERT_BRANCH: {
107 string arg = cmd.getArg(0);
110 return new InsetBranch(params, InsetBranchParams(arg));
114 return new InsetERT(params);
116 case LFUN_INSET_FOOTNOTE:
117 return new InsetFoot(params);
119 case LFUN_INSET_MARGINAL:
120 return new InsetMarginal(params);
122 case LFUN_INSET_OPTARG:
123 return new InsetOptArg(params);
125 case LFUN_INSERT_BIBITEM:
126 return new InsetBibitem(InsetCommandParams("bibitem"));
128 case LFUN_INSET_FLOAT:
129 // check if the float type exists
130 if (params.getLyXTextClass().floats().typeExist(cmd.argument))
131 return new InsetFloat(params, cmd.argument);
132 lyxerr << "Non-existent float type: " << cmd.argument << endl;
135 case LFUN_INSET_WIDE_FLOAT:
136 // check if the float type exists
137 if (params.getLyXTextClass().floats().typeExist(cmd.argument)) {
138 auto_ptr<InsetFloat> p(new InsetFloat(params, cmd.argument));
139 p->wide(true, params);
142 lyxerr << "Non-existent float type: " << cmd.argument << endl;
145 case LFUN_INSET_WRAP:
146 if (cmd.argument == "figure")
147 return new InsetWrap(params, cmd.argument);
148 lyxerr << "Non-existent floatflt type: " << cmd.argument << endl;
151 case LFUN_INDEX_INSERT: {
152 // Try and generate a valid index entry.
153 InsetCommandParams icp("index");
154 string const contents = cmd.argument.empty() ?
155 bv->getLyXText()->getStringToIndex() :
157 icp.setContents(contents);
159 string data = InsetCommandMailer::params2string("index", icp);
160 LyXView * lv = bv->owner();
162 if (icp.getContents().empty()) {
163 lv->getDialogs().show("index", data, 0);
165 lv->dispatch(FuncRequest(LFUN_INSET_APPLY, data));
170 case LFUN_TABULAR_INSERT:
171 if (!cmd.argument.empty()) {
172 std::istringstream ss(cmd.argument);
177 return new InsetTabular(*bv->buffer(), r, c);
179 bv->owner()->getDialogs().show("tabularcreate");
182 case LFUN_INSET_CAPTION:
183 if (!bv->innerInset()) {
184 auto_ptr<InsetCaption> inset(new InsetCaption(params));
185 inset->setOwner(bv->innerInset());
186 inset->setAutoBreakRows(true);
187 inset->setDrawFrame(InsetText::LOCKED);
188 inset->setFrameColor(LColor::captionframe);
189 return inset.release();
193 case LFUN_INDEX_PRINT:
194 return new InsetPrintIndex(InsetCommandParams("printindex"));
196 case LFUN_TOC_INSERT:
197 return new InsetTOC(InsetCommandParams("tableofcontents"));
199 case LFUN_ENVIRONMENT_INSERT:
200 return new InsetEnvironment(params, cmd.argument);
203 case LFUN_INSET_LIST:
204 return new InsetList;
206 case LFUN_INSET_THEOREM:
207 return new InsetTheorem;
210 case LFUN_INSET_INSERT: {
211 string const name = cmd.getArg(0);
213 if (name == "bibitem") {
214 InsetCommandParams icp;
215 InsetCommandMailer::string2params(name, cmd.argument,
217 return new InsetBibitem(icp);
219 } else if (name == "bibtex") {
220 InsetCommandParams icp;
221 InsetCommandMailer::string2params(name, cmd.argument,
223 return new InsetBibtex(icp);
225 } else if (name == "citation") {
226 InsetCommandParams icp;
227 InsetCommandMailer::string2params(name, cmd.argument,
229 return new InsetCitation(icp);
231 } else if (name == "ert") {
232 InsetCollapsable::CollapseStatus st;
233 InsetERTMailer::string2params(cmd.argument, st);
234 return new InsetERT(params, st);
236 } else if (name == "external") {
237 Buffer const & buffer = *bv->buffer();
238 InsetExternalParams iep;
239 InsetExternalMailer::string2params(cmd.argument,
241 auto_ptr<InsetExternal> inset(new InsetExternal);
242 inset->setParams(iep, buffer);
243 return inset.release();
245 } else if (name == "graphics") {
246 Buffer const & buffer = *bv->buffer();
247 InsetGraphicsParams igp;
248 InsetGraphicsMailer::string2params(cmd.argument,
250 auto_ptr<InsetGraphics> inset(new InsetGraphics);
251 inset->setParams(igp);
252 return inset.release();
254 } else if (name == "include") {
255 InsetCommandParams iip;
256 InsetIncludeMailer::string2params(cmd.argument, iip);
257 return new InsetInclude(iip);
259 } else if (name == "index") {
260 InsetCommandParams icp;
261 InsetCommandMailer::string2params(name, cmd.argument,
263 return new InsetIndex(icp);
265 } else if (name == "label") {
266 InsetCommandParams icp;
267 InsetCommandMailer::string2params(name, cmd.argument,
269 return new InsetLabel(icp);
271 } else if (name == "ref") {
272 InsetCommandParams icp;
273 InsetCommandMailer::string2params(name, cmd.argument,
275 return new InsetRef(icp, *bv->buffer());
277 } else if (name == "toc") {
278 InsetCommandParams icp;
279 InsetCommandMailer::string2params(name, cmd.argument,
281 return new InsetTOC(icp);
283 } else if (name == "url") {
284 InsetCommandParams icp;
285 InsetCommandMailer::string2params(name, cmd.argument,
287 return new InsetUrl(icp);
289 } else if (name == "vspace") {
291 InsetVSpaceMailer::string2params(cmd.argument, vspace);
292 return new InsetVSpace(vspace);
296 case LFUN_SPACE_INSERT: {
297 string const name = cmd.argument;
298 if (name == "normal")
299 return new InsetSpace(InsetSpace::NORMAL);
300 else if (name == "protected")
301 return new InsetSpace(InsetSpace::PROTECTED);
302 else if (name == "thin")
303 return new InsetSpace(InsetSpace::THIN);
304 else if (name == "quad")
305 return new InsetSpace(InsetSpace::QUAD);
306 else if (name == "qquad")
307 return new InsetSpace(InsetSpace::QQUAD);
308 else if (name == "enspace")
309 return new InsetSpace(InsetSpace::ENSPACE);
310 else if (name == "enskip")
311 return new InsetSpace(InsetSpace::ENSKIP);
312 else if (name == "negthinspace")
313 return new InsetSpace(InsetSpace::NEGTHIN);
314 else if (name.empty())
315 lyxerr << "LyX function 'space' needs an argument." << endl;
317 lyxerr << "Wrong argument for LyX function 'space'." << endl;
330 InsetOld * readInset(LyXLex & lex, Buffer const & buf)
333 if (lex.getString() != "\\begin_inset") {
334 lyxerr << "Buffer::readInset: Consistency check failed."
338 auto_ptr<InsetOld> inset;
340 LyXTextClass tclass = buf.params().getLyXTextClass();
343 string tmptok = lex.getString();
345 // test the different insets
346 if (tmptok == "LatexCommand") {
347 InsetCommandParams inscmd;
350 string const cmdName = inscmd.getCmdName();
352 // This strange command allows LyX to recognize "natbib" style
353 // citations: citet, citep, Citet etc.
354 if (compare_ascii_no_case(cmdName.substr(0,4), "cite") == 0) {
355 inset.reset(new InsetCitation(inscmd));
356 } else if (cmdName == "bibitem") {
357 lex.printError("Wrong place for bibitem");
358 inset.reset(new InsetBibitem(inscmd));
359 } else if (cmdName == "bibtex") {
360 inset.reset(new InsetBibtex(inscmd));
361 } else if (cmdName == "index") {
362 inset.reset(new InsetIndex(inscmd));
363 } else if (cmdName == "include") {
364 inset.reset(new InsetInclude(inscmd));
365 } else if (cmdName == "label") {
366 inset.reset(new InsetLabel(inscmd));
367 } else if (cmdName == "url"
368 || cmdName == "htmlurl") {
369 inset.reset(new InsetUrl(inscmd));
370 } else if (cmdName == "ref"
371 || cmdName == "eqref"
372 || cmdName == "pageref"
374 || cmdName == "vpageref"
375 || cmdName == "prettyref") {
376 if (!inscmd.getOptions().empty()
377 || !inscmd.getContents().empty()) {
378 inset.reset(new InsetRef(inscmd, buf));
380 } else if (cmdName == "tableofcontents") {
381 inset.reset(new InsetTOC(inscmd));
382 } else if (cmdName == "listofalgorithms") {
383 inset.reset(new InsetFloatList("algorithm"));
384 } else if (cmdName == "listoffigures") {
385 inset.reset(new InsetFloatList("figure"));
386 } else if (cmdName == "listoftables") {
387 inset.reset(new InsetFloatList("table"));
388 } else if (cmdName == "printindex") {
389 inset.reset(new InsetPrintIndex(inscmd));
391 lyxerr << "unknown CommandInset '" << cmdName
393 while (lex.isOK() && lex.getString() != "\\end_inset")
398 if (tmptok == "Quotes") {
399 inset.reset(new InsetQuotes);
400 } else if (tmptok == "External") {
401 inset.reset(new InsetExternal);
402 } else if (tmptok == "FormulaMacro") {
403 inset.reset(new InsetFormulaMacro);
404 } else if (tmptok == "Formula") {
405 inset.reset(new InsetFormula);
406 } else if (tmptok == "Graphics") {
407 inset.reset(new InsetGraphics);
408 } else if (tmptok == "Note") {
409 inset.reset(new InsetNote(buf.params(), tmptok));
410 } else if (tmptok == "Box") {
411 inset.reset(new InsetBox(buf.params(), tmptok));
412 } else if (tmptok == "CharStyle") {
414 string s = lex.getString();
415 CharStyles::iterator found_cs = tclass.charstyle(s);
416 inset.reset(new InsetCharStyle(buf.params(), found_cs));
417 } else if (tmptok == "Branch") {
418 inset.reset(new InsetBranch(buf.params(),
419 InsetBranchParams()));
420 } else if (tmptok == "Include") {
421 InsetCommandParams p("Include");
422 inset.reset(new InsetInclude(p));
423 } else if (tmptok == "Environment") {
425 inset.reset(new InsetEnvironment(buf.params(), lex.getString()));
426 } else if (tmptok == "ERT") {
427 inset.reset(new InsetERT(buf.params()));
428 } else if (tmptok == "InsetSpace") {
429 inset.reset(new InsetSpace);
430 } else if (tmptok == "Tabular") {
431 inset.reset(new InsetTabular(buf));
432 } else if (tmptok == "Text") {
433 inset.reset(new InsetText(buf.params()));
434 } else if (tmptok == "VSpace") {
435 inset.reset(new InsetVSpace);
436 } else if (tmptok == "Foot") {
437 inset.reset(new InsetFoot(buf.params()));
438 } else if (tmptok == "Marginal") {
439 inset.reset(new InsetMarginal(buf.params()));
440 } else if (tmptok == "OptArg") {
441 inset.reset(new InsetOptArg(buf.params()));
442 } else if (tmptok == "Float") {
444 string tmptok = lex.getString();
445 inset.reset(new InsetFloat(buf.params(), tmptok));
446 } else if (tmptok == "Wrap") {
448 string tmptok = lex.getString();
449 inset.reset(new InsetWrap(buf.params(), tmptok));
451 } else if (tmptok == "List") {
452 inset.reset(new InsetList);
453 } else if (tmptok == "Theorem") {
454 inset.reset(new InsetList);
456 } else if (tmptok == "Caption") {
457 inset.reset(new InsetCaption(buf.params()));
458 } else if (tmptok == "FloatList") {
459 inset.reset(new InsetFloatList);
461 lyxerr << "unknown Inset type '" << tmptok
463 while (lex.isOK() && lex.getString() != "\\end_inset")
468 inset->read(buf, lex);
471 return inset.release();