src/insets/insetnote.C

   1 /**
   2  * \file insetnote.C
   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 "BufferView.h"
  18 #include "debug.h"
  19 #include "dispatchresult.h"
  20 #include "funcrequest.h"
  21 #include "gettext.h"
  22 #include "LaTeXFeatures.h"
  23 #include "LColor.h"
  24 #include "lyxlex.h"
  25 #include "metricsinfo.h"
  26 #include "paragraph.h"
  27
  28 #include "support/lyxalgo.h"
  29 #include "support/std_sstream.h"
  30 #include "support/translator.h"
  31
  32
  33 using std::string;
  34 using std::auto_ptr;
  35 using std::istringstream;
  36 using std::ostream;
  37 using std::ostringstream;
  38
  39
  40 namespace {
  41
  42 typedef Translator<std::string, InsetNoteParams::Type> NoteTranslator;
  43
  44 NoteTranslator const init_notetranslator() {
  45         NoteTranslator translator("Note", InsetNoteParams::Note);
  46         translator.addPair("Comment", InsetNoteParams::Comment);
  47         translator.addPair("Greyedout", InsetNoteParams::Greyedout);
  48         return translator;
  49 }
  50
  51
  52 NoteTranslator const init_notetranslator_loc() {
  53         NoteTranslator translator(_("Note"), InsetNoteParams::Note);
  54         translator.addPair(_("Comment"), InsetNoteParams::Comment);
  55         translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
  56         return translator;
  57 }
  58
  59
  60 NoteTranslator const & notetranslator() {
  61         static NoteTranslator translator = init_notetranslator();
  62         return translator;
  63 }
  64
  65
  66 NoteTranslator const & notetranslator_loc() {
  67         static NoteTranslator translator = init_notetranslator_loc();
  68         return translator;
  69 }
  70
  71 } // anon
  72
  73
  74
  75
  76 InsetNoteParams::InsetNoteParams()
  77         : type(Note)
  78 {}
  79
  80
  81 void InsetNoteParams::write(ostream & os) const
  82 {
  83         string const label = notetranslator().find(type);
  84         os << "Note " << label << "\n";
  85 }
  86
  87
  88 void InsetNoteParams::read(LyXLex & lex)
  89 {
  90         string label;
  91         lex >> label;
  92         if (lex)
  93                 type = notetranslator().find(label);
  94 }
  95
  96
  97 void InsetNote::init()
  98 {
  99         setInsetName("Note");
 100         setButtonLabel();
 101 }
 102
 103
 104 InsetNote::InsetNote(BufferParams const & bp, string const & label)
 105         : InsetCollapsable(bp)
 106 {
 107         params_.type = notetranslator().find(label);
 108         init();
 109 }
 110
 111
 112 InsetNote::InsetNote(InsetNote const & in)
 113         : InsetCollapsable(in), params_(in.params_)
 114 {
 115         init();
 116 }
 117
 118
 119 InsetNote::~InsetNote()
 120 {
 121         InsetNoteMailer(*this).hideDialog();
 122 }
 123
 124
 125 auto_ptr<InsetBase> InsetNote::clone() const
 126 {
 127         return auto_ptr<InsetBase>(new InsetNote(*this));
 128 }
 129
 130
 131 string const InsetNote::editMessage() const
 132 {
 133         return _("Opened Note Inset");
 134 }
 135
 136
 137 void InsetNote::write(Buffer const & buf, ostream & os) const
 138 {
 139         params_.write(os);
 140         InsetCollapsable::write(buf, os);
 141 }
 142
 143
 144 void InsetNote::read(Buffer const & buf, LyXLex & lex)
 145 {
 146         params_.read(lex);
 147         InsetCollapsable::read(buf, lex);
 148         setButtonLabel();
 149 }
 150
 151
 152 void InsetNote::setButtonLabel()
 153 {
 154         string const label = notetranslator_loc().find(params_.type);
 155         setLabel(label);
 156
 157         LyXFont font(LyXFont::ALL_SANE);
 158         font.decSize();
 159         font.decSize();
 160
 161         switch (params_.type) {
 162         case InsetNoteParams::Note:
 163                 font.setColor(LColor::note);
 164                 setBackgroundColor(LColor::notebg);
 165                 break;
 166         case InsetNoteParams::Comment:
 167                 font.setColor(LColor::comment);
 168                 setBackgroundColor(LColor::commentbg);
 169                 break;
 170         case InsetNoteParams::Greyedout:
 171                 font.setColor(LColor::greyedout);
 172                 setBackgroundColor(LColor::greyedoutbg);
 173                 break;
 174         }
 175         setLabelFont(font);
 176 }
 177
 178
 179 bool InsetNote::showInsetDialog(BufferView * bv) const
 180 {
 181         InsetNoteMailer(const_cast<InsetNote &>(*this)).showDialog(bv);
 182         return true;
 183 }
 184
 185
 186 DispatchResult
 187 InsetNote::priv_dispatch(BufferView & bv, FuncRequest const & cmd)
 188 {
 189         switch (cmd.action) {
 190
 191         case LFUN_INSET_MODIFY: {
 192                 InsetNoteMailer::string2params(cmd.argument, params_);
 193                 setButtonLabel();
 194                 bv.update();
 195                 return DispatchResult(true, true);
 196         }
 197
 198         case LFUN_INSET_DIALOG_UPDATE:
 199                 InsetNoteMailer(*this).updateDialog(&bv);
 200                 return DispatchResult(true, true);
 201
 202         case LFUN_MOUSE_RELEASE:
 203                 if (cmd.button() == mouse_button::button3 && hitButton(cmd)) {
 204                         InsetNoteMailer(*this).showDialog(&bv);
 205                         return DispatchResult(true, true);
 206                 }
 207                 return InsetCollapsable::priv_dispatch(bv, cmd);
 208
 209         default:
 210                 return InsetCollapsable::priv_dispatch(bv, cmd);
 211         }
 212 }
 213
 214
 215 int InsetNote::latex(Buffer const & buf, ostream & os,
 216                      OutputParams const & runparams) const
 217 {
 218         if (params_.type == InsetNoteParams::Note)
 219                 return 0;
 220
 221         string type;
 222         if (params_.type == InsetNoteParams::Comment)
 223                 type = "comment";
 224         else if (params_.type == InsetNoteParams::Greyedout)
 225                 type = "lyxgreyedout";
 226
 227         ostringstream ss;
 228         ss << "%\n\\begin{" << type << "}\n";
 229         inset.latex(buf, ss, runparams);
 230         ss << "%\n\\end{" << type << "}\n";
 231
 232         string const str = ss.str();
 233         os << str;
 234         // Return how many newlines we issued.
 235         return int(lyx::count(str.begin(), str.end(),'\n') + 1);
 236 }
 237
 238
 239 int InsetNote::linuxdoc(Buffer const & buf, std::ostream & os,
 240                         OutputParams const & runparams) const
 241 {
 242         if (params_.type == InsetNoteParams::Note)
 243                 return 0;
 244
 245         ostringstream ss;
 246         if (params_.type == InsetNoteParams::Comment)
 247                 ss << "<comment>\n";
 248
 249         inset.linuxdoc(buf, ss, runparams);
 250
 251         if (params_.type == InsetNoteParams::Comment)
 252                 ss << "\n</comment>\n";
 253
 254         string const str = ss.str();
 255         os << str;
 256         // Return how many newlines we issued.
 257         return int(lyx::count(str.begin(), str.end(),'\n') + 1);
 258 }
 259
 260
 261 int InsetNote::docbook(Buffer const & buf, std::ostream & os,
 262                        OutputParams const & runparams) const
 263 {
 264         if (params_.type == InsetNoteParams::Note)
 265                 return 0;
 266
 267         ostringstream ss;
 268         if (params_.type == InsetNoteParams::Comment)
 269                 ss << "<remark>\n";
 270
 271         inset.docbook(buf, ss, runparams);
 272
 273         if (params_.type == InsetNoteParams::Comment)
 274                 ss << "\n</remark>\n";
 275
 276         string const str = ss.str();
 277         os << str;
 278         // Return how many newlines we issued.
 279         return int(lyx::count(str.begin(), str.end(),'\n') + 1);
 280 }
 281
 282
 283 int InsetNote::plaintext(Buffer const & buf, std::ostream & os,
 284                      OutputParams const & runparams) const
 285 {
 286         if (params_.type == InsetNoteParams::Note)
 287                 return 0;
 288
 289         ostringstream ss;
 290         ss << "[";
 291         inset.plaintext(buf, ss, runparams);
 292         ss << "]";
 293
 294         string const str = ss.str();
 295         os << str;
 296         // Return how many newlines we issued.
 297         return int(lyx::count(str.begin(), str.end(),'\n') + 1);
 298 }
 299
 300
 301 void InsetNote::validate(LaTeXFeatures & features) const
 302 {
 303         if (params_.type == InsetNoteParams::Comment)
 304                 features.require("verbatim");
 305         if (params_.type == InsetNoteParams::Greyedout) {
 306                 features.require("color");
 307                 features.require("lyxgreyedout");
 308         }
 309         inset.validate(features);
 310 }
 311
 312
 313
 314 string const InsetNoteMailer:: name_("note");
 315
 316 InsetNoteMailer::InsetNoteMailer(InsetNote & inset)
 317         : inset_(inset)
 318 {}
 319
 320
 321 string const InsetNoteMailer::inset2string(Buffer const &) const
 322 {
 323         return params2string(inset_.params());
 324 }
 325
 326
 327 string const InsetNoteMailer::params2string(InsetNoteParams const & params)
 328 {
 329         ostringstream data;
 330         data << name_ << ' ';
 331         params.write(data);
 332         return data.str();
 333 }
 334
 335
 336 void InsetNoteMailer::string2params(string const & in,
 337                                     InsetNoteParams & params)
 338 {
 339         params = InsetNoteParams();
 340
 341         if (in.empty())
 342                 return;
 343
 344         istringstream data(in);
 345         LyXLex lex(0,0);
 346         lex.setStream(data);
 347
 348         string name;
 349         lex >> name;
 350         if (!lex || name != name_)
 351                 return print_mailer_error("InsetNoteMailer", in, 1, name_);
 352
 353         // This is part of the inset proper that is usually swallowed
 354         // by LyXText::readInset
 355         string id;
 356         lex >> id;
 357         if (!lex || id != "Note")
 358                 return print_mailer_error("InsetBoxMailer", in, 2, "Note");
 359
 360         params.read(lex);
 361 }