-/* 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 "dimension.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"
+#include "metricsinfo.h"
using std::ostream;
using std::max;
+using std::auto_ptr;
+
InsetSpecialChar::InsetSpecialChar(Kind k)
: kind_(k)
return kind_;
}
-int InsetSpecialChar::ascent(BufferView *, LyXFont const & font) const
-{
- return lyxfont::maxAscent(font);
-}
-
-int InsetSpecialChar::descent(BufferView *, LyXFont const & font) const
+void InsetSpecialChar::metrics(MetricsInfo & mi, Dimension & dim) const
{
- return lyxfont::maxDescent(font);
-}
-
+ LyXFont & font = mi.base.font;
+ dim.asc = font_metrics::maxAscent(font);
+ dim.des = font_metrics::maxDescent(font);
-int InsetSpecialChar::width(BufferView *, LyXFont const & font) const
-{
+ string s;
switch (kind_) {
- case HYPHENATION:
- {
- int w = lyxfont::width('-', font);
- if (w > 5)
- w -= 2; // to make it look shorter
- return w;
- }
- case LIGATURE_BREAK:
- {
- return lyxfont::width('|', font);
- }
- case END_OF_SENTENCE:
- {
- return lyxfont::width('.', font);
+ case LIGATURE_BREAK: s = "|"; break;
+ case END_OF_SENTENCE: s = "."; break;
+ case LDOTS: s = ". . ."; break;
+ case MENU_SEPARATOR: s = " x "; break;
+ case HYPHENATION: s = "-"; break;
}
- case LDOTS:
- {
- return lyxfont::width(". . .", font);
- }
- case MENU_SEPARATOR:
- {
- return lyxfont::width(" x ", font);
- }
- case PROTECTED_SEPARATOR:
- {
- return lyxfont::width('x', font);
- }
-
- }
- return 1; // To shut up gcc
+ dim.wid = font_metrics::width(s, font);
+ if (kind_ == HYPHENATION && dim.wid > 5)
+ dim.wid -= 2; // to make it look shorter
+ dim_ = dim;
}
-void InsetSpecialChar::draw(BufferView * bv, LyXFont const & f,
- int baseline, float & x, bool) const
+void InsetSpecialChar::draw(PainterInfo & pi, int x, int y) const
{
- Painter & pain = bv->painter();
- LyXFont font(f);
+ LyXFont font = pi.base.font;
switch (kind_) {
case HYPHENATION:
{
font.setColor(LColor::special);
- pain.text(int(x), baseline, "-", font);
- x += width(bv, font);
+ pi.pain.text(x, y, '-', font);
break;
}
case LIGATURE_BREAK:
{
font.setColor(LColor::special);
- pain.text(int(x), baseline, "|", font);
- x += width(bv, font);
+ pi.pain.text(x, y, '|', font);
break;
}
case END_OF_SENTENCE:
{
font.setColor(LColor::special);
- pain.text(int(x), baseline, ".", font);
- x += width(bv, font);
+ pi.pain.text(x, y, '.', font);
break;
}
case LDOTS:
{
font.setColor(LColor::special);
- pain.text(int(x), baseline, ". . .", font);
- x += width(bv, font);
+ pi.pain.text(x, y, ". . .", 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 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 w = font_metrics::width('x', font);
+ int ox = font_metrics::width(' ', font) + x;
+ int h = font_metrics::ascent('x', font);
int xp[4], yp[4];
-
- xp[0] = int(x);
- yp[0] = baseline - max(h / 4, 1);
- xp[1] = int(x);
- yp[1] = baseline;
+ xp[0] = ox; yp[0] = y;
+ xp[1] = ox; yp[1] = y - h;
+ xp[2] = ox + w; yp[2] = y - h/2;
+ xp[3] = ox; yp[3] = y;
- xp[2] = int(x + w);
- yp[2] = baseline;
-
- xp[3] = int(x + w);
- yp[3] = baseline - max(h / 4, 1);
-
- pain.lines(xp, yp, 4, LColor::special);
- x += w;
+ pi.pain.lines(xp, yp, 4, LColor::special);
break;
}
}
{
string command;
switch (kind_) {
- case HYPHENATION:
- command = "\\-";
+ case HYPHENATION:
+ command = "\\-";
break;
- case LIGATURE_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";
- break;
- case PROTECTED_SEPARATOR:
- //command = "\\protected_separator";
- command = "~";
+ command = "\\menuseparator";
break;
}
os << "\\SpecialChar " << command << "\n";
// This function will not be necessary when lyx3
void InsetSpecialChar::read(Buffer const *, LyXLex & lex)
-{
+{
lex.nextToken();
string const command = lex.getString();
else if (command == "\\ldots{}")
kind_ = LDOTS;
else if (command == "\\menuseparator")
- kind_ = MENU_SEPARATOR;
- else if (command == "\\protected_separator"
- || command == "~")
- kind_ = PROTECTED_SEPARATOR;
+ kind_ = MENU_SEPARATOR;
else
lex.printError("InsetSpecialChar: Unknown kind: `$$Token'");
}
-int InsetSpecialChar::latex(Buffer const *, ostream & os, bool /*fragile*/,
- bool free_space) const
+int InsetSpecialChar::latex(Buffer const *, ostream & os,
+ LatexRunParams const &) const
{
switch (kind_) {
- case HYPHENATION:
- os << "\\-";
+ case HYPHENATION:
+ os << "\\-";
break;
case LIGATURE_BREAK:
os << "\\textcompwordmark{}";
break;
- case END_OF_SENTENCE:
- os << "\\@.";
- break;
- case LDOTS:
- os << "\\ldots{}";
+ case END_OF_SENTENCE:
+ os << "\\@.";
break;
- case MENU_SEPARATOR:
- os << "\\lyxarrow{}";
+ case LDOTS:
+ os << "\\ldots{}";
break;
- case PROTECTED_SEPARATOR:
- os << (free_space ? " " : "~");
+ case MENU_SEPARATOR:
+ os << "\\lyxarrow{}";
break;
}
return 0;
case HYPHENATION:
case LIGATURE_BREAK:
break;
- case END_OF_SENTENCE:
- os << ".";
- break;
- case LDOTS:
- os << "...";
+ case END_OF_SENTENCE:
+ os << '.';
break;
- case MENU_SEPARATOR:
- os << "->";
+ case LDOTS:
+ os << "...";
break;
- case PROTECTED_SEPARATOR:
- os << " ";
+ case MENU_SEPARATOR:
+ os << "->";
break;
}
return 0;
}
-int InsetSpecialChar::linuxdoc(Buffer const * buf, ostream & os) const
+int InsetSpecialChar::linuxdoc(Buffer const *, ostream & os) const
{
switch (kind_) {
case HYPHENATION:
case LIGATURE_BREAK:
break;
case END_OF_SENTENCE:
- os << ".";
+ os << '.';
break;
case LDOTS:
- os << "...";
+ os << "...";
break;
- case MENU_SEPARATOR:
- os << "&lyxarrow;";
- break;
- case PROTECTED_SEPARATOR:
- os << " ";
+ case MENU_SEPARATOR:
+ os << "&lyxarrow;";
break;
}
return 0;
}
-int InsetSpecialChar::docbook(Buffer const * buf, ostream & os) const
+int InsetSpecialChar::docbook(Buffer const *, ostream & os, bool) const
{
switch (kind_) {
case HYPHENATION:
case LIGATURE_BREAK:
break;
case END_OF_SENTENCE:
- os << ".";
+ os << '.';
break;
case LDOTS:
- os << "...";
+ os << "...";
break;
case MENU_SEPARATOR:
os << "&lyxarrow;";
break;
- case PROTECTED_SEPARATOR:
- os << " ";
- break;
}
return 0;
}
-Inset * InsetSpecialChar::clone(Buffer const &, bool) const
+auto_ptr<InsetBase> InsetSpecialChar::clone() const
{
- return new InsetSpecialChar(kind_);
+ return auto_ptr<InsetBase>(new InsetSpecialChar(kind_));
}
void InsetSpecialChar::validate(LaTeXFeatures & features) const
{
if (kind_ == MENU_SEPARATOR) {
- features.lyxarrow = true;
+ 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;
+ return false;
+}
+
+
+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
}