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 "LyXRC.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 * 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::name() const
 132 {
 133         return from_ascii("Note:" + notetranslator().find(params_.type));
 134 }
 135
 136
 137 Inset::DisplayType InsetNote::display() const
 138 {
 139         return Inline;
 140 }
 141
 142
 143 void InsetNote::write(ostream & os) const
 144 {
 145         params_.write(os);
 146         InsetCollapsable::write(os);
 147 }
 148
 149
 150 void InsetNote::read(Lexer & lex)
 151 {
 152         params_.read(lex);
 153         InsetCollapsable::read(lex);
 154 }
 155
 156
 157 void InsetNote::setButtonLabel()
 158 {
 159         docstring const label = notetranslator_loc().find(params_.type);
 160         setLabel(label);
 161 }
 162
 163
 164 bool InsetNote::showInsetDialog(BufferView * bv) const
 165 {
 166         bv->showDialog("note", params2string(params()),
 167                 const_cast<InsetNote *>(this));
 168         return true;
 169 }
 170
 171
 172 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 173 {
 174         switch (cmd.action()) {
 175
 176         case LFUN_INSET_MODIFY:
 177                 cur.recordUndoInset(ATOMIC_UNDO, this);
 178                 string2params(to_utf8(cmd.argument()), params_);
 179                 setButtonLabel();
 180                 // what we really want here is a TOC update, but that means
 181                 // a full buffer update
 182                 cur.forceBufferUpdate();
 183                 break;
 184
 185         case LFUN_INSET_DIALOG_UPDATE:
 186                 cur.bv().updateDialog("note", params2string(params()));
 187                 break;
 188
 189         default:
 190                 InsetCollapsable::doDispatch(cur, cmd);
 191                 break;
 192         }
 193 }
 194
 195
 196 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
 197                 FuncStatus & flag) const
 198 {
 199         switch (cmd.action()) {
 200
 201         case LFUN_INSET_MODIFY:
 202                 // disallow comment and greyed out in commands
 203                 flag.setEnabled(!cur.paragraph().layout().isCommand() ||
 204                                 cmd.getArg(2) == "Note");
 205                 if (cmd.getArg(0) == "note") {
 206                         InsetNoteParams params;
 207                         string2params(to_utf8(cmd.argument()), params);
 208                         flag.setOnOff(params_.type == params.type);
 209                 }
 210                 return true;
 211
 212         case LFUN_INSET_DIALOG_UPDATE:
 213                 flag.setEnabled(true);
 214                 return true;
 215
 216         default:
 217                 return InsetCollapsable::getStatus(cur, cmd, flag);
 218         }
 219 }
 220
 221
 222 void InsetNote::addToToc(DocIterator const & cpit)
 223 {
 224         DocIterator pit = cpit;
 225         pit.push_back(CursorSlice(*this));
 226
 227         Toc & toc = buffer().tocBackend().toc("note");
 228         docstring str;
 229         str = notetranslator_loc().find(params_.type) + from_ascii(": ")
 230                 + text().getPar(0).asString();
 231         toc.push_back(TocItem(pit, 0, str, toolTipText()));
 232         // Proceed with the rest of the inset.
 233         InsetCollapsable::addToToc(cpit);
 234 }
 235
 236
 237 bool InsetNote::isMacroScope() const
 238 {
 239         // LyX note has no latex output
 240         if (params_.type == InsetNoteParams::Note)
 241                 return true;
 242
 243         return InsetCollapsable::isMacroScope();
 244 }
 245
 246
 247 int InsetNote::latex(odocstream & os, OutputParams const & runparams_in) const
 248 {
 249         if (params_.type == InsetNoteParams::Note)
 250                 return 0;
 251
 252         OutputParams runparams(runparams_in);
 253         if (params_.type == InsetNoteParams::Comment) {
 254                 runparams.inComment = true;
 255                 // Ignore files that are exported inside a comment
 256                 runparams.exportdata.reset(new ExportData);
 257         }
 258
 259         odocstringstream ss;
 260         InsetCollapsable::latex(ss, runparams);
 261         // the space after the comment in 'a[comment] b' will be eaten by the
 262         // comment environment since the space before b is ignored with the
 263         // following latex output:
 264         //
 265         // a%
 266         // \begin{comment}
 267         // comment
 268         // \end{comment}
 269         //  b
 270         //
 271         // Adding {} before ' b' fixes this.
 272         if (params_.type == InsetNoteParams::Comment)
 273                 ss << "{}";
 274
 275         docstring const str = ss.str();
 276         os << str;
 277         runparams_in.encoding = runparams.encoding;
 278         // Return how many newlines we issued.
 279         return int(count(str.begin(), str.end(), '\n'));
 280 }
 281
 282
 283 int InsetNote::plaintext(odocstream & os,
 284                          OutputParams const & runparams_in) const
 285 {
 286         if (params_.type == InsetNoteParams::Note)
 287                 return 0;
 288
 289         OutputParams runparams(runparams_in);
 290         if (params_.type == InsetNoteParams::Comment) {
 291                 runparams.inComment = true;
 292                 // Ignore files that are exported inside a comment
 293                 runparams.exportdata.reset(new ExportData);
 294         }
 295         os << '[' << buffer().B_("note") << ":\n";
 296         InsetText::plaintext(os, runparams);
 297         os << "\n]";
 298
 299         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 300 }
 301
 302
 303 int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
 304 {
 305         if (params_.type == InsetNoteParams::Note)
 306                 return 0;
 307
 308         OutputParams runparams(runparams_in);
 309         if (params_.type == InsetNoteParams::Comment) {
 310                 os << "<remark>\n";
 311                 runparams.inComment = true;
 312                 // Ignore files that are exported inside a comment
 313                 runparams.exportdata.reset(new ExportData);
 314         }
 315
 316         int const n = InsetText::docbook(os, runparams);
 317
 318         if (params_.type == InsetNoteParams::Comment)
 319                 os << "\n</remark>\n";
 320
 321         // Return how many newlines we issued.
 322         //return int(count(str.begin(), str.end(), '\n'));
 323         return n + 1 + 2;
 324 }
 325
 326
 327 docstring InsetNote::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 328 {
 329         if (params_.type == InsetNoteParams::Note)
 330                 return docstring();
 331
 332         return InsetCollapsable::xhtml(xs, rp);
 333 }
 334
 335
 336 void InsetNote::validate(LaTeXFeatures & features) const
 337 {
 338         switch (params_.type) {
 339         case InsetNoteParams::Comment:
 340                 features.require("verbatim");
 341                 break;
 342         case InsetNoteParams::Greyedout:
 343                 features.require("color");
 344                 features.require("lyxgreyedout");
 345                 InsetCollapsable::validate(features);
 346                 break;
 347         case InsetNoteParams::Note:
 348                 break;
 349         }
 350 }
 351
 352
 353 docstring InsetNote::contextMenu(BufferView const &, int, int) const
 354 {
 355         return from_ascii("context-note");
 356 }
 357
 358 bool InsetNote::allowSpellCheck() const
 359 {
 360         return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
 361 }
 362
 363
 364 string InsetNote::params2string(InsetNoteParams const & params)
 365 {
 366         ostringstream data;
 367         data << "note" << ' ';
 368         params.write(data);
 369         return data.str();
 370 }
 371
 372
 373 void InsetNote::string2params(string const & in, InsetNoteParams & params)
 374 {
 375         params = InsetNoteParams();
 376
 377         if (in.empty())
 378                 return;
 379
 380         istringstream data(in);
 381         Lexer lex;
 382         lex.setStream(data);
 383         lex.setContext("InsetNote::string2params");
 384         lex >> "note";
 385         // There are cases, such as when we are called via getStatus() from
 386         // Dialog::canApply(), where we are just called with "note" rather
 387         // than a full "note Note TYPE".
 388         if (!lex.isOK())
 389                 return;
 390         lex >> "Note";
 391
 392         params.read(lex);
 393 }
 394
 395
 396 } // namespace lyx