src/factory.C

   1 /**
   2  * \file factory.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author André Pönitz
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "factory.h"
  14
  15 #include "buffer.h"
  16 #include "BufferView.h"
  17 #include "bufferparams.h"
  18 #include "debug.h"
  19 #include "FloatList.h"
  20 #include "funcrequest.h"
  21 #include "LColor.h"
  22 #include "lyxlex.h"
  23 #include "paragraph.h"
  24
  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
  56 #include "mathed/MathMacroTemplate.h"
  57 #include "mathed/InsetMathHull.h"
  58
  59 #include "support/lstrings.h"
  60
  61 #include <boost/assert.hpp>
  62 #include <boost/current_function.hpp>
  63
  64 #include <sstream>
  65
  66 using lyx::support::compare_ascii_no_case;
  67
  68 using std::auto_ptr;
  69 using std::endl;
  70 using std::string;
  71
  72
  73 InsetBase * createInset(BufferView * bv, FuncRequest const & cmd)
  74 {
  75         BufferParams const & params = bv->buffer()->params();
  76
  77         switch (cmd.action) {
  78         case LFUN_HFILL_INSERT:
  79                 return new InsetHFill;
  80
  81         case LFUN_LINE_INSERT:
  82                 return new InsetLine;
  83
  84         case LFUN_PAGEBREAK_INSERT:
  85                 return new InsetPagebreak;
  86
  87         case LFUN_CHARSTYLE_INSERT: {
  88                 string s = cmd.getArg(0);
  89                 LyXTextClass tclass = params.getLyXTextClass();
  90                 CharStyles::iterator found_cs = tclass.charstyle(s);
  91                 if (found_cs != tclass.charstyles().end())
  92                         return new InsetCharStyle(params, found_cs);
  93                 else
  94                         return new InsetCharStyle(params, s);
  95         }
  96
  97         case LFUN_NOTE_INSERT: {
  98                 string arg = cmd.getArg(0);
  99                 if (arg.empty())
 100                         arg = "Note";
 101                 return new InsetNote(params, arg);
 102         }
 103
 104         case LFUN_BOX_INSERT: {
 105                 string arg = cmd.getArg(0);
 106                 if (arg.empty())
 107                         arg = "Boxed";
 108                 return new InsetBox(params, arg);
 109         }
 110
 111         case LFUN_BRANCH_INSERT: {
 112                 string arg = cmd.getArg(0);
 113                 if (arg.empty())
 114                         arg = "none";
 115                 return new InsetBranch(params, InsetBranchParams(arg));
 116         }
 117
 118         case LFUN_ERT_INSERT:
 119                 return new InsetERT(params);
 120
 121         case LFUN_FOOTNOTE_INSERT:
 122                 return new InsetFoot(params);
 123
 124         case LFUN_MARGINALNOTE_INSERT:
 125                 return new InsetMarginal(params);
 126
 127         case LFUN_OPTIONAL_INSERT:
 128                 return new InsetOptArg(params);
 129
 130         case LFUN_BIBITEM_INSERT:
 131                 return new InsetBibitem(InsetCommandParams("bibitem"));
 132
 133         case LFUN_FLOAT_INSERT: {
 134                 // check if the float type exists
 135                 string const argument = lyx::to_utf8(cmd.argument());
 136                 if (params.getLyXTextClass().floats().typeExist(argument))
 137                         return new InsetFloat(params, argument);
 138                 lyxerr << "Non-existent float type: " << argument << endl;
 139                 return 0;
 140         }
 141
 142         case LFUN_FLOAT_WIDE_INSERT: {
 143                 // check if the float type exists
 144                 string const argument = lyx::to_utf8(cmd.argument());
 145                 if (params.getLyXTextClass().floats().typeExist(argument)) {
 146                         auto_ptr<InsetFloat> p(new InsetFloat(params, argument));
 147                         p->wide(true, params);
 148                         return p.release();
 149                 }
 150                 lyxerr << "Non-existent float type: " << argument << endl;
 151                 return 0;
 152         }
 153
 154         case LFUN_WRAP_INSERT: {
 155                 string const argument = lyx::to_utf8(cmd.argument());
 156                 if (argument == "figure")
 157                         return new InsetWrap(params, argument);
 158                 lyxerr << "Non-existent floatflt type: " << argument << endl;
 159                 return 0;
 160         }
 161
 162         case LFUN_INDEX_INSERT: {
 163                 // Try and generate a valid index entry.
 164                 InsetCommandParams icp("index");
 165                 string const contents = cmd.argument().empty() ?
 166                         bv->getLyXText()->getStringToIndex(bv->cursor()) :
 167                         lyx::to_utf8(cmd.argument());
 168                 icp.setContents(contents);
 169                 return new InsetIndex(icp);
 170         }
 171
 172         case LFUN_TABULAR_INSERT: {
 173                 if (cmd.argument().empty())
 174                         return 0;
 175                 std::istringstream ss(lyx::to_utf8(cmd.argument()));
 176                 int r = 0, c = 0;
 177                 ss >> r >> c;
 178                 if (r <= 0)
 179                         r = 2;
 180                 if (c <= 0)
 181                         c = 2;
 182                 return new InsetTabular(*bv->buffer(), r, c);
 183         }
 184
 185         case LFUN_CAPTION_INSERT: {
 186                 auto_ptr<InsetCaption> inset(new InsetCaption(params));
 187                 inset->setAutoBreakRows(true);
 188                 inset->setDrawFrame(true);
 189                 inset->setFrameColor(LColor::captionframe);
 190                 return inset.release();
 191         }
 192
 193         case LFUN_INDEX_PRINT:
 194                 return new InsetPrintIndex(InsetCommandParams("printindex"));
 195
 196         case LFUN_TOC_INSERT:
 197                 return new InsetTOC(InsetCommandParams("tableofcontents"));
 198
 199         case LFUN_ENVIRONMENT_INSERT:
 200                 return new InsetEnvironment(params, lyx::to_utf8(cmd.argument()));
 201
 202 #if 0
 203         case LFUN_LIST_INSERT:
 204                 return new InsetList;
 205
 206         case LFUN_THEOREM_INSERT:
 207                 return new InsetTheorem;
 208 #endif
 209
 210         case LFUN_INSET_INSERT: {
 211                 string const name = cmd.getArg(0);
 212
 213                 if (name == "bibitem") {
 214                         InsetCommandParams icp(name);
 215                         InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()),
 216                                                           icp);
 217                         return new InsetBibitem(icp);
 218
 219                 } else if (name == "bibtex") {
 220                         InsetCommandParams icp(name);
 221                         InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()),
 222                                                           icp);
 223                         return new InsetBibtex(icp);
 224
 225                 } else if (name == "citation") {
 226                         InsetCommandParams icp("cite");
 227                         InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()),
 228                                                           icp);
 229                         return new InsetCitation(icp);
 230
 231                 } else if (name == "ert") {
 232                         InsetCollapsable::CollapseStatus st;
 233                         InsetERTMailer::string2params(lyx::to_utf8(cmd.argument()), st);
 234                         return new InsetERT(params, st);
 235
 236                 } else if (name == "external") {
 237                         Buffer const & buffer = *bv->buffer();
 238                         InsetExternalParams iep;
 239                         InsetExternalMailer::string2params(lyx::to_utf8(cmd.argument()),
 240                                                            buffer, iep);
 241                         auto_ptr<InsetExternal> inset(new InsetExternal);
 242                         inset->setParams(iep, buffer);
 243                         return inset.release();
 244
 245                 } else if (name == "graphics") {
 246                         Buffer const & buffer = *bv->buffer();
 247                         InsetGraphicsParams igp;
 248                         InsetGraphicsMailer::string2params(lyx::to_utf8(cmd.argument()),
 249                                                            buffer, igp);
 250                         auto_ptr<InsetGraphics> inset(new InsetGraphics);
 251                         inset->setParams(igp);
 252                         return inset.release();
 253
 254                 } else if (name == "include") {
 255                         InsetCommandParams iip(name);
 256                         InsetIncludeMailer::string2params(lyx::to_utf8(cmd.argument()), iip);
 257                         return new InsetInclude(iip);
 258
 259                 } else if (name == "index") {
 260                         InsetCommandParams icp(name);
 261                         InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()),
 262                                                           icp);
 263                         return new InsetIndex(icp);
 264
 265                 } else if (name == "label") {
 266                         InsetCommandParams icp(name);
 267                         InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()),
 268                                                           icp);
 269                         return new InsetLabel(icp);
 270
 271                 } else if (name == "ref") {
 272                         InsetCommandParams icp(name);
 273                         InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()),
 274                                                           icp);
 275                         return new InsetRef(icp, *bv->buffer());
 276
 277                 } else if (name == "toc") {
 278                         InsetCommandParams icp("tableofcontents");
 279                         InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()),
 280                                                           icp);
 281                         return new InsetTOC(icp);
 282
 283                 } else if (name == "url") {
 284                         InsetCommandParams icp(name);
 285                         InsetCommandMailer::string2params(name, lyx::to_utf8(cmd.argument()),
 286                                                           icp);
 287                         return new InsetUrl(icp);
 288
 289                 } else if (name == "vspace") {
 290                         VSpace vspace;
 291                         InsetVSpaceMailer::string2params(lyx::to_utf8(cmd.argument()), vspace);
 292                         return new InsetVSpace(vspace);
 293                 }
 294         }
 295
 296         case LFUN_SPACE_INSERT: {
 297                 string const name = lyx::to_utf8(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;
 316                 else
 317                         lyxerr << "Wrong argument for LyX function 'space'." << endl;
 318         }
 319
 320         break;
 321
 322         default:
 323                 break;
 324         }
 325
 326         return 0;
 327 }
 328
 329
 330 InsetBase * readInset(LyXLex & lex, Buffer const & buf)
 331 {
 332         // consistency check
 333         if (lex.getString() != "\\begin_inset") {
 334                 lyxerr << "Buffer::readInset: Consistency check failed."
 335                        << endl;
 336         }
 337
 338         auto_ptr<InsetBase> inset;
 339
 340         LyXTextClass tclass = buf.params().getLyXTextClass();
 341
 342         lex.next();
 343         string tmptok = lex.getString();
 344
 345         // test the different insets
 346         if (tmptok == "LatexCommand") {
 347                 lex.next();
 348                 string const cmdName = lex.getString();
 349                 lex.pushToken(cmdName);
 350
 351                 InsetCommandParams inscmd(cmdName);
 352                 inscmd.read(lex);
 353
 354                 // This strange command allows LyX to recognize "natbib" style
 355                 // citations: citet, citep, Citet etc.
 356                 // FIXME: We already have partial support for \\fullcite and
 357                 // the various \\footcite commands. We should increase the
 358                 // file format number and read these commands here, too.
 359                 // Then we should use is_possible_cite_command() in
 360                 // src/frontends/controllers/biblio.C to test for valid cite
 361                 // commands.
 362                 if (compare_ascii_no_case(cmdName.substr(0,4), "cite") == 0) {
 363                         inset.reset(new InsetCitation(inscmd));
 364                 } else if (cmdName == "bibitem") {
 365                         inset.reset(new InsetBibitem(inscmd));
 366                 } else if (cmdName == "bibtex") {
 367                         inset.reset(new InsetBibtex(inscmd));
 368                 } else if (cmdName == "index") {
 369                         inset.reset(new InsetIndex(inscmd));
 370                 } else if (cmdName == "include") {
 371                         inset.reset(new InsetInclude(inscmd));
 372                 } else if (cmdName == "label") {
 373                         inset.reset(new InsetLabel(inscmd));
 374                 } else if (cmdName == "url"
 375                            || cmdName == "htmlurl") {
 376                         inset.reset(new InsetUrl(inscmd));
 377                 } else if (cmdName == "ref"
 378                            || cmdName == "eqref"
 379                            || cmdName == "pageref"
 380                            || cmdName == "vref"
 381                            || cmdName == "vpageref"
 382                            || cmdName == "prettyref") {
 383                         if (!inscmd.getOptions().empty()
 384                             || !inscmd.getContents().empty()) {
 385                                 inset.reset(new InsetRef(inscmd, buf));
 386                         }
 387                 } else if (cmdName == "tableofcontents") {
 388                         inset.reset(new InsetTOC(inscmd));
 389                 } else if (cmdName == "listofalgorithms") {
 390                         inset.reset(new InsetFloatList("algorithm"));
 391                 } else if (cmdName == "listoffigures") {
 392                         inset.reset(new InsetFloatList("figure"));
 393                 } else if (cmdName == "listoftables") {
 394                         inset.reset(new InsetFloatList("table"));
 395                 } else if (cmdName == "printindex") {
 396                         inset.reset(new InsetPrintIndex(inscmd));
 397                 } else {
 398                         lyxerr << "unknown CommandInset '" << cmdName
 399                                << "'" << std::endl;
 400                         while (lex.isOK() && lex.getString() != "\\end_inset")
 401                                 lex.next();
 402                         return 0;
 403                 }
 404         } else {
 405                 if (tmptok == "Quotes") {
 406                         inset.reset(new InsetQuotes);
 407                 } else if (tmptok == "External") {
 408                         inset.reset(new InsetExternal);
 409                 } else if (tmptok == "FormulaMacro") {
 410                         inset.reset(new MathMacroTemplate);
 411                 } else if (tmptok == "Formula") {
 412                         inset.reset(new InsetMathHull);
 413                 } else if (tmptok == "Graphics") {
 414                         inset.reset(new InsetGraphics);
 415                 } else if (tmptok == "Note") {
 416                         inset.reset(new InsetNote(buf.params(), tmptok));
 417                 } else if (tmptok == "Box") {
 418                         inset.reset(new InsetBox(buf.params(), tmptok));
 419                 } else if (tmptok == "CharStyle") {
 420                         lex.next();
 421                         string s = lex.getString();
 422                         CharStyles::iterator found_cs = tclass.charstyle(s);
 423                         if (found_cs != tclass.charstyles().end())
 424                                 inset.reset(new InsetCharStyle(buf.params(), found_cs));
 425                         else {
 426                                 // "Undefined" inset
 427                                 inset.reset(new InsetCharStyle(buf.params(), s));
 428                         }
 429                 } else if (tmptok == "Branch") {
 430                         inset.reset(new InsetBranch(buf.params(),
 431                                                     InsetBranchParams()));
 432                 } else if (tmptok == "Include") {
 433                         InsetCommandParams p("Include");
 434                         inset.reset(new InsetInclude(p));
 435                 } else if (tmptok == "Environment") {
 436                         lex.next();
 437                         inset.reset(new InsetEnvironment(buf.params(), lex.getString()));
 438                 } else if (tmptok == "ERT") {
 439                         inset.reset(new InsetERT(buf.params()));
 440                 } else if (tmptok == "InsetSpace") {
 441                         inset.reset(new InsetSpace);
 442                 } else if (tmptok == "Tabular") {
 443                         inset.reset(new InsetTabular(buf));
 444                 } else if (tmptok == "Text") {
 445                         inset.reset(new InsetText(buf.params()));
 446                 } else if (tmptok == "VSpace") {
 447                         inset.reset(new InsetVSpace);
 448                 } else if (tmptok == "Foot") {
 449                         inset.reset(new InsetFoot(buf.params()));
 450                 } else if (tmptok == "Marginal") {
 451                         inset.reset(new InsetMarginal(buf.params()));
 452                 } else if (tmptok == "OptArg") {
 453                         inset.reset(new InsetOptArg(buf.params()));
 454                 } else if (tmptok == "Float") {
 455                         lex.next();
 456                         string tmptok = lex.getString();
 457                         inset.reset(new InsetFloat(buf.params(), tmptok));
 458                 } else if (tmptok == "Wrap") {
 459                         lex.next();
 460                         string tmptok = lex.getString();
 461                         inset.reset(new InsetWrap(buf.params(), tmptok));
 462 #if 0
 463                 } else if (tmptok == "List") {
 464                         inset.reset(new InsetList);
 465                 } else if (tmptok == "Theorem") {
 466                         inset.reset(new InsetList);
 467 #endif
 468                 } else if (tmptok == "Caption") {
 469                         inset.reset(new InsetCaption(buf.params()));
 470                 } else if (tmptok == "FloatList") {
 471                         inset.reset(new InsetFloatList);
 472                 } else {
 473                         lyxerr << "unknown Inset type '" << tmptok
 474                                << "'" << std::endl;
 475                         while (lex.isOK() && lex.getString() != "\\end_inset")
 476                                 lex.next();
 477                         return 0;
 478                 }
 479
 480                 inset->read(buf, lex);
 481
 482 #ifdef WITH_WARNINGS
 483 #warning hack..
 484 #endif
 485                 if (inset->lyxCode() == InsetBase::MATHMACRO_CODE) {
 486                         MathMacroTemplate const * tmpl =
 487                                 static_cast<MathMacroTemplate*>(inset.get());
 488                         MacroTable::globalMacros().insert
 489                                 (tmpl->name(), tmpl->asMacroData());
 490                         lyxerr[Debug::DEBUG]
 491                                 << BOOST_CURRENT_FUNCTION
 492                                 << ": creating local macro " << tmpl->name()
 493                                 << endl;
 494                 }
 495         }
 496
 497         return inset.release();
 498 }