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"
19 #include "support/filetools.h"
21 #include <boost/bind.hpp>
22 #include <boost/regex.hpp>
29 using support::FileName;
30 using support::addName;
31 using support::libFileSearch;
32 using support::makeDisplayPath;
48 // Gets textclass number from name
49 pair<bool, textclass_type> const
50 TextClassList::numberOfClass(string const & textclass) const
52 ClassList::const_iterator cit =
53 find_if(classlist_.begin(), classlist_.end(),
54 bind(equal_to<string>(),
55 bind(&TextClass::name, _1),
58 return cit != classlist_.end() ?
59 make_pair(true, textclass_type(cit - classlist_.begin())) :
60 make_pair(false, textclass_type(0));
64 // Gets a textclass structure from number
66 TextClassList::operator[](textclass_type textclass) const
68 if (textclass >= classlist_.size())
71 //FIXME I don't believe the following line is actually necessary (rgh)
72 classlist_[textclass].load();
73 return classlist_[textclass];
77 // used when sorting the textclass list.
78 class less_textclass_avail_desc
79 : public std::binary_function<TextClass, TextClass, int>
82 int operator()(TextClass const & tc1,
83 TextClass const & tc2) const
86 // 1. Availability of text class
87 // 2. Description (lexicographic)
89 return (tc1.isTeXClassAvailable() && !tc2.isTeXClassAvailable()) ||
90 (tc1.isTeXClassAvailable() == tc2.isTeXClassAvailable() &&
91 tc1.description() < tc2.description());
96 // Reads LyX textclass definitions according to textclass config file
97 bool TextClassList::read()
100 support::FileName const real_file = libFileSearch("", "textclass.lst");
101 LYXERR(Debug::TCLASS) << "Reading textclasses from `"
102 << real_file << '\'' << endl;
104 if (real_file.empty()) {
105 lyxerr << "TextClassList::Read: unable to find "
107 << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
108 << "'. Exiting." << endl;
110 // This causes LyX to end... Not a desirable behaviour. Lgb
111 // What do you propose? That the user gets a file dialog
112 // and is allowed to hunt for the file? (Asger)
113 // more that we have a layout for minimal.cls statically
114 // compiled in... (Lgb)
117 if (!lex.setFile(real_file)) {
118 lyxerr << "TextClassList::Read: "
119 "lyxlex was not able to set file: "
120 << real_file << endl;
124 lyxerr << "TextClassList::Read: unable to open "
126 << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
127 << "'\nCheck your installation. LyX can't continue."
132 bool finished = false;
134 LYXERR(Debug::TCLASS) << "Starting parsing of textclass.lst" << endl;
135 while (lex.isOK() && !finished) {
136 LYXERR(Debug::TCLASS) << "\tline by line" << endl;
138 case Lexer::LEX_FEOF:
142 string const fname = lex.getString();
143 LYXERR(Debug::TCLASS) << "Fname: " << fname << endl;
145 string const clname = lex.getString();
146 LYXERR(Debug::TCLASS) << "Clname: " << clname << endl;
148 string const desc = lex.getString();
149 LYXERR(Debug::TCLASS) << "Desc: " << desc << endl;
151 bool avail = lex.getBool();
152 LYXERR(Debug::TCLASS) << "Avail: " << avail << endl;
153 // This code is run when we have
154 // fname, clname, desc, and avail
155 TextClass tmpl(fname, clname, desc, avail);
156 if (lyxerr.debugging(Debug::TCLASS)) {
159 classlist_.push_back(tmpl);
165 LYXERR(Debug::TCLASS) << "End of parsing of textclass.lst" << endl;
167 // lyx will start with an empty classlist_, but only reconfigure is allowed
168 // in this case. This gives users a second chance to configure lyx if
169 // initial configuration fails. (c.f. bug 2829)
170 if (classlist_.empty())
171 lyxerr << "TextClassList::Read: no textclasses found!"
174 // Ok everything loaded ok, now sort the list.
175 sort(classlist_.begin(), classlist_.end(), less_textclass_avail_desc());
180 void TextClassList::reset(textclass_type const textclass) {
181 if (textclass >= classlist_.size())
183 TextClass const & tc = classlist_[textclass];
184 TextClass tmpl(tc.name(), tc.latexname(), tc.description(),
185 tc.isTeXClassAvailable());
186 classlist_[textclass] = tmpl;
190 std::pair<bool, textclass_type> const
191 TextClassList::addTextClass(std::string const & textclass, std::string const & path)
193 // only check for textclass.layout file, .cls can be anywhere in $TEXINPUTS
194 // NOTE: latex class name is defined in textclass.layout, which can be different from textclass
195 FileName const layout_file(addName(path, textclass + ".layout"));
196 if (layout_file.exists()) {
197 LYXERR(Debug::TCLASS) << "Adding class " << textclass << " from directory " << path << endl;
198 // Read .layout file and get description, real latex classname etc
200 // This is a C++ version of function processLayoutFile in configure.py,
201 // which uses the following regex
202 // \Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}
203 ifstream ifs(layout_file.toFilesystemEncoding().c_str());
204 static regex const reg("^#\\s*\\\\Declare(LaTeX|DocBook)Class\\s*"
205 "(?:\\[([^,]*)(?:,.*)*\\])*\\s*\\{(.*)\\}\\s*");
207 while (getline(ifs, line)) {
208 // look for the \DeclareXXXClass line
210 if (regex_match(line, sub, reg)) {
211 // returns: whole string, classtype (not used here), first option, description
212 BOOST_ASSERT(sub.size()==4);
213 // now, add the layout to textclass.
214 TextClass tmpl(textclass, sub.str(2)==""?textclass:sub.str(2),
215 sub.str(3) + " <" + path + ">", true);
216 if (lyxerr.debugging(Debug::TCLASS))
218 classlist_.push_back(tmpl);
219 return make_pair(true, classlist_.size() - 1);
223 // If .layout is not in local directory, or an invalid layout is found, return false
224 return make_pair(false, textclass_type(0));
228 // Global variable: textclass table.
229 TextClassList textclasslist;
232 // Reads the style files
235 LYXERR(Debug::TCLASS) << "LyXSetStyle: parsing configuration..." << endl;
237 if (!textclasslist.read()) {
238 LYXERR(Debug::TCLASS) << "LyXSetStyle: an error occured "
239 "during parsing.\n Exiting." << endl;
243 LYXERR(Debug::TCLASS) << "LyXSetStyle: configuration parsed." << endl;