]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetspecialchar.C
* src/LyXAction.C: mark goto-clear-bookmark as working without buffer
[lyx.git] / src / insets / insetspecialchar.C
index 1d727042f9638005978a1d5b06119dee40841af8..7ed1ea8489cbae9250b301601e10480647e119c3 100644 (file)
@@ -1,29 +1,35 @@
-/* This file is part of
- * ======================================================
+/**
+ * \file insetspecialchar.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
+ * \author Asger Alstrup Nielsen
+ * \author Jean-Marc Lasgouttes
+ * \author Lars Gullik Bjønnes
  *
- *         Copyright 1997 Asger Alstrup
- *
- * ====================================================== */
+ * 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 "frontends/Painter.h"
-#include "frontends/font_metrics.h"
+#include "LColor.h"
 #include "lyxlex.h"
-#include "lyxfont.h"
+#include "metricsinfo.h"
+
+#include "frontends/FontMetrics.h"
+#include "frontends/Painter.h"
+
+
+namespace lyx {
 
+using std::string;
+using std::auto_ptr;
 using std::ostream;
-using std::max;
+
 
 InsetSpecialChar::InsetSpecialChar(Kind k)
        : kind_(k)
@@ -35,126 +41,80 @@ InsetSpecialChar::Kind InsetSpecialChar::kind() const
        return kind_;
 }
 
-int InsetSpecialChar::ascent(BufferView *, LyXFont const & font) const
-{
-       return font_metrics::maxAscent(font);
-}
 
-
-int InsetSpecialChar::descent(BufferView *, LyXFont const & font) const
+bool InsetSpecialChar::metrics(MetricsInfo & mi, Dimension & dim) const
 {
-       return font_metrics::maxDescent(font);
-}
+       frontend::FontMetrics const & fm =
+               theFontMetrics(mi.base.font);
+       dim.asc = fm.maxAscent();
+       dim.des = fm.maxDescent();
 
-
-int InsetSpecialChar::width(BufferView *, LyXFont const & font) const
-{
+       string s;
        switch (kind_) {
-       case HYPHENATION:
-       {
-               int w = font_metrics::width('-', font);
-               if (w > 5) 
-                       w -= 2; // to make it look shorter
-               return w;
+               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 LIGATURE_BREAK:
-       {
-               return font_metrics::width('|', font);
-       }
-       case END_OF_SENTENCE:
-       {
-               return font_metrics::width('.', font);
-       }
-       case LDOTS:
-       {
-               return font_metrics::width(". . .", font);
-       }
-       case MENU_SEPARATOR:
-       {
-               return font_metrics::width(" x ", font);
-       }
-       case PROTECTED_SEPARATOR:
-       {
-               return font_metrics::width('x', font);
-       }
-
-       }
-       return 1; // To shut up gcc
+        docstring ds(s.begin(), s.end());
+       dim.wid = fm.width(ds);
+       if (kind_ == HYPHENATION && dim.wid > 5)
+               dim.wid -= 2; // to make it look shorter
+       bool const changed = dim_ != dim;
+       dim_ = dim;
+       return changed;
 }
 
 
-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, char_type('-'), font);
                break;
        }
        case LIGATURE_BREAK:
        {
                font.setColor(LColor::special);
-               pain.text(int(x), baseline, "|", font);
-               x += width(bv, font);
+               pi.pain.text(x, y, char_type('|'), 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, char_type('.'), font);
                break;
        }
        case LDOTS:
        {
                font.setColor(LColor::special);
-               pain.text(int(x), baseline, ". . .", font);
-               x += width(bv, font);
+                string ell = ". . . ";
+                docstring dell(ell.begin(), ell.end());
+               pi.pain.text(x, y, dell, font);
                break;
        }
        case MENU_SEPARATOR:
        {
-               // A triangle the width and height of an 'x'
-               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;
+               frontend::FontMetrics const & fm =
+                       theFontMetrics(font);
 
-               pain.lines(xp, yp, 4, LColor::special);
-               x += width(bv, font);
-               break;
-       }
-       case PROTECTED_SEPARATOR:
-       {
-               float w = width(bv, font);
-               int h = font_metrics::ascent('x', font);
+               // A triangle the width and height of an 'x'
+                int w = fm.width(char_type('x'));
+               int ox = fm.width(char_type(' ')) + x;
+               int h = fm.ascent(char_type('x'));
                int xp[4], yp[4];
 
-               xp[0] = int(x);
-               yp[0] = baseline - max(h / 4, 1);
-
-               xp[1] = int(x);
-               yp[1] = baseline;
-
-               xp[2] = int(x + w);
-               yp[2] = baseline;
-
-               xp[3] = int(x + w);
-               yp[3] = baseline - max(h / 4, 1);
+               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;
 
-               pain.lines(xp, yp, 4, LColor::special);
-               x += w;
+               pi.pain.lines(xp, yp, 4, LColor::special);
                break;
        }
        }
@@ -162,7 +122,7 @@ void InsetSpecialChar::draw(BufferView * bv, LyXFont const & f,
 
 
 // In lyxf3 this will be just LaTeX
-void InsetSpecialChar::write(Buffer const *, ostream & os) const
+void InsetSpecialChar::write(Buffer const &, ostream & os) const
 {
        string command;
        switch (kind_) {
@@ -181,19 +141,15 @@ void InsetSpecialChar::write(Buffer const *, ostream & os) const
        case MENU_SEPARATOR:
                command = "\\menuseparator";
                break;
-       case PROTECTED_SEPARATOR:
-               //command = "\\protected_separator";
-               command = "~";
-               break;
        }
        os << "\\SpecialChar " << command << "\n";
 }
 
 
 // This function will not be necessary when lyx3
-void InsetSpecialChar::read(Buffer const *, LyXLex & lex)
+void InsetSpecialChar::read(Buffer const &, LyXLex & lex)
 {
-       lex.nextToken();
+       lex.next();
        string const command = lex.getString();
 
        if (command == "\\-")
@@ -206,16 +162,13 @@ void InsetSpecialChar::read(Buffer const *, LyXLex & lex)
                kind_ = LDOTS;
        else if (command == "\\menuseparator")
                kind_ = MENU_SEPARATOR;
-       else if (command == "\\protected_separator"
-                || command == "~")
-               kind_ = PROTECTED_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 &, odocstream & os,
+                           OutputParams const &) const
 {
        switch (kind_) {
        case HYPHENATION:
@@ -233,22 +186,20 @@ int InsetSpecialChar::latex(Buffer const *, ostream & os, bool /*fragile*/,
        case MENU_SEPARATOR:
                os << "\\lyxarrow{}";
                break;
-       case PROTECTED_SEPARATOR:
-               os << (free_space ? " " : "~");
-               break;
        }
        return 0;
 }
 
 
-int InsetSpecialChar::ascii(Buffer const *, ostream & os, int) const
+int InsetSpecialChar::plaintext(Buffer const &, odocstream & os,
+                           OutputParams const &) const
 {
        switch (kind_) {
        case HYPHENATION:
        case LIGATURE_BREAK:
                break;
        case END_OF_SENTENCE:
-               os << ".";
+               os << '.';
                break;
        case LDOTS:
                os << "...";
@@ -256,22 +207,20 @@ int InsetSpecialChar::ascii(Buffer const *, ostream & os, int) const
        case MENU_SEPARATOR:
                os << "->";
                break;
-       case PROTECTED_SEPARATOR:
-               os << " ";
-               break;
        }
        return 0;
 }
 
 
-int InsetSpecialChar::linuxdoc(Buffer const *, ostream & os) const
+int InsetSpecialChar::docbook(Buffer const &, odocstream & os,
+                             OutputParams const &) const
 {
        switch (kind_) {
        case HYPHENATION:
        case LIGATURE_BREAK:
                break;
        case END_OF_SENTENCE:
-               os << ".";
+               os << '.';
                break;
        case LDOTS:
                os << "...";
@@ -279,40 +228,21 @@ int InsetSpecialChar::linuxdoc(Buffer const *, ostream & os) const
        case MENU_SEPARATOR:
                os << "&lyxarrow;";
                break;
-       case PROTECTED_SEPARATOR:
-               os << "&nbsp;";
-               break;
        }
        return 0;
 }
 
 
-int InsetSpecialChar::docbook(Buffer const *, ostream & os) const
+int InsetSpecialChar::textString(Buffer const & buf, odocstream & os,
+                      OutputParams const & op) const
 {
-       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 << "&nbsp;";
-               break;
-       }
-       return 0;
+       return plaintext(buf, os, op);
 }
 
 
-Inset * InsetSpecialChar::clone(Buffer const &, bool) const
+auto_ptr<InsetBase> InsetSpecialChar::doClone() const
 {
-       return new InsetSpecialChar(kind_);
+       return auto_ptr<InsetBase>(new InsetSpecialChar(kind_));
 }
 
 
@@ -336,12 +266,6 @@ bool InsetSpecialChar::isLetter() const
 }
 
 
-bool InsetSpecialChar::isSpace() const
-{
-       return kind_ == PROTECTED_SEPARATOR;
-}
-
-
 bool InsetSpecialChar::isLineSeparator() const
 {
 #if 0
@@ -354,3 +278,6 @@ bool InsetSpecialChar::isLineSeparator() const
        return false;
 #endif
 }
+
+
+} // namespace lyx