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;
29 // The order of the LayoutTags enum is no more important. [asierra300396]
42 //LT_ENVIRONMENT_DEFAULT,
59 LT_LABELSTRING_APPENDIX,
85 LT_INTITLE // keep this last!
90 // Constructor for layout
91 LyXLayout::LyXLayout ()
93 margintype = MARGIN_STATIC;
94 latextype = LATEX_PARAGRAPH;
99 font = LyXFont(LyXFont::ALL_INHERIT);
100 labelfont = LyXFont(LyXFont::ALL_INHERIT);
101 resfont = LyXFont(LyXFont::ALL_SANE);
102 reslabelfont = LyXFont(LyXFont::ALL_SANE);
103 nextnoindent = false;
108 labelbottomsep = 0.0;
110 align = LYX_ALIGN_BLOCK;
111 alignpossible = LYX_ALIGN_BLOCK;
112 labeltype = LABEL_NO_LABEL;
113 endlabeltype = END_LABEL_NO_LABEL;
114 // Should or should not. That is the question.
115 // spacing.set(Spacing::OneHalf);
118 newline_allowed = true;
119 free_spacing = false;
121 is_environment = false;
127 // Reads a layout definition from file
128 bool LyXLayout::Read(LyXLex & lexrc, LyXTextClass const & tclass)
130 // This table is sorted alphabetically [asierra 30March96]
131 keyword_item layoutTags[] = {
132 { "align", LT_ALIGN },
133 { "alignpossible", LT_ALIGNPOSSIBLE },
134 { "bottomsep", LT_BOTTOMSEP },
135 { "commanddepth", LT_COMMANDDEPTH },
136 { "copystyle", LT_COPYSTYLE },
137 { "dependson", LT_DEPENDSON },
139 { "endlabelstring", LT_ENDLABELSTRING },
140 { "endlabeltype", LT_ENDLABELTYPE },
141 { "fill_bottom", LT_FILL_BOTTOM },
142 { "fill_top", LT_FILL_TOP },
144 { "freespacing", LT_FREE_SPACING },
145 { "innertag", LT_INNERTAG },
146 { "intitle", LT_INTITLE },
147 { "itemsep", LT_ITEMSEP },
148 { "keepempty", LT_KEEPEMPTY },
149 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
150 { "labelcounter", LT_LABELCOUNTER },
151 { "labelfont", LT_LABELFONT },
152 { "labelindent", LT_LABELINDENT },
153 { "labelsep", LT_LABELSEP },
154 { "labelstring", LT_LABELSTRING },
155 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
156 { "labeltype", LT_LABELTYPE },
157 { "latexfooter", LT_LATEXFOOTER },
158 { "latexheader", LT_LATEXHEADER },
159 { "latexname", LT_LATEXNAME },
160 { "latexparagraph", LT_LATEXPARAGRAPH },
161 { "latexparam", LT_LATEXPARAM },
162 { "latextype", LT_LATEXTYPE },
163 { "leftmargin", LT_LEFTMARGIN },
164 { "margin", LT_MARGIN },
165 { "needprotect", LT_NEED_PROTECT },
166 { "newline", LT_NEWLINE },
167 { "nextnoindent", LT_NEXTNOINDENT },
168 { "obsoletedby", LT_OBSOLETEDBY },
169 { "optionalargs", LT_OPTARGS },
170 { "parindent", LT_PARINDENT },
171 { "parsep", LT_PARSEP },
172 { "parskip", LT_PARSKIP },
173 { "passthru", LT_PASS_THRU },
174 { "preamble", LT_PREAMBLE },
175 { "rightmargin", LT_RIGHTMARGIN },
176 { "spacing", LT_SPACING },
177 { "textfont", LT_TEXTFONT },
178 { "toclevel", LT_TOCLEVEL },
179 { "topsep", LT_TOPSEP }
183 bool finished = false;
184 lexrc.pushTable(layoutTags, LT_INTITLE);
185 // parse style section
186 while (!finished && lexrc.isOK() && !error) {
187 int le = lexrc.lex();
188 // See comment in lyxrc.C.
190 case LyXLex::LEX_FEOF:
193 case LyXLex::LEX_UNDEF: // parse error
194 lexrc.printError("Unknown layout tag `$$Token'");
199 switch (static_cast<LayoutTags>(le)) {
200 case LT_END: // end of structure
204 case LT_COPYSTYLE: // initialize with a known style
206 string const style = lexrc.getString();
208 if (tclass.hasLayout(style)) {
209 string const tmpname = name_;
210 this->operator=(*tclass[style]);
213 lyxerr << "Cannot copy unknown style `"
215 << "All layouts so far:"
217 LyXTextClass::const_iterator it =
219 LyXTextClass::const_iterator end =
221 for (; it != end; ++it) {
222 lyxerr << (*it)->name()
226 //lexrc.printError("Cannot copy known "
227 // "style `$$Token'");
232 case LT_OBSOLETEDBY: // replace with a known style
234 string const style = lexrc.getString();
236 if (tclass.hasLayout(style)) {
237 string const tmpname = name_;
238 this->operator=(*tclass[style]);
240 if (obsoleted_by().empty())
241 obsoleted_by_ = style;
243 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
245 //lexrc.printError("Cannot replace with"
254 depends_on_ = lexrc.getString();
257 case LT_MARGIN: // margin style definition.
261 case LT_LATEXTYPE: // LaTeX style definition.
262 readLatexType(lexrc);
265 case LT_LATEXHEADER: // header for environments
267 latexheader = lexrc.getString();
270 case LT_LATEXFOOTER: // footer for environments
272 latexfooter = lexrc.getString();
275 case LT_LATEXPARAGRAPH:
277 latexparagraph = lexrc.getString();
281 intitle = lexrc.next() && lexrc.getInteger();
286 toclevel = lexrc.getInteger();
291 optionalargs = lexrc.getInteger();
294 case LT_NEED_PROTECT:
295 needprotect = lexrc.next() && lexrc.getInteger();
299 keepempty = lexrc.next() && lexrc.getInteger();
312 labelfont.lyxRead(lexrc);
315 case LT_NEXTNOINDENT: // Indent next paragraph?
316 if (lexrc.next() && lexrc.getInteger())
319 nextnoindent = false;
322 case LT_COMMANDDEPTH:
324 commanddepth = lexrc.getInteger();
329 latexname_ = lexrc.getString();
334 latexparam_ = lexrc.getString();
339 innertag_ = lexrc.getString();
343 preamble_ = lexrc.getLongString("EndPreamble");
347 readLabelType(lexrc);
350 case LT_ENDLABELTYPE:
351 readEndLabelType(lexrc);
354 case LT_LEFTMARGIN: // left margin type
356 leftmargin = lexrc.getString();
359 case LT_RIGHTMARGIN: // right margin type
361 rightmargin = lexrc.getString();
364 case LT_LABELINDENT: // label indenting flag
366 labelindent = lexrc.getString();
369 case LT_PARINDENT: // paragraph indent. flag
371 parindent = lexrc.getString();
374 case LT_PARSKIP: // paragraph skip size
376 parskip = lexrc.getFloat();
379 case LT_ITEMSEP: // item separation size
381 itemsep = lexrc.getFloat();
384 case LT_TOPSEP: // top separation size
386 topsep = lexrc.getFloat();
389 case LT_BOTTOMSEP: // bottom separation size
391 bottomsep = lexrc.getFloat();
394 case LT_LABEL_BOTTOMSEP: // label bottom separation size
396 labelbottomsep = lexrc.getFloat();
399 case LT_LABELSEP: // label separator
401 labelsep = subst(lexrc.getString(), 'x', ' ');
405 case LT_PARSEP: // par. separation size
407 parsep = lexrc.getFloat();
410 case LT_FILL_TOP: // fill top flag
412 fill_top = lexrc.getInteger();
415 case LT_FILL_BOTTOM: // fill bottom flag
417 fill_bottom = lexrc.getInteger();
420 case LT_NEWLINE: // newlines allowed?
422 newline_allowed = lexrc.getInteger();
425 case LT_ALIGN: // paragraph align
428 case LT_ALIGNPOSSIBLE: // paragraph allowed align
429 readAlignPossible(lexrc);
432 case LT_LABELSTRING: // label string definition
434 labelstring_ = trim(lexrc.getString());
437 case LT_ENDLABELSTRING: // endlabel string definition
439 endlabelstring_ = trim(lexrc.getString());
442 case LT_LABELSTRING_APPENDIX: // label string appendix definition
444 labelstring_appendix_ = trim(lexrc.getString());
447 case LT_LABELCOUNTER: // name of counter to use
449 counter = trim(lexrc.getString());
452 case LT_FREE_SPACING: // Allow for free spacing.
454 free_spacing = lexrc.getInteger();
457 case LT_PASS_THRU: // Allow for pass thru.
459 pass_thru = lexrc.getInteger();
462 case LT_SPACING: // setspace.sty
469 if (labelstring_appendix_.empty())
470 labelstring_appendix_ = labelstring_;
484 void LyXLayout::readAlign(LyXLex & lexrc)
486 keyword_item alignTags[] = {
487 { "block", AT_BLOCK },
488 { "center", AT_CENTER },
489 { "layout", AT_LAYOUT },
491 { "right", AT_RIGHT }
494 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
495 int le = lexrc.lex();
497 case LyXLex::LEX_UNDEF:
498 lexrc.printError("Unknown alignment `$$Token'");
502 switch (static_cast<AlignTags>(le)) {
504 align = LYX_ALIGN_BLOCK;
507 align = LYX_ALIGN_LEFT;
510 align = LYX_ALIGN_RIGHT;
513 align = LYX_ALIGN_CENTER;
516 align = LYX_ALIGN_LAYOUT;
522 void LyXLayout::readAlignPossible(LyXLex & lexrc)
524 keyword_item alignTags[] = {
525 { "block", AT_BLOCK },
526 { "center", AT_CENTER },
527 { "layout", AT_LAYOUT },
529 { "right", AT_RIGHT }
532 lexrc.pushTable(alignTags, AT_LAYOUT);
533 alignpossible = LYX_ALIGN_NONE;
534 int lineno = lexrc.getLineNo();
536 int le = lexrc.lex();
538 case LyXLex::LEX_UNDEF:
539 lexrc.printError("Unknown alignment `$$Token'");
543 switch (static_cast<AlignTags>(le)) {
545 alignpossible |= LYX_ALIGN_BLOCK;
548 alignpossible |= LYX_ALIGN_LEFT;
551 alignpossible |= LYX_ALIGN_RIGHT;
554 alignpossible |= LYX_ALIGN_CENTER;
557 alignpossible |= LYX_ALIGN_LAYOUT;
560 } while (lineno == lexrc.getLineNo());
569 LA_CENTERED_TOP_ENVIRONMENT,
579 void LyXLayout::readLabelType(LyXLex & lexrc)
581 keyword_item labelTypeTags[] = {
582 { "bibliography", LA_BIBLIO },
583 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
584 { "counter", LA_COUNTER },
585 { "enumerate", LA_ENUMERATE },
586 { "itemize", LA_ITEMIZE },
587 { "manual", LA_MANUAL },
588 { "no_label", LA_NO_LABEL },
589 { "sensitive", LA_SENSITIVE },
590 { "static", LA_STATIC },
591 { "top_environment", LA_TOP_ENVIRONMENT }
594 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
595 int le = lexrc.lex();
597 case LyXLex::LEX_UNDEF:
598 lexrc.printError("Unknown labeltype tag `$$Token'");
602 switch (static_cast<LabelTypeTags>(le)) {
604 labeltype = LABEL_NO_LABEL;
607 labeltype = LABEL_MANUAL;
609 case LA_TOP_ENVIRONMENT:
610 labeltype = LABEL_TOP_ENVIRONMENT;
612 case LA_CENTERED_TOP_ENVIRONMENT:
613 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
616 labeltype = LABEL_STATIC;
619 labeltype = LABEL_SENSITIVE;
622 labeltype = LABEL_COUNTER;
625 labeltype = LABEL_ENUMERATE;
628 labeltype = LABEL_ITEMIZE;
631 labeltype = LABEL_BIBLIO;
639 keyword_item endlabelTypeTags[] = {
640 { "box", END_LABEL_BOX },
641 { "filled_box", END_LABEL_FILLED_BOX },
642 { "no_label", END_LABEL_NO_LABEL },
643 { "static", END_LABEL_STATIC }
649 void LyXLayout::readEndLabelType(LyXLex & lexrc)
651 pushpophelper pph(lexrc, endlabelTypeTags,
652 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
653 int le = lexrc.lex();
655 case LyXLex::LEX_UNDEF:
656 lexrc.printError("Unknown labeltype tag `$$Token'");
658 case END_LABEL_STATIC:
660 case END_LABEL_FILLED_BOX:
661 case END_LABEL_NO_LABEL:
662 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
665 lyxerr << "Unhandled value " << le
666 << " in LyXLayout::readEndLabelType." << endl;
672 void LyXLayout::readMargin(LyXLex & lexrc)
674 keyword_item marginTags[] = {
675 { "dynamic", MARGIN_DYNAMIC },
676 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
677 { "manual", MARGIN_MANUAL },
678 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
679 { "static", MARGIN_STATIC }
682 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
684 int le = lexrc.lex();
686 case LyXLex::LEX_UNDEF:
687 lexrc.printError("Unknown margin type tag `$$Token'");
692 case MARGIN_FIRST_DYNAMIC:
693 case MARGIN_RIGHT_ADDRESS_BOX:
694 margintype = static_cast<LYX_MARGIN_TYPE>(le);
697 lyxerr << "Unhandled value " << le
698 << " in LyXLayout::readMargin." << endl;
704 void LyXLayout::readLatexType(LyXLex & lexrc)
706 keyword_item latexTypeTags[] = {
707 { "bib_environment", LATEX_BIB_ENVIRONMENT },
708 { "command", LATEX_COMMAND },
709 { "environment", LATEX_ENVIRONMENT },
710 { "item_environment", LATEX_ITEM_ENVIRONMENT },
711 { "list_environment", LATEX_LIST_ENVIRONMENT },
712 { "paragraph", LATEX_PARAGRAPH }
715 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
716 int le = lexrc.lex();
718 case LyXLex::LEX_UNDEF:
719 lexrc.printError("Unknown latextype tag `$$Token'");
721 case LATEX_PARAGRAPH:
723 case LATEX_ENVIRONMENT:
724 case LATEX_ITEM_ENVIRONMENT:
725 case LATEX_BIB_ENVIRONMENT:
726 case LATEX_LIST_ENVIRONMENT:
727 latextype = static_cast<LYX_LATEX_TYPES>(le);
730 lyxerr << "Unhandled value " << le
731 << " in LyXLayout::readLatexType." << endl;
738 ST_SPACING_SINGLE = 1,
745 void LyXLayout::readSpacing(LyXLex & lexrc)
747 keyword_item spacingTags[] = {
748 {"double", ST_SPACING_DOUBLE },
749 {"onehalf", ST_SPACING_ONEHALF },
750 {"other", ST_OTHER },
751 {"single", ST_SPACING_SINGLE }
754 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
755 int le = lexrc.lex();
757 case LyXLex::LEX_UNDEF:
758 lexrc.printError("Unknown spacing token `$$Token'");
762 switch (static_cast<SpacingTags>(le)) {
763 case ST_SPACING_SINGLE:
764 spacing.set(Spacing::Single);
766 case ST_SPACING_ONEHALF:
767 spacing.set(Spacing::Onehalf);
769 case ST_SPACING_DOUBLE:
770 spacing.set(Spacing::Double);
774 spacing.set(Spacing::Other, lexrc.getFloat());
780 string const & LyXLayout::name() const
786 void LyXLayout::setName(string const & n)
792 string const & LyXLayout::obsoleted_by() const
794 return obsoleted_by_;
798 string const & LyXLayout::depends_on() const