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"
21 #include "LaTeXFeatures.h"
24 #include "MetricsInfo.h"
25 #include "OutputParams.h"
26 #include "output_xhtml.h"
27 #include "texstream.h"
29 #include "frontends/FontMetrics.h"
30 #include "frontends/Painter.h"
32 #include "support/debug.h"
33 #include "support/docstring.h"
34 #include "support/docstream.h"
35 #include "support/lstrings.h"
38 using namespace lyx::support;
44 /* codes used to read/write quotes to LyX files
53 char const * const language_char = "esgpfa";
54 char const * const side_char = "lr" ;
55 char const * const times_char = "sd";
57 // List of known quote chars
58 char const * const quote_char = ",'`<>";
60 // Unicode characters needed by each quote type
61 char_type const display_quote_char[2][5] = {
62 { 0x201a, 0x2019, 0x2018, 0x2039, 0x203a},
63 { 0x201e, 0x201d, 0x201c, 0x00ab, 0x00bb}
66 // Index of chars used for the quote. Index is [side, language]
67 int quote_index[2][6] = {
68 { 2, 1, 0, 0, 3, 4 }, // "'',,<>"
69 { 1, 1, 2, 1, 4, 3 } // "`'`'><"
72 // Corresponding LaTeX code, for double and single quotes.
73 char const * const latex_quote_t1[2][5] = {
74 { "\\quotesinglbase ", "'", "`",
75 "\\guilsinglleft{}", "\\guilsinglright{}" },
76 { ",,", "''", "``", "<<", ">>" }
79 char const * const latex_quote_ot1[2][5] = {
80 { "\\quotesinglbase ", "'", "`",
81 "\\guilsinglleft{}", "\\guilsinglright{}" },
82 { "\\quotedblbase ", "''", "``",
83 "\\guillemotleft{}", "\\guillemotright{}" }
86 char const * const latex_quote_babel[2][5] = {
87 { "\\glq ", "'", "`", "\\flq{}", "\\frq{}" },
88 { "\\glqq ", "''", "``", "\\flqq{}", "\\frqq{}" }
94 InsetQuotes::InsetQuotes(Buffer * buf, string const & str) : Inset(buf)
99 InsetQuotes::InsetQuotes(Buffer * buf, char_type c, QuoteTimes t)
100 : Inset(buf), times_(t)
103 language_ = buf->params().quotes_language;
105 language_ = EnglishQuotes;
111 docstring InsetQuotes::layoutName() const
113 return from_ascii("Quotes");
117 void InsetQuotes::setSide(char_type c)
119 // Decide whether left or right
124 side_ = LeftQuote; // left quote
127 side_ = RightQuote; // right quote
132 void InsetQuotes::parseString(string const & s)
135 if (str.length() != 3) {
136 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
137 " bad string length." << endl;
143 for (i = 0; i < 6; ++i) {
144 if (str[0] == language_char[i]) {
145 language_ = QuoteLanguage(i);
150 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
151 " bad language specification." << endl;
152 language_ = EnglishQuotes;
155 for (i = 0; i < 2; ++i) {
156 if (str[1] == side_char[i]) {
157 side_ = QuoteSide(i);
162 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
163 " bad side specification." << endl;
167 for (i = 0; i < 2; ++i) {
168 if (str[2] == times_char[i]) {
169 times_ = QuoteTimes(i);
174 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
175 " bad times specification." << endl;
176 times_ = DoubleQuotes;
181 docstring InsetQuotes::displayString() const
183 Language const * loclang =
184 isBufferValid() ? buffer().params().language : 0;
185 int const index = quote_index[side_][language_];
186 docstring retdisp = docstring(1, display_quote_char[times_][index]);
188 // in french, spaces are added inside double quotes
189 // FIXME: this should be done by a separate quote type.
190 if (times_ == DoubleQuotes && loclang && prefixIs(loclang->code(), "fr")) {
191 if (side_ == LeftQuote)
194 retdisp.insert(size_t(0), 1, ' ');
201 void InsetQuotes::metrics(MetricsInfo & mi, Dimension & dim) const
203 FontInfo & font = mi.base.font;
204 frontend::FontMetrics const & fm =
205 theFontMetrics(font);
206 dim.asc = fm.maxAscent();
207 dim.des = fm.maxDescent();
210 // FIXME: should we add a language or a font parameter member?
211 docstring const text = displayString();
212 for (string::size_type i = 0; i < text.length(); ++i) {
214 dim.wid += fm.width('i');
215 else if (i == 0 || text[i] != text[i - 1])
216 dim.wid += fm.width(text[i]);
218 dim.wid += fm.width(',');
223 void InsetQuotes::draw(PainterInfo & pi, int x, int y) const
225 // FIXME: should we add a language or a font parameter member?
226 docstring const text = displayString();
227 FontInfo font = pi.base.font;
228 font.setPaintColor(pi.textColor(font.realColor()));
229 if (text.length() == 2 && text[0] == text[1]) {
230 pi.pain.text(x, y, text[0], font);
231 int const t = theFontMetrics(font)
233 pi.pain.text(x + t, y, text[0], font);
235 pi.pain.text(x, y, text, font);
240 void InsetQuotes::write(ostream & os) const
243 text += language_char[language_];
244 text += side_char[side_];
245 text += times_char[times_];
246 os << "Quotes " << text;
250 void InsetQuotes::read(Lexer & lex)
252 lex.setContext("InsetQuotes::read");
254 parseString(lex.getString());
255 lex >> "\\end_inset";
259 void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
261 const int quoteind = quote_index[side_][language_];
264 if (language_ == FrenchQuotes && times_ == DoubleQuotes
265 && prefixIs(runparams.local_font->language()->code(), "fr")
266 && !runparams.use_polyglossia) {
267 if (side_ == LeftQuote)
268 qstr = "\\og "; //the spaces are important here
270 qstr = " \\fg{}"; //and here
271 } else if (lyxrc.fontenc == "T1" && !runparams.use_polyglossia) {
272 qstr = latex_quote_t1[times_][quoteind];
273 #ifdef DO_USE_DEFAULT_LANGUAGE
274 } else if (doclang == "default") {
276 } else if (!runparams.use_babel) {
278 // these are also used by polyglossia
279 qstr = latex_quote_ot1[times_][quoteind];
281 qstr = latex_quote_babel[times_][quoteind];
284 // Always guard against unfortunate ligatures (!` ?`)
285 if (prefixIs(qstr, "`")) {
286 char_type const lastchar = os.lastChar();
287 if (lastchar == '!' || lastchar == '?')
288 qstr.insert(0, "{}");
291 os << from_ascii(qstr);
295 int InsetQuotes::plaintext(odocstringstream & os,
296 OutputParams const &, size_t) const
298 docstring const str = displayString();
304 docstring InsetQuotes::getQuoteEntity() const {
305 if (times_ == DoubleQuotes) {
306 if (side_ == LeftQuote)
307 return from_ascii("“");
309 return from_ascii("”");
311 if (side_ == LeftQuote)
312 return from_ascii("‘");
314 return from_ascii("’");
318 int InsetQuotes::docbook(odocstream & os, OutputParams const &) const
320 os << getQuoteEntity();
325 docstring InsetQuotes::xhtml(XHTMLStream & xs, OutputParams const &) const
327 xs << XHTMLStream::ESCAPE_NONE << getQuoteEntity();
332 void InsetQuotes::toString(odocstream & os) const
334 os << displayString();
338 void InsetQuotes::forOutliner(docstring & os, size_t const, bool const) const
340 os += displayString();
344 void InsetQuotes::validate(LaTeXFeatures & features) const
346 char type = quote_char[quote_index[side_][language_]];
348 #ifdef DO_USE_DEFAULT_LANGUAGE
349 if (features.bufferParams().language->lang() == "default"
351 if (!features.useBabel()
353 && lyxrc.fontenc != "T1") {
354 if (times_ == SingleQuotes)
356 case ',': features.require("quotesinglbase"); break;
357 case '<': features.require("guilsinglleft"); break;
358 case '>': features.require("guilsinglright"); break;
363 case ',': features.require("quotedblbase"); break;
364 case '<': features.require("guillemotleft"); break;
365 case '>': features.require("guillemotright"); break;