3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
7 * \author Martin Vermeer
8 * \author Jürgen Spitzmüller
10 * Full author contact details are available in file CREDITS.
15 #include "InsetNote.h"
18 #include "BufferParams.h"
19 #include "BufferView.h"
20 #include "BufferParams.h"
23 #include "DispatchResult.h"
25 #include "FuncRequest.h"
26 #include "FuncStatus.h"
27 #include "support/gettext.h"
28 #include "LaTeXFeatures.h"
30 #include "MetricsInfo.h"
31 #include "OutputParams.h"
32 #include "ParIterator.h"
33 #include "TextClass.h"
34 #include "TocBackend.h"
36 #include "support/debug.h"
37 #include "support/docstream.h"
38 #include "support/Translator.h"
40 #include "frontends/Application.h"
51 typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
52 typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
54 NoteTranslator const init_notetranslator()
56 NoteTranslator translator("Note", InsetNoteParams::Note);
57 translator.addPair("Comment", InsetNoteParams::Comment);
58 translator.addPair("Greyedout", InsetNoteParams::Greyedout);
63 NoteTranslatorLoc const init_notetranslator_loc()
65 NoteTranslatorLoc translator(_("Note[[InsetNote]]"), InsetNoteParams::Note);
66 translator.addPair(_("Comment"), InsetNoteParams::Comment);
67 translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
72 NoteTranslator const & notetranslator()
74 static NoteTranslator translator = init_notetranslator();
79 NoteTranslatorLoc const & notetranslator_loc()
81 static NoteTranslatorLoc translator = init_notetranslator_loc();
90 InsetNoteParams::InsetNoteParams()
95 void InsetNoteParams::write(ostream & os) const
97 string const label = notetranslator().find(type);
98 os << "Note " << label << "\n";
102 void InsetNoteParams::read(Lexer & lex)
107 type = notetranslator().find(label);
111 /////////////////////////////////////////////////////////////////////
115 /////////////////////////////////////////////////////////////////////
117 InsetNote::InsetNote(Buffer const & buf, string const & label)
118 : InsetCollapsable(buf)
120 params_.type = notetranslator().find(label);
124 InsetNote::~InsetNote()
126 hideDialogs("note", this);
130 docstring InsetNote::editMessage() const
132 return _("Opened Note Inset");
136 docstring InsetNote::name() const
138 return from_ascii("Note:" + notetranslator().find(params_.type));
142 Inset::DisplayType InsetNote::display() const
148 void InsetNote::write(ostream & os) const
151 InsetCollapsable::write(os);
155 void InsetNote::read(Lexer & lex)
158 InsetCollapsable::read(lex);
162 void InsetNote::setButtonLabel()
164 docstring const label = notetranslator_loc().find(params_.type);
169 bool InsetNote::showInsetDialog(BufferView * bv) const
171 bv->showDialog("note", params2string(params()),
172 const_cast<InsetNote *>(this));
177 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
179 switch (cmd.action) {
181 case LFUN_INSET_MODIFY:
182 string2params(to_utf8(cmd.argument()), params_);
183 // get a bp from cur:
184 setLayout(cur.buffer().params());
187 case LFUN_INSET_DIALOG_UPDATE:
188 cur.bv().updateDialog("note", params2string(params()));
192 InsetCollapsable::doDispatch(cur, cmd);
198 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
199 FuncStatus & flag) const
201 switch (cmd.action) {
203 case LFUN_INSET_MODIFY:
204 // disallow comment and greyed out in commands
205 flag.enabled(!cur.paragraph().layout().isCommand() ||
206 cmd.getArg(2) == "Note");
207 if (cmd.getArg(0) == "note") {
208 InsetNoteParams params;
209 string2params(to_utf8(cmd.argument()), params);
210 flag.setOnOff(params_.type == params.type);
214 case LFUN_INSET_DIALOG_UPDATE:
219 return InsetCollapsable::getStatus(cur, cmd, flag);
224 void InsetNote::updateLabels(ParIterator const & it)
226 DocumentClass const & tclass = buffer().params().documentClass();
227 Counters savecnt = tclass.counters();
228 InsetCollapsable::updateLabels(it);
229 tclass.counters() = savecnt;
233 void InsetNote::addToToc(ParConstIterator const & cpit) const
235 ParConstIterator pit = cpit;
236 pit.push_back(*this);
238 Toc & toc = buffer().tocBackend().toc("note");
240 str = notetranslator_loc().find(params_.type) + from_ascii(": ")
242 toc.push_back(TocItem(pit, 0, str));
246 bool InsetNote::isMacroScope() const
248 // LyX note has no latex output
249 if (params_.type == InsetNoteParams::Note)
252 return InsetCollapsable::isMacroScope();
256 int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
258 if (params_.type == InsetNoteParams::Note)
261 OutputParams runparams(runparams_in);
262 if (params_.type == InsetNoteParams::Comment) {
263 runparams.inComment = true;
264 // Ignore files that are exported inside a comment
265 runparams.exportdata.reset(new ExportData);
269 InsetCollapsable::latex(ss, runparams);
270 // the space after the comment in 'a[comment] b' will be eaten by the
271 // comment environment since the space before b is ignored with the
272 // following latex output:
280 // Adding {} before ' b' fixes this.
281 if (params_.type == InsetNoteParams::Comment)
284 docstring const str = ss.str();
286 runparams_in.encoding = runparams.encoding;
287 // Return how many newlines we issued.
288 return int(count(str.begin(), str.end(), '\n'));
292 int InsetNote::plaintext(odocstream & os,
293 OutputParams const & runparams_in) const
295 if (params_.type == InsetNoteParams::Note)
298 OutputParams runparams(runparams_in);
299 if (params_.type == InsetNoteParams::Comment) {
300 runparams.inComment = true;
301 // Ignore files that are exported inside a comment
302 runparams.exportdata.reset(new ExportData);
304 os << '[' << buffer().B_("note") << ":\n";
305 InsetText::plaintext(os, runparams);
308 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
312 int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
314 if (params_.type == InsetNoteParams::Note)
317 OutputParams runparams(runparams_in);
318 if (params_.type == InsetNoteParams::Comment) {
320 runparams.inComment = true;
321 // Ignore files that are exported inside a comment
322 runparams.exportdata.reset(new ExportData);
325 int const n = InsetText::docbook(os, runparams);
327 if (params_.type == InsetNoteParams::Comment)
328 os << "\n</remark>\n";
330 // Return how many newlines we issued.
331 //return int(count(str.begin(), str.end(), '\n'));
336 void InsetNote::validate(LaTeXFeatures & features) const
338 if (params_.type == InsetNoteParams::Comment)
339 features.require("verbatim");
340 if (params_.type == InsetNoteParams::Greyedout) {
341 features.require("color");
342 features.require("lyxgreyedout");
344 InsetText::validate(features);
348 docstring InsetNote::contextMenu(BufferView const &, int, int) const
350 return from_ascii("context-note");
354 string InsetNote::params2string(InsetNoteParams const & params)
357 data << "note" << ' ';
363 void InsetNote::string2params(string const & in, InsetNoteParams & params)
365 params = InsetNoteParams();
370 istringstream data(in);
376 if (!lex || name != "note") {
377 LYXERR0("Expected arg 1 to be \"note\" in " << in);
381 // This is part of the inset proper that is usually swallowed
382 // by Text::readInset
385 if (!lex || id != "Note") {
386 LYXERR0("Expected arg 1 to be \"Note\" in " << in);