#include "TextClass.h"
+#include "LayoutFile.h"
#include "Color.h"
#include "Counters.h"
#include "Floating.h"
#include "support/lstrings.h"
#include "support/os.h"
+#include <algorithm>
+#include <fstream>
#include <sstream>
+#include "boost/assert.hpp"
+
using namespace std;
using namespace lyx::support;
namespace {
-class LayoutNamesEqual : public unary_function<LayoutPtr, bool> {
+class LayoutNamesEqual : public unary_function<Layout, bool> {
public:
LayoutNamesEqual(docstring const & name)
: name_(name)
{}
- bool operator()(LayoutPtr const & c) const
+ bool operator()(Layout const & c) const
{
- return c->name() == name_;
+ return c.name() == name_;
}
private:
docstring name_;
};
-int const FORMAT = 6;
+int const FORMAT = 7;
bool layout2layout(FileName const & filename, FileName const & tempfile)
return "input file";
case TextClass::MODULE:
return "module file";
+ case TextClass::VALIDATION:
+ return "validation";
}
// shutup warning
return string();
} // namespace anon
-TextClass::TextClass(string const & fn, string const & cln,
- string const & desc, bool texClassAvail )
- : name_(fn), latexname_(cln), description_(desc),
- floatlist_(new FloatList), counters_(new Counters),
- texClassAvail_(texClassAvail)
+docstring const TextClass::emptylayout_ = from_ascii(N_("Plain Layout"));
+
+
+InsetLayout DocumentClass::empty_insetlayout_;
+
+
+TextClass::TextClass()
{
- modular_ = false;
outputType_ = LATEX;
columns_ = 1;
sides_ = OneSide;
titletype_ = TITLE_COMMAND_AFTER;
titlename_ = "maketitle";
loaded_ = false;
- // a hack to make this available for translation
- // i'm sure there must be a better way (rgh)
- _("PlainLayout");
-}
-
-
-docstring const TextClass::emptylayout_ = from_ascii("PlainLayout");
-
-
-InsetLayout TextClass::empty_insetlayout_;
-
-
-bool TextClass::isTeXClassAvailable() const
-{
- return texClassAvail_;
}
}
// Resolve fonts
lay.resfont = lay.font;
- lay.resfont.realize(defaultfont());
+ lay.resfont.realize(defaultfont_);
lay.reslabelfont = lay.labelfont;
- lay.reslabelfont.realize(defaultfont());
+ lay.reslabelfont.realize(defaultfont_);
return true; // no errors
}
TC_NOFLOAT,
TC_TITLELATEXNAME,
TC_TITLELATEXTYPE,
- TC_FORMAT
+ TC_FORMAT,
+ TC_ADDTOPREAMBLE
};
-// Reads a textclass structure from file.
-bool TextClass::read(FileName const & filename, ReadType rt)
-{
- if (!filename.isReadableFile()) {
- lyxerr << "Cannot read layout file `" << filename << "'."
- << endl;
- return false;
- }
+namespace {
keyword_item textClassTags[] = {
+ { "addtopreamble", TC_ADDTOPREAMBLE },
{ "classoptions", TC_CLASSOPTIONS },
{ "columns", TC_COLUMNS },
{ "counter", TC_COUNTER },
{ "titlelatextype", TC_TITLELATEXTYPE },
{ "tocdepth", TC_TOCDEPTH }
};
+
+} //namespace anon
+
+
+bool TextClass::convertLayoutFormat(support::FileName const & filename, ReadType rt)
+{
+ LYXERR(Debug::TCLASS, "Converting layout file to " << FORMAT);
+ FileName const tempfile = FileName::tempName();
+ bool success = layout2layout(filename, tempfile);
+ if (success)
+ success = read(tempfile, rt);
+ tempfile.removeFile();
+ return success;
+}
+
+bool TextClass::read(FileName const & filename, ReadType rt)
+{
+ if (!filename.isReadableFile()) {
+ lyxerr << "Cannot read layout file `" << filename << "'."
+ << endl;
+ return false;
+ }
LYXERR(Debug::TCLASS, "Reading " + translateRT(rt) + ": " +
to_utf8(makeDisplayPath(filename.absFilename())));
// Define the `empty' layout used in table cells, ert, etc. Note that
// we do this before loading any layout file, so that classes can
// override features of this layout if they should choose to do so.
- if (rt == BASECLASS) {
+ if (rt == BASECLASS && !hasLayout(emptylayout_)) {
static char const * s = "Margin Static\n"
"LatexType Paragraph\n"
"LatexName dummy\n"
// The only way this happens is because the hardcoded layout above
// is wrong.
BOOST_ASSERT(false);
- }
- layoutlist_.push_back(boost::shared_ptr<Layout>(new Layout(lay)));
+ };
+ layoutlist_.push_back(lay);
}
-
Lexer lexrc(textClassTags,
sizeof(textClassTags) / sizeof(textClassTags[0]));
lexrc.setFile(filename);
+ ReturnValues retval = read(lexrc, rt);
+
+ LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " +
+ to_utf8(makeDisplayPath(filename.absFilename())));
+
+ if (retval != FORMAT_MISMATCH)
+ return retval == OK;
+
+ bool const worx = convertLayoutFormat(filename, rt);
+ if (!worx) {
+ lyxerr << "Unable to convert " << filename <<
+ " to format " << FORMAT << std::endl;
+ return false;
+ }
+ return true;
+}
+
+
+bool TextClass::validate(std::string const & str)
+{
+ TextClass tc;
+ return tc.read(str, VALIDATION);
+}
+
+
+bool TextClass::read(std::string const & str, ReadType rt)
+{
+ Lexer lexrc(textClassTags,
+ sizeof(textClassTags) / sizeof(textClassTags[0]));
+ istringstream is(str);
+ lexrc.setStream(is);
+ ReturnValues retval = read(lexrc, rt);
+
+ if (retval != FORMAT_MISMATCH)
+ return retval == OK;
+
+ // write the layout string to a temporary file
+ FileName const tempfile = FileName::tempName();
+ ofstream os(tempfile.toFilesystemEncoding().c_str());
+ if (!os) {
+ lyxerr << "Unable to create tempoary file in TextClass::read!!"
+ << std::endl;
+ return false;
+ }
+ os << str;
+ os.close();
+
+ // now try to convert it
+ bool const worx = convertLayoutFormat(tempfile, rt);
+ if (!worx) {
+ lyxerr << "Unable to convert internal layout information to format "
+ << FORMAT << std::endl;
+ }
+ tempfile.removeFile();
+ return worx;
+}
+
+
+// Reads a textclass structure from file.
+TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
+{
bool error = !lexrc.isOK();
// Format of files before the 'Format' tag was introduced
+ lexrc.getString() + " is probably not valid UTF-8!";
lexrc.printError(s.c_str());
Layout lay;
- //FIXME If we're just dropping this layout, do we really
- //care whether there's an error?? Or should we just set
- //error to true, since we couldn't even read the name?
+ // Since we couldn't read the name, we just scan the rest
+ // of the style and discard it.
error = !readStyle(lexrc, lay);
} else if (hasLayout(name)) {
- Layout * lay = operator[](name).get();
- error = !readStyle(lexrc, *lay);
+ Layout & lay = operator[](name);
+ error = !readStyle(lexrc, lay);
} else {
Layout lay;
lay.setName(name);
lay.is_environment = true;
error = !readStyle(lexrc, lay);
if (!error)
- layoutlist_.push_back(boost::shared_ptr<Layout>(new Layout(lay)));
+ layoutlist_.push_back(lay);
if (defaultlayout_.empty()) {
// We do not have a default layout yet, so we choose
preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
break;
+ case TC_ADDTOPREAMBLE:
+ preamble_ += from_utf8(lexrc.getLongString("EndPreamble"));
+ break;
+
case TC_PROVIDES: {
lexrc.next();
string const feature = lexrc.getString();
case TC_NOFLOAT:
if (lexrc.next()) {
string const nofloat = lexrc.getString();
- floatlist_->erase(nofloat);
+ floatlist_.erase(nofloat);
}
break;
}
break;
}
- if (format != FORMAT) {
- LYXERR(Debug::TCLASS, "Converting layout file from format "
- << format << " to " << FORMAT);
- FileName const tempfile = FileName::tempName();
- bool success = layout2layout(filename, tempfile);
- if (success)
- read(tempfile, rt);
- tempfile.removeFile();
- return success;
- }
-
- LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " +
- to_utf8(makeDisplayPath(filename.absFilename())));
+ if (format != FORMAT)
+ return FORMAT_MISMATCH;
if (rt != BASECLASS)
- return !error;
+ return (error ? ERROR : OK);
if (defaultlayout_.empty()) {
lyxerr << "Error: Textclass '" << name_
min_toclevel_ = Layout::NOT_IN_TOC;
max_toclevel_ = Layout::NOT_IN_TOC;
- for (size_t i = 0; i != layoutCount(); ++i) {
- int const toclevel = layout(i)->toclevel;
+ const_iterator lit = begin();
+ const_iterator len = end();
+ for (; lit != len; ++lit) {
+ int const toclevel = lit->toclevel;
if (toclevel != Layout::NOT_IN_TOC) {
if (min_toclevel_ == Layout::NOT_IN_TOC)
min_toclevel_ = toclevel;
LYXERR(Debug::TCLASS, "Minimum TocLevel is " << min_toclevel_
<< ", maximum is " << max_toclevel_);
- return !error;
+ return (error ? ERROR : OK);
}
case FT_TYPE:
lexrc.next();
type = lexrc.getString();
- if (floatlist_->typeExist(type)) {
- Floating const & fl = floatlist_->getType(type);
+ if (floatlist_.typeExist(type)) {
+ Floating const & fl = floatlist_.getType(type);
placement = fl.placement();
ext = fl.ext();
within = fl.within();
if (getout) {
Floating fl(type, placement, ext, within,
style, name, listName, builtin);
- floatlist_->newFloat(fl);
+ floatlist_.newFloat(fl);
// each float has its own counter
- counters_->newCounter(from_ascii(type), from_ascii(within),
+ counters_.newCounter(from_ascii(type), from_ascii(within),
docstring(), docstring());
+ // also define sub-float counters
+ docstring const subtype = "sub-" + from_ascii(type);
+ counters_.newCounter(subtype, from_ascii(type),
+ "\\alph{" + subtype + "}", docstring());
}
lexrc.popTable();
case CT_NAME:
lexrc.next();
name = lexrc.getDocString();
- if (counters_->hasCounter(name))
+ if (counters_.hasCounter(name))
LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
else
LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
// Here if have a full counter if getout == true
if (getout)
- counters_->newCounter(name, within,
+ counters_.newCounter(name, within,
labelstring, labelstring_appendix);
lexrc.popTable();
}
-FontInfo const & TextClass::defaultfont() const
+bool TextClass::hasLayout(docstring const & n) const
{
- return defaultfont_;
-}
-
+ docstring const name = n.empty() ? defaultLayoutName() : n;
-docstring const & TextClass::leftmargin() const
-{
- return leftmargin_;
+ return find_if(layoutlist_.begin(), layoutlist_.end(),
+ LayoutNamesEqual(name))
+ != layoutlist_.end();
}
-docstring const & TextClass::rightmargin() const
+
+Layout const & TextClass::operator[](docstring const & name) const
{
- return rightmargin_;
-}
+ BOOST_ASSERT(!name.empty());
+ const_iterator it =
+ find_if(begin(), end(), LayoutNamesEqual(name));
-bool TextClass::hasLayout(docstring const & n) const
-{
- docstring const name = n.empty() ? defaultLayoutName() : n;
+ if (it == end()) {
+ lyxerr << "We failed to find the layout '" << to_utf8(name)
+ << "' in the layout list. You MUST investigate!"
+ << endl;
+ for (const_iterator cit = begin(); cit != end(); ++cit)
+ lyxerr << " " << to_utf8(cit->name()) << endl;
- return find_if(layoutlist_.begin(), layoutlist_.end(),
- LayoutNamesEqual(name))
- != layoutlist_.end();
-}
+ // we require the name to exist
+ BOOST_ASSERT(false);
+ }
+ return *it;
+}
-LayoutPtr const & TextClass::operator[](docstring const & name) const
+Layout & TextClass::operator[](docstring const & name)
{
BOOST_ASSERT(!name.empty());
- LayoutList::const_iterator cit =
- find_if(layoutlist_.begin(),
- layoutlist_.end(),
- LayoutNamesEqual(name));
+ iterator it = find_if(begin(), end(), LayoutNamesEqual(name));
- if (cit == layoutlist_.end()) {
+ if (it == end()) {
lyxerr << "We failed to find the layout '" << to_utf8(name)
<< "' in the layout list. You MUST investigate!"
<< endl;
- for (LayoutList::const_iterator it = layoutlist_.begin();
- it != layoutlist_.end(); ++it)
- lyxerr << " " << to_utf8(it->get()->name()) << endl;
+ for (const_iterator cit = begin(); cit != end(); ++cit)
+ lyxerr << " " << to_utf8(cit->name()) << endl;
// we require the name to exist
BOOST_ASSERT(false);
}
- return *cit;
+ return *it;
}
}
-FloatList & TextClass::floats()
-{
- return *floatlist_.get();
-}
-
-
-FloatList const & TextClass::floats() const
-{
- return *floatlist_.get();
-}
-
-
-Counters & TextClass::counters() const
-{
- return *counters_.get();
-}
-
-
-// Return the layout object of an inset given by name. If the name
-// is not found as such, the part after the ':' is stripped off, and
-// searched again. In this way, an error fallback can be provided:
-// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
-// will invoke the layout object defined by name = 'CharStyle'.
-// If that doesn't work either, an empty object returns (shouldn't
-// happen). -- Idea JMarc, comment MV
-InsetLayout const & TextClass::insetLayout(docstring const & name) const
+InsetLayout const & DocumentClass::insetLayout(docstring const & name) const
{
docstring n = name;
+ InsetLayouts::const_iterator cen = insetlayoutlist_.end();
while (!n.empty()) {
- if (insetlayoutlist_.count(n) > 0)
- return insetlayoutlist_[n];
+ InsetLayouts::const_iterator cit = insetlayoutlist_.lower_bound(n);
+ if (cit != cen && cit->first == n)
+ return cit->second;
size_t i = n.find(':');
if (i == string::npos)
break;
}
-LayoutPtr const & TextClass::defaultLayout() const
+Layout const & TextClass::defaultLayout() const
{
return operator[](defaultLayoutName());
}
-string const & TextClass::name() const
+bool TextClass::isDefaultLayout(Layout const & lay) const
{
- return name_;
+ return lay.name() == defaultLayoutName();
}
-string const & TextClass::latexname() const
+bool TextClass::isEmptyLayout(Layout const & lay) const
{
- // No buffer path information is needed here because on-demand layout files
- // have already been loaded, and no path is needed for system layouts.
- const_cast<TextClass*>(this)->load();
- return latexname_;
+ return lay.name() == emptyLayoutName();
}
-string const & TextClass::description() const
+DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass)
{
- return description_;
-}
-
-
-string const & TextClass::opt_fontsize() const
-{
- return opt_fontsize_;
-}
-
-
-string const & TextClass::opt_pagestyle() const
-{
- return opt_pagestyle_;
-}
-
-
-string const & TextClass::options() const
-{
- return options_;
-}
-
-
-string const & TextClass::class_header() const
-{
- return class_header_;
-}
-
-
-string const & TextClass::pagestyle() const
-{
- return pagestyle_;
-}
-
-
-docstring const & TextClass::preamble() const
-{
- return preamble_;
-}
-
-
-PageSides TextClass::sides() const
-{
- return sides_;
+ DocumentClass * dc = new DocumentClass(baseClass);
+ tc_list_.push_back(dc);
+ return *tc_list_.back();
}
-int TextClass::secnumdepth() const
+DocumentClassBundle & DocumentClassBundle::get()
{
- return secnumdepth_;
+ static DocumentClassBundle singleton;
+ return singleton;
}
-int TextClass::tocdepth() const
-{
- return tocdepth_;
-}
+DocumentClass::DocumentClass(LayoutFile const & tc)
+ : TextClass(tc)
+{}
-OutputType TextClass::outputType() const
+bool DocumentClass::hasLaTeXLayout(std::string const & lay) const
{
- return outputType_;
+ LayoutList::const_iterator it = layoutlist_.begin();
+ LayoutList::const_iterator end = layoutlist_.end();
+ for (; it != end; ++it)
+ if (it->latexname() == lay)
+ return true;
+ return false;
}
-bool TextClass::provides(string const & p) const
+bool DocumentClass::provides(string const & p) const
{
return provides_.find(p) != provides_.end();
}
-unsigned int TextClass::columns() const
-{
- return columns_;
-}
-
-
-TitleLatexType TextClass::titletype() const
-{
- return titletype_;
-}
-
-
-string const & TextClass::titlename() const
-{
- return titlename_;
-}
-
-
-int TextClass::size() const
-{
- return layoutlist_.size();
-}
-
-
-int TextClass::min_toclevel() const
-{
- return min_toclevel_;
-}
-
-
-int TextClass::max_toclevel() const
-{
- return max_toclevel_;
-}
-
-
-bool TextClass::hasTocLevels() const
+bool DocumentClass::hasTocLevels() const
{
return min_toclevel_ != Layout::NOT_IN_TOC;
}
-DocumentClass & DocumentClassBundle::newClass(TextClass const & baseClass)
-{
- DocumentClass dc(baseClass);
- tc_list_.push_back(dc);
- return tc_list_.back();
-}
-
-
-DocumentClassBundle & DocumentClassBundle::get()
-{
- static DocumentClassBundle singleton;
- return singleton;
-}
-
-
-DocumentClass::DocumentClass(TextClass const & tc)
- : TextClass(tc)
-{}
-
-
ostream & operator<<(ostream & os, PageSides p)
{
switch (p) {
projects / lyx.git / blobdiff