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