* Licence details can be found in the file COPYING.
*
* \author Pavel Sanda
+ * \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*/
-
-#include "config.h"
+#include <config.h>
#include "PDFOptions.h"
-#include <sstream>
-#include <string>
+#include "Encoding.h"
+#include "Lexer.h"
+
#include "support/convert.h"
+#include "support/debug.h"
#include "support/lstrings.h"
-#include "debug.h"
-#include "Lexer.h"
+#include <sstream>
+#include <string>
+#include <algorithm>
-namespace lyx {
+using namespace std;
+using namespace lyx::support;
+namespace lyx {
-using std::ostream;
-using std::ostringstream;
-using std::string;
const string PDFOptions::pagemode_fullscreen("FullScreen");
bool PDFOptions::empty() const
{
- return
- author.empty() &&
- title.empty() &&
- subject.empty() &&
- keywords.empty()&&
- pagemode.empty()&&
- bookmarksopenlevel.empty() &&
- quoted_options.empty();
+ 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';
- os << "\\pdf_store_options " << convert<string>(store_options) << '\n';
- if (!use_hyperref && !store_options) return;
+ if (!use_hyperref && empty())
+ return;
if (!title.empty() )
- os << "\\pdf_title \"" << title << "\"\n";
+ os << "\\pdf_title \"" << title << "\"\n";
if (!author.empty())
- os << "\\pdf_author \"" << author << "\"\n";
+ os << "\\pdf_author \"" << author << "\"\n";
if (!subject.empty())
- os << "\\pdf_subject \"" << subject << "\"\n";
+ os << "\\pdf_subject \"" << subject << "\"\n";
if (!keywords.empty())
- os << "\\pdf_keywords \"" << keywords << "\"\n";
+ 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';
- if (bookmarksopenlevel.empty())
- os << "\\pdf_bookmarksopenlevel \"" << bookmarksopenlevel << "\"\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 " << convert<string>(backref) << '\n';
- os << "\\pdf_pagebackref " << convert<string>(pagebackref) << '\n';
+ os << "\\pdf_backref " << backref << '\n';
+ os << "\\pdf_pdfusetitle " << convert<string>(pdfusetitle) << '\n';
if (!pagemode.empty())
- os << "\\pdf_pagemode " << pagemode << '\n';
+ os << "\\pdf_pagemode " << pagemode << '\n';
if (!quoted_options.empty())
- os << "\\pdf_quoted_options \"" << quoted_options << "\"\n";
+ os << "\\pdf_quoted_options \"" << quoted_options << "\"\n";
}
-void PDFOptions::writeLaTeX(odocstream &os) const
+
+void PDFOptions::writeLaTeX(OutputParams & runparams, otexstream & os,
+ bool hyperref_already_provided) const
{
- if (!use_hyperref) return ;
-
+ // FIXME Unicode
string opt;
+ string hyperset;
- opt = "\\usepackage[";
- if (!title.empty())
- opt += "pdftitle={" + title + "},\n";
- if (!author.empty())
- opt += "pdfauthor={" + author + "},\n";
- if (!subject.empty())
- opt += "pdfsubject={" + subject + "},\n";
- if (!keywords.empty())
- opt += "pdfkeywords={" + keywords + "},\n";
-
- opt += "bookmarks=" + convert<string>(bookmarks) + ',';
- if (bookmarks) {
- opt += "bookmarksnumbered=" + convert<string>(bookmarksnumbered) + ',';
- opt += "bookmarksopen=" + convert<string>(bookmarksopen) + ',';
-
- if (bookmarksopen && !bookmarksopenlevel.empty())
- opt += "bookmarksopennumbered=" + bookmarksopenlevel + ',';
+ // since LyX uses unicode, also set the PDF strings to unicode strings with the
+ // hyperref option "unicode"
+ opt += "unicode=true,";
+
+ // only use the hyperref settings if hyperref is enabled by the user
+ // see bug #7052
+ if (use_hyperref) {
+ // try to extract author and title from document when none is
+ // explicitly 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
+ 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,",");
}
-
- opt += "breaklinks=" + convert<string>(breaklinks) + ',';
-
- opt += "pdfborder={0 0 " ;
- opt += (pdfborder ?'1':'0');
- opt += "},\n";
-
- opt += "colorlinks=" + convert<string>(colorlinks) + ',';
- opt += "backref=" + convert<string>(backref) + ',';
- opt += "pagebackref=" + convert<string>(pagebackref) + ',';
-
- if (!pagemode.empty())
- opt += "pdfpagemode=" + pagemode + ',';
- opt += quoted_options_get();
-
- opt = support::rtrim(opt,",");
- opt += "]{hyperref}\n";
-
- // FIXME UNICODE
+
+ // check if the hyperref settings use an encoding that exceeds
+ // ours. If so, we have to switch to utf8.
+ Encoding const * const enc = runparams.encoding;
+ docstring const hs = from_utf8(hyperset);
+ bool need_unicode = false;
+ if (enc) {
+ for (size_t n = 0; n < hs.size(); ++n) {
+ if (enc->latexChar(hs[n], true) != docstring(1, hs[n]))
+ need_unicode = true;
+ }
+ }
+
+ // 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: rename in this case the PDF settings dialog checkbox
+ // label from "Use Hyperref" to "Customize Hyperref Settings"
+ // as discussd in bug #6293
+ opt = "\\hypersetup{" + opt + hyperset + "}\n";
+ }
+
+ // hyperref expects utf8!
+ if (need_unicode && enc && enc->iconvName() != "UTF-8"
+ &&!runparams.isFullUnicode()) {
+ os << "\\inputencoding{utf8}\n"
+ << setEncoding("UTF-8");
+ }
+ // If hyperref is loaded by the document class, we output
+ // \hypersetup \AtBeginDocument, since the class might
+ // load hyperref late, see bug #7048.
+ if (hyperref_already_provided && !opt.empty())
+ os << "\\AtBeginDocument{%\n";
os << from_utf8(opt);
+ if (hyperref_already_provided && !opt.empty())
+ os << "}";
+
+ if (need_unicode && enc && enc->iconvName() != "UTF-8"
+ &&!runparams.isFullUnicode()) {
+ os << setEncoding(enc->iconvName())
+ << "\\inputencoding{" << from_ascii(enc->latexName()) << "}\n";
+ }
}
+
string PDFOptions::readToken(Lexer &lex, string const & token)
{
if (token == "\\use_hyperref") {
- lex >> use_hyperref;
+ lex >> use_hyperref;
} else if (token == "\\pdf_title") {
lex >> title;
} else if (token == "\\pdf_author") {
} else if (token == "\\pdf_bookmarksnumbered") {
lex >> bookmarksnumbered;
} else if (token == "\\pdf_bookmarksopen") {
- lex >> bookmarksopenlevel;
+ lex >> bookmarksopen;
} else if (token == "\\pdf_bookmarksopenlevel") {
lex >> bookmarksopenlevel;
} else if (token == "\\pdf_breaklinks") {
lex >> colorlinks;
} else if (token == "\\pdf_backref") {
lex >> backref;
- } else if (token == "\\pdf_pagebackref") {
- lex >> pagebackref;
+ } else if (token == "\\pdf_pdfusetitle") {
+ lex >> pdfusetitle;
} else if (token == "\\pdf_pagemode") {
lex >> pagemode;
} else if (token == "\\pdf_quoted_options") {
lex >> quoted_options;
- } else if (token == "\\pdf_store_options") {
- lex >> store_options;
} else {
return token;
}
return string();
}
-//prepared for check
-string PDFOptions::quoted_options_get() const
+
+// check the string from UI
+string PDFOptions::quoted_options_check(string const str) const
{
- return quoted_options;
+ return subst(str, "\n", "");
}
-// Keep implicit hyperref settings
+
+// set implicit settings for hyperref
void PDFOptions::clear()
{
use_hyperref = false;
bookmarks = true;
bookmarksnumbered = false;
bookmarksopen = false;
- bookmarksopenlevel.clear();
+ bookmarksopenlevel = 1;
breaklinks = false;
pdfborder = false;
colorlinks = false;
- backref = false;
- pagebackref = false;
+ backref = "false";
pagemode.clear();
quoted_options.clear();
- store_options = false;
-
+ pdfusetitle = true; //in contrast with hyperref
}
} // namespace lyx