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"
27 using namespace lyx::support;
31 /// Special value of toclevel for layouts that to not belong in a TOC
32 const int Layout::NOT_IN_TOC = -1000;
34 // 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 & lexrc, TextClass const & tclass)
136 // This table is sorted alphabetically [asierra 30March96]
137 keyword_item layoutTags[] = {
138 { "align", LT_ALIGN },
139 { "alignpossible", LT_ALIGNPOSSIBLE },
140 { "bottomsep", LT_BOTTOMSEP },
141 { "commanddepth", LT_COMMANDDEPTH },
142 { "copystyle", LT_COPYSTYLE },
143 { "dependson", LT_DEPENDSON },
145 { "endlabelstring", LT_ENDLABELSTRING },
146 { "endlabeltype", LT_ENDLABELTYPE },
147 { "fill_bottom", LT_FILL_BOTTOM },
148 { "fill_top", LT_FILL_TOP },
150 { "freespacing", LT_FREE_SPACING },
151 { "innertag", LT_INNERTAG },
152 { "intitle", LT_INTITLE },
153 { "itemsep", LT_ITEMSEP },
154 { "itemtag", LT_ITEMTAG },
155 { "keepempty", LT_KEEPEMPTY },
156 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
157 { "labelcounter", LT_LABELCOUNTER },
158 { "labelfont", LT_LABELFONT },
159 { "labelindent", LT_LABELINDENT },
160 { "labelsep", LT_LABELSEP },
161 { "labelstring", LT_LABELSTRING },
162 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
163 { "labeltag", LT_LABELTAG },
164 { "labeltype", LT_LABELTYPE },
165 { "latexfooter", LT_LATEXFOOTER },
166 { "latexheader", LT_LATEXHEADER },
167 { "latexname", LT_LATEXNAME },
168 { "latexparagraph", LT_LATEXPARAGRAPH },
169 { "latexparam", LT_LATEXPARAM },
170 { "latextype", LT_LATEXTYPE },
171 { "leftmargin", LT_LEFTMARGIN },
172 { "margin", LT_MARGIN },
173 { "needprotect", LT_NEED_PROTECT },
174 { "newline", LT_NEWLINE },
175 { "nextnoindent", LT_NEXTNOINDENT },
176 { "obsoletedby", LT_OBSOLETEDBY },
177 { "optionalargs", LT_OPTARGS },
178 { "parindent", LT_PARINDENT },
179 { "parsep", LT_PARSEP },
180 { "parskip", LT_PARSKIP },
181 { "passthru", LT_PASS_THRU },
182 { "preamble", LT_PREAMBLE },
183 { "requires", LT_REQUIRES },
184 { "rightmargin", LT_RIGHTMARGIN },
185 { "spacing", LT_SPACING },
186 { "textfont", LT_TEXTFONT },
187 { "toclevel", LT_TOCLEVEL },
188 { "topsep", LT_TOPSEP }
192 bool finished = false;
193 lexrc.pushTable(layoutTags, LT_INTITLE);
194 // parse style section
195 while (!finished && lexrc.isOK() && !error) {
196 int le = lexrc.lex();
197 // See comment in LyXRC.cpp.
199 case Lexer::LEX_FEOF:
202 case Lexer::LEX_UNDEF: // parse error
203 lexrc.printError("Unknown layout tag `$$Token'");
208 switch (static_cast<LayoutTags>(le)) {
209 case LT_END: // end of structure
213 case LT_COPYSTYLE: // initialize with a known style
215 docstring const style = subst(lexrc.getDocString(),
218 if (tclass.hasLayout(style)) {
219 docstring const tmpname = name_;
220 this->operator=(*tclass[style]);
223 lyxerr << "Cannot copy unknown style `"
224 << to_utf8(style) << "'\n"
225 << "All layouts so far:"
227 TextClass::const_iterator it =
229 TextClass::const_iterator end =
231 for (; it != end; ++it) {
232 lyxerr << to_utf8((*it)->name())
236 //lexrc.printError("Cannot copy known "
237 // "style `$$Token'");
242 case LT_OBSOLETEDBY: // replace with a known style
244 docstring const style =
245 subst(lexrc.getDocString(), '_', ' ');
247 if (tclass.hasLayout(style)) {
248 docstring const tmpname = name_;
249 this->operator=(*tclass[style]);
251 if (obsoleted_by().empty())
252 obsoleted_by_ = style;
254 lyxerr << "Cannot replace with unknown style `"
255 << to_utf8(style) << '\'' << endl;
257 //lexrc.printError("Cannot replace with"
266 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
269 case LT_MARGIN: // margin style definition.
273 case LT_LATEXTYPE: // LaTeX style definition.
274 readLatexType(lexrc);
277 case LT_LATEXHEADER: // header for environments
279 latexheader = lexrc.getString();
282 case LT_LATEXFOOTER: // footer for environments
284 latexfooter = lexrc.getString();
287 case LT_LATEXPARAGRAPH:
289 latexparagraph = lexrc.getString();
293 intitle = lexrc.next() && lexrc.getInteger();
298 toclevel = lexrc.getInteger();
303 optionalargs = lexrc.getInteger();
306 case LT_NEED_PROTECT:
307 needprotect = lexrc.next() && lexrc.getInteger();
311 keepempty = lexrc.next() && lexrc.getInteger();
315 font = lyxRead(lexrc, font);
320 font = lyxRead(lexrc, font);
324 labelfont = lyxRead(lexrc, labelfont);
327 case LT_NEXTNOINDENT: // Indent next paragraph?
328 if (lexrc.next() && lexrc.getInteger())
331 nextnoindent = false;
334 case LT_COMMANDDEPTH:
336 commanddepth = lexrc.getInteger();
341 latexname_ = lexrc.getString();
346 latexparam_ = subst(lexrc.getString(), """, "\"");
351 innertag_ = lexrc.getString();
356 labeltag_ = lexrc.getString();
361 itemtag_ = lexrc.getString();
365 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
369 readLabelType(lexrc);
372 case LT_ENDLABELTYPE:
373 readEndLabelType(lexrc);
376 case LT_LEFTMARGIN: // left margin type
378 leftmargin = lexrc.getDocString();
381 case LT_RIGHTMARGIN: // right margin type
383 rightmargin = lexrc.getDocString();
386 case LT_LABELINDENT: // label indenting flag
388 labelindent = lexrc.getDocString();
391 case LT_PARINDENT: // paragraph indent. flag
393 parindent = lexrc.getDocString();
396 case LT_PARSKIP: // paragraph skip size
398 parskip = lexrc.getFloat();
401 case LT_ITEMSEP: // item separation size
403 itemsep = lexrc.getFloat();
406 case LT_TOPSEP: // top separation size
408 topsep = lexrc.getFloat();
411 case LT_BOTTOMSEP: // bottom separation size
413 bottomsep = lexrc.getFloat();
416 case LT_LABEL_BOTTOMSEP: // label bottom separation size
418 labelbottomsep = lexrc.getFloat();
421 case LT_LABELSEP: // label separator
423 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
427 case LT_PARSEP: // par. separation size
429 parsep = lexrc.getFloat();
432 case LT_FILL_TOP: // fill top flag
434 fill_top = lexrc.getInteger();
437 case LT_FILL_BOTTOM: // fill bottom flag
439 fill_bottom = lexrc.getInteger();
442 case LT_NEWLINE: // newlines allowed?
444 newline_allowed = lexrc.getInteger();
447 case LT_ALIGN: // paragraph align
450 case LT_ALIGNPOSSIBLE: // paragraph allowed align
451 readAlignPossible(lexrc);
454 case LT_LABELSTRING: // label string definition
456 labelstring_ = trim(lexrc.getDocString());
457 labelstring_appendix_ = labelstring_;
461 case LT_ENDLABELSTRING: // endlabel string definition
463 endlabelstring_ = trim(lexrc.getDocString());
466 case LT_LABELSTRING_APPENDIX: // label string appendix definition
468 labelstring_appendix_ = trim(lexrc.getDocString());
471 case LT_LABELCOUNTER: // name of counter to use
473 counter = lyx::from_ascii(trim(lexrc.getString()));
476 case LT_FREE_SPACING: // Allow for free spacing.
478 free_spacing = lexrc.getInteger();
481 case LT_PASS_THRU: // Allow for pass thru.
483 pass_thru = lexrc.getInteger();
486 case LT_SPACING: // setspace.sty
492 vector<string> const req =
493 getVectorFromString(lexrc.getString());
494 requires_.insert(req.begin(), req.end());
514 void Layout::readAlign(Lexer & lexrc)
516 keyword_item alignTags[] = {
517 { "block", AT_BLOCK },
518 { "center", AT_CENTER },
519 { "layout", AT_LAYOUT },
521 { "right", AT_RIGHT }
524 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
525 int le = lexrc.lex();
527 case Lexer::LEX_UNDEF:
528 lexrc.printError("Unknown alignment `$$Token'");
532 switch (static_cast<AlignTags>(le)) {
534 align = LYX_ALIGN_BLOCK;
537 align = LYX_ALIGN_LEFT;
540 align = LYX_ALIGN_RIGHT;
543 align = LYX_ALIGN_CENTER;
546 align = LYX_ALIGN_LAYOUT;
552 void Layout::readAlignPossible(Lexer & lexrc)
554 keyword_item alignTags[] = {
555 { "block", AT_BLOCK },
556 { "center", AT_CENTER },
557 { "layout", AT_LAYOUT },
559 { "right", AT_RIGHT }
562 lexrc.pushTable(alignTags, AT_LAYOUT);
563 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
564 int lineno = lexrc.getLineNo();
566 int le = lexrc.lex();
568 case Lexer::LEX_UNDEF:
569 lexrc.printError("Unknown alignment `$$Token'");
573 switch (static_cast<AlignTags>(le)) {
575 alignpossible |= LYX_ALIGN_BLOCK;
578 alignpossible |= LYX_ALIGN_LEFT;
581 alignpossible |= LYX_ALIGN_RIGHT;
584 alignpossible |= LYX_ALIGN_CENTER;
587 alignpossible |= LYX_ALIGN_LAYOUT;
590 } while (lineno == lexrc.getLineNo());
599 LA_CENTERED_TOP_ENVIRONMENT,
609 void Layout::readLabelType(Lexer & lexrc)
611 keyword_item labelTypeTags[] = {
612 { "bibliography", LA_BIBLIO },
613 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
614 { "counter", LA_COUNTER },
615 { "enumerate", LA_ENUMERATE },
616 { "itemize", LA_ITEMIZE },
617 { "manual", LA_MANUAL },
618 { "no_label", LA_NO_LABEL },
619 { "sensitive", LA_SENSITIVE },
620 { "static", LA_STATIC },
621 { "top_environment", LA_TOP_ENVIRONMENT }
624 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
625 int le = lexrc.lex();
627 case Lexer::LEX_UNDEF:
628 lexrc.printError("Unknown labeltype tag `$$Token'");
632 switch (static_cast<LabelTypeTags>(le)) {
634 labeltype = LABEL_NO_LABEL;
637 labeltype = LABEL_MANUAL;
639 case LA_TOP_ENVIRONMENT:
640 labeltype = LABEL_TOP_ENVIRONMENT;
642 case LA_CENTERED_TOP_ENVIRONMENT:
643 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
646 labeltype = LABEL_STATIC;
649 labeltype = LABEL_SENSITIVE;
652 labeltype = LABEL_COUNTER;
655 labeltype = LABEL_ENUMERATE;
658 labeltype = LABEL_ITEMIZE;
661 labeltype = LABEL_BIBLIO;
667 static keyword_item endlabelTypeTags[] =
669 { "box", END_LABEL_BOX },
670 { "filled_box", END_LABEL_FILLED_BOX },
671 { "no_label", END_LABEL_NO_LABEL },
672 { "static", END_LABEL_STATIC }
676 void Layout::readEndLabelType(Lexer & lexrc)
678 PushPopHelper pph(lexrc, endlabelTypeTags,
679 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
680 int le = lexrc.lex();
682 case Lexer::LEX_UNDEF:
683 lexrc.printError("Unknown labeltype tag `$$Token'");
685 case END_LABEL_STATIC:
687 case END_LABEL_FILLED_BOX:
688 case END_LABEL_NO_LABEL:
689 endlabeltype = static_cast<EndLabelType>(le);
692 lyxerr << "Unhandled value " << le
693 << " in Layout::readEndLabelType." << endl;
699 void Layout::readMargin(Lexer & lexrc)
701 keyword_item marginTags[] = {
702 { "dynamic", MARGIN_DYNAMIC },
703 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
704 { "manual", MARGIN_MANUAL },
705 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
706 { "static", MARGIN_STATIC }
709 PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
711 int le = lexrc.lex();
713 case Lexer::LEX_UNDEF:
714 lexrc.printError("Unknown margin type tag `$$Token'");
719 case MARGIN_FIRST_DYNAMIC:
720 case MARGIN_RIGHT_ADDRESS_BOX:
721 margintype = static_cast<MarginType>(le);
724 lyxerr << "Unhandled value " << le
725 << " in Layout::readMargin." << endl;
731 void Layout::readLatexType(Lexer & lexrc)
733 keyword_item latexTypeTags[] = {
734 { "bib_environment", LATEX_BIB_ENVIRONMENT },
735 { "command", LATEX_COMMAND },
736 { "environment", LATEX_ENVIRONMENT },
737 { "item_environment", LATEX_ITEM_ENVIRONMENT },
738 { "list_environment", LATEX_LIST_ENVIRONMENT },
739 { "paragraph", LATEX_PARAGRAPH }
742 PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
743 int le = lexrc.lex();
745 case Lexer::LEX_UNDEF:
746 lexrc.printError("Unknown latextype tag `$$Token'");
748 case LATEX_PARAGRAPH:
750 case LATEX_ENVIRONMENT:
751 case LATEX_ITEM_ENVIRONMENT:
752 case LATEX_BIB_ENVIRONMENT:
753 case LATEX_LIST_ENVIRONMENT:
754 latextype = static_cast<LatexType>(le);
757 lyxerr << "Unhandled value " << le
758 << " in Layout::readLatexType." << endl;
765 ST_SPACING_SINGLE = 1,
772 void Layout::readSpacing(Lexer & lexrc)
774 keyword_item spacingTags[] = {
775 {"double", ST_SPACING_DOUBLE },
776 {"onehalf", ST_SPACING_ONEHALF },
777 {"other", ST_OTHER },
778 {"single", ST_SPACING_SINGLE }
781 PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
782 int le = lexrc.lex();
784 case Lexer::LEX_UNDEF:
785 lexrc.printError("Unknown spacing token `$$Token'");
789 switch (static_cast<SpacingTags>(le)) {
790 case ST_SPACING_SINGLE:
791 spacing.set(Spacing::Single);
793 case ST_SPACING_ONEHALF:
794 spacing.set(Spacing::Onehalf);
796 case ST_SPACING_DOUBLE:
797 spacing.set(Spacing::Double);
801 spacing.set(Spacing::Other, lexrc.getString());
807 docstring const & Layout::name() const
813 void Layout::setName(docstring const & name)
819 docstring const & Layout::obsoleted_by() const
821 return obsoleted_by_;
825 docstring const & Layout::depends_on() const
831 Layout * Layout::forCaption()
833 Layout * lay = new Layout();
834 lay->name_ = from_ascii("Caption");
835 lay->latexname_ = "caption";
836 lay->latextype = LATEX_COMMAND;
837 lay->optionalargs = 1;