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"
31 /// Special value of toclevel for layouts that to not belong in a TOC
32 const int LyXLayout::NOT_IN_TOC = -1000;
34 // The order of the LayoutTags enum is no more important. [asierra300396]
47 //LT_ENVIRONMENT_DEFAULT,
64 LT_LABELSTRING_APPENDIX,
92 LT_INTITLE // keep this last!
97 // Constructor for layout
98 LyXLayout::LyXLayout ()
100 margintype = MARGIN_STATIC;
101 latextype = LATEX_PARAGRAPH;
106 font = LyXFont(LyXFont::ALL_INHERIT);
107 labelfont = LyXFont(LyXFont::ALL_INHERIT);
108 resfont = LyXFont(LyXFont::ALL_SANE);
109 reslabelfont = LyXFont(LyXFont::ALL_SANE);
110 nextnoindent = false;
115 labelbottomsep = 0.0;
117 align = LYX_ALIGN_BLOCK;
118 alignpossible = LYX_ALIGN_BLOCK;
119 labeltype = LABEL_NO_LABEL;
120 endlabeltype = END_LABEL_NO_LABEL;
121 // Should or should not. That is the question.
122 // spacing.set(Spacing::OneHalf);
125 newline_allowed = true;
126 free_spacing = false;
128 is_environment = false;
129 toclevel = NOT_IN_TOC;
134 // Reads a layout definition from file
135 bool LyXLayout::read(LyXLex & lexrc, LyXTextClass const & tclass)
137 // This table is sorted alphabetically [asierra 30March96]
138 keyword_item layoutTags[] = {
139 { "align", LT_ALIGN },
140 { "alignpossible", LT_ALIGNPOSSIBLE },
141 { "bottomsep", LT_BOTTOMSEP },
142 { "commanddepth", LT_COMMANDDEPTH },
143 { "copystyle", LT_COPYSTYLE },
144 { "dependson", LT_DEPENDSON },
146 { "endlabelstring", LT_ENDLABELSTRING },
147 { "endlabeltype", LT_ENDLABELTYPE },
148 { "fill_bottom", LT_FILL_BOTTOM },
149 { "fill_top", LT_FILL_TOP },
151 { "freespacing", LT_FREE_SPACING },
152 { "innertag", LT_INNERTAG },
153 { "intitle", LT_INTITLE },
154 { "itemsep", LT_ITEMSEP },
155 { "itemtag", LT_ITEMTAG },
156 { "keepempty", LT_KEEPEMPTY },
157 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
158 { "labelcounter", LT_LABELCOUNTER },
159 { "labelfont", LT_LABELFONT },
160 { "labelindent", LT_LABELINDENT },
161 { "labelsep", LT_LABELSEP },
162 { "labelstring", LT_LABELSTRING },
163 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
164 { "labeltag", LT_LABELTAG },
165 { "labeltype", LT_LABELTYPE },
166 { "latexfooter", LT_LATEXFOOTER },
167 { "latexheader", LT_LATEXHEADER },
168 { "latexname", LT_LATEXNAME },
169 { "latexparagraph", LT_LATEXPARAGRAPH },
170 { "latexparam", LT_LATEXPARAM },
171 { "latextype", LT_LATEXTYPE },
172 { "leftmargin", LT_LEFTMARGIN },
173 { "margin", LT_MARGIN },
174 { "needprotect", LT_NEED_PROTECT },
175 { "newline", LT_NEWLINE },
176 { "nextnoindent", LT_NEXTNOINDENT },
177 { "obsoletedby", LT_OBSOLETEDBY },
178 { "optionalargs", LT_OPTARGS },
179 { "parindent", LT_PARINDENT },
180 { "parsep", LT_PARSEP },
181 { "parskip", LT_PARSKIP },
182 { "passthru", LT_PASS_THRU },
183 { "preamble", LT_PREAMBLE },
184 { "rightmargin", LT_RIGHTMARGIN },
185 { "spacing", LT_SPACING },
186 { "textfont", LT_TEXTFONT },
187 { "toclevel", LT_TOCLEVEL },
188 { "topsep", LT_TOPSEP }
192 bool finished = false;
193 lexrc.pushTable(layoutTags, LT_INTITLE);
194 // parse style section
195 while (!finished && lexrc.isOK() && !error) {
196 int le = lexrc.lex();
197 // See comment in lyxrc.C.
199 case LyXLex::LEX_FEOF:
202 case LyXLex::LEX_UNDEF: // parse error
203 lexrc.printError("Unknown layout tag `$$Token'");
208 switch (static_cast<LayoutTags>(le)) {
209 case LT_END: // end of structure
213 case LT_COPYSTYLE: // initialize with a known style
215 string const style = subst(lexrc.getString(),
218 if (tclass.hasLayout(style)) {
219 string const tmpname = name_;
220 this->operator=(*tclass[style]);
223 lyxerr << "Cannot copy unknown style `"
225 << "All layouts so far:"
227 LyXTextClass::const_iterator it =
229 LyXTextClass::const_iterator end =
231 for (; it != end; ++it) {
232 lyxerr << (*it)->name()
236 //lexrc.printError("Cannot copy known "
237 // "style `$$Token'");
242 case LT_OBSOLETEDBY: // replace with a known style
244 string const style = lexrc.getString();
246 if (tclass.hasLayout(style)) {
247 string const tmpname = name_;
248 this->operator=(*tclass[style]);
250 if (obsoleted_by().empty())
251 obsoleted_by_ = style;
253 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
255 //lexrc.printError("Cannot replace with"
264 depends_on_ = lexrc.getString();
267 case LT_MARGIN: // margin style definition.
271 case LT_LATEXTYPE: // LaTeX style definition.
272 readLatexType(lexrc);
275 case LT_LATEXHEADER: // header for environments
277 latexheader = lexrc.getString();
280 case LT_LATEXFOOTER: // footer for environments
282 latexfooter = lexrc.getString();
285 case LT_LATEXPARAGRAPH:
287 latexparagraph = lexrc.getString();
291 intitle = lexrc.next() && lexrc.getInteger();
296 toclevel = lexrc.getInteger();
301 optionalargs = lexrc.getInteger();
304 case LT_NEED_PROTECT:
305 needprotect = lexrc.next() && lexrc.getInteger();
309 keepempty = lexrc.next() && lexrc.getInteger();
322 labelfont.lyxRead(lexrc);
325 case LT_NEXTNOINDENT: // Indent next paragraph?
326 if (lexrc.next() && lexrc.getInteger())
329 nextnoindent = false;
332 case LT_COMMANDDEPTH:
334 commanddepth = lexrc.getInteger();
339 latexname_ = lexrc.getString();
344 latexparam_ = subst(lexrc.getString(), """, "\"");
349 innertag_ = lexrc.getString();
354 labeltag_ = lexrc.getString();
359 itemtag_ = lexrc.getString();
363 preamble_ = lexrc.getLongString("EndPreamble");
367 readLabelType(lexrc);
370 case LT_ENDLABELTYPE:
371 readEndLabelType(lexrc);
374 case LT_LEFTMARGIN: // left margin type
376 leftmargin = lexrc.getString();
379 case LT_RIGHTMARGIN: // right margin type
381 rightmargin = lexrc.getString();
384 case LT_LABELINDENT: // label indenting flag
386 labelindent = lexrc.getString();
389 case LT_PARINDENT: // paragraph indent. flag
391 parindent = lexrc.getString();
394 case LT_PARSKIP: // paragraph skip size
396 parskip = lexrc.getFloat();
399 case LT_ITEMSEP: // item separation size
401 itemsep = lexrc.getFloat();
404 case LT_TOPSEP: // top separation size
406 topsep = lexrc.getFloat();
409 case LT_BOTTOMSEP: // bottom separation size
411 bottomsep = lexrc.getFloat();
414 case LT_LABEL_BOTTOMSEP: // label bottom separation size
416 labelbottomsep = lexrc.getFloat();
419 case LT_LABELSEP: // label separator
421 labelsep = subst(lexrc.getString(), 'x', ' ');
425 case LT_PARSEP: // par. separation size
427 parsep = lexrc.getFloat();
430 case LT_FILL_TOP: // fill top flag
432 fill_top = lexrc.getInteger();
435 case LT_FILL_BOTTOM: // fill bottom flag
437 fill_bottom = lexrc.getInteger();
440 case LT_NEWLINE: // newlines allowed?
442 newline_allowed = lexrc.getInteger();
445 case LT_ALIGN: // paragraph align
448 case LT_ALIGNPOSSIBLE: // paragraph allowed align
449 readAlignPossible(lexrc);
452 case LT_LABELSTRING: // label string definition
454 labelstring_ = lyx::from_ascii(trim(lexrc.getString()));
457 case LT_ENDLABELSTRING: // endlabel string definition
459 endlabelstring_ = lyx::from_ascii(trim(lexrc.getString()));
462 case LT_LABELSTRING_APPENDIX: // label string appendix definition
464 labelstring_appendix_ = lyx::from_ascii(trim(lexrc.getString()));
467 case LT_LABELCOUNTER: // name of counter to use
469 counter = lyx::from_ascii(trim(lexrc.getString()));
472 case LT_FREE_SPACING: // Allow for free spacing.
474 free_spacing = lexrc.getInteger();
477 case LT_PASS_THRU: // Allow for pass thru.
479 pass_thru = lexrc.getInteger();
482 case LT_SPACING: // setspace.sty
489 if (labelstring_appendix_.empty())
490 labelstring_appendix_ = labelstring_;
504 void LyXLayout::readAlign(LyXLex & lexrc)
506 keyword_item alignTags[] = {
507 { "block", AT_BLOCK },
508 { "center", AT_CENTER },
509 { "layout", AT_LAYOUT },
511 { "right", AT_RIGHT }
514 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
515 int le = lexrc.lex();
517 case LyXLex::LEX_UNDEF:
518 lexrc.printError("Unknown alignment `$$Token'");
522 switch (static_cast<AlignTags>(le)) {
524 align = LYX_ALIGN_BLOCK;
527 align = LYX_ALIGN_LEFT;
530 align = LYX_ALIGN_RIGHT;
533 align = LYX_ALIGN_CENTER;
536 align = LYX_ALIGN_LAYOUT;
542 void LyXLayout::readAlignPossible(LyXLex & lexrc)
544 keyword_item alignTags[] = {
545 { "block", AT_BLOCK },
546 { "center", AT_CENTER },
547 { "layout", AT_LAYOUT },
549 { "right", AT_RIGHT }
552 lexrc.pushTable(alignTags, AT_LAYOUT);
553 alignpossible = LYX_ALIGN_NONE;
554 int lineno = lexrc.getLineNo();
556 int le = lexrc.lex();
558 case LyXLex::LEX_UNDEF:
559 lexrc.printError("Unknown alignment `$$Token'");
563 switch (static_cast<AlignTags>(le)) {
565 alignpossible |= LYX_ALIGN_BLOCK;
568 alignpossible |= LYX_ALIGN_LEFT;
571 alignpossible |= LYX_ALIGN_RIGHT;
574 alignpossible |= LYX_ALIGN_CENTER;
577 alignpossible |= LYX_ALIGN_LAYOUT;
580 } while (lineno == lexrc.getLineNo());
589 LA_CENTERED_TOP_ENVIRONMENT,
599 void LyXLayout::readLabelType(LyXLex & lexrc)
601 keyword_item labelTypeTags[] = {
602 { "bibliography", LA_BIBLIO },
603 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
604 { "counter", LA_COUNTER },
605 { "enumerate", LA_ENUMERATE },
606 { "itemize", LA_ITEMIZE },
607 { "manual", LA_MANUAL },
608 { "no_label", LA_NO_LABEL },
609 { "sensitive", LA_SENSITIVE },
610 { "static", LA_STATIC },
611 { "top_environment", LA_TOP_ENVIRONMENT }
614 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
615 int le = lexrc.lex();
617 case LyXLex::LEX_UNDEF:
618 lexrc.printError("Unknown labeltype tag `$$Token'");
622 switch (static_cast<LabelTypeTags>(le)) {
624 labeltype = LABEL_NO_LABEL;
627 labeltype = LABEL_MANUAL;
629 case LA_TOP_ENVIRONMENT:
630 labeltype = LABEL_TOP_ENVIRONMENT;
632 case LA_CENTERED_TOP_ENVIRONMENT:
633 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
636 labeltype = LABEL_STATIC;
639 labeltype = LABEL_SENSITIVE;
642 labeltype = LABEL_COUNTER;
645 labeltype = LABEL_ENUMERATE;
648 labeltype = LABEL_ITEMIZE;
651 labeltype = LABEL_BIBLIO;
659 keyword_item endlabelTypeTags[] = {
660 { "box", END_LABEL_BOX },
661 { "filled_box", END_LABEL_FILLED_BOX },
662 { "no_label", END_LABEL_NO_LABEL },
663 { "static", END_LABEL_STATIC }
669 void LyXLayout::readEndLabelType(LyXLex & lexrc)
671 pushpophelper pph(lexrc, endlabelTypeTags,
672 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
673 int le = lexrc.lex();
675 case LyXLex::LEX_UNDEF:
676 lexrc.printError("Unknown labeltype tag `$$Token'");
678 case END_LABEL_STATIC:
680 case END_LABEL_FILLED_BOX:
681 case END_LABEL_NO_LABEL:
682 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
685 lyxerr << "Unhandled value " << le
686 << " in LyXLayout::readEndLabelType." << endl;
692 void LyXLayout::readMargin(LyXLex & lexrc)
694 keyword_item marginTags[] = {
695 { "dynamic", MARGIN_DYNAMIC },
696 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
697 { "manual", MARGIN_MANUAL },
698 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
699 { "static", MARGIN_STATIC }
702 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
704 int le = lexrc.lex();
706 case LyXLex::LEX_UNDEF:
707 lexrc.printError("Unknown margin type tag `$$Token'");
712 case MARGIN_FIRST_DYNAMIC:
713 case MARGIN_RIGHT_ADDRESS_BOX:
714 margintype = static_cast<LYX_MARGIN_TYPE>(le);
717 lyxerr << "Unhandled value " << le
718 << " in LyXLayout::readMargin." << endl;
724 void LyXLayout::readLatexType(LyXLex & lexrc)
726 keyword_item latexTypeTags[] = {
727 { "bib_environment", LATEX_BIB_ENVIRONMENT },
728 { "command", LATEX_COMMAND },
729 { "environment", LATEX_ENVIRONMENT },
730 { "item_environment", LATEX_ITEM_ENVIRONMENT },
731 { "list_environment", LATEX_LIST_ENVIRONMENT },
732 { "paragraph", LATEX_PARAGRAPH }
735 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
736 int le = lexrc.lex();
738 case LyXLex::LEX_UNDEF:
739 lexrc.printError("Unknown latextype tag `$$Token'");
741 case LATEX_PARAGRAPH:
743 case LATEX_ENVIRONMENT:
744 case LATEX_ITEM_ENVIRONMENT:
745 case LATEX_BIB_ENVIRONMENT:
746 case LATEX_LIST_ENVIRONMENT:
747 latextype = static_cast<LYX_LATEX_TYPES>(le);
750 lyxerr << "Unhandled value " << le
751 << " in LyXLayout::readLatexType." << endl;
758 ST_SPACING_SINGLE = 1,
765 void LyXLayout::readSpacing(LyXLex & lexrc)
767 keyword_item spacingTags[] = {
768 {"double", ST_SPACING_DOUBLE },
769 {"onehalf", ST_SPACING_ONEHALF },
770 {"other", ST_OTHER },
771 {"single", ST_SPACING_SINGLE }
774 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
775 int le = lexrc.lex();
777 case LyXLex::LEX_UNDEF:
778 lexrc.printError("Unknown spacing token `$$Token'");
782 switch (static_cast<SpacingTags>(le)) {
783 case ST_SPACING_SINGLE:
784 spacing.set(Spacing::Single);
786 case ST_SPACING_ONEHALF:
787 spacing.set(Spacing::Onehalf);
789 case ST_SPACING_DOUBLE:
790 spacing.set(Spacing::Double);
794 spacing.set(Spacing::Other, lexrc.getString());
800 string const & LyXLayout::name() const
806 void LyXLayout::setName(string const & n)
812 string const & LyXLayout::obsoleted_by() const
814 return obsoleted_by_;
818 string const & LyXLayout::depends_on() const