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/debug.h"
21 #include "support/lstrings.h"
24 using namespace lyx::support;
28 /// Special value of toclevel for layouts that to not belong in a TOC
29 const int Layout::NOT_IN_TOC = -1000;
31 // The order of the LayoutTags enum is no more important. [asierra300396]
45 //LT_ENVIRONMENT_DEFAULT,
62 LT_LABELSTRING_APPENDIX,
91 LT_INTITLE // keep this last!
99 margintype = MARGIN_STATIC;
100 latextype = LATEX_PARAGRAPH;
106 labelfont = inherit_font;
108 reslabelfont = sane_font;
109 nextnoindent = false;
114 labelbottomsep = 0.0;
116 align = LYX_ALIGN_BLOCK;
117 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
118 labeltype = LABEL_NO_LABEL;
119 endlabeltype = END_LABEL_NO_LABEL;
120 // Should or should not. That is the question.
121 // spacing.set(Spacing::OneHalf);
124 newline_allowed = true;
125 free_spacing = false;
127 toclevel = NOT_IN_TOC;
132 bool Layout::read(Lexer & lex, TextClass const & tclass)
134 // This table is sorted alphabetically [asierra 30March96]
135 LexerKeyword layoutTags[] = {
136 { "align", LT_ALIGN },
137 { "alignpossible", LT_ALIGNPOSSIBLE },
138 { "bottomsep", LT_BOTTOMSEP },
139 { "category", LT_CATEGORY },
140 { "commanddepth", LT_COMMANDDEPTH },
141 { "copystyle", LT_COPYSTYLE },
142 { "dependson", LT_DEPENDSON },
144 { "endlabelstring", LT_ENDLABELSTRING },
145 { "endlabeltype", LT_ENDLABELTYPE },
146 { "fill_bottom", LT_FILL_BOTTOM },
147 { "fill_top", LT_FILL_TOP },
149 { "freespacing", LT_FREE_SPACING },
150 { "innertag", LT_INNERTAG },
151 { "intitle", LT_INTITLE },
152 { "itemsep", LT_ITEMSEP },
153 { "itemtag", LT_ITEMTAG },
154 { "keepempty", LT_KEEPEMPTY },
155 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
156 { "labelcounter", LT_LABELCOUNTER },
157 { "labelfont", LT_LABELFONT },
158 { "labelindent", LT_LABELINDENT },
159 { "labelsep", LT_LABELSEP },
160 { "labelstring", LT_LABELSTRING },
161 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
162 { "labeltag", LT_LABELTAG },
163 { "labeltype", LT_LABELTYPE },
164 { "latexfooter", LT_LATEXFOOTER },
165 { "latexheader", LT_LATEXHEADER },
166 { "latexname", LT_LATEXNAME },
167 { "latexparagraph", LT_LATEXPARAGRAPH },
168 { "latexparam", LT_LATEXPARAM },
169 { "latextype", LT_LATEXTYPE },
170 { "leftmargin", LT_LEFTMARGIN },
171 { "margin", LT_MARGIN },
172 { "needprotect", LT_NEED_PROTECT },
173 { "newline", LT_NEWLINE },
174 { "nextnoindent", LT_NEXTNOINDENT },
175 { "obsoletedby", LT_OBSOLETEDBY },
176 { "optionalargs", LT_OPTARGS },
177 { "parindent", LT_PARINDENT },
178 { "parsep", LT_PARSEP },
179 { "parskip", LT_PARSKIP },
180 { "passthru", LT_PASS_THRU },
181 { "preamble", LT_PREAMBLE },
182 { "requires", LT_REQUIRES },
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 lex.pushTable(layoutTags);
193 // parse style section
194 while (!finished && lex.isOK() && !error) {
196 // See comment in LyXRC.cpp.
198 case Lexer::LEX_FEOF:
201 case Lexer::LEX_UNDEF: // parse error
202 lex.printError("Unknown layout tag `$$Token'");
207 switch (static_cast<LayoutTags>(le)) {
208 case LT_END: // end of structure
216 case LT_COPYSTYLE: { // initialize with a known style
219 style = subst(style, '_', ' ');
221 if (tclass.hasLayout(style)) {
222 docstring const tmpname = name_;
223 this->operator=(tclass[style]);
226 LYXERR0("Cannot copy unknown style `"
228 << "All layouts so far:");
229 DocumentClass::const_iterator lit = tclass.begin();
230 DocumentClass::const_iterator len = tclass.end();
231 for (; lit != len; ++lit)
232 LYXERR0(lit->name());
237 case LT_OBSOLETEDBY: { // replace with a known style
240 style = subst(style, '_', ' ');
242 if (tclass.hasLayout(style)) {
243 docstring const tmpname = name_;
244 this->operator=(tclass[style]);
246 if (obsoleted_by().empty())
247 obsoleted_by_ = style;
249 LYXERR0("Cannot replace with unknown style `"
252 //lex.printError("Cannot replace with"
261 depends_on_ = subst(depends_on_, '_', ' ');
264 case LT_MARGIN: // margin style definition.
268 case LT_LATEXTYPE: // LaTeX style definition.
272 case LT_LATEXHEADER: // header for environments
276 case LT_LATEXFOOTER: // footer for environments
280 case LT_LATEXPARAGRAPH:
281 lex >> latexparagraph;
293 lex >> optionalargs ;
296 case LT_NEED_PROTECT:
305 font = lyxRead(lex, font);
310 font = lyxRead(lex, font);
314 labelfont = lyxRead(lex, labelfont);
317 case LT_NEXTNOINDENT: // Indent next paragraph?
321 case LT_COMMANDDEPTH:
331 latexparam_ = subst(latexparam_, """, "\"");
347 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
354 case LT_ENDLABELTYPE:
355 readEndLabelType(lex);
358 case LT_LEFTMARGIN: // left margin type
362 case LT_RIGHTMARGIN: // right margin type
366 case LT_LABELINDENT: // label indenting flag
370 case LT_PARINDENT: // paragraph indent. flag
374 case LT_PARSKIP: // paragraph skip size
378 case LT_ITEMSEP: // item separation size
382 case LT_TOPSEP: // top separation size
386 case LT_BOTTOMSEP: // bottom separation size
390 case LT_LABEL_BOTTOMSEP: // label bottom separation size
391 lex >> labelbottomsep;
394 case LT_LABELSEP: // label separator
396 labelsep = subst(labelsep, 'x', ' ');
399 case LT_PARSEP: // par. separation size
403 case LT_FILL_TOP: // fill top flag
407 case LT_FILL_BOTTOM: // fill bottom flag
411 case LT_NEWLINE: // newlines allowed?
412 lex >> newline_allowed;
415 case LT_ALIGN: // paragraph align
418 case LT_ALIGNPOSSIBLE: // paragraph allowed align
419 readAlignPossible(lex);
422 case LT_LABELSTRING: // label string definition
423 // FIXME: this means LT_ENDLABELSTRING may only
424 // occur after LT_LABELSTRING
426 labelstring_ = trim(labelstring_);
427 labelstring_appendix_ = labelstring_;
430 case LT_ENDLABELSTRING: // endlabel string definition
431 lex >> endlabelstring_;
432 endlabelstring_ = trim(endlabelstring_);
435 case LT_LABELSTRING_APPENDIX: // label string appendix definition
436 lex >> labelstring_appendix_;
437 labelstring_appendix_ = trim(labelstring_appendix_);
440 case LT_LABELCOUNTER: // name of counter to use
442 counter = trim(counter);
445 case LT_FREE_SPACING: // Allow for free spacing.
449 case LT_PASS_THRU: // Allow for pass thru.
453 case LT_SPACING: // setspace.sty
459 vector<string> const req =
460 getVectorFromString(lex.getString());
461 requires_.insert(req.begin(), req.end());
481 LexerKeyword alignTags[] = {
482 { "block", AT_BLOCK },
483 { "center", AT_CENTER },
484 { "layout", AT_LAYOUT },
486 { "right", AT_RIGHT }
490 void Layout::readAlign(Lexer & lex)
492 PushPopHelper pph(lex, alignTags);
495 case Lexer::LEX_UNDEF:
496 lex.printError("Unknown alignment `$$Token'");
502 align = LYX_ALIGN_BLOCK;
505 align = LYX_ALIGN_LEFT;
508 align = LYX_ALIGN_RIGHT;
511 align = LYX_ALIGN_CENTER;
514 align = LYX_ALIGN_LAYOUT;
520 void Layout::readAlignPossible(Lexer & lex)
522 lex.pushTable(alignTags);
523 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
524 int lineno = lex.lineNumber();
528 case Lexer::LEX_UNDEF:
529 lex.printError("Unknown alignment `$$Token'");
535 alignpossible |= LYX_ALIGN_BLOCK;
538 alignpossible |= LYX_ALIGN_LEFT;
541 alignpossible |= LYX_ALIGN_RIGHT;
544 alignpossible |= LYX_ALIGN_CENTER;
547 alignpossible |= LYX_ALIGN_LAYOUT;
550 } while (lineno == lex.lineNumber());
555 void Layout::readLabelType(Lexer & lex)
561 LA_CENTERED_TOP_ENVIRONMENT,
571 LexerKeyword labelTypeTags[] = {
572 { "bibliography", LA_BIBLIO },
573 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
574 { "counter", LA_COUNTER },
575 { "enumerate", LA_ENUMERATE },
576 { "itemize", LA_ITEMIZE },
577 { "manual", LA_MANUAL },
578 { "no_label", LA_NO_LABEL },
579 { "sensitive", LA_SENSITIVE },
580 { "static", LA_STATIC },
581 { "top_environment", LA_TOP_ENVIRONMENT }
584 PushPopHelper pph(lex, labelTypeTags);
587 case Lexer::LEX_UNDEF:
588 lex.printError("Unknown labeltype tag `$$Token'");
594 labeltype = LABEL_NO_LABEL;
597 labeltype = LABEL_MANUAL;
599 case LA_TOP_ENVIRONMENT:
600 labeltype = LABEL_TOP_ENVIRONMENT;
602 case LA_CENTERED_TOP_ENVIRONMENT:
603 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
606 labeltype = LABEL_STATIC;
609 labeltype = LABEL_SENSITIVE;
612 labeltype = LABEL_COUNTER;
615 labeltype = LABEL_ENUMERATE;
618 labeltype = LABEL_ITEMIZE;
621 labeltype = LABEL_BIBLIO;
627 void Layout::readEndLabelType(Lexer & lex)
629 static LexerKeyword endlabelTypeTags[] = {
630 { "box", END_LABEL_BOX },
631 { "filled_box", END_LABEL_FILLED_BOX },
632 { "no_label", END_LABEL_NO_LABEL },
633 { "static", END_LABEL_STATIC }
636 PushPopHelper pph(lex, endlabelTypeTags);
639 case Lexer::LEX_UNDEF:
640 lex.printError("Unknown labeltype tag `$$Token'");
642 case END_LABEL_STATIC:
644 case END_LABEL_FILLED_BOX:
645 case END_LABEL_NO_LABEL:
646 endlabeltype = static_cast<EndLabelType>(le);
649 LYXERR0("Unhandled value " << le);
655 void Layout::readMargin(Lexer & lex)
657 LexerKeyword marginTags[] = {
658 { "dynamic", MARGIN_DYNAMIC },
659 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
660 { "manual", MARGIN_MANUAL },
661 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
662 { "static", MARGIN_STATIC }
665 PushPopHelper pph(lex, marginTags);
669 case Lexer::LEX_UNDEF:
670 lex.printError("Unknown margin type tag `$$Token'");
675 case MARGIN_FIRST_DYNAMIC:
676 case MARGIN_RIGHT_ADDRESS_BOX:
677 margintype = static_cast<MarginType>(le);
680 LYXERR0("Unhandled value " << le);
686 void Layout::readLatexType(Lexer & lex)
688 LexerKeyword latexTypeTags[] = {
689 { "bib_environment", LATEX_BIB_ENVIRONMENT },
690 { "command", LATEX_COMMAND },
691 { "environment", LATEX_ENVIRONMENT },
692 { "item_environment", LATEX_ITEM_ENVIRONMENT },
693 { "list_environment", LATEX_LIST_ENVIRONMENT },
694 { "paragraph", LATEX_PARAGRAPH }
697 PushPopHelper pph(lex, latexTypeTags);
700 case Lexer::LEX_UNDEF:
701 lex.printError("Unknown latextype tag `$$Token'");
703 case LATEX_PARAGRAPH:
705 case LATEX_ENVIRONMENT:
706 case LATEX_ITEM_ENVIRONMENT:
707 case LATEX_BIB_ENVIRONMENT:
708 case LATEX_LIST_ENVIRONMENT:
709 latextype = static_cast<LatexType>(le);
712 LYXERR0("Unhandled value " << le);
718 void Layout::readSpacing(Lexer & lex)
721 ST_SPACING_SINGLE = 1,
727 LexerKeyword spacingTags[] = {
728 {"double", ST_SPACING_DOUBLE },
729 {"onehalf", ST_SPACING_ONEHALF },
730 {"other", ST_OTHER },
731 {"single", ST_SPACING_SINGLE }
734 PushPopHelper pph(lex, spacingTags);
737 case Lexer::LEX_UNDEF:
738 lex.printError("Unknown spacing token `$$Token'");
743 case ST_SPACING_SINGLE:
744 spacing.set(Spacing::Single);
746 case ST_SPACING_ONEHALF:
747 spacing.set(Spacing::Onehalf);
749 case ST_SPACING_DOUBLE:
750 spacing.set(Spacing::Double);
754 spacing.set(Spacing::Other, lex.getString());
760 docstring const & Layout::name() const
766 void Layout::setName(docstring const & name)
772 docstring const & Layout::obsoleted_by() const
774 return obsoleted_by_;
778 docstring const & Layout::depends_on() const
784 bool Layout::operator==(Layout const & rhs) const
786 // This is enough for the applications we actually make,
787 // at least at the moment. But we could check more.
788 return name() == rhs.name()
789 && latexname() == rhs.latexname()
790 && latextype == rhs.latextype;