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{}" }
91 char const * const latex_quote_html[2][5] = {
92 { "‚", "’", "‘",
93 "‹", "›" },
94 { "„", "”", "“", "«", "»" }
100 InsetQuotes::InsetQuotes(Buffer * buf, string const & str) : Inset(buf)
105 InsetQuotes::InsetQuotes(Buffer * buf, char_type c, QuoteTimes t)
106 : Inset(buf), times_(t)
109 language_ = buf->params().quotes_language;
110 fontenc_ = (buf->params().fontenc == "global")
111 ? lyxrc.fontenc : buf->params().fontenc;
113 language_ = EnglishQuotes;
114 fontenc_ = lyxrc.fontenc;
121 docstring InsetQuotes::layoutName() const
123 return from_ascii("Quotes");
127 void InsetQuotes::setSide(char_type c)
129 // Decide whether left or right
134 side_ = LeftQuote; // left quote
137 side_ = RightQuote; // right quote
142 void InsetQuotes::parseString(string const & s)
145 if (str.length() != 3) {
146 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
147 " bad string length." << endl;
153 for (i = 0; i < 6; ++i) {
154 if (str[0] == language_char[i]) {
155 language_ = QuoteLanguage(i);
160 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
161 " bad language specification." << endl;
162 language_ = EnglishQuotes;
165 for (i = 0; i < 2; ++i) {
166 if (str[1] == side_char[i]) {
167 side_ = QuoteSide(i);
172 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
173 " bad side specification." << endl;
177 for (i = 0; i < 2; ++i) {
178 if (str[2] == times_char[i]) {
179 times_ = QuoteTimes(i);
184 lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
185 " bad times specification." << endl;
186 times_ = DoubleQuotes;
191 // FIXME: should we add a language or a font parameter member?
192 docstring InsetQuotes::displayString() const
194 Language const * loclang =
195 isBufferValid() ? buffer().params().language : 0;
196 int const index = quote_index[side_][language_];
197 docstring retdisp = docstring(1, display_quote_char[times_][index]);
199 // in french, thin spaces are added inside double quotes
200 // FIXME: this should be done by a separate quote type.
201 if (times_ == DoubleQuotes && loclang && prefixIs(loclang->code(), "fr")) {
202 // THIN SPACE (U+2009)
203 char_type const thin_space = 0x2009;
204 if (side_ == LeftQuote)
205 retdisp += thin_space;
207 retdisp = thin_space + retdisp;
214 void InsetQuotes::metrics(MetricsInfo & mi, Dimension & dim) const
216 FontInfo & font = mi.base.font;
217 frontend::FontMetrics const & fm = theFontMetrics(font);
218 dim.asc = fm.maxAscent();
219 dim.des = fm.maxDescent();
220 dim.wid = fm.width(displayString());
224 void InsetQuotes::draw(PainterInfo & pi, int x, int y) const
226 FontInfo font = pi.base.font;
227 font.setPaintColor(pi.textColor(font.realColor()));
228 pi.pain.text(x, y, displayString(), font);
232 void InsetQuotes::write(ostream & os) const
235 text += language_char[language_];
236 text += side_char[side_];
237 text += times_char[times_];
238 os << "Quotes " << text;
242 void InsetQuotes::read(Lexer & lex)
244 lex.setContext("InsetQuotes::read");
246 parseString(lex.getString());
247 lex >> "\\end_inset";
251 void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
253 const int quoteind = quote_index[side_][language_];
256 if (language_ == FrenchQuotes && times_ == DoubleQuotes
257 && prefixIs(runparams.local_font->language()->code(), "fr")
258 && !runparams.use_polyglossia) {
259 if (side_ == LeftQuote)
260 qstr = "\\og "; //the spaces are important here
262 qstr = " \\fg{}"; //and here
263 } else if (fontenc_ == "T1" && !runparams.use_polyglossia) {
264 qstr = latex_quote_t1[times_][quoteind];
265 #ifdef DO_USE_DEFAULT_LANGUAGE
266 } else if (doclang == "default") {
268 } else if (!runparams.use_babel) {
270 // these are also used by polyglossia
271 qstr = latex_quote_ot1[times_][quoteind];
273 qstr = latex_quote_babel[times_][quoteind];
276 // Always guard against unfortunate ligatures (!` ?` `` '' ,, << >>)
277 char_type const lastchar = os.lastChar();
278 if (prefixIs(qstr, "`")) {
279 if (lastchar == '!' || lastchar == '?')
280 qstr.insert(0, "{}");
282 if (qstr[1] == lastchar)
283 qstr.insert(0, "{}");
285 os << from_ascii(qstr);
289 int InsetQuotes::plaintext(odocstringstream & os,
290 OutputParams const &, size_t) const
292 docstring const str = displayString();
298 docstring InsetQuotes::getQuoteEntity() const {
299 const int quoteind = quote_index[side_][language_];
300 return from_ascii(latex_quote_html[times_][quoteind]);
304 int InsetQuotes::docbook(odocstream & os, OutputParams const &) const
306 os << getQuoteEntity();
311 docstring InsetQuotes::xhtml(XHTMLStream & xs, OutputParams const &) const
313 xs << XHTMLStream::ESCAPE_NONE << getQuoteEntity();
318 void InsetQuotes::toString(odocstream & os) const
320 os << displayString();
324 void InsetQuotes::forOutliner(docstring & os, size_t const, bool const) const
326 os += displayString();
330 void InsetQuotes::validate(LaTeXFeatures & features) const
332 char type = quote_char[quote_index[side_][language_]];
334 #ifdef DO_USE_DEFAULT_LANGUAGE
335 if (features.bufferParams().language->lang() == "default"
337 if (!features.useBabel()
339 && fontenc_ != "T1") {
340 if (times_ == SingleQuotes)
342 case ',': features.require("quotesinglbase"); break;
343 case '<': features.require("guilsinglleft"); break;
344 case '>': features.require("guilsinglright"); break;
349 case ',': features.require("quotedblbase"); break;
350 case '<': features.require("guillemotleft"); break;
351 case '>': features.require("guillemotright"); break;