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,
102 LT_INTITLE // keep this last!
105 /////////////////////
110 margintype = MARGIN_STATIC;
111 latextype = LATEX_PARAGRAPH;
117 labelfont = inherit_font;
119 reslabelfont = sane_font;
120 nextnoindent = false;
125 labelbottomsep = 0.0;
127 align = LYX_ALIGN_BLOCK;
128 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
129 labeltype = LABEL_NO_LABEL;
130 endlabeltype = END_LABEL_NO_LABEL;
131 // Should or should not. That is the question.
132 // spacing.set(Spacing::OneHalf);
135 newline_allowed = true;
136 free_spacing = false;
138 toclevel = NOT_IN_TOC;
143 bool Layout::read(Lexer & lex, TextClass const & tclass)
145 // This table is sorted alphabetically [asierra 30March96]
146 LexerKeyword layoutTags[] = {
147 { "align", LT_ALIGN },
148 { "alignpossible", LT_ALIGNPOSSIBLE },
149 { "babelpreamble", LT_BABELPREAMBLE },
150 { "bottomsep", LT_BOTTOMSEP },
151 { "category", LT_CATEGORY },
152 { "commanddepth", LT_COMMANDDEPTH },
153 { "copystyle", LT_COPYSTYLE },
154 { "dependson", LT_DEPENDSON },
156 { "endlabelstring", LT_ENDLABELSTRING },
157 { "endlabeltype", LT_ENDLABELTYPE },
158 { "fill_bottom", LT_FILL_BOTTOM },
159 { "fill_top", LT_FILL_TOP },
161 { "freespacing", LT_FREE_SPACING },
162 { "htmlattr", LT_HTMLATTR },
163 { "htmlitem", LT_HTMLITEM },
164 { "htmlitemattr", LT_HTMLITEMATTR },
165 { "htmllabel", LT_HTMLLABEL },
166 { "htmllabelattr", LT_HTMLLABELATTR },
167 { "htmlstyle", LT_HTMLSTYLE },
168 { "htmltag", LT_HTMLTAG },
169 { "innertag", LT_INNERTAG },
170 { "intitle", LT_INTITLE },
171 { "itemsep", LT_ITEMSEP },
172 { "itemtag", LT_ITEMTAG },
173 { "keepempty", LT_KEEPEMPTY },
174 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
175 { "labelcounter", LT_LABELCOUNTER },
176 { "labelfont", LT_LABELFONT },
177 { "labelindent", LT_LABELINDENT },
178 { "labelsep", LT_LABELSEP },
179 { "labelstring", LT_LABELSTRING },
180 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
181 { "labeltag", LT_LABELTAG },
182 { "labeltype", LT_LABELTYPE },
183 { "langpreamble", LT_LANGPREAMBLE },
184 { "latexname", LT_LATEXNAME },
185 { "latexparam", LT_LATEXPARAM },
186 { "latextype", LT_LATEXTYPE },
187 { "leftmargin", LT_LEFTMARGIN },
188 { "margin", LT_MARGIN },
189 { "needprotect", LT_NEED_PROTECT },
190 { "newline", LT_NEWLINE },
191 { "nextnoindent", LT_NEXTNOINDENT },
192 { "obsoletedby", LT_OBSOLETEDBY },
193 { "optionalargs", LT_OPTARGS },
194 { "parindent", LT_PARINDENT },
195 { "parsep", LT_PARSEP },
196 { "parskip", LT_PARSKIP },
197 { "passthru", LT_PASS_THRU },
198 { "preamble", LT_PREAMBLE },
199 { "requires", LT_REQUIRES },
200 { "rightmargin", LT_RIGHTMARGIN },
201 { "spacing", LT_SPACING },
202 { "textfont", LT_TEXTFONT },
203 { "toclevel", LT_TOCLEVEL },
204 { "topsep", LT_TOPSEP }
208 bool finished = false;
209 lex.pushTable(layoutTags);
210 // parse style section
211 while (!finished && lex.isOK() && !error) {
213 // See comment in LyXRC.cpp.
215 case Lexer::LEX_FEOF:
218 case Lexer::LEX_UNDEF: // parse error
219 lex.printError("Unknown layout tag `$$Token'");
226 switch (static_cast<LayoutTags>(le)) {
227 case LT_END: // end of structure
235 case LT_COPYSTYLE: { // initialize with a known style
238 style = subst(style, '_', ' ');
240 if (tclass.hasLayout(style)) {
241 docstring const tmpname = name_;
242 this->operator=(tclass[style]);
245 LYXERR0("Cannot copy unknown style `"
247 << "All layouts so far:");
248 DocumentClass::const_iterator lit = tclass.begin();
249 DocumentClass::const_iterator len = tclass.end();
250 for (; lit != len; ++lit)
251 LYXERR0(lit->name());
256 case LT_OBSOLETEDBY: { // replace with a known style
259 style = subst(style, '_', ' ');
261 if (tclass.hasLayout(style)) {
262 docstring const tmpname = name_;
263 this->operator=(tclass[style]);
265 if (obsoleted_by().empty())
266 obsoleted_by_ = style;
268 LYXERR0("Cannot replace with unknown style `"
271 //lex.printError("Cannot replace with"
280 depends_on_ = subst(depends_on_, '_', ' ');
283 case LT_MARGIN: // margin style definition.
287 case LT_LATEXTYPE: // LaTeX style definition.
300 lex >> optionalargs ;
303 case LT_NEED_PROTECT:
312 font = lyxRead(lex, font);
317 font = lyxRead(lex, font);
321 labelfont = lyxRead(lex, labelfont);
324 case LT_NEXTNOINDENT: // Indent next paragraph?
328 case LT_COMMANDDEPTH:
338 latexparam_ = subst(latexparam_, """, "\"");
354 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
357 case LT_LANGPREAMBLE:
358 langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble"));
361 case LT_BABELPREAMBLE:
362 babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble"));
369 case LT_ENDLABELTYPE:
370 readEndLabelType(lex);
373 case LT_LEFTMARGIN: // left margin type
377 case LT_RIGHTMARGIN: // right margin type
381 case LT_LABELINDENT: // label indenting flag
385 case LT_PARINDENT: // paragraph indent. flag
389 case LT_PARSKIP: // paragraph skip size
393 case LT_ITEMSEP: // item separation size
397 case LT_TOPSEP: // top separation size
401 case LT_BOTTOMSEP: // bottom separation size
405 case LT_LABEL_BOTTOMSEP: // label bottom separation size
406 lex >> labelbottomsep;
409 case LT_LABELSEP: // label separator
411 labelsep = subst(labelsep, 'x', ' ');
414 case LT_PARSEP: // par. separation size
418 case LT_FILL_TOP: // fill top flag
422 case LT_FILL_BOTTOM: // fill bottom flag
426 case LT_NEWLINE: // newlines allowed?
427 lex >> newline_allowed;
430 case LT_ALIGN: // paragraph align
433 case LT_ALIGNPOSSIBLE: // paragraph allowed align
434 readAlignPossible(lex);
437 case LT_LABELSTRING: // label string definition
438 // FIXME: this means LT_ENDLABELSTRING may only
439 // occur after LT_LABELSTRING
441 labelstring_ = trim(labelstring_);
442 labelstring_appendix_ = labelstring_;
445 case LT_ENDLABELSTRING: // endlabel string definition
446 lex >> endlabelstring_;
447 endlabelstring_ = trim(endlabelstring_);
450 case LT_LABELSTRING_APPENDIX: // label string appendix definition
451 lex >> labelstring_appendix_;
452 labelstring_appendix_ = trim(labelstring_appendix_);
455 case LT_LABELCOUNTER: // name of counter to use
457 counter = trim(counter);
460 case LT_FREE_SPACING: // Allow for free spacing.
464 case LT_PASS_THRU: // Allow for pass thru.
468 case LT_SPACING: // setspace.sty
474 vector<string> const req =
475 getVectorFromString(lex.getString());
476 requires_.insert(req.begin(), req.end());
492 case LT_HTMLITEMATTR:
493 lex >> htmlitemattr_;
500 case LT_HTMLLABELATTR:
501 lex >> htmllabelattr_;
505 htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle"));
525 LexerKeyword alignTags[] = {
526 { "block", AT_BLOCK },
527 { "center", AT_CENTER },
528 { "layout", AT_LAYOUT },
530 { "right", AT_RIGHT }
534 void Layout::readAlign(Lexer & lex)
536 PushPopHelper pph(lex, alignTags);
539 case Lexer::LEX_UNDEF:
540 lex.printError("Unknown alignment `$$Token'");
546 align = LYX_ALIGN_BLOCK;
549 align = LYX_ALIGN_LEFT;
552 align = LYX_ALIGN_RIGHT;
555 align = LYX_ALIGN_CENTER;
558 align = LYX_ALIGN_LAYOUT;
564 void Layout::readAlignPossible(Lexer & lex)
566 lex.pushTable(alignTags);
567 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
568 int lineno = lex.lineNumber();
572 case Lexer::LEX_UNDEF:
573 lex.printError("Unknown alignment `$$Token'");
579 alignpossible |= LYX_ALIGN_BLOCK;
582 alignpossible |= LYX_ALIGN_LEFT;
585 alignpossible |= LYX_ALIGN_RIGHT;
588 alignpossible |= LYX_ALIGN_CENTER;
591 alignpossible |= LYX_ALIGN_LAYOUT;
594 } while (lineno == lex.lineNumber());
599 void Layout::readLabelType(Lexer & lex)
605 LA_CENTERED_TOP_ENVIRONMENT,
615 LexerKeyword labelTypeTags[] = {
616 { "bibliography", LA_BIBLIO },
617 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
618 { "counter", LA_COUNTER },
619 { "enumerate", LA_ENUMERATE },
620 { "itemize", LA_ITEMIZE },
621 { "manual", LA_MANUAL },
622 { "no_label", LA_NO_LABEL },
623 { "sensitive", LA_SENSITIVE },
624 { "static", LA_STATIC },
625 { "top_environment", LA_TOP_ENVIRONMENT }
628 PushPopHelper pph(lex, labelTypeTags);
631 case Lexer::LEX_UNDEF:
632 lex.printError("Unknown labeltype tag `$$Token'");
638 labeltype = LABEL_NO_LABEL;
641 labeltype = LABEL_MANUAL;
643 case LA_TOP_ENVIRONMENT:
644 labeltype = LABEL_TOP_ENVIRONMENT;
646 case LA_CENTERED_TOP_ENVIRONMENT:
647 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
650 labeltype = LABEL_STATIC;
653 labeltype = LABEL_SENSITIVE;
656 labeltype = LABEL_COUNTER;
659 labeltype = LABEL_ENUMERATE;
662 labeltype = LABEL_ITEMIZE;
665 labeltype = LABEL_BIBLIO;
671 void Layout::readEndLabelType(Lexer & lex)
673 static LexerKeyword endlabelTypeTags[] = {
674 { "box", END_LABEL_BOX },
675 { "filled_box", END_LABEL_FILLED_BOX },
676 { "no_label", END_LABEL_NO_LABEL },
677 { "static", END_LABEL_STATIC }
680 PushPopHelper pph(lex, endlabelTypeTags);
683 case Lexer::LEX_UNDEF:
684 lex.printError("Unknown labeltype tag `$$Token'");
686 case END_LABEL_STATIC:
688 case END_LABEL_FILLED_BOX:
689 case END_LABEL_NO_LABEL:
690 endlabeltype = static_cast<EndLabelType>(le);
693 LYXERR0("Unhandled value " << le);
699 void Layout::readMargin(Lexer & lex)
701 LexerKeyword marginTags[] = {
702 { "dynamic", MARGIN_DYNAMIC },
703 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
704 { "manual", MARGIN_MANUAL },
705 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
706 { "static", MARGIN_STATIC }
709 PushPopHelper pph(lex, marginTags);
713 case Lexer::LEX_UNDEF:
714 lex.printError("Unknown margin type tag `$$Token'");
719 case MARGIN_FIRST_DYNAMIC:
720 case MARGIN_RIGHT_ADDRESS_BOX:
721 margintype = static_cast<MarginType>(le);
724 LYXERR0("Unhandled value " << le);
730 void Layout::readLatexType(Lexer & lex)
732 LexerKeyword latexTypeTags[] = {
733 { "bib_environment", LATEX_BIB_ENVIRONMENT },
734 { "command", LATEX_COMMAND },
735 { "environment", LATEX_ENVIRONMENT },
736 { "item_environment", LATEX_ITEM_ENVIRONMENT },
737 { "list_environment", LATEX_LIST_ENVIRONMENT },
738 { "paragraph", LATEX_PARAGRAPH }
741 PushPopHelper pph(lex, latexTypeTags);
744 case Lexer::LEX_UNDEF:
745 lex.printError("Unknown latextype tag `$$Token'");
747 case LATEX_PARAGRAPH:
749 case LATEX_ENVIRONMENT:
750 case LATEX_ITEM_ENVIRONMENT:
751 case LATEX_BIB_ENVIRONMENT:
752 case LATEX_LIST_ENVIRONMENT:
753 latextype = static_cast<LatexType>(le);
756 LYXERR0("Unhandled value " << le);
762 void Layout::readSpacing(Lexer & lex)
765 ST_SPACING_SINGLE = 1,
771 LexerKeyword spacingTags[] = {
772 {"double", ST_SPACING_DOUBLE },
773 {"onehalf", ST_SPACING_ONEHALF },
774 {"other", ST_OTHER },
775 {"single", ST_SPACING_SINGLE }
778 PushPopHelper pph(lex, spacingTags);
781 case Lexer::LEX_UNDEF:
782 lex.printError("Unknown spacing token `$$Token'");
787 case ST_SPACING_SINGLE:
788 spacing.set(Spacing::Single);
790 case ST_SPACING_ONEHALF:
791 spacing.set(Spacing::Onehalf);
793 case ST_SPACING_DOUBLE:
794 spacing.set(Spacing::Double);
798 spacing.set(Spacing::Other, lex.getString());
806 docstring const i18npreamble(Language const * lang, docstring const & templ)
811 string preamble = subst(to_utf8(templ), "$$lang", lang->babel());
814 // tex2lyx does not have getMessages()
815 LASSERT(false, /**/);
818 // boost::regex is not unicode-safe.
819 // Should use QRegExp or (boost::u32regex, but that requires ICU)
820 static boost::regex const reg("_\\(([^\\)]+)\\)");
822 while (boost::regex_search(preamble, sub, reg)) {
823 string const key = sub.str(1);
826 translated = to_utf8(getMessages(lang->code()).get(key));
828 lyxerr << "Warning: not translating `" << key
829 << "' because it is not pure ASCII." << endl;
832 preamble = subst(preamble, sub.str(), translated);
835 return from_utf8(preamble);
841 docstring const Layout::langpreamble(Language const * lang) const
843 return i18npreamble(lang, langpreamble_);
847 docstring const Layout::babelpreamble(Language const * lang) const
849 return i18npreamble(lang, babelpreamble_);
853 bool Layout::operator==(Layout const & rhs) const
855 // This is enough for the applications we actually make,
856 // at least at the moment. But we could check more.
857 return name() == rhs.name()
858 && latexname() == rhs.latexname()
859 && latextype == rhs.latextype;