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  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "TocBackend.h"
  16
  17 #include "Buffer.h"
  18 #include "BufferParams.h"
  19 #include "FloatList.h"
  20 #include "FuncRequest.h"
  21 #include "InsetList.h"
  22 #include "Layout.h"
  23 #include "LyXAction.h"
  24 #include "Paragraph.h"
  25 #include "ParIterator.h"
  26 #include "TextClass.h"
  27
  28 #include "insets/InsetOptArg.h"
  29
  30 #include "support/convert.h"
  31 #include "support/debug.h"
  32 #include "support/docstream.h"
  33
  34 #include "support/lassert.h"
  35
  36 using namespace std;
  37
  38
  39 namespace lyx {
  40
  41 ///////////////////////////////////////////////////////////////////////////
  42 //
  43 // TocItem implementation
  44 //
  45 ///////////////////////////////////////////////////////////////////////////
  46
  47 TocItem::TocItem(DocIterator const & dit, int d, docstring const & s)
  48         : dit_(dit), depth_(d), str_(s)
  49 {
  50 }
  51
  52
  53 int TocItem::id() const
  54 {
  55         return dit_.paragraph().id();
  56 }
  57
  58
  59 int TocItem::depth() const
  60 {
  61         return depth_;
  62 }
  63
  64
  65 docstring const & TocItem::str() const
  66 {
  67         return str_;
  68 }
  69
  70
  71 docstring const TocItem::asString() const
  72 {
  73         return docstring(4 * depth_, ' ') + str_;
  74 }
  75
  76
  77 DocIterator const & TocItem::dit() const
  78 {
  79         return dit_;
  80 }
  81
  82
  83 FuncRequest TocItem::action() const
  84 {
  85         string const arg = convert<string>(dit_.paragraph().id())
  86                 + ' ' + convert<string>(dit_.pos());
  87         return FuncRequest(LFUN_PARAGRAPH_GOTO, arg);
  88 }
  89
  90
  91 ///////////////////////////////////////////////////////////////////////////
  92 //
  93 // TocBackend implementation
  94 //
  95 ///////////////////////////////////////////////////////////////////////////
  96
  97 Toc const & TocBackend::toc(string const & type) const
  98 {
  99         // Is the type already supported?
 100         TocList::const_iterator it = tocs_.find(type);
 101         LASSERT(it != tocs_.end(), /**/);
 102
 103         return it->second;
 104 }
 105
 106
 107 Toc & TocBackend::toc(string const & type)
 108 {
 109         return tocs_[type];
 110 }
 111
 112
 113 bool TocBackend::updateItem(DocIterator const & dit)
 114 {
 115         if (dit.paragraph().layout().toclevel == Layout::NOT_IN_TOC)
 116                 return false;
 117
 118         if (toc("tableofcontents").empty()) {
 119                 // FIXME: should not happen,
 120                 // a call to TocBackend::update() is missing somewhere
 121                 LYXERR0("TocBackend::updateItem called but the TOC is empty!");
 122                 return false;
 123         }
 124
 125         BufferParams const & bufparams = buffer_->params();
 126         const int min_toclevel = bufparams.documentClass().min_toclevel();
 127
 128         TocIterator toc_item = item("tableofcontents", dit);
 129
 130         docstring tocstring;
 131
 132         // For each paragraph, traverse its insets and let them add
 133         // their toc items
 134         Paragraph & par = toc_item->dit_.paragraph();
 135         InsetList::const_iterator it = par.insetList().begin();
 136         InsetList::const_iterator end = par.insetList().end();
 137         for (; it != end; ++it) {
 138                 Inset & inset = *it->inset;
 139                 if (inset.lyxCode() == OPTARG_CODE) {
 140                         if (!tocstring.empty())
 141                                 break;
 142                         Paragraph const & inset_par =
 143                                 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
 144                         if (!par.labelString().empty())
 145                                 tocstring = par.labelString() + ' ';
 146                         tocstring += inset_par.asString(AS_STR_INSETS);
 147                         break;
 148                 }
 149         }
 150
 151         int const toclevel = par.layout().toclevel;
 152         if (toclevel != Layout::NOT_IN_TOC && toclevel >= min_toclevel
 153                 && tocstring.empty())
 154                         tocstring = par.asString(AS_STR_LABEL | AS_STR_INSETS);
 155
 156         const_cast<TocItem &>(*toc_item).str_ = tocstring;
 157
 158         buffer_->updateTocItem("tableofcontents", dit);
 159         return true;
 160 }
 161
 162
 163 void TocBackend::update()
 164 {
 165         tocs_.clear();
 166         if (! buffer_->isInternal()) {
 167                 DocIterator dit;
 168                 buffer_->inset().addToToc(dit);
 169         }
 170 }
 171
 172
 173 TocIterator TocBackend::item(string const & type,
 174                 DocIterator const & dit) const
 175 {
 176         TocList::const_iterator toclist_it = tocs_.find(type);
 177         // Is the type supported?
 178         LASSERT(toclist_it != tocs_.end(), /**/);
 179         return toclist_it->second.item(dit);
 180 }
 181
 182
 183 TocIterator Toc::item(DocIterator const & dit) const
 184 {
 185         TocIterator last = begin();
 186         TocIterator it = end();
 187         if (it == last)
 188                 return it;
 189
 190         --it;
 191
 192         DocIterator dit_text = dit;
 193         if (dit_text.inMathed()) {
 194                 // We are only interested in text so remove the math CursorSlice.
 195                 while (dit_text.inMathed())
 196                         dit_text.pop_back();
 197         }
 198
 199         for (; it != last; --it) {
 200                 // We verify that we don't compare contents of two
 201                 // different document. This happens when you
 202                 // have parent and child documents.
 203                 if (&it->dit_[0].inset() != &dit_text[0].inset())
 204                         continue;
 205                 if (it->dit_ <= dit_text)
 206                         return it;
 207         }
 208
 209         // We are before the first Toc Item:
 210         return last;
 211 }
 212
 213
 214 Toc::iterator Toc::item(int depth, docstring const & str)
 215 {
 216         if (empty())
 217                 return end();
 218         iterator it = begin();
 219         iterator itend = end();
 220         for (; it != itend; ++it) {
 221                 if (it->depth() == depth && it->str() == str)
 222                         break;
 223         }
 224         return it;
 225 }
 226
 227
 228 void TocBackend::writePlaintextTocList(string const & type, odocstream & os) const
 229 {
 230         TocList::const_iterator cit = tocs_.find(type);
 231         if (cit != tocs_.end()) {
 232                 TocIterator ccit = cit->second.begin();
 233                 TocIterator end = cit->second.end();
 234                 for (; ccit != end; ++ccit)
 235                         os << ccit->asString() << from_utf8("\n");
 236         }
 237 }
 238
 239
 240 } // namespace lyx