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(FuncRequest const & cmd)
74 BufferView * bv = cmd.view();
75 BufferParams const & params = bv->buffer()->params();
79 return new InsetHFill;
81 case LFUN_INSERT_LINE:
84 case LFUN_INSERT_PAGEBREAK:
85 return new InsetPagebreak;
87 case LFUN_INSET_MINIPAGE:
88 return new InsetBox(params, "Frameless");
90 case LFUN_INSERT_CHARSTYLE: {
91 string s = cmd.getArg(0);
92 CharStyles::iterator found_cs = params.getLyXTextClass().charstyle(s);
93 return new InsetCharStyle(params, found_cs);
96 case LFUN_INSERT_NOTE: {
97 string arg = cmd.getArg(0);
100 return new InsetNote(params, arg);
103 case LFUN_INSERT_BOX: {
104 string arg = cmd.getArg(0);
107 return new InsetBox(params, arg);
110 case LFUN_INSERT_BRANCH: {
111 string arg = cmd.getArg(0);
114 return new InsetBranch(params, arg);
118 return new InsetERT(params);
120 case LFUN_INSET_FOOTNOTE:
121 return new InsetFoot(params);
123 case LFUN_INSET_MARGINAL:
124 return new InsetMarginal(params);
126 case LFUN_INSET_OPTARG:
127 return new InsetOptArg(params);
129 case LFUN_INSERT_BIBITEM:
130 return new InsetBibitem(InsetCommandParams("bibitem"));
132 case LFUN_INSET_FLOAT:
133 // check if the float type exists
134 if (params.getLyXTextClass().floats().typeExist(cmd.argument))
135 return new InsetFloat(params, cmd.argument);
136 lyxerr << "Non-existent float type: " << cmd.argument << endl;
139 case LFUN_INSET_WIDE_FLOAT:
140 // check if the float type exists
141 if (params.getLyXTextClass().floats().typeExist(cmd.argument)) {
142 auto_ptr<InsetFloat> p(new InsetFloat(params, cmd.argument));
143 p->wide(true, params);
146 lyxerr << "Non-existent float type: " << cmd.argument << endl;
149 case LFUN_INSET_WRAP:
150 if (cmd.argument == "figure")
151 return new InsetWrap(params, cmd.argument);
152 lyxerr << "Non-existent floatflt type: " << cmd.argument << endl;
155 case LFUN_INDEX_INSERT: {
156 // Try and generate a valid index entry.
157 InsetCommandParams icp("index");
158 string const contents = cmd.argument.empty() ?
159 bv->getLyXText()->getStringToIndex() :
161 icp.setContents(contents);
163 string data = InsetCommandMailer::params2string("index", icp);
164 LyXView * lv = bv->owner();
166 if (icp.getContents().empty()) {
167 lv->getDialogs().show("index", data, 0);
169 lv->dispatch(FuncRequest(bv, LFUN_INSET_APPLY, data));
174 case LFUN_TABULAR_INSERT:
175 if (!cmd.argument.empty()) {
176 std::istringstream ss(cmd.argument);
181 return new InsetTabular(*bv->buffer(), r, c);
183 bv->owner()->getDialogs().show("tabularcreate");
186 case LFUN_INSET_CAPTION:
187 if (!bv->innerInset()) {
188 auto_ptr<InsetCaption> inset(new InsetCaption(params));
189 inset->setOwner(bv->innerInset());
190 inset->setAutoBreakRows(true);
191 inset->setDrawFrame(InsetText::LOCKED);
192 inset->setFrameColor(LColor::captionframe);
193 return inset.release();
197 case LFUN_INDEX_PRINT:
198 return new InsetPrintIndex(InsetCommandParams("printindex"));
200 case LFUN_TOC_INSERT:
201 return new InsetTOC(InsetCommandParams("tableofcontents"));
203 case LFUN_ENVIRONMENT_INSERT:
204 return new InsetEnvironment(params, cmd.argument);
207 case LFUN_INSET_LIST:
208 return new InsetList;
210 case LFUN_INSET_THEOREM:
211 return new InsetTheorem;
214 case LFUN_INSET_INSERT: {
215 string const name = cmd.getArg(0);
217 if (name == "bibitem") {
218 InsetCommandParams icp;
219 InsetCommandMailer::string2params(name, cmd.argument,
221 return new InsetBibitem(icp);
223 } else if (name == "bibtex") {
224 InsetCommandParams icp;
225 InsetCommandMailer::string2params(name, cmd.argument,
227 return new InsetBibtex(icp);
229 } else if (name == "citation") {
230 InsetCommandParams icp;
231 InsetCommandMailer::string2params(name, cmd.argument,
233 return new InsetCitation(icp);
235 } else if (name == "ert") {
236 InsetCollapsable::CollapseStatus st;
237 InsetERTMailer::string2params(cmd.argument, st);
238 return new InsetERT(params, st);
240 } else if (name == "external") {
241 Buffer const & buffer = *cmd.view()->buffer();
242 InsetExternalParams iep;
243 InsetExternalMailer::string2params(cmd.argument,
245 auto_ptr<InsetExternal> inset(new InsetExternal);
246 inset->setParams(iep, buffer);
247 return inset.release();
249 } else if (name == "graphics") {
250 Buffer const & buffer = *cmd.view()->buffer();
251 InsetGraphicsParams igp;
252 InsetGraphicsMailer::string2params(cmd.argument,
254 auto_ptr<InsetGraphics> inset(new InsetGraphics);
255 inset->setParams(igp);
256 return inset.release();
258 } else if (name == "include") {
259 InsetCommandParams iip;
260 InsetIncludeMailer::string2params(cmd.argument, iip);
261 return new InsetInclude(iip);
263 } else if (name == "index") {
264 InsetCommandParams icp;
265 InsetCommandMailer::string2params(name, cmd.argument,
267 return new InsetIndex(icp);
269 } else if (name == "label") {
270 InsetCommandParams icp;
271 InsetCommandMailer::string2params(name, cmd.argument,
273 return new InsetLabel(icp);
275 } else if (name == "ref") {
276 InsetCommandParams icp;
277 InsetCommandMailer::string2params(name, cmd.argument,
279 return new InsetRef(icp, *bv->buffer());
281 } else if (name == "toc") {
282 InsetCommandParams icp;
283 InsetCommandMailer::string2params(name, cmd.argument,
285 return new InsetTOC(icp);
287 } else if (name == "url") {
288 InsetCommandParams icp;
289 InsetCommandMailer::string2params(name, cmd.argument,
291 return new InsetUrl(icp);
293 } else if (name == "vspace") {
295 InsetVSpaceMailer::string2params(cmd.argument, vspace);
296 return new InsetVSpace(vspace);
300 case LFUN_SPACE_INSERT: {
301 string const name = cmd.argument;
302 if (name == "normal")
303 return new InsetSpace(InsetSpace::NORMAL);
304 else if (name == "protected")
305 return new InsetSpace(InsetSpace::PROTECTED);
306 else if (name == "thin")
307 return new InsetSpace(InsetSpace::THIN);
308 else if (name == "quad")
309 return new InsetSpace(InsetSpace::QUAD);
310 else if (name == "qquad")
311 return new InsetSpace(InsetSpace::QQUAD);
312 else if (name == "enspace")
313 return new InsetSpace(InsetSpace::ENSPACE);
314 else if (name == "enskip")
315 return new InsetSpace(InsetSpace::ENSKIP);
316 else if (name == "negthinspace")
317 return new InsetSpace(InsetSpace::NEGTHIN);
318 else if (name.empty())
319 lyxerr << "LyX function 'space' needs an argument." << endl;
321 lyxerr << "Wrong argument for LyX function 'space'." << endl;
334 InsetOld * readInset(LyXLex & lex, Buffer const & buf)
337 if (lex.getString() != "\\begin_inset") {
338 lyxerr << "Buffer::readInset: Consistency check failed."
342 auto_ptr<InsetOld> inset;
344 LyXTextClass tclass = buf.params().getLyXTextClass();
347 string tmptok = lex.getString();
349 // test the different insets
350 if (tmptok == "LatexCommand") {
351 InsetCommandParams inscmd;
354 string const cmdName = inscmd.getCmdName();
356 // This strange command allows LyX to recognize "natbib" style
357 // citations: citet, citep, Citet etc.
358 if (compare_ascii_no_case(cmdName.substr(0,4), "cite") == 0) {
359 inset.reset(new InsetCitation(inscmd));
360 } else if (cmdName == "bibitem") {
361 lex.printError("Wrong place for bibitem");
362 inset.reset(new InsetBibitem(inscmd));
363 } else if (cmdName == "bibtex") {
364 inset.reset(new InsetBibtex(inscmd));
365 } else if (cmdName == "index") {
366 inset.reset(new InsetIndex(inscmd));
367 } else if (cmdName == "include") {
368 inset.reset(new InsetInclude(inscmd));
369 } else if (cmdName == "label") {
370 inset.reset(new InsetLabel(inscmd));
371 } else if (cmdName == "url"
372 || cmdName == "htmlurl") {
373 inset.reset(new InsetUrl(inscmd));
374 } else if (cmdName == "ref"
375 || cmdName == "eqref"
376 || cmdName == "pageref"
378 || cmdName == "vpageref"
379 || cmdName == "prettyref") {
380 if (!inscmd.getOptions().empty()
381 || !inscmd.getContents().empty()) {
382 inset.reset(new InsetRef(inscmd, buf));
384 } else if (cmdName == "tableofcontents") {
385 inset.reset(new InsetTOC(inscmd));
386 } else if (cmdName == "listofalgorithms") {
387 inset.reset(new InsetFloatList("algorithm"));
388 } else if (cmdName == "listoffigures") {
389 inset.reset(new InsetFloatList("figure"));
390 } else if (cmdName == "listoftables") {
391 inset.reset(new InsetFloatList("table"));
392 } else if (cmdName == "printindex") {
393 inset.reset(new InsetPrintIndex(inscmd));
395 lyxerr << "unknown CommandInset '" << cmdName
397 while (lex.isOK() && lex.getString() != "\\end_inset")
402 if (tmptok == "Quotes") {
403 inset.reset(new InsetQuotes);
404 } else if (tmptok == "External") {
405 inset.reset(new InsetExternal);
406 } else if (tmptok == "FormulaMacro") {
407 inset.reset(new InsetFormulaMacro);
408 } else if (tmptok == "Formula") {
409 inset.reset(new InsetFormula);
410 } else if (tmptok == "Graphics") {
411 inset.reset(new InsetGraphics);
412 } else if (tmptok == "Note") {
413 inset.reset(new InsetNote(buf.params(), tmptok));
414 } else if (tmptok == "Box") {
415 inset.reset(new InsetBox(buf.params(), tmptok));
416 } else if (tmptok == "CharStyle") {
418 string s = lex.getString();
419 CharStyles::iterator found_cs = tclass.charstyle(s);
420 inset.reset(new InsetCharStyle(buf.params(), found_cs));
421 } else if (tmptok == "Branch") {
422 inset.reset(new InsetBranch(buf.params(), string()));
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 == "Minipage") {
446 inset.reset(new InsetBox(buf.params(), "Frameless"));
447 } else if (tmptok == "Float") {
449 string tmptok = lex.getString();
450 inset.reset(new InsetFloat(buf.params(), tmptok));
451 } else if (tmptok == "Wrap") {
453 string tmptok = lex.getString();
454 inset.reset(new InsetWrap(buf.params(), tmptok));
456 } else if (tmptok == "List") {
457 inset.reset(new InsetList);
458 } else if (tmptok == "Theorem") {
459 inset.reset(new InsetList);
461 } else if (tmptok == "Caption") {
462 inset.reset(new InsetCaption(buf.params()));
463 } else if (tmptok == "FloatList") {
464 inset.reset(new InsetFloatList);
466 lyxerr << "unknown Inset type '" << tmptok
468 while (lex.isOK() && lex.getString() != "\\end_inset")
473 inset->read(buf, lex);
476 return inset.release();