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