src/PDFOptions.cpp

   1 /**
   2  * \file PDFoptions.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Pavel Sanda
   7  * \author Jürgen Spitzmüller
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "PDFOptions.h"
  15
  16 #include "Encoding.h"
  17 #include "Lexer.h"
  18
  19 #include "support/convert.h"
  20 #include "support/debug.h"
  21 #include "support/lstrings.h"
  22
  23 #include <sstream>
  24 #include <string>
  25 #include <algorithm>
  26
  27 using namespace std;
  28 using namespace lyx::support;
  29
  30 namespace lyx {
  31
  32
  33 const string PDFOptions::pagemode_fullscreen("FullScreen");
  34
  35 bool PDFOptions::empty() const
  36 {
  37         PDFOptions x; //implicit hyperref settings
  38
  39         return  author == x.author
  40                 && title == x.title
  41                 && subject == x.subject
  42                 && keywords == x.keywords
  43                 && pagemode == x.pagemode
  44                 && quoted_options == x.quoted_options
  45                 && bookmarks == x.bookmarks
  46                 && bookmarksnumbered == x.bookmarksnumbered
  47                 && bookmarksopen == x.bookmarksopen
  48                 && bookmarksopenlevel == x.bookmarksopenlevel
  49                 && breaklinks == x.breaklinks
  50                 && pdfborder == x.pdfborder
  51                 && colorlinks == x.colorlinks
  52                 && backref == x.backref
  53                 && pdfusetitle == x.pdfusetitle;
  54 }
  55
  56
  57 void PDFOptions::writeFile(ostream & os) const
  58 {
  59         os << "\\use_hyperref " << convert<string>(use_hyperref) << '\n';
  60         if (!use_hyperref && empty())
  61                 return;
  62
  63         if (!title.empty() )
  64                 os << "\\pdf_title \"" << title << "\"\n";
  65         if (!author.empty())
  66                 os << "\\pdf_author \"" << author << "\"\n";
  67         if (!subject.empty())
  68                 os << "\\pdf_subject \"" << subject << "\"\n";
  69         if (!keywords.empty())
  70                 os << "\\pdf_keywords \"" << keywords << "\"\n";
  71
  72
  73         os << "\\pdf_bookmarks " << convert<string>(bookmarks) << '\n';
  74         os << "\\pdf_bookmarksnumbered " << convert<string>(bookmarksnumbered) << '\n';
  75         os << "\\pdf_bookmarksopen " << convert<string>(bookmarksopen) << '\n';
  76         os << "\\pdf_bookmarksopenlevel " << bookmarksopenlevel << '\n';
  77
  78         os << "\\pdf_breaklinks "  << convert<string>(breaklinks)  << '\n';
  79         os << "\\pdf_pdfborder "   << convert<string>(pdfborder)   << '\n';
  80         os << "\\pdf_colorlinks "  << convert<string>(colorlinks)  << '\n';
  81         os << "\\pdf_backref "     << backref << '\n';
  82         os << "\\pdf_pdfusetitle " << convert<string>(pdfusetitle) << '\n';
  83
  84         if (!pagemode.empty())
  85                 os << "\\pdf_pagemode " << pagemode << '\n';
  86
  87         if (!quoted_options.empty())
  88                 os << "\\pdf_quoted_options \"" << quoted_options << "\"\n";
  89 }
  90
  91
  92 void PDFOptions::writeLaTeX(OutputParams & runparams, otexstream & os,
  93                             bool hyperref_already_provided) const
  94 {
  95         // FIXME Unicode
  96         string opt;
  97         string hyperset;
  98
  99         // since LyX uses unicode, also set the PDF strings to unicode strings with the
 100         // hyperref option "unicode"
 101         opt += "unicode=true,";
 102
 103         // only use the hyperref settings if hyperref is enabled by the user
 104         // see bug #7052
 105         if (use_hyperref) {
 106                 // try to extract author and title from document when none is
 107                 // explicitly given
 108                 if (pdfusetitle && title.empty() && author.empty())
 109                         opt += "pdfusetitle,";
 110                 opt += "\n ";
 111                 opt += "bookmarks=" + convert<string>(bookmarks) + ',';
 112                 if (bookmarks) {
 113                         opt += "bookmarksnumbered=" + convert<string>(bookmarksnumbered) + ',';
 114                         opt += "bookmarksopen=" + convert<string>(bookmarksopen) + ',';
 115                         if (bookmarksopen)
 116                                 opt += "bookmarksopenlevel="
 117                                 + convert<string>(bookmarksopenlevel) + ',';
 118                 }
 119                 opt += "\n ";
 120                 opt += "breaklinks=" + convert<string>(breaklinks) + ',';
 121                 opt += "pdfborder={0 0 ";
 122                 opt += (pdfborder ? '0' : '1');
 123                 opt += "},";
 124                 opt += "backref=" + backref + ',';
 125                 opt += "colorlinks=" + convert<string>(colorlinks) + ',';
 126                 if (!pagemode.empty())
 127                         opt += "pdfpagemode=" + pagemode + ',';
 128
 129                 // load the pdftitle etc. as hypersetup, otherwise you'll get
 130                 // LaTeX-errors when using non-latin characters
 131                 if (!title.empty())
 132                         hyperset += "pdftitle={" + title + "},";
 133                 if (!author.empty())
 134                         hyperset += "\n pdfauthor={" + author + "},";
 135                 if (!subject.empty())
 136                         hyperset += "\n pdfsubject={" + subject + "},";
 137                 if (!keywords.empty())
 138                         hyperset += "\n pdfkeywords={" + keywords + "},";
 139                 if (!quoted_options.empty()){
 140                         hyperset += "\n ";
 141                         hyperset += quoted_options;
 142                 }
 143                 hyperset = rtrim(hyperset,",");
 144         }
 145
 146         // check if the hyperref settings use an encoding that exceeds
 147         // ours. If so, we have to switch to utf8.
 148         Encoding const * const enc = runparams.encoding;
 149         docstring const hs = from_utf8(hyperset);
 150         bool need_unicode = false;
 151         if (enc) {
 152                 for (size_t n = 0; n < hs.size(); ++n) {
 153                         if (!enc->encodable(hs[n]))
 154                                 need_unicode = true;
 155                 }
 156         }
 157
 158         // use in \\usepackage parameter as not all options can be handled inside \\hypersetup
 159         if (!hyperref_already_provided) {
 160                 opt = rtrim(opt, ",");
 161                 opt = "\\usepackage[" + opt + "]\n {hyperref}\n";
 162
 163                 if (!hyperset.empty())
 164                         opt += "\\hypersetup{" + hyperset + "}\n";
 165         } else {
 166                 // only in case hyperref is already loaded by the current text class
 167                 // try to put it into hyperset
 168                 //
 169                 // FIXME: rename in this case the PDF settings dialog checkbox
 170                 //  label from "Use Hyperref" to "Customize Hyperref Settings"
 171                 //  as discussd in bug #6293
 172                 opt = "\\hypersetup{" + rtrim(opt + hyperset, ",") + "}\n";
 173         }
 174
 175         // hyperref expects utf8!
 176         if (need_unicode && enc && enc->iconvName() != "UTF-8"
 177             &&!runparams.isFullUnicode()) {
 178                 os << "\\inputencoding{utf8}\n"
 179                    << setEncoding("UTF-8");
 180         }
 181         // If hyperref is loaded by the document class, we output
 182         // \hypersetup \AtBeginDocument if hypersetup is not (yet)
 183         // defined. In this case, the class loads hyperref late
 184         // (see bug #7048).
 185         if (hyperref_already_provided && !opt.empty()) {
 186                 os << "\\ifx\\hypersetup\\undefined\n"
 187                    << "  \\AtBeginDocument{%\n    "
 188                    << from_utf8(opt)
 189                    << "  }\n"
 190                    << "\\else\n  "
 191                    << from_utf8(opt)
 192                    << "\\fi\n";
 193         } else
 194                 os << from_utf8(opt);
 195
 196         if (need_unicode && enc && enc->iconvName() != "UTF-8"
 197             &&!runparams.isFullUnicode()) {
 198                 os << setEncoding(enc->iconvName())
 199                    << "\\inputencoding{" << from_ascii(enc->latexName()) << "}\n";
 200         }
 201 }
 202
 203
 204 string PDFOptions::readToken(Lexer &lex, string const & token)
 205 {
 206         if (token == "\\use_hyperref") {
 207                 lex >> use_hyperref;
 208         } else if (token == "\\pdf_title") {
 209                 lex >> title;
 210         } else if (token == "\\pdf_author") {
 211                 lex >> author;
 212         } else if (token == "\\pdf_subject") {
 213                 lex >> subject;
 214         } else if (token == "\\pdf_keywords") {
 215                 lex >> keywords;
 216         } else if (token == "\\pdf_bookmarks") {
 217                 lex >> bookmarks;
 218         } else if (token == "\\pdf_bookmarksnumbered") {
 219                 lex >> bookmarksnumbered;
 220         } else if (token == "\\pdf_bookmarksopen") {
 221                 lex >> bookmarksopen;
 222         } else if (token == "\\pdf_bookmarksopenlevel") {
 223                 lex >> bookmarksopenlevel;
 224         } else if (token == "\\pdf_breaklinks") {
 225                 lex >> breaklinks;
 226         } else if (token == "\\pdf_pdfborder") {
 227                 lex >> pdfborder;
 228         } else if (token == "\\pdf_colorlinks") {
 229                 lex >> colorlinks;
 230         } else if (token == "\\pdf_backref") {
 231                 lex >> backref;
 232         } else if (token == "\\pdf_pdfusetitle") {
 233                 lex >> pdfusetitle;
 234         } else if (token == "\\pdf_pagemode") {
 235                 lex >> pagemode;
 236         } else if (token == "\\pdf_quoted_options") {
 237                 lex >> quoted_options;
 238         } else {
 239                 return token;
 240         }
 241         return string();
 242 }
 243
 244
 245 // check the string from UI
 246 string PDFOptions::quoted_options_check(string const & str) const
 247 {
 248         return subst(str, "\n", "");
 249 }
 250
 251
 252 // set implicit settings for hyperref
 253 void PDFOptions::clear()
 254 {
 255         use_hyperref            = false;
 256         title.clear();
 257         author.clear();
 258         subject.clear();
 259         keywords.clear();
 260         bookmarks               = true;
 261         bookmarksnumbered       = false;
 262         bookmarksopen           = false;
 263         bookmarksopenlevel      = 1;
 264         breaklinks              = false;
 265         pdfborder               = false;
 266         colorlinks              = false;
 267         backref                 = "false";
 268         pagemode.clear();
 269         quoted_options.clear();
 270         pdfusetitle             = true;  //in contrast with hyperref
 271 }
 272
 273 } // namespace lyx