1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ======================================================
15 #pragma implementation
18 #include "lyxtextclass.h"
22 #include "support/lstrings.h"
23 #include "support/LAssert.h"
24 #include "support/lyxfunctional.h"
25 #include "support/filetools.h"
30 /* ******************************************************************* */
32 LyXTextClass::LyXTextClass(string const & fn, string const & cln,
34 : name_(fn), latexname_(cln), description_(desc)
41 pagestyle_ = "default";
42 maxcounter_ = LABEL_COUNTER_CHAPTER;
43 defaultfont_ = LyXFont(LyXFont::ALL_SANE);
44 opt_fontsize_ = "10|11|12";
45 opt_pagestyle_ = "empty|plain|headings|fancy";
51 bool LyXTextClass::do_readStyle(LyXLex & lexrc, LyXLayout & lay)
53 lyxerr[Debug::TCLASS] << "Reading style " << lay.name() << endl;
54 if (!lay.Read(lexrc, *this)) {
56 lay.resfont = lay.font;
57 #ifndef INHERIT_LANGUAGE
58 lay.resfont.realize(defaultfont());
59 lay.reslabelfont = lay.labelfont;
60 lay.reslabelfont.realize(defaultfont());
62 lay.resfont.realize(defaultfont(), default_language);
63 lay.reslabelfont = lay.labelfont;
64 lay.reslabelfont.realize(defaultfont(), default_language);
66 return false; // no errors
68 lyxerr << "Error parsing style `" << lay.name() << "'" << endl;
95 // Reads a textclass structure from file.
96 bool LyXTextClass::Read(string const & filename, bool merge)
98 keyword_item textClassTags[] = {
99 { "classoptions", TC_CLASSOPTIONS },
100 { "columns", TC_COLUMNS },
101 { "defaultfont", TC_DEFAULTFONT },
102 { "input", TC_INPUT },
103 { "leftmargin", TC_LEFTMARGIN },
104 { "maxcounter", TC_MAXCOUNTER },
105 { "nostyle", TC_NOSTYLE },
106 { "outputtype", TC_OUTPUTTYPE },
107 { "pagestyle", TC_PAGESTYLE },
108 { "preamble", TC_PREAMBLE },
109 { "providesamsmath", TC_PROVIDESAMSMATH },
110 { "providesmakeidx", TC_PROVIDESMAKEIDX },
111 { "providesurl", TC_PROVIDESURL },
112 { "rightmargin", TC_RIGHTMARGIN },
113 { "secnumdepth", TC_SECNUMDEPTH },
114 { "sides", TC_SIDES },
115 { "style", TC_STYLE },
116 { "tocdepth", TC_TOCDEPTH }
120 lyxerr[Debug::TCLASS] << "Reading textclass "
121 << MakeDisplayPath(filename)
124 lyxerr[Debug::TCLASS] << "Reading input file "
125 << MakeDisplayPath(filename)
128 LyXLex lexrc(textClassTags, TC_RIGHTMARGIN);
131 lexrc.setFile(filename);
132 if (!lexrc.isOK()) error = true;
135 while (lexrc.isOK() && !error) {
136 int le = lexrc.lex();
138 case LyXLex::LEX_FEOF:
141 case LyXLex::LEX_UNDEF:
142 lexrc.printError("Unknown TextClass tag `$$Token'");
147 switch (static_cast<TextClassTags>(le)) {
148 case TC_OUTPUTTYPE: // output type definition
149 readOutputType(lexrc);
152 case TC_INPUT: // Include file
154 string tmp = LibFileSearch("layouts",
158 if (Read(tmp, true)) {
159 lexrc.printError("Error reading input"
168 string name = subst(lexrc.getString(),
170 if (hasLayout(name)) {
171 LyXLayout & lay = GetLayout(name);
172 error = do_readStyle(lexrc, lay);
176 if (!(error = do_readStyle(lexrc, lay)))
177 layoutlist.push_back(lay);
181 lexrc.printError("No name given for style: `$$Token'.");
188 string const style = subst(lexrc.getString(),
190 if (!delete_layout(style))
191 lexrc.printError("Cannot delete style"
198 columns_ = lexrc.getInteger();
203 switch (lexrc.getInteger()) {
204 case 1: sides_ = OneSide; break;
205 case 2: sides_ = TwoSides; break;
207 lyxerr << "Impossible number of page"
208 " sides, setting to one."
218 pagestyle_ = strip(lexrc.getString());
222 defaultfont_.lyxRead(lexrc);
223 if (!defaultfont_.resolved()) {
224 lexrc.printError("Warning: defaultfont should "
225 "be fully instantiated!");
226 #ifndef INHERIT_LANGUAGE
227 defaultfont_.realize(LyXFont(LyXFont::ALL_SANE));
229 defaultfont_.realize(LyXFont(LyXFont::ALL_SANE),
236 readMaxCounter(lexrc);
241 secnumdepth_ = lexrc.getInteger();
246 tocdepth_ = lexrc.getInteger();
249 // First step to support options
250 case TC_CLASSOPTIONS:
251 readClassOptions(lexrc);
255 preamble_ = lexrc.getLongString("EndPreamble");
258 case TC_PROVIDESAMSMATH:
259 if (lexrc.next() && lexrc.getInteger())
260 provides_ |= amsmath;
263 case TC_PROVIDESMAKEIDX:
264 if (lexrc.next() && lexrc.getInteger())
265 provides_ |= makeidx;
269 if (lexrc.next() && lexrc.getInteger())
273 case TC_LEFTMARGIN: // left margin type
275 leftmargin_ = lexrc.getString();
278 case TC_RIGHTMARGIN: // right margin type
280 rightmargin_ = lexrc.getString();
285 if (!merge) { // we are at top level here.
286 lyxerr[Debug::TCLASS] << "Finished reading textclass "
287 << MakeDisplayPath(filename)
290 lyxerr[Debug::TCLASS] << "Finished reading input file "
291 << MakeDisplayPath(filename)
298 void LyXTextClass::readOutputType(LyXLex & lexrc)
300 keyword_item outputTypeTags[] = {
301 { "docbook", DOCBOOK },
303 { "linuxdoc", LINUXDOC },
304 { "literate", LITERATE }
307 pushpophelper pph(lexrc, outputTypeTags, LITERATE);
309 int le = lexrc.lex();
311 case LyXLex::LEX_UNDEF:
312 lexrc.printError("Unknown output type `$$Token'");
318 outputType_ = static_cast<OutputType>(le);
321 lyxerr << "Unhandled value " << le
322 << " in LyXTextClass::readOutputType." << endl;
329 enum MaxCounterTags {
330 MC_COUNTER_CHAPTER = 1,
332 MC_COUNTER_SUBSECTION,
333 MC_COUNTER_SUBSUBSECTION,
334 MC_COUNTER_PARAGRAPH,
335 MC_COUNTER_SUBPARAGRAPH,
343 void LyXTextClass::readMaxCounter(LyXLex & lexrc)
345 keyword_item maxCounterTags[] = {
346 {"counter_chapter", MC_COUNTER_CHAPTER },
347 {"counter_enumi", MC_COUNTER_ENUMI },
348 {"counter_enumii", MC_COUNTER_ENUMII },
349 {"counter_enumiii", MC_COUNTER_ENUMIII },
350 {"counter_enumiv", MC_COUNTER_ENUMIV },
351 {"counter_paragraph", MC_COUNTER_PARAGRAPH },
352 {"counter_section", MC_COUNTER_SECTION },
353 {"counter_subparagraph", MC_COUNTER_SUBPARAGRAPH },
354 {"counter_subsection", MC_COUNTER_SUBSECTION },
355 {"counter_subsubsection", MC_COUNTER_SUBSUBSECTION }
358 pushpophelper pph(lexrc, maxCounterTags, MC_COUNTER_ENUMIV);
359 int le = lexrc.lex();
361 case LyXLex::LEX_UNDEF:
362 lexrc.printError("Unknown MaxCounter tag `$$Token'");
366 switch (static_cast<MaxCounterTags>(le)) {
367 case MC_COUNTER_CHAPTER:
368 maxcounter_ = LABEL_COUNTER_CHAPTER;
370 case MC_COUNTER_SECTION:
371 maxcounter_ = LABEL_COUNTER_SECTION;
373 case MC_COUNTER_SUBSECTION:
374 maxcounter_ = LABEL_COUNTER_SUBSECTION;
376 case MC_COUNTER_SUBSUBSECTION:
377 maxcounter_ = LABEL_COUNTER_SUBSUBSECTION;
379 case MC_COUNTER_PARAGRAPH:
380 maxcounter_ = LABEL_COUNTER_PARAGRAPH;
382 case MC_COUNTER_SUBPARAGRAPH:
383 maxcounter_ = LABEL_COUNTER_SUBPARAGRAPH;
385 case MC_COUNTER_ENUMI:
386 maxcounter_ = LABEL_COUNTER_ENUMI;
388 case MC_COUNTER_ENUMII:
389 maxcounter_ = LABEL_COUNTER_ENUMII;
391 case MC_COUNTER_ENUMIII:
392 maxcounter_ = LABEL_COUNTER_ENUMIII;
394 case MC_COUNTER_ENUMIV:
395 maxcounter_ = LABEL_COUNTER_ENUMIV;
401 enum ClassOptionsTags {
409 void LyXTextClass::readClassOptions(LyXLex & lexrc)
411 keyword_item classOptionsTags[] = {
413 {"fontsize", CO_FONTSIZE },
414 {"other", CO_OTHER },
415 {"pagestyle", CO_PAGESTYLE }
418 lexrc.pushTable(classOptionsTags, CO_END);
420 while (!getout && lexrc.isOK()) {
421 int le = lexrc.lex();
423 case LyXLex::LEX_UNDEF:
424 lexrc.printError("Unknown ClassOption tag `$$Token'");
428 switch (static_cast<ClassOptionsTags>(le)) {
431 opt_fontsize_ = strip(lexrc.getString());
435 opt_pagestyle_ = strip(lexrc.getString());
439 options_ = lexrc.getString();
450 LyXFont const & LyXTextClass::defaultfont() const
456 string const & LyXTextClass::leftmargin() const
462 string const & LyXTextClass::rightmargin() const
468 bool LyXTextClass::hasLayout(string const & name) const
470 return find_if(layoutlist.begin(), layoutlist.end(),
471 lyx::compare_memfun(&LyXLayout::name, name))
476 LyXLayout const & LyXTextClass::GetLayout (string const & name) const
478 LayoutList::const_iterator cit =
479 find_if(layoutlist.begin(),
481 lyx::compare_memfun(&LyXLayout::name, name));
482 lyx::Assert(cit != layoutlist.end()); // we require the name to exist
487 LyXLayout & LyXTextClass::GetLayout(string const & name)
489 LayoutList::iterator it =
490 find_if(layoutlist.begin(),
492 lyx::compare_memfun(&LyXLayout::name, name));
493 lyx::Assert(it != layoutlist.end()); // we require the name to exist
498 bool LyXTextClass::delete_layout(string const & name)
500 LayoutList::iterator it =
501 remove_if(layoutlist.begin(), layoutlist.end(),
502 lyx::compare_memfun(&LyXLayout::name, name));
503 LayoutList::iterator end = layoutlist.end();
504 bool const ret = (it != end);
505 layoutlist.erase(it, end);
510 // Load textclass info if not loaded yet
511 void LyXTextClass::load()
516 string const real_file = LibFileSearch("layouts", name_, "layout");
518 if (Read(real_file)) {
519 lyxerr << "Error reading `"
520 << MakeDisplayPath(real_file)
521 << "'\n(Check `" << name_
522 << "')\nCheck your installation and "
523 "try Options/Reconfigure..." << endl;
529 std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p)
532 case LyXTextClass::OneSide:
535 case LyXTextClass::TwoSides: