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"
19 #include "support/debug.h"
22 #include "support/lstrings.h"
35 /// Special value of toclevel for layouts that to not belong in a TOC
36 const int Layout::NOT_IN_TOC = -1000;
38 // The order of the LayoutTags enum is no more important. [asierra300396]
51 //LT_ENVIRONMENT_DEFAULT,
68 LT_LABELSTRING_APPENDIX,
96 LT_INTITLE // keep this last!
103 margintype = MARGIN_STATIC;
104 latextype = LATEX_PARAGRAPH;
110 labelfont = inherit_font;
112 reslabelfont = sane_font;
113 nextnoindent = false;
118 labelbottomsep = 0.0;
120 align = LYX_ALIGN_BLOCK;
121 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
122 labeltype = LABEL_NO_LABEL;
123 endlabeltype = END_LABEL_NO_LABEL;
124 // Should or should not. That is the question.
125 // spacing.set(Spacing::OneHalf);
128 newline_allowed = true;
129 free_spacing = false;
131 is_environment = false;
132 toclevel = NOT_IN_TOC;
137 bool Layout::read(Lexer & lexrc, TextClass const & tclass)
139 // This table is sorted alphabetically [asierra 30March96]
140 keyword_item layoutTags[] = {
141 { "align", LT_ALIGN },
142 { "alignpossible", LT_ALIGNPOSSIBLE },
143 { "bottomsep", LT_BOTTOMSEP },
144 { "commanddepth", LT_COMMANDDEPTH },
145 { "copystyle", LT_COPYSTYLE },
146 { "dependson", LT_DEPENDSON },
148 { "endlabelstring", LT_ENDLABELSTRING },
149 { "endlabeltype", LT_ENDLABELTYPE },
150 { "fill_bottom", LT_FILL_BOTTOM },
151 { "fill_top", LT_FILL_TOP },
153 { "freespacing", LT_FREE_SPACING },
154 { "innertag", LT_INNERTAG },
155 { "intitle", LT_INTITLE },
156 { "itemsep", LT_ITEMSEP },
157 { "itemtag", LT_ITEMTAG },
158 { "keepempty", LT_KEEPEMPTY },
159 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
160 { "labelcounter", LT_LABELCOUNTER },
161 { "labelfont", LT_LABELFONT },
162 { "labelindent", LT_LABELINDENT },
163 { "labelsep", LT_LABELSEP },
164 { "labelstring", LT_LABELSTRING },
165 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
166 { "labeltag", LT_LABELTAG },
167 { "labeltype", LT_LABELTYPE },
168 { "latexfooter", LT_LATEXFOOTER },
169 { "latexheader", LT_LATEXHEADER },
170 { "latexname", LT_LATEXNAME },
171 { "latexparagraph", LT_LATEXPARAGRAPH },
172 { "latexparam", LT_LATEXPARAM },
173 { "latextype", LT_LATEXTYPE },
174 { "leftmargin", LT_LEFTMARGIN },
175 { "margin", LT_MARGIN },
176 { "needprotect", LT_NEED_PROTECT },
177 { "newline", LT_NEWLINE },
178 { "nextnoindent", LT_NEXTNOINDENT },
179 { "obsoletedby", LT_OBSOLETEDBY },
180 { "optionalargs", LT_OPTARGS },
181 { "parindent", LT_PARINDENT },
182 { "parsep", LT_PARSEP },
183 { "parskip", LT_PARSKIP },
184 { "passthru", LT_PASS_THRU },
185 { "preamble", LT_PREAMBLE },
186 { "rightmargin", LT_RIGHTMARGIN },
187 { "spacing", LT_SPACING },
188 { "textfont", LT_TEXTFONT },
189 { "toclevel", LT_TOCLEVEL },
190 { "topsep", LT_TOPSEP }
194 bool finished = false;
195 lexrc.pushTable(layoutTags, LT_INTITLE);
196 // parse style section
197 while (!finished && lexrc.isOK() && !error) {
198 int le = lexrc.lex();
199 // See comment in LyXRC.cpp.
201 case Lexer::LEX_FEOF:
204 case Lexer::LEX_UNDEF: // parse error
205 lexrc.printError("Unknown layout tag `$$Token'");
210 switch (static_cast<LayoutTags>(le)) {
211 case LT_END: // end of structure
215 case LT_COPYSTYLE: // initialize with a known style
217 docstring const style = subst(lexrc.getDocString(),
220 if (tclass.hasLayout(style)) {
221 docstring const tmpname = name_;
222 this->operator=(*tclass[style]);
225 lyxerr << "Cannot copy unknown style `"
226 << to_utf8(style) << "'\n"
227 << "All layouts so far:"
229 TextClass::const_iterator it =
231 TextClass::const_iterator end =
233 for (; it != end; ++it) {
234 lyxerr << to_utf8((*it)->name())
238 //lexrc.printError("Cannot copy known "
239 // "style `$$Token'");
244 case LT_OBSOLETEDBY: // replace with a known style
246 docstring const style =
247 subst(lexrc.getDocString(), '_', ' ');
249 if (tclass.hasLayout(style)) {
250 docstring const tmpname = name_;
251 this->operator=(*tclass[style]);
253 if (obsoleted_by().empty())
254 obsoleted_by_ = style;
256 lyxerr << "Cannot replace with unknown style `"
257 << to_utf8(style) << '\'' << endl;
259 //lexrc.printError("Cannot replace with"
268 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
271 case LT_MARGIN: // margin style definition.
275 case LT_LATEXTYPE: // LaTeX style definition.
276 readLatexType(lexrc);
279 case LT_LATEXHEADER: // header for environments
281 latexheader = lexrc.getString();
284 case LT_LATEXFOOTER: // footer for environments
286 latexfooter = lexrc.getString();
289 case LT_LATEXPARAGRAPH:
291 latexparagraph = lexrc.getString();
295 intitle = lexrc.next() && lexrc.getInteger();
300 toclevel = lexrc.getInteger();
305 optionalargs = lexrc.getInteger();
308 case LT_NEED_PROTECT:
309 needprotect = lexrc.next() && lexrc.getInteger();
313 keepempty = lexrc.next() && lexrc.getInteger();
317 font = lyxRead(lexrc, font);
322 font = lyxRead(lexrc, font);
326 labelfont = lyxRead(lexrc, labelfont);
329 case LT_NEXTNOINDENT: // Indent next paragraph?
330 if (lexrc.next() && lexrc.getInteger())
333 nextnoindent = false;
336 case LT_COMMANDDEPTH:
338 commanddepth = lexrc.getInteger();
343 latexname_ = lexrc.getString();
348 latexparam_ = subst(lexrc.getString(), """, "\"");
353 innertag_ = lexrc.getString();
358 labeltag_ = lexrc.getString();
363 itemtag_ = lexrc.getString();
367 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
371 readLabelType(lexrc);
374 case LT_ENDLABELTYPE:
375 readEndLabelType(lexrc);
378 case LT_LEFTMARGIN: // left margin type
380 leftmargin = lexrc.getDocString();
383 case LT_RIGHTMARGIN: // right margin type
385 rightmargin = lexrc.getDocString();
388 case LT_LABELINDENT: // label indenting flag
390 labelindent = lexrc.getDocString();
393 case LT_PARINDENT: // paragraph indent. flag
395 parindent = lexrc.getDocString();
398 case LT_PARSKIP: // paragraph skip size
400 parskip = lexrc.getFloat();
403 case LT_ITEMSEP: // item separation size
405 itemsep = lexrc.getFloat();
408 case LT_TOPSEP: // top separation size
410 topsep = lexrc.getFloat();
413 case LT_BOTTOMSEP: // bottom separation size
415 bottomsep = lexrc.getFloat();
418 case LT_LABEL_BOTTOMSEP: // label bottom separation size
420 labelbottomsep = lexrc.getFloat();
423 case LT_LABELSEP: // label separator
425 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
429 case LT_PARSEP: // par. separation size
431 parsep = lexrc.getFloat();
434 case LT_FILL_TOP: // fill top flag
436 fill_top = lexrc.getInteger();
439 case LT_FILL_BOTTOM: // fill bottom flag
441 fill_bottom = lexrc.getInteger();
444 case LT_NEWLINE: // newlines allowed?
446 newline_allowed = lexrc.getInteger();
449 case LT_ALIGN: // paragraph align
452 case LT_ALIGNPOSSIBLE: // paragraph allowed align
453 readAlignPossible(lexrc);
456 case LT_LABELSTRING: // label string definition
458 labelstring_ = trim(lexrc.getDocString());
459 labelstring_appendix_ = labelstring_;
463 case LT_ENDLABELSTRING: // endlabel string definition
465 endlabelstring_ = trim(lexrc.getDocString());
468 case LT_LABELSTRING_APPENDIX: // label string appendix definition
470 labelstring_appendix_ = trim(lexrc.getDocString());
473 case LT_LABELCOUNTER: // name of counter to use
475 counter = lyx::from_ascii(trim(lexrc.getString()));
478 case LT_FREE_SPACING: // Allow for free spacing.
480 free_spacing = lexrc.getInteger();
483 case LT_PASS_THRU: // Allow for pass thru.
485 pass_thru = lexrc.getInteger();
488 case LT_SPACING: // setspace.sty
508 void Layout::readAlign(Lexer & lexrc)
510 keyword_item alignTags[] = {
511 { "block", AT_BLOCK },
512 { "center", AT_CENTER },
513 { "layout", AT_LAYOUT },
515 { "right", AT_RIGHT }
518 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
519 int le = lexrc.lex();
521 case Lexer::LEX_UNDEF:
522 lexrc.printError("Unknown alignment `$$Token'");
526 switch (static_cast<AlignTags>(le)) {
528 align = LYX_ALIGN_BLOCK;
531 align = LYX_ALIGN_LEFT;
534 align = LYX_ALIGN_RIGHT;
537 align = LYX_ALIGN_CENTER;
540 align = LYX_ALIGN_LAYOUT;
546 void Layout::readAlignPossible(Lexer & lexrc)
548 keyword_item alignTags[] = {
549 { "block", AT_BLOCK },
550 { "center", AT_CENTER },
551 { "layout", AT_LAYOUT },
553 { "right", AT_RIGHT }
556 lexrc.pushTable(alignTags, AT_LAYOUT);
557 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
558 int lineno = lexrc.getLineNo();
560 int le = lexrc.lex();
562 case Lexer::LEX_UNDEF:
563 lexrc.printError("Unknown alignment `$$Token'");
567 switch (static_cast<AlignTags>(le)) {
569 alignpossible |= LYX_ALIGN_BLOCK;
572 alignpossible |= LYX_ALIGN_LEFT;
575 alignpossible |= LYX_ALIGN_RIGHT;
578 alignpossible |= LYX_ALIGN_CENTER;
581 alignpossible |= LYX_ALIGN_LAYOUT;
584 } while (lineno == lexrc.getLineNo());
593 LA_CENTERED_TOP_ENVIRONMENT,
603 void Layout::readLabelType(Lexer & lexrc)
605 keyword_item labelTypeTags[] = {
606 { "bibliography", LA_BIBLIO },
607 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
608 { "counter", LA_COUNTER },
609 { "enumerate", LA_ENUMERATE },
610 { "itemize", LA_ITEMIZE },
611 { "manual", LA_MANUAL },
612 { "no_label", LA_NO_LABEL },
613 { "sensitive", LA_SENSITIVE },
614 { "static", LA_STATIC },
615 { "top_environment", LA_TOP_ENVIRONMENT }
618 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
619 int le = lexrc.lex();
621 case Lexer::LEX_UNDEF:
622 lexrc.printError("Unknown labeltype tag `$$Token'");
626 switch (static_cast<LabelTypeTags>(le)) {
628 labeltype = LABEL_NO_LABEL;
631 labeltype = LABEL_MANUAL;
633 case LA_TOP_ENVIRONMENT:
634 labeltype = LABEL_TOP_ENVIRONMENT;
636 case LA_CENTERED_TOP_ENVIRONMENT:
637 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
640 labeltype = LABEL_STATIC;
643 labeltype = LABEL_SENSITIVE;
646 labeltype = LABEL_COUNTER;
649 labeltype = LABEL_ENUMERATE;
652 labeltype = LABEL_ITEMIZE;
655 labeltype = LABEL_BIBLIO;
661 static keyword_item endlabelTypeTags[] =
663 { "box", END_LABEL_BOX },
664 { "filled_box", END_LABEL_FILLED_BOX },
665 { "no_label", END_LABEL_NO_LABEL },
666 { "static", END_LABEL_STATIC }
670 void Layout::readEndLabelType(Lexer & lexrc)
672 PushPopHelper pph(lexrc, endlabelTypeTags,
673 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
674 int le = lexrc.lex();
676 case Lexer::LEX_UNDEF:
677 lexrc.printError("Unknown labeltype tag `$$Token'");
679 case END_LABEL_STATIC:
681 case END_LABEL_FILLED_BOX:
682 case END_LABEL_NO_LABEL:
683 endlabeltype = static_cast<EndLabelType>(le);
686 lyxerr << "Unhandled value " << le
687 << " in Layout::readEndLabelType." << endl;
693 void Layout::readMargin(Lexer & lexrc)
695 keyword_item marginTags[] = {
696 { "dynamic", MARGIN_DYNAMIC },
697 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
698 { "manual", MARGIN_MANUAL },
699 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
700 { "static", MARGIN_STATIC }
703 PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
705 int le = lexrc.lex();
707 case Lexer::LEX_UNDEF:
708 lexrc.printError("Unknown margin type tag `$$Token'");
713 case MARGIN_FIRST_DYNAMIC:
714 case MARGIN_RIGHT_ADDRESS_BOX:
715 margintype = static_cast<MarginType>(le);
718 lyxerr << "Unhandled value " << le
719 << " in Layout::readMargin." << endl;
725 void Layout::readLatexType(Lexer & lexrc)
727 keyword_item latexTypeTags[] = {
728 { "bib_environment", LATEX_BIB_ENVIRONMENT },
729 { "command", LATEX_COMMAND },
730 { "environment", LATEX_ENVIRONMENT },
731 { "item_environment", LATEX_ITEM_ENVIRONMENT },
732 { "list_environment", LATEX_LIST_ENVIRONMENT },
733 { "paragraph", LATEX_PARAGRAPH }
736 PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
737 int le = lexrc.lex();
739 case Lexer::LEX_UNDEF:
740 lexrc.printError("Unknown latextype tag `$$Token'");
742 case LATEX_PARAGRAPH:
744 case LATEX_ENVIRONMENT:
745 case LATEX_ITEM_ENVIRONMENT:
746 case LATEX_BIB_ENVIRONMENT:
747 case LATEX_LIST_ENVIRONMENT:
748 latextype = static_cast<LatexType>(le);
751 lyxerr << "Unhandled value " << le
752 << " in Layout::readLatexType." << endl;
759 ST_SPACING_SINGLE = 1,
766 void Layout::readSpacing(Lexer & lexrc)
768 keyword_item spacingTags[] = {
769 {"double", ST_SPACING_DOUBLE },
770 {"onehalf", ST_SPACING_ONEHALF },
771 {"other", ST_OTHER },
772 {"single", ST_SPACING_SINGLE }
775 PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
776 int le = lexrc.lex();
778 case Lexer::LEX_UNDEF:
779 lexrc.printError("Unknown spacing token `$$Token'");
783 switch (static_cast<SpacingTags>(le)) {
784 case ST_SPACING_SINGLE:
785 spacing.set(Spacing::Single);
787 case ST_SPACING_ONEHALF:
788 spacing.set(Spacing::Onehalf);
790 case ST_SPACING_DOUBLE:
791 spacing.set(Spacing::Double);
795 spacing.set(Spacing::Other, lexrc.getString());
801 docstring const & Layout::name() const
807 void Layout::setName(docstring const & name)
813 docstring const & Layout::obsoleted_by() const
815 return obsoleted_by_;
819 docstring const & Layout::depends_on() const
825 Layout * Layout::forCaption()
827 Layout * lay = new Layout();
828 lay->name_ = from_ascii("Caption");
829 lay->latexname_ = "caption";
830 lay->latextype = LATEX_COMMAND;
831 lay->optionalargs = 1;