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