]> git.lyx.org Git - lyx.git/blobdiff - src/insets/insetspecialchar.C
fix typo that put too many include paths for most people
[lyx.git] / src / insets / insetspecialchar.C
index 172e0d4aaab69ea7f5fba03e541659502bb224de..b75d573b3700ced7100e567015602675370dd7d5 100644 (file)
@@ -1,8 +1,8 @@
 /* This file is part of
  * ======================================================
- * 
+ *
  *           LyX, The Document Processor
- *      
+ *
  *         Copyright 1997 Asger Alstrup
  *
  * ====================================================== */
 #include "BufferView.h"
 #include "Painter.h"
 #include "font.h"
+#include "lyxlex.h"
+#include "lyxfont.h"
 
 using std::ostream;
 using std::max;
 
 InsetSpecialChar::InsetSpecialChar(Kind k)
-       : kind(k)
+       : kind_(k)
 {}
 
 
-int InsetSpecialChar::ascent(Painter &, LyXFont const & font) const
+InsetSpecialChar::Kind InsetSpecialChar::kind() const
+{
+       return kind_;
+}
+
+int InsetSpecialChar::ascent(BufferView *, LyXFont const & font) const
 {
        return lyxfont::maxAscent(font);
 }
 
 
-int InsetSpecialChar::descent(Painter &, LyXFont const & font) const
+int InsetSpecialChar::descent(BufferView *, LyXFont const & font) const
 {
        return lyxfont::maxDescent(font);
 }
 
 
-int InsetSpecialChar::width(Painter &, LyXFont const & font) const
+int InsetSpecialChar::width(BufferView *, LyXFont const & font) const
 {
-       switch (kind) {
+       switch (kind_) {
        case HYPHENATION:
        {
                int w = lyxfont::width('-', font);
-               if (w > 5) 
+               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);
@@ -66,7 +77,7 @@ int InsetSpecialChar::width(Painter &, LyXFont const & font) const
        {
                return lyxfont::width('x', font);
        }
-       
+
        }
        return 1; // To shut up gcc
 }
@@ -78,26 +89,33 @@ void InsetSpecialChar::draw(BufferView * bv, LyXFont const & f,
        Painter & pain = bv->painter();
        LyXFont font(f);
 
-       switch (kind) {
+       switch (kind_) {
        case HYPHENATION:
        {
                font.setColor(LColor::special);
                pain.text(int(x), baseline, "-", font);
-               x += width(pain, font);
+               x += width(bv, font);
+               break;
+       }
+       case LIGATURE_BREAK:
+       {
+               font.setColor(LColor::special);
+               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);
-               x += width(pain, font);
+               x += width(bv, font);
                break;
        }
        case LDOTS:
        {
                font.setColor(LColor::special);
                pain.text(int(x), baseline, ". . .", font);
-               x += width(pain, font);
+               x += width(bv, font);
                break;
        }
        case MENU_SEPARATOR:
@@ -107,22 +125,22 @@ void InsetSpecialChar::draw(BufferView * bv, LyXFont const & f,
                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(pain, font);
+               x += width(bv, font);
                break;
        }
        case PROTECTED_SEPARATOR:
        {
-               float w = width(pain, font);
+               float w = width(bv, font);
                int h = lyxfont::ascent('x', font);
                int xp[4], yp[4];
-               
+
                xp[0] = int(x);
                yp[0] = baseline - max(h / 4, 1);
 
@@ -134,7 +152,7 @@ void InsetSpecialChar::draw(BufferView * bv, LyXFont const & f,
 
                xp[3] = int(x + w);
                yp[3] = baseline - max(h / 4, 1);
-               
+
                pain.lines(xp, yp, 4, LColor::special);
                x += w;
                break;
@@ -144,14 +162,25 @@ 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) {
-       case HYPHENATION:       command = "\\-";        break;
-       case END_OF_SENTENCE:   command = "\\@.";       break;
-       case LDOTS:             command = "\\ldots{}";  break;
-       case MENU_SEPARATOR:    command = "\\menuseparator"; break;
+       switch (kind_) {
+       case HYPHENATION:
+               command = "\\-";
+               break;
+       case LIGATURE_BREAK:
+               command = "\\textcompwordmark{}";
+               break;
+       case END_OF_SENTENCE:
+               command = "\\@.";
+               break;
+       case LDOTS:
+               command = "\\ldots{}";
+               break;
+       case MENU_SEPARATOR:
+               command = "\\menuseparator";
+               break;
        case PROTECTED_SEPARATOR:
                //command = "\\protected_separator";
                command = "~";
@@ -162,74 +191,166 @@ void InsetSpecialChar::Write(Buffer const *, ostream & os) const
 
 
 // This function will not be necessary when lyx3
-void InsetSpecialChar::Read(Buffer const *, LyXLex & lex)
-{    
+void InsetSpecialChar::read(Buffer const *, LyXLex & lex)
+{
        lex.nextToken();
-       string command = lex.GetString();
+       string const command = lex.getString();
 
        if (command == "\\-")
-               kind = HYPHENATION;
+               kind_ = HYPHENATION;
+       else if (command == "\\textcompwordmark{}")
+               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;
+               kind_ = MENU_SEPARATOR;
        else if (command == "\\protected_separator"
                 || command == "~")
-               kind = PROTECTED_SEPARATOR;
+               kind_ = PROTECTED_SEPARATOR;
        else
                lex.printError("InsetSpecialChar: Unknown kind: `$$Token'");
 }
 
 
-int InsetSpecialChar::Latex(Buffer const *, ostream & os, bool /*fragile*/,
+int InsetSpecialChar::latex(Buffer const *, ostream & os, bool /*fragile*/,
                            bool free_space) const
 {
-       switch (kind) {
-       case HYPHENATION:         os << "\\-";  break;
-       case END_OF_SENTENCE:     os << "\\@."; break;
-       case LDOTS:               os << "\\ldots{}";    break;
-       case MENU_SEPARATOR:      os << "\\lyxarrow{}"; break;
-       case PROTECTED_SEPARATOR: os << (free_space ? " " : "~"); break;
+       switch (kind_) {
+       case HYPHENATION:
+               os << "\\-";
+               break;
+       case LIGATURE_BREAK:
+               os << "\\textcompwordmark{}";
+               break;
+       case END_OF_SENTENCE:
+               os << "\\@.";
+               break;
+       case LDOTS:
+               os << "\\ldots{}";
+               break;
+       case MENU_SEPARATOR:
+               os << "\\lyxarrow{}";
+               break;
+       case PROTECTED_SEPARATOR:
+               os << (free_space ? " " : "~");
+               break;
        }
        return 0;
 }
 
-int InsetSpecialChar::Ascii(Buffer const *, ostream & os) const
+
+int InsetSpecialChar::ascii(Buffer const *, ostream & os, int) const
 {
-       switch (kind) {
-       case HYPHENATION:                       break;
-       case END_OF_SENTENCE:     os << ".";    break;
-       case LDOTS:               os << "...";  break;
-       case MENU_SEPARATOR:      os << "->";   break;
-       case PROTECTED_SEPARATOR: os << " ";   break;
+       switch (kind_) {
+       case HYPHENATION:
+       case LIGATURE_BREAK:
+               break;
+       case END_OF_SENTENCE:
+               os << ".";
+               break;
+       case LDOTS:
+               os << "...";
+               break;
+       case MENU_SEPARATOR:
+               os << "->";
+               break;
+       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);
+       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;
 }
 
 
-int InsetSpecialChar::DocBook(Buffer const * buf, ostream & os) const
+int InsetSpecialChar::docbook(Buffer const *, ostream & os) const
 {
-       return Ascii(buf, os);
+       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;
 }
 
 
-Inset * InsetSpecialChar::Clone() const
+Inset * InsetSpecialChar::clone(Buffer const &, bool) const
 {
-       return new InsetSpecialChar(kind);
+       return new InsetSpecialChar(kind_);
 }
 
 
-void InsetSpecialChar::Validate(LaTeXFeatures & features) const
+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
+}