mirror of
https://git.lyx.org/repos/lyx.git
synced 2024-12-20 20:51:40 +00:00
a59301eaff
The current spelling is not strictly wrong, but flagged as unusual or
historical by some authorities. It is also found fault with many
spell checkers. Thus we decided to move to the more standard "-ible"
form once and for all.
See #10678 for discussion
This part covers the most tricky part: the internal naming.
Translations and layouts will follow.
This will all also all be backported to 2.3.x, for the sake of backwards
compatibility (cherry-picking).
(cherry picked from commit c466baaa5b)
409 lines
8.6 KiB
C++
409 lines
8.6 KiB
C++
/**
|
|
* \file InsetPhantom.cpp
|
|
* This file is part of LyX, the document processor.
|
|
* Licence details can be found in the file COPYING.
|
|
*
|
|
* \author Uwe Stöhr
|
|
*
|
|
* Full author contact details are available in file CREDITS.
|
|
*/
|
|
|
|
#include <config.h>
|
|
|
|
#include "InsetPhantom.h"
|
|
|
|
#include "Buffer.h"
|
|
#include "BufferParams.h"
|
|
#include "BufferView.h"
|
|
#include "BufferParams.h"
|
|
#include "Counters.h"
|
|
#include "Cursor.h"
|
|
#include "Dimension.h"
|
|
#include "DispatchResult.h"
|
|
#include "Exporter.h"
|
|
#include "FuncRequest.h"
|
|
#include "FuncStatus.h"
|
|
#include "InsetIterator.h"
|
|
#include "LaTeXFeatures.h"
|
|
#include "Lexer.h"
|
|
#include "MetricsInfo.h"
|
|
#include "OutputParams.h"
|
|
#include "texstream.h"
|
|
#include "TextClass.h"
|
|
|
|
#include "support/docstream.h"
|
|
#include "support/gettext.h"
|
|
#include "support/lstrings.h"
|
|
#include "support/Translator.h"
|
|
|
|
#include "frontends/Application.h"
|
|
#include "frontends/FontMetrics.h"
|
|
#include "frontends/Painter.h"
|
|
|
|
#include <algorithm>
|
|
#include <sstream>
|
|
|
|
using namespace std;
|
|
|
|
namespace lyx {
|
|
|
|
namespace {
|
|
|
|
typedef Translator<string, InsetPhantomParams::Type> PhantomTranslator;
|
|
typedef Translator<docstring, InsetPhantomParams::Type> PhantomTranslatorLoc;
|
|
|
|
PhantomTranslator const init_phantomtranslator()
|
|
{
|
|
PhantomTranslator translator("Phantom", InsetPhantomParams::Phantom);
|
|
translator.addPair("HPhantom", InsetPhantomParams::HPhantom);
|
|
translator.addPair("VPhantom", InsetPhantomParams::VPhantom);
|
|
return translator;
|
|
}
|
|
|
|
|
|
PhantomTranslatorLoc const init_phantomtranslator_loc()
|
|
{
|
|
PhantomTranslatorLoc translator(_("Phantom"), InsetPhantomParams::Phantom);
|
|
translator.addPair(_("HPhantom"), InsetPhantomParams::HPhantom);
|
|
translator.addPair(_("VPhantom"), InsetPhantomParams::VPhantom);
|
|
return translator;
|
|
}
|
|
|
|
|
|
PhantomTranslator const & phantomtranslator()
|
|
{
|
|
static PhantomTranslator const translator =
|
|
init_phantomtranslator();
|
|
return translator;
|
|
}
|
|
|
|
|
|
PhantomTranslatorLoc const & phantomtranslator_loc()
|
|
{
|
|
static PhantomTranslatorLoc const translator =
|
|
init_phantomtranslator_loc();
|
|
return translator;
|
|
}
|
|
|
|
} // namespace
|
|
|
|
|
|
InsetPhantomParams::InsetPhantomParams()
|
|
: type(Phantom)
|
|
{}
|
|
|
|
|
|
void InsetPhantomParams::write(ostream & os) const
|
|
{
|
|
string const label = phantomtranslator().find(type);
|
|
os << "Phantom " << label << "\n";
|
|
}
|
|
|
|
|
|
void InsetPhantomParams::read(Lexer & lex)
|
|
{
|
|
string label;
|
|
lex >> label;
|
|
if (lex)
|
|
type = phantomtranslator().find(label);
|
|
}
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////
|
|
//
|
|
// InsetPhantom
|
|
//
|
|
/////////////////////////////////////////////////////////////////////
|
|
|
|
InsetPhantom::InsetPhantom(Buffer * buf, string const & label)
|
|
: InsetCollapsible(buf)
|
|
{
|
|
setDrawFrame(false);
|
|
params_.type = phantomtranslator().find(label);
|
|
}
|
|
|
|
|
|
InsetPhantom::~InsetPhantom()
|
|
{
|
|
hideDialogs("phantom", this);
|
|
}
|
|
|
|
|
|
docstring InsetPhantom::layoutName() const
|
|
{
|
|
return from_ascii("Phantom:" + phantomtranslator().find(params_.type));
|
|
}
|
|
|
|
|
|
void InsetPhantom::draw(PainterInfo & pi, int x, int y) const
|
|
{
|
|
// draw the text
|
|
InsetCollapsible::draw(pi, x, y);
|
|
|
|
// draw the inset marker
|
|
drawMarkers(pi, x, y);
|
|
|
|
// draw the arrow(s)
|
|
static int const arrow_size = 4;
|
|
ColorCode const origcol = pi.base.font.color();
|
|
pi.base.font.setColor(Color_special);
|
|
pi.base.font.setColor(origcol);
|
|
Dimension const dim = dimension(*pi.base.bv);
|
|
|
|
if (params_.type == InsetPhantomParams::Phantom ||
|
|
params_.type == InsetPhantomParams::VPhantom) {
|
|
// y1---------
|
|
// / \.
|
|
// y2----- / | \.
|
|
// |
|
|
// |
|
|
// y3----- \ | /
|
|
// \ /
|
|
// y4---------
|
|
// | | |
|
|
// / | \.
|
|
// x1 x2 x3
|
|
|
|
int const x2 = x + dim.wid / 2;
|
|
int const x1 = x2 - arrow_size;
|
|
int const x3 = x2 + arrow_size;
|
|
|
|
int const y1 = y - dim.asc;
|
|
int const y2 = y1 + arrow_size;
|
|
int const y4 = y + dim.des;
|
|
int const y3 = y4 - arrow_size;
|
|
|
|
// top arrow
|
|
pi.pain.line(x2, y1, x1, y2, Color_added_space);
|
|
pi.pain.line(x2, y1, x3, y2, Color_added_space);
|
|
|
|
// bottom arrow
|
|
pi.pain.line(x2, y4, x1, y3, Color_added_space);
|
|
pi.pain.line(x2, y4, x3, y3, Color_added_space);
|
|
|
|
// joining line
|
|
pi.pain.line(x2, y1, x2, y4, Color_added_space);
|
|
}
|
|
|
|
if (params_.type == InsetPhantomParams::Phantom ||
|
|
params_.type == InsetPhantomParams::HPhantom) {
|
|
// y1---- / \.
|
|
// / \.
|
|
// y2--- <---------------->
|
|
// \ /
|
|
// y3---- \ /
|
|
// | | | |
|
|
// x1 x2 x3 x4
|
|
|
|
x = x + TEXT_TO_INSET_OFFSET;
|
|
int const x1 = x;
|
|
int const x2 = x + arrow_size;
|
|
int const x4 = x + dim.wid - 2 * TEXT_TO_INSET_OFFSET;
|
|
int const x3 = x4 - arrow_size;
|
|
|
|
int const y2 = y + (dim.des - dim.asc) / 2;
|
|
int const y1 = y2 - arrow_size;
|
|
int const y3 = y2 + arrow_size;
|
|
|
|
// left arrow
|
|
pi.pain.line(x1, y2, x2, y3, Color_added_space);
|
|
pi.pain.line(x1, y2, x2, y1, Color_added_space);
|
|
|
|
// right arrow
|
|
pi.pain.line(x4, y2, x3, y3, Color_added_space);
|
|
pi.pain.line(x4, y2, x3, y1, Color_added_space);
|
|
|
|
// joining line
|
|
pi.pain.line(x1, y2, x4, y2, Color_added_space);
|
|
}
|
|
}
|
|
|
|
|
|
void InsetPhantom::write(ostream & os) const
|
|
{
|
|
params_.write(os);
|
|
InsetCollapsible::write(os);
|
|
}
|
|
|
|
|
|
void InsetPhantom::read(Lexer & lex)
|
|
{
|
|
params_.read(lex);
|
|
InsetCollapsible::read(lex);
|
|
}
|
|
|
|
|
|
void InsetPhantom::setButtonLabel()
|
|
{
|
|
docstring const label = phantomtranslator_loc().find(params_.type);
|
|
setLabel(label);
|
|
}
|
|
|
|
|
|
bool InsetPhantom::showInsetDialog(BufferView * bv) const
|
|
{
|
|
bv->showDialog("phantom", params2string(params()),
|
|
const_cast<InsetPhantom *>(this));
|
|
return true;
|
|
}
|
|
|
|
|
|
void InsetPhantom::doDispatch(Cursor & cur, FuncRequest & cmd)
|
|
{
|
|
switch (cmd.action()) {
|
|
|
|
case LFUN_INSET_MODIFY:
|
|
cur.recordUndoInset(this);
|
|
string2params(to_utf8(cmd.argument()), params_);
|
|
setButtonLabel();
|
|
cur.forceBufferUpdate();
|
|
break;
|
|
|
|
case LFUN_INSET_DIALOG_UPDATE:
|
|
cur.bv().updateDialog("phantom", params2string(params()));
|
|
break;
|
|
|
|
default:
|
|
InsetCollapsible::doDispatch(cur, cmd);
|
|
break;
|
|
}
|
|
}
|
|
|
|
|
|
bool InsetPhantom::getStatus(Cursor & cur, FuncRequest const & cmd,
|
|
FuncStatus & flag) const
|
|
{
|
|
switch (cmd.action()) {
|
|
|
|
case LFUN_INSET_MODIFY:
|
|
if (cmd.getArg(0) == "phantom") {
|
|
InsetPhantomParams params;
|
|
string2params(to_utf8(cmd.argument()), params);
|
|
flag.setOnOff(params_.type == params.type);
|
|
}
|
|
flag.setEnabled(true);
|
|
return true;
|
|
|
|
case LFUN_INSET_DIALOG_UPDATE:
|
|
flag.setEnabled(true);
|
|
return true;
|
|
|
|
default:
|
|
return InsetCollapsible::getStatus(cur, cmd, flag);
|
|
}
|
|
}
|
|
|
|
|
|
docstring InsetPhantom::toolTip(BufferView const &, int, int) const
|
|
{
|
|
docstring const res = phantomtranslator_loc().find(params_.type);
|
|
return toolTipText(res + from_ascii(": "));
|
|
}
|
|
|
|
|
|
void InsetPhantom::latex(otexstream & os, OutputParams const & runparams) const
|
|
{
|
|
if (runparams.moving_arg)
|
|
os << "\\protect";
|
|
|
|
switch (params_.type) {
|
|
case InsetPhantomParams::Phantom:
|
|
os << "\\phantom{";
|
|
break;
|
|
case InsetPhantomParams::HPhantom:
|
|
os << "\\hphantom{";
|
|
break;
|
|
case InsetPhantomParams::VPhantom:
|
|
os << "\\vphantom{";
|
|
break;
|
|
default:
|
|
os << "\\phantom{";
|
|
break;
|
|
}
|
|
InsetCollapsible::latex(os, runparams);
|
|
os << "}";
|
|
}
|
|
|
|
|
|
int InsetPhantom::plaintext(odocstringstream & os,
|
|
OutputParams const & runparams, size_t max_length) const
|
|
{
|
|
switch (params_.type) {
|
|
case InsetPhantomParams::Phantom:
|
|
os << '[' << buffer().B_("phantom") << ":";
|
|
break;
|
|
case InsetPhantomParams::HPhantom:
|
|
os << '[' << buffer().B_("hphantom") << ":";
|
|
break;
|
|
case InsetPhantomParams::VPhantom:
|
|
os << '[' << buffer().B_("vphantom") << ":";
|
|
break;
|
|
default:
|
|
os << '[' << buffer().B_("phantom") << ":";
|
|
break;
|
|
}
|
|
InsetCollapsible::plaintext(os, runparams, max_length);
|
|
os << "]";
|
|
|
|
return PLAINTEXT_NEWLINE;
|
|
}
|
|
|
|
|
|
int InsetPhantom::docbook(odocstream & os, OutputParams const & runparams) const
|
|
{
|
|
docstring cmdname;
|
|
switch (params_.type) {
|
|
case InsetPhantomParams::Phantom:
|
|
case InsetPhantomParams::HPhantom:
|
|
case InsetPhantomParams::VPhantom:
|
|
default:
|
|
cmdname = from_ascii("phantom");
|
|
break;
|
|
}
|
|
os << "<" + cmdname + ">";
|
|
int const i = InsetCollapsible::docbook(os, runparams);
|
|
os << "</" + cmdname + ">";
|
|
|
|
return i;
|
|
}
|
|
|
|
|
|
docstring InsetPhantom::xhtml(XHTMLStream &, OutputParams const &) const
|
|
{
|
|
return docstring();
|
|
}
|
|
|
|
string InsetPhantom::contextMenuName() const
|
|
{
|
|
return "context-phantom";
|
|
}
|
|
|
|
|
|
string InsetPhantom::params2string(InsetPhantomParams const & params)
|
|
{
|
|
ostringstream data;
|
|
data << "phantom" << ' ';
|
|
params.write(data);
|
|
return data.str();
|
|
}
|
|
|
|
|
|
void InsetPhantom::string2params(string const & in, InsetPhantomParams & params)
|
|
{
|
|
params = InsetPhantomParams();
|
|
|
|
if (in.empty())
|
|
return;
|
|
|
|
istringstream data(in);
|
|
Lexer lex;
|
|
lex.setStream(data);
|
|
lex.setContext("InsetPhantom::string2params");
|
|
lex >> "phantom" >> "Phantom";
|
|
|
|
params.read(lex);
|
|
}
|
|
|
|
|
|
} // namespace lyx
|