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 int PDFOptions::writeLaTeX(OutputParams & runparams, odocstream & os,
  93                             bool hyperref_already_provided) const
  94 {
  95         int lines = 0;
  96         // FIXME Unicode
  97         string opt;
  98         string hyperset;
  99
 100         // since LyX uses unicode, also set the PDF strings to unicode strings with the
 101         // hyperref option "unicode"
 102         opt += "unicode=true,";
 103
 104         // only use the hyperref settings if hyperref is enabled by the user
 105         // see bug #7052
 106         if(use_hyperref) {
 107                 // try to extract author and title from document when none is
 108                 // explicitly given
 109                 if (pdfusetitle && title.empty() && author.empty())
 110                         opt += "pdfusetitle,";
 111                 opt += "\n ";
 112                 opt += "bookmarks=" + convert<string>(bookmarks) + ',';
 113                 if (bookmarks) {
 114                         opt += "bookmarksnumbered=" + convert<string>(bookmarksnumbered) + ',';
 115                         opt += "bookmarksopen=" + convert<string>(bookmarksopen) + ',';
 116                         if (bookmarksopen)
 117                                 opt += "bookmarksopenlevel="
 118                                 + convert<string>(bookmarksopenlevel) + ',';
 119                 }
 120                 opt += "\n ";
 121                 opt += "breaklinks=" + convert<string>(breaklinks) + ',';
 122                 opt += "pdfborder={0 0 ";
 123                 opt += (pdfborder ? '0' : '1');
 124                 opt += "},";
 125                 opt += "backref=" + backref + ',';
 126                 opt += "colorlinks=" + convert<string>(colorlinks) + ',';
 127                 if (!pagemode.empty())
 128                         opt += "pdfpagemode=" + pagemode + ',';
 129
 130                 // load the pdftitle etc. as hypersetup, otherwise you'll get
 131                 // LaTeX-errors when using non-latin characters
 132                 if (!title.empty())
 133                         hyperset += "pdftitle={" + title + "},";
 134                 if (!author.empty())
 135                         hyperset += "\n pdfauthor={" + author + "},";
 136                 if (!subject.empty())
 137                         hyperset += "\n pdfsubject={" + subject + "},";
 138                 if (!keywords.empty())
 139                         hyperset += "\n pdfkeywords={" + keywords + "},";
 140                 if (!quoted_options.empty()){
 141                         hyperset += "\n ";
 142                         hyperset += quoted_options;
 143                 }
 144                 hyperset = rtrim(hyperset,",");
 145
 146         }
 147
 148         // check if the hyperref settings use an encoding that exceeds
 149         // ours. If so, we have to switch to utf8.
 150         Encoding const * const enc = runparams.encoding;
 151         docstring const hs = from_utf8(hyperset);
 152         bool need_unicode = false;
 153         if (enc) {
 154                 for (size_t n = 0; n < hs.size(); ++n) {
 155                         if (enc->latexChar(hs[n], true) != docstring(1, hs[n]))
 156                                 need_unicode = true;
 157                 }
 158         }
 159
 160         // use in \\usepackage parameter as not all options can be handled inside \\hypersetup
 161         if (!hyperref_already_provided) {
 162                 opt = rtrim(opt, ",");
 163                 opt = "\\usepackage[" + opt + "]\n {hyperref}\n";
 164
 165                 if (!hyperset.empty())
 166                         opt += "\\hypersetup{" + hyperset + "}\n";
 167         } else {
 168                 // only in case hyperref is already loaded by the current text class
 169                 // try to put it into hyperset
 170                 //
 171                 // FIXME: rename in this case the PDF settings dialog checkbox
 172                 //  label from "Use Hyperref" to "Customize Hyperref Settings"
 173                 //  as discussd in bug #6293
 174                 opt = "\\hypersetup{" + opt + hyperset + "}\n";
 175         }
 176
 177         lines = int(count(opt.begin(), opt.end(), '\n'));
 178
 179         // hyperref expects utf8!
 180         if (need_unicode && enc && enc->iconvName() != "UTF-8"
 181             &&!runparams.isFullUnicode()) {
 182                 os << "\\inputencoding{utf8}\n"
 183                    << setEncoding("UTF-8");
 184                 ++lines;
 185         }
 186         // FIXME: handle the case that hyperref is loaded by the document class and
 187         // hyperset is empty, see bug #7048
 188         if (!(hyperref_already_provided && hyperset.empty()))
 189                 os << from_utf8(opt);
 190
 191         if (need_unicode && enc && enc->iconvName() != "UTF-8"
 192             &&!runparams.isFullUnicode()) {
 193                 os << setEncoding(enc->iconvName())
 194                    << "\\inputencoding{" << from_ascii(enc->latexName()) << "}\n";
 195                 ++lines;
 196         }
 197         return lines;
 198 }
 199
 200
 201 string PDFOptions::readToken(Lexer &lex, string const & token)
 202 {
 203         if (token == "\\use_hyperref") {
 204                 lex >> use_hyperref;
 205         } else if (token == "\\pdf_title") {
 206                 lex >> title;
 207         } else if (token == "\\pdf_author") {
 208                 lex >> author;
 209         } else if (token == "\\pdf_subject") {
 210                 lex >> subject;
 211         } else if (token == "\\pdf_keywords") {
 212                 lex >> keywords;
 213         } else if (token == "\\pdf_bookmarks") {
 214                 lex >> bookmarks;
 215         } else if (token == "\\pdf_bookmarksnumbered") {
 216                 lex >> bookmarksnumbered;
 217         } else if (token == "\\pdf_bookmarksopen") {
 218                 lex >> bookmarksopen;
 219         } else if (token == "\\pdf_bookmarksopenlevel") {
 220                 lex >> bookmarksopenlevel;
 221         } else if (token == "\\pdf_breaklinks") {
 222                 lex >> breaklinks;
 223         } else if (token == "\\pdf_pdfborder") {
 224                 lex >> pdfborder;
 225         } else if (token == "\\pdf_colorlinks") {
 226                 lex >> colorlinks;
 227         } else if (token == "\\pdf_backref") {
 228                 lex >> backref;
 229         } else if (token == "\\pdf_pdfusetitle") {
 230                 lex >> pdfusetitle;
 231         } else if (token == "\\pdf_pagemode") {
 232                 lex >> pagemode;
 233         } else if (token == "\\pdf_quoted_options") {
 234                 lex >> quoted_options;
 235         } else {
 236                 return token;
 237         }
 238         return string();
 239 }
 240
 241
 242 // check the string from UI
 243 string PDFOptions::quoted_options_check(string const str) const
 244 {
 245         return subst(str, "\n", "");
 246 }
 247
 248
 249 // set implicit settings for hyperref
 250 void PDFOptions::clear()
 251 {
 252         use_hyperref            = false;
 253         title.clear();
 254         author.clear();
 255         subject.clear();
 256         keywords.clear();
 257         bookmarks               = true;
 258         bookmarksnumbered       = false;
 259         bookmarksopen           = false;
 260         bookmarksopenlevel      = 1;
 261         breaklinks              = false;
 262         pdfborder               = false;
 263         colorlinks              = false;
 264         backref                 = "false";
 265         pagemode.clear();
 266         quoted_options.clear();
 267         pdfusetitle             = true;  //in contrast with hyperref
 268 }
 269
 270 } // namespace lyx