mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-09-20 15:01:58 +00:00
c52bd08442
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@29255 a592a061-630c-0410-9148-cb99ea01b6c8
1048 lines
30 KiB
C++
1048 lines
30 KiB
C++
/**
|
|
* \file LaTeXFeatures.cpp
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author José Matos
|
|
* \author Lars Gullik Bjønnes
|
|
* \author Jean-Marc Lasgouttes
|
|
* \author Jürgen Vigna
|
|
* \author André Pönitz
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#include <config.h>
|
|
|
|
#include "LaTeXFeatures.h"
|
|
|
|
#include "Buffer.h"
|
|
#include "BufferParams.h"
|
|
#include "ColorSet.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"
|
|
|
|
using namespace std;
|
|
using namespace lyx::support;
|
|
|
|
|
|
namespace lyx {
|
|
|
|
/////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Strings
|
|
//
|
|
/////////////////////////////////////////////////////////////////////
|
|
|
|
//\NeedsTeXFormat{LaTeX2e}
|
|
//\ProvidesPackage{lyx}[1996/01/11 LLE v0.2 (LyX LaTeX Extensions)]
|
|
//\message{LyX LaTeX Extensions (LLE v0.2) of 11-Jan-1996.}
|
|
|
|
static string const lyx_def =
|
|
"\\providecommand{\\LyX}{L\\kern-.1667em\\lower.25em\\hbox{Y}\\kern-.125emX\\@}";
|
|
|
|
static string const lyxline_def =
|
|
"\\newcommand{\\lyxline}[1][1pt]{%\n"
|
|
" \\par\\noindent%\n"
|
|
" \\rule[.5ex]{\\linewidth}{#1}\\par}";
|
|
|
|
static string const noun_def = "\\newcommand{\\noun}[1]{\\textsc{#1}}";
|
|
|
|
static string const lyxarrow_def =
|
|
"\\DeclareRobustCommand*{\\lyxarrow}{%\n"
|
|
"\\@ifstar\n"
|
|
"{\\leavevmode\\,$\\triangleleft$\\,\\allowbreak}\n"
|
|
"{\\leavevmode\\,$\\triangleright$\\,\\allowbreak}}";
|
|
|
|
// for quotes without babel. This does not give perfect results, but
|
|
// anybody serious about non-english quotes should use babel (JMarc).
|
|
|
|
static string const quotedblbase_def =
|
|
"\\ProvideTextCommandDefault{\\quotedblbase}{%\n"
|
|
" \\raisebox{-1.4ex}[1ex][.5ex]{\\textquotedblright}%\n"
|
|
" \\penalty10000\\hskip0em\\relax%\n"
|
|
"}";
|
|
|
|
static string const quotesinglbase_def =
|
|
"\\ProvideTextCommandDefault{\\quotesinglbase}{%\n"
|
|
" \\raisebox{-1.4ex}[1ex][.5ex]{\\textquoteright}%\n"
|
|
" \\penalty10000\\hskip0em\\relax%\n"
|
|
"}";
|
|
|
|
static string const guillemotleft_def =
|
|
"\\ProvideTextCommandDefault{\\guillemotleft}{%\n"
|
|
" {\\usefont{U}{lasy}{m}{n}\\char'50\\kern-.15em\\char'50}%\n"
|
|
"\\penalty10000\\hskip0pt\\relax%\n"
|
|
"}";
|
|
|
|
static string const guillemotright_def =
|
|
"\\ProvideTextCommandDefault{\\guillemotright}{%\n"
|
|
" \\penalty10000\\hskip0pt%\n"
|
|
" {\\usefont{U}{lasy}{m}{n}\\char'51\\kern-.15em\\char'51}%\n"
|
|
"}";
|
|
|
|
static string const guilsinglleft_def =
|
|
"\\ProvideTextCommandDefault{\\guilsinglleft}{%\n"
|
|
" {\\usefont{U}{lasy}{m}{n}\\char'50}%\n"
|
|
" \\penalty10000\\hskip0pt\\relax%\n"
|
|
"}";
|
|
|
|
static string const guilsinglright_def =
|
|
"\\ProvideTextCommandDefault{\\guilsinglright}{%\n"
|
|
" \\penalty10000\\hskip0pt%\n"
|
|
" {\\usefont{U}{lasy}{m}{n}\\char'51}%\n"
|
|
"}";
|
|
|
|
static string const paragraphleftindent_def =
|
|
"\\newenvironment{LyXParagraphLeftIndent}[1]%\n"
|
|
"{\n"
|
|
" \\begin{list}{}{%\n"
|
|
" \\setlength{\\topsep}{0pt}%\n"
|
|
" \\addtolength{\\leftmargin}{#1}\n"
|
|
// ho hum, yet more things commented out with no hint as to why they
|
|
// weren't just removed
|
|
// "%% \\addtolength{\\leftmargin}{#1\\textwidth}\n"
|
|
// "%% \\setlength{\\textwidth}{#2\\textwidth}\n"
|
|
// "%% \\setlength\\listparindent\\parindent%\n"
|
|
// "%% \\setlength\\itemindent\\parindent%\n"
|
|
" \\setlength{\\parsep}{0pt plus 1pt}%\n"
|
|
" }\n"
|
|
" \\item[]\n"
|
|
"}\n"
|
|
"{\\end{list}}\n";
|
|
|
|
static string const floatingfootnote_def =
|
|
"%% Special footnote code from the package 'stblftnt.sty'\n"
|
|
"%% Author: Robin Fairbairns -- Last revised Dec 13 1996\n"
|
|
"\\let\\SF@@footnote\\footnote\n"
|
|
"\\def\\footnote{\\ifx\\protect\\@typeset@protect\n"
|
|
" \\expandafter\\SF@@footnote\n"
|
|
" \\else\n"
|
|
" \\expandafter\\SF@gobble@opt\n"
|
|
" \\fi\n"
|
|
"}\n"
|
|
"\\expandafter\\def\\csname SF@gobble@opt \\endcsname{\\@ifnextchar[%]\n"
|
|
" \\SF@gobble@twobracket\n"
|
|
" \\@gobble\n"
|
|
"}\n"
|
|
"\\edef\\SF@gobble@opt{\\noexpand\\protect\n"
|
|
" \\expandafter\\noexpand\\csname SF@gobble@opt \\endcsname}\n"
|
|
"\\def\\SF@gobble@twobracket[#1]#2{}\n";
|
|
|
|
static string const binom_def =
|
|
"%% Binom macro for standard LaTeX users\n"
|
|
"\\newcommand{\\binom}[2]{{#1 \\choose #2}}\n";
|
|
|
|
static string const mathcircumflex_def =
|
|
"%% For printing a cirumflex inside a formula\n"
|
|
"\\newcommand{\\mathcircumflex}[0]{\\mbox{\\^{}}}\n";
|
|
|
|
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";
|
|
|
|
// We want to omit the file extension for includegraphics, but this does not
|
|
// work when the filename contains other dots.
|
|
// Idea from http://www.tex.ac.uk/cgi-bin/texfaq2html?label=unkgrfextn
|
|
static string const lyxdot_def =
|
|
"%% A simple dot to overcome graphicx limitations\n"
|
|
"\\newcommand{\\lyxdot}{.}\n";
|
|
|
|
static string const changetracking_dvipost_def =
|
|
"%% Change tracking with dvipost\n"
|
|
"\\dvipostlayout\n"
|
|
"\\dvipost{osstart color push Red}\n"
|
|
"\\dvipost{osend color pop}\n"
|
|
"\\dvipost{cbstart color push Blue}\n"
|
|
"\\dvipost{cbend color pop}\n"
|
|
"\\newcommand{\\lyxadded}[3]{\\changestart#3\\changeend}\n"
|
|
"\\newcommand{\\lyxdeleted}[3]{%\n"
|
|
"\\changestart\\overstrikeon#3\\overstrikeoff\\changeend}\n";
|
|
|
|
static string const changetracking_xcolor_ulem_def =
|
|
"%% Change tracking with ulem\n"
|
|
"\\newcommand{\\lyxadded}[3]{{\\color{lyxadded}#3}}\n"
|
|
"\\newcommand{\\lyxdeleted}[3]{{\\color{lyxdeleted}\\sout{#3}}}\n";
|
|
|
|
static string const changetracking_xcolor_ulem_hyperref_def =
|
|
"%% Change tracking with ulem\n"
|
|
"\\newcommand{\\lyxadded}[3]{{\\texorpdfstring{\\color{lyxadded}}{}#3}}\n"
|
|
"\\newcommand{\\lyxdeleted}[3]{{\\texorpdfstring{\\color{lyxdeleted}\\sout{#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\\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\\def\\encodingdefault{T2A}}\n"
|
|
"\\DeclareRobustCommand{\\textcyr}[1]{\\leavevmode{\\cyrtext #1}}\n"
|
|
"\\AtBeginDocument{\\DeclareFontEncoding{T2A}{}{}}\n";
|
|
|
|
static string const lyxmathsym_def =
|
|
"\\newcommand{\\lyxmathsym}[1]{\\ifmmode\\begingroup\\def\\b@ld{bold}\n"
|
|
" \\text{\\ifx\\math@version\\b@ld\\bfseries\\fi#1}\\endgroup\\else#1\\fi}\n";
|
|
|
|
static string const papersizedvi_def =
|
|
"\\special{papersize=\\the\\paperwidth,\\the\\paperheight}\n";
|
|
|
|
static string const papersizepdf_def =
|
|
"\\pdfpageheight\\paperheight\n"
|
|
"\\pdfpagewidth\\paperwidth\n";
|
|
|
|
static string const cedilla_def =
|
|
"\\newcommand{\\docedilla}[2]{\\underaccent{#1\\mathchar'30}{#2}}\n"
|
|
"\\newcommand{\\cedilla}[1]{\\mathpalette\\docedilla{#1}}\n";
|
|
|
|
static string const subring_def =
|
|
"\\newcommand{\\dosubring}[2]{\\underaccent{#1\\mathchar'27}{#2}}\n"
|
|
"\\newcommand{\\subring}[1]{\\mathpalette\\dosubring{#1}}\n";
|
|
|
|
static string const subdot_def =
|
|
"\\newcommand{\\dosubdot}[2]{\\underaccent{#1.}{#2}}\n"
|
|
"\\newcommand{\\subdot}[1]{\\mathpalette\\dosubdot{#1}}\n";
|
|
|
|
static string const subhat_def =
|
|
"\\newcommand{\\dosubhat}[2]{\\underaccent{#1\\mathchar'136}{#2}}\n"
|
|
"\\newcommand{\\subhat}[1]{\\mathpalette\\dosubhat{#1}}\n";
|
|
|
|
static string const subtilde_def =
|
|
"\\newcommand{\\dosubtilde}[2]{\\underaccent{#1\\mathchar'176}{#2}}\n"
|
|
"\\newcommand{\\subtilde}[1]{\\mathpalette\\dosubtilde{#1}}\n";
|
|
|
|
static string const dacute_def =
|
|
"\\DeclareMathAccent{\\dacute}{\\mathalpha}{operators}{'175}\n";
|
|
|
|
static string const tipasymb_def =
|
|
"\\DeclareFontEncoding{T3}{}{}\n"
|
|
"\\DeclareSymbolFont{tipasymb}{T3}{cmr}{m}{n}\n";
|
|
|
|
static string const dgrave_def =
|
|
"\\DeclareMathAccent{\\dgrave}{\\mathord}{tipasymb}{'15}\n";
|
|
|
|
static string const rcap_def =
|
|
"\\DeclareMathAccent{\\rcap}{\\mathord}{tipasymb}{'20}\n";
|
|
|
|
static string const ogonek_def =
|
|
"\\newcommand{\\doogonek}[2]{\\setbox0=\\hbox{$#1#2$}\\underaccent{#1\\mkern-6mu\n"
|
|
" \\ifx#2O\\hskip0.5\\wd0\\else\\ifx#2U\\hskip0.5\\wd0\\else\\hskip\\wd0\\fi\\fi\n"
|
|
" \\ifx#2o\\mkern-2mu\\else\\ifx#2e\\mkern-1mu\\fi\\fi\n"
|
|
" \\mathchar\"0\\hexnumber@\\symtipasymb0C}{#2}}\n"
|
|
"\\newcommand{\\ogonek}[1]{\\mathpalette\\doogonek{#1}}\n";
|
|
|
|
/////////////////////////////////////////////////////////////////////
|
|
//
|
|
// LaTeXFeatures
|
|
//
|
|
/////////////////////////////////////////////////////////////////////
|
|
|
|
LaTeXFeatures::Packages LaTeXFeatures::packages_;
|
|
|
|
|
|
LaTeXFeatures::LaTeXFeatures(Buffer const & b, BufferParams const & p,
|
|
OutputParams const & r)
|
|
: buffer_(&b), params_(p), runparams_(r), in_float_(false)
|
|
{}
|
|
|
|
|
|
bool LaTeXFeatures::useBabel() const
|
|
{
|
|
return lyxrc.language_use_babel ||
|
|
(bufferParams().language->lang() != lyxrc.default_language &&
|
|
!bufferParams().language->babel().empty()) ||
|
|
this->hasLanguages();
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::require(string const & name)
|
|
{
|
|
features_.insert(name);
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::require(set<string> const & names)
|
|
{
|
|
features_.insert(names.begin(), names.end());
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::getAvailable()
|
|
{
|
|
Lexer lex;
|
|
support::FileName const real_file = libFileSearch("", "packages.lst");
|
|
|
|
if (real_file.empty())
|
|
return;
|
|
|
|
lex.setFile(real_file);
|
|
|
|
if (!lex.isOK())
|
|
return;
|
|
|
|
// Make sure that we are clean
|
|
packages_.clear();
|
|
|
|
bool finished = false;
|
|
// Parse config-file
|
|
while (lex.isOK() && !finished) {
|
|
switch (lex.lex()) {
|
|
case Lexer::LEX_FEOF:
|
|
finished = true;
|
|
break;
|
|
default:
|
|
packages_.insert(lex.getString());
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::useLayout(docstring 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 "
|
|
<< to_utf8(layoutname) << endl;
|
|
return;
|
|
}
|
|
|
|
DocumentClass const & tclass = params_.documentClass();
|
|
if (tclass.hasLayout(layoutname)) {
|
|
// Is this layout already in usedLayouts?
|
|
if (find(usedLayouts_.begin(), usedLayouts_.end(), layoutname)
|
|
!= usedLayouts_.end())
|
|
return;
|
|
|
|
Layout const & layout = tclass[layoutname];
|
|
require(layout.requires());
|
|
|
|
if (!layout.depends_on().empty()) {
|
|
++level;
|
|
useLayout(layout.depends_on());
|
|
--level;
|
|
}
|
|
usedLayouts_.push_back(layoutname);
|
|
} else {
|
|
lyxerr << "LaTeXFeatures::useLayout: layout `"
|
|
<< to_utf8(layoutname) << "' does not exist in this class"
|
|
<< endl;
|
|
}
|
|
|
|
--level;
|
|
}
|
|
|
|
|
|
bool LaTeXFeatures::isRequired(string const & name) const
|
|
{
|
|
return features_.find(name) != features_.end();
|
|
}
|
|
|
|
|
|
bool LaTeXFeatures::mustProvide(string const & name) const
|
|
{
|
|
return isRequired(name) && !params_.documentClass().provides(name);
|
|
}
|
|
|
|
|
|
bool LaTeXFeatures::isAvailable(string const & name)
|
|
{
|
|
if (packages_.empty())
|
|
getAvailable();
|
|
string n = name;
|
|
if (suffixIs(n, ".sty"))
|
|
n.erase(name.length() - 4);
|
|
return packages_.find(n) != packages_.end();
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::addPreambleSnippet(string const & preamble)
|
|
{
|
|
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, bool subfloat)
|
|
{
|
|
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_.documentClass().floats().getType(name);
|
|
if (!fl.type().empty() && !fl.builtin()) {
|
|
require("float");
|
|
}
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::useLanguage(Language const * lang)
|
|
{
|
|
if (!lang->babel().empty())
|
|
UsedLanguages_.insert(lang);
|
|
if (lang->lang() == "vietnamese")
|
|
require("vietnamese");
|
|
// CJK languages do not have a babel name.
|
|
// They use the CJK package
|
|
if (lang->encoding()->package() == Encoding::CJK)
|
|
require("CJK");
|
|
// japanese package is special
|
|
if (lang->encoding()->package() == Encoding::japanese)
|
|
require("japanese");
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::includeFile(docstring const & key, string const & name)
|
|
{
|
|
IncludedFiles_[key] = name;
|
|
}
|
|
|
|
|
|
bool LaTeXFeatures::hasLanguages() const
|
|
{
|
|
return !UsedLanguages_.empty();
|
|
}
|
|
|
|
|
|
string LaTeXFeatures::getLanguages() const
|
|
{
|
|
ostringstream languages;
|
|
|
|
LanguageList::const_iterator const begin = UsedLanguages_.begin();
|
|
for (LanguageList::const_iterator cit = begin;
|
|
cit != UsedLanguages_.end();
|
|
++cit) {
|
|
if (cit != begin)
|
|
languages << ',';
|
|
languages << (*cit)->babel();
|
|
}
|
|
return languages.str();
|
|
}
|
|
|
|
|
|
set<string> LaTeXFeatures::getEncodingSet(string const & doc_encoding) const
|
|
{
|
|
// This does only find encodings of languages supported by babel, but
|
|
// that does not matter since we don't have a language with an
|
|
// encoding supported by inputenc but without babel support.
|
|
set<string> encodings;
|
|
LanguageList::const_iterator it = UsedLanguages_.begin();
|
|
LanguageList::const_iterator end = UsedLanguages_.end();
|
|
for (; it != end; ++it)
|
|
if ((*it)->encoding()->latexName() != doc_encoding &&
|
|
((*it)->encoding()->package() == Encoding::inputenc
|
|
|| (*it)->encoding()->package() == Encoding::japanese))
|
|
encodings.insert((*it)->encoding()->latexName());
|
|
return encodings;
|
|
}
|
|
|
|
namespace {
|
|
|
|
char const * simplefeatures[] = {
|
|
// note that the package order here will be the same in the LaTeX-output
|
|
"array",
|
|
"verbatim",
|
|
"longtable",
|
|
"rotating",
|
|
"latexsym",
|
|
"pifont",
|
|
// subfig is handled in BufferParams.cpp
|
|
"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",
|
|
"units",
|
|
"tipa",
|
|
"tipx",
|
|
"framed",
|
|
"soul",
|
|
"textcomp",
|
|
"pmboxdraw",
|
|
"bbding",
|
|
"ifsym",
|
|
"marvosym",
|
|
"txfonts",
|
|
"mathrsfs",
|
|
"ascii",
|
|
"url",
|
|
"covington",
|
|
"csquotes",
|
|
"enumitem",
|
|
"endnotes",
|
|
"ifthen",
|
|
"amsthm",
|
|
// listings is handled in BufferParams.cpp
|
|
"bm",
|
|
"pdfpages",
|
|
"amscd",
|
|
"slashed"
|
|
};
|
|
|
|
int const nb_simplefeatures = sizeof(simplefeatures) / sizeof(char const *);
|
|
|
|
}
|
|
|
|
|
|
string const LaTeXFeatures::getColorOptions() const
|
|
{
|
|
ostringstream colors;
|
|
|
|
// Handling the color packages separately is needed to be able to load them
|
|
// before babel when hyperref is loaded with the colorlinks option
|
|
// for more info see Bufferparams.cpp
|
|
|
|
// [x]color.sty
|
|
if (mustProvide("color") || mustProvide("xcolor")) {
|
|
string const package =
|
|
(mustProvide("xcolor") ? "xcolor" : "color");
|
|
if (params_.graphicsDriver == "default"
|
|
|| params_.graphicsDriver == "none")
|
|
colors << "\\usepackage{" << package << "}\n";
|
|
else
|
|
colors << "\\usepackage["
|
|
<< params_.graphicsDriver
|
|
<< "]{" << package << "}\n";
|
|
}
|
|
|
|
// pdfcolmk must be loaded after color
|
|
if (mustProvide("pdfcolmk"))
|
|
colors << "\\usepackage{pdfcolmk}\n";
|
|
|
|
if (mustProvide("pagecolor")) {
|
|
// the \pagecolor command must be set after color is loaded and
|
|
// before pdfpages, therefore add the command here
|
|
// define the set color
|
|
colors << "\\definecolor{page_backgroundcolor}{rgb}{";
|
|
colors << outputLaTeXColor(params_.backgroundcolor) << "}\n";
|
|
// set the page color
|
|
colors << "\\pagecolor{page_backgroundcolor}\n";
|
|
}
|
|
|
|
return colors.str();
|
|
}
|
|
|
|
|
|
string const LaTeXFeatures::getPackages() const
|
|
{
|
|
ostringstream packages;
|
|
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
|
|
// packages which we just \usepackage{package}
|
|
//
|
|
for (int i = 0; i < nb_simplefeatures; ++i) {
|
|
if (mustProvide(simplefeatures[i]))
|
|
packages << "\\usepackage{"
|
|
<< simplefeatures[i] << "}\n";
|
|
}
|
|
|
|
//
|
|
// The rest of these packages are somewhat more complicated
|
|
// than those above.
|
|
//
|
|
|
|
// esint is preferred for esintoramsmath
|
|
if ((mustProvide("amsmath")
|
|
&& params_.use_amsmath != BufferParams::package_off)
|
|
|| (mustProvide("esintoramsmath")
|
|
&& params_.use_esint == BufferParams::package_off
|
|
&& params_.use_amsmath != BufferParams::package_off)) {
|
|
packages << "\\usepackage{amsmath}\n";
|
|
} else {
|
|
// amsbsy and amstext are already provided by amsmath
|
|
if (mustProvide("amsbsy"))
|
|
packages << "\\usepackage{amsbsy}\n";
|
|
if (mustProvide("amstext"))
|
|
packages << "\\usepackage{amstext}\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
|
|
// leads to inconsistent integrals. We only load this package if
|
|
// the document does not contain integrals (then isRequired("esint")
|
|
// is false) or if esint is used, since esint redefines all relevant
|
|
// integral symbols from wasysym and amsmath.
|
|
// See http://bugzilla.lyx.org/show_bug.cgi?id=1942
|
|
if (mustProvide("wasysym") &&
|
|
(params_.use_esint != BufferParams::package_off || !isRequired("esint")))
|
|
packages << "\\usepackage{wasysym}\n";
|
|
|
|
// accents must be loaded after amsmath
|
|
if (mustProvide("accents"))
|
|
packages << "\\usepackage{accents}\n";
|
|
|
|
// [x]color and pdfcolmk are handled in getColorOptions() above
|
|
|
|
// makeidx.sty
|
|
if (isRequired("makeidx") || isRequired("splitidx")) {
|
|
if (!tclass.provides("makeidx") && !isRequired("splitidx"))
|
|
packages << "\\usepackage{makeidx}\n";
|
|
if (!tclass.provides("splitidx") && isRequired("splitidx"))
|
|
packages << "\\usepackage{splitidx}\n";
|
|
packages << "\\makeindex\n";
|
|
}
|
|
|
|
// graphicx.sty
|
|
if (mustProvide("graphicx") && params_.graphicsDriver != "none") {
|
|
if (params_.graphicsDriver == "default")
|
|
packages << "\\usepackage{graphicx}\n";
|
|
else
|
|
packages << "\\usepackage["
|
|
<< params_.graphicsDriver
|
|
<< "]{graphicx}\n";
|
|
}
|
|
// shadecolor for shaded
|
|
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
|
|
// \define{shadcolor}{RGB}...
|
|
//and not do any conversion. We'd then need to require xcolor
|
|
//in InsetNote::validate().
|
|
int const stmSize = packages.precision(2);
|
|
packages << "\\definecolor{shadecolor}{rgb}{"
|
|
<< c.r / 255.0 << ',' << c.g / 255.0 << ',' << c.b / 255.0 << "}\n";
|
|
packages.precision(stmSize);
|
|
}
|
|
|
|
// lyxskak.sty --- newer chess support based on skak.sty
|
|
if (mustProvide("chess"))
|
|
packages << "\\usepackage[ps,mover]{lyxskak}\n";
|
|
|
|
// setspace.sty
|
|
if (mustProvide("setspace") && !tclass.provides("SetSpace"))
|
|
packages << "\\usepackage{setspace}\n";
|
|
|
|
// amssymb.sty
|
|
if (mustProvide("amssymb")
|
|
|| params_.use_amsmath == BufferParams::package_on)
|
|
packages << "\\usepackage{amssymb}\n";
|
|
|
|
// esint must be after amsmath and wasysym, since it will redeclare
|
|
// inconsistent integral symbols
|
|
if ((mustProvide("esint") || mustProvide("esintoramsmath")) &&
|
|
params_.use_esint != BufferParams::package_off)
|
|
packages << "\\usepackage{esint}\n";
|
|
|
|
// natbib.sty
|
|
// Some classes load natbib themselves, but still allow (or even require)
|
|
// plain numeric citations (ReVTeX is such a case, see bug 5182).
|
|
// This special case is indicated by the "natbib-internal" key.
|
|
if (mustProvide("natbib") && !tclass.provides("natbib-internal")) {
|
|
packages << "\\usepackage[";
|
|
if (params_.citeEngine() == ENGINE_NATBIB_NUMERICAL)
|
|
packages << "numbers";
|
|
else
|
|
packages << "authoryear";
|
|
packages << "]{natbib}\n";
|
|
}
|
|
|
|
// jurabib -- we need version 0.6 at least.
|
|
if (mustProvide("jurabib"))
|
|
packages << "\\usepackage{jurabib}[2004/01/25]\n";
|
|
|
|
// xargs -- we need version 1.09 at least
|
|
if (mustProvide("xargs"))
|
|
packages << "\\usepackage{xargs}[2008/03/08]\n";
|
|
|
|
// bibtopic -- the dot provides the aux file naming which
|
|
// LyX can detect.
|
|
if (mustProvide("bibtopic"))
|
|
packages << "\\usepackage[dot]{bibtopic}\n";
|
|
|
|
if (mustProvide("xy"))
|
|
packages << "\\usepackage[all]{xy}\n";
|
|
|
|
if (mustProvide("ulem"))
|
|
packages << "\\PassOptionsToPackage{normalem}{ulem}\n"
|
|
"\\usepackage{ulem}\n";
|
|
|
|
if (mustProvide("nomencl")) {
|
|
// Make it work with the new and old version of the package,
|
|
// but don't use the compatibility option since it is
|
|
// incompatible to other packages.
|
|
packages << "\\usepackage{nomencl}\n"
|
|
"% the following is useful when we have the old nomencl.sty package\n"
|
|
"\\providecommand{\\printnomenclature}{\\printglossary}\n"
|
|
"\\providecommand{\\makenomenclature}{\\makeglossary}\n"
|
|
"\\makenomenclature\n";
|
|
}
|
|
|
|
return packages.str();
|
|
}
|
|
|
|
|
|
string const LaTeXFeatures::getMacros() const
|
|
{
|
|
ostringstream macros;
|
|
|
|
if (!preamble_snippets_.empty())
|
|
macros << '\n';
|
|
SnippetList::const_iterator pit = preamble_snippets_.begin();
|
|
SnippetList::const_iterator pend = preamble_snippets_.end();
|
|
for (; pit != pend; ++pit)
|
|
macros << *pit << '\n';
|
|
|
|
if (mustProvide("papersize")) {
|
|
if (runparams_.flavor == OutputParams::LATEX)
|
|
macros << papersizedvi_def << '\n';
|
|
else
|
|
macros << papersizepdf_def << '\n';
|
|
}
|
|
|
|
if (mustProvide("LyX"))
|
|
macros << lyx_def << '\n';
|
|
|
|
if (mustProvide("lyxline"))
|
|
macros << lyxline_def << '\n';
|
|
|
|
if (mustProvide("noun"))
|
|
macros << noun_def << '\n';
|
|
|
|
if (mustProvide("lyxarrow"))
|
|
macros << lyxarrow_def << '\n';
|
|
|
|
if (mustProvide("textgreek"))
|
|
macros << textgreek_def << '\n';
|
|
|
|
if (mustProvide("textcyr"))
|
|
macros << textcyr_def << '\n';
|
|
|
|
if (mustProvide("lyxmathsym"))
|
|
macros << lyxmathsym_def << '\n';
|
|
|
|
if (mustProvide("cedilla"))
|
|
macros << cedilla_def << '\n';
|
|
|
|
if (mustProvide("subring"))
|
|
macros << subring_def << '\n';
|
|
|
|
if (mustProvide("subdot"))
|
|
macros << subdot_def << '\n';
|
|
|
|
if (mustProvide("subhat"))
|
|
macros << subhat_def << '\n';
|
|
|
|
if (mustProvide("subtilde"))
|
|
macros << subtilde_def << '\n';
|
|
|
|
if (mustProvide("dacute"))
|
|
macros << dacute_def << '\n';
|
|
|
|
if (mustProvide("tipasymb"))
|
|
macros << tipasymb_def << '\n';
|
|
|
|
if (mustProvide("dgrave"))
|
|
macros << dgrave_def << '\n';
|
|
|
|
if (mustProvide("rcap"))
|
|
macros << rcap_def << '\n';
|
|
|
|
if (mustProvide("ogonek"))
|
|
macros << ogonek_def << '\n';
|
|
|
|
// quotes.
|
|
if (mustProvide("quotesinglbase"))
|
|
macros << quotesinglbase_def << '\n';
|
|
if (mustProvide("quotedblbase"))
|
|
macros << quotedblbase_def << '\n';
|
|
if (mustProvide("guilsinglleft"))
|
|
macros << guilsinglleft_def << '\n';
|
|
if (mustProvide("guilsinglright"))
|
|
macros << guilsinglright_def << '\n';
|
|
if (mustProvide("guillemotleft"))
|
|
macros << guillemotleft_def << '\n';
|
|
if (mustProvide("guillemotright"))
|
|
macros << guillemotright_def << '\n';
|
|
|
|
// Math mode
|
|
if (mustProvide("binom") && !isRequired("amsmath"))
|
|
macros << binom_def << '\n';
|
|
if (mustProvide("mathcircumflex"))
|
|
macros << mathcircumflex_def << '\n';
|
|
|
|
// other
|
|
if (mustProvide("ParagraphLeftIndent"))
|
|
macros << paragraphleftindent_def;
|
|
if (mustProvide("NeedLyXFootnoteCode"))
|
|
macros << floatingfootnote_def;
|
|
|
|
// some problems with tex->html converters
|
|
if (mustProvide("NeedTabularnewline"))
|
|
macros << tabularnewline_def;
|
|
|
|
// greyedout environment (note inset)
|
|
if (mustProvide("lyxgreyedout"))
|
|
macros << lyxgreyedout_def;
|
|
|
|
if (mustProvide("lyxdot"))
|
|
macros << lyxdot_def << '\n';
|
|
|
|
// floats
|
|
getFloatDefinitions(macros);
|
|
|
|
// change tracking
|
|
if (mustProvide("ct-dvipost"))
|
|
macros << changetracking_dvipost_def;
|
|
|
|
if (mustProvide("ct-xcolor-ulem")) {
|
|
int const prec = macros.precision(2);
|
|
|
|
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 = 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);
|
|
|
|
if (isRequired("hyperref"))
|
|
macros << changetracking_xcolor_ulem_hyperref_def;
|
|
else
|
|
macros << changetracking_xcolor_ulem_def;
|
|
}
|
|
|
|
if (mustProvide("ct-none"))
|
|
macros << changetracking_none_def;
|
|
|
|
return macros.str();
|
|
}
|
|
|
|
|
|
string const LaTeXFeatures::getBabelOptions() const
|
|
{
|
|
ostringstream tmp;
|
|
|
|
LanguageList::const_iterator it = UsedLanguages_.begin();
|
|
LanguageList::const_iterator end = UsedLanguages_.end();
|
|
for (; it != end; ++it)
|
|
if (!(*it)->latex_options().empty())
|
|
tmp << (*it)->latex_options() << '\n';
|
|
if (!params_.language->latex_options().empty())
|
|
tmp << params_.language->latex_options() << '\n';
|
|
|
|
return tmp.str();
|
|
}
|
|
|
|
|
|
docstring const LaTeXFeatures::getTClassPreamble() const
|
|
{
|
|
// the text class specific preamble
|
|
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();
|
|
|
|
return tcpreamble.str();
|
|
}
|
|
|
|
|
|
docstring const LaTeXFeatures::getTClassI18nPreamble(bool use_babel) const
|
|
{
|
|
DocumentClass const & tclass = params_.documentClass();
|
|
// collect preamble snippets in a set to prevent multiple identical
|
|
// commands (would happen if e.g. both theorem and theorem* are used)
|
|
set<docstring> snippets;
|
|
typedef LanguageList::const_iterator lang_it;
|
|
lang_it const lbeg = UsedLanguages_.begin();
|
|
lang_it const lend = UsedLanguages_.end();
|
|
list<docstring>::const_iterator cit = usedLayouts_.begin();
|
|
list<docstring>::const_iterator end = usedLayouts_.end();
|
|
for (; cit != end; ++cit) {
|
|
// language dependent commands (once per document)
|
|
snippets.insert(tclass[*cit].langpreamble(buffer().language()));
|
|
// commands for language changing (for multilanguage documents)
|
|
if (use_babel && !UsedLanguages_.empty()) {
|
|
snippets.insert(tclass[*cit].babelpreamble(buffer().language()));
|
|
for (lang_it lit = lbeg; lit != lend; ++lit)
|
|
snippets.insert(tclass[*cit].babelpreamble(*lit));
|
|
}
|
|
}
|
|
|
|
odocstringstream tcpreamble;
|
|
set<docstring>::const_iterator const send = snippets.end();
|
|
set<docstring>::const_iterator it = snippets.begin();
|
|
for (; it != send; ++it)
|
|
tcpreamble << *it;
|
|
return tcpreamble.str();
|
|
}
|
|
|
|
|
|
docstring const LaTeXFeatures::getLyXSGMLEntities() const
|
|
{
|
|
// Definition of entities used in the document that are LyX related.
|
|
odocstringstream entities;
|
|
|
|
if (mustProvide("lyxarrow")) {
|
|
entities << "<!ENTITY lyxarrow \"->\">" << '\n';
|
|
}
|
|
|
|
return entities.str();
|
|
}
|
|
|
|
|
|
docstring const LaTeXFeatures::getIncludedFiles(string const & fname) const
|
|
{
|
|
odocstringstream sgmlpreamble;
|
|
// FIXME UNICODE
|
|
docstring const basename(from_utf8(onlyPath(fname)));
|
|
|
|
FileMap::const_iterator end = IncludedFiles_.end();
|
|
for (FileMap::const_iterator fi = IncludedFiles_.begin();
|
|
fi != end; ++fi)
|
|
// FIXME UNICODE
|
|
sgmlpreamble << "\n<!ENTITY " << fi->first
|
|
<< (isSGMLFilename(fi->second) ? " SYSTEM \"" : " \"")
|
|
<< makeRelPath(from_utf8(fi->second), basename) << "\">";
|
|
|
|
return sgmlpreamble.str();
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::showStruct() const
|
|
{
|
|
lyxerr << "LyX needs the following commands when LaTeXing:"
|
|
<< "\n***** Packages:" << getPackages()
|
|
<< "\n***** Macros:" << getMacros()
|
|
<< "\n***** Textclass stuff:" << to_utf8(getTClassPreamble())
|
|
<< "\n***** done." << endl;
|
|
}
|
|
|
|
|
|
Buffer const & LaTeXFeatures::buffer() const
|
|
{
|
|
return *buffer_;
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::setBuffer(Buffer const & buffer)
|
|
{
|
|
buffer_ = &buffer;
|
|
}
|
|
|
|
|
|
BufferParams const & LaTeXFeatures::bufferParams() const
|
|
{
|
|
return params_;
|
|
}
|
|
|
|
|
|
void LaTeXFeatures::getFloatDefinitions(ostream & os) const
|
|
{
|
|
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.
|
|
// \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->first));
|
|
|
|
// 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)
|
|
}
|
|
if (cit->second)
|
|
os << "\n\\newsubfloat{" << fl.type() << "}\n";
|
|
}
|
|
}
|
|
|
|
|
|
} // namespace lyx
|