1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ======================================================
14 #include "lyxlayout.h"
15 #include "lyxtextclass.h"
19 #include "support/lstrings.h"
23 // The order of the LayoutTags enum is no more important. [asierra300396]
35 //LT_ENVIRONMENT_DEFAULT,
52 LT_LABELSTRING_APPENDIX,
79 // Constructor for layout
80 LyXLayout::LyXLayout ()
82 margintype = MARGIN_STATIC;
83 latextype = LATEX_PARAGRAPH;
88 font = LyXFont(LyXFont::ALL_INHERIT);
89 labelfont = LyXFont(LyXFont::ALL_INHERIT);
90 resfont = LyXFont(LyXFont::ALL_SANE);
91 reslabelfont = LyXFont(LyXFont::ALL_SANE);
99 align = LYX_ALIGN_BLOCK;
100 alignpossible = LYX_ALIGN_BLOCK;
101 labeltype = LABEL_NO_LABEL;
102 endlabeltype = END_LABEL_NO_LABEL;
103 // Should or should not. That is the question.
104 // spacing.set(Spacing::OneHalf);
107 newline_allowed = true;
108 free_spacing = false;
113 // Reads a layout definition from file
114 bool LyXLayout::Read (LyXLex & lexrc, LyXTextClass const & tclass)
116 // This table is sorted alphabetically [asierra 30March96]
117 keyword_item layoutTags[] = {
118 { "align", LT_ALIGN },
119 { "alignpossible", LT_ALIGNPOSSIBLE },
120 { "bottomsep", LT_BOTTOMSEP },
121 { "copystyle", LT_COPYSTYLE },
122 { "dependson", LT_DEPENDSON },
124 { "endlabelstring", LT_ENDLABELSTRING },
125 { "endlabeltype", LT_ENDLABELTYPE },
126 { "fill_bottom", LT_FILL_BOTTOM },
127 { "fill_top", LT_FILL_TOP },
129 { "freespacing", LT_FREE_SPACING },
130 { "intitle", LT_INTITLE },
131 { "itemsep", LT_ITEMSEP },
132 { "keepempty", LT_KEEPEMPTY },
133 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
134 { "labelfont", LT_LABELFONT },
135 { "labelindent", LT_LABELINDENT },
136 { "labelsep", LT_LABELSEP },
137 { "labelstring", LT_LABELSTRING },
138 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
139 { "labeltype", LT_LABELTYPE },
140 { "latexfooter", LT_LATEXFOOTER },
141 { "latexheader", LT_LATEXHEADER },
142 { "latexname", LT_LATEXNAME },
143 { "latexparam", LT_LATEXPARAM },
144 { "latextype", LT_LATEXTYPE },
145 { "leftmargin", LT_LEFTMARGIN },
146 { "margin", LT_MARGIN },
147 { "needprotect", LT_NEED_PROTECT },
148 { "newline", LT_NEWLINE },
149 { "nextnoindent", LT_NEXTNOINDENT },
150 { "obsoletedby", LT_OBSOLETEDBY },
151 { "optionalargs", LT_OPTARGS },
152 { "parindent", LT_PARINDENT },
153 { "parsep", LT_PARSEP },
154 { "parskip", LT_PARSKIP },
155 { "passthru", LT_PASS_THRU },
156 { "preamble", LT_PREAMBLE },
157 { "rightmargin", LT_RIGHTMARGIN },
158 { "spacing", LT_SPACING },
159 { "textfont", LT_TEXTFONT },
160 { "topsep", LT_TOPSEP }
164 bool finished = false;
165 lexrc.pushTable(layoutTags, LT_INTITLE);
166 // parse style section
167 while (!finished && lexrc.isOK() && !error) {
168 int le = lexrc.lex();
169 // See comment in lyxrc.C.
171 case LyXLex::LEX_FEOF:
174 case LyXLex::LEX_UNDEF: // parse error
175 lexrc.printError("Unknown layout tag `$$Token'");
180 switch (static_cast<LayoutTags>(le)) {
181 case LT_END: // end of structure
185 case LT_COPYSTYLE: // initialize with a known style
187 string const style = lexrc.getString();
189 if (tclass.hasLayout(style)) {
190 string const tmpname = name_;
191 this->operator=(*tclass[style]);
194 lyxerr << "Cannot copy unknown style `"
196 << "All layouts so far:"
198 LyXTextClass::const_iterator it =
200 LyXTextClass::const_iterator end =
202 for (; it != end; ++it) {
203 lyxerr << (*it)->name()
207 //lexrc.printError("Cannot copy known "
208 // "style `$$Token'");
213 case LT_OBSOLETEDBY: // replace with a known style
215 string const style = lexrc.getString();
217 if (tclass.hasLayout(style)) {
218 string const tmpname = name_;
219 this->operator=(*tclass[style]);
221 if (obsoleted_by().empty())
222 obsoleted_by_ = style;
224 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
226 //lexrc.printError("Cannot replace with"
235 depends_on_ = lexrc.getString();
239 case LT_MARGIN: // Margin style definition.
243 case LT_LATEXTYPE: // Latex style definition.
244 readLatexType(lexrc);
247 case LT_LATEXHEADER: // Latex style definition.
249 latexheader = lexrc.getString();
252 case LT_LATEXFOOTER: // Latex style definition.
254 latexfooter = lexrc.getString();
258 intitle = lexrc.next() && lexrc.getInteger();
263 optionalargs = lexrc.getInteger();
267 case LT_NEED_PROTECT:
268 needprotect = lexrc.next() && lexrc.getInteger();
272 keepempty = lexrc.next() && lexrc.getInteger();
285 labelfont.lyxRead(lexrc);
288 case LT_NEXTNOINDENT: // Indent next paragraph?
289 if (lexrc.next() && lexrc.getInteger())
292 nextnoindent = false;
297 latexname_ = lexrc.getString();
302 latexparam_ = lexrc.getString();
306 preamble_ = lexrc.getLongString("EndPreamble");
310 readLabelType(lexrc);
313 case LT_ENDLABELTYPE:
314 readEndLabelType(lexrc);
317 case LT_LEFTMARGIN: // left margin type
319 leftmargin = lexrc.getString();
322 case LT_RIGHTMARGIN: // right margin type
324 rightmargin = lexrc.getString();
327 case LT_LABELINDENT: // label indenting flag
329 labelindent = lexrc.getString();
332 case LT_PARINDENT: // paragraph indent. flag
334 parindent = lexrc.getString();
337 case LT_PARSKIP: // paragraph skip size
339 parskip = lexrc.getFloat();
342 case LT_ITEMSEP: // item separation size
344 itemsep = lexrc.getFloat();
347 case LT_TOPSEP: // top separation size
349 topsep = lexrc.getFloat();
352 case LT_BOTTOMSEP: // bottom separation size
354 bottomsep = lexrc.getFloat();
357 case LT_LABEL_BOTTOMSEP: // label bottom separation size
359 labelbottomsep = lexrc.getFloat();
362 case LT_LABELSEP: // label separator
364 labelsep = subst(lexrc.getString(), 'x', ' ');
368 case LT_PARSEP: // par. separation size
370 parsep = lexrc.getFloat();
373 case LT_FILL_TOP: // fill top flag
375 fill_top = lexrc.getInteger();
378 case LT_FILL_BOTTOM: // fill bottom flag
380 fill_bottom = lexrc.getInteger();
383 case LT_NEWLINE: // newlines allowed?
385 newline_allowed = lexrc.getInteger();
388 case LT_ALIGN: // paragraph align
391 case LT_ALIGNPOSSIBLE: // paragraph allowed align
392 readAlignPossible(lexrc);
395 case LT_LABELSTRING: // label string definition
397 labelstring_ = trim(lexrc.getString());
400 case LT_ENDLABELSTRING: // endlabel string definition
402 endlabelstring_ = trim(lexrc.getString());
405 case LT_LABELSTRING_APPENDIX: // label string appendix definition
407 labelstring_appendix_ = trim(lexrc.getString());
410 case LT_FREE_SPACING: // Allow for free spacing.
412 free_spacing = lexrc.getInteger();
415 case LT_PASS_THRU: // Allow for pass thru.
417 pass_thru = lexrc.getInteger();
420 case LT_SPACING: // setspace.sty
439 void LyXLayout::readAlign(LyXLex & lexrc)
441 keyword_item alignTags[] = {
442 { "block", AT_BLOCK },
443 { "center", AT_CENTER },
444 { "layout", AT_LAYOUT },
446 { "right", AT_RIGHT }
449 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
450 int le = lexrc.lex();
452 case LyXLex::LEX_UNDEF:
453 lexrc.printError("Unknown alignment `$$Token'");
457 switch (static_cast<AlignTags>(le)) {
459 align = LYX_ALIGN_BLOCK;
462 align = LYX_ALIGN_LEFT;
465 align = LYX_ALIGN_RIGHT;
468 align = LYX_ALIGN_CENTER;
471 align = LYX_ALIGN_LAYOUT;
477 void LyXLayout::readAlignPossible(LyXLex & lexrc)
479 keyword_item alignTags[] = {
480 { "block", AT_BLOCK },
481 { "center", AT_CENTER },
482 { "layout", AT_LAYOUT },
484 { "right", AT_RIGHT }
487 lexrc.pushTable(alignTags, AT_LAYOUT);
488 alignpossible = LYX_ALIGN_NONE;
489 int lineno = lexrc.getLineNo();
491 int le = lexrc.lex();
493 case LyXLex::LEX_UNDEF:
494 lexrc.printError("Unknown alignment `$$Token'");
498 switch (static_cast<AlignTags>(le)) {
500 alignpossible |= LYX_ALIGN_BLOCK;
503 alignpossible |= LYX_ALIGN_LEFT;
506 alignpossible |= LYX_ALIGN_RIGHT;
509 alignpossible |= LYX_ALIGN_CENTER;
512 alignpossible |= LYX_ALIGN_LAYOUT;
515 } while (lineno == lexrc.getLineNo());
524 LA_CENTERED_TOP_ENVIRONMENT,
529 LA_COUNTER_SUBSECTION,
530 LA_COUNTER_SUBSUBSECTION,
531 LA_COUNTER_PARAGRAPH,
532 LA_COUNTER_SUBPARAGRAPH,
541 void LyXLayout::readLabelType(LyXLex & lexrc)
543 keyword_item labelTypeTags[] = {
544 { "bibliography", LA_BIBLIO },
545 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
546 { "counter_chapter", LA_COUNTER_CHAPTER },
547 { "counter_enumi", LA_COUNTER_ENUMI },
548 { "counter_enumii", LA_COUNTER_ENUMII },
549 { "counter_enumiii", LA_COUNTER_ENUMIII },
550 { "counter_enumiv", LA_COUNTER_ENUMIV },
551 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
552 { "counter_section", LA_COUNTER_SECTION },
553 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
554 { "counter_subsection", LA_COUNTER_SUBSECTION },
555 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
556 { "manual", LA_MANUAL },
557 { "no_label", LA_NO_LABEL },
558 { "sensitive", LA_SENSITIVE },
559 { "static", LA_STATIC },
560 { "top_environment", LA_TOP_ENVIRONMENT }
563 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
564 int le = lexrc.lex();
566 case LyXLex::LEX_UNDEF:
567 lexrc.printError("Unknown labeltype tag `$$Token'");
571 switch (static_cast<LabelTypeTags>(le)) {
573 labeltype = LABEL_NO_LABEL;
576 labeltype = LABEL_MANUAL;
578 case LA_TOP_ENVIRONMENT:
579 labeltype = LABEL_TOP_ENVIRONMENT;
581 case LA_CENTERED_TOP_ENVIRONMENT:
582 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
585 labeltype = LABEL_STATIC;
588 labeltype = LABEL_SENSITIVE;
590 case LA_COUNTER_CHAPTER:
591 labeltype = LABEL_COUNTER_CHAPTER;
593 case LA_COUNTER_SECTION:
594 labeltype = LABEL_COUNTER_SECTION;
596 case LA_COUNTER_SUBSECTION:
597 labeltype = LABEL_COUNTER_SUBSECTION;
599 case LA_COUNTER_SUBSUBSECTION:
600 labeltype = LABEL_COUNTER_SUBSUBSECTION;
602 case LA_COUNTER_PARAGRAPH:
603 labeltype = LABEL_COUNTER_PARAGRAPH;
605 case LA_COUNTER_SUBPARAGRAPH:
606 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
608 case LA_COUNTER_ENUMI:
609 labeltype = LABEL_COUNTER_ENUMI;
611 case LA_COUNTER_ENUMII:
612 labeltype = LABEL_COUNTER_ENUMII;
614 case LA_COUNTER_ENUMIII:
615 labeltype = LABEL_COUNTER_ENUMIII;
617 case LA_COUNTER_ENUMIV:
618 labeltype = LABEL_COUNTER_ENUMIV;
621 labeltype = LABEL_BIBLIO;
629 keyword_item endlabelTypeTags[] = {
630 { "box", END_LABEL_BOX },
631 { "filled_box", END_LABEL_FILLED_BOX },
632 { "no_label", END_LABEL_NO_LABEL },
633 { "static", END_LABEL_STATIC }
639 void LyXLayout::readEndLabelType(LyXLex & lexrc)
641 pushpophelper pph(lexrc, endlabelTypeTags,
642 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
643 int le = lexrc.lex();
645 case LyXLex::LEX_UNDEF:
646 lexrc.printError("Unknown labeltype tag `$$Token'");
648 case END_LABEL_STATIC:
650 case END_LABEL_FILLED_BOX:
651 case END_LABEL_NO_LABEL:
652 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
655 lyxerr << "Unhandled value " << le
656 << " in LyXLayout::readEndLabelType." << endl;
662 void LyXLayout::readMargin(LyXLex & lexrc)
664 keyword_item marginTags[] = {
665 { "dynamic", MARGIN_DYNAMIC },
666 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
667 { "manual", MARGIN_MANUAL },
668 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
669 { "static", MARGIN_STATIC }
672 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
674 int le = lexrc.lex();
676 case LyXLex::LEX_UNDEF:
677 lexrc.printError("Unknown margin type tag `$$Token'");
682 case MARGIN_FIRST_DYNAMIC:
683 case MARGIN_RIGHT_ADDRESS_BOX:
684 margintype = static_cast<LYX_MARGIN_TYPE>(le);
687 lyxerr << "Unhandled value " << le
688 << " in LyXLayout::readMargin." << endl;
694 void LyXLayout::readLatexType(LyXLex & lexrc)
696 keyword_item latexTypeTags[] = {
697 { "bib_environment", LATEX_BIB_ENVIRONMENT },
698 { "command", LATEX_COMMAND },
699 { "environment", LATEX_ENVIRONMENT },
700 { "item_environment", LATEX_ITEM_ENVIRONMENT },
701 { "list_environment", LATEX_LIST_ENVIRONMENT },
702 { "paragraph", LATEX_PARAGRAPH }
705 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
706 int le = lexrc.lex();
708 case LyXLex::LEX_UNDEF:
709 lexrc.printError("Unknown latextype tag `$$Token'");
711 case LATEX_PARAGRAPH:
713 case LATEX_ENVIRONMENT:
714 case LATEX_ITEM_ENVIRONMENT:
715 case LATEX_BIB_ENVIRONMENT:
716 case LATEX_LIST_ENVIRONMENT:
717 latextype = static_cast<LYX_LATEX_TYPES>(le);
720 lyxerr << "Unhandled value " << le
721 << " in LyXLayout::readLatexType." << endl;
728 ST_SPACING_SINGLE = 1,
735 void LyXLayout::readSpacing(LyXLex & lexrc)
737 keyword_item spacingTags[] = {
738 {"double", ST_SPACING_DOUBLE },
739 {"onehalf", ST_SPACING_ONEHALF },
740 {"other", ST_OTHER },
741 {"single", ST_SPACING_SINGLE }
744 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
745 int le = lexrc.lex();
747 case LyXLex::LEX_UNDEF:
748 lexrc.printError("Unknown spacing token `$$Token'");
752 switch (static_cast<SpacingTags>(le)) {
753 case ST_SPACING_SINGLE:
754 spacing.set(Spacing::Single);
756 case ST_SPACING_ONEHALF:
757 spacing.set(Spacing::Onehalf);
759 case ST_SPACING_DOUBLE:
760 spacing.set(Spacing::Double);
764 spacing.set(Spacing::Other, lexrc.getFloat());
770 string const & LyXLayout::name() const
776 void LyXLayout::setName(string const & n)
782 string const & LyXLayout::obsoleted_by() const
784 return obsoleted_by_;
788 string const & LyXLayout::depends_on() const