2 * \file TextClassList.cpp
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
9 * Full author contact details are available in file CREDITS.
14 #include "TextClassList.h"
15 #include "TextClass.h"
16 #include "support/debug.h"
19 #include "support/filetools.h"
21 #include <boost/bind.hpp>
22 #include <boost/regex.hpp>
27 using namespace lyx::support;
35 // Gets textclass number from name
36 pair<bool, textclass_type> const
37 TextClassList::numberOfClass(string const & textclass) const
39 ClassList::const_iterator cit =
40 find_if(classlist_.begin(), classlist_.end(),
41 bind(equal_to<string>(),
42 bind(&TextClass::name, _1),
45 return cit != classlist_.end() ?
46 make_pair(true, textclass_type(cit - classlist_.begin())) :
47 make_pair(false, textclass_type(0));
51 // Gets a textclass structure from number
53 TextClassList::operator[](textclass_type textclass) const
55 if (textclass >= classlist_.size())
58 //FIXME I don't believe the following line is actually necessary (rgh)
59 classlist_[textclass].load();
60 return classlist_[textclass];
64 // used when sorting the textclass list.
65 class less_textclass_avail_desc
66 : public binary_function<TextClass, TextClass, int>
69 int operator()(TextClass const & tc1,
70 TextClass const & tc2) const
73 // 1. Availability of text class
74 // 2. Description (lexicographic)
76 return (tc1.isTeXClassAvailable() && !tc2.isTeXClassAvailable()) ||
77 (tc1.isTeXClassAvailable() == tc2.isTeXClassAvailable() &&
78 tc1.description() < tc2.description());
83 // Reads LyX textclass definitions according to textclass config file
84 bool TextClassList::read()
87 FileName const real_file = libFileSearch("", "textclass.lst");
88 LYXERR(Debug::TCLASS, "Reading textclasses from `" << real_file << '\'');
90 if (real_file.empty()) {
91 lyxerr << "TextClassList::Read: unable to find "
93 << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
94 << "'. Exiting." << endl;
96 // This causes LyX to end... Not a desirable behaviour. Lgb
97 // What do you propose? That the user gets a file dialog
98 // and is allowed to hunt for the file? (Asger)
99 // more that we have a layout for minimal.cls statically
100 // compiled in... (Lgb)
103 if (!lex.setFile(real_file)) {
104 lyxerr << "TextClassList::Read: "
105 "lyxlex was not able to set file: "
106 << real_file << endl;
110 lyxerr << "TextClassList::Read: unable to open "
112 << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
113 << "'\nCheck your installation. LyX can't continue."
118 bool finished = false;
120 LYXERR(Debug::TCLASS, "Starting parsing of textclass.lst");
121 while (lex.isOK() && !finished) {
122 LYXERR(Debug::TCLASS, "\tline by line");
124 case Lexer::LEX_FEOF:
128 string const fname = lex.getString();
129 LYXERR(Debug::TCLASS, "Fname: " << fname);
131 string const clname = lex.getString();
132 LYXERR(Debug::TCLASS, "Clname: " << clname);
134 string const desc = lex.getString();
135 LYXERR(Debug::TCLASS, "Desc: " << desc);
137 bool avail = lex.getBool();
138 LYXERR(Debug::TCLASS, "Avail: " << avail);
139 // This code is run when we have
140 // fname, clname, desc, and avail
141 TextClass tmpl(fname, clname, desc, avail);
142 if (lyxerr.debugging(Debug::TCLASS)) {
145 classlist_.push_back(tmpl);
151 LYXERR(Debug::TCLASS, "End of parsing of textclass.lst");
153 // lyx will start with an empty classlist_, but only reconfigure is allowed
154 // in this case. This gives users a second chance to configure lyx if
155 // initial configuration fails. (c.f. bug 2829)
156 if (classlist_.empty())
157 lyxerr << "TextClassList::Read: no textclasses found!"
160 // Ok everything loaded ok, now sort the list.
161 sort(classlist_.begin(), classlist_.end(), less_textclass_avail_desc());
166 void TextClassList::reset(textclass_type const textclass) {
167 if (textclass >= classlist_.size())
169 TextClass const & tc = classlist_[textclass];
170 TextClass tmpl(tc.name(), tc.latexname(), tc.description(),
171 tc.isTeXClassAvailable());
172 classlist_[textclass] = tmpl;
176 pair<bool, textclass_type> const
177 TextClassList::addTextClass(string const & textclass, string const & path)
179 // only check for textclass.layout file, .cls can be anywhere in $TEXINPUTS
180 // NOTE: latex class name is defined in textclass.layout, which can be different from textclass
181 FileName const layout_file(addName(path, textclass + ".layout"));
182 if (layout_file.exists()) {
183 LYXERR(Debug::TCLASS, "Adding class " << textclass << " from directory " << path);
184 // Read .layout file and get description, real latex classname etc
186 // This is a C++ version of function processLayoutFile in configure.py,
187 // which uses the following regex
188 // \Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}
189 ifstream ifs(layout_file.toFilesystemEncoding().c_str());
190 static regex const reg("^#\\s*\\\\Declare(LaTeX|DocBook)Class\\s*"
191 "(?:\\[([^,]*)(?:,.*)*\\])*\\s*\\{(.*)\\}\\s*");
193 while (getline(ifs, line)) {
194 // look for the \DeclareXXXClass line
196 if (regex_match(line, sub, reg)) {
197 // returns: whole string, classtype (not used here), first option, description
198 BOOST_ASSERT(sub.size()==4);
199 // now, create a TextClass with description containing path information
200 TextClass tmpl(textclass, sub.str(2)==""?textclass:sub.str(2),
201 sub.str(3) + " <" + path + ">", true);
202 if (lyxerr.debugging(Debug::TCLASS))
204 // Do not add this local TextClass to classlist_ if it has
205 // already been loaded by, for example, a master buffer.
206 pair<bool, lyx::textclass_type> pp =
207 textclasslist.numberOfClass(textclass);
208 // only layouts from the same directory are considered to be identical.
209 if (pp.first && classlist_[pp.second].description() == tmpl.description())
211 classlist_.push_back(tmpl);
212 return make_pair(true, classlist_.size() - 1);
216 // If .layout is not in local directory, or an invalid layout is found, return false
217 return make_pair(false, textclass_type(0));
221 // Global variable: textclass table.
222 TextClassList textclasslist;
225 textclass_type defaultTextclass()
227 // We want to return the article class. if `first' is
228 // true in the returned pair, then `second' is the textclass
229 // number; if it is false, second is 0. In both cases, second
231 return textclasslist.numberOfClass("article").second;
236 // Reads the style files
239 LYXERR(Debug::TCLASS, "LyXSetStyle: parsing configuration...");
241 if (!textclasslist.read()) {
242 LYXERR(Debug::TCLASS, "LyXSetStyle: an error occured "
243 "during parsing.\n Exiting.");
247 LYXERR(Debug::TCLASS, "LyXSetStyle: configuration parsed.");