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,
80 // Constructor for layout
81 LyXLayout::LyXLayout ()
83 margintype = MARGIN_STATIC;
84 latextype = LATEX_PARAGRAPH;
88 font = LyXFont(LyXFont::ALL_INHERIT);
89 labelfont = LyXFont(LyXFont::ALL_INHERIT);
90 resfont = LyXFont(LyXFont::ALL_SANE);
91 reslabelfont = LyXFont(LyXFont::ALL_SANE);
99 align = LYX_ALIGN_BLOCK;
100 alignpossible = LYX_ALIGN_BLOCK;
101 labeltype = LABEL_NO_LABEL;
102 endlabeltype = END_LABEL_NO_LABEL;
103 // Should or should not. That is the question.
104 // spacing.set(Spacing::OneHalf);
107 newline_allowed = true;
108 free_spacing = false;
113 // Reads a layout definition from file
114 bool LyXLayout::Read (LyXLex & lexrc, LyXTextClass const & tclass)
116 // This table is sorted alphabetically [asierra 30March96]
117 keyword_item layoutTags[] = {
118 { "align", LT_ALIGN },
119 { "alignpossible", LT_ALIGNPOSSIBLE },
120 { "bottomsep", LT_BOTTOMSEP },
121 { "copystyle", LT_COPYSTYLE },
122 { "dependson", LT_DEPENDSON },
124 { "endlabelstring", LT_ENDLABELSTRING },
125 { "endlabeltype", LT_ENDLABELTYPE },
126 { "fill_bottom", LT_FILL_BOTTOM },
127 { "fill_top", LT_FILL_TOP },
129 { "freespacing", LT_FREE_SPACING },
130 { "intitle", LT_INTITLE },
131 { "itemsep", LT_ITEMSEP },
132 { "keepempty", LT_KEEPEMPTY },
133 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
134 { "labelfont", LT_LABELFONT },
135 { "labelindent", LT_LABELINDENT },
136 { "labelsep", LT_LABELSEP },
137 { "labelstring", LT_LABELSTRING },
138 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
139 { "labeltype", LT_LABELTYPE },
140 { "latexname", LT_LATEXNAME },
141 { "latexparam", LT_LATEXPARAM },
142 { "latextype", LT_LATEXTYPE },
143 { "leftmargin", LT_LEFTMARGIN },
144 { "margin", LT_MARGIN },
145 { "needprotect", LT_NEED_PROTECT },
146 { "newline", LT_NEWLINE },
147 { "nextnoindent", LT_NEXTNOINDENT },
148 { "obsoletedby", LT_OBSOLETEDBY },
149 { "parindent", LT_PARINDENT },
150 { "parsep", LT_PARSEP },
151 { "parskip", LT_PARSKIP },
152 { "passthru", LT_PASS_THRU },
153 { "preamble", LT_PREAMBLE },
154 { "rightmargin", LT_RIGHTMARGIN },
155 { "spacing", LT_SPACING },
156 { "textfont", LT_TEXTFONT },
157 { "topsep", LT_TOPSEP }
161 bool finished = false;
162 lexrc.pushTable(layoutTags, LT_INTITLE);
163 // parse style section
164 while (!finished && lexrc.isOK() && !error) {
165 int le = lexrc.lex();
166 // See comment in lyxrc.C.
168 case LyXLex::LEX_FEOF:
171 case LyXLex::LEX_UNDEF: // parse error
172 lexrc.printError("Unknown layout tag `$$Token'");
177 switch (static_cast<LayoutTags>(le)) {
178 case LT_END: // end of structure
182 case LT_COPYSTYLE: // initialize with a known style
184 string const style = lexrc.getString();
186 if (tclass.hasLayout(style)) {
187 string const tmpname = name_;
188 this->operator=(*tclass[style]);
191 lyxerr << "Cannot copy unknown style `"
193 << "All layouts so far:"
195 LyXTextClass::const_iterator it =
197 LyXTextClass::const_iterator end =
199 for (; it != end; ++it) {
200 lyxerr << (*it)->name()
204 //lexrc.printError("Cannot copy known "
205 // "style `$$Token'");
210 case LT_OBSOLETEDBY: // replace with a known style
212 string const style = lexrc.getString();
214 if (tclass.hasLayout(style)) {
215 string const tmpname = name_;
216 this->operator=(*tclass[style]);
218 if (obsoleted_by().empty())
219 obsoleted_by_ = style;
221 lyxerr << "Cannot replace with unknown style `" << style << "'" << endl;
223 //lexrc.printError("Cannot replace with"
232 depends_on_ = lexrc.getString();
236 case LT_MARGIN: // Margin style definition.
240 case LT_LATEXTYPE: // Latex style definition.
241 readLatexType(lexrc);
245 intitle = lexrc.next() && lexrc.getInteger();
248 case LT_NEED_PROTECT:
249 needprotect = lexrc.next() && lexrc.getInteger();
253 keepempty = lexrc.next() && lexrc.getInteger();
266 labelfont.lyxRead(lexrc);
269 case LT_NEXTNOINDENT: // Indent next paragraph?
270 if (lexrc.next() && lexrc.getInteger())
273 nextnoindent = false;
278 latexname_ = lexrc.getString();
283 latexparam_ = lexrc.getString();
287 preamble_ = lexrc.getLongString("EndPreamble");
291 readLabelType(lexrc);
294 case LT_ENDLABELTYPE:
295 readEndLabelType(lexrc);
298 case LT_LEFTMARGIN: // left margin type
300 leftmargin = lexrc.getString();
303 case LT_RIGHTMARGIN: // right margin type
305 rightmargin = lexrc.getString();
308 case LT_LABELINDENT: // label indenting flag
310 labelindent = lexrc.getString();
313 case LT_PARINDENT: // paragraph indent. flag
315 parindent = lexrc.getString();
318 case LT_PARSKIP: // paragraph skip size
320 parskip = lexrc.getFloat();
323 case LT_ITEMSEP: // item separation size
325 itemsep = lexrc.getFloat();
328 case LT_TOPSEP: // top separation size
330 topsep = lexrc.getFloat();
333 case LT_BOTTOMSEP: // bottom separation size
335 bottomsep = lexrc.getFloat();
338 case LT_LABEL_BOTTOMSEP: // label bottom separation size
340 labelbottomsep = lexrc.getFloat();
343 case LT_LABELSEP: // label separator
345 labelsep = subst(lexrc.getString(), 'x', ' ');
349 case LT_PARSEP: // par. separation size
351 parsep = lexrc.getFloat();
354 case LT_FILL_TOP: // fill top flag
356 fill_top = lexrc.getInteger();
359 case LT_FILL_BOTTOM: // fill bottom flag
361 fill_bottom = lexrc.getInteger();
364 case LT_NEWLINE: // newlines allowed?
366 newline_allowed = lexrc.getInteger();
369 case LT_ALIGN: // paragraph align
372 case LT_ALIGNPOSSIBLE: // paragraph allowed align
373 readAlignPossible(lexrc);
376 case LT_LABELSTRING: // label string definition
378 labelstring_ = lexrc.getString();
381 case LT_ENDLABELSTRING: // endlabel string definition
383 endlabelstring_ = lexrc.getString();
386 case LT_LABELSTRING_APPENDIX: // label string appendix definition
388 labelstring_appendix_ = lexrc.getString();
391 case LT_FREE_SPACING: // Allow for free spacing.
393 free_spacing = lexrc.getInteger();
396 case LT_PASS_THRU: // Allow for pass thru.
398 pass_thru = lexrc.getInteger();
401 case LT_SPACING: // setspace.sty
420 void LyXLayout::readAlign(LyXLex & lexrc)
422 keyword_item alignTags[] = {
423 { "block", AT_BLOCK },
424 { "center", AT_CENTER },
425 { "layout", AT_LAYOUT },
427 { "right", AT_RIGHT }
430 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
431 int le = lexrc.lex();
433 case LyXLex::LEX_UNDEF:
434 lexrc.printError("Unknown alignment `$$Token'");
438 switch (static_cast<AlignTags>(le)) {
440 align = LYX_ALIGN_BLOCK;
443 align = LYX_ALIGN_LEFT;
446 align = LYX_ALIGN_RIGHT;
449 align = LYX_ALIGN_CENTER;
452 align = LYX_ALIGN_LAYOUT;
458 void LyXLayout::readAlignPossible(LyXLex & lexrc)
460 keyword_item alignTags[] = {
461 { "block", AT_BLOCK },
462 { "center", AT_CENTER },
463 { "layout", AT_LAYOUT },
465 { "right", AT_RIGHT }
468 lexrc.pushTable(alignTags, AT_LAYOUT);
469 alignpossible = LYX_ALIGN_NONE;
470 int lineno = lexrc.getLineNo();
472 int le = lexrc.lex();
474 case LyXLex::LEX_UNDEF:
475 lexrc.printError("Unknown alignment `$$Token'");
479 switch (static_cast<AlignTags>(le)) {
481 alignpossible |= LYX_ALIGN_BLOCK;
484 alignpossible |= LYX_ALIGN_LEFT;
487 alignpossible |= LYX_ALIGN_RIGHT;
490 alignpossible |= LYX_ALIGN_CENTER;
493 alignpossible |= LYX_ALIGN_LAYOUT;
496 } while (lineno == lexrc.getLineNo());
505 LA_CENTERED_TOP_ENVIRONMENT,
510 LA_COUNTER_SUBSECTION,
511 LA_COUNTER_SUBSUBSECTION,
512 LA_COUNTER_PARAGRAPH,
513 LA_COUNTER_SUBPARAGRAPH,
522 void LyXLayout::readLabelType(LyXLex & lexrc)
524 keyword_item labelTypeTags[] = {
525 { "bibliography", LA_BIBLIO },
526 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
527 { "counter_chapter", LA_COUNTER_CHAPTER },
528 { "counter_enumi", LA_COUNTER_ENUMI },
529 { "counter_enumii", LA_COUNTER_ENUMII },
530 { "counter_enumiii", LA_COUNTER_ENUMIII },
531 { "counter_enumiv", LA_COUNTER_ENUMIV },
532 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
533 { "counter_section", LA_COUNTER_SECTION },
534 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
535 { "counter_subsection", LA_COUNTER_SUBSECTION },
536 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
537 { "manual", LA_MANUAL },
538 { "no_label", LA_NO_LABEL },
539 { "sensitive", LA_SENSITIVE },
540 { "static", LA_STATIC },
541 { "top_environment", LA_TOP_ENVIRONMENT }
544 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
545 int le = lexrc.lex();
547 case LyXLex::LEX_UNDEF:
548 lexrc.printError("Unknown labeltype tag `$$Token'");
552 switch (static_cast<LabelTypeTags>(le)) {
554 labeltype = LABEL_NO_LABEL;
557 labeltype = LABEL_MANUAL;
559 case LA_TOP_ENVIRONMENT:
560 labeltype = LABEL_TOP_ENVIRONMENT;
562 case LA_CENTERED_TOP_ENVIRONMENT:
563 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
566 labeltype = LABEL_STATIC;
569 labeltype = LABEL_SENSITIVE;
571 case LA_COUNTER_CHAPTER:
572 labeltype = LABEL_COUNTER_CHAPTER;
574 case LA_COUNTER_SECTION:
575 labeltype = LABEL_COUNTER_SECTION;
577 case LA_COUNTER_SUBSECTION:
578 labeltype = LABEL_COUNTER_SUBSECTION;
580 case LA_COUNTER_SUBSUBSECTION:
581 labeltype = LABEL_COUNTER_SUBSUBSECTION;
583 case LA_COUNTER_PARAGRAPH:
584 labeltype = LABEL_COUNTER_PARAGRAPH;
586 case LA_COUNTER_SUBPARAGRAPH:
587 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
589 case LA_COUNTER_ENUMI:
590 labeltype = LABEL_COUNTER_ENUMI;
592 case LA_COUNTER_ENUMII:
593 labeltype = LABEL_COUNTER_ENUMII;
595 case LA_COUNTER_ENUMIII:
596 labeltype = LABEL_COUNTER_ENUMIII;
598 case LA_COUNTER_ENUMIV:
599 labeltype = LABEL_COUNTER_ENUMIV;
602 labeltype = LABEL_BIBLIO;
610 keyword_item endlabelTypeTags[] = {
611 { "box", END_LABEL_BOX },
612 { "filled_box", END_LABEL_FILLED_BOX },
613 { "no_label", END_LABEL_NO_LABEL },
614 { "static", END_LABEL_STATIC }
620 void LyXLayout::readEndLabelType(LyXLex & lexrc)
622 pushpophelper pph(lexrc, endlabelTypeTags,
623 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
624 int le = lexrc.lex();
626 case LyXLex::LEX_UNDEF:
627 lexrc.printError("Unknown labeltype tag `$$Token'");
629 case END_LABEL_STATIC:
631 case END_LABEL_FILLED_BOX:
632 case END_LABEL_NO_LABEL:
633 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
636 lyxerr << "Unhandled value " << le
637 << " in LyXLayout::readEndLabelType." << endl;
643 void LyXLayout::readMargin(LyXLex & lexrc)
645 keyword_item marginTags[] = {
646 { "dynamic", MARGIN_DYNAMIC },
647 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
648 { "manual", MARGIN_MANUAL },
649 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
650 { "static", MARGIN_STATIC }
653 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
655 int le = lexrc.lex();
657 case LyXLex::LEX_UNDEF:
658 lexrc.printError("Unknown margin type tag `$$Token'");
663 case MARGIN_FIRST_DYNAMIC:
664 case MARGIN_RIGHT_ADDRESS_BOX:
665 margintype = static_cast<LYX_MARGIN_TYPE>(le);
668 lyxerr << "Unhandled value " << le
669 << " in LyXLayout::readMargin." << endl;
675 void LyXLayout::readLatexType(LyXLex & lexrc)
677 keyword_item latexTypeTags[] = {
678 { "command", LATEX_COMMAND },
679 { "environment", LATEX_ENVIRONMENT },
680 { "item_environment", LATEX_ITEM_ENVIRONMENT },
681 { "list_environment", LATEX_LIST_ENVIRONMENT },
682 { "paragraph", LATEX_PARAGRAPH }
685 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
686 int le = lexrc.lex();
688 case LyXLex::LEX_UNDEF:
689 lexrc.printError("Unknown latextype tag `$$Token'");
691 case LATEX_PARAGRAPH:
693 case LATEX_ENVIRONMENT:
694 case LATEX_ITEM_ENVIRONMENT:
695 case LATEX_LIST_ENVIRONMENT:
696 latextype = static_cast<LYX_LATEX_TYPES>(le);
699 lyxerr << "Unhandled value " << le
700 << " in LyXLayout::readLatexType." << endl;
707 ST_SPACING_SINGLE = 1,
714 void LyXLayout::readSpacing(LyXLex & lexrc)
716 keyword_item spacingTags[] = {
717 {"double", ST_SPACING_DOUBLE },
718 {"onehalf", ST_SPACING_ONEHALF },
719 {"other", ST_OTHER },
720 {"single", ST_SPACING_SINGLE }
723 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
724 int le = lexrc.lex();
726 case LyXLex::LEX_UNDEF:
727 lexrc.printError("Unknown spacing token `$$Token'");
731 switch (static_cast<SpacingTags>(le)) {
732 case ST_SPACING_SINGLE:
733 spacing.set(Spacing::Single);
735 case ST_SPACING_ONEHALF:
736 spacing.set(Spacing::Onehalf);
738 case ST_SPACING_DOUBLE:
739 spacing.set(Spacing::Double);
743 spacing.set(Spacing::Other, lexrc.getFloat());
749 string const & LyXLayout::name() const
755 void LyXLayout::setName(string const & n)
761 string const & LyXLayout::obsoleted_by() const
763 return obsoleted_by_;
767 string const & LyXLayout::depends_on() const