lyx_mirror/src/insets/InsetQuotes.cpp
2015-02-14 11:32:39 +01:00

379 lines
8.3 KiB
C++

/**
* \file InsetQuotes.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Jean-Marc Lasgouttes
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "InsetQuotes.h"
#include "Buffer.h"
#include "BufferParams.h"
#include "BufferView.h"
#include "Dimension.h"
#include "Font.h"
#include "Language.h"
#include "LaTeXFeatures.h"
#include "Lexer.h"
#include "LyXRC.h"
#include "MetricsInfo.h"
#include "OutputParams.h"
#include "output_xhtml.h"
#include "frontends/FontMetrics.h"
#include "frontends/Painter.h"
#include "support/debug.h"
#include "support/docstring.h"
#include "support/docstream.h"
#include "support/lstrings.h"
using namespace std;
using namespace lyx::support;
namespace lyx {
namespace {
/* codes used to read/write quotes to LyX files
* e ``english''
* s ''swedish''
* g ,,german``
* p ,,polish''
* f <<french>>
* a >>danish<<
*/
char const * const language_char = "esgpfa";
char const * const side_char = "lr" ;
char const * const times_char = "sd";
// List of known quote chars
char const * const quote_char = ",'`<>";
// Unicode characters needed by each quote type
char_type const display_quote_char[2][5] = {
{ 0x201a, 0x2019, 0x2018, 0x2039, 0x203a},
{ 0x201e, 0x201d, 0x201c, 0x00ab, 0x00bb}
};
// Index of chars used for the quote. Index is [side, language]
int quote_index[2][6] = {
{ 2, 1, 0, 0, 3, 4 }, // "'',,<>"
{ 1, 1, 2, 1, 4, 3 } // "`'`'><"
};
// Corresponding LaTeX code, for double and single quotes.
char const * const latex_quote_t1[2][5] = {
{ "\\quotesinglbase ", "'", "`",
"\\guilsinglleft{}", "\\guilsinglright{}" },
{ ",,", "''", "``", "<<", ">>" }
};
char const * const latex_quote_ot1[2][5] = {
{ "\\quotesinglbase ", "'", "`",
"\\guilsinglleft{}", "\\guilsinglright{}" },
{ "\\quotedblbase ", "''", "``",
"\\guillemotleft{}", "\\guillemotright{}" }
};
char const * const latex_quote_babel[2][5] = {
{ "\\glq ", "'", "`", "\\flq{}", "\\frq{}" },
{ "\\glqq ", "''", "``", "\\flqq{}", "\\frqq{}" }
};
} // namespace anon
InsetQuotes::InsetQuotes(Buffer * buf, string const & str) : Inset(buf)
{
parseString(str);
}
InsetQuotes::InsetQuotes(Buffer * buf, char_type c) : Inset(buf)
{
if (buf) {
language_ = buf->params().quotes_language;
times_ = buf->params().quotes_times;
}
setSide(c);
}
InsetQuotes::InsetQuotes(Buffer * buf, char_type c, QuoteTimes t)
: Inset(buf), times_(t)
{
if (buf)
language_ = buf->params().quotes_language;
setSide(c);
}
docstring InsetQuotes::layoutName() const
{
return from_ascii("Quotes");
}
void InsetQuotes::setSide(char_type c)
{
// Decide whether left or right
switch (c) {
case ' ':
case '(':
case '[':
side_ = LeftQuote; // left quote
break;
default:
side_ = RightQuote; // right quote
}
}
void InsetQuotes::parseString(string const & s)
{
string str = s;
if (str.length() != 3) {
lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
" bad string length." << endl;
str = "eld";
}
int i;
for (i = 0; i < 6; ++i) {
if (str[0] == language_char[i]) {
language_ = QuoteLanguage(i);
break;
}
}
if (i >= 6) {
lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
" bad language specification." << endl;
language_ = EnglishQuotes;
}
for (i = 0; i < 2; ++i) {
if (str[1] == side_char[i]) {
side_ = QuoteSide(i);
break;
}
}
if (i >= 2) {
lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
" bad side specification." << endl;
side_ = LeftQuote;
}
for (i = 0; i < 2; ++i) {
if (str[2] == times_char[i]) {
times_ = QuoteTimes(i);
break;
}
}
if (i >= 2) {
lyxerr << "ERROR (InsetQuotes::InsetQuotes):"
" bad times specification." << endl;
times_ = DoubleQuotes;
}
}
docstring InsetQuotes::displayString() const
{
Language const * loclang =
isBufferValid() ? buffer().params().language : 0;
int const index = quote_index[side_][language_];
docstring retdisp = docstring(1, display_quote_char[times_][index]);
// in french, spaces are added inside double quotes
// FIXME: this should be done by a separate quote type.
if (times_ == DoubleQuotes && loclang && prefixIs(loclang->code(), "fr")) {
if (side_ == LeftQuote)
retdisp += ' ';
else
retdisp.insert(size_t(0), 1, ' ');
}
return retdisp;
}
void InsetQuotes::metrics(MetricsInfo & mi, Dimension & dim) const
{
FontInfo & font = mi.base.font;
frontend::FontMetrics const & fm =
theFontMetrics(font);
dim.asc = fm.maxAscent();
dim.des = fm.maxDescent();
dim.wid = 0;
// FIXME: should we add a language or a font parameter member?
docstring const text = displayString();
for (string::size_type i = 0; i < text.length(); ++i) {
if (text[i] == ' ')
dim.wid += fm.width('i');
else if (i == 0 || text[i] != text[i - 1])
dim.wid += fm.width(text[i]);
else
dim.wid += fm.width(',');
}
}
void InsetQuotes::draw(PainterInfo & pi, int x, int y) const
{
// FIXME: should we add a language or a font parameter member?
docstring const text = displayString();
FontInfo font = pi.base.font;
font.setPaintColor(pi.textColor(font.realColor()));
if (text.length() == 2 && text[0] == text[1]) {
pi.pain.text(x, y, text[0], font);
int const t = theFontMetrics(font)
.width(',');
pi.pain.text(x + t, y, text[0], font);
} else {
pi.pain.text(x, y, text, font);
}
}
void InsetQuotes::write(ostream & os) const
{
string text;
text += language_char[language_];
text += side_char[side_];
text += times_char[times_];
os << "Quotes " << text;
}
void InsetQuotes::read(Lexer & lex)
{
lex.setContext("InsetQuotes::read");
lex.next();
parseString(lex.getString());
lex >> "\\end_inset";
}
void InsetQuotes::latex(otexstream & os, OutputParams const & runparams) const
{
const int quoteind = quote_index[side_][language_];
string qstr;
if (language_ == FrenchQuotes && times_ == DoubleQuotes
&& prefixIs(runparams.local_font->language()->code(), "fr")
&& !runparams.use_polyglossia) {
if (side_ == LeftQuote)
qstr = "\\og "; //the spaces are important here
else
qstr = " \\fg{}"; //and here
} else if (lyxrc.fontenc == "T1" && !runparams.use_polyglossia) {
qstr = latex_quote_t1[times_][quoteind];
#ifdef DO_USE_DEFAULT_LANGUAGE
} else if (doclang == "default") {
#else
} else if (!runparams.use_babel) {
#endif
// these are also used by polyglossia
qstr = latex_quote_ot1[times_][quoteind];
} else {
qstr = latex_quote_babel[times_][quoteind];
}
// Always guard against unfortunate ligatures (!` ?`)
if (prefixIs(qstr, "`")) {
char_type const lastchar = os.lastChar();
if (lastchar == '!' || lastchar == '?')
qstr.insert(0, "{}");
}
os << from_ascii(qstr);
}
int InsetQuotes::plaintext(odocstringstream & os,
OutputParams const &, size_t) const
{
docstring const str = displayString();
os << str;
return str.size();
}
docstring InsetQuotes::getQuoteEntity() const {
if (times_ == DoubleQuotes) {
if (side_ == LeftQuote)
return from_ascii("&ldquo;");
else
return from_ascii("&rdquo;");
}
if (side_ == LeftQuote)
return from_ascii("&lsquo;");
else
return from_ascii("&rsquo;");
}
int InsetQuotes::docbook(odocstream & os, OutputParams const &) const
{
os << getQuoteEntity();
return 0;
}
docstring InsetQuotes::xhtml(XHTMLStream & xs, OutputParams const &) const
{
xs << XHTMLStream::ESCAPE_NONE << getQuoteEntity();
return docstring();
}
void InsetQuotes::toString(odocstream & os) const
{
os << displayString();
}
void InsetQuotes::forOutliner(docstring & os, size_t) const
{
os += displayString();
}
void InsetQuotes::validate(LaTeXFeatures & features) const
{
bool const use_babel = features.useBabel();
char type = quote_char[quote_index[side_][language_]];
#ifdef DO_USE_DEFAULT_LANGUAGE
if (features.bufferParams().language->lang() == "default"
#else
if (!use_babel
#endif
&& lyxrc.fontenc != "T1") {
if (times_ == SingleQuotes)
switch (type) {
case ',': features.require("quotesinglbase"); break;
case '<': features.require("guilsinglleft"); break;
case '>': features.require("guilsinglright"); break;
default: break;
}
else
switch (type) {
case ',': features.require("quotedblbase"); break;
case '<': features.require("guillemotleft"); break;
case '>': features.require("guillemotright"); break;
default: break;
}
}
}
} // namespace lyx