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"
26 using namespace lyx::support;
30 /// Special value of toclevel for layouts that to not belong in a TOC
31 const int Layout::NOT_IN_TOC = -1000;
33 // The order of the LayoutTags enum is no more important. [asierra300396]
47 //LT_ENVIRONMENT_DEFAULT,
64 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 & lex, TextClass const & tclass)
136 // This table is sorted alphabetically [asierra 30March96]
137 LexerKeyword layoutTags[] = {
138 { "align", LT_ALIGN },
139 { "alignpossible", LT_ALIGNPOSSIBLE },
140 { "bottomsep", LT_BOTTOMSEP },
141 { "category", LT_CATEGORY },
142 { "commanddepth", LT_COMMANDDEPTH },
143 { "copystyle", LT_COPYSTYLE },
144 { "dependson", LT_DEPENDSON },
146 { "endlabelstring", LT_ENDLABELSTRING },
147 { "endlabeltype", LT_ENDLABELTYPE },
148 { "fill_bottom", LT_FILL_BOTTOM },
149 { "fill_top", LT_FILL_TOP },
151 { "freespacing", LT_FREE_SPACING },
152 { "innertag", LT_INNERTAG },
153 { "intitle", LT_INTITLE },
154 { "itemsep", LT_ITEMSEP },
155 { "itemtag", LT_ITEMTAG },
156 { "keepempty", LT_KEEPEMPTY },
157 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
158 { "labelcounter", LT_LABELCOUNTER },
159 { "labelfont", LT_LABELFONT },
160 { "labelindent", LT_LABELINDENT },
161 { "labelsep", LT_LABELSEP },
162 { "labelstring", LT_LABELSTRING },
163 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
164 { "labeltag", LT_LABELTAG },
165 { "labeltype", LT_LABELTYPE },
166 { "latexfooter", LT_LATEXFOOTER },
167 { "latexheader", LT_LATEXHEADER },
168 { "latexname", LT_LATEXNAME },
169 { "latexparagraph", LT_LATEXPARAGRAPH },
170 { "latexparam", LT_LATEXPARAM },
171 { "latextype", LT_LATEXTYPE },
172 { "leftmargin", LT_LEFTMARGIN },
173 { "margin", LT_MARGIN },
174 { "needprotect", LT_NEED_PROTECT },
175 { "newline", LT_NEWLINE },
176 { "nextnoindent", LT_NEXTNOINDENT },
177 { "obsoletedby", LT_OBSOLETEDBY },
178 { "optionalargs", LT_OPTARGS },
179 { "parindent", LT_PARINDENT },
180 { "parsep", LT_PARSEP },
181 { "parskip", LT_PARSKIP },
182 { "passthru", LT_PASS_THRU },
183 { "preamble", LT_PREAMBLE },
184 { "requires", LT_REQUIRES },
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 lex.pushTable(layoutTags);
195 // parse style section
196 while (!finished && lex.isOK() && !error) {
198 // See comment in LyXRC.cpp.
200 case Lexer::LEX_FEOF:
203 case Lexer::LEX_UNDEF: // parse error
204 lex.printError("Unknown layout tag `$$Token'");
209 switch (static_cast<LayoutTags>(le)) {
210 case LT_END: // end of structure
218 case LT_COPYSTYLE: { // initialize with a known style
221 style = subst(style, '_', ' ');
223 if (tclass.hasLayout(style)) {
224 docstring const tmpname = name_;
225 this->operator=(tclass[style]);
228 lyxerr << "Cannot copy unknown style `"
229 << to_utf8(style) << "'\n"
230 << "All layouts so far:"
232 DocumentClass::const_iterator lit = tclass.begin();
233 DocumentClass::const_iterator len = tclass.end();
234 for (; lit != len; ++lit)
235 lyxerr << to_utf8(lit->name()) << endl;
237 //lex.printError("Cannot copy known "
238 // "style `$$Token'");
243 case LT_OBSOLETEDBY: { // replace with a known style
246 style = subst(style, '_', ' ');
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 //lex.printError("Cannot replace with"
267 depends_on_ = subst(depends_on_, '_', ' ');
270 case LT_MARGIN: // margin style definition.
274 case LT_LATEXTYPE: // LaTeX style definition.
278 case LT_LATEXHEADER: // header for environments
282 case LT_LATEXFOOTER: // footer for environments
286 case LT_LATEXPARAGRAPH:
287 lex >> latexparagraph;
299 lex >> optionalargs ;
302 case LT_NEED_PROTECT:
311 font = lyxRead(lex, font);
316 font = lyxRead(lex, font);
320 labelfont = lyxRead(lex, labelfont);
323 case LT_NEXTNOINDENT: // Indent next paragraph?
327 case LT_COMMANDDEPTH:
337 latexparam_ = subst(latexparam_, """, "\"");
353 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
360 case LT_ENDLABELTYPE:
361 readEndLabelType(lex);
364 case LT_LEFTMARGIN: // left margin type
368 case LT_RIGHTMARGIN: // right margin type
372 case LT_LABELINDENT: // label indenting flag
376 case LT_PARINDENT: // paragraph indent. flag
380 case LT_PARSKIP: // paragraph skip size
384 case LT_ITEMSEP: // item separation size
388 case LT_TOPSEP: // top separation size
392 case LT_BOTTOMSEP: // bottom separation size
396 case LT_LABEL_BOTTOMSEP: // label bottom separation size
397 lex >> labelbottomsep;
400 case LT_LABELSEP: // label separator
402 labelsep = subst(labelsep, 'x', ' ');
405 case LT_PARSEP: // par. separation size
409 case LT_FILL_TOP: // fill top flag
413 case LT_FILL_BOTTOM: // fill bottom flag
417 case LT_NEWLINE: // newlines allowed?
418 lex >> newline_allowed;
421 case LT_ALIGN: // paragraph align
424 case LT_ALIGNPOSSIBLE: // paragraph allowed align
425 readAlignPossible(lex);
428 case LT_LABELSTRING: // label string definition
429 // FIXME: this means LT_ENDLABELSTRING may only
430 // occur after LT_LABELSTRING
432 labelstring_ = trim(labelstring_);
433 labelstring_appendix_ = labelstring_;
436 case LT_ENDLABELSTRING: // endlabel string definition
437 lex >> endlabelstring_;
438 endlabelstring_ = trim(endlabelstring_);
441 case LT_LABELSTRING_APPENDIX: // label string appendix definition
442 lex >> labelstring_appendix_;
443 labelstring_appendix_ = trim(labelstring_appendix_);
446 case LT_LABELCOUNTER: // name of counter to use
448 counter = trim(counter);
451 case LT_FREE_SPACING: // Allow for free spacing.
455 case LT_PASS_THRU: // Allow for pass thru.
459 case LT_SPACING: // setspace.sty
465 vector<string> const req =
466 getVectorFromString(lex.getString());
467 requires_.insert(req.begin(), req.end());
487 LexerKeyword alignTags[] = {
488 { "block", AT_BLOCK },
489 { "center", AT_CENTER },
490 { "layout", AT_LAYOUT },
492 { "right", AT_RIGHT }
496 void Layout::readAlign(Lexer & lex)
498 PushPopHelper pph(lex, alignTags);
501 case Lexer::LEX_UNDEF:
502 lex.printError("Unknown alignment `$$Token'");
508 align = LYX_ALIGN_BLOCK;
511 align = LYX_ALIGN_LEFT;
514 align = LYX_ALIGN_RIGHT;
517 align = LYX_ALIGN_CENTER;
520 align = LYX_ALIGN_LAYOUT;
526 void Layout::readAlignPossible(Lexer & lex)
528 lex.pushTable(alignTags);
529 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
530 int lineno = lex.lineNumber();
534 case Lexer::LEX_UNDEF:
535 lex.printError("Unknown alignment `$$Token'");
541 alignpossible |= LYX_ALIGN_BLOCK;
544 alignpossible |= LYX_ALIGN_LEFT;
547 alignpossible |= LYX_ALIGN_RIGHT;
550 alignpossible |= LYX_ALIGN_CENTER;
553 alignpossible |= LYX_ALIGN_LAYOUT;
556 } while (lineno == lex.lineNumber());
561 void Layout::readLabelType(Lexer & lex)
567 LA_CENTERED_TOP_ENVIRONMENT,
577 LexerKeyword labelTypeTags[] = {
578 { "bibliography", LA_BIBLIO },
579 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
580 { "counter", LA_COUNTER },
581 { "enumerate", LA_ENUMERATE },
582 { "itemize", LA_ITEMIZE },
583 { "manual", LA_MANUAL },
584 { "no_label", LA_NO_LABEL },
585 { "sensitive", LA_SENSITIVE },
586 { "static", LA_STATIC },
587 { "top_environment", LA_TOP_ENVIRONMENT }
590 PushPopHelper pph(lex, labelTypeTags);
593 case Lexer::LEX_UNDEF:
594 lex.printError("Unknown labeltype tag `$$Token'");
600 labeltype = LABEL_NO_LABEL;
603 labeltype = LABEL_MANUAL;
605 case LA_TOP_ENVIRONMENT:
606 labeltype = LABEL_TOP_ENVIRONMENT;
608 case LA_CENTERED_TOP_ENVIRONMENT:
609 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
612 labeltype = LABEL_STATIC;
615 labeltype = LABEL_SENSITIVE;
618 labeltype = LABEL_COUNTER;
621 labeltype = LABEL_ENUMERATE;
624 labeltype = LABEL_ITEMIZE;
627 labeltype = LABEL_BIBLIO;
633 void Layout::readEndLabelType(Lexer & lex)
635 static LexerKeyword endlabelTypeTags[] = {
636 { "box", END_LABEL_BOX },
637 { "filled_box", END_LABEL_FILLED_BOX },
638 { "no_label", END_LABEL_NO_LABEL },
639 { "static", END_LABEL_STATIC }
642 PushPopHelper pph(lex, endlabelTypeTags);
645 case Lexer::LEX_UNDEF:
646 lex.printError("Unknown labeltype tag `$$Token'");
648 case END_LABEL_STATIC:
650 case END_LABEL_FILLED_BOX:
651 case END_LABEL_NO_LABEL:
652 endlabeltype = static_cast<EndLabelType>(le);
655 LYXERR0("Unhandled value " << le
656 << " in Layout::readEndLabelType.");
662 void Layout::readMargin(Lexer & lex)
664 LexerKeyword marginTags[] = {
665 { "dynamic", MARGIN_DYNAMIC },
666 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
667 { "manual", MARGIN_MANUAL },
668 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
669 { "static", MARGIN_STATIC }
672 PushPopHelper pph(lex, marginTags);
676 case Lexer::LEX_UNDEF:
677 lex.printError("Unknown margin type tag `$$Token'");
682 case MARGIN_FIRST_DYNAMIC:
683 case MARGIN_RIGHT_ADDRESS_BOX:
684 margintype = static_cast<MarginType>(le);
687 lyxerr << "Unhandled value " << le
688 << " in Layout::readMargin." << endl;
694 void Layout::readLatexType(Lexer & lex)
696 LexerKeyword latexTypeTags[] = {
697 { "bib_environment", LATEX_BIB_ENVIRONMENT },
698 { "command", LATEX_COMMAND },
699 { "environment", LATEX_ENVIRONMENT },
700 { "item_environment", LATEX_ITEM_ENVIRONMENT },
701 { "list_environment", LATEX_LIST_ENVIRONMENT },
702 { "paragraph", LATEX_PARAGRAPH }
705 PushPopHelper pph(lex, latexTypeTags);
708 case Lexer::LEX_UNDEF:
709 lex.printError("Unknown latextype tag `$$Token'");
711 case LATEX_PARAGRAPH:
713 case LATEX_ENVIRONMENT:
714 case LATEX_ITEM_ENVIRONMENT:
715 case LATEX_BIB_ENVIRONMENT:
716 case LATEX_LIST_ENVIRONMENT:
717 latextype = static_cast<LatexType>(le);
720 lyxerr << "Unhandled value " << le
721 << " in Layout::readLatexType." << endl;
727 void Layout::readSpacing(Lexer & lex)
730 ST_SPACING_SINGLE = 1,
736 LexerKeyword spacingTags[] = {
737 {"double", ST_SPACING_DOUBLE },
738 {"onehalf", ST_SPACING_ONEHALF },
739 {"other", ST_OTHER },
740 {"single", ST_SPACING_SINGLE }
743 PushPopHelper pph(lex, spacingTags);
746 case Lexer::LEX_UNDEF:
747 lex.printError("Unknown spacing token `$$Token'");
752 case ST_SPACING_SINGLE:
753 spacing.set(Spacing::Single);
755 case ST_SPACING_ONEHALF:
756 spacing.set(Spacing::Onehalf);
758 case ST_SPACING_DOUBLE:
759 spacing.set(Spacing::Double);
763 spacing.set(Spacing::Other, lex.getString());
769 docstring const & Layout::name() const
775 void Layout::setName(docstring const & name)
781 docstring const & Layout::obsoleted_by() const
783 return obsoleted_by_;
787 docstring const & Layout::depends_on() const
793 bool Layout::operator==(Layout const & rhs) const
795 // This is enough for the applications we actually make,
796 // at least at the moment. But we could check more.
797 return name() == rhs.name()
798 && latexname() == rhs.latexname()
799 && latextype == rhs.latextype;