lyx_mirror/src/LayoutFile.cpp
Richard Heck 7e4d4d2641 Cosmetics.
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@28455 a592a061-630c-0410-9148-cb99ea01b6c8
2009-02-11 20:02:53 +00:00

319 lines
8.8 KiB
C++

/**
* \file LayoutFileList.cpp
* 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>
#include "LayoutFile.h"
#include "Counters.h"
#include "Floating.h"
#include "FloatList.h"
#include "Lexer.h"
#include "TextClass.h"
#include "support/lassert.h"
#include "support/debug.h"
#include "support/FileName.h"
#include "support/filetools.h"
#include "support/gettext.h"
#include <boost/bind.hpp>
#include <boost/regex.hpp>
#include <fstream>
using namespace std;
using namespace lyx::support;
namespace lyx {
using boost::bind;
using boost::regex;
using boost::smatch;
LayoutFile::LayoutFile(string const & fn, string const & cln,
string const & desc, bool texClassAvail )
{
name_ = fn;
latexname_ = cln;
description_ = desc;
texClassAvail_ = texClassAvail;
}
LayoutFileList::~LayoutFileList()
{
ClassMap::const_iterator it = classmap_.begin();
ClassMap::const_iterator en = classmap_.end();
for (; it != en; ++it) {
delete it->second;
}
}
LayoutFileList & LayoutFileList::get()
{
static LayoutFileList baseclasslist;
return baseclasslist;
}
bool LayoutFileList::haveClass(string const & classname) const
{
ClassMap::const_iterator it = classmap_.begin();
ClassMap::const_iterator en = classmap_.end();
for (; it != en; ++it) {
if (it->first == classname)
return true;
}
return false;
}
LayoutFile const & LayoutFileList::operator[](string const & classname) const
{
LASSERT(haveClass(classname), /**/);
return *classmap_[classname];
}
LayoutFile & LayoutFileList::operator[](string const & classname)
{
LASSERT(haveClass(classname), /**/);
return *classmap_[classname];
}
// Reads LyX textclass definitions according to textclass config file
bool LayoutFileList::read()
{
Lexer lex;
FileName const real_file = libFileSearch("", "textclass.lst");
LYXERR(Debug::TCLASS, "Reading textclasses from `" << real_file << '\'');
if (real_file.empty()) {
lyxerr << "LayoutFileList::Read: unable to find "
"textclass file `"
<< to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
<< "'. Exiting." << endl;
return false;
// This causes LyX to end... Not a desirable behaviour. Lgb
// What do you propose? That the user gets a file dialog
// and is allowed to hunt for the file? (Asger)
// more that we have a layout for minimal.cls statically
// compiled in... (Lgb)
}
if (!lex.setFile(real_file)) {
lyxerr << "LayoutFileList::Read: "
"lyxlex was not able to set file: "
<< real_file << endl;
}
if (!lex.isOK()) {
lyxerr << "LayoutFileList::Read: unable to open "
"textclass file `"
<< to_utf8(makeDisplayPath(real_file.absFilename(), 1000))
<< "'\nCheck your installation. LyX can't continue."
<< endl;
return false;
}
bool finished = false;
// Parse config-file
LYXERR(Debug::TCLASS, "Starting parsing of textclass.lst");
while (lex.isOK() && !finished) {
LYXERR(Debug::TCLASS, "\tline by line");
switch (lex.lex()) {
case Lexer::LEX_FEOF:
finished = true;
break;
default:
string const fname = lex.getString();
LYXERR(Debug::TCLASS, "Fname: " << fname);
if (lex.next()) {
string const clname = lex.getString();
LYXERR(Debug::TCLASS, "Clname: " << clname);
if (lex.next()) {
string const desc = lex.getString();
LYXERR(Debug::TCLASS, "Desc: " << desc);
if (lex.next()) {
bool avail = lex.getBool();
LYXERR(Debug::TCLASS, "Avail: " << avail);
// This code is run when we have
// fname, clname, desc, and avail
LayoutFile * tmpl = new LayoutFile(fname, clname, desc, avail);
if (lyxerr.debugging(Debug::TCLASS)) {
// only system layout files are loaded here so no
// buffer path is needed.
tmpl->load();
}
classmap_[fname] = tmpl;
}
}
}
}
}
LYXERR(Debug::TCLASS, "End of parsing of textclass.lst");
// lyx will start with an empty classmap_, but only reconfigure is allowed
// in this case. This gives users a second chance to configure lyx if
// initial configuration fails. (c.f. bug 2829)
if (classmap_.empty())
lyxerr << "LayoutFileList::Read: no textclasses found!"
<< endl;
return true;
}
std::vector<LayoutFileIndex> LayoutFileList::classList() const
{
std::vector<LayoutFileIndex> cl;
ClassMap::const_iterator it = classmap_.begin();
ClassMap::const_iterator en = classmap_.end();
for (; it != en; ++it)
cl.push_back(it->first);
return cl;
}
void LayoutFileList::reset(LayoutFileIndex const & classname) {
LASSERT(haveClass(classname), /**/);
LayoutFile * tc = classmap_[classname];
LayoutFile * tmpl =
new LayoutFile(tc->name(), tc->latexname(), tc->description(),
tc->isTeXClassAvailable());
classmap_[classname] = tmpl;
delete tc;
}
LayoutFileIndex LayoutFileList::addEmptyClass(string const & textclass)
{
if (haveClass(textclass))
return textclass;
FileName const tempLayout = FileName::tempName();
ofstream ofs(tempLayout.toFilesystemEncoding().c_str());
ofs << "# This layout is automatically generated\n"
"# \\DeclareLaTeXClass{" << textclass << "}\n\n"
"Format 7\n"
"Input stdclass.inc\n\n"
"Columns 1\n"
"Sides 1\n"
"SecNumDepth 2\n"
"TocDepth 2\n"
"DefaultStyle Standard\n\n"
"Style Standard\n"
" Category MainText\n"
" Margin Static\n"
" LatexType Paragraph\n"
" LatexName dummy\n"
" ParIndent MM\n"
" ParSkip 0.4\n"
" Align Block\n"
" AlignPossible Block, Left, Right, Center\n"
" LabelType No_Label\n"
"End\n";
ofs.close();
// We do not know if a LaTeX class is available for this document, but setting
// the last parameter to true will suppress a warning message about missing
// tex class.
LayoutFile * tc = new LayoutFile(textclass, textclass, "Unknown text class " + textclass, true);
if (!tc->load(tempLayout.absFilename())) {
// The only way this happens is because the hardcoded layout file above
// is wrong.
LASSERT(false, /**/);
}
classmap_[textclass] = tc;
return textclass;
}
LayoutFileIndex
LayoutFileList::addLocalLayout(string const & textclass, string const & path)
{
// FIXME There is a bug here: 4593
//
// 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
string fullName = addName(path, textclass + ".layout");
FileName const layout_file(fullName);
if (layout_file.exists()) {
LYXERR(Debug::TCLASS, "Adding class " << textclass << " from directory " << path);
// 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), class name, description
LASSERT(sub.size() == 4, /**/);
// now, create a TextClass with description containing path information
string className(sub.str(2) == "" ? textclass : sub.str(2));
LayoutFile * tmpl =
new LayoutFile(textclass, className, textclass, true);
// This textclass is added on request so it will definitely be
// used. Load it now because other load() calls may fail if they
// are called in a context without buffer path information.
tmpl->load(path);
// There will be only one textclass with this name, even if different
// layout files are loaded from different directories.
if (haveClass(textclass)) {
LYXERR0("Existing textclass " << textclass << " is redefined by " << fullName);
delete classmap_[textclass];
}
classmap_[textclass] = tmpl;
return textclass;
}
}
}
// If .layout is not in local directory, or an invalid layout is found, return null
return string();
}
LayoutFileIndex defaultBaseclass()
{
if (LayoutFileList::get().haveClass("article"))
return string("article");
if (LayoutFileList::get().empty())
return string();
return LayoutFileList::get().classList().front();
}
// Reads the style files
bool LyXSetStyle()
{
LYXERR(Debug::TCLASS, "LyXSetStyle: parsing configuration...");
if (!LayoutFileList::get().read()) {
LYXERR(Debug::TCLASS, "LyXSetStyle: an error occured "
"during parsing.\n Exiting.");
return false;
}
LYXERR(Debug::TCLASS, "LyXSetStyle: configuration parsed.");
return true;
}
} // namespace lyx