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"
24 #include "DispatchResult.h"
26 #include "FuncRequest.h"
27 #include "FuncStatus.h"
29 #include "LaTeXFeatures.h"
31 #include "MetricsInfo.h"
32 #include "OutputParams.h"
34 #include "support/docstream.h"
35 #include "support/Translator.h"
44 using std::istringstream;
46 using std::ostringstream;
51 typedef Translator<std::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);
59 translator.addPair("Framed", InsetNoteParams::Framed);
60 translator.addPair("Shaded", InsetNoteParams::Shaded);
65 NoteTranslatorLoc const init_notetranslator_loc()
67 NoteTranslatorLoc translator(_("Note"), InsetNoteParams::Note);
68 translator.addPair(_("Comment"), InsetNoteParams::Comment);
69 translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
70 translator.addPair(_("Framed"), InsetNoteParams::Framed);
71 translator.addPair(_("Shaded"), InsetNoteParams::Shaded);
76 NoteTranslator const & notetranslator()
78 static NoteTranslator translator = init_notetranslator();
83 NoteTranslatorLoc const & notetranslator_loc()
85 static NoteTranslatorLoc translator = init_notetranslator_loc();
94 InsetNoteParams::InsetNoteParams()
99 void InsetNoteParams::write(ostream & os) const
101 string const label = notetranslator().find(type);
102 os << "Note " << label << "\n";
106 void InsetNoteParams::read(Lexer & lex)
111 type = notetranslator().find(label);
115 InsetNote::InsetNote(BufferParams const & bp, string const & label)
116 : InsetCollapsable(bp)
118 params_.type = notetranslator().find(label);
124 InsetNote::InsetNote(InsetNote const & in)
125 : InsetCollapsable(in), params_(in.params_)
131 InsetNote::~InsetNote()
133 InsetNoteMailer(*this).hideDialog();
137 Inset * InsetNote::clone() const
139 return new InsetNote(*this);
143 docstring const InsetNote::editMessage() const
145 return _("Opened Note Inset");
149 docstring InsetNote::name() const
151 return from_ascii(string("Note") + string(":") + string(notetranslator().find(params_.type)));
155 Inset::DisplayType InsetNote::display() const
157 switch (params_.type) {
158 case InsetNoteParams::Framed:
159 case InsetNoteParams::Shaded:
167 void InsetNote::write(Buffer const & buf, ostream & os) const
170 InsetCollapsable::write(buf, os);
174 void InsetNote::read(Buffer const & buf, Lexer & lex)
177 InsetCollapsable::read(buf, lex);
178 setLayout(buf.params());
183 void InsetNote::setButtonLabel()
185 docstring const label = notetranslator_loc().find(params_.type);
190 bool InsetNote::showInsetDialog(BufferView * bv) const
192 InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
197 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
199 switch (cmd.action) {
201 case LFUN_INSET_MODIFY:
202 InsetNoteMailer::string2params(to_utf8(cmd.argument()), params_);
203 // get a bp from cur:
204 setLayout(cur.buffer().params());
208 case LFUN_INSET_DIALOG_UPDATE:
209 InsetNoteMailer(*this).updateDialog(&cur.bv());
212 InsetCollapsable::doDispatch(cur, cmd);
218 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
219 FuncStatus & flag) const
221 switch (cmd.action) {
223 case LFUN_INSET_MODIFY:
224 case LFUN_INSET_DIALOG_UPDATE:
229 return InsetCollapsable::getStatus(cur, cmd, flag);
233 void InsetNote::updateLabels(Buffer const & buf, ParIterator const & it)
235 TextClass const & tclass = buf.params().getTextClass();
236 Counters savecnt = tclass.counters();
237 InsetCollapsable::updateLabels(buf, it);
238 tclass.counters() = savecnt;
242 int InsetNote::latex(Buffer const & buf, odocstream & os,
243 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(buf, 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(std::count(str.begin(), str.end(), '\n'));
279 int InsetNote::plaintext(Buffer const & buf, 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 << '[' << buf.B_("note") << ":\n";
292 InsetText::plaintext(buf, os, runparams);
295 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
299 int InsetNote::docbook(Buffer const & buf, odocstream & os,
300 OutputParams const & runparams_in) const
302 if (params_.type == InsetNoteParams::Note)
305 OutputParams runparams(runparams_in);
306 if (params_.type == InsetNoteParams::Comment) {
308 runparams.inComment = true;
309 // Ignore files that are exported inside a comment
310 runparams.exportdata.reset(new ExportData);
313 int const n = InsetText::docbook(buf, os, runparams);
315 if (params_.type == InsetNoteParams::Comment)
316 os << "\n</remark>\n";
318 // Return how many newlines we issued.
319 //return int(count(str.begin(), str.end(), '\n'));
324 void InsetNote::validate(LaTeXFeatures & features) const
326 if (params_.type == InsetNoteParams::Comment)
327 features.require("verbatim");
328 if (params_.type == InsetNoteParams::Greyedout) {
329 features.require("color");
330 features.require("lyxgreyedout");
332 if (params_.type == InsetNoteParams::Shaded) {
333 features.require("color");
334 features.require("framed");
336 if (params_.type == InsetNoteParams::Framed)
337 features.require("framed");
338 InsetText::validate(features);
343 string const InsetNoteMailer::name_("note");
345 InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
350 string const InsetNoteMailer::inset2string(Buffer const &) const
352 return params2string(inset_.params());
356 string const InsetNoteMailer::params2string(InsetNoteParams const & params)
359 data << name_ << ' ';
365 void InsetNoteMailer::string2params(string const & in,
366 InsetNoteParams & params)
368 params = InsetNoteParams();
373 istringstream data(in);
379 if (!lex || name != name_)
380 return print_mailer_error("InsetNoteMailer", in, 1, name_);
382 // This is part of the inset proper that is usually swallowed
383 // by Text::readInset
386 if (!lex || id != "Note")
387 return print_mailer_error("InsetBoxMailer", in, 2, "Note");