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 "TextClass.h"
  17 #include "Lexer.h"
  18 #include "Font.h"
  19
  20 #include "support/debug.h"
  21 #include "support/lstrings.h"
  22
  23 #include <ostream>
  24
  25 using namespace std;
  26 using namespace lyx::support;
  27
  28 namespace lyx {
  29
  30 /// Special value of toclevel for layouts that to not belong in a TOC
  31 const int Layout::NOT_IN_TOC = -1000;
  32
  33 //  The order of the LayoutTags enum is no more important. [asierra300396]
  34 // Tags indexes.
  35 enum LayoutTags {
  36         LT_ALIGN = 1,
  37         LT_ALIGNPOSSIBLE,
  38         LT_MARGIN,
  39         LT_BOTTOMSEP,
  40         LT_COMMANDDEPTH,
  41         LT_COPYSTYLE,
  42         LT_DEPENDSON,
  43         LT_OBSOLETEDBY,
  44         //LT_EMPTY,
  45         LT_END,
  46         //LT_ENVIRONMENT_DEFAULT,
  47         //LT_FANCYHDR,
  48         LT_FILL_BOTTOM,
  49         LT_FILL_TOP,
  50         //LT_FIRST_COUNTER,
  51         LT_FONT,
  52         LT_FREE_SPACING,
  53         LT_PASS_THRU,
  54         //LT_HEADINGS,
  55         LT_ITEMSEP,
  56         LT_KEEPEMPTY,
  57         LT_LABEL_BOTTOMSEP,
  58         LT_LABELFONT,
  59         LT_TEXTFONT,
  60         LT_LABELINDENT,
  61         LT_LABELSEP,
  62         LT_LABELSTRING,
  63         LT_LABELSTRING_APPENDIX,
  64         LT_LABELCOUNTER,
  65         LT_LABELTYPE,
  66         LT_ENDLABELSTRING,
  67         LT_ENDLABELTYPE,
  68         LT_LATEXNAME,
  69         LT_LATEXPARAM,
  70         LT_OPTARGS,
  71         LT_LATEXTYPE,
  72         LT_LATEXHEADER,
  73         LT_LATEXFOOTER,
  74         LT_LATEXPARAGRAPH,
  75         LT_LEFTMARGIN,
  76         LT_NEED_PROTECT,
  77         LT_NEWLINE,
  78         LT_NEXTNOINDENT,
  79         LT_PARINDENT,
  80         LT_PARSEP,
  81         LT_PARSKIP,
  82         //LT_PLAIN,
  83         LT_PREAMBLE,
  84         LT_REQUIRES,
  85         LT_RIGHTMARGIN,
  86         LT_SPACING,
  87         LT_TOPSEP,
  88         LT_TOCLEVEL,
  89         LT_INNERTAG,
  90         LT_LABELTAG,
  91         LT_ITEMTAG,
  92         LT_INTITLE // keep this last!
  93 };
  94
  95 /////////////////////
  96
  97 Layout::Layout()
  98 {
  99         margintype = MARGIN_STATIC;
 100         latextype = LATEX_PARAGRAPH;
 101         intitle = false;
 102         optionalargs = 0;
 103         needprotect = false;
 104         keepempty = false;
 105         font = inherit_font;
 106         labelfont = inherit_font;
 107         resfont = sane_font;
 108         reslabelfont = sane_font;
 109         nextnoindent = false;
 110         parskip = 0.0;
 111         itemsep = 0;
 112         topsep = 0.0;
 113         bottomsep = 0.0;
 114         labelbottomsep = 0.0;
 115         parsep = 0;
 116         align = LYX_ALIGN_BLOCK;
 117         alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
 118         labeltype = LABEL_NO_LABEL;
 119         endlabeltype = END_LABEL_NO_LABEL;
 120         // Should or should not. That is the question.
 121         // spacing.set(Spacing::OneHalf);
 122         fill_top = false;
 123         fill_bottom = false;
 124         newline_allowed = true;
 125         free_spacing = false;
 126         pass_thru = false;
 127         is_environment = false;
 128         toclevel = NOT_IN_TOC;
 129         commanddepth = 0;
 130 }
 131
 132
 133 bool Layout::read(Lexer & lexrc, TextClass const & tclass)
 134 {
 135         // This table is sorted alphabetically [asierra 30March96]
 136         keyword_item layoutTags[] = {
 137                 { "align",          LT_ALIGN },
 138                 { "alignpossible",  LT_ALIGNPOSSIBLE },
 139                 { "bottomsep",      LT_BOTTOMSEP },
 140                 { "commanddepth",   LT_COMMANDDEPTH },
 141                 { "copystyle",      LT_COPYSTYLE },
 142                 { "dependson",      LT_DEPENDSON },
 143                 { "end",            LT_END },
 144                 { "endlabelstring", LT_ENDLABELSTRING },
 145                 { "endlabeltype",   LT_ENDLABELTYPE },
 146                 { "fill_bottom",    LT_FILL_BOTTOM },
 147                 { "fill_top",       LT_FILL_TOP },
 148                 { "font",           LT_FONT },
 149                 { "freespacing",    LT_FREE_SPACING },
 150                 { "innertag",       LT_INNERTAG },
 151                 { "intitle",        LT_INTITLE },
 152                 { "itemsep",        LT_ITEMSEP },
 153                 { "itemtag",        LT_ITEMTAG },
 154                 { "keepempty",      LT_KEEPEMPTY },
 155                 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
 156                 { "labelcounter",   LT_LABELCOUNTER },
 157                 { "labelfont",      LT_LABELFONT },
 158                 { "labelindent",    LT_LABELINDENT },
 159                 { "labelsep",       LT_LABELSEP },
 160                 { "labelstring",    LT_LABELSTRING },
 161                 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
 162                 { "labeltag",       LT_LABELTAG },
 163                 { "labeltype",      LT_LABELTYPE },
 164                 { "latexfooter",    LT_LATEXFOOTER },
 165                 { "latexheader",    LT_LATEXHEADER },
 166                 { "latexname",      LT_LATEXNAME },
 167                 { "latexparagraph", LT_LATEXPARAGRAPH },
 168                 { "latexparam",     LT_LATEXPARAM },
 169                 { "latextype",      LT_LATEXTYPE },
 170                 { "leftmargin",     LT_LEFTMARGIN },
 171                 { "margin",         LT_MARGIN },
 172                 { "needprotect",    LT_NEED_PROTECT },
 173                 { "newline",        LT_NEWLINE },
 174                 { "nextnoindent",   LT_NEXTNOINDENT },
 175                 { "obsoletedby",    LT_OBSOLETEDBY },
 176                 { "optionalargs",   LT_OPTARGS },
 177                 { "parindent",      LT_PARINDENT },
 178                 { "parsep",         LT_PARSEP },
 179                 { "parskip",        LT_PARSKIP },
 180                 { "passthru",       LT_PASS_THRU },
 181                 { "preamble",       LT_PREAMBLE },
 182                 { "requires",       LT_REQUIRES },
 183                 { "rightmargin",    LT_RIGHTMARGIN },
 184                 { "spacing",        LT_SPACING },
 185                 { "textfont",       LT_TEXTFONT },
 186                 { "toclevel",       LT_TOCLEVEL },
 187                 { "topsep",         LT_TOPSEP }
 188         };
 189
 190         bool error = false;
 191         bool finished = false;
 192         lexrc.pushTable(layoutTags, LT_INTITLE);
 193         // parse style section
 194         while (!finished && lexrc.isOK() && !error) {
 195                 int le = lexrc.lex();
 196                 // See comment in LyXRC.cpp.
 197                 switch (le) {
 198                 case Lexer::LEX_FEOF:
 199                         continue;
 200
 201                 case Lexer::LEX_UNDEF:          // parse error
 202                         lexrc.printError("Unknown layout tag `$$Token'");
 203                         error = true;
 204                         continue;
 205                 default: break;
 206                 }
 207                 switch (static_cast<LayoutTags>(le)) {
 208                 case LT_END:            // end of structure
 209                         finished = true;
 210                         break;
 211
 212                 case LT_COPYSTYLE:     // initialize with a known style
 213                         if (lexrc.next()) {
 214                                 docstring const style = subst(lexrc.getDocString(),
 215                                                                 '_', ' ');
 216
 217                                 if (tclass.hasLayout(style)) {
 218                                         docstring const tmpname = name_;
 219                                         this->operator=(*tclass[style]);
 220                                         name_ = tmpname;
 221                                 } else {
 222                                         lyxerr << "Cannot copy unknown style `"
 223                                                << to_utf8(style) << "'\n"
 224                                                << "All layouts so far:"
 225                                                << endl;
 226                                         for (size_t i = 0; i != tclass.layoutCount(); ++i)
 227                                                 lyxerr << to_utf8(tclass.layout(i)->name())
 228                                                        << endl;
 229
 230                                         //lexrc.printError("Cannot copy known "
 231                                         //               "style `$$Token'");
 232                                 }
 233                         }
 234                         break;
 235
 236                 case LT_OBSOLETEDBY:     // replace with a known style
 237                         if (lexrc.next()) {
 238                                 docstring const style =
 239                                         subst(lexrc.getDocString(), '_', ' ');
 240
 241                                 if (tclass.hasLayout(style)) {
 242                                         docstring const tmpname = name_;
 243                                         this->operator=(*tclass[style]);
 244                                         name_ = tmpname;
 245                                         if (obsoleted_by().empty())
 246                                                 obsoleted_by_ = style;
 247                                 } else {
 248                                         lyxerr << "Cannot replace with unknown style `"
 249                                                 << to_utf8(style) << '\'' << endl;
 250
 251                                         //lexrc.printError("Cannot replace with"
 252                                         //               " unknown style "
 253                                         //               "`$$Token'");
 254                                 }
 255                         }
 256                         break;
 257
 258                 case LT_DEPENDSON:
 259                         if (lexrc.next())
 260                         depends_on_ = subst(lexrc.getDocString(), '_', ' ');
 261                         break;
 262
 263                 case LT_MARGIN:         // margin style definition.
 264                         readMargin(lexrc);
 265                         break;
 266
 267                 case LT_LATEXTYPE:      // LaTeX style definition.
 268                         readLatexType(lexrc);
 269                         break;
 270
 271                 case LT_LATEXHEADER:    // header for environments
 272                         lexrc.next();
 273                         latexheader = lexrc.getString();
 274                         break;
 275
 276                 case LT_LATEXFOOTER:    // footer for environments
 277                         lexrc.next();
 278                         latexfooter = lexrc.getString();
 279                         break;
 280
 281                 case LT_LATEXPARAGRAPH:
 282                         lexrc.next();
 283                         latexparagraph = lexrc.getString();
 284                         break;
 285
 286                 case LT_INTITLE:
 287                         intitle = lexrc.next() && lexrc.getInteger();
 288                         break;
 289
 290                 case LT_TOCLEVEL:
 291                         lexrc.next();
 292                         toclevel = lexrc.getInteger();
 293                         break;
 294
 295                 case LT_OPTARGS:
 296                         if (lexrc.next())
 297                                 optionalargs = lexrc.getInteger();
 298                         break;
 299
 300                 case LT_NEED_PROTECT:
 301                         needprotect = lexrc.next() && lexrc.getInteger();
 302                         break;
 303
 304                 case LT_KEEPEMPTY:
 305                         keepempty = lexrc.next() && lexrc.getInteger();
 306                         break;
 307
 308                 case LT_FONT:
 309                         font = lyxRead(lexrc, font);
 310                         labelfont = font;
 311                         break;
 312
 313                 case LT_TEXTFONT:
 314                         font = lyxRead(lexrc, font);
 315                         break;
 316
 317                 case LT_LABELFONT:
 318                         labelfont = lyxRead(lexrc, labelfont);
 319                         break;
 320
 321                 case LT_NEXTNOINDENT:   // Indent next paragraph?
 322                         if (lexrc.next() && lexrc.getInteger())
 323                                 nextnoindent = true;
 324                         else
 325                                 nextnoindent = false;
 326                         break;
 327
 328                 case LT_COMMANDDEPTH:
 329                         lexrc.next();
 330                         commanddepth = lexrc.getInteger();
 331                         break;
 332
 333                 case LT_LATEXNAME:
 334                         if (lexrc.next())
 335                                 latexname_ = lexrc.getString();
 336                         break;
 337
 338                 case LT_LATEXPARAM:
 339                         if (lexrc.next())
 340                                 latexparam_ = subst(lexrc.getString(), "&quot;", "\"");
 341                         break;
 342
 343                 case LT_INNERTAG:
 344                         if (lexrc.next())
 345                                 innertag_ = lexrc.getString();
 346                         break;
 347
 348                 case LT_LABELTAG:
 349                         if (lexrc.next())
 350                                 labeltag_ = lexrc.getString();
 351                         break;
 352
 353                 case LT_ITEMTAG:
 354                         if (lexrc.next())
 355                                 itemtag_ = lexrc.getString();
 356                         break;
 357
 358                 case LT_PREAMBLE:
 359                         preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
 360                         break;
 361
 362                 case LT_LABELTYPE:
 363                         readLabelType(lexrc);
 364                         break;
 365
 366                 case LT_ENDLABELTYPE:
 367                         readEndLabelType(lexrc);
 368                         break;
 369
 370                 case LT_LEFTMARGIN:     // left margin type
 371                         if (lexrc.next())
 372                                 leftmargin = lexrc.getDocString();
 373                         break;
 374
 375                 case LT_RIGHTMARGIN:    // right margin type
 376                         if (lexrc.next())
 377                                 rightmargin = lexrc.getDocString();
 378                         break;
 379
 380                 case LT_LABELINDENT:    // label indenting flag
 381                         if (lexrc.next())
 382                                 labelindent = lexrc.getDocString();
 383                         break;
 384
 385                 case LT_PARINDENT:      // paragraph indent. flag
 386                         if (lexrc.next())
 387                                 parindent = lexrc.getDocString();
 388                         break;
 389
 390                 case LT_PARSKIP:        // paragraph skip size
 391                         if (lexrc.next())
 392                                 parskip = lexrc.getFloat();
 393                         break;
 394
 395                 case LT_ITEMSEP:        // item separation size
 396                         if (lexrc.next())
 397                                 itemsep = lexrc.getFloat();
 398                         break;
 399
 400                 case LT_TOPSEP:         // top separation size
 401                         if (lexrc.next())
 402                                 topsep = lexrc.getFloat();
 403                         break;
 404
 405                 case LT_BOTTOMSEP:      // bottom separation size
 406                         if (lexrc.next())
 407                                 bottomsep = lexrc.getFloat();
 408                         break;
 409
 410                 case LT_LABEL_BOTTOMSEP: // label bottom separation size
 411                         if (lexrc.next())
 412                                 labelbottomsep = lexrc.getFloat();
 413                         break;
 414
 415                 case LT_LABELSEP:       // label separator
 416                         if (lexrc.next()) {
 417                                 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
 418                         }
 419                         break;
 420
 421                 case LT_PARSEP:         // par. separation size
 422                         if (lexrc.next())
 423                                 parsep = lexrc.getFloat();
 424                         break;
 425
 426                 case LT_FILL_TOP:       // fill top flag
 427                         if (lexrc.next())
 428                                 fill_top = lexrc.getInteger();
 429                         break;
 430
 431                 case LT_FILL_BOTTOM:    // fill bottom flag
 432                         if (lexrc.next())
 433                                 fill_bottom = lexrc.getInteger();
 434                         break;
 435
 436                 case LT_NEWLINE:        // newlines allowed?
 437                         if (lexrc.next())
 438                                 newline_allowed = lexrc.getInteger();
 439                         break;
 440
 441                 case LT_ALIGN:          // paragraph align
 442                         readAlign(lexrc);
 443                         break;
 444                 case LT_ALIGNPOSSIBLE:  // paragraph allowed align
 445                         readAlignPossible(lexrc);
 446                         break;
 447
 448                 case LT_LABELSTRING:    // label string definition
 449                         if (lexrc.next()) {
 450                                 labelstring_ = trim(lexrc.getDocString());
 451                                 labelstring_appendix_ = labelstring_;
 452                         }
 453                         break;
 454
 455                 case LT_ENDLABELSTRING: // endlabel string definition
 456                         if (lexrc.next())
 457                                 endlabelstring_ = trim(lexrc.getDocString());
 458                         break;
 459
 460                 case LT_LABELSTRING_APPENDIX: // label string appendix definition
 461                         if (lexrc.next())
 462                                 labelstring_appendix_ = trim(lexrc.getDocString());
 463                         break;
 464
 465                 case LT_LABELCOUNTER: // name of counter to use
 466                         if (lexrc.next())
 467                                 counter = lyx::from_ascii(trim(lexrc.getString()));
 468                         break;
 469
 470                 case LT_FREE_SPACING:   // Allow for free spacing.
 471                         if (lexrc.next())
 472                                 free_spacing = lexrc.getInteger();
 473                         break;
 474
 475                 case LT_PASS_THRU:      // Allow for pass thru.
 476                         if (lexrc.next())
 477                                 pass_thru = lexrc.getInteger();
 478                         break;
 479
 480                 case LT_SPACING: // setspace.sty
 481                         readSpacing(lexrc);
 482                         break;
 483
 484                 case LT_REQUIRES:
 485                         lexrc.eatLine();
 486                         vector<string> const req =
 487                                 getVectorFromString(lexrc.getString());
 488                         requires_.insert(req.begin(), req.end());
 489                         break;
 490
 491                 }
 492         }
 493         lexrc.popTable();
 494
 495         return !error;
 496 }
 497
 498
 499 enum AlignTags {
 500         AT_BLOCK = 1,
 501         AT_LEFT,
 502         AT_RIGHT,
 503         AT_CENTER,
 504         AT_LAYOUT
 505 };
 506
 507
 508 void Layout::readAlign(Lexer & lexrc)
 509 {
 510         keyword_item alignTags[] = {
 511                 { "block",  AT_BLOCK },
 512                 { "center", AT_CENTER },
 513                 { "layout", AT_LAYOUT },
 514                 { "left",   AT_LEFT },
 515                 { "right",  AT_RIGHT }
 516         };
 517
 518         PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
 519         int le = lexrc.lex();
 520         switch (le) {
 521         case Lexer::LEX_UNDEF:
 522                 lexrc.printError("Unknown alignment `$$Token'");
 523                 return;
 524         default: break;
 525         };
 526         switch (static_cast<AlignTags>(le)) {
 527         case AT_BLOCK:
 528                 align = LYX_ALIGN_BLOCK;
 529                 break;
 530         case AT_LEFT:
 531                 align = LYX_ALIGN_LEFT;
 532                 break;
 533         case AT_RIGHT:
 534                 align = LYX_ALIGN_RIGHT;
 535                 break;
 536         case AT_CENTER:
 537                 align = LYX_ALIGN_CENTER;
 538                 break;
 539         case AT_LAYOUT:
 540                 align = LYX_ALIGN_LAYOUT;
 541                 break;
 542         }
 543 }
 544
 545
 546 void Layout::readAlignPossible(Lexer & lexrc)
 547 {
 548         keyword_item alignTags[] = {
 549                 { "block",  AT_BLOCK },
 550                 { "center", AT_CENTER },
 551                 { "layout", AT_LAYOUT },
 552                 { "left",   AT_LEFT },
 553                 { "right",  AT_RIGHT }
 554         };
 555
 556         lexrc.pushTable(alignTags, AT_LAYOUT);
 557         alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
 558         int lineno = lexrc.getLineNo();
 559         do {
 560                 int le = lexrc.lex();
 561                 switch (le) {
 562                 case Lexer::LEX_UNDEF:
 563                         lexrc.printError("Unknown alignment `$$Token'");
 564                         continue;
 565                 default: break;
 566                 };
 567                 switch (static_cast<AlignTags>(le)) {
 568                 case AT_BLOCK:
 569                         alignpossible |= LYX_ALIGN_BLOCK;
 570                         break;
 571                 case AT_LEFT:
 572                         alignpossible |= LYX_ALIGN_LEFT;
 573                         break;
 574                 case AT_RIGHT:
 575                         alignpossible |= LYX_ALIGN_RIGHT;
 576                         break;
 577                 case AT_CENTER:
 578                         alignpossible |= LYX_ALIGN_CENTER;
 579                         break;
 580                 case AT_LAYOUT:
 581                         alignpossible |= LYX_ALIGN_LAYOUT;
 582                         break;
 583                 }
 584         } while (lineno == lexrc.getLineNo());
 585         lexrc.popTable();
 586 }
 587
 588
 589 enum LabelTypeTags {
 590         LA_NO_LABEL = 1,
 591         LA_MANUAL,
 592         LA_TOP_ENVIRONMENT,
 593         LA_CENTERED_TOP_ENVIRONMENT,
 594         LA_STATIC,
 595         LA_SENSITIVE,
 596         LA_COUNTER,
 597         LA_ENUMERATE,
 598         LA_ITEMIZE,
 599         LA_BIBLIO
 600 };
 601
 602
 603 void Layout::readLabelType(Lexer & lexrc)
 604 {
 605         keyword_item labelTypeTags[] = {
 606         { "bibliography",             LA_BIBLIO },
 607         { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
 608         { "counter",                  LA_COUNTER },
 609         { "enumerate",                LA_ENUMERATE },
 610         { "itemize",                  LA_ITEMIZE },
 611         { "manual",                   LA_MANUAL },
 612         { "no_label",                 LA_NO_LABEL },
 613         { "sensitive",                LA_SENSITIVE },
 614         { "static",                   LA_STATIC },
 615         { "top_environment",          LA_TOP_ENVIRONMENT }
 616         };
 617
 618         PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
 619         int le = lexrc.lex();
 620         switch (le) {
 621         case Lexer::LEX_UNDEF:
 622                 lexrc.printError("Unknown labeltype tag `$$Token'");
 623                 return;
 624         default: break;
 625         }
 626         switch (static_cast<LabelTypeTags>(le)) {
 627         case LA_NO_LABEL:
 628                 labeltype = LABEL_NO_LABEL;
 629                 break;
 630         case LA_MANUAL:
 631                 labeltype = LABEL_MANUAL;
 632                 break;
 633         case LA_TOP_ENVIRONMENT:
 634                 labeltype = LABEL_TOP_ENVIRONMENT;
 635                 break;
 636         case LA_CENTERED_TOP_ENVIRONMENT:
 637                 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
 638                 break;
 639         case LA_STATIC:
 640                 labeltype = LABEL_STATIC;
 641                 break;
 642         case LA_SENSITIVE:
 643                 labeltype = LABEL_SENSITIVE;
 644                 break;
 645         case LA_COUNTER:
 646                 labeltype = LABEL_COUNTER;
 647                 break;
 648         case LA_ENUMERATE:
 649                 labeltype = LABEL_ENUMERATE;
 650                 break;
 651         case LA_ITEMIZE:
 652                 labeltype = LABEL_ITEMIZE;
 653                 break;
 654         case LA_BIBLIO:
 655                 labeltype = LABEL_BIBLIO;
 656                 break;
 657         }
 658 }
 659
 660
 661 static keyword_item endlabelTypeTags[] =
 662 {
 663         { "box",        END_LABEL_BOX },
 664         { "filled_box", END_LABEL_FILLED_BOX },
 665         { "no_label",   END_LABEL_NO_LABEL },
 666         { "static",     END_LABEL_STATIC }
 667 };
 668
 669
 670 void Layout::readEndLabelType(Lexer & lexrc)
 671 {
 672         PushPopHelper pph(lexrc, endlabelTypeTags,
 673                           END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
 674         int le = lexrc.lex();
 675         switch (le) {
 676         case Lexer::LEX_UNDEF:
 677                 lexrc.printError("Unknown labeltype tag `$$Token'");
 678                 break;
 679         case END_LABEL_STATIC:
 680         case END_LABEL_BOX:
 681         case END_LABEL_FILLED_BOX:
 682         case END_LABEL_NO_LABEL:
 683                 endlabeltype = static_cast<EndLabelType>(le);
 684                 break;
 685         default:
 686                 lyxerr << "Unhandled value " << le
 687                        << " in Layout::readEndLabelType." << endl;
 688                 break;
 689         }
 690 }
 691
 692
 693 void Layout::readMargin(Lexer & lexrc)
 694 {
 695         keyword_item marginTags[] = {
 696                 { "dynamic",           MARGIN_DYNAMIC },
 697                 { "first_dynamic",     MARGIN_FIRST_DYNAMIC },
 698                 { "manual",            MARGIN_MANUAL },
 699                 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
 700                 { "static",            MARGIN_STATIC }
 701         };
 702
 703         PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
 704
 705         int le = lexrc.lex();
 706         switch (le) {
 707         case Lexer::LEX_UNDEF:
 708                 lexrc.printError("Unknown margin type tag `$$Token'");
 709                 return;
 710         case MARGIN_STATIC:
 711         case MARGIN_MANUAL:
 712         case MARGIN_DYNAMIC:
 713         case MARGIN_FIRST_DYNAMIC:
 714         case MARGIN_RIGHT_ADDRESS_BOX:
 715                 margintype = static_cast<MarginType>(le);
 716                 break;
 717         default:
 718                 lyxerr << "Unhandled value " << le
 719                        << " in Layout::readMargin." << endl;
 720                 break;
 721         }
 722 }
 723
 724
 725 void Layout::readLatexType(Lexer & lexrc)
 726 {
 727         keyword_item latexTypeTags[] = {
 728                 { "bib_environment",  LATEX_BIB_ENVIRONMENT },
 729                 { "command",          LATEX_COMMAND },
 730                 { "environment",      LATEX_ENVIRONMENT },
 731                 { "item_environment", LATEX_ITEM_ENVIRONMENT },
 732                 { "list_environment", LATEX_LIST_ENVIRONMENT },
 733                 { "paragraph",        LATEX_PARAGRAPH }
 734         };
 735
 736         PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
 737         int le = lexrc.lex();
 738         switch (le) {
 739         case Lexer::LEX_UNDEF:
 740                 lexrc.printError("Unknown latextype tag `$$Token'");
 741                 return;
 742         case LATEX_PARAGRAPH:
 743         case LATEX_COMMAND:
 744         case LATEX_ENVIRONMENT:
 745         case LATEX_ITEM_ENVIRONMENT:
 746         case LATEX_BIB_ENVIRONMENT:
 747         case LATEX_LIST_ENVIRONMENT:
 748                 latextype = static_cast<LatexType>(le);
 749                 break;
 750         default:
 751                 lyxerr << "Unhandled value " << le
 752                        << " in Layout::readLatexType." << endl;
 753                 break;
 754         }
 755 }
 756
 757
 758 enum SpacingTags {
 759         ST_SPACING_SINGLE = 1,
 760         ST_SPACING_ONEHALF,
 761         ST_SPACING_DOUBLE,
 762         ST_OTHER
 763 };
 764
 765
 766 void Layout::readSpacing(Lexer & lexrc)
 767 {
 768         keyword_item spacingTags[] = {
 769                 {"double",  ST_SPACING_DOUBLE },
 770                 {"onehalf", ST_SPACING_ONEHALF },
 771                 {"other",   ST_OTHER },
 772                 {"single",  ST_SPACING_SINGLE }
 773         };
 774
 775         PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
 776         int le = lexrc.lex();
 777         switch (le) {
 778         case Lexer::LEX_UNDEF:
 779                 lexrc.printError("Unknown spacing token `$$Token'");
 780                 return;
 781         default: break;
 782         }
 783         switch (static_cast<SpacingTags>(le)) {
 784         case ST_SPACING_SINGLE:
 785                 spacing.set(Spacing::Single);
 786                 break;
 787         case ST_SPACING_ONEHALF:
 788                 spacing.set(Spacing::Onehalf);
 789                 break;
 790         case ST_SPACING_DOUBLE:
 791                 spacing.set(Spacing::Double);
 792                 break;
 793         case ST_OTHER:
 794                 lexrc.next();
 795                 spacing.set(Spacing::Other, lexrc.getString());
 796                 break;
 797         }
 798 }
 799
 800
 801 docstring const & Layout::name() const
 802 {
 803         return name_;
 804 }
 805
 806
 807 void Layout::setName(docstring const & name)
 808 {
 809         name_ = name;
 810 }
 811
 812
 813 docstring const & Layout::obsoleted_by() const
 814 {
 815         return obsoleted_by_;
 816 }
 817
 818
 819 docstring const & Layout::depends_on() const
 820 {
 821         return depends_on_;
 822 }
 823
 824
 825 Layout * Layout::forCaption()
 826 {
 827         Layout * lay = new Layout();
 828         lay->name_ = from_ascii("Caption");
 829         lay->latexname_ = "caption";
 830         lay->latextype = LATEX_COMMAND;
 831         lay->optionalargs = 1;
 832         return lay;
 833 }
 834
 835 } // namespace lyx