src/Layout.cpp

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