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  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "PDFOptions.h"
  14
  15 #include "support/convert.h"
  16 #include "support/lstrings.h"
  17 #include "support/debug.h"
  18 #include "Lexer.h"
  19
  20 #include <sstream>
  21 #include <string>
  22
  23 using namespace std;
  24 using namespace lyx::support;
  25
  26 namespace lyx {
  27
  28
  29 const string PDFOptions::pagemode_fullscreen("FullScreen");
  30
  31 bool PDFOptions::empty() const
  32 {
  33         PDFOptions x; //implicit hyperref settings
  34
  35         return  author == x.author
  36                 && title == x.title
  37                 && subject == x.subject
  38                 && keywords == x.keywords
  39                 && pagemode == x.pagemode
  40                 && quoted_options == x.quoted_options
  41                 && bookmarks == x.bookmarks
  42                 && bookmarksnumbered == x.bookmarksnumbered
  43                 && bookmarksopen == x.bookmarksopen
  44                 && bookmarksopenlevel == x.bookmarksopenlevel
  45                 && breaklinks == x.breaklinks
  46                 && pdfborder == x.pdfborder
  47                 && colorlinks == x.colorlinks
  48                 && backref == x.backref
  49                 && pagebackref == x.pagebackref
  50                 && pdfusetitle == x.pdfusetitle;
  51 }
  52
  53
  54 void PDFOptions::writeFile(ostream & os) const
  55 {
  56         os << "\\use_hyperref " << convert<string>(use_hyperref) << '\n';
  57         if (!use_hyperref && empty())
  58                 return;
  59
  60         if (!title.empty() )
  61                 os << "\\pdf_title \"" << title << "\"\n";
  62         if (!author.empty())
  63                 os << "\\pdf_author \"" << author << "\"\n";
  64         if (!subject.empty())
  65                 os << "\\pdf_subject \"" << subject << "\"\n";
  66         if (!keywords.empty())
  67                 os << "\\pdf_keywords \"" << keywords << "\"\n";
  68
  69
  70         os << "\\pdf_bookmarks " << convert<string>(bookmarks) << '\n';
  71         os << "\\pdf_bookmarksnumbered " << convert<string>(bookmarksnumbered) << '\n';
  72         os << "\\pdf_bookmarksopen " << convert<string>(bookmarksopen) << '\n';
  73         os << "\\pdf_bookmarksopenlevel " << bookmarksopenlevel << '\n';
  74
  75         os << "\\pdf_breaklinks "  << convert<string>(breaklinks)  << '\n';
  76         os << "\\pdf_pdfborder "   << convert<string>(pdfborder)   << '\n';
  77         os << "\\pdf_colorlinks "  << convert<string>(colorlinks)  << '\n';
  78         os << "\\pdf_backref "     << convert<string>(backref)     << '\n';
  79         os << "\\pdf_pagebackref " << convert<string>(pagebackref) << '\n';
  80         os << "\\pdf_pdfusetitle " << convert<string>(pdfusetitle) << '\n';
  81
  82         if (!pagemode.empty())
  83                 os << "\\pdf_pagemode " << pagemode << '\n';
  84
  85         if (!quoted_options.empty())
  86                 os << "\\pdf_quoted_options \"" << quoted_options << "\"\n";
  87 }
  88
  89
  90 void PDFOptions::writeLaTeX(odocstream & os, bool hyperref_already_provided) const
  91 {
  92         string opt;
  93
  94         // since LyX uses unicode, also set the PDF strings to unicode strings with the
  95         // hyperref option "unicode"
  96         opt += "unicode=true, ";
  97
  98         // try to extract author and title from document when none is
  99         // explicitely given
 100         if (pdfusetitle && title.empty() && author.empty())
 101                 opt += "pdfusetitle,";
 102         opt += "\n ";
 103
 104         opt += "bookmarks=" + convert<string>(bookmarks) + ',';
 105         if (bookmarks) {
 106                 opt += "bookmarksnumbered=" + convert<string>(bookmarksnumbered) + ',';
 107                 opt += "bookmarksopen=" + convert<string>(bookmarksopen) + ',';
 108                 if (bookmarksopen)
 109                         opt += "bookmarksopenlevel=" + convert<string>(bookmarksopenlevel) + ',';
 110         }
 111         opt += "\n ";
 112         opt += "breaklinks="     + convert<string>(breaklinks) + ',';
 113
 114         opt += "pdfborder={0 0 " ;
 115         opt += (pdfborder ?'0':'1');
 116         opt += "},";
 117
 118         opt += "backref="        + convert<string>(backref) + ',';
 119         opt += "pagebackref="    + convert<string>(pagebackref) + ',';
 120         opt += "\n ";
 121         opt += "colorlinks="     + convert<string>(colorlinks) + ',';
 122         if (!pagemode.empty())
 123                 opt += "pdfpagemode=" + pagemode + ',';
 124
 125
 126
 127         // load the pdftitle etc. as hypersetup, otherwise you'll get
 128         // LaTeX-errors when using non-latin characters
 129         string hyperset;
 130         if (!title.empty())
 131                 hyperset += "pdftitle={"   + title + "},";
 132         if (!author.empty())
 133                 hyperset += "\n pdfauthor={"  + author + "},";
 134         if (!subject.empty())
 135                 hyperset += "\n pdfsubject={" + subject + "},";
 136         if (!keywords.empty())
 137                 hyperset += "\n pdfkeywords={" + keywords + "},";
 138         if (!quoted_options.empty()){
 139                 hyperset += "\n ";
 140                 hyperset += quoted_options_get();
 141         }
 142         hyperset = rtrim(hyperset,",");
 143
 144
 145         // use in \\usepackage parameter as not all options can be handled inside \\hypersetup
 146         if (!hyperref_already_provided) {
 147                 opt = rtrim(opt,",");
 148                 opt = "\\usepackage[" + opt + "]\n {hyperref}\n";
 149
 150                 if (!hyperset.empty())
 151                         opt += "\\hypersetup{" + hyperset + "}\n ";
 152         } else
 153                 // only in case hyperref is already loaded by the current text class
 154                 // try to put it into hyperset
 155                 //
 156                 // FIXME: this still does not fix the cases where hyperref is loaded
 157                 //        and the option is active only when part of usepackage parameter
 158                 //        (e.g. pdfusetitle).
 159                 {
 160                         opt = "\\hypersetup{" + opt + hyperset + "}\n ";
 161                 }
 162
 163         // FIXME UNICODE
 164         os << from_utf8(opt);
 165 }
 166
 167
 168 string PDFOptions::readToken(Lexer &lex, string const & token)
 169 {
 170         if (token == "\\use_hyperref") {
 171                 lex >> use_hyperref;
 172         } else if (token == "\\pdf_title") {
 173                 lex >> title;
 174         } else if (token == "\\pdf_author") {
 175                 lex >> author;
 176         } else if (token == "\\pdf_subject") {
 177                 lex >> subject;
 178         } else if (token == "\\pdf_keywords") {
 179                 lex >> keywords;
 180         } else if (token == "\\pdf_bookmarks") {
 181                 lex >> bookmarks;
 182         } else if (token == "\\pdf_bookmarksnumbered") {
 183                 lex >> bookmarksnumbered;
 184         } else if (token == "\\pdf_bookmarksopen") {
 185                 lex >> bookmarksopen;
 186         } else if (token == "\\pdf_bookmarksopenlevel") {
 187                 lex >> bookmarksopenlevel;
 188         } else if (token == "\\pdf_breaklinks") {
 189                 lex >> breaklinks;
 190         } else if (token == "\\pdf_pdfborder") {
 191                 lex >> pdfborder;
 192         } else if (token == "\\pdf_colorlinks") {
 193                 lex >> colorlinks;
 194         } else if (token == "\\pdf_backref") {
 195                 lex >> backref;
 196         } else if (token == "\\pdf_pagebackref") {
 197                 lex >> pagebackref;
 198         } else if (token == "\\pdf_pdfusetitle") {
 199                 lex >> pdfusetitle;
 200         } else if (token == "\\pdf_pagemode") {
 201                 lex >> pagemode;
 202         } else if (token == "\\pdf_quoted_options") {
 203                 lex >> quoted_options;
 204         } else {
 205                 return token;
 206         }
 207         return string();
 208 }
 209
 210
 211 // prepared for check
 212 string PDFOptions::quoted_options_get() const
 213 {
 214         return quoted_options;
 215 }
 216
 217
 218 // set implicit settings for hyperref
 219 void PDFOptions::clear()
 220 {
 221         use_hyperref            = false;
 222         title.clear();
 223         author.clear();
 224         subject.clear();
 225         keywords.clear();
 226         bookmarks               = true;
 227         bookmarksnumbered       = false;
 228         bookmarksopen           = false;
 229         bookmarksopenlevel      = 1;
 230         breaklinks              = false;
 231         pdfborder               = false;
 232         colorlinks              = false;
 233         backref                 = false;
 234         pagebackref             = false;
 235         pagemode.clear();
 236         quoted_options.clear();
 237         pdfusetitle             = true;  //in contrast with hyperref
 238 }
 239
 240 } // namespace lyx