*
* \author Angus Leeming
* \author Martin Vermeer
- * \author Jürgen Spitzmüller
+ * \author Jürgen Spitzmüller
*
* Full author contact details are available in file CREDITS.
*/
#include "InsetNote.h"
+#include "Buffer.h"
+#include "BufferParams.h"
#include "BufferView.h"
-#include "LCursor.h"
-#include "debug.h"
+#include "BufferParams.h"
+#include "Counters.h"
+#include "Cursor.h"
#include "DispatchResult.h"
#include "Exporter.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
-#include "gettext.h"
+#include "InsetIterator.h"
#include "LaTeXFeatures.h"
-#include "LColor.h"
-#include "LyXLex.h"
-#include "MetricsInfo.h"
+#include "Lexer.h"
+#include "LyXRC.h"
#include "OutputParams.h"
-#include "Paragraph.h"
+#include "ParIterator.h"
+#include "TextClass.h"
+#include "TocBackend.h"
-#include "support/lyxalgo.h"
+#include "support/debug.h"
+#include "support/docstream.h"
+#include "support/gettext.h"
#include "support/Translator.h"
+#include "frontends/Application.h"
+
+#include <algorithm>
#include <sstream>
+using namespace std;
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;
+typedef Translator<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;
-}
-
-
-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;
}
}
-NoteTranslatorLoc const & notetranslator_loc()
-{
- static NoteTranslatorLoc translator = init_notetranslator_loc();
- return translator;
-}
-
} // anon
-
-
InsetNoteParams::InsetNoteParams()
: type(Note)
{}
}
-void InsetNoteParams::read(LyXLex & lex)
+void InsetNoteParams::read(Lexer & lex)
{
string label;
lex >> label;
}
-void InsetNote::init()
-{
- setInsetName(from_ascii("Note"));
- setButtonLabel();
-}
-
+/////////////////////////////////////////////////////////////////////
+//
+// InsetNote
+//
+/////////////////////////////////////////////////////////////////////
-InsetNote::InsetNote(BufferParams const & bp, string const & label)
- : InsetCollapsable(bp)
+InsetNote::InsetNote(Buffer * buf, string const & label)
+ : InsetCollapsable(buf)
{
params_.type = notetranslator().find(label);
- init();
-}
-
-
-InsetNote::InsetNote(InsetNote const & in)
- : InsetCollapsable(in), params_(in.params_)
-{
- init();
}
InsetNote::~InsetNote()
{
- InsetNoteMailer(*this).hideDialog();
+ hideDialogs("note", this);
}
-auto_ptr<InsetBase> InsetNote::doClone() const
+docstring InsetNote::layoutName() const
{
- return auto_ptr<InsetBase>(new InsetNote(*this));
+ return from_ascii("Note:" + notetranslator().find(params_.type));
}
-docstring const InsetNote::editMessage() const
+Inset::DisplayType InsetNote::display() const
{
- return _("Opened Note Inset");
+ return Inline;
}
-void InsetNote::write(Buffer const & buf, ostream & os) const
+void InsetNote::write(ostream & os) const
{
params_.write(os);
- InsetCollapsable::write(buf, os);
+ InsetCollapsable::write(os);
}
-void InsetNote::read(Buffer const & buf, LyXLex & lex)
+void InsetNote::read(Lexer & 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.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);
+ InsetCollapsable::read(lex);
}
bool InsetNote::showInsetDialog(BufferView * bv) const
{
- InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
+ bv->showDialog("note", params2string(params()),
+ const_cast<InsetNote *>(this));
return true;
}
-void InsetNote::doDispatch(LCursor & cur, FuncRequest & cmd)
+void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- switch (cmd.action) {
+ switch (cmd.action()) {
case LFUN_INSET_MODIFY:
- InsetNoteMailer::string2params(to_utf8(cmd.argument()), params_);
+ cur.recordUndoInset(ATOMIC_UNDO, this);
+ string2params(to_utf8(cmd.argument()), params_);
setButtonLabel();
+ // what we really want here is a TOC update, but that means
+ // a full buffer update
+ cur.forceBufferUpdate();
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);
+ cur.bv().updateDialog("note", params2string(params()));
break;
default:
}
-bool InsetNote::getStatus(LCursor & cur, FuncRequest const & cmd,
+bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
FuncStatus & flag) const
{
- switch (cmd.action) {
+ switch (cmd.action()) {
case LFUN_INSET_MODIFY:
+ // disallow comment and greyed out in commands
+ flag.setEnabled(!cur.paragraph().layout().isCommand() ||
+ cmd.getArg(2) == "Note");
+ if (cmd.getArg(0) == "note") {
+ InsetNoteParams params;
+ string2params(to_utf8(cmd.argument()), params);
+ flag.setOnOff(params_.type == params.type);
+ }
+ return true;
+
case LFUN_INSET_DIALOG_UPDATE:
- flag.enabled(true);
+ flag.setEnabled(true);
return true;
default:
}
-int InsetNote::latex(Buffer const & buf, odocstream & os,
- OutputParams const & runparams_in) const
+void InsetNote::addToToc(DocIterator const & cpit) const
{
+ DocIterator pit = cpit;
+ pit.push_back(CursorSlice(const_cast<InsetNote &>(*this)));
+
+ Toc & toc = buffer().tocBackend().toc("note");
+ InsetLayout const & il = getLayout();
+ docstring str = translateIfPossible(il.labelstring()) + from_ascii(": ");
+ text().forToc(str, TOC_ENTRY_LENGTH);
+ toc.push_back(TocItem(pit, 0, str, toolTipText(docstring(), 3, 60)));
+ // Proceed with the rest of the inset.
+ InsetCollapsable::addToToc(cpit);
+}
+
+
+bool InsetNote::isMacroScope() const
+{
+ // LyX note has no latex output
if (params_.type == InsetNoteParams::Note)
- return 0;
+ return true;
+
+ return InsetCollapsable::isMacroScope();
+}
+
+
+void InsetNote::latex(otexstream & os, OutputParams const & runparams_in) const
+{
+ if (params_.type == InsetNoteParams::Note)
+ return;
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";
-
- 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:
// b
//
// Adding {} before ' b' fixes this.
- if (params_.type == InsetNoteParams::Comment)
- ss << "{}";
+ // The {} will be automatically added, but only if needed, for all
+ // insets whose InsetLayout Display tag is false. This is achieved
+ // by telling otexstream to protect an immediately following space
+ // and is done for both comment and greyedout insets.
+ InsetCollapsable::latex(os, runparams);
- docstring const str = ss.str();
- os << str;
runparams_in.encoding = runparams.encoding;
- // Return how many newlines we issued.
- return int(lyx::count(str.begin(), str.end(), '\n'));
}
-int InsetNote::plaintext(Buffer const & buf, odocstream & os,
- OutputParams const & runparams_in) const
+int InsetNote::plaintext(odocstream & os,
+ OutputParams const & runparams_in) const
{
if (params_.type == InsetNoteParams::Note)
return 0;
// Ignore files that are exported inside a comment
runparams.exportdata.reset(new ExportData);
}
- os << '[' << _("note") << ":\n";
- InsetText::plaintext(buf, os, runparams);
+ os << '[' << buffer().B_("note") << ":\n";
+ InsetText::plaintext(os, runparams);
os << "\n]";
return PLAINTEXT_NEWLINE + 1; // one char on a separate line
}
-int InsetNote::docbook(Buffer const & buf, odocstream & os,
- OutputParams const & runparams_in) const
+int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
{
if (params_.type == InsetNoteParams::Note)
return 0;
runparams.exportdata.reset(new ExportData);
}
- int const n = InsetText::docbook(buf, os, runparams);
+ int const n = InsetText::docbook(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;
+ return n + 1 + 2;
+}
+
+
+docstring InsetNote::xhtml(XHTMLStream & xs, OutputParams const & rp) const
+{
+ if (params_.type == InsetNoteParams::Note)
+ return docstring();
+
+ return InsetCollapsable::xhtml(xs, rp);
}
void InsetNote::validate(LaTeXFeatures & features) const
{
- if (params_.type == InsetNoteParams::Comment)
+ switch (params_.type) {
+ case InsetNoteParams::Comment:
features.require("verbatim");
- if (params_.type == InsetNoteParams::Greyedout) {
+ if (features.runparams().flavor == OutputParams::HTML)
+ // we do output this but set display to "none" by default,
+ // but people might want to use it.
+ InsetCollapsable::validate(features);
+ break;
+ case InsetNoteParams::Greyedout:
features.require("color");
features.require("lyxgreyedout");
+ InsetCollapsable::validate(features);
+ break;
+ case InsetNoteParams::Note:
+ break;
}
- if (params_.type == InsetNoteParams::Shaded) {
- features.require("color");
- features.require("framed");
- }
- if (params_.type == InsetNoteParams::Framed)
- features.require("framed");
- InsetText::validate(features);
}
+string InsetNote::contextMenuName() const
+{
+ return "context-note";
+}
-string const InsetNoteMailer::name_("note");
-
-InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
- : inset_(inset)
-{}
-
-
-string const InsetNoteMailer::inset2string(Buffer const &) const
+bool InsetNote::allowSpellCheck() const
{
- return params2string(inset_.params());
+ return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
}
-string const InsetNoteMailer::params2string(InsetNoteParams const & params)
+string InsetNote::params2string(InsetNoteParams const & params)
{
ostringstream data;
- data << name_ << ' ';
+ data << "note" << ' ';
params.write(data);
return data.str();
}
-void InsetNoteMailer::string2params(string const & in,
- InsetNoteParams & params)
+void InsetNote::string2params(string const & in, InsetNoteParams & params)
{
params = InsetNoteParams();
return;
istringstream data(in);
- LyXLex lex(0,0);
+ Lexer lex;
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");
+ lex.setContext("InsetNote::string2params");
+ lex >> "note";
+ // There are cases, such as when we are called via getStatus() from
+ // Dialog::canApply(), where we are just called with "note" rather
+ // than a full "note Note TYPE".
+ if (!lex.isOK())
+ return;
+ lex >> "Note";
params.read(lex);
}
projects / lyx.git / blobdiff