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,
92 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 is_environment = false;
128 toclevel = NOT_IN_TOC;
133 bool Layout::read(Lexer & lexrc, TextClass const & tclass)
135 // This table is sorted alphabetically [asierra 30March96]
136 keyword_item layoutTags[] = {
137 { "align", LT_ALIGN },
138 { "alignpossible", LT_ALIGNPOSSIBLE },
139 { "bottomsep", LT_BOTTOMSEP },
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 { "rightmargin", LT_RIGHTMARGIN },
183 { "spacing", LT_SPACING },
184 { "textfont", LT_TEXTFONT },
185 { "toclevel", LT_TOCLEVEL },
186 { "topsep", LT_TOPSEP }
190 bool finished = false;
191 lexrc.pushTable(layoutTags, LT_INTITLE);
192 // parse style section
193 while (!finished && lexrc.isOK() && !error) {
194 int le = lexrc.lex();
195 // See comment in LyXRC.cpp.
197 case Lexer::LEX_FEOF:
200 case Lexer::LEX_UNDEF: // parse error
201 lexrc.printError("Unknown layout tag `$$Token'");
206 switch (static_cast<LayoutTags>(le)) {
207 case LT_END: // end of structure
211 case LT_COPYSTYLE: // initialize with a known style
213 docstring const style = subst(lexrc.getDocString(),
216 if (tclass.hasLayout(style)) {
217 docstring const tmpname = name_;
218 this->operator=(*tclass[style]);
221 lyxerr << "Cannot copy unknown style `"
222 << to_utf8(style) << "'\n"
223 << "All layouts so far:"
225 TextClass::const_iterator it =
227 TextClass::const_iterator end =
229 for (; it != end; ++it) {
230 lyxerr << to_utf8((*it)->name())
234 //lexrc.printError("Cannot copy known "
235 // "style `$$Token'");
240 case LT_OBSOLETEDBY: // replace with a known style
242 docstring const style =
243 subst(lexrc.getDocString(), '_', ' ');
245 if (tclass.hasLayout(style)) {
246 docstring const tmpname = name_;
247 this->operator=(*tclass[style]);
249 if (obsoleted_by().empty())
250 obsoleted_by_ = style;
252 lyxerr << "Cannot replace with unknown style `"
253 << to_utf8(style) << '\'' << endl;
255 //lexrc.printError("Cannot replace with"
264 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
267 case LT_MARGIN: // margin style definition.
271 case LT_LATEXTYPE: // LaTeX style definition.
272 readLatexType(lexrc);
275 case LT_LATEXHEADER: // header for environments
277 latexheader = lexrc.getString();
280 case LT_LATEXFOOTER: // footer for environments
282 latexfooter = lexrc.getString();
285 case LT_LATEXPARAGRAPH:
287 latexparagraph = lexrc.getString();
291 intitle = lexrc.next() && lexrc.getInteger();
296 toclevel = lexrc.getInteger();
301 optionalargs = lexrc.getInteger();
304 case LT_NEED_PROTECT:
305 needprotect = lexrc.next() && lexrc.getInteger();
309 keepempty = lexrc.next() && lexrc.getInteger();
313 font = lyxRead(lexrc, font);
318 font = lyxRead(lexrc, font);
322 labelfont = lyxRead(lexrc, labelfont);
325 case LT_NEXTNOINDENT: // Indent next paragraph?
326 if (lexrc.next() && lexrc.getInteger())
329 nextnoindent = false;
332 case LT_COMMANDDEPTH:
334 commanddepth = lexrc.getInteger();
339 latexname_ = lexrc.getString();
344 latexparam_ = subst(lexrc.getString(), """, "\"");
349 innertag_ = lexrc.getString();
354 labeltag_ = lexrc.getString();
359 itemtag_ = lexrc.getString();
363 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
367 readLabelType(lexrc);
370 case LT_ENDLABELTYPE:
371 readEndLabelType(lexrc);
374 case LT_LEFTMARGIN: // left margin type
376 leftmargin = lexrc.getDocString();
379 case LT_RIGHTMARGIN: // right margin type
381 rightmargin = lexrc.getDocString();
384 case LT_LABELINDENT: // label indenting flag
386 labelindent = lexrc.getDocString();
389 case LT_PARINDENT: // paragraph indent. flag
391 parindent = lexrc.getDocString();
394 case LT_PARSKIP: // paragraph skip size
396 parskip = lexrc.getFloat();
399 case LT_ITEMSEP: // item separation size
401 itemsep = lexrc.getFloat();
404 case LT_TOPSEP: // top separation size
406 topsep = lexrc.getFloat();
409 case LT_BOTTOMSEP: // bottom separation size
411 bottomsep = lexrc.getFloat();
414 case LT_LABEL_BOTTOMSEP: // label bottom separation size
416 labelbottomsep = lexrc.getFloat();
419 case LT_LABELSEP: // label separator
421 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
425 case LT_PARSEP: // par. separation size
427 parsep = lexrc.getFloat();
430 case LT_FILL_TOP: // fill top flag
432 fill_top = lexrc.getInteger();
435 case LT_FILL_BOTTOM: // fill bottom flag
437 fill_bottom = lexrc.getInteger();
440 case LT_NEWLINE: // newlines allowed?
442 newline_allowed = lexrc.getInteger();
445 case LT_ALIGN: // paragraph align
448 case LT_ALIGNPOSSIBLE: // paragraph allowed align
449 readAlignPossible(lexrc);
452 case LT_LABELSTRING: // label string definition
454 labelstring_ = trim(lexrc.getDocString());
455 labelstring_appendix_ = labelstring_;
459 case LT_ENDLABELSTRING: // endlabel string definition
461 endlabelstring_ = trim(lexrc.getDocString());
464 case LT_LABELSTRING_APPENDIX: // label string appendix definition
466 labelstring_appendix_ = trim(lexrc.getDocString());
469 case LT_LABELCOUNTER: // name of counter to use
471 counter = lyx::from_ascii(trim(lexrc.getString()));
474 case LT_FREE_SPACING: // Allow for free spacing.
476 free_spacing = lexrc.getInteger();
479 case LT_PASS_THRU: // Allow for pass thru.
481 pass_thru = lexrc.getInteger();
484 case LT_SPACING: // setspace.sty
504 void Layout::readAlign(Lexer & lexrc)
506 keyword_item alignTags[] = {
507 { "block", AT_BLOCK },
508 { "center", AT_CENTER },
509 { "layout", AT_LAYOUT },
511 { "right", AT_RIGHT }
514 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
515 int le = lexrc.lex();
517 case Lexer::LEX_UNDEF:
518 lexrc.printError("Unknown alignment `$$Token'");
522 switch (static_cast<AlignTags>(le)) {
524 align = LYX_ALIGN_BLOCK;
527 align = LYX_ALIGN_LEFT;
530 align = LYX_ALIGN_RIGHT;
533 align = LYX_ALIGN_CENTER;
536 align = LYX_ALIGN_LAYOUT;
542 void Layout::readAlignPossible(Lexer & lexrc)
544 keyword_item alignTags[] = {
545 { "block", AT_BLOCK },
546 { "center", AT_CENTER },
547 { "layout", AT_LAYOUT },
549 { "right", AT_RIGHT }
552 lexrc.pushTable(alignTags, AT_LAYOUT);
553 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
554 int lineno = lexrc.getLineNo();
556 int le = lexrc.lex();
558 case Lexer::LEX_UNDEF:
559 lexrc.printError("Unknown alignment `$$Token'");
563 switch (static_cast<AlignTags>(le)) {
565 alignpossible |= LYX_ALIGN_BLOCK;
568 alignpossible |= LYX_ALIGN_LEFT;
571 alignpossible |= LYX_ALIGN_RIGHT;
574 alignpossible |= LYX_ALIGN_CENTER;
577 alignpossible |= LYX_ALIGN_LAYOUT;
580 } while (lineno == lexrc.getLineNo());
589 LA_CENTERED_TOP_ENVIRONMENT,
599 void Layout::readLabelType(Lexer & lexrc)
601 keyword_item labelTypeTags[] = {
602 { "bibliography", LA_BIBLIO },
603 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
604 { "counter", LA_COUNTER },
605 { "enumerate", LA_ENUMERATE },
606 { "itemize", LA_ITEMIZE },
607 { "manual", LA_MANUAL },
608 { "no_label", LA_NO_LABEL },
609 { "sensitive", LA_SENSITIVE },
610 { "static", LA_STATIC },
611 { "top_environment", LA_TOP_ENVIRONMENT }
614 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
615 int le = lexrc.lex();
617 case Lexer::LEX_UNDEF:
618 lexrc.printError("Unknown labeltype tag `$$Token'");
622 switch (static_cast<LabelTypeTags>(le)) {
624 labeltype = LABEL_NO_LABEL;
627 labeltype = LABEL_MANUAL;
629 case LA_TOP_ENVIRONMENT:
630 labeltype = LABEL_TOP_ENVIRONMENT;
632 case LA_CENTERED_TOP_ENVIRONMENT:
633 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
636 labeltype = LABEL_STATIC;
639 labeltype = LABEL_SENSITIVE;
642 labeltype = LABEL_COUNTER;
645 labeltype = LABEL_ENUMERATE;
648 labeltype = LABEL_ITEMIZE;
651 labeltype = LABEL_BIBLIO;
657 static keyword_item endlabelTypeTags[] =
659 { "box", END_LABEL_BOX },
660 { "filled_box", END_LABEL_FILLED_BOX },
661 { "no_label", END_LABEL_NO_LABEL },
662 { "static", END_LABEL_STATIC }
666 void Layout::readEndLabelType(Lexer & lexrc)
668 PushPopHelper pph(lexrc, endlabelTypeTags,
669 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
670 int le = lexrc.lex();
672 case Lexer::LEX_UNDEF:
673 lexrc.printError("Unknown labeltype tag `$$Token'");
675 case END_LABEL_STATIC:
677 case END_LABEL_FILLED_BOX:
678 case END_LABEL_NO_LABEL:
679 endlabeltype = static_cast<EndLabelType>(le);
682 lyxerr << "Unhandled value " << le
683 << " in Layout::readEndLabelType." << endl;
689 void Layout::readMargin(Lexer & lexrc)
691 keyword_item marginTags[] = {
692 { "dynamic", MARGIN_DYNAMIC },
693 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
694 { "manual", MARGIN_MANUAL },
695 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
696 { "static", MARGIN_STATIC }
699 PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
701 int le = lexrc.lex();
703 case Lexer::LEX_UNDEF:
704 lexrc.printError("Unknown margin type tag `$$Token'");
709 case MARGIN_FIRST_DYNAMIC:
710 case MARGIN_RIGHT_ADDRESS_BOX:
711 margintype = static_cast<MarginType>(le);
714 lyxerr << "Unhandled value " << le
715 << " in Layout::readMargin." << endl;
721 void Layout::readLatexType(Lexer & lexrc)
723 keyword_item latexTypeTags[] = {
724 { "bib_environment", LATEX_BIB_ENVIRONMENT },
725 { "command", LATEX_COMMAND },
726 { "environment", LATEX_ENVIRONMENT },
727 { "item_environment", LATEX_ITEM_ENVIRONMENT },
728 { "list_environment", LATEX_LIST_ENVIRONMENT },
729 { "paragraph", LATEX_PARAGRAPH }
732 PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
733 int le = lexrc.lex();
735 case Lexer::LEX_UNDEF:
736 lexrc.printError("Unknown latextype tag `$$Token'");
738 case LATEX_PARAGRAPH:
740 case LATEX_ENVIRONMENT:
741 case LATEX_ITEM_ENVIRONMENT:
742 case LATEX_BIB_ENVIRONMENT:
743 case LATEX_LIST_ENVIRONMENT:
744 latextype = static_cast<LatexType>(le);
747 lyxerr << "Unhandled value " << le
748 << " in Layout::readLatexType." << endl;
755 ST_SPACING_SINGLE = 1,
762 void Layout::readSpacing(Lexer & lexrc)
764 keyword_item spacingTags[] = {
765 {"double", ST_SPACING_DOUBLE },
766 {"onehalf", ST_SPACING_ONEHALF },
767 {"other", ST_OTHER },
768 {"single", ST_SPACING_SINGLE }
771 PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
772 int le = lexrc.lex();
774 case Lexer::LEX_UNDEF:
775 lexrc.printError("Unknown spacing token `$$Token'");
779 switch (static_cast<SpacingTags>(le)) {
780 case ST_SPACING_SINGLE:
781 spacing.set(Spacing::Single);
783 case ST_SPACING_ONEHALF:
784 spacing.set(Spacing::Onehalf);
786 case ST_SPACING_DOUBLE:
787 spacing.set(Spacing::Double);
791 spacing.set(Spacing::Other, lexrc.getString());
797 docstring const & Layout::name() const
803 void Layout::setName(docstring const & name)
809 docstring const & Layout::obsoleted_by() const
811 return obsoleted_by_;
815 docstring const & Layout::depends_on() const
821 Layout * Layout::forCaption()
823 Layout * lay = new Layout();
824 lay->name_ = from_ascii("Caption");
825 lay->latexname_ = "caption";
826 lay->latextype = LATEX_COMMAND;
827 lay->optionalargs = 1;