2 * \file InsetQuotes.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Jean-Marc Lasgouttes
8 * Full author contact details are available in file CREDITS.
13 #include "InsetQuotes.h"
16 #include "BufferParams.h"
17 #include "BufferView.h"
18 #include "Dimension.h"
20 #include "LaTeXFeatures.h"
23 #include "MetricsInfo.h"
24 #include "OutputParams.h"
25 #include "output_xhtml.h"
27 #include "frontends/FontMetrics.h"
28 #include "frontends/Painter.h"
30 #include "support/debug.h"
31 #include "support/docstring.h"
32 #include "support/docstream.h"
33 #include "support/lstrings.h"
36 using namespace lyx::support;
42 /* codes used to read/write quotes to LyX files
51 char const * const language_char = "esgpfa";
52 char const * const side_char = "lr" ;
53 char const * const times_char = "sd";
55 // List of known quote chars
56 char const * const quote_char = ",'`<>";
58 // Unicode characters needed by each quote type
59 char_type const display_quote_char[2][5] = {
60 { 0x201a, 0x2019, 0x2018, 0x2039, 0x203a},
61 { 0x201e, 0x201d, 0x201c, 0x00ab, 0x00bb}
64 // Index of chars used for the quote. Index is [side, language]
65 int quote_index[2][6] = {
66 { 2, 1, 0, 0, 3, 4 }, // "'',,<>"
67 { 1, 1, 2, 1, 4, 3 } // "`'`'><"
70 // Corresponding LaTeX code, for double and single quotes.
71 char const * const latex_quote_t1[2][5] = {
72 { "\\quotesinglbase ", "'", "`",
73 "\\guilsinglleft{}", "\\guilsinglright{}" },
74 { ",,", "''", "``", "<<", ">>" }
77 char const * const latex_quote_ot1[2][5] = {
78 { "\\quotesinglbase ", "'", "`",
79 "\\guilsinglleft{}", "\\guilsinglright{}" },
80 { "\\quotedblbase ", "''", "``",
81 "\\guillemotleft{}", "\\guillemotright{}" }
84 char const * const latex_quote_babel[2][5] = {
85 { "\\glq ", "'", "`", "\\flq{}", "\\frq{}" },
86 { "\\glqq ", "''", "``", "\\flqq{}", "\\frqq{}" }
92 InsetQuotes::InsetQuotes(Buffer * buf, string const & str) : Inset(buf)
97 InsetQuotes::InsetQuotes(Buffer * buf, char_type c) : Inset(buf)
100 language_ = buf->params().quotes_language;
101 times_ = buf->params().quotes_times;
107 InsetQuotes::InsetQuotes(Buffer * buf, char_type c, QuoteTimes t)
108 : Inset(buf), times_(t)
111 language_ = buf->params().quotes_language;
116 docstring InsetQuotes::name() const
118 return from_ascii("Quotes");
122 void InsetQuotes::setSide(char_type c)
124 // Decide whether left or right
129 side_ = LeftQuote; // left quote
132 side_ = RightQuote; // right quote
137 void InsetQuotes::parseString(string const & s)
140 if (str.length() != 3) {
141 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
142 " bad string length." << endl;
148 for (i = 0; i < 6; ++i) {
149 if (str[0] == language_char[i]) {
150 language_ = QuoteLanguage(i);
155 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
156 " bad language specification." << endl;
157 language_ = EnglishQuotes;
160 for (i = 0; i < 2; ++i) {
161 if (str[1] == side_char[i]) {
162 side_ = QuoteSide(i);
167 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
168 " bad side specification." << endl;
172 for (i = 0; i < 2; ++i) {
173 if (str[2] == times_char[i]) {
174 times_ = QuoteTimes(i);
179 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
180 " bad times specification." << endl;
181 times_ = DoubleQuotes;
186 docstring InsetQuotes::displayString() const
188 Language const * loclang = isBufferValid() ? buffer().params().language : 0;
189 int const index = quote_index[side_][language_];
190 docstring retdisp = docstring(1, display_quote_char[times_][index]);
192 // in french, spaces are added inside double quotes
193 // FIXME: this should be done by a separate quote type.
194 if (times_ == DoubleQuotes && loclang && prefixIs(loclang->code(), "fr")) {
195 if (side_ == LeftQuote)
198 retdisp.insert(size_t(0), 1, ' ');
205 void InsetQuotes::metrics(MetricsInfo & mi, Dimension & dim) const
207 FontInfo & font = mi.base.font;
208 frontend::FontMetrics const & fm =
209 theFontMetrics(font);
210 dim.asc = fm.maxAscent();
211 dim.des = fm.maxDescent();
214 // FIXME: should we add a language or a font parameter member?
215 docstring const text = displayString();
216 for (string::size_type i = 0; i < text.length(); ++i) {
218 dim.wid += fm.width('i');
219 else if (i == 0 || text[i] != text[i - 1])
220 dim.wid += fm.width(text[i]);
222 dim.wid += fm.width(',');
227 void InsetQuotes::draw(PainterInfo & pi, int x, int y) const
229 // FIXME: should we add a language or a font parameter member?
230 docstring const text = displayString();
232 if (text.length() == 2 && text[0] == text[1]) {
233 pi.pain.text(x, y, text[0], pi.base.font);
234 int const t = theFontMetrics(pi.base.font)
236 pi.pain.text(x + t, y, text[0], pi.base.font);
238 pi.pain.text(x, y, text, pi.base.font);
243 void InsetQuotes::write(ostream & os) const
246 text += language_char[language_];
247 text += side_char[side_];
248 text += times_char[times_];
249 os << "Quotes " << text;
253 void InsetQuotes::read(Lexer & lex)
255 lex.setContext("InsetQuotes::read");
257 parseString(lex.getString());
258 lex >> "\\end_inset";
262 int InsetQuotes::latex(odocstream & os, OutputParams const & runparams) const
264 const int quoteind = quote_index[side_][language_];
267 if (language_ == FrenchQuotes && times_ == DoubleQuotes
268 && prefixIs(runparams.local_font->language()->code(), "fr")) {
269 if (side_ == LeftQuote)
270 qstr = "\\og "; //the spaces are important here
272 qstr = " \\fg{}"; //and here
273 } else if (lyxrc.fontenc == "T1") {
274 qstr = latex_quote_t1[times_][quoteind];
275 #ifdef DO_USE_DEFAULT_LANGUAGE
276 } else if (doclang == "default") {
278 } else if (!runparams.use_babel) {
280 qstr = latex_quote_ot1[times_][quoteind];
282 qstr = latex_quote_babel[times_][quoteind];
285 // Always guard against unfortunate ligatures (!` ?`)
286 if (prefixIs(qstr, "`"))
287 qstr.insert(0, "{}");
289 os << from_ascii(qstr);
294 int InsetQuotes::plaintext(odocstream & os, OutputParams const &) const
296 docstring const str = displayString();
302 int InsetQuotes::docbook(odocstream & os, OutputParams const &) const
304 if (times_ == DoubleQuotes) {
305 if (side_ == LeftQuote)
310 if (side_ == LeftQuote)
319 docstring InsetQuotes::xhtml(XHTMLStream & xs, OutputParams const & op) const
321 docbook(xs.os(), op);
326 void InsetQuotes::tocString(odocstream & os) const
328 os << displayString();
332 void InsetQuotes::validate(LaTeXFeatures & features) const
334 bool const use_babel = features.useBabel();
335 char type = quote_char[quote_index[side_][language_]];
337 #ifdef DO_USE_DEFAULT_LANGUAGE
338 if (features.bufferParams().language->lang() == "default"
342 && lyxrc.fontenc != "T1") {
343 if (times_ == SingleQuotes)
345 case ',': features.require("quotesinglbase"); break;
346 case '<': features.require("guilsinglleft"); break;
347 case '>': features.require("guilsinglright"); break;
352 case ',': features.require("quotedblbase"); break;
353 case '<': features.require("guillemotleft"); break;
354 case '>': features.require("guillemotright"); break;