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 string const style = lowercase(lexrc.getString());
185 if (tclass.hasLayout(style)) {
186 string const tmpname = lowercase(name_);
187 this->operator=(tclass[style]);
188 name_ = lowercase(tmpname);
190 lyxerr << "Cannot copy unknown style `" << style << "'" << endl;
191 LyXTextClass::const_iterator it = tclass.begin();
192 LyXTextClass::const_iterator end = tclass.end();
193 lyxerr << "All layouts so far:" << endl;
194 for (; it != end; ++it) {
195 //lyxerr << it->name() << endl;
196 fprintf(stderr, "%s\n", it->name().c_str());
199 //lexrc.printError("Cannot copy known "
200 // "style `$$Token'");
205 case LT_OBSOLETEDBY: // replace with a known style
207 string const style = lowercase(lexrc.getString());
209 if (tclass.hasLayout(style)) {
210 string const tmpname = name_;
211 this->operator=(tclass[style]);
213 if (obsoleted_by().empty())
214 obsoleted_by_ = style;
216 lyxerr << "Cannot replace with unknown style `" << style << "'" << endl;
218 //lexrc.printError("Cannot replace with"
225 case LT_MARGIN: // Margin style definition.
229 case LT_LATEXTYPE: // Latex style definition.
230 readLatexType(lexrc);
234 intitle = lexrc.next() && lexrc.getInteger();
237 case LT_NEED_PROTECT:
238 needprotect = lexrc.next() && lexrc.getInteger();
242 keepempty = lexrc.next() && lexrc.getInteger();
255 labelfont.lyxRead(lexrc);
258 case LT_NEXTNOINDENT: // Indent next paragraph?
259 if (lexrc.next() && lexrc.getInteger())
262 nextnoindent = false;
267 latexname_ = lexrc.getString();
272 latexparam_ = lexrc.getString();
276 preamble_ = lexrc.getLongString("EndPreamble");
280 readLabelType(lexrc);
283 case LT_ENDLABELTYPE:
284 readEndLabelType(lexrc);
287 case LT_LEFTMARGIN: // left margin type
289 leftmargin = lexrc.getString();
292 case LT_RIGHTMARGIN: // right margin type
294 rightmargin = lexrc.getString();
297 case LT_LABELINDENT: // label indenting flag
299 labelindent = lexrc.getString();
302 case LT_PARINDENT: // paragraph indent. flag
304 parindent = lexrc.getString();
307 case LT_PARSKIP: // paragraph skip size
309 parskip = lexrc.getFloat();
312 case LT_ITEMSEP: // item separation size
314 itemsep = lexrc.getFloat();
317 case LT_TOPSEP: // top separation size
319 topsep = lexrc.getFloat();
322 case LT_BOTTOMSEP: // bottom separation size
324 bottomsep = lexrc.getFloat();
327 case LT_LABEL_BOTTOMSEP: // label bottom separation size
329 labelbottomsep = lexrc.getFloat();
332 case LT_LABELSEP: // label separator
334 labelsep = subst(lexrc.getString(), 'x', ' ');
338 case LT_PARSEP: // par. separation size
340 parsep = lexrc.getFloat();
343 case LT_FILL_TOP: // fill top flag
345 fill_top = lexrc.getInteger();
348 case LT_FILL_BOTTOM: // fill bottom flag
350 fill_bottom = lexrc.getInteger();
353 case LT_NEWLINE: // newlines allowed?
355 newline_allowed = lexrc.getInteger();
358 case LT_ALIGN: // paragraph align
361 case LT_ALIGNPOSSIBLE: // paragraph allowed align
362 readAlignPossible(lexrc);
365 case LT_LABELSTRING: // label string definition
367 labelstring_ = lexrc.getString();
370 case LT_ENDLABELSTRING: // endlabel string definition
372 endlabelstring_ = lexrc.getString();
375 case LT_LABELSTRING_APPENDIX: // label string appendix definition
377 labelstring_appendix_ = lexrc.getString();
380 case LT_FREE_SPACING: // Allow for free spacing.
382 free_spacing = lexrc.getInteger();
385 case LT_PASS_THRU: // Allow for pass thru.
387 pass_thru = lexrc.getInteger();
390 case LT_SPACING: // setspace.sty
409 void LyXLayout::readAlign(LyXLex & lexrc)
411 keyword_item alignTags[] = {
412 { "block", AT_BLOCK },
413 { "center", AT_CENTER },
414 { "layout", AT_LAYOUT },
416 { "right", AT_RIGHT }
419 pushpophelper pph(lexrc, alignTags, AT_LAYOUT);
420 int le = lexrc.lex();
422 case LyXLex::LEX_UNDEF:
423 lexrc.printError("Unknown alignment `$$Token'");
427 switch (static_cast<AlignTags>(le)) {
429 align = LYX_ALIGN_BLOCK;
432 align = LYX_ALIGN_LEFT;
435 align = LYX_ALIGN_RIGHT;
438 align = LYX_ALIGN_CENTER;
441 align = LYX_ALIGN_LAYOUT;
447 void LyXLayout::readAlignPossible(LyXLex & lexrc)
449 keyword_item alignTags[] = {
450 { "block", AT_BLOCK },
451 { "center", AT_CENTER },
452 { "layout", AT_LAYOUT },
454 { "right", AT_RIGHT }
457 lexrc.pushTable(alignTags, AT_LAYOUT);
458 alignpossible = LYX_ALIGN_NONE;
459 int lineno = lexrc.getLineNo();
461 int le = lexrc.lex();
463 case LyXLex::LEX_UNDEF:
464 lexrc.printError("Unknown alignment `$$Token'");
468 switch (static_cast<AlignTags>(le)) {
470 alignpossible |= LYX_ALIGN_BLOCK;
473 alignpossible |= LYX_ALIGN_LEFT;
476 alignpossible |= LYX_ALIGN_RIGHT;
479 alignpossible |= LYX_ALIGN_CENTER;
482 alignpossible |= LYX_ALIGN_LAYOUT;
485 } while (lineno == lexrc.getLineNo());
494 LA_CENTERED_TOP_ENVIRONMENT,
499 LA_COUNTER_SUBSECTION,
500 LA_COUNTER_SUBSUBSECTION,
501 LA_COUNTER_PARAGRAPH,
502 LA_COUNTER_SUBPARAGRAPH,
511 void LyXLayout::readLabelType(LyXLex & lexrc)
513 keyword_item labelTypeTags[] = {
514 { "bibliography", LA_BIBLIO },
515 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
516 { "counter_chapter", LA_COUNTER_CHAPTER },
517 { "counter_enumi", LA_COUNTER_ENUMI },
518 { "counter_enumii", LA_COUNTER_ENUMII },
519 { "counter_enumiii", LA_COUNTER_ENUMIII },
520 { "counter_enumiv", LA_COUNTER_ENUMIV },
521 { "counter_paragraph", LA_COUNTER_PARAGRAPH },
522 { "counter_section", LA_COUNTER_SECTION },
523 { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
524 { "counter_subsection", LA_COUNTER_SUBSECTION },
525 { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
526 { "manual", LA_MANUAL },
527 { "no_label", LA_NO_LABEL },
528 { "sensitive", LA_SENSITIVE },
529 { "static", LA_STATIC },
530 { "top_environment", LA_TOP_ENVIRONMENT }
533 pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
534 int le = lexrc.lex();
536 case LyXLex::LEX_UNDEF:
537 lexrc.printError("Unknown labeltype tag `$$Token'");
541 switch (static_cast<LabelTypeTags>(le)) {
543 labeltype = LABEL_NO_LABEL;
546 labeltype = LABEL_MANUAL;
548 case LA_TOP_ENVIRONMENT:
549 labeltype = LABEL_TOP_ENVIRONMENT;
551 case LA_CENTERED_TOP_ENVIRONMENT:
552 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
555 labeltype = LABEL_STATIC;
558 labeltype = LABEL_SENSITIVE;
560 case LA_COUNTER_CHAPTER:
561 labeltype = LABEL_COUNTER_CHAPTER;
563 case LA_COUNTER_SECTION:
564 labeltype = LABEL_COUNTER_SECTION;
566 case LA_COUNTER_SUBSECTION:
567 labeltype = LABEL_COUNTER_SUBSECTION;
569 case LA_COUNTER_SUBSUBSECTION:
570 labeltype = LABEL_COUNTER_SUBSUBSECTION;
572 case LA_COUNTER_PARAGRAPH:
573 labeltype = LABEL_COUNTER_PARAGRAPH;
575 case LA_COUNTER_SUBPARAGRAPH:
576 labeltype = LABEL_COUNTER_SUBPARAGRAPH;
578 case LA_COUNTER_ENUMI:
579 labeltype = LABEL_COUNTER_ENUMI;
581 case LA_COUNTER_ENUMII:
582 labeltype = LABEL_COUNTER_ENUMII;
584 case LA_COUNTER_ENUMIII:
585 labeltype = LABEL_COUNTER_ENUMIII;
587 case LA_COUNTER_ENUMIV:
588 labeltype = LABEL_COUNTER_ENUMIV;
591 labeltype = LABEL_BIBLIO;
599 keyword_item endlabelTypeTags[] = {
600 { "box", END_LABEL_BOX },
601 { "filled_box", END_LABEL_FILLED_BOX },
602 { "no_label", END_LABEL_NO_LABEL },
603 { "static", END_LABEL_STATIC }
609 void LyXLayout::readEndLabelType(LyXLex & lexrc)
611 pushpophelper pph(lexrc, endlabelTypeTags,
612 END_LABEL_ENUM_LAST-END_LABEL_ENUM_FIRST+1);
613 int le = lexrc.lex();
615 case LyXLex::LEX_UNDEF:
616 lexrc.printError("Unknown labeltype tag `$$Token'");
618 case END_LABEL_STATIC:
620 case END_LABEL_FILLED_BOX:
621 case END_LABEL_NO_LABEL:
622 endlabeltype = static_cast<LYX_END_LABEL_TYPES>(le);
625 lyxerr << "Unhandled value " << le
626 << " in LyXLayout::readEndLabelType." << endl;
632 void LyXLayout::readMargin(LyXLex & lexrc)
634 keyword_item marginTags[] = {
635 { "dynamic", MARGIN_DYNAMIC },
636 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
637 { "manual", MARGIN_MANUAL },
638 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
639 { "static", MARGIN_STATIC }
642 pushpophelper pph(lexrc, marginTags, MARGIN_RIGHT_ADDRESS_BOX);
644 int le = lexrc.lex();
646 case LyXLex::LEX_UNDEF:
647 lexrc.printError("Unknown margin type tag `$$Token'");
652 case MARGIN_FIRST_DYNAMIC:
653 case MARGIN_RIGHT_ADDRESS_BOX:
654 margintype = static_cast<LYX_MARGIN_TYPE>(le);
657 lyxerr << "Unhandled value " << le
658 << " in LyXLayout::readMargin." << endl;
664 void LyXLayout::readLatexType(LyXLex & lexrc)
666 keyword_item latexTypeTags[] = {
667 { "command", LATEX_COMMAND },
668 { "environment", LATEX_ENVIRONMENT },
669 { "item_environment", LATEX_ITEM_ENVIRONMENT },
670 { "list_environment", LATEX_LIST_ENVIRONMENT },
671 { "paragraph", LATEX_PARAGRAPH }
674 pushpophelper pph(lexrc, latexTypeTags, LATEX_LIST_ENVIRONMENT);
675 int le = lexrc.lex();
677 case LyXLex::LEX_UNDEF:
678 lexrc.printError("Unknown latextype tag `$$Token'");
680 case LATEX_PARAGRAPH:
682 case LATEX_ENVIRONMENT:
683 case LATEX_ITEM_ENVIRONMENT:
684 case LATEX_LIST_ENVIRONMENT:
685 latextype = static_cast<LYX_LATEX_TYPES>(le);
688 lyxerr << "Unhandled value " << le
689 << " in LyXLayout::readLatexType." << endl;
696 ST_SPACING_SINGLE = 1,
703 void LyXLayout::readSpacing(LyXLex & lexrc)
705 keyword_item spacingTags[] = {
706 {"double", ST_SPACING_DOUBLE },
707 {"onehalf", ST_SPACING_ONEHALF },
708 {"other", ST_OTHER },
709 {"single", ST_SPACING_SINGLE }
712 pushpophelper pph(lexrc, spacingTags, ST_OTHER);
713 int le = lexrc.lex();
715 case LyXLex::LEX_UNDEF:
716 lexrc.printError("Unknown spacing token `$$Token'");
720 switch (static_cast<SpacingTags>(le)) {
721 case ST_SPACING_SINGLE:
722 spacing.set(Spacing::Single);
724 case ST_SPACING_ONEHALF:
725 spacing.set(Spacing::Onehalf);
727 case ST_SPACING_DOUBLE:
728 spacing.set(Spacing::Double);
732 spacing.set(Spacing::Other, lexrc.getFloat());
738 string const & LyXLayout::name() const
740 static string name_t;
741 name_t = lowercase(name_);
746 void LyXLayout::setName(string const & n)
748 name_ = lowercase(n);
752 string const & LyXLayout::obsoleted_by() const
754 static string obsoleted_by_t;
755 obsoleted_by_t = lowercase(obsoleted_by_);
756 return obsoleted_by_t;