X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FTextClass.cpp;h=a594375cda5930118f51d3513ea237c56dc77d64;hb=fb12b282f1300123c7f4c7f10525c29cb598e1fe;hp=2d79a2b75528d5b9b270c40057afd6974a4762af;hpb=11a0458d3f66bce83b90e23f1c85175a8ffcae45;p=lyx.git

diff --git a/src/TextClass.cpp b/src/TextClass.cpp
index 2d79a2b755..a594375cda 100644
--- a/src/TextClass.cpp
+++ b/src/TextClass.cpp
@@ -27,6 +27,7 @@
 
 #include "frontends/alert.h"
 
+#include "support/lassert.h"
 #include "support/debug.h"
 #include "support/ExceptionMessage.h"
 #include "support/FileName.h"
@@ -39,8 +40,6 @@
 #include <fstream>
 #include <sstream>
 
-#include "boost/assert.hpp"
-
 using namespace std;
 using namespace lyx::support;
 
@@ -62,15 +61,15 @@ private:
 };
 
 
-int const FORMAT = 7;
+int const FORMAT = 8;
 
 
 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;
+		LYXERR0("Could not find layout conversion "
+			  "script layout2layout.py.");
 		return false;
 	}
 
@@ -82,11 +81,9 @@ bool layout2layout(FileName const & filename, FileName const & tempfile)
 
 	LYXERR(Debug::TCLASS, "Running `" << command_str << '\'');
 
-	cmd_ret const ret =
-		runCommand(command_str);
+	cmd_ret const ret = runCommand(command_str);
 	if (ret.first != 0) {
-		lyxerr << "Could not run layout conversion "
-			  "script layout2layout.py." << endl;
+		LYXERR0("Could not run layout conversion script layout2layout.py.");
 		return false;
 	}
 	return true;
@@ -112,11 +109,19 @@ std::string translateRT(TextClass::ReadType rt)
 } // namespace anon
 
 
-docstring const TextClass::emptylayout_ = from_ascii(N_("Plain Layout"));
+// This string should not be translated here, 
+// because it is a layout identifier.
+docstring const TextClass::plain_layout_ = from_ascii("Plain Layout");
+
 
+InsetLayout DocumentClass::plain_insetlayout_;
 
-InsetLayout DocumentClass::empty_insetlayout_;
 
+/////////////////////////////////////////////////////////////////////////
+//
+// TextClass
+//
+/////////////////////////////////////////////////////////////////////////
 
 TextClass::TextClass()
 {
@@ -132,14 +137,15 @@ TextClass::TextClass()
 	titletype_ = TITLE_COMMAND_AFTER;
 	titlename_ = "maketitle";
 	loaded_ = false;
+	_("Plain Layout"); // a hack to make this translatable
 }
 
 
-bool TextClass::readStyle(Lexer & lexrc, Layout & lay)
+bool TextClass::readStyle(Lexer & lexrc, Layout & lay) const
 {
 	LYXERR(Debug::TCLASS, "Reading style " << to_utf8(lay.name()));
 	if (!lay.read(lexrc, *this)) {
-		lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl;
+		LYXERR0("Error parsing style `" << to_utf8(lay.name()) << '\'');
 		return false;
 	}
 	// Resolve fonts
@@ -157,7 +163,6 @@ enum TextClassTags {
 	TC_STYLE,
 	TC_DEFAULTSTYLE,
 	TC_INSETLAYOUT,
-	TC_ENVIRONMENT,
 	TC_NOSTYLE,
 	TC_COLUMNS,
 	TC_SIDES,
@@ -177,7 +182,8 @@ enum TextClassTags {
 	TC_TITLELATEXNAME,
 	TC_TITLELATEXTYPE,
 	TC_FORMAT,
-	TC_ADDTOPREAMBLE
+	TC_ADDTOPREAMBLE,
+	TC_USEMODULE
 };
 
 
@@ -190,7 +196,6 @@ namespace {
 		{ "counter",         TC_COUNTER },
 		{ "defaultfont",     TC_DEFAULTFONT },
 		{ "defaultstyle",    TC_DEFAULTSTYLE },
-		{ "environment",     TC_ENVIRONMENT },
 		{ "float",           TC_FLOAT },
 		{ "format",          TC_FORMAT },
 		{ "input",           TC_INPUT },
@@ -209,7 +214,8 @@ namespace {
 		{ "style",           TC_STYLE },
 		{ "titlelatexname",  TC_TITLELATEXNAME },
 		{ "titlelatextype",  TC_TITLELATEXTYPE },
-		{ "tocdepth",        TC_TOCDEPTH }
+		{ "tocdepth",        TC_TOCDEPTH },
+		{ "usemodule",       TC_USEMODULE }
 	};
 	
 } //namespace anon
@@ -218,7 +224,7 @@ namespace {
 bool TextClass::convertLayoutFormat(support::FileName const & filename, ReadType rt)
 {
 	LYXERR(Debug::TCLASS, "Converting layout file to " << FORMAT);
-		FileName const tempfile = FileName::tempName();
+		FileName const tempfile = FileName::tempName("convert_layout");
 		bool success = layout2layout(filename, tempfile);
 		if (success)
 			success = read(tempfile, rt);
@@ -237,29 +243,11 @@ bool TextClass::read(FileName const & filename, ReadType rt)
 	LYXERR(Debug::TCLASS, "Reading " + translateRT(rt) + ": " +
 		to_utf8(makeDisplayPath(filename.absFilename())));
 
-	// Define the `empty' layout used in table cells, ert, etc. Note that 
+	// Define the plain layout used in table cells, ert, etc. Note that 
 	// we do this before loading any layout file, so that classes can 
 	// override features of this layout if they should choose to do so.
-	if (rt == BASECLASS && !hasLayout(emptylayout_)) {
-		static char const * s = "Margin Static\n"
-			"LatexType Paragraph\n"
-			"LatexName dummy\n"
-			"Align Block\n"
-			"AlignPossible Left, Right, Center\n"
-			"LabelType No_Label\n"
-			"End";
-		istringstream ss(s);
-		Lexer lex(textClassTags);
-		lex.setStream(ss);
-		Layout lay;
-		lay.setName(emptylayout_);
-		if (!readStyle(lex, lay)) {
-			// The only way this happens is because the hardcoded layout above
-			// is wrong.
-			BOOST_ASSERT(false);
-		};
-		layoutlist_.push_back(lay);
-	}
+	if (rt == BASECLASS && !hasLayout(plain_layout_))
+		layoutlist_.push_back(createBasicLayout(plain_layout_));
 
 	Lexer lexrc(textClassTags);
 	lexrc.setFile(filename);
@@ -299,11 +287,10 @@ bool TextClass::read(std::string const & str, ReadType rt)
 		return retval == OK;
 
 	// write the layout string to a temporary file
-	FileName const tempfile = FileName::tempName();
+	FileName const tempfile = FileName::tempName("TextClass_read");
 	ofstream os(tempfile.toFilesystemEncoding().c_str());
 	if (!os) {
-		lyxerr << "Unable to create tempoary file in TextClass::read!!" 
-			<< std::endl;
+		LYXERR0("Unable to create temporary file");
 		return false;
 	}
 	os << str;
@@ -312,8 +299,8 @@ bool TextClass::read(std::string const & str, ReadType rt)
 	// now try to convert it
 	bool const worx = convertLayoutFormat(tempfile, rt);
 	if (!worx) {
-		lyxerr << "Unable to convert internal layout information to format " 
-			<< FORMAT << std::endl;
+		LYXERR0("Unable to convert internal layout information to format " 
+			<< FORMAT);
 	}
 	tempfile.removeFile();
 	return worx;
@@ -381,7 +368,6 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 			}
 			break;
 
-		case TC_ENVIRONMENT:
 		case TC_STYLE:
 			if (lexrc.next()) {
 				docstring const name = from_utf8(subst(lexrc.getString(),
@@ -398,13 +384,11 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 					Layout & lay = operator[](name);
 					error = !readStyle(lexrc, lay);
 				} else {
-					Layout lay;
-					lay.setName(name);
-					if (le == TC_ENVIRONMENT)
-						lay.is_environment = true;
-					error = !readStyle(lexrc, lay);
+					Layout layout;
+					layout.setName(name);
+					error = !readStyle(lexrc, layout);
 					if (!error)
-						layoutlist_.push_back(lay);
+						layoutlist_.push_back(layout);
 
 					if (defaultlayout_.empty()) {
 						// We do not have a default layout yet, so we choose
@@ -415,8 +399,8 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 			}
 			else {
 				//FIXME Should we also eat the style here? viz:
-				//Layout lay;
-				//readStyle(lexrc, lay);
+				//Layout layout;
+				//readStyle(lexrc, layout);
 				//as above...
 				lexrc.printError("No name given for style: `$$Token'.");
 				error = true;
@@ -509,6 +493,13 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 			break;
 		}
 
+		case TC_USEMODULE: {
+			lexrc.next();
+			string const module = lexrc.getString();
+			usemod_.insert(module);
+			break;
+		}
+
 		case TC_LEFTMARGIN:	// left margin type
 			if (lexrc.next())
 				leftmargin_ = lexrc.getDocString();
@@ -522,9 +513,8 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 		case TC_INSETLAYOUT:
 			if (lexrc.next()) {
 				InsetLayout il;
-				if (il.read(lexrc)) {
+				if (il.read(lexrc, *this))
 					insetlayoutlist_[il.name()] = il;
-				}
 				// else there was an error, so forget it
 			}
 			break;
@@ -567,21 +557,21 @@ TextClass::ReturnValues TextClass::read(Lexer & lexrc, ReadType rt)
 		return (error ? ERROR : OK);
 
 	if (defaultlayout_.empty()) {
-		lyxerr << "Error: Textclass '" << name_
-						<< "' is missing a defaultstyle." << endl;
+		LYXERR0("Error: Textclass '" << name_
+						<< "' is missing a defaultstyle.");
 		error = true;
 	}
 		
-	//Try to erase "stdinsets" from the provides_ set. 
-	//The
-	//  Provides stdinsets 1
-	//declaration simply tells us that the standard insets have been
-	//defined. (It's found in stdinsets.inc but could also be used in
-	//user-defined files.) There isn't really any such package. So we
-	//might as well go ahead and erase it.
-	//If we do not succeed, then it was not there, which means that
-	//the textclass did not provide the definitions of the standard
-	//insets. So we need to try to load them.
+	// Try to erase "stdinsets" from the provides_ set. 
+	// The
+	//   Provides stdinsets 1
+	// declaration simply tells us that the standard insets have been
+	// defined. (It's found in stdinsets.inc but could also be used in
+	// user-defined files.) There isn't really any such package. So we
+	// might as well go ahead and erase it.
+	// If we do not succeed, then it was not there, which means that
+	// the textclass did not provide the definitions of the standard
+	// insets. So we need to try to load them.
 	int erased = provides_.erase("stdinsets");
 	if (!erased) {
 		FileName tmp = libFileSearch("layouts", "stdinsets.inc");
@@ -622,24 +612,22 @@ void TextClass::readTitleType(Lexer & lexrc)
 {
 	LexerKeyword titleTypeTags[] = {
 		{ "commandafter", TITLE_COMMAND_AFTER },
-		{ "environment", TITLE_ENVIRONMENT }
+		{ "environment",  TITLE_ENVIRONMENT }
 	};
 
-	PushPopHelper pph(lexrc, titleTypeTags, TITLE_ENVIRONMENT);
+	PushPopHelper pph(lexrc, titleTypeTags);
 
 	int le = lexrc.lex();
 	switch (le) {
 	case Lexer::LEX_UNDEF:
 		lexrc.printError("Unknown output type `$$Token'");
-		return;
+		break;
 	case TITLE_COMMAND_AFTER:
 	case TITLE_ENVIRONMENT:
 		titletype_ = static_cast<TitleLatexType>(le);
 		break;
 	default:
-		lyxerr << "Unhandled value " << le
-		       << " in TextClass::readTitleType." << endl;
-
+		LYXERR0("Unhandled value " << le << " in TextClass::readTitleType.");
 		break;
 	}
 }
@@ -648,12 +636,12 @@ void TextClass::readTitleType(Lexer & lexrc)
 void TextClass::readOutputType(Lexer & lexrc)
 {
 	LexerKeyword outputTypeTags[] = {
-		{ "docbook", DOCBOOK },
-		{ "latex", LATEX },
+		{ "docbook",  DOCBOOK },
+		{ "latex",    LATEX },
 		{ "literate", LITERATE }
 	};
 
-	PushPopHelper pph(lexrc, outputTypeTags, LITERATE);
+	PushPopHelper pph(lexrc, outputTypeTags);
 
 	int le = lexrc.lex();
 	switch (le) {
@@ -666,30 +654,27 @@ void TextClass::readOutputType(Lexer & lexrc)
 		outputType_ = static_cast<OutputType>(le);
 		break;
 	default:
-		lyxerr << "Unhandled value " << le
-		       << " in TextClass::readOutputType." << endl;
-
+		LYXERR0("Unhandled value " << le);
 		break;
 	}
 }
 
 
-enum ClassOptionsTags {
-	CO_FONTSIZE = 1,
-	CO_PAGESTYLE,
-	CO_OTHER,
-	CO_HEADER,
-	CO_END
-};
-
-
 void TextClass::readClassOptions(Lexer & lexrc)
 {
+	enum {
+		CO_FONTSIZE = 1,
+		CO_PAGESTYLE,
+		CO_OTHER,
+		CO_HEADER,
+		CO_END
+	};
+
 	LexerKeyword classOptionsTags[] = {
-		{"end", CO_END },
-		{"fontsize", CO_FONTSIZE },
-		{"header", CO_HEADER },
-		{"other", CO_OTHER },
+		{"end",       CO_END },
+		{"fontsize",  CO_FONTSIZE },
+		{"header",    CO_HEADER },
+		{"other",     CO_OTHER },
 		{"pagestyle", CO_PAGESTYLE }
 	};
 
@@ -703,7 +688,7 @@ void TextClass::readClassOptions(Lexer & lexrc)
 			continue;
 		default: break;
 		}
-		switch (static_cast<ClassOptionsTags>(le)) {
+		switch (le) {
 		case CO_FONTSIZE:
 			lexrc.next();
 			opt_fontsize_ = rtrim(lexrc.getString());
@@ -729,21 +714,20 @@ void TextClass::readClassOptions(Lexer & lexrc)
 }
 
 
-enum FloatTags {
-	FT_TYPE = 1,
-	FT_NAME,
-	FT_PLACEMENT,
-	FT_EXT,
-	FT_WITHIN,
-	FT_STYLE,
-	FT_LISTNAME,
-	FT_BUILTIN,
-	FT_END
-};
-
-
 void TextClass::readFloat(Lexer & lexrc)
 {
+	enum {
+		FT_TYPE = 1,
+		FT_NAME,
+		FT_PLACEMENT,
+		FT_EXT,
+		FT_WITHIN,
+		FT_STYLE,
+		FT_LISTNAME,
+		FT_BUILTIN,
+		FT_END
+	};
+
 	LexerKeyword floatTags[] = {
 		{ "end", FT_END },
 		{ "extension", FT_EXT },
@@ -776,7 +760,7 @@ void TextClass::readFloat(Lexer & lexrc)
 			continue;
 		default: break;
 		}
-		switch (static_cast<FloatTags>(le)) {
+		switch (le) {
 		case FT_TYPE:
 			lexrc.next();
 			type = lexrc.getString();
@@ -845,17 +829,16 @@ void TextClass::readFloat(Lexer & lexrc)
 }
 
 
-enum CounterTags {
-	CT_NAME = 1,
-	CT_WITHIN,
-	CT_LABELSTRING,
-	CT_LABELSTRING_APPENDIX,
-	CT_END
-};
-
-
 void TextClass::readCounter(Lexer & lexrc)
 {
+	enum {
+		CT_NAME = 1,
+		CT_WITHIN,
+		CT_LABELSTRING,
+		CT_LABELSTRING_APPENDIX,
+		CT_END
+	};
+
 	LexerKeyword counterTags[] = {
 		{ "end", CT_END },
 		{ "labelstring", CT_LABELSTRING },
@@ -880,7 +863,7 @@ void TextClass::readCounter(Lexer & lexrc)
 			continue;
 		default: break;
 		}
-		switch (static_cast<CounterTags>(le)) {
+		switch (le) {
 		case CT_NAME:
 			lexrc.next();
 			name = lexrc.getDocString();
@@ -929,10 +912,9 @@ bool TextClass::hasLayout(docstring const & n) const
 }
 
 
-
 Layout const & TextClass::operator[](docstring const & name) const
 {
-	BOOST_ASSERT(!name.empty());
+	LASSERT(!name.empty(), /**/);
 
 	const_iterator it = 
 		find_if(begin(), end(), LayoutNamesEqual(name));
@@ -945,7 +927,7 @@ Layout const & TextClass::operator[](docstring const & name) const
 			lyxerr  << " " << to_utf8(cit->name()) << endl;
 
 		// we require the name to exist
-		BOOST_ASSERT(false);
+		LASSERT(false, /**/);
 	}
 
 	return *it;
@@ -954,19 +936,18 @@ Layout const & TextClass::operator[](docstring const & name) const
 
 Layout & TextClass::operator[](docstring const & name)
 {
-	BOOST_ASSERT(!name.empty());
+	LASSERT(!name.empty(), /**/);
 
 	iterator it = find_if(begin(), end(), LayoutNamesEqual(name));
 
 	if (it == end()) {
-		lyxerr << "We failed to find the layout '" << to_utf8(name)
-		       << "' in the layout list. You MUST investigate!"
-		       << endl;
+		LYXERR0("We failed to find the layout '" << to_utf8(name)
+		       << "' in the layout list. You MUST investigate!");
 		for (const_iterator cit = begin(); cit != end(); ++cit)
-			lyxerr  << " " << to_utf8(cit->name()) << endl;
+			LYXERR0(" " << to_utf8(cit->name()));
 
 		// we require the name to exist
-		BOOST_ASSERT(false);
+		LASSERT(false, /**/);
 	}
 
 	return *it;
@@ -975,7 +956,7 @@ Layout & TextClass::operator[](docstring const & name)
 
 bool TextClass::deleteLayout(docstring const & name)
 {
-	if (name == defaultLayoutName() || name == emptyLayoutName())
+	if (name == defaultLayoutName() || name == plainLayoutName())
 		return false;
 
 	LayoutList::iterator it =
@@ -996,8 +977,9 @@ bool TextClass::load(string const & path) const
 		return true;
 
 	// Read style-file, provided path is searched before the system ones
-	FileName layout_file;
-	if (!path.empty())
+	// If path is a file, it is loaded directly.
+	FileName layout_file(path);
+	if (!path.empty() && !layout_file.isReadableFile())
 		layout_file = FileName(addName(path, name_ + ".layout"));
 	if (layout_file.empty() || !layout_file.exists())
 		layout_file = libFileSearch("layouts", name_, "layout");
@@ -1015,8 +997,17 @@ bool TextClass::load(string const & path) const
 }
 
 
+void DocumentClass::addLayoutIfNeeded(docstring const & n) const
+{
+	if (!hasLayout(n))
+		layoutlist_.push_back(createBasicLayout(n, true));
+}
+
+
 InsetLayout const & DocumentClass::insetLayout(docstring const & name) const 
 {
+	// FIXME The fix for the InsetLayout part of 4812 would be here:
+	// Add the InsetLayout to the document class if it is not found.
 	docstring n = name;
 	InsetLayouts::const_iterator cen = insetlayoutlist_.end();
 	while (!n.empty()) {
@@ -1028,7 +1019,7 @@ InsetLayout const & DocumentClass::insetLayout(docstring const & name) const
 			break;
 		n = n.substr(0,i);
 	}
-	return empty_insetlayout_;
+	return plain_insetlayout_;
 }
 
 
@@ -1045,23 +1036,67 @@ Layout const & TextClass::defaultLayout() const
 }
 
 
-bool TextClass::isDefaultLayout(Layout const & lay) const 
+bool TextClass::isDefaultLayout(Layout const & layout) const 
 {
-	return lay.name() == defaultLayoutName();
+	return layout.name() == defaultLayoutName();
 }
 
 
-bool TextClass::isEmptyLayout(Layout const & lay) const 
+bool TextClass::isPlainLayout(Layout const & layout) const 
 {
-	return lay.name() == emptyLayoutName();
+	return layout.name() == plainLayoutName();
 }
 
 
+Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const
+{
+	static Layout * defaultLayout = NULL;
+
+	if (defaultLayout) {
+		defaultLayout->setUnknown(unknown);
+		defaultLayout->setName(name);
+		return *defaultLayout;
+	}
+
+	static char const * s = "Margin Static\n"
+			"LatexType Paragraph\n"
+			"LatexName dummy\n"
+			"Align Block\n"
+			"AlignPossible Left, Right, Center\n"
+			"LabelType No_Label\n"
+			"End";
+	istringstream ss(s);
+	Lexer lex(textClassTags);
+	lex.setStream(ss);
+	defaultLayout = new Layout;
+	defaultLayout->setUnknown(unknown);
+	defaultLayout->setName(name);
+	if (!readStyle(lex, *defaultLayout)) {
+		// The only way this happens is because the hardcoded layout above
+		// is wrong.
+		LASSERT(false, /**/);
+	};
+	return *defaultLayout;
+}
+
+/////////////////////////////////////////////////////////////////////////
+//
+// DocumentClassBundle
+//
+/////////////////////////////////////////////////////////////////////////
+
+DocumentClassBundle::~DocumentClassBundle()
+{
+	for (size_t i = 0; i != documentClasses_.size(); ++i)
+		delete documentClasses_[i];
+	documentClasses_.clear();
+}
+
 DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass)
 {
 	DocumentClass * dc = new DocumentClass(baseClass);
-	tc_list_.push_back(dc);
-	return *tc_list_.back();
+	documentClasses_.push_back(dc);
+	return *documentClasses_.back();
 }
 
 
@@ -1072,6 +1107,12 @@ DocumentClassBundle & DocumentClassBundle::get()
 }
 
 
+/////////////////////////////////////////////////////////////////////////
+//
+// DocumentClass
+//
+/////////////////////////////////////////////////////////////////////////
+
 DocumentClass::DocumentClass(LayoutFile const & tc)
 	: TextClass(tc)
 {}
@@ -1100,6 +1141,12 @@ bool DocumentClass::hasTocLevels() const
 }
 
 
+/////////////////////////////////////////////////////////////////////////
+//
+// PageSides
+//
+/////////////////////////////////////////////////////////////////////////
+
 ostream & operator<<(ostream & os, PageSides p)
 {
 	switch (p) {