src/insets/insetquotes.C

   1 /**
   2  * \file insetquotes.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jean-Marc Lasgouttes
   7  *
   8  * Full author contact details are available in file CREDITS
   9  */
  10
  11 #include <config.h>
  12
  13
  14 #include "insetquotes.h"
  15
  16 #include "support/LAssert.h"
  17 #include "support/lstrings.h"
  18 #include "BufferView.h"
  19 #include "LaTeXFeatures.h"
  20 #include "frontends/Painter.h"
  21 #include "buffer.h"
  22 #include "debug.h"
  23 #include "frontends/font_metrics.h"
  24 #include "language.h"
  25 #include "lyxfont.h"
  26 #include "lyxrc.h"
  27 #include "paragraph.h"
  28 #include "lyxlex.h"
  29
  30 using std::ostream;
  31 using std::endl;
  32
  33 // Quotes. Used for the various quotes. German, English, French,
  34 // Danish, Polish, all either double or single.
  35
  36 namespace {
  37
  38 // codes used to read/write quotes to LyX files
  39 char const * const language_char = "esgpfa";
  40 char const * const side_char = "lr" ;
  41 char const * const times_char = "sd";
  42
  43 // List of known quote chars
  44 char const * const quote_char = ",'`<>";
  45
  46 // Index of chars used for the quote. Index is [side, language]
  47 int quote_index[2][6] = {
  48         { 2, 1, 0, 0, 3, 4 },    // "'',,<>"
  49         { 1, 1, 2, 1, 4, 3 } };  // "`'`'><"
  50
  51 // Corresponding LaTeX code, for double and single quotes.
  52 char const * const latex_quote_t1[2][5] =
  53 { { "\\quotesinglbase ",  "'", "`",
  54     "\\guilsinglleft{}", "\\guilsinglright{}" },
  55   { ",,", "''", "``", "<<", ">>" } };
  56
  57 char const * const latex_quote_ot1[2][5] =
  58 { { "\\quotesinglbase ",  "'", "`",
  59     "\\guilsinglleft{}", "\\guilsinglright{}" },
  60   { "\\quotedblbase ", "''", "``",
  61     "\\guillemotleft{}", "\\guillemotright{}" } };
  62
  63 char const * const latex_quote_babel[2][5] =
  64 { { "\\glq ",  "'", "`", "\\flq{}", "\\frq{}" },
  65   { "\\glqq ", "''", "``", "\\flqq{}", "\\frqq{}" } };
  66
  67 } // namespace anon
  68
  69
  70 InsetQuotes::InsetQuotes(string const & str)
  71 {
  72         parseString(str);
  73 }
  74
  75
  76 InsetQuotes::InsetQuotes(quote_language l,
  77                          quote_side s,
  78                          quote_times t)
  79         : language_(l), side_(s), times_(t)
  80 {}
  81
  82
  83 InsetQuotes::InsetQuotes(char c, BufferParams const & params)
  84         : language_(params.quotes_language), times_(params.quotes_times)
  85 {
  86         // Decide whether left or right
  87         switch (c) {
  88         case ' ': case '(':
  89         case Paragraph::META_HFILL:
  90         case Paragraph::META_NEWLINE:
  91                 side_ = LeftQ;   // left quote
  92                 break;
  93         default:
  94                 side_ = RightQ;  // right quote
  95         }
  96 }
  97
  98
  99 void InsetQuotes::parseString(string const & s)
 100 {
 101         string str(s);
 102         if (str.length() != 3) {
 103                 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
 104                         " bad string length." << endl;
 105                 str = "eld";
 106         }
 107
 108         int i;
 109
 110         for (i = 0; i < 6; ++i) {
 111                 if (str[0] == language_char[i]) {
 112                         language_ = quote_language(i);
 113                         break;
 114                 }
 115         }
 116         if (i >= 6) {
 117                 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
 118                         " bad language specification." << endl;
 119                 language_ = EnglishQ;
 120         }
 121
 122         for (i = 0; i < 2; ++i) {
 123                 if (str[1] == side_char[i]) {
 124                         side_ = quote_side(i);
 125                         break;
 126                 }
 127         }
 128         if (i >= 2) {
 129                 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
 130                         " bad side specification." << endl;
 131                 side_ = LeftQ;
 132         }
 133
 134         for (i = 0; i < 2; ++i) {
 135                 if (str[2] == times_char[i]) {
 136                         times_ = quote_times(i);
 137                         break;
 138                 }
 139         }
 140         if (i >= 2) {
 141                 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
 142                         " bad times specification." << endl;
 143                 times_ = DoubleQ;
 144         }
 145 }
 146
 147
 148 string const InsetQuotes::dispString(Language const * loclang) const
 149 {
 150         string disp;
 151         disp += quote_char[quote_index[side_][language_]];
 152         if (times_ == DoubleQ)
 153                 disp += disp;
 154
 155         if (lyxrc.font_norm_type == LyXRC::ISO_8859_1
 156             || lyxrc.font_norm_type == LyXRC::ISO_8859_3
 157             || lyxrc.font_norm_type == LyXRC::ISO_8859_4
 158             || lyxrc.font_norm_type == LyXRC::ISO_8859_9) {
 159                 if (disp == "'")
 160                         disp = "´";
 161                 else if (disp == "''")
 162                         disp = "´´";
 163         }
 164         if (lyxrc.font_norm_type == LyXRC::ISO_8859_1
 165             || lyxrc.font_norm_type == LyXRC::ISO_8859_9
 166             || lyxrc.font_norm_type == LyXRC::ISO_8859_15) {
 167                 if (disp == "<<")
 168                         disp = '«';
 169                 else if (disp == ">>")
 170                         disp = '»';
 171         }
 172
 173         // in french, spaces are added inside double quotes
 174         if (times_ == DoubleQ && prefixIs(loclang->code(), "fr")) {
 175                 if (side_ == LeftQ)
 176                         disp += ' ';
 177                 else
 178                         disp.insert(string::size_type(0), 1, ' ');
 179         }
 180
 181         return disp;
 182 }
 183
 184
 185 int InsetQuotes::ascent(BufferView *, LyXFont const & font) const
 186 {
 187         return font_metrics::maxAscent(font);
 188 }
 189
 190
 191 int InsetQuotes::descent(BufferView *, LyXFont const & font) const
 192 {
 193         return font_metrics::maxDescent(font);
 194 }
 195
 196
 197 int InsetQuotes::width(BufferView *, LyXFont const & font) const
 198 {
 199         string const text = dispString(font.language());
 200         int w = 0;
 201
 202         for (string::size_type i = 0; i < text.length(); ++i) {
 203                 if (text[i] == ' ')
 204                         w += font_metrics::width('i', font);
 205                 else if (i == 0 || text[i] != text[i - 1])
 206                         w += font_metrics::width(text[i], font);
 207                 else
 208                         w += font_metrics::width(',', font);
 209         }
 210
 211         return w;
 212 }
 213
 214
 215 #if 0
 216 LyXFont const InsetQuotes::convertFont(LyXFont const & f) const
 217 {
 218 #if 1
 219         return f;
 220 #else
 221         LyXFont font(f);
 222         return font;
 223 #endif
 224 }
 225 #endif
 226
 227
 228 void InsetQuotes::draw(BufferView * bv, LyXFont const & font,
 229                        int baseline, float & x, bool) const
 230 {
 231         string const text = dispString(font.language());
 232
 233         if (text.length() == 2 && text[0] == text[1]) {
 234                 bv->painter().text(int(x), baseline, text[0], font);
 235                 int x2 = int(x + font_metrics::width(',', font));
 236                 bv->painter().text(x2, baseline, text[0], font);
 237         } else
 238                 bv->painter().text(int(x), baseline, text, font);
 239         x += width(bv, font);
 240 }
 241
 242
 243 void InsetQuotes::write(Buffer const *, ostream & os) const
 244 {
 245         string text;
 246         text += language_char[language_];
 247         text += side_char[side_];
 248         text += times_char[times_];
 249         os << "Quotes " << text;
 250 }
 251
 252
 253 void InsetQuotes::read(Buffer const *, LyXLex & lex)
 254 {
 255         lex.nextToken();
 256         parseString(lex.getString());
 257         lex.next();
 258         if (lex.getString() != "\\end_inset") {
 259                 lex.printError("Missing \\end_inset at this point");
 260         }
 261 }
 262
 263
 264 extern bool use_babel;
 265
 266 int InsetQuotes::latex(Buffer const * buf, ostream & os,
 267                        bool /*fragile*/, bool /* free_spc */) const
 268 {
 269         // How do we get the local language here??
 270         lyx::pos_type curr_pos = parOwner()->getPositionOfInset(this);
 271         lyx::Assert(curr_pos != -1);
 272         string const curr_lang =
 273                 parOwner()->getFont(buf->params,
 274                                     curr_pos).language()->babel();
 275
 276         const int quoteind = quote_index[side_][language_];
 277         string qstr;
 278
 279         if (language_ == FrenchQ && times_ == DoubleQ
 280             && curr_lang == "frenchb") {
 281                 if (side_ == LeftQ)
 282                         qstr = "\\og "; //the spaces are important here
 283                 else
 284                         qstr = " \\fg{}"; //and here
 285         } else if (language_ == FrenchQ && times_ == DoubleQ
 286                    && curr_lang == "french") {
 287                 if (side_ == LeftQ)
 288                         qstr = "<< "; //the spaces are important here
 289                 else
 290                         qstr = " >>"; //and here
 291         } else if (lyxrc.fontenc == "T1") {
 292                 qstr = latex_quote_t1[times_][quoteind];
 293 #ifdef DO_USE_DEFAULT_LANGUAGE
 294         } else if (doclang == "default") {
 295 #else
 296         } else if (!use_babel) {
 297 #endif
 298                 qstr = latex_quote_ot1[times_][quoteind];
 299         } else {
 300                 qstr = latex_quote_babel[times_][quoteind];
 301         }
 302
 303         // Always guard against unfortunate ligatures (!` ?`)
 304         if (prefixIs(qstr, "`"))
 305                 qstr.insert(0, "{}");
 306
 307         os << qstr;
 308         return 0;
 309 }
 310
 311
 312 int InsetQuotes::ascii(Buffer const *, ostream & os, int) const
 313 {
 314         os << '"';
 315         return 0;
 316 }
 317
 318
 319 int InsetQuotes::linuxdoc(Buffer const *, ostream & os) const
 320 {
 321         os << '"';
 322         return 0;
 323 }
 324
 325
 326 int InsetQuotes::docbook(Buffer const *, ostream & os, bool) const
 327 {
 328         if (times_ == DoubleQ) {
 329                 if (side_ == LeftQ)
 330                         os << "&ldquo;";
 331                 else
 332                         os << "&rdquo;";
 333         } else {
 334                 if (side_ == LeftQ)
 335                         os << "&lsquo;";
 336                 else
 337                         os << "&rsquo;";
 338         }
 339         return 0;
 340 }
 341
 342
 343 void InsetQuotes::validate(LaTeXFeatures & features) const
 344 {
 345         char type = quote_char[quote_index[side_][language_]];
 346
 347 #ifdef DO_USE_DEFAULT_LANGUAGE
 348         if (features.bufferParams().language->lang() == "default"
 349 #else
 350         if (!use_babel
 351 #endif
 352             && lyxrc.fontenc != "T1") {
 353                 if (times_ == SingleQ)
 354                         switch (type) {
 355                         case ',': features.require("quotesinglbase");  break;
 356                         case '<': features.require("guilsinglleft");  break;
 357                         case '>': features.require("guilsinglright"); break;
 358                         default: break;
 359                         }
 360                 else
 361                         switch (type) {
 362                         case ',': features.require("quotedblbase");   break;
 363                         case '<': features.require("guillemotleft");  break;
 364                         case '>': features.require("guillemotright"); break;
 365                         default: break;
 366                         }
 367         }
 368 }
 369
 370
 371 Inset * InsetQuotes::clone(Buffer const &, bool) const
 372 {
 373   return new InsetQuotes(language_, side_, times_);
 374 }
 375
 376
 377 Inset::Code InsetQuotes::lyxCode() const
 378 {
 379   return Inset::QUOTE_CODE;
 380 }