src/Layout.cpp

   1 /**
   2  * \file Layout.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jean-Marc Lasgouttes
   8  * \author André Pönitz
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "Layout.h"
  16 #include "Lexer.h"
  17 #include "output_xhtml.h"
  18 #include "TextClass.h"
  19
  20 #include "support/debug.h"
  21 #include "support/docstream.h"
  22 #include "support/lassert.h"
  23 #include "support/lstrings.h"
  24 #include "support/textutils.h"
  25
  26
  27 using namespace std;
  28 using namespace lyx::support;
  29
  30 namespace lyx {
  31
  32 /// Special value of toclevel for layouts that do not belong to a TOC
  33 const int Layout::NOT_IN_TOC = -1000;
  34
  35 //  The order of the LayoutTags enum is no more important. [asierra300396]
  36 // Tags indexes.
  37 enum LayoutTags {
  38         LT_ALIGN = 1,
  39         LT_ALIGNPOSSIBLE,
  40         LT_ARGUMENT,
  41         LT_AUTONESTS,
  42         LT_AUTONESTEDBY,
  43         LT_MARGIN,
  44         LT_BOTTOMSEP,
  45         LT_CATEGORY,
  46         LT_COMMANDDEPTH,
  47         LT_COPYSTYLE,
  48         LT_DEPENDSON,
  49         LT_OBSOLETEDBY,
  50         LT_END,
  51         LT_FONT,
  52         LT_FREE_SPACING,
  53         LT_PASS_THRU,
  54         LT_PASS_THRU_CHARS,
  55         LT_PARBREAK_IS_NEWLINE,
  56         LT_ITEMCOMMAND,
  57         LT_ITEMSEP,
  58         LT_KEEPEMPTY,
  59         LT_LABEL_BOTTOMSEP,
  60         LT_LABELFONT,
  61         LT_TEXTFONT,
  62         LT_LABELINDENT,
  63         LT_LABELSEP,
  64         LT_LABELSTRING,
  65         LT_LABELSTRING_APPENDIX,
  66         LT_LABELCOUNTER,
  67         LT_LABELTYPE,
  68         LT_ENDLABELSTRING,
  69         LT_ENDLABELTYPE,
  70         LT_LATEXNAME,
  71         LT_LATEXPARAM,
  72         LT_LATEXTYPE,
  73         LT_LEFTDELIM,
  74         LT_LEFTMARGIN,
  75         LT_NEED_CPROTECT,
  76         LT_NEED_MBOXPROTECT,
  77         LT_NEED_PROTECT,
  78         LT_NEWLINE,
  79         LT_NEXTNOINDENT,
  80         LT_PAR_GROUP,
  81         LT_PARINDENT,
  82         LT_PARSEP,
  83         LT_PARSKIP,
  84         LT_PREAMBLE,
  85         LT_LANGPREAMBLE,
  86         LT_BABELPREAMBLE,
  87         LT_REQUIRES,
  88         LT_RIGHTMARGIN,
  89         LT_SPACING,
  90         LT_TOPSEP,
  91         LT_TOCLEVEL,
  92         LT_INNERTAG,
  93         LT_LABELTAG,
  94         LT_ITEMTAG,
  95         LT_HTMLTAG,
  96         LT_HTMLATTR,
  97         LT_HTMLCLASS,
  98         LT_HTMLITEM,
  99         LT_HTMLITEMATTR,
 100         LT_HTMLLABEL,
 101         LT_HTMLLABELATTR,
 102         LT_HTMLLABELFIRST,
 103         LT_HTMLPREAMBLE,
 104         LT_HTMLSTYLE,
 105         LT_HTMLFORCECSS,
 106         LT_DOCBOOKTAG,
 107         LT_DOCBOOKATTR,
 108         LT_DOCBOOKTAGTYPE,
 109         LT_DOCBOOKINNERATTR,
 110         LT_DOCBOOKINNERTAG,
 111         LT_DOCBOOKINNERTAGTYPE,
 112         LT_DOCBOOKININFO,
 113         LT_DOCBOOKABSTRACT,
 114         LT_DOCBOOKGENERATETITLE,
 115         LT_DOCBOOKWRAPPERTAG,
 116         LT_DOCBOOKWRAPPERATTR,
 117         LT_DOCBOOKWRAPPERTAGTYPE,
 118         LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS,
 119         LT_DOCBOOKSECTION,
 120         LT_DOCBOOKSECTIONTAG,
 121         LT_DOCBOOKITEMWRAPPERTAG,
 122         LT_DOCBOOKITEMWRAPPERATTR,
 123         LT_DOCBOOKITEMWRAPPERTAGTYPE,
 124         LT_DOCBOOKITEMTAG,
 125         LT_DOCBOOKITEMATTR,
 126         LT_DOCBOOKITEMTAGTYPE,
 127         LT_DOCBOOKITEMLABELTAG,
 128         LT_DOCBOOKITEMLABELATTR,
 129         LT_DOCBOOKITEMLABELTAGTYPE,
 130         LT_DOCBOOKITEMINNERTAG,
 131         LT_DOCBOOKITEMINNERATTR,
 132         LT_DOCBOOKITEMINNERTAGTYPE,
 133         LT_DOCBOOKFORCEABSTRACTTAG,
 134         LT_DOCBOOKNOFONTINSIDE,
 135         LT_INPREAMBLE,
 136         LT_HTMLTITLE,
 137         LT_SPELLCHECK,
 138         LT_REFPREFIX,
 139         LT_RESETARGS,
 140         LT_RESUMECOUNTER,
 141         LT_STEPPARENTCOUNTER,
 142         LT_RIGHTDELIM,
 143         LT_FORCELOCAL,
 144         LT_TOGGLE_INDENT,
 145         LT_ADDTOTOC,
 146         LT_ISTOCCAPTION,
 147         LT_HTMLINTOC,
 148         LT_INTITLE // keep this last!
 149 };
 150
 151 /////////////////////
 152
 153 Layout::Layout()
 154         : add_to_toc_(false), is_toc_caption_(true)
 155 {
 156         unknown_ = false;
 157         margintype = MARGIN_STATIC;
 158         latextype = LATEX_PARAGRAPH;
 159         resumecounter = false;
 160         stepparentcounter = false;
 161         intitle = false;
 162         inpreamble = false;
 163         needprotect = false;
 164         needcprotect = false;
 165         needmboxprotect = false;
 166         keepempty = false;
 167         font = inherit_font;
 168         labelfont = inherit_font;
 169         resfont = sane_font;
 170         reslabelfont = sane_font;
 171         nextnoindent = false;
 172         parskip = 0.0;
 173         itemsep = 0;
 174         topsep = 0.0;
 175         bottomsep = 0.0;
 176         labelbottomsep = 0.0;
 177         parsep = 0;
 178         align = LYX_ALIGN_BLOCK;
 179         alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
 180         labeltype = LABEL_NO_LABEL;
 181         endlabeltype = END_LABEL_NO_LABEL;
 182         // Should or should not. That is the question.
 183         // spacing.set(Spacing::OneHalf);
 184         newline_allowed = true;
 185         free_spacing = false;
 186         pass_thru = false;
 187         parbreak_is_newline = false;
 188         toclevel = NOT_IN_TOC;
 189         commanddepth = 0;
 190         htmllabelfirst_ = false;
 191         htmlforcecss_ = false;
 192         htmltitle_ = false;
 193         htmlintoc_ = true;
 194         docbookabstract_ = false;
 195         docbookwrappermergewithprevious_ = false;
 196         docbooksection_ = false;
 197         spellcheck = true;
 198         forcelocal = 0;
 199         itemcommand_ = "item";
 200         toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
 201         par_group_ = false;
 202 }
 203
 204
 205 bool Layout::read(Lexer & lex, TextClass const & tclass, bool validating)
 206 {
 207         // If this is an empty layout, or if no force local version is set,
 208         // we know that we will not discard the stuff to read
 209         if (forcelocal == 0)
 210                 return readIgnoreForcelocal(lex, tclass, validating);
 211         Layout tmp(*this);
 212         tmp.forcelocal = 0;
 213         bool const ret = tmp.readIgnoreForcelocal(lex, tclass, validating);
 214         // Keep the stuff if
 215         // - the read version is higher
 216         // - both versions are infinity (arbitrary decision)
 217         // - the file did not contain any local version (needed for not
 218         //   skipping user defined local layouts)
 219         if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
 220                 *this = tmp;
 221         return ret;
 222 }
 223
 224
 225 bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass,
 226                                                                   bool validating)
 227 {
 228         // This table is sorted alphabetically [asierra 30March96]
 229         LexerKeyword layoutTags[] = {
 230                 { "addtotoc",       LT_ADDTOTOC },
 231                 { "align",          LT_ALIGN },
 232                 { "alignpossible",  LT_ALIGNPOSSIBLE },
 233                 { "argument",       LT_ARGUMENT },
 234                 { "autonests",      LT_AUTONESTS },
 235                 { "babelpreamble",  LT_BABELPREAMBLE },
 236                 { "bottomsep",      LT_BOTTOMSEP },
 237                 { "category",       LT_CATEGORY },
 238                 { "commanddepth",   LT_COMMANDDEPTH },
 239                 { "copystyle",      LT_COPYSTYLE },
 240                 { "dependson",      LT_DEPENDSON },
 241                 { "docbookabstract",           LT_DOCBOOKABSTRACT },
 242                 { "docbookattr",               LT_DOCBOOKATTR },
 243                 { "docbookforceabstracttag",   LT_DOCBOOKFORCEABSTRACTTAG },
 244                 { "docbookgeneratetitle",      LT_DOCBOOKGENERATETITLE },
 245                 { "docbookininfo",             LT_DOCBOOKININFO },
 246                 { "docbookinnerattr",          LT_DOCBOOKINNERATTR },
 247                 { "docbookinnertag",           LT_DOCBOOKINNERTAG },
 248                 { "docbookinnertagtype",       LT_DOCBOOKINNERTAGTYPE },
 249                 { "docbookitemattr",           LT_DOCBOOKITEMATTR },
 250                 { "docbookiteminnerattr",      LT_DOCBOOKITEMINNERATTR },
 251                 { "docbookiteminnertag",       LT_DOCBOOKITEMINNERTAG },
 252                 { "docbookiteminnertagtype",   LT_DOCBOOKITEMINNERTAGTYPE },
 253                 { "docbookitemlabelattr",      LT_DOCBOOKITEMLABELATTR },
 254                 { "docbookitemlabeltag",       LT_DOCBOOKITEMLABELTAG },
 255                 { "docbookitemlabeltagtype",   LT_DOCBOOKITEMLABELTAGTYPE },
 256                 { "docbookitemtag",            LT_DOCBOOKITEMTAG },
 257                 { "docbookitemtagtype",        LT_DOCBOOKITEMTAGTYPE },
 258                 { "docbookitemwrapperattr",    LT_DOCBOOKITEMWRAPPERATTR },
 259                 { "docbookitemwrappertag",     LT_DOCBOOKITEMWRAPPERTAG },
 260                 { "docbookitemwrappertagtype", LT_DOCBOOKITEMWRAPPERTAGTYPE },
 261                 { "docbooknofontinside",       LT_DOCBOOKNOFONTINSIDE, },
 262                 { "docbooksection",            LT_DOCBOOKSECTION },
 263                 { "docbooksectiontag",         LT_DOCBOOKSECTIONTAG },
 264                 { "docbooktag",                LT_DOCBOOKTAG },
 265                 { "docbooktagtype",            LT_DOCBOOKTAGTYPE },
 266                 { "docbookwrapperattr",        LT_DOCBOOKWRAPPERATTR },
 267                 { "docbookwrappermergewithprevious", LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS },
 268                 { "docbookwrappertag",         LT_DOCBOOKWRAPPERTAG },
 269                 { "docbookwrappertagtype",     LT_DOCBOOKWRAPPERTAGTYPE },
 270                 { "end",            LT_END },
 271                 { "endlabelstring", LT_ENDLABELSTRING },
 272                 { "endlabeltype",   LT_ENDLABELTYPE },
 273                 { "font",           LT_FONT },
 274                 { "forcelocal",     LT_FORCELOCAL },
 275                 { "freespacing",    LT_FREE_SPACING },
 276                 { "htmlattr",       LT_HTMLATTR },
 277                 { "htmlclass",      LT_HTMLCLASS },
 278                 { "htmlforcecss",   LT_HTMLFORCECSS },
 279                 { "htmlintoc",      LT_HTMLINTOC },
 280                 { "htmlitem",       LT_HTMLITEM },
 281                 { "htmlitemattr",   LT_HTMLITEMATTR },
 282                 { "htmllabel",      LT_HTMLLABEL },
 283                 { "htmllabelattr",  LT_HTMLLABELATTR },
 284                 { "htmllabelfirst", LT_HTMLLABELFIRST },
 285                 { "htmlpreamble",   LT_HTMLPREAMBLE },
 286                 { "htmlstyle",      LT_HTMLSTYLE },
 287                 { "htmltag",        LT_HTMLTAG },
 288                 { "htmltitle",      LT_HTMLTITLE },
 289                 { "innertag",       LT_INNERTAG },
 290                 { "inpreamble",     LT_INPREAMBLE },
 291                 { "intitle",        LT_INTITLE },
 292                 { "isautonestedby", LT_AUTONESTEDBY },
 293                 { "istoccaption",   LT_ISTOCCAPTION },
 294                 { "itemcommand",    LT_ITEMCOMMAND },
 295                 { "itemsep",        LT_ITEMSEP },
 296                 { "itemtag",        LT_ITEMTAG },
 297                 { "keepempty",      LT_KEEPEMPTY },
 298                 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
 299                 { "labelcounter",   LT_LABELCOUNTER },
 300                 { "labelfont",      LT_LABELFONT },
 301                 { "labelindent",    LT_LABELINDENT },
 302                 { "labelsep",       LT_LABELSEP },
 303                 { "labelstring",    LT_LABELSTRING },
 304                 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
 305                 { "labeltag",       LT_LABELTAG },
 306                 { "labeltype",      LT_LABELTYPE },
 307                 { "langpreamble",   LT_LANGPREAMBLE },
 308                 { "latexname",      LT_LATEXNAME },
 309                 { "latexparam",     LT_LATEXPARAM },
 310                 { "latextype",      LT_LATEXTYPE },
 311                 { "leftdelim",      LT_LEFTDELIM },
 312                 { "leftmargin",     LT_LEFTMARGIN },
 313                 { "margin",         LT_MARGIN },
 314                 { "needcprotect",    LT_NEED_CPROTECT },
 315                 { "needmboxprotect", LT_NEED_MBOXPROTECT },
 316                 { "needprotect",    LT_NEED_PROTECT },
 317                 { "newline",        LT_NEWLINE },
 318                 { "nextnoindent",   LT_NEXTNOINDENT },
 319                 { "obsoletedby",    LT_OBSOLETEDBY },
 320                 { "paragraphgroup", LT_PAR_GROUP },
 321                 { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
 322                 { "parindent",      LT_PARINDENT },
 323                 { "parsep",         LT_PARSEP },
 324                 { "parskip",        LT_PARSKIP },
 325                 { "passthru",       LT_PASS_THRU },
 326                 { "passthruchars",  LT_PASS_THRU_CHARS },
 327                 { "preamble",       LT_PREAMBLE },
 328                 { "refprefix",      LT_REFPREFIX },
 329                 { "requires",       LT_REQUIRES },
 330                 { "resetargs",      LT_RESETARGS },
 331                 { "resumecounter",  LT_RESUMECOUNTER },
 332                 { "rightdelim",     LT_RIGHTDELIM },
 333                 { "rightmargin",    LT_RIGHTMARGIN },
 334                 { "spacing",        LT_SPACING },
 335                 { "spellcheck",     LT_SPELLCHECK },
 336                 { "stepparentcounter",  LT_STEPPARENTCOUNTER },
 337                 { "textfont",       LT_TEXTFONT },
 338                 { "toclevel",       LT_TOCLEVEL },
 339                 { "toggleindent",   LT_TOGGLE_INDENT },
 340                 { "topsep",         LT_TOPSEP }
 341         };
 342
 343         bool error = false;
 344         bool finished = false;
 345         lex.pushTable(layoutTags);
 346
 347         // parse style section
 348         while (!finished && lex.isOK() && !error) {
 349                 int le = lex.lex();
 350                 // See comment in LyXRC.cpp.
 351                 switch (le) {
 352                 case Lexer::LEX_FEOF:
 353                         continue;
 354
 355                 case Lexer::LEX_UNDEF:
 356                         // parse error
 357                         lex.printError("Unknown layout tag `$$Token'");
 358                         error = true;
 359                         continue;
 360
 361                 default:
 362                         break;
 363                 }
 364                 switch (static_cast<LayoutTags>(le)) {
 365                 case LT_END:
 366                         finished = true;
 367                         break;
 368
 369                 case LT_CATEGORY:
 370                         lex >> category_;
 371                         break;
 372
 373                 case LT_COPYSTYLE: {
 374                         docstring style;
 375                         lex >> style;
 376                         style = subst(style, '_', ' ');
 377
 378                         if (tclass.hasLayout(style)) {
 379                                 docstring const tmpname = name_;
 380                                 this->operator=(tclass[style]);
 381                                 name_ = tmpname;
 382                         } else {
 383                                 LYXERR0("Cannot copy unknown style `"
 384                                         << style << "'\n"
 385                                         << "All layouts so far:");
 386                                 DocumentClass::const_iterator lit = tclass.begin();
 387                                 DocumentClass::const_iterator len = tclass.end();
 388                                 for (; lit != len; ++lit)
 389                                         LYXERR0(lit->name());
 390                         }
 391                         break;
 392                         }
 393
 394                 case LT_OBSOLETEDBY: {
 395                         docstring style;
 396                         lex >> style;
 397                         style = subst(style, '_', ' ');
 398
 399                         if (tclass.hasLayout(style)) {
 400                                 docstring const tmpname = name_;
 401                                 this->operator=(tclass[style]);
 402                                 name_ = tmpname;
 403                                 if (obsoleted_by().empty())
 404                                         obsoleted_by_ = style;
 405                         } else {
 406                                 LYXERR0("Cannot replace with unknown style `"
 407                                         << style << '\'');
 408
 409                                 //lex.printError("Cannot replace with"
 410                                 //               " unknown style "
 411                                 //               "`$$Token'");
 412                         }
 413                         break;
 414                 }
 415
 416                 case LT_DEPENDSON:
 417                         lex >> depends_on_;
 418                         depends_on_ = subst(depends_on_, '_', ' ');
 419                         break;
 420
 421                 case LT_MARGIN:
 422                         readMargin(lex);
 423                         break;
 424
 425                 case LT_LATEXTYPE:
 426                         readLatexType(lex);
 427                         break;
 428
 429                 case LT_INTITLE:
 430                         lex >> intitle;
 431                         break;
 432
 433                 case LT_INPREAMBLE:
 434                         lex >> inpreamble;
 435                         break;
 436
 437                 case LT_TOCLEVEL:
 438                         lex >> toclevel;
 439                         break;
 440
 441                 case LT_RESETARGS:
 442                         bool reset;
 443                         lex >> reset;
 444                         if (reset) {
 445                                 latexargs_.clear();
 446                                 itemargs_.clear();
 447                                 postcommandargs_.clear();
 448                                 listpreamble_.clear();
 449                         }
 450                         break;
 451
 452                 case LT_RESUMECOUNTER:
 453                         lex >> resumecounter;
 454                         break;
 455
 456                 case LT_STEPPARENTCOUNTER:
 457                         lex >> stepparentcounter;
 458                         break;
 459
 460                 case LT_ARGUMENT:
 461                         readArgument(lex, validating);
 462                         break;
 463
 464                 case LT_NEED_PROTECT:
 465                         lex >> needprotect;
 466                         break;
 467
 468                 case LT_NEED_CPROTECT:
 469                         lex >> needcprotect;
 470                         break;
 471
 472                 case LT_NEED_MBOXPROTECT:
 473                         lex >> needmboxprotect;
 474                         break;
 475
 476                 case LT_KEEPEMPTY:
 477                         lex >> keepempty;
 478                         break;
 479
 480                 case LT_FONT:
 481                         font = lyxRead(lex, font);
 482                         labelfont = font;
 483                         break;
 484
 485                 case LT_TEXTFONT:
 486                         font = lyxRead(lex, font);
 487                         break;
 488
 489                 case LT_LABELFONT:
 490                         labelfont = lyxRead(lex, labelfont);
 491                         break;
 492
 493                 case LT_NEXTNOINDENT:
 494                         lex >> nextnoindent;
 495                         break;
 496
 497                 case LT_TOGGLE_INDENT: {
 498                         string tog;
 499                         lex >> tog;
 500                         tog = support::ascii_lowercase(tog);
 501                         if (tog == "always")
 502                                 toggle_indent = ITOGGLE_ALWAYS;
 503                         else if (tog == "never")
 504                                 toggle_indent = ITOGGLE_NEVER;
 505                         else
 506                                 toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
 507                         break;
 508                 }
 509
 510                 case LT_COMMANDDEPTH:
 511                         lex >> commanddepth;
 512                         break;
 513
 514                 case LT_LATEXNAME:
 515                         lex >> latexname_;
 516                         break;
 517
 518                 case LT_LATEXPARAM:
 519                         lex >> latexparam_;
 520                         latexparam_ = subst(latexparam_, "&#34;", "\"");
 521                         break;
 522
 523                 case LT_LEFTDELIM:
 524                         lex >> leftdelim_;
 525                         leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
 526                                                     from_ascii("\n"));
 527                         break;
 528
 529                 case LT_RIGHTDELIM:
 530                         lex >> rightdelim_;
 531                         rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
 532                                                      from_ascii("\n"));
 533                         break;
 534
 535                 case LT_INNERTAG:
 536                         lex >> innertag_;
 537                         break;
 538
 539                 case LT_LABELTAG:
 540                         lex >> labeltag_;
 541                         break;
 542
 543                 case LT_ITEMTAG:
 544                         lex >> itemtag_;
 545                         break;
 546
 547                 case LT_ITEMCOMMAND:
 548                         lex >> itemcommand_;
 549                         break;
 550
 551                 case LT_PREAMBLE:
 552                         preamble_ = lex.getLongString(from_ascii("EndPreamble"));
 553                         break;
 554
 555                 case LT_LANGPREAMBLE:
 556                         langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
 557                         break;
 558
 559                 case LT_BABELPREAMBLE:
 560                         babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
 561                         break;
 562
 563                 case LT_LABELTYPE:
 564                         readLabelType(lex);
 565                         break;
 566
 567                 case LT_ENDLABELTYPE:
 568                         readEndLabelType(lex);
 569                         break;
 570
 571                 case LT_LEFTMARGIN:
 572                         lex >> leftmargin;
 573                         break;
 574
 575                 case LT_RIGHTMARGIN:
 576                         lex >> rightmargin;
 577                         break;
 578
 579                 case LT_LABELINDENT:
 580                         lex >> labelindent;
 581                         break;
 582
 583                 case LT_PARINDENT:
 584                         lex >> parindent;
 585                         break;
 586
 587                 case LT_PARSKIP:
 588                         lex >> parskip;
 589                         break;
 590
 591                 case LT_ITEMSEP:
 592                         lex >> itemsep;
 593                         break;
 594
 595                 case LT_TOPSEP:
 596                         lex >> topsep;
 597                         break;
 598
 599                 case LT_BOTTOMSEP:
 600                         lex >> bottomsep;
 601                         break;
 602
 603                 case LT_LABEL_BOTTOMSEP:
 604                         lex >> labelbottomsep;
 605                         break;
 606
 607                 case LT_LABELSEP:
 608                         lex >> labelsep;
 609                         labelsep = subst(labelsep, 'x', ' ');
 610                         break;
 611
 612                 case LT_PARSEP:
 613                         lex >> parsep;
 614                         break;
 615
 616                 case LT_NEWLINE:
 617                         lex >> newline_allowed;
 618                         break;
 619
 620                 case LT_ALIGN:
 621                         readAlign(lex);
 622                         break;
 623
 624                 case LT_ALIGNPOSSIBLE:
 625                         readAlignPossible(lex);
 626                         break;
 627
 628                 case LT_LABELSTRING:
 629                         // FIXME: this means LT_LABELSTRING_APPENDIX may only
 630                         // occur after LT_LABELSTRING
 631                         lex >> labelstring_;
 632                         labelstring_appendix_ = labelstring_;
 633                         break;
 634
 635                 case LT_ENDLABELSTRING:
 636                         lex >> endlabelstring_;
 637                         break;
 638
 639                 case LT_LABELSTRING_APPENDIX:
 640                         lex >> labelstring_appendix_;
 641                         break;
 642
 643                 case LT_LABELCOUNTER:
 644                         lex >> counter;
 645                         break;
 646
 647                 case LT_PAR_GROUP:
 648                         lex >> par_group_;
 649                         break;
 650
 651                 case LT_FREE_SPACING:
 652                         lex >> free_spacing;
 653                         break;
 654
 655                 case LT_PASS_THRU:
 656                         lex >> pass_thru;
 657                         break;
 658
 659                 case LT_PASS_THRU_CHARS:
 660                         lex >> pass_thru_chars;
 661                         break;
 662
 663                 case LT_PARBREAK_IS_NEWLINE:
 664                         lex >> parbreak_is_newline;
 665                         break;
 666
 667                 case LT_SPACING:
 668                         readSpacing(lex);
 669                         break;
 670
 671                 case LT_REQUIRES: {
 672                         lex.eatLine();
 673                         vector<string> const req =
 674                                 getVectorFromString(lex.getString(true));
 675                         required_.insert(req.begin(), req.end());
 676                         break;
 677                 }
 678
 679                 case LT_AUTONESTS: {
 680                         docstring autonest = lex.getLongString(from_ascii("EndAutoNests"));
 681                         autonest = subst(autonest, from_ascii("\n"), docstring());
 682                         autonest = subst(autonest, from_ascii("\t"), docstring());
 683                         autonest = subst(autonest, from_ascii("\""), docstring());
 684                         autonest = subst(autonest, '_', ' ');
 685                         vector<docstring> const autonests =
 686                                 getVectorFromString(autonest, from_ascii(","), false, true);
 687                         autonests_.insert(autonests.begin(), autonests.end());
 688                         break;
 689                 }
 690
 691                 case LT_AUTONESTEDBY: {
 692                         docstring autonest = lex.getLongString(from_ascii("EndIsAutoNestedBy"));
 693                         autonest = subst(autonest, from_ascii("\n"), docstring());
 694                         autonest = subst(autonest, from_ascii("\t"), docstring());
 695                         autonest = subst(autonest, from_ascii("\""), docstring());
 696                         autonest = subst(autonest, '_', ' ');
 697                         vector<docstring> const autonests =
 698                                 getVectorFromString(autonest, from_ascii(","), false, true);
 699                         autonested_by_.insert(autonests.begin(), autonests.end());
 700                         break;
 701                 }
 702
 703                 case LT_REFPREFIX: {
 704                         docstring arg;
 705                         lex >> arg;
 706                         if (arg == "OFF")
 707                                 refprefix.clear();
 708                         else
 709                                 refprefix = arg;
 710                         break;
 711                 }
 712
 713                 case LT_HTMLINTOC:
 714                         lex >> htmlintoc_;
 715                         break;
 716
 717                 case LT_HTMLTAG:
 718                         lex >> htmltag_;
 719                         break;
 720
 721                 case LT_HTMLATTR:
 722                         lex >> htmlattr_;
 723                         break;
 724
 725                 case LT_HTMLCLASS:
 726                         lex >> htmlclass_;
 727                         break;
 728
 729                 case LT_HTMLITEM:
 730                         lex >> htmlitemtag_;
 731                         break;
 732
 733                 case LT_HTMLITEMATTR:
 734                         lex >> htmlitemattr_;
 735                         break;
 736
 737                 case LT_HTMLLABEL:
 738                         lex >> htmllabeltag_;
 739                         break;
 740
 741                 case LT_HTMLLABELATTR:
 742                         lex >> htmllabelattr_;
 743                         break;
 744
 745                 case LT_HTMLLABELFIRST:
 746                         lex >> htmllabelfirst_;
 747                         break;
 748
 749                 case LT_HTMLSTYLE:
 750                         htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
 751                         break;
 752
 753                 case LT_HTMLFORCECSS:
 754                         lex >> htmlforcecss_;
 755                         break;
 756
 757                 case LT_HTMLPREAMBLE:
 758                         htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
 759                         break;
 760
 761                 case LT_HTMLTITLE:
 762                         lex >> htmltitle_;
 763                         break;
 764
 765                 case LT_DOCBOOKTAG:
 766                         lex >> docbooktag_;
 767                         break;
 768
 769                 case LT_DOCBOOKATTR:
 770                         lex >> docbookattr_;
 771                         break;
 772
 773                 case LT_DOCBOOKTAGTYPE:
 774                         lex >> docbooktagtype_;
 775                         break;
 776
 777                 case LT_DOCBOOKINNERTAG:
 778                         lex >> docbookinnertag_;
 779                         break;
 780
 781                 case LT_DOCBOOKINNERATTR:
 782                         lex >> docbookinnerattr_;
 783                         break;
 784
 785                 case LT_DOCBOOKINNERTAGTYPE:
 786                         lex >> docbookinnertagtype_;
 787                         break;
 788
 789                 case LT_DOCBOOKFORCEABSTRACTTAG:
 790                         lex >> docbookforceabstracttag_;
 791                         break;
 792
 793                 case LT_DOCBOOKININFO:
 794                         lex >> docbookininfo_;
 795                         break;
 796
 797                 case LT_DOCBOOKABSTRACT:
 798                         lex >> docbookabstract_;
 799                         break;
 800
 801                 case LT_DOCBOOKWRAPPERTAG:
 802                         lex >> docbookwrappertag_;
 803                         break;
 804
 805                 case LT_DOCBOOKWRAPPERATTR:
 806                         lex >> docbookwrapperattr_;
 807                         break;
 808
 809                 case LT_DOCBOOKWRAPPERTAGTYPE:
 810                         lex >> docbookwrappertagtype_;
 811                         break;
 812
 813                 case LT_DOCBOOKWRAPPERMERGEWITHPREVIOUS:
 814                         lex >> docbookwrappermergewithprevious_;
 815                         break;
 816
 817                 case LT_DOCBOOKSECTION:
 818                         lex >> docbooksection_;
 819                         break;
 820
 821                 case LT_DOCBOOKSECTIONTAG:
 822                         lex >> docbooksectiontag_;
 823                         break;
 824
 825                 case LT_DOCBOOKITEMWRAPPERTAG:
 826                         lex >> docbookitemwrappertag_;
 827                         break;
 828
 829                 case LT_DOCBOOKITEMWRAPPERATTR:
 830                         lex >> docbookitemwrapperattr_;
 831                         break;
 832
 833                 case LT_DOCBOOKITEMWRAPPERTAGTYPE:
 834                         lex >> docbookitemwrappertagtype_;
 835                         break;
 836
 837                 case LT_DOCBOOKITEMTAG:
 838                         lex >> docbookitemtag_;
 839                         break;
 840
 841                 case LT_DOCBOOKITEMATTR:
 842                         lex >> docbookitemattr_;
 843                         break;
 844
 845                 case LT_DOCBOOKITEMTAGTYPE:
 846                         lex >> docbookitemtagtype_;
 847                         break;
 848
 849                 case LT_DOCBOOKITEMLABELTAG:
 850                         lex >> docbookitemlabeltag_;
 851                         break;
 852
 853                 case LT_DOCBOOKITEMLABELATTR:
 854                         lex >> docbookitemlabelattr_;
 855                         break;
 856
 857                 case LT_DOCBOOKITEMLABELTAGTYPE:
 858                         lex >> docbookitemlabeltagtype_;
 859                         break;
 860
 861                 case LT_DOCBOOKITEMINNERTAG:
 862                         lex >> docbookiteminnertag_;
 863                         break;
 864
 865                 case LT_DOCBOOKITEMINNERATTR:
 866                         lex >> docbookiteminnerattr_;
 867                         break;
 868
 869                 case LT_DOCBOOKITEMINNERTAGTYPE:
 870                         lex >> docbookiteminnertagtype_;
 871                         break;
 872
 873         case LT_DOCBOOKNOFONTINSIDE:
 874             lex >> docbooknofontinside_;
 875             break;
 876
 877         case LT_DOCBOOKGENERATETITLE:
 878             lex >> docbookgeneratetitle_;
 879             break;
 880
 881                 case LT_SPELLCHECK:
 882                         lex >> spellcheck;
 883                         break;
 884
 885                 case LT_FORCELOCAL:
 886                         lex >> forcelocal;
 887                         break;
 888
 889                 case LT_ADDTOTOC:
 890                         lex >> toc_type_;
 891                         add_to_toc_ = !toc_type_.empty();
 892                         break;
 893
 894                 case LT_ISTOCCAPTION:
 895                         lex >> is_toc_caption_;
 896                         break;
 897
 898                 }
 899         }
 900         lex.popTable();
 901         // make sure we only have inpreamble = true for commands
 902         if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
 903                 LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
 904                 LYXERR0("Layout name: " << name());
 905                 inpreamble = false;
 906         }
 907
 908         return finished && !error;
 909 }
 910
 911
 912 enum {
 913         AT_BLOCK = 1,
 914         AT_LEFT,
 915         AT_RIGHT,
 916         AT_CENTER,
 917         AT_LAYOUT
 918 };
 919
 920
 921 LexerKeyword alignTags[] = {
 922         { "block",  AT_BLOCK },
 923         { "center", AT_CENTER },
 924         { "layout", AT_LAYOUT },
 925         { "left",   AT_LEFT },
 926         { "right",  AT_RIGHT }
 927 };
 928
 929
 930 void Layout::readAlign(Lexer & lex)
 931 {
 932         PushPopHelper pph(lex, alignTags);
 933         int le = lex.lex();
 934         switch (le) {
 935         case Lexer::LEX_UNDEF:
 936                 lex.printError("Unknown alignment `$$Token'");
 937                 return;
 938         default: break;
 939         };
 940         switch (le) {
 941         case AT_BLOCK:
 942                 align = LYX_ALIGN_BLOCK;
 943                 break;
 944         case AT_LEFT:
 945                 align = LYX_ALIGN_LEFT;
 946                 break;
 947         case AT_RIGHT:
 948                 align = LYX_ALIGN_RIGHT;
 949                 break;
 950         case AT_CENTER:
 951                 align = LYX_ALIGN_CENTER;
 952                 break;
 953         case AT_LAYOUT:
 954                 align = LYX_ALIGN_LAYOUT;
 955                 break;
 956         }
 957 }
 958
 959
 960 void Layout::readAlignPossible(Lexer & lex)
 961 {
 962         lex.pushTable(alignTags);
 963         alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
 964         int lineno = lex.lineNumber();
 965         do {
 966                 int le = lex.lex();
 967                 switch (le) {
 968                 case Lexer::LEX_UNDEF:
 969                         lex.printError("Unknown alignment `$$Token'");
 970                         continue;
 971                 default: break;
 972                 };
 973                 switch (le) {
 974                 case AT_BLOCK:
 975                         alignpossible |= LYX_ALIGN_BLOCK;
 976                         break;
 977                 case AT_LEFT:
 978                         alignpossible |= LYX_ALIGN_LEFT;
 979                         break;
 980                 case AT_RIGHT:
 981                         alignpossible |= LYX_ALIGN_RIGHT;
 982                         break;
 983                 case AT_CENTER:
 984                         alignpossible |= LYX_ALIGN_CENTER;
 985                         break;
 986                 case AT_LAYOUT:
 987                         alignpossible |= LYX_ALIGN_LAYOUT;
 988                         break;
 989                 }
 990         } while (lineno == lex.lineNumber());
 991         lex.popTable();
 992 }
 993
 994
 995 void Layout::readLabelType(Lexer & lex)
 996 {
 997         enum {
 998                 LA_NO_LABEL = 1,
 999                 LA_MANUAL,
1000                 LA_ABOVE,
1001                 LA_CENTERED,
1002                 LA_STATIC,
1003                 LA_SENSITIVE,
1004                 LA_ENUMERATE,
1005                 LA_ITEMIZE,
1006                 LA_BIBLIO
1007         };
1008
1009
1010         LexerKeyword labelTypeTags[] = {
1011           { "above",        LA_ABOVE },
1012                 { "bibliography", LA_BIBLIO },
1013                 { "centered",     LA_CENTERED },
1014                 { "enumerate",    LA_ENUMERATE },
1015                 { "itemize",      LA_ITEMIZE },
1016                 { "manual",       LA_MANUAL },
1017                 { "no_label",     LA_NO_LABEL },
1018                 { "sensitive",    LA_SENSITIVE },
1019                 { "static",       LA_STATIC }
1020         };
1021
1022         PushPopHelper pph(lex, labelTypeTags);
1023         int le = lex.lex();
1024         switch (le) {
1025         case Lexer::LEX_UNDEF:
1026                 lex.printError("Unknown labeltype tag `$$Token'");
1027                 return;
1028         default: break;
1029         }
1030         switch (le) {
1031         case LA_NO_LABEL:
1032                 labeltype = LABEL_NO_LABEL;
1033                 break;
1034         case LA_MANUAL:
1035                 labeltype = LABEL_MANUAL;
1036                 break;
1037         case LA_ABOVE:
1038                 labeltype = LABEL_ABOVE;
1039                 break;
1040         case LA_CENTERED:
1041                 labeltype = LABEL_CENTERED;
1042                 break;
1043         case LA_STATIC:
1044                 labeltype = LABEL_STATIC;
1045                 break;
1046         case LA_SENSITIVE:
1047                 labeltype = LABEL_SENSITIVE;
1048                 break;
1049         case LA_ENUMERATE:
1050                 labeltype = LABEL_ENUMERATE;
1051                 break;
1052         case LA_ITEMIZE:
1053                 labeltype = LABEL_ITEMIZE;
1054                 break;
1055         case LA_BIBLIO:
1056                 labeltype = LABEL_BIBLIO;
1057                 break;
1058         }
1059 }
1060
1061
1062 void Layout::readEndLabelType(Lexer & lex)
1063 {
1064         // this should be const, but can't be because
1065         // of PushPopHelper.
1066         static LexerKeyword endlabelTypeTags[] = {
1067                 { "box",              END_LABEL_BOX },
1068                 { "filled_box", END_LABEL_FILLED_BOX },
1069                 { "no_label",     END_LABEL_NO_LABEL },
1070                 { "static",     END_LABEL_STATIC }
1071         };
1072
1073         PushPopHelper pph(lex, endlabelTypeTags);
1074         int le = lex.lex();
1075         switch (le) {
1076         case Lexer::LEX_UNDEF:
1077                 lex.printError("Unknown labeltype tag `$$Token'");
1078                 break;
1079         case END_LABEL_STATIC:
1080         case END_LABEL_BOX:
1081         case END_LABEL_FILLED_BOX:
1082         case END_LABEL_NO_LABEL:
1083                 endlabeltype = static_cast<EndLabelType>(le);
1084                 break;
1085         default:
1086                 LYXERR0("Unhandled value " << le);
1087                 break;
1088         }
1089 }
1090
1091
1092 void Layout::readMargin(Lexer & lex)
1093 {
1094         LexerKeyword marginTags[] = {
1095                 { "dynamic",           MARGIN_DYNAMIC },
1096                 { "first_dynamic",     MARGIN_FIRST_DYNAMIC },
1097                 { "manual",            MARGIN_MANUAL },
1098                 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
1099                 { "static",            MARGIN_STATIC }
1100         };
1101
1102         PushPopHelper pph(lex, marginTags);
1103
1104         int le = lex.lex();
1105         switch (le) {
1106         case Lexer::LEX_UNDEF:
1107                 lex.printError("Unknown margin type tag `$$Token'");
1108                 return;
1109         case MARGIN_STATIC:
1110         case MARGIN_MANUAL:
1111         case MARGIN_DYNAMIC:
1112         case MARGIN_FIRST_DYNAMIC:
1113         case MARGIN_RIGHT_ADDRESS_BOX:
1114                 margintype = static_cast<MarginType>(le);
1115                 break;
1116         default:
1117                 LYXERR0("Unhandled value " << le);
1118                 break;
1119         }
1120 }
1121
1122
1123 void Layout::readLatexType(Lexer & lex)
1124 {
1125         LexerKeyword latexTypeTags[] = {
1126                 { "bib_environment",  LATEX_BIB_ENVIRONMENT },
1127                 { "command",          LATEX_COMMAND },
1128                 { "environment",      LATEX_ENVIRONMENT },
1129                 { "item_environment", LATEX_ITEM_ENVIRONMENT },
1130                 { "list_environment", LATEX_LIST_ENVIRONMENT },
1131                 { "paragraph",        LATEX_PARAGRAPH }
1132         };
1133
1134         PushPopHelper pph(lex, latexTypeTags);
1135         int le = lex.lex();
1136         switch (le) {
1137         case Lexer::LEX_UNDEF:
1138                 lex.printError("Unknown latextype tag `$$Token'");
1139                 return;
1140         case LATEX_PARAGRAPH:
1141         case LATEX_COMMAND:
1142         case LATEX_ITEM_ENVIRONMENT:
1143         case LATEX_LIST_ENVIRONMENT:
1144                 latextype = static_cast<LatexType>(le);
1145                 break;
1146         case LATEX_ENVIRONMENT:
1147         case LATEX_BIB_ENVIRONMENT:
1148                 latextype = static_cast<LatexType>(le);
1149                 par_group_ = true;
1150                 break;
1151         default:
1152                 LYXERR0("Unhandled value " << le);
1153                 break;
1154         }
1155 }
1156
1157
1158 void Layout::readSpacing(Lexer & lex)
1159 {
1160         enum {
1161                 ST_SPACING_SINGLE = 1,
1162                 ST_SPACING_ONEHALF,
1163                 ST_SPACING_DOUBLE,
1164                 ST_OTHER
1165         };
1166
1167         LexerKeyword spacingTags[] = {
1168                 {"double",  ST_SPACING_DOUBLE },
1169                 {"onehalf", ST_SPACING_ONEHALF },
1170                 {"other",   ST_OTHER },
1171                 {"single",  ST_SPACING_SINGLE }
1172         };
1173
1174         PushPopHelper pph(lex, spacingTags);
1175         int le = lex.lex();
1176         switch (le) {
1177         case Lexer::LEX_UNDEF:
1178                 lex.printError("Unknown spacing token `$$Token'");
1179                 return;
1180         default: break;
1181         }
1182         switch (le) {
1183         case ST_SPACING_SINGLE:
1184                 spacing.set(Spacing::Single);
1185                 break;
1186         case ST_SPACING_ONEHALF:
1187                 spacing.set(Spacing::Onehalf);
1188                 break;
1189         case ST_SPACING_DOUBLE:
1190                 spacing.set(Spacing::Double);
1191                 break;
1192         case ST_OTHER:
1193                 lex.next();
1194                 spacing.set(Spacing::Other, lex.getString());
1195                 break;
1196         }
1197 }
1198
1199
1200 void Layout::readArgument(Lexer & lex, bool validating)
1201 {
1202         if (!lex.next()) {
1203                 LYXERR0("Unable to read argument ID!");
1204                 return;
1205         }
1206         string const id = lex.getString();
1207
1208         bool const itemarg = prefixIs(id, "item:");
1209         bool const postcmd = prefixIs(id, "post:");
1210         bool const listpreamble = prefixIs(id, "listpreamble:");
1211
1212         LaTeXArgMap & lam = itemarg ? itemargs_ :
1213                         (postcmd ? postcommandargs_ :
1214                         (listpreamble ? listpreamble_ :
1215                         latexargs_));
1216         latexarg & arg = lam[id];
1217
1218         if (listpreamble)
1219                 // list preamble has no delimiters by default
1220                 arg.nodelims = true;
1221
1222         bool error = false;
1223         bool finished = false;
1224         while (!finished && lex.isOK() && !error) {
1225                 lex.next();
1226                 string const tok = ascii_lowercase(lex.getString());
1227
1228                 if (tok.empty()) {
1229                         continue;
1230                 } else if (tok == "endargument") {
1231                         finished = true;
1232                 } else if (tok == "labelstring") {
1233                         lex.next();
1234                         arg.labelstring = lex.getDocString();
1235                 } else if (tok == "menustring") {
1236                         lex.next();
1237                         arg.menustring = lex.getDocString();
1238                 } else if (tok == "mandatory") {
1239                         lex.next();
1240                         arg.mandatory = lex.getBool();
1241                 } else if (tok == "autoinsert") {
1242                         lex.next();
1243                         arg.autoinsert = lex.getBool();
1244                 } else if (tok == "insertcotext") {
1245                         lex.next();
1246                         arg.insertcotext = lex.getBool();
1247                 } else if (tok == "leftdelim") {
1248                         lex.next();
1249                         arg.ldelim = lex.getDocString();
1250                         arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
1251                                                     from_ascii("\n"));
1252                 } else if (tok == "rightdelim") {
1253                         lex.next();
1254                         arg.rdelim = lex.getDocString();
1255                         arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
1256                                                     from_ascii("\n"));
1257                 } else if (tok == "defaultarg") {
1258                         lex.next();
1259                         arg.defaultarg = lex.getDocString();
1260                 } else if (tok == "presetarg") {
1261                         lex.next();
1262                         arg.presetarg = lex.getDocString();
1263                 } else if (tok == "tooltip") {
1264                         lex.next();
1265                         arg.tooltip = lex.getDocString();
1266                 } else if (tok == "requires") {
1267                         lex.next();
1268                         arg.required = lex.getString();
1269                 } else if (tok == "decoration") {
1270                         lex.next();
1271                         arg.decoration = lex.getString();
1272                 } else if (tok == "newlinecmd") {
1273                         lex.next();
1274                         arg.newlinecmd = lex.getString();
1275                 } else if (tok == "font") {
1276                         arg.font = lyxRead(lex, arg.font);
1277                 } else if (tok == "labelfont") {
1278                         arg.labelfont = lyxRead(lex, arg.labelfont);
1279                 } else if (tok == "passthruchars") {
1280                         lex.next();
1281                         arg.pass_thru_chars = lex.getDocString();
1282                 } else if (tok == "passthru") {
1283                         lex.next();
1284                         docstring value = lex.getDocString();
1285                         if (value == "true" || value == "1")
1286                                 arg.passthru = PT_TRUE;
1287                         else if (value == "false" || value == "0")
1288                                 arg.passthru = PT_FALSE;
1289                         else
1290                                 arg.passthru = PT_INHERITED;
1291                 } else if (tok == "istoccaption") {
1292                         lex.next();
1293                         arg.is_toc_caption = lex.getBool();
1294                 } else if (tok == "freespacing") {
1295                         lex.next();
1296                         arg.free_spacing = lex.getBool();
1297                 } else if (tok == "docbooktag") {
1298                         lex.next();
1299                         arg.docbooktag = lex.getDocString();
1300                 } else if (tok == "docbookattr") {
1301                         lex.next();
1302                         arg.docbookattr = lex.getDocString();
1303                 } else if (tok == "docbooktagtype") {
1304                         lex.next();
1305                         arg.docbooktagtype = lex.getDocString();
1306                 } else if (tok == "docbookargumentaftermaintag") {
1307                         lex.next();
1308                         arg.docbookargumentaftermaintag = lex.getBool();
1309                 } else if (tok == "docbookargumentbeforemaintag") {
1310                         lex.next();
1311                         arg.docbookargumentbeforemaintag = lex.getBool();
1312                 } else {
1313                         lex.printError("Unknown tag");
1314                         error = true;
1315                 }
1316         }
1317         if (!validating && arg.labelstring.empty()) {
1318                 LYXERR0("Incomplete Argument definition!");
1319                 // remove invalid definition
1320                 lam.erase(id);
1321         }
1322 }
1323
1324
1325 void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
1326 {
1327         os << "\tArgument " << id << '\n';
1328         if (!arg.labelstring.empty())
1329                 os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
1330         if (!arg.menustring.empty())
1331                 os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
1332         if (arg.mandatory)
1333                 os << "\t\tMandatory " << arg.mandatory << '\n';
1334         if (arg.autoinsert)
1335                 os << "\t\tAutoinsert " << arg.autoinsert << '\n';
1336         if (arg.insertcotext)
1337                 os << "\t\tInsertCotext " << arg.insertcotext << '\n';
1338         if (!arg.ldelim.empty())
1339                 os << "\t\tLeftDelim \""
1340                    << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
1341                    << "\"\n";
1342         if (!arg.rdelim.empty())
1343                 os << "\t\tRightDelim \""
1344                    << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
1345                    << "\"\n";
1346         if (!arg.defaultarg.empty())
1347                 os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
1348         if (!arg.presetarg.empty())
1349                 os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
1350         if (!arg.tooltip.empty())
1351                 os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
1352         if (!arg.required.empty())
1353                 os << "\t\tRequires \"" << arg.required << "\"\n";
1354         if (!arg.decoration.empty())
1355                 os << "\t\tDecoration \"" << arg.decoration << "\"\n";
1356         if (!arg.newlinecmd.empty())
1357                 os << "\t\tNewlineCmd \"" << arg.newlinecmd << "\"\n";
1358         if (arg.font != inherit_font)
1359                 lyxWrite(os, arg.font, "Font", 2);
1360         if (arg.labelfont != inherit_font)
1361                 lyxWrite(os, arg.labelfont, "LabelFont", 2);
1362         switch (arg.passthru) {
1363                 case PT_TRUE:
1364                         os << "\t\tPassThru true\n";
1365                         break;
1366                 case PT_FALSE:
1367                         os << "\t\tPassThru false\n";
1368                         break;
1369                 case PT_INHERITED:
1370                         os << "\t\tPassThru inherited\n";
1371                         break;
1372         }
1373         if (!arg.pass_thru_chars.empty())
1374                 os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
1375         if (arg.free_spacing)
1376                 os << "\t\tFreeSpacing " << arg.free_spacing << "\n";
1377         os << "\tEndArgument\n";
1378 }
1379
1380
1381 void Layout::write(ostream & os) const
1382 {
1383         os << "Style \"" << to_utf8(name_) << "\"\n";
1384         if (!category_.empty() && obsoleted_by_.empty())
1385                 os << "\tCategory \"" << to_utf8(category_) << "\"\n";
1386         // Can't deduce Copystyle here :-(
1387         if (!obsoleted_by_.empty()) {
1388                 os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
1389                    << "\"\nEnd\n";
1390                 return;
1391         }
1392         if (!depends_on_.empty())
1393                 os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
1394         switch (margintype) {
1395                 case MARGIN_DYNAMIC:
1396                         os << "\tMargin Dynamic\n";
1397                         break;
1398                 case MARGIN_FIRST_DYNAMIC:
1399                         os << "\tMargin First_Dynamic\n";
1400                         break;
1401                 case MARGIN_MANUAL:
1402                         os << "\tMargin Manual\n";
1403                         break;
1404                 case MARGIN_RIGHT_ADDRESS_BOX:
1405                         os << "\tMargin Right_Address_Box\n";
1406                         break;
1407                 case MARGIN_STATIC:
1408                         os << "\tMargin Static\n";
1409                         break;
1410         }
1411         switch (latextype) {
1412                 case LATEX_BIB_ENVIRONMENT:
1413                         os << "\tLatexType Bib_Environment\n";
1414                         break;
1415                 case LATEX_COMMAND:
1416                         os << "\tLatexType Command\n";
1417                         break;
1418                 case LATEX_ENVIRONMENT:
1419                         os << "\tLatexType Environment\n";
1420                         break;
1421                 case LATEX_ITEM_ENVIRONMENT:
1422                         os << "\tLatexType Item_Environment\n";
1423                         break;
1424                 case LATEX_LIST_ENVIRONMENT:
1425                         os << "\tLatexType List_Environment\n";
1426                         break;
1427                 case LATEX_PARAGRAPH:
1428                         os << "\tLatexType Paragraph\n";
1429                         break;
1430         }
1431         os << "\tInTitle " << intitle << "\n"
1432               "\tInPreamble " << inpreamble << "\n"
1433               "\tTocLevel " << toclevel << "\n"
1434               "\tResumeCounter " << resumecounter << "\n"
1435               "\tStepParentCounter " << stepparentcounter << '\n';
1436         // ResetArgs does not make sense here
1437         for (LaTeXArgMap::const_iterator it = latexargs_.begin();
1438              it != latexargs_.end(); ++it)
1439                 writeArgument(os, it->first, it->second);
1440         for (LaTeXArgMap::const_iterator it = itemargs_.begin();
1441              it != itemargs_.end(); ++it)
1442                 writeArgument(os, it->first, it->second);
1443         for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
1444              it != postcommandargs_.end(); ++it)
1445                 writeArgument(os, it->first, it->second);
1446         for (LaTeXArgMap::const_iterator it = listpreamble_.begin();
1447              it != listpreamble_.end(); ++it)
1448                 writeArgument(os, it->first, it->second);
1449         os << "\tNeedProtect " << needprotect << "\n"
1450               "\tNeedCProtect " << needcprotect << "\n"
1451               "\tNeedMBoxProtect " << needmboxprotect << "\n"
1452               "\tKeepEmpty " << keepempty << '\n';
1453         if (labelfont == font)
1454                 lyxWrite(os, font, "Font", 1);
1455         else {
1456                 lyxWrite(os, font, "TextFont", 1);
1457                 lyxWrite(os, labelfont, "LabelFont", 1);
1458         }
1459         os << "\tNextNoIndent " << nextnoindent << "\n"
1460               "\tCommandDepth " << commanddepth << '\n';
1461         if (!latexname_.empty())
1462                 os << "\tLatexName \"" << latexname_ << "\"\n";
1463         if (!latexparam_.empty())
1464                 os << "\tLatexParam \"" << subst(latexparam_, "\"", "&#34;")
1465                    << "\"\n";
1466         if (!leftdelim_.empty())
1467                 os << "\tLeftDelim "
1468                    << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
1469                    << '\n';
1470         if (!rightdelim_.empty())
1471                 os << "\tRightDelim "
1472                    << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
1473                    << '\n';
1474         if (!innertag_.empty())
1475                 os << "\tInnerTag \"" << innertag_ << "\"\n";
1476         if (!labeltag_.empty())
1477                 os << "\tLabelTag \"" << labeltag_ << "\"\n";
1478         if (!itemtag_.empty())
1479                 os << "\tItemTag \"" << itemtag_ << "\"\n";
1480         if (!itemcommand_.empty())
1481                 os << "\tItemCommand " << itemcommand_ << '\n';
1482         if (!preamble_.empty())
1483                 os << "\tPreamble\n\t"
1484                    << to_utf8(subst(rtrim(preamble_, "\n"),
1485                                     from_ascii("\n"), from_ascii("\n\t")))
1486                    << "\n\tEndPreamble\n";
1487         if (!langpreamble_.empty())
1488                 os << "\tLangPreamble\n\t"
1489                    << to_utf8(subst(rtrim(langpreamble_, "\n"),
1490                                     from_ascii("\n"), from_ascii("\n\t")))
1491                    << "\n\tEndLangPreamble\n";
1492         if (!babelpreamble_.empty())
1493                 os << "\tBabelPreamble\n\t"
1494                    << to_utf8(subst(rtrim(babelpreamble_, "\n"),
1495                                     from_ascii("\n"), from_ascii("\n\t")))
1496                    << "\n\tEndBabelPreamble\n";
1497         switch (labeltype) {
1498         case LABEL_ABOVE:
1499                 os << "\tLabelType Above\n";
1500                 break;
1501         case LABEL_BIBLIO:
1502                 os << "\tLabelType Bibliography\n";
1503                 break;
1504         case LABEL_CENTERED:
1505                 os << "\tLabelType Centered\n";
1506                 break;
1507         case LABEL_ENUMERATE:
1508                 os << "\tLabelType Enumerate\n";
1509                 break;
1510         case LABEL_ITEMIZE:
1511                 os << "\tLabelType Itemize\n";
1512                 break;
1513         case LABEL_MANUAL:
1514                 os << "\tLabelType Manual\n";
1515                 break;
1516         case LABEL_NO_LABEL:
1517                 os << "\tLabelType No_Label\n";
1518                 break;
1519         case LABEL_SENSITIVE:
1520                 os << "\tLabelType Sensitive\n";
1521                 break;
1522         case LABEL_STATIC:
1523                 os << "\tLabelType Static\n";
1524                 break;
1525         }
1526         switch (endlabeltype) {
1527         case END_LABEL_BOX:
1528                 os << "\tEndLabelType Box\n";
1529                 break;
1530         case END_LABEL_FILLED_BOX:
1531                 os << "\tEndLabelType Filled_Box\n";
1532                 break;
1533         case END_LABEL_NO_LABEL:
1534                 os << "\tEndLabelType No_Label\n";
1535                 break;
1536         case END_LABEL_STATIC:
1537                 os << "\tEndLabelType Static\n";
1538                 break;
1539         }
1540         os << "\tParagraphGroup \"" << par_group_ << "\"\n";
1541         if (!leftmargin.empty())
1542                 os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
1543         if (!rightmargin.empty())
1544                 os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
1545         if (!labelindent.empty())
1546                 os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
1547         if (!parindent.empty())
1548                 os << "\tParIndent " << to_utf8(parindent) << '\n';
1549         os << "\tParSkip " << parskip << "\n"
1550               "\tItemSep " << itemsep << "\n"
1551               "\tTopSep " << topsep << "\n"
1552               "\tBottomSep " << bottomsep << "\n"
1553               "\tLabelBottomSep " << labelbottomsep << '\n';
1554         if (!labelsep.empty())
1555                 os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
1556                    << '\n';
1557         os << "\tParSep " << parsep << "\n"
1558               "\tNewLine " << newline_allowed << '\n';
1559         switch (align) {
1560         case LYX_ALIGN_BLOCK:
1561                 os << "\tAlign Block\n";
1562                 break;
1563         case LYX_ALIGN_CENTER:
1564                 os << "\tAlign Center\n";
1565                 break;
1566         case LYX_ALIGN_LAYOUT:
1567                 os << "\tAlign Layout\n";
1568                 break;
1569         case LYX_ALIGN_LEFT:
1570                 os << "\tAlign Left\n";
1571                 break;
1572         case LYX_ALIGN_RIGHT:
1573                 os << "\tAlign Right\n";
1574                 break;
1575         case LYX_ALIGN_DECIMAL:
1576         case LYX_ALIGN_SPECIAL:
1577         case LYX_ALIGN_NONE:
1578                 break;
1579         }
1580         if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
1581                              LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
1582                 bool first = true;
1583                 os << "\tAlignPossible";
1584                 if (alignpossible & LYX_ALIGN_BLOCK) {
1585                         os << " Block";
1586                         first = false;
1587                 }
1588                 if (alignpossible & LYX_ALIGN_CENTER) {
1589                         if (!first)
1590                                 os << ',';
1591                         os << " Center";
1592                         first = false;
1593                 }
1594                 if (alignpossible & LYX_ALIGN_LAYOUT) {
1595                         if (!first)
1596                                 os << ',';
1597                         os << " Layout";
1598                         first = false;
1599                 }
1600                 if (alignpossible & LYX_ALIGN_LEFT) {
1601                         if (!first)
1602                                 os << ',';
1603                         os << " Left";
1604                         first = false;
1605                 }
1606                 if (alignpossible & LYX_ALIGN_RIGHT) {
1607                         if (!first)
1608                                 os << ',';
1609                         os << " Right";
1610                         first = false;
1611                 }
1612                 os << '\n';
1613         }
1614         // LabelString must come before LabelStringAppendix
1615         if (!labelstring_.empty())
1616                 os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
1617         if (!endlabelstring_.empty())
1618                 os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
1619         if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
1620                 os << "\tLabelStringAppendix \""
1621                    << to_utf8(labelstring_appendix_) << "\"\n";
1622         if (!counter.empty())
1623                 os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
1624         os << "\tFreeSpacing " << free_spacing << '\n';
1625         os << "\tPassThru " << pass_thru << '\n';
1626         if (!pass_thru_chars.empty())
1627                 os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
1628         os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
1629         switch (spacing.getSpace()) {
1630         case Spacing::Double:
1631                 os << "\tSpacing Double\n";
1632                 break;
1633         case Spacing::Onehalf:
1634                 os << "\tSpacing Onehalf\n";
1635                 break;
1636         case Spacing::Other:
1637                 os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
1638                 break;
1639         case Spacing::Single:
1640                 os << "\tSpacing Single\n";
1641                 break;
1642         case Spacing::Default:
1643                 break;
1644         }
1645         if (!required_.empty()) {
1646                 os << "\tRequires ";
1647                 for (set<string>::const_iterator it = required_.begin();
1648                      it != required_.end(); ++it) {
1649                         if (it != required_.begin())
1650                                 os << ',';
1651                         os << *it;
1652                 }
1653                 os << '\n';
1654         }
1655         if (!autonests_.empty()) {
1656                 os << "\tAutoNests\n\t";
1657                 for (set<docstring>::const_iterator it = autonests_.begin();
1658                      it != autonests_.end(); ++it) {
1659                         if (it != autonests_.begin())
1660                                 os << ',';
1661                         os << to_utf8(*it);
1662                 }
1663                 os << "\n\tEndAutoNests\n";
1664         }
1665         if (!autonested_by_.empty()) {
1666                 os << "\tIsAutoNestedBy\n\t\t";
1667                 for (set<docstring>::const_iterator it = autonested_by_.begin();
1668                      it != autonested_by_.end(); ++it) {
1669                         if (it != autonested_by_.begin())
1670                                 os << ',';
1671                         os << to_utf8(*it);
1672                 }
1673                 os << "\n\tEndIsAutoNestedBy\n";
1674         }
1675         if (refprefix.empty())
1676                 os << "\tRefPrefix OFF\n";
1677         else
1678                 os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
1679         if (!htmltag_.empty())
1680                 os << "\tHTMLTag " << htmltag_ << '\n';
1681         if (!htmlattr_.empty())
1682                 os << "\tHTMLAttr " << htmlattr_ << '\n';
1683         if (!htmlclass_.empty())
1684                 os << "\tHTMLClass " << htmlclass_ << '\n';
1685         if (!htmlintoc_)
1686                 os << "\tHTMLInToc " << htmlintoc_ << '\n';
1687         if (!htmlitemtag_.empty())
1688                 os << "\tHTMLItem " << htmlitemtag_ << '\n';
1689         if (!htmlitemattr_.empty())
1690                 os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
1691         if (!htmllabeltag_.empty())
1692                 os << "\tHTMLLabel " << htmllabeltag_ << '\n';
1693         if (!htmllabelattr_.empty())
1694                 os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
1695         os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
1696         if (!htmlstyle_.empty())
1697                 os << "\tHTMLStyle\n"
1698                    << to_utf8(rtrim(htmlstyle_, "\n"))
1699                    << "\n\tEndHTMLStyle\n";
1700         os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
1701         if (!htmlpreamble_.empty())
1702                 os << "\tHTMLPreamble\n"
1703                    << to_utf8(rtrim(htmlpreamble_, "\n"))
1704                    << "\n\tEndPreamble\n";
1705         os << "\tHTMLTitle " << htmltitle_ << "\n";
1706         if (!docbooktag_.empty())
1707                 os << "\tDocBookTag " << docbooktag_ << '\n';
1708         if (!docbookattr_.empty())
1709                 os << "\tDocBookAttr \"" << docbookattr_ << "\"\n";
1710         if (!docbooktagtype_.empty())
1711                 os << "\tDocBookTagType " << docbooktagtype_ << '\n';
1712         if (!docbookinnertag_.empty())
1713                 os << "\tDocBookInnerTag " << docbookinnertag_ << '\n';
1714         if (!docbookinnerattr_.empty())
1715                 os << "\tDocBookInnerAttr \"" << docbookinnerattr_ << "\"\n";
1716         if (!docbookinnertagtype_.empty())
1717                 os << "\tDocBookInnerTagType " << docbookinnertagtype_ << '\n';
1718         if (!docbookininfo_.empty())
1719                 os << "\tDocBookInInfo " << docbookininfo_ << '\n';
1720         os << "\tDocBookAbstract " << docbookabstract_ << '\n';
1721         if (!docbookwrappertag_.empty())
1722                 os << "\tDocBookWrapperTag " << docbookwrappertag_ << '\n';
1723         if (!docbookwrapperattr_.empty())
1724                 os << "\tDocBookWrapperAttr " << docbookwrapperattr_ << '\n';
1725         if (!docbookwrappertagtype_.empty())
1726                 os << "\tDocBookWrapperTagType " << docbookwrappertagtype_ << '\n';
1727         os << "\tDocBookSection " << docbooksection_ << '\n';
1728         if (!docbooksectiontag_.empty())
1729                 os << "\tDocBookSectionTag " << docbooksectiontag_ << '\n';
1730         if (!docbookitemtag_.empty())
1731                 os << "\tDocBookItemTag " << docbookitemtag_ << '\n';
1732         if (!docbookitemattr_.empty())
1733                 os << "\tDocBookItemAttr " << docbookitemattr_ << '\n';
1734         if (!docbookitemtagtype_.empty())
1735                 os << "\tDocBookItemTagType " << docbookitemtagtype_ << '\n';
1736         if (!docbookitemwrappertag_.empty())
1737                 os << "\tDocBookItemWrapperTag " << docbookitemwrappertag_ << '\n';
1738         if (!docbookitemwrapperattr_.empty())
1739                 os << "\tDocBookItemWrapperAttr " << docbookitemwrapperattr_ << '\n';
1740         if (!docbookitemwrappertagtype_.empty())
1741                 os << "\tDocBookItemWrapperTagType " << docbookitemwrappertagtype_ << '\n';
1742         os << "\tDocBookWrapperMergeWithPrevious " << docbookwrappermergewithprevious_ << '\n';
1743         if (!docbookitemlabeltag_.empty())
1744                 os << "\tDocBookItemLabelTag " << docbookitemlabeltag_ << '\n';
1745         if (!docbookitemlabelattr_.empty())
1746                 os << "\tDocBookItemLabelAttr " << docbookitemlabelattr_ << '\n';
1747         if (!docbookitemlabeltagtype_.empty())
1748                 os << "\tDocBookItemLabelTagType " << docbookitemlabeltagtype_ << '\n';
1749         if (!docbookiteminnertag_.empty())
1750                 os << "\tDocBookItemInnerTag " << docbookiteminnertag_ << '\n';
1751         if (!docbookiteminnerattr_.empty())
1752                 os << "\tDocBookItemInnerAttr " << docbookiteminnerattr_ << '\n';
1753         if (!docbookiteminnertagtype_.empty())
1754                 os << "\tDocBookItemInnerTagType " << docbookiteminnertagtype_ << '\n';
1755         if (!docbookforceabstracttag_.empty())
1756                 os << "\tDocBookForceAbstractTag " << docbookforceabstracttag_ << '\n';
1757     os << "\tDocBookNoFontInside " << docbooknofontinside_ << "\n"
1758               "\tSpellcheck " << spellcheck << "\n"
1759               "\tForceLocal " << forcelocal << "\n"
1760               "End\n";
1761 }
1762
1763
1764 bool Layout::hasArgs() const
1765 {
1766         return !latexargs_.empty() || !postcommandargs_.empty() ||
1767                 !itemargs_.empty() || !listpreamble_.empty();
1768 }
1769
1770
1771 Layout::LaTeXArgMap Layout::args() const
1772 {
1773         LaTeXArgMap args = latexargs_;
1774         if (!postcommandargs_.empty())
1775                 args.insert(postcommandargs_.begin(), postcommandargs_.end());
1776         if (!listpreamble_.empty())
1777                 args.insert(listpreamble_.begin(), listpreamble_.end());
1778         if (!itemargs_.empty())
1779                 args.insert(itemargs_.begin(), itemargs_.end());
1780         return args;
1781 }
1782
1783
1784 int Layout::optArgs() const
1785 {
1786         int nr = 0;
1787         LaTeXArgMap::const_iterator it = latexargs_.begin();
1788         for (; it != latexargs_.end(); ++it) {
1789                 if (!(*it).second.mandatory)
1790                         ++nr;
1791         }
1792         LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1793         for (; iit != postcommandargs_.end(); ++iit) {
1794                 if (!(*iit).second.mandatory)
1795                         ++nr;
1796         }
1797         return nr;
1798 }
1799
1800
1801 int Layout::requiredArgs() const
1802 {
1803         int nr = 0;
1804         LaTeXArgMap::const_iterator it = latexargs_.begin();
1805         for (; it != latexargs_.end(); ++it) {
1806                 if ((*it).second.mandatory)
1807                         ++nr;
1808         }
1809         LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
1810         for (; iit != postcommandargs_.end(); ++iit) {
1811                 if (!(*iit).second.mandatory)
1812                         ++nr;
1813         }
1814         return nr;
1815 }
1816
1817
1818 string const & Layout::htmltag() const
1819 {
1820         if (htmltag_.empty())
1821                 htmltag_ =  "div";
1822         return htmltag_;
1823 }
1824
1825
1826 string const & Layout::htmlclass() const
1827 {
1828         // If it's an enumeration or itemize list, then we recalculate the class each
1829         // time through (unless it has been given explicitly). So we do nothing here.
1830         if (htmlclass_.empty() && labeltype != LABEL_ENUMERATE && labeltype != LABEL_ITEMIZE)
1831                 htmlclass_ = defaultCSSClass();
1832         return htmlclass_;
1833 }
1834
1835
1836 string const & Layout::htmlGetAttrString() const {
1837         if (!htmlfullattrs_.empty())
1838                 return htmlfullattrs_;
1839         htmlfullattrs_ = htmlclass();
1840         if (!htmlfullattrs_.empty())
1841                 htmlfullattrs_ = "class='" + htmlfullattrs_ + "'";
1842         if (!htmlattr_.empty())
1843                 htmlfullattrs_ += " " + htmlattr_;
1844         return htmlfullattrs_;
1845 }
1846
1847
1848 string const & Layout::htmlitemtag() const
1849 {
1850         if (htmlitemtag_.empty())
1851                 htmlitemtag_ = "div";
1852         return htmlitemtag_;
1853 }
1854
1855
1856 string const & Layout::htmlitemattr() const
1857 {
1858         if (htmlitemattr_.empty())
1859                 htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
1860         return htmlitemattr_;
1861 }
1862
1863
1864 string const & Layout::htmllabeltag() const
1865 {
1866         if (htmllabeltag_.empty())
1867                         htmllabeltag_ = "span";
1868         return htmllabeltag_;
1869 }
1870
1871
1872 string const & Layout::htmllabelattr() const
1873 {
1874         if (htmllabelattr_.empty())
1875                 htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
1876         return htmllabelattr_;
1877 }
1878
1879
1880 docstring Layout::htmlstyle() const
1881 {
1882         if (!htmlstyle_.empty() && !htmlforcecss_)
1883                 return htmlstyle_;
1884         if (htmldefaultstyle_.empty())
1885                 makeDefaultCSS();
1886         docstring retval = htmldefaultstyle_;
1887         if (!htmlstyle_.empty())
1888                 retval += '\n' + htmlstyle_;
1889         return retval;
1890 }
1891
1892
1893 string Layout::defaultCSSClass() const
1894 {
1895         if (!defaultcssclass_.empty())
1896                 return defaultcssclass_;
1897         docstring d;
1898         docstring::const_iterator it = name().begin();
1899         docstring::const_iterator en = name().end();
1900         for (; it != en; ++it) {
1901                 char_type const c = *it;
1902                 if (!isAlphaASCII(c)) {
1903                         if (d.empty())
1904                                 // make sure we don't start with an underscore,
1905                                 // as that sometimes causes problems.
1906                                 d = from_ascii("lyx_");
1907                         else
1908                                 d += '_';
1909                 } else if (isLower(c))
1910                         d += c;
1911                 else
1912                         // this is slow, so do it only if necessary
1913                         d += lowercase(c);
1914         }
1915         defaultcssclass_ = to_utf8(d);
1916         return defaultcssclass_;
1917 }
1918
1919
1920 string const & Layout::docbooktag() const
1921 {
1922         if (docbooktag_.empty()) {
1923                 if (to_ascii(name_) == "Plain Layout")
1924                         docbooktag_ = "para";
1925                 else // No sensible default value, unhappily...
1926                         docbooktag_ = to_utf8(name_);
1927         }
1928         return docbooktag_;
1929 }
1930
1931
1932 string const & Layout::docbookattr() const
1933 {
1934         // Perfectly OK to return no attributes, so docbookattr_ does not need to be filled.
1935         return docbookattr_;
1936 }
1937
1938
1939 bool isValidTagType(std::string const & type)
1940 {
1941         return !(type.empty() || (type != "block" && type != "paragraph" && type != "inline"));
1942 }
1943
1944
1945 string const & Layout::docbooktagtype() const
1946 {
1947         if (!isValidTagType(docbooktagtype_))
1948                 docbooktagtype_ = "block";
1949         return docbooktagtype_;
1950 }
1951
1952
1953 string const & Layout::docbookinnertag() const
1954 {
1955         if (docbookinnertag_.empty())
1956                 docbookinnertag_ = "NONE";
1957         return docbookinnertag_;
1958 }
1959
1960
1961 string const & Layout::docbookinnerattr() const
1962 {
1963         return docbookinnerattr_;
1964 }
1965
1966
1967 string const & Layout::docbookinnertagtype() const
1968 {
1969         if (!isValidTagType(docbookinnertagtype_))
1970                 docbookinnertagtype_ = "block";
1971         return docbookinnertagtype_;
1972 }
1973
1974
1975 string const & Layout::docbookininfo() const
1976 {
1977         // Indeed, a trilean. Only titles should be "maybe": otherwise, metadata is "always", content is "never".
1978         if (docbookininfo_.empty() || (docbookininfo_ != "never" && docbookininfo_ != "always" && docbookininfo_ != "maybe"))
1979                 docbookininfo_ = "never";
1980         return docbookininfo_;
1981 }
1982
1983
1984 string const & Layout::docbookwrappertag() const
1985 {
1986     if (docbookwrappertag_.empty())
1987         docbookwrappertag_ = "NONE";
1988     return docbookwrappertag_;
1989 }
1990
1991
1992 string const & Layout::docbookwrapperattr() const
1993 {
1994     return docbookwrapperattr_;
1995 }
1996
1997
1998 string const & Layout::docbookwrappertagtype() const
1999 {
2000         if (!isValidTagType(docbookwrappertagtype_))
2001                 docbookwrappertagtype_ = "block";
2002         return docbookwrappertagtype_;
2003 }
2004
2005
2006 string const & Layout::docbooksectiontag() const
2007 {
2008         if (docbooksectiontag_.empty())
2009                 docbooksectiontag_ = "section";
2010         return docbooksectiontag_;
2011 }
2012
2013
2014 string const & Layout::docbookitemwrappertag() const
2015 {
2016     if (docbookitemwrappertag_.empty())
2017         docbookitemwrappertag_ = "NONE";
2018     return docbookitemwrappertag_;
2019 }
2020
2021
2022 string const & Layout::docbookitemwrapperattr() const
2023 {
2024     return docbookitemwrapperattr_;
2025 }
2026
2027
2028 string const & Layout::docbookitemwrappertagtype() const
2029 {
2030         if (!isValidTagType(docbookitemwrappertagtype_))
2031                 docbookitemwrappertagtype_ = "block";
2032         return docbookitemwrappertagtype_;
2033 }
2034
2035
2036 string const & Layout::docbookitemtag() const
2037 {
2038         if (docbookitemtag_.empty())
2039                 docbookitemtag_ = "NONE";
2040         return docbookitemtag_;
2041 }
2042
2043
2044 string const & Layout::docbookitemattr() const
2045 {
2046     return docbookitemattr_;
2047 }
2048
2049
2050 string const & Layout::docbookitemtagtype() const
2051 {
2052         if (!isValidTagType(docbookitemtagtype_))
2053                 docbookitemtagtype_ = "block";
2054         return docbookitemtagtype_;
2055 }
2056
2057
2058 string const & Layout::docbookitemlabeltag() const
2059 {
2060         if (docbookitemlabeltag_.empty())
2061                 docbookitemlabeltag_ = "NONE";
2062         return docbookitemlabeltag_;
2063 }
2064
2065
2066 string const & Layout::docbookitemlabelattr() const
2067 {
2068         return docbookitemlabelattr_;
2069 }
2070
2071
2072 string const & Layout::docbookitemlabeltagtype() const
2073 {
2074         if (!isValidTagType(docbookitemlabeltagtype_))
2075                 docbookitemlabeltagtype_ = "block";
2076         return docbookitemlabeltagtype_;
2077 }
2078
2079
2080 string const & Layout::docbookiteminnertag() const
2081 {
2082         if (docbookiteminnertag_.empty())
2083                 docbookiteminnertag_ = "NONE";
2084         return docbookiteminnertag_;
2085 }
2086
2087
2088 string const & Layout::docbookiteminnerattr() const
2089 {
2090         return docbookiteminnerattr_;
2091 }
2092
2093
2094 string const & Layout::docbookiteminnertagtype() const
2095 {
2096         if (!isValidTagType(docbookiteminnertagtype_))
2097                 docbookiteminnertagtype_ = "block";
2098         return docbookiteminnertagtype_;
2099 }
2100
2101
2102 std::string const & Layout::docbookforceabstracttag() const
2103 {
2104         if (docbookforceabstracttag_.empty())
2105                 docbookforceabstracttag_ = "NONE";
2106         return docbookforceabstracttag_;
2107 }
2108
2109
2110
2111 namespace {
2112
2113 string makeMarginValue(char const * side, double d)
2114 {
2115         ostringstream os;
2116         os << "margin-" << side << ": " << d << "ex;\n";
2117         return os.str();
2118 }
2119
2120 } // namespace
2121
2122
2123 void Layout::makeDefaultCSS() const
2124 {
2125         // this never needs to be redone, since reloading layouts will
2126         // wipe out what we did before.
2127         if (!htmldefaultstyle_.empty())
2128                 return;
2129
2130         // main font
2131         htmldefaultstyle_ = font.asCSS();
2132
2133         // bottom margins
2134         string tmp;
2135         if (topsep > 0)
2136                 tmp += makeMarginValue("top", topsep);
2137         if (bottomsep > 0)
2138                 tmp += makeMarginValue("bottom", bottomsep);
2139         if (!leftmargin.empty()) {
2140                 // we can't really do what LyX does with the margin, so
2141                 // we'll just figure out how many characters it is
2142                 int const len = leftmargin.length();
2143                 tmp += makeMarginValue("left", len);
2144         }
2145         if (!rightmargin.empty()) {
2146                 int const len = rightmargin.length();
2147                 tmp += makeMarginValue("right", len);
2148         }
2149
2150         if (!tmp.empty()) {
2151                 if (!htmldefaultstyle_.empty())
2152                         htmldefaultstyle_ += from_ascii("\n");
2153                 htmldefaultstyle_ += from_ascii(tmp);
2154         }
2155
2156         // alignment
2157         string where = alignmentToCSS(align);
2158         if (!where.empty()) {
2159                 htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
2160         }
2161
2162         // wrap up what we have, if anything
2163         if (!htmldefaultstyle_.empty())
2164                 htmldefaultstyle_ =
2165                         from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
2166                         htmldefaultstyle_ + from_ascii("\n}\n");
2167
2168         if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
2169                 return;
2170
2171         docstring labelCSS;
2172
2173         // label font
2174         if (labelfont != font)
2175                 labelCSS = labelfont.asCSS() + from_ascii("\n");
2176         if (labeltype == LABEL_CENTERED)
2177                 labelCSS += from_ascii("text-align: center;\n");
2178
2179         if (!labelCSS.empty())
2180                 htmldefaultstyle_ +=
2181                         from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
2182                         labelCSS + from_ascii("\n}\n");
2183 }
2184
2185
2186 bool Layout::operator==(Layout const & rhs) const
2187 {
2188         // This is enough for the applications we actually make,
2189         // at least at the moment. But we could check more.
2190         return name() == rhs.name()
2191                 && latexname() == rhs.latexname()
2192                 && latextype == rhs.latextype;
2193 }
2194
2195
2196 } // namespace lyx