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"
49 typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
50 typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
52 NoteTranslator const init_notetranslator()
54 NoteTranslator translator("Note", InsetNoteParams::Note);
55 translator.addPair("Comment", InsetNoteParams::Comment);
56 translator.addPair("Greyedout", InsetNoteParams::Greyedout);
61 NoteTranslatorLoc const init_notetranslator_loc()
63 NoteTranslatorLoc translator(_("Note[[InsetNote]]"), InsetNoteParams::Note);
64 translator.addPair(_("Comment"), InsetNoteParams::Comment);
65 translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
70 NoteTranslator const & notetranslator()
72 static NoteTranslator translator = init_notetranslator();
77 NoteTranslatorLoc const & notetranslator_loc()
79 static NoteTranslatorLoc translator = init_notetranslator_loc();
88 InsetNoteParams::InsetNoteParams()
93 void InsetNoteParams::write(ostream & os) const
95 string const label = notetranslator().find(type);
96 os << "Note " << label << "\n";
100 void InsetNoteParams::read(Lexer & lex)
105 type = notetranslator().find(label);
109 InsetNote::InsetNote(BufferParams const & bp, string const & label)
110 : InsetCollapsable(bp)
112 params_.type = notetranslator().find(label);
116 InsetNote::InsetNote(InsetNote const & in)
117 : InsetCollapsable(in), params_(in.params_)
121 InsetNote::~InsetNote()
123 InsetNoteMailer(*this).hideDialog();
127 Inset * InsetNote::clone() const
129 return new InsetNote(*this);
133 docstring InsetNote::editMessage() const
135 return _("Opened Note Inset");
139 docstring InsetNote::name() const
141 return from_ascii("Note:" + notetranslator().find(params_.type));
145 Inset::DisplayType InsetNote::display() const
151 void InsetNote::write(ostream & os) const
154 InsetCollapsable::write(os);
158 void InsetNote::read(Lexer & lex)
161 InsetCollapsable::read(lex);
165 void InsetNote::setButtonLabel()
167 docstring const label = notetranslator_loc().find(params_.type);
172 bool InsetNote::showInsetDialog(BufferView * bv) const
174 InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
179 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
181 switch (cmd.action) {
183 case LFUN_INSET_MODIFY:
184 InsetNoteMailer::string2params(to_utf8(cmd.argument()), params_);
185 // get a bp from cur:
186 setLayout(cur.buffer().params());
189 case LFUN_INSET_DIALOG_UPDATE:
190 InsetNoteMailer(*this).updateDialog(&cur.bv());
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 case LFUN_INSET_DIALOG_UPDATE:
210 return InsetCollapsable::getStatus(cur, cmd, flag);
214 void InsetNote::updateLabels(ParIterator const & it)
216 DocumentClass const & tclass = buffer().params().documentClass();
217 Counters savecnt = tclass.counters();
218 InsetCollapsable::updateLabels(it);
219 tclass.counters() = savecnt;
223 void InsetNote::addToToc(ParConstIterator const & cpit) const
225 ParConstIterator pit = cpit;
226 pit.push_back(*this);
228 Toc & toc = buffer().tocBackend().toc("note");
230 str = notetranslator_loc().find(params_.type) + from_ascii(": ")
232 toc.push_back(TocItem(pit, 0, str));
236 bool InsetNote::isMacroScope() const
238 // LyX note has no latex output
239 if (params_.type == InsetNoteParams::Note)
242 return InsetCollapsable::isMacroScope();
246 int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
248 if (params_.type == InsetNoteParams::Note)
251 OutputParams runparams(runparams_in);
252 if (params_.type == InsetNoteParams::Comment) {
253 runparams.inComment = true;
254 // Ignore files that are exported inside a comment
255 runparams.exportdata.reset(new ExportData);
259 InsetCollapsable::latex(ss, runparams);
260 // the space after the comment in 'a[comment] b' will be eaten by the
261 // comment environment since the space before b is ignored with the
262 // following latex output:
270 // Adding {} before ' b' fixes this.
271 if (params_.type == InsetNoteParams::Comment)
274 docstring const str = ss.str();
276 runparams_in.encoding = runparams.encoding;
277 // Return how many newlines we issued.
278 return int(count(str.begin(), str.end(), '\n'));
282 int InsetNote::plaintext(odocstream & os,
283 OutputParams const & runparams_in) const
285 if (params_.type == InsetNoteParams::Note)
288 OutputParams runparams(runparams_in);
289 if (params_.type == InsetNoteParams::Comment) {
290 runparams.inComment = true;
291 // Ignore files that are exported inside a comment
292 runparams.exportdata.reset(new ExportData);
294 os << '[' << buffer().B_("note") << ":\n";
295 InsetText::plaintext(os, runparams);
298 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
302 int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
304 if (params_.type == InsetNoteParams::Note)
307 OutputParams runparams(runparams_in);
308 if (params_.type == InsetNoteParams::Comment) {
310 runparams.inComment = true;
311 // Ignore files that are exported inside a comment
312 runparams.exportdata.reset(new ExportData);
315 int const n = InsetText::docbook(os, runparams);
317 if (params_.type == InsetNoteParams::Comment)
318 os << "\n</remark>\n";
320 // Return how many newlines we issued.
321 //return int(count(str.begin(), str.end(), '\n'));
326 void InsetNote::validate(LaTeXFeatures & features) const
328 if (params_.type == InsetNoteParams::Comment)
329 features.require("verbatim");
330 if (params_.type == InsetNoteParams::Greyedout) {
331 features.require("color");
332 features.require("lyxgreyedout");
334 InsetText::validate(features);
339 string const InsetNoteMailer::name_("note");
341 InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
346 string const InsetNoteMailer::inset2string(Buffer const &) const
348 return params2string(inset_.params());
352 string const InsetNoteMailer::params2string(InsetNoteParams const & params)
355 data << name_ << ' ';
361 void InsetNoteMailer::string2params(string const & in,
362 InsetNoteParams & params)
364 params = InsetNoteParams();
369 istringstream data(in);
375 if (!lex || name != name_)
376 return print_mailer_error("InsetNoteMailer", in, 1, name_);
378 // This is part of the inset proper that is usually swallowed
379 // by Text::readInset
382 if (!lex || id != "Note")
383 return print_mailer_error("InsetBoxMailer", in, 2, "Note");