-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1997 Asger Alstrup
+/**
+ * \file insetspecialchar.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
*
- * ====================================================== */
+ * \author Asger Alstrup Nielsen
+ * \author Jean-Marc Lasgouttes
+ * \author Lars Gullik Bjønnes
+ *
+ * Full author contact details are available in file CREDITS
+ */
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
#include "insetspecialchar.h"
#include "debug.h"
#include "LaTeXFeatures.h"
#include "BufferView.h"
-#include "Painter.h"
-#include "font.h"
+#include "frontends/Painter.h"
+#include "frontends/font_metrics.h"
+#include "lyxlex.h"
+#include "lyxfont.h"
using std::ostream;
using std::max;
InsetSpecialChar::InsetSpecialChar(Kind k)
- : kind(k)
+ : kind_(k)
{}
+InsetSpecialChar::Kind InsetSpecialChar::kind() const
+{
+ return kind_;
+}
+
+
int InsetSpecialChar::ascent(BufferView *, LyXFont const & font) const
{
- return lyxfont::maxAscent(font);
+ return font_metrics::maxAscent(font);
}
int InsetSpecialChar::descent(BufferView *, LyXFont const & font) const
{
- return lyxfont::maxDescent(font);
+ return font_metrics::maxDescent(font);
}
int InsetSpecialChar::width(BufferView *, LyXFont const & font) const
{
- switch (kind) {
+ switch (kind_) {
case HYPHENATION:
{
- int w = lyxfont::width('-', font);
- if (w > 5)
+ int w = font_metrics::width('-', font);
+ if (w > 5)
w -= 2; // to make it look shorter
return w;
}
- case HYPHENATION_BREAK:
+ case LIGATURE_BREAK:
{
- return lyxfont::width('|', font);
+ return font_metrics::width('|', font);
}
case END_OF_SENTENCE:
{
- return lyxfont::width('.', font);
+ return font_metrics::width('.', font);
}
case LDOTS:
{
- return lyxfont::width(". . .", font);
+ return font_metrics::width(". . .", font);
}
case MENU_SEPARATOR:
{
- return lyxfont::width(" x ", font);
+ return font_metrics::width(" x ", font);
}
case PROTECTED_SEPARATOR:
{
- return lyxfont::width('x', font);
+ return font_metrics::width('x', font);
}
-
+
}
return 1; // To shut up gcc
}
void InsetSpecialChar::draw(BufferView * bv, LyXFont const & f,
- int baseline, float & x, bool) const
+ int baseline, float & x) const
{
Painter & pain = bv->painter();
LyXFont font(f);
- switch (kind) {
+ switch (kind_) {
case HYPHENATION:
{
font.setColor(LColor::special);
- pain.text(int(x), baseline, "-", font);
+ pain.text(int(x), baseline, '-', font);
x += width(bv, font);
break;
}
- case HYPHENATION_BREAK:
+ case LIGATURE_BREAK:
{
font.setColor(LColor::special);
- pain.text(int(x), baseline, "|", font);
+ pain.text(int(x), baseline, '|', font);
x += width(bv, font);
break;
}
case END_OF_SENTENCE:
{
font.setColor(LColor::special);
- pain.text(int(x), baseline, ".", font);
+ pain.text(int(x), baseline, '.', font);
x += width(bv, font);
break;
}
case MENU_SEPARATOR:
{
// A triangle the width and height of an 'x'
- int w = lyxfont::width('x', font);
- int ox = lyxfont::width(' ', font) + int(x);
- int h = lyxfont::ascent('x', font);
+ int w = font_metrics::width('x', font);
+ int ox = font_metrics::width(' ', font) + int(x);
+ int h = font_metrics::ascent('x', font);
int xp[4], yp[4];
-
+
xp[0] = ox; yp[0] = baseline;
xp[1] = ox; yp[1] = baseline - h;
xp[2] = ox + w; yp[2] = baseline - h/2;
xp[3] = ox; yp[3] = baseline;
-
+
pain.lines(xp, yp, 4, LColor::special);
x += width(bv, font);
break;
case PROTECTED_SEPARATOR:
{
float w = width(bv, font);
- int h = lyxfont::ascent('x', font);
+ int h = font_metrics::ascent('x', font);
int xp[4], yp[4];
-
+
xp[0] = int(x);
yp[0] = baseline - max(h / 4, 1);
xp[3] = int(x + w);
yp[3] = baseline - max(h / 4, 1);
-
+
pain.lines(xp, yp, 4, LColor::special);
x += w;
break;
void InsetSpecialChar::write(Buffer const *, ostream & os) const
{
string command;
- switch (kind) {
- case HYPHENATION:
- command = "\\-";
+ switch (kind_) {
+ case HYPHENATION:
+ command = "\\-";
break;
- case HYPHENATION_BREAK:
- command = "\\textcompwordmark{}";
+ case LIGATURE_BREAK:
+ command = "\\textcompwordmark{}";
break;
- case END_OF_SENTENCE:
+ case END_OF_SENTENCE:
command = "\\@.";
break;
case LDOTS:
- command = "\\ldots{}";
+ command = "\\ldots{}";
break;
case MENU_SEPARATOR:
- command = "\\menuseparator";
+ command = "\\menuseparator";
break;
case PROTECTED_SEPARATOR:
- //command = "\\protected_separator";
command = "~";
break;
}
// This function will not be necessary when lyx3
void InsetSpecialChar::read(Buffer const *, LyXLex & lex)
-{
+{
lex.nextToken();
- string const command = lex.GetString();
+ string const command = lex.getString();
if (command == "\\-")
- kind = HYPHENATION;
+ kind_ = HYPHENATION;
else if (command == "\\textcompwordmark{}")
- kind = HYPHENATION_BREAK;
+ kind_ = LIGATURE_BREAK;
else if (command == "\\@.")
- kind = END_OF_SENTENCE;
+ kind_ = END_OF_SENTENCE;
else if (command == "\\ldots{}")
- kind = LDOTS;
+ kind_ = LDOTS;
else if (command == "\\menuseparator")
- kind = MENU_SEPARATOR;
- else if (command == "\\protected_separator"
- || command == "~")
- kind = PROTECTED_SEPARATOR;
+ kind_ = MENU_SEPARATOR;
+ else if (command == "~")
+ kind_ = PROTECTED_SEPARATOR;
else
lex.printError("InsetSpecialChar: Unknown kind: `$$Token'");
}
int InsetSpecialChar::latex(Buffer const *, ostream & os, bool /*fragile*/,
bool free_space) const
{
- switch (kind) {
- case HYPHENATION:
- os << "\\-";
+ switch (kind_) {
+ case HYPHENATION:
+ os << "\\-";
break;
- case HYPHENATION_BREAK:
+ case LIGATURE_BREAK:
os << "\\textcompwordmark{}";
break;
- case END_OF_SENTENCE:
- os << "\\@.";
+ case END_OF_SENTENCE:
+ os << "\\@.";
break;
- case LDOTS:
- os << "\\ldots{}";
+ case LDOTS:
+ os << "\\ldots{}";
break;
- case MENU_SEPARATOR:
- os << "\\lyxarrow{}";
+ case MENU_SEPARATOR:
+ os << "\\lyxarrow{}";
break;
- case PROTECTED_SEPARATOR:
- os << (free_space ? " " : "~");
+ case PROTECTED_SEPARATOR:
+ os << (free_space ? ' ' : '~');
break;
}
return 0;
int InsetSpecialChar::ascii(Buffer const *, ostream & os, int) const
{
- switch (kind) {
+ switch (kind_) {
case HYPHENATION:
- case HYPHENATION_BREAK:
+ case LIGATURE_BREAK:
break;
- case END_OF_SENTENCE:
- os << ".";
+ case END_OF_SENTENCE:
+ os << '.';
break;
- case LDOTS:
- os << "...";
+ case LDOTS:
+ os << "...";
break;
- case MENU_SEPARATOR:
- os << "->";
+ case MENU_SEPARATOR:
+ os << "->";
break;
- case PROTECTED_SEPARATOR:
- os << " ";
+ case PROTECTED_SEPARATOR:
+ os << ' ';
break;
}
return 0;
}
-int InsetSpecialChar::linuxdoc(Buffer const * buf, ostream & os) const
+int InsetSpecialChar::linuxdoc(Buffer const *, ostream & os) const
{
- return ascii(buf, os, 0);
+ switch (kind_) {
+ case HYPHENATION:
+ case LIGATURE_BREAK:
+ break;
+ case END_OF_SENTENCE:
+ os << '.';
+ break;
+ case LDOTS:
+ os << "...";
+ break;
+ case MENU_SEPARATOR:
+ os << "&lyxarrow;";
+ break;
+ case PROTECTED_SEPARATOR:
+ os << " ";
+ break;
+ }
+ return 0;
}
-int InsetSpecialChar::docBook(Buffer const * buf, ostream & os) const
+int InsetSpecialChar::docbook(Buffer const *, ostream & os, bool) const
{
- return ascii(buf, os, 0);
+ switch (kind_) {
+ case HYPHENATION:
+ case LIGATURE_BREAK:
+ break;
+ case END_OF_SENTENCE:
+ os << '.';
+ break;
+ case LDOTS:
+ os << "...";
+ break;
+ case MENU_SEPARATOR:
+ os << "&lyxarrow;";
+ break;
+ case PROTECTED_SEPARATOR:
+ os << " ";
+ break;
+ }
+ return 0;
}
Inset * InsetSpecialChar::clone(Buffer const &, bool) const
{
- return new InsetSpecialChar(kind);
+ return new InsetSpecialChar(kind_);
}
void InsetSpecialChar::validate(LaTeXFeatures & features) const
{
- if (kind == MENU_SEPARATOR) {
- features.lyxarrow = true;
+ if (kind_ == MENU_SEPARATOR) {
+ features.require("lyxarrow");
}
}
+
+
+bool InsetSpecialChar::isChar() const
+{
+ return true;
+}
+
+
+bool InsetSpecialChar::isLetter() const
+{
+ return kind_ == HYPHENATION || kind_ == LIGATURE_BREAK;
+}
+
+
+bool InsetSpecialChar::isSpace() const
+{
+ return kind_ == PROTECTED_SEPARATOR;
+}
+
+
+bool InsetSpecialChar::isLineSeparator() const
+{
+#if 0
+ // this would be nice, but it does not work, since
+ // Paragraph::stripLeadingSpaces nukes the characters which
+ // have this property. I leave the code here, since it should
+ // eventually be made to work. (JMarc 20020327)
+ return kind_ == HYPHENATION || kind_ == MENU_SEPARATOR;
+#else
+ return false;
+#endif
+}
projects / lyx.git / blobdiff