*
* \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 "Buffer.h"
#include "BufferParams.h"
#include "BufferView.h"
-#include "BufferParams.h"
-#include "Counters.h"
+#include "ColorSet.h"
#include "Cursor.h"
-#include "DispatchResult.h"
#include "Exporter.h"
+#include "FontInfo.h"
#include "FuncRequest.h"
#include "FuncStatus.h"
-#include "support/gettext.h"
+#include "InsetLayout.h"
#include "LaTeXFeatures.h"
#include "Lexer.h"
-#include "MetricsInfo.h"
-#include "OutputParams.h"
-#include "ParIterator.h"
-#include "TextClass.h"
-#include "TocBackend.h"
+#include "LyXRC.h"
+#include "output_docbook.h"
+#include "output_latex.h"
#include "support/debug.h"
#include "support/docstream.h"
+#include "support/gettext.h"
+#include "support/lstrings.h"
#include "support/Translator.h"
#include "frontends/Application.h"
namespace {
typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
-typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
NoteTranslator const init_notetranslator()
{
}
-NoteTranslatorLoc const init_notetranslator_loc()
-{
- NoteTranslatorLoc translator(_("Note[[InsetNote]]"), InsetNoteParams::Note);
- translator.addPair(_("Comment"), InsetNoteParams::Comment);
- translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
- return translator;
-}
-
-
NoteTranslator const & notetranslator()
{
- static NoteTranslator translator = init_notetranslator();
- return translator;
-}
-
-
-NoteTranslatorLoc const & notetranslator_loc()
-{
- static NoteTranslatorLoc translator = init_notetranslator_loc();
+ static NoteTranslator const translator = init_notetranslator();
return translator;
}
-} // anon
-
+} // namespace
InsetNoteParams::InsetNoteParams()
/////////////////////////////////////////////////////////////////////
//
-// InsetNode
+// InsetNote
//
/////////////////////////////////////////////////////////////////////
-InsetNote::InsetNote(Buffer const & buf, string const & label)
- : InsetCollapsable(buf)
+InsetNote::InsetNote(Buffer * buf, string const & label)
+ : InsetCollapsible(buf)
{
params_.type = notetranslator().find(label);
}
}
-docstring InsetNote::editMessage() const
-{
- return _("Opened Note Inset");
-}
-
-
-docstring InsetNote::name() const
+docstring InsetNote::layoutName() const
{
return from_ascii("Note:" + notetranslator().find(params_.type));
}
-Inset::DisplayType InsetNote::display() const
-{
- return Inline;
-}
-
-
void InsetNote::write(ostream & os) const
{
params_.write(os);
- InsetCollapsable::write(os);
+ InsetCollapsible::write(os);
}
void InsetNote::read(Lexer & lex)
{
params_.read(lex);
- InsetCollapsable::read(lex);
-}
-
-
-void InsetNote::setButtonLabel()
-{
- docstring const label = notetranslator_loc().find(params_.type);
- setLabel(label);
+ InsetCollapsible::read(lex);
}
void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
{
- switch (cmd.action) {
-
- case LFUN_INSET_MODIFY:
+ switch (cmd.action()) {
+
+ case LFUN_INSET_MODIFY: {
+ // Do not do anything if converting to the same type of Note.
+ // A quick break here is done instead of disabling the LFUN
+ // because disabling the LFUN would lead to a greyed out
+ // entry, which might confuse users.
+ // In the future, we might want to have a radio button for
+ // switching between notes.
+ InsetNoteParams params;
+ string2params(to_utf8(cmd.argument()), params);
+ if (params_.type == params.type)
+ break;
+
+ cur.recordUndoInset(this);
string2params(to_utf8(cmd.argument()), params_);
- // get a bp from cur:
- setLayout(cur.buffer().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:
cur.bv().updateDialog("note", params2string(params()));
break;
default:
- InsetCollapsable::doDispatch(cur, cmd);
+ InsetCollapsible::doDispatch(cur, cmd);
break;
}
}
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.enabled(!cur.paragraph().layout().isCommand() ||
- cmd.getArg(2) == "Note");
if (cmd.getArg(0) == "note") {
InsetNoteParams params;
string2params(to_utf8(cmd.argument()), params);
return true;
case LFUN_INSET_DIALOG_UPDATE:
- flag.enabled(true);
+ flag.setEnabled(true);
return true;
default:
- return InsetCollapsable::getStatus(cur, cmd, flag);
+ return InsetCollapsible::getStatus(cur, cmd, flag);
}
}
-void InsetNote::updateLabels(ParIterator const & it)
-{
- DocumentClass const & tclass = buffer().params().documentClass();
- Counters savecnt = tclass.counters();
- InsetCollapsable::updateLabels(it);
- tclass.counters() = savecnt;
-}
-
-
-void InsetNote::addToToc(ParConstIterator const & cpit) const
-{
- ParConstIterator pit = cpit;
- pit.push_back(*this);
-
- Toc & toc = buffer().tocBackend().toc("note");
- docstring str;
- str = notetranslator_loc().find(params_.type) + from_ascii(": ")
- + getNewLabel(str);
- toc.push_back(TocItem(pit, 0, str));
-}
-
-
bool InsetNote::isMacroScope() const
{
// LyX note has no latex output
if (params_.type == InsetNoteParams::Note)
return true;
- return InsetCollapsable::isMacroScope();
+ return InsetCollapsible::isMacroScope();
}
-int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
+void InsetNote::latex(otexstream & os, OutputParams const & runparams_in) const
{
- if (params_.type == InsetNoteParams::Note)
- return 0;
+ if (params_.type != InsetNoteParams::Greyedout
+ && runparams_in.find_effective()
+ && !runparams_in.find_with_non_output())
+ return;
+
+ if (params_.type == InsetNoteParams::Note) {
+ if (runparams_in.find_with_non_output()) {
+ OutputParams runparams(runparams_in);
+ InsetCollapsible::latex(os, runparams);
+ runparams_in.encoding = runparams.encoding;
+ }
+ return;
+ }
OutputParams runparams(runparams_in);
if (params_.type == InsetNoteParams::Comment) {
+ if (runparams_in.inComment) {
+ // Nested comments should just output the contents.
+ latexParagraphs(buffer(), text(), os, runparams);
+ return;
+ }
+
runparams.inComment = true;
// Ignore files that are exported inside a comment
runparams.exportdata.reset(new ExportData);
- }
+ }
- odocstringstream ss;
- InsetCollapsable::latex(ss, runparams);
// 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.
+ InsetCollapsible::latex(os, runparams);
- docstring const str = ss.str();
- os << str;
runparams_in.encoding = runparams.encoding;
- // Return how many newlines we issued.
- return int(count(str.begin(), str.end(), '\n'));
}
-int InsetNote::plaintext(odocstream & os,
- OutputParams const & runparams_in) const
+int InsetNote::plaintext(odocstringstream & os,
+ OutputParams const & runparams_in, size_t max_length) const
{
- if (params_.type == InsetNoteParams::Note)
- return 0;
+ if (!runparams_in.find_with_non_output()) {
+ if (params_.type == InsetNoteParams::Note)
+ return 0;
+ else if (params_.type == InsetNoteParams::Comment
+ && runparams_in.find_effective())
+ return 0;
+ }
OutputParams runparams(runparams_in);
- if (params_.type == InsetNoteParams::Comment) {
+ if (params_.type != InsetNoteParams::Greyedout) {
runparams.inComment = true;
// Ignore files that are exported inside a comment
runparams.exportdata.reset(new ExportData);
}
- os << '[' << buffer().B_("note") << ":\n";
- InsetText::plaintext(os, runparams);
- os << "\n]";
+ if (!runparams_in.find_with_non_output())
+ os << '[' << buffer().B_("note") << ":\n";
+ InsetText::plaintext(os, runparams, max_length);
+ if (!runparams_in.find_with_non_output())
+ os << "\n]";
return PLAINTEXT_NEWLINE + 1; // one char on a separate line
}
-int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
+void InsetNote::docbook(XMLStream & xs, OutputParams const & runparams_in) const
{
if (params_.type == InsetNoteParams::Note)
- return 0;
+ return;
OutputParams runparams(runparams_in);
if (params_.type == InsetNoteParams::Comment) {
- os << "<remark>\n";
+ xs << xml::StartTag("remark");
+ xs << xml::CR();
runparams.inComment = true;
// Ignore files that are exported inside a comment
runparams.exportdata.reset(new ExportData);
}
+ // Greyed out text is output as such (no way to mark text as greyed out with DocBook).
+
+ InsetText::docbook(xs, runparams);
+
+ if (params_.type == InsetNoteParams::Comment) {
+ xs << xml::CR();
+ xs << xml::EndTag("remark");
+ xs << xml::CR();
+ }
+}
- int const n = InsetText::docbook(os, runparams);
- if (params_.type == InsetNoteParams::Comment)
- os << "\n</remark>\n";
+docstring InsetNote::xhtml(XMLStream & xs, OutputParams const & rp) const
+{
+ if (params_.type == InsetNoteParams::Note)
+ return docstring();
- // Return how many newlines we issued.
- //return int(count(str.begin(), str.end(), '\n'));
- return n + 1 + 2;
+ return InsetCollapsible::xhtml(xs, rp);
}
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");
+ switch (params_.type) {
+ case InsetNoteParams::Comment:
+ if (features.runparams().flavor == Flavor::Html)
+ // we do output this but set display to "none" by default,
+ // but people might want to use it.
+ InsetCollapsible::validate(features);
+ else
+ // Only do the requires
+ features.useInsetLayout(getLayout());
+ break;
+ case InsetNoteParams::Greyedout:
+ if (features.hasRTLLanguage())
+ features.require("environ");
+ InsetCollapsible::validate(features);
+ break;
+ case InsetNoteParams::Note:
+ break;
}
- InsetText::validate(features);
}
-docstring InsetNote::contextMenu(BufferView const &, int, int) const
+string InsetNote::contextMenuName() const
+{
+ return "context-note";
+}
+
+bool InsetNote::allowSpellCheck() const
+{
+ return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
+}
+
+FontInfo InsetNote::getFont() const
{
- return from_ascii("context-note");
+ FontInfo font = getLayout().font();
+ if (params_.type == InsetNoteParams::Greyedout
+ && buffer().params().isnotefontcolor) {
+ ColorCode c = lcolor.getFromLyXName("notefontcolor");
+ if (c != Color_none)
+ font.setColor(c);
+ // This is the local color (not overridden by other documents)
+ ColorCode lc = lcolor.getFromLyXName("notefontcolor@" + buffer().fileName().absFileName());
+ if (lc != Color_none)
+ font.setPaintColor(lc);
+ }
+ return font;
}
istringstream data(in);
Lexer lex;
lex.setStream(data);
-
- string name;
- lex >> name;
- if (!lex || name != "note") {
- LYXERR0("Expected arg 1 to be \"note\" in " << in);
+ 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;
- }
-
- // This is part of the inset proper that is usually swallowed
- // by Text::readInset
- string id;
- lex >> id;
- if (!lex || id != "Note") {
- LYXERR0("Expected arg 1 to be \"Note\" in " << in);
- return;
- }
+ lex >> "Note";
params.read(lex);
}
projects / lyx.git / blobdiff