]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.cpp
Add comment.
[lyx.git] / src / TextClass.cpp
index 6bc0bc0c8e65aded738618c509014955e8c4588b..9cf75a7669debf447b09e46b512a6c7b877954f6 100644 (file)
@@ -30,7 +30,6 @@
 
 #include "support/lassert.h"
 #include "support/debug.h"
-#include "support/ExceptionMessage.h"
 #include "support/FileName.h"
 #include "support/filetools.h"
 #include "support/gettext.h"
@@ -50,6 +49,19 @@ using namespace lyx::support;
 
 namespace lyx {
 
+// Keep the changes documented in the Customization manual. 
+//
+// If you change this format, then you MUST also make sure that
+// your changes do not invalidate the hardcoded layout file in 
+// LayoutFile.cpp. Additions will never do so, but syntax changes
+// could. See LayoutFileList::addEmptyClass() and, especially, the
+// definition of the layoutpost string. 
+// You should also run (or ask someone who has bash to run) the
+// development/updatelayouts.sh script, to update the format of 
+// all of our layout files.
+//
+int const LAYOUT_FORMAT = 30;
+       
 namespace {
 
 class LayoutNamesEqual : public unary_function<Layout, bool> {
@@ -65,9 +77,6 @@ private:
        docstring name_;
 };
 
-// Keep the changes documented in the Customization manual. 
-int const FORMAT = 26;
-
 
 bool layout2layout(FileName const & filename, FileName const & tempfile)
 {
@@ -95,7 +104,7 @@ bool layout2layout(FileName const & filename, FileName const & tempfile)
 }
 
 
-string translateRT(TextClass::ReadType rt) 
+string translateReadType(TextClass::ReadType rt) 
 {
        switch (rt) {
        case TextClass::BASECLASS:
@@ -247,7 +256,7 @@ namespace {
 
 bool TextClass::convertLayoutFormat(support::FileName const & filename, ReadType rt)
 {
-       LYXERR(Debug::TCLASS, "Converting layout file to " << FORMAT);
+       LYXERR(Debug::TCLASS, "Converting layout file to " << LAYOUT_FORMAT);
        FileName const tempfile = FileName::tempName("convert_layout");
        bool success = layout2layout(filename, tempfile);
        if (success)
@@ -265,8 +274,8 @@ TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, Re
                return ERROR;
        }
 
-       LYXERR(Debug::TCLASS, "Reading " + translateRT(rt) + ": " +
-               to_utf8(makeDisplayPath(filename.absFilename())));
+       LYXERR(Debug::TCLASS, "Reading " + translateReadType(rt) + ": " +
+               to_utf8(makeDisplayPath(filename.absFileName())));
 
        // Define the plain layout used in table cells, ert, etc. Note that 
        // we do this before loading any layout file, so that classes can 
@@ -278,8 +287,8 @@ TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, Re
        lexrc.setFile(filename);
        ReturnValues retval = read(lexrc, rt);
        
-       LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " +
-                       to_utf8(makeDisplayPath(filename.absFilename())));
+       LYXERR(Debug::TCLASS, "Finished reading " + translateReadType(rt) + ": " +
+                       to_utf8(makeDisplayPath(filename.absFileName())));
 
        return retval;
 }
@@ -294,7 +303,7 @@ bool TextClass::read(FileName const & filename, ReadType rt)
        bool const worx = convertLayoutFormat(filename, rt);
        if (!worx) {
                LYXERR0 ("Unable to convert " << filename << 
-                       " to format " << FORMAT);
+                       " to format " << LAYOUT_FORMAT);
                return false;
        }
        return true;
@@ -332,7 +341,7 @@ bool TextClass::read(std::string const & str, ReadType rt)
        bool const worx = convertLayoutFormat(tempfile, rt);
        if (!worx) {
                LYXERR0("Unable to convert internal layout information to format " 
-                       << FORMAT);
+                       << LAYOUT_FORMAT);
        }
        tempfile.removeFile();
        return worx;
@@ -342,10 +351,12 @@ bool TextClass::read(std::string const & str, ReadType rt)
 // Reads a textclass structure from file.
 TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt) 
 {
-       bool error = !lexrc.isOK();
+       if (!lexrc.isOK())
+               return ERROR;
 
        // Format of files before the 'Format' tag was introduced
        int format = 1;
+       bool error = false;
 
        // parsing
        while (lexrc.isOK() && !error) {
@@ -405,8 +416,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                                        lexrc.printError("Could not find input file: " + inc);
                                        error = true;
                                } else if (!read(tmp, MERGE)) {
-                                       lexrc.printError("Error reading input"
-                                                        "file: " + tmp.absFilename());
+                                       lexrc.printError("Error reading input file: " + tmp.absFileName());
                                        error = true;
                                }
                        }
@@ -434,7 +444,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        if (name.empty()) {
                                string s = "Could not read name for style: `$$Token' "
                                        + lexrc.getString() + " is probably not valid UTF-8!";
-                               lexrc.printError(s.c_str());
+                               lexrc.printError(s);
                                Layout lay;
                                // Since we couldn't read the name, we just scan the rest
                                // of the style and discard it.
@@ -456,10 +466,10 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                                }
                        }
                        else {
+                               // this was an ifstyle where we didn't have the style
                                // scan the rest and discard it
                                Layout lay;
                                readStyle(lexrc, lay);
-                               error = false;
                        }
 
                        // reset flag
@@ -614,12 +624,13 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        if (name.empty()) {
                                string s = "Could not read name for InsetLayout: `$$Token' "
                                        + lexrc.getString() + " is probably not valid UTF-8!";
-                               lexrc.printError(s.c_str());
+                               lexrc.printError(s);
                                InsetLayout il;
                                // Since we couldn't read the name, we just scan the rest
                                // of the style and discard it.
                                il.read(lexrc, *this);
-                               error = true;
+                               // Let's try to continue rather than abort.
+                               // error = true;
                        } else if (hasInsetLayout(name)) {
                                InsetLayout & il = insetlayoutlist_[name];
                                error = !il.read(lexrc, *this);
@@ -634,7 +645,7 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                }
 
                case TC_FLOAT:
-                       readFloat(lexrc);
+                       error = !readFloat(lexrc);
                        break;
                
                case TC_CITEFORMAT:
@@ -682,22 +693,24 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                        break;
                } // end of switch
 
-               //Note that this is triggered the first time through the loop unless
-               //we hit a format tag.
-               if (format != FORMAT)
-                       break;
+               // Note that this is triggered the first time through the loop unless
+               // we hit a format tag.
+               if (format != LAYOUT_FORMAT)
+                       return FORMAT_MISMATCH;
        }
 
-       if (format != FORMAT)
-               return FORMAT_MISMATCH;
+       // at present, we abort if we encounter an error,
+       // so there is no point continuing.
+       if (error)
+               return ERROR;
 
-       if (rt != BASECLASS) 
+       if (rt != BASECLASS)
                return (error ? ERROR : OK);
 
        if (defaultlayout_.empty()) {
                LYXERR0("Error: Textclass '" << name_
                                                << "' is missing a defaultstyle.");
-               error = true;
+               return ERROR;
        }
                
        // Try to erase "stdinsets" from the provides_ set. 
@@ -715,11 +728,11 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                FileName tmp = libFileSearch("layouts", "stdinsets.inc");
 
                if (tmp.empty()) {
-                       throw ExceptionMessage(WarningException, _("Missing File"),
+                       frontend::Alert::warning(_("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"),
+                       frontend::Alert::warning(_("Corrupt File"),
                                _("Could not read stdinsets.inc! This may lead to data loss!"));
                        error = true;
                }
@@ -824,7 +837,8 @@ void TextClass::readClassOptions(Lexer & lexrc)
                case Lexer::LEX_UNDEF:
                        lexrc.printError("Unknown ClassOption tag `$$Token'");
                        continue;
-               default: break;
+               default:
+                       break;
                }
                switch (le) {
                case CO_FONTSIZE:
@@ -837,7 +851,10 @@ void TextClass::readClassOptions(Lexer & lexrc)
                        break;
                case CO_OTHER:
                        lexrc.next();
-                       options_ = lexrc.getString();
+                       if (options_.empty())
+                               options_ = lexrc.getString();
+                       else
+                               options_ += ',' + lexrc.getString();
                        break;
                case CO_HEADER:
                        lexrc.next();
@@ -874,7 +891,7 @@ void TextClass::readCiteFormat(Lexer & lexrc)
 }
 
 
-void TextClass::readFloat(Lexer & lexrc)
+bool TextClass::readFloat(Lexer & lexrc)
 {
        enum {
                FT_TYPE = 1,
@@ -933,7 +950,8 @@ void TextClass::readFloat(Lexer & lexrc)
                case Lexer::LEX_UNDEF:
                        lexrc.printError("Unknown float tag `$$Token'");
                        continue;
-               default: break;
+               default:
+                       break;
                }
                switch (le) {
                case FT_TYPE:
@@ -1008,6 +1026,8 @@ void TextClass::readFloat(Lexer & lexrc)
                }
        }
 
+       lexrc.popTable();
+
        // Here we have a full float if getout == true
        if (getout) {
                if (!needsfloat && listcommand.empty())
@@ -1026,8 +1046,7 @@ void TextClass::readFloat(Lexer & lexrc)
                counters_.newCounter(subtype, from_ascii(type),
                                      "\\alph{" + subtype + "}", docstring());
        }
-
-       lexrc.popTable();
+       return getout;
 }
 
 
@@ -1138,10 +1157,11 @@ bool TextClass::load(string const & path) const
 
        if (!loaded_) {
                lyxerr << "Error reading `"
-                      << to_utf8(makeDisplayPath(layout_file.absFilename()))
+                      << to_utf8(makeDisplayPath(layout_file.absFileName()))
                       << "'\n(Check `" << name_
                       << "')\nCheck your installation and "
-                       "try Options/Reconfigure..." << endl;
+                         "try Options/Reconfigure..." 
+                      << endl;
        }
 
        return loaded_;
@@ -1274,8 +1294,7 @@ DocumentClass & DocumentClassBundle::makeDocumentClass(
                                                "this document but has not been found in the list of\n"
                                                "available modules. If you recently installed it, you\n"
                                                "probably need to reconfigure LyX.\n"), from_utf8(modName));
-                       ExceptionMessage(WarningException,_("Module not available"),
-                                       msg + _("Some layouts may not be available."));
+                       frontend::Alert::warning(_("Module not available"), msg);
                        continue;
                }
                if (!lm->isAvailable()) {
@@ -1283,13 +1302,13 @@ DocumentClass & DocumentClassBundle::makeDocumentClass(
                                                bformat(_("The module %1$s requires a package that is\n"
                                                "not available in your LaTeX installation. LaTeX output\n"
                                                "may not be possible.\n"), from_utf8(modName));
-                       ExceptionMessage(WarningException, _("Package not available"), msg);
+                       frontend::Alert::warning(_("Package not available"), msg);
                }
                FileName layout_file = libFileSearch("layouts", lm->getFilename());
                if (!doc_class.read(layout_file, TextClass::MODULE)) {
                        docstring const msg =
                                                bformat(_("Error reading module %1$s\n"), from_utf8(modName));
-                       throw ExceptionMessage(WarningException, _("Read Error"), msg);
+                       frontend::Alert::warning(_("Read Error"), msg);
                }
        }
        return doc_class;