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,
104 LT_INTITLE // keep this last!
107 /////////////////////
112 margintype = MARGIN_STATIC;
113 latextype = LATEX_PARAGRAPH;
119 labelfont = inherit_font;
121 reslabelfont = sane_font;
122 nextnoindent = false;
127 labelbottomsep = 0.0;
129 align = LYX_ALIGN_BLOCK;
130 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
131 labeltype = LABEL_NO_LABEL;
132 endlabeltype = END_LABEL_NO_LABEL;
133 // Should or should not. That is the question.
134 // spacing.set(Spacing::OneHalf);
137 newline_allowed = true;
138 free_spacing = false;
140 toclevel = NOT_IN_TOC;
145 bool Layout::read(Lexer & lex, TextClass const & tclass)
147 // This table is sorted alphabetically [asierra 30March96]
148 LexerKeyword layoutTags[] = {
149 { "align", LT_ALIGN },
150 { "alignpossible", LT_ALIGNPOSSIBLE },
151 { "babelpreamble", LT_BABELPREAMBLE },
152 { "bottomsep", LT_BOTTOMSEP },
153 { "category", LT_CATEGORY },
154 { "commanddepth", LT_COMMANDDEPTH },
155 { "copystyle", LT_COPYSTYLE },
156 { "dependson", LT_DEPENDSON },
158 { "endlabelstring", LT_ENDLABELSTRING },
159 { "endlabeltype", LT_ENDLABELTYPE },
160 { "fill_bottom", LT_FILL_BOTTOM },
161 { "fill_top", LT_FILL_TOP },
163 { "freespacing", LT_FREE_SPACING },
164 { "htmlattr", LT_HTMLATTR },
165 { "htmlitem", LT_HTMLITEM },
166 { "htmlitemattr", LT_HTMLITEMATTR },
167 { "htmllabel", LT_HTMLLABEL },
168 { "htmllabelattr", LT_HTMLLABELATTR },
169 { "htmllabelfirst", LT_HTMLLABELFIRST },
170 { "htmlpremable", LT_HTMLPREAMBLE },
171 { "htmlstyle", LT_HTMLSTYLE },
172 { "htmltag", LT_HTMLTAG },
173 { "innertag", LT_INNERTAG },
174 { "intitle", LT_INTITLE },
175 { "itemsep", LT_ITEMSEP },
176 { "itemtag", LT_ITEMTAG },
177 { "keepempty", LT_KEEPEMPTY },
178 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
179 { "labelcounter", LT_LABELCOUNTER },
180 { "labelfont", LT_LABELFONT },
181 { "labelindent", LT_LABELINDENT },
182 { "labelsep", LT_LABELSEP },
183 { "labelstring", LT_LABELSTRING },
184 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
185 { "labeltag", LT_LABELTAG },
186 { "labeltype", LT_LABELTYPE },
187 { "langpreamble", LT_LANGPREAMBLE },
188 { "latexname", LT_LATEXNAME },
189 { "latexparam", LT_LATEXPARAM },
190 { "latextype", LT_LATEXTYPE },
191 { "leftmargin", LT_LEFTMARGIN },
192 { "margin", LT_MARGIN },
193 { "needprotect", LT_NEED_PROTECT },
194 { "newline", LT_NEWLINE },
195 { "nextnoindent", LT_NEXTNOINDENT },
196 { "obsoletedby", LT_OBSOLETEDBY },
197 { "optionalargs", LT_OPTARGS },
198 { "parindent", LT_PARINDENT },
199 { "parsep", LT_PARSEP },
200 { "parskip", LT_PARSKIP },
201 { "passthru", LT_PASS_THRU },
202 { "preamble", LT_PREAMBLE },
203 { "requires", LT_REQUIRES },
204 { "rightmargin", LT_RIGHTMARGIN },
205 { "spacing", LT_SPACING },
206 { "textfont", LT_TEXTFONT },
207 { "toclevel", LT_TOCLEVEL },
208 { "topsep", LT_TOPSEP }
212 bool finished = false;
213 lex.pushTable(layoutTags);
214 // parse style section
215 while (!finished && lex.isOK() && !error) {
217 // See comment in LyXRC.cpp.
219 case Lexer::LEX_FEOF:
222 case Lexer::LEX_UNDEF: // parse error
223 lex.printError("Unknown layout tag `$$Token'");
230 switch (static_cast<LayoutTags>(le)) {
231 case LT_END: // end of structure
239 case LT_COPYSTYLE: { // initialize with a known style
242 style = subst(style, '_', ' ');
244 if (tclass.hasLayout(style)) {
245 docstring const tmpname = name_;
246 this->operator=(tclass[style]);
249 LYXERR0("Cannot copy unknown style `"
251 << "All layouts so far:");
252 DocumentClass::const_iterator lit = tclass.begin();
253 DocumentClass::const_iterator len = tclass.end();
254 for (; lit != len; ++lit)
255 LYXERR0(lit->name());
260 case LT_OBSOLETEDBY: { // replace with a known style
263 style = subst(style, '_', ' ');
265 if (tclass.hasLayout(style)) {
266 docstring const tmpname = name_;
267 this->operator=(tclass[style]);
269 if (obsoleted_by().empty())
270 obsoleted_by_ = style;
272 LYXERR0("Cannot replace with unknown style `"
275 //lex.printError("Cannot replace with"
284 depends_on_ = subst(depends_on_, '_', ' ');
287 case LT_MARGIN: // margin style definition.
291 case LT_LATEXTYPE: // LaTeX style definition.
304 lex >> optionalargs ;
307 case LT_NEED_PROTECT:
316 font = lyxRead(lex, font);
321 font = lyxRead(lex, font);
325 labelfont = lyxRead(lex, labelfont);
328 case LT_NEXTNOINDENT: // Indent next paragraph?
332 case LT_COMMANDDEPTH:
342 latexparam_ = subst(latexparam_, """, "\"");
358 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
361 case LT_LANGPREAMBLE:
362 langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble"));
365 case LT_BABELPREAMBLE:
366 babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble"));
373 case LT_ENDLABELTYPE:
374 readEndLabelType(lex);
377 case LT_LEFTMARGIN: // left margin type
381 case LT_RIGHTMARGIN: // right margin type
385 case LT_LABELINDENT: // label indenting flag
389 case LT_PARINDENT: // paragraph indent. flag
393 case LT_PARSKIP: // paragraph skip size
397 case LT_ITEMSEP: // item separation size
401 case LT_TOPSEP: // top separation size
405 case LT_BOTTOMSEP: // bottom separation size
409 case LT_LABEL_BOTTOMSEP: // label bottom separation size
410 lex >> labelbottomsep;
413 case LT_LABELSEP: // label separator
415 labelsep = subst(labelsep, 'x', ' ');
418 case LT_PARSEP: // par. separation size
422 case LT_FILL_TOP: // fill top flag
426 case LT_FILL_BOTTOM: // fill bottom flag
430 case LT_NEWLINE: // newlines allowed?
431 lex >> newline_allowed;
434 case LT_ALIGN: // paragraph align
437 case LT_ALIGNPOSSIBLE: // paragraph allowed align
438 readAlignPossible(lex);
441 case LT_LABELSTRING: // label string definition
442 // FIXME: this means LT_ENDLABELSTRING may only
443 // occur after LT_LABELSTRING
445 labelstring_ = trim(labelstring_);
446 labelstring_appendix_ = labelstring_;
449 case LT_ENDLABELSTRING: // endlabel string definition
450 lex >> endlabelstring_;
451 endlabelstring_ = trim(endlabelstring_);
454 case LT_LABELSTRING_APPENDIX: // label string appendix definition
455 lex >> labelstring_appendix_;
456 labelstring_appendix_ = trim(labelstring_appendix_);
459 case LT_LABELCOUNTER: // name of counter to use
461 counter = trim(counter);
464 case LT_FREE_SPACING: // Allow for free spacing.
468 case LT_PASS_THRU: // Allow for pass thru.
472 case LT_SPACING: // setspace.sty
478 vector<string> const req =
479 getVectorFromString(lex.getString());
480 requires_.insert(req.begin(), req.end());
496 case LT_HTMLITEMATTR:
497 lex >> htmlitemattr_;
504 case LT_HTMLLABELATTR:
505 lex >> htmllabelattr_;
508 case LT_HTMLLABELFIRST:
509 lex >> htmllabelfirst_;
513 htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle"));
516 case LT_HTMLPREAMBLE:
517 htmlpreamble_ = from_utf8(lex.getLongString("EndPreamble"));
537 LexerKeyword alignTags[] = {
538 { "block", AT_BLOCK },
539 { "center", AT_CENTER },
540 { "layout", AT_LAYOUT },
542 { "right", AT_RIGHT }
546 void Layout::readAlign(Lexer & lex)
548 PushPopHelper pph(lex, alignTags);
551 case Lexer::LEX_UNDEF:
552 lex.printError("Unknown alignment `$$Token'");
558 align = LYX_ALIGN_BLOCK;
561 align = LYX_ALIGN_LEFT;
564 align = LYX_ALIGN_RIGHT;
567 align = LYX_ALIGN_CENTER;
570 align = LYX_ALIGN_LAYOUT;
576 void Layout::readAlignPossible(Lexer & lex)
578 lex.pushTable(alignTags);
579 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
580 int lineno = lex.lineNumber();
584 case Lexer::LEX_UNDEF:
585 lex.printError("Unknown alignment `$$Token'");
591 alignpossible |= LYX_ALIGN_BLOCK;
594 alignpossible |= LYX_ALIGN_LEFT;
597 alignpossible |= LYX_ALIGN_RIGHT;
600 alignpossible |= LYX_ALIGN_CENTER;
603 alignpossible |= LYX_ALIGN_LAYOUT;
606 } while (lineno == lex.lineNumber());
611 void Layout::readLabelType(Lexer & lex)
617 LA_CENTERED_TOP_ENVIRONMENT,
627 LexerKeyword labelTypeTags[] = {
628 { "bibliography", LA_BIBLIO },
629 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
630 { "counter", LA_COUNTER },
631 { "enumerate", LA_ENUMERATE },
632 { "itemize", LA_ITEMIZE },
633 { "manual", LA_MANUAL },
634 { "no_label", LA_NO_LABEL },
635 { "sensitive", LA_SENSITIVE },
636 { "static", LA_STATIC },
637 { "top_environment", LA_TOP_ENVIRONMENT }
640 PushPopHelper pph(lex, labelTypeTags);
643 case Lexer::LEX_UNDEF:
644 lex.printError("Unknown labeltype tag `$$Token'");
650 labeltype = LABEL_NO_LABEL;
653 labeltype = LABEL_MANUAL;
655 case LA_TOP_ENVIRONMENT:
656 labeltype = LABEL_TOP_ENVIRONMENT;
658 case LA_CENTERED_TOP_ENVIRONMENT:
659 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
662 labeltype = LABEL_STATIC;
665 labeltype = LABEL_SENSITIVE;
668 labeltype = LABEL_COUNTER;
671 labeltype = LABEL_ENUMERATE;
674 labeltype = LABEL_ITEMIZE;
677 labeltype = LABEL_BIBLIO;
683 void Layout::readEndLabelType(Lexer & lex)
685 static LexerKeyword endlabelTypeTags[] = {
686 { "box", END_LABEL_BOX },
687 { "filled_box", END_LABEL_FILLED_BOX },
688 { "no_label", END_LABEL_NO_LABEL },
689 { "static", END_LABEL_STATIC }
692 PushPopHelper pph(lex, endlabelTypeTags);
695 case Lexer::LEX_UNDEF:
696 lex.printError("Unknown labeltype tag `$$Token'");
698 case END_LABEL_STATIC:
700 case END_LABEL_FILLED_BOX:
701 case END_LABEL_NO_LABEL:
702 endlabeltype = static_cast<EndLabelType>(le);
705 LYXERR0("Unhandled value " << le);
711 void Layout::readMargin(Lexer & lex)
713 LexerKeyword marginTags[] = {
714 { "dynamic", MARGIN_DYNAMIC },
715 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
716 { "manual", MARGIN_MANUAL },
717 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
718 { "static", MARGIN_STATIC }
721 PushPopHelper pph(lex, marginTags);
725 case Lexer::LEX_UNDEF:
726 lex.printError("Unknown margin type tag `$$Token'");
731 case MARGIN_FIRST_DYNAMIC:
732 case MARGIN_RIGHT_ADDRESS_BOX:
733 margintype = static_cast<MarginType>(le);
736 LYXERR0("Unhandled value " << le);
742 void Layout::readLatexType(Lexer & lex)
744 LexerKeyword latexTypeTags[] = {
745 { "bib_environment", LATEX_BIB_ENVIRONMENT },
746 { "command", LATEX_COMMAND },
747 { "environment", LATEX_ENVIRONMENT },
748 { "item_environment", LATEX_ITEM_ENVIRONMENT },
749 { "list_environment", LATEX_LIST_ENVIRONMENT },
750 { "paragraph", LATEX_PARAGRAPH }
753 PushPopHelper pph(lex, latexTypeTags);
756 case Lexer::LEX_UNDEF:
757 lex.printError("Unknown latextype tag `$$Token'");
759 case LATEX_PARAGRAPH:
761 case LATEX_ENVIRONMENT:
762 case LATEX_ITEM_ENVIRONMENT:
763 case LATEX_BIB_ENVIRONMENT:
764 case LATEX_LIST_ENVIRONMENT:
765 latextype = static_cast<LatexType>(le);
768 LYXERR0("Unhandled value " << le);
774 void Layout::readSpacing(Lexer & lex)
777 ST_SPACING_SINGLE = 1,
783 LexerKeyword spacingTags[] = {
784 {"double", ST_SPACING_DOUBLE },
785 {"onehalf", ST_SPACING_ONEHALF },
786 {"other", ST_OTHER },
787 {"single", ST_SPACING_SINGLE }
790 PushPopHelper pph(lex, spacingTags);
793 case Lexer::LEX_UNDEF:
794 lex.printError("Unknown spacing token `$$Token'");
799 case ST_SPACING_SINGLE:
800 spacing.set(Spacing::Single);
802 case ST_SPACING_ONEHALF:
803 spacing.set(Spacing::Onehalf);
805 case ST_SPACING_DOUBLE:
806 spacing.set(Spacing::Double);
810 spacing.set(Spacing::Other, lex.getString());
818 docstring const i18npreamble(Language const * lang, docstring const & templ)
823 string preamble = subst(to_utf8(templ), "$$lang", lang->babel());
826 // tex2lyx does not have getMessages()
827 LASSERT(false, /**/);
830 // boost::regex is not unicode-safe.
831 // Should use QRegExp or (boost::u32regex, but that requires ICU)
832 static boost::regex const reg("_\\(([^\\)]+)\\)");
834 while (boost::regex_search(preamble, sub, reg)) {
835 string const key = sub.str(1);
838 translated = to_utf8(getMessages(lang->code()).get(key));
840 lyxerr << "Warning: not translating `" << key
841 << "' because it is not pure ASCII." << endl;
844 preamble = subst(preamble, sub.str(), translated);
847 return from_utf8(preamble);
853 docstring const Layout::langpreamble(Language const * lang) const
855 return i18npreamble(lang, langpreamble_);
859 docstring const Layout::babelpreamble(Language const * lang) const
861 return i18npreamble(lang, babelpreamble_);
865 bool Layout::operator==(Layout const & rhs) const
867 // This is enough for the applications we actually make,
868 // at least at the moment. But we could check more.
869 return name() == rhs.name()
870 && latexname() == rhs.latexname()
871 && latextype == rhs.latextype;