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]
46 //LT_ENVIRONMENT_DEFAULT,
63 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 { "requires", LT_REQUIRES },
183 { "rightmargin", LT_RIGHTMARGIN },
184 { "spacing", LT_SPACING },
185 { "textfont", LT_TEXTFONT },
186 { "toclevel", LT_TOCLEVEL },
187 { "topsep", LT_TOPSEP }
191 bool finished = false;
192 lexrc.pushTable(layoutTags, LT_INTITLE);
193 // parse style section
194 while (!finished && lexrc.isOK() && !error) {
195 int le = lexrc.lex();
196 // See comment in LyXRC.cpp.
198 case Lexer::LEX_FEOF:
201 case Lexer::LEX_UNDEF: // parse error
202 lexrc.printError("Unknown layout tag `$$Token'");
207 switch (static_cast<LayoutTags>(le)) {
208 case LT_END: // end of structure
212 case LT_COPYSTYLE: // initialize with a known style
214 docstring const style = subst(lexrc.getDocString(),
217 if (tclass.hasLayout(style)) {
218 docstring const tmpname = name_;
219 this->operator=(*tclass[style]);
222 lyxerr << "Cannot copy unknown style `"
223 << to_utf8(style) << "'\n"
224 << "All layouts so far:"
226 TextClass::const_iterator it =
228 TextClass::const_iterator end =
230 for (; it != end; ++it) {
231 lyxerr << to_utf8((*it)->name())
235 //lexrc.printError("Cannot copy known "
236 // "style `$$Token'");
241 case LT_OBSOLETEDBY: // replace with a known style
243 docstring const style =
244 subst(lexrc.getDocString(), '_', ' ');
246 if (tclass.hasLayout(style)) {
247 docstring const tmpname = name_;
248 this->operator=(*tclass[style]);
250 if (obsoleted_by().empty())
251 obsoleted_by_ = style;
253 lyxerr << "Cannot replace with unknown style `"
254 << to_utf8(style) << '\'' << endl;
256 //lexrc.printError("Cannot replace with"
265 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
268 case LT_MARGIN: // margin style definition.
272 case LT_LATEXTYPE: // LaTeX style definition.
273 readLatexType(lexrc);
276 case LT_LATEXHEADER: // header for environments
278 latexheader = lexrc.getString();
281 case LT_LATEXFOOTER: // footer for environments
283 latexfooter = lexrc.getString();
286 case LT_LATEXPARAGRAPH:
288 latexparagraph = lexrc.getString();
292 intitle = lexrc.next() && lexrc.getInteger();
297 toclevel = lexrc.getInteger();
302 optionalargs = lexrc.getInteger();
305 case LT_NEED_PROTECT:
306 needprotect = lexrc.next() && lexrc.getInteger();
310 keepempty = lexrc.next() && lexrc.getInteger();
314 font = lyxRead(lexrc, font);
319 font = lyxRead(lexrc, font);
323 labelfont = lyxRead(lexrc, labelfont);
326 case LT_NEXTNOINDENT: // Indent next paragraph?
327 if (lexrc.next() && lexrc.getInteger())
330 nextnoindent = false;
333 case LT_COMMANDDEPTH:
335 commanddepth = lexrc.getInteger();
340 latexname_ = lexrc.getString();
345 latexparam_ = subst(lexrc.getString(), """, "\"");
350 innertag_ = lexrc.getString();
355 labeltag_ = lexrc.getString();
360 itemtag_ = lexrc.getString();
364 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
368 readLabelType(lexrc);
371 case LT_ENDLABELTYPE:
372 readEndLabelType(lexrc);
375 case LT_LEFTMARGIN: // left margin type
377 leftmargin = lexrc.getDocString();
380 case LT_RIGHTMARGIN: // right margin type
382 rightmargin = lexrc.getDocString();
385 case LT_LABELINDENT: // label indenting flag
387 labelindent = lexrc.getDocString();
390 case LT_PARINDENT: // paragraph indent. flag
392 parindent = lexrc.getDocString();
395 case LT_PARSKIP: // paragraph skip size
397 parskip = lexrc.getFloat();
400 case LT_ITEMSEP: // item separation size
402 itemsep = lexrc.getFloat();
405 case LT_TOPSEP: // top separation size
407 topsep = lexrc.getFloat();
410 case LT_BOTTOMSEP: // bottom separation size
412 bottomsep = lexrc.getFloat();
415 case LT_LABEL_BOTTOMSEP: // label bottom separation size
417 labelbottomsep = lexrc.getFloat();
420 case LT_LABELSEP: // label separator
422 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
426 case LT_PARSEP: // par. separation size
428 parsep = lexrc.getFloat();
431 case LT_FILL_TOP: // fill top flag
433 fill_top = lexrc.getInteger();
436 case LT_FILL_BOTTOM: // fill bottom flag
438 fill_bottom = lexrc.getInteger();
441 case LT_NEWLINE: // newlines allowed?
443 newline_allowed = lexrc.getInteger();
446 case LT_ALIGN: // paragraph align
449 case LT_ALIGNPOSSIBLE: // paragraph allowed align
450 readAlignPossible(lexrc);
453 case LT_LABELSTRING: // label string definition
455 labelstring_ = trim(lexrc.getDocString());
456 labelstring_appendix_ = labelstring_;
460 case LT_ENDLABELSTRING: // endlabel string definition
462 endlabelstring_ = trim(lexrc.getDocString());
465 case LT_LABELSTRING_APPENDIX: // label string appendix definition
467 labelstring_appendix_ = trim(lexrc.getDocString());
470 case LT_LABELCOUNTER: // name of counter to use
472 counter = lyx::from_ascii(trim(lexrc.getString()));
475 case LT_FREE_SPACING: // Allow for free spacing.
477 free_spacing = lexrc.getInteger();
480 case LT_PASS_THRU: // Allow for pass thru.
482 pass_thru = lexrc.getInteger();
485 case LT_SPACING: // setspace.sty
491 vector<string> const req =
492 getVectorFromString(lexrc.getString());
493 requires_.insert(req.begin(), req.end());
513 void Layout::readAlign(Lexer & lexrc)
515 keyword_item alignTags[] = {
516 { "block", AT_BLOCK },
517 { "center", AT_CENTER },
518 { "layout", AT_LAYOUT },
520 { "right", AT_RIGHT }
523 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
524 int le = lexrc.lex();
526 case Lexer::LEX_UNDEF:
527 lexrc.printError("Unknown alignment `$$Token'");
531 switch (static_cast<AlignTags>(le)) {
533 align = LYX_ALIGN_BLOCK;
536 align = LYX_ALIGN_LEFT;
539 align = LYX_ALIGN_RIGHT;
542 align = LYX_ALIGN_CENTER;
545 align = LYX_ALIGN_LAYOUT;
551 void Layout::readAlignPossible(Lexer & lexrc)
553 keyword_item alignTags[] = {
554 { "block", AT_BLOCK },
555 { "center", AT_CENTER },
556 { "layout", AT_LAYOUT },
558 { "right", AT_RIGHT }
561 lexrc.pushTable(alignTags, AT_LAYOUT);
562 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
563 int lineno = lexrc.getLineNo();
565 int le = lexrc.lex();
567 case Lexer::LEX_UNDEF:
568 lexrc.printError("Unknown alignment `$$Token'");
572 switch (static_cast<AlignTags>(le)) {
574 alignpossible |= LYX_ALIGN_BLOCK;
577 alignpossible |= LYX_ALIGN_LEFT;
580 alignpossible |= LYX_ALIGN_RIGHT;
583 alignpossible |= LYX_ALIGN_CENTER;
586 alignpossible |= LYX_ALIGN_LAYOUT;
589 } while (lineno == lexrc.getLineNo());
598 LA_CENTERED_TOP_ENVIRONMENT,
608 void Layout::readLabelType(Lexer & lexrc)
610 keyword_item labelTypeTags[] = {
611 { "bibliography", LA_BIBLIO },
612 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
613 { "counter", LA_COUNTER },
614 { "enumerate", LA_ENUMERATE },
615 { "itemize", LA_ITEMIZE },
616 { "manual", LA_MANUAL },
617 { "no_label", LA_NO_LABEL },
618 { "sensitive", LA_SENSITIVE },
619 { "static", LA_STATIC },
620 { "top_environment", LA_TOP_ENVIRONMENT }
623 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
624 int le = lexrc.lex();
626 case Lexer::LEX_UNDEF:
627 lexrc.printError("Unknown labeltype tag `$$Token'");
631 switch (static_cast<LabelTypeTags>(le)) {
633 labeltype = LABEL_NO_LABEL;
636 labeltype = LABEL_MANUAL;
638 case LA_TOP_ENVIRONMENT:
639 labeltype = LABEL_TOP_ENVIRONMENT;
641 case LA_CENTERED_TOP_ENVIRONMENT:
642 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
645 labeltype = LABEL_STATIC;
648 labeltype = LABEL_SENSITIVE;
651 labeltype = LABEL_COUNTER;
654 labeltype = LABEL_ENUMERATE;
657 labeltype = LABEL_ITEMIZE;
660 labeltype = LABEL_BIBLIO;
666 static keyword_item endlabelTypeTags[] =
668 { "box", END_LABEL_BOX },
669 { "filled_box", END_LABEL_FILLED_BOX },
670 { "no_label", END_LABEL_NO_LABEL },
671 { "static", END_LABEL_STATIC }
675 void Layout::readEndLabelType(Lexer & lexrc)
677 PushPopHelper pph(lexrc, endlabelTypeTags,
678 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
679 int le = lexrc.lex();
681 case Lexer::LEX_UNDEF:
682 lexrc.printError("Unknown labeltype tag `$$Token'");
684 case END_LABEL_STATIC:
686 case END_LABEL_FILLED_BOX:
687 case END_LABEL_NO_LABEL:
688 endlabeltype = static_cast<EndLabelType>(le);
691 lyxerr << "Unhandled value " << le
692 << " in Layout::readEndLabelType." << endl;
698 void Layout::readMargin(Lexer & lexrc)
700 keyword_item marginTags[] = {
701 { "dynamic", MARGIN_DYNAMIC },
702 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
703 { "manual", MARGIN_MANUAL },
704 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
705 { "static", MARGIN_STATIC }
708 PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
710 int le = lexrc.lex();
712 case Lexer::LEX_UNDEF:
713 lexrc.printError("Unknown margin type tag `$$Token'");
718 case MARGIN_FIRST_DYNAMIC:
719 case MARGIN_RIGHT_ADDRESS_BOX:
720 margintype = static_cast<MarginType>(le);
723 lyxerr << "Unhandled value " << le
724 << " in Layout::readMargin." << endl;
730 void Layout::readLatexType(Lexer & lexrc)
732 keyword_item latexTypeTags[] = {
733 { "bib_environment", LATEX_BIB_ENVIRONMENT },
734 { "command", LATEX_COMMAND },
735 { "environment", LATEX_ENVIRONMENT },
736 { "item_environment", LATEX_ITEM_ENVIRONMENT },
737 { "list_environment", LATEX_LIST_ENVIRONMENT },
738 { "paragraph", LATEX_PARAGRAPH }
741 PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
742 int le = lexrc.lex();
744 case Lexer::LEX_UNDEF:
745 lexrc.printError("Unknown latextype tag `$$Token'");
747 case LATEX_PARAGRAPH:
749 case LATEX_ENVIRONMENT:
750 case LATEX_ITEM_ENVIRONMENT:
751 case LATEX_BIB_ENVIRONMENT:
752 case LATEX_LIST_ENVIRONMENT:
753 latextype = static_cast<LatexType>(le);
756 lyxerr << "Unhandled value " << le
757 << " in Layout::readLatexType." << endl;
764 ST_SPACING_SINGLE = 1,
771 void Layout::readSpacing(Lexer & lexrc)
773 keyword_item spacingTags[] = {
774 {"double", ST_SPACING_DOUBLE },
775 {"onehalf", ST_SPACING_ONEHALF },
776 {"other", ST_OTHER },
777 {"single", ST_SPACING_SINGLE }
780 PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
781 int le = lexrc.lex();
783 case Lexer::LEX_UNDEF:
784 lexrc.printError("Unknown spacing token `$$Token'");
788 switch (static_cast<SpacingTags>(le)) {
789 case ST_SPACING_SINGLE:
790 spacing.set(Spacing::Single);
792 case ST_SPACING_ONEHALF:
793 spacing.set(Spacing::Onehalf);
795 case ST_SPACING_DOUBLE:
796 spacing.set(Spacing::Double);
800 spacing.set(Spacing::Other, lexrc.getString());
806 docstring const & Layout::name() const
812 void Layout::setName(docstring const & name)
818 docstring const & Layout::obsoleted_by() const
820 return obsoleted_by_;
824 docstring const & Layout::depends_on() const
830 Layout * Layout::forCaption()
832 Layout * lay = new Layout();
833 lay->name_ = from_ascii("Caption");
834 lay->latexname_ = "caption";
835 lay->latextype = LATEX_COMMAND;
836 lay->optionalargs = 1;