src/insets/InsetNote.cpp

   1 /**
   2  * \file InsetNote.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Angus Leeming
   7  * \author Martin Vermeer
   8  * \author Jürgen Spitzmüller
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "InsetNote.h"
  16
  17 #include "Buffer.h"
  18 #include "BufferParams.h"
  19 #include "BufferView.h"
  20 #include "BufferParams.h"
  21 #include "Counters.h"
  22 #include "Cursor.h"
  23 #include "debug.h"
  24 #include "DispatchResult.h"
  25 #include "Exporter.h"
  26 #include "FuncRequest.h"
  27 #include "FuncStatus.h"
  28 #include "gettext.h"
  29 #include "LaTeXFeatures.h"
  30 #include "Lexer.h"
  31 #include "MetricsInfo.h"
  32 #include "OutputParams.h"
  33
  34 #include "support/Translator.h"
  35
  36 #include <algorithm>
  37 #include <sstream>
  38
  39
  40 namespace lyx {
  41
  42 using std::string;
  43 using std::auto_ptr;
  44 using std::istringstream;
  45 using std::ostream;
  46 using std::ostringstream;
  47
  48
  49 namespace {
  50
  51 typedef Translator<std::string, InsetNoteParams::Type> NoteTranslator;
  52 typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
  53
  54 NoteTranslator const init_notetranslator()
  55 {
  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);
  61         return translator;
  62 }
  63
  64
  65 NoteTranslatorLoc const init_notetranslator_loc()
  66 {
  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);
  72         return translator;
  73 }
  74
  75
  76 NoteTranslator const & notetranslator()
  77 {
  78         static NoteTranslator translator = init_notetranslator();
  79         return translator;
  80 }
  81
  82
  83 NoteTranslatorLoc const & notetranslator_loc()
  84 {
  85         static NoteTranslatorLoc translator = init_notetranslator_loc();
  86         return translator;
  87 }
  88
  89 } // anon
  90
  91
  92
  93
  94 InsetNoteParams::InsetNoteParams()
  95         : type(Note)
  96 {}
  97
  98
  99 void InsetNoteParams::write(ostream & os) const
 100 {
 101         string const label = notetranslator().find(type);
 102         os << "Note " << label << "\n";
 103 }
 104
 105
 106 void InsetNoteParams::read(Lexer & lex)
 107 {
 108         string label;
 109         lex >> label;
 110         if (lex)
 111                 type = notetranslator().find(label);
 112 }
 113
 114
 115 InsetNote::InsetNote(BufferParams const & bp, string const & label)
 116         : InsetCollapsable(bp)
 117 {
 118         params_.type = notetranslator().find(label);
 119         setLayout(bp);
 120         setButtonLabel();
 121 }
 122
 123
 124 InsetNote::InsetNote(InsetNote const & in)
 125         : InsetCollapsable(in), params_(in.params_)
 126 {
 127         setButtonLabel();
 128 }
 129
 130
 131 InsetNote::~InsetNote()
 132 {
 133         InsetNoteMailer(*this).hideDialog();
 134 }
 135
 136
 137 auto_ptr<Inset> InsetNote::doClone() const
 138 {
 139         return auto_ptr<Inset>(new InsetNote(*this));
 140 }
 141
 142
 143 docstring const InsetNote::editMessage() const
 144 {
 145         return _("Opened Note Inset");
 146 }
 147
 148
 149 docstring InsetNote::name() const
 150 {
 151         return from_ascii(string("Note") + string(":") + string(notetranslator().find(params_.type)));
 152 }
 153
 154
 155 Inset::DisplayType InsetNote::display() const
 156 {
 157         switch (params_.type) {
 158         case InsetNoteParams::Framed:
 159         case InsetNoteParams::Shaded:
 160                 return AlignLeft;
 161         default:
 162                 return Inline;
 163         }
 164 }
 165
 166
 167 void InsetNote::write(Buffer const & buf, ostream & os) const
 168 {
 169         params_.write(os);
 170         InsetCollapsable::write(buf, os);
 171 }
 172
 173
 174 void InsetNote::read(Buffer const & buf, Lexer & lex)
 175 {
 176         params_.read(lex);
 177         InsetCollapsable::read(buf, lex);
 178         setLayout(buf.params());
 179         setButtonLabel();
 180 }
 181
 182
 183 void InsetNote::setButtonLabel()
 184 {
 185         docstring const label = notetranslator_loc().find(params_.type);
 186         setLabel(label);
 187 }
 188
 189
 190 Color_color InsetNote::backgroundColor() const
 191 {
 192         Color_color c;
 193         switch (params_.type) {
 194         case InsetNoteParams::Note:
 195                 c = Color::notebg;
 196                 break;
 197         case InsetNoteParams::Comment:
 198                 c = Color::commentbg;
 199                 break;
 200         case InsetNoteParams::Greyedout:
 201                 c = Color::greyedoutbg;
 202                 break;
 203         case InsetNoteParams::Framed:
 204                 c = Color::greyedoutbg;
 205                 break;
 206         case InsetNoteParams::Shaded:
 207                 c = Color::shadedbg;
 208                 break;
 209         }
 210         return c;
 211 }
 212
 213
 214 bool InsetNote::showInsetDialog(BufferView * bv) const
 215 {
 216         InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
 217         return true;
 218 }
 219
 220
 221 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 222 {
 223         switch (cmd.action) {
 224
 225         case LFUN_INSET_MODIFY:
 226                 InsetNoteMailer::string2params(to_utf8(cmd.argument()), params_);
 227                 // get a bp from cur:
 228                 setLayout(cur.buffer().params());
 229                 setButtonLabel();
 230                 break;
 231
 232         case LFUN_INSET_DIALOG_UPDATE:
 233                 InsetNoteMailer(*this).updateDialog(&cur.bv());
 234                 break;
 235
 236         case LFUN_MOUSE_RELEASE:
 237                 if (cmd.button() == mouse_button::button3 && hitButton(cmd))
 238                         InsetNoteMailer(*this).showDialog(&cur.bv());
 239                 else
 240                         InsetCollapsable::doDispatch(cur, cmd);
 241                 break;
 242
 243         default:
 244                 InsetCollapsable::doDispatch(cur, cmd);
 245                 break;
 246         }
 247 }
 248
 249
 250 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
 251                 FuncStatus & flag) const
 252 {
 253         switch (cmd.action) {
 254
 255         case LFUN_INSET_MODIFY:
 256         case LFUN_INSET_DIALOG_UPDATE:
 257                 flag.enabled(true);
 258                 return true;
 259
 260         default:
 261                 return InsetCollapsable::getStatus(cur, cmd, flag);
 262         }
 263 }
 264
 265 void InsetNote::updateLabels(Buffer const & buf, ParIterator const & it)
 266 {
 267         TextClass const & tclass = buf.params().getTextClass();
 268         Counters savecnt = tclass.counters();
 269         InsetCollapsable::updateLabels(buf, it);
 270         tclass.counters() = savecnt;
 271 }
 272
 273
 274 int InsetNote::latex(Buffer const & buf, odocstream & os,
 275                      OutputParams const & runparams_in) const
 276 {
 277         if (params_.type == InsetNoteParams::Note)
 278                 return 0;
 279
 280         OutputParams runparams(runparams_in);
 281         if (params_.type == InsetNoteParams::Comment) {
 282                 runparams.inComment = true;
 283                 // Ignore files that are exported inside a comment
 284                 runparams.exportdata.reset(new ExportData);
 285         }
 286
 287         odocstringstream ss;
 288         //ss << "%\n\\begin{" << from_ascii(type) << "}\n";
 289         ss << "%\n\\begin{" << from_ascii(layout_.latexname) << "}\n";
 290         InsetText::latex(buf, ss, runparams);
 291         ss << "\n\\end{" << from_ascii(layout_.latexname) << "}\n";
 292         // the space after the comment in 'a[comment] b' will be eaten by the
 293         // comment environment since the space before b is ignored with the
 294         // following latex output:
 295         //
 296         // a%
 297         // \begin{comment}
 298         // comment
 299         // \end{comment}
 300         //  b
 301         //
 302         // Adding {} before ' b' fixes this.
 303         if (params_.type == InsetNoteParams::Comment)
 304                 ss << "{}";
 305
 306         docstring const str = ss.str();
 307         os << str;
 308         runparams_in.encoding = runparams.encoding;
 309         // Return how many newlines we issued.
 310         return int(std::count(str.begin(), str.end(), '\n'));
 311 }
 312
 313
 314 int InsetNote::plaintext(Buffer const & buf, odocstream & os,
 315                          OutputParams const & runparams_in) const
 316 {
 317         if (params_.type == InsetNoteParams::Note)
 318                 return 0;
 319
 320         OutputParams runparams(runparams_in);
 321         if (params_.type == InsetNoteParams::Comment) {
 322                 runparams.inComment = true;
 323                 // Ignore files that are exported inside a comment
 324                 runparams.exportdata.reset(new ExportData);
 325         }
 326         os << '[' << buf.B_("note") << ":\n";
 327         InsetText::plaintext(buf, os, runparams);
 328         os << "\n]";
 329
 330         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 331 }
 332
 333
 334 int InsetNote::docbook(Buffer const & buf, odocstream & os,
 335                        OutputParams const & runparams_in) const
 336 {
 337         if (params_.type == InsetNoteParams::Note)
 338                 return 0;
 339
 340         OutputParams runparams(runparams_in);
 341         if (params_.type == InsetNoteParams::Comment) {
 342                 os << "<remark>\n";
 343                 runparams.inComment = true;
 344                 // Ignore files that are exported inside a comment
 345                 runparams.exportdata.reset(new ExportData);
 346         }
 347
 348         int const n = InsetText::docbook(buf, os, runparams);
 349
 350         if (params_.type == InsetNoteParams::Comment)
 351                 os << "\n</remark>\n";
 352
 353         // Return how many newlines we issued.
 354         //return int(count(str.begin(), str.end(), '\n'));
 355         return n + 1 + 2;
 356 }
 357
 358
 359 void InsetNote::validate(LaTeXFeatures & features) const
 360 {
 361         if (params_.type == InsetNoteParams::Comment)
 362                 features.require("verbatim");
 363         if (params_.type == InsetNoteParams::Greyedout) {
 364                 features.require("color");
 365                 features.require("lyxgreyedout");
 366         }
 367         if (params_.type == InsetNoteParams::Shaded) {
 368                 features.require("color");
 369                 features.require("framed");
 370         }
 371         if (params_.type == InsetNoteParams::Framed)
 372                 features.require("framed");
 373         InsetText::validate(features);
 374 }
 375
 376
 377
 378 string const InsetNoteMailer::name_("note");
 379
 380 InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
 381         : inset_(inset)
 382 {}
 383
 384
 385 string const InsetNoteMailer::inset2string(Buffer const &) const
 386 {
 387         return params2string(inset_.params());
 388 }
 389
 390
 391 string const InsetNoteMailer::params2string(InsetNoteParams const & params)
 392 {
 393         ostringstream data;
 394         data << name_ << ' ';
 395         params.write(data);
 396         return data.str();
 397 }
 398
 399
 400 void InsetNoteMailer::string2params(string const & in,
 401                                     InsetNoteParams & params)
 402 {
 403         params = InsetNoteParams();
 404
 405         if (in.empty())
 406                 return;
 407
 408         istringstream data(in);
 409         Lexer lex(0,0);
 410         lex.setStream(data);
 411
 412         string name;
 413         lex >> name;
 414         if (!lex || name != name_)
 415                 return print_mailer_error("InsetNoteMailer", in, 1, name_);
 416
 417         // This is part of the inset proper that is usually swallowed
 418         // by Text::readInset
 419         string id;
 420         lex >> id;
 421         if (!lex || id != "Note")
 422                 return print_mailer_error("InsetBoxMailer", in, 2, "Note");
 423
 424         params.read(lex);
 425 }
 426
 427
 428 } // namespace lyx