3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
15 #include "lyxlayout.h"
16 #include "lyxtextclass.h"
20 #include "support/lstrings.h"
22 using lyx::support::subst;
23 using lyx::support::trim;
28 /// Special value of toclevel for layouts that to not belong in a TOC
29 const int LyXLayout::NOT_IN_TOC = -1000;
31 // The order of the LayoutTags enum is no more important. [asierra300396]
44 //LT_ENVIRONMENT_DEFAULT,
61 LT_LABELSTRING_APPENDIX,
89 LT_INTITLE // keep this last!
94 // Constructor for layout
95 LyXLayout::LyXLayout ()
97 margintype = MARGIN_STATIC;
98 latextype = LATEX_PARAGRAPH;
103 font = LyXFont(LyXFont::ALL_INHERIT);
104 labelfont = LyXFont(LyXFont::ALL_INHERIT);
105 resfont = LyXFont(LyXFont::ALL_SANE);
106 reslabelfont = LyXFont(LyXFont::ALL_SANE);
107 nextnoindent = false;
112 labelbottomsep = 0.0;
114 align = LYX_ALIGN_BLOCK;
115 alignpossible = LYX_ALIGN_BLOCK;
116 labeltype = LABEL_NO_LABEL;
117 endlabeltype = END_LABEL_NO_LABEL;
118 // Should or should not. That is the question.
119 // spacing.set(Spacing::OneHalf);
122 newline_allowed = true;
123 free_spacing = false;
125 is_environment = false;
126 toclevel = NOT_IN_TOC;
131 // Reads a layout definition from file
132 bool LyXLayout::read(LyXLex & lexrc, LyXTextClass const & tclass)
134 // This table is sorted alphabetically [asierra 30March96]
135 keyword_item layoutTags[] = {
136 { "align", LT_ALIGN },
137 { "alignpossible", LT_ALIGNPOSSIBLE },
138 { "bottomsep", LT_BOTTOMSEP },
139 { "commanddepth", LT_COMMANDDEPTH },
140 { "copystyle", LT_COPYSTYLE },
141 { "dependson", LT_DEPENDSON },
143 { "endlabelstring", LT_ENDLABELSTRING },
144 { "endlabeltype", LT_ENDLABELTYPE },
145 { "fill_bottom", LT_FILL_BOTTOM },
146 { "fill_top", LT_FILL_TOP },
148 { "freespacing", LT_FREE_SPACING },
149 { "innertag", LT_INNERTAG },
150 { "intitle", LT_INTITLE },
151 { "itemsep", LT_ITEMSEP },
152 { "itemtag", LT_ITEMTAG },
153 { "keepempty", LT_KEEPEMPTY },
154 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
155 { "labelcounter", LT_LABELCOUNTER },
156 { "labelfont", LT_LABELFONT },
157 { "labelindent", LT_LABELINDENT },
158 { "labelsep", LT_LABELSEP },
159 { "labelstring", LT_LABELSTRING },
160 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
161 { "labeltag", LT_LABELTAG },
162 { "labeltype", LT_LABELTYPE },
163 { "latexfooter", LT_LATEXFOOTER },
164 { "latexheader", LT_LATEXHEADER },
165 { "latexname", LT_LATEXNAME },
166 { "latexparagraph", LT_LATEXPARAGRAPH },
167 { "latexparam", LT_LATEXPARAM },
168 { "latextype", LT_LATEXTYPE },
169 { "leftmargin", LT_LEFTMARGIN },
170 { "margin", LT_MARGIN },
171 { "needprotect", LT_NEED_PROTECT },
172 { "newline", LT_NEWLINE },
173 { "nextnoindent", LT_NEXTNOINDENT },
174 { "obsoletedby", LT_OBSOLETEDBY },
175 { "optionalargs", LT_OPTARGS },
176 { "parindent", LT_PARINDENT },
177 { "parsep", LT_PARSEP },
178 { "parskip", LT_PARSKIP },
179 { "passthru", LT_PASS_THRU },
180 { "preamble", LT_PREAMBLE },
181 { "rightmargin", LT_RIGHTMARGIN },
182 { "spacing", LT_SPACING },
183 { "textfont", LT_TEXTFONT },
184 { "toclevel", LT_TOCLEVEL },
185 { "topsep", LT_TOPSEP }
189 bool finished = false;
190 lexrc.pushTable(layoutTags, LT_INTITLE);
191 // parse style section
192 while (!finished && lexrc.isOK() && !error) {
193 int le = lexrc.lex();
194 // See comment in lyxrc.C.
196 case LyXLex::LEX_FEOF:
199 case LyXLex::LEX_UNDEF: // parse error
200 lexrc.printError("Unknown layout tag `$$Token'");
205 switch (static_cast<LayoutTags>(le)) {
206 case LT_END: // end of structure
210 case LT_COPYSTYLE: // initialize with a known style
212 string const style = subst(lexrc.getString(),
215 if (tclass.hasLayout(style)) {
216 string const tmpname = name_;
217 this->operator=(*tclass[style]);
220 lyxerr << "Cannot copy unknown style `"
222 << "All layouts so far:"
224 LyXTextClass::const_iterator it =
226 LyXTextClass::const_iterator end =
228 for (; it != end; ++it) {
229 lyxerr << (*it)->name()
233 //lexrc.printError("Cannot copy known "
234 // "style `$$Token'");
239 case LT_OBSOLETEDBY: // replace with a known style
241 string const style = lexrc.getString();
243 if (tclass.hasLayout(style)) {
244 string const tmpname = name_;
245 this->operator=(*tclass[style]);
247 if (obsoleted_by().empty())
248 obsoleted_by_ = style;
250 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
252 //lexrc.printError("Cannot replace with"
261 depends_on_ = lexrc.getString();
264 case LT_MARGIN: // margin style definition.
268 case LT_LATEXTYPE: // LaTeX style definition.
269 readLatexType(lexrc);
272 case LT_LATEXHEADER: // header for environments
274 latexheader = lexrc.getString();
277 case LT_LATEXFOOTER: // footer for environments
279 latexfooter = lexrc.getString();
282 case LT_LATEXPARAGRAPH:
284 latexparagraph = lexrc.getString();
288 intitle = lexrc.next() && lexrc.getInteger();
293 toclevel = lexrc.getInteger();
298 optionalargs = lexrc.getInteger();
301 case LT_NEED_PROTECT:
302 needprotect = lexrc.next() && lexrc.getInteger();
306 keepempty = lexrc.next() && lexrc.getInteger();
319 labelfont.lyxRead(lexrc);
322 case LT_NEXTNOINDENT: // Indent next paragraph?
323 if (lexrc.next() && lexrc.getInteger())
326 nextnoindent = false;
329 case LT_COMMANDDEPTH:
331 commanddepth = lexrc.getInteger();
336 latexname_ = lexrc.getString();
341 latexparam_ = subst(lexrc.getString(), """, "\"");
346 innertag_ = lexrc.getString();
351 labeltag_ = lexrc.getString();
356 itemtag_ = lexrc.getString();
360 preamble_ = lexrc.getLongString("EndPreamble");
364 readLabelType(lexrc);
367 case LT_ENDLABELTYPE:
368 readEndLabelType(lexrc);
371 case LT_LEFTMARGIN: // left margin type
373 leftmargin = lexrc.getString();
376 case LT_RIGHTMARGIN: // right margin type
378 rightmargin = lexrc.getString();
381 case LT_LABELINDENT: // label indenting flag
383 labelindent = lexrc.getString();
386 case LT_PARINDENT: // paragraph indent. flag
388 parindent = lexrc.getString();
391 case LT_PARSKIP: // paragraph skip size
393 parskip = lexrc.getFloat();
396 case LT_ITEMSEP: // item separation size
398 itemsep = lexrc.getFloat();
401 case LT_TOPSEP: // top separation size
403 topsep = lexrc.getFloat();
406 case LT_BOTTOMSEP: // bottom separation size
408 bottomsep = lexrc.getFloat();
411 case LT_LABEL_BOTTOMSEP: // label bottom separation size
413 labelbottomsep = lexrc.getFloat();
416 case LT_LABELSEP: // label separator
418 labelsep = subst(lexrc.getString(), 'x', ' ');
422 case LT_PARSEP: // par. separation size
424 parsep = lexrc.getFloat();
427 case LT_FILL_TOP: // fill top flag
429 fill_top = lexrc.getInteger();
432 case LT_FILL_BOTTOM: // fill bottom flag
434 fill_bottom = lexrc.getInteger();
437 case LT_NEWLINE: // newlines allowed?
439 newline_allowed = lexrc.getInteger();
442 case LT_ALIGN: // paragraph align
445 case LT_ALIGNPOSSIBLE: // paragraph allowed align
446 readAlignPossible(lexrc);
449 case LT_LABELSTRING: // label string definition
451 labelstring_ = trim(lexrc.getString());
454 case LT_ENDLABELSTRING: // endlabel string definition
456 endlabelstring_ = trim(lexrc.getString());
459 case LT_LABELSTRING_APPENDIX: // label string appendix definition
461 labelstring_appendix_ = trim(lexrc.getString());
464 case LT_LABELCOUNTER: // name of counter to use
466 counter = trim(lexrc.getString());
469 case LT_FREE_SPACING: // Allow for free spacing.
471 free_spacing = lexrc.getInteger();
474 case LT_PASS_THRU: // Allow for pass thru.
476 pass_thru = lexrc.getInteger();
479 case LT_SPACING: // setspace.sty
486 if (labelstring_appendix_.empty())
487 labelstring_appendix_ = labelstring_;
501 void LyXLayout::readAlign(LyXLex & lexrc)
503 keyword_item alignTags[] = {
504 { "block", AT_BLOCK },
505 { "center", AT_CENTER },
506 { "layout", AT_LAYOUT },
508 { "right", AT_RIGHT }
511 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
512 int le = lexrc.lex();
514 case LyXLex::LEX_UNDEF:
515 lexrc.printError("Unknown alignment `$$Token'");
519 switch (static_cast<AlignTags>(le)) {
521 align = LYX_ALIGN_BLOCK;
524 align = LYX_ALIGN_LEFT;
527 align = LYX_ALIGN_RIGHT;
530 align = LYX_ALIGN_CENTER;
533 align = LYX_ALIGN_LAYOUT;
539 void LyXLayout::readAlignPossible(LyXLex & lexrc)
541 keyword_item alignTags[] = {
542 { "block", AT_BLOCK },
543 { "center", AT_CENTER },
544 { "layout", AT_LAYOUT },
546 { "right", AT_RIGHT }
549 lexrc.pushTable(alignTags, AT_LAYOUT);
550 alignpossible = LYX_ALIGN_NONE;
551 int lineno = lexrc.getLineNo();
553 int le = lexrc.lex();
555 case LyXLex::LEX_UNDEF:
556 lexrc.printError("Unknown alignment `$$Token'");
560 switch (static_cast<AlignTags>(le)) {
562 alignpossible |= LYX_ALIGN_BLOCK;
565 alignpossible |= LYX_ALIGN_LEFT;
568 alignpossible |= LYX_ALIGN_RIGHT;
571 alignpossible |= LYX_ALIGN_CENTER;
574 alignpossible |= LYX_ALIGN_LAYOUT;
577 } while (lineno == lexrc.getLineNo());
586 LA_CENTERED_TOP_ENVIRONMENT,
596 void LyXLayout::readLabelType(LyXLex & lexrc)
598 keyword_item labelTypeTags[] = {
599 { "bibliography", LA_BIBLIO },
600 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
601 { "counter", LA_COUNTER },
602 { "enumerate", LA_ENUMERATE },
603 { "itemize", LA_ITEMIZE },
604 { "manual", LA_MANUAL },
605 { "no_label", LA_NO_LABEL },
606 { "sensitive", LA_SENSITIVE },
607 { "static", LA_STATIC },
608 { "top_environment", LA_TOP_ENVIRONMENT }
611 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
612 int le = lexrc.lex();
614 case LyXLex::LEX_UNDEF:
615 lexrc.printError("Unknown labeltype tag `$$Token'");
619 switch (static_cast<LabelTypeTags>(le)) {
621 labeltype = LABEL_NO_LABEL;
624 labeltype = LABEL_MANUAL;
626 case LA_TOP_ENVIRONMENT:
627 labeltype = LABEL_TOP_ENVIRONMENT;
629 case LA_CENTERED_TOP_ENVIRONMENT:
630 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
633 labeltype = LABEL_STATIC;
636 labeltype = LABEL_SENSITIVE;
639 labeltype = LABEL_COUNTER;
642 labeltype = LABEL_ENUMERATE;
645 labeltype = LABEL_ITEMIZE;
648 labeltype = LABEL_BIBLIO;
656 keyword_item endlabelTypeTags[] = {
657 { "box", END_LABEL_BOX },
658 { "filled_box", END_LABEL_FILLED_BOX },
659 { "no_label", END_LABEL_NO_LABEL },
660 { "static", END_LABEL_STATIC }
666 void LyXLayout::readEndLabelType(LyXLex & lexrc)
668 pushpophelper pph(lexrc, endlabelTypeTags,
669 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
670 int le = lexrc.lex();
672 case LyXLex::LEX_UNDEF:
673 lexrc.printError("Unknown labeltype tag `$$Token'");
675 case END_LABEL_STATIC:
677 case END_LABEL_FILLED_BOX:
678 case END_LABEL_NO_LABEL:
679 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
682 lyxerr << "Unhandled value " << le
683 << " in LyXLayout::readEndLabelType." << endl;
689 void LyXLayout::readMargin(LyXLex & lexrc)
691 keyword_item marginTags[] = {
692 { "dynamic", MARGIN_DYNAMIC },
693 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
694 { "manual", MARGIN_MANUAL },
695 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
696 { "static", MARGIN_STATIC }
699 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
701 int le = lexrc.lex();
703 case LyXLex::LEX_UNDEF:
704 lexrc.printError("Unknown margin type tag `$$Token'");
709 case MARGIN_FIRST_DYNAMIC:
710 case MARGIN_RIGHT_ADDRESS_BOX:
711 margintype = static_cast<LYX_MARGIN_TYPE>(le);
714 lyxerr << "Unhandled value " << le
715 << " in LyXLayout::readMargin." << endl;
721 void LyXLayout::readLatexType(LyXLex & lexrc)
723 keyword_item latexTypeTags[] = {
724 { "bib_environment", LATEX_BIB_ENVIRONMENT },
725 { "command", LATEX_COMMAND },
726 { "environment", LATEX_ENVIRONMENT },
727 { "item_environment", LATEX_ITEM_ENVIRONMENT },
728 { "list_environment", LATEX_LIST_ENVIRONMENT },
729 { "paragraph", LATEX_PARAGRAPH }
732 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
733 int le = lexrc.lex();
735 case LyXLex::LEX_UNDEF:
736 lexrc.printError("Unknown latextype tag `$$Token'");
738 case LATEX_PARAGRAPH:
740 case LATEX_ENVIRONMENT:
741 case LATEX_ITEM_ENVIRONMENT:
742 case LATEX_BIB_ENVIRONMENT:
743 case LATEX_LIST_ENVIRONMENT:
744 latextype = static_cast<LYX_LATEX_TYPES>(le);
747 lyxerr << "Unhandled value " << le
748 << " in LyXLayout::readLatexType." << endl;
755 ST_SPACING_SINGLE = 1,
762 void LyXLayout::readSpacing(LyXLex & lexrc)
764 keyword_item spacingTags[] = {
765 {"double", ST_SPACING_DOUBLE },
766 {"onehalf", ST_SPACING_ONEHALF },
767 {"other", ST_OTHER },
768 {"single", ST_SPACING_SINGLE }
771 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
772 int le = lexrc.lex();
774 case LyXLex::LEX_UNDEF:
775 lexrc.printError("Unknown spacing token `$$Token'");
779 switch (static_cast<SpacingTags>(le)) {
780 case ST_SPACING_SINGLE:
781 spacing.set(Spacing::Single);
783 case ST_SPACING_ONEHALF:
784 spacing.set(Spacing::Onehalf);
786 case ST_SPACING_DOUBLE:
787 spacing.set(Spacing::Double);
791 spacing.set(Spacing::Other, lexrc.getString());
797 string const & LyXLayout::name() const
803 void LyXLayout::setName(string const & n)
809 string const & LyXLayout::obsoleted_by() const
811 return obsoleted_by_;
815 string const & LyXLayout::depends_on() const