src/TocBackend.cpp

   1 /**
   2  * \file TocBackend.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Jean-Marc Lasgouttes
   7  * \author Angus Leeming
   8  * \author Abdelrazak Younes
   9  * \author Guillaume Munch
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #include <config.h>
  15
  16 #include "TocBackend.h"
  17
  18 #include "Buffer.h"
  19 #include "BufferParams.h"
  20 #include "Cursor.h"
  21 #include "FloatList.h"
  22 #include "FuncRequest.h"
  23 #include "InsetList.h"
  24 #include "Layout.h"
  25 #include "LyXAction.h"
  26 #include "Paragraph.h"
  27 #include "ParIterator.h"
  28 #include "TextClass.h"
  29
  30 #include "insets/InsetArgument.h"
  31
  32 #include "support/convert.h"
  33 #include "support/debug.h"
  34 #include "support/docstream.h"
  35 #include "support/gettext.h"
  36 #include "support/lassert.h"
  37 #include "support/lstrings.h"
  38
  39 using namespace std;
  40
  41
  42 namespace lyx {
  43
  44
  45 ///////////////////////////////////////////////////////////////////////////
  46 //
  47 // TocItem implementation
  48 //
  49 ///////////////////////////////////////////////////////////////////////////
  50
  51 TocItem::TocItem(DocIterator const & dit, int d, docstring const & s,
  52                  bool output_active, docstring const & t, FuncRequest action)
  53         : dit_(dit), depth_(d), str_(s), tooltip_(t), output_(output_active),
  54           action_(action)
  55 {
  56 }
  57
  58
  59 int TocItem::id() const
  60 {
  61         return dit_.paragraph().id();
  62 }
  63
  64
  65 docstring const & TocItem::tooltip() const
  66 {
  67         return tooltip_.empty() ? str_ : tooltip_;
  68 }
  69
  70
  71 docstring const TocItem::asString() const
  72 {
  73         static char_type const cross = 0x2716; // ✖ U+2716 HEAVY MULTIPLICATION X
  74         static char_type const thin = 0x2009; // U+2009 THIN SPACE
  75         docstring prefix;
  76         if (!output_) {
  77                 prefix += cross;
  78                 prefix += thin;
  79         }
  80         return prefix + str_;
  81 }
  82
  83 namespace {
  84
  85 // convert a DocIterator into an argument to LFUN_PARAGRAPH_GOTO
  86 docstring paragraph_goto_arg(DocIterator const & dit)
  87 {
  88         CursorSlice const & s = dit.innerTextSlice();
  89         return convert<docstring>(s.paragraph().id()) + ' ' +
  90                 convert<docstring>(s.pos());
  91 }
  92
  93 } // namespace anon
  94
  95 FuncRequest TocItem::action() const
  96 {
  97         if (action_.action() == LFUN_UNKNOWN_ACTION) {
  98                 return FuncRequest(LFUN_PARAGRAPH_GOTO, paragraph_goto_arg(dit_));
  99         } else
 100                 return action_;
 101 }
 102
 103
 104 ///////////////////////////////////////////////////////////////////////////
 105 //
 106 // Toc implementation
 107 //
 108 ///////////////////////////////////////////////////////////////////////////
 109
 110 Toc::const_iterator TocBackend::findItem(Toc const & toc,
 111                                          DocIterator const & dit)
 112 {
 113         Toc::const_iterator last = toc.begin();
 114         Toc::const_iterator it = toc.end();
 115         if (it == last)
 116                 return it;
 117         --it;
 118         DocIterator dit_text = dit.getInnerText();
 119
 120         for (; it != last; --it) {
 121                 // We verify that we don't compare contents of two
 122                 // different document. This happens when you
 123                 // have parent and child documents.
 124                 if (&it->dit_[0].inset() != &dit_text[0].inset())
 125                         continue;
 126                 if (it->dit_ <= dit_text)
 127                         return it;
 128         }
 129
 130         // We are before the first Toc Item:
 131         return last;
 132 }
 133
 134
 135 Toc::iterator TocBackend::findItem(Toc & toc, int depth, docstring const & str)
 136 {
 137         if (toc.empty())
 138                 return toc.end();
 139         Toc::iterator it = toc.begin();
 140         Toc::iterator itend = toc.end();
 141         for (; it != itend; ++it) {
 142                 if (it->depth() == depth && it->str() == str)
 143                         break;
 144         }
 145         return it;
 146 }
 147
 148
 149 ///////////////////////////////////////////////////////////////////////////
 150 //
 151 // TocBuilder implementation
 152 //
 153 ///////////////////////////////////////////////////////////////////////////
 154
 155 TocBuilder::TocBuilder(shared_ptr<Toc> toc)
 156         : toc_(toc ? toc : make_shared<Toc>()),
 157           stack_()
 158 {
 159         LATTEST(toc);
 160 }
 161
 162 void TocBuilder::pushItem(DocIterator const & dit, docstring const & s,
 163                           bool output_active, bool is_captioned)
 164 {
 165         toc_->push_back(TocItem(dit, stack_.size(), s, output_active));
 166         frame f = {
 167                 toc_->size() - 1, //pos
 168                 is_captioned, //is_captioned
 169         };
 170         stack_.push(f);
 171 }
 172
 173 void TocBuilder::captionItem(DocIterator const & dit, docstring const & s,
 174                              bool output_active)
 175 {
 176         // first show the float before moving to the caption
 177         docstring arg = "paragraph-goto " + paragraph_goto_arg(dit);
 178         if (!stack_.empty())
 179                 arg = "paragraph-goto " +
 180                         paragraph_goto_arg((*toc_)[stack_.top().pos].dit_) + ";" + arg;
 181         FuncRequest func(LFUN_COMMAND_SEQUENCE, arg);
 182
 183         if (!stack_.empty() && !stack_.top().is_captioned) {
 184                 // The float we entered has not yet been assigned a caption.
 185                 // Assign the caption string to it.
 186                 TocItem & captionable = (*toc_)[stack_.top().pos];
 187                 captionable.str(s);
 188                 captionable.setAction(func);
 189                 stack_.top().is_captioned = true;
 190         } else {
 191                 // This is a new entry.
 192                 pop();
 193                 // the dit is at the float's level, e.g. for the contextual menu of
 194                 // outliner entries
 195                 DocIterator captionable_dit = dit;
 196                 captionable_dit.pop_back();
 197                 pushItem(captionable_dit, s, output_active, true);
 198                 (*toc_)[stack_.top().pos].setAction(func);
 199         }
 200 }
 201
 202 void TocBuilder::pop()
 203 {
 204         if (!stack_.empty())
 205                 stack_.pop();
 206 }
 207
 208
 209
 210 ///////////////////////////////////////////////////////////////////////////
 211 //
 212 // TocBackend implementation
 213 //
 214 ///////////////////////////////////////////////////////////////////////////
 215
 216 shared_ptr<Toc const> TocBackend::toc(string const & type) const
 217 {
 218         // Is the type already supported?
 219         TocList::const_iterator it = tocs_.find(type);
 220         LASSERT(it != tocs_.end(), { return make_shared<Toc>(); });
 221         return it->second;
 222 }
 223
 224
 225 shared_ptr<Toc> TocBackend::toc(string const & type)
 226 {
 227         // std::map::insert only really performs the insertion if the key is not
 228         // already bound, and otherwise returns an iterator to the element already
 229         // there, see manual.
 230         return tocs_.insert({type, make_shared<Toc>()}).first->second;
 231 }
 232
 233
 234 TocBuilder & TocBackend::builder(string const & type)
 235 {
 236         auto p = make_unique<TocBuilder>(toc(type));
 237         return * builders_.insert(make_pair(type, move(p))).first->second;
 238 }
 239
 240
 241 // FIXME: This function duplicates functionality from InsetText::iterateForToc.
 242 // Both have their own way of computing the TocItem for "tableofcontents". The
 243 // TocItem creation and update should be made in a dedicated function and
 244 // updateItem should be rewritten to uniformly update the matching items from
 245 // all TOCs.
 246 bool TocBackend::updateItem(DocIterator const & dit_in)
 247 {
 248         // we need a text
 249         DocIterator dit = dit_in.getInnerText();
 250
 251         if (dit.text()->getTocLevel(dit.pit()) == Layout::NOT_IN_TOC)
 252                 return false;
 253
 254         if (toc("tableofcontents")->empty()) {
 255                 // FIXME: should not happen,
 256                 // a call to TocBackend::update() is missing somewhere
 257                 LYXERR0("TocBackend::updateItem called but the TOC is empty!");
 258                 return false;
 259         }
 260
 261         BufferParams const & bufparams = buffer_->params();
 262         const int min_toclevel = bufparams.documentClass().min_toclevel();
 263
 264         Toc::const_iterator toc_item = item("tableofcontents", dit);
 265
 266         docstring tocstring;
 267
 268         // For each paragraph, traverse its insets and let them add
 269         // their toc items
 270         //
 271         // FIXME: This is supposed to accomplish the same as the body of
 272         // InsetText::iterateForToc(), probably
 273         Paragraph & par = toc_item->dit_.paragraph();
 274         InsetList::const_iterator it = par.insetList().begin();
 275         InsetList::const_iterator end = par.insetList().end();
 276         for (; it != end; ++it) {
 277                 Inset & inset = *it->inset;
 278                 if (inset.lyxCode() == ARG_CODE) {
 279                         tocstring = par.labelString();
 280                         if (!tocstring.empty())
 281                                 tocstring += ' ';
 282                         inset.asInsetText()->text().forOutliner(tocstring,TOC_ENTRY_LENGTH);
 283                         break;
 284                 }
 285         }
 286
 287         int const toclevel = toc_item->dit_.text()->
 288                 getTocLevel(toc_item->dit_.pit());
 289         if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel
 290                 && tocstring.empty())
 291                 par.forOutliner(tocstring, TOC_ENTRY_LENGTH);
 292
 293         support::truncateWithEllipsis(tocstring, TOC_ENTRY_LENGTH);
 294         const_cast<TocItem &>(*toc_item).str(tocstring);
 295
 296         buffer_->updateTocItem("tableofcontents", dit);
 297         return true;
 298 }
 299
 300
 301 void TocBackend::update(bool output_active, UpdateType utype)
 302 {
 303         for (TocList::iterator it = tocs_.begin(); it != tocs_.end(); ++it)
 304                 it->second->clear();
 305         tocs_.clear();
 306         builders_.clear();
 307         if (!buffer_->isInternal()) {
 308                 DocIterator dit;
 309                 buffer_->inset().addToToc(dit, output_active, utype);
 310         }
 311 }
 312
 313
 314 Toc::const_iterator TocBackend::item(string const & type,
 315                                      DocIterator const & dit) const
 316 {
 317         TocList::const_iterator toclist_it = tocs_.find(type);
 318         // Is the type supported?
 319         // We will try to make the best of it in release mode
 320         LASSERT(toclist_it != tocs_.end(), toclist_it = tocs_.begin());
 321         return findItem(*toclist_it->second, dit);
 322 }
 323
 324
 325 void TocBackend::writePlaintextTocList(string const & type,
 326         odocstringstream & os, size_t max_length) const
 327 {
 328         TocList::const_iterator cit = tocs_.find(type);
 329         if (cit != tocs_.end()) {
 330                 Toc::const_iterator ccit = cit->second->begin();
 331                 Toc::const_iterator end = cit->second->end();
 332                 for (; ccit != end; ++ccit) {
 333                         os << ccit->asString() << from_utf8("\n");
 334                         if (os.str().size() > max_length)
 335                                 break;
 336                 }
 337         }
 338 }
 339
 340
 341 docstring TocBackend::outlinerName(string const & type) const
 342 {
 343         return translateIfPossible(
 344             buffer_->params().documentClass().outlinerName(type));
 345 }
 346
 347
 348 } // namespace lyx