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"
33 extern FontInfo lyxRead(Lexer &, FontInfo const & fi = sane_font);
36 /// Special value of toclevel for layouts that to not belong in a TOC
37 const int Layout::NOT_IN_TOC = -1000;
39 // The order of the LayoutTags enum is no more important. [asierra300396]
52 //LT_ENVIRONMENT_DEFAULT,
69 LT_LABELSTRING_APPENDIX,
97 LT_INTITLE // keep this last!
100 /////////////////////
104 margintype = MARGIN_STATIC;
105 latextype = LATEX_PARAGRAPH;
111 labelfont = inherit_font;
113 reslabelfont = sane_font;
114 nextnoindent = false;
119 labelbottomsep = 0.0;
121 align = LYX_ALIGN_BLOCK;
122 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
123 labeltype = LABEL_NO_LABEL;
124 endlabeltype = END_LABEL_NO_LABEL;
125 // Should or should not. That is the question.
126 // spacing.set(Spacing::OneHalf);
129 newline_allowed = true;
130 free_spacing = false;
132 is_environment = false;
133 toclevel = NOT_IN_TOC;
138 bool Layout::read(Lexer & lexrc, TextClass const & tclass)
140 // This table is sorted alphabetically [asierra 30March96]
141 keyword_item layoutTags[] = {
142 { "align", LT_ALIGN },
143 { "alignpossible", LT_ALIGNPOSSIBLE },
144 { "bottomsep", LT_BOTTOMSEP },
145 { "commanddepth", LT_COMMANDDEPTH },
146 { "copystyle", LT_COPYSTYLE },
147 { "dependson", LT_DEPENDSON },
149 { "endlabelstring", LT_ENDLABELSTRING },
150 { "endlabeltype", LT_ENDLABELTYPE },
151 { "fill_bottom", LT_FILL_BOTTOM },
152 { "fill_top", LT_FILL_TOP },
154 { "freespacing", LT_FREE_SPACING },
155 { "innertag", LT_INNERTAG },
156 { "intitle", LT_INTITLE },
157 { "itemsep", LT_ITEMSEP },
158 { "itemtag", LT_ITEMTAG },
159 { "keepempty", LT_KEEPEMPTY },
160 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
161 { "labelcounter", LT_LABELCOUNTER },
162 { "labelfont", LT_LABELFONT },
163 { "labelindent", LT_LABELINDENT },
164 { "labelsep", LT_LABELSEP },
165 { "labelstring", LT_LABELSTRING },
166 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
167 { "labeltag", LT_LABELTAG },
168 { "labeltype", LT_LABELTYPE },
169 { "latexfooter", LT_LATEXFOOTER },
170 { "latexheader", LT_LATEXHEADER },
171 { "latexname", LT_LATEXNAME },
172 { "latexparagraph", LT_LATEXPARAGRAPH },
173 { "latexparam", LT_LATEXPARAM },
174 { "latextype", LT_LATEXTYPE },
175 { "leftmargin", LT_LEFTMARGIN },
176 { "margin", LT_MARGIN },
177 { "needprotect", LT_NEED_PROTECT },
178 { "newline", LT_NEWLINE },
179 { "nextnoindent", LT_NEXTNOINDENT },
180 { "obsoletedby", LT_OBSOLETEDBY },
181 { "optionalargs", LT_OPTARGS },
182 { "parindent", LT_PARINDENT },
183 { "parsep", LT_PARSEP },
184 { "parskip", LT_PARSKIP },
185 { "passthru", LT_PASS_THRU },
186 { "preamble", LT_PREAMBLE },
187 { "rightmargin", LT_RIGHTMARGIN },
188 { "spacing", LT_SPACING },
189 { "textfont", LT_TEXTFONT },
190 { "toclevel", LT_TOCLEVEL },
191 { "topsep", LT_TOPSEP }
195 bool finished = false;
196 lexrc.pushTable(layoutTags, LT_INTITLE);
197 // parse style section
198 while (!finished && lexrc.isOK() && !error) {
199 int le = lexrc.lex();
200 // See comment in LyXRC.cpp.
202 case Lexer::LEX_FEOF:
205 case Lexer::LEX_UNDEF: // parse error
206 lexrc.printError("Unknown layout tag `$$Token'");
211 switch (static_cast<LayoutTags>(le)) {
212 case LT_END: // end of structure
216 case LT_COPYSTYLE: // initialize with a known style
218 docstring const style = subst(lexrc.getDocString(),
221 if (tclass.hasLayout(style)) {
222 docstring const tmpname = name_;
223 this->operator=(*tclass[style]);
226 lyxerr << "Cannot copy unknown style `"
227 << to_utf8(style) << "'\n"
228 << "All layouts so far:"
230 TextClass::const_iterator it =
232 TextClass::const_iterator end =
234 for (; it != end; ++it) {
235 lyxerr << to_utf8((*it)->name())
239 //lexrc.printError("Cannot copy known "
240 // "style `$$Token'");
245 case LT_OBSOLETEDBY: // replace with a known style
247 docstring const style =
248 subst(lexrc.getDocString(), '_', ' ');
250 if (tclass.hasLayout(style)) {
251 docstring const tmpname = name_;
252 this->operator=(*tclass[style]);
254 if (obsoleted_by().empty())
255 obsoleted_by_ = style;
257 lyxerr << "Cannot replace with unknown style `"
258 << to_utf8(style) << '\'' << endl;
260 //lexrc.printError("Cannot replace with"
269 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
272 case LT_MARGIN: // margin style definition.
276 case LT_LATEXTYPE: // LaTeX style definition.
277 readLatexType(lexrc);
280 case LT_LATEXHEADER: // header for environments
282 latexheader = lexrc.getString();
285 case LT_LATEXFOOTER: // footer for environments
287 latexfooter = lexrc.getString();
290 case LT_LATEXPARAGRAPH:
292 latexparagraph = lexrc.getString();
296 intitle = lexrc.next() && lexrc.getInteger();
301 toclevel = lexrc.getInteger();
306 optionalargs = lexrc.getInteger();
309 case LT_NEED_PROTECT:
310 needprotect = lexrc.next() && lexrc.getInteger();
314 keepempty = lexrc.next() && lexrc.getInteger();
318 font = lyxRead(lexrc, font);
323 font = lyxRead(lexrc, font);
327 labelfont = lyxRead(lexrc, labelfont);
330 case LT_NEXTNOINDENT: // Indent next paragraph?
331 if (lexrc.next() && lexrc.getInteger())
334 nextnoindent = false;
337 case LT_COMMANDDEPTH:
339 commanddepth = lexrc.getInteger();
344 latexname_ = lexrc.getString();
349 latexparam_ = subst(lexrc.getString(), """, "\"");
354 innertag_ = lexrc.getString();
359 labeltag_ = lexrc.getString();
364 itemtag_ = lexrc.getString();
368 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
372 readLabelType(lexrc);
375 case LT_ENDLABELTYPE:
376 readEndLabelType(lexrc);
379 case LT_LEFTMARGIN: // left margin type
381 leftmargin = lexrc.getDocString();
384 case LT_RIGHTMARGIN: // right margin type
386 rightmargin = lexrc.getDocString();
389 case LT_LABELINDENT: // label indenting flag
391 labelindent = lexrc.getDocString();
394 case LT_PARINDENT: // paragraph indent. flag
396 parindent = lexrc.getDocString();
399 case LT_PARSKIP: // paragraph skip size
401 parskip = lexrc.getFloat();
404 case LT_ITEMSEP: // item separation size
406 itemsep = lexrc.getFloat();
409 case LT_TOPSEP: // top separation size
411 topsep = lexrc.getFloat();
414 case LT_BOTTOMSEP: // bottom separation size
416 bottomsep = lexrc.getFloat();
419 case LT_LABEL_BOTTOMSEP: // label bottom separation size
421 labelbottomsep = lexrc.getFloat();
424 case LT_LABELSEP: // label separator
426 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
430 case LT_PARSEP: // par. separation size
432 parsep = lexrc.getFloat();
435 case LT_FILL_TOP: // fill top flag
437 fill_top = lexrc.getInteger();
440 case LT_FILL_BOTTOM: // fill bottom flag
442 fill_bottom = lexrc.getInteger();
445 case LT_NEWLINE: // newlines allowed?
447 newline_allowed = lexrc.getInteger();
450 case LT_ALIGN: // paragraph align
453 case LT_ALIGNPOSSIBLE: // paragraph allowed align
454 readAlignPossible(lexrc);
457 case LT_LABELSTRING: // label string definition
459 labelstring_ = trim(lexrc.getDocString());
460 labelstring_appendix_ = labelstring_;
464 case LT_ENDLABELSTRING: // endlabel string definition
466 endlabelstring_ = trim(lexrc.getDocString());
469 case LT_LABELSTRING_APPENDIX: // label string appendix definition
471 labelstring_appendix_ = trim(lexrc.getDocString());
474 case LT_LABELCOUNTER: // name of counter to use
476 counter = lyx::from_ascii(trim(lexrc.getString()));
479 case LT_FREE_SPACING: // Allow for free spacing.
481 free_spacing = lexrc.getInteger();
484 case LT_PASS_THRU: // Allow for pass thru.
486 pass_thru = lexrc.getInteger();
489 case LT_SPACING: // setspace.sty
509 void Layout::readAlign(Lexer & lexrc)
511 keyword_item alignTags[] = {
512 { "block", AT_BLOCK },
513 { "center", AT_CENTER },
514 { "layout", AT_LAYOUT },
516 { "right", AT_RIGHT }
519 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
520 int le = lexrc.lex();
522 case Lexer::LEX_UNDEF:
523 lexrc.printError("Unknown alignment `$$Token'");
527 switch (static_cast<AlignTags>(le)) {
529 align = LYX_ALIGN_BLOCK;
532 align = LYX_ALIGN_LEFT;
535 align = LYX_ALIGN_RIGHT;
538 align = LYX_ALIGN_CENTER;
541 align = LYX_ALIGN_LAYOUT;
547 void Layout::readAlignPossible(Lexer & lexrc)
549 keyword_item alignTags[] = {
550 { "block", AT_BLOCK },
551 { "center", AT_CENTER },
552 { "layout", AT_LAYOUT },
554 { "right", AT_RIGHT }
557 lexrc.pushTable(alignTags, AT_LAYOUT);
558 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
559 int lineno = lexrc.getLineNo();
561 int le = lexrc.lex();
563 case Lexer::LEX_UNDEF:
564 lexrc.printError("Unknown alignment `$$Token'");
568 switch (static_cast<AlignTags>(le)) {
570 alignpossible |= LYX_ALIGN_BLOCK;
573 alignpossible |= LYX_ALIGN_LEFT;
576 alignpossible |= LYX_ALIGN_RIGHT;
579 alignpossible |= LYX_ALIGN_CENTER;
582 alignpossible |= LYX_ALIGN_LAYOUT;
585 } while (lineno == lexrc.getLineNo());
594 LA_CENTERED_TOP_ENVIRONMENT,
604 void Layout::readLabelType(Lexer & lexrc)
606 keyword_item labelTypeTags[] = {
607 { "bibliography", LA_BIBLIO },
608 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
609 { "counter", LA_COUNTER },
610 { "enumerate", LA_ENUMERATE },
611 { "itemize", LA_ITEMIZE },
612 { "manual", LA_MANUAL },
613 { "no_label", LA_NO_LABEL },
614 { "sensitive", LA_SENSITIVE },
615 { "static", LA_STATIC },
616 { "top_environment", LA_TOP_ENVIRONMENT }
619 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
620 int le = lexrc.lex();
622 case Lexer::LEX_UNDEF:
623 lexrc.printError("Unknown labeltype tag `$$Token'");
627 switch (static_cast<LabelTypeTags>(le)) {
629 labeltype = LABEL_NO_LABEL;
632 labeltype = LABEL_MANUAL;
634 case LA_TOP_ENVIRONMENT:
635 labeltype = LABEL_TOP_ENVIRONMENT;
637 case LA_CENTERED_TOP_ENVIRONMENT:
638 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
641 labeltype = LABEL_STATIC;
644 labeltype = LABEL_SENSITIVE;
647 labeltype = LABEL_COUNTER;
650 labeltype = LABEL_ENUMERATE;
653 labeltype = LABEL_ITEMIZE;
656 labeltype = LABEL_BIBLIO;
662 static keyword_item endlabelTypeTags[] =
664 { "box", END_LABEL_BOX },
665 { "filled_box", END_LABEL_FILLED_BOX },
666 { "no_label", END_LABEL_NO_LABEL },
667 { "static", END_LABEL_STATIC }
671 void Layout::readEndLabelType(Lexer & lexrc)
673 PushPopHelper pph(lexrc, endlabelTypeTags,
674 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
675 int le = lexrc.lex();
677 case Lexer::LEX_UNDEF:
678 lexrc.printError("Unknown labeltype tag `$$Token'");
680 case END_LABEL_STATIC:
682 case END_LABEL_FILLED_BOX:
683 case END_LABEL_NO_LABEL:
684 endlabeltype = static_cast<EndLabelType>(le);
687 lyxerr << "Unhandled value " << le
688 << " in Layout::readEndLabelType." << endl;
694 void Layout::readMargin(Lexer & lexrc)
696 keyword_item marginTags[] = {
697 { "dynamic", MARGIN_DYNAMIC },
698 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
699 { "manual", MARGIN_MANUAL },
700 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
701 { "static", MARGIN_STATIC }
704 PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
706 int le = lexrc.lex();
708 case Lexer::LEX_UNDEF:
709 lexrc.printError("Unknown margin type tag `$$Token'");
714 case MARGIN_FIRST_DYNAMIC:
715 case MARGIN_RIGHT_ADDRESS_BOX:
716 margintype = static_cast<MarginType>(le);
719 lyxerr << "Unhandled value " << le
720 << " in Layout::readMargin." << endl;
726 void Layout::readLatexType(Lexer & lexrc)
728 keyword_item latexTypeTags[] = {
729 { "bib_environment", LATEX_BIB_ENVIRONMENT },
730 { "command", LATEX_COMMAND },
731 { "environment", LATEX_ENVIRONMENT },
732 { "item_environment", LATEX_ITEM_ENVIRONMENT },
733 { "list_environment", LATEX_LIST_ENVIRONMENT },
734 { "paragraph", LATEX_PARAGRAPH }
737 PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
738 int le = lexrc.lex();
740 case Lexer::LEX_UNDEF:
741 lexrc.printError("Unknown latextype tag `$$Token'");
743 case LATEX_PARAGRAPH:
745 case LATEX_ENVIRONMENT:
746 case LATEX_ITEM_ENVIRONMENT:
747 case LATEX_BIB_ENVIRONMENT:
748 case LATEX_LIST_ENVIRONMENT:
749 latextype = static_cast<LatexType>(le);
752 lyxerr << "Unhandled value " << le
753 << " in Layout::readLatexType." << endl;
760 ST_SPACING_SINGLE = 1,
767 void Layout::readSpacing(Lexer & lexrc)
769 keyword_item spacingTags[] = {
770 {"double", ST_SPACING_DOUBLE },
771 {"onehalf", ST_SPACING_ONEHALF },
772 {"other", ST_OTHER },
773 {"single", ST_SPACING_SINGLE }
776 PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
777 int le = lexrc.lex();
779 case Lexer::LEX_UNDEF:
780 lexrc.printError("Unknown spacing token `$$Token'");
784 switch (static_cast<SpacingTags>(le)) {
785 case ST_SPACING_SINGLE:
786 spacing.set(Spacing::Single);
788 case ST_SPACING_ONEHALF:
789 spacing.set(Spacing::Onehalf);
791 case ST_SPACING_DOUBLE:
792 spacing.set(Spacing::Double);
796 spacing.set(Spacing::Other, lexrc.getString());
802 docstring const & Layout::name() const
808 void Layout::setName(docstring const & name)
814 docstring const & Layout::obsoleted_by() const
816 return obsoleted_by_;
820 docstring const & Layout::depends_on() const
826 Layout * Layout::forCaption()
828 Layout * lay = new Layout();
829 lay->name_ = from_ascii("Caption");
830 lay->latexname_ = "caption";
831 lay->latextype = LATEX_COMMAND;
832 lay->optionalargs = 1;