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"
23 // The order of the LayoutTags enum is no more important. [asierra300396]
35 //LT_ENVIRONMENT_DEFAULT,
52 LT_LABELSTRING_APPENDIX,
80 // Constructor for layout
81 LyXLayout::LyXLayout ()
83 margintype = MARGIN_STATIC;
84 latextype = LATEX_PARAGRAPH;
89 font = LyXFont(LyXFont::ALL_INHERIT);
90 labelfont = LyXFont(LyXFont::ALL_INHERIT);
91 resfont = LyXFont(LyXFont::ALL_SANE);
92 reslabelfont = LyXFont(LyXFont::ALL_SANE);
100 align = LYX_ALIGN_BLOCK;
101 alignpossible = LYX_ALIGN_BLOCK;
102 labeltype = LABEL_NO_LABEL;
103 endlabeltype = END_LABEL_NO_LABEL;
104 // Should or should not. That is the question.
105 // spacing.set(Spacing::OneHalf);
108 newline_allowed = true;
109 free_spacing = false;
111 is_environment = false;
115 // Reads a layout definition from file
116 bool LyXLayout::Read (LyXLex & lexrc, LyXTextClass const & tclass)
118 // This table is sorted alphabetically [asierra 30March96]
119 keyword_item layoutTags[] = {
120 { "align", LT_ALIGN },
121 { "alignpossible", LT_ALIGNPOSSIBLE },
122 { "bottomsep", LT_BOTTOMSEP },
123 { "copystyle", LT_COPYSTYLE },
124 { "dependson", LT_DEPENDSON },
126 { "endlabelstring", LT_ENDLABELSTRING },
127 { "endlabeltype", LT_ENDLABELTYPE },
128 { "fill_bottom", LT_FILL_BOTTOM },
129 { "fill_top", LT_FILL_TOP },
131 { "freespacing", LT_FREE_SPACING },
132 { "intitle", LT_INTITLE },
133 { "itemsep", LT_ITEMSEP },
134 { "keepempty", LT_KEEPEMPTY },
135 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
136 { "labelfont", LT_LABELFONT },
137 { "labelindent", LT_LABELINDENT },
138 { "labelsep", LT_LABELSEP },
139 { "labelstring", LT_LABELSTRING },
140 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
141 { "labeltype", LT_LABELTYPE },
142 { "latexfooter", LT_LATEXFOOTER },
143 { "latexheader", LT_LATEXHEADER },
144 { "latexname", LT_LATEXNAME },
145 { "latexparagraph", LT_LATEXPARAGRAPH },
146 { "latexparam", LT_LATEXPARAM },
147 { "latextype", LT_LATEXTYPE },
148 { "leftmargin", LT_LEFTMARGIN },
149 { "margin", LT_MARGIN },
150 { "needprotect", LT_NEED_PROTECT },
151 { "newline", LT_NEWLINE },
152 { "nextnoindent", LT_NEXTNOINDENT },
153 { "obsoletedby", LT_OBSOLETEDBY },
154 { "optionalargs", LT_OPTARGS },
155 { "parindent", LT_PARINDENT },
156 { "parsep", LT_PARSEP },
157 { "parskip", LT_PARSKIP },
158 { "passthru", LT_PASS_THRU },
159 { "preamble", LT_PREAMBLE },
160 { "rightmargin", LT_RIGHTMARGIN },
161 { "spacing", LT_SPACING },
162 { "textfont", LT_TEXTFONT },
163 { "topsep", LT_TOPSEP }
167 bool finished = false;
168 lexrc.pushTable(layoutTags, LT_INTITLE);
169 // parse style section
170 while (!finished && lexrc.isOK() && !error) {
171 int le = lexrc.lex();
172 // See comment in lyxrc.C.
174 case LyXLex::LEX_FEOF:
177 case LyXLex::LEX_UNDEF: // parse error
178 lexrc.printError("Unknown layout tag `$$Token'");
183 switch (static_cast<LayoutTags>(le)) {
184 case LT_END: // end of structure
188 case LT_COPYSTYLE: // initialize with a known style
190 string const style = lexrc.getString();
192 if (tclass.hasLayout(style)) {
193 string const tmpname = name_;
194 this->operator=(*tclass[style]);
197 lyxerr << "Cannot copy unknown style `"
199 << "All layouts so far:"
201 LyXTextClass::const_iterator it =
203 LyXTextClass::const_iterator end =
205 for (; it != end; ++it) {
206 lyxerr << (*it)->name()
210 //lexrc.printError("Cannot copy known "
211 // "style `$$Token'");
216 case LT_OBSOLETEDBY: // replace with a known style
218 string const style = lexrc.getString();
220 if (tclass.hasLayout(style)) {
221 string const tmpname = name_;
222 this->operator=(*tclass[style]);
224 if (obsoleted_by().empty())
225 obsoleted_by_ = style;
227 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
229 //lexrc.printError("Cannot replace with"
238 depends_on_ = lexrc.getString();
242 case LT_MARGIN: // margin style definition.
246 case LT_LATEXTYPE: // LaTeX style definition.
247 readLatexType(lexrc);
250 case LT_LATEXHEADER: // header for environments
252 latexheader = lexrc.getString();
255 case LT_LATEXFOOTER: // footer for environments
257 latexfooter = lexrc.getString();
260 case LT_LATEXPARAGRAPH:
262 latexparagraph = lexrc.getString();
266 intitle = lexrc.next() && lexrc.getInteger();
271 optionalargs = lexrc.getInteger();
275 case LT_NEED_PROTECT:
276 needprotect = lexrc.next() && lexrc.getInteger();
280 keepempty = lexrc.next() && lexrc.getInteger();
293 labelfont.lyxRead(lexrc);
296 case LT_NEXTNOINDENT: // Indent next paragraph?
297 if (lexrc.next() && lexrc.getInteger())
300 nextnoindent = false;
305 latexname_ = lexrc.getString();
310 latexparam_ = lexrc.getString();
314 preamble_ = lexrc.getLongString("EndPreamble");
318 readLabelType(lexrc);
321 case LT_ENDLABELTYPE:
322 readEndLabelType(lexrc);
325 case LT_LEFTMARGIN: // left margin type
327 leftmargin = lexrc.getString();
330 case LT_RIGHTMARGIN: // right margin type
332 rightmargin = lexrc.getString();
335 case LT_LABELINDENT: // label indenting flag
337 labelindent = lexrc.getString();
340 case LT_PARINDENT: // paragraph indent. flag
342 parindent = lexrc.getString();
345 case LT_PARSKIP: // paragraph skip size
347 parskip = lexrc.getFloat();
350 case LT_ITEMSEP: // item separation size
352 itemsep = lexrc.getFloat();
355 case LT_TOPSEP: // top separation size
357 topsep = lexrc.getFloat();
360 case LT_BOTTOMSEP: // bottom separation size
362 bottomsep = lexrc.getFloat();
365 case LT_LABEL_BOTTOMSEP: // label bottom separation size
367 labelbottomsep = lexrc.getFloat();
370 case LT_LABELSEP: // label separator
372 labelsep = subst(lexrc.getString(), 'x', ' ');
376 case LT_PARSEP: // par. separation size
378 parsep = lexrc.getFloat();
381 case LT_FILL_TOP: // fill top flag
383 fill_top = lexrc.getInteger();
386 case LT_FILL_BOTTOM: // fill bottom flag
388 fill_bottom = lexrc.getInteger();
391 case LT_NEWLINE: // newlines allowed?
393 newline_allowed = lexrc.getInteger();
396 case LT_ALIGN: // paragraph align
399 case LT_ALIGNPOSSIBLE: // paragraph allowed align
400 readAlignPossible(lexrc);
403 case LT_LABELSTRING: // label string definition
405 labelstring_ = trim(lexrc.getString());
408 case LT_ENDLABELSTRING: // endlabel string definition
410 endlabelstring_ = trim(lexrc.getString());
413 case LT_LABELSTRING_APPENDIX: // label string appendix definition
415 labelstring_appendix_ = trim(lexrc.getString());
418 case LT_FREE_SPACING: // Allow for free spacing.
420 free_spacing = lexrc.getInteger();
423 case LT_PASS_THRU: // Allow for pass thru.
425 pass_thru = lexrc.getInteger();
428 case LT_SPACING: // setspace.sty
447 void LyXLayout::readAlign(LyXLex & lexrc)
449 keyword_item alignTags[] = {
450 { "block", AT_BLOCK },
451 { "center", AT_CENTER },
452 { "layout", AT_LAYOUT },
454 { "right", AT_RIGHT }
457 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
458 int le = lexrc.lex();
460 case LyXLex::LEX_UNDEF:
461 lexrc.printError("Unknown alignment `$$Token'");
465 switch (static_cast<AlignTags>(le)) {
467 align = LYX_ALIGN_BLOCK;
470 align = LYX_ALIGN_LEFT;
473 align = LYX_ALIGN_RIGHT;
476 align = LYX_ALIGN_CENTER;
479 align = LYX_ALIGN_LAYOUT;
485 void LyXLayout::readAlignPossible(LyXLex & lexrc)
487 keyword_item alignTags[] = {
488 { "block", AT_BLOCK },
489 { "center", AT_CENTER },
490 { "layout", AT_LAYOUT },
492 { "right", AT_RIGHT }
495 lexrc.pushTable(alignTags, AT_LAYOUT);
496 alignpossible = LYX_ALIGN_NONE;
497 int lineno = lexrc.getLineNo();
499 int le = lexrc.lex();
501 case LyXLex::LEX_UNDEF:
502 lexrc.printError("Unknown alignment `$$Token'");
506 switch (static_cast<AlignTags>(le)) {
508 alignpossible |= LYX_ALIGN_BLOCK;
511 alignpossible |= LYX_ALIGN_LEFT;
514 alignpossible |= LYX_ALIGN_RIGHT;
517 alignpossible |= LYX_ALIGN_CENTER;
520 alignpossible |= LYX_ALIGN_LAYOUT;
523 } while (lineno == lexrc.getLineNo());
532 LA_CENTERED_TOP_ENVIRONMENT,
537 LA_COUNTER_SUBSECTION,
538 LA_COUNTER_SUBSUBSECTION,
539 LA_COUNTER_PARAGRAPH,
540 LA_COUNTER_SUBPARAGRAPH,
549 void LyXLayout::readLabelType(LyXLex & lexrc)
551 keyword_item labelTypeTags[] = {
552 { "bibliography", LA_BIBLIO },
553 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
554 { "counter_chapter", LA_COUNTER_CHAPTER },
555 { "counter_enumi", LA_COUNTER_ENUMI },
556 { "counter_enumii", LA_COUNTER_ENUMII },
557 { "counter_enumiii", LA_COUNTER_ENUMIII },
558 { "counter_enumiv", LA_COUNTER_ENUMIV },
559 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
560 { "counter_section", LA_COUNTER_SECTION },
561 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
562 { "counter_subsection", LA_COUNTER_SUBSECTION },
563 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
564 { "manual", LA_MANUAL },
565 { "no_label", LA_NO_LABEL },
566 { "sensitive", LA_SENSITIVE },
567 { "static", LA_STATIC },
568 { "top_environment", LA_TOP_ENVIRONMENT }
571 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
572 int le = lexrc.lex();
574 case LyXLex::LEX_UNDEF:
575 lexrc.printError("Unknown labeltype tag `$$Token'");
579 switch (static_cast<LabelTypeTags>(le)) {
581 labeltype = LABEL_NO_LABEL;
584 labeltype = LABEL_MANUAL;
586 case LA_TOP_ENVIRONMENT:
587 labeltype = LABEL_TOP_ENVIRONMENT;
589 case LA_CENTERED_TOP_ENVIRONMENT:
590 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
593 labeltype = LABEL_STATIC;
596 labeltype = LABEL_SENSITIVE;
598 case LA_COUNTER_CHAPTER:
599 labeltype = LABEL_COUNTER_CHAPTER;
601 case LA_COUNTER_SECTION:
602 labeltype = LABEL_COUNTER_SECTION;
604 case LA_COUNTER_SUBSECTION:
605 labeltype = LABEL_COUNTER_SUBSECTION;
607 case LA_COUNTER_SUBSUBSECTION:
608 labeltype = LABEL_COUNTER_SUBSUBSECTION;
610 case LA_COUNTER_PARAGRAPH:
611 labeltype = LABEL_COUNTER_PARAGRAPH;
613 case LA_COUNTER_SUBPARAGRAPH:
614 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
616 case LA_COUNTER_ENUMI:
617 labeltype = LABEL_COUNTER_ENUMI;
619 case LA_COUNTER_ENUMII:
620 labeltype = LABEL_COUNTER_ENUMII;
622 case LA_COUNTER_ENUMIII:
623 labeltype = LABEL_COUNTER_ENUMIII;
625 case LA_COUNTER_ENUMIV:
626 labeltype = LABEL_COUNTER_ENUMIV;
629 labeltype = LABEL_BIBLIO;
637 keyword_item endlabelTypeTags[] = {
638 { "box", END_LABEL_BOX },
639 { "filled_box", END_LABEL_FILLED_BOX },
640 { "no_label", END_LABEL_NO_LABEL },
641 { "static", END_LABEL_STATIC }
647 void LyXLayout::readEndLabelType(LyXLex & lexrc)
649 pushpophelper pph(lexrc, endlabelTypeTags,
650 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
651 int le = lexrc.lex();
653 case LyXLex::LEX_UNDEF:
654 lexrc.printError("Unknown labeltype tag `$$Token'");
656 case END_LABEL_STATIC:
658 case END_LABEL_FILLED_BOX:
659 case END_LABEL_NO_LABEL:
660 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
663 lyxerr << "Unhandled value " << le
664 << " in LyXLayout::readEndLabelType." << endl;
670 void LyXLayout::readMargin(LyXLex & lexrc)
672 keyword_item marginTags[] = {
673 { "dynamic", MARGIN_DYNAMIC },
674 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
675 { "manual", MARGIN_MANUAL },
676 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
677 { "static", MARGIN_STATIC }
680 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
682 int le = lexrc.lex();
684 case LyXLex::LEX_UNDEF:
685 lexrc.printError("Unknown margin type tag `$$Token'");
690 case MARGIN_FIRST_DYNAMIC:
691 case MARGIN_RIGHT_ADDRESS_BOX:
692 margintype = static_cast<LYX_MARGIN_TYPE>(le);
695 lyxerr << "Unhandled value " << le
696 << " in LyXLayout::readMargin." << endl;
702 void LyXLayout::readLatexType(LyXLex & lexrc)
704 keyword_item latexTypeTags[] = {
705 { "bib_environment", LATEX_BIB_ENVIRONMENT },
706 { "command", LATEX_COMMAND },
707 { "environment", LATEX_ENVIRONMENT },
708 { "item_environment", LATEX_ITEM_ENVIRONMENT },
709 { "list_environment", LATEX_LIST_ENVIRONMENT },
710 { "paragraph", LATEX_PARAGRAPH }
713 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
714 int le = lexrc.lex();
716 case LyXLex::LEX_UNDEF:
717 lexrc.printError("Unknown latextype tag `$$Token'");
719 case LATEX_PARAGRAPH:
721 case LATEX_ENVIRONMENT:
722 case LATEX_ITEM_ENVIRONMENT:
723 case LATEX_BIB_ENVIRONMENT:
724 case LATEX_LIST_ENVIRONMENT:
725 latextype = static_cast<LYX_LATEX_TYPES>(le);
728 lyxerr << "Unhandled value " << le
729 << " in LyXLayout::readLatexType." << endl;
736 ST_SPACING_SINGLE = 1,
743 void LyXLayout::readSpacing(LyXLex & lexrc)
745 keyword_item spacingTags[] = {
746 {"double", ST_SPACING_DOUBLE },
747 {"onehalf", ST_SPACING_ONEHALF },
748 {"other", ST_OTHER },
749 {"single", ST_SPACING_SINGLE }
752 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
753 int le = lexrc.lex();
755 case LyXLex::LEX_UNDEF:
756 lexrc.printError("Unknown spacing token `$$Token'");
760 switch (static_cast<SpacingTags>(le)) {
761 case ST_SPACING_SINGLE:
762 spacing.set(Spacing::Single);
764 case ST_SPACING_ONEHALF:
765 spacing.set(Spacing::Onehalf);
767 case ST_SPACING_DOUBLE:
768 spacing.set(Spacing::Double);
772 spacing.set(Spacing::Other, lexrc.getFloat());
778 string const & LyXLayout::name() const
784 void LyXLayout::setName(string const & n)
790 string const & LyXLayout::obsoleted_by() const
792 return obsoleted_by_;
796 string const & LyXLayout::depends_on() const