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 "ColorSet.h"
  22 #include "Counters.h"
  23 #include "Cursor.h"
  24 #include "DispatchResult.h"
  25 #include "Exporter.h"
  26 #include "FuncRequest.h"
  27 #include "FuncStatus.h"
  28 #include "InsetIterator.h"
  29 #include "LaTeXFeatures.h"
  30 #include "Lexer.h"
  31 #include "LyXRC.h"
  32 #include "OutputParams.h"
  33 #include "ParIterator.h"
  34 #include "TextClass.h"
  35 #include "TocBackend.h"
  36
  37 #include "support/debug.h"
  38 #include "support/docstream.h"
  39 #include "support/gettext.h"
  40 #include "support/lstrings.h"
  41 #include "support/Translator.h"
  42
  43 #include "frontends/Application.h"
  44
  45 #include <algorithm>
  46 #include <sstream>
  47
  48 using namespace std;
  49
  50 namespace lyx {
  51
  52 namespace {
  53
  54 typedef Translator<string, InsetNoteParams::Type> NoteTranslator;
  55
  56 NoteTranslator const init_notetranslator()
  57 {
  58         NoteTranslator translator("Note", InsetNoteParams::Note);
  59         translator.addPair("Comment", InsetNoteParams::Comment);
  60         translator.addPair("Greyedout", InsetNoteParams::Greyedout);
  61         return translator;
  62 }
  63
  64
  65 NoteTranslator const & notetranslator()
  66 {
  67         static NoteTranslator const translator = init_notetranslator();
  68         return translator;
  69 }
  70
  71
  72 } // anon
  73
  74
  75 InsetNoteParams::InsetNoteParams()
  76         : type(Note)
  77 {}
  78
  79
  80 void InsetNoteParams::write(ostream & os) const
  81 {
  82         string const label = notetranslator().find(type);
  83         os << "Note " << label << "\n";
  84 }
  85
  86
  87 void InsetNoteParams::read(Lexer & lex)
  88 {
  89         string label;
  90         lex >> label;
  91         if (lex)
  92                 type = notetranslator().find(label);
  93 }
  94
  95
  96 /////////////////////////////////////////////////////////////////////
  97 //
  98 // InsetNote
  99 //
 100 /////////////////////////////////////////////////////////////////////
 101
 102 InsetNote::InsetNote(Buffer * buf, string const & label)
 103         : InsetCollapsable(buf)
 104 {
 105         params_.type = notetranslator().find(label);
 106 }
 107
 108
 109 InsetNote::~InsetNote()
 110 {
 111         hideDialogs("note", this);
 112 }
 113
 114
 115 docstring InsetNote::layoutName() const
 116 {
 117         return from_ascii("Note:" + notetranslator().find(params_.type));
 118 }
 119
 120
 121 Inset::DisplayType InsetNote::display() const
 122 {
 123         return Inline;
 124 }
 125
 126
 127 void InsetNote::write(ostream & os) const
 128 {
 129         params_.write(os);
 130         InsetCollapsable::write(os);
 131 }
 132
 133
 134 void InsetNote::read(Lexer & lex)
 135 {
 136         params_.read(lex);
 137         InsetCollapsable::read(lex);
 138 }
 139
 140
 141 bool InsetNote::showInsetDialog(BufferView * bv) const
 142 {
 143         bv->showDialog("note", params2string(params()),
 144                 const_cast<InsetNote *>(this));
 145         return true;
 146 }
 147
 148
 149 void InsetNote::doDispatch(Cursor & cur, FuncRequest & cmd)
 150 {
 151         switch (cmd.action()) {
 152
 153         case LFUN_INSET_MODIFY: {
 154                 // Do not do anything if converting to the same type of Note.
 155                 // A quick break here is done instead of disabling the LFUN
 156                 // because disabling the LFUN would lead to a greyed out
 157                 // entry, which might confuse users.
 158                 // In the future, we might want to have a radio button for
 159                 // switching between notes.
 160                 InsetNoteParams params;
 161                 string2params(to_utf8(cmd.argument()), params);
 162                 if (params_.type == params.type)
 163                   break;
 164
 165                 cur.recordUndoInset(this);
 166                 string2params(to_utf8(cmd.argument()), params_);
 167                 setButtonLabel();
 168                 // what we really want here is a TOC update, but that means
 169                 // a full buffer update
 170                 cur.forceBufferUpdate();
 171                 break;
 172         }
 173
 174         case LFUN_INSET_DIALOG_UPDATE:
 175                 cur.bv().updateDialog("note", params2string(params()));
 176                 break;
 177
 178         default:
 179                 InsetCollapsable::doDispatch(cur, cmd);
 180                 break;
 181         }
 182 }
 183
 184
 185 bool InsetNote::getStatus(Cursor & cur, FuncRequest const & cmd,
 186                 FuncStatus & flag) const
 187 {
 188         switch (cmd.action()) {
 189
 190         case LFUN_INSET_MODIFY:
 191                 // disallow comment and greyed out in commands
 192                 flag.setEnabled(!cur.paragraph().layout().isCommand() ||
 193                                 cmd.getArg(2) == "Note");
 194                 if (cmd.getArg(0) == "note") {
 195                         InsetNoteParams params;
 196                         string2params(to_utf8(cmd.argument()), params);
 197                         flag.setOnOff(params_.type == params.type);
 198                 }
 199                 return true;
 200
 201         case LFUN_INSET_DIALOG_UPDATE:
 202                 flag.setEnabled(true);
 203                 return true;
 204
 205         default:
 206                 return InsetCollapsable::getStatus(cur, cmd, flag);
 207         }
 208 }
 209
 210
 211 void InsetNote::addToToc(DocIterator const & cpit, bool output_active,
 212                                                  UpdateType utype) const
 213 {
 214         DocIterator pit = cpit;
 215         pit.push_back(CursorSlice(const_cast<InsetNote &>(*this)));
 216
 217         InsetLayout const & il = getLayout();
 218         docstring str;
 219         text().forOutliner(str, TOC_ENTRY_LENGTH);
 220         str = translateIfPossible(il.labelstring()) + ": " + str;
 221
 222         shared_ptr<Toc> toc = buffer().tocBackend().toc("note");
 223         toc->push_back(TocItem(pit, 0, str, output_active));
 224
 225         // Proceed with the rest of the inset.
 226         bool doing_output = output_active && producesOutput();
 227         InsetCollapsable::addToToc(cpit, doing_output, utype);
 228 }
 229
 230
 231 bool InsetNote::isMacroScope() const
 232 {
 233         // LyX note has no latex output
 234         if (params_.type == InsetNoteParams::Note)
 235                 return true;
 236
 237         return InsetCollapsable::isMacroScope();
 238 }
 239
 240
 241 void InsetNote::latex(otexstream & os, OutputParams const & runparams_in) const
 242 {
 243         if (params_.type == InsetNoteParams::Note)
 244                 return;
 245
 246         OutputParams runparams(runparams_in);
 247         if (params_.type == InsetNoteParams::Comment) {
 248                 runparams.inComment = true;
 249                 // Ignore files that are exported inside a comment
 250                 runparams.exportdata.reset(new ExportData);
 251         }
 252
 253         // the space after the comment in 'a[comment] b' will be eaten by the
 254         // comment environment since the space before b is ignored with the
 255         // following latex output:
 256         //
 257         // a%
 258         // \begin{comment}
 259         // comment
 260         // \end{comment}
 261         //  b
 262         //
 263         // Adding {} before ' b' fixes this.
 264         // The {} will be automatically added, but only if needed, for all
 265         // insets whose InsetLayout Display tag is false. This is achieved
 266         // by telling otexstream to protect an immediately following space
 267         // and is done for both comment and greyedout insets.
 268         InsetCollapsable::latex(os, runparams);
 269
 270         runparams_in.encoding = runparams.encoding;
 271 }
 272
 273
 274 int InsetNote::plaintext(odocstringstream & os,
 275                          OutputParams const & runparams_in, size_t max_length) 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         os << '[' << buffer().B_("note") << ":\n";
 287         InsetText::plaintext(os, runparams, max_length);
 288         os << "\n]";
 289
 290         return PLAINTEXT_NEWLINE + 1; // one char on a separate line
 291 }
 292
 293
 294 int InsetNote::docbook(odocstream & os, OutputParams const & runparams_in) const
 295 {
 296         if (params_.type == InsetNoteParams::Note)
 297                 return 0;
 298
 299         OutputParams runparams(runparams_in);
 300         if (params_.type == InsetNoteParams::Comment) {
 301                 os << "<remark>\n";
 302                 runparams.inComment = true;
 303                 // Ignore files that are exported inside a comment
 304                 runparams.exportdata.reset(new ExportData);
 305         }
 306
 307         int const n = InsetText::docbook(os, runparams);
 308
 309         if (params_.type == InsetNoteParams::Comment)
 310                 os << "\n</remark>\n";
 311
 312         // Return how many newlines we issued.
 313         //return int(count(str.begin(), str.end(), '\n'));
 314         return n + 1 + 2;
 315 }
 316
 317
 318 docstring InsetNote::xhtml(XHTMLStream & xs, OutputParams const & rp) const
 319 {
 320         if (params_.type == InsetNoteParams::Note)
 321                 return docstring();
 322
 323         return InsetCollapsable::xhtml(xs, rp);
 324 }
 325
 326
 327 void InsetNote::validate(LaTeXFeatures & features) const
 328 {
 329         switch (params_.type) {
 330         case InsetNoteParams::Comment:
 331                 features.require("verbatim");
 332                 if (features.runparams().flavor == OutputParams::HTML)
 333                         // we do output this but set display to "none" by default,
 334                         // but people might want to use it.
 335                         InsetCollapsable::validate(features);
 336                 break;
 337         case InsetNoteParams::Greyedout:
 338                 features.require("color");
 339                 features.require("lyxgreyedout");
 340                 InsetCollapsable::validate(features);
 341                 break;
 342         case InsetNoteParams::Note:
 343                 break;
 344         }
 345 }
 346
 347
 348 string InsetNote::contextMenuName() const
 349 {
 350         return "context-note";
 351 }
 352
 353 bool InsetNote::allowSpellCheck() const
 354 {
 355         return (params_.type == InsetNoteParams::Greyedout || lyxrc.spellcheck_notes);
 356 }
 357
 358 FontInfo InsetNote::getFont() const
 359 {
 360         FontInfo font = getLayout().font();
 361         // FIXME: This hardcoded color is a hack!
 362         if (params_.type == InsetNoteParams::Greyedout
 363             && buffer().params().notefontcolor != lyx::rgbFromHexName("#cccccc")) {
 364                 ColorCode c = lcolor.getFromLyXName("notefontcolor");
 365                 if (c != Color_none)
 366                         font.setColor(c);
 367         }
 368         return font;
 369 }
 370
 371
 372 string InsetNote::params2string(InsetNoteParams const & params)
 373 {
 374         ostringstream data;
 375         data << "note" << ' ';
 376         params.write(data);
 377         return data.str();
 378 }
 379
 380
 381 void InsetNote::string2params(string const & in, InsetNoteParams & params)
 382 {
 383         params = InsetNoteParams();
 384
 385         if (in.empty())
 386                 return;
 387
 388         istringstream data(in);
 389         Lexer lex;
 390         lex.setStream(data);
 391         lex.setContext("InsetNote::string2params");
 392         lex >> "note";
 393         // There are cases, such as when we are called via getStatus() from
 394         // Dialog::canApply(), where we are just called with "note" rather
 395         // than a full "note Note TYPE".
 396         if (!lex.isOK())
 397                 return;
 398         lex >> "Note";
 399
 400         params.read(lex);
 401 }
 402
 403
 404 } // namespace lyx