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 & 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 { "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 lexrc.pushTable(layoutTags, LT_INTITLE);
195 // parse style section
196 while (!finished && lexrc.isOK() && !error) {
197 int le = lexrc.lex();
198 // See comment in LyXRC.cpp.
200 case Lexer::LEX_FEOF:
203 case Lexer::LEX_UNDEF: // parse error
204 lexrc.printError("Unknown layout tag `$$Token'");
209 switch (static_cast<LayoutTags>(le)) {
210 case LT_END: // end of structure
216 category_ = lexrc.getDocString();
219 case LT_COPYSTYLE: // initialize with a known style
221 docstring const style = subst(lexrc.getDocString(),
224 if (tclass.hasLayout(style)) {
225 docstring const tmpname = name_;
226 this->operator=(tclass[style]);
229 lyxerr << "Cannot copy unknown style `"
230 << to_utf8(style) << "'\n"
231 << "All layouts so far:"
233 DocumentClass::const_iterator lit = tclass.begin();
234 DocumentClass::const_iterator len = tclass.end();
235 for (; lit != len; ++lit)
236 lyxerr << to_utf8(lit->name()) << endl;
238 //lexrc.printError("Cannot copy known "
239 // "style `$$Token'");
244 case LT_OBSOLETEDBY: // replace with a known style
246 docstring const style =
247 subst(lexrc.getDocString(), '_', ' ');
249 if (tclass.hasLayout(style)) {
250 docstring const tmpname = name_;
251 this->operator=(tclass[style]);
253 if (obsoleted_by().empty())
254 obsoleted_by_ = style;
256 lyxerr << "Cannot replace with unknown style `"
257 << to_utf8(style) << '\'' << endl;
259 //lexrc.printError("Cannot replace with"
268 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
271 case LT_MARGIN: // margin style definition.
275 case LT_LATEXTYPE: // LaTeX style definition.
276 readLatexType(lexrc);
279 case LT_LATEXHEADER: // header for environments
281 latexheader = lexrc.getString();
284 case LT_LATEXFOOTER: // footer for environments
286 latexfooter = lexrc.getString();
289 case LT_LATEXPARAGRAPH:
291 latexparagraph = lexrc.getString();
295 intitle = lexrc.next() && lexrc.getInteger();
300 toclevel = lexrc.getInteger();
305 optionalargs = lexrc.getInteger();
308 case LT_NEED_PROTECT:
309 needprotect = lexrc.next() && lexrc.getInteger();
313 keepempty = lexrc.next() && lexrc.getInteger();
317 font = lyxRead(lexrc, font);
322 font = lyxRead(lexrc, font);
326 labelfont = lyxRead(lexrc, labelfont);
329 case LT_NEXTNOINDENT: // Indent next paragraph?
330 if (lexrc.next() && lexrc.getInteger())
333 nextnoindent = false;
336 case LT_COMMANDDEPTH:
338 commanddepth = lexrc.getInteger();
343 latexname_ = lexrc.getString();
348 latexparam_ = subst(lexrc.getString(), """, "\"");
353 innertag_ = lexrc.getString();
358 labeltag_ = lexrc.getString();
363 itemtag_ = lexrc.getString();
367 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
371 readLabelType(lexrc);
374 case LT_ENDLABELTYPE:
375 readEndLabelType(lexrc);
378 case LT_LEFTMARGIN: // left margin type
380 leftmargin = lexrc.getDocString();
383 case LT_RIGHTMARGIN: // right margin type
385 rightmargin = lexrc.getDocString();
388 case LT_LABELINDENT: // label indenting flag
390 labelindent = lexrc.getDocString();
393 case LT_PARINDENT: // paragraph indent. flag
395 parindent = lexrc.getDocString();
398 case LT_PARSKIP: // paragraph skip size
400 parskip = lexrc.getFloat();
403 case LT_ITEMSEP: // item separation size
405 itemsep = lexrc.getFloat();
408 case LT_TOPSEP: // top separation size
410 topsep = lexrc.getFloat();
413 case LT_BOTTOMSEP: // bottom separation size
415 bottomsep = lexrc.getFloat();
418 case LT_LABEL_BOTTOMSEP: // label bottom separation size
420 labelbottomsep = lexrc.getFloat();
423 case LT_LABELSEP: // label separator
425 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
429 case LT_PARSEP: // par. separation size
431 parsep = lexrc.getFloat();
434 case LT_FILL_TOP: // fill top flag
436 fill_top = lexrc.getInteger();
439 case LT_FILL_BOTTOM: // fill bottom flag
441 fill_bottom = lexrc.getInteger();
444 case LT_NEWLINE: // newlines allowed?
446 newline_allowed = lexrc.getInteger();
449 case LT_ALIGN: // paragraph align
452 case LT_ALIGNPOSSIBLE: // paragraph allowed align
453 readAlignPossible(lexrc);
456 case LT_LABELSTRING: // label string definition
458 labelstring_ = trim(lexrc.getDocString());
459 labelstring_appendix_ = labelstring_;
463 case LT_ENDLABELSTRING: // endlabel string definition
465 endlabelstring_ = trim(lexrc.getDocString());
468 case LT_LABELSTRING_APPENDIX: // label string appendix definition
470 labelstring_appendix_ = trim(lexrc.getDocString());
473 case LT_LABELCOUNTER: // name of counter to use
475 counter = lyx::from_ascii(trim(lexrc.getString()));
478 case LT_FREE_SPACING: // Allow for free spacing.
480 free_spacing = lexrc.getInteger();
483 case LT_PASS_THRU: // Allow for pass thru.
485 pass_thru = lexrc.getInteger();
488 case LT_SPACING: // setspace.sty
494 vector<string> const req =
495 getVectorFromString(lexrc.getString());
496 requires_.insert(req.begin(), req.end());
516 void Layout::readAlign(Lexer & lexrc)
518 keyword_item alignTags[] = {
519 { "block", AT_BLOCK },
520 { "center", AT_CENTER },
521 { "layout", AT_LAYOUT },
523 { "right", AT_RIGHT }
526 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
527 int le = lexrc.lex();
529 case Lexer::LEX_UNDEF:
530 lexrc.printError("Unknown alignment `$$Token'");
534 switch (static_cast<AlignTags>(le)) {
536 align = LYX_ALIGN_BLOCK;
539 align = LYX_ALIGN_LEFT;
542 align = LYX_ALIGN_RIGHT;
545 align = LYX_ALIGN_CENTER;
548 align = LYX_ALIGN_LAYOUT;
554 void Layout::readAlignPossible(Lexer & lexrc)
556 keyword_item alignTags[] = {
557 { "block", AT_BLOCK },
558 { "center", AT_CENTER },
559 { "layout", AT_LAYOUT },
561 { "right", AT_RIGHT }
564 lexrc.pushTable(alignTags, AT_LAYOUT);
565 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
566 int lineno = lexrc.getLineNo();
568 int le = lexrc.lex();
570 case Lexer::LEX_UNDEF:
571 lexrc.printError("Unknown alignment `$$Token'");
575 switch (static_cast<AlignTags>(le)) {
577 alignpossible |= LYX_ALIGN_BLOCK;
580 alignpossible |= LYX_ALIGN_LEFT;
583 alignpossible |= LYX_ALIGN_RIGHT;
586 alignpossible |= LYX_ALIGN_CENTER;
589 alignpossible |= LYX_ALIGN_LAYOUT;
592 } while (lineno == lexrc.getLineNo());
601 LA_CENTERED_TOP_ENVIRONMENT,
611 void Layout::readLabelType(Lexer & lexrc)
613 keyword_item labelTypeTags[] = {
614 { "bibliography", LA_BIBLIO },
615 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
616 { "counter", LA_COUNTER },
617 { "enumerate", LA_ENUMERATE },
618 { "itemize", LA_ITEMIZE },
619 { "manual", LA_MANUAL },
620 { "no_label", LA_NO_LABEL },
621 { "sensitive", LA_SENSITIVE },
622 { "static", LA_STATIC },
623 { "top_environment", LA_TOP_ENVIRONMENT }
626 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
627 int le = lexrc.lex();
629 case Lexer::LEX_UNDEF:
630 lexrc.printError("Unknown labeltype tag `$$Token'");
634 switch (static_cast<LabelTypeTags>(le)) {
636 labeltype = LABEL_NO_LABEL;
639 labeltype = LABEL_MANUAL;
641 case LA_TOP_ENVIRONMENT:
642 labeltype = LABEL_TOP_ENVIRONMENT;
644 case LA_CENTERED_TOP_ENVIRONMENT:
645 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
648 labeltype = LABEL_STATIC;
651 labeltype = LABEL_SENSITIVE;
654 labeltype = LABEL_COUNTER;
657 labeltype = LABEL_ENUMERATE;
660 labeltype = LABEL_ITEMIZE;
663 labeltype = LABEL_BIBLIO;
669 static keyword_item endlabelTypeTags[] =
671 { "box", END_LABEL_BOX },
672 { "filled_box", END_LABEL_FILLED_BOX },
673 { "no_label", END_LABEL_NO_LABEL },
674 { "static", END_LABEL_STATIC }
678 void Layout::readEndLabelType(Lexer & lexrc)
680 PushPopHelper pph(lexrc, endlabelTypeTags,
681 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
682 int le = lexrc.lex();
684 case Lexer::LEX_UNDEF:
685 lexrc.printError("Unknown labeltype tag `$$Token'");
687 case END_LABEL_STATIC:
689 case END_LABEL_FILLED_BOX:
690 case END_LABEL_NO_LABEL:
691 endlabeltype = static_cast<EndLabelType>(le);
694 lyxerr << "Unhandled value " << le
695 << " in Layout::readEndLabelType." << endl;
701 void Layout::readMargin(Lexer & lexrc)
703 keyword_item marginTags[] = {
704 { "dynamic", MARGIN_DYNAMIC },
705 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
706 { "manual", MARGIN_MANUAL },
707 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
708 { "static", MARGIN_STATIC }
711 PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
713 int le = lexrc.lex();
715 case Lexer::LEX_UNDEF:
716 lexrc.printError("Unknown margin type tag `$$Token'");
721 case MARGIN_FIRST_DYNAMIC:
722 case MARGIN_RIGHT_ADDRESS_BOX:
723 margintype = static_cast<MarginType>(le);
726 lyxerr << "Unhandled value " << le
727 << " in Layout::readMargin." << endl;
733 void Layout::readLatexType(Lexer & lexrc)
735 keyword_item latexTypeTags[] = {
736 { "bib_environment", LATEX_BIB_ENVIRONMENT },
737 { "command", LATEX_COMMAND },
738 { "environment", LATEX_ENVIRONMENT },
739 { "item_environment", LATEX_ITEM_ENVIRONMENT },
740 { "list_environment", LATEX_LIST_ENVIRONMENT },
741 { "paragraph", LATEX_PARAGRAPH }
744 PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
745 int le = lexrc.lex();
747 case Lexer::LEX_UNDEF:
748 lexrc.printError("Unknown latextype tag `$$Token'");
750 case LATEX_PARAGRAPH:
752 case LATEX_ENVIRONMENT:
753 case LATEX_ITEM_ENVIRONMENT:
754 case LATEX_BIB_ENVIRONMENT:
755 case LATEX_LIST_ENVIRONMENT:
756 latextype = static_cast<LatexType>(le);
759 lyxerr << "Unhandled value " << le
760 << " in Layout::readLatexType." << endl;
767 ST_SPACING_SINGLE = 1,
774 void Layout::readSpacing(Lexer & lexrc)
776 keyword_item spacingTags[] = {
777 {"double", ST_SPACING_DOUBLE },
778 {"onehalf", ST_SPACING_ONEHALF },
779 {"other", ST_OTHER },
780 {"single", ST_SPACING_SINGLE }
783 PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
784 int le = lexrc.lex();
786 case Lexer::LEX_UNDEF:
787 lexrc.printError("Unknown spacing token `$$Token'");
791 switch (static_cast<SpacingTags>(le)) {
792 case ST_SPACING_SINGLE:
793 spacing.set(Spacing::Single);
795 case ST_SPACING_ONEHALF:
796 spacing.set(Spacing::Onehalf);
798 case ST_SPACING_DOUBLE:
799 spacing.set(Spacing::Double);
803 spacing.set(Spacing::Other, lexrc.getString());
809 docstring const & Layout::name() const
815 void Layout::setName(docstring const & name)
821 docstring const & Layout::obsoleted_by() const
823 return obsoleted_by_;
827 docstring const & Layout::depends_on() const
833 bool Layout::operator==(Layout const & rhs) const
835 // This is enough for the applications we actually make,
836 // at least at the moment. But we could check more.
837 return name() == rhs.name()
838 && latexname() == rhs.latexname()
839 && latextype == rhs.latextype;
843 Layout * Layout::forCaption()
845 Layout * lay = new Layout();
846 lay->name_ = from_ascii("Caption");
847 lay->latexname_ = "caption";
848 lay->latextype = LATEX_COMMAND;
849 lay->optionalargs = 1;