-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1998 The LyX Team.
+/**
+ * \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>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "insetnote.h"
-#include "gettext.h"
-#include "lyxfont.h"
-#include "language.h"
-#include "buffer.h"
+
#include "BufferView.h"
-#include "lyxtext.h"
-#include "insets/insettext.h"
-#include "support/LOstream.h"
-#include "support/lstrings.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>
+
+namespace lyx {
+
+using std::string;
+using std::auto_ptr;
+using std::istringstream;
using std::ostream;
+using std::ostringstream;
+
+
+namespace {
+
+typedef Translator<std::string, InsetNoteParams::Type> NoteTranslator;
+typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
+
+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;
+}
+
+
+NoteTranslatorLoc const init_notetranslator_loc()
+{
+ NoteTranslatorLoc translator(_("Note"), InsetNoteParams::Note);
+ translator.addPair(_("Comment"), InsetNoteParams::Comment);
+ translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
+ translator.addPair(_("Framed"), InsetNoteParams::Framed);
+ translator.addPair(_("Shaded"), InsetNoteParams::Shaded);
+ return translator;
+}
+
+
+NoteTranslator const & notetranslator()
+{
+ static NoteTranslator translator = init_notetranslator();
+ return translator;
+}
+
+
+NoteTranslatorLoc const & notetranslator_loc()
+{
+ static NoteTranslatorLoc 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(from_ascii("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()
+{
+ docstring const label = notetranslator_loc().find(params_.type);
+ setLabel(label);
+
LyXFont font(LyXFont::ALL_SANE);
font.decSize();
- font.setColor(LColor::note);
+ 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);
- setBackgroundColor(LColor::notebg);
- setLabel(_("note"));
- setInsetName("Note");
}
-InsetNote::InsetNote()
- : InsetCollapsable()
+bool InsetNote::showInsetDialog(BufferView * bv) const
{
- init();
+ InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
+ return true;
}
-InsetNote::InsetNote(InsetNote const & in, bool same_id)
- : InsetCollapsable(in, same_id)
+void InsetNote::doDispatch(LCursor & cur, FuncRequest & cmd)
{
- init();
+ switch (cmd.action) {
+
+ case LFUN_INSET_MODIFY:
+ InsetNoteMailer::string2params(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;
+ }
}
-Inset * InsetNote::clone(Buffer const &, bool same_id) const
+bool InsetNote::getStatus(LCursor & cur, FuncRequest const & cmd,
+ FuncStatus & flag) const
{
- return new InsetNote(*const_cast<InsetNote *>(this), same_id);
+ switch (cmd.action) {
+
+ case LFUN_INSET_MODIFY:
+ case LFUN_INSET_DIALOG_UPDATE:
+ flag.enabled(true);
+ return true;
+
+ default:
+ return InsetCollapsable::getStatus(cur, cmd, flag);
+ }
}
-// This constructor is used for reading old InsetInfo
-InsetNote::InsetNote(Buffer const * buf, string const & contents,
- bool collapsed)
- : InsetCollapsable(collapsed)
+int InsetNote::latex(Buffer const & buf, odocstream & os,
+ OutputParams const & runparams_in) const
{
- init();
+ if (params_.type == InsetNoteParams::Note)
+ return 0;
- Paragraph * par = inset.paragraph();
- LyXFont font(LyXFont::ALL_INHERIT, buf->params.language);
+ 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";
- // Since XForms doesn't support RTL, we can assume that old notes
- // in RTL documents are written in English.
- if (font.language()->RightToLeft())
- font.setLanguage(default_language);
+ odocstringstream ss;
+ ss << "%\n\\begin{" << from_ascii(type) << "}\n";
+ InsetText::latex(buf, ss, runparams);
+ ss << "\n\\end{" << from_ascii(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 << "{}";
- lyx::pos_type pos = 0;
- buf->insertStringAsLines(par, pos, font, strip(contents, '\n'));
+ docstring const str = ss.str();
+ os << str;
+ // Return how many newlines we issued.
+ return int(lyx::count(str.begin(), str.end(), '\n'));
}
-string const InsetNote::editMessage() const
+int InsetNote::docbook(Buffer const & buf, odocstream & os,
+ OutputParams const & runparams_in) const
{
- return _("Opened Note Inset");
+ if (params_.type == InsetNoteParams::Note)
+ return 0;
+
+ OutputParams runparams(runparams_in);
+ if (params_.type == InsetNoteParams::Comment) {
+ os << "<remark>\n";
+ runparams.inComment = true;
+ // Ignore files that are exported inside a comment
+ runparams.exportdata.reset(new ExportData);
+ }
+
+ int const n = InsetText::docbook(buf, os, runparams);
+
+ if (params_.type == InsetNoteParams::Comment)
+ os << "\n</remark>\n";
+
+ // Return how many newlines we issued.
+ //return int(count(str.begin(), str.end(), '\n'));
+ return n + 1 + 2;
}
-void InsetNote::write(Buffer const *buf, ostream & os) const
+int InsetNote::plaintext(Buffer const & buf, odocstream & os,
+ OutputParams const & runparams_in) const
{
- os << getInsetName() << "\n";
- InsetCollapsable::write(buf, os);
+ 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);
+}
+
+
+} // namespace lyx
projects / lyx.git / blobdiff