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.
17 #include "TextClass.h"
21 #include "support/Messages.h"
22 #include "support/debug.h"
23 #include "support/lassert.h"
24 #include "support/lstrings.h"
26 #include <boost/regex.hpp>
29 using namespace lyx::support;
33 /// Special value of toclevel for layouts that to not belong in a TOC
34 const int Layout::NOT_IN_TOC = -1000;
36 // The order of the LayoutTags enum is no more important. [asierra300396]
50 //LT_ENVIRONMENT_DEFAULT,
67 LT_LABELSTRING_APPENDIX,
95 LT_INTITLE // keep this last!
103 margintype = MARGIN_STATIC;
104 latextype = LATEX_PARAGRAPH;
110 labelfont = inherit_font;
112 reslabelfont = sane_font;
113 nextnoindent = false;
118 labelbottomsep = 0.0;
120 align = LYX_ALIGN_BLOCK;
121 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
122 labeltype = LABEL_NO_LABEL;
123 endlabeltype = END_LABEL_NO_LABEL;
124 // Should or should not. That is the question.
125 // spacing.set(Spacing::OneHalf);
128 newline_allowed = true;
129 free_spacing = false;
131 toclevel = NOT_IN_TOC;
136 bool Layout::read(Lexer & lex, TextClass const & tclass)
138 // This table is sorted alphabetically [asierra 30March96]
139 LexerKeyword layoutTags[] = {
140 { "align", LT_ALIGN },
141 { "alignpossible", LT_ALIGNPOSSIBLE },
142 { "babelpreamble", LT_BABELPREAMBLE },
143 { "bottomsep", LT_BOTTOMSEP },
144 { "category", LT_CATEGORY },
145 { "commanddepth", LT_COMMANDDEPTH },
146 { "copystyle", LT_COPYSTYLE },
147 { "dependson", LT_DEPENDSON },
149 { "endlabelstring", LT_ENDLABELSTRING },
150 { "endlabeltype", LT_ENDLABELTYPE },
151 { "fill_bottom", LT_FILL_BOTTOM },
152 { "fill_top", LT_FILL_TOP },
154 { "freespacing", LT_FREE_SPACING },
155 { "innertag", LT_INNERTAG },
156 { "intitle", LT_INTITLE },
157 { "itemsep", LT_ITEMSEP },
158 { "itemtag", LT_ITEMTAG },
159 { "keepempty", LT_KEEPEMPTY },
160 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
161 { "labelcounter", LT_LABELCOUNTER },
162 { "labelfont", LT_LABELFONT },
163 { "labelindent", LT_LABELINDENT },
164 { "labelsep", LT_LABELSEP },
165 { "labelstring", LT_LABELSTRING },
166 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
167 { "labeltag", LT_LABELTAG },
168 { "labeltype", LT_LABELTYPE },
169 { "langpreamble", LT_LANGPREAMBLE },
170 { "latexname", LT_LATEXNAME },
171 { "latexparam", LT_LATEXPARAM },
172 { "latextype", LT_LATEXTYPE },
173 { "leftmargin", LT_LEFTMARGIN },
174 { "margin", LT_MARGIN },
175 { "needprotect", LT_NEED_PROTECT },
176 { "newline", LT_NEWLINE },
177 { "nextnoindent", LT_NEXTNOINDENT },
178 { "obsoletedby", LT_OBSOLETEDBY },
179 { "optionalargs", LT_OPTARGS },
180 { "parindent", LT_PARINDENT },
181 { "parsep", LT_PARSEP },
182 { "parskip", LT_PARSKIP },
183 { "passthru", LT_PASS_THRU },
184 { "preamble", LT_PREAMBLE },
185 { "requires", LT_REQUIRES },
186 { "rightmargin", LT_RIGHTMARGIN },
187 { "spacing", LT_SPACING },
188 { "textfont", LT_TEXTFONT },
189 { "toclevel", LT_TOCLEVEL },
190 { "topsep", LT_TOPSEP }
194 bool finished = false;
195 lex.pushTable(layoutTags);
196 // parse style section
197 while (!finished && lex.isOK() && !error) {
199 // See comment in LyXRC.cpp.
201 case Lexer::LEX_FEOF:
204 case Lexer::LEX_UNDEF: // parse error
205 lex.printError("Unknown layout tag `$$Token'");
210 switch (static_cast<LayoutTags>(le)) {
211 case LT_END: // end of structure
219 case LT_COPYSTYLE: { // initialize with a known style
222 style = subst(style, '_', ' ');
224 if (tclass.hasLayout(style)) {
225 docstring const tmpname = name_;
226 this->operator=(tclass[style]);
229 LYXERR0("Cannot copy unknown style `"
231 << "All layouts so far:");
232 DocumentClass::const_iterator lit = tclass.begin();
233 DocumentClass::const_iterator len = tclass.end();
234 for (; lit != len; ++lit)
235 LYXERR0(lit->name());
240 case LT_OBSOLETEDBY: { // replace with a known style
243 style = subst(style, '_', ' ');
245 if (tclass.hasLayout(style)) {
246 docstring const tmpname = name_;
247 this->operator=(tclass[style]);
249 if (obsoleted_by().empty())
250 obsoleted_by_ = style;
252 LYXERR0("Cannot replace with unknown style `"
255 //lex.printError("Cannot replace with"
264 depends_on_ = subst(depends_on_, '_', ' ');
267 case LT_MARGIN: // margin style definition.
271 case LT_LATEXTYPE: // LaTeX style definition.
284 lex >> optionalargs ;
287 case LT_NEED_PROTECT:
296 font = lyxRead(lex, font);
301 font = lyxRead(lex, font);
305 labelfont = lyxRead(lex, labelfont);
308 case LT_NEXTNOINDENT: // Indent next paragraph?
312 case LT_COMMANDDEPTH:
322 latexparam_ = subst(latexparam_, """, "\"");
338 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
341 case LT_LANGPREAMBLE:
342 langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble"));
345 case LT_BABELPREAMBLE:
346 babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble"));
353 case LT_ENDLABELTYPE:
354 readEndLabelType(lex);
357 case LT_LEFTMARGIN: // left margin type
361 case LT_RIGHTMARGIN: // right margin type
365 case LT_LABELINDENT: // label indenting flag
369 case LT_PARINDENT: // paragraph indent. flag
373 case LT_PARSKIP: // paragraph skip size
377 case LT_ITEMSEP: // item separation size
381 case LT_TOPSEP: // top separation size
385 case LT_BOTTOMSEP: // bottom separation size
389 case LT_LABEL_BOTTOMSEP: // label bottom separation size
390 lex >> labelbottomsep;
393 case LT_LABELSEP: // label separator
395 labelsep = subst(labelsep, 'x', ' ');
398 case LT_PARSEP: // par. separation size
402 case LT_FILL_TOP: // fill top flag
406 case LT_FILL_BOTTOM: // fill bottom flag
410 case LT_NEWLINE: // newlines allowed?
411 lex >> newline_allowed;
414 case LT_ALIGN: // paragraph align
417 case LT_ALIGNPOSSIBLE: // paragraph allowed align
418 readAlignPossible(lex);
421 case LT_LABELSTRING: // label string definition
422 // FIXME: this means LT_ENDLABELSTRING may only
423 // occur after LT_LABELSTRING
425 labelstring_ = trim(labelstring_);
426 labelstring_appendix_ = labelstring_;
429 case LT_ENDLABELSTRING: // endlabel string definition
430 lex >> endlabelstring_;
431 endlabelstring_ = trim(endlabelstring_);
434 case LT_LABELSTRING_APPENDIX: // label string appendix definition
435 lex >> labelstring_appendix_;
436 labelstring_appendix_ = trim(labelstring_appendix_);
439 case LT_LABELCOUNTER: // name of counter to use
441 counter = trim(counter);
444 case LT_FREE_SPACING: // Allow for free spacing.
448 case LT_PASS_THRU: // Allow for pass thru.
452 case LT_SPACING: // setspace.sty
458 vector<string> const req =
459 getVectorFromString(lex.getString());
460 requires_.insert(req.begin(), req.end());
480 LexerKeyword alignTags[] = {
481 { "block", AT_BLOCK },
482 { "center", AT_CENTER },
483 { "layout", AT_LAYOUT },
485 { "right", AT_RIGHT }
489 void Layout::readAlign(Lexer & lex)
491 PushPopHelper pph(lex, alignTags);
494 case Lexer::LEX_UNDEF:
495 lex.printError("Unknown alignment `$$Token'");
501 align = LYX_ALIGN_BLOCK;
504 align = LYX_ALIGN_LEFT;
507 align = LYX_ALIGN_RIGHT;
510 align = LYX_ALIGN_CENTER;
513 align = LYX_ALIGN_LAYOUT;
519 void Layout::readAlignPossible(Lexer & lex)
521 lex.pushTable(alignTags);
522 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
523 int lineno = lex.lineNumber();
527 case Lexer::LEX_UNDEF:
528 lex.printError("Unknown alignment `$$Token'");
534 alignpossible |= LYX_ALIGN_BLOCK;
537 alignpossible |= LYX_ALIGN_LEFT;
540 alignpossible |= LYX_ALIGN_RIGHT;
543 alignpossible |= LYX_ALIGN_CENTER;
546 alignpossible |= LYX_ALIGN_LAYOUT;
549 } while (lineno == lex.lineNumber());
554 void Layout::readLabelType(Lexer & lex)
560 LA_CENTERED_TOP_ENVIRONMENT,
570 LexerKeyword labelTypeTags[] = {
571 { "bibliography", LA_BIBLIO },
572 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
573 { "counter", LA_COUNTER },
574 { "enumerate", LA_ENUMERATE },
575 { "itemize", LA_ITEMIZE },
576 { "manual", LA_MANUAL },
577 { "no_label", LA_NO_LABEL },
578 { "sensitive", LA_SENSITIVE },
579 { "static", LA_STATIC },
580 { "top_environment", LA_TOP_ENVIRONMENT }
583 PushPopHelper pph(lex, labelTypeTags);
586 case Lexer::LEX_UNDEF:
587 lex.printError("Unknown labeltype tag `$$Token'");
593 labeltype = LABEL_NO_LABEL;
596 labeltype = LABEL_MANUAL;
598 case LA_TOP_ENVIRONMENT:
599 labeltype = LABEL_TOP_ENVIRONMENT;
601 case LA_CENTERED_TOP_ENVIRONMENT:
602 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
605 labeltype = LABEL_STATIC;
608 labeltype = LABEL_SENSITIVE;
611 labeltype = LABEL_COUNTER;
614 labeltype = LABEL_ENUMERATE;
617 labeltype = LABEL_ITEMIZE;
620 labeltype = LABEL_BIBLIO;
626 void Layout::readEndLabelType(Lexer & lex)
628 static LexerKeyword endlabelTypeTags[] = {
629 { "box", END_LABEL_BOX },
630 { "filled_box", END_LABEL_FILLED_BOX },
631 { "no_label", END_LABEL_NO_LABEL },
632 { "static", END_LABEL_STATIC }
635 PushPopHelper pph(lex, endlabelTypeTags);
638 case Lexer::LEX_UNDEF:
639 lex.printError("Unknown labeltype tag `$$Token'");
641 case END_LABEL_STATIC:
643 case END_LABEL_FILLED_BOX:
644 case END_LABEL_NO_LABEL:
645 endlabeltype = static_cast<EndLabelType>(le);
648 LYXERR0("Unhandled value " << le);
654 void Layout::readMargin(Lexer & lex)
656 LexerKeyword marginTags[] = {
657 { "dynamic", MARGIN_DYNAMIC },
658 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
659 { "manual", MARGIN_MANUAL },
660 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
661 { "static", MARGIN_STATIC }
664 PushPopHelper pph(lex, marginTags);
668 case Lexer::LEX_UNDEF:
669 lex.printError("Unknown margin type tag `$$Token'");
674 case MARGIN_FIRST_DYNAMIC:
675 case MARGIN_RIGHT_ADDRESS_BOX:
676 margintype = static_cast<MarginType>(le);
679 LYXERR0("Unhandled value " << le);
685 void Layout::readLatexType(Lexer & lex)
687 LexerKeyword latexTypeTags[] = {
688 { "bib_environment", LATEX_BIB_ENVIRONMENT },
689 { "command", LATEX_COMMAND },
690 { "environment", LATEX_ENVIRONMENT },
691 { "item_environment", LATEX_ITEM_ENVIRONMENT },
692 { "list_environment", LATEX_LIST_ENVIRONMENT },
693 { "paragraph", LATEX_PARAGRAPH }
696 PushPopHelper pph(lex, latexTypeTags);
699 case Lexer::LEX_UNDEF:
700 lex.printError("Unknown latextype tag `$$Token'");
702 case LATEX_PARAGRAPH:
704 case LATEX_ENVIRONMENT:
705 case LATEX_ITEM_ENVIRONMENT:
706 case LATEX_BIB_ENVIRONMENT:
707 case LATEX_LIST_ENVIRONMENT:
708 latextype = static_cast<LatexType>(le);
711 LYXERR0("Unhandled value " << le);
717 void Layout::readSpacing(Lexer & lex)
720 ST_SPACING_SINGLE = 1,
726 LexerKeyword spacingTags[] = {
727 {"double", ST_SPACING_DOUBLE },
728 {"onehalf", ST_SPACING_ONEHALF },
729 {"other", ST_OTHER },
730 {"single", ST_SPACING_SINGLE }
733 PushPopHelper pph(lex, spacingTags);
736 case Lexer::LEX_UNDEF:
737 lex.printError("Unknown spacing token `$$Token'");
742 case ST_SPACING_SINGLE:
743 spacing.set(Spacing::Single);
745 case ST_SPACING_ONEHALF:
746 spacing.set(Spacing::Onehalf);
748 case ST_SPACING_DOUBLE:
749 spacing.set(Spacing::Double);
753 spacing.set(Spacing::Other, lex.getString());
759 docstring const & Layout::name() const
765 void Layout::setName(docstring const & name)
771 docstring const & Layout::obsoleted_by() const
773 return obsoleted_by_;
777 docstring const & Layout::depends_on() const
785 docstring const i18npreamble(Language const * lang, docstring const & templ)
790 string preamble = subst(to_utf8(templ), "$$lang", lang->babel());
793 // tex2lyx does not have getMessages()
794 LASSERT(false, /**/);
797 // boost::regex is not unicode-safe.
798 // Should use QRegExp or (boost::u32regex, but that requires ICU)
799 static boost::regex const reg("_\\(([^\\)]+)\\)");
801 while (boost::regex_search(preamble, sub, reg)) {
802 string const key = sub.str(1);
805 translated = to_utf8(getMessages(lang->code()).get(key));
807 lyxerr << "Warning: not translating `" << key
808 << "' because it is not pure ASCII." << endl;
811 preamble = subst(preamble, sub.str(), translated);
814 return from_utf8(preamble);
820 docstring const Layout::langpreamble(Language const * lang) const
822 return i18npreamble(lang, langpreamble_);
826 docstring const Layout::babelpreamble(Language const * lang) const
828 return i18npreamble(lang, babelpreamble_);
832 bool Layout::operator==(Layout const & rhs) const
834 // This is enough for the applications we actually make,
835 // at least at the moment. But we could check more.
836 return name() == rhs.name()
837 && latexname() == rhs.latexname()
838 && latextype == rhs.latextype;