src/insets/insetquotes.C

   1 /* This file is part of
   2  * ======================================================
   3  *
   4  *           LyX, The Document Processor
   5  *
   6  *          Copyright 1995 Matthias Ettrich
   7  *          Copyright 1995-2001 The LyX Team.
   8  *
   9  * ====================================================== */
  10
  11 #include <config.h>
  12
  13 #ifdef __GNUG__
  14 #pragma implementation
  15 #endif
  16
  17 #include "insetquotes.h"
  18 #include "support/lyxlib.h"
  19 #include "debug.h"
  20 #include "lyxfont.h"
  21 #include "lyxrc.h"
  22 #include "buffer.h"
  23 #include "LaTeXFeatures.h"
  24 #include "support/lstrings.h"
  25 #include "Painter.h"
  26 #include "font.h"
  27 #include "language.h"
  28 #include "BufferView.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 '(': case '{': case '[': 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_15)
 157                 if (disp == "<<")
 158                         disp = '«';
 159                 else if (disp == ">>")
 160                         disp = '»';
 161
 162         // in french, spaces are added inside double quotes
 163         if (times_ == DoubleQ && prefixIs(loclang->code(), "fr")) {
 164                 if (side_ == LeftQ)
 165                         disp += " ";
 166                 else
 167                         disp = " " + disp;
 168         }
 169
 170         return disp;
 171 }
 172
 173
 174 int InsetQuotes::ascent(BufferView *, LyXFont const & font) const
 175 {
 176         return lyxfont::maxAscent(font);
 177 }
 178
 179
 180 int InsetQuotes::descent(BufferView *, LyXFont const & font) const
 181 {
 182         return lyxfont::maxDescent(font);
 183 }
 184
 185
 186 int InsetQuotes::width(BufferView *, LyXFont const & font) const
 187 {
 188         string const text = dispString(font.language());
 189         int w = 0;
 190
 191         for (string::size_type i = 0; i < text.length(); ++i) {
 192                 if (text[i] == ' ')
 193                         w += lyxfont::width('i', font);
 194                 else if (i == 0 || text[i] != text[i-1])
 195                         w += lyxfont::width(text[i], font);
 196                 else
 197                         w += lyxfont::width(',', font);
 198         }
 199
 200         return w;
 201 }
 202
 203
 204 LyXFont const InsetQuotes::convertFont(LyXFont const & f) const
 205 {
 206         LyXFont font(f);
 207 #ifndef NO_LATEX
 208         // quotes-insets cannot be latex of any kind
 209         font.setLatex(LyXFont::OFF);
 210 #endif
 211         return font;
 212 }
 213
 214
 215 void InsetQuotes::draw(BufferView * bv, LyXFont const & font,
 216                        int baseline, float & x, bool) const
 217 {
 218         string const text = dispString(font.language());
 219
 220         bv->painter().text(int(x), baseline, text, font);
 221         x += width(bv, font);
 222 }
 223
 224
 225 void InsetQuotes::write(Buffer const *, ostream & os) const
 226 {
 227         string text;
 228         text += language_char[language_];
 229         text += side_char[side_];
 230         text += times_char[times_];
 231         os << "Quotes " << text;
 232 }
 233
 234
 235 void InsetQuotes::read(Buffer const *, LyXLex & lex)
 236 {
 237         lex.nextToken();
 238         parseString(lex.GetString());
 239         lex.next();
 240         if (lex.GetString() != "\\end_inset")
 241                 lex.printError("Missing \\end_inset at this point");
 242 }
 243
 244
 245 extern bool use_babel;
 246
 247 int InsetQuotes::latex(Buffer const * buf, ostream & os,
 248                        bool /*fragile*/, bool) const
 249 {
 250 #ifdef WITH_WARNINGS
 251 #warning How do we get the local language here??
 252 #endif
 253         string const doclang = buf->getLanguage()->babel();
 254         const int quoteind = quote_index[side_][language_];
 255         string qstr;
 256
 257         if (language_ == FrenchQ && times_ == DoubleQ
 258             && doclang == "frenchb") {
 259                 if (side_ == LeftQ)
 260                         qstr = "\\og "; //the spaces are important here
 261                 else
 262                         qstr = " \\fg{}"; //and here
 263         } else if (language_ == FrenchQ && times_ == DoubleQ
 264                    && doclang == "french") {
 265                 if (side_ == LeftQ)
 266                         qstr = "<< "; //the spaces are important here
 267                 else
 268                         qstr = " >>"; //and here
 269         } else if (lyxrc.fontenc == "T1") {
 270                 qstr = latex_quote_t1[times_][quoteind];
 271 #ifdef DO_USE_DEFAULT_LANGUAGE
 272         } else if (doclang == "default") {
 273 #else
 274         } else if (!use_babel) {
 275 #endif
 276                 qstr = latex_quote_ot1[times_][quoteind];
 277         } else {
 278                 qstr = latex_quote_babel[times_][quoteind];
 279         }
 280
 281         // Always guard against unfortunate ligatures (!` ?`)
 282         if (prefixIs(qstr, "`"))
 283                 qstr.insert(0, "{}");
 284
 285         os << qstr;
 286         return 0;
 287 }
 288
 289
 290 int InsetQuotes::ascii(Buffer const *, ostream & os, int) const
 291 {
 292         os << "\"";
 293         return 0;
 294 }
 295
 296
 297 int InsetQuotes::linuxdoc(Buffer const *, ostream & os) const
 298 {
 299         os << "\"";
 300         return 0;
 301 }
 302
 303
 304 int InsetQuotes::docBook(Buffer const *, ostream & os) const
 305 {
 306         if (times_ == DoubleQ) {
 307                 if (side_ == LeftQ)
 308                         os << "&ldquo;";
 309                 else
 310                         os << "&rdquo;";
 311         } else {
 312                 if (side_ == LeftQ)
 313                         os << "&lsquo;";
 314                 else
 315                         os << "&rsquo;";
 316         }
 317         return 0;
 318 }
 319
 320
 321 void InsetQuotes::validate(LaTeXFeatures & features) const
 322 {
 323         char type = quote_char[quote_index[side_][language_]];
 324
 325 #ifdef DO_USE_DEFAULT_LANGUAGE
 326         if (features.bufferParams().language->lang() == "default"
 327 #else
 328         if (!use_babel
 329 #endif
 330             && lyxrc.fontenc != "T1") {
 331                 if (times_ == SingleQ)
 332                         switch (type) {
 333                         case ',': features.quotesinglbase = true; break;
 334                         case '<': features.guilsinglleft = true; break;
 335                         case '>': features.guilsinglright = true; break;
 336                         default: break;
 337                         }
 338                 else
 339                         switch (type) {
 340                         case ',': features.quotedblbase = true; break;
 341                         case '<': features.guillemotleft = true; break;
 342                         case '>': features.guillemotright = true; break;
 343                         default: break;
 344                         }
 345         }
 346 }
 347
 348
 349 Inset * InsetQuotes::clone(Buffer const &, bool) const
 350 {
 351   return new InsetQuotes(language_, side_, times_);
 352 }
 353
 354
 355 Inset::Code InsetQuotes::lyxCode() const
 356 {
 357   return Inset::QUOTE_CODE;
 358 }