]> git.lyx.org Git - lyx.git/blobdiff - src/TextClass.cpp
New XHTML math options. Format change.
[lyx.git] / src / TextClass.cpp
index 0cf0372b793d9896a8863179b37d69485ef38dae..bbf54cc946ac9c72760aa643207289a2d9af3fbb 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"
@@ -66,7 +65,7 @@ private:
 };
 
 // Keep the changes documented in the Customization manual. 
-int const FORMAT = 24;
+int const FORMAT = 26;
 
 
 bool layout2layout(FileName const & filename, FileName const & tempfile)
@@ -95,7 +94,7 @@ bool layout2layout(FileName const & filename, FileName const & tempfile)
 }
 
 
-std::string translateRT(TextClass::ReadType rt) 
+string translateRT(TextClass::ReadType rt) 
 {
        switch (rt) {
        case TextClass::BASECLASS:
@@ -197,7 +196,8 @@ enum TextClassTags {
        TC_DEFAULTMODULE,
        TC_PROVIDESMODULE,
        TC_EXCLUDESMODULE,
-       TC_HTMLTOCSECTION
+       TC_HTMLTOCSECTION,
+       TC_CITEFORMAT
 };
 
 
@@ -206,6 +206,7 @@ namespace {
        LexerKeyword textClassTags[] = {
                { "addtohtmlpreamble", TC_ADDTOHTMLPREAMBLE },
                { "addtopreamble",     TC_ADDTOPREAMBLE },
+               { "citeformat",        TC_CITEFORMAT },
                { "classoptions",      TC_CLASSOPTIONS },
                { "columns",           TC_COLUMNS },
                { "counter",           TC_COUNTER },
@@ -264,7 +265,7 @@ TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, Re
        }
 
        LYXERR(Debug::TCLASS, "Reading " + translateRT(rt) + ": " +
-               to_utf8(makeDisplayPath(filename.absFilename())));
+               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 
@@ -277,7 +278,7 @@ TextClass::ReturnValues TextClass::readWithoutConv(FileName const & filename, Re
        ReturnValues retval = read(lexrc, rt);
        
        LYXERR(Debug::TCLASS, "Finished reading " + translateRT(rt) + ": " +
-                       to_utf8(makeDisplayPath(filename.absFilename())));
+                       to_utf8(makeDisplayPath(filename.absFileName())));
 
        return retval;
 }
@@ -340,10 +341,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) {
@@ -403,8 +406,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;
                                }
                        }
@@ -432,7 +434,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.
@@ -454,10 +456,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
@@ -612,12 +614,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);
@@ -632,7 +635,11 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
                }
 
                case TC_FLOAT:
-                       readFloat(lexrc);
+                       error = !readFloat(lexrc);
+                       break;
+               
+               case TC_CITEFORMAT:
+                       readCiteFormat(lexrc);
                        break;
 
                case TC_IFCOUNTER:
@@ -676,22 +683,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.
+               // Note that this is triggered the first time through the loop unless
+               // we hit a format tag.
                if (format != FORMAT)
-                       break;
+                       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. 
@@ -709,11 +718,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;
                }
@@ -818,7 +827,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:
@@ -831,7 +841,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();
@@ -846,7 +859,29 @@ void TextClass::readClassOptions(Lexer & lexrc)
 }
 
 
-void TextClass::readFloat(Lexer & lexrc)
+void TextClass::readCiteFormat(Lexer & lexrc)
+{
+       string etype;
+       string definition;
+       while (lexrc.isOK()) {
+               lexrc.next();
+               etype = lexrc.getString();
+               if (!lexrc.isOK() || compare_ascii_no_case(etype, "end") == 0)
+                       break;
+               lexrc.eatLine();
+               definition = lexrc.getString();
+               char initchar = etype[0];
+               if (initchar == '#')
+                       continue;
+               if (initchar == '!' || initchar == '_')
+                       cite_macros_[etype] = definition;
+               else
+                       cite_formats_[etype] = definition;
+       }
+}
+
+
+bool TextClass::readFloat(Lexer & lexrc)
 {
        enum {
                FT_TYPE = 1,
@@ -861,6 +896,7 @@ void TextClass::readFloat(Lexer & lexrc)
                FT_HTMLATTR,
                FT_HTMLTAG,
                FT_LISTCOMMAND,
+               FT_REFPREFIX,
                FT_END
        };
 
@@ -876,6 +912,7 @@ void TextClass::readFloat(Lexer & lexrc)
                { "needsfloatpkg", FT_NEEDSFLOAT },
                { "numberwithin", FT_WITHIN },
                { "placement", FT_PLACEMENT },
+               { "refprefix", FT_REFPREFIX },
                { "style", FT_STYLE },
                { "type", FT_TYPE }
        };
@@ -886,10 +923,11 @@ void TextClass::readFloat(Lexer & lexrc)
        string htmlattr;
        string htmlstyle;
        string htmltag;
-       string listName;
-       string listCommand;
+       string listname;
+       string listcommand;
        string name;
        string placement;
+       string refprefix;
        string style;
        string type;
        string within;
@@ -902,7 +940,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:
@@ -915,9 +954,10 @@ void TextClass::readFloat(Lexer & lexrc)
                                within = fl.within();
                                style = fl.style();
                                name = fl.name();
-                               listName = fl.listName();
+                               listname = fl.listName();
                                needsfloat = fl.needsFloatPkg();
-                               listCommand = fl.listCommand();
+                               listcommand = fl.listCommand();
+                               refprefix = fl.refPrefix();
                        } 
                        break;
                case FT_NAME:
@@ -944,11 +984,15 @@ void TextClass::readFloat(Lexer & lexrc)
                        break;
                case FT_LISTCOMMAND:
                        lexrc.next();
-                       listCommand = lexrc.getString();
+                       listcommand = lexrc.getString();
+                       break;
+               case FT_REFPREFIX:
+                       lexrc.next();
+                       refprefix = lexrc.getString();
                        break;
                case FT_LISTNAME:
                        lexrc.next();
-                       listName = lexrc.getString();
+                       listname = lexrc.getString();
                        break;
                case FT_NEEDSFLOAT:
                        lexrc.next();
@@ -972,15 +1016,17 @@ void TextClass::readFloat(Lexer & lexrc)
                }
        }
 
+       lexrc.popTable();
+
        // Here we have a full float if getout == true
        if (getout) {
-               if (!needsfloat && listCommand.empty())
+               if (!needsfloat && listcommand.empty())
                        LYXERR0("The layout does not provide a list command " <<
                                "for the builtin float `" << type << "'. LyX will " <<
                                "not be able to produce a float list.");
                Floating fl(type, placement, ext, within, style, name, 
-                               listName, listCommand, htmltag, htmlattr, htmlstyle
-                               needsfloat);
+                               listname, listcommand, refprefix
+                               htmltag, htmlattr, htmlstyle, needsfloat);
                floatlist_.newFloat(fl);
                // each float has its own counter
                counters_.newCounter(from_ascii(type), from_ascii(within),
@@ -990,11 +1036,19 @@ void TextClass::readFloat(Lexer & lexrc)
                counters_.newCounter(subtype, from_ascii(type),
                                      "\\alph{" + subtype + "}", docstring());
        }
-
-       lexrc.popTable();
+       return getout;
 }
 
 
+string const & TextClass::prerequisites() const
+{ 
+       if (contains(prerequisites_, ',')) {
+               vector<string> const pres = getVectorFromString(prerequisites_);
+               prerequisites_ = getStringFromVector(pres, "\n\t");
+       }
+       return prerequisites_; 
+}
+
 bool TextClass::hasLayout(docstring const & n) const
 {
        docstring const name = n.empty() ? defaultLayoutName() : n;
@@ -1093,10 +1147,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_;
@@ -1229,8 +1284,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()) {
@@ -1238,13 +1292,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;
@@ -1311,6 +1365,27 @@ Layout const & DocumentClass::htmlTOCLayout() const
 }
 
 
+string const & DocumentClass::getCiteFormat(string const & entry_type) const
+{
+       static string default_format = N_("{%author%[[%author%, ]][[{%editor%[[%editor%, ed., ]]}]]}\"%title%\"{%journal%[[, {!<i>!}%journal%{!</i>!}]][[{%publisher%[[, %publisher%]][[{%institution%[[, %institution%]]}]]}]]}{%year%[[ (%year%)]]}{%pages%[[, %pages%]]}.");
+       
+       map<string, string>::const_iterator it = cite_formats_.find(entry_type);
+       if (it != cite_formats_.end())
+               return it->second;
+       return default_format;
+}
+
+
+string const & DocumentClass::getCiteMacro(string const & macro) const
+{
+       static string empty;
+       map<string, string>::const_iterator it = cite_macros_.find(macro);
+       if (it != cite_macros_.end())
+               return it->second;
+       return empty;
+}
+
+
 /////////////////////////////////////////////////////////////////////////
 //
 // PageSides