-/* 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 <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "lyxtextclass.h"
#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/filetools.h"
-#include <algorithm>
+using lyx::support::LibFileSearch;
+using lyx::support::MakeDisplayPath;
+using lyx::support::rtrim;
+using lyx::support::subst;
using std::endl;
using std::find_if;
using std::remove_if;
+using std::string;
using std::ostream;
-namespace { // anon
-struct compare_name {
- compare_name(string const & name)
- : name_(name) {}
- template <class C>
- bool operator()(C & c) {
+namespace {
+
+class LayoutNamesEqual : public std::unary_function<LyXLayout_ptr, bool> {
+public:
+ LayoutNamesEqual(string const & name)
+ : name_(name)
+ {}
+ bool operator()(LyXLayout_ptr const & c) const
+ {
return c->name() == name_;
}
+private:
string name_;
};
-} // anon
+} // namespace anon
LyXTextClass::LyXTextClass(string const & fn, string const & cln,
- string const & desc)
- : name_(fn), latexname_(cln), description_(desc)
+ string const & desc, bool texClassAvail )
+ : name_(fn), latexname_(cln), description_(desc),
+ floatlist_(new FloatList), ctrs_(new Counters),
+ texClassAvail_(texClassAvail)
{
outputType_ = LATEX;
columns_ = 1;
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;
- loaded = false;
+ titletype_ = TITLE_COMMAND_AFTER;
+ titlename_ = "maketitle";
+ loaded_ = false;
+}
+
+
+bool LyXTextClass::isTeXClassAvailable() const
+{
+ return texClassAvail_;
}
if (!lay.Read(lexrc, *this)) {
// Resolve fonts
lay.resfont = lay.font;
-#ifndef INHERIT_LANGUAGE
lay.resfont.realize(defaultfont());
lay.reslabelfont = lay.labelfont;
lay.reslabelfont.realize(defaultfont());
-#else
- lay.resfont.realize(defaultfont(), default_language);
- lay.reslabelfont = lay.labelfont;
- lay.reslabelfont.realize(defaultfont(), default_language);
-#endif
return false; // no errors
}
- lyxerr << "Error parsing style `" << lay.name() << "'" << endl;
+ lyxerr << "Error parsing style `" << lay.name() << '\'' << endl;
return true;
}
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,
TC_PROVIDESURL,
TC_LEFTMARGIN,
TC_RIGHTMARGIN,
- TC_FLOAT
+ TC_FLOAT,
+ TC_COUNTER,
+ TC_NOFLOAT,
+ TC_TITLELATEXNAME,
+ TC_TITLELATEXTYPE
};
-
// Reads a textclass structure from file.
bool LyXTextClass::Read(string const & filename, bool merge)
{
keyword_item textClassTags[] = {
+ { "charstyle", TC_CHARSTYLE },
{ "classoptions", TC_CLASSOPTIONS },
{ "columns", TC_COLUMNS },
+ { "counter", TC_COUNTER },
{ "defaultfont", TC_DEFAULTFONT },
{ "defaultstyle", TC_DEFAULTSTYLE },
+ { "environment", TC_ENVIRONMENT },
{ "float", TC_FLOAT },
{ "input", TC_INPUT },
{ "leftmargin", TC_LEFTMARGIN },
- { "maxcounter", TC_MAXCOUNTER },
+ { "nofloat", TC_NOFLOAT },
{ "nostyle", TC_NOSTYLE },
{ "outputtype", TC_OUTPUTTYPE },
{ "pagestyle", TC_PAGESTYLE },
{ "secnumdepth", TC_SECNUMDEPTH },
{ "sides", TC_SIDES },
{ "style", TC_STYLE },
+ { "titlelatexname", TC_TITLELATEXNAME },
+ { "titlelatextype", TC_TITLELATEXTYPE },
{ "tocdepth", TC_TOCDEPTH }
};
<< MakeDisplayPath(filename)
<< endl;
- LyXLex lexrc(textClassTags, TC_FLOAT);
+ LyXLex lexrc(textClassTags,
+ sizeof(textClassTags) / sizeof(textClassTags[0]));
bool error = false;
lexrc.setFile(filename);
// parsing
while (lexrc.isOK() && !error) {
int le = lexrc.lex();
+
switch (le) {
case LyXLex::LEX_FEOF:
continue;
lexrc.printError("Unknown TextClass tag `$$Token'");
error = true;
continue;
- default: break;
+
+ default:
+ break;
}
+
switch (static_cast<TextClassTags>(le)) {
+
case TC_OUTPUTTYPE: // output type definition
readOutputType(lexrc);
break;
}
break;
+ case TC_ENVIRONMENT:
case TC_STYLE:
if (lexrc.next()) {
string const name = subst(lexrc.getString(),
'_', ' ');
if (hasLayout(name)) {
- LyXLayout * lay =
- operator[](name).get();
+ LyXLayout * lay = operator[](name).get();
error = do_readStyle(lexrc, *lay);
} else {
LyXLayout lay;
lay.setName(name);
+ if (le == TC_ENVIRONMENT)
+ lay.is_environment = true;
if (!(error = do_readStyle(lexrc, lay)))
- layoutlist_.push_back(boost::shared_ptr<LyXLayout>(new LyXLayout(lay)));
+ layoutlist_.push_back(
+ boost::shared_ptr<LyXLayout>(new LyXLayout(lay))
+ );
+
if (defaultlayout_.empty()) {
// We do not have a default
// layout yet, so we choose
string const style = subst(lexrc.getString(),
'_', ' ');
if (!delete_layout(style))
- lyxerr << "Cannot delete style `" << style << "'" << endl;
+ lyxerr << "Cannot delete style `"
+ << style << '\'' << endl;
// lexrc.printError("Cannot delete style"
// " `$$Token'");
}
if (!defaultfont_.resolved()) {
lexrc.printError("Warning: defaultfont should "
"be fully instantiated!");
-#ifndef INHERIT_LANGUAGE
defaultfont_.realize(LyXFont(LyXFont::ALL_SANE));
-#else
- defaultfont_.realize(LyXFont(LyXFont::ALL_SANE),
- default_language);
-#endif
}
break;
- case TC_MAXCOUNTER:
- readMaxCounter(lexrc);
- break;
-
case TC_SECNUMDEPTH:
lexrc.next();
secnumdepth_ = lexrc.getInteger();
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;
+ 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();
+ floatlist_->erase(nofloat);
+ }
+ break;
}
}
}
+void LyXTextClass::readTitleType(LyXLex & lexrc)
+{
+ keyword_item titleTypeTags[] = {
+ { "commandafter", TITLE_COMMAND_AFTER },
+ { "environment", TITLE_ENVIRONMENT }
+ };
+
+ pushpophelper pph(lexrc, titleTypeTags, TITLE_ENVIRONMENT);
+
+ int le = lexrc.lex();
+ switch (le) {
+ case LyXLex::LEX_UNDEF:
+ lexrc.printError("Unknown output type `$$Token'");
+ return;
+ case TITLE_COMMAND_AFTER:
+ case TITLE_ENVIRONMENT:
+ titletype_ = static_cast<LYX_TITLE_LATEX_TYPES>(le);
+ break;
+ default:
+ lyxerr << "Unhandled value " << le
+ << " in LyXTextClass::readTitleType." << endl;
+
+ break;
+ }
+}
+
+
void LyXTextClass::readOutputType(LyXLex & lexrc)
{
keyword_item outputTypeTags[] = {
};
-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<MaxCounterTags>(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
};
keyword_item classOptionsTags[] = {
{"end", CO_END },
{"fontsize", CO_FONTSIZE },
+ {"header", CO_HEADER },
{"other", CO_OTHER },
{"pagestyle", CO_PAGESTYLE }
};
lexrc.next();
options_ = lexrc.getString();
break;
+ case CO_HEADER:
+ lexrc.next();
+ class_header_ = subst(lexrc.getString(), """, "\"");
+ break;
case CO_END:
getout = true;
break;
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<CharStyleTags>(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 = preamble;
+ charstyles().push_back(cs);
+ }
+
+ lexrc.popTable();
+}
+
enum FloatTags {
FT_TYPE = 1,
FT_END
};
+
void LyXTextClass::readFloat(LyXLex & lexrc)
{
keyword_item floatTags[] = {
if (getout) {
Floating newfloat(type, placement, ext, within,
style, name, listname, builtin);
- floatlist_.newFloat(newfloat);
+ floatlist_->newFloat(newfloat);
+ }
+
+ lexrc.popTable();
+}
+
+
+enum CounterTags {
+ CT_NAME = 1,
+ CT_WITHIN,
+ CT_END
+};
+
+void LyXTextClass::readCounter(LyXLex & lexrc)
+{
+ keyword_item counterTags[] = {
+ { "end", CT_END },
+ { "name", CT_NAME },
+ { "within", CT_WITHIN }
+ };
+
+ lexrc.pushTable(counterTags, CT_END);
+
+ string name;
+ string within;
+
+ 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<CounterTags>(le)) {
+ case CT_NAME:
+ lexrc.next();
+ name = lexrc.getString();
+ break;
+ case CT_WITHIN:
+ lexrc.next();
+ within = lexrc.getString();
+ if (within == "none")
+ within.erase();
+ break;
+ case CT_END:
+ getout = true;
+ break;
+ }
+ }
+
+ // Here if have a full counter if getout == true
+ if (getout) {
+ if (within.empty()) {
+ ctrs_->newCounter(name);
+ } else {
+ ctrs_->newCounter(name, within);
+ }
}
lexrc.popTable();
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 << "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);
}
+
bool LyXTextClass::delete_layout(string const & name)
{
if (name == defaultLayoutName())
LayoutList::iterator it =
remove_if(layoutlist_.begin(), layoutlist_.end(),
- compare_name(name));
+ LayoutNamesEqual(name));
LayoutList::iterator end = layoutlist_.end();
bool const ret = (it != end);
// Load textclass info if not loaded yet
bool LyXTextClass::load() const
{
- if (loaded)
+ if (loaded_)
return true;
// Read style-file
string const real_file = LibFileSearch("layouts", name_, "layout");
+ loaded_ = const_cast<LyXTextClass*>(this)->Read(real_file) == 0;
- if (const_cast<LyXTextClass*>(this)->Read(real_file)) {
+ if (!loaded_) {
lyxerr << "Error reading `"
<< MakeDisplayPath(real_file)
<< "'\n(Check `" << name_
<< "')\nCheck your installation and "
"try Options/Reconfigure..." << endl;
- loaded = false;
}
- loaded = true;
- return loaded;
+
+ return loaded_;
}
FloatList & LyXTextClass::floats()
{
- return floatlist_;
+ return *floatlist_.get();
}
FloatList const & LyXTextClass::floats() const
{
- return floatlist_;
+ return *floatlist_.get();
}
-string const LyXTextClass::defaultLayoutName() const
+Counters & LyXTextClass::counters() const
+{
+ return *ctrs_.get();
+}
+
+
+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)
return defaultlayout_;
}
+string const & LyXTextClass::class_header() const
+{
+ return class_header_;
+}
+
+
string const & LyXTextClass::pagestyle() const
{
return pagestyle_;
}
-int LyXTextClass::maxcounter() const
+LYX_TITLE_LATEX_TYPES LyXTextClass::titletype() const
+{
+ return titletype_;
+}
+
+
+string const & LyXTextClass::titlename() const
{
- return maxcounter_;
+ return titlename_;
}
{
switch (p) {
case LyXTextClass::OneSide:
- os << "1";
+ os << '1';
break;
case LyXTextClass::TwoSides:
- os << "2";
+ os << '2';
break;
}
return os;