1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ======================================================
14 #include "lyxlayout.h"
15 #include "lyxtextclass.h"
19 #include "support/lstrings.h"
21 using namespace lyx::support;
25 // The order of the LayoutTags enum is no more important. [asierra300396]
37 //LT_ENVIRONMENT_DEFAULT,
54 LT_LABELSTRING_APPENDIX,
82 // Constructor for layout
83 LyXLayout::LyXLayout ()
85 margintype = MARGIN_STATIC;
86 latextype = LATEX_PARAGRAPH;
91 font = LyXFont(LyXFont::ALL_INHERIT);
92 labelfont = LyXFont(LyXFont::ALL_INHERIT);
93 resfont = LyXFont(LyXFont::ALL_SANE);
94 reslabelfont = LyXFont(LyXFont::ALL_SANE);
100 labelbottomsep = 0.0;
102 align = LYX_ALIGN_BLOCK;
103 alignpossible = LYX_ALIGN_BLOCK;
104 labeltype = LABEL_NO_LABEL;
105 endlabeltype = END_LABEL_NO_LABEL;
106 // Should or should not. That is the question.
107 // spacing.set(Spacing::OneHalf);
110 newline_allowed = true;
111 free_spacing = false;
113 is_environment = false;
117 // Reads a layout definition from file
118 bool LyXLayout::Read (LyXLex & lexrc, LyXTextClass const & tclass)
120 // This table is sorted alphabetically [asierra 30March96]
121 keyword_item layoutTags[] = {
122 { "align", LT_ALIGN },
123 { "alignpossible", LT_ALIGNPOSSIBLE },
124 { "bottomsep", LT_BOTTOMSEP },
125 { "copystyle", LT_COPYSTYLE },
126 { "dependson", LT_DEPENDSON },
128 { "endlabelstring", LT_ENDLABELSTRING },
129 { "endlabeltype", LT_ENDLABELTYPE },
130 { "fill_bottom", LT_FILL_BOTTOM },
131 { "fill_top", LT_FILL_TOP },
133 { "freespacing", LT_FREE_SPACING },
134 { "intitle", LT_INTITLE },
135 { "itemsep", LT_ITEMSEP },
136 { "keepempty", LT_KEEPEMPTY },
137 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
138 { "labelfont", LT_LABELFONT },
139 { "labelindent", LT_LABELINDENT },
140 { "labelsep", LT_LABELSEP },
141 { "labelstring", LT_LABELSTRING },
142 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
143 { "labeltype", LT_LABELTYPE },
144 { "latexfooter", LT_LATEXFOOTER },
145 { "latexheader", LT_LATEXHEADER },
146 { "latexname", LT_LATEXNAME },
147 { "latexparagraph", LT_LATEXPARAGRAPH },
148 { "latexparam", LT_LATEXPARAM },
149 { "latextype", LT_LATEXTYPE },
150 { "leftmargin", LT_LEFTMARGIN },
151 { "margin", LT_MARGIN },
152 { "needprotect", LT_NEED_PROTECT },
153 { "newline", LT_NEWLINE },
154 { "nextnoindent", LT_NEXTNOINDENT },
155 { "obsoletedby", LT_OBSOLETEDBY },
156 { "optionalargs", LT_OPTARGS },
157 { "parindent", LT_PARINDENT },
158 { "parsep", LT_PARSEP },
159 { "parskip", LT_PARSKIP },
160 { "passthru", LT_PASS_THRU },
161 { "preamble", LT_PREAMBLE },
162 { "rightmargin", LT_RIGHTMARGIN },
163 { "spacing", LT_SPACING },
164 { "textfont", LT_TEXTFONT },
165 { "topsep", LT_TOPSEP }
169 bool finished = false;
170 lexrc.pushTable(layoutTags, LT_INTITLE);
171 // parse style section
172 while (!finished && lexrc.isOK() && !error) {
173 int le = lexrc.lex();
174 // See comment in lyxrc.C.
176 case LyXLex::LEX_FEOF:
179 case LyXLex::LEX_UNDEF: // parse error
180 lexrc.printError("Unknown layout tag `$$Token'");
185 switch (static_cast<LayoutTags>(le)) {
186 case LT_END: // end of structure
190 case LT_COPYSTYLE: // initialize with a known style
192 string const style = lexrc.getString();
194 if (tclass.hasLayout(style)) {
195 string const tmpname = name_;
196 this->operator=(*tclass[style]);
199 lyxerr << "Cannot copy unknown style `"
201 << "All layouts so far:"
203 LyXTextClass::const_iterator it =
205 LyXTextClass::const_iterator end =
207 for (; it != end; ++it) {
208 lyxerr << (*it)->name()
212 //lexrc.printError("Cannot copy known "
213 // "style `$$Token'");
218 case LT_OBSOLETEDBY: // replace with a known style
220 string const style = lexrc.getString();
222 if (tclass.hasLayout(style)) {
223 string const tmpname = name_;
224 this->operator=(*tclass[style]);
226 if (obsoleted_by().empty())
227 obsoleted_by_ = style;
229 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
231 //lexrc.printError("Cannot replace with"
240 depends_on_ = lexrc.getString();
244 case LT_MARGIN: // margin style definition.
248 case LT_LATEXTYPE: // LaTeX style definition.
249 readLatexType(lexrc);
252 case LT_LATEXHEADER: // header for environments
254 latexheader = lexrc.getString();
257 case LT_LATEXFOOTER: // footer for environments
259 latexfooter = lexrc.getString();
262 case LT_LATEXPARAGRAPH:
264 latexparagraph = lexrc.getString();
268 intitle = lexrc.next() && lexrc.getInteger();
273 optionalargs = lexrc.getInteger();
277 case LT_NEED_PROTECT:
278 needprotect = lexrc.next() && lexrc.getInteger();
282 keepempty = lexrc.next() && lexrc.getInteger();
295 labelfont.lyxRead(lexrc);
298 case LT_NEXTNOINDENT: // Indent next paragraph?
299 if (lexrc.next() && lexrc.getInteger())
302 nextnoindent = false;
307 latexname_ = lexrc.getString();
312 latexparam_ = lexrc.getString();
316 preamble_ = lexrc.getLongString("EndPreamble");
320 readLabelType(lexrc);
323 case LT_ENDLABELTYPE:
324 readEndLabelType(lexrc);
327 case LT_LEFTMARGIN: // left margin type
329 leftmargin = lexrc.getString();
332 case LT_RIGHTMARGIN: // right margin type
334 rightmargin = lexrc.getString();
337 case LT_LABELINDENT: // label indenting flag
339 labelindent = lexrc.getString();
342 case LT_PARINDENT: // paragraph indent. flag
344 parindent = lexrc.getString();
347 case LT_PARSKIP: // paragraph skip size
349 parskip = lexrc.getFloat();
352 case LT_ITEMSEP: // item separation size
354 itemsep = lexrc.getFloat();
357 case LT_TOPSEP: // top separation size
359 topsep = lexrc.getFloat();
362 case LT_BOTTOMSEP: // bottom separation size
364 bottomsep = lexrc.getFloat();
367 case LT_LABEL_BOTTOMSEP: // label bottom separation size
369 labelbottomsep = lexrc.getFloat();
372 case LT_LABELSEP: // label separator
374 labelsep = subst(lexrc.getString(), 'x', ' ');
378 case LT_PARSEP: // par. separation size
380 parsep = lexrc.getFloat();
383 case LT_FILL_TOP: // fill top flag
385 fill_top = lexrc.getInteger();
388 case LT_FILL_BOTTOM: // fill bottom flag
390 fill_bottom = lexrc.getInteger();
393 case LT_NEWLINE: // newlines allowed?
395 newline_allowed = lexrc.getInteger();
398 case LT_ALIGN: // paragraph align
401 case LT_ALIGNPOSSIBLE: // paragraph allowed align
402 readAlignPossible(lexrc);
405 case LT_LABELSTRING: // label string definition
407 labelstring_ = trim(lexrc.getString());
410 case LT_ENDLABELSTRING: // endlabel string definition
412 endlabelstring_ = trim(lexrc.getString());
415 case LT_LABELSTRING_APPENDIX: // label string appendix definition
417 labelstring_appendix_ = trim(lexrc.getString());
420 case LT_FREE_SPACING: // Allow for free spacing.
422 free_spacing = lexrc.getInteger();
425 case LT_PASS_THRU: // Allow for pass thru.
427 pass_thru = lexrc.getInteger();
430 case LT_SPACING: // setspace.sty
449 void LyXLayout::readAlign(LyXLex & lexrc)
451 keyword_item alignTags[] = {
452 { "block", AT_BLOCK },
453 { "center", AT_CENTER },
454 { "layout", AT_LAYOUT },
456 { "right", AT_RIGHT }
459 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
460 int le = lexrc.lex();
462 case LyXLex::LEX_UNDEF:
463 lexrc.printError("Unknown alignment `$$Token'");
467 switch (static_cast<AlignTags>(le)) {
469 align = LYX_ALIGN_BLOCK;
472 align = LYX_ALIGN_LEFT;
475 align = LYX_ALIGN_RIGHT;
478 align = LYX_ALIGN_CENTER;
481 align = LYX_ALIGN_LAYOUT;
487 void LyXLayout::readAlignPossible(LyXLex & lexrc)
489 keyword_item alignTags[] = {
490 { "block", AT_BLOCK },
491 { "center", AT_CENTER },
492 { "layout", AT_LAYOUT },
494 { "right", AT_RIGHT }
497 lexrc.pushTable(alignTags, AT_LAYOUT);
498 alignpossible = LYX_ALIGN_NONE;
499 int lineno = lexrc.getLineNo();
501 int le = lexrc.lex();
503 case LyXLex::LEX_UNDEF:
504 lexrc.printError("Unknown alignment `$$Token'");
508 switch (static_cast<AlignTags>(le)) {
510 alignpossible |= LYX_ALIGN_BLOCK;
513 alignpossible |= LYX_ALIGN_LEFT;
516 alignpossible |= LYX_ALIGN_RIGHT;
519 alignpossible |= LYX_ALIGN_CENTER;
522 alignpossible |= LYX_ALIGN_LAYOUT;
525 } while (lineno == lexrc.getLineNo());
534 LA_CENTERED_TOP_ENVIRONMENT,
539 LA_COUNTER_SUBSECTION,
540 LA_COUNTER_SUBSUBSECTION,
541 LA_COUNTER_PARAGRAPH,
542 LA_COUNTER_SUBPARAGRAPH,
551 void LyXLayout::readLabelType(LyXLex & lexrc)
553 keyword_item labelTypeTags[] = {
554 { "bibliography", LA_BIBLIO },
555 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
556 { "counter_chapter", LA_COUNTER_CHAPTER },
557 { "counter_enumi", LA_COUNTER_ENUMI },
558 { "counter_enumii", LA_COUNTER_ENUMII },
559 { "counter_enumiii", LA_COUNTER_ENUMIII },
560 { "counter_enumiv", LA_COUNTER_ENUMIV },
561 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
562 { "counter_section", LA_COUNTER_SECTION },
563 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
564 { "counter_subsection", LA_COUNTER_SUBSECTION },
565 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
566 { "manual", LA_MANUAL },
567 { "no_label", LA_NO_LABEL },
568 { "sensitive", LA_SENSITIVE },
569 { "static", LA_STATIC },
570 { "top_environment", LA_TOP_ENVIRONMENT }
573 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
574 int le = lexrc.lex();
576 case LyXLex::LEX_UNDEF:
577 lexrc.printError("Unknown labeltype tag `$$Token'");
581 switch (static_cast<LabelTypeTags>(le)) {
583 labeltype = LABEL_NO_LABEL;
586 labeltype = LABEL_MANUAL;
588 case LA_TOP_ENVIRONMENT:
589 labeltype = LABEL_TOP_ENVIRONMENT;
591 case LA_CENTERED_TOP_ENVIRONMENT:
592 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
595 labeltype = LABEL_STATIC;
598 labeltype = LABEL_SENSITIVE;
600 case LA_COUNTER_CHAPTER:
601 labeltype = LABEL_COUNTER_CHAPTER;
603 case LA_COUNTER_SECTION:
604 labeltype = LABEL_COUNTER_SECTION;
606 case LA_COUNTER_SUBSECTION:
607 labeltype = LABEL_COUNTER_SUBSECTION;
609 case LA_COUNTER_SUBSUBSECTION:
610 labeltype = LABEL_COUNTER_SUBSUBSECTION;
612 case LA_COUNTER_PARAGRAPH:
613 labeltype = LABEL_COUNTER_PARAGRAPH;
615 case LA_COUNTER_SUBPARAGRAPH:
616 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
618 case LA_COUNTER_ENUMI:
619 labeltype = LABEL_COUNTER_ENUMI;
621 case LA_COUNTER_ENUMII:
622 labeltype = LABEL_COUNTER_ENUMII;
624 case LA_COUNTER_ENUMIII:
625 labeltype = LABEL_COUNTER_ENUMIII;
627 case LA_COUNTER_ENUMIV:
628 labeltype = LABEL_COUNTER_ENUMIV;
631 labeltype = LABEL_BIBLIO;
639 keyword_item endlabelTypeTags[] = {
640 { "box", END_LABEL_BOX },
641 { "filled_box", END_LABEL_FILLED_BOX },
642 { "no_label", END_LABEL_NO_LABEL },
643 { "static", END_LABEL_STATIC }
649 void LyXLayout::readEndLabelType(LyXLex & lexrc)
651 pushpophelper pph(lexrc, endlabelTypeTags,
652 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
653 int le = lexrc.lex();
655 case LyXLex::LEX_UNDEF:
656 lexrc.printError("Unknown labeltype tag `$$Token'");
658 case END_LABEL_STATIC:
660 case END_LABEL_FILLED_BOX:
661 case END_LABEL_NO_LABEL:
662 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
665 lyxerr << "Unhandled value " << le
666 << " in LyXLayout::readEndLabelType." << endl;
672 void LyXLayout::readMargin(LyXLex & lexrc)
674 keyword_item marginTags[] = {
675 { "dynamic", MARGIN_DYNAMIC },
676 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
677 { "manual", MARGIN_MANUAL },
678 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
679 { "static", MARGIN_STATIC }
682 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
684 int le = lexrc.lex();
686 case LyXLex::LEX_UNDEF:
687 lexrc.printError("Unknown margin type tag `$$Token'");
692 case MARGIN_FIRST_DYNAMIC:
693 case MARGIN_RIGHT_ADDRESS_BOX:
694 margintype = static_cast<LYX_MARGIN_TYPE>(le);
697 lyxerr << "Unhandled value " << le
698 << " in LyXLayout::readMargin." << endl;
704 void LyXLayout::readLatexType(LyXLex & lexrc)
706 keyword_item latexTypeTags[] = {
707 { "bib_environment", LATEX_BIB_ENVIRONMENT },
708 { "command", LATEX_COMMAND },
709 { "environment", LATEX_ENVIRONMENT },
710 { "item_environment", LATEX_ITEM_ENVIRONMENT },
711 { "list_environment", LATEX_LIST_ENVIRONMENT },
712 { "paragraph", LATEX_PARAGRAPH }
715 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
716 int le = lexrc.lex();
718 case LyXLex::LEX_UNDEF:
719 lexrc.printError("Unknown latextype tag `$$Token'");
721 case LATEX_PARAGRAPH:
723 case LATEX_ENVIRONMENT:
724 case LATEX_ITEM_ENVIRONMENT:
725 case LATEX_BIB_ENVIRONMENT:
726 case LATEX_LIST_ENVIRONMENT:
727 latextype = static_cast<LYX_LATEX_TYPES>(le);
730 lyxerr << "Unhandled value " << le
731 << " in LyXLayout::readLatexType." << endl;
738 ST_SPACING_SINGLE = 1,
745 void LyXLayout::readSpacing(LyXLex & lexrc)
747 keyword_item spacingTags[] = {
748 {"double", ST_SPACING_DOUBLE },
749 {"onehalf", ST_SPACING_ONEHALF },
750 {"other", ST_OTHER },
751 {"single", ST_SPACING_SINGLE }
754 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
755 int le = lexrc.lex();
757 case LyXLex::LEX_UNDEF:
758 lexrc.printError("Unknown spacing token `$$Token'");
762 switch (static_cast<SpacingTags>(le)) {
763 case ST_SPACING_SINGLE:
764 spacing.set(Spacing::Single);
766 case ST_SPACING_ONEHALF:
767 spacing.set(Spacing::Onehalf);
769 case ST_SPACING_DOUBLE:
770 spacing.set(Spacing::Double);
774 spacing.set(Spacing::Other, lexrc.getFloat());
780 string const & LyXLayout::name() const
786 void LyXLayout::setName(string const & n)
792 string const & LyXLayout::obsoleted_by() const
794 return obsoleted_by_;
798 string const & LyXLayout::depends_on() const