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_ = lowercase(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 for (size_t i = 0; i != tclass.layoutCount(); ++i)
234 lyxerr << to_utf8(tclass.layout(i)->name())
237 //lexrc.printError("Cannot copy known "
238 // "style `$$Token'");
243 case LT_OBSOLETEDBY: // replace with a known style
245 docstring const style =
246 subst(lexrc.getDocString(), '_', ' ');
248 if (tclass.hasLayout(style)) {
249 docstring const tmpname = name_;
250 this->operator=(*tclass[style]);
252 if (obsoleted_by().empty())
253 obsoleted_by_ = style;
255 lyxerr << "Cannot replace with unknown style `"
256 << to_utf8(style) << '\'' << endl;
258 //lexrc.printError("Cannot replace with"
267 depends_on_ = subst(lexrc.getDocString(), '_', ' ');
270 case LT_MARGIN: // margin style definition.
274 case LT_LATEXTYPE: // LaTeX style definition.
275 readLatexType(lexrc);
278 case LT_LATEXHEADER: // header for environments
280 latexheader = lexrc.getString();
283 case LT_LATEXFOOTER: // footer for environments
285 latexfooter = lexrc.getString();
288 case LT_LATEXPARAGRAPH:
290 latexparagraph = lexrc.getString();
294 intitle = lexrc.next() && lexrc.getInteger();
299 toclevel = lexrc.getInteger();
304 optionalargs = lexrc.getInteger();
307 case LT_NEED_PROTECT:
308 needprotect = lexrc.next() && lexrc.getInteger();
312 keepempty = lexrc.next() && lexrc.getInteger();
316 font = lyxRead(lexrc, font);
321 font = lyxRead(lexrc, font);
325 labelfont = lyxRead(lexrc, labelfont);
328 case LT_NEXTNOINDENT: // Indent next paragraph?
329 if (lexrc.next() && lexrc.getInteger())
332 nextnoindent = false;
335 case LT_COMMANDDEPTH:
337 commanddepth = lexrc.getInteger();
342 latexname_ = lexrc.getString();
347 latexparam_ = subst(lexrc.getString(), """, "\"");
352 innertag_ = lexrc.getString();
357 labeltag_ = lexrc.getString();
362 itemtag_ = lexrc.getString();
366 preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
370 readLabelType(lexrc);
373 case LT_ENDLABELTYPE:
374 readEndLabelType(lexrc);
377 case LT_LEFTMARGIN: // left margin type
379 leftmargin = lexrc.getDocString();
382 case LT_RIGHTMARGIN: // right margin type
384 rightmargin = lexrc.getDocString();
387 case LT_LABELINDENT: // label indenting flag
389 labelindent = lexrc.getDocString();
392 case LT_PARINDENT: // paragraph indent. flag
394 parindent = lexrc.getDocString();
397 case LT_PARSKIP: // paragraph skip size
399 parskip = lexrc.getFloat();
402 case LT_ITEMSEP: // item separation size
404 itemsep = lexrc.getFloat();
407 case LT_TOPSEP: // top separation size
409 topsep = lexrc.getFloat();
412 case LT_BOTTOMSEP: // bottom separation size
414 bottomsep = lexrc.getFloat();
417 case LT_LABEL_BOTTOMSEP: // label bottom separation size
419 labelbottomsep = lexrc.getFloat();
422 case LT_LABELSEP: // label separator
424 labelsep = from_utf8(subst(lexrc.getString(), 'x', ' '));
428 case LT_PARSEP: // par. separation size
430 parsep = lexrc.getFloat();
433 case LT_FILL_TOP: // fill top flag
435 fill_top = lexrc.getInteger();
438 case LT_FILL_BOTTOM: // fill bottom flag
440 fill_bottom = lexrc.getInteger();
443 case LT_NEWLINE: // newlines allowed?
445 newline_allowed = lexrc.getInteger();
448 case LT_ALIGN: // paragraph align
451 case LT_ALIGNPOSSIBLE: // paragraph allowed align
452 readAlignPossible(lexrc);
455 case LT_LABELSTRING: // label string definition
457 labelstring_ = trim(lexrc.getDocString());
458 labelstring_appendix_ = labelstring_;
462 case LT_ENDLABELSTRING: // endlabel string definition
464 endlabelstring_ = trim(lexrc.getDocString());
467 case LT_LABELSTRING_APPENDIX: // label string appendix definition
469 labelstring_appendix_ = trim(lexrc.getDocString());
472 case LT_LABELCOUNTER: // name of counter to use
474 counter = lyx::from_ascii(trim(lexrc.getString()));
477 case LT_FREE_SPACING: // Allow for free spacing.
479 free_spacing = lexrc.getInteger();
482 case LT_PASS_THRU: // Allow for pass thru.
484 pass_thru = lexrc.getInteger();
487 case LT_SPACING: // setspace.sty
493 vector<string> const req =
494 getVectorFromString(lexrc.getString());
495 requires_.insert(req.begin(), req.end());
515 void Layout::readAlign(Lexer & lexrc)
517 keyword_item alignTags[] = {
518 { "block", AT_BLOCK },
519 { "center", AT_CENTER },
520 { "layout", AT_LAYOUT },
522 { "right", AT_RIGHT }
525 PushPopHelper pph(lexrc, alignTags, AT_LAYOUT);
526 int le = lexrc.lex();
528 case Lexer::LEX_UNDEF:
529 lexrc.printError("Unknown alignment `$$Token'");
533 switch (static_cast<AlignTags>(le)) {
535 align = LYX_ALIGN_BLOCK;
538 align = LYX_ALIGN_LEFT;
541 align = LYX_ALIGN_RIGHT;
544 align = LYX_ALIGN_CENTER;
547 align = LYX_ALIGN_LAYOUT;
553 void Layout::readAlignPossible(Lexer & lexrc)
555 keyword_item alignTags[] = {
556 { "block", AT_BLOCK },
557 { "center", AT_CENTER },
558 { "layout", AT_LAYOUT },
560 { "right", AT_RIGHT }
563 lexrc.pushTable(alignTags, AT_LAYOUT);
564 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
565 int lineno = lexrc.getLineNo();
567 int le = lexrc.lex();
569 case Lexer::LEX_UNDEF:
570 lexrc.printError("Unknown alignment `$$Token'");
574 switch (static_cast<AlignTags>(le)) {
576 alignpossible |= LYX_ALIGN_BLOCK;
579 alignpossible |= LYX_ALIGN_LEFT;
582 alignpossible |= LYX_ALIGN_RIGHT;
585 alignpossible |= LYX_ALIGN_CENTER;
588 alignpossible |= LYX_ALIGN_LAYOUT;
591 } while (lineno == lexrc.getLineNo());
600 LA_CENTERED_TOP_ENVIRONMENT,
610 void Layout::readLabelType(Lexer & lexrc)
612 keyword_item labelTypeTags[] = {
613 { "bibliography", LA_BIBLIO },
614 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
615 { "counter", LA_COUNTER },
616 { "enumerate", LA_ENUMERATE },
617 { "itemize", LA_ITEMIZE },
618 { "manual", LA_MANUAL },
619 { "no_label", LA_NO_LABEL },
620 { "sensitive", LA_SENSITIVE },
621 { "static", LA_STATIC },
622 { "top_environment", LA_TOP_ENVIRONMENT }
625 PushPopHelper pph(lexrc, labelTypeTags, LA_BIBLIO);
626 int le = lexrc.lex();
628 case Lexer::LEX_UNDEF:
629 lexrc.printError("Unknown labeltype tag `$$Token'");
633 switch (static_cast<LabelTypeTags>(le)) {
635 labeltype = LABEL_NO_LABEL;
638 labeltype = LABEL_MANUAL;
640 case LA_TOP_ENVIRONMENT:
641 labeltype = LABEL_TOP_ENVIRONMENT;
643 case LA_CENTERED_TOP_ENVIRONMENT:
644 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
647 labeltype = LABEL_STATIC;
650 labeltype = LABEL_SENSITIVE;
653 labeltype = LABEL_COUNTER;
656 labeltype = LABEL_ENUMERATE;
659 labeltype = LABEL_ITEMIZE;
662 labeltype = LABEL_BIBLIO;
668 static keyword_item endlabelTypeTags[] =
670 { "box", END_LABEL_BOX },
671 { "filled_box", END_LABEL_FILLED_BOX },
672 { "no_label", END_LABEL_NO_LABEL },
673 { "static", END_LABEL_STATIC }
677 void Layout::readEndLabelType(Lexer & lexrc)
679 PushPopHelper pph(lexrc, endlabelTypeTags,
680 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
681 int le = lexrc.lex();
683 case Lexer::LEX_UNDEF:
684 lexrc.printError("Unknown labeltype tag `$$Token'");
686 case END_LABEL_STATIC:
688 case END_LABEL_FILLED_BOX:
689 case END_LABEL_NO_LABEL:
690 endlabeltype = static_cast<EndLabelType>(le);
693 lyxerr << "Unhandled value " << le
694 << " in Layout::readEndLabelType." << endl;
700 void Layout::readMargin(Lexer & lexrc)
702 keyword_item marginTags[] = {
703 { "dynamic", MARGIN_DYNAMIC },
704 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
705 { "manual", MARGIN_MANUAL },
706 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
707 { "static", MARGIN_STATIC }
710 PushPopHelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
712 int le = lexrc.lex();
714 case Lexer::LEX_UNDEF:
715 lexrc.printError("Unknown margin type tag `$$Token'");
720 case MARGIN_FIRST_DYNAMIC:
721 case MARGIN_RIGHT_ADDRESS_BOX:
722 margintype = static_cast<MarginType>(le);
725 lyxerr << "Unhandled value " << le
726 << " in Layout::readMargin." << endl;
732 void Layout::readLatexType(Lexer & lexrc)
734 keyword_item latexTypeTags[] = {
735 { "bib_environment", LATEX_BIB_ENVIRONMENT },
736 { "command", LATEX_COMMAND },
737 { "environment", LATEX_ENVIRONMENT },
738 { "item_environment", LATEX_ITEM_ENVIRONMENT },
739 { "list_environment", LATEX_LIST_ENVIRONMENT },
740 { "paragraph", LATEX_PARAGRAPH }
743 PushPopHelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
744 int le = lexrc.lex();
746 case Lexer::LEX_UNDEF:
747 lexrc.printError("Unknown latextype tag `$$Token'");
749 case LATEX_PARAGRAPH:
751 case LATEX_ENVIRONMENT:
752 case LATEX_ITEM_ENVIRONMENT:
753 case LATEX_BIB_ENVIRONMENT:
754 case LATEX_LIST_ENVIRONMENT:
755 latextype = static_cast<LatexType>(le);
758 lyxerr << "Unhandled value " << le
759 << " in Layout::readLatexType." << endl;
766 ST_SPACING_SINGLE = 1,
773 void Layout::readSpacing(Lexer & lexrc)
775 keyword_item spacingTags[] = {
776 {"double", ST_SPACING_DOUBLE },
777 {"onehalf", ST_SPACING_ONEHALF },
778 {"other", ST_OTHER },
779 {"single", ST_SPACING_SINGLE }
782 PushPopHelper pph(lexrc, spacingTags, ST_OTHER);
783 int le = lexrc.lex();
785 case Lexer::LEX_UNDEF:
786 lexrc.printError("Unknown spacing token `$$Token'");
790 switch (static_cast<SpacingTags>(le)) {
791 case ST_SPACING_SINGLE:
792 spacing.set(Spacing::Single);
794 case ST_SPACING_ONEHALF:
795 spacing.set(Spacing::Onehalf);
797 case ST_SPACING_DOUBLE:
798 spacing.set(Spacing::Double);
802 spacing.set(Spacing::Other, lexrc.getString());
808 docstring const & Layout::name() const
814 void Layout::setName(docstring const & name)
820 docstring const & Layout::obsoleted_by() const
822 return obsoleted_by_;
826 docstring const & Layout::depends_on() const
832 Layout * Layout::forCaption()
834 Layout * lay = new Layout();
835 lay->name_ = from_ascii("Caption");
836 lay->latexname_ = "caption";
837 lay->latextype = LATEX_COMMAND;
838 lay->optionalargs = 1;