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;
28 // The order of the LayoutTags enum is no more important. [asierra300396]
40 //LT_ENVIRONMENT_DEFAULT,
57 LT_LABELSTRING_APPENDIX,
87 // Constructor for layout
88 LyXLayout::LyXLayout ()
90 margintype = MARGIN_STATIC;
91 latextype = LATEX_PARAGRAPH;
96 font = LyXFont(LyXFont::ALL_INHERIT);
97 labelfont = LyXFont(LyXFont::ALL_INHERIT);
98 resfont = LyXFont(LyXFont::ALL_SANE);
99 reslabelfont = LyXFont(LyXFont::ALL_SANE);
100 nextnoindent = false;
105 labelbottomsep = 0.0;
107 align = LYX_ALIGN_BLOCK;
108 alignpossible = LYX_ALIGN_BLOCK;
109 labeltype = LABEL_NO_LABEL;
110 endlabeltype = END_LABEL_NO_LABEL;
111 // Should or should not. That is the question.
112 // spacing.set(Spacing::OneHalf);
115 newline_allowed = true;
116 free_spacing = false;
118 is_environment = false;
123 // Reads a layout definition from file
124 bool LyXLayout::Read(LyXLex & lexrc, LyXTextClass const & tclass)
126 // This table is sorted alphabetically [asierra 30March96]
127 keyword_item layoutTags[] = {
128 { "align", LT_ALIGN },
129 { "alignpossible", LT_ALIGNPOSSIBLE },
130 { "bottomsep", LT_BOTTOMSEP },
131 { "copystyle", LT_COPYSTYLE },
132 { "dependson", LT_DEPENDSON },
134 { "endlabelstring", LT_ENDLABELSTRING },
135 { "endlabeltype", LT_ENDLABELTYPE },
136 { "fill_bottom", LT_FILL_BOTTOM },
137 { "fill_top", LT_FILL_TOP },
139 { "freespacing", LT_FREE_SPACING },
140 { "intitle", LT_INTITLE },
141 { "itemsep", LT_ITEMSEP },
142 { "keepempty", LT_KEEPEMPTY },
143 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
144 { "labelcounter", LT_LABELCOUNTER },
145 { "labelfont", LT_LABELFONT },
146 { "labelindent", LT_LABELINDENT },
147 { "labelsep", LT_LABELSEP },
148 { "labelstring", LT_LABELSTRING },
149 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
150 { "labeltype", LT_LABELTYPE },
151 { "latexfooter", LT_LATEXFOOTER },
152 { "latexheader", LT_LATEXHEADER },
153 { "latexname", LT_LATEXNAME },
154 { "latexparagraph", LT_LATEXPARAGRAPH },
155 { "latexparam", LT_LATEXPARAM },
156 { "latextype", LT_LATEXTYPE },
157 { "leftmargin", LT_LEFTMARGIN },
158 { "margin", LT_MARGIN },
159 { "needprotect", LT_NEED_PROTECT },
160 { "newline", LT_NEWLINE },
161 { "nextnoindent", LT_NEXTNOINDENT },
162 { "obsoletedby", LT_OBSOLETEDBY },
163 { "optionalargs", LT_OPTARGS },
164 { "parindent", LT_PARINDENT },
165 { "parsep", LT_PARSEP },
166 { "parskip", LT_PARSKIP },
167 { "passthru", LT_PASS_THRU },
168 { "preamble", LT_PREAMBLE },
169 { "rightmargin", LT_RIGHTMARGIN },
170 { "spacing", LT_SPACING },
171 { "textfont", LT_TEXTFONT },
172 { "toclevel", LT_TOCLEVEL },
173 { "topsep", LT_TOPSEP }
177 bool finished = false;
178 lexrc.pushTable(layoutTags, LT_INTITLE);
179 // parse style section
180 while (!finished && lexrc.isOK() && !error) {
181 int le = lexrc.lex();
182 // See comment in lyxrc.C.
184 case LyXLex::LEX_FEOF:
187 case LyXLex::LEX_UNDEF: // parse error
188 lexrc.printError("Unknown layout tag `$$Token'");
193 switch (static_cast<LayoutTags>(le)) {
194 case LT_END: // end of structure
198 case LT_COPYSTYLE: // initialize with a known style
200 string const style = lexrc.getString();
202 if (tclass.hasLayout(style)) {
203 string const tmpname = name_;
204 this->operator=(*tclass[style]);
207 lyxerr << "Cannot copy unknown style `"
209 << "All layouts so far:"
211 LyXTextClass::const_iterator it =
213 LyXTextClass::const_iterator end =
215 for (; it != end; ++it) {
216 lyxerr << (*it)->name()
220 //lexrc.printError("Cannot copy known "
221 // "style `$$Token'");
226 case LT_OBSOLETEDBY: // replace with a known style
228 string const style = lexrc.getString();
230 if (tclass.hasLayout(style)) {
231 string const tmpname = name_;
232 this->operator=(*tclass[style]);
234 if (obsoleted_by().empty())
235 obsoleted_by_ = style;
237 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
239 //lexrc.printError("Cannot replace with"
248 depends_on_ = lexrc.getString();
251 case LT_MARGIN: // margin style definition.
255 case LT_LATEXTYPE: // LaTeX style definition.
256 readLatexType(lexrc);
259 case LT_LATEXHEADER: // header for environments
261 latexheader = lexrc.getString();
264 case LT_LATEXFOOTER: // footer for environments
266 latexfooter = lexrc.getString();
269 case LT_LATEXPARAGRAPH:
271 latexparagraph = lexrc.getString();
275 intitle = lexrc.next() && lexrc.getInteger();
280 toclevel = lexrc.getInteger();
285 optionalargs = lexrc.getInteger();
288 case LT_NEED_PROTECT:
289 needprotect = lexrc.next() && lexrc.getInteger();
293 keepempty = lexrc.next() && lexrc.getInteger();
306 labelfont.lyxRead(lexrc);
309 case LT_NEXTNOINDENT: // Indent next paragraph?
310 if (lexrc.next() && lexrc.getInteger())
313 nextnoindent = false;
318 latexname_ = lexrc.getString();
323 latexparam_ = lexrc.getString();
327 preamble_ = lexrc.getLongString("EndPreamble");
331 readLabelType(lexrc);
334 case LT_ENDLABELTYPE:
335 readEndLabelType(lexrc);
338 case LT_LEFTMARGIN: // left margin type
340 leftmargin = lexrc.getString();
343 case LT_RIGHTMARGIN: // right margin type
345 rightmargin = lexrc.getString();
348 case LT_LABELINDENT: // label indenting flag
350 labelindent = lexrc.getString();
353 case LT_PARINDENT: // paragraph indent. flag
355 parindent = lexrc.getString();
358 case LT_PARSKIP: // paragraph skip size
360 parskip = lexrc.getFloat();
363 case LT_ITEMSEP: // item separation size
365 itemsep = lexrc.getFloat();
368 case LT_TOPSEP: // top separation size
370 topsep = lexrc.getFloat();
373 case LT_BOTTOMSEP: // bottom separation size
375 bottomsep = lexrc.getFloat();
378 case LT_LABEL_BOTTOMSEP: // label bottom separation size
380 labelbottomsep = lexrc.getFloat();
383 case LT_LABELSEP: // label separator
385 labelsep = subst(lexrc.getString(), 'x', ' ');
389 case LT_PARSEP: // par. separation size
391 parsep = lexrc.getFloat();
394 case LT_FILL_TOP: // fill top flag
396 fill_top = lexrc.getInteger();
399 case LT_FILL_BOTTOM: // fill bottom flag
401 fill_bottom = lexrc.getInteger();
404 case LT_NEWLINE: // newlines allowed?
406 newline_allowed = lexrc.getInteger();
409 case LT_ALIGN: // paragraph align
412 case LT_ALIGNPOSSIBLE: // paragraph allowed align
413 readAlignPossible(lexrc);
416 case LT_LABELSTRING: // label string definition
418 labelstring_ = trim(lexrc.getString());
421 case LT_ENDLABELSTRING: // endlabel string definition
423 endlabelstring_ = trim(lexrc.getString());
426 case LT_LABELSTRING_APPENDIX: // label string appendix definition
428 labelstring_appendix_ = trim(lexrc.getString());
431 case LT_LABELCOUNTER: // name of counter to use
433 counter = trim(lexrc.getString());
436 case LT_FREE_SPACING: // Allow for free spacing.
438 free_spacing = lexrc.getInteger();
441 case LT_PASS_THRU: // Allow for pass thru.
443 pass_thru = lexrc.getInteger();
446 case LT_SPACING: // setspace.sty
453 if (labelstring_appendix_.empty())
454 labelstring_appendix_ = labelstring_;
468 void LyXLayout::readAlign(LyXLex & lexrc)
470 keyword_item alignTags[] = {
471 { "block", AT_BLOCK },
472 { "center", AT_CENTER },
473 { "layout", AT_LAYOUT },
475 { "right", AT_RIGHT }
478 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
479 int le = lexrc.lex();
481 case LyXLex::LEX_UNDEF:
482 lexrc.printError("Unknown alignment `$$Token'");
486 switch (static_cast<AlignTags>(le)) {
488 align = LYX_ALIGN_BLOCK;
491 align = LYX_ALIGN_LEFT;
494 align = LYX_ALIGN_RIGHT;
497 align = LYX_ALIGN_CENTER;
500 align = LYX_ALIGN_LAYOUT;
506 void LyXLayout::readAlignPossible(LyXLex & lexrc)
508 keyword_item alignTags[] = {
509 { "block", AT_BLOCK },
510 { "center", AT_CENTER },
511 { "layout", AT_LAYOUT },
513 { "right", AT_RIGHT }
516 lexrc.pushTable(alignTags, AT_LAYOUT);
517 alignpossible = LYX_ALIGN_NONE;
518 int lineno = lexrc.getLineNo();
520 int le = lexrc.lex();
522 case LyXLex::LEX_UNDEF:
523 lexrc.printError("Unknown alignment `$$Token'");
527 switch (static_cast<AlignTags>(le)) {
529 alignpossible |= LYX_ALIGN_BLOCK;
532 alignpossible |= LYX_ALIGN_LEFT;
535 alignpossible |= LYX_ALIGN_RIGHT;
538 alignpossible |= LYX_ALIGN_CENTER;
541 alignpossible |= LYX_ALIGN_LAYOUT;
544 } while (lineno == lexrc.getLineNo());
553 LA_CENTERED_TOP_ENVIRONMENT,
563 void LyXLayout::readLabelType(LyXLex & lexrc)
565 keyword_item labelTypeTags[] = {
566 { "bibliography", LA_BIBLIO },
567 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
568 { "counter", LA_COUNTER },
569 { "enumerate", LA_ENUMERATE },
570 { "itemize", LA_ITEMIZE },
571 { "manual", LA_MANUAL },
572 { "no_label", LA_NO_LABEL },
573 { "sensitive", LA_SENSITIVE },
574 { "static", LA_STATIC },
575 { "top_environment", LA_TOP_ENVIRONMENT }
578 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
579 int le = lexrc.lex();
581 case LyXLex::LEX_UNDEF:
582 lexrc.printError("Unknown labeltype tag `$$Token'");
586 switch (static_cast<LabelTypeTags>(le)) {
588 labeltype = LABEL_NO_LABEL;
591 labeltype = LABEL_MANUAL;
593 case LA_TOP_ENVIRONMENT:
594 labeltype = LABEL_TOP_ENVIRONMENT;
596 case LA_CENTERED_TOP_ENVIRONMENT:
597 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
600 labeltype = LABEL_STATIC;
603 labeltype = LABEL_SENSITIVE;
606 labeltype = LABEL_COUNTER;
609 labeltype = LABEL_ENUMERATE;
612 labeltype = LABEL_ITEMIZE;
615 labeltype = LABEL_BIBLIO;
623 keyword_item endlabelTypeTags[] = {
624 { "box", END_LABEL_BOX },
625 { "filled_box", END_LABEL_FILLED_BOX },
626 { "no_label", END_LABEL_NO_LABEL },
627 { "static", END_LABEL_STATIC }
633 void LyXLayout::readEndLabelType(LyXLex & lexrc)
635 pushpophelper pph(lexrc, endlabelTypeTags,
636 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
637 int le = lexrc.lex();
639 case LyXLex::LEX_UNDEF:
640 lexrc.printError("Unknown labeltype tag `$$Token'");
642 case END_LABEL_STATIC:
644 case END_LABEL_FILLED_BOX:
645 case END_LABEL_NO_LABEL:
646 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
649 lyxerr << "Unhandled value " << le
650 << " in LyXLayout::readEndLabelType." << endl;
656 void LyXLayout::readMargin(LyXLex & lexrc)
658 keyword_item marginTags[] = {
659 { "dynamic", MARGIN_DYNAMIC },
660 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
661 { "manual", MARGIN_MANUAL },
662 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
663 { "static", MARGIN_STATIC }
666 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
668 int le = lexrc.lex();
670 case LyXLex::LEX_UNDEF:
671 lexrc.printError("Unknown margin type tag `$$Token'");
676 case MARGIN_FIRST_DYNAMIC:
677 case MARGIN_RIGHT_ADDRESS_BOX:
678 margintype = static_cast<LYX_MARGIN_TYPE>(le);
681 lyxerr << "Unhandled value " << le
682 << " in LyXLayout::readMargin." << endl;
688 void LyXLayout::readLatexType(LyXLex & lexrc)
690 keyword_item latexTypeTags[] = {
691 { "bib_environment", LATEX_BIB_ENVIRONMENT },
692 { "command", LATEX_COMMAND },
693 { "environment", LATEX_ENVIRONMENT },
694 { "item_environment", LATEX_ITEM_ENVIRONMENT },
695 { "list_environment", LATEX_LIST_ENVIRONMENT },
696 { "paragraph", LATEX_PARAGRAPH }
699 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
700 int le = lexrc.lex();
702 case LyXLex::LEX_UNDEF:
703 lexrc.printError("Unknown latextype tag `$$Token'");
705 case LATEX_PARAGRAPH:
707 case LATEX_ENVIRONMENT:
708 case LATEX_ITEM_ENVIRONMENT:
709 case LATEX_BIB_ENVIRONMENT:
710 case LATEX_LIST_ENVIRONMENT:
711 latextype = static_cast<LYX_LATEX_TYPES>(le);
714 lyxerr << "Unhandled value " << le
715 << " in LyXLayout::readLatexType." << endl;
722 ST_SPACING_SINGLE = 1,
729 void LyXLayout::readSpacing(LyXLex & lexrc)
731 keyword_item spacingTags[] = {
732 {"double", ST_SPACING_DOUBLE },
733 {"onehalf", ST_SPACING_ONEHALF },
734 {"other", ST_OTHER },
735 {"single", ST_SPACING_SINGLE }
738 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
739 int le = lexrc.lex();
741 case LyXLex::LEX_UNDEF:
742 lexrc.printError("Unknown spacing token `$$Token'");
746 switch (static_cast<SpacingTags>(le)) {
747 case ST_SPACING_SINGLE:
748 spacing.set(Spacing::Single);
750 case ST_SPACING_ONEHALF:
751 spacing.set(Spacing::Onehalf);
753 case ST_SPACING_DOUBLE:
754 spacing.set(Spacing::Double);
758 spacing.set(Spacing::Other, lexrc.getFloat());
764 string const & LyXLayout::name() const
770 void LyXLayout::setName(string const & n)
776 string const & LyXLayout::obsoleted_by() const
778 return obsoleted_by_;
782 string const & LyXLayout::depends_on() const