]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetNote.cpp
Fix previews in yellow notes and disabled branches
[lyx.git] / src / insets / InsetNote.cpp
index acb9cb6b9141b479199ec7dc3a40badc8aed908a..b12b755fba9ed16e2a135c28a0286afb13720b81 100644 (file)
 #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 "InsetIterator.h"
+#include "InsetLayout.h"
 #include "LaTeXFeatures.h"
 #include "Lexer.h"
 #include "LyXRC.h"
-#include "OutputParams.h"
-#include "ParIterator.h"
-#include "TextClass.h"
-#include "TocBackend.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"
@@ -50,7 +48,6 @@ namespace lyx {
 namespace {
 
 typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
-typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
 
 NoteTranslator const init_notetranslator()
 {
@@ -63,12 +60,12 @@ NoteTranslator const init_notetranslator()
 
 NoteTranslator const & notetranslator()
 {
-       static NoteTranslator translator = init_notetranslator();
+       static NoteTranslator const translator = init_notetranslator();
        return translator;
 }
 
 
-} // anon
+} // namespace
 
 
 InsetNoteParams::InsetNoteParams()
@@ -99,7 +96,7 @@ void InsetNoteParams::read(Lexer & lex)
 /////////////////////////////////////////////////////////////////////
 
 InsetNote::InsetNote(Buffer * buf, string const & label)
-       : InsetCollapsable(buf)
+       : InsetCollapsible(buf)
 {
        params_.type = notetranslator().find(label);
 }
@@ -111,29 +108,23 @@ InsetNote::~InsetNote()
 }
 
 
-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);
+       InsetCollapsible::read(lex);
 }
 
 
@@ -149,21 +140,33 @@ void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 {
        switch (cmd.action()) {
 
-       case LFUN_INSET_MODIFY:
-               cur.recordUndoInset(ATOMIC_UNDO, this);
+       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_);
                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;
        }
 }
@@ -175,9 +178,6 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
        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);
@@ -190,54 +190,49 @@ bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
                return true;
 
        default:
-               return InsetCollapsable::getStatus(cur, cmd, flag);
+               return InsetCollapsible::getStatus(cur, cmd, flag);
        }
 }
 
 
-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 true;
 
-       return InsetCollapsable::isMacroScope();
+       return InsetCollapsible::isMacroScope();
 }
 
 
-int InsetNote::latex(otexstream & 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;
-       otexstream ots(ss);
-       ots.canBreakLine(os.canBreakLine());
-       InsetCollapsable::latex(ots, runparams);
-       docstring const str = ss.str();
-       os << str;
+       }
 
        // 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
@@ -250,66 +245,74 @@ int InsetNote::latex(otexstream & os, OutputParams const & runparams_in) const
        //  b
        //
        // Adding {} before ' b' fixes this.
-       // The {} will be automatically added, but only if needed, by
-       // telling otexstream to protect an immediately following space.
-       os.protectSpace(ots.protectSpace());
+       // 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);
 
        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).
 
-       int const n = InsetText::docbook(os, runparams);
-
-       if (params_.type == InsetNoteParams::Comment)
-               os << "\n</remark>\n";
+       InsetText::docbook(xs, runparams);
 
-       // Return how many newlines we issued.
-       //return int(count(str.begin(), str.end(), '\n'));
-       return n + 1 + 2;
+       if (params_.type == InsetNoteParams::Comment) {
+               xs << xml::CR();
+               xs << xml::EndTag("remark");
+               xs << xml::CR();
+       }
 }
 
 
-docstring InsetNote::xhtml(XHTMLStream & xs, OutputParams const & rp) const
+docstring InsetNote::xhtml(XMLStream & xs, OutputParams const & rp) const
 {
        if (params_.type == InsetNoteParams::Note)
                return docstring();
 
-       return InsetCollapsable::xhtml(xs, rp);
+       return InsetCollapsible::xhtml(xs, rp);
 }
 
 
@@ -317,22 +320,31 @@ void InsetNote::validate(LaTeXFeatures & features) const
 {
        switch (params_.type) {
        case InsetNoteParams::Comment:
-               features.require("verbatim");
+               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:
-               features.require("color");
-               features.require("lyxgreyedout");
-               InsetCollapsable::validate(features);
+               if (features.hasRTLLanguage())
+                       features.require("environ");
+               InsetCollapsible::validate(features);
                break;
        case InsetNoteParams::Note:
+               // Showing previews in this inset may require stuff
+               if (features.runparams().for_preview)
+                       InsetCollapsible::validate(features);
                break;
        }
 }
 
 
-docstring InsetNote::contextMenuName() const
+string InsetNote::contextMenuName() const
 {
-       return from_ascii("context-note");
+       return "context-note";
 }
 
 bool InsetNote::allowSpellCheck() const
@@ -340,6 +352,22 @@ bool InsetNote::allowSpellCheck() const
        return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
 }
 
+FontInfo InsetNote::getFont() const
+{
+       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;
+}
+
 
 string InsetNote::params2string(InsetNoteParams const & params)
 {