]> git.lyx.org Git - lyx.git/blobdiff - src/bufferparams.C
"Inter-word Space"
[lyx.git] / src / bufferparams.C
index 0d73595781c0de04710986b417685c4f103d3774..d4c166aaf828de5bfeebfc15af4780e810ff738d 100644 (file)
 
 #include <config.h>
 
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
 #include "bufferparams.h"
 #include "tex-strings.h"
+#include "encoding.h"
 #include "layout.h"
 #include "vspace.h"
 #include "debug.h"
 #include "language.h"
 #include "lyxtextclasslist.h"
 #include "lyxlex.h"
+#include "Lsstream.h"
+#include "author.h"
+#include "gettext.h"
 
+#include "support/lyxalgo.h" // for lyx::count
 #include "support/lyxlib.h"
 #include "support/lstrings.h"
+#include "support/types.h"
+
+#include "frontends/Alert.h"
 
 #include <cstdlib>
+#include <algorithm>
 
 using std::ostream;
 using std::endl;
+using std::pair;
+
 
 BufferParams::BufferParams()
        // Initialize textclass to point to article. if `first' is
@@ -51,9 +58,10 @@ BufferParams::BufferParams()
        paperpackage = PACKAGE_NONE;
        orientation = ORIENTATION_PORTRAIT;
        use_geometry = false;
-       use_amsmath = false;
+       use_amsmath = AMS_AUTO;
        use_natbib = false;
        use_numerical_citations = false;
+       tracking_changes = false;
        secnumdepth = 3;
        tocdepth = 3;
        language = default_language;
@@ -70,6 +78,261 @@ BufferParams::BufferParams()
 }
 
 
+string const BufferParams::readToken(LyXLex & lex, string const & token)
+{
+       if (token == "\\textclass") {
+               lex.eatLine();
+               string const classname = lex.getString();
+               pair<bool, lyx::textclass_type> pp =
+                       textclasslist.NumberOfClass(classname);
+               if (pp.first) {
+                       textclass = pp.second;
+               } else {
+                       textclass = 0;
+                       return classname;
+               }
+               if (!getLyXTextClass().isTeXClassAvailable()) {
+                       string msg = bformat(_("The document uses a missing "
+                               "TeX class \"%1$s\".\n"), classname);
+                       Alert::warning(_("Document class not available"),
+                                      msg + _("LyX will not be able to produce output."));
+               }
+       } else if (token == "\\begin_preamble") {
+               readPreamble(lex);
+       } else if (token == "\\options") {
+               lex.eatLine();
+               options = lex.getString();
+       } else if (token == "\\language") {
+               readLanguage(lex);
+       } else if (token == "\\inputencoding") {
+               lex.eatLine();
+               inputenc = lex.getString();
+       } else if (token == "\\graphics") {
+               readGraphicsDriver(lex);
+       } else if (token == "\\fontscheme") {
+               lex.eatLine();
+               fonts = lex.getString();
+       } else if (token == "\\paragraph_separation") {
+               int tmpret = lex.findToken(string_paragraph_separation);
+               if (tmpret == -1)
+                       ++tmpret;
+               paragraph_separation =
+                       static_cast<BufferParams::PARSEP>(tmpret);
+       } else if (token == "\\defskip") {
+               lex.nextToken();
+               defskip = VSpace(lex.getString());
+       } else if (token == "\\quotes_language") {
+               // FIXME: should be params.readQuotes()
+               int tmpret = lex.findToken(string_quotes_language);
+               if (tmpret == -1)
+                       ++tmpret;
+               InsetQuotes::quote_language tmpl =
+                       InsetQuotes::EnglishQ;
+               switch (tmpret) {
+               case 0:
+                       tmpl = InsetQuotes::EnglishQ;
+                       break;
+               case 1:
+                       tmpl = InsetQuotes::SwedishQ;
+                       break;
+               case 2:
+                       tmpl = InsetQuotes::GermanQ;
+                       break;
+               case 3:
+                       tmpl = InsetQuotes::PolishQ;
+                       break;
+               case 4:
+                       tmpl = InsetQuotes::FrenchQ;
+                       break;
+               case 5:
+                       tmpl = InsetQuotes::DanishQ;
+                       break;
+               }
+               quotes_language = tmpl;
+       } else if (token == "\\quotes_times") {
+               // FIXME: should be params.readQuotes()
+               lex.nextToken();
+               switch (lex.getInteger()) {
+               case 1:
+                       quotes_times = InsetQuotes::SingleQ;
+                       break;
+               case 2:
+                       quotes_times = InsetQuotes::DoubleQ;
+                       break;
+               }
+       } else if (token == "\\papersize") {
+               int tmpret = lex.findToken(string_papersize);
+               if (tmpret == -1)
+                       ++tmpret;
+               else
+                       papersize2 = tmpret;
+       } else if (token == "\\paperpackage") {
+               int tmpret = lex.findToken(string_paperpackages);
+               if (tmpret == -1) {
+                       ++tmpret;
+                       paperpackage = BufferParams::PACKAGE_NONE;
+               } else
+                       paperpackage = tmpret;
+       } else if (token == "\\use_geometry") {
+               lex.nextToken();
+               use_geometry = lex.getInteger();
+       } else if (token == "\\use_amsmath") {
+               lex.nextToken();
+               use_amsmath = static_cast<BufferParams::AMS>(
+                       lex.getInteger());
+       } else if (token == "\\use_natbib") {
+               lex.nextToken();
+               use_natbib = lex.getInteger();
+       } else if (token == "\\use_numerical_citations") {
+               lex.nextToken();
+               use_numerical_citations = lex.getInteger();
+       } else if (token == "\\tracking_changes") {
+               lex.nextToken();
+               tracking_changes = lex.getInteger();
+       } else if (token == "\\author") {
+               lex.nextToken();
+               istringstream ss(STRCONV(lex.getString()));
+               Author a;
+               ss >> a;
+               author_map.push_back(authorlist.record(a));
+       } else if (token == "\\paperorientation") {
+               int tmpret = lex.findToken(string_orientation);
+               if (tmpret == -1)
+                       ++tmpret;
+               orientation =
+                       static_cast<BufferParams::PAPER_ORIENTATION>(tmpret);
+       } else if (token == "\\paperwidth") {
+               lex.next();
+               paperwidth = lex.getString();
+       } else if (token == "\\paperheight") {
+               lex.next();
+               paperheight = lex.getString();
+       } else if (token == "\\leftmargin") {
+               lex.next();
+               leftmargin = lex.getString();
+       } else if (token == "\\topmargin") {
+               lex.next();
+               topmargin = lex.getString();
+       } else if (token == "\\rightmargin") {
+               lex.next();
+               rightmargin = lex.getString();
+       } else if (token == "\\bottommargin") {
+               lex.next();
+               bottommargin = lex.getString();
+       } else if (token == "\\headheight") {
+               lex.next();
+               headheight = lex.getString();
+       } else if (token == "\\headsep") {
+               lex.next();
+               headsep = lex.getString();
+       } else if (token == "\\footskip") {
+               lex.next();
+               footskip = lex.getString();
+       } else if (token == "\\paperfontsize") {
+               lex.nextToken();
+               fontsize = rtrim(lex.getString());
+       } else if (token == "\\papercolumns") {
+               lex.nextToken();
+               columns = lex.getInteger();
+       } else if (token == "\\papersides") {
+               lex.nextToken();
+               switch (lex.getInteger()) {
+               default:
+               case 1: sides = LyXTextClass::OneSide; break;
+               case 2: sides = LyXTextClass::TwoSides; break;
+               }
+       } else if (token == "\\paperpagestyle") {
+               lex.nextToken();
+               pagestyle = rtrim(lex.getString());
+       } else if (token == "\\bullet") {
+               // FIXME: should be params.readBullets()
+               lex.nextToken();
+               int const index = lex.getInteger();
+               lex.nextToken();
+               int temp_int = lex.getInteger();
+               user_defined_bullets[index].setFont(temp_int);
+               temp_bullets[index].setFont(temp_int);
+               lex.nextToken();
+               temp_int = lex.getInteger();
+               user_defined_bullets[index].setCharacter(temp_int);
+               temp_bullets[index].setCharacter(temp_int);
+               lex.nextToken();
+               temp_int = lex.getInteger();
+               user_defined_bullets[index].setSize(temp_int);
+               temp_bullets[index].setSize(temp_int);
+               lex.nextToken();
+               string const temp_str = lex.getString();
+               if (temp_str != "\\end_bullet") {
+                               // this element isn't really necessary for
+                               // parsing but is easier for humans
+                               // to understand bullets. Put it back and
+                               // set a debug message?
+                       lex.printError("\\end_bullet expected, got" + temp_str);
+                               //how can I put it back?
+               }
+       } else if (token == "\\bulletLaTeX") {
+               // The bullet class should be able to read this.
+               lex.nextToken();
+               int const index = lex.getInteger();
+               lex.next();
+               string temp_str = lex.getString();
+               string sum_str;
+               while (temp_str != "\\end_bullet") {
+                               // this loop structure is needed when user
+                               // enters an empty string since the first
+                               // thing returned will be the \\end_bullet
+                               // OR
+                               // if the LaTeX entry has spaces. Each element
+                               // therefore needs to be read in turn
+                       sum_str += temp_str;
+                       lex.next();
+                       temp_str = lex.getString();
+               }
+
+               user_defined_bullets[index].setText(sum_str);
+               temp_bullets[index].setText(sum_str);
+       } else if (token == "\\secnumdepth") {
+               lex.nextToken();
+               secnumdepth = lex.getInteger();
+       } else if (token == "\\tocdepth") {
+               lex.nextToken();
+               tocdepth = lex.getInteger();
+       } else if (token == "\\spacing") {
+               lex.next();
+               string const tmp = rtrim(lex.getString());
+               Spacing::Space tmp_space = Spacing::Default;
+               float tmp_val = 0.0;
+               if (tmp == "single") {
+                       tmp_space = Spacing::Single;
+               } else if (tmp == "onehalf") {
+                       tmp_space = Spacing::Onehalf;
+               } else if (tmp == "double") {
+                       tmp_space = Spacing::Double;
+               } else if (tmp == "other") {
+                       lex.next();
+                       tmp_space = Spacing::Other;
+                       tmp_val = lex.getFloat();
+               } else {
+                       lex.printError("Unknown spacing token: '$$Token'");
+               }
+#if 0 // FIXME: Handled in lyx2lyx ?
+               // Small hack so that files written with klyx will be
+               // parsed correctly.
+               if (first_par)
+                       par->params().spacing(Spacing(tmp_space, tmp_val));
+#endif
+               spacing.set(tmp_space, tmp_val);
+       } else if (token == "\\float_placement") {
+               lex.nextToken();
+               float_placement = lex.getString();
+       } else {
+               return token;
+       }
+
+       return string();
+}
+
+
 void BufferParams::writeFile(ostream & os) const
 {
        // The top of the file is written by the buffer.
@@ -81,7 +344,7 @@ void BufferParams::writeFile(ostream & os) const
        // then the the preamble
        if (!preamble.empty()) {
                // remove '\n' from the end of preamble
-               string const tmppreamble = strip(preamble, '\n');
+               string const tmppreamble = rtrim(preamble, "\n");
                os << "\\begin_preamble\n"
                   << tmppreamble
                   << "\n\\end_preamble\n";
@@ -178,9 +441,406 @@ void BufferParams::writeFile(ostream & os) const
                        }
                }
        }
+
+       os << "\\tracking_changes " << tracking_changes << "\n";
+
+       if (tracking_changes) {
+               AuthorList::Authors::const_iterator it = authorlist.begin();
+               AuthorList::Authors::const_iterator end = authorlist.end();
+               for (; it != end; ++it) {
+                       os << "\\author " << it->second << "\n";
+               }
+       }
 }
 
 
+bool BufferParams::writeLaTeX(ostream & os, LaTeXFeatures & features,
+                             TexRow & texrow) const
+{
+       os << "\\documentclass";
+
+       LyXTextClass const & tclass = getLyXTextClass();
+
+       ostringstream clsoptions; // the document class options.
+
+       if (tokenPos(tclass.opt_fontsize(),
+                    '|', fontsize) >= 0) {
+               // only write if existing in list (and not default)
+               clsoptions << fontsize << "pt,";
+       }
+
+
+       if (!use_geometry &&
+           (paperpackage == PACKAGE_NONE)) {
+               switch (papersize) {
+               case PAPER_A4PAPER:
+                       clsoptions << "a4paper,";
+                       break;
+               case PAPER_USLETTER:
+                       clsoptions << "letterpaper,";
+                       break;
+               case PAPER_A5PAPER:
+                       clsoptions << "a5paper,";
+                       break;
+               case PAPER_B5PAPER:
+                       clsoptions << "b5paper,";
+                       break;
+               case PAPER_EXECUTIVEPAPER:
+                       clsoptions << "executivepaper,";
+                       break;
+               case PAPER_LEGALPAPER:
+                       clsoptions << "legalpaper,";
+                       break;
+               }
+       }
+
+       // if needed
+       if (sides != tclass.sides()) {
+               switch (sides) {
+               case LyXTextClass::OneSide:
+                       clsoptions << "oneside,";
+                       break;
+               case LyXTextClass::TwoSides:
+                       clsoptions << "twoside,";
+                       break;
+               }
+       }
+
+       // if needed
+       if (columns != tclass.columns()) {
+               if (columns == 2)
+                       clsoptions << "twocolumn,";
+               else
+                       clsoptions << "onecolumn,";
+       }
+
+       if (!use_geometry
+           && orientation == ORIENTATION_LANDSCAPE)
+               clsoptions << "landscape,";
+
+       // language should be a parameter to \documentclass
+       if (language->babel() == "hebrew"
+           && default_language->babel() != "hebrew")
+               // This seems necessary
+               features.useLanguage(default_language);
+
+       ostringstream language_options;
+       bool const use_babel = features.useBabel();
+       if (use_babel) {
+               language_options << features.getLanguages();
+               language_options << language->babel();
+               if (lyxrc.language_global_options)
+                       clsoptions << language_options.str() << ',';
+       }
+
+       // the user-defined options
+       if (!options.empty()) {
+               clsoptions << options << ',';
+       }
+
+       string strOptions(STRCONV(clsoptions.str()));
+       if (!strOptions.empty()) {
+               strOptions = rtrim(strOptions, ",");
+               os << '[' << strOptions << ']';
+       }
+
+       os << '{' << tclass.latexname() << "}\n";
+       texrow.newline();
+       // end of \documentclass defs
+
+       // font selection must be done before loading fontenc.sty
+       // The ae package is not needed when using OT1 font encoding.
+       if (fonts != "default" &&
+           (fonts != "ae" || lyxrc.fontenc != "default")) {
+               os << "\\usepackage{" << fonts << "}\n";
+               texrow.newline();
+               if (fonts == "ae") {
+                       os << "\\usepackage{aecompl}\n";
+                       texrow.newline();
+               }
+       }
+       // this one is not per buffer
+       if (lyxrc.fontenc != "default") {
+               os << "\\usepackage[" << lyxrc.fontenc
+                  << "]{fontenc}\n";
+               texrow.newline();
+       }
+
+       if (inputenc == "auto") {
+               string const doc_encoding =
+                       language->encoding()->LatexName();
+
+               // Create a list with all the input encodings used
+               // in the document
+               std::set<string> encodings =
+                       features.getEncodingSet(doc_encoding);
+
+               os << "\\usepackage[";
+               std::copy(encodings.begin(), encodings.end(),
+                         std::ostream_iterator<string>(os, ","));
+               os << doc_encoding << "]{inputenc}\n";
+               texrow.newline();
+       } else if (inputenc != "default") {
+               os << "\\usepackage[" << inputenc
+                  << "]{inputenc}\n";
+               texrow.newline();
+       }
+
+       // At the very beginning the text parameters.
+       if (paperpackage != PACKAGE_NONE) {
+               switch (paperpackage) {
+               case PACKAGE_A4:
+                       os << "\\usepackage{a4}\n";
+                       texrow.newline();
+                       break;
+               case PACKAGE_A4WIDE:
+                       os << "\\usepackage{a4wide}\n";
+                       texrow.newline();
+                       break;
+               case PACKAGE_WIDEMARGINSA4:
+                       os << "\\usepackage[widemargins]{a4}\n";
+                       texrow.newline();
+                       break;
+               }
+       }
+       if (use_geometry) {
+               os << "\\usepackage{geometry}\n";
+               texrow.newline();
+               os << "\\geometry{verbose";
+               if (orientation == ORIENTATION_LANDSCAPE)
+                       os << ",landscape";
+               switch (papersize2) {
+               case VM_PAPER_CUSTOM:
+                       if (!paperwidth.empty())
+                               os << ",paperwidth="
+                                  << paperwidth;
+                       if (!paperheight.empty())
+                               os << ",paperheight="
+                                  << paperheight;
+                       break;
+               case VM_PAPER_USLETTER:
+                       os << ",letterpaper";
+                       break;
+               case VM_PAPER_USLEGAL:
+                       os << ",legalpaper";
+                       break;
+               case VM_PAPER_USEXECUTIVE:
+                       os << ",executivepaper";
+                       break;
+               case VM_PAPER_A3:
+                       os << ",a3paper";
+                       break;
+               case VM_PAPER_A4:
+                       os << ",a4paper";
+                       break;
+               case VM_PAPER_A5:
+                       os << ",a5paper";
+                       break;
+               case VM_PAPER_B3:
+                       os << ",b3paper";
+                       break;
+               case VM_PAPER_B4:
+                       os << ",b4paper";
+                       break;
+               case VM_PAPER_B5:
+                       os << ",b5paper";
+                       break;
+               default:
+                               // default papersize ie VM_PAPER_DEFAULT
+                       switch (lyxrc.default_papersize) {
+                       case PAPER_DEFAULT: // keep compiler happy
+                       case PAPER_USLETTER:
+                               os << ",letterpaper";
+                               break;
+                       case PAPER_LEGALPAPER:
+                               os << ",legalpaper";
+                               break;
+                       case PAPER_EXECUTIVEPAPER:
+                               os << ",executivepaper";
+                               break;
+                       case PAPER_A3PAPER:
+                               os << ",a3paper";
+                               break;
+                       case PAPER_A4PAPER:
+                               os << ",a4paper";
+                               break;
+                       case PAPER_A5PAPER:
+                               os << ",a5paper";
+                               break;
+                       case PAPER_B5PAPER:
+                               os << ",b5paper";
+                               break;
+                       }
+               }
+               if (!topmargin.empty())
+                       os << ",tmargin=" << topmargin;
+               if (!bottommargin.empty())
+                       os << ",bmargin=" << bottommargin;
+               if (!leftmargin.empty())
+                       os << ",lmargin=" << leftmargin;
+               if (!rightmargin.empty())
+                       os << ",rmargin=" << rightmargin;
+               if (!headheight.empty())
+                       os << ",headheight=" << headheight;
+               if (!headsep.empty())
+                       os << ",headsep=" << headsep;
+               if (!footskip.empty())
+                       os << ",footskip=" << footskip;
+               os << "}\n";
+               texrow.newline();
+       }
+
+       if (tokenPos(tclass.opt_pagestyle(),
+                    '|', pagestyle) >= 0) {
+               if (pagestyle == "fancy") {
+                       os << "\\usepackage{fancyhdr}\n";
+                       texrow.newline();
+               }
+               os << "\\pagestyle{" << pagestyle << "}\n";
+               texrow.newline();
+       }
+
+       if (secnumdepth != tclass.secnumdepth()) {
+               os << "\\setcounter{secnumdepth}{"
+                  << secnumdepth
+                  << "}\n";
+               texrow.newline();
+       }
+       if (tocdepth != tclass.tocdepth()) {
+               os << "\\setcounter{tocdepth}{"
+                  << tocdepth
+                  << "}\n";
+               texrow.newline();
+       }
+
+       if (paragraph_separation) {
+               switch (defskip.kind()) {
+               case VSpace::SMALLSKIP:
+                       os << "\\setlength\\parskip{\\smallskipamount}\n";
+                       break;
+               case VSpace::MEDSKIP:
+                       os << "\\setlength\\parskip{\\medskipamount}\n";
+                       break;
+               case VSpace::BIGSKIP:
+                       os << "\\setlength\\parskip{\\bigskipamount}\n";
+                       break;
+               case VSpace::LENGTH:
+                       os << "\\setlength\\parskip{"
+                          << defskip.length().asLatexString()
+                          << "}\n";
+                       break;
+               default: // should never happen // Then delete it.
+                       os << "\\setlength\\parskip{\\medskipamount}\n";
+                       break;
+               }
+               texrow.newline();
+
+               os << "\\setlength\\parindent{0pt}\n";
+               texrow.newline();
+       }
+
+       // Now insert the LyX specific LaTeX commands...
+
+       // The optional packages;
+       string lyxpreamble(features.getPackages());
+
+       // this might be useful...
+       lyxpreamble += "\n\\makeatletter\n";
+
+       // Some macros LyX will need
+       string tmppreamble(features.getMacros());
+
+       if (!tmppreamble.empty()) {
+               lyxpreamble += "\n%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
+                       "LyX specific LaTeX commands.\n"
+                       + tmppreamble + '\n';
+       }
+
+       // the text class specific preamble
+       tmppreamble = features.getTClassPreamble();
+       if (!tmppreamble.empty()) {
+               lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
+                       "Textclass specific LaTeX commands.\n"
+                       + tmppreamble + '\n';
+       }
+
+       /* the user-defined preamble */
+       if (!preamble.empty()) {
+               lyxpreamble += "%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% "
+                       "User specified LaTeX commands.\n"
+                       + preamble + '\n';
+       }
+
+       // Itemize bullet settings need to be last in case the user
+       // defines their own bullets that use a package included
+       // in the user-defined preamble -- ARRae
+       // Actually it has to be done much later than that
+       // since some packages like frenchb make modifications
+       // at \begin{document} time -- JMarc
+       string bullets_def;
+       for (int i = 0; i < 4; ++i) {
+               if (user_defined_bullets[i] != ITEMIZE_DEFAULTS[i]) {
+                       if (bullets_def.empty())
+                               bullets_def="\\AtBeginDocument{\n";
+                       bullets_def += "  \\renewcommand{\\labelitemi";
+                       switch (i) {
+                               // `i' is one less than the item to modify
+                       case 0:
+                               break;
+                       case 1:
+                               bullets_def += 'i';
+                               break;
+                       case 2:
+                               bullets_def += "ii";
+                               break;
+                       case 3:
+                               bullets_def += 'v';
+                               break;
+                       }
+                       bullets_def += "}{" +
+                               user_defined_bullets[i].getText()
+                               + "}\n";
+               }
+       }
+
+       if (!bullets_def.empty())
+               lyxpreamble += bullets_def + "}\n\n";
+
+       // We try to load babel late, in case it interferes
+       // with other packages.
+       if (use_babel) {
+               string tmp = lyxrc.language_package;
+               if (!lyxrc.language_global_options
+                   && tmp == "\\usepackage{babel}")
+                       tmp = string("\\usepackage[") +
+                               STRCONV(language_options.str()) +
+                               "]{babel}";
+               lyxpreamble += tmp + "\n";
+               lyxpreamble += features.getBabelOptions();
+       }
+
+       lyxpreamble += "\\makeatother\n";
+
+       // dvipost settings come after everything else
+       if (tracking_changes) {
+               lyxpreamble +=
+                       "\\dvipostlayout\n"
+                       "\\dvipost{osstart color push Red}\n"
+                       "\\dvipost{osend color pop}\n"
+                       "\\dvipost{cbstart color push Blue}\n"
+                       "\\dvipost{cbend color pop} \n";
+       }
+
+       int const nlines =
+               int(lyx::count(lyxpreamble.begin(), lyxpreamble.end(), '\n'));
+       for (int j = 0; j != nlines; ++j) {
+               texrow.newline();
+       }
+
+       os << lyxpreamble;
+       return use_babel;
+}
+
 void BufferParams::setPaperStuff()
 {
        papersize = PAPER_DEFAULT;