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;
29 // The order of the LayoutTags enum is no more important. [asierra300396]
42 //LT_ENVIRONMENT_DEFAULT,
59 LT_LABELSTRING_APPENDIX,
87 LT_INTITLE // keep this last!
92 // Constructor for layout
93 LyXLayout::LyXLayout ()
95 margintype = MARGIN_STATIC;
96 latextype = LATEX_PARAGRAPH;
101 font = LyXFont(LyXFont::ALL_INHERIT);
102 labelfont = LyXFont(LyXFont::ALL_INHERIT);
103 resfont = LyXFont(LyXFont::ALL_SANE);
104 reslabelfont = LyXFont(LyXFont::ALL_SANE);
105 nextnoindent = false;
110 labelbottomsep = 0.0;
112 align = LYX_ALIGN_BLOCK;
113 alignpossible = LYX_ALIGN_BLOCK;
114 labeltype = LABEL_NO_LABEL;
115 endlabeltype = END_LABEL_NO_LABEL;
116 // Should or should not. That is the question.
117 // spacing.set(Spacing::OneHalf);
120 newline_allowed = true;
121 free_spacing = false;
123 is_environment = false;
129 // Reads a layout definition from file
130 bool LyXLayout::Read(LyXLex & lexrc, LyXTextClass const & tclass)
132 // This table is sorted alphabetically [asierra 30March96]
133 keyword_item layoutTags[] = {
134 { "align", LT_ALIGN },
135 { "alignpossible", LT_ALIGNPOSSIBLE },
136 { "bottomsep", LT_BOTTOMSEP },
137 { "commanddepth", LT_COMMANDDEPTH },
138 { "copystyle", LT_COPYSTYLE },
139 { "dependson", LT_DEPENDSON },
141 { "endlabelstring", LT_ENDLABELSTRING },
142 { "endlabeltype", LT_ENDLABELTYPE },
143 { "fill_bottom", LT_FILL_BOTTOM },
144 { "fill_top", LT_FILL_TOP },
146 { "freespacing", LT_FREE_SPACING },
147 { "innertag", LT_INNERTAG },
148 { "intitle", LT_INTITLE },
149 { "itemsep", LT_ITEMSEP },
150 { "itemtag", LT_ITEMTAG },
151 { "keepempty", LT_KEEPEMPTY },
152 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
153 { "labelcounter", LT_LABELCOUNTER },
154 { "labelfont", LT_LABELFONT },
155 { "labelindent", LT_LABELINDENT },
156 { "labelsep", LT_LABELSEP },
157 { "labelstring", LT_LABELSTRING },
158 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
159 { "labeltag", LT_LABELTAG },
160 { "labeltype", LT_LABELTYPE },
161 { "latexfooter", LT_LATEXFOOTER },
162 { "latexheader", LT_LATEXHEADER },
163 { "latexname", LT_LATEXNAME },
164 { "latexparagraph", LT_LATEXPARAGRAPH },
165 { "latexparam", LT_LATEXPARAM },
166 { "latextype", LT_LATEXTYPE },
167 { "leftmargin", LT_LEFTMARGIN },
168 { "margin", LT_MARGIN },
169 { "needprotect", LT_NEED_PROTECT },
170 { "newline", LT_NEWLINE },
171 { "nextnoindent", LT_NEXTNOINDENT },
172 { "obsoletedby", LT_OBSOLETEDBY },
173 { "optionalargs", LT_OPTARGS },
174 { "parindent", LT_PARINDENT },
175 { "parsep", LT_PARSEP },
176 { "parskip", LT_PARSKIP },
177 { "passthru", LT_PASS_THRU },
178 { "preamble", LT_PREAMBLE },
179 { "rightmargin", LT_RIGHTMARGIN },
180 { "spacing", LT_SPACING },
181 { "textfont", LT_TEXTFONT },
182 { "toclevel", LT_TOCLEVEL },
183 { "topsep", LT_TOPSEP }
187 bool finished = false;
188 lexrc.pushTable(layoutTags, LT_INTITLE);
189 // parse style section
190 while (!finished && lexrc.isOK() && !error) {
191 int le = lexrc.lex();
192 // See comment in lyxrc.C.
194 case LyXLex::LEX_FEOF:
197 case LyXLex::LEX_UNDEF: // parse error
198 lexrc.printError("Unknown layout tag `$$Token'");
203 switch (static_cast<LayoutTags>(le)) {
204 case LT_END: // end of structure
208 case LT_COPYSTYLE: // initialize with a known style
210 string const style = lexrc.getString();
212 if (tclass.hasLayout(style)) {
213 string const tmpname = name_;
214 this->operator=(*tclass[style]);
217 lyxerr << "Cannot copy unknown style `"
219 << "All layouts so far:"
221 LyXTextClass::const_iterator it =
223 LyXTextClass::const_iterator end =
225 for (; it != end; ++it) {
226 lyxerr << (*it)->name()
230 //lexrc.printError("Cannot copy known "
231 // "style `$$Token'");
236 case LT_OBSOLETEDBY: // replace with a known style
238 string const style = lexrc.getString();
240 if (tclass.hasLayout(style)) {
241 string const tmpname = name_;
242 this->operator=(*tclass[style]);
244 if (obsoleted_by().empty())
245 obsoleted_by_ = style;
247 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
249 //lexrc.printError("Cannot replace with"
258 depends_on_ = lexrc.getString();
261 case LT_MARGIN: // margin style definition.
265 case LT_LATEXTYPE: // LaTeX style definition.
266 readLatexType(lexrc);
269 case LT_LATEXHEADER: // header for environments
271 latexheader = lexrc.getString();
274 case LT_LATEXFOOTER: // footer for environments
276 latexfooter = lexrc.getString();
279 case LT_LATEXPARAGRAPH:
281 latexparagraph = lexrc.getString();
285 intitle = lexrc.next() && lexrc.getInteger();
290 toclevel = lexrc.getInteger();
295 optionalargs = lexrc.getInteger();
298 case LT_NEED_PROTECT:
299 needprotect = lexrc.next() && lexrc.getInteger();
303 keepempty = lexrc.next() && lexrc.getInteger();
316 labelfont.lyxRead(lexrc);
319 case LT_NEXTNOINDENT: // Indent next paragraph?
320 if (lexrc.next() && lexrc.getInteger())
323 nextnoindent = false;
326 case LT_COMMANDDEPTH:
328 commanddepth = lexrc.getInteger();
333 latexname_ = lexrc.getString();
338 latexparam_ = subst(lexrc.getString(), """, "\"");
343 innertag_ = lexrc.getString();
348 labeltag_ = lexrc.getString();
353 itemtag_ = lexrc.getString();
357 preamble_ = lexrc.getLongString("EndPreamble");
361 readLabelType(lexrc);
364 case LT_ENDLABELTYPE:
365 readEndLabelType(lexrc);
368 case LT_LEFTMARGIN: // left margin type
370 leftmargin = lexrc.getString();
373 case LT_RIGHTMARGIN: // right margin type
375 rightmargin = lexrc.getString();
378 case LT_LABELINDENT: // label indenting flag
380 labelindent = lexrc.getString();
383 case LT_PARINDENT: // paragraph indent. flag
385 parindent = lexrc.getString();
388 case LT_PARSKIP: // paragraph skip size
390 parskip = lexrc.getFloat();
393 case LT_ITEMSEP: // item separation size
395 itemsep = lexrc.getFloat();
398 case LT_TOPSEP: // top separation size
400 topsep = lexrc.getFloat();
403 case LT_BOTTOMSEP: // bottom separation size
405 bottomsep = lexrc.getFloat();
408 case LT_LABEL_BOTTOMSEP: // label bottom separation size
410 labelbottomsep = lexrc.getFloat();
413 case LT_LABELSEP: // label separator
415 labelsep = subst(lexrc.getString(), 'x', ' ');
419 case LT_PARSEP: // par. separation size
421 parsep = lexrc.getFloat();
424 case LT_FILL_TOP: // fill top flag
426 fill_top = lexrc.getInteger();
429 case LT_FILL_BOTTOM: // fill bottom flag
431 fill_bottom = lexrc.getInteger();
434 case LT_NEWLINE: // newlines allowed?
436 newline_allowed = lexrc.getInteger();
439 case LT_ALIGN: // paragraph align
442 case LT_ALIGNPOSSIBLE: // paragraph allowed align
443 readAlignPossible(lexrc);
446 case LT_LABELSTRING: // label string definition
448 labelstring_ = trim(lexrc.getString());
451 case LT_ENDLABELSTRING: // endlabel string definition
453 endlabelstring_ = trim(lexrc.getString());
456 case LT_LABELSTRING_APPENDIX: // label string appendix definition
458 labelstring_appendix_ = trim(lexrc.getString());
461 case LT_LABELCOUNTER: // name of counter to use
463 counter = trim(lexrc.getString());
466 case LT_FREE_SPACING: // Allow for free spacing.
468 free_spacing = lexrc.getInteger();
471 case LT_PASS_THRU: // Allow for pass thru.
473 pass_thru = lexrc.getInteger();
476 case LT_SPACING: // setspace.sty
483 if (labelstring_appendix_.empty())
484 labelstring_appendix_ = labelstring_;
498 void LyXLayout::readAlign(LyXLex & lexrc)
500 keyword_item alignTags[] = {
501 { "block", AT_BLOCK },
502 { "center", AT_CENTER },
503 { "layout", AT_LAYOUT },
505 { "right", AT_RIGHT }
508 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
509 int le = lexrc.lex();
511 case LyXLex::LEX_UNDEF:
512 lexrc.printError("Unknown alignment `$$Token'");
516 switch (static_cast<AlignTags>(le)) {
518 align = LYX_ALIGN_BLOCK;
521 align = LYX_ALIGN_LEFT;
524 align = LYX_ALIGN_RIGHT;
527 align = LYX_ALIGN_CENTER;
530 align = LYX_ALIGN_LAYOUT;
536 void LyXLayout::readAlignPossible(LyXLex & lexrc)
538 keyword_item alignTags[] = {
539 { "block", AT_BLOCK },
540 { "center", AT_CENTER },
541 { "layout", AT_LAYOUT },
543 { "right", AT_RIGHT }
546 lexrc.pushTable(alignTags, AT_LAYOUT);
547 alignpossible = LYX_ALIGN_NONE;
548 int lineno = lexrc.getLineNo();
550 int le = lexrc.lex();
552 case LyXLex::LEX_UNDEF:
553 lexrc.printError("Unknown alignment `$$Token'");
557 switch (static_cast<AlignTags>(le)) {
559 alignpossible |= LYX_ALIGN_BLOCK;
562 alignpossible |= LYX_ALIGN_LEFT;
565 alignpossible |= LYX_ALIGN_RIGHT;
568 alignpossible |= LYX_ALIGN_CENTER;
571 alignpossible |= LYX_ALIGN_LAYOUT;
574 } while (lineno == lexrc.getLineNo());
583 LA_CENTERED_TOP_ENVIRONMENT,
593 void LyXLayout::readLabelType(LyXLex & lexrc)
595 keyword_item labelTypeTags[] = {
596 { "bibliography", LA_BIBLIO },
597 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
598 { "counter", LA_COUNTER },
599 { "enumerate", LA_ENUMERATE },
600 { "itemize", LA_ITEMIZE },
601 { "manual", LA_MANUAL },
602 { "no_label", LA_NO_LABEL },
603 { "sensitive", LA_SENSITIVE },
604 { "static", LA_STATIC },
605 { "top_environment", LA_TOP_ENVIRONMENT }
608 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
609 int le = lexrc.lex();
611 case LyXLex::LEX_UNDEF:
612 lexrc.printError("Unknown labeltype tag `$$Token'");
616 switch (static_cast<LabelTypeTags>(le)) {
618 labeltype = LABEL_NO_LABEL;
621 labeltype = LABEL_MANUAL;
623 case LA_TOP_ENVIRONMENT:
624 labeltype = LABEL_TOP_ENVIRONMENT;
626 case LA_CENTERED_TOP_ENVIRONMENT:
627 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
630 labeltype = LABEL_STATIC;
633 labeltype = LABEL_SENSITIVE;
636 labeltype = LABEL_COUNTER;
639 labeltype = LABEL_ENUMERATE;
642 labeltype = LABEL_ITEMIZE;
645 labeltype = LABEL_BIBLIO;
653 keyword_item endlabelTypeTags[] = {
654 { "box", END_LABEL_BOX },
655 { "filled_box", END_LABEL_FILLED_BOX },
656 { "no_label", END_LABEL_NO_LABEL },
657 { "static", END_LABEL_STATIC }
663 void LyXLayout::readEndLabelType(LyXLex & lexrc)
665 pushpophelper pph(lexrc, endlabelTypeTags,
666 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
667 int le = lexrc.lex();
669 case LyXLex::LEX_UNDEF:
670 lexrc.printError("Unknown labeltype tag `$$Token'");
672 case END_LABEL_STATIC:
674 case END_LABEL_FILLED_BOX:
675 case END_LABEL_NO_LABEL:
676 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
679 lyxerr << "Unhandled value " << le
680 << " in LyXLayout::readEndLabelType." << endl;
686 void LyXLayout::readMargin(LyXLex & lexrc)
688 keyword_item marginTags[] = {
689 { "dynamic", MARGIN_DYNAMIC },
690 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
691 { "manual", MARGIN_MANUAL },
692 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
693 { "static", MARGIN_STATIC }
696 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
698 int le = lexrc.lex();
700 case LyXLex::LEX_UNDEF:
701 lexrc.printError("Unknown margin type tag `$$Token'");
706 case MARGIN_FIRST_DYNAMIC:
707 case MARGIN_RIGHT_ADDRESS_BOX:
708 margintype = static_cast<LYX_MARGIN_TYPE>(le);
711 lyxerr << "Unhandled value " << le
712 << " in LyXLayout::readMargin." << endl;
718 void LyXLayout::readLatexType(LyXLex & lexrc)
720 keyword_item latexTypeTags[] = {
721 { "bib_environment", LATEX_BIB_ENVIRONMENT },
722 { "command", LATEX_COMMAND },
723 { "environment", LATEX_ENVIRONMENT },
724 { "item_environment", LATEX_ITEM_ENVIRONMENT },
725 { "list_environment", LATEX_LIST_ENVIRONMENT },
726 { "paragraph", LATEX_PARAGRAPH }
729 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
730 int le = lexrc.lex();
732 case LyXLex::LEX_UNDEF:
733 lexrc.printError("Unknown latextype tag `$$Token'");
735 case LATEX_PARAGRAPH:
737 case LATEX_ENVIRONMENT:
738 case LATEX_ITEM_ENVIRONMENT:
739 case LATEX_BIB_ENVIRONMENT:
740 case LATEX_LIST_ENVIRONMENT:
741 latextype = static_cast<LYX_LATEX_TYPES>(le);
744 lyxerr << "Unhandled value " << le
745 << " in LyXLayout::readLatexType." << endl;
752 ST_SPACING_SINGLE = 1,
759 void LyXLayout::readSpacing(LyXLex & lexrc)
761 keyword_item spacingTags[] = {
762 {"double", ST_SPACING_DOUBLE },
763 {"onehalf", ST_SPACING_ONEHALF },
764 {"other", ST_OTHER },
765 {"single", ST_SPACING_SINGLE }
768 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
769 int le = lexrc.lex();
771 case LyXLex::LEX_UNDEF:
772 lexrc.printError("Unknown spacing token `$$Token'");
776 switch (static_cast<SpacingTags>(le)) {
777 case ST_SPACING_SINGLE:
778 spacing.set(Spacing::Single);
780 case ST_SPACING_ONEHALF:
781 spacing.set(Spacing::Onehalf);
783 case ST_SPACING_DOUBLE:
784 spacing.set(Spacing::Double);
788 spacing.set(Spacing::Other, lexrc.getString());
794 string const & LyXLayout::name() const
800 void LyXLayout::setName(string const & n)
806 string const & LyXLayout::obsoleted_by() const
808 return obsoleted_by_;
812 string const & LyXLayout::depends_on() const