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,
86 // Constructor for layout
87 LyXLayout::LyXLayout ()
89 margintype = MARGIN_STATIC;
90 latextype = LATEX_PARAGRAPH;
95 font = LyXFont(LyXFont::ALL_INHERIT);
96 labelfont = LyXFont(LyXFont::ALL_INHERIT);
97 resfont = LyXFont(LyXFont::ALL_SANE);
98 reslabelfont = LyXFont(LyXFont::ALL_SANE);
104 labelbottomsep = 0.0;
106 align = LYX_ALIGN_BLOCK;
107 alignpossible = LYX_ALIGN_BLOCK;
108 labeltype = LABEL_NO_LABEL;
109 endlabeltype = END_LABEL_NO_LABEL;
110 // Should or should not. That is the question.
111 // spacing.set(Spacing::OneHalf);
114 newline_allowed = true;
115 free_spacing = false;
117 is_environment = false;
121 // Reads a layout definition from file
122 bool LyXLayout::Read(LyXLex & lexrc, LyXTextClass const & tclass)
124 // This table is sorted alphabetically [asierra 30March96]
125 keyword_item layoutTags[] = {
126 { "align", LT_ALIGN },
127 { "alignpossible", LT_ALIGNPOSSIBLE },
128 { "bottomsep", LT_BOTTOMSEP },
129 { "copystyle", LT_COPYSTYLE },
130 { "dependson", LT_DEPENDSON },
132 { "endlabelstring", LT_ENDLABELSTRING },
133 { "endlabeltype", LT_ENDLABELTYPE },
134 { "fill_bottom", LT_FILL_BOTTOM },
135 { "fill_top", LT_FILL_TOP },
137 { "freespacing", LT_FREE_SPACING },
138 { "intitle", LT_INTITLE },
139 { "itemsep", LT_ITEMSEP },
140 { "keepempty", LT_KEEPEMPTY },
141 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
142 { "labelcounter", LT_LABELCOUNTER },
143 { "labelfont", LT_LABELFONT },
144 { "labelindent", LT_LABELINDENT },
145 { "labelsep", LT_LABELSEP },
146 { "labelstring", LT_LABELSTRING },
147 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
148 { "labeltype", LT_LABELTYPE },
149 { "latexfooter", LT_LATEXFOOTER },
150 { "latexheader", LT_LATEXHEADER },
151 { "latexname", LT_LATEXNAME },
152 { "latexparagraph", LT_LATEXPARAGRAPH },
153 { "latexparam", LT_LATEXPARAM },
154 { "latextype", LT_LATEXTYPE },
155 { "leftmargin", LT_LEFTMARGIN },
156 { "margin", LT_MARGIN },
157 { "needprotect", LT_NEED_PROTECT },
158 { "newline", LT_NEWLINE },
159 { "nextnoindent", LT_NEXTNOINDENT },
160 { "obsoletedby", LT_OBSOLETEDBY },
161 { "optionalargs", LT_OPTARGS },
162 { "parindent", LT_PARINDENT },
163 { "parsep", LT_PARSEP },
164 { "parskip", LT_PARSKIP },
165 { "passthru", LT_PASS_THRU },
166 { "preamble", LT_PREAMBLE },
167 { "rightmargin", LT_RIGHTMARGIN },
168 { "spacing", LT_SPACING },
169 { "textfont", LT_TEXTFONT },
170 { "topsep", LT_TOPSEP }
174 bool finished = false;
175 lexrc.pushTable(layoutTags, LT_INTITLE);
176 // parse style section
177 while (!finished && lexrc.isOK() && !error) {
178 int le = lexrc.lex();
179 // See comment in lyxrc.C.
181 case LyXLex::LEX_FEOF:
184 case LyXLex::LEX_UNDEF: // parse error
185 lexrc.printError("Unknown layout tag `$$Token'");
190 switch (static_cast<LayoutTags>(le)) {
191 case LT_END: // end of structure
195 case LT_COPYSTYLE: // initialize with a known style
197 string const style = lexrc.getString();
199 if (tclass.hasLayout(style)) {
200 string const tmpname = name_;
201 this->operator=(*tclass[style]);
204 lyxerr << "Cannot copy unknown style `"
206 << "All layouts so far:"
208 LyXTextClass::const_iterator it =
210 LyXTextClass::const_iterator end =
212 for (; it != end; ++it) {
213 lyxerr << (*it)->name()
217 //lexrc.printError("Cannot copy known "
218 // "style `$$Token'");
223 case LT_OBSOLETEDBY: // replace with a known style
225 string const style = lexrc.getString();
227 if (tclass.hasLayout(style)) {
228 string const tmpname = name_;
229 this->operator=(*tclass[style]);
231 if (obsoleted_by().empty())
232 obsoleted_by_ = style;
234 lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
236 //lexrc.printError("Cannot replace with"
245 depends_on_ = lexrc.getString();
249 case LT_MARGIN: // margin style definition.
253 case LT_LATEXTYPE: // LaTeX style definition.
254 readLatexType(lexrc);
257 case LT_LATEXHEADER: // header for environments
259 latexheader = lexrc.getString();
262 case LT_LATEXFOOTER: // footer for environments
264 latexfooter = lexrc.getString();
267 case LT_LATEXPARAGRAPH:
269 latexparagraph = lexrc.getString();
273 intitle = lexrc.next() && lexrc.getInteger();
278 optionalargs = lexrc.getInteger();
282 case LT_NEED_PROTECT:
283 needprotect = lexrc.next() && lexrc.getInteger();
287 keepempty = lexrc.next() && lexrc.getInteger();
300 labelfont.lyxRead(lexrc);
303 case LT_NEXTNOINDENT: // Indent next paragraph?
304 if (lexrc.next() && lexrc.getInteger())
307 nextnoindent = false;
312 latexname_ = lexrc.getString();
317 latexparam_ = lexrc.getString();
321 preamble_ = lexrc.getLongString("EndPreamble");
325 readLabelType(lexrc);
328 case LT_ENDLABELTYPE:
329 readEndLabelType(lexrc);
332 case LT_LEFTMARGIN: // left margin type
334 leftmargin = lexrc.getString();
337 case LT_RIGHTMARGIN: // right margin type
339 rightmargin = lexrc.getString();
342 case LT_LABELINDENT: // label indenting flag
344 labelindent = lexrc.getString();
347 case LT_PARINDENT: // paragraph indent. flag
349 parindent = lexrc.getString();
352 case LT_PARSKIP: // paragraph skip size
354 parskip = lexrc.getFloat();
357 case LT_ITEMSEP: // item separation size
359 itemsep = lexrc.getFloat();
362 case LT_TOPSEP: // top separation size
364 topsep = lexrc.getFloat();
367 case LT_BOTTOMSEP: // bottom separation size
369 bottomsep = lexrc.getFloat();
372 case LT_LABEL_BOTTOMSEP: // label bottom separation size
374 labelbottomsep = lexrc.getFloat();
377 case LT_LABELSEP: // label separator
379 labelsep = subst(lexrc.getString(), 'x', ' ');
383 case LT_PARSEP: // par. separation size
385 parsep = lexrc.getFloat();
388 case LT_FILL_TOP: // fill top flag
390 fill_top = lexrc.getInteger();
393 case LT_FILL_BOTTOM: // fill bottom flag
395 fill_bottom = lexrc.getInteger();
398 case LT_NEWLINE: // newlines allowed?
400 newline_allowed = lexrc.getInteger();
403 case LT_ALIGN: // paragraph align
406 case LT_ALIGNPOSSIBLE: // paragraph allowed align
407 readAlignPossible(lexrc);
410 case LT_LABELSTRING: // label string definition
412 labelstring_ = trim(lexrc.getString());
415 case LT_ENDLABELSTRING: // endlabel string definition
417 endlabelstring_ = trim(lexrc.getString());
420 case LT_LABELSTRING_APPENDIX: // label string appendix definition
422 labelstring_appendix_ = trim(lexrc.getString());
425 case LT_LABELCOUNTER: // name of counter to use
427 counter = trim(lexrc.getString());
430 case LT_FREE_SPACING: // Allow for free spacing.
432 free_spacing = lexrc.getInteger();
435 case LT_PASS_THRU: // Allow for pass thru.
437 pass_thru = lexrc.getInteger();
440 case LT_SPACING: // setspace.sty
447 if (labelstring_appendix_.empty())
448 labelstring_appendix_ = labelstring_;
462 void LyXLayout::readAlign(LyXLex & lexrc)
464 keyword_item alignTags[] = {
465 { "block", AT_BLOCK },
466 { "center", AT_CENTER },
467 { "layout", AT_LAYOUT },
469 { "right", AT_RIGHT }
472 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
473 int le = lexrc.lex();
475 case LyXLex::LEX_UNDEF:
476 lexrc.printError("Unknown alignment `$$Token'");
480 switch (static_cast<AlignTags>(le)) {
482 align = LYX_ALIGN_BLOCK;
485 align = LYX_ALIGN_LEFT;
488 align = LYX_ALIGN_RIGHT;
491 align = LYX_ALIGN_CENTER;
494 align = LYX_ALIGN_LAYOUT;
500 void LyXLayout::readAlignPossible(LyXLex & lexrc)
502 keyword_item alignTags[] = {
503 { "block", AT_BLOCK },
504 { "center", AT_CENTER },
505 { "layout", AT_LAYOUT },
507 { "right", AT_RIGHT }
510 lexrc.pushTable(alignTags, AT_LAYOUT);
511 alignpossible = LYX_ALIGN_NONE;
512 int lineno = lexrc.getLineNo();
514 int le = lexrc.lex();
516 case LyXLex::LEX_UNDEF:
517 lexrc.printError("Unknown alignment `$$Token'");
521 switch (static_cast<AlignTags>(le)) {
523 alignpossible |= LYX_ALIGN_BLOCK;
526 alignpossible |= LYX_ALIGN_LEFT;
529 alignpossible |= LYX_ALIGN_RIGHT;
532 alignpossible |= LYX_ALIGN_CENTER;
535 alignpossible |= LYX_ALIGN_LAYOUT;
538 } while (lineno == lexrc.getLineNo());
547 LA_CENTERED_TOP_ENVIRONMENT,
557 void LyXLayout::readLabelType(LyXLex & lexrc)
559 keyword_item labelTypeTags[] = {
560 { "bibliography", LA_BIBLIO },
561 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
562 { "counter", LA_COUNTER },
563 { "enumerate", LA_ENUMERATE },
564 { "itemize", LA_ITEMIZE },
565 { "manual", LA_MANUAL },
566 { "no_label", LA_NO_LABEL },
567 { "sensitive", LA_SENSITIVE },
568 { "static", LA_STATIC },
569 { "top_environment", LA_TOP_ENVIRONMENT }
572 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
573 int le = lexrc.lex();
575 case LyXLex::LEX_UNDEF:
576 lexrc.printError("Unknown labeltype tag `$$Token'");
580 switch (static_cast<LabelTypeTags>(le)) {
582 labeltype = LABEL_NO_LABEL;
585 labeltype = LABEL_MANUAL;
587 case LA_TOP_ENVIRONMENT:
588 labeltype = LABEL_TOP_ENVIRONMENT;
590 case LA_CENTERED_TOP_ENVIRONMENT:
591 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
594 labeltype = LABEL_STATIC;
597 labeltype = LABEL_SENSITIVE;
600 labeltype = LABEL_COUNTER;
603 labeltype = LABEL_ENUMERATE;
606 labeltype = LABEL_ITEMIZE;
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 { "bib_environment", LATEX_BIB_ENVIRONMENT },
686 { "command", LATEX_COMMAND },
687 { "environment", LATEX_ENVIRONMENT },
688 { "item_environment", LATEX_ITEM_ENVIRONMENT },
689 { "list_environment", LATEX_LIST_ENVIRONMENT },
690 { "paragraph", LATEX_PARAGRAPH }
693 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
694 int le = lexrc.lex();
696 case LyXLex::LEX_UNDEF:
697 lexrc.printError("Unknown latextype tag `$$Token'");
699 case LATEX_PARAGRAPH:
701 case LATEX_ENVIRONMENT:
702 case LATEX_ITEM_ENVIRONMENT:
703 case LATEX_BIB_ENVIRONMENT:
704 case LATEX_LIST_ENVIRONMENT:
705 latextype = static_cast<LYX_LATEX_TYPES>(le);
708 lyxerr << "Unhandled value " << le
709 << " in LyXLayout::readLatexType." << endl;
716 ST_SPACING_SINGLE = 1,
723 void LyXLayout::readSpacing(LyXLex & lexrc)
725 keyword_item spacingTags[] = {
726 {"double", ST_SPACING_DOUBLE },
727 {"onehalf", ST_SPACING_ONEHALF },
728 {"other", ST_OTHER },
729 {"single", ST_SPACING_SINGLE }
732 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
733 int le = lexrc.lex();
735 case LyXLex::LEX_UNDEF:
736 lexrc.printError("Unknown spacing token `$$Token'");
740 switch (static_cast<SpacingTags>(le)) {
741 case ST_SPACING_SINGLE:
742 spacing.set(Spacing::Single);
744 case ST_SPACING_ONEHALF:
745 spacing.set(Spacing::Onehalf);
747 case ST_SPACING_DOUBLE:
748 spacing.set(Spacing::Double);
752 spacing.set(Spacing::Other, lexrc.getFloat());
758 string const & LyXLayout::name() const
764 void LyXLayout::setName(string const & n)
770 string const & LyXLayout::obsoleted_by() const
772 return obsoleted_by_;
776 string const & LyXLayout::depends_on() const