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 * buf, string const & label)
119 : InsetCollapsable(buf)
121 params_.type = notetranslator().find(label);
125 InsetNote::~InsetNote()
127 hideDialogs("note", this);
131 docstring InsetNote::name() const
133 return from_ascii("Note:" + notetranslator().find(params_.type));
137 Inset::DisplayType InsetNote::display() const
143 void InsetNote::write(ostream & os) const
146 InsetCollapsable::write(os);
150 void InsetNote::read(Lexer & lex)
153 InsetCollapsable::read(lex);
157 void InsetNote::setButtonLabel()
159 docstring const label = notetranslator_loc().find(params_.type);
164 bool InsetNote::showInsetDialog(BufferView * bv) const
166 bv->showDialog("note", params2string(params()),
167 const_cast<InsetNote *>(this));
172 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
174 switch (cmd.action) {
176 case LFUN_INSET_MODIFY:
177 string2params(to_utf8(cmd.argument()), params_);
181 case LFUN_INSET_DIALOG_UPDATE:
182 cur.bv().updateDialog("note", params2string(params()));
186 InsetCollapsable::doDispatch(cur, cmd);
192 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
193 FuncStatus & flag) const
195 switch (cmd.action) {
197 case LFUN_INSET_MODIFY:
198 // disallow comment and greyed out in commands
199 flag.setEnabled(!cur.paragraph().layout().isCommand() ||
200 cmd.getArg(2) == "Note");
201 if (cmd.getArg(0) == "note") {
202 InsetNoteParams params;
203 string2params(to_utf8(cmd.argument()), params);
204 flag.setOnOff(params_.type == params.type);
208 case LFUN_INSET_DIALOG_UPDATE:
209 flag.setEnabled(true);
213 return InsetCollapsable::getStatus(cur, cmd, flag);
218 void InsetNote::addToToc(DocIterator const & cpit)
220 DocIterator pit = cpit;
221 pit.push_back(CursorSlice(*this));
223 Toc & toc = buffer().tocBackend().toc("note");
225 str = notetranslator_loc().find(params_.type) + from_ascii(": ")
227 toc.push_back(TocItem(pit, 0, str));
228 // Proceed with the rest of the inset.
229 InsetCollapsable::addToToc(cpit);
233 bool InsetNote::isMacroScope() const
235 // LyX note has no latex output
236 if (params_.type == InsetNoteParams::Note)
239 return InsetCollapsable::isMacroScope();
243 int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
245 if (params_.type == InsetNoteParams::Note)
248 OutputParams runparams(runparams_in);
249 if (params_.type == InsetNoteParams::Comment) {
250 runparams.inComment = true;
251 // Ignore files that are exported inside a comment
252 runparams.exportdata.reset(new ExportData);
256 InsetCollapsable::latex(ss, runparams);
257 // the space after the comment in 'a[comment] b' will be eaten by the
258 // comment environment since the space before b is ignored with the
259 // following latex output:
267 // Adding {} before ' b' fixes this.
268 if (params_.type == InsetNoteParams::Comment)
271 docstring const str = ss.str();
273 runparams_in.encoding = runparams.encoding;
274 // Return how many newlines we issued.
275 return int(count(str.begin(), str.end(), '\n'));
279 int InsetNote::plaintext(odocstream & os,
280 OutputParams const & runparams_in) const
282 if (params_.type == InsetNoteParams::Note)
285 OutputParams runparams(runparams_in);
286 if (params_.type == InsetNoteParams::Comment) {
287 runparams.inComment = true;
288 // Ignore files that are exported inside a comment
289 runparams.exportdata.reset(new ExportData);
291 os << '[' << buffer().B_("note") << ":\n";
292 InsetText::plaintext(os, runparams);
295 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
299 int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
301 if (params_.type == InsetNoteParams::Note)
304 OutputParams runparams(runparams_in);
305 if (params_.type == InsetNoteParams::Comment) {
307 runparams.inComment = true;
308 // Ignore files that are exported inside a comment
309 runparams.exportdata.reset(new ExportData);
312 int const n = InsetText::docbook(os, runparams);
314 if (params_.type == InsetNoteParams::Comment)
315 os << "\n</remark>\n";
317 // Return how many newlines we issued.
318 //return int(count(str.begin(), str.end(), '\n'));
323 docstring InsetNote::xhtml(XHTMLStream & xs, OutputParams const & rp) const
325 if (params_.type == InsetNoteParams::Note)
328 return InsetCollapsable::xhtml(xs, rp);
332 void InsetNote::validate(LaTeXFeatures & features) const
334 switch (params_.type) {
335 case InsetNoteParams::Comment:
336 features.require("verbatim");
338 case InsetNoteParams::Greyedout:
339 features.require("color");
340 features.require("lyxgreyedout");
341 InsetCollapsable::validate(features);
343 case InsetNoteParams::Note:
349 docstring InsetNote::contextMenu(BufferView const &, int, int) const
351 return from_ascii("context-note");
355 string InsetNote::params2string(InsetNoteParams const & params)
358 data << "note" << ' ';
364 void InsetNote::string2params(string const & in, InsetNoteParams & params)
366 params = InsetNoteParams();
371 istringstream data(in);
374 lex.setContext("InsetNote::string2params");
376 // There are cases, such as when we are called via getStatus() from
377 // Dialog::canApply(), where we are just called with "note" rather
378 // than a full "note Note TYPE".
387 bool mutateNotes(Cursor & cur, string const & source, string const & target)
389 InsetNoteParams::Type typeSrc = notetranslator().find(source);
390 InsetNoteParams::Type typeTrt = notetranslator().find(target);
391 // syntax check of arguments
392 string src = notetranslator().find(typeSrc);
393 string trt = notetranslator().find(typeTrt);
394 if (src != source || trt != target)
397 // did we found some conforming inset?
400 cur.beginUndoGroup();
401 Inset & inset = cur.buffer()->inset();
402 InsetIterator it = inset_iterator_begin(inset);
403 InsetIterator const end = inset_iterator_end(inset);
404 for (; it != end; ++it) {
405 if (it->lyxCode() == NOTE_CODE) {
406 InsetNote & ins = static_cast<InsetNote &>(*it);
407 if (ins.params().type == typeSrc) {
408 cur.buffer()->undo().recordUndo(it);
409 FuncRequest fr(LFUN_INSET_MODIFY, "note Note " + target);
410 ins.dispatch(cur, fr);