]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.cpp
Push latest Andre's changes toward their true direction:
[lyx.git] / src / TextClass.cpp
index 2a4d69d0c78ecb27b6eda7f9002720b9666c89aa..f1b1df7eaab855ac78b1d13843d9f45479f23ac1 100644 (file)
 #include <config.h>
 
 #include "TextClass.h"
-#include "debug.h"
-#include "Lexer.h"
+
+#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 "frontends/alert.h"
 
 #include "support/filetools.h"
 #include "support/os.h"
 
-#include <boost/filesystem/operations.hpp>
-namespace fs = boost::filesystem;
-
 #include <sstream>
 
+using std::endl;
+using std::find_if;
+using std::remove_if;
+using std::string;
+using std::ostream;
 
 namespace lyx {
 
@@ -45,21 +50,16 @@ using support::rtrim;
 using support::subst;
 using support::addName;
 
-using std::endl;
-using std::find_if;
-using std::remove_if;
-using std::string;
-using std::ostream;
-
+extern FontInfo lyxRead(Lexer &, FontInfo const & fi = sane_font);
 
 namespace {
 
-class LayoutNamesEqual : public std::unary_function<Layout_ptr, bool> {
+class LayoutNamesEqual : public std::unary_function<LayoutPtr, bool> {
 public:
        LayoutNamesEqual(docstring const & name)
                : name_(name)
        {}
-       bool operator()(Layout_ptr const & c) const
+       bool operator()(LayoutPtr const & c) const
        {
                return c->name() == name_;
        }
@@ -107,13 +107,14 @@ TextClass::TextClass(string const & fn, string const & cln,
          floatlist_(new FloatList), counters_(new Counters),
          texClassAvail_(texClassAvail)
 {
+       modular_ = false;
        outputType_ = LATEX;
        columns_ = 1;
        sides_ = OneSide;
        secnumdepth_ = 3;
        tocdepth_ = 3;
        pagestyle_ = "default";
-       defaultfont_ = Font(Font::ALL_SANE);
+       defaultfont_ = sane_font;
        opt_fontsize_ = "10|11|12";
        opt_pagestyle_ = "empty|plain|headings|fancy";
        titletype_ = TITLE_COMMAND_AFTER;
@@ -128,7 +129,7 @@ bool TextClass::isTeXClassAvailable() const
 }
 
 
-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;
        if (!lay.read(lexrc, *this)) {
@@ -173,9 +174,9 @@ enum TextClassTags {
 
 
 // Reads a textclass structure from file.
-bool TextClass::read(FileName const & filename, bool merge)
+bool TextClass::read(FileName const & filename, ReadType rt)
 {
-       if (!support::isFileReadable(filename)) {
+       if (!filename.isFileReadable()) {
                lyxerr << "Cannot read layout file `" << filename << "'."
                       << endl;
                return true;
@@ -208,14 +209,21 @@ bool TextClass::read(FileName const & filename, bool merge)
                { "tocdepth",        TC_TOCDEPTH }
        };
 
-       if (!merge)
-               LYXERR(Debug::TCLASS) << "Reading textclass "
-                                     << to_utf8(makeDisplayPath(filename.absFilename()))
-                                     << endl;
-       else
-               LYXERR(Debug::TCLASS) << "Reading input file "
-                                     << to_utf8(makeDisplayPath(filename.absFilename()))
-                                     << endl;
+       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) << to_utf8(makeDisplayPath(filename.absFilename()))
+               << endl;
 
        Lexer lexrc(textClassTags,
                sizeof(textClassTags) / sizeof(textClassTags[0]));
@@ -264,7 +272,7 @@ bool TextClass::read(FileName const & filename, bool merge)
                                        lexrc.printError("Could not find input"
                                                         "file: " + inc);
                                        error = true;
-                               } else if (read(tmp, true)) {
+                               } else if (read(tmp, MERGE)) {
                                        lexrc.printError("Error reading input"
                                                         "file: " + tmp.absFilename());
                                        error = true;
@@ -290,16 +298,16 @@ bool TextClass::read(FileName const & filename, bool merge)
                                                + lexrc.getString() + " is probably not valid UTF-8!";
                                        lexrc.printError(s.c_str());
                                        Layout lay;
-                                       error = do_readStyle(lexrc, lay);
+                                       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))
@@ -324,7 +332,7 @@ bool TextClass::read(FileName const & filename, bool merge)
                        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"
@@ -358,11 +366,11 @@ bool TextClass::read(FileName const & filename, bool merge)
                        break;
 
                case TC_DEFAULTFONT:
-                       defaultfont_.lyxRead(lexrc);
+                       defaultfont_ = lyxRead(lexrc);
                        if (!defaultfont_.resolved()) {
                                lexrc.printError("Warning: defaultfont should "
                                                 "be fully instantiated!");
-                               defaultfont_.realize(Font(Font::ALL_SANE));
+                               defaultfont_.realize(sane_font);
                        }
                        break;
 
@@ -441,12 +449,20 @@ bool TextClass::read(FileName const & filename, bool merge)
                FileName const tempfile(support::tempName());
                error = !layout2layout(filename, tempfile);
                if (!error)
-                       error = read(tempfile, merge);
+                       error = read(tempfile, rt);
                support::unlink(tempfile);
                return error;
        }
 
-       if (!merge) { // we are at top level here.
+       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;
@@ -476,10 +492,7 @@ bool TextClass::read(FileName const & filename, bool merge)
                        << "Minimum TocLevel is " << min_toclevel_
                        << ", maximum is " << max_toclevel_ <<endl;
 
-       } else
-               LYXERR(Debug::TCLASS) << "Finished reading input file "
-                                     << to_utf8(makeDisplayPath(filename.absFilename()))
-                                     << endl;
+       }
 
        return error;
 }
@@ -501,7 +514,7 @@ void TextClass::readTitleType(Lexer & lexrc)
                return;
        case TITLE_COMMAND_AFTER:
        case TITLE_ENVIRONMENT:
-               titletype_ = static_cast<LYX_TITLE_LATEX_TYPES>(le);
+               titletype_ = static_cast<TitleLatexType>(le);
                break;
        default:
                lyxerr << "Unhandled value " << le
@@ -598,12 +611,20 @@ void TextClass::readClassOptions(Lexer & lexrc)
 
 enum InsetLayoutTags {
        IL_FONT = 1,
+       IL_BGCOLOR,
+       IL_DECORATION,
+       IL_FREESPACING,
+       IL_FORCELTR,
        IL_LABELFONT,
        IL_LABELSTRING,
        IL_LATEXNAME,
        IL_LATEXPARAM,
        IL_LATEXTYPE,
        IL_LYXTYPE,
+       IL_KEEPEMPTY,
+       IL_MULTIPAR,
+       IL_NEEDPROTECT,
+       IL_PASSTHRU,
        IL_PREAMBLE,
        IL_END
 };
@@ -612,14 +633,22 @@ enum InsetLayoutTags {
 void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
 {
        keyword_item elementTags[] = {
+               { "bgcolor", IL_BGCOLOR },
+               { "decoration", IL_DECORATION },
                { "end", IL_END },
                { "font", IL_FONT },
+               { "forceltr", IL_FORCELTR },
+               { "freespacing", IL_FREESPACING },
+               { "keepempty", IL_KEEPEMPTY },
                { "labelfont", IL_LABELFONT },
                { "labelstring", IL_LABELSTRING },
                { "latexname", IL_LATEXNAME },
                { "latexparam", IL_LATEXPARAM },
                { "latextype", IL_LATEXTYPE },
                { "lyxtype", IL_LYXTYPE },
+               { "multipar", IL_MULTIPAR },
+               { "needprotect", IL_NEEDPROTECT },
+               { "passthru", IL_PASSTHRU },
                { "preamble", IL_PREAMBLE }
        };
 
@@ -628,11 +657,19 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
        string lyxtype;
        docstring labelstring;
        string latextype;
+       string decoration;
        string latexname;
        string latexparam;
-       Font font(Font::ALL_INHERIT);
-       Font labelfont(Font::ALL_INHERIT);
+       FontInfo font = inherit_font;
+       FontInfo labelfont = inherit_font;
+       ColorCode bgcolor(Color_background);
        string preamble;
+       bool multipar = false;
+       bool passthru = false;
+       bool needprotect = false;
+       bool keepempty = false;
+       bool freespacing = false;
+       bool forceltr = false;
 
        bool getout = false;
        while (!getout && lexrc.isOK()) {
@@ -656,6 +693,10 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
                        lexrc.next();
                        labelstring = lexrc.getDocString();
                        break;
+               case IL_DECORATION:
+                       lexrc.next();
+                       decoration = lexrc.getString();
+                       break;
                case IL_LATEXNAME:
                        lexrc.next();
                        latexname = lexrc.getString();
@@ -665,14 +706,43 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
                        latexparam = subst(lexrc.getString(), "&quot;", "\"");
                        break;
                case IL_LABELFONT:
-                       labelfont.lyxRead(lexrc);
-                       labelfont.realize(defaultfont());
+                       labelfont = lyxRead(lexrc, inherit_font);
+                       break;
+               case IL_FORCELTR:
+                       lexrc.next();
+                       forceltr = lexrc.getBool();
+                       break;
+               case IL_MULTIPAR:
+                       lexrc.next();
+                       multipar = lexrc.getBool();
+                       break;
+               case IL_PASSTHRU:
+                       lexrc.next();
+                       passthru = lexrc.getBool();
+                       break;
+               case IL_KEEPEMPTY:
+                       lexrc.next();
+                       keepempty = lexrc.getBool();
+                       break;
+               case IL_FREESPACING:
+                       lexrc.next();
+                       freespacing = lexrc.getBool();
+                       break;
+               case IL_NEEDPROTECT:
+                       lexrc.next();
+                       needprotect = lexrc.getBool();
                        break;
                case IL_FONT:
-                       font.lyxRead(lexrc);
-                       font.realize(defaultfont());
+                       font = lyxRead(lexrc, inherit_font);
+                       // So: define font before labelfont
                        labelfont = font;
                        break;
+               case IL_BGCOLOR: {
+                       lexrc.next();
+                       string const token = lexrc.getString();
+                       bgcolor = lcolor.getFromLyXName(token);
+                       break;
+               }
                case IL_PREAMBLE:
                        preamble = lexrc.getLongString("EndPreamble");
                        break;
@@ -682,25 +752,30 @@ void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
                }
        }
 
-       //
        // 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;
+               // 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;
                insetlayoutlist_[name] = il;
-
-               // test name for CS:
-               if (il.lyxtype == "charstyle") {
-                       charstyles().push_back(il);
-               }
        }
 
        lexrc.popTable();
@@ -897,7 +972,7 @@ void TextClass::readCounter(Lexer & lexrc)
 }
 
 
-Font const & TextClass::defaultfont() const
+FontInfo const & TextClass::defaultfont() const
 {
        return defaultfont_;
 }
@@ -926,7 +1001,7 @@ bool TextClass::hasLayout(docstring const & n) const
 
 
 
-Layout_ptr const & TextClass::operator[](docstring const & name) const
+LayoutPtr const & TextClass::operator[](docstring const & name) const
 {
        BOOST_ASSERT(!name.empty());
 
@@ -947,12 +1022,11 @@ Layout_ptr 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())
                return false;
@@ -978,7 +1052,7 @@ bool TextClass::load(string const & path) const
        FileName layout_file;
        if (!path.empty())
                layout_file = FileName(addName(path, name_ + ".layout"));
-       if (layout_file.empty() || !fs::exists(layout_file.toFilesystemEncoding()))
+       if (layout_file.empty() || !layout_file.exists())
                layout_file = libFileSearch("layouts", name_, "layout");
        loaded_ = const_cast<TextClass*>(this)->read(layout_file) == 0;
 
@@ -1011,6 +1085,14 @@ 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 
 {
        docstring n = name;
@@ -1022,23 +1104,15 @@ InsetLayout const & TextClass::insetlayout(docstring const & name) const
                        break;
                n = n.substr(0,i);
        }
-       static const InsetLayout empty;
+       static InsetLayout empty;
+       empty.labelstring = from_utf8("UNDEFINED");
+       empty.labelfont = sane_font;
+       empty.labelfont.setColor(Color_error);
+       empty.bgcolor = Color_error;
        return empty;
 }
 
 
-CharStyles::iterator TextClass::charstyle(string const & s) const
-{
-       CharStyles::iterator cs = charstyles().begin();
-       CharStyles::iterator csend = charstyles().end();
-       for (; cs != csend; ++cs) {
-               if (cs->name == s)
-                       return cs;
-       }
-       return csend;
-}
-
-
 docstring const & TextClass::defaultLayoutName() const
 {
        // This really should come from the actual layout... (Lgb)
@@ -1046,7 +1120,7 @@ docstring const & TextClass::defaultLayoutName() const
 }
 
 
-Layout_ptr const & TextClass::defaultLayout() const
+LayoutPtr const & TextClass::defaultLayout() const
 {
        return operator[](defaultLayoutName());
 }
@@ -1107,7 +1181,7 @@ docstring const & TextClass::preamble() const
 }
 
 
-TextClass::PageSides TextClass::sides() const
+PageSides TextClass::sides() const
 {
        return sides_;
 }
@@ -1143,7 +1217,7 @@ unsigned int TextClass::columns() const
 }
 
 
-LYX_TITLE_LATEX_TYPES TextClass::titletype() const
+TitleLatexType TextClass::titletype() const
 {
        return titletype_;
 }
@@ -1179,13 +1253,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;
        }