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 "funcrequest.h"
  14 #include "bufferparams.h"
  15 #include "buffer.h"
  16 #include "FloatList.h"
  17 #include "debug.h"
  18 #include "BufferView.h"
  19 #include "lyxtext.h"
  20 #include "lyxlex.h"
  21
  22 #include "insets/insetbibitem.h"
  23 #include "insets/insetbibtex.h"
  24 #include "insets/insetcaption.h"
  25 #include "insets/insetcite.h"
  26 #include "insets/insetenv.h"
  27 #include "insets/insetert.h"
  28 #include "insets/insetexternal.h"
  29 #include "insets/insetfloat.h"
  30 #include "insets/insetfloatlist.h"
  31 #include "insets/insetfoot.h"
  32 #include "insets/insetgraphics.h"
  33 #include "insets/insethfill.h"
  34 #include "insets/insetinclude.h"
  35 #include "insets/insetindex.h"
  36 #include "insets/insetlabel.h"
  37 #include "insets/insetmarginal.h"
  38 #include "insets/insetminipage.h"
  39 #include "insets/insetnote.h"
  40 #include "insets/insetbranch.h"
  41 #include "insets/insetoptarg.h"
  42 #include "insets/insetref.h"
  43 #include "insets/insetspace.h"
  44 #include "insets/insettabular.h"
  45 #include "insets/insettext.h"
  46 #include "insets/insettoc.h"
  47 #include "insets/inseturl.h"
  48 #include "insets/insetwrap.h"
  49 #include "mathed/formulamacro.h"
  50 #include "mathed/formula.h"
  51
  52 #include "frontends/Dialogs.h"
  53 #include "frontends/LyXView.h"
  54 #include "support/lstrings.h"
  55
  56 #include <cstdio>
  57
  58 using namespace lyx::support;
  59
  60 using std::endl;
  61
  62 InsetOld * createInset(FuncRequest const & cmd)
  63 {
  64         BufferView * bv = cmd.view();
  65         BufferParams const & params = bv->buffer()->params;
  66
  67         switch (cmd.action) {
  68         case LFUN_HFILL:
  69                 return new InsetHFill();
  70
  71         case LFUN_INSET_MINIPAGE:
  72                 return new InsetMinipage(params);
  73
  74         case LFUN_INSERT_NOTE:
  75                 {
  76                         string arg = cmd.getArg(0);
  77                         if (arg.empty())
  78                                 arg = "Note";
  79                         return new InsetNote(params, arg);
  80                 }
  81         case LFUN_INSERT_BRANCH:
  82                 {
  83                         string arg = cmd.getArg(0);
  84                         if (arg.empty())
  85                                 arg = "none";
  86                         return new InsetBranch(params, arg);
  87                 }
  88
  89         case LFUN_INSET_ERT:
  90                 return new InsetERT(params);
  91
  92         case LFUN_INSET_FOOTNOTE:
  93                 return new InsetFoot(params);
  94
  95         case LFUN_INSET_MARGINAL:
  96                 return new InsetMarginal(params);
  97
  98         case LFUN_INSET_OPTARG:
  99                 return new InsetOptArg(params);
 100
 101         case LFUN_INSERT_BIBITEM:
 102                 return new InsetBibitem(InsetCommandParams("bibitem"));
 103
 104         case LFUN_INSET_FLOAT:
 105                 // check if the float type exists
 106                 if (params.getLyXTextClass().floats().typeExist(cmd.argument))
 107                         return new InsetFloat(params, cmd.argument);
 108                 lyxerr << "Non-existent float type: " << cmd.argument << endl;
 109                 return 0;
 110
 111         case LFUN_INSET_WIDE_FLOAT:
 112                 // check if the float type exists
 113                 if (params.getLyXTextClass().floats().typeExist(cmd.argument)) {
 114                         InsetFloat * p = new InsetFloat(params, cmd.argument);
 115                         p->wide(true, params);
 116                 }
 117                 lyxerr << "Non-existent float type: " << cmd.argument << endl;
 118                 return 0;
 119
 120         case LFUN_INSET_WRAP:
 121                 if (cmd.argument == "figure")
 122                         return new InsetWrap(params, cmd.argument);
 123                 lyxerr << "Non-existent floatflt type: " << cmd.argument << endl;
 124                 return 0;
 125
 126         case LFUN_INDEX_INSERT: {
 127                 // Try and generate a valid index entry.
 128                 InsetCommandParams icp("index");
 129                 string const contents = cmd.argument.empty() ?
 130                         bv->getLyXText()->getStringToIndex() :
 131                         cmd.argument;
 132                 icp.setContents(contents);
 133
 134                 string data = InsetCommandMailer::params2string("index", icp);
 135                 LyXView * lv = bv->owner();
 136
 137                 if (icp.getContents().empty()) {
 138                         lv->getDialogs().show("index", data, 0);
 139                 } else {
 140                         lv->dispatch(FuncRequest(bv, LFUN_INSET_APPLY, data));
 141                 }
 142                 return 0;
 143         }
 144
 145         case LFUN_TABULAR_INSERT:
 146                 if (!cmd.argument.empty()) {
 147                         int r = 2;
 148                         int c = 2;
 149                         ::sscanf(cmd.argument.c_str(),"%d%d", &r, &c);
 150                         return new InsetTabular(*bv->buffer(), r, c);
 151                 }
 152                 bv->owner()->getDialogs().show("tabularcreate");
 153                 return 0;
 154
 155         case LFUN_INSET_CAPTION:
 156                 if (bv->theLockingInset()) {
 157                         lyxerr << "Locking inset code: "
 158                                << static_cast<int>(bv->theLockingInset()->lyxCode());
 159                         InsetCaption * inset = new InsetCaption(params);
 160                         inset->setOwner(bv->theLockingInset());
 161                         inset->setAutoBreakRows(true);
 162                         inset->setDrawFrame(InsetText::LOCKED);
 163                         inset->setFrameColor(LColor::captionframe);
 164                         return inset;
 165                 }
 166                 return 0;
 167
 168         case LFUN_INDEX_PRINT:
 169                 return new InsetPrintIndex(InsetCommandParams("printindex"));
 170
 171         case LFUN_TOC_INSERT:
 172                 return new InsetTOC(InsetCommandParams("tableofcontents"));
 173
 174         case LFUN_ENVIRONMENT_INSERT:
 175                 return new InsetEnvironment(params, cmd.argument);
 176
 177 #if 0
 178         case LFUN_INSET_LIST:
 179                 return new InsetList;
 180
 181         case LFUN_INSET_THEOREM:
 182                 return new InsetTheorem;
 183 #endif
 184
 185         case LFUN_INSET_INSERT: {
 186                 string const name = cmd.getArg(0);
 187
 188                 if (name == "bibitem") {
 189                         InsetCommandParams icp;
 190                         InsetCommandMailer::string2params(cmd.argument, icp);
 191                         return new InsetBibitem(icp);
 192
 193                 } else if (name == "bibtex") {
 194                         Buffer const & buffer = *cmd.view()->buffer();
 195                         InsetBibtexParams ibp;
 196                         InsetBibtexMailer::string2params(cmd.argument,
 197                                                          buffer, ibp);
 198                         return new InsetBibtex(ibp);
 199
 200                 } else if (name == "citation") {
 201                         InsetCommandParams icp;
 202                         InsetCommandMailer::string2params(cmd.argument, icp);
 203                         InsetCitation * inset = new InsetCitation(icp);
 204                         inset->setLoadingBuffer(*bv->buffer(), false);
 205                         return inset;
 206
 207                 } else if (name == "ert") {
 208                         InsetERT * inset = new InsetERT(params);
 209                         InsetERT::ERTStatus s;
 210                         InsetERTMailer::string2params(cmd.argument, s);
 211                         inset->status(bv, s);
 212                         return inset;
 213
 214                 } else if (name == "external") {
 215                         Buffer const & buffer = *cmd.view()->buffer();
 216                         InsetExternal::Params iep;
 217                         InsetExternalMailer::string2params(cmd.argument,
 218                                                            buffer, iep);
 219                         InsetExternal * inset = new InsetExternal;
 220                         inset->setParams(iep, buffer);
 221                         return inset;
 222
 223                 } else if (name == "graphics") {
 224                         Buffer const & buffer = *cmd.view()->buffer();
 225                         InsetGraphicsParams igp;
 226                         InsetGraphicsMailer::string2params(cmd.argument,
 227                                                            buffer, igp);
 228                         InsetGraphics * inset = new InsetGraphics;
 229                         inset->setParams(igp);
 230                         return inset;
 231
 232                 } else if (name == "include") {
 233                         InsetInclude::Params iip;
 234                         InsetIncludeMailer::string2params(cmd.argument, iip);
 235                         return new InsetInclude(iip);
 236
 237                 } else if (name == "index") {
 238                         InsetCommandParams icp;
 239                         InsetCommandMailer::string2params(cmd.argument, icp);
 240                         return new InsetIndex(icp);
 241
 242                 } else if (name == "label") {
 243                         InsetCommandParams icp;
 244                         InsetCommandMailer::string2params(cmd.argument, icp);
 245                         return new InsetLabel(icp);
 246
 247                 } else if (name == "ref") {
 248                         InsetCommandParams icp;
 249                         InsetCommandMailer::string2params(cmd.argument, icp);
 250                         return new InsetRef(icp, *bv->buffer());
 251
 252                 } else if (name == "toc") {
 253                         InsetCommandParams icp;
 254                         InsetCommandMailer::string2params(cmd.argument, icp);
 255                         return new InsetTOC(icp);
 256
 257                 } else if (name == "url") {
 258                         InsetCommandParams icp;
 259                         InsetCommandMailer::string2params(cmd.argument, icp);
 260                         return new InsetUrl(icp);
 261                 }
 262         }
 263
 264         case LFUN_SPACE_INSERT: {
 265                 string const name = cmd.argument;
 266                 if (name == "normal")
 267                         return new InsetSpace(InsetSpace::NORMAL);
 268                 else if (name == "protected")
 269                         return new InsetSpace(InsetSpace::PROTECTED);
 270                 else if (name == "thin")
 271                         return new InsetSpace(InsetSpace::THIN);
 272                 else if (name == "quad")
 273                         return new InsetSpace(InsetSpace::QUAD);
 274                 else if (name == "qquad")
 275                         return new InsetSpace(InsetSpace::QQUAD);
 276                 else if (name == "enspace")
 277                         return new InsetSpace(InsetSpace::ENSPACE);
 278                 else if (name == "enskip")
 279                         return new InsetSpace(InsetSpace::ENSKIP);
 280                 else if (name == "negthinspace")
 281                         return new InsetSpace(InsetSpace::NEGTHIN);
 282                 else if (name.empty())
 283                         lyxerr << "LyX function 'space' needs an argument." << endl;
 284                 else
 285                         lyxerr << "Wrong argument for LyX function 'space'." << endl;
 286         }
 287
 288         break;
 289
 290         default:
 291                 break;
 292         }
 293
 294         return 0;
 295 }
 296
 297
 298 InsetOld * readInset(LyXLex & lex, Buffer const & buf)
 299 {
 300         // consistency check
 301         if (lex.getString() != "\\begin_inset") {
 302                 lyxerr << "Buffer::readInset: Consistency check failed."
 303                        << endl;
 304         }
 305
 306         InsetOld * inset = 0;
 307
 308         lex.next();
 309         string const tmptok = lex.getString();
 310
 311         // test the different insets
 312         if (tmptok == "LatexCommand") {
 313                 InsetCommandParams inscmd;
 314                 inscmd.read(lex);
 315
 316                 string const cmdName = inscmd.getCmdName();
 317
 318                 // This strange command allows LyX to recognize "natbib" style
 319                 // citations: citet, citep, Citet etc.
 320                 if (compare_ascii_no_case(cmdName.substr(0,4), "cite") == 0) {
 321                         inset = new InsetCitation(inscmd);
 322                 } else if (cmdName == "bibitem") {
 323                         lex.printError("Wrong place for bibitem");
 324                         inset = new InsetBibitem(inscmd);
 325                 } else if (cmdName == "index") {
 326                         inset = new InsetIndex(inscmd);
 327                 } else if (cmdName == "include") {
 328                         inset = new InsetInclude(inscmd, buf);
 329                 } else if (cmdName == "label") {
 330                         inset = new InsetLabel(inscmd);
 331                 } else if (cmdName == "url"
 332                            || cmdName == "htmlurl") {
 333                         inset = new InsetUrl(inscmd);
 334                 } else if (cmdName == "ref"
 335                            || cmdName == "eqref"
 336                            || cmdName == "pageref"
 337                            || cmdName == "vref"
 338                            || cmdName == "vpageref"
 339                            || cmdName == "prettyref") {
 340                         if (!inscmd.getOptions().empty()
 341                             || !inscmd.getContents().empty()) {
 342                                 inset = new InsetRef(inscmd, buf);
 343                         }
 344                 } else if (cmdName == "tableofcontents") {
 345                         inset = new InsetTOC(inscmd);
 346                 } else if (cmdName == "listofalgorithms") {
 347                         inset = new InsetFloatList("algorithm");
 348                 } else if (cmdName == "listoffigures") {
 349                         inset = new InsetFloatList("figure");
 350                 } else if (cmdName == "listoftables") {
 351                         inset = new InsetFloatList("table");
 352                 } else if (cmdName == "printindex") {
 353                         inset = new InsetPrintIndex(inscmd);
 354                 }
 355         } else {
 356                 if (tmptok == "Quotes") {
 357                         inset = new InsetQuotes;
 358                 } else if (tmptok == "Bibtex") {
 359                         inset = new InsetBibtex;
 360                 } else if (tmptok == "External") {
 361                         inset = new InsetExternal;
 362                 } else if (tmptok == "FormulaMacro") {
 363                         inset = new InsetFormulaMacro;
 364                 } else if (tmptok == "Formula") {
 365                         inset = new InsetFormula;
 366                 } else if (tmptok == "Graphics") {
 367                         inset = new InsetGraphics;
 368                 } else if (tmptok == "Note"     || tmptok == "Comment"
 369                                 || tmptok == "Greyedout") {
 370                         inset = new InsetNote(buf.params, tmptok);
 371                 } else if (tmptok == "Branch") {
 372                         inset = new InsetBranch(buf.params, tmptok);
 373                 } else if (tmptok == "Include") {
 374                         InsetCommandParams p("Include");
 375                         inset = new InsetInclude(p, buf);
 376                 } else if (tmptok == "Environment") {
 377                         lex.next();
 378                         inset = new InsetEnvironment(buf.params, lex.getString());
 379                 } else if (tmptok == "ERT") {
 380                         inset = new InsetERT(buf.params);
 381                 } else if (tmptok == "InsetSpace") {
 382                         inset = new InsetSpace;
 383                 } else if (tmptok == "Tabular") {
 384                         inset = new InsetTabular(buf);
 385                 } else if (tmptok == "Text") {
 386                         inset = new InsetText(buf.params);
 387                 } else if (tmptok == "Foot") {
 388                         inset = new InsetFoot(buf.params);
 389                 } else if (tmptok == "Marginal") {
 390                         inset = new InsetMarginal(buf.params);
 391                 } else if (tmptok == "OptArg") {
 392                         inset = new InsetOptArg(buf.params);
 393                 } else if (tmptok == "Minipage") {
 394                         inset = new InsetMinipage(buf.params);
 395                 } else if (tmptok == "Float") {
 396                         lex.next();
 397                         string tmptok = lex.getString();
 398                         inset = new InsetFloat(buf.params, tmptok);
 399                 } else if (tmptok == "Wrap") {
 400                         lex.next();
 401                         string tmptok = lex.getString();
 402                         inset = new InsetWrap(buf.params, tmptok);
 403 #if 0
 404                 } else if (tmptok == "List") {
 405                         inset = new InsetList;
 406                 } else if (tmptok == "Theorem") {
 407                         inset = new InsetList;
 408 #endif
 409                 } else if (tmptok == "Caption") {
 410                         inset = new InsetCaption(buf.params);
 411                 } else if (tmptok == "FloatList") {
 412                         inset = new InsetFloatList;
 413                 }
 414
 415                 if (inset)
 416                         inset->read(buf, lex);
 417         }
 418
 419         return inset;
 420 }