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,
77 // Constructor for layout
78 LyXLayout::LyXLayout ()
80 margintype = MARGIN_STATIC;
81 latextype = LATEX_PARAGRAPH;
86 font = LyXFont(LyXFont::ALL_INHERIT);
87 labelfont = LyXFont(LyXFont::ALL_INHERIT);
88 resfont = LyXFont(LyXFont::ALL_SANE);
89 reslabelfont = LyXFont(LyXFont::ALL_SANE);
97 align = LYX_ALIGN_BLOCK;
98 alignpossible = LYX_ALIGN_BLOCK;
99 labeltype = LABEL_NO_LABEL;
100 endlabeltype = END_LABEL_NO_LABEL;
101 // Should or should not. That is the question.
102 // spacing.set(Spacing::OneHalf);
105 newline_allowed = true;
106 free_spacing = false;
111 // Reads a layout definition from file
112 bool LyXLayout::Read (LyXLex & lexrc, LyXTextClass const & tclass)
114 // This table is sorted alphabetically [asierra 30March96]
115 keyword_item layoutTags[] = {
116 { "align", LT_ALIGN },
117 { "alignpossible", LT_ALIGNPOSSIBLE },
118 { "bottomsep", LT_BOTTOMSEP },
119 { "copystyle", LT_COPYSTYLE },
120 { "dependson", LT_DEPENDSON },
122 { "endlabelstring", LT_ENDLABELSTRING },
123 { "endlabeltype", LT_ENDLABELTYPE },
124 { "fill_bottom", LT_FILL_BOTTOM },
125 { "fill_top", LT_FILL_TOP },
127 { "freespacing", LT_FREE_SPACING },
128 { "intitle", LT_INTITLE },
129 { "itemsep", LT_ITEMSEP },
130 { "keepempty", LT_KEEPEMPTY },
131 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
132 { "labelfont", LT_LABELFONT },
133 { "labelindent", LT_LABELINDENT },
134 { "labelsep", LT_LABELSEP },
135 { "labelstring", LT_LABELSTRING },
136 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
137 { "labeltype", LT_LABELTYPE },
138 { "latexname", LT_LATEXNAME },
139 { "latexparam", LT_LATEXPARAM },
140 { "latextype", LT_LATEXTYPE },
141 { "leftmargin", LT_LEFTMARGIN },
142 { "margin", LT_MARGIN },
143 { "needprotect", LT_NEED_PROTECT },
144 { "newline", LT_NEWLINE },
145 { "nextnoindent", LT_NEXTNOINDENT },
146 { "obsoletedby", LT_OBSOLETEDBY },
147 { "optionalargs", LT_OPTARGS },
148 { "parindent", LT_PARINDENT },
149 { "parsep", LT_PARSEP },
150 { "parskip", LT_PARSKIP },
151 { "passthru", LT_PASS_THRU },
152 { "preamble", LT_PREAMBLE },
153 { "rightmargin", LT_RIGHTMARGIN },
154 { "spacing", LT_SPACING },
155 { "textfont", LT_TEXTFONT },
156 { "topsep", LT_TOPSEP }
160 bool finished = false;
161 lexrc.pushTable(layoutTags, LT_INTITLE);
162 // parse style section
163 while (!finished && lexrc.isOK() && !error) {
164 int le = lexrc.lex();
165 // See comment in lyxrc.C.
167 case LyXLex::LEX_FEOF:
170 case LyXLex::LEX_UNDEF: // parse error
171 lexrc.printError("Unknown layout tag `$$Token'");
176 switch (static_cast<LayoutTags>(le)) {
177 case LT_END: // end of structure
181 case LT_COPYSTYLE: // initialize with a known style
183 string const style = lexrc.getString();
185 if (tclass.hasLayout(style)) {
186 string const tmpname = name_;
187 this->operator=(*tclass[style]);
190 lyxerr << "Cannot copy unknown style `"
192 << "All layouts so far:"
194 LyXTextClass::const_iterator it =
196 LyXTextClass::const_iterator end =
198 for (; it != end; ++it) {
199 lyxerr << (*it)->name()
203 //lexrc.printError("Cannot copy known "
204 // "style `$$Token'");
209 case LT_OBSOLETEDBY: // replace with a known style
211 string const style = lexrc.getString();
213 if (tclass.hasLayout(style)) {
214 string const tmpname = name_;
215 this->operator=(*tclass[style]);
217 if (obsoleted_by().empty())
218 obsoleted_by_ = style;
220 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
222 //lexrc.printError("Cannot replace with"
231 depends_on_ = lexrc.getString();
235 case LT_MARGIN: // Margin style definition.
239 case LT_LATEXTYPE: // Latex style definition.
240 readLatexType(lexrc);
244 intitle = lexrc.next() && lexrc.getInteger();
249 optionalargs = lexrc.getInteger();
253 case LT_NEED_PROTECT:
254 needprotect = lexrc.next() && lexrc.getInteger();
258 keepempty = lexrc.next() && lexrc.getInteger();
271 labelfont.lyxRead(lexrc);
274 case LT_NEXTNOINDENT: // Indent next paragraph?
275 if (lexrc.next() && lexrc.getInteger())
278 nextnoindent = false;
283 latexname_ = lexrc.getString();
288 latexparam_ = lexrc.getString();
292 preamble_ = lexrc.getLongString("EndPreamble");
296 readLabelType(lexrc);
299 case LT_ENDLABELTYPE:
300 readEndLabelType(lexrc);
303 case LT_LEFTMARGIN: // left margin type
305 leftmargin = lexrc.getString();
308 case LT_RIGHTMARGIN: // right margin type
310 rightmargin = lexrc.getString();
313 case LT_LABELINDENT: // label indenting flag
315 labelindent = lexrc.getString();
318 case LT_PARINDENT: // paragraph indent. flag
320 parindent = lexrc.getString();
323 case LT_PARSKIP: // paragraph skip size
325 parskip = lexrc.getFloat();
328 case LT_ITEMSEP: // item separation size
330 itemsep = lexrc.getFloat();
333 case LT_TOPSEP: // top separation size
335 topsep = lexrc.getFloat();
338 case LT_BOTTOMSEP: // bottom separation size
340 bottomsep = lexrc.getFloat();
343 case LT_LABEL_BOTTOMSEP: // label bottom separation size
345 labelbottomsep = lexrc.getFloat();
348 case LT_LABELSEP: // label separator
350 labelsep = subst(lexrc.getString(), 'x', ' ');
354 case LT_PARSEP: // par. separation size
356 parsep = lexrc.getFloat();
359 case LT_FILL_TOP: // fill top flag
361 fill_top = lexrc.getInteger();
364 case LT_FILL_BOTTOM: // fill bottom flag
366 fill_bottom = lexrc.getInteger();
369 case LT_NEWLINE: // newlines allowed?
371 newline_allowed = lexrc.getInteger();
374 case LT_ALIGN: // paragraph align
377 case LT_ALIGNPOSSIBLE: // paragraph allowed align
378 readAlignPossible(lexrc);
381 case LT_LABELSTRING: // label string definition
383 labelstring_ = lexrc.getString();
386 case LT_ENDLABELSTRING: // endlabel string definition
388 endlabelstring_ = lexrc.getString();
391 case LT_LABELSTRING_APPENDIX: // label string appendix definition
393 labelstring_appendix_ = lexrc.getString();
396 case LT_FREE_SPACING: // Allow for free spacing.
398 free_spacing = lexrc.getInteger();
401 case LT_PASS_THRU: // Allow for pass thru.
403 pass_thru = lexrc.getInteger();
406 case LT_SPACING: // setspace.sty
425 void LyXLayout::readAlign(LyXLex & lexrc)
427 keyword_item alignTags[] = {
428 { "block", AT_BLOCK },
429 { "center", AT_CENTER },
430 { "layout", AT_LAYOUT },
432 { "right", AT_RIGHT }
435 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
436 int le = lexrc.lex();
438 case LyXLex::LEX_UNDEF:
439 lexrc.printError("Unknown alignment `$$Token'");
443 switch (static_cast<AlignTags>(le)) {
445 align = LYX_ALIGN_BLOCK;
448 align = LYX_ALIGN_LEFT;
451 align = LYX_ALIGN_RIGHT;
454 align = LYX_ALIGN_CENTER;
457 align = LYX_ALIGN_LAYOUT;
463 void LyXLayout::readAlignPossible(LyXLex & lexrc)
465 keyword_item alignTags[] = {
466 { "block", AT_BLOCK },
467 { "center", AT_CENTER },
468 { "layout", AT_LAYOUT },
470 { "right", AT_RIGHT }
473 lexrc.pushTable(alignTags, AT_LAYOUT);
474 alignpossible = LYX_ALIGN_NONE;
475 int lineno = lexrc.getLineNo();
477 int le = lexrc.lex();
479 case LyXLex::LEX_UNDEF:
480 lexrc.printError("Unknown alignment `$$Token'");
484 switch (static_cast<AlignTags>(le)) {
486 alignpossible |= LYX_ALIGN_BLOCK;
489 alignpossible |= LYX_ALIGN_LEFT;
492 alignpossible |= LYX_ALIGN_RIGHT;
495 alignpossible |= LYX_ALIGN_CENTER;
498 alignpossible |= LYX_ALIGN_LAYOUT;
501 } while (lineno == lexrc.getLineNo());
510 LA_CENTERED_TOP_ENVIRONMENT,
515 LA_COUNTER_SUBSECTION,
516 LA_COUNTER_SUBSUBSECTION,
517 LA_COUNTER_PARAGRAPH,
518 LA_COUNTER_SUBPARAGRAPH,
527 void LyXLayout::readLabelType(LyXLex & lexrc)
529 keyword_item labelTypeTags[] = {
530 { "bibliography", LA_BIBLIO },
531 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
532 { "counter_chapter", LA_COUNTER_CHAPTER },
533 { "counter_enumi", LA_COUNTER_ENUMI },
534 { "counter_enumii", LA_COUNTER_ENUMII },
535 { "counter_enumiii", LA_COUNTER_ENUMIII },
536 { "counter_enumiv", LA_COUNTER_ENUMIV },
537 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
538 { "counter_section", LA_COUNTER_SECTION },
539 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
540 { "counter_subsection", LA_COUNTER_SUBSECTION },
541 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
542 { "manual", LA_MANUAL },
543 { "no_label", LA_NO_LABEL },
544 { "sensitive", LA_SENSITIVE },
545 { "static", LA_STATIC },
546 { "top_environment", LA_TOP_ENVIRONMENT }
549 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
550 int le = lexrc.lex();
552 case LyXLex::LEX_UNDEF:
553 lexrc.printError("Unknown labeltype tag `$$Token'");
557 switch (static_cast<LabelTypeTags>(le)) {
559 labeltype = LABEL_NO_LABEL;
562 labeltype = LABEL_MANUAL;
564 case LA_TOP_ENVIRONMENT:
565 labeltype = LABEL_TOP_ENVIRONMENT;
567 case LA_CENTERED_TOP_ENVIRONMENT:
568 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
571 labeltype = LABEL_STATIC;
574 labeltype = LABEL_SENSITIVE;
576 case LA_COUNTER_CHAPTER:
577 labeltype = LABEL_COUNTER_CHAPTER;
579 case LA_COUNTER_SECTION:
580 labeltype = LABEL_COUNTER_SECTION;
582 case LA_COUNTER_SUBSECTION:
583 labeltype = LABEL_COUNTER_SUBSECTION;
585 case LA_COUNTER_SUBSUBSECTION:
586 labeltype = LABEL_COUNTER_SUBSUBSECTION;
588 case LA_COUNTER_PARAGRAPH:
589 labeltype = LABEL_COUNTER_PARAGRAPH;
591 case LA_COUNTER_SUBPARAGRAPH:
592 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
594 case LA_COUNTER_ENUMI:
595 labeltype = LABEL_COUNTER_ENUMI;
597 case LA_COUNTER_ENUMII:
598 labeltype = LABEL_COUNTER_ENUMII;
600 case LA_COUNTER_ENUMIII:
601 labeltype = LABEL_COUNTER_ENUMIII;
603 case LA_COUNTER_ENUMIV:
604 labeltype = LABEL_COUNTER_ENUMIV;
607 labeltype = LABEL_BIBLIO;
615 keyword_item endlabelTypeTags[] = {
616 { "box", END_LABEL_BOX },
617 { "filled_box", END_LABEL_FILLED_BOX },
618 { "no_label", END_LABEL_NO_LABEL },
619 { "static", END_LABEL_STATIC }
625 void LyXLayout::readEndLabelType(LyXLex & lexrc)
627 pushpophelper pph(lexrc, endlabelTypeTags,
628 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
629 int le = lexrc.lex();
631 case LyXLex::LEX_UNDEF:
632 lexrc.printError("Unknown labeltype tag `$$Token'");
634 case END_LABEL_STATIC:
636 case END_LABEL_FILLED_BOX:
637 case END_LABEL_NO_LABEL:
638 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
641 lyxerr << "Unhandled value " << le
642 << " in LyXLayout::readEndLabelType." << endl;
648 void LyXLayout::readMargin(LyXLex & lexrc)
650 keyword_item marginTags[] = {
651 { "dynamic", MARGIN_DYNAMIC },
652 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
653 { "manual", MARGIN_MANUAL },
654 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
655 { "static", MARGIN_STATIC }
658 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
660 int le = lexrc.lex();
662 case LyXLex::LEX_UNDEF:
663 lexrc.printError("Unknown margin type tag `$$Token'");
668 case MARGIN_FIRST_DYNAMIC:
669 case MARGIN_RIGHT_ADDRESS_BOX:
670 margintype = static_cast<LYX_MARGIN_TYPE>(le);
673 lyxerr << "Unhandled value " << le
674 << " in LyXLayout::readMargin." << endl;
680 void LyXLayout::readLatexType(LyXLex & lexrc)
682 keyword_item latexTypeTags[] = {
683 { "bib_environment", LATEX_BIB_ENVIRONMENT },
684 { "command", LATEX_COMMAND },
685 { "environment", LATEX_ENVIRONMENT },
686 { "item_environment", LATEX_ITEM_ENVIRONMENT },
687 { "list_environment", LATEX_LIST_ENVIRONMENT },
688 { "paragraph", LATEX_PARAGRAPH }
691 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
692 int le = lexrc.lex();
694 case LyXLex::LEX_UNDEF:
695 lexrc.printError("Unknown latextype tag `$$Token'");
697 case LATEX_PARAGRAPH:
699 case LATEX_ENVIRONMENT:
700 case LATEX_ITEM_ENVIRONMENT:
701 case LATEX_BIB_ENVIRONMENT:
702 case LATEX_LIST_ENVIRONMENT:
703 latextype = static_cast<LYX_LATEX_TYPES>(le);
706 lyxerr << "Unhandled value " << le
707 << " in LyXLayout::readLatexType." << endl;
714 ST_SPACING_SINGLE = 1,
721 void LyXLayout::readSpacing(LyXLex & lexrc)
723 keyword_item spacingTags[] = {
724 {"double", ST_SPACING_DOUBLE },
725 {"onehalf", ST_SPACING_ONEHALF },
726 {"other", ST_OTHER },
727 {"single", ST_SPACING_SINGLE }
730 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
731 int le = lexrc.lex();
733 case LyXLex::LEX_UNDEF:
734 lexrc.printError("Unknown spacing token `$$Token'");
738 switch (static_cast<SpacingTags>(le)) {
739 case ST_SPACING_SINGLE:
740 spacing.set(Spacing::Single);
742 case ST_SPACING_ONEHALF:
743 spacing.set(Spacing::Onehalf);
745 case ST_SPACING_DOUBLE:
746 spacing.set(Spacing::Double);
750 spacing.set(Spacing::Other, lexrc.getFloat());
756 string const & LyXLayout::name() const
762 void LyXLayout::setName(string const & n)
768 string const & LyXLayout::obsoleted_by() const
770 return obsoleted_by_;
774 string const & LyXLayout::depends_on() const