src/TextClassList.cpp

   1 /**
   2  * \file TextClassList.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author John Levon
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "TextClassList.h"
  15 #include "TextClass.h"
  16 #include "debug.h"
  17 #include "Lexer.h"
  18
  19 #include "support/filetools.h"
  20
  21 #include <boost/bind.hpp>
  22 #include <boost/regex.hpp>
  23 #include <boost/filesystem/operations.hpp>
  24 #include <fstream>
  25
  26
  27 namespace lyx {
  28 namespace fs = boost::filesystem;
  29
  30 using support::FileName;
  31 using support::addName;
  32 using support::libFileSearch;
  33 using support::makeDisplayPath;
  34
  35 using boost::bind;
  36 using boost::regex;
  37 using boost::smatch;
  38
  39 using std::endl;
  40 using std::equal_to;
  41 using std::find_if;
  42 using std::make_pair;
  43 using std::sort;
  44 using std::string;
  45 using std::pair;
  46 using std::ifstream;
  47
  48
  49 // Gets textclass number from name
  50 pair<bool, textclass_type> const
  51 TextClassList::numberOfClass(string const & textclass) const
  52 {
  53         ClassList::const_iterator cit =
  54                 find_if(classlist_.begin(), classlist_.end(),
  55                         bind(equal_to<string>(),
  56                              bind(&TextClass::name, _1),
  57                              textclass));
  58
  59         return cit != classlist_.end() ?
  60                 make_pair(true, textclass_type(cit - classlist_.begin())) :
  61                 make_pair(false, textclass_type(0));
  62 }
  63
  64
  65 // Gets a textclass structure from number
  66 TextClass const &
  67 TextClassList::operator[](textclass_type textclass) const
  68 {
  69         classlist_[textclass].load();
  70         if (textclass < classlist_.size())
  71                 return classlist_[textclass];
  72         else
  73                 return classlist_[0];
  74 }
  75
  76
  77 // used when sorting the textclass list.
  78 class less_textclass_avail_desc
  79         : public std::binary_function<TextClass, TextClass, int>
  80 {
  81 public:
  82         int operator()(TextClass const & tc1,
  83                        TextClass const & tc2) const
  84         {
  85                 // Ordering criteria:
  86                 //   1. Availability of text class
  87                 //   2. Description (lexicographic)
  88
  89                 return (tc1.isTeXClassAvailable() && !tc2.isTeXClassAvailable()) ||
  90                         (tc1.isTeXClassAvailable() == tc2.isTeXClassAvailable() &&
  91                          tc1.description() < tc2.description());
  92         }
  93 };
  94
  95
  96 // Reads LyX textclass definitions according to textclass config file
  97 bool TextClassList::read()
  98 {
  99         Lexer lex(0, 0);
 100         support::FileName const real_file = libFileSearch("", "textclass.lst");
 101         LYXERR(Debug::TCLASS) << "Reading textclasses from `"
 102                               << real_file << '\'' << endl;
 103
 104         if (real_file.empty()) {
 105                 lyxerr << "TextClassList::Read: unable to find "
 106                           "textclass file  `"
 107                        << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
 108                        << "'. Exiting." << endl;
 109                 return false;
 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)
 115         }
 116
 117         if (!lex.setFile(real_file)) {
 118                 lyxerr << "TextClassList::Read: "
 119                         "lyxlex was not able to set file: "
 120                        << real_file << endl;
 121         }
 122
 123         if (!lex.isOK()) {
 124                 lyxerr << "TextClassList::Read: unable to open "
 125                           "textclass file  `"
 126                        << to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
 127                        << "'\nCheck your installation. LyX can't continue."
 128                        << endl;
 129                 return false;
 130         }
 131
 132         bool finished = false;
 133         // Parse config-file
 134         LYXERR(Debug::TCLASS) << "Starting parsing of textclass.lst" << endl;
 135         while (lex.isOK() && !finished) {
 136                 LYXERR(Debug::TCLASS) << "\tline by line" << endl;
 137                 switch (lex.lex()) {
 138                 case Lexer::LEX_FEOF:
 139                         finished = true;
 140                         break;
 141                 default:
 142                         string const fname = lex.getString();
 143                         LYXERR(Debug::TCLASS) << "Fname: " << fname << endl;
 144                         if (lex.next()) {
 145                                 string const clname = lex.getString();
 146                                 LYXERR(Debug::TCLASS) << "Clname: " << clname << endl;
 147                                 if (lex.next()) {
 148                                         string const desc = lex.getString();
 149                                         LYXERR(Debug::TCLASS) << "Desc: " << desc << endl;
 150                                         if (lex.next()) {
 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)) {
 157                                                         tmpl.load();
 158                                                 }
 159                                                 classlist_.push_back(tmpl);
 160                                         }
 161                                 }
 162                         }
 163                 }
 164         }
 165         LYXERR(Debug::TCLASS) << "End of parsing of textclass.lst" << endl;
 166
 167         if (classlist_.empty()) {
 168                 lyxerr << "TextClassList::Read: no textclasses found!"
 169                        << endl;
 170                 return false;
 171         }
 172         // Ok everything loaded ok, now sort the list.
 173         sort(classlist_.begin(), classlist_.end(), less_textclass_avail_desc());
 174         return true;
 175 }
 176
 177
 178 std::pair<bool, textclass_type> const
 179 TextClassList::addTextClass(std::string const & textclass, std::string const & path)
 180 {
 181         // only check for textclass.layout file, .cls can be anywhere in $TEXINPUTS
 182         // NOTE: latex class name is defined in textclass.layout, which can be different from textclass
 183         FileName const layout_file(addName(path, textclass + ".layout"));
 184         if (fs::exists(layout_file.toFilesystemEncoding())) {
 185                 LYXERR(Debug::TCLASS) << "Adding class " << textclass << " from directory " << path << endl;
 186                 // Read .layout file and get description, real latex classname etc
 187                 //
 188                 // This is a C++ version of function processLayoutFile in configure.py,
 189                 // which uses the following regex
 190                 //     \Declare(LaTeX|DocBook)Class\s*(\[([^,]*)(,.*)*\])*\s*{(.*)}
 191                 ifstream ifs(layout_file.toFilesystemEncoding().c_str());
 192                 static regex const reg("^#\\s*\\\\Declare(LaTeX|DocBook)Class\\s*"
 193                         "(?:\\[([^,]*)(?:,.*)*\\])*\\s*\\{(.*)\\}\\s*");
 194                 string line;
 195                 while (getline(ifs, line)) {
 196                         // look for the \DeclareXXXClass line
 197                         smatch sub;
 198                         if (regex_match(line, sub, reg)) {
 199                                 // returns: whole string, classtype (not used here), first option, description
 200                                 BOOST_ASSERT(sub.size()==4);
 201                                 // now, add the layout to textclass.
 202                                 TextClass tmpl(textclass, sub.str(2)==""?textclass:sub.str(2),
 203                                         sub.str(3) + " <" + path + ">", true);
 204                                 if (lyxerr.debugging(Debug::TCLASS))
 205                                         tmpl.load(path);
 206                                 classlist_.push_back(tmpl);
 207                                 return make_pair(true, classlist_.size() - 1);
 208                         }
 209                 }
 210         }
 211         // If .layout is not in local directory, or an invalid layout is found, return false
 212         return make_pair(false, textclass_type(0));
 213 }
 214
 215
 216 // Global variable: textclass table.
 217 TextClassList textclasslist;
 218
 219
 220 // Reads the style files
 221 bool LyXSetStyle()
 222 {
 223         LYXERR(Debug::TCLASS) << "LyXSetStyle: parsing configuration..." << endl;
 224
 225         if (!textclasslist.read()) {
 226                 LYXERR(Debug::TCLASS) << "LyXSetStyle: an error occured "
 227                         "during parsing.\n             Exiting." << endl;
 228                 return false;
 229         }
 230
 231         LYXERR(Debug::TCLASS) << "LyXSetStyle: configuration parsed." << endl;
 232         return true;
 233 }
 234
 235
 236 } // namespace lyx