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.
15 #include "lyxlayout.h"
16 #include "lyxtextclass.h"
20 #include "support/lstrings.h"
22 using lyx::support::subst;
23 using lyx::support::trim;
29 // The order of the LayoutTags enum is no more important. [asierra300396]
42 //LT_ENVIRONMENT_DEFAULT,
59 LT_LABELSTRING_APPENDIX,
87 LT_INTITLE // keep this last!
92 // Constructor for layout
93 LyXLayout::LyXLayout ()
95 margintype = MARGIN_STATIC;
96 latextype = LATEX_PARAGRAPH;
101 font = LyXFont(LyXFont::ALL_INHERIT);
102 labelfont = LyXFont(LyXFont::ALL_INHERIT);
103 resfont = LyXFont(LyXFont::ALL_SANE);
104 reslabelfont = LyXFont(LyXFont::ALL_SANE);
105 nextnoindent = false;
110 labelbottomsep = 0.0;
112 align = LYX_ALIGN_BLOCK;
113 alignpossible = LYX_ALIGN_BLOCK;
114 labeltype = LABEL_NO_LABEL;
115 endlabeltype = END_LABEL_NO_LABEL;
116 // Should or should not. That is the question.
117 // spacing.set(Spacing::OneHalf);
120 newline_allowed = true;
121 free_spacing = false;
123 is_environment = false;
129 // Reads a layout definition from file
130 bool LyXLayout::Read(LyXLex & lexrc, LyXTextClass const & tclass)
132 // This table is sorted alphabetically [asierra 30March96]
133 keyword_item layoutTags[] = {
134 { "align", LT_ALIGN },
135 { "alignpossible", LT_ALIGNPOSSIBLE },
136 { "bottomsep", LT_BOTTOMSEP },
137 { "commanddepth", LT_COMMANDDEPTH },
138 { "copystyle", LT_COPYSTYLE },
139 { "dependson", LT_DEPENDSON },
141 { "endlabelstring", LT_ENDLABELSTRING },
142 { "endlabeltype", LT_ENDLABELTYPE },
143 { "fill_bottom", LT_FILL_BOTTOM },
144 { "fill_top", LT_FILL_TOP },
146 { "freespacing", LT_FREE_SPACING },
147 { "innertag", LT_INNERTAG },
148 { "intitle", LT_INTITLE },
149 { "itemsep", LT_ITEMSEP },
150 { "itemtag", LT_ITEMTAG },
151 { "keepempty", LT_KEEPEMPTY },
152 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
153 { "labelcounter", LT_LABELCOUNTER },
154 { "labelfont", LT_LABELFONT },
155 { "labelindent", LT_LABELINDENT },
156 { "labelsep", LT_LABELSEP },
157 { "labelstring", LT_LABELSTRING },
158 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
159 { "labeltag", LT_LABELTAG },
160 { "labeltype", LT_LABELTYPE },
161 { "latexfooter", LT_LATEXFOOTER },
162 { "latexheader", LT_LATEXHEADER },
163 { "latexname", LT_LATEXNAME },
164 { "latexparagraph", LT_LATEXPARAGRAPH },
165 { "latexparam", LT_LATEXPARAM },
166 { "latextype", LT_LATEXTYPE },
167 { "leftmargin", LT_LEFTMARGIN },
168 { "margin", LT_MARGIN },
169 { "needprotect", LT_NEED_PROTECT },
170 { "newline", LT_NEWLINE },
171 { "nextnoindent", LT_NEXTNOINDENT },
172 { "obsoletedby", LT_OBSOLETEDBY },
173 { "optionalargs", LT_OPTARGS },
174 { "parindent", LT_PARINDENT },
175 { "parsep", LT_PARSEP },
176 { "parskip", LT_PARSKIP },
177 { "passthru", LT_PASS_THRU },
178 { "preamble", LT_PREAMBLE },
179 { "rightmargin", LT_RIGHTMARGIN },
180 { "spacing", LT_SPACING },
181 { "textfont", LT_TEXTFONT },
182 { "toclevel", LT_TOCLEVEL },
183 { "topsep", LT_TOPSEP }
187 bool finished = false;
188 lexrc.pushTable(layoutTags, LT_INTITLE);
189 // parse style section
190 while (!finished && lexrc.isOK() && !error) {
191 int le = lexrc.lex();
192 // See comment in lyxrc.C.
194 case LyXLex::LEX_FEOF:
197 case LyXLex::LEX_UNDEF: // parse error
198 lexrc.printError("Unknown layout tag `$$Token'");
203 switch (static_cast<LayoutTags>(le)) {
204 case LT_END: // end of structure
208 case LT_COPYSTYLE: // initialize with a known style
210 string const style = subst(lexrc.getString(),
213 if (tclass.hasLayout(style)) {
214 string const tmpname = name_;
215 this->operator=(*tclass[style]);
218 lyxerr << "Cannot copy unknown style `"
220 << "All layouts so far:"
222 LyXTextClass::const_iterator it =
224 LyXTextClass::const_iterator end =
226 for (; it != end; ++it) {
227 lyxerr << (*it)->name()
231 //lexrc.printError("Cannot copy known "
232 // "style `$$Token'");
237 case LT_OBSOLETEDBY: // replace with a known style
239 string const style = lexrc.getString();
241 if (tclass.hasLayout(style)) {
242 string const tmpname = name_;
243 this->operator=(*tclass[style]);
245 if (obsoleted_by().empty())
246 obsoleted_by_ = style;
248 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
250 //lexrc.printError("Cannot replace with"
259 depends_on_ = lexrc.getString();
262 case LT_MARGIN: // margin style definition.
266 case LT_LATEXTYPE: // LaTeX style definition.
267 readLatexType(lexrc);
270 case LT_LATEXHEADER: // header for environments
272 latexheader = lexrc.getString();
275 case LT_LATEXFOOTER: // footer for environments
277 latexfooter = lexrc.getString();
280 case LT_LATEXPARAGRAPH:
282 latexparagraph = lexrc.getString();
286 intitle = lexrc.next() && lexrc.getInteger();
291 toclevel = lexrc.getInteger();
296 optionalargs = lexrc.getInteger();
299 case LT_NEED_PROTECT:
300 needprotect = lexrc.next() && lexrc.getInteger();
304 keepempty = lexrc.next() && lexrc.getInteger();
317 labelfont.lyxRead(lexrc);
320 case LT_NEXTNOINDENT: // Indent next paragraph?
321 if (lexrc.next() && lexrc.getInteger())
324 nextnoindent = false;
327 case LT_COMMANDDEPTH:
329 commanddepth = lexrc.getInteger();
334 latexname_ = lexrc.getString();
339 latexparam_ = subst(lexrc.getString(), """, "\"");
344 innertag_ = lexrc.getString();
349 labeltag_ = lexrc.getString();
354 itemtag_ = lexrc.getString();
358 preamble_ = lexrc.getLongString("EndPreamble");
362 readLabelType(lexrc);
365 case LT_ENDLABELTYPE:
366 readEndLabelType(lexrc);
369 case LT_LEFTMARGIN: // left margin type
371 leftmargin = lexrc.getString();
374 case LT_RIGHTMARGIN: // right margin type
376 rightmargin = lexrc.getString();
379 case LT_LABELINDENT: // label indenting flag
381 labelindent = lexrc.getString();
384 case LT_PARINDENT: // paragraph indent. flag
386 parindent = lexrc.getString();
389 case LT_PARSKIP: // paragraph skip size
391 parskip = lexrc.getFloat();
394 case LT_ITEMSEP: // item separation size
396 itemsep = lexrc.getFloat();
399 case LT_TOPSEP: // top separation size
401 topsep = lexrc.getFloat();
404 case LT_BOTTOMSEP: // bottom separation size
406 bottomsep = lexrc.getFloat();
409 case LT_LABEL_BOTTOMSEP: // label bottom separation size
411 labelbottomsep = lexrc.getFloat();
414 case LT_LABELSEP: // label separator
416 labelsep = subst(lexrc.getString(), 'x', ' ');
420 case LT_PARSEP: // par. separation size
422 parsep = lexrc.getFloat();
425 case LT_FILL_TOP: // fill top flag
427 fill_top = lexrc.getInteger();
430 case LT_FILL_BOTTOM: // fill bottom flag
432 fill_bottom = lexrc.getInteger();
435 case LT_NEWLINE: // newlines allowed?
437 newline_allowed = lexrc.getInteger();
440 case LT_ALIGN: // paragraph align
443 case LT_ALIGNPOSSIBLE: // paragraph allowed align
444 readAlignPossible(lexrc);
447 case LT_LABELSTRING: // label string definition
449 labelstring_ = trim(lexrc.getString());
452 case LT_ENDLABELSTRING: // endlabel string definition
454 endlabelstring_ = trim(lexrc.getString());
457 case LT_LABELSTRING_APPENDIX: // label string appendix definition
459 labelstring_appendix_ = trim(lexrc.getString());
462 case LT_LABELCOUNTER: // name of counter to use
464 counter = trim(lexrc.getString());
467 case LT_FREE_SPACING: // Allow for free spacing.
469 free_spacing = lexrc.getInteger();
472 case LT_PASS_THRU: // Allow for pass thru.
474 pass_thru = lexrc.getInteger();
477 case LT_SPACING: // setspace.sty
484 if (labelstring_appendix_.empty())
485 labelstring_appendix_ = labelstring_;
499 void LyXLayout::readAlign(LyXLex & lexrc)
501 keyword_item alignTags[] = {
502 { "block", AT_BLOCK },
503 { "center", AT_CENTER },
504 { "layout", AT_LAYOUT },
506 { "right", AT_RIGHT }
509 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
510 int le = lexrc.lex();
512 case LyXLex::LEX_UNDEF:
513 lexrc.printError("Unknown alignment `$$Token'");
517 switch (static_cast<AlignTags>(le)) {
519 align = LYX_ALIGN_BLOCK;
522 align = LYX_ALIGN_LEFT;
525 align = LYX_ALIGN_RIGHT;
528 align = LYX_ALIGN_CENTER;
531 align = LYX_ALIGN_LAYOUT;
537 void LyXLayout::readAlignPossible(LyXLex & lexrc)
539 keyword_item alignTags[] = {
540 { "block", AT_BLOCK },
541 { "center", AT_CENTER },
542 { "layout", AT_LAYOUT },
544 { "right", AT_RIGHT }
547 lexrc.pushTable(alignTags, AT_LAYOUT);
548 alignpossible = LYX_ALIGN_NONE;
549 int lineno = lexrc.getLineNo();
551 int le = lexrc.lex();
553 case LyXLex::LEX_UNDEF:
554 lexrc.printError("Unknown alignment `$$Token'");
558 switch (static_cast<AlignTags>(le)) {
560 alignpossible |= LYX_ALIGN_BLOCK;
563 alignpossible |= LYX_ALIGN_LEFT;
566 alignpossible |= LYX_ALIGN_RIGHT;
569 alignpossible |= LYX_ALIGN_CENTER;
572 alignpossible |= LYX_ALIGN_LAYOUT;
575 } while (lineno == lexrc.getLineNo());
584 LA_CENTERED_TOP_ENVIRONMENT,
594 void LyXLayout::readLabelType(LyXLex & lexrc)
596 keyword_item labelTypeTags[] = {
597 { "bibliography", LA_BIBLIO },
598 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
599 { "counter", LA_COUNTER },
600 { "enumerate", LA_ENUMERATE },
601 { "itemize", LA_ITEMIZE },
602 { "manual", LA_MANUAL },
603 { "no_label", LA_NO_LABEL },
604 { "sensitive", LA_SENSITIVE },
605 { "static", LA_STATIC },
606 { "top_environment", LA_TOP_ENVIRONMENT }
609 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
610 int le = lexrc.lex();
612 case LyXLex::LEX_UNDEF:
613 lexrc.printError("Unknown labeltype tag `$$Token'");
617 switch (static_cast<LabelTypeTags>(le)) {
619 labeltype = LABEL_NO_LABEL;
622 labeltype = LABEL_MANUAL;
624 case LA_TOP_ENVIRONMENT:
625 labeltype = LABEL_TOP_ENVIRONMENT;
627 case LA_CENTERED_TOP_ENVIRONMENT:
628 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
631 labeltype = LABEL_STATIC;
634 labeltype = LABEL_SENSITIVE;
637 labeltype = LABEL_COUNTER;
640 labeltype = LABEL_ENUMERATE;
643 labeltype = LABEL_ITEMIZE;
646 labeltype = LABEL_BIBLIO;
654 keyword_item endlabelTypeTags[] = {
655 { "box", END_LABEL_BOX },
656 { "filled_box", END_LABEL_FILLED_BOX },
657 { "no_label", END_LABEL_NO_LABEL },
658 { "static", END_LABEL_STATIC }
664 void LyXLayout::readEndLabelType(LyXLex & lexrc)
666 pushpophelper pph(lexrc, endlabelTypeTags,
667 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
668 int le = lexrc.lex();
670 case LyXLex::LEX_UNDEF:
671 lexrc.printError("Unknown labeltype tag `$$Token'");
673 case END_LABEL_STATIC:
675 case END_LABEL_FILLED_BOX:
676 case END_LABEL_NO_LABEL:
677 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
680 lyxerr << "Unhandled value " << le
681 << " in LyXLayout::readEndLabelType." << endl;
687 void LyXLayout::readMargin(LyXLex & lexrc)
689 keyword_item marginTags[] = {
690 { "dynamic", MARGIN_DYNAMIC },
691 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
692 { "manual", MARGIN_MANUAL },
693 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
694 { "static", MARGIN_STATIC }
697 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
699 int le = lexrc.lex();
701 case LyXLex::LEX_UNDEF:
702 lexrc.printError("Unknown margin type tag `$$Token'");
707 case MARGIN_FIRST_DYNAMIC:
708 case MARGIN_RIGHT_ADDRESS_BOX:
709 margintype = static_cast<LYX_MARGIN_TYPE>(le);
712 lyxerr << "Unhandled value " << le
713 << " in LyXLayout::readMargin." << endl;
719 void LyXLayout::readLatexType(LyXLex & lexrc)
721 keyword_item latexTypeTags[] = {
722 { "bib_environment", LATEX_BIB_ENVIRONMENT },
723 { "command", LATEX_COMMAND },
724 { "environment", LATEX_ENVIRONMENT },
725 { "item_environment", LATEX_ITEM_ENVIRONMENT },
726 { "list_environment", LATEX_LIST_ENVIRONMENT },
727 { "paragraph", LATEX_PARAGRAPH }
730 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
731 int le = lexrc.lex();
733 case LyXLex::LEX_UNDEF:
734 lexrc.printError("Unknown latextype tag `$$Token'");
736 case LATEX_PARAGRAPH:
738 case LATEX_ENVIRONMENT:
739 case LATEX_ITEM_ENVIRONMENT:
740 case LATEX_BIB_ENVIRONMENT:
741 case LATEX_LIST_ENVIRONMENT:
742 latextype = static_cast<LYX_LATEX_TYPES>(le);
745 lyxerr << "Unhandled value " << le
746 << " in LyXLayout::readLatexType." << endl;
753 ST_SPACING_SINGLE = 1,
760 void LyXLayout::readSpacing(LyXLex & lexrc)
762 keyword_item spacingTags[] = {
763 {"double", ST_SPACING_DOUBLE },
764 {"onehalf", ST_SPACING_ONEHALF },
765 {"other", ST_OTHER },
766 {"single", ST_SPACING_SINGLE }
769 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
770 int le = lexrc.lex();
772 case LyXLex::LEX_UNDEF:
773 lexrc.printError("Unknown spacing token `$$Token'");
777 switch (static_cast<SpacingTags>(le)) {
778 case ST_SPACING_SINGLE:
779 spacing.set(Spacing::Single);
781 case ST_SPACING_ONEHALF:
782 spacing.set(Spacing::Onehalf);
784 case ST_SPACING_DOUBLE:
785 spacing.set(Spacing::Double);
789 spacing.set(Spacing::Other, lexrc.getString());
795 string const & LyXLayout::name() const
801 void LyXLayout::setName(string const & n)
807 string const & LyXLayout::obsoleted_by() const
809 return obsoleted_by_;
813 string const & LyXLayout::depends_on() const