src/factory.cpp

   1 /**
   2  * \file factory.cpp
   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 "BufferParams.h"
  17 #include "FloatList.h"
  18 #include "FuncRequest.h"
  19 #include "Lexer.h"
  20 #include "LyX.h"
  21 #include "TextClass.h"
  22
  23 #include "insets/InsetBibitem.h"
  24 #include "insets/InsetBibtex.h"
  25 #include "insets/InsetBox.h"
  26 #include "insets/InsetBranch.h"
  27 #include "insets/InsetCaption.h"
  28 #include "insets/InsetCitation.h"
  29 #include "insets/InsetFlex.h"
  30 #include "insets/InsetERT.h"
  31 #include "insets/InsetListings.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/InsetHyperlink.h"
  38 #include "insets/InsetInclude.h"
  39 #include "insets/InsetIndex.h"
  40 #include "insets/InsetInfo.h"
  41 #include "insets/InsetLabel.h"
  42 #include "insets/InsetLine.h"
  43 #include "insets/InsetMarginal.h"
  44 #include "insets/InsetNewline.h"
  45 #include "insets/InsetNewpage.h"
  46 #include "insets/InsetNomencl.h"
  47 #include "insets/InsetNote.h"
  48 #include "insets/InsetArgument.h"
  49 #include "insets/InsetPhantom.h"
  50 #include "insets/InsetPreview.h"
  51 #include "insets/InsetRef.h"
  52 #include "insets/InsetScript.h"
  53 #include "insets/InsetSpace.h"
  54 #include "insets/InsetTabular.h"
  55 #include "insets/InsetTOC.h"
  56 #include "insets/InsetVSpace.h"
  57 #include "insets/InsetWrap.h"
  58
  59 #include "mathed/MathMacroTemplate.h"
  60 #include "mathed/InsetMathHull.h"
  61
  62 #include "frontends/alert.h"
  63
  64 #include "support/debug.h"
  65 #include "support/lstrings.h"
  66 #include "support/ExceptionMessage.h"
  67
  68 #include "support/lassert.h"
  69
  70 #include <sstream>
  71
  72 using namespace std;
  73 using namespace lyx::support;
  74
  75 namespace lyx {
  76
  77 namespace Alert = frontend::Alert;
  78
  79
  80 Inset * createInsetHelper(Buffer * buf, FuncRequest const & cmd)
  81 {
  82         try {
  83
  84                 switch (cmd.action()) {
  85
  86                 case LFUN_NEWPAGE_INSERT: {
  87                         string const name = cmd.getArg(0);
  88                         InsetNewpageParams inp;
  89                         if (name.empty() || name == "newpage")
  90                                 inp.kind = InsetNewpageParams::NEWPAGE;
  91                         else if (name == "pagebreak")
  92                                 inp.kind = InsetNewpageParams::PAGEBREAK;
  93                         else if (name == "clearpage")
  94                                 inp.kind = InsetNewpageParams::CLEARPAGE;
  95                         else if (name == "cleardoublepage")
  96                                 inp.kind = InsetNewpageParams::CLEARDOUBLEPAGE;
  97                         return new InsetNewpage(inp);
  98                 }
  99
 100                 case LFUN_FLEX_INSERT: {
 101                         string s = cmd.getArg(0);
 102                         return new InsetFlex(buf, s);
 103                 }
 104
 105                 case LFUN_NOTE_INSERT: {
 106                         string arg = cmd.getArg(0);
 107                         if (arg.empty())
 108                                 arg = "Note";
 109                         return new InsetNote(buf, arg);
 110                 }
 111
 112                 case LFUN_BOX_INSERT: {
 113                         string arg = cmd.getArg(0);
 114                         if (arg.empty())
 115                                 arg = "Boxed";
 116                         return new InsetBox(buf, arg);
 117                 }
 118
 119                 case LFUN_BRANCH_INSERT: {
 120                         docstring arg = cmd.argument();
 121                         if (arg.empty())
 122                                 arg = from_ascii("none");
 123                         return new InsetBranch(buf, InsetBranchParams(arg));
 124                 }
 125
 126                 case LFUN_PHANTOM_INSERT: {
 127                         string arg = cmd.getArg(0);
 128                         if (arg.empty())
 129                                 arg = "Phantom";
 130                         return new InsetPhantom(buf, arg);
 131                 }
 132
 133                 case LFUN_ERT_INSERT:
 134                         return new InsetERT(buf);
 135
 136                 case LFUN_LISTING_INSERT:
 137                         return new InsetListings(buf);
 138
 139                 case LFUN_FOOTNOTE_INSERT:
 140                         return new InsetFoot(buf);
 141
 142                 case LFUN_MARGINALNOTE_INSERT:
 143                         return new InsetMarginal(buf);
 144
 145                 case LFUN_ARGUMENT_INSERT:
 146                         return new InsetArgument(buf);
 147
 148                 case LFUN_FLOAT_INSERT:
 149                         return new InsetFloat(buf, to_utf8(cmd.argument()));
 150
 151                 case LFUN_FLOAT_WIDE_INSERT: {
 152                         InsetFloat * fl = new InsetFloat(buf, to_utf8(cmd.argument()));
 153                         fl->setWide(true);
 154                         return fl;
 155                 }
 156
 157                 case LFUN_WRAP_INSERT: {
 158                         string const argument = to_utf8(cmd.argument());
 159                         if (argument == "figure" || argument == "table")
 160                                 return new InsetWrap(buf, argument);
 161                         lyxerr << "Non-existent wrapfig type: " << argument << endl;
 162                         return 0;
 163                 }
 164
 165                 case LFUN_INDEX_INSERT: {
 166                         docstring arg = cmd.argument();
 167                         return new InsetIndex(buf, InsetIndexParams(arg));
 168                 }
 169
 170                 case LFUN_NOMENCL_INSERT: {
 171                         InsetCommandParams icp(NOMENCL_CODE);
 172                         icp["symbol"] = cmd.argument();
 173                         return new InsetNomencl(buf, icp);
 174                 }
 175
 176                 case LFUN_TABULAR_INSERT: {
 177                         if (cmd.argument().empty())
 178                                 return 0;
 179                         istringstream ss(to_utf8(cmd.argument()));
 180                         int r = 0, c = 0;
 181                         ss >> r >> c;
 182                         if (r <= 0)
 183                                 r = 2;
 184                         if (c <= 0)
 185                                 c = 2;
 186                         return new InsetTabular(buf, r, c);
 187                 }
 188
 189                 case LFUN_CAPTION_INSERT:
 190                         return new InsetCaption(buf);
 191
 192                 case LFUN_INDEX_PRINT:  {
 193                         InsetCommandParams icp(INDEX_PRINT_CODE);
 194                         icp["type"] = cmd.argument();
 195                         return new InsetPrintIndex(buf, icp);
 196                 }
 197
 198                 case LFUN_NOMENCL_PRINT: {
 199                         InsetCommandParams icp(NOMENCL_PRINT_CODE);
 200                         icp["set_width"] = from_ascii("auto");
 201                         return new InsetPrintNomencl(buf, icp);
 202                 }
 203
 204                 case LFUN_INFO_INSERT: {
 205                         InsetInfo * inset = new InsetInfo(buf, to_utf8(cmd.argument()));
 206                         inset->updateInfo();
 207                         return inset;
 208                 }
 209
 210                 case LFUN_PREVIEW_INSERT:
 211                         return new InsetPreview(buf);
 212
 213                 case LFUN_INSET_INSERT: {
 214                         string const name = cmd.getArg(0);
 215                         InsetCode code = insetCode(name);
 216                         switch (code) {
 217                         case NO_CODE:
 218                                 lyxerr << "No such inset '" << name << "'.";
 219                                 return 0;
 220
 221                         case BIBITEM_CODE: {
 222                                 InsetCommandParams icp(code);
 223                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 224                                 return new InsetBibitem(buf, icp);
 225                         }
 226
 227                         case BIBTEX_CODE: {
 228                                 InsetCommandParams icp(code);
 229                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 230                                 return new InsetBibtex(buf, icp);
 231                         }
 232
 233                         case CITE_CODE: {
 234                                 InsetCommandParams icp(code);
 235                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 236                                 return new InsetCitation(buf, icp);
 237                         }
 238
 239                         case ERT_CODE: {
 240                                 return new InsetERT(buf,
 241                                         InsetERT::string2params(to_utf8(cmd.argument())));
 242                         }
 243
 244                         case EXTERNAL_CODE: {
 245                                 InsetExternalParams iep;
 246                                 InsetExternal::string2params(to_utf8(cmd.argument()), *buf, iep);
 247                                 auto_ptr<InsetExternal> inset(new InsetExternal(buf));
 248                                 inset->setBuffer(*buf);
 249                                 inset->setParams(iep);
 250                                 return inset.release();
 251                         }
 252
 253                         case GRAPHICS_CODE: {
 254                                 InsetGraphicsParams igp;
 255                                 InsetGraphics::string2params(to_utf8(cmd.argument()), *buf, igp);
 256                                 auto_ptr<InsetGraphics> inset(new InsetGraphics(buf));
 257                                 inset->setParams(igp);
 258                                 return inset.release();
 259                         }
 260
 261                         case HYPERLINK_CODE: {
 262                                 InsetCommandParams icp(code);
 263                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 264                                 return new InsetHyperlink(buf, icp);
 265                         }
 266
 267                         case INCLUDE_CODE: {
 268                                 InsetCommandParams icp(code);
 269                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 270                                 return new InsetInclude(buf, icp);
 271                         }
 272
 273                         case INDEX_CODE: {
 274                                 docstring arg = cmd.argument();
 275                                 return new InsetIndex(buf, InsetIndexParams(arg));
 276                         }
 277
 278                         case INDEX_PRINT_CODE:  {
 279                                 InsetCommandParams icp(code);
 280                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 281                                 return new InsetPrintIndex(buf, icp);
 282                         }
 283
 284                         case LABEL_CODE: {
 285                                 InsetCommandParams icp(code);
 286                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 287                                 return new InsetLabel(buf, icp);
 288                         }
 289
 290                         case LINE_CODE: {
 291                                 InsetCommandParams icp(code);
 292                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 293                                 return new InsetLine(buf, icp);
 294                         }
 295
 296                         case LISTINGS_CODE: {
 297                                 InsetListingsParams par;
 298                                 InsetListings::string2params(to_utf8(cmd.argument()), par);
 299                                 return new InsetListings(buf, par);
 300                         }
 301
 302                         case NOMENCL_CODE: {
 303                                 InsetCommandParams icp(code);
 304                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 305                                 return new InsetNomencl(buf, icp);
 306                         }
 307
 308                         case REF_CODE: {
 309                                 InsetCommandParams icp(code);
 310                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 311                                 return new InsetRef(buf, icp);
 312                         }
 313
 314                         case SCRIPT_CODE: {
 315                                 InsetScriptParams isp;
 316                                 InsetScript::string2params(to_utf8(cmd.argument()), isp);
 317                                 return new InsetScript(buf, isp);
 318                         }
 319
 320                         case SPACE_CODE: {
 321                                 InsetSpaceParams isp;
 322                                 InsetSpace::string2params(to_utf8(cmd.argument()), isp);
 323                                 return new InsetSpace(isp);
 324                         }
 325
 326                         case TOC_CODE: {
 327                                 InsetCommandParams icp(code);
 328                                 InsetCommand::string2params(to_utf8(cmd.argument()), icp);
 329                                 return new InsetTOC(buf, icp);
 330                         }
 331
 332                         case VSPACE_CODE: {
 333                                 VSpace vspace;
 334                                 InsetVSpace::string2params(to_utf8(cmd.argument()), vspace);
 335                                 return new InsetVSpace(vspace);
 336                         }
 337
 338                         case PREVIEW_CODE:
 339                                 return new InsetPreview(buf);
 340
 341                         default:
 342                                 lyxerr << "Inset '" << name << "' not permitted with LFUN_INSET_INSERT."
 343                                                 << endl;
 344                                 return 0;
 345
 346                         }
 347                 } //end LFUN_INSET_INSERT
 348
 349                 case LFUN_SPACE_INSERT: {
 350                         string const name = cmd.getArg(0);
 351                         string const len = cmd.getArg(1);
 352                         if (name.empty()) {
 353                                 lyxerr << "LyX function 'space-insert' needs an argument." << endl;
 354                                 break;
 355                         }
 356                         InsetSpaceParams isp;
 357                         // The tests for isp.math might be disabled after a file format change
 358                         if (name == "normal")
 359                                 isp.kind = InsetSpaceParams::NORMAL;
 360                         else if (name == "protected")
 361                                 isp.kind = InsetSpaceParams::PROTECTED;
 362                         else if (name == "thin")
 363                                 isp.kind = InsetSpaceParams::THIN;
 364                         else if (isp.math && name == "med")
 365                                 isp.kind = InsetSpaceParams::MEDIUM;
 366                         else if (isp.math && name == "thick")
 367                                 isp.kind = InsetSpaceParams::THICK;
 368                         else if (name == "quad")
 369                                 isp.kind = InsetSpaceParams::QUAD;
 370                         else if (name == "qquad")
 371                                 isp.kind = InsetSpaceParams::QQUAD;
 372                         else if (name == "enspace")
 373                                 isp.kind = InsetSpaceParams::ENSPACE;
 374                         else if (name == "enskip")
 375                                 isp.kind = InsetSpaceParams::ENSKIP;
 376                         else if (name == "negthinspace")
 377                                 isp.kind = InsetSpaceParams::NEGTHIN;
 378                         else if (isp.math && name == "negmedspace")
 379                                 isp.kind = InsetSpaceParams::NEGMEDIUM;
 380                         else if (isp.math && name == "negthickspace")
 381                                 isp.kind = InsetSpaceParams::NEGTHICK;
 382                         else if (name == "hfill")
 383                                 isp.kind = InsetSpaceParams::HFILL;
 384                         else if (name == "hfill*")
 385                                 isp.kind = InsetSpaceParams::HFILL_PROTECTED;
 386                         else if (name == "dotfill")
 387                                 isp.kind = InsetSpaceParams::DOTFILL;
 388                         else if (name == "hrulefill")
 389                                 isp.kind = InsetSpaceParams::HRULEFILL;
 390                         else if (name == "hspace") {
 391                                 if (len.empty() || !isValidGlueLength(len)) {
 392                                         lyxerr << "LyX function 'space-insert hspace' "
 393                                                << "needs a valid length argument." << endl;
 394                                         break;
 395                                 }
 396                                 isp.kind = InsetSpaceParams::CUSTOM;
 397                                 isp.length = GlueLength(len);
 398                         }
 399                         else if (name == "hspace*") {
 400                                 if (len.empty() || !isValidGlueLength(len)) {
 401                                         lyxerr << "LyX function 'space-insert hspace*' "
 402                                                << "needs a valid length argument." << endl;
 403                                         break;
 404                                 }
 405                                 isp.kind = InsetSpaceParams::CUSTOM_PROTECTED;
 406                                 isp.length = GlueLength(len);
 407                         }
 408                         else {
 409                                 lyxerr << "Wrong argument for LyX function 'space-insert'." << endl;
 410                                 break;
 411                         }
 412                         return new InsetSpace(isp);
 413                 }
 414                 break;
 415
 416                 default:
 417                         break;
 418                 }
 419
 420         } catch (ExceptionMessage const & message) {
 421                 if (message.type_ == ErrorException) {
 422                         // This should never happen!
 423                         Alert::error(message.title_, message.details_);
 424                         lyx_exit(1);
 425                 } else if (message.type_ == WarningException) {
 426                         Alert::warning(message.title_, message.details_);
 427                         return 0;
 428                 }
 429         }
 430
 431         return 0;
 432 }
 433
 434
 435 Inset * createInset(Buffer * buf, FuncRequest const & cmd)
 436 {
 437         Inset * inset = createInsetHelper(buf, cmd);
 438         if (inset)
 439                 inset->setBuffer(*buf);
 440         return inset;
 441 }
 442
 443
 444 Inset * readInset(Lexer & lex, Buffer * buf)
 445 {
 446         // consistency check
 447         if (lex.getString() != "\\begin_inset")
 448                 LYXERR0("Buffer::readInset: Consistency check failed.");
 449
 450         auto_ptr<Inset> inset;
 451
 452         string tmptok;
 453         lex >> tmptok;
 454
 455         // test the different insets
 456
 457         // FIXME It would be better if we did not have this branch and could
 458         // just do one massive switch for all insets. But at present, it's
 459         // easier to do it this way, and we can't do the massive switch until
 460         // the conversion mentioned below.  Note that if we do want to do a
 461         // single switch, we need to remove this "CommandInset" line---or
 462         // replace it with a single "InsetType" line that would be used in all
 463         // insets.
 464         if (tmptok == "CommandInset") {
 465                 lex.next();
 466                 string const insetType = lex.getString();
 467                 lex.pushToken(insetType);
 468
 469                 InsetCode const code = insetCode(insetType);
 470
 471                 //FIXME If we do the one massive switch, we cannot do this here, since
 472                 //we do not know in advance that we're dealing with a command inset.
 473                 //Worst case, we could put it in each case below. Better, we could
 474                 //pass the lexer to the constructor and let the params be built there.
 475                 InsetCommandParams inscmd(code);
 476                 inscmd.read(lex);
 477
 478                 switch (code) {
 479                         case BIBITEM_CODE:
 480                                 inset.reset(new InsetBibitem(buf, inscmd));
 481                                 break;
 482                         case BIBTEX_CODE:
 483                                 inset.reset(new InsetBibtex(buf, inscmd));
 484                                 break;
 485                         case CITE_CODE:
 486                                 inset.reset(new InsetCitation(buf, inscmd));
 487                                 break;
 488                         case HYPERLINK_CODE:
 489                                 inset.reset(new InsetHyperlink(buf, inscmd));
 490                                 break;
 491                         case INCLUDE_CODE:
 492                                 inset.reset(new InsetInclude(buf, inscmd));
 493                                 break;
 494                         case INDEX_PRINT_CODE:
 495                                 inset.reset(new InsetPrintIndex(buf, inscmd));
 496                                 break;
 497                         case LABEL_CODE:
 498                                 inset.reset(new InsetLabel(buf, inscmd));
 499                                 break;
 500                         case LINE_CODE:
 501                                 inset.reset(new InsetLine(buf, inscmd));
 502                                 break;
 503                         case NOMENCL_CODE:
 504                                 inset.reset(new InsetNomencl(buf, inscmd));
 505                                 break;
 506                         case NOMENCL_PRINT_CODE:
 507                                 inset.reset(new InsetPrintNomencl(buf, inscmd));
 508                                 break;
 509                         case REF_CODE:
 510                                 if (inscmd["name"].empty() && inscmd["reference"].empty())
 511                                         return 0;
 512                                 inset.reset(new InsetRef(buf, inscmd));
 513                                 break;
 514                         case TOC_CODE:
 515                                 inset.reset(new InsetTOC(buf, inscmd));
 516                                 break;
 517                         case NO_CODE:
 518                         default:
 519                                 lyxerr << "unknown CommandInset '" << insetType
 520                                                         << "'" << endl;
 521                                 while (lex.isOK() && lex.getString() != "\\end_inset")
 522                                         lex.next();
 523                                 return 0;
 524                 }
 525                 inset->setBuffer(*buf);
 526         } else {
 527                 // FIXME This branch should be made to use inset codes as the preceding
 528                 // branch does. Unfortunately, that will take some doing. It requires
 529                 // converting the representation of the insets in LyX files so that they
 530                 // use the inset names listed in Inset.cpp. Then, as above, the inset names
 531                 // can be translated to inset codes using insetCode(). And the insets'
 532                 // write() routines should use insetName() rather than hardcoding it.
 533                 if (tmptok == "Quotes") {
 534                         inset.reset(new InsetQuotes(buf));
 535                 } else if (tmptok == "External") {
 536                         inset.reset(new InsetExternal(buf));
 537                 } else if (tmptok == "FormulaMacro") {
 538                         inset.reset(new MathMacroTemplate(buf));
 539                 } else if (tmptok == "Formula") {
 540                         inset.reset(new InsetMathHull(buf));
 541                 } else if (tmptok == "Graphics") {
 542                         inset.reset(new InsetGraphics(buf));
 543                 } else if (tmptok == "Note") {
 544                         inset.reset(new InsetNote(buf, tmptok));
 545                 } else if (tmptok == "Box") {
 546                         inset.reset(new InsetBox(buf, tmptok));
 547                 } else if (tmptok == "Flex") {
 548                         lex.eatLine();
 549                         string s = lex.getString();
 550                         inset.reset(new InsetFlex(buf, s));
 551                 } else if (tmptok == "Branch") {
 552                         inset.reset(new InsetBranch(buf, InsetBranchParams()));
 553                 } else if (tmptok == "Phantom") {
 554                         inset.reset(new InsetPhantom(buf, tmptok));
 555                 } else if (tmptok == "ERT") {
 556                         inset.reset(new InsetERT(buf));
 557                 } else if (tmptok == "listings") {
 558                         inset.reset(new InsetListings(buf));
 559                 } else if (tmptok == "script") {
 560                         inset.reset(new InsetScript(buf));
 561                 } else if (tmptok == "space") {
 562                         inset.reset(new InsetSpace);
 563                 } else if (tmptok == "Tabular") {
 564                         inset.reset(new InsetTabular(buf));
 565                 } else if (tmptok == "Text") {
 566                         inset.reset(new InsetText(buf));
 567                 } else if (tmptok == "VSpace") {
 568                         inset.reset(new InsetVSpace);
 569                 } else if (tmptok == "Foot") {
 570                         inset.reset(new InsetFoot(buf));
 571                 } else if (tmptok == "Marginal") {
 572                         inset.reset(new InsetMarginal(buf));
 573                 } else if (tmptok == "Newpage") {
 574                         inset.reset(new InsetNewpage);
 575                 } else if (tmptok == "Newline") {
 576                         inset.reset(new InsetNewline);
 577                 } else if (tmptok == "Argument") {
 578                         inset.reset(new InsetArgument(buf));
 579                 } else if (tmptok == "Float") {
 580                         inset.reset(new InsetFloat(buf, string()));
 581                 } else if (tmptok == "Wrap") {
 582                         lex.next();
 583                         string tmptok = lex.getString();
 584                         inset.reset(new InsetWrap(buf, tmptok));
 585                 } else if (tmptok == "Caption") {
 586                         inset.reset(new InsetCaption(buf));
 587                 } else if (tmptok == "Index") {
 588                         inset.reset(new InsetIndex(buf, InsetIndexParams()));
 589                 } else if (tmptok == "FloatList") {
 590                         inset.reset(new InsetFloatList(buf));
 591                 } else if (tmptok == "Info") {
 592                         inset.reset(new InsetInfo(buf));
 593                 } else if (tmptok == "Preview") {
 594                         inset.reset(new InsetPreview(buf));
 595                 } else {
 596                         lyxerr << "unknown Inset type '" << tmptok
 597                                << "'" << endl;
 598                         while (lex.isOK() && lex.getString() != "\\end_inset")
 599                                 lex.next();
 600                         return 0;
 601                 }
 602
 603                 // Set the buffer reference for proper parsing of some insets
 604                 // (InsetCollapsable for example)
 605                 inset->setBuffer(*buf);
 606                 inset->read(lex);
 607                 // Set again the buffer for insets that are created inside this inset
 608                 // (InsetMathHull for example).
 609                 inset->setBuffer(*buf);
 610         }
 611         return inset.release();
 612 }
 613
 614
 615 } // namespace lyx