lyx_mirror/src/insets/insetnote.C
Georg Baum 9b5a63aaaf Fix return value of InsetText::plaintext
* src/insets/insetnote.C
	(InsetNote::plaintext): Move line counting code from here ...

	* src/insets/insettext.C
	(InsetText::plaintext): ... here.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@14957 a592a061-630c-0410-9148-cb99ea01b6c8
2006-09-10 08:41:39 +00:00

412 lines
8.7 KiB
C

/**
* \file insetnote.C
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Angus Leeming
* \author Martin Vermeer
* \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "insetnote.h"
#include "BufferView.h"
#include "cursor.h"
#include "debug.h"
#include "dispatchresult.h"
#include "exporter.h"
#include "funcrequest.h"
#include "FuncStatus.h"
#include "gettext.h"
#include "LaTeXFeatures.h"
#include "LColor.h"
#include "lyxlex.h"
#include "metricsinfo.h"
#include "outputparams.h"
#include "paragraph.h"
#include "support/lyxalgo.h"
#include "support/translator.h"
#include <sstream>
using lyx::docstring;
using std::string;
using std::auto_ptr;
using std::istringstream;
using std::ostream;
using std::ostringstream;
namespace {
typedef Translator<std::string, InsetNoteParams::Type> NoteTranslator;
NoteTranslator const init_notetranslator()
{
NoteTranslator translator("Note", InsetNoteParams::Note);
translator.addPair("Comment", InsetNoteParams::Comment);
translator.addPair("Greyedout", InsetNoteParams::Greyedout);
translator.addPair("Framed", InsetNoteParams::Framed);
translator.addPair("Shaded", InsetNoteParams::Shaded);
return translator;
}
NoteTranslator const init_notetranslator_loc()
{
// FIXME UNICODE
NoteTranslator translator(lyx::to_utf8(_("Note")), InsetNoteParams::Note);
translator.addPair(lyx::to_utf8(_("Comment")), InsetNoteParams::Comment);
translator.addPair(lyx::to_utf8(_("Greyed out")), InsetNoteParams::Greyedout);
translator.addPair(lyx::to_utf8(_("Framed")), InsetNoteParams::Framed);
translator.addPair(lyx::to_utf8(_("Shaded")), InsetNoteParams::Shaded);
return translator;
}
NoteTranslator const & notetranslator()
{
static NoteTranslator translator = init_notetranslator();
return translator;
}
NoteTranslator const & notetranslator_loc()
{
static NoteTranslator translator = init_notetranslator_loc();
return translator;
}
} // anon
InsetNoteParams::InsetNoteParams()
: type(Note)
{}
void InsetNoteParams::write(ostream & os) const
{
string const label = notetranslator().find(type);
os << "Note " << label << "\n";
}
void InsetNoteParams::read(LyXLex & lex)
{
string label;
lex >> label;
if (lex)
type = notetranslator().find(label);
}
void InsetNote::init()
{
setInsetName("Note");
setButtonLabel();
}
InsetNote::InsetNote(BufferParams const & bp, string const & label)
: InsetCollapsable(bp)
{
params_.type = notetranslator().find(label);
init();
}
InsetNote::InsetNote(InsetNote const & in)
: InsetCollapsable(in), params_(in.params_)
{
init();
}
InsetNote::~InsetNote()
{
InsetNoteMailer(*this).hideDialog();
}
auto_ptr<InsetBase> InsetNote::doClone() const
{
return auto_ptr<InsetBase>(new InsetNote(*this));
}
docstring const InsetNote::editMessage() const
{
return _("Opened Note Inset");
}
void InsetNote::write(Buffer const & buf, ostream & os) const
{
params_.write(os);
InsetCollapsable::write(buf, os);
}
void InsetNote::read(Buffer const & buf, LyXLex & lex)
{
params_.read(lex);
InsetCollapsable::read(buf, lex);
setButtonLabel();
}
void InsetNote::setButtonLabel()
{
string const label = notetranslator_loc().find(params_.type);
setLabel(label);
LyXFont font(LyXFont::ALL_SANE);
font.decSize();
font.decSize();
switch (params_.type) {
case InsetNoteParams::Note:
font.setColor(LColor::note);
setBackgroundColor(LColor::notebg);
break;
case InsetNoteParams::Comment:
font.setColor(LColor::comment);
setBackgroundColor(LColor::commentbg);
break;
case InsetNoteParams::Greyedout:
font.setColor(LColor::greyedout);
setBackgroundColor(LColor::greyedoutbg);
break;
case InsetNoteParams::Framed:
font.setColor(LColor::greyedout);
setBackgroundColor(LColor::greyedoutbg);
break;
case InsetNoteParams::Shaded:
font.setColor(LColor::greyedout);
setBackgroundColor(LColor::shadedbg);
break;
}
setLabelFont(font);
}
bool InsetNote::showInsetDialog(BufferView * bv) const
{
InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
return true;
}
void InsetNote::doDispatch(LCursor & cur, FuncRequest & cmd)
{
switch (cmd.action) {
case LFUN_INSET_MODIFY:
InsetNoteMailer::string2params(lyx::to_utf8(cmd.argument()), params_);
setButtonLabel();
break;
case LFUN_INSET_DIALOG_UPDATE:
InsetNoteMailer(*this).updateDialog(&cur.bv());
break;
case LFUN_MOUSE_RELEASE:
if (cmd.button() == mouse_button::button3 && hitButton(cmd))
InsetNoteMailer(*this).showDialog(&cur.bv());
else
InsetCollapsable::doDispatch(cur, cmd);
break;
default:
InsetCollapsable::doDispatch(cur, cmd);
break;
}
}
bool InsetNote::getStatus(LCursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const
{
switch (cmd.action) {
case LFUN_INSET_MODIFY:
case LFUN_INSET_DIALOG_UPDATE:
flag.enabled(true);
return true;
default:
return InsetCollapsable::getStatus(cur, cmd, flag);
}
}
int InsetNote::latex(Buffer const & buf, ostream & os,
OutputParams const & runparams_in) const
{
if (params_.type == InsetNoteParams::Note)
return 0;
OutputParams runparams(runparams_in);
string type;
if (params_.type == InsetNoteParams::Comment) {
type = "comment";
runparams.inComment = true;
// Ignore files that are exported inside a comment
runparams.exportdata.reset(new ExportData);
} else if (params_.type == InsetNoteParams::Greyedout)
type = "lyxgreyedout";
else if (params_.type == InsetNoteParams::Framed)
type = "framed";
else if (params_.type == InsetNoteParams::Shaded)
type = "shaded";
ostringstream ss;
ss << "%\n\\begin{" << type << "}\n";
InsetText::latex(buf, ss, runparams);
ss << "\n\\end{" << type << "}\n";
// the space after the comment in 'a[comment] b' will be eaten by the
// comment environment since the space before b is ignored with the
// following latex output:
//
// a%
// \begin{comment}
// comment
// \end{comment}
// b
//
// Adding {} before ' b' fixes this.
if (params_.type == InsetNoteParams::Comment)
ss << "{}";
string const str = ss.str();
os << str;
// Return how many newlines we issued.
return int(lyx::count(str.begin(), str.end(),'\n'));
}
int InsetNote::docbook(Buffer const & buf, std::ostream & os,
OutputParams const & runparams_in) const
{
if (params_.type == InsetNoteParams::Note)
return 0;
OutputParams runparams(runparams_in);
ostringstream ss;
if (params_.type == InsetNoteParams::Comment) {
ss << "<remark>\n";
runparams.inComment = true;
// Ignore files that are exported inside a comment
runparams.exportdata.reset(new ExportData);
}
InsetText::docbook(buf, ss, runparams);
if (params_.type == InsetNoteParams::Comment)
ss << "\n</remark>\n";
string const str = ss.str();
os << str;
// Return how many newlines we issued.
return int(lyx::count(str.begin(), str.end(),'\n'));
}
int InsetNote::plaintext(Buffer const & buf, std::ostream & os,
OutputParams const & runparams_in) const
{
if (params_.type == InsetNoteParams::Note)
return 0;
OutputParams runparams(runparams_in);
if (params_.type == InsetNoteParams::Comment) {
runparams.inComment = true;
// Ignore files that are exported inside a comment
runparams.exportdata.reset(new ExportData);
}
os << "[";
int const nlines = InsetText::plaintext(buf, os, runparams);
os << "]";
// Return how many newlines we issued.
return nlines;
}
void InsetNote::validate(LaTeXFeatures & features) const
{
if (params_.type == InsetNoteParams::Comment)
features.require("verbatim");
if (params_.type == InsetNoteParams::Greyedout) {
features.require("color");
features.require("lyxgreyedout");
}
if (params_.type == InsetNoteParams::Shaded) {
features.require("color");
features.require("framed");
}
if (params_.type == InsetNoteParams::Framed)
features.require("framed");
InsetText::validate(features);
}
string const InsetNoteMailer::name_("note");
InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
: inset_(inset)
{}
string const InsetNoteMailer::inset2string(Buffer const &) const
{
return params2string(inset_.params());
}
string const InsetNoteMailer::params2string(InsetNoteParams const & params)
{
ostringstream data;
data << name_ << ' ';
params.write(data);
return data.str();
}
void InsetNoteMailer::string2params(string const & in,
InsetNoteParams & params)
{
params = InsetNoteParams();
if (in.empty())
return;
istringstream data(in);
LyXLex lex(0,0);
lex.setStream(data);
string name;
lex >> name;
if (!lex || name != name_)
return print_mailer_error("InsetNoteMailer", in, 1, name_);
// This is part of the inset proper that is usually swallowed
// by LyXText::readInset
string id;
lex >> id;
if (!lex || id != "Note")
return print_mailer_error("InsetBoxMailer", in, 2, "Note");
params.read(lex);
}