X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Flyxtextclass.C;h=cdda271a71d942a40660e246fcc891867197cc9d;hb=ce7c45bb437c44dae15f96148cb9b793ab0b895c;hp=462e9ed74c58c21a820afd09e37ca41f02d239c8;hpb=fc7c77587f85368b5ef86d75fe4c202c1f58a158;p=lyx.git diff --git a/src/lyxtextclass.C b/src/lyxtextclass.C index 462e9ed74c..cdda271a71 100644 --- a/src/lyxtextclass.C +++ b/src/lyxtextclass.C @@ -1,12 +1,15 @@ -/* This file is part of - * ====================================================== +/** + * \file lyxtextclass.C + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. * - * LyX, The Document Processor + * \author Lars Gullik Bjønnes + * \author Jean-Marc Lasgouttes + * \author Angus Leeming + * \author John Levon + * \author André Pönitz * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-2001 The LyX Team. - * - * ====================================================== + * Full author contact details are available in file CREDITS. */ #include @@ -15,44 +18,91 @@ #include "debug.h" #include "lyxlex.h" #include "counters.h" +#include "Floating.h" #include "FloatList.h" #include "support/lstrings.h" -#include "support/LAssert.h" -#include "support/lyxfunctional.h" +#include "support/lyxlib.h" #include "support/filetools.h" +#include "support/os.h" + +#include +namespace fs = boost::filesystem; + +#include -#include + +namespace lyx { + +using support::FileName; +using support::libFileSearch; +using support::makeDisplayPath; +using support::quoteName; +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; -namespace { // anon -struct compare_name { +namespace { - compare_name(string const & name) +class LayoutNamesEqual : public std::unary_function { +public: + LayoutNamesEqual(string const & name) : name_(name) {} - - bool operator()(boost::shared_ptr const & c) + bool operator()(LyXLayout_ptr const & c) const { return c->name() == name_; } - +private: string name_; - }; -} // anon + +int const FORMAT = 3; + + +bool layout2layout(FileName const & filename, FileName const & tempfile) +{ + FileName const script = libFileSearch("scripts", "layout2layout.py"); + if (script.empty()) { + lyxerr << "Could not find layout conversion " + "script layout2layout.py." << endl; + return false; + } + + std::ostringstream command; + command << support::os::python() << ' ' << quoteName(script.toFilesystemEncoding()) + << ' ' << quoteName(filename.toFilesystemEncoding()) + << ' ' << quoteName(tempfile.toFilesystemEncoding()); + string const command_str = command.str(); + + lyxerr[Debug::TCLASS] << "Running `" << command_str << '\'' << endl; + + support::cmd_ret const ret = + support::runCommand(command_str); + if (ret.first != 0) { + lyxerr << "Could not run layout conversion " + "script layout2layout.py." << endl; + return false; + } + return true; +} + +} // namespace anon LyXTextClass::LyXTextClass(string const & fn, string const & cln, string const & desc, bool texClassAvail ) : name_(fn), latexname_(cln), description_(desc), - floatlist_(new FloatList), ctrs_(new Counters), texClassAvail_(texClassAvail) + floatlist_(new FloatList), ctrs_(new Counters), + texClassAvail_(texClassAvail) { outputType_ = LATEX; columns_ = 1; @@ -60,14 +110,13 @@ LyXTextClass::LyXTextClass(string const & fn, string const & cln, secnumdepth_ = 3; tocdepth_ = 3; pagestyle_ = "default"; - maxcounter_ = LABEL_COUNTER_CHAPTER; defaultfont_ = LyXFont(LyXFont::ALL_SANE); opt_fontsize_ = "10|11|12"; opt_pagestyle_ = "empty|plain|headings|fancy"; provides_ = nothing; titletype_ = TITLE_COMMAND_AFTER; titlename_ = "maketitle"; - loaded = false; + loaded_ = false; } @@ -80,7 +129,7 @@ bool LyXTextClass::isTeXClassAvailable() const bool LyXTextClass::do_readStyle(LyXLex & lexrc, LyXLayout & lay) { lyxerr[Debug::TCLASS] << "Reading style " << lay.name() << endl; - if (!lay.Read(lexrc, *this)) { + if (!lay.read(lexrc, *this)) { // Resolve fonts lay.resfont = lay.font; lay.resfont.realize(defaultfont()); @@ -98,13 +147,13 @@ enum TextClassTags { TC_INPUT, TC_STYLE, TC_DEFAULTSTYLE, + TC_CHARSTYLE, TC_ENVIRONMENT, TC_NOSTYLE, TC_COLUMNS, TC_SIDES, TC_PAGESTYLE, TC_DEFAULTFONT, - TC_MAXCOUNTER, TC_SECNUMDEPTH, TC_TOCDEPTH, TC_CLASSOPTIONS, @@ -119,13 +168,22 @@ enum TextClassTags { TC_COUNTER, TC_NOFLOAT, TC_TITLELATEXNAME, - TC_TITLELATEXTYPE + TC_TITLELATEXTYPE, + TC_FORMAT }; + // Reads a textclass structure from file. -bool LyXTextClass::Read(string const & filename, bool merge) +bool LyXTextClass::read(FileName const & filename, bool merge) { + if (!support::isFileReadable(filename)) { + lyxerr << "Cannot read layout file `" << filename << "'." + << endl; + return true; + } + keyword_item textClassTags[] = { + { "charstyle", TC_CHARSTYLE }, { "classoptions", TC_CLASSOPTIONS }, { "columns", TC_COLUMNS }, { "counter", TC_COUNTER }, @@ -133,9 +191,9 @@ bool LyXTextClass::Read(string const & filename, bool merge) { "defaultstyle", TC_DEFAULTSTYLE }, { "environment", TC_ENVIRONMENT }, { "float", TC_FLOAT }, + { "format", TC_FORMAT }, { "input", TC_INPUT }, { "leftmargin", TC_LEFTMARGIN }, - { "maxcounter", TC_MAXCOUNTER }, { "nofloat", TC_NOFLOAT }, { "nostyle", TC_NOSTYLE }, { "outputtype", TC_OUTPUTTYPE }, @@ -156,19 +214,21 @@ bool LyXTextClass::Read(string const & filename, bool merge) if (!merge) lyxerr[Debug::TCLASS] << "Reading textclass " - << MakeDisplayPath(filename) - << endl; + << to_utf8(makeDisplayPath(filename.absFilename())) + << endl; else lyxerr[Debug::TCLASS] << "Reading input file " - << MakeDisplayPath(filename) + << to_utf8(makeDisplayPath(filename.absFilename())) << endl; LyXLex lexrc(textClassTags, sizeof(textClassTags) / sizeof(textClassTags[0])); - bool error = false; lexrc.setFile(filename); - if (!lexrc.isOK()) error = true; + bool error = !lexrc.isOK(); + + // Format of files before the 'Format' tag was introduced + int format = 1; // parsing while (lexrc.isOK() && !error) { @@ -189,19 +249,28 @@ bool LyXTextClass::Read(string const & filename, bool merge) switch (static_cast(le)) { + case TC_FORMAT: + if (lexrc.next()) + format = lexrc.getInteger(); + break; + case TC_OUTPUTTYPE: // output type definition readOutputType(lexrc); break; case TC_INPUT: // Include file if (lexrc.next()) { - string tmp = LibFileSearch("layouts", - lexrc.getString(), + string const inc = lexrc.getString(); + FileName tmp = libFileSearch("layouts", inc, "layout"); - if (Read(tmp, true)) { + if (tmp.empty()) { + lexrc.printError("Could not find input" + "file: " + inc); + error = true; + } else if (read(tmp, true)) { lexrc.printError("Error reading input" - "file: "+tmp); + "file: " + tmp.absFilename()); error = true; } } @@ -215,6 +284,7 @@ bool LyXTextClass::Read(string const & filename, bool merge) } break; + case TC_ENVIRONMENT: case TC_STYLE: if (lexrc.next()) { string const name = subst(lexrc.getString(), @@ -225,9 +295,14 @@ bool LyXTextClass::Read(string const & filename, bool merge) } else { LyXLayout lay; lay.setName(name); - if (!(error = do_readStyle(lexrc, lay))) - layoutlist_.push_back - (boost::shared_ptr(new LyXLayout(lay))); + if (le == TC_ENVIRONMENT) + lay.is_environment = true; + error = do_readStyle(lexrc, lay); + if (!error) + layoutlist_.push_back( + boost::shared_ptr(new LyXLayout(lay)) + ); + if (defaultlayout_.empty()) { // We do not have a default // layout yet, so we choose @@ -243,29 +318,6 @@ bool LyXTextClass::Read(string const & filename, bool merge) } break; - case TC_ENVIRONMENT: - if (lexrc.next()) { - string const name = subst(lexrc.getString(), - '_', ' '); - if (hasLayout(name)) { - LyXLayout * lay = operator[](name).get(); - error = do_readStyle(lexrc, *lay); - } else { - LyXLayout lay; - lay.setName(name); - if (!(error = do_readStyle(lexrc, lay))) - envlist_.push_back - (boost::shared_ptr(new LyXLayout(lay))); - else - lexrc.printError("Problems reading environment: `$$Token'."); - } - } - else { - lexrc.printError("No name given for style: `$$Token'."); - error = true; - } - break; - case TC_NOSTYLE: if (lexrc.next()) { string const style = subst(lexrc.getString(), @@ -312,10 +364,6 @@ bool LyXTextClass::Read(string const & filename, bool merge) } break; - case TC_MAXCOUNTER: - readMaxCounter(lexrc); - break; - case TC_SECNUMDEPTH: lexrc.next(); secnumdepth_ = lexrc.getInteger(); @@ -332,7 +380,7 @@ bool LyXTextClass::Read(string const & filename, bool merge) break; case TC_PREAMBLE: - preamble_ = lexrc.getLongString("EndPreamble"); + preamble_ = from_utf8(lexrc.getLongString("EndPreamble")); break; case TC_PROVIDESAMSMATH: @@ -364,6 +412,12 @@ bool LyXTextClass::Read(string const & filename, bool merge) if (lexrc.next()) rightmargin_ = lexrc.getString(); break; + case TC_CHARSTYLE: + if (lexrc.next()) { + string const name = subst(lexrc.getString(), '_', ' '); + readCharStyle(lexrc, name); + } + break; case TC_FLOAT: readFloat(lexrc); break; @@ -384,20 +438,54 @@ bool LyXTextClass::Read(string const & filename, bool merge) } break; } + if (format != FORMAT) + break; + } + + if (format != FORMAT) { + lyxerr[Debug::TCLASS] << "Converting layout file from format " + << format << " to " << FORMAT << endl; + FileName const tempfile(support::tempName()); + error = !layout2layout(filename, tempfile); + if (!error) + error = read(tempfile, merge); + support::unlink(tempfile); + return error; } if (!merge) { // we are at top level here. lyxerr[Debug::TCLASS] << "Finished reading textclass " - << MakeDisplayPath(filename) + << to_utf8(makeDisplayPath(filename.absFilename())) << endl; if (defaultlayout_.empty()) { lyxerr << "Error: Textclass '" << name_ << "' is missing a defaultstyle." << endl; error = true; } + + min_toclevel_ = LyXLayout::NOT_IN_TOC; + max_toclevel_ = LyXLayout::NOT_IN_TOC; + const_iterator cit = begin(); + const_iterator the_end = end(); + for ( ; cit != the_end ; ++cit) { + int const toclevel = (*cit)->toclevel; + if (toclevel != LyXLayout::NOT_IN_TOC) { + if (min_toclevel_ == LyXLayout::NOT_IN_TOC) + min_toclevel_ = toclevel; + else + min_toclevel_ = std::min(min_toclevel_, + toclevel); + max_toclevel_ = std::max(max_toclevel_, + toclevel); + } + } + lyxerr[Debug::TCLASS] + << "Minimum TocLevel is " << min_toclevel_ + << ", maximum is " << max_toclevel_ <(le); @@ -462,85 +548,11 @@ void LyXTextClass::readOutputType(LyXLex & lexrc) } -enum MaxCounterTags { - MC_COUNTER_CHAPTER = 1, - MC_COUNTER_SECTION, - MC_COUNTER_SUBSECTION, - MC_COUNTER_SUBSUBSECTION, - MC_COUNTER_PARAGRAPH, - MC_COUNTER_SUBPARAGRAPH, - MC_COUNTER_ENUMI, - MC_COUNTER_ENUMII, - MC_COUNTER_ENUMIII, - MC_COUNTER_ENUMIV -}; - - -void LyXTextClass::readMaxCounter(LyXLex & lexrc) -{ - keyword_item maxCounterTags[] = { - {"counter_chapter", MC_COUNTER_CHAPTER }, - {"counter_enumi", MC_COUNTER_ENUMI }, - {"counter_enumii", MC_COUNTER_ENUMII }, - {"counter_enumiii", MC_COUNTER_ENUMIII }, - {"counter_enumiv", MC_COUNTER_ENUMIV }, - {"counter_paragraph", MC_COUNTER_PARAGRAPH }, - {"counter_section", MC_COUNTER_SECTION }, - {"counter_subparagraph", MC_COUNTER_SUBPARAGRAPH }, - {"counter_subsection", MC_COUNTER_SUBSECTION }, - {"counter_subsubsection", MC_COUNTER_SUBSUBSECTION } - }; - - pushpophelper pph(lexrc, maxCounterTags, MC_COUNTER_ENUMIV); - - int le = lexrc.lex(); - switch (le) { - case LyXLex::LEX_UNDEF: - lexrc.printError("Unknown MaxCounter tag `$$Token'"); - return; - default: - break; - } - - switch (static_cast(le)) { - case MC_COUNTER_CHAPTER: - maxcounter_ = LABEL_COUNTER_CHAPTER; - break; - case MC_COUNTER_SECTION: - maxcounter_ = LABEL_COUNTER_SECTION; - break; - case MC_COUNTER_SUBSECTION: - maxcounter_ = LABEL_COUNTER_SUBSECTION; - break; - case MC_COUNTER_SUBSUBSECTION: - maxcounter_ = LABEL_COUNTER_SUBSUBSECTION; - break; - case MC_COUNTER_PARAGRAPH: - maxcounter_ = LABEL_COUNTER_PARAGRAPH; - break; - case MC_COUNTER_SUBPARAGRAPH: - maxcounter_ = LABEL_COUNTER_SUBPARAGRAPH; - break; - case MC_COUNTER_ENUMI: - maxcounter_ = LABEL_COUNTER_ENUMI; - break; - case MC_COUNTER_ENUMII: - maxcounter_ = LABEL_COUNTER_ENUMII; - break; - case MC_COUNTER_ENUMIII: - maxcounter_ = LABEL_COUNTER_ENUMIII; - break; - case MC_COUNTER_ENUMIV: - maxcounter_ = LABEL_COUNTER_ENUMIV; - break; - } -} - - enum ClassOptionsTags { CO_FONTSIZE = 1, CO_PAGESTYLE, CO_OTHER, + CO_HEADER, CO_END }; @@ -550,6 +562,7 @@ void LyXTextClass::readClassOptions(LyXLex & lexrc) keyword_item classOptionsTags[] = { {"end", CO_END }, {"fontsize", CO_FONTSIZE }, + {"header", CO_HEADER }, {"other", CO_OTHER }, {"pagestyle", CO_PAGESTYLE } }; @@ -577,6 +590,10 @@ void LyXTextClass::readClassOptions(LyXLex & lexrc) lexrc.next(); options_ = lexrc.getString(); break; + case CO_HEADER: + lexrc.next(); + class_header_ = subst(lexrc.getString(), """, "\""); + break; case CO_END: getout = true; break; @@ -585,6 +602,93 @@ void LyXTextClass::readClassOptions(LyXLex & lexrc) lexrc.popTable(); } +enum CharStyleTags { + CS_FONT = 1, + CS_LABELFONT, + CS_LATEXTYPE, + CS_LATEXNAME, + CS_LATEXPARAM, + CS_PREAMBLE, + CS_END +}; + + +void LyXTextClass::readCharStyle(LyXLex & lexrc, string const & name) +{ + keyword_item elementTags[] = { + { "end", CS_END }, + { "font", CS_FONT }, + { "labelfont", CS_LABELFONT }, + { "latexname", CS_LATEXNAME }, + { "latexparam", CS_LATEXPARAM }, + { "latextype", CS_LATEXTYPE }, + { "preamble", CS_PREAMBLE} + }; + + lexrc.pushTable(elementTags, CS_END); + + string latextype; + string latexname; + string latexparam; + LyXFont font(LyXFont::ALL_INHERIT); + LyXFont labelfont(LyXFont::ALL_INHERIT); + string preamble; + + bool getout = false; + while (!getout && lexrc.isOK()) { + int le = lexrc.lex(); + switch (le) { + case LyXLex::LEX_UNDEF: + lexrc.printError("Unknown ClassOption tag `$$Token'"); + continue; + default: break; + } + switch (static_cast(le)) { + case CS_LATEXTYPE: + lexrc.next(); + latextype = lexrc.getString(); + break; + case CS_LATEXNAME: + lexrc.next(); + latexname = lexrc.getString(); + break; + case CS_LATEXPARAM: + lexrc.next(); + latexparam = subst(lexrc.getString(), """, "\""); + break; + case CS_LABELFONT: + labelfont.lyxRead(lexrc); + break; + case CS_FONT: + font.lyxRead(lexrc); + labelfont = font; + break; + case CS_PREAMBLE: + preamble = lexrc.getLongString("EndPreamble"); + break; + case CS_END: + getout = true; + break; + } + } + + // + // Here add element to list if getout == true + if (getout) { + CharStyle cs; + cs.name = name; + cs.latextype = latextype; + cs.latexname = latexname; + cs.latexparam = latexparam; + cs.font = font; + cs.labelfont = labelfont; + cs.preamble = from_utf8(preamble); + charstyles().push_back(cs); + } + + lexrc.popTable(); +} + enum FloatTags { FT_TYPE = 1, @@ -598,6 +702,7 @@ enum FloatTags { FT_END }; + void LyXTextClass::readFloat(LyXLex & lexrc) { keyword_item floatTags[] = { @@ -702,8 +807,8 @@ void LyXTextClass::readCounter(LyXLex & lexrc) lexrc.pushTable(counterTags, CT_END); - string name; - string within; + docstring name; + docstring within; bool getout = false; while (!getout && lexrc.isOK()) { @@ -717,11 +822,11 @@ void LyXTextClass::readCounter(LyXLex & lexrc) switch (static_cast(le)) { case CT_NAME: lexrc.next(); - name = lexrc.getString(); + name = from_ascii(lexrc.getString()); break; case CT_WITHIN: lexrc.next(); - within = lexrc.getString(); + within = from_ascii(lexrc.getString()); if (within == "none") within.erase(); break; @@ -731,13 +836,12 @@ void LyXTextClass::readCounter(LyXLex & lexrc) } } - // Here if have a full float if getout == true + // Here if have a full counter if getout == true if (getout) { - if (within.empty()) { + if (within.empty()) ctrs_->newCounter(name); - } else { + else ctrs_->newCounter(name, within); - } } lexrc.popTable(); @@ -767,68 +871,37 @@ bool LyXTextClass::hasLayout(string const & n) const string const name = (n.empty() ? defaultLayoutName() : n); return find_if(layoutlist_.begin(), layoutlist_.end(), - compare_name(name)) + LayoutNamesEqual(name)) != layoutlist_.end(); } -LyXLayout_ptr const & LyXTextClass::operator[](string const & n) const -{ - lyx::Assert(!n.empty()); - - if (n.empty()) - lyxerr << "LyXTextClass::operator[] called with empty n" << endl; - - string const name = (n.empty() ? defaultLayoutName() : n); - - static string lastLayoutName; - static LayoutList::difference_type lastLayoutIndex; - if (name == lastLayoutName) - return layoutlist_[lastLayoutIndex]; +LyXLayout_ptr const & LyXTextClass::operator[](string const & name) const +{ + BOOST_ASSERT(!name.empty()); LayoutList::const_iterator cit = find_if(layoutlist_.begin(), layoutlist_.end(), - compare_name(name)); + LayoutNamesEqual(name)); if (cit == layoutlist_.end()) { lyxerr << "We failed to find the layout '" << name << "' in the layout list. You MUST investigate!" << endl; + for (LayoutList::const_iterator it = layoutlist_.begin(); + it != layoutlist_.end(); ++it) + lyxerr << " " << it->get()->name() << endl; // we require the name to exist - lyx::Assert(false); + BOOST_ASSERT(false); } - lastLayoutName = name; - lastLayoutIndex = std::distance(layoutlist_.begin(), cit); - return (*cit); } -LyXLayout_ptr const & LyXTextClass::getEnv(string const & name) const -{ - lyx::Assert(!name.empty()); - - if (name.empty()) - lyxerr << "LyXTextClass::getEnv() called with empty n" << endl; - - LayoutList::const_iterator cit = - find_if(envlist_.begin(), envlist_.end(), compare_name(name)); - - if (cit == envlist_.end()) { - lyxerr << "We failed to find the environment '" << name - << "' in the layout list. You MUST investigate!" - << endl; - // we require the name to exist - lyx::Assert(false); - } - - return *cit; -} - bool LyXTextClass::delete_layout(string const & name) { @@ -837,7 +910,7 @@ bool LyXTextClass::delete_layout(string const & name) LayoutList::iterator it = remove_if(layoutlist_.begin(), layoutlist_.end(), - compare_name(name)); + LayoutNamesEqual(name)); LayoutList::iterator end = layoutlist_.end(); bool const ret = (it != end); @@ -847,24 +920,28 @@ bool LyXTextClass::delete_layout(string const & name) // Load textclass info if not loaded yet -bool LyXTextClass::load() const +bool LyXTextClass::load(string const & path) const { - if (loaded) + if (loaded_) return true; - // Read style-file - string const real_file = LibFileSearch("layouts", name_, "layout"); + // Read style-file, provided path is searched before the system ones + FileName layout_file; + if (!path.empty()) + layout_file = FileName(addName(path, name_ + ".layout")); + if (layout_file.empty() || !fs::exists(layout_file.toFilesystemEncoding())) + layout_file = libFileSearch("layouts", name_, "layout"); + loaded_ = const_cast(this)->read(layout_file) == 0; - if (const_cast(this)->Read(real_file)) { + if (!loaded_) { lyxerr << "Error reading `" - << MakeDisplayPath(real_file) + << to_utf8(makeDisplayPath(layout_file.absFilename())) << "'\n(Check `" << name_ << "')\nCheck your installation and " "try Options/Reconfigure..." << endl; - loaded = false; } - loaded = true; - return loaded; + + return loaded_; } @@ -886,6 +963,18 @@ Counters & LyXTextClass::counters() const } +CharStyles::iterator LyXTextClass::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; +} + + string const & LyXTextClass::defaultLayoutName() const { // This really should come from the actual layout... (Lgb) @@ -936,13 +1025,19 @@ string const & LyXTextClass::options() const } +string const & LyXTextClass::class_header() const +{ + return class_header_; +} + + string const & LyXTextClass::pagestyle() const { return pagestyle_; } -string const & LyXTextClass::preamble() const +docstring const & LyXTextClass::preamble() const { return preamble_; } @@ -984,12 +1079,6 @@ unsigned int LyXTextClass::columns() const } -int LyXTextClass::maxcounter() const -{ - return maxcounter_; -} - - LYX_TITLE_LATEX_TYPES LyXTextClass::titletype() const { return titletype_; @@ -1002,12 +1091,27 @@ string const & LyXTextClass::titlename() const } +int LyXTextClass::size() const +{ + return layoutlist_.size(); +} +int LyXTextClass::min_toclevel() const +{ + return min_toclevel_; +} -int LyXTextClass::size() const + +int LyXTextClass::max_toclevel() const { - return layoutlist_.size(); + return max_toclevel_; +} + + +bool LyXTextClass::hasTocLevels() const +{ + return min_toclevel_ != LyXLayout::NOT_IN_TOC; } @@ -1023,3 +1127,6 @@ ostream & operator<<(ostream & os, LyXTextClass::PageSides p) } return os; } + + +} // namespace lyx