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 "InsetIterator.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/gettext.h"
39 #include "support/Translator.h"
41 #include "frontends/Application.h"
52 typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
53 typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
55 NoteTranslator const init_notetranslator()
57 NoteTranslator translator("Note", InsetNoteParams::Note);
58 translator.addPair("Comment", InsetNoteParams::Comment);
59 translator.addPair("Greyedout", InsetNoteParams::Greyedout);
64 NoteTranslatorLoc const init_notetranslator_loc()
66 NoteTranslatorLoc translator(_("Note[[InsetNote]]"), InsetNoteParams::Note);
67 translator.addPair(_("Comment"), InsetNoteParams::Comment);
68 translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
73 NoteTranslator const & notetranslator()
75 static NoteTranslator translator = init_notetranslator();
80 NoteTranslatorLoc const & notetranslator_loc()
82 static NoteTranslatorLoc translator = init_notetranslator_loc();
91 InsetNoteParams::InsetNoteParams()
96 void InsetNoteParams::write(ostream & os) const
98 string const label = notetranslator().find(type);
99 os << "Note " << label << "\n";
103 void InsetNoteParams::read(Lexer & lex)
108 type = notetranslator().find(label);
112 /////////////////////////////////////////////////////////////////////
116 /////////////////////////////////////////////////////////////////////
118 InsetNote::InsetNote(Buffer const & buf, string const & label)
119 : InsetCollapsable(buf)
121 params_.type = notetranslator().find(label);
125 InsetNote::~InsetNote()
127 hideDialogs("note", this);
131 docstring InsetNote::editMessage() const
133 return _("Opened Note Inset");
137 docstring InsetNote::name() const
139 return from_ascii("Note:" + notetranslator().find(params_.type));
143 Inset::DisplayType InsetNote::display() const
149 void InsetNote::write(ostream & os) const
152 InsetCollapsable::write(os);
156 void InsetNote::read(Lexer & lex)
159 InsetCollapsable::read(lex);
163 void InsetNote::setButtonLabel()
165 docstring const label = notetranslator_loc().find(params_.type);
170 bool InsetNote::showInsetDialog(BufferView * bv) const
172 bv->showDialog("note", params2string(params()),
173 const_cast<InsetNote *>(this));
178 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
180 switch (cmd.action) {
182 case LFUN_INSET_MODIFY:
183 string2params(to_utf8(cmd.argument()), params_);
184 // get a bp from cur:
185 setLayout(cur.buffer().params());
188 case LFUN_INSET_DIALOG_UPDATE:
189 cur.bv().updateDialog("note", params2string(params()));
193 InsetCollapsable::doDispatch(cur, cmd);
199 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
200 FuncStatus & flag) const
202 switch (cmd.action) {
204 case LFUN_INSET_MODIFY:
205 // disallow comment and greyed out in commands
206 flag.setEnabled(!cur.paragraph().layout().isCommand() ||
207 cmd.getArg(2) == "Note");
208 if (cmd.getArg(0) == "note") {
209 InsetNoteParams params;
210 string2params(to_utf8(cmd.argument()), params);
211 flag.setOnOff(params_.type == params.type);
215 case LFUN_INSET_DIALOG_UPDATE:
216 flag.setEnabled(true);
220 return InsetCollapsable::getStatus(cur, cmd, flag);
225 void InsetNote::addToToc(DocIterator const & cpit)
227 DocIterator pit = cpit;
228 pit.push_back(CursorSlice(*this));
230 Toc & toc = buffer().tocBackend().toc("note");
232 str = notetranslator_loc().find(params_.type) + from_ascii(": ")
234 toc.push_back(TocItem(pit, 0, str));
235 // Proceed with the rest of the inset.
236 InsetCollapsable::addToToc(cpit);
240 bool InsetNote::isMacroScope() const
242 // LyX note has no latex output
243 if (params_.type == InsetNoteParams::Note)
246 return InsetCollapsable::isMacroScope();
250 int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
252 if (params_.type == InsetNoteParams::Note)
255 OutputParams runparams(runparams_in);
256 if (params_.type == InsetNoteParams::Comment) {
257 runparams.inComment = true;
258 // Ignore files that are exported inside a comment
259 runparams.exportdata.reset(new ExportData);
263 InsetCollapsable::latex(ss, runparams);
264 // the space after the comment in 'a[comment] b' will be eaten by the
265 // comment environment since the space before b is ignored with the
266 // following latex output:
274 // Adding {} before ' b' fixes this.
275 if (params_.type == InsetNoteParams::Comment)
278 docstring const str = ss.str();
280 runparams_in.encoding = runparams.encoding;
281 // Return how many newlines we issued.
282 return int(count(str.begin(), str.end(), '\n'));
286 int InsetNote::plaintext(odocstream & os,
287 OutputParams const & runparams_in) const
289 if (params_.type == InsetNoteParams::Note)
292 OutputParams runparams(runparams_in);
293 if (params_.type == InsetNoteParams::Comment) {
294 runparams.inComment = true;
295 // Ignore files that are exported inside a comment
296 runparams.exportdata.reset(new ExportData);
298 os << '[' << buffer().B_("note") << ":\n";
299 InsetText::plaintext(os, runparams);
302 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
306 int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
308 if (params_.type == InsetNoteParams::Note)
311 OutputParams runparams(runparams_in);
312 if (params_.type == InsetNoteParams::Comment) {
314 runparams.inComment = true;
315 // Ignore files that are exported inside a comment
316 runparams.exportdata.reset(new ExportData);
319 int const n = InsetText::docbook(os, runparams);
321 if (params_.type == InsetNoteParams::Comment)
322 os << "\n</remark>\n";
324 // Return how many newlines we issued.
325 //return int(count(str.begin(), str.end(), '\n'));
330 void InsetNote::validate(LaTeXFeatures & features) const
332 if (params_.type == InsetNoteParams::Comment)
333 features.require("verbatim");
334 if (params_.type == InsetNoteParams::Greyedout) {
335 features.require("color");
336 features.require("lyxgreyedout");
338 InsetText::validate(features);
342 docstring InsetNote::contextMenu(BufferView const &, int, int) const
344 return from_ascii("context-note");
348 string InsetNote::params2string(InsetNoteParams const & params)
351 data << "note" << ' ';
357 void InsetNote::string2params(string const & in, InsetNoteParams & params)
359 params = InsetNoteParams();
364 istringstream data(in);
367 lex.setContext("InsetNote::string2params");
368 lex >> "note" >> "Note";
373 bool mutateNotes(Cursor & cur, string const & source, string const &target)
375 InsetNoteParams::Type typeSrc = notetranslator().find(source);
376 InsetNoteParams::Type typeTrt = notetranslator().find(target);
377 // syntax check of arguments
378 string sSrc = notetranslator().find(typeSrc);
379 string sTrt = notetranslator().find(typeTrt);
380 if ((sSrc != source) || (sTrt != target))
383 // did we found some conforming inset?
386 Inset & inset = cur.buffer().inset();
387 InsetIterator it = inset_iterator_begin(inset);
388 InsetIterator const end = inset_iterator_end(inset);
389 for (; it != end; ++it) {
390 if (it->lyxCode() == NOTE_CODE) {
391 InsetNote & ins = static_cast<InsetNote &>(*it);
392 if (ins.params().type == typeSrc) {
393 FuncRequest fr(LFUN_INSET_MODIFY, "note Note " + target);
394 ins.dispatch(cur, fr);