src/Layout.cpp

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