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 * ======================================================
15 #pragma implementation
18 #include "lyxlayout.h"
19 #include "lyxtextclass.h"
23 #include "support/lstrings.h"
27 // The order of the LayoutTags enum is no more important. [asierra300396]
39 //LT_ENVIRONMENT_DEFAULT,
56 LT_LABELSTRING_APPENDIX,
81 // Constructor for layout
82 LyXLayout::LyXLayout ()
84 margintype = MARGIN_STATIC;
85 latextype = LATEX_PARAGRAPH;
90 font = LyXFont(LyXFont::ALL_INHERIT);
91 labelfont = LyXFont(LyXFont::ALL_INHERIT);
92 resfont = LyXFont(LyXFont::ALL_SANE);
93 reslabelfont = LyXFont(LyXFont::ALL_SANE);
101 align = LYX_ALIGN_BLOCK;
102 alignpossible = LYX_ALIGN_BLOCK;
103 labeltype = LABEL_NO_LABEL;
104 endlabeltype = END_LABEL_NO_LABEL;
105 // Should or should not. That is the question.
106 // spacing.set(Spacing::OneHalf);
109 newline_allowed = true;
110 free_spacing = 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 { "latexname", LT_LATEXNAME },
143 { "latexparam", LT_LATEXPARAM },
144 { "latextype", LT_LATEXTYPE },
145 { "leftmargin", LT_LEFTMARGIN },
146 { "margin", LT_MARGIN },
147 { "needprotect", LT_NEED_PROTECT },
148 { "newline", LT_NEWLINE },
149 { "nextnoindent", LT_NEXTNOINDENT },
150 { "obsoletedby", LT_OBSOLETEDBY },
151 { "optionalargs", LT_OPTARGS },
152 { "parindent", LT_PARINDENT },
153 { "parsep", LT_PARSEP },
154 { "parskip", LT_PARSKIP },
155 { "passthru", LT_PASS_THRU },
156 { "preamble", LT_PREAMBLE },
157 { "rightmargin", LT_RIGHTMARGIN },
158 { "spacing", LT_SPACING },
159 { "textfont", LT_TEXTFONT },
160 { "topsep", LT_TOPSEP }
164 bool finished = false;
165 lexrc.pushTable(layoutTags, LT_INTITLE);
166 // parse style section
167 while (!finished && lexrc.isOK() && !error) {
168 int le = lexrc.lex();
169 // See comment in lyxrc.C.
171 case LyXLex::LEX_FEOF:
174 case LyXLex::LEX_UNDEF: // parse error
175 lexrc.printError("Unknown layout tag `$$Token'");
180 switch (static_cast<LayoutTags>(le)) {
181 case LT_END: // end of structure
185 case LT_COPYSTYLE: // initialize with a known style
187 string const style = lexrc.getString();
189 if (tclass.hasLayout(style)) {
190 string const tmpname = name_;
191 this->operator=(*tclass[style]);
194 lyxerr << "Cannot copy unknown style `"
196 << "All layouts so far:"
198 LyXTextClass::const_iterator it =
200 LyXTextClass::const_iterator end =
202 for (; it != end; ++it) {
203 lyxerr << (*it)->name()
207 //lexrc.printError("Cannot copy known "
208 // "style `$$Token'");
213 case LT_OBSOLETEDBY: // replace with a known style
215 string const style = lexrc.getString();
217 if (tclass.hasLayout(style)) {
218 string const tmpname = name_;
219 this->operator=(*tclass[style]);
221 if (obsoleted_by().empty())
222 obsoleted_by_ = style;
224 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
226 //lexrc.printError("Cannot replace with"
235 depends_on_ = lexrc.getString();
239 case LT_MARGIN: // Margin style definition.
243 case LT_LATEXTYPE: // Latex style definition.
244 readLatexType(lexrc);
248 intitle = lexrc.next() && lexrc.getInteger();
253 optionalargs = lexrc.getInteger();
257 case LT_NEED_PROTECT:
258 needprotect = lexrc.next() && lexrc.getInteger();
262 keepempty = lexrc.next() && lexrc.getInteger();
275 labelfont.lyxRead(lexrc);
278 case LT_NEXTNOINDENT: // Indent next paragraph?
279 if (lexrc.next() && lexrc.getInteger())
282 nextnoindent = false;
287 latexname_ = lexrc.getString();
292 latexparam_ = lexrc.getString();
296 preamble_ = lexrc.getLongString("EndPreamble");
300 readLabelType(lexrc);
303 case LT_ENDLABELTYPE:
304 readEndLabelType(lexrc);
307 case LT_LEFTMARGIN: // left margin type
309 leftmargin = lexrc.getString();
312 case LT_RIGHTMARGIN: // right margin type
314 rightmargin = lexrc.getString();
317 case LT_LABELINDENT: // label indenting flag
319 labelindent = lexrc.getString();
322 case LT_PARINDENT: // paragraph indent. flag
324 parindent = lexrc.getString();
327 case LT_PARSKIP: // paragraph skip size
329 parskip = lexrc.getFloat();
332 case LT_ITEMSEP: // item separation size
334 itemsep = lexrc.getFloat();
337 case LT_TOPSEP: // top separation size
339 topsep = lexrc.getFloat();
342 case LT_BOTTOMSEP: // bottom separation size
344 bottomsep = lexrc.getFloat();
347 case LT_LABEL_BOTTOMSEP: // label bottom separation size
349 labelbottomsep = lexrc.getFloat();
352 case LT_LABELSEP: // label separator
354 labelsep = subst(lexrc.getString(), 'x', ' ');
358 case LT_PARSEP: // par. separation size
360 parsep = lexrc.getFloat();
363 case LT_FILL_TOP: // fill top flag
365 fill_top = lexrc.getInteger();
368 case LT_FILL_BOTTOM: // fill bottom flag
370 fill_bottom = lexrc.getInteger();
373 case LT_NEWLINE: // newlines allowed?
375 newline_allowed = lexrc.getInteger();
378 case LT_ALIGN: // paragraph align
381 case LT_ALIGNPOSSIBLE: // paragraph allowed align
382 readAlignPossible(lexrc);
385 case LT_LABELSTRING: // label string definition
387 labelstring_ = lexrc.getString();
390 case LT_ENDLABELSTRING: // endlabel string definition
392 endlabelstring_ = lexrc.getString();
395 case LT_LABELSTRING_APPENDIX: // label string appendix definition
397 labelstring_appendix_ = lexrc.getString();
400 case LT_FREE_SPACING: // Allow for free spacing.
402 free_spacing = lexrc.getInteger();
405 case LT_PASS_THRU: // Allow for pass thru.
407 pass_thru = lexrc.getInteger();
410 case LT_SPACING: // setspace.sty
429 void LyXLayout::readAlign(LyXLex & lexrc)
431 keyword_item alignTags[] = {
432 { "block", AT_BLOCK },
433 { "center", AT_CENTER },
434 { "layout", AT_LAYOUT },
436 { "right", AT_RIGHT }
439 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
440 int le = lexrc.lex();
442 case LyXLex::LEX_UNDEF:
443 lexrc.printError("Unknown alignment `$$Token'");
447 switch (static_cast<AlignTags>(le)) {
449 align = LYX_ALIGN_BLOCK;
452 align = LYX_ALIGN_LEFT;
455 align = LYX_ALIGN_RIGHT;
458 align = LYX_ALIGN_CENTER;
461 align = LYX_ALIGN_LAYOUT;
467 void LyXLayout::readAlignPossible(LyXLex & lexrc)
469 keyword_item alignTags[] = {
470 { "block", AT_BLOCK },
471 { "center", AT_CENTER },
472 { "layout", AT_LAYOUT },
474 { "right", AT_RIGHT }
477 lexrc.pushTable(alignTags, AT_LAYOUT);
478 alignpossible = LYX_ALIGN_NONE;
479 int lineno = lexrc.getLineNo();
481 int le = lexrc.lex();
483 case LyXLex::LEX_UNDEF:
484 lexrc.printError("Unknown alignment `$$Token'");
488 switch (static_cast<AlignTags>(le)) {
490 alignpossible |= LYX_ALIGN_BLOCK;
493 alignpossible |= LYX_ALIGN_LEFT;
496 alignpossible |= LYX_ALIGN_RIGHT;
499 alignpossible |= LYX_ALIGN_CENTER;
502 alignpossible |= LYX_ALIGN_LAYOUT;
505 } while (lineno == lexrc.getLineNo());
514 LA_CENTERED_TOP_ENVIRONMENT,
519 LA_COUNTER_SUBSECTION,
520 LA_COUNTER_SUBSUBSECTION,
521 LA_COUNTER_PARAGRAPH,
522 LA_COUNTER_SUBPARAGRAPH,
531 void LyXLayout::readLabelType(LyXLex & lexrc)
533 keyword_item labelTypeTags[] = {
534 { "bibliography", LA_BIBLIO },
535 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
536 { "counter_chapter", LA_COUNTER_CHAPTER },
537 { "counter_enumi", LA_COUNTER_ENUMI },
538 { "counter_enumii", LA_COUNTER_ENUMII },
539 { "counter_enumiii", LA_COUNTER_ENUMIII },
540 { "counter_enumiv", LA_COUNTER_ENUMIV },
541 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
542 { "counter_section", LA_COUNTER_SECTION },
543 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
544 { "counter_subsection", LA_COUNTER_SUBSECTION },
545 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
546 { "manual", LA_MANUAL },
547 { "no_label", LA_NO_LABEL },
548 { "sensitive", LA_SENSITIVE },
549 { "static", LA_STATIC },
550 { "top_environment", LA_TOP_ENVIRONMENT }
553 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
554 int le = lexrc.lex();
556 case LyXLex::LEX_UNDEF:
557 lexrc.printError("Unknown labeltype tag `$$Token'");
561 switch (static_cast<LabelTypeTags>(le)) {
563 labeltype = LABEL_NO_LABEL;
566 labeltype = LABEL_MANUAL;
568 case LA_TOP_ENVIRONMENT:
569 labeltype = LABEL_TOP_ENVIRONMENT;
571 case LA_CENTERED_TOP_ENVIRONMENT:
572 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
575 labeltype = LABEL_STATIC;
578 labeltype = LABEL_SENSITIVE;
580 case LA_COUNTER_CHAPTER:
581 labeltype = LABEL_COUNTER_CHAPTER;
583 case LA_COUNTER_SECTION:
584 labeltype = LABEL_COUNTER_SECTION;
586 case LA_COUNTER_SUBSECTION:
587 labeltype = LABEL_COUNTER_SUBSECTION;
589 case LA_COUNTER_SUBSUBSECTION:
590 labeltype = LABEL_COUNTER_SUBSUBSECTION;
592 case LA_COUNTER_PARAGRAPH:
593 labeltype = LABEL_COUNTER_PARAGRAPH;
595 case LA_COUNTER_SUBPARAGRAPH:
596 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
598 case LA_COUNTER_ENUMI:
599 labeltype = LABEL_COUNTER_ENUMI;
601 case LA_COUNTER_ENUMII:
602 labeltype = LABEL_COUNTER_ENUMII;
604 case LA_COUNTER_ENUMIII:
605 labeltype = LABEL_COUNTER_ENUMIII;
607 case LA_COUNTER_ENUMIV:
608 labeltype = LABEL_COUNTER_ENUMIV;
611 labeltype = LABEL_BIBLIO;
619 keyword_item endlabelTypeTags[] = {
620 { "box", END_LABEL_BOX },
621 { "filled_box", END_LABEL_FILLED_BOX },
622 { "no_label", END_LABEL_NO_LABEL },
623 { "static", END_LABEL_STATIC }
629 void LyXLayout::readEndLabelType(LyXLex & lexrc)
631 pushpophelper pph(lexrc, endlabelTypeTags,
632 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
633 int le = lexrc.lex();
635 case LyXLex::LEX_UNDEF:
636 lexrc.printError("Unknown labeltype tag `$$Token'");
638 case END_LABEL_STATIC:
640 case END_LABEL_FILLED_BOX:
641 case END_LABEL_NO_LABEL:
642 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
645 lyxerr << "Unhandled value " << le
646 << " in LyXLayout::readEndLabelType." << endl;
652 void LyXLayout::readMargin(LyXLex & lexrc)
654 keyword_item marginTags[] = {
655 { "dynamic", MARGIN_DYNAMIC },
656 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
657 { "manual", MARGIN_MANUAL },
658 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
659 { "static", MARGIN_STATIC }
662 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
664 int le = lexrc.lex();
666 case LyXLex::LEX_UNDEF:
667 lexrc.printError("Unknown margin type tag `$$Token'");
672 case MARGIN_FIRST_DYNAMIC:
673 case MARGIN_RIGHT_ADDRESS_BOX:
674 margintype = static_cast<LYX_MARGIN_TYPE>(le);
677 lyxerr << "Unhandled value " << le
678 << " in LyXLayout::readMargin." << endl;
684 void LyXLayout::readLatexType(LyXLex & lexrc)
686 keyword_item latexTypeTags[] = {
687 { "command", LATEX_COMMAND },
688 { "environment", LATEX_ENVIRONMENT },
689 { "item_environment", LATEX_ITEM_ENVIRONMENT },
690 { "list_environment", LATEX_LIST_ENVIRONMENT },
691 { "paragraph", LATEX_PARAGRAPH }
694 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
695 int le = lexrc.lex();
697 case LyXLex::LEX_UNDEF:
698 lexrc.printError("Unknown latextype tag `$$Token'");
700 case LATEX_PARAGRAPH:
702 case LATEX_ENVIRONMENT:
703 case LATEX_ITEM_ENVIRONMENT:
704 case LATEX_LIST_ENVIRONMENT:
705 latextype = static_cast<LYX_LATEX_TYPES>(le);
708 lyxerr << "Unhandled value " << le
709 << " in LyXLayout::readLatexType." << endl;
716 ST_SPACING_SINGLE = 1,
723 void LyXLayout::readSpacing(LyXLex & lexrc)
725 keyword_item spacingTags[] = {
726 {"double", ST_SPACING_DOUBLE },
727 {"onehalf", ST_SPACING_ONEHALF },
728 {"other", ST_OTHER },
729 {"single", ST_SPACING_SINGLE }
732 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
733 int le = lexrc.lex();
735 case LyXLex::LEX_UNDEF:
736 lexrc.printError("Unknown spacing token `$$Token'");
740 switch (static_cast<SpacingTags>(le)) {
741 case ST_SPACING_SINGLE:
742 spacing.set(Spacing::Single);
744 case ST_SPACING_ONEHALF:
745 spacing.set(Spacing::Onehalf);
747 case ST_SPACING_DOUBLE:
748 spacing.set(Spacing::Double);
752 spacing.set(Spacing::Other, lexrc.getFloat());
758 string const & LyXLayout::name() const
764 void LyXLayout::setName(string const & n)
770 string const & LyXLayout::obsoleted_by() const
772 return obsoleted_by_;
776 string const & LyXLayout::depends_on() const