]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.cpp
This is the first of a series of commits that will make InsetLayout a real class.
[lyx.git] / src / TextClass.cpp
index 16928031332bb1282a10d17074c7e69a618234c5..2dbd10b6f364d82d679f1fbb29f47afc33c5241a 100644 (file)
 
 #include "Color.h"
 #include "Counters.h"
-#include "debug.h"
-#include "gettext.h"
 #include "Floating.h"
 #include "FloatList.h"
 #include "Layout.h"
 #include "Lexer.h"
+#include "Font.h"
 
 #include "frontends/alert.h"
 
-#include "support/lstrings.h"
-#include "support/lyxlib.h"
+#include "support/debug.h"
+#include "support/ExceptionMessage.h"
+#include "support/FileName.h"
 #include "support/filetools.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
 #include "support/os.h"
 
 #include <sstream>
 
-using std::endl;
-using std::find_if;
-using std::remove_if;
-using std::string;
-using std::ostream;
+using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
-using support::FileName;
-using support::libFileSearch;
-using support::makeDisplayPath;
-using support::quoteName;
-using support::rtrim;
-using support::subst;
-using support::addName;
-
-extern FontInfo lyxRead(Lexer &, FontInfo const & fi = sane_font);
-
 namespace {
 
-class LayoutNamesEqual : public std::unary_function<LayoutPtr, bool> {
+class LayoutNamesEqual : public unary_function<LayoutPtr, bool> {
 public:
        LayoutNamesEqual(docstring const & name)
                : name_(name)
@@ -68,7 +57,7 @@ private:
 };
 
 
-int const FORMAT = 5;
+int const FORMAT = 6;
 
 
 bool layout2layout(FileName const & filename, FileName const & tempfile)
@@ -80,16 +69,16 @@ bool layout2layout(FileName const & filename, FileName const & tempfile)
                return false;
        }
 
-       std::ostringstream command;
-       command << support::os::python() << ' ' << quoteName(script.toFilesystemEncoding())
+       ostringstream command;
+       command << os::python() << ' ' << quoteName(script.toFilesystemEncoding())
                << ' ' << quoteName(filename.toFilesystemEncoding())
                << ' ' << quoteName(tempfile.toFilesystemEncoding());
        string const command_str = command.str();
 
-       LYXERR(Debug::TCLASS) << "Running `" << command_str << '\'' << endl;
+       LYXERR(Debug::TCLASS, "Running `" << command_str << '\'');
 
-       support::cmd_ret const ret =
-               support::runCommand(command_str);
+       cmd_ret const ret =
+               runCommand(command_str);
        if (ret.first != 0) {
                lyxerr << "Could not run layout conversion "
                          "script layout2layout.py." << endl;
@@ -98,6 +87,21 @@ bool layout2layout(FileName const & filename, FileName const & tempfile)
        return true;
 }
 
+
+std::string translateRT(TextClass::ReadType rt) 
+{
+       switch (rt) {
+       case TextClass::BASECLASS:
+               return "textclass";
+       case TextClass::MERGE:
+               return "input file";
+       case TextClass::MODULE:
+               return "module file";
+       }
+       // shutup warning
+       return string();
+}
+
 } // namespace anon
 
 
@@ -120,28 +124,37 @@ TextClass::TextClass(string const & fn, string const & cln,
        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_;
 }
 
 
-bool TextClass::do_readStyle(Lexer & lexrc, Layout & lay)
+bool TextClass::readStyle(Lexer & lexrc, Layout & lay)
 {
-       LYXERR(Debug::TCLASS) << "Reading style " << to_utf8(lay.name()) << endl;
+       LYXERR(Debug::TCLASS, "Reading style " << to_utf8(lay.name()));
        if (!lay.read(lexrc, *this)) {
-               // Resolve fonts
-               lay.resfont = lay.font;
-               lay.resfont.realize(defaultfont());
-               lay.reslabelfont = lay.labelfont;
-               lay.reslabelfont.realize(defaultfont());
-               return false; // no errors
+               lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl;
+               return false;
        }
-       lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl;
-       return true;
+       // Resolve fonts
+       lay.resfont = lay.font;
+       lay.resfont.realize(defaultfont());
+       lay.reslabelfont = lay.labelfont;
+       lay.reslabelfont.realize(defaultfont());
+       return true; // no errors
 }
 
 
@@ -162,6 +175,7 @@ enum TextClassTags {
        TC_CLASSOPTIONS,
        TC_PREAMBLE,
        TC_PROVIDES,
+       TC_REQUIRES,
        TC_LEFTMARGIN,
        TC_RIGHTMARGIN,
        TC_FLOAT,
@@ -176,10 +190,10 @@ enum TextClassTags {
 // Reads a textclass structure from file.
 bool TextClass::read(FileName const & filename, ReadType rt)
 {
-       if (!filename.isFileReadable()) {
+       if (!filename.isReadableFile()) {
                lyxerr << "Cannot read layout file `" << filename << "'."
                       << endl;
-               return true;
+               return false;
        }
 
        keyword_item textClassTags[] = {
@@ -200,6 +214,7 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                { "pagestyle",       TC_PAGESTYLE },
                { "preamble",        TC_PREAMBLE },
                { "provides",        TC_PROVIDES },
+               { "requires",        TC_REQUIRES },
                { "rightmargin",     TC_RIGHTMARGIN },
                { "secnumdepth",     TC_SECNUMDEPTH },
                { "sides",           TC_SIDES },
@@ -209,21 +224,32 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                { "tocdepth",        TC_TOCDEPTH }
        };
 
-       switch (rt) {
-       case BASECLASS:
-               LYXERR(Debug::TCLASS) << "Reading textclass ";
-               break;
-       case MERGE:
-               LYXERR(Debug::TCLASS) << "Reading input file ";
-         break;
-       case MODULE:
-               LYXERR(Debug::TCLASS) << "Reading module file ";
-               break;
-       default:
-               BOOST_ASSERT(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) {
+               static char const * s = "Margin Static\n"
+                       "LatexType Paragraph\n"
+                       "LatexName dummy\n"
+                       "Align Block\n"
+                       "AlignPossible Left, Right, Center\n"
+                       "LabelType No_Label\n"
+                       "End";
+               istringstream ss(s);
+               Lexer lex(textClassTags, sizeof(textClassTags) / sizeof(textClassTags[0]));
+               lex.setStream(ss);
+               Layout lay;
+               lay.setName(emptylayout_);
+               if (!readStyle(lex, lay)) {
+                       // 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)));
        }
-       LYXERR(Debug::TCLASS) << to_utf8(makeDisplayPath(filename.absFilename()))
-               << endl;
 
        Lexer lexrc(textClassTags,
                sizeof(textClassTags) / sizeof(textClassTags[0]));
@@ -269,10 +295,9 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                                                            "layout");
 
                                if (tmp.empty()) {
-                                       lexrc.printError("Could not find input"
-                                                        "file: " + inc);
+                                       lexrc.printError("Could not find input file: " + inc);
                                        error = true;
-                               } else if (read(tmp, MERGE)) {
+                               } else if (!read(tmp, MERGE)) {
                                        lexrc.printError("Error reading input"
                                                         "file: " + tmp.absFilename());
                                        error = true;
@@ -298,31 +323,34 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                                                + lexrc.getString() + " is probably not valid UTF-8!";
                                        lexrc.printError(s.c_str());
                                        Layout lay;
-                                       error = do_readStyle(lexrc, 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?
+                                       error = !readStyle(lexrc, lay);
                                } else if (hasLayout(name)) {
                                        Layout * lay = operator[](name).get();
-                                       error = do_readStyle(lexrc, *lay);
+                                       error = !readStyle(lexrc, *lay);
                                } else {
                                        Layout lay;
                                        lay.setName(name);
                                        if (le == TC_ENVIRONMENT)
                                                lay.is_environment = true;
-                                       error = do_readStyle(lexrc, lay);
+                                       error = !readStyle(lexrc, lay);
                                        if (!error)
-                                               layoutlist_.push_back(
-                                                       boost::shared_ptr<Layout>(new Layout(lay))
-                                                       );
+                                               layoutlist_.push_back(boost::shared_ptr<Layout>(new Layout(lay)));
 
                                        if (defaultlayout_.empty()) {
-                                               // We do not have a default
-                                               // layout yet, so we choose
-                                               // the first layout we
-                                               // encounter.
+                                               // We do not have a default layout yet, so we choose
+                                               // the first layout we encounter.
                                                defaultlayout_ = name;
                                        }
                                }
                        }
                        else {
+                               //FIXME Should we also eat the style here? viz:
+                               //Layout lay;
+                               //readStyle(lexrc, lay);
+                               //as above...
                                lexrc.printError("No name given for style: `$$Token'.");
                                error = true;
                        }
@@ -332,11 +360,9 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                        if (lexrc.next()) {
                                docstring const style = from_utf8(subst(lexrc.getString(),
                                                     '_', ' '));
-                               if (!delete_layout(style))
+                               if (!deleteLayout(style))
                                        lyxerr << "Cannot delete style `"
                                               << to_utf8(style) << '\'' << endl;
-//                                     lexrc.printError("Cannot delete style"
-//                                                      " `$$Token'");
                        }
                        break;
 
@@ -384,7 +410,7 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                        tocdepth_ = lexrc.getInteger();
                        break;
 
-                       // First step to support options
+               // First step to support options
                case TC_CLASSOPTIONS:
                        readClassOptions(lexrc);
                        break;
@@ -404,6 +430,14 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                        break;
                }
 
+               case TC_REQUIRES: {
+                       lexrc.eatLine();
+                       vector<string> const req 
+                               = getVectorFromString(lexrc.getString());
+                       requires_.insert(req.begin(), req.end());
+                       break;
+               }
+
                case TC_LEFTMARGIN:     // left margin type
                        if (lexrc.next())
                                leftmargin_ = lexrc.getDocString();
@@ -413,25 +447,31 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                        if (lexrc.next())
                                rightmargin_ = lexrc.getDocString();
                        break;
+
                case TC_INSETLAYOUT:
                        if (lexrc.next()) {
                                docstring const name = subst(lexrc.getDocString(), '_', ' ');
                                readInsetLayout(lexrc, name);
                        }
                        break;
+
                case TC_FLOAT:
                        readFloat(lexrc);
                        break;
+
                case TC_COUNTER:
                        readCounter(lexrc);
                        break;
+
                case TC_TITLELATEXTYPE:
                        readTitleType(lexrc);
                        break;
+
                case TC_TITLELATEXNAME:
                        if (lexrc.next())
                                titlename_ = lexrc.getString();
                        break;
+
                case TC_NOFLOAT:
                        if (lexrc.next()) {
                                string const nofloat = lexrc.getString();
@@ -439,62 +479,81 @@ bool TextClass::read(FileName const & filename, ReadType rt)
                        }
                        break;
                }
+
+               //Note that this is triggered the first time through the loop unless
+               //we hit a format tag.
                if (format != FORMAT)
                        break;
        }
 
        if (format != FORMAT) {
-               LYXERR(Debug::TCLASS) << "Converting layout file from format "
-                                     << format << " to " << FORMAT << endl;
-               FileName const tempfile(support::tempName());
+               LYXERR(Debug::TCLASS, "Converting layout file from format "
+                                     << format << " to " << FORMAT);
+               FileName const tempfile = FileName::tempName();
                error = !layout2layout(filename, tempfile);
                if (!error)
                        error = read(tempfile, rt);
-               support::unlink(tempfile);
-               return error;
+               tempfile.removeFile();
+               return !error;
        }
 
-       if (rt == MODULE) 
-               LYXERR(Debug::TCLASS) << "Finished reading module file "
-                               << to_utf8(makeDisplayPath(filename.absFilename()))
-                               << endl;
-       else if (rt == MERGE)
-               LYXERR(Debug::TCLASS) << "Finished reading input file "
-                               << to_utf8(makeDisplayPath(filename.absFilename()))
-                               << endl;
-       else { // we are at top level here.
-               LYXERR(Debug::TCLASS) << "Finished reading textclass "
-                                     << to_utf8(makeDisplayPath(filename.absFilename()))
-                                     << endl;
-               if (defaultlayout_.empty()) {
-                       lyxerr << "Error: Textclass '" << name_
-                              << "' is missing a defaultstyle." << endl;
+       LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " +
+                       to_utf8(makeDisplayPath(filename.absFilename())));
+
+       if (rt != BASECLASS) 
+               return !error;
+
+       if (defaultlayout_.empty()) {
+               lyxerr << "Error: Textclass '" << name_
+                                               << "' is missing a defaultstyle." << endl;
+               error = true;
+       }
+               
+       //Try to erase "stdinsets" from the provides_ set. 
+       //The
+       //  Provides stdinsets 1
+       //declaration simply tells us that the standard insets have been
+       //defined. (It's found in stdinsets.inc but could also be used in
+       //user-defined files.) There isn't really any such package. So we
+       //might as well go ahead and erase it.
+       //If we do not succeed, then it was not there, which means that
+       //the textclass did not provide the definitions of the standard
+       //insets. So we need to try to load them.
+       int erased = provides_.erase("stdinsets");
+       if (!erased) {
+               FileName tmp = libFileSearch("layouts", "stdinsets.inc");
+
+               if (tmp.empty()) {
+                       throw ExceptionMessage(WarningException, _("Missing File"),
+                               _("Could not find stdinsets.inc! This may lead to data loss!"));
+                       error = true;
+               } else if (!read(tmp, MERGE)) {
+                       throw ExceptionMessage(WarningException, _("Corrupt File"),
+                               _("Could not read stdinsets.inc! This may lead to data loss!"));
                        error = true;
                }
+       }
 
-               min_toclevel_ = Layout::NOT_IN_TOC;
-               max_toclevel_ = Layout::NOT_IN_TOC;
-               const_iterator cit = begin();
-               const_iterator the_end = end();
-               for ( ; cit != the_end ; ++cit) {
-                       int const toclevel = (*cit)->toclevel;
-                       if (toclevel != Layout::NOT_IN_TOC) {
-                               if (min_toclevel_ == Layout::NOT_IN_TOC)
-                                       min_toclevel_ = toclevel;
-                               else
-                                       min_toclevel_ = std::min(min_toclevel_,
-                                                        toclevel);
-                               max_toclevel_ = std::max(max_toclevel_,
-                                                        toclevel);
-                       }
+       min_toclevel_ = Layout::NOT_IN_TOC;
+       max_toclevel_ = Layout::NOT_IN_TOC;
+       const_iterator cit = begin();
+       const_iterator the_end = end();
+       for ( ; cit != the_end ; ++cit) {
+               int const toclevel = (*cit)->toclevel;
+               if (toclevel != Layout::NOT_IN_TOC) {
+                       if (min_toclevel_ == Layout::NOT_IN_TOC)
+                               min_toclevel_ = toclevel;
+                       else
+                               min_toclevel_ = min(min_toclevel_,
+                                                       toclevel);
+                       max_toclevel_ = max(max_toclevel_,
+                                                       toclevel);
                }
-               LYXERR(Debug::TCLASS)
-                       << "Minimum TocLevel is " << min_toclevel_
-                       << ", maximum is " << max_toclevel_ <<endl;
-
        }
+       LYXERR(Debug::TCLASS, "Minimum TocLevel is " << min_toclevel_
+               << ", maximum is " << max_toclevel_);
 
-       return error;
+       return !error;
 }
 
 
@@ -626,6 +685,7 @@ enum InsetLayoutTags {
        IL_NEEDPROTECT,
        IL_PASSTHRU,
        IL_PREAMBLE,
+       IL_REQUIRES,
        IL_END
 };
 
@@ -649,7 +709,8 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
                { "multipar", IL_MULTIPAR },
                { "needprotect", IL_NEEDPROTECT },
                { "passthru", IL_PASSTHRU },
-               { "preamble", IL_PREAMBLE }
+               { "preamble", IL_PREAMBLE },
+               { "requires", IL_REQUIRES }
        };
 
        lexrc.pushTable(elementTags, IL_END);
@@ -664,6 +725,7 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
        FontInfo labelfont = inherit_font;
        ColorCode bgcolor(Color_background);
        string preamble;
+       set<string> requires;
        bool multipar = false;
        bool passthru = false;
        bool needprotect = false;
@@ -676,7 +738,7 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
                int le = lexrc.lex();
                switch (le) {
                case Lexer::LEX_UNDEF:
-                       lexrc.printError("Unknown ClassOption tag `$$Token'");
+                       lexrc.printError("Unknown InsetLayout tag `$$Token'");
                        continue;
                default: break;
                }
@@ -746,33 +808,43 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
                case IL_PREAMBLE:
                        preamble = lexrc.getLongString("EndPreamble");
                        break;
+               case IL_REQUIRES: {
+                       lexrc.eatLine();
+                       vector<string> const req 
+                               = getVectorFromString(lexrc.getString());
+                       requires.insert(req.begin(), req.end());
+                       break;
+               }
                case IL_END:
                        getout = true;
                        break;
                }
        }
 
-       //
        // Here add element to list if getout == true
        if (getout) {
                InsetLayout il;
-               il.name = to_ascii(name);
-               il.lyxtype = lyxtype;
-               il.labelstring = labelstring;
-               il.decoration = decoration;
-               il.latextype = latextype;
-               il.latexname = latexname;
-               il.latexparam = latexparam;
-               il.multipar = multipar;
-               il.passthru = passthru;
-               il.needprotect = needprotect;
-               il.freespacing = freespacing;
-               il.forceltr = forceltr;
-               il.keepempty = keepempty;
-               il.font = font;
-               il.labelfont = labelfont;
-               il.bgcolor = bgcolor;           
-               il.preamble = preamble;
+               il.name_ = to_ascii(name);
+               il.lyxtype_ = lyxtype;
+               il.labelstring_ = labelstring;
+               il.decoration_ = decoration;
+               il.latextype_ = latextype;
+               il.latexname_ = latexname;
+               il.latexparam_ = latexparam;
+               il.multipar_ = multipar;
+               il.passthru_ = passthru;
+               il.needprotect_ = needprotect;
+               il.freespacing_ = freespacing;
+               il.forceltr_ = forceltr;
+               il.keepempty_ = keepempty;
+               il.font_ = font;
+               // The label font is generally used as-is without
+               // any realization against a given context.
+               labelfont.realize(sane_font);
+               il.labelfont_ = labelfont;
+               il.bgcolor_ = bgcolor;
+               il.preamble_ = preamble;
+               il.requires_ = requires;
                insetlayoutlist_[name] = il;
        }
 
@@ -824,7 +896,7 @@ void TextClass::readFloat(Lexer & lexrc)
                int le = lexrc.lex();
                switch (le) {
                case Lexer::LEX_UNDEF:
-                       lexrc.printError("Unknown ClassOption tag `$$Token'");
+                       lexrc.printError("Unknown float tag `$$Token'");
                        continue;
                default: break;
                }
@@ -901,6 +973,7 @@ enum CounterTags {
        CT_END
 };
 
+
 void TextClass::readCounter(Lexer & lexrc)
 {
        keyword_item counterTags[] = {
@@ -923,7 +996,7 @@ void TextClass::readCounter(Lexer & lexrc)
                int le = lexrc.lex();
                switch (le) {
                case Lexer::LEX_UNDEF:
-                       lexrc.printError("Unknown ClassOption tag `$$Token'");
+                       lexrc.printError("Unknown counter tag `$$Token'");
                        continue;
                default: break;
                }
@@ -932,13 +1005,9 @@ void TextClass::readCounter(Lexer & lexrc)
                        lexrc.next();
                        name = lexrc.getDocString();
                        if (counters_->hasCounter(name))
-                               LYXERR(Debug::TCLASS) 
-                                       << "Reading existing counter " 
-                                       << to_utf8(name) << endl;
+                               LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
                        else
-                               LYXERR(Debug::TCLASS) 
-                                       << "Reading new counter " 
-                                       << to_utf8(name) << endl;
+                               LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
                        break;
                case CT_WITHIN:
                        lexrc.next();
@@ -1020,14 +1089,13 @@ LayoutPtr const & TextClass::operator[](docstring const & name) const
                BOOST_ASSERT(false);
        }
 
-       return (*cit);
+       return *cit;
 }
 
 
-
-bool TextClass::delete_layout(docstring const & name)
+bool TextClass::deleteLayout(docstring const & name)
 {
-       if (name == defaultLayoutName())
+       if (name == defaultLayoutName() || name == emptyLayoutName())
                return false;
 
        LayoutList::iterator it =
@@ -1053,7 +1121,7 @@ bool TextClass::load(string const & path) const
                layout_file = FileName(addName(path, name_ + ".layout"));
        if (layout_file.empty() || !layout_file.exists())
                layout_file = libFileSearch("layouts", name_, "layout");
-       loaded_ = const_cast<TextClass*>(this)->read(layout_file) == 0;
+       loaded_ = const_cast<TextClass*>(this)->read(layout_file);
 
        if (!loaded_) {
                lyxerr << "Error reading `"
@@ -1103,10 +1171,7 @@ InsetLayout const & TextClass::insetlayout(docstring const & name) const
                        break;
                n = n.substr(0,i);
        }
-       static InsetLayout empty;
-       empty.labelstring = from_utf8("UNDEFINED");
-       empty.bgcolor = Color_error;
-       return empty;
+       return empty_insetlayout_;
 }
 
 
@@ -1178,7 +1243,7 @@ docstring const & TextClass::preamble() const
 }
 
 
-TextClass::PageSides TextClass::sides() const
+PageSides TextClass::sides() const
 {
        return sides_;
 }
@@ -1250,13 +1315,13 @@ bool TextClass::hasTocLevels() const
 }
 
 
-ostream & operator<<(ostream & os, TextClass::PageSides p)
+ostream & operator<<(ostream & os, PageSides p)
 {
        switch (p) {
-       case TextClass::OneSide:
+       case OneSide:
                os << '1';
                break;
-       case TextClass::TwoSides:
+       case TwoSides:
                os << '2';
                break;
        }