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"
30 extern FontInfo lyxRead(Lexer &, FontInfo const & fi = sane_font);
32 /// Special value of toclevel for layouts that to not belong in a TOC
33 const int Layout::NOT_IN_TOC = -1000;
35 // The order of the LayoutTags enum is no more important. [asierra300396]
48 //LT_ENVIRONMENT_DEFAULT,
65 LT_LABELSTRING_APPENDIX,
93 LT_INTITLE // keep this last!
100 margintype = MARGIN_STATIC;
101 latextype = LATEX_PARAGRAPH;
107 labelfont = inherit_font;
109 reslabelfont = sane_font;
110 nextnoindent = false;
115 labelbottomsep = 0.0;
117 align = LYX_ALIGN_BLOCK;
118 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
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 bool Layout::read(Lexer & lexrc, TextClass const & tclass)
136 // This table is sorted alphabetically [asierra 30March96]
137 keyword_item layoutTags[] = {
138 { "align", LT_ALIGN },
139 { "alignpossible", LT_ALIGNPOSSIBLE },
140 { "bottomsep", LT_BOTTOMSEP },
141 { "commanddepth", LT_COMMANDDEPTH },
142 { "copystyle", LT_COPYSTYLE },
143 { "dependson", LT_DEPENDSON },
145 { "endlabelstring", LT_ENDLABELSTRING },
146 { "endlabeltype", LT_ENDLABELTYPE },
147 { "fill_bottom", LT_FILL_BOTTOM },
148 { "fill_top", LT_FILL_TOP },
150 { "freespacing", LT_FREE_SPACING },
151 { "innertag", LT_INNERTAG },
152 { "intitle", LT_INTITLE },
153 { "itemsep", LT_ITEMSEP },
154 { "itemtag", LT_ITEMTAG },
155 { "keepempty", LT_KEEPEMPTY },
156 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
157 { "labelcounter", LT_LABELCOUNTER },
158 { "labelfont", LT_LABELFONT },
159 { "labelindent", LT_LABELINDENT },
160 { "labelsep", LT_LABELSEP },
161 { "labelstring", LT_LABELSTRING },
162 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
163 { "labeltag", LT_LABELTAG },
164 { "labeltype", LT_LABELTYPE },
165 { "latexfooter", LT_LATEXFOOTER },
166 { "latexheader", LT_LATEXHEADER },
167 { "latexname", LT_LATEXNAME },
168 { "latexparagraph", LT_LATEXPARAGRAPH },
169 { "latexparam", LT_LATEXPARAM },
170 { "latextype", LT_LATEXTYPE },
171 { "leftmargin", LT_LEFTMARGIN },
172 { "margin", LT_MARGIN },
173 { "needprotect", LT_NEED_PROTECT },
174 { "newline", LT_NEWLINE },
175 { "nextnoindent", LT_NEXTNOINDENT },
176 { "obsoletedby", LT_OBSOLETEDBY },
177 { "optionalargs", LT_OPTARGS },
178 { "parindent", LT_PARINDENT },
179 { "parsep", LT_PARSEP },
180 { "parskip", LT_PARSKIP },
181 { "passthru", LT_PASS_THRU },
182 { "preamble", LT_PREAMBLE },
183 { "rightmargin", LT_RIGHTMARGIN },
184 { "spacing", LT_SPACING },
185 { "textfont", LT_TEXTFONT },
186 { "toclevel", LT_TOCLEVEL },
187 { "topsep", LT_TOPSEP }
191 bool finished = false;
192 lexrc.pushTable(layoutTags, LT_INTITLE);
193 // parse style section
194 while (!finished && lexrc.isOK() && !error) {
195 int le = lexrc.lex();
196 // See comment in LyXRC.cpp.
198 case Lexer::LEX_FEOF:
201 case Lexer::LEX_UNDEF: // parse error
202 lexrc.printError("Unknown layout tag `$$Token'");
207 switch (static_cast<LayoutTags>(le)) {
208 case LT_END: // end of structure
212 case LT_COPYSTYLE: // initialize with a known style
214 docstring const style = subst(lexrc.getDocString(),
217 if (tclass.hasLayout(style)) {
218 docstring const tmpname = name_;
219 this->operator=(*tclass[style]);
222 lyxerr << "Cannot copy unknown style `"
223 << to_utf8(style) << "'\n"
224 << "All layouts so far:"
226 TextClass::const_iterator it =
228 TextClass::const_iterator end =
230 for (; it != end; ++it) {
231 lyxerr << to_utf8((*it)->name())
235 //lexrc.printError("Cannot copy known "
236 // "style `$$Token'");
241 case LT_OBSOLETEDBY: // replace with a known style
243 docstring const style =
244 subst(lexrc.getDocString(), '_', ' ');
246 if (tclass.hasLayout(style)) {
247 docstring const tmpname = name_;
248 this->operator=(*tclass[style]);
250 if (obsoleted_by().empty())
251 obsoleted_by_ = style;
253 lyxerr << "Cannot replace with unknown style `"
254 << to_utf8(style) << '\'' << endl;
256 //lexrc.printError("Cannot replace with"
265 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
268 case LT_MARGIN: // margin style definition.
272 case LT_LATEXTYPE: // LaTeX style definition.
273 readLatexType(lexrc);
276 case LT_LATEXHEADER: // header for environments
278 latexheader = lexrc.getString();
281 case LT_LATEXFOOTER: // footer for environments
283 latexfooter = lexrc.getString();
286 case LT_LATEXPARAGRAPH:
288 latexparagraph = lexrc.getString();
292 intitle = lexrc.next() && lexrc.getInteger();
297 toclevel = lexrc.getInteger();
302 optionalargs = lexrc.getInteger();
305 case LT_NEED_PROTECT:
306 needprotect = lexrc.next() && lexrc.getInteger();
310 keepempty = lexrc.next() && lexrc.getInteger();
314 font = lyxRead(lexrc, sane_font);
319 font = lyxRead(lexrc, sane_font);
323 labelfont = lyxRead(lexrc, sane_font);
326 case LT_NEXTNOINDENT: // Indent next paragraph?
327 if (lexrc.next() && lexrc.getInteger())
330 nextnoindent = false;
333 case LT_COMMANDDEPTH:
335 commanddepth = lexrc.getInteger();
340 latexname_ = lexrc.getString();
345 latexparam_ = subst(lexrc.getString(), """, "\"");
350 innertag_ = lexrc.getString();
355 labeltag_ = lexrc.getString();
360 itemtag_ = lexrc.getString();
364 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
368 readLabelType(lexrc);
371 case LT_ENDLABELTYPE:
372 readEndLabelType(lexrc);
375 case LT_LEFTMARGIN: // left margin type
377 leftmargin = lexrc.getDocString();
380 case LT_RIGHTMARGIN: // right margin type
382 rightmargin = lexrc.getDocString();
385 case LT_LABELINDENT: // label indenting flag
387 labelindent = lexrc.getDocString();
390 case LT_PARINDENT: // paragraph indent. flag
392 parindent = lexrc.getDocString();
395 case LT_PARSKIP: // paragraph skip size
397 parskip = lexrc.getFloat();
400 case LT_ITEMSEP: // item separation size
402 itemsep = lexrc.getFloat();
405 case LT_TOPSEP: // top separation size
407 topsep = lexrc.getFloat();
410 case LT_BOTTOMSEP: // bottom separation size
412 bottomsep = lexrc.getFloat();
415 case LT_LABEL_BOTTOMSEP: // label bottom separation size
417 labelbottomsep = lexrc.getFloat();
420 case LT_LABELSEP: // label separator
422 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
426 case LT_PARSEP: // par. separation size
428 parsep = lexrc.getFloat();
431 case LT_FILL_TOP: // fill top flag
433 fill_top = lexrc.getInteger();
436 case LT_FILL_BOTTOM: // fill bottom flag
438 fill_bottom = lexrc.getInteger();
441 case LT_NEWLINE: // newlines allowed?
443 newline_allowed = lexrc.getInteger();
446 case LT_ALIGN: // paragraph align
449 case LT_ALIGNPOSSIBLE: // paragraph allowed align
450 readAlignPossible(lexrc);
453 case LT_LABELSTRING: // label string definition
455 labelstring_ = trim(lexrc.getDocString());
456 labelstring_appendix_ = labelstring_;
460 case LT_ENDLABELSTRING: // endlabel string definition
462 endlabelstring_ = trim(lexrc.getDocString());
465 case LT_LABELSTRING_APPENDIX: // label string appendix definition
467 labelstring_appendix_ = trim(lexrc.getDocString());
470 case LT_LABELCOUNTER: // name of counter to use
472 counter = lyx::from_ascii(trim(lexrc.getString()));
475 case LT_FREE_SPACING: // Allow for free spacing.
477 free_spacing = lexrc.getInteger();
480 case LT_PASS_THRU: // Allow for pass thru.
482 pass_thru = lexrc.getInteger();
485 case LT_SPACING: // setspace.sty
505 void Layout::readAlign(Lexer & lexrc)
507 keyword_item alignTags[] = {
508 { "block", AT_BLOCK },
509 { "center", AT_CENTER },
510 { "layout", AT_LAYOUT },
512 { "right", AT_RIGHT }
515 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
516 int le = lexrc.lex();
518 case Lexer::LEX_UNDEF:
519 lexrc.printError("Unknown alignment `$$Token'");
523 switch (static_cast<AlignTags>(le)) {
525 align = LYX_ALIGN_BLOCK;
528 align = LYX_ALIGN_LEFT;
531 align = LYX_ALIGN_RIGHT;
534 align = LYX_ALIGN_CENTER;
537 align = LYX_ALIGN_LAYOUT;
543 void Layout::readAlignPossible(Lexer & lexrc)
545 keyword_item alignTags[] = {
546 { "block", AT_BLOCK },
547 { "center", AT_CENTER },
548 { "layout", AT_LAYOUT },
550 { "right", AT_RIGHT }
553 lexrc.pushTable(alignTags, AT_LAYOUT);
554 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
555 int lineno = lexrc.getLineNo();
557 int le = lexrc.lex();
559 case Lexer::LEX_UNDEF:
560 lexrc.printError("Unknown alignment `$$Token'");
564 switch (static_cast<AlignTags>(le)) {
566 alignpossible |= LYX_ALIGN_BLOCK;
569 alignpossible |= LYX_ALIGN_LEFT;
572 alignpossible |= LYX_ALIGN_RIGHT;
575 alignpossible |= LYX_ALIGN_CENTER;
578 alignpossible |= LYX_ALIGN_LAYOUT;
581 } while (lineno == lexrc.getLineNo());
590 LA_CENTERED_TOP_ENVIRONMENT,
600 void Layout::readLabelType(Lexer & lexrc)
602 keyword_item labelTypeTags[] = {
603 { "bibliography", LA_BIBLIO },
604 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
605 { "counter", LA_COUNTER },
606 { "enumerate", LA_ENUMERATE },
607 { "itemize", LA_ITEMIZE },
608 { "manual", LA_MANUAL },
609 { "no_label", LA_NO_LABEL },
610 { "sensitive", LA_SENSITIVE },
611 { "static", LA_STATIC },
612 { "top_environment", LA_TOP_ENVIRONMENT }
615 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
616 int le = lexrc.lex();
618 case Lexer::LEX_UNDEF:
619 lexrc.printError("Unknown labeltype tag `$$Token'");
623 switch (static_cast<LabelTypeTags>(le)) {
625 labeltype = LABEL_NO_LABEL;
628 labeltype = LABEL_MANUAL;
630 case LA_TOP_ENVIRONMENT:
631 labeltype = LABEL_TOP_ENVIRONMENT;
633 case LA_CENTERED_TOP_ENVIRONMENT:
634 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
637 labeltype = LABEL_STATIC;
640 labeltype = LABEL_SENSITIVE;
643 labeltype = LABEL_COUNTER;
646 labeltype = LABEL_ENUMERATE;
649 labeltype = LABEL_ITEMIZE;
652 labeltype = LABEL_BIBLIO;
658 static 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 }
667 void Layout::readEndLabelType(Lexer & lexrc)
669 PushPopHelper pph(lexrc, endlabelTypeTags,
670 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
671 int le = lexrc.lex();
673 case Lexer::LEX_UNDEF:
674 lexrc.printError("Unknown labeltype tag `$$Token'");
676 case END_LABEL_STATIC:
678 case END_LABEL_FILLED_BOX:
679 case END_LABEL_NO_LABEL:
680 endlabeltype = static_cast<EndLabelType>(le);
683 lyxerr << "Unhandled value " << le
684 << " in Layout::readEndLabelType." << endl;
690 void Layout::readMargin(Lexer & lexrc)
692 keyword_item marginTags[] = {
693 { "dynamic", MARGIN_DYNAMIC },
694 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
695 { "manual", MARGIN_MANUAL },
696 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
697 { "static", MARGIN_STATIC }
700 PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
702 int le = lexrc.lex();
704 case Lexer::LEX_UNDEF:
705 lexrc.printError("Unknown margin type tag `$$Token'");
710 case MARGIN_FIRST_DYNAMIC:
711 case MARGIN_RIGHT_ADDRESS_BOX:
712 margintype = static_cast<MarginType>(le);
715 lyxerr << "Unhandled value " << le
716 << " in Layout::readMargin." << endl;
722 void Layout::readLatexType(Lexer & lexrc)
724 keyword_item latexTypeTags[] = {
725 { "bib_environment", LATEX_BIB_ENVIRONMENT },
726 { "command", LATEX_COMMAND },
727 { "environment", LATEX_ENVIRONMENT },
728 { "item_environment", LATEX_ITEM_ENVIRONMENT },
729 { "list_environment", LATEX_LIST_ENVIRONMENT },
730 { "paragraph", LATEX_PARAGRAPH }
733 PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
734 int le = lexrc.lex();
736 case Lexer::LEX_UNDEF:
737 lexrc.printError("Unknown latextype tag `$$Token'");
739 case LATEX_PARAGRAPH:
741 case LATEX_ENVIRONMENT:
742 case LATEX_ITEM_ENVIRONMENT:
743 case LATEX_BIB_ENVIRONMENT:
744 case LATEX_LIST_ENVIRONMENT:
745 latextype = static_cast<LatexType>(le);
748 lyxerr << "Unhandled value " << le
749 << " in Layout::readLatexType." << endl;
756 ST_SPACING_SINGLE = 1,
763 void Layout::readSpacing(Lexer & lexrc)
765 keyword_item spacingTags[] = {
766 {"double", ST_SPACING_DOUBLE },
767 {"onehalf", ST_SPACING_ONEHALF },
768 {"other", ST_OTHER },
769 {"single", ST_SPACING_SINGLE }
772 PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
773 int le = lexrc.lex();
775 case Lexer::LEX_UNDEF:
776 lexrc.printError("Unknown spacing token `$$Token'");
780 switch (static_cast<SpacingTags>(le)) {
781 case ST_SPACING_SINGLE:
782 spacing.set(Spacing::Single);
784 case ST_SPACING_ONEHALF:
785 spacing.set(Spacing::Onehalf);
787 case ST_SPACING_DOUBLE:
788 spacing.set(Spacing::Double);
792 spacing.set(Spacing::Other, lexrc.getString());
798 docstring const & Layout::name() const
804 void Layout::setName(docstring const & name)
810 docstring const & Layout::obsoleted_by() const
812 return obsoleted_by_;
816 docstring const & Layout::depends_on() const
822 Layout * Layout::forCaption()
824 Layout * lay = new Layout();
825 lay->name_ = from_ascii("Caption");
826 lay->latexname_ = "caption";
827 lay->latextype = LATEX_COMMAND;
828 lay->optionalargs = 1;