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/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 auto_ptr<Inset> InsetNote::doClone() const
139 return auto_ptr<Inset>(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);
187 setLabelFont(layout_.labelfont);
191 Color_color InsetNote::backgroundColor() const
194 switch (params_.type) {
195 case InsetNoteParams::Note:
198 case InsetNoteParams::Comment:
199 c = Color::commentbg;
201 case InsetNoteParams::Greyedout:
202 c = Color::greyedoutbg;
204 case InsetNoteParams::Framed:
205 c = Color::greyedoutbg;
207 case InsetNoteParams::Shaded:
215 bool InsetNote::showInsetDialog(BufferView * bv) const
217 InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
222 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
224 switch (cmd.action) {
226 case LFUN_INSET_MODIFY:
227 InsetNoteMailer::string2params(to_utf8(cmd.argument()), params_);
228 // get a bp from cur:
229 setLayout(cur.buffer().params());
233 case LFUN_INSET_DIALOG_UPDATE:
234 InsetNoteMailer(*this).updateDialog(&cur.bv());
237 case LFUN_MOUSE_RELEASE:
238 if (cmd.button() == mouse_button::button3 && hitButton(cmd))
239 InsetNoteMailer(*this).showDialog(&cur.bv());
241 InsetCollapsable::doDispatch(cur, cmd);
245 InsetCollapsable::doDispatch(cur, cmd);
251 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
252 FuncStatus & flag) const
254 switch (cmd.action) {
256 case LFUN_INSET_MODIFY:
257 case LFUN_INSET_DIALOG_UPDATE:
262 return InsetCollapsable::getStatus(cur, cmd, flag);
266 void InsetNote::updateLabels(Buffer const & buf, ParIterator const & it)
268 TextClass const & tclass = buf.params().getTextClass();
269 Counters savecnt = tclass.counters();
270 InsetCollapsable::updateLabels(buf, it);
271 tclass.counters() = savecnt;
275 int InsetNote::latex(Buffer const & buf, odocstream & os,
276 OutputParams const & runparams_in) const
278 if (params_.type == InsetNoteParams::Note)
281 OutputParams runparams(runparams_in);
283 if (params_.type == InsetNoteParams::Comment) {
285 runparams.inComment = true;
286 // Ignore files that are exported inside a comment
287 runparams.exportdata.reset(new ExportData);
288 } else if (params_.type == InsetNoteParams::Greyedout)
289 type = "lyxgreyedout";
290 else if (params_.type == InsetNoteParams::Framed)
292 else if (params_.type == InsetNoteParams::Shaded)
296 ss << "%\n\\begin{" << from_ascii(type) << "}\n";
297 InsetText::latex(buf, ss, runparams);
298 ss << "\n\\end{" << from_ascii(type) << "}\n";
299 // the space after the comment in 'a[comment] b' will be eaten by the
300 // comment environment since the space before b is ignored with the
301 // following latex output:
309 // Adding {} before ' b' fixes this.
310 if (params_.type == InsetNoteParams::Comment)
313 docstring const str = ss.str();
315 runparams_in.encoding = runparams.encoding;
316 // Return how many newlines we issued.
317 return int(std::count(str.begin(), str.end(), '\n'));
321 int InsetNote::plaintext(Buffer const & buf, odocstream & os,
322 OutputParams const & runparams_in) const
324 if (params_.type == InsetNoteParams::Note)
327 OutputParams runparams(runparams_in);
328 if (params_.type == InsetNoteParams::Comment) {
329 runparams.inComment = true;
330 // Ignore files that are exported inside a comment
331 runparams.exportdata.reset(new ExportData);
333 os << '[' << buf.B_("note") << ":\n";
334 InsetText::plaintext(buf, os, runparams);
337 return PLAINTEXT_NEWLINE + 1; // one char on a separate line
341 int InsetNote::docbook(Buffer const & buf, odocstream & os,
342 OutputParams const & runparams_in) const
344 if (params_.type == InsetNoteParams::Note)
347 OutputParams runparams(runparams_in);
348 if (params_.type == InsetNoteParams::Comment) {
350 runparams.inComment = true;
351 // Ignore files that are exported inside a comment
352 runparams.exportdata.reset(new ExportData);
355 int const n = InsetText::docbook(buf, os, runparams);
357 if (params_.type == InsetNoteParams::Comment)
358 os << "\n</remark>\n";
360 // Return how many newlines we issued.
361 //return int(count(str.begin(), str.end(), '\n'));
366 void InsetNote::validate(LaTeXFeatures & features) const
368 if (params_.type == InsetNoteParams::Comment)
369 features.require("verbatim");
370 if (params_.type == InsetNoteParams::Greyedout) {
371 features.require("color");
372 features.require("lyxgreyedout");
374 if (params_.type == InsetNoteParams::Shaded) {
375 features.require("color");
376 features.require("framed");
378 if (params_.type == InsetNoteParams::Framed)
379 features.require("framed");
380 InsetText::validate(features);
385 string const InsetNoteMailer::name_("note");
387 InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
392 string const InsetNoteMailer::inset2string(Buffer const &) const
394 return params2string(inset_.params());
398 string const InsetNoteMailer::params2string(InsetNoteParams const & params)
401 data << name_ << ' ';
407 void InsetNoteMailer::string2params(string const & in,
408 InsetNoteParams & params)
410 params = InsetNoteParams();
415 istringstream data(in);
421 if (!lex || name != name_)
422 return print_mailer_error("InsetNoteMailer", in, 1, name_);
424 // This is part of the inset proper that is usually swallowed
425 // by Text::readInset
428 if (!lex || id != "Note")
429 return print_mailer_error("InsetBoxMailer", in, 2, "Note");