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