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.
16 #include "TextClass.h"
20 #include "support/lstrings.h"
31 extern FontInfo lyxRead(Lexer &, FontInfo const & fi = sane_font);
34 /// Special value of toclevel for layouts that to not belong in a TOC
35 const int Layout::NOT_IN_TOC = -1000;
37 // The order of the LayoutTags enum is no more important. [asierra300396]
50 //LT_ENVIRONMENT_DEFAULT,
67 LT_LABELSTRING_APPENDIX,
95 LT_INTITLE // keep this last!
102 margintype = MARGIN_STATIC;
103 latextype = LATEX_PARAGRAPH;
109 labelfont = inherit_font;
111 reslabelfont = sane_font;
112 nextnoindent = false;
117 labelbottomsep = 0.0;
119 align = LYX_ALIGN_BLOCK;
120 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
121 labeltype = LABEL_NO_LABEL;
122 endlabeltype = END_LABEL_NO_LABEL;
123 // Should or should not. That is the question.
124 // spacing.set(Spacing::OneHalf);
127 newline_allowed = true;
128 free_spacing = false;
130 is_environment = false;
131 toclevel = NOT_IN_TOC;
136 bool Layout::read(Lexer & lexrc, TextClass const & tclass)
138 // This table is sorted alphabetically [asierra 30March96]
139 keyword_item layoutTags[] = {
140 { "align", LT_ALIGN },
141 { "alignpossible", LT_ALIGNPOSSIBLE },
142 { "bottomsep", LT_BOTTOMSEP },
143 { "commanddepth", LT_COMMANDDEPTH },
144 { "copystyle", LT_COPYSTYLE },
145 { "dependson", LT_DEPENDSON },
147 { "endlabelstring", LT_ENDLABELSTRING },
148 { "endlabeltype", LT_ENDLABELTYPE },
149 { "fill_bottom", LT_FILL_BOTTOM },
150 { "fill_top", LT_FILL_TOP },
152 { "freespacing", LT_FREE_SPACING },
153 { "innertag", LT_INNERTAG },
154 { "intitle", LT_INTITLE },
155 { "itemsep", LT_ITEMSEP },
156 { "itemtag", LT_ITEMTAG },
157 { "keepempty", LT_KEEPEMPTY },
158 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
159 { "labelcounter", LT_LABELCOUNTER },
160 { "labelfont", LT_LABELFONT },
161 { "labelindent", LT_LABELINDENT },
162 { "labelsep", LT_LABELSEP },
163 { "labelstring", LT_LABELSTRING },
164 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
165 { "labeltag", LT_LABELTAG },
166 { "labeltype", LT_LABELTYPE },
167 { "latexfooter", LT_LATEXFOOTER },
168 { "latexheader", LT_LATEXHEADER },
169 { "latexname", LT_LATEXNAME },
170 { "latexparagraph", LT_LATEXPARAGRAPH },
171 { "latexparam", LT_LATEXPARAM },
172 { "latextype", LT_LATEXTYPE },
173 { "leftmargin", LT_LEFTMARGIN },
174 { "margin", LT_MARGIN },
175 { "needprotect", LT_NEED_PROTECT },
176 { "newline", LT_NEWLINE },
177 { "nextnoindent", LT_NEXTNOINDENT },
178 { "obsoletedby", LT_OBSOLETEDBY },
179 { "optionalargs", LT_OPTARGS },
180 { "parindent", LT_PARINDENT },
181 { "parsep", LT_PARSEP },
182 { "parskip", LT_PARSKIP },
183 { "passthru", LT_PASS_THRU },
184 { "preamble", LT_PREAMBLE },
185 { "rightmargin", LT_RIGHTMARGIN },
186 { "spacing", LT_SPACING },
187 { "textfont", LT_TEXTFONT },
188 { "toclevel", LT_TOCLEVEL },
189 { "topsep", LT_TOPSEP }
193 bool finished = false;
194 lexrc.pushTable(layoutTags, LT_INTITLE);
195 // parse style section
196 while (!finished && lexrc.isOK() && !error) {
197 int le = lexrc.lex();
198 // See comment in LyXRC.cpp.
200 case Lexer::LEX_FEOF:
203 case Lexer::LEX_UNDEF: // parse error
204 lexrc.printError("Unknown layout tag `$$Token'");
209 switch (static_cast<LayoutTags>(le)) {
210 case LT_END: // end of structure
214 case LT_COPYSTYLE: // initialize with a known style
216 docstring const style = subst(lexrc.getDocString(),
219 if (tclass.hasLayout(style)) {
220 docstring const tmpname = name_;
221 this->operator=(*tclass[style]);
224 lyxerr << "Cannot copy unknown style `"
225 << to_utf8(style) << "'\n"
226 << "All layouts so far:"
228 TextClass::const_iterator it =
230 TextClass::const_iterator end =
232 for (; it != end; ++it) {
233 lyxerr << to_utf8((*it)->name())
237 //lexrc.printError("Cannot copy known "
238 // "style `$$Token'");
243 case LT_OBSOLETEDBY: // replace with a known style
245 docstring const style =
246 subst(lexrc.getDocString(), '_', ' ');
248 if (tclass.hasLayout(style)) {
249 docstring const tmpname = name_;
250 this->operator=(*tclass[style]);
252 if (obsoleted_by().empty())
253 obsoleted_by_ = style;
255 lyxerr << "Cannot replace with unknown style `"
256 << to_utf8(style) << '\'' << endl;
258 //lexrc.printError("Cannot replace with"
267 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
270 case LT_MARGIN: // margin style definition.
274 case LT_LATEXTYPE: // LaTeX style definition.
275 readLatexType(lexrc);
278 case LT_LATEXHEADER: // header for environments
280 latexheader = lexrc.getString();
283 case LT_LATEXFOOTER: // footer for environments
285 latexfooter = lexrc.getString();
288 case LT_LATEXPARAGRAPH:
290 latexparagraph = lexrc.getString();
294 intitle = lexrc.next() && lexrc.getInteger();
299 toclevel = lexrc.getInteger();
304 optionalargs = lexrc.getInteger();
307 case LT_NEED_PROTECT:
308 needprotect = lexrc.next() && lexrc.getInteger();
312 keepempty = lexrc.next() && lexrc.getInteger();
316 font = lyxRead(lexrc, font);
321 font = lyxRead(lexrc, font);
325 labelfont = lyxRead(lexrc, labelfont);
328 case LT_NEXTNOINDENT: // Indent next paragraph?
329 if (lexrc.next() && lexrc.getInteger())
332 nextnoindent = false;
335 case LT_COMMANDDEPTH:
337 commanddepth = lexrc.getInteger();
342 latexname_ = lexrc.getString();
347 latexparam_ = subst(lexrc.getString(), """, "\"");
352 innertag_ = lexrc.getString();
357 labeltag_ = lexrc.getString();
362 itemtag_ = lexrc.getString();
366 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
370 readLabelType(lexrc);
373 case LT_ENDLABELTYPE:
374 readEndLabelType(lexrc);
377 case LT_LEFTMARGIN: // left margin type
379 leftmargin = lexrc.getDocString();
382 case LT_RIGHTMARGIN: // right margin type
384 rightmargin = lexrc.getDocString();
387 case LT_LABELINDENT: // label indenting flag
389 labelindent = lexrc.getDocString();
392 case LT_PARINDENT: // paragraph indent. flag
394 parindent = lexrc.getDocString();
397 case LT_PARSKIP: // paragraph skip size
399 parskip = lexrc.getFloat();
402 case LT_ITEMSEP: // item separation size
404 itemsep = lexrc.getFloat();
407 case LT_TOPSEP: // top separation size
409 topsep = lexrc.getFloat();
412 case LT_BOTTOMSEP: // bottom separation size
414 bottomsep = lexrc.getFloat();
417 case LT_LABEL_BOTTOMSEP: // label bottom separation size
419 labelbottomsep = lexrc.getFloat();
422 case LT_LABELSEP: // label separator
424 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
428 case LT_PARSEP: // par. separation size
430 parsep = lexrc.getFloat();
433 case LT_FILL_TOP: // fill top flag
435 fill_top = lexrc.getInteger();
438 case LT_FILL_BOTTOM: // fill bottom flag
440 fill_bottom = lexrc.getInteger();
443 case LT_NEWLINE: // newlines allowed?
445 newline_allowed = lexrc.getInteger();
448 case LT_ALIGN: // paragraph align
451 case LT_ALIGNPOSSIBLE: // paragraph allowed align
452 readAlignPossible(lexrc);
455 case LT_LABELSTRING: // label string definition
457 labelstring_ = trim(lexrc.getDocString());
458 labelstring_appendix_ = labelstring_;
462 case LT_ENDLABELSTRING: // endlabel string definition
464 endlabelstring_ = trim(lexrc.getDocString());
467 case LT_LABELSTRING_APPENDIX: // label string appendix definition
469 labelstring_appendix_ = trim(lexrc.getDocString());
472 case LT_LABELCOUNTER: // name of counter to use
474 counter = lyx::from_ascii(trim(lexrc.getString()));
477 case LT_FREE_SPACING: // Allow for free spacing.
479 free_spacing = lexrc.getInteger();
482 case LT_PASS_THRU: // Allow for pass thru.
484 pass_thru = lexrc.getInteger();
487 case LT_SPACING: // setspace.sty
507 void Layout::readAlign(Lexer & lexrc)
509 keyword_item alignTags[] = {
510 { "block", AT_BLOCK },
511 { "center", AT_CENTER },
512 { "layout", AT_LAYOUT },
514 { "right", AT_RIGHT }
517 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
518 int le = lexrc.lex();
520 case Lexer::LEX_UNDEF:
521 lexrc.printError("Unknown alignment `$$Token'");
525 switch (static_cast<AlignTags>(le)) {
527 align = LYX_ALIGN_BLOCK;
530 align = LYX_ALIGN_LEFT;
533 align = LYX_ALIGN_RIGHT;
536 align = LYX_ALIGN_CENTER;
539 align = LYX_ALIGN_LAYOUT;
545 void Layout::readAlignPossible(Lexer & lexrc)
547 keyword_item alignTags[] = {
548 { "block", AT_BLOCK },
549 { "center", AT_CENTER },
550 { "layout", AT_LAYOUT },
552 { "right", AT_RIGHT }
555 lexrc.pushTable(alignTags, AT_LAYOUT);
556 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
557 int lineno = lexrc.getLineNo();
559 int le = lexrc.lex();
561 case Lexer::LEX_UNDEF:
562 lexrc.printError("Unknown alignment `$$Token'");
566 switch (static_cast<AlignTags>(le)) {
568 alignpossible |= LYX_ALIGN_BLOCK;
571 alignpossible |= LYX_ALIGN_LEFT;
574 alignpossible |= LYX_ALIGN_RIGHT;
577 alignpossible |= LYX_ALIGN_CENTER;
580 alignpossible |= LYX_ALIGN_LAYOUT;
583 } while (lineno == lexrc.getLineNo());
592 LA_CENTERED_TOP_ENVIRONMENT,
602 void Layout::readLabelType(Lexer & lexrc)
604 keyword_item labelTypeTags[] = {
605 { "bibliography", LA_BIBLIO },
606 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
607 { "counter", LA_COUNTER },
608 { "enumerate", LA_ENUMERATE },
609 { "itemize", LA_ITEMIZE },
610 { "manual", LA_MANUAL },
611 { "no_label", LA_NO_LABEL },
612 { "sensitive", LA_SENSITIVE },
613 { "static", LA_STATIC },
614 { "top_environment", LA_TOP_ENVIRONMENT }
617 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
618 int le = lexrc.lex();
620 case Lexer::LEX_UNDEF:
621 lexrc.printError("Unknown labeltype tag `$$Token'");
625 switch (static_cast<LabelTypeTags>(le)) {
627 labeltype = LABEL_NO_LABEL;
630 labeltype = LABEL_MANUAL;
632 case LA_TOP_ENVIRONMENT:
633 labeltype = LABEL_TOP_ENVIRONMENT;
635 case LA_CENTERED_TOP_ENVIRONMENT:
636 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
639 labeltype = LABEL_STATIC;
642 labeltype = LABEL_SENSITIVE;
645 labeltype = LABEL_COUNTER;
648 labeltype = LABEL_ENUMERATE;
651 labeltype = LABEL_ITEMIZE;
654 labeltype = LABEL_BIBLIO;
660 static keyword_item endlabelTypeTags[] =
662 { "box", END_LABEL_BOX },
663 { "filled_box", END_LABEL_FILLED_BOX },
664 { "no_label", END_LABEL_NO_LABEL },
665 { "static", END_LABEL_STATIC }
669 void Layout::readEndLabelType(Lexer & lexrc)
671 PushPopHelper pph(lexrc, endlabelTypeTags,
672 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
673 int le = lexrc.lex();
675 case Lexer::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<EndLabelType>(le);
685 lyxerr << "Unhandled value " << le
686 << " in Layout::readEndLabelType." << endl;
692 void Layout::readMargin(Lexer & 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 Lexer::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<MarginType>(le);
717 lyxerr << "Unhandled value " << le
718 << " in Layout::readMargin." << endl;
724 void Layout::readLatexType(Lexer & 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 Lexer::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<LatexType>(le);
750 lyxerr << "Unhandled value " << le
751 << " in Layout::readLatexType." << endl;
758 ST_SPACING_SINGLE = 1,
765 void Layout::readSpacing(Lexer & 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 Lexer::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 docstring const & Layout::name() const
806 void Layout::setName(docstring const & name)
812 docstring const & Layout::obsoleted_by() const
814 return obsoleted_by_;
818 docstring const & Layout::depends_on() const
824 Layout * Layout::forCaption()
826 Layout * lay = new Layout();
827 lay->name_ = from_ascii("Caption");
828 lay->latexname_ = "caption";
829 lay->latextype = LATEX_COMMAND;
830 lay->optionalargs = 1;