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