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 "DispatchResult.h"
  24 #include "Exporter.h"
  25 #include "FuncRequest.h"
  26 #include "FuncStatus.h"
  27 #include "InsetIterator.h"
  28 #include "LaTeXFeatures.h"
  29 #include "Lexer.h"
  30 #include "MetricsInfo.h"
  31 #include "OutputParams.h"
  32 #include "ParIterator.h"
  33 #include "TextClass.h"
  34 #include "TocBackend.h"
  35
  36 #include "support/debug.h"
  37 #include "support/docstream.h"
  38 #include "support/gettext.h"
  39 #include "support/Translator.h"
  40
  41 #include "frontends/Application.h"
  42
  43 #include <algorithm>
  44 #include <sstream>
  45
  46 using namespace std;
  47
  48 namespace lyx {
  49
  50 namespace {
  51
  52 typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
  53 typedef Translator<docstring, InsetNoteParams::Type> NoteTranslatorLoc;
  54
  55 NoteTranslator const init_notetranslator()
  56 {
  57         NoteTranslator translator("Note", InsetNoteParams::Note);
  58         translator.addPair("Comment", InsetNoteParams::Comment);
  59         translator.addPair("Greyedout", InsetNoteParams::Greyedout);
  60         return translator;
  61 }
  62
  63
  64 NoteTranslatorLoc const init_notetranslator_loc()
  65 {
  66         NoteTranslatorLoc translator(_("Note[[InsetNote]]"), InsetNoteParams::Note);
  67         translator.addPair(_("Comment"), InsetNoteParams::Comment);
  68         translator.addPair(_("Greyed out"), InsetNoteParams::Greyedout);
  69         return translator;
  70 }
  71
  72
  73 NoteTranslator const & notetranslator()
  74 {
  75         static NoteTranslator translator = init_notetranslator();
  76         return translator;
  77 }
  78
  79
  80 NoteTranslatorLoc const & notetranslator_loc()
  81 {
  82         static NoteTranslatorLoc translator = init_notetranslator_loc();
  83         return translator;
  84 }
  85
  86 } // anon
  87
  88
  89
  90
  91 InsetNoteParams::InsetNoteParams()
  92         : type(Note)
  93 {}
  94
  95
  96 void InsetNoteParams::write(ostream & os) const
  97 {
  98         string const label = notetranslator().find(type);
  99         os << "Note " << label << "\n";
 100 }
 101
 102
 103 void InsetNoteParams::read(Lexer & lex)
 104 {
 105         string label;
 106         lex >> label;
 107         if (lex)
 108                 type = notetranslator().find(label);
 109 }
 110
 111
 112 /////////////////////////////////////////////////////////////////////
 113 //
 114 // InsetNote
 115 //
 116 /////////////////////////////////////////////////////////////////////
 117
 118 InsetNote::InsetNote(Buffer const & buf, string const & label)
 119         : InsetCollapsable(buf)
 120 {
 121         params_.type = notetranslator().find(label);
 122 }
 123
 124
 125 InsetNote::~InsetNote()
 126 {
 127         hideDialogs("note", this);
 128 }
 129
 130
 131 docstring InsetNote::editMessage() const
 132 {
 133         return _("Opened Note Inset");
 134 }
 135
 136
 137 docstring InsetNote::name() const
 138 {
 139         return from_ascii("Note:" + notetranslator().find(params_.type));
 140 }
 141
 142
 143 Inset::DisplayType InsetNote::display() const
 144 {
 145         return Inline;
 146 }
 147
 148
 149 void InsetNote::write(ostream & os) const
 150 {
 151         params_.write(os);
 152         InsetCollapsable::write(os);
 153 }
 154
 155
 156 void InsetNote::read(Lexer & lex)
 157 {
 158         params_.read(lex);
 159         InsetCollapsable::read(lex);
 160 }
 161
 162
 163 void InsetNote::setButtonLabel()
 164 {
 165         docstring const label = notetranslator_loc().find(params_.type);
 166         setLabel(label);
 167 }
 168
 169
 170 bool InsetNote::showInsetDialog(BufferView * bv) const
 171 {
 172         bv->showDialog("note", params2string(params()),
 173                 const_cast<InsetNote *>(this));
 174         return true;
 175 }
 176
 177
 178 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 179 {
 180         switch (cmd.action) {
 181
 182         case LFUN_INSET_MODIFY:
 183                 string2params(to_utf8(cmd.argument()), params_);
 184                 setLayout();
 185                 break;
 186
 187         case LFUN_INSET_DIALOG_UPDATE:
 188                 cur.bv().updateDialog("note", params2string(params()));
 189                 break;
 190
 191         default:
 192                 InsetCollapsable::doDispatch(cur, cmd);
 193                 break;
 194         }
 195 }
 196
 197
 198 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
 199                 FuncStatus & flag) const
 200 {
 201         switch (cmd.action) {
 202
 203         case LFUN_INSET_MODIFY:
 204                 // disallow comment and greyed out in commands
 205                 flag.setEnabled(!cur.paragraph().layout().isCommand() ||
 206                                 cmd.getArg(2) == "Note");
 207                 if (cmd.getArg(0) == "note") {
 208                         InsetNoteParams params;
 209                         string2params(to_utf8(cmd.argument()), params);
 210                         flag.setOnOff(params_.type == params.type);
 211                 }
 212                 return true;
 213
 214         case LFUN_INSET_DIALOG_UPDATE:
 215                 flag.setEnabled(true);
 216                 return true;
 217
 218         default:
 219                 return InsetCollapsable::getStatus(cur, cmd, flag);
 220         }
 221 }
 222
 223
 224 void InsetNote::addToToc(DocIterator const & cpit)
 225 {
 226         DocIterator pit = cpit;
 227         pit.push_back(CursorSlice(*this));
 228
 229         Toc & toc = buffer().tocBackend().toc("note");
 230         docstring str;
 231         str = notetranslator_loc().find(params_.type) + from_ascii(": ")
 232                 + getNewLabel(str);
 233         toc.push_back(TocItem(pit, 0, str));
 234         // Proceed with the rest of the inset.
 235         InsetCollapsable::addToToc(cpit);
 236 }
 237
 238
 239 bool InsetNote::isMacroScope() const
 240 {
 241         // LyX note has no latex output
 242         if (params_.type == InsetNoteParams::Note)
 243                 return true;
 244
 245         return InsetCollapsable::isMacroScope();
 246 }
 247
 248
 249 int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
 250 {
 251         if (params_.type == InsetNoteParams::Note)
 252                 return 0;
 253
 254         OutputParams runparams(runparams_in);
 255         if (params_.type == InsetNoteParams::Comment) {
 256                 runparams.inComment = true;
 257                 // Ignore files that are exported inside a comment
 258                 runparams.exportdata.reset(new ExportData);
 259         }
 260
 261         odocstringstream ss;
 262         InsetCollapsable::latex(ss, runparams);
 263         // the space after the comment in 'a[comment] b' will be eaten by the
 264         // comment environment since the space before b is ignored with the
 265         // following latex output:
 266         //
 267         // a%
 268         // \begin{comment}
 269         // comment
 270         // \end{comment}
 271         //  b
 272         //
 273         // Adding {} before ' b' fixes this.
 274         if (params_.type == InsetNoteParams::Comment)
 275                 ss << "{}";
 276
 277         docstring const str = ss.str();
 278         os << str;
 279         runparams_in.encoding = runparams.encoding;
 280         // Return how many newlines we issued.
 281         return int(count(str.begin(), str.end(), '\n'));
 282 }
 283
 284
 285 int InsetNote::plaintext(odocstream & os,
 286                          OutputParams const & runparams_in) const
 287 {
 288         if (params_.type == InsetNoteParams::Note)
 289                 return 0;
 290
 291         OutputParams runparams(runparams_in);
 292         if (params_.type == InsetNoteParams::Comment) {
 293                 runparams.inComment = true;
 294                 // Ignore files that are exported inside a comment
 295                 runparams.exportdata.reset(new ExportData);
 296         }
 297         os << '[' << buffer().B_("note") << ":\n";
 298         InsetText::plaintext(os, runparams);
 299         os << "\n]";
 300
 301         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 302 }
 303
 304
 305 int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
 306 {
 307         if (params_.type == InsetNoteParams::Note)
 308                 return 0;
 309
 310         OutputParams runparams(runparams_in);
 311         if (params_.type == InsetNoteParams::Comment) {
 312                 os << "<remark>\n";
 313                 runparams.inComment = true;
 314                 // Ignore files that are exported inside a comment
 315                 runparams.exportdata.reset(new ExportData);
 316         }
 317
 318         int const n = InsetText::docbook(os, runparams);
 319
 320         if (params_.type == InsetNoteParams::Comment)
 321                 os << "\n</remark>\n";
 322
 323         // Return how many newlines we issued.
 324         //return int(count(str.begin(), str.end(), '\n'));
 325         return n + 1 + 2;
 326 }
 327
 328
 329 docstring InsetNote::xhtml(odocstream & os, OutputParams const & rp) const
 330 {
 331         if (params_.type == InsetNoteParams::Note)
 332                 return docstring();
 333
 334         return InsetCollapsable::xhtml(os, rp);
 335 }
 336
 337
 338 void InsetNote::validate(LaTeXFeatures & features) const
 339 {
 340         switch (params_.type) {
 341         case InsetNoteParams::Comment:
 342                 features.require("verbatim");
 343                 break;
 344         case InsetNoteParams::Greyedout:
 345                 features.require("color");
 346                 features.require("lyxgreyedout");
 347                 InsetCollapsable::validate(features);
 348                 break;
 349         case InsetNoteParams::Note:
 350                 break;
 351         }
 352 }
 353
 354
 355 docstring InsetNote::contextMenu(BufferView const &, int, int) const
 356 {
 357         return from_ascii("context-note");
 358 }
 359
 360
 361 string InsetNote::params2string(InsetNoteParams const & params)
 362 {
 363         ostringstream data;
 364         data << "note" << ' ';
 365         params.write(data);
 366         return data.str();
 367 }
 368
 369
 370 void InsetNote::string2params(string const & in, InsetNoteParams & params)
 371 {
 372         params = InsetNoteParams();
 373
 374         if (in.empty())
 375                 return;
 376
 377         istringstream data(in);
 378         Lexer lex;
 379         lex.setStream(data);
 380         lex.setContext("InsetNote::string2params");
 381         lex >> "note";
 382         // There are cases, such as when we are called via getStatus() from
 383         // Dialog::canApply(), where we are just called with "note" rather
 384         // than a full "note Note TYPE".
 385         if (!lex.isOK())
 386                 return;
 387         lex >> "Note";
 388
 389         params.read(lex);
 390 }
 391
 392
 393 bool mutateNotes(Cursor & cur, string const & source, string const & target)
 394 {
 395         InsetNoteParams::Type typeSrc = notetranslator().find(source);
 396         InsetNoteParams::Type typeTrt = notetranslator().find(target);
 397         // syntax check of arguments
 398         string src = notetranslator().find(typeSrc);
 399         string trt = notetranslator().find(typeTrt);
 400         if (src != source || trt != target)
 401                 return false;
 402
 403         // did we found some conforming inset?
 404         bool ret = false;
 405
 406         cur.beginUndoGroup();
 407         Inset & inset = cur.buffer()->inset();
 408         InsetIterator it  = inset_iterator_begin(inset);
 409         InsetIterator const end = inset_iterator_end(inset);
 410         for (; it != end; ++it) {
 411                 if (it->lyxCode() == NOTE_CODE) {
 412                         InsetNote & ins = static_cast<InsetNote &>(*it);
 413                         if (ins.params().type == typeSrc) {
 414                                 cur.buffer()->undo().recordUndo(it);
 415                                 FuncRequest fr(LFUN_INSET_MODIFY, "note Note " + target);
 416                                 ins.dispatch(cur, fr);
 417                                 ret = true;
 418                         }
 419                 }
 420         }
 421         cur.endUndoGroup();
 422
 423         return ret;
 424 }
 425
 426 } // namespace lyx