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>
23 #include <boost/filesystem/operations.hpp>
28 namespace fs = boost::filesystem;
30 using support::FileName;
31 using support::addName;
32 using support::libFileSearch;
33 using support::makeDisplayPath;
49 // Gets textclass number from name
50 pair<bool, textclass_type> const
51 TextClassList::numberOfClass(string const & textclass) const
53 ClassList::const_iterator cit =
54 find_if(classlist_.begin(), classlist_.end(),
55 bind(equal_to<string>(),
56 bind(&TextClass::name, _1),
59 return cit != classlist_.end() ?
60 make_pair(true, textclass_type(cit - classlist_.begin())) :
61 make_pair(false, textclass_type(0));
65 // Gets a textclass structure from number
67 TextClassList::operator[](textclass_type textclass) const
69 if (textclass >= classlist_.size())
72 //FIXME I don't believe the following line is actually necessary (rgh)
73 classlist_[textclass].load();
74 return classlist_[textclass];
78 // used when sorting the textclass list.
79 class less_textclass_avail_desc
80 : public std::binary_function<TextClass, TextClass, int>
83 int operator()(TextClass const & tc1,
84 TextClass const & tc2) const
87 // 1. Availability of text class
88 // 2. Description (lexicographic)
90 return (tc1.isTeXClassAvailable() && !tc2.isTeXClassAvailable()) ||
91 (tc1.isTeXClassAvailable() == tc2.isTeXClassAvailable() &&
92 tc1.description() < tc2.description());
97 // Reads LyX textclass definitions according to textclass config file
98 bool TextClassList::read()
101 support::FileName const real_file = libFileSearch("", "textclass.lst");
102 LYXERR(Debug::TCLASS) << "Reading textclasses from `"
103 << real_file << '\'' << endl;
105 if (real_file.empty()) {
106 lyxerr << "TextClassList::Read: unable to find "
108 << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
109 << "'. Exiting." << endl;
111 // This causes LyX to end... Not a desirable behaviour. Lgb
112 // What do you propose? That the user gets a file dialog
113 // and is allowed to hunt for the file? (Asger)
114 // more that we have a layout for minimal.cls statically
115 // compiled in... (Lgb)
118 if (!lex.setFile(real_file)) {
119 lyxerr << "TextClassList::Read: "
120 "lyxlex was not able to set file: "
121 << real_file << endl;
125 lyxerr << "TextClassList::Read: unable to open "
127 << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
128 << "'\nCheck your installation. LyX can't continue."
133 bool finished = false;
135 LYXERR(Debug::TCLASS) << "Starting parsing of textclass.lst" << endl;
136 while (lex.isOK() && !finished) {
137 LYXERR(Debug::TCLASS) << "\tline by line" << endl;
139 case Lexer::LEX_FEOF:
143 string const fname = lex.getString();
144 LYXERR(Debug::TCLASS) << "Fname: " << fname << endl;
146 string const clname = lex.getString();
147 LYXERR(Debug::TCLASS) << "Clname: " << clname << endl;
149 string const desc = lex.getString();
150 LYXERR(Debug::TCLASS) << "Desc: " << desc << endl;
152 bool avail = lex.getBool();
153 LYXERR(Debug::TCLASS) << "Avail: " << avail << endl;
154 // This code is run when we have
155 // fname, clname, desc, and avail
156 TextClass tmpl(fname, clname, desc, avail);
157 if (lyxerr.debugging(Debug::TCLASS)) {
160 classlist_.push_back(tmpl);
166 LYXERR(Debug::TCLASS) << "End of parsing of textclass.lst" << endl;
168 // lyx will start with an empty classlist_, but only reconfigure is allowed
169 // in this case. This gives users a second chance to configure lyx if
170 // initial configuration fails. (c.f. bug 2829)
171 if (classlist_.empty())
172 lyxerr << "TextClassList::Read: no textclasses found!"
175 // Ok everything loaded ok, now sort the list.
176 sort(classlist_.begin(), classlist_.end(), less_textclass_avail_desc());
181 void TextClassList::reset(textclass_type const textclass) {
182 if (textclass >= classlist_.size())
184 TextClass const & tc = classlist_[textclass];
185 TextClass tmpl(tc.name(), tc.latexname(), tc.description(),
186 tc.isTeXClassAvailable());
187 classlist_[textclass] = tmpl;
191 std::pair<bool, textclass_type> const
192 TextClassList::addTextClass(std::string const & textclass, std::string const & path)
194 // only check for textclass.layout file, .cls can be anywhere in $TEXINPUTS
195 // NOTE: latex class name is defined in textclass.layout, which can be different from textclass
196 FileName const layout_file(addName(path, textclass + ".layout"));
197 if (fs::exists(layout_file.toFilesystemEncoding())) {
198 LYXERR(Debug::TCLASS) << "Adding class " << textclass << " from directory " << path << endl;
199 // Read .layout file and get description, real latex classname etc
201 // This is a C++ version of function processLayoutFile in configure.py,
202 // which uses the following regex
203 // \Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}
204 ifstream ifs(layout_file.toFilesystemEncoding().c_str());
205 static regex const reg("^#\\s*\\\\Declare(LaTeX|DocBook)Class\\s*"
206 "(?:\\[([^,]*)(?:,.*)*\\])*\\s*\\{(.*)\\}\\s*");
208 while (getline(ifs, line)) {
209 // look for the \DeclareXXXClass line
211 if (regex_match(line, sub, reg)) {
212 // returns: whole string, classtype (not used here), first option, description
213 BOOST_ASSERT(sub.size()==4);
214 // now, add the layout to textclass.
215 TextClass tmpl(textclass, sub.str(2)==""?textclass:sub.str(2),
216 sub.str(3) + " <" + path + ">", true);
217 if (lyxerr.debugging(Debug::TCLASS))
219 classlist_.push_back(tmpl);
220 return make_pair(true, classlist_.size() - 1);
224 // If .layout is not in local directory, or an invalid layout is found, return false
225 return make_pair(false, textclass_type(0));
229 // Global variable: textclass table.
230 TextClassList textclasslist;
233 // Reads the style files
236 LYXERR(Debug::TCLASS) << "LyXSetStyle: parsing configuration..." << endl;
238 if (!textclasslist.read()) {
239 LYXERR(Debug::TCLASS) << "LyXSetStyle: an error occured "
240 "during parsing.\n Exiting." << endl;
244 LYXERR(Debug::TCLASS) << "LyXSetStyle: configuration parsed." << endl;