2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2001 The LyX Team.
10 * ======================================================
16 #pragma implementation
19 #include "lyxlayout.h"
20 #include "lyxtextclass.h"
24 #include "support/lstrings.h"
28 // The order of the LayoutTags enum is no more important. [asierra300396]
39 //LT_ENVIRONMENT_DEFAULT,
56 LT_LABELSTRING_APPENDIX,
80 // Constructor for layout
81 LyXLayout::LyXLayout ()
83 margintype = MARGIN_STATIC;
84 latextype = LATEX_PARAGRAPH;
88 font = LyXFont(LyXFont::ALL_INHERIT);
89 labelfont = LyXFont(LyXFont::ALL_INHERIT);
90 resfont = LyXFont(LyXFont::ALL_SANE);
91 reslabelfont = LyXFont(LyXFont::ALL_SANE);
99 align = LYX_ALIGN_BLOCK;
100 alignpossible = LYX_ALIGN_BLOCK;
101 labeltype = LABEL_NO_LABEL;
102 endlabeltype = END_LABEL_NO_LABEL;
103 // Should or should not. That is the question.
104 // spacing.set(Spacing::OneHalf);
107 newline_allowed = true;
108 free_spacing = false;
113 // Reads a layout definition from file
114 bool LyXLayout::Read (LyXLex & lexrc, LyXTextClass const & tclass)
116 // This table is sorted alphabetically [asierra 30March96]
117 keyword_item layoutTags[] = {
118 { "align", LT_ALIGN },
119 { "alignpossible", LT_ALIGNPOSSIBLE },
120 { "bottomsep", LT_BOTTOMSEP },
121 { "copystyle", LT_COPYSTYLE },
123 { "endlabelstring", LT_ENDLABELSTRING },
124 { "endlabeltype", LT_ENDLABELTYPE },
125 { "fill_bottom", LT_FILL_BOTTOM },
126 { "fill_top", LT_FILL_TOP },
128 { "freespacing", LT_FREE_SPACING },
129 { "intitle", LT_INTITLE },
130 { "itemsep", LT_ITEMSEP },
131 { "keepempty", LT_KEEPEMPTY },
132 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
133 { "labelfont", LT_LABELFONT },
134 { "labelindent", LT_LABELINDENT },
135 { "labelsep", LT_LABELSEP },
136 { "labelstring", LT_LABELSTRING },
137 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
138 { "labeltype", LT_LABELTYPE },
139 { "latexname", LT_LATEXNAME },
140 { "latexparam", LT_LATEXPARAM },
141 { "latextype", LT_LATEXTYPE },
142 { "leftmargin", LT_LEFTMARGIN },
143 { "margin", LT_MARGIN },
144 { "needprotect", LT_NEED_PROTECT },
145 { "newline", LT_NEWLINE },
146 { "nextnoindent", LT_NEXTNOINDENT },
147 { "obsoletedby", LT_OBSOLETEDBY },
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 if (tclass.hasLayout(lexrc.getString())) {
184 string const tmpname = name_;
185 this->operator= (tclass.GetLayout(lexrc.getString()));
188 lexrc.printError("Cannot copy known "
194 case LT_OBSOLETEDBY: // replace with a known style
196 if (tclass.hasLayout(lexrc.getString())) {
197 string const tmpname = name_;
198 this->operator= (tclass.GetLayout(lexrc.getString()));
200 if (obsoleted_by().empty())
201 obsoleted_by_ = lexrc.getString();
203 lexrc.printError("Cannot replace with"
210 case LT_MARGIN: // Margin style definition.
214 case LT_LATEXTYPE: // Latex style definition.
215 readLatexType(lexrc);
219 intitle = lexrc.next() && lexrc.getInteger();
222 case LT_NEED_PROTECT:
223 needprotect = lexrc.next() && lexrc.getInteger();
227 keepempty = lexrc.next() && lexrc.getInteger();
240 labelfont.lyxRead(lexrc);
243 case LT_NEXTNOINDENT: // Indent next paragraph?
244 if (lexrc.next() && lexrc.getInteger())
247 nextnoindent = false;
252 latexname_ = lexrc.getString();
257 latexparam_ = lexrc.getString();
261 preamble_ = lexrc.getLongString("EndPreamble");
265 readLabelType(lexrc);
268 case LT_ENDLABELTYPE:
269 readEndLabelType(lexrc);
272 case LT_LEFTMARGIN: // left margin type
274 leftmargin = lexrc.getString();
277 case LT_RIGHTMARGIN: // right margin type
279 rightmargin = lexrc.getString();
282 case LT_LABELINDENT: // label indenting flag
284 labelindent = lexrc.getString();
287 case LT_PARINDENT: // paragraph indent. flag
289 parindent = lexrc.getString();
292 case LT_PARSKIP: // paragraph skip size
294 parskip = lexrc.getFloat();
297 case LT_ITEMSEP: // item separation size
299 itemsep = lexrc.getFloat();
302 case LT_TOPSEP: // top separation size
304 topsep = lexrc.getFloat();
307 case LT_BOTTOMSEP: // bottom separation size
309 bottomsep = lexrc.getFloat();
312 case LT_LABEL_BOTTOMSEP: // label bottom separation size
314 labelbottomsep = lexrc.getFloat();
317 case LT_LABELSEP: // label separator
319 labelsep = subst(lexrc.getString(), 'x', ' ');
323 case LT_PARSEP: // par. separation size
325 parsep = lexrc.getFloat();
328 case LT_FILL_TOP: // fill top flag
330 fill_top = lexrc.getInteger();
333 case LT_FILL_BOTTOM: // fill bottom flag
335 fill_bottom = lexrc.getInteger();
338 case LT_NEWLINE: // newlines allowed?
340 newline_allowed = lexrc.getInteger();
343 case LT_ALIGN: // paragraph align
346 case LT_ALIGNPOSSIBLE: // paragraph allowed align
347 readAlignPossible(lexrc);
350 case LT_LABELSTRING: // label string definition
352 labelstring_ = lexrc.getString();
355 case LT_ENDLABELSTRING: // endlabel string definition
357 endlabelstring_ = lexrc.getString();
360 case LT_LABELSTRING_APPENDIX: // label string appendix definition
362 labelstring_appendix_ = lexrc.getString();
365 case LT_FREE_SPACING: // Allow for free spacing.
367 free_spacing = lexrc.getInteger();
370 case LT_PASS_THRU: // Allow for pass thru.
372 pass_thru = lexrc.getInteger();
375 case LT_SPACING: // setspace.sty
394 void LyXLayout::readAlign(LyXLex & lexrc)
396 keyword_item alignTags[] = {
397 { "block", AT_BLOCK },
398 { "center", AT_CENTER },
399 { "layout", AT_LAYOUT },
401 { "right", AT_RIGHT }
404 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
405 int le = lexrc.lex();
407 case LyXLex::LEX_UNDEF:
408 lexrc.printError("Unknown alignment `$$Token'");
412 switch (static_cast<AlignTags>(le)) {
414 align = LYX_ALIGN_BLOCK;
417 align = LYX_ALIGN_LEFT;
420 align = LYX_ALIGN_RIGHT;
423 align = LYX_ALIGN_CENTER;
426 align = LYX_ALIGN_LAYOUT;
432 void LyXLayout::readAlignPossible(LyXLex & lexrc)
434 keyword_item alignTags[] = {
435 { "block", AT_BLOCK },
436 { "center", AT_CENTER },
437 { "layout", AT_LAYOUT },
439 { "right", AT_RIGHT }
442 lexrc.pushTable(alignTags, AT_LAYOUT);
443 alignpossible = LYX_ALIGN_NONE;
444 int lineno = lexrc.getLineNo();
446 int le = lexrc.lex();
448 case LyXLex::LEX_UNDEF:
449 lexrc.printError("Unknown alignment `$$Token'");
453 switch (static_cast<AlignTags>(le)) {
455 alignpossible |= LYX_ALIGN_BLOCK;
458 alignpossible |= LYX_ALIGN_LEFT;
461 alignpossible |= LYX_ALIGN_RIGHT;
464 alignpossible |= LYX_ALIGN_CENTER;
467 alignpossible |= LYX_ALIGN_LAYOUT;
470 } while (lineno == lexrc.getLineNo());
479 LA_CENTERED_TOP_ENVIRONMENT,
484 LA_COUNTER_SUBSECTION,
485 LA_COUNTER_SUBSUBSECTION,
486 LA_COUNTER_PARAGRAPH,
487 LA_COUNTER_SUBPARAGRAPH,
496 void LyXLayout::readLabelType(LyXLex & lexrc)
498 keyword_item labelTypeTags[] = {
499 { "bibliography", LA_BIBLIO },
500 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
501 { "counter_chapter", LA_COUNTER_CHAPTER },
502 { "counter_enumi", LA_COUNTER_ENUMI },
503 { "counter_enumii", LA_COUNTER_ENUMII },
504 { "counter_enumiii", LA_COUNTER_ENUMIII },
505 { "counter_enumiv", LA_COUNTER_ENUMIV },
506 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
507 { "counter_section", LA_COUNTER_SECTION },
508 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
509 { "counter_subsection", LA_COUNTER_SUBSECTION },
510 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
511 { "manual", LA_MANUAL },
512 { "no_label", LA_NO_LABEL },
513 { "sensitive", LA_SENSITIVE },
514 { "static", LA_STATIC },
515 { "top_environment", LA_TOP_ENVIRONMENT }
518 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
519 int le = lexrc.lex();
521 case LyXLex::LEX_UNDEF:
522 lexrc.printError("Unknown labeltype tag `$$Token'");
526 switch (static_cast<LabelTypeTags>(le)) {
528 labeltype = LABEL_NO_LABEL;
531 labeltype = LABEL_MANUAL;
533 case LA_TOP_ENVIRONMENT:
534 labeltype = LABEL_TOP_ENVIRONMENT;
536 case LA_CENTERED_TOP_ENVIRONMENT:
537 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
540 labeltype = LABEL_STATIC;
543 labeltype = LABEL_SENSITIVE;
545 case LA_COUNTER_CHAPTER:
546 labeltype = LABEL_COUNTER_CHAPTER;
548 case LA_COUNTER_SECTION:
549 labeltype = LABEL_COUNTER_SECTION;
551 case LA_COUNTER_SUBSECTION:
552 labeltype = LABEL_COUNTER_SUBSECTION;
554 case LA_COUNTER_SUBSUBSECTION:
555 labeltype = LABEL_COUNTER_SUBSUBSECTION;
557 case LA_COUNTER_PARAGRAPH:
558 labeltype = LABEL_COUNTER_PARAGRAPH;
560 case LA_COUNTER_SUBPARAGRAPH:
561 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
563 case LA_COUNTER_ENUMI:
564 labeltype = LABEL_COUNTER_ENUMI;
566 case LA_COUNTER_ENUMII:
567 labeltype = LABEL_COUNTER_ENUMII;
569 case LA_COUNTER_ENUMIII:
570 labeltype = LABEL_COUNTER_ENUMIII;
572 case LA_COUNTER_ENUMIV:
573 labeltype = LABEL_COUNTER_ENUMIV;
576 labeltype = LABEL_BIBLIO;
584 keyword_item endlabelTypeTags[] = {
585 { "box", END_LABEL_BOX },
586 { "filled_box", END_LABEL_FILLED_BOX },
587 { "no_label", END_LABEL_NO_LABEL },
588 { "static", END_LABEL_STATIC }
594 void LyXLayout::readEndLabelType(LyXLex & lexrc)
596 pushpophelper pph(lexrc, endlabelTypeTags,
597 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
598 int le = lexrc.lex();
600 case LyXLex::LEX_UNDEF:
601 lexrc.printError("Unknown labeltype tag `$$Token'");
603 case END_LABEL_STATIC:
605 case END_LABEL_FILLED_BOX:
606 case END_LABEL_NO_LABEL:
607 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
610 lyxerr << "Unhandled value " << le
611 << " in LyXLayout::readEndLabelType." << endl;
617 void LyXLayout::readMargin(LyXLex & lexrc)
619 keyword_item marginTags[] = {
620 { "dynamic", MARGIN_DYNAMIC },
621 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
622 { "manual", MARGIN_MANUAL },
623 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
624 { "static", MARGIN_STATIC }
627 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
629 int le = lexrc.lex();
631 case LyXLex::LEX_UNDEF:
632 lexrc.printError("Unknown margin type tag `$$Token'");
637 case MARGIN_FIRST_DYNAMIC:
638 case MARGIN_RIGHT_ADDRESS_BOX:
639 margintype = static_cast<LYX_MARGIN_TYPE>(le);
642 lyxerr << "Unhandled value " << le
643 << " in LyXLayout::readMargin." << endl;
649 void LyXLayout::readLatexType(LyXLex & lexrc)
651 keyword_item latexTypeTags[] = {
652 { "command", LATEX_COMMAND },
653 { "environment", LATEX_ENVIRONMENT },
654 { "item_environment", LATEX_ITEM_ENVIRONMENT },
655 { "list_environment", LATEX_LIST_ENVIRONMENT },
656 { "paragraph", LATEX_PARAGRAPH }
659 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
660 int le = lexrc.lex();
662 case LyXLex::LEX_UNDEF:
663 lexrc.printError("Unknown latextype tag `$$Token'");
665 case LATEX_PARAGRAPH:
667 case LATEX_ENVIRONMENT:
668 case LATEX_ITEM_ENVIRONMENT:
669 case LATEX_LIST_ENVIRONMENT:
670 latextype = static_cast<LYX_LATEX_TYPES>(le);
673 lyxerr << "Unhandled value " << le
674 << " in LyXLayout::readLatexType." << endl;
681 ST_SPACING_SINGLE = 1,
688 void LyXLayout::readSpacing(LyXLex & lexrc)
690 keyword_item spacingTags[] = {
691 {"double", ST_SPACING_DOUBLE },
692 {"onehalf", ST_SPACING_ONEHALF },
693 {"other", ST_OTHER },
694 {"single", ST_SPACING_SINGLE }
697 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
698 int le = lexrc.lex();
700 case LyXLex::LEX_UNDEF:
701 lexrc.printError("Unknown spacing token `$$Token'");
705 switch (static_cast<SpacingTags>(le)) {
706 case ST_SPACING_SINGLE:
707 spacing.set(Spacing::Single);
709 case ST_SPACING_ONEHALF:
710 spacing.set(Spacing::Onehalf);
712 case ST_SPACING_DOUBLE:
713 spacing.set(Spacing::Double);
717 spacing.set(Spacing::Other, lexrc.getFloat());