#include "LaTeXFeatures.h"
-#include "BufferParams.h"
#include "Color.h"
-#include "debug.h"
+#include "BufferParams.h"
#include "Encoding.h"
#include "Floating.h"
#include "FloatList.h"
#include "Language.h"
+#include "Layout.h"
#include "Lexer.h"
#include "LyXRC.h"
+#include "TextClass.h"
+#include "support/debug.h"
#include "support/docstream.h"
+#include "support/FileName.h"
#include "support/filetools.h"
+#include "support/lstrings.h"
-#include "frontends/controllers/frontend_helpers.h"
-
-using std::endl;
-using std::find;
-using std::string;
-using std::list;
-using std::ostream;
-using std::ostringstream;
-using std::set;
-
+using namespace std;
+using namespace lyx::support;
namespace lyx {
-using support::isSGMLFilename;
-using support::libFileSearch;
-using support::makeRelPath;
-using support::onlyPath;
-
/////////////////////////////////////////////////////////////////////
//
// Strings
static string const tabularnewline_def =
"%% Because html converters don't know tabularnewline\n"
"\\providecommand{\\tabularnewline}{\\\\}\n";
-
+
static string const lyxgreyedout_def =
"%% The greyedout annotation environment\n"
"\\newenvironment{lyxgreyedout}{\\textcolor[gray]{0.8}\\bgroup}{\\egroup}\n";
"\\newcommand{\\lyxdeleted}[3]{%\n"
"\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n";
+static string const changetracking_xcolor_soul_def =
+ "%% Change tracking with soul\n"
+ "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
+ "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\st{#3}}}\n";
+
+static string const changetracking_xcolor_soul_hyperref_def =
+ "%% Change tracking with soul\n"
+ "\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}}{}#3}}\n"
+ "\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\st{#3}}{}}}\n";
+
static string const changetracking_none_def =
"\\newcommand{\\lyxadded}[3]{#3}\n"
"\\newcommand{\\lyxdeleted}[3]{}\n";
-
+static string const textgreek_def =
+ "\\DeclareRobustCommand{\\greektext}{%\n"
+ " \\fontencoding{LGR}\\selectfont\n"
+ " \\def\\encodingdefault{LGR}}\n"
+ "\\DeclareRobustCommand{\\textgreek}[1]{\\leavevmode{\\greektext #1}}\n"
+ "\\DeclareFontEncoding{LGR}{}{}\n";
+
+static string const textcyr_def =
+ "\\DeclareRobustCommand{\\cyrtext}{%\n"
+ " \\fontencoding{T2A}\\selectfont\n"
+ " \\def\\encodingdefault{T2A}}\n"
+ "\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
+ "\\DeclareFontEncoding{T2A}{}{}\n";
+
+static string const newlyxcommand_def =
+ "%% Math macros with multiple optional parameters\n"
+ "% #1<-\\foo\n"
+ "\\def\\newlyxcommand#1{\n"
+ " \\@ifnextchar[%]\n"
+ " {\\newlyxcommand@arity{#1}}\n"
+ " {\\newlyxcommand@arity{#1}[0]}\n"
+ "}\n"
+ "\n"
+ "% #1<-\\foo #2<-arity\n"
+ "\\def\\newlyxcommand@arity#1[#2]{\n"
+ " \\@ifnextchar[%]\n"
+ " {\\newlyxcommand@firstopt{#1}{}{#2}}\n"
+ " {\\newlyxcommand@def#1{#2}}\n"
+ "}\n"
+ "\n"
+ "% #1<-\\foo #2<-iii #3<-arity #4<-default value for (#2+1)th argument\n"
+ "\\def\\newlyxcommand@firstopt#1#2#3[#4]{\n"
+ " % ##1<-\\foo@\n"
+ " \\def\\@defclause##1{\n"
+ " \\def#1{\n"
+ " \\@ifnextchar[%]\n"
+ " {##1{}{#4}}\n"
+ " {##1{}{#4}[#4]}}\n"
+ " }\n"
+ " \\expandafter\\@defclause\\csname\\expandafter\\@gobble\\string#1@\\endcsname\n"
+ " \\@ifnextchar[%]\n"
+ " {\\newlyxcommand@opt{#1}{#2}{#3}}\n"
+ " {\\newlyxcommand@last{#1}{#2}{#3}[#4]}\n"
+ "}\n"
+ "\n"
+ "\\begingroup\n"
+ "\\catcode`\\Q=3\n"
+ "\\gdef\\@myempty{Q}\n"
+ "\\endgroup\n"
+ "\n"
+ "% #1<-\\foo #2<-iii #3<-arity #4<-default value for (#2+1)th argument\n"
+ "\\def\\newlyxcommand@opt#1#2#3[#4]{\n"
+ " % ##1<-\\foo@iii ##2<-\\foo@iiii \n"
+ " % ####1<-{a}{b}{c} ####2<-default value ####3<- default arg\n"
+ " \\def\\@defclause##1##2{\n"
+ " \\def##1####1####2[####3]{\n"
+ " \\ifx\\@myempty####3\\@myempty%\n"
+ " \\def\\@callnext{\n"
+ " \\@ifnextchar[%]\n"
+ " {##2{####1{####2}}{#4}}\n"
+ " {##2{####1{####2}}{#4}[#4]}\n"
+ " }\n"
+ " \\else\n"
+ " \\def\\@callnext{\n"
+ " \\@ifnextchar[%]\n"
+ " {##2{####1{####3}}{#4}}\n"
+ " {##2{####1{####3}}{#4}[#4]}\n"
+ " }\n"
+ " \\fi\n"
+ " \\@callnext\n"
+ " }\n"
+ " }\n"
+ " \\expandafter\\def\\expandafter\\@clausename\\expandafter{\\csname\\expandafter\\@gobble\\string#1@#2\\endcsname}\n"
+ " \\expandafter\\def\\expandafter\\@nextclausename\\expandafter{\\csname\\expandafter\\@gobble\\string#1@#2i\\endcsname}\n"
+ " \\expandafter\\expandafter\\expandafter \n"
+ " \\@defclause\\expandafter\\@clausename\\@nextclausename\n"
+ " \\@ifnextchar[%]\n"
+ " {\\newlyxcommand@opt{#1}{#2i}{#3}}\n"
+ " {\\newlyxcommand@last{#1}{#2i}{#3}[#4]}\n"
+ "}\n"
+ "\n"
+ "% #1<-\\foo #2<-iii #3<-arity #4<-default value for (#2+1)th argument\n"
+ "\\def\\newlyxcommand@last#1#2#3[#4]{\n"
+ " \\def\\@defclause##1##2{\n"
+ " \\def##1####1####2[####3]{\n"
+ " \\ifx\\@myempty####3\\@myempty%\n"
+ " \\def\\@callnext{##2####1{####2}}\n"
+ " \\else\n"
+ " \\def\\@callnext{##2####1{####3}}\n"
+ " \\fi\n"
+ " \\@callnext\n"
+ " }\n"
+ " }\n"
+ " \\expandafter\\def\\expandafter\\@clausename\\expandafter{\\csname\\expandafter\\@gobble\\string#1@#2\\endcsname}\n"
+ " \\expandafter\\def\\expandafter\\@nextclausename\\expandafter{\\csname\\expandafter\\@gobble\\string#1@#2i\\endcsname}\n"
+ " \\expandafter\\expandafter\\expandafter\n"
+ " \\@defclause\\expandafter\\@clausename\\@nextclausename\n"
+ " \\expandafter\\newlyxcommand@def\\csname\\expandafter\\@gobble\\string#1@#2i\\endcsname{#3}\n"
+ "}\n"
+ "\n"
+ "% #1<-\\foo #2<-arity #3<-definition\n"
+ "\\def\\newlyxcommand@def#1#2#3{\n"
+ " \\ifx#20\n"
+ " \\def#1{#3}\n"
+ " \\else\n"
+ " \\def\\@splitargs##1#2##2.{\\def#1##1#2}\\@splitargs##1##2##3##4##5##6##7##8##9.{#3}\n"
+ " \\fi\n"
+ "}\n";
+
/////////////////////////////////////////////////////////////////////
//
// LaTeXFeatures
//
/////////////////////////////////////////////////////////////////////
-LaTeXFeatures::PackagesList LaTeXFeatures::packages_;
+LaTeXFeatures::Packages LaTeXFeatures::packages_;
LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
void LaTeXFeatures::require(string const & name)
{
- if (isRequired(name))
- return;
+ features_.insert(name);
+}
+
- features_.push_back(name);
+void LaTeXFeatures::require(set<string> const & names)
+{
+ features_.insert(names.begin(), names.end());
}
finished = true;
break;
default:
- string const name = lex.getString();
- PackagesList::const_iterator begin = packages_.begin();
- PackagesList::const_iterator end = packages_.end();
- if (find(begin, end, name) == end)
- packages_.push_back(name);
+ packages_.insert(lex.getString());
}
}
}
return;
}
- TextClass const & tclass = params_.getTextClass();
+ DocumentClass const & tclass = params_.documentClass();
if (tclass.hasLayout(layoutname)) {
// Is this layout already in usedLayouts?
- list<docstring>::const_iterator cit = usedLayouts_.begin();
- list<docstring>::const_iterator end = usedLayouts_.end();
- for (; cit != end; ++cit) {
- if (layoutname == *cit)
- return;
- }
+ if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
+ != usedLayouts_.end())
+ return;
+
+ Layout const & layout = tclass[layoutname];
+ require(layout.requires());
- LayoutPtr const & lyt = tclass[layoutname];
- if (!lyt->depends_on().empty()) {
+ if (!layout.depends_on().empty()) {
++level;
- useLayout(lyt->depends_on());
+ useLayout(layout.depends_on());
--level;
}
usedLayouts_.push_back(layoutname);
bool LaTeXFeatures::isRequired(string const & name) const
{
- return find(features_.begin(), features_.end(), name) != features_.end();
+ return features_.find(name) != features_.end();
}
bool LaTeXFeatures::mustProvide(string const & name) const
{
- return isRequired(name) && !params_.getTextClass().provides(name);
+ return isRequired(name) && !params_.documentClass().provides(name);
}
{
if (packages_.empty())
getAvailable();
- return find(packages_.begin(), packages_.end(), name) != packages_.end();
+ string n = name;
+ if (suffixIs(n, ".sty"))
+ n.erase(name.length() - 4);
+ return packages_.find(n) != packages_.end();
}
void LaTeXFeatures::addPreambleSnippet(string const & preamble)
{
- FeaturesList::const_iterator begin = preamble_snippets_.begin();
- FeaturesList::const_iterator end = preamble_snippets_.end();
+ SnippetList::const_iterator begin = preamble_snippets_.begin();
+ SnippetList::const_iterator end = preamble_snippets_.end();
if (find(begin, end, preamble) == end)
preamble_snippets_.push_back(preamble);
}
-void LaTeXFeatures::useFloat(string const & name)
+void LaTeXFeatures::useFloat(string const & name, bool subfloat)
{
- usedFloats_.insert(name);
+ if (!usedFloats_[name])
+ usedFloats_[name] = subfloat;
+ if (subfloat)
+ require("subfig");
// 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_.getTextClass().floats().getType(name);
+ Floating const & fl = params_.documentClass().floats().getType(name);
if (!fl.type().empty() && !fl.builtin()) {
require("float");
}
{
if (!lang->babel().empty())
UsedLanguages_.insert(lang);
+ // CJK languages do not have a babel name.
+ // They use the CJK package
+ if (lang->encoding()->package() == Encoding::CJK)
+ require("CJK");
}
"rotating",
"latexsym",
"pifont",
- "subfigure",
- "floatflt",
+ "subfig",
"varioref",
"prettyref",
+ /*For a successful cooperation of the `wrapfig' package with the
+ `float' package you should load the `wrapfig' package *after*
+ the `float' package. See the caption package documentation
+ for explanation.*/
"float",
+ "rotfloat",
+ "wrapfig",
"booktabs",
"dvipost",
"fancybox",
"calc",
- "nicefrac",
+ "units",
"tipa",
+ "tipx",
"framed",
- "pdfcolmk",
"soul",
"textcomp",
- "xcolor",
"pmboxdraw",
"bbding",
"ifsym",
"txfonts",
"mathrsfs",
"ascii",
+ "url",
+ "covington",
+ "csquotes",
+ "enumitem",
+ "endnotes",
+ "ifthen",
+ "amsthm",
+ "listings",
+ "bm"
};
int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
string const LaTeXFeatures::getPackages() const
{
ostringstream packages;
- TextClass const & tclass = params_.getTextClass();
+ DocumentClass const & tclass = params_.documentClass();
+
+ // FIXME: currently, we can only load packages and macros known
+ // to LyX.
+ // However, with the Require tag of layouts/custom insets,
+ // also inknown packages can be requested. They are silently
+ // swallowed now. We should change this eventually.
//
// These are all the 'simple' includes. i.e
params_.use_esint == BufferParams::package_off)) {
packages << "\\usepackage{amsmath}\n";
}
-
+
// wasysym is a simple feature, but it must be after amsmath if both
// are used
// wasysym redefines some integrals (e.g. iint) from amsmath. That
(params_.use_esint != BufferParams::package_off || !isRequired("esint")))
packages << "\\usepackage{wasysym}\n";
- // color.sty
- if (mustProvide("color")) {
+ // [x]color.sty
+ if (mustProvide("color") || mustProvide("xcolor")) {
+ string const package =
+ (mustProvide("xcolor") ? "xcolor" : "color");
if (params_.graphicsDriver == "default")
- packages << "\\usepackage{color}\n";
+ packages << "\\usepackage{" << package << "}\n";
else
packages << "\\usepackage["
<< params_.graphicsDriver
- << "]{color}\n";
+ << "]{" << package << "}\n";
+ }
+
+ // pdfcolmk must be loaded after color
+ if (mustProvide("pdfcolmk")) {
+ packages << "\\usepackage{pdfcolmk}\n";
}
// makeidx.sty
<< "]{graphicx}\n";
}
// shadecolor for shaded
- if (mustProvide("framed") && mustProvide("color")) {
- RGBColor c = RGBColor(lcolor.getX11Name(Color::shadedbg));
+ if (isRequired("framed") && mustProvide("color")) {
+ RGBColor c = rgbFromHexName(lcolor.getX11Name(Color_shadedbg));
//255.0 to force conversion to double
//NOTE As Jürgen Spitzmüller pointed out, an alternative would be
//to use the xcolor package instead, and then we can do
}
// setspace.sty
- if ((params_.spacing().getSpace() != Spacing::Single
- && !params_.spacing().isDefault())
- || isRequired("setspace")) {
- packages << "\\usepackage{setspace}\n";
- }
- switch (params_.spacing().getSpace()) {
- case Spacing::Default:
- case Spacing::Single:
- // we dont use setspace.sty so dont print anything
- //packages += "\\singlespacing\n";
- break;
- case Spacing::Onehalf:
- packages << "\\onehalfspacing\n";
- break;
- case Spacing::Double:
- packages << "\\doublespacing\n";
- break;
- case Spacing::Other:
- packages << "\\setstretch{"
- << params_.spacing().getValue() << "}\n";
- break;
- }
+ if (mustProvide("setspace") && !tclass.provides("SetSpace"))
+ packages << "\\usepackage{setspace}\n";
// amssymb.sty
if (mustProvide("amssymb")
params_.use_esint != BufferParams::package_off)
packages << "\\usepackage{esint}\n";
- // url.sty
- if (mustProvide("url"))
- packages << "\\IfFileExists{url.sty}{\\usepackage{url}}\n"
- " {\\newcommand{\\url}{\\texttt}}\n";
-
// natbib.sty
if (mustProvide("natbib")) {
packages << "\\usepackage[";
"\\makenomenclature\n";
}
- if (mustProvide("listings"))
- packages << "\\usepackage{listings}\n";
-
return packages.str();
}
if (!preamble_snippets_.empty())
macros << '\n';
- FeaturesList::const_iterator pit = preamble_snippets_.begin();
- FeaturesList::const_iterator pend = preamble_snippets_.end();
- for (; pit != pend; ++pit) {
+ SnippetList::const_iterator pit = preamble_snippets_.begin();
+ SnippetList::const_iterator pend = preamble_snippets_.end();
+ for (; pit != pend; ++pit)
macros << *pit << '\n';
- }
if (mustProvide("LyX"))
macros << lyx_def << '\n';
if (mustProvide("lyxarrow"))
macros << lyxarrow_def << '\n';
+ if (mustProvide("textgreek"))
+ macros << textgreek_def << '\n';
+
+ if (mustProvide("textcyr"))
+ macros << textcyr_def << '\n';
+
// quotes.
if (mustProvide("quotesinglbase"))
macros << quotesinglbase_def << '\n';
macros << binom_def << '\n';
if (mustProvide("mathcircumflex"))
macros << mathcircumflex_def << '\n';
+ if (mustProvide("newlyxcommand"))
+ macros << newlyxcommand_def << '\n';
// other
if (mustProvide("ParagraphLeftIndent"))
getFloatDefinitions(macros);
// change tracking
- if (mustProvide("ct-dvipost")) {
+ if (mustProvide("ct-dvipost"))
macros << changetracking_dvipost_def;
- }
+
if (mustProvide("ct-xcolor-soul")) {
int const prec = macros.precision(2);
- RGBColor cadd = RGBColor(lcolor.getX11Name(Color::addedtext));
+ RGBColor cadd = rgbFromHexName(lcolor.getX11Name(Color_addedtext));
macros << "\\providecolor{lyxadded}{rgb}{"
<< cadd.r / 255.0 << ',' << cadd.g / 255.0 << ',' << cadd.b / 255.0 << "}\n";
- RGBColor cdel = RGBColor(lcolor.getX11Name(Color::deletedtext));
+ RGBColor cdel = rgbFromHexName(lcolor.getX11Name(Color_deletedtext));
macros << "\\providecolor{lyxdeleted}{rgb}{"
<< cdel.r / 255.0 << ',' << cdel.g / 255.0 << ',' << cdel.b / 255.0 << "}\n";
macros.precision(prec);
-
- macros << "\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
- << "\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\st{#3}}}\n";
+
+ if (isRequired("hyperref"))
+ macros << changetracking_xcolor_soul_hyperref_def;
+ else
+ macros << changetracking_xcolor_soul_def;
}
- if (mustProvide("ct-none")) {
+
+ if (mustProvide("ct-none"))
macros << changetracking_none_def;
- }
return macros.str();
}
docstring const LaTeXFeatures::getTClassPreamble() const
{
// the text class specific preamble
- TextClass const & tclass = params_.getTextClass();
+ DocumentClass const & tclass = params_.documentClass();
odocstringstream tcpreamble;
tcpreamble << tclass.preamble();
list<docstring>::const_iterator cit = usedLayouts_.begin();
list<docstring>::const_iterator end = usedLayouts_.end();
for (; cit != end; ++cit) {
- tcpreamble << tclass[*cit]->preamble();
- }
-
- CharStyles::iterator cs = tclass.charstyles().begin();
- CharStyles::iterator csend = tclass.charstyles().end();
- for (; cs != csend; ++cs) {
- if (isRequired(cs->name))
- tcpreamble << cs->preamble;
+ tcpreamble << tclass[*cit].preamble();
}
return tcpreamble.str();
void LaTeXFeatures::getFloatDefinitions(ostream & os) const
{
- FloatList const & floats = params_.getTextClass().floats();
+ FloatList const & floats = params_.documentClass().floats();
// Here we will output the code to create the needed float styles.
// We will try to do this as minimal as possible.
UsedFloats::const_iterator end = usedFloats_.end();
// ostringstream floats;
for (; cit != end; ++cit) {
- Floating const & fl = floats.getType((*cit));
+ Floating const & fl = floats.getType((cit->first));
// For builtin floats we do nothing.
if (fl.builtin()) continue;
// used several times, when the same style is still in
// effect. (Lgb)
}
+ if (cit->second)
+ os << "\n\\newsubfloat{" << fl.type() << "}\n";
}
}