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 const 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(Buffer const & buf, ostream & os) const
154 InsetCollapsable::write(buf, os);
158 void InsetNote::read(Buffer const & buf, Lexer & lex)
161 InsetCollapsable::read(buf, 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(Buffer const & buf, ParIterator const & it)
216 TextClass const & tclass = buf.params().textClass();
217 Counters savecnt = tclass.counters();
218 InsetCollapsable::updateLabels(buf, it);
219 tclass.counters() = savecnt;
223 void InsetNote::addToToc(Buffer const & buf,
224 ParConstIterator const & cpit) const
226 ParConstIterator pit = cpit;
227 pit.push_back(*this);
229 Toc & toc = buf.tocBackend().toc("note");
231 str = notetranslator_loc().find(params_.type) + from_ascii(": ")
233 toc.push_back(TocItem(pit, 0, str));
237 bool InsetNote::isMacroScope(Buffer const & buf) const
239 // LyX note has no latex output
240 if (params_.type == InsetNoteParams::Note)
243 return InsetCollapsable::isMacroScope(buf);
247 int InsetNote::latex(Buffer const & buf, odocstream & os,
248 OutputParams const & runparams_in) const
250 if (params_.type == InsetNoteParams::Note)
253 OutputParams runparams(runparams_in);
254 if (params_.type == InsetNoteParams::Comment) {
255 runparams.inComment = true;
256 // Ignore files that are exported inside a comment
257 runparams.exportdata.reset(new ExportData);
261 InsetCollapsable::latex(buf, ss, runparams);
262 // the space after the comment in 'a[comment] b' will be eaten by the
263 // comment environment since the space before b is ignored with the
264 // following latex output:
272 // Adding {} before ' b' fixes this.
273 if (params_.type == InsetNoteParams::Comment)
276 docstring const str = ss.str();
278 runparams_in.encoding = runparams.encoding;
279 // Return how many newlines we issued.
280 return int(count(str.begin(), str.end(), '\n'));
284 int InsetNote::plaintext(Buffer const & buf, odocstream & os,
285 OutputParams const & runparams_in) const
287 if (params_.type == InsetNoteParams::Note)
290 OutputParams runparams(runparams_in);
291 if (params_.type == InsetNoteParams::Comment) {
292 runparams.inComment = true;
293 // Ignore files that are exported inside a comment
294 runparams.exportdata.reset(new ExportData);
296 os << '[' << buf.B_("note") << ":\n";
297 InsetText::plaintext(buf, os, runparams);
300 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
304 int InsetNote::docbook(Buffer const & buf, odocstream & os,
305 OutputParams const & runparams_in) const
307 if (params_.type == InsetNoteParams::Note)
310 OutputParams runparams(runparams_in);
311 if (params_.type == InsetNoteParams::Comment) {
313 runparams.inComment = true;
314 // Ignore files that are exported inside a comment
315 runparams.exportdata.reset(new ExportData);
318 int const n = InsetText::docbook(buf, os, runparams);
320 if (params_.type == InsetNoteParams::Comment)
321 os << "\n</remark>\n";
323 // Return how many newlines we issued.
324 //return int(count(str.begin(), str.end(), '\n'));
329 void InsetNote::validate(LaTeXFeatures & features) const
331 if (params_.type == InsetNoteParams::Comment)
332 features.require("verbatim");
333 if (params_.type == InsetNoteParams::Greyedout) {
334 features.require("color");
335 features.require("lyxgreyedout");
337 InsetText::validate(features);
342 string const InsetNoteMailer::name_("note");
344 InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
349 string const InsetNoteMailer::inset2string(Buffer const &) const
351 return params2string(inset_.params());
355 string const InsetNoteMailer::params2string(InsetNoteParams const & params)
358 data << name_ << ' ';
364 void InsetNoteMailer::string2params(string const & in,
365 InsetNoteParams & params)
367 params = InsetNoteParams();
372 istringstream data(in);
378 if (!lex || name != name_)
379 return print_mailer_error("InsetNoteMailer", in, 1, name_);
381 // This is part of the inset proper that is usually swallowed
382 // by Text::readInset
385 if (!lex || id != "Note")
386 return print_mailer_error("InsetBoxMailer", in, 2, "Note");