3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
15 #include "lyxlayout.h"
16 #include "lyxtextclass.h"
20 #include "support/lstrings.h"
22 using lyx::support::subst;
23 using lyx::support::trim;
28 // The order of the LayoutTags enum is no more important. [asierra300396]
40 //LT_ENVIRONMENT_DEFAULT,
57 LT_LABELSTRING_APPENDIX,
85 // Constructor for layout
86 LyXLayout::LyXLayout ()
88 margintype = MARGIN_STATIC;
89 latextype = LATEX_PARAGRAPH;
94 font = LyXFont(LyXFont::ALL_INHERIT);
95 labelfont = LyXFont(LyXFont::ALL_INHERIT);
96 resfont = LyXFont(LyXFont::ALL_SANE);
97 reslabelfont = LyXFont(LyXFont::ALL_SANE);
103 labelbottomsep = 0.0;
105 align = LYX_ALIGN_BLOCK;
106 alignpossible = LYX_ALIGN_BLOCK;
107 labeltype = LABEL_NO_LABEL;
108 endlabeltype = END_LABEL_NO_LABEL;
109 // Should or should not. That is the question.
110 // spacing.set(Spacing::OneHalf);
113 newline_allowed = true;
114 free_spacing = false;
116 is_environment = false;
120 // Reads a layout definition from file
121 bool LyXLayout::Read (LyXLex & lexrc, LyXTextClass const & tclass)
123 // This table is sorted alphabetically [asierra 30March96]
124 keyword_item layoutTags[] = {
125 { "align", LT_ALIGN },
126 { "alignpossible", LT_ALIGNPOSSIBLE },
127 { "bottomsep", LT_BOTTOMSEP },
128 { "copystyle", LT_COPYSTYLE },
129 { "dependson", LT_DEPENDSON },
131 { "endlabelstring", LT_ENDLABELSTRING },
132 { "endlabeltype", LT_ENDLABELTYPE },
133 { "fill_bottom", LT_FILL_BOTTOM },
134 { "fill_top", LT_FILL_TOP },
136 { "freespacing", LT_FREE_SPACING },
137 { "intitle", LT_INTITLE },
138 { "itemsep", LT_ITEMSEP },
139 { "keepempty", LT_KEEPEMPTY },
140 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
141 { "labelfont", LT_LABELFONT },
142 { "labelindent", LT_LABELINDENT },
143 { "labelsep", LT_LABELSEP },
144 { "labelstring", LT_LABELSTRING },
145 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
146 { "labeltype", LT_LABELTYPE },
147 { "latexfooter", LT_LATEXFOOTER },
148 { "latexheader", LT_LATEXHEADER },
149 { "latexname", LT_LATEXNAME },
150 { "latexparagraph", LT_LATEXPARAGRAPH },
151 { "latexparam", LT_LATEXPARAM },
152 { "latextype", LT_LATEXTYPE },
153 { "leftmargin", LT_LEFTMARGIN },
154 { "margin", LT_MARGIN },
155 { "needprotect", LT_NEED_PROTECT },
156 { "newline", LT_NEWLINE },
157 { "nextnoindent", LT_NEXTNOINDENT },
158 { "obsoletedby", LT_OBSOLETEDBY },
159 { "optionalargs", LT_OPTARGS },
160 { "parindent", LT_PARINDENT },
161 { "parsep", LT_PARSEP },
162 { "parskip", LT_PARSKIP },
163 { "passthru", LT_PASS_THRU },
164 { "preamble", LT_PREAMBLE },
165 { "rightmargin", LT_RIGHTMARGIN },
166 { "spacing", LT_SPACING },
167 { "textfont", LT_TEXTFONT },
168 { "topsep", LT_TOPSEP }
172 bool finished = false;
173 lexrc.pushTable(layoutTags, LT_INTITLE);
174 // parse style section
175 while (!finished && lexrc.isOK() && !error) {
176 int le = lexrc.lex();
177 // See comment in lyxrc.C.
179 case LyXLex::LEX_FEOF:
182 case LyXLex::LEX_UNDEF: // parse error
183 lexrc.printError("Unknown layout tag `$$Token'");
188 switch (static_cast<LayoutTags>(le)) {
189 case LT_END: // end of structure
193 case LT_COPYSTYLE: // initialize with a known style
195 string const style = lexrc.getString();
197 if (tclass.hasLayout(style)) {
198 string const tmpname = name_;
199 this->operator=(*tclass[style]);
202 lyxerr << "Cannot copy unknown style `"
204 << "All layouts so far:"
206 LyXTextClass::const_iterator it =
208 LyXTextClass::const_iterator end =
210 for (; it != end; ++it) {
211 lyxerr << (*it)->name()
215 //lexrc.printError("Cannot copy known "
216 // "style `$$Token'");
221 case LT_OBSOLETEDBY: // replace with a known style
223 string const style = lexrc.getString();
225 if (tclass.hasLayout(style)) {
226 string const tmpname = name_;
227 this->operator=(*tclass[style]);
229 if (obsoleted_by().empty())
230 obsoleted_by_ = style;
232 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
234 //lexrc.printError("Cannot replace with"
243 depends_on_ = lexrc.getString();
247 case LT_MARGIN: // margin style definition.
251 case LT_LATEXTYPE: // LaTeX style definition.
252 readLatexType(lexrc);
255 case LT_LATEXHEADER: // header for environments
257 latexheader = lexrc.getString();
260 case LT_LATEXFOOTER: // footer for environments
262 latexfooter = lexrc.getString();
265 case LT_LATEXPARAGRAPH:
267 latexparagraph = lexrc.getString();
271 intitle = lexrc.next() && lexrc.getInteger();
276 optionalargs = lexrc.getInteger();
280 case LT_NEED_PROTECT:
281 needprotect = lexrc.next() && lexrc.getInteger();
285 keepempty = lexrc.next() && lexrc.getInteger();
298 labelfont.lyxRead(lexrc);
301 case LT_NEXTNOINDENT: // Indent next paragraph?
302 if (lexrc.next() && lexrc.getInteger())
305 nextnoindent = false;
310 latexname_ = lexrc.getString();
315 latexparam_ = lexrc.getString();
319 preamble_ = lexrc.getLongString("EndPreamble");
323 readLabelType(lexrc);
326 case LT_ENDLABELTYPE:
327 readEndLabelType(lexrc);
330 case LT_LEFTMARGIN: // left margin type
332 leftmargin = lexrc.getString();
335 case LT_RIGHTMARGIN: // right margin type
337 rightmargin = lexrc.getString();
340 case LT_LABELINDENT: // label indenting flag
342 labelindent = lexrc.getString();
345 case LT_PARINDENT: // paragraph indent. flag
347 parindent = lexrc.getString();
350 case LT_PARSKIP: // paragraph skip size
352 parskip = lexrc.getFloat();
355 case LT_ITEMSEP: // item separation size
357 itemsep = lexrc.getFloat();
360 case LT_TOPSEP: // top separation size
362 topsep = lexrc.getFloat();
365 case LT_BOTTOMSEP: // bottom separation size
367 bottomsep = lexrc.getFloat();
370 case LT_LABEL_BOTTOMSEP: // label bottom separation size
372 labelbottomsep = lexrc.getFloat();
375 case LT_LABELSEP: // label separator
377 labelsep = subst(lexrc.getString(), 'x', ' ');
381 case LT_PARSEP: // par. separation size
383 parsep = lexrc.getFloat();
386 case LT_FILL_TOP: // fill top flag
388 fill_top = lexrc.getInteger();
391 case LT_FILL_BOTTOM: // fill bottom flag
393 fill_bottom = lexrc.getInteger();
396 case LT_NEWLINE: // newlines allowed?
398 newline_allowed = lexrc.getInteger();
401 case LT_ALIGN: // paragraph align
404 case LT_ALIGNPOSSIBLE: // paragraph allowed align
405 readAlignPossible(lexrc);
408 case LT_LABELSTRING: // label string definition
410 labelstring_ = trim(lexrc.getString());
413 case LT_ENDLABELSTRING: // endlabel string definition
415 endlabelstring_ = trim(lexrc.getString());
418 case LT_LABELSTRING_APPENDIX: // label string appendix definition
420 labelstring_appendix_ = trim(lexrc.getString());
423 case LT_FREE_SPACING: // Allow for free spacing.
425 free_spacing = lexrc.getInteger();
428 case LT_PASS_THRU: // Allow for pass thru.
430 pass_thru = lexrc.getInteger();
433 case LT_SPACING: // setspace.sty
452 void LyXLayout::readAlign(LyXLex & lexrc)
454 keyword_item alignTags[] = {
455 { "block", AT_BLOCK },
456 { "center", AT_CENTER },
457 { "layout", AT_LAYOUT },
459 { "right", AT_RIGHT }
462 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
463 int le = lexrc.lex();
465 case LyXLex::LEX_UNDEF:
466 lexrc.printError("Unknown alignment `$$Token'");
470 switch (static_cast<AlignTags>(le)) {
472 align = LYX_ALIGN_BLOCK;
475 align = LYX_ALIGN_LEFT;
478 align = LYX_ALIGN_RIGHT;
481 align = LYX_ALIGN_CENTER;
484 align = LYX_ALIGN_LAYOUT;
490 void LyXLayout::readAlignPossible(LyXLex & lexrc)
492 keyword_item alignTags[] = {
493 { "block", AT_BLOCK },
494 { "center", AT_CENTER },
495 { "layout", AT_LAYOUT },
497 { "right", AT_RIGHT }
500 lexrc.pushTable(alignTags, AT_LAYOUT);
501 alignpossible = LYX_ALIGN_NONE;
502 int lineno = lexrc.getLineNo();
504 int le = lexrc.lex();
506 case LyXLex::LEX_UNDEF:
507 lexrc.printError("Unknown alignment `$$Token'");
511 switch (static_cast<AlignTags>(le)) {
513 alignpossible |= LYX_ALIGN_BLOCK;
516 alignpossible |= LYX_ALIGN_LEFT;
519 alignpossible |= LYX_ALIGN_RIGHT;
522 alignpossible |= LYX_ALIGN_CENTER;
525 alignpossible |= LYX_ALIGN_LAYOUT;
528 } while (lineno == lexrc.getLineNo());
537 LA_CENTERED_TOP_ENVIRONMENT,
542 LA_COUNTER_SUBSECTION,
543 LA_COUNTER_SUBSUBSECTION,
544 LA_COUNTER_PARAGRAPH,
545 LA_COUNTER_SUBPARAGRAPH,
554 void LyXLayout::readLabelType(LyXLex & lexrc)
556 keyword_item labelTypeTags[] = {
557 { "bibliography", LA_BIBLIO },
558 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
559 { "counter_chapter", LA_COUNTER_CHAPTER },
560 { "counter_enumi", LA_COUNTER_ENUMI },
561 { "counter_enumii", LA_COUNTER_ENUMII },
562 { "counter_enumiii", LA_COUNTER_ENUMIII },
563 { "counter_enumiv", LA_COUNTER_ENUMIV },
564 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
565 { "counter_section", LA_COUNTER_SECTION },
566 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
567 { "counter_subsection", LA_COUNTER_SUBSECTION },
568 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
569 { "manual", LA_MANUAL },
570 { "no_label", LA_NO_LABEL },
571 { "sensitive", LA_SENSITIVE },
572 { "static", LA_STATIC },
573 { "top_environment", LA_TOP_ENVIRONMENT }
576 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
577 int le = lexrc.lex();
579 case LyXLex::LEX_UNDEF:
580 lexrc.printError("Unknown labeltype tag `$$Token'");
584 switch (static_cast<LabelTypeTags>(le)) {
586 labeltype = LABEL_NO_LABEL;
589 labeltype = LABEL_MANUAL;
591 case LA_TOP_ENVIRONMENT:
592 labeltype = LABEL_TOP_ENVIRONMENT;
594 case LA_CENTERED_TOP_ENVIRONMENT:
595 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
598 labeltype = LABEL_STATIC;
601 labeltype = LABEL_SENSITIVE;
603 case LA_COUNTER_CHAPTER:
604 labeltype = LABEL_COUNTER_CHAPTER;
606 case LA_COUNTER_SECTION:
607 labeltype = LABEL_COUNTER_SECTION;
609 case LA_COUNTER_SUBSECTION:
610 labeltype = LABEL_COUNTER_SUBSECTION;
612 case LA_COUNTER_SUBSUBSECTION:
613 labeltype = LABEL_COUNTER_SUBSUBSECTION;
615 case LA_COUNTER_PARAGRAPH:
616 labeltype = LABEL_COUNTER_PARAGRAPH;
618 case LA_COUNTER_SUBPARAGRAPH:
619 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
621 case LA_COUNTER_ENUMI:
622 labeltype = LABEL_COUNTER_ENUMI;
624 case LA_COUNTER_ENUMII:
625 labeltype = LABEL_COUNTER_ENUMII;
627 case LA_COUNTER_ENUMIII:
628 labeltype = LABEL_COUNTER_ENUMIII;
630 case LA_COUNTER_ENUMIV:
631 labeltype = LABEL_COUNTER_ENUMIV;
634 labeltype = LABEL_BIBLIO;
642 keyword_item endlabelTypeTags[] = {
643 { "box", END_LABEL_BOX },
644 { "filled_box", END_LABEL_FILLED_BOX },
645 { "no_label", END_LABEL_NO_LABEL },
646 { "static", END_LABEL_STATIC }
652 void LyXLayout::readEndLabelType(LyXLex & lexrc)
654 pushpophelper pph(lexrc, endlabelTypeTags,
655 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
656 int le = lexrc.lex();
658 case LyXLex::LEX_UNDEF:
659 lexrc.printError("Unknown labeltype tag `$$Token'");
661 case END_LABEL_STATIC:
663 case END_LABEL_FILLED_BOX:
664 case END_LABEL_NO_LABEL:
665 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
668 lyxerr << "Unhandled value " << le
669 << " in LyXLayout::readEndLabelType." << endl;
675 void LyXLayout::readMargin(LyXLex & lexrc)
677 keyword_item marginTags[] = {
678 { "dynamic", MARGIN_DYNAMIC },
679 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
680 { "manual", MARGIN_MANUAL },
681 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
682 { "static", MARGIN_STATIC }
685 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
687 int le = lexrc.lex();
689 case LyXLex::LEX_UNDEF:
690 lexrc.printError("Unknown margin type tag `$$Token'");
695 case MARGIN_FIRST_DYNAMIC:
696 case MARGIN_RIGHT_ADDRESS_BOX:
697 margintype = static_cast<LYX_MARGIN_TYPE>(le);
700 lyxerr << "Unhandled value " << le
701 << " in LyXLayout::readMargin." << endl;
707 void LyXLayout::readLatexType(LyXLex & lexrc)
709 keyword_item latexTypeTags[] = {
710 { "bib_environment", LATEX_BIB_ENVIRONMENT },
711 { "command", LATEX_COMMAND },
712 { "environment", LATEX_ENVIRONMENT },
713 { "item_environment", LATEX_ITEM_ENVIRONMENT },
714 { "list_environment", LATEX_LIST_ENVIRONMENT },
715 { "paragraph", LATEX_PARAGRAPH }
718 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
719 int le = lexrc.lex();
721 case LyXLex::LEX_UNDEF:
722 lexrc.printError("Unknown latextype tag `$$Token'");
724 case LATEX_PARAGRAPH:
726 case LATEX_ENVIRONMENT:
727 case LATEX_ITEM_ENVIRONMENT:
728 case LATEX_BIB_ENVIRONMENT:
729 case LATEX_LIST_ENVIRONMENT:
730 latextype = static_cast<LYX_LATEX_TYPES>(le);
733 lyxerr << "Unhandled value " << le
734 << " in LyXLayout::readLatexType." << endl;
741 ST_SPACING_SINGLE = 1,
748 void LyXLayout::readSpacing(LyXLex & lexrc)
750 keyword_item spacingTags[] = {
751 {"double", ST_SPACING_DOUBLE },
752 {"onehalf", ST_SPACING_ONEHALF },
753 {"other", ST_OTHER },
754 {"single", ST_SPACING_SINGLE }
757 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
758 int le = lexrc.lex();
760 case LyXLex::LEX_UNDEF:
761 lexrc.printError("Unknown spacing token `$$Token'");
765 switch (static_cast<SpacingTags>(le)) {
766 case ST_SPACING_SINGLE:
767 spacing.set(Spacing::Single);
769 case ST_SPACING_ONEHALF:
770 spacing.set(Spacing::Onehalf);
772 case ST_SPACING_DOUBLE:
773 spacing.set(Spacing::Double);
777 spacing.set(Spacing::Other, lexrc.getFloat());
783 string const & LyXLayout::name() const
789 void LyXLayout::setName(string const & n)
795 string const & LyXLayout::obsoleted_by() const
797 return obsoleted_by_;
801 string const & LyXLayout::depends_on() const