lyx_mirror/src/PDFOptions.cpp
Pavel Sanda 308e2d9df3 Sanitize backreferences in hyperref.
http://bugzilla.lyx.org/show_bug.cgi?id=5340
http://www.mail-archive.com/lyx-devel@lists.lyx.org/msg144958.html



git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@26882 a592a061-630c-0410-9148-cb99ea01b6c8
2008-10-13 16:01:02 +00:00

235 lines
6.3 KiB
C++

/**
* \file PDFoptions.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Pavel Sanda
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "PDFOptions.h"
#include "Lexer.h"
#include "support/convert.h"
#include "support/debug.h"
#include "support/lstrings.h"
#include <sstream>
#include <string>
using namespace std;
using namespace lyx::support;
namespace lyx {
const string PDFOptions::pagemode_fullscreen("FullScreen");
bool PDFOptions::empty() const
{
PDFOptions x; //implicit hyperref settings
return author == x.author
&& title == x.title
&& subject == x.subject
&& keywords == x.keywords
&& pagemode == x.pagemode
&& quoted_options == x.quoted_options
&& bookmarks == x.bookmarks
&& bookmarksnumbered == x.bookmarksnumbered
&& bookmarksopen == x.bookmarksopen
&& bookmarksopenlevel == x.bookmarksopenlevel
&& breaklinks == x.breaklinks
&& pdfborder == x.pdfborder
&& colorlinks == x.colorlinks
&& backref == x.backref
&& pdfusetitle == x.pdfusetitle;
}
void PDFOptions::writeFile(ostream & os) const
{
os << "\\use_hyperref " << convert<string>(use_hyperref) << '\n';
if (!use_hyperref && empty())
return;
if (!title.empty() )
os << "\\pdf_title \"" << title << "\"\n";
if (!author.empty())
os << "\\pdf_author \"" << author << "\"\n";
if (!subject.empty())
os << "\\pdf_subject \"" << subject << "\"\n";
if (!keywords.empty())
os << "\\pdf_keywords \"" << keywords << "\"\n";
os << "\\pdf_bookmarks " << convert<string>(bookmarks) << '\n';
os << "\\pdf_bookmarksnumbered " << convert<string>(bookmarksnumbered) << '\n';
os << "\\pdf_bookmarksopen " << convert<string>(bookmarksopen) << '\n';
os << "\\pdf_bookmarksopenlevel " << bookmarksopenlevel << '\n';
os << "\\pdf_breaklinks " << convert<string>(breaklinks) << '\n';
os << "\\pdf_pdfborder " << convert<string>(pdfborder) << '\n';
os << "\\pdf_colorlinks " << convert<string>(colorlinks) << '\n';
os << "\\pdf_backref " << backref << '\n';
os << "\\pdf_pdfusetitle " << convert<string>(pdfusetitle) << '\n';
if (!pagemode.empty())
os << "\\pdf_pagemode " << pagemode << '\n';
if (!quoted_options.empty())
os << "\\pdf_quoted_options \"" << quoted_options << "\"\n";
}
void PDFOptions::writeLaTeX(odocstream & os, bool hyperref_already_provided) const
{
string opt;
// since LyX uses unicode, also set the PDF strings to unicode strings with the
// hyperref option "unicode"
opt += "unicode=true, ";
// try to extract author and title from document when none is
// explicitely given
if (pdfusetitle && title.empty() && author.empty())
opt += "pdfusetitle,";
opt += "\n ";
opt += "bookmarks=" + convert<string>(bookmarks) + ',';
if (bookmarks) {
opt += "bookmarksnumbered=" + convert<string>(bookmarksnumbered) + ',';
opt += "bookmarksopen=" + convert<string>(bookmarksopen) + ',';
if (bookmarksopen)
opt += "bookmarksopenlevel=" + convert<string>(bookmarksopenlevel) + ',';
}
opt += "\n ";
opt += "breaklinks=" + convert<string>(breaklinks) + ',';
opt += "pdfborder={0 0 " ;
opt += (pdfborder ?'0':'1');
opt += "},";
opt += "backref=" + backref + ',';
opt += "colorlinks=" + convert<string>(colorlinks) + ',';
if (!pagemode.empty())
opt += "pdfpagemode=" + pagemode + ',';
// load the pdftitle etc. as hypersetup, otherwise you'll get
// LaTeX-errors when using non-latin characters
string hyperset;
if (!title.empty())
hyperset += "pdftitle={" + title + "},";
if (!author.empty())
hyperset += "\n pdfauthor={" + author + "},";
if (!subject.empty())
hyperset += "\n pdfsubject={" + subject + "},";
if (!keywords.empty())
hyperset += "\n pdfkeywords={" + keywords + "},";
if (!quoted_options.empty()){
hyperset += "\n ";
hyperset += quoted_options;
}
hyperset = rtrim(hyperset,",");
// use in \\usepackage parameter as not all options can be handled inside \\hypersetup
if (!hyperref_already_provided) {
opt = rtrim(opt,",");
opt = "\\usepackage[" + opt + "]\n {hyperref}\n";
if (!hyperset.empty())
opt += "\\hypersetup{" + hyperset + "}\n ";
} else
// only in case hyperref is already loaded by the current text class
// try to put it into hyperset
//
// FIXME: this still does not fix the cases where hyperref is loaded
// and the option is active only when part of usepackage parameter
// (e.g. pdfusetitle).
{
opt = "\\hypersetup{" + opt + hyperset + "}\n ";
}
// FIXME UNICODE
os << from_utf8(opt);
}
string PDFOptions::readToken(Lexer &lex, string const & token)
{
if (token == "\\use_hyperref") {
lex >> use_hyperref;
} else if (token == "\\pdf_title") {
lex >> title;
} else if (token == "\\pdf_author") {
lex >> author;
} else if (token == "\\pdf_subject") {
lex >> subject;
} else if (token == "\\pdf_keywords") {
lex >> keywords;
} else if (token == "\\pdf_bookmarks") {
lex >> bookmarks;
} else if (token == "\\pdf_bookmarksnumbered") {
lex >> bookmarksnumbered;
} else if (token == "\\pdf_bookmarksopen") {
lex >> bookmarksopen;
} else if (token == "\\pdf_bookmarksopenlevel") {
lex >> bookmarksopenlevel;
} else if (token == "\\pdf_breaklinks") {
lex >> breaklinks;
} else if (token == "\\pdf_pdfborder") {
lex >> pdfborder;
} else if (token == "\\pdf_colorlinks") {
lex >> colorlinks;
} else if (token == "\\pdf_backref") {
lex >> backref;
} else if (token == "\\pdf_pdfusetitle") {
lex >> pdfusetitle;
} else if (token == "\\pdf_pagemode") {
lex >> pagemode;
} else if (token == "\\pdf_quoted_options") {
lex >> quoted_options;
} else {
return token;
}
return string();
}
// check the string from UI
string PDFOptions::quoted_options_check(string const str) const
{
return subst(str, "\n", "");
}
// set implicit settings for hyperref
void PDFOptions::clear()
{
use_hyperref = false;
title.clear();
author.clear();
subject.clear();
keywords.clear();
bookmarks = true;
bookmarksnumbered = false;
bookmarksopen = false;
bookmarksopenlevel = 1;
breaklinks = false;
pdfborder = false;
colorlinks = false;
backref = "false";
pagemode.clear();
quoted_options.clear();
pdfusetitle = true; //in contrast with hyperref
}
} // namespace lyx