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,
88 LT_INTITLE // keep this last!
96 margintype = MARGIN_STATIC;
97 latextype = LATEX_PARAGRAPH;
103 labelfont = inherit_font;
105 reslabelfont = sane_font;
106 nextnoindent = false;
111 labelbottomsep = 0.0;
113 align = LYX_ALIGN_BLOCK;
114 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
115 labeltype = LABEL_NO_LABEL;
116 endlabeltype = END_LABEL_NO_LABEL;
117 // Should or should not. That is the question.
118 // spacing.set(Spacing::OneHalf);
121 newline_allowed = true;
122 free_spacing = false;
124 toclevel = NOT_IN_TOC;
129 bool Layout::read(Lexer & lex, TextClass const & tclass)
131 // This table is sorted alphabetically [asierra 30March96]
132 LexerKeyword layoutTags[] = {
133 { "align", LT_ALIGN },
134 { "alignpossible", LT_ALIGNPOSSIBLE },
135 { "bottomsep", LT_BOTTOMSEP },
136 { "category", LT_CATEGORY },
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 { "latexname", LT_LATEXNAME },
162 { "latexparam", LT_LATEXPARAM },
163 { "latextype", LT_LATEXTYPE },
164 { "leftmargin", LT_LEFTMARGIN },
165 { "margin", LT_MARGIN },
166 { "needprotect", LT_NEED_PROTECT },
167 { "newline", LT_NEWLINE },
168 { "nextnoindent", LT_NEXTNOINDENT },
169 { "obsoletedby", LT_OBSOLETEDBY },
170 { "optionalargs", LT_OPTARGS },
171 { "parindent", LT_PARINDENT },
172 { "parsep", LT_PARSEP },
173 { "parskip", LT_PARSKIP },
174 { "passthru", LT_PASS_THRU },
175 { "preamble", LT_PREAMBLE },
176 { "requires", LT_REQUIRES },
177 { "rightmargin", LT_RIGHTMARGIN },
178 { "spacing", LT_SPACING },
179 { "textfont", LT_TEXTFONT },
180 { "toclevel", LT_TOCLEVEL },
181 { "topsep", LT_TOPSEP }
185 bool finished = false;
186 lex.pushTable(layoutTags);
187 // parse style section
188 while (!finished && lex.isOK() && !error) {
190 // See comment in LyXRC.cpp.
192 case Lexer::LEX_FEOF:
195 case Lexer::LEX_UNDEF: // parse error
196 lex.printError("Unknown layout tag `$$Token'");
201 switch (static_cast<LayoutTags>(le)) {
202 case LT_END: // end of structure
210 case LT_COPYSTYLE: { // initialize with a known style
213 style = subst(style, '_', ' ');
215 if (tclass.hasLayout(style)) {
216 docstring const tmpname = name_;
217 this->operator=(tclass[style]);
220 LYXERR0("Cannot copy unknown style `"
222 << "All layouts so far:");
223 DocumentClass::const_iterator lit = tclass.begin();
224 DocumentClass::const_iterator len = tclass.end();
225 for (; lit != len; ++lit)
226 LYXERR0(lit->name());
231 case LT_OBSOLETEDBY: { // replace with a known style
234 style = subst(style, '_', ' ');
236 if (tclass.hasLayout(style)) {
237 docstring const tmpname = name_;
238 this->operator=(tclass[style]);
240 if (obsoleted_by().empty())
241 obsoleted_by_ = style;
243 LYXERR0("Cannot replace with unknown style `"
246 //lex.printError("Cannot replace with"
255 depends_on_ = subst(depends_on_, '_', ' ');
258 case LT_MARGIN: // margin style definition.
262 case LT_LATEXTYPE: // LaTeX style definition.
275 lex >> optionalargs ;
278 case LT_NEED_PROTECT:
287 font = lyxRead(lex, font);
292 font = lyxRead(lex, font);
296 labelfont = lyxRead(lex, labelfont);
299 case LT_NEXTNOINDENT: // Indent next paragraph?
303 case LT_COMMANDDEPTH:
313 latexparam_ = subst(latexparam_, """, "\"");
329 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
336 case LT_ENDLABELTYPE:
337 readEndLabelType(lex);
340 case LT_LEFTMARGIN: // left margin type
344 case LT_RIGHTMARGIN: // right margin type
348 case LT_LABELINDENT: // label indenting flag
352 case LT_PARINDENT: // paragraph indent. flag
356 case LT_PARSKIP: // paragraph skip size
360 case LT_ITEMSEP: // item separation size
364 case LT_TOPSEP: // top separation size
368 case LT_BOTTOMSEP: // bottom separation size
372 case LT_LABEL_BOTTOMSEP: // label bottom separation size
373 lex >> labelbottomsep;
376 case LT_LABELSEP: // label separator
378 labelsep = subst(labelsep, 'x', ' ');
381 case LT_PARSEP: // par. separation size
385 case LT_FILL_TOP: // fill top flag
389 case LT_FILL_BOTTOM: // fill bottom flag
393 case LT_NEWLINE: // newlines allowed?
394 lex >> newline_allowed;
397 case LT_ALIGN: // paragraph align
400 case LT_ALIGNPOSSIBLE: // paragraph allowed align
401 readAlignPossible(lex);
404 case LT_LABELSTRING: // label string definition
405 // FIXME: this means LT_ENDLABELSTRING may only
406 // occur after LT_LABELSTRING
408 labelstring_ = trim(labelstring_);
409 labelstring_appendix_ = labelstring_;
412 case LT_ENDLABELSTRING: // endlabel string definition
413 lex >> endlabelstring_;
414 endlabelstring_ = trim(endlabelstring_);
417 case LT_LABELSTRING_APPENDIX: // label string appendix definition
418 lex >> labelstring_appendix_;
419 labelstring_appendix_ = trim(labelstring_appendix_);
422 case LT_LABELCOUNTER: // name of counter to use
424 counter = trim(counter);
427 case LT_FREE_SPACING: // Allow for free spacing.
431 case LT_PASS_THRU: // Allow for pass thru.
435 case LT_SPACING: // setspace.sty
441 vector<string> const req =
442 getVectorFromString(lex.getString());
443 requires_.insert(req.begin(), req.end());
463 LexerKeyword alignTags[] = {
464 { "block", AT_BLOCK },
465 { "center", AT_CENTER },
466 { "layout", AT_LAYOUT },
468 { "right", AT_RIGHT }
472 void Layout::readAlign(Lexer & lex)
474 PushPopHelper pph(lex, alignTags);
477 case Lexer::LEX_UNDEF:
478 lex.printError("Unknown alignment `$$Token'");
484 align = LYX_ALIGN_BLOCK;
487 align = LYX_ALIGN_LEFT;
490 align = LYX_ALIGN_RIGHT;
493 align = LYX_ALIGN_CENTER;
496 align = LYX_ALIGN_LAYOUT;
502 void Layout::readAlignPossible(Lexer & lex)
504 lex.pushTable(alignTags);
505 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
506 int lineno = lex.lineNumber();
510 case Lexer::LEX_UNDEF:
511 lex.printError("Unknown alignment `$$Token'");
517 alignpossible |= LYX_ALIGN_BLOCK;
520 alignpossible |= LYX_ALIGN_LEFT;
523 alignpossible |= LYX_ALIGN_RIGHT;
526 alignpossible |= LYX_ALIGN_CENTER;
529 alignpossible |= LYX_ALIGN_LAYOUT;
532 } while (lineno == lex.lineNumber());
537 void Layout::readLabelType(Lexer & lex)
543 LA_CENTERED_TOP_ENVIRONMENT,
553 LexerKeyword labelTypeTags[] = {
554 { "bibliography", LA_BIBLIO },
555 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
556 { "counter", LA_COUNTER },
557 { "enumerate", LA_ENUMERATE },
558 { "itemize", LA_ITEMIZE },
559 { "manual", LA_MANUAL },
560 { "no_label", LA_NO_LABEL },
561 { "sensitive", LA_SENSITIVE },
562 { "static", LA_STATIC },
563 { "top_environment", LA_TOP_ENVIRONMENT }
566 PushPopHelper pph(lex, labelTypeTags);
569 case Lexer::LEX_UNDEF:
570 lex.printError("Unknown labeltype tag `$$Token'");
576 labeltype = LABEL_NO_LABEL;
579 labeltype = LABEL_MANUAL;
581 case LA_TOP_ENVIRONMENT:
582 labeltype = LABEL_TOP_ENVIRONMENT;
584 case LA_CENTERED_TOP_ENVIRONMENT:
585 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
588 labeltype = LABEL_STATIC;
591 labeltype = LABEL_SENSITIVE;
594 labeltype = LABEL_COUNTER;
597 labeltype = LABEL_ENUMERATE;
600 labeltype = LABEL_ITEMIZE;
603 labeltype = LABEL_BIBLIO;
609 void Layout::readEndLabelType(Lexer & lex)
611 static LexerKeyword endlabelTypeTags[] = {
612 { "box", END_LABEL_BOX },
613 { "filled_box", END_LABEL_FILLED_BOX },
614 { "no_label", END_LABEL_NO_LABEL },
615 { "static", END_LABEL_STATIC }
618 PushPopHelper pph(lex, endlabelTypeTags);
621 case Lexer::LEX_UNDEF:
622 lex.printError("Unknown labeltype tag `$$Token'");
624 case END_LABEL_STATIC:
626 case END_LABEL_FILLED_BOX:
627 case END_LABEL_NO_LABEL:
628 endlabeltype = static_cast<EndLabelType>(le);
631 LYXERR0("Unhandled value " << le);
637 void Layout::readMargin(Lexer & lex)
639 LexerKeyword marginTags[] = {
640 { "dynamic", MARGIN_DYNAMIC },
641 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
642 { "manual", MARGIN_MANUAL },
643 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
644 { "static", MARGIN_STATIC }
647 PushPopHelper pph(lex, marginTags);
651 case Lexer::LEX_UNDEF:
652 lex.printError("Unknown margin type tag `$$Token'");
657 case MARGIN_FIRST_DYNAMIC:
658 case MARGIN_RIGHT_ADDRESS_BOX:
659 margintype = static_cast<MarginType>(le);
662 LYXERR0("Unhandled value " << le);
668 void Layout::readLatexType(Lexer & lex)
670 LexerKeyword latexTypeTags[] = {
671 { "bib_environment", LATEX_BIB_ENVIRONMENT },
672 { "command", LATEX_COMMAND },
673 { "environment", LATEX_ENVIRONMENT },
674 { "item_environment", LATEX_ITEM_ENVIRONMENT },
675 { "list_environment", LATEX_LIST_ENVIRONMENT },
676 { "paragraph", LATEX_PARAGRAPH }
679 PushPopHelper pph(lex, latexTypeTags);
682 case Lexer::LEX_UNDEF:
683 lex.printError("Unknown latextype tag `$$Token'");
685 case LATEX_PARAGRAPH:
687 case LATEX_ENVIRONMENT:
688 case LATEX_ITEM_ENVIRONMENT:
689 case LATEX_BIB_ENVIRONMENT:
690 case LATEX_LIST_ENVIRONMENT:
691 latextype = static_cast<LatexType>(le);
694 LYXERR0("Unhandled value " << le);
700 void Layout::readSpacing(Lexer & lex)
703 ST_SPACING_SINGLE = 1,
709 LexerKeyword spacingTags[] = {
710 {"double", ST_SPACING_DOUBLE },
711 {"onehalf", ST_SPACING_ONEHALF },
712 {"other", ST_OTHER },
713 {"single", ST_SPACING_SINGLE }
716 PushPopHelper pph(lex, spacingTags);
719 case Lexer::LEX_UNDEF:
720 lex.printError("Unknown spacing token `$$Token'");
725 case ST_SPACING_SINGLE:
726 spacing.set(Spacing::Single);
728 case ST_SPACING_ONEHALF:
729 spacing.set(Spacing::Onehalf);
731 case ST_SPACING_DOUBLE:
732 spacing.set(Spacing::Double);
736 spacing.set(Spacing::Other, lex.getString());
742 docstring const & Layout::name() const
748 void Layout::setName(docstring const & name)
754 docstring const & Layout::obsoleted_by() const
756 return obsoleted_by_;
760 docstring const & Layout::depends_on() const
766 bool Layout::operator==(Layout const & rhs) const
768 // This is enough for the applications we actually make,
769 // at least at the moment. But we could check more.
770 return name() == rhs.name()
771 && latexname() == rhs.latexname()
772 && latextype == rhs.latextype;