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();
252 optionalargs = lexrc.next() && lexrc.getInteger();
255 case LT_NEED_PROTECT:
256 needprotect = lexrc.next() && lexrc.getInteger();
260 keepempty = lexrc.next() && lexrc.getInteger();
273 labelfont.lyxRead(lexrc);
276 case LT_NEXTNOINDENT: // Indent next paragraph?
277 if (lexrc.next() && lexrc.getInteger())
280 nextnoindent = false;
285 latexname_ = lexrc.getString();
290 latexparam_ = lexrc.getString();
294 preamble_ = lexrc.getLongString("EndPreamble");
298 readLabelType(lexrc);
301 case LT_ENDLABELTYPE:
302 readEndLabelType(lexrc);
305 case LT_LEFTMARGIN: // left margin type
307 leftmargin = lexrc.getString();
310 case LT_RIGHTMARGIN: // right margin type
312 rightmargin = lexrc.getString();
315 case LT_LABELINDENT: // label indenting flag
317 labelindent = lexrc.getString();
320 case LT_PARINDENT: // paragraph indent. flag
322 parindent = lexrc.getString();
325 case LT_PARSKIP: // paragraph skip size
327 parskip = lexrc.getFloat();
330 case LT_ITEMSEP: // item separation size
332 itemsep = lexrc.getFloat();
335 case LT_TOPSEP: // top separation size
337 topsep = lexrc.getFloat();
340 case LT_BOTTOMSEP: // bottom separation size
342 bottomsep = lexrc.getFloat();
345 case LT_LABEL_BOTTOMSEP: // label bottom separation size
347 labelbottomsep = lexrc.getFloat();
350 case LT_LABELSEP: // label separator
352 labelsep = subst(lexrc.getString(), 'x', ' ');
356 case LT_PARSEP: // par. separation size
358 parsep = lexrc.getFloat();
361 case LT_FILL_TOP: // fill top flag
363 fill_top = lexrc.getInteger();
366 case LT_FILL_BOTTOM: // fill bottom flag
368 fill_bottom = lexrc.getInteger();
371 case LT_NEWLINE: // newlines allowed?
373 newline_allowed = lexrc.getInteger();
376 case LT_ALIGN: // paragraph align
379 case LT_ALIGNPOSSIBLE: // paragraph allowed align
380 readAlignPossible(lexrc);
383 case LT_LABELSTRING: // label string definition
385 labelstring_ = lexrc.getString();
388 case LT_ENDLABELSTRING: // endlabel string definition
390 endlabelstring_ = lexrc.getString();
393 case LT_LABELSTRING_APPENDIX: // label string appendix definition
395 labelstring_appendix_ = lexrc.getString();
398 case LT_FREE_SPACING: // Allow for free spacing.
400 free_spacing = lexrc.getInteger();
403 case LT_PASS_THRU: // Allow for pass thru.
405 pass_thru = lexrc.getInteger();
408 case LT_SPACING: // setspace.sty
427 void LyXLayout::readAlign(LyXLex & lexrc)
429 keyword_item alignTags[] = {
430 { "block", AT_BLOCK },
431 { "center", AT_CENTER },
432 { "layout", AT_LAYOUT },
434 { "right", AT_RIGHT }
437 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
438 int le = lexrc.lex();
440 case LyXLex::LEX_UNDEF:
441 lexrc.printError("Unknown alignment `$$Token'");
445 switch (static_cast<AlignTags>(le)) {
447 align = LYX_ALIGN_BLOCK;
450 align = LYX_ALIGN_LEFT;
453 align = LYX_ALIGN_RIGHT;
456 align = LYX_ALIGN_CENTER;
459 align = LYX_ALIGN_LAYOUT;
465 void LyXLayout::readAlignPossible(LyXLex & lexrc)
467 keyword_item alignTags[] = {
468 { "block", AT_BLOCK },
469 { "center", AT_CENTER },
470 { "layout", AT_LAYOUT },
472 { "right", AT_RIGHT }
475 lexrc.pushTable(alignTags, AT_LAYOUT);
476 alignpossible = LYX_ALIGN_NONE;
477 int lineno = lexrc.getLineNo();
479 int le = lexrc.lex();
481 case LyXLex::LEX_UNDEF:
482 lexrc.printError("Unknown alignment `$$Token'");
486 switch (static_cast<AlignTags>(le)) {
488 alignpossible |= LYX_ALIGN_BLOCK;
491 alignpossible |= LYX_ALIGN_LEFT;
494 alignpossible |= LYX_ALIGN_RIGHT;
497 alignpossible |= LYX_ALIGN_CENTER;
500 alignpossible |= LYX_ALIGN_LAYOUT;
503 } while (lineno == lexrc.getLineNo());
512 LA_CENTERED_TOP_ENVIRONMENT,
517 LA_COUNTER_SUBSECTION,
518 LA_COUNTER_SUBSUBSECTION,
519 LA_COUNTER_PARAGRAPH,
520 LA_COUNTER_SUBPARAGRAPH,
529 void LyXLayout::readLabelType(LyXLex & lexrc)
531 keyword_item labelTypeTags[] = {
532 { "bibliography", LA_BIBLIO },
533 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
534 { "counter_chapter", LA_COUNTER_CHAPTER },
535 { "counter_enumi", LA_COUNTER_ENUMI },
536 { "counter_enumii", LA_COUNTER_ENUMII },
537 { "counter_enumiii", LA_COUNTER_ENUMIII },
538 { "counter_enumiv", LA_COUNTER_ENUMIV },
539 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
540 { "counter_section", LA_COUNTER_SECTION },
541 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
542 { "counter_subsection", LA_COUNTER_SUBSECTION },
543 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
544 { "manual", LA_MANUAL },
545 { "no_label", LA_NO_LABEL },
546 { "sensitive", LA_SENSITIVE },
547 { "static", LA_STATIC },
548 { "top_environment", LA_TOP_ENVIRONMENT }
551 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
552 int le = lexrc.lex();
554 case LyXLex::LEX_UNDEF:
555 lexrc.printError("Unknown labeltype tag `$$Token'");
559 switch (static_cast<LabelTypeTags>(le)) {
561 labeltype = LABEL_NO_LABEL;
564 labeltype = LABEL_MANUAL;
566 case LA_TOP_ENVIRONMENT:
567 labeltype = LABEL_TOP_ENVIRONMENT;
569 case LA_CENTERED_TOP_ENVIRONMENT:
570 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
573 labeltype = LABEL_STATIC;
576 labeltype = LABEL_SENSITIVE;
578 case LA_COUNTER_CHAPTER:
579 labeltype = LABEL_COUNTER_CHAPTER;
581 case LA_COUNTER_SECTION:
582 labeltype = LABEL_COUNTER_SECTION;
584 case LA_COUNTER_SUBSECTION:
585 labeltype = LABEL_COUNTER_SUBSECTION;
587 case LA_COUNTER_SUBSUBSECTION:
588 labeltype = LABEL_COUNTER_SUBSUBSECTION;
590 case LA_COUNTER_PARAGRAPH:
591 labeltype = LABEL_COUNTER_PARAGRAPH;
593 case LA_COUNTER_SUBPARAGRAPH:
594 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
596 case LA_COUNTER_ENUMI:
597 labeltype = LABEL_COUNTER_ENUMI;
599 case LA_COUNTER_ENUMII:
600 labeltype = LABEL_COUNTER_ENUMII;
602 case LA_COUNTER_ENUMIII:
603 labeltype = LABEL_COUNTER_ENUMIII;
605 case LA_COUNTER_ENUMIV:
606 labeltype = LABEL_COUNTER_ENUMIV;
609 labeltype = LABEL_BIBLIO;
617 keyword_item endlabelTypeTags[] = {
618 { "box", END_LABEL_BOX },
619 { "filled_box", END_LABEL_FILLED_BOX },
620 { "no_label", END_LABEL_NO_LABEL },
621 { "static", END_LABEL_STATIC }
627 void LyXLayout::readEndLabelType(LyXLex & lexrc)
629 pushpophelper pph(lexrc, endlabelTypeTags,
630 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
631 int le = lexrc.lex();
633 case LyXLex::LEX_UNDEF:
634 lexrc.printError("Unknown labeltype tag `$$Token'");
636 case END_LABEL_STATIC:
638 case END_LABEL_FILLED_BOX:
639 case END_LABEL_NO_LABEL:
640 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
643 lyxerr << "Unhandled value " << le
644 << " in LyXLayout::readEndLabelType." << endl;
650 void LyXLayout::readMargin(LyXLex & lexrc)
652 keyword_item marginTags[] = {
653 { "dynamic", MARGIN_DYNAMIC },
654 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
655 { "manual", MARGIN_MANUAL },
656 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
657 { "static", MARGIN_STATIC }
660 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
662 int le = lexrc.lex();
664 case LyXLex::LEX_UNDEF:
665 lexrc.printError("Unknown margin type tag `$$Token'");
670 case MARGIN_FIRST_DYNAMIC:
671 case MARGIN_RIGHT_ADDRESS_BOX:
672 margintype = static_cast<LYX_MARGIN_TYPE>(le);
675 lyxerr << "Unhandled value " << le
676 << " in LyXLayout::readMargin." << endl;
682 void LyXLayout::readLatexType(LyXLex & lexrc)
684 keyword_item latexTypeTags[] = {
685 { "command", LATEX_COMMAND },
686 { "environment", LATEX_ENVIRONMENT },
687 { "item_environment", LATEX_ITEM_ENVIRONMENT },
688 { "list_environment", LATEX_LIST_ENVIRONMENT },
689 { "paragraph", LATEX_PARAGRAPH }
692 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
693 int le = lexrc.lex();
695 case LyXLex::LEX_UNDEF:
696 lexrc.printError("Unknown latextype tag `$$Token'");
698 case LATEX_PARAGRAPH:
700 case LATEX_ENVIRONMENT:
701 case LATEX_ITEM_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