lyx_mirror/src/insets/InsetSpecialChar.cpp
Christian Ridderström e30f3d76d2 Bulk cleanup/fix incorrect annotation at the end of namespaces.
This commit does a bulk fix of incorrect annotations (comments) at the
end of namespaces.

The commit was generated by initially running clang-format, and then
from the diff of the result extracting the hunks corresponding to
fixes of namespace comments. The changes being applied and all the
results have been manually reviewed. The source code successfully
builds on macOS.

Further details on the steps below, in case they're of interest to
someone else in the future.

1. Checkout a fresh and up to date version of src/

    git pull && git checkout -- src && git status src

2. Ensure there's a suitable .clang-format in place, i.e. with options
   to fix the comment at the end of namespaces, including:

    FixNamespaceComments:                           true
    SpacesBeforeTrailingComments:                   1

and that clang-format is >= 5.0.0, by doing e.g.:

    clang-format -dump-config | grep Comments:
    clang-format --version

3. Apply clang-format to the source:

    clang-format -i $(find src -name "*.cpp" -or -name "*.h")

4. Create and filter out hunks related to fixing the namespace

    git diff -U0 src > tmp.patch
    grepdiff '^} // namespace' --output-matching=hunk tmp.patch  > fix_namespace.patch

5. Filter out hunks corresponding to simple fixes into to a separate patch:

    pcregrep -M -e '^diff[^\n]+\nindex[^\n]+\n--- [^\n]+\n\+\+\+ [^\n]+\n'  \
        -e '^@@ -[0-9]+ \+[0-9]+ @@[^\n]*\n-\}[^\n]*\n\+\}[^\n]*\n'         \
        fix_namespace.patch > fix_namespace_simple.patch

6. Manually review the simple patch and then apply it, after first
   restoring the source.

    git checkout -- src
    patch -p1 < fix_namespace_simple.path

7. Manually review the (simple) changes and then stage the changes

    git diff src
    git add src

8. Again apply clang-format and filter out hunks related to any
   remaining fixes to the namespace, this time filter with more
   context. There will be fewer hunks as all the simple cases have
   already been handled:

    clang-format -i $(find src -name "*.cpp" -or -name "*.h")
    git diff src > tmp.patch
    grepdiff '^} // namespace' --output-matching=hunk tmp.patch  > fix_namespace2.patch

9. Manually review/edit the resulting patch file to remove hunks for files
   which need to be dealt with manually, noting the file names and
   line numbers. Then restore files to as before applying clang-format
   and apply the patch:

    git checkout src
    patch -p1 < fix_namespace2.patch

10. Manually fix the files noted in the previous step. Stage files,
    review changes and commit.
2017-07-23 13:11:54 +02:00

673 lines
14 KiB
C++

/**
* \file InsetSpecialChar.cpp
* 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>
#include "InsetSpecialChar.h"
#include "Dimension.h"
#include "Font.h"
#include "LaTeXFeatures.h"
#include "Lexer.h"
#include "MetricsInfo.h"
#include "output_xhtml.h"
#include "texstream.h"
#include "frontends/FontMetrics.h"
#include "frontends/Painter.h"
#include "support/debug.h"
#include "support/docstream.h"
using namespace std;
namespace lyx {
InsetSpecialChar::InsetSpecialChar(Kind k)
: Inset(0), kind_(k)
{}
InsetSpecialChar::Kind InsetSpecialChar::kind() const
{
return kind_;
}
namespace {
int logoWidth(FontInfo const & font, InsetSpecialChar::Kind kind) {
frontend::FontMetrics const & fm = theFontMetrics(font);
int const em = fm.em();
int width = 0;
// See drawlogo() below to understand what this does.
switch (kind) {
case InsetSpecialChar::PHRASE_LYX:
width = fm.width(from_ascii("L")) - em / 6
+ fm.width(from_ascii("Y")) - em / 8
+ fm.width(from_ascii("X"));
break;
case InsetSpecialChar::PHRASE_TEX:
width = fm.width(from_ascii("T")) - em / 6
+ fm.width(from_ascii("E")) - em / 8
+ fm.width(from_ascii("X"));
break;
case InsetSpecialChar::PHRASE_LATEX2E:
width = logoWidth(font, InsetSpecialChar::PHRASE_LATEX)
+ 3 * em / 20
+ fm.width(from_ascii("2") + char_type(0x03b5));
break;
case InsetSpecialChar::PHRASE_LATEX: {
FontInfo smaller = font;
smaller.decSize().decSize();
width = fm.width(from_ascii("L")) - 9 * em / 25
+ theFontMetrics(smaller).width(from_ascii("A")) - 3 * em / 20
+ logoWidth(font, InsetSpecialChar::PHRASE_TEX);
break;
}
default:
LYXERR0("No information for computing width of logo " << kind);
}
return width;
}
} // namespace
docstring InsetSpecialChar::toolTip(BufferView const &, int, int) const
{
docstring message;
switch (kind_) {
case ALLOWBREAK:
message = from_ascii("Optional Line Break (ZWSP)");
break;
case LIGATURE_BREAK:
message = from_ascii("Ligature Break (ZWNJ)");
break;
case END_OF_SENTENCE:
message = from_ascii("End of Sentence");
break;
case HYPHENATION:
message = from_ascii("Hyphenation Point");
break;
case SLASH:
message = from_ascii("Breakable Slash");
break;
case NOBREAKDASH:
message = from_ascii("Protected Hyphen (SHY)");
break;
case LDOTS:
case MENU_SEPARATOR:
case PHRASE_LYX:
case PHRASE_TEX:
case PHRASE_LATEX2E:
case PHRASE_LATEX:
// no tooltip for these ones.
break;
}
return message;
}
void InsetSpecialChar::metrics(MetricsInfo & mi, Dimension & dim) const
{
frontend::FontMetrics const & fm =
theFontMetrics(mi.base.font);
dim.asc = fm.maxAscent();
dim.des = fm.maxDescent();
dim.wid = 0;
docstring s;
switch (kind_) {
case ALLOWBREAK:
dim.wid = fm.em() / 8;
break;
case LIGATURE_BREAK:
s = from_ascii("|");
break;
case END_OF_SENTENCE:
s = from_ascii(".");
break;
case LDOTS:
s = from_ascii(". . .");
break;
case MENU_SEPARATOR:
s = from_ascii(" x ");
break;
case HYPHENATION:
dim.wid = fm.width(from_ascii("-"));
if (dim.wid > 5)
dim.wid -= 2; // to make it look shorter
break;
case SLASH:
s = from_ascii("/");
break;
case NOBREAKDASH:
s = from_ascii("-");
break;
case PHRASE_LYX:
case PHRASE_TEX:
case PHRASE_LATEX2E:
case PHRASE_LATEX:
dim.wid = logoWidth(mi.base.font, kind_);
break;
}
if (dim.wid == 0)
dim.wid = fm.width(s);
}
namespace {
// helper function: draw text and update x.
void drawChar(PainterInfo & pi, int & x, int const y, char_type ch)
{
FontInfo font = pi.base.font;
font.setPaintColor(pi.textColor(font.realColor()));
pi.pain.text(x, y, ch, font);
x += theFontMetrics(font).width(ch);
}
void drawLogo(PainterInfo & pi, int & x, int const y, InsetSpecialChar::Kind kind)
{
FontInfo const & font = pi.base.font;
int const em = theFontMetrics(font).em();
switch (kind) {
case InsetSpecialChar::PHRASE_LYX:
/** Reference macro:
* \providecommand{\LyX}{L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\\@};
*/
drawChar(pi, x, y, 'L');
x -= em / 6;
drawChar(pi, x, y + em / 4, 'Y');
x -= em / 8;
drawChar(pi, x, y, 'X');
break;
case InsetSpecialChar::PHRASE_TEX: {
/** Reference macro:
* \def\TeX{T\kern-.1667em\lower.5ex\hbox{E}\kern-.125emX\@}
*/
int const ex = theFontMetrics(font).ascent('x');
drawChar(pi, x, y, 'T');
x -= em / 6;
drawChar(pi, x, y + ex / 2, 'E');
x -= em / 8;
drawChar(pi, x, y, 'X');
break;
}
case InsetSpecialChar::PHRASE_LATEX2E:
/** Reference macro:
* \DeclareRobustCommand{\LaTeXe}{\mbox{\m@th
* \if b\expandafter\@car\f@series\@nil\boldmath\fi
* \LaTeX\kern.15em2$_{\textstyle\varepsilon}$}}
*/
drawLogo(pi, x, y, InsetSpecialChar::PHRASE_LATEX);
x += 3 * em / 20;
drawChar(pi, x, y, '2');
drawChar(pi, x, y + em / 4, char_type(0x03b5));
break;
case InsetSpecialChar::PHRASE_LATEX: {
/** Reference macro:
* \DeclareRobustCommand{\LaTeX}{L\kern-.36em%
* {\sbox\z@ T%
* \vbox to\ht\z@{\hbox{\check@mathfonts
* \fontsize\sf@size\z@
* \math@fontsfalse\selectfont
* A}%
* \vss}%
* }%
* \kern-.15em%
* \TeX}
*/
drawChar(pi, x, y, 'L');
x -= 9 * em / 25;
PainterInfo pi2 = pi;
pi2.base.font.decSize().decSize();
drawChar(pi2, x, y - em / 5, 'A');
x -= 3 * em / 20;
drawLogo(pi, x, y, InsetSpecialChar::PHRASE_TEX);
break;
}
default:
LYXERR0("No information for drawing logo " << kind);
}
}
} // namespace
void InsetSpecialChar::draw(PainterInfo & pi, int x, int y) const
{
FontInfo font = pi.base.font;
switch (kind_) {
case HYPHENATION:
{
font.setColor(Color_special);
pi.pain.text(x, y, char_type('-'), font);
break;
}
case ALLOWBREAK:
{
// A small vertical line
int const asc = theFontMetrics(pi.base.font).ascent('x');
int const desc = theFontMetrics(pi.base.font).descent('g');
int const x0 = x; // x + 1; // FIXME: incline,
int const x1 = x; // x - 1; // similar to LibreOffice?
int const y0 = y + desc;
int const y1 = y - asc / 3;
pi.pain.line(x0, y1, x1, y0, Color_special);
break;
}
case LIGATURE_BREAK:
{
font.setColor(Color_special);
pi.pain.text(x, y, char_type('|'), font);
break;
}
case END_OF_SENTENCE:
{
font.setColor(Color_special);
pi.pain.text(x, y, char_type('.'), font);
break;
}
case LDOTS:
{
font.setColor(Color_special);
string ell = ". . . ";
docstring dell(ell.begin(), ell.end());
pi.pain.text(x, y, dell, font);
break;
}
case MENU_SEPARATOR:
{
frontend::FontMetrics const & fm =
theFontMetrics(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] = 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;
pi.pain.lines(xp, yp, 4, Color_special);
break;
}
case SLASH:
{
font.setColor(Color_special);
pi.pain.text(x, y, char_type('/'), font);
break;
}
case NOBREAKDASH:
{
font.setColor(Color_latex);
pi.pain.text(x, y, char_type('-'), font);
break;
}
case PHRASE_LYX:
case PHRASE_TEX:
case PHRASE_LATEX2E:
case PHRASE_LATEX:
drawLogo(pi, x, y, kind_);
break;
}
}
void InsetSpecialChar::write(ostream & os) const
{
string command;
switch (kind_) {
case HYPHENATION:
command = "softhyphen";
break;
case ALLOWBREAK:
command = "allowbreak";
break;
case LIGATURE_BREAK:
command = "ligaturebreak";
break;
case END_OF_SENTENCE:
command = "endofsentence";
break;
case LDOTS:
command = "ldots";
break;
case MENU_SEPARATOR:
command = "menuseparator";
break;
case SLASH:
command = "breakableslash";
break;
case NOBREAKDASH:
command = "nobreakdash";
break;
case PHRASE_LYX:
command = "LyX";
break;
case PHRASE_TEX:
command = "TeX";
break;
case PHRASE_LATEX2E:
command = "LaTeX2e";
break;
case PHRASE_LATEX:
command = "LaTeX";
break;
}
os << "\\SpecialChar " << command << "\n";
}
void InsetSpecialChar::read(Lexer & lex)
{
lex.next();
string const command = lex.getString();
if (command == "softhyphen")
kind_ = HYPHENATION;
else if (command == "allowbreak")
kind_ = ALLOWBREAK;
else if (command == "ligaturebreak")
kind_ = LIGATURE_BREAK;
else if (command == "endofsentence")
kind_ = END_OF_SENTENCE;
else if (command == "ldots")
kind_ = LDOTS;
else if (command == "menuseparator")
kind_ = MENU_SEPARATOR;
else if (command == "breakableslash")
kind_ = SLASH;
else if (command == "nobreakdash")
kind_ = NOBREAKDASH;
else if (command == "LyX")
kind_ = PHRASE_LYX;
else if (command == "TeX")
kind_ = PHRASE_TEX;
else if (command == "LaTeX2e")
kind_ = PHRASE_LATEX2E;
else if (command == "LaTeX")
kind_ = PHRASE_LATEX;
else
lex.printError("InsetSpecialChar: Unknown kind: `$$Token'");
}
void InsetSpecialChar::latex(otexstream & os,
OutputParams const & rp) const
{
switch (kind_) {
case HYPHENATION:
os << "\\-";
break;
case ALLOWBREAK:
os << "\\LyXZeroWidthSpace" << termcmd;
break;
case LIGATURE_BREAK:
os << "\\textcompwordmark" << termcmd;
break;
case END_OF_SENTENCE:
os << "\\@.";
break;
case LDOTS:
os << "\\ldots" << termcmd;
break;
case MENU_SEPARATOR:
if (rp.local_font->isRightToLeft())
os << "\\lyxarrow*";
else
os << "\\lyxarrow";
os << termcmd;
break;
case SLASH:
os << "\\slash" << termcmd;
break;
case NOBREAKDASH:
if (rp.moving_arg)
os << "\\protect";
os << "\\nobreakdash-";
break;
case PHRASE_LYX:
if (rp.moving_arg)
os << "\\protect";
os << "\\LyX" << termcmd;
break;
case PHRASE_TEX:
if (rp.moving_arg)
os << "\\protect";
os << "\\TeX" << termcmd;
break;
case PHRASE_LATEX2E:
if (rp.moving_arg)
os << "\\protect";
os << "\\LaTeXe" << termcmd;
break;
case PHRASE_LATEX:
if (rp.moving_arg)
os << "\\protect";
os << "\\LaTeX" << termcmd;
break;
}
}
int InsetSpecialChar::plaintext(odocstringstream & os,
OutputParams const &, size_t) const
{
switch (kind_) {
case HYPHENATION:
return 0;
case ALLOWBREAK:
os.put(0x200b);
return 1;
case LIGATURE_BREAK:
os.put(0x200c);
return 1;
case END_OF_SENTENCE:
os << '.';
return 1;
case LDOTS:
os.put(0x2026);
return 1;
case MENU_SEPARATOR:
os << "->";
return 2;
case SLASH:
os << '/';
return 1;
case NOBREAKDASH:
os.put(0x2011);
return 1;
case PHRASE_LYX:
os << "LyX";
return 3;
case PHRASE_TEX:
os << "TeX";
return 3;
case PHRASE_LATEX2E:
os << "LaTeX2";
os.put(0x03b5);
return 7;
case PHRASE_LATEX:
os << "LaTeX";
return 5;
}
return 0;
}
int InsetSpecialChar::docbook(odocstream & os, OutputParams const &) const
{
switch (kind_) {
case HYPHENATION:
break;
case ALLOWBREAK:
os.put(0x200b);
break;
case LIGATURE_BREAK:
break;
case END_OF_SENTENCE:
os << '.';
break;
case LDOTS:
os << "&hellip;";
break;
case MENU_SEPARATOR:
os << "&lyxarrow;";
break;
case SLASH:
os << '/';
break;
case NOBREAKDASH:
os << '-';
break;
case PHRASE_LYX:
os << "LyX";
break;
case PHRASE_TEX:
os << "TeX";
break;
case PHRASE_LATEX2E:
os << "LaTeX2";
os.put(0x03b5);
break;
case PHRASE_LATEX:
os << "LaTeX";
break;
}
return 0;
}
docstring InsetSpecialChar::xhtml(XHTMLStream & xs, OutputParams const &) const
{
switch (kind_) {
case HYPHENATION:
break;
case ALLOWBREAK:
xs << XHTMLStream::ESCAPE_NONE << "&#8203;";
break;
case LIGATURE_BREAK:
xs << XHTMLStream::ESCAPE_NONE << "&#8204;";
break;
case END_OF_SENTENCE:
xs << '.';
break;
case LDOTS:
xs << XHTMLStream::ESCAPE_NONE << "&hellip;";
break;
case MENU_SEPARATOR:
xs << XHTMLStream::ESCAPE_NONE << "&rArr;";
break;
case SLASH:
xs << XHTMLStream::ESCAPE_NONE << "&frasl;";
break;
case NOBREAKDASH:
xs << XHTMLStream::ESCAPE_NONE << "&#8209;";
break;
case PHRASE_LYX:
xs << "LyX";
break;
case PHRASE_TEX:
xs << "TeX";
break;
case PHRASE_LATEX2E:
xs << "LaTeX2" << XHTMLStream::ESCAPE_NONE << "&#x3b5;";
break;
case PHRASE_LATEX:
xs << "LaTeX";
break;
}
return docstring();
}
void InsetSpecialChar::toString(odocstream & os) const
{
switch (kind_) {
case ALLOWBREAK:
case LIGATURE_BREAK:
// Do not output ZERO WIDTH SPACE and ZERO WIDTH NON JOINER here
// Spell checker would choke on it.
return;
default:
break;
}
odocstringstream ods;
plaintext(ods, OutputParams(0));
os << ods.str();
}
void InsetSpecialChar::forOutliner(docstring & os, size_t const,
bool const) const
{
odocstringstream ods;
plaintext(ods, OutputParams(0));
os += ods.str();
}
void InsetSpecialChar::validate(LaTeXFeatures & features) const
{
if (kind_ == ALLOWBREAK)
features.require("lyxzerowidthspace");
if (kind_ == MENU_SEPARATOR)
features.require("lyxarrow");
if (kind_ == NOBREAKDASH)
features.require("amsmath");
if (kind_ == PHRASE_LYX)
features.require("LyX");
}
bool InsetSpecialChar::isChar() const
{
return kind_ != HYPHENATION && kind_ != LIGATURE_BREAK;
}
bool InsetSpecialChar::isLetter() const
{
return kind_ == HYPHENATION || kind_ == LIGATURE_BREAK
|| kind_ == NOBREAKDASH;
}
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_ == ALLOWBREAK
|| kind_ == MENU_SEPARATOR || kind_ == SLASH;
#else
return false;
#endif
}
} // namespace lyx