-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
+/**
+ * \file lyxtextclasslist.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ======================================================
+ * \author Lars Gullik Bjønnes
+ * \author John Levon
+ *
+ * Full author contact details are available in file CREDITS.
*/
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "lyxtextclasslist.h"
#include "lyxtextclass.h"
#include "debug.h"
#include "lyxlex.h"
-#include "gettext.h"
-#include "frontends/Alert.h"
-
-#include "support/lyxfunctional.h"
-#include "support/LAssert.h"
#include "support/filetools.h"
-#include <utility>
+#include <boost/bind.hpp>
+#include <boost/regex.hpp>
+#include <boost/filesystem/operations.hpp>
+#include <fstream>
+
+
+namespace lyx {
+namespace fs = boost::filesystem;
+
+using support::FileName;
+using support::libFileSearch;
+using support::makeDisplayPath;
+
+using boost::bind;
+using boost::regex;
+using boost::smatch;
-using lyx::layout_type;
-using lyx::textclass_type;
-using std::pair;
-using std::make_pair;
using std::endl;
+using std::equal_to;
using std::find_if;
+using std::make_pair;
using std::sort;
+using std::string;
+using std::pair;
+using std::ifstream;
// Gets textclass number from name
pair<bool, textclass_type> const
-LyXTextClassList::NumberOfClass(string const & textclass) const
+LyXTextClassList::numberOfClass(string const & textclass) const
{
ClassList::const_iterator cit =
- find_if(classlist.begin(), classlist.end(),
- lyx::compare_memfun(&LyXTextClass::name, textclass));
- return cit != classlist.end() ?
- make_pair(true, textclass_type(cit - classlist.begin())) :
- make_pair(false, textclass_type(0));
-}
-
-
-// Gets layout structure from style number and textclass number
-LyXLayout const &
-LyXTextClassList::Style(textclass_type textclass,
- layout_type layout) const
-{
- classlist[textclass].load();
- if (layout < classlist[textclass].numLayouts())
- return classlist[textclass][layout];
- return classlist[textclass][0];
-}
-
-
-// Gets layout number from name and textclass number
-pair<bool, layout_type> const
-LyXTextClassList::NumberOfLayout(textclass_type textclass,
- string const & name) const
-{
- classlist[textclass].load();
- for (unsigned int i = 0; i < classlist[textclass].numLayouts(); ++i) {
- if (classlist[textclass][i].name() == name)
- return make_pair(true, i);
- }
- return make_pair(false, layout_type(0)); // not found
-}
-
-
-// Gets a layout (style) name from layout number and textclass number
-string const &
-LyXTextClassList::NameOfLayout(textclass_type textclass,
- layout_type layout) const
-{
- static string const dummy("dummy");
- classlist[textclass].load();
- if (layout < classlist[textclass].numLayouts())
- return classlist[textclass][layout].name();
- return dummy;
-}
-
-
-// Gets a textclass name from number
-string const &
-LyXTextClassList::NameOfClass(textclass_type number) const
-{
- static string const dummy("dummy");
- if (classlist.empty()) {
- return dummy;
- }
- lyx::Assert(number < classlist.size());
- return classlist[number].name();
-}
+ find_if(classlist_.begin(), classlist_.end(),
+ bind(equal_to<string>(),
+ bind(&LyXTextClass::name, _1),
+ textclass));
-
-// Gets a textclass latexname from number
-string const &
-LyXTextClassList::LatexnameOfClass(textclass_type number) const
-{
- static string const dummy("dummy");
- classlist[number].load();
- if (classlist.empty()) {
- return dummy;
- }
- lyx::Assert(number < classlist.size());
- return classlist[number].latexname();
-}
-
-
-// Gets a textclass description from number
-string const &
-LyXTextClassList::DescOfClass(textclass_type number) const
-{
- static string const dummy("dummy");
- if (classlist.empty()) {
- return dummy;
- }
- lyx::Assert(number < classlist.size());
- return classlist[number].description();
+ return cit != classlist_.end() ?
+ make_pair(true, textclass_type(cit - classlist_.begin())) :
+ make_pair(false, textclass_type(0));
}
// Gets a textclass structure from number
LyXTextClass const &
-LyXTextClassList::TextClass(textclass_type textclass) const
+LyXTextClassList::operator[](textclass_type textclass) const
{
- classlist[textclass].load();
- if (textclass < classlist.size())
- return classlist[textclass];
+ classlist_[textclass].load();
+ if (textclass < classlist_.size())
+ return classlist_[textclass];
else
- return classlist[0];
-}
-
-
-void LyXTextClassList::Add(LyXTextClass const & t)
-{
- classlist.push_back(t);
+ return classlist_[0];
}
// used when sorting the textclass list.
-class less_textclass_desc {
+class less_textclass_avail_desc
+ : public std::binary_function<LyXTextClass, LyXTextClass, int>
+{
public:
- int operator()(LyXTextClass const & tc1, LyXTextClass const & tc2) {
- return tc1.description() < tc2.description();
+ int operator()(LyXTextClass const & tc1,
+ LyXTextClass const & tc2) const
+ {
+ // Ordering criteria:
+ // 1. Availability of text class
+ // 2. Description (lexicographic)
+
+ return (tc1.isTeXClassAvailable() && !tc2.isTeXClassAvailable()) ||
+ (tc1.isTeXClassAvailable() == tc2.isTeXClassAvailable() &&
+ tc1.description() < tc2.description());
}
};
// Reads LyX textclass definitions according to textclass config file
-bool LyXTextClassList::Read ()
+bool LyXTextClassList::read()
{
LyXLex lex(0, 0);
- string real_file = LibFileSearch("", "textclass.lst");
+ support::FileName const real_file = libFileSearch("", "textclass.lst");
lyxerr[Debug::TCLASS] << "Reading textclasses from `"
- << real_file << "'" << endl;
+ << real_file << '\'' << endl;
if (real_file.empty()) {
lyxerr << "LyXTextClassList::Read: unable to find "
- "textclass file `" << MakeDisplayPath(real_file, 1000)
+ "textclass file `"
+ << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
<< "'. Exiting." << endl;
-
- Alert::alert(_("LyX wasn't able to find its layout descriptions!"),
- _("Check that the file \"textclass.lst\""),
- _("is installed correctly. Sorry, has to exit :-("));
return false;
// This causes LyX to end... Not a desirable behaviour. Lgb
// What do you propose? That the user gets a file dialog
"lyxlex was not able to set file: "
<< real_file << endl;
}
-
+
if (!lex.isOK()) {
lyxerr << "LyXTextClassList::Read: unable to open "
- "textclass file `" << MakeDisplayPath(real_file, 1000)
+ "textclass file `"
+ << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
<< "'\nCheck your installation. LyX can't continue."
<< endl;
- return false;
+ return false;
}
bool finished = false;
lyxerr[Debug::TCLASS] << "Fname: " << fname << endl;
if (lex.next()) {
string const clname = lex.getString();
- lyxerr[Debug::TCLASS]
- << "Clname: " << clname << endl;
+ lyxerr[Debug::TCLASS] << "Clname: " << clname << endl;
if (lex.next()) {
- string const desc = lex.getString();
- lyxerr[Debug::TCLASS]
- << "Desc: " << desc << endl;
- // This code is run when we have
- // fname, clname and desc
- LyXTextClass tmpl(fname,
- clname,
- desc);
- if (lyxerr.
- debugging(Debug::TCLASS)) {
- tmpl.load();
- }
- Add (tmpl);
+ string const desc = lex.getString();
+ lyxerr[Debug::TCLASS] << "Desc: " << desc << endl;
+ if (lex.next()) {
+ bool avail = lex.getBool();
+ lyxerr[Debug::TCLASS] << "Avail: " << avail << endl;
+ // This code is run when we have
+ // fname, clname, desc, and avail
+ LyXTextClass tmpl(fname, clname, desc, avail);
+ if (lyxerr.debugging(Debug::TCLASS)) {
+ tmpl.load();
+ }
+ classlist_.push_back(tmpl);
+ }
}
}
}
}
lyxerr[Debug::TCLASS] << "End of parsing of textclass.lst" << endl;
- if (classlist.empty()) {
+ if (classlist_.empty()) {
lyxerr << "LyXTextClassList::Read: no textclasses found!"
<< endl;
- Alert::alert(_("LyX wasn't able to find any layout description!"),
- _("Check the contents of the file \"textclass.lst\""),
- _("Sorry, has to exit :-("));
return false;
}
// Ok everything loaded ok, now sort the list.
- sort(classlist.begin(), classlist.end(), less_textclass_desc());
+ sort(classlist_.begin(), classlist_.end(), less_textclass_avail_desc());
return true;
}
-
-/* Load textclass
- Returns false if this fails
-*/
-bool LyXTextClassList::Load(textclass_type number) const
+
+std::pair<bool, textclass_type> const
+LyXTextClassList::addTextClass(std::string const & textclass, std::string const & path)
{
- bool result = true;
- if (number < classlist.size()) {
- classlist[number].load();
- if (classlist[number].numLayouts() == 0) {
- result = false;
+ // only check for textclass.layout file, .cls can be anywhere in $TEXINPUTS
+ // NOTE: latex class name is defined in textclass.layout, which can be different from textclass
+ FileName const layout_file(path + '/' + textclass + ".layout");
+ if (fs::exists(layout_file.toFilesystemEncoding())) {
+ lyxerr[Debug::TCLASS] << "Adding class " << textclass << " from directory " << path << endl;
+ // Read .layout file and get description, real latex classname etc
+ //
+ // This is a C++ version of function processLayoutFile in configure.py,
+ // which uses the following regex
+ // \Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}
+ ifstream ifs(layout_file.toFilesystemEncoding().c_str());
+ static regex const reg("^#\\s*\\\\Declare(LaTeX|DocBook)Class\\s*"
+ "(?:\\[([^,]*)(?:,.*)*\\])*\\s*\\{(.*)\\}\\s*");
+ string line;
+ while (getline(ifs, line)) {
+ // look for the \DeclareXXXClass line
+ smatch sub;
+ if (regex_match(line, sub, reg)) {
+ // returns: whole string, classtype (not used here), first option, description
+ BOOST_ASSERT(sub.size()==4);
+ // now, add the layout to textclass.
+ LyXTextClass tmpl(textclass, sub.str(2)==""?textclass:sub.str(2),
+ sub.str(3) + " <" + path + ">", true);
+ if (lyxerr.debugging(Debug::TCLASS))
+ tmpl.load(path);
+ classlist_.push_back(tmpl);
+ return make_pair(true, classlist_.size() - 1);
+ }
}
- } else {
- result = false;
}
- return result;
+ // If .layout is not in local directory, or an invalid layout is found, return false
+ return make_pair(false, textclass_type(0));
}
-
+
// Global variable: textclass table.
LyXTextClassList textclasslist;
+
// Reads the style files
-void LyXSetStyle()
+bool LyXSetStyle()
{
- lyxerr[Debug::TCLASS] << "LyXSetStyle: parsing configuration...\n";
-
- if (!textclasslist.Read()) {
+ lyxerr[Debug::TCLASS] << "LyXSetStyle: parsing configuration..." << endl;
+
+ if (!textclasslist.read()) {
lyxerr[Debug::TCLASS] << "LyXSetStyle: an error occured "
"during parsing.\n Exiting." << endl;
- exit(1);
+ return false;
}
lyxerr[Debug::TCLASS] << "LyXSetStyle: configuration parsed." << endl;
+ return true;
}
+
+
+} // namespace lyx