X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.C;h=c6e65beb99fa6434055c5752ebb3c4aad0858a7f;hb=1b0cfa4381f8efa0f724bfc661c108d73242d1d6;hp=67341747bdaf5ce14ff24c14e606e469fe709e29;hpb=ee72ce87743857b4317da00e6e09cb6842095664;p=lyx.git

diff --git a/src/LaTeXFeatures.C b/src/LaTeXFeatures.C
index 67341747bd..c6e65beb99 100644
--- a/src/LaTeXFeatures.C
+++ b/src/LaTeXFeatures.C
@@ -1,176 +1,253 @@
-// -*- C++ -*-
 /* This file is part of
- * ====================================================== 
- * 
+ * ======================================================
+ *
  *           LyX, The Document Processor
- *        
+ *
  *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2000 the LyX Team.
+ *           Copyright 1995-2001 the LyX Team.
  *
  * ====================================================== */
 
 #include <config.h>
 
 #ifdef __GNUG__
-#pragma implementation "LaTeXFeatures.h"
+#pragma implementation
 #endif
 
-#include "LString.h"
+#include "LaTeXFeatures.h"
 #include "debug.h"
 #include "lyx_sty.h"
 #include "lyxrc.h"
-#include "LaTeXFeatures.h"
 #include "bufferparams.h"
-#include "layout.h"
+#include "FloatList.h"
+#include "language.h"
+#include "encoding.h"
+#include "LString.h"
+
+#include "support/filetools.h"
+#include "support/lstrings.h"
+
+using lyx::textclass_type;
 
 using std::endl;
+using std::list;
+using std::set;
+using std::find;
+using std::ostream;
 
-LaTeXFeatures::LaTeXFeatures(BufferParams const & p, int n)
-	: layout(n, false), params(p)
+
+LaTeXFeatures::LaTeXFeatures(BufferParams const & p)
+	: params(p)
+{}
+
+
+void LaTeXFeatures::require(string const & name)
 {
-	// packages
-	color = false;
-	graphics = false;
-	setspace = false;
-	makeidx = false;
-	verbatim = false;
-	longtable = false;
-	algorithm = false;
-	rotating = false;
-	amssymb = false;
-	latexsym = false;
-	pifont = false;
-	subfigure = false;
-	floatflt = false;
-	url = false;
-	varioref = false;
-	prettyref = false;
-	chess = false;
-	
-	// commands
-	lyx = false;
-	lyxline = false;
-	noun = false;
-	lyxarrow = false;
-
-	// quotes
-	quotesinglbase = false;
-	quotedblbase = false;
-	guilsinglleft = false;
-	guilsinglright = false;
-	guillemotleft = false;
-	guillemotright = false;
+	if (isRequired(name))
+		return;
 
-	// Math mode
-	amsstyle = false;
-	binom = false;
-	boldsymbol = false;
-    
-	// special features
-	LyXParagraphIndent = false;
-	NeedLyXFootnoteCode = false;
-	NeedLyXMinipageIndent = false;
+	features.push_back(name);
 }
 
-void LaTeXFeatures::require(string const & name) {
-	if (name == "color") {
-		color = true;
-	} else if (name == "graphics") {
-#ifdef USE_GRAPHICX
-		graphicx = true;
-#else
-		graphics = true;
-#endif
-	} else if (name == "setspace") {
-		setspace = true;
-	} else if (name == "makeidx") {
-		makeidx = true;
-	} else if (name == "verbatim") {
-		verbatim = true;
-	} else if (name == "longtable") {
-		longtable = true;
-	} else if (name == "algorithm") {
-		algorithm = true;
-	} else if (name == "rotating") {
-		rotating = true;
-	} else if (name == "amssymb") {
-		amssymb = true;
-	} else if (name == "latexsym") {
-		latexsym = true;
-	} else if (name == "pifont") {
-		pifont = true;
-	} else if (name == "subfigure") {
-		subfigure = true;
-	} else if (name == "floatflt") {
-		floatflt = true;
-	} else if (name == "url") {
-		url = true;
-	} else if (name == "varioref") {
-		varioref = true;
-	} else if (name == "prettyref") {
-		prettyref = true;
-	} else if (name == "chess") {
-		chess = true;
-	} else if (name == "amsstyle") {
-		amsstyle = true;
-	} else if (name == "boldsymbol") {
-		boldsymbol = true;
-	} else if (name == "binom") {
-		binom = true;
+
+void LaTeXFeatures::useLayout(string const & layoutname)
+{
+	// Some code to avoid loops in dependency definition
+	static int level = 0;
+	const int maxlevel = 30;
+	if (level > maxlevel) {
+		lyxerr << "LaTeXFeatures::useLayout: maximum level of "
+		       << "recursion attained by layout "
+		       << layoutname << endl;
+		return;
+	}
+
+	LyXTextClass const & tclass = params.getLyXTextClass();
+	if (tclass.hasLayout(layoutname)) {
+		// Is this layout already in usedLayouts?
+		list<string>::const_iterator cit = usedLayouts.begin();
+		list<string>::const_iterator end = usedLayouts.end();
+		for (; cit != end; ++cit) {
+			if (layoutname == *cit)
+				return;
+		}
+
+		LyXLayout_ptr const & lyt = tclass[layoutname];
+		if (!lyt->depends_on().empty()) {
+			++level;
+			useLayout(lyt->depends_on());
+			--level;
+		}
+		usedLayouts.push_back(layoutname);
+	} else {
+		lyxerr << "LaTeXFeatures::useLayout: layout `"
+		       << layoutname << "' does not exist in this class"
+		       << endl;
+	}
+
+	--level;
+}
+
+
+bool LaTeXFeatures::isRequired(string const & name) const
+{
+	FeaturesList::const_iterator i = find(features.begin(),
+					      features.end(),
+					      name);
+	return i != features.end();
+}
+
+
+void LaTeXFeatures::addExternalPreamble(string const & pream)
+{
+	externalPreambles += pream;
+}
+
+
+void LaTeXFeatures::useFloat(string const & name)
+{
+	usedFloats.insert(name);
+	// We only need float.sty if we use non builtin floats, or if we
+	// use the "H" modifier. This includes modified table and
+	// figure floats. (Lgb)
+	Floating const & fl = params.getLyXTextClass().floats().getType(name);
+	if (!fl.type().empty() && !fl.builtin()) {
+		require("float");
 	}
 }
 
-string LaTeXFeatures::getPackages()
+
+void LaTeXFeatures::useLanguage(Language const * lang)
+{
+	UsedLanguages.insert(lang);
+}
+
+
+void LaTeXFeatures::includeFile(string const & key, string const & name)
+{
+	IncludedFiles[key] = name;
+}
+
+
+bool LaTeXFeatures::hasLanguages()
+{
+	return !UsedLanguages.empty();
+}
+
+
+string LaTeXFeatures::getLanguages() const
+{
+	ostringstream languages;
+
+	for (LanguageList::const_iterator cit =
+		    UsedLanguages.begin();
+	     cit != UsedLanguages.end();
+	     ++cit)
+		languages << (*cit)->babel() << ',';
+
+	return STRCONV(languages.str());
+}
+
+
+set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding)
+{
+	set<string> encodings;
+	for (LanguageList::const_iterator it =
+		     UsedLanguages.begin();
+	     it != UsedLanguages.end(); ++it)
+		if ((*it)->encoding()->LatexName() != doc_encoding)
+			encodings.insert((*it)->encoding()->LatexName());
+	return encodings;
+}
+
+namespace {
+
+char const * simplefeatures[] = {
+	"array",
+	"verbatim",
+	"longtable",
+	"rotating",
+	"latexsym",
+	"pifont",
+	"subfigure",
+	"floatflt",
+	"varioref",
+	"prettyref",
+	"float",
+	"wasy"
+};
+
+const int nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
+
+}
+
+string const LaTeXFeatures::getPackages() const
 {
-	string packages;
-	LyXTextClass const & tclass =
-		textclasslist.TextClass(params.textclass);
+	ostringstream packages;
+	LyXTextClass const & tclass = params.getLyXTextClass();
+
+
+	//
+	//  These are all the 'simple' includes.  i.e
+	//  packages which we just \usepackage{package}
+	//
+	for (int i = 0; i < nb_simplefeatures; ++i) {
+		if (isRequired(simplefeatures[i]))
+			packages << "\\usepackage{"
+				 << simplefeatures[i] << "}\n";
+	}
+
+	//
+	// The rest of these packages are somewhat more complicated
+	// than those above.
+	//
+
+	if (isRequired("amsmath")
+	    && ! tclass.provides(LyXTextClass::amsmath)) {
+		packages << "\\usepackage{amsmath}\n";
+	}
 
 	// color.sty
-	if (color) {
+	if (isRequired("color")) {
 		if (params.graphicsDriver == "default")
-			packages += "\\usepackage{color}\n";
+			packages << "\\usepackage{color}\n";
 		else
-			packages += "\\usepackage[" 
-				+ params.graphicsDriver + "]{color}\n";
+			packages << "\\usepackage["
+				 << params.graphicsDriver
+				 << "]{color}\n";
 	}
-		
+
 	// makeidx.sty
-	if (makeidx) {
-		if (! tclass.provides(LyXTextClass::makeidx)
-		    && params.language != "french") // french provides
-						    // \index !
-			packages += "\\usepackage{makeidx}\n";
-		packages += "\\makeindex\n";
+	if (isRequired("makeidx")) {
+		if (! tclass.provides(LyXTextClass::makeidx))
+			packages << "\\usepackage{makeidx}\n";
+		packages << "\\makeindex\n";
 	}
 
-	// graphics.sty
-	if (graphics && params.graphicsDriver != "none") {
+	// graphicx.sty
+	if (isRequired("graphicx") && params.graphicsDriver != "none") {
 		if (params.graphicsDriver == "default")
-			packages += "\\usepackage{graphics}\n";
+			packages << "\\usepackage{graphicx}\n";
 		else
-			packages += "\\usepackage[" 
-				+ params.graphicsDriver + "]{graphics}\n";
+			packages << "\\usepackage["
+				 << params.graphicsDriver
+				 << "]{graphicx}\n";
 	}
 
-	// verbatim.sty
-	if (verbatim)
-		packages += "\\usepackage{verbatim}\n";
-
-	if (algorithm) {
-		packages += "\\usepackage{algorithm}\n";
-	}
+	//if (algorithm) {
+	//	packages << "\\usepackage{algorithm}\n";
+	//}
 
-	// lyxchess.sty
-	if (chess) {
-		packages += "\\usepackage{lyxchess}\n";
+	// lyxskak.sty --- newer chess support based on skak.sty
+	if (isRequired("chess")) {
+		packages << "\\usepackage[ps,mover]{lyxskak}\n";
 	}
 
 	// setspace.sty
 	if ((params.spacing.getSpace() != Spacing::Single
 	     && !params.spacing.isDefault())
-	    || setspace) {
-		packages += "\\usepackage{setspace}\n";
+	    || isRequired("setspace")) {
+		packages << "\\usepackage{setspace}\n";
 	}
 	switch (params.spacing.getSpace()) {
 	case Spacing::Default:
@@ -179,160 +256,163 @@ string LaTeXFeatures::getPackages()
 		//packages += "\\singlespacing\n";
 		break;
 	case Spacing::Onehalf:
-		packages += "\\onehalfspacing\n";
+		packages << "\\onehalfspacing\n";
 		break;
 	case Spacing::Double:
-		packages += "\\doublespacing\n";
+		packages << "\\doublespacing\n";
 		break;
 	case Spacing::Other:
-#ifdef HAVE_SSTREAM
-		std::ostringstream value;
-#else
-		char val[30];
-		ostrstream value(val, 30);
-		
-#endif
-		value << params.spacing.getValue(); // setw?
-#ifdef HAVE_SSTREAM
-		packages += string("\\setstretch{") 
-			  + value.str().c_str() + "}\n";
-#else
-		value << '\0';
-		packages += string("\\setstretch{") 
-			  + value.str() + "}\n";
-#endif
+		packages << "\\setstretch{"
+			 << params.spacing.getValue() << "}\n";
 		break;
 	}
 
-	//longtable.sty
-	if (longtable)
-		packages += "\\usepackage{longtable}\n";
+	// amssymb.sty
+	if (isRequired("amssymb") || params.use_amsmath)
+		packages << "\\usepackage{amssymb}\n";
+	// url.sty
+	if (isRequired("url") && ! tclass.provides(LyXTextClass::url))
+		packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
+			    "                      {\\newcommand{\\url}{\\texttt}}\n";
 
-	//rotating.sty
-	if (rotating)
-		packages += "\\usepackage{rotating}\n";
+	// float.sty
+	// natbib.sty
+	if (isRequired("natbib") && ! tclass.provides(LyXTextClass::natbib)) {
+		packages << "\\usepackage[";
+		if (params.use_numerical_citations) {
+			packages << "numbers";
+		} else {
+			packages << "authoryear";
+		}
+		packages << "]{natbib}\n";
+	}
 
-	// amssymb.sty
-	if (amssymb || params.use_amsmath)
-		packages += "\\usepackage{amssymb}\n";
+	packages << externalPreambles;
 
-	// latexsym.sty
-	if (latexsym)
-		packages += "\\usepackage{latexsym}\n";
+	return STRCONV(packages.str());
+}
 
-	// pifont.sty
-	if (pifont)
-		packages += "\\usepackage{pifont}\n";
 
-	// subfigure.sty
-	if (subfigure)
-		packages += "\\usepackage{subfigure}\n";
+string const LaTeXFeatures::getMacros() const
+{
+	ostringstream macros;
+
+	if (isRequired("LyX"))
+		macros << lyx_def << '\n';
+
+	if (isRequired("lyxline"))
+		macros << lyxline_def << '\n';
+
+	if (isRequired("noun"))
+		macros << noun_def << '\n';
+
+	if (isRequired("lyxarrow"))
+		macros << lyxarrow_def << '\n';
+
+	// quotes.
+	if (isRequired("quotesinglbase"))
+		macros << quotesinglbase_def << '\n';
+	if (isRequired("quotedblbase"))
+		macros << quotedblbase_def << '\n';
+	if (isRequired("guilsinglleft"))
+		macros << guilsinglleft_def << '\n';
+	if (isRequired("guilsinglright"))
+		macros << guilsinglright_def << '\n';
+	if (isRequired("guillemotleft"))
+		macros << guillemotleft_def << '\n';
+	if (isRequired("guillemotright"))
+		macros << guillemotright_def << '\n';
 
-	// floatflt.sty
-	if (floatflt)
-		packages += "\\usepackage{floatflt}\n";
+	// Math mode
+	if (isRequired("boldsymbol") && !isRequired("amsmath"))
+		macros << boldsymbol_def << '\n';
+	if (isRequired("binom") && !isRequired("amsmath"))
+		macros << binom_def << '\n';
+	if (isRequired("mathcircumflex"))
+		macros << mathcircumflex_def << '\n';
 
-	// url.sty
-	if (url && ! tclass.provides(LyXTextClass::url))
-		packages += "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
-			    "                      {\\newcommand{\\url}{\\texttt}}\n";
+	// other
+	if (isRequired("NeedLyXMinipageIndent"))
+		macros << minipageindent_def;
+	if (isRequired("ParagraphLeftIndent"))
+		macros << paragraphleftindent_def;
+	if (isRequired("NeedLyXFootnoteCode"))
+		macros << floatingfootnote_def;
 
-	// varioref.sty
-	if (varioref)
-		packages += "\\usepackage{varioref}\n";
+	// some problems with tex->html converters
+	if (isRequired("NeedTabularnewline"))
+		macros << tabularnewline_def;
 
-	// prettyref.sty
-	if (prettyref)
-		packages += "\\usepackage{prettyref}\n";
+	// floats
+	getFloatDefinitions(macros);
 
-	// float.sty
-	// This is not correct and needs fixing.
-	// We don't need float.sty if we only use unchanged
-	// table and figure floats. (Lgb)
-	if (!usedFloats.empty())
-		packages += "\\usepackage{float}\n";
-	
-	packages += externalPreambles;
-
-	return packages;
+	return STRCONV(macros.str());
 }
 
 
-string LaTeXFeatures::getMacros()
+string const LaTeXFeatures::getBabelOptions() const
 {
-	string macros;
+	ostringstream tmp;
 
-	// always include this
-	if (true || lyx) 
-		macros += lyx_def + '\n';
+	for (LanguageList::const_iterator cit = UsedLanguages.begin();
+	     cit != UsedLanguages.end(); ++cit)
+		if (!(*cit)->latex_options().empty())
+			tmp << (*cit)->latex_options() << '\n';
+	if (!params.language->latex_options().empty())
+		tmp << params.language->latex_options() << '\n';
 
-	if (lyxline) 
-		macros += lyxline_def + '\n';
+	return STRCONV(tmp.str());
+}
 
-	if (noun) {
-		macros += noun_def + '\n';
-	}
 
-	if (lyxarrow) {
-		macros += lyxarrow_def + '\n';
-	}
+string const LaTeXFeatures::getTClassPreamble() const
+{
+	// the text class specific preamble
+	LyXTextClass const & tclass = params.getLyXTextClass();
+	ostringstream tcpreamble;
 
-	// quotes. 
-	if (quotesinglbase)
-		macros += quotesinglbase_def + '\n';
-	if (quotedblbase)
-		macros += quotedblbase_def + '\n';
-	if (guilsinglleft)
-		macros += guilsinglleft_def + '\n';
-	if (guilsinglright)
-		macros += guilsinglright_def + '\n';
-	if (guillemotleft)
-		macros += guillemotleft_def + '\n';
-	if (guillemotright)
-		macros += guillemotright_def + '\n';
-    
-        // Math mode    
-	if (boldsymbol && !amsstyle)
-		macros += boldsymbol_def + '\n';
-	if (binom && !amsstyle)
-		macros += binom_def + '\n';
+	tcpreamble << tclass.preamble();
 
-	// other
-        if (NeedLyXMinipageIndent) 
-		macros += minipageindent_def;
-        if (LyXParagraphIndent) 
-		macros += paragraphindent_def;
-        if (NeedLyXFootnoteCode) 
-		macros += floatingfootnote_def;
+	list<string>::const_iterator cit = usedLayouts.begin();
+	list<string>::const_iterator end = usedLayouts.end();
+	for (; cit != end; ++cit) {
+		tcpreamble << tclass[*cit]->preamble();
+	}
 
-	// floats
-	// Here we will output the code to create the needed float styles.
-	// We will try to do this as minimal as possible.
-	// \floatstyle{ruled}
-	// \newfloat{algorithm}{htbp}{loa}
-	// \floatname{algorithm}{Algorithm}
-	return macros;
+	return STRCONV(tcpreamble.str());
 }
 
 
-string LaTeXFeatures::getTClassPreamble()
+string const LaTeXFeatures::getLyXSGMLEntities() const
 {
-	// the text class specific preamble 
-	LyXTextClass const & tclass =
-		textclasslist.TextClass(params.textclass);
-	string tcpreamble = tclass.preamble();
-
-	for (unsigned int i = 0; i < tclass.numLayouts(); ++i) {
-		if (layout[i]) {
-			tcpreamble += tclass[i].preamble();
-		}
+	// Definition of entities used in the document that are LyX related.
+	ostringstream entities;
+
+	if (isRequired("lyxarrow")) {
+		entities << "<!ENTITY lyxarrow \"-&gt;\">" << '\n';
 	}
 
-	return tcpreamble;
-}	
+	return STRCONV(entities.str());
+}
 
 
-void LaTeXFeatures::showStruct() {
+string const LaTeXFeatures::getIncludedFiles(string const & fname) const
+{
+	ostringstream sgmlpreamble;
+	string const basename = OnlyPath(fname);
+
+	FileMap::const_iterator end = IncludedFiles.end();
+	for (FileMap::const_iterator fi = IncludedFiles.begin();
+	     fi != end; ++fi)
+		sgmlpreamble << "\n<!ENTITY " << fi->first
+			     << (IsSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
+			     << MakeRelPath(fi->second, basename) << "\">";
+
+	return STRCONV(sgmlpreamble.str());
+}
+
+
+void LaTeXFeatures::showStruct() const {
 	lyxerr << "LyX needs the following commands when LaTeXing:"
 	       << "\n***** Packages:" << getPackages()
 	       << "\n***** Macros:" << getMacros()
@@ -345,3 +425,65 @@ BufferParams const & LaTeXFeatures::bufferParams() const
 {
 	return params;
 }
+
+
+void LaTeXFeatures::getFloatDefinitions(ostream & os) const
+{
+	FloatList const & floats = params.getLyXTextClass().floats();
+
+	// Here we will output the code to create the needed float styles.
+	// We will try to do this as minimal as possible.
+	// \floatstyle{ruled}
+	// \newfloat{algorithm}{htbp}{loa}
+	// \floatname{algorithm}{Algorithm}
+	UsedFloats::const_iterator cit = usedFloats.begin();
+	UsedFloats::const_iterator end = usedFloats.end();
+	// ostringstream floats;
+	for (; cit != end; ++cit) {
+		Floating const & fl = floats.getType((*cit));
+
+		// For builtin floats we do nothing.
+		if (fl.builtin()) continue;
+
+		// We have to special case "table" and "figure"
+		if (fl.type() == "tabular" || fl.type() == "figure") {
+			// Output code to modify "table" or "figure"
+			// but only if builtin == false
+			// and that have to be true at this point in the
+			// function.
+			string const type = fl.type();
+			string const placement = fl.placement();
+			string const style = fl.style();
+			if (!style.empty()) {
+				os << "\\floatstyle{" << style << "}\n"
+				   << "\\restylefloat{" << type << "}\n";
+			}
+			if (!placement.empty()) {
+				os << "\\floatplacement{" << type << "}{"
+				   << placement << "}\n";
+			}
+		} else {
+			// The other non builtin floats.
+
+			string const type = fl.type();
+			string const placement = fl.placement();
+			string const ext = fl.ext();
+			string const within = fl.within();
+			string const style = fl.style();
+			string const name = fl.name();
+			os << "\\floatstyle{" << style << "}\n"
+			   << "\\newfloat{" << type << "}{" << placement
+			   << "}{" << ext << "}";
+			if (!within.empty())
+				os << "[" << within << "]";
+			os << "\n"
+			   << "\\floatname{" << type << "}{"
+			   << name << "}\n";
+
+			// What missing here is to code to minimalize the code
+			// output so that the same floatstyle will not be
+			// used several times, when the same style is still in
+			// effect. (Lgb)
+		}
+	}
+}