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 "LyXAction.h"
  22 #include "Paragraph.h"
  23 #include "debug.h"
  24
  25 #include "insets/InsetOptArg.h"
  26
  27 #include "support/convert.h"
  28
  29
  30 namespace lyx {
  31
  32 using std::vector;
  33 using std::string;
  34
  35
  36 ///////////////////////////////////////////////////////////////////////////
  37 // TocItem implementation
  38
  39 TocItem::TocItem(ParConstIterator const & par_it, int d,
  40                 docstring const & s)
  41                 : par_it_(par_it), depth_(d), str_(s)
  42 {
  43 /*
  44         if (!uid_.empty())
  45                 return;
  46
  47         size_t pos = s.find(" ");
  48         if (pos == string::npos) {
  49                 // Non labelled item
  50                 uid_ = s;
  51                 return;
  52         }
  53
  54         string s2 = s.substr(0, pos);
  55
  56         if (s2 == "Chapter" || s2 == "Part") {
  57                 size_t pos2 = s.find(" ", pos + 1);
  58                 if (pos2 == string::npos) {
  59                         // Unnumbered Chapter?? This should not happen.
  60                         uid_ = s.substr(pos + 1);
  61                         return;
  62                 }
  63                 // Chapter or Part
  64                 uid_ = s.substr(pos2 + 1);
  65                 return;
  66         }
  67         // Numbered Item.
  68         uid_ = s.substr(pos + 1);
  69         */
  70 }
  71
  72 bool const TocItem::isValid() const
  73 {
  74         return depth_ != -1;
  75 }
  76
  77
  78 int const TocItem::id() const
  79 {
  80         return par_it_->id();
  81 }
  82
  83
  84 int const TocItem::depth() const
  85 {
  86         return depth_;
  87 }
  88
  89
  90 docstring const & TocItem::str() const
  91 {
  92         return str_;
  93 }
  94
  95
  96 docstring const TocItem::asString() const
  97 {
  98         return docstring(4 * depth_, ' ') + str_;
  99 }
 100
 101
 102 FuncRequest TocItem::action() const
 103 {
 104         return FuncRequest(LFUN_PARAGRAPH_GOTO, convert<string>(id()));
 105 }
 106
 107
 108
 109
 110
 111 ///////////////////////////////////////////////////////////////////////////
 112 // TocBackend implementation
 113
 114 Toc const & TocBackend::toc(std::string const & type) const
 115 {
 116         // Is the type already supported?
 117         TocList::const_iterator it = tocs_.find(type);
 118         BOOST_ASSERT(it != tocs_.end());
 119
 120         return it->second;
 121 }
 122
 123
 124 void TocBackend::updateItem(ParConstIterator const & par_it)
 125 {
 126         if (toc("tableofcontents").empty()) {
 127                 // TODO should not happen,
 128                 // a call to TocBackend::update() is missing somewhere
 129                 LYXERR(Debug::INFO)
 130                                 << "TocBackend.cpp: TocBackend::updateItem"
 131                                 << "called but the TOC is empty" << std::endl;
 132                 return;
 133         }
 134
 135         BufferParams const & bufparams = buffer_->params();
 136         const int min_toclevel = bufparams.getTextClass().min_toclevel();
 137
 138         TocIterator toc_item = item("tableofcontents", par_it);
 139
 140         docstring tocstring;
 141
 142         // For each paragraph, traverse its insets and let them add
 143         // their toc items
 144         InsetList::const_iterator it = toc_item->par_it_->insetlist.begin();
 145         InsetList::const_iterator end = toc_item->par_it_->insetlist.end();
 146         for (; it != end; ++it) {
 147                 Inset & inset = *it->inset;
 148                 if (inset.lyxCode() == Inset::OPTARG_CODE) {
 149                         if (!tocstring.empty())
 150                                 break;
 151                         Paragraph const & par =
 152                                 *static_cast<InsetOptArg&>(inset).paragraphs().begin();
 153                         if (!toc_item->par_it_->getLabelstring().empty())
 154                                 tocstring = toc_item->par_it_->getLabelstring() + ' ';
 155                         tocstring += par.asString(*buffer_, false);
 156                         break;
 157                 }
 158         }
 159
 160         int const toclevel = toc_item->par_it_->layout()->toclevel;
 161         if (toclevel != Layout::NOT_IN_TOC
 162             && toclevel >= min_toclevel
 163                 && tocstring.empty())
 164                         tocstring = toc_item->par_it_->asString(*buffer_, true);
 165
 166         const_cast<TocItem &>(*toc_item).str_ = tocstring;
 167 }
 168
 169
 170 void TocBackend::update()
 171 {
 172         tocs_.clear();
 173
 174         BufferParams const & bufparams = buffer_->params();
 175         const int min_toclevel = bufparams.getTextClass().min_toclevel();
 176
 177         Toc & toc = tocs_["tableofcontents"];
 178         ParConstIterator pit = buffer_->par_iterator_begin();
 179         ParConstIterator end = buffer_->par_iterator_end();
 180         for (; pit != end; ++pit) {
 181
 182                 // the string that goes to the toc (could be the optarg)
 183                 docstring tocstring;
 184
 185                 // For each paragraph, traverse its insets and let them add
 186                 // their toc items
 187                 InsetList::const_iterator it = pit->insetlist.begin();
 188                 InsetList::const_iterator end = pit->insetlist.end();
 189                 for (; it != end; ++it) {
 190                         Inset & inset = *it->inset;
 191                         inset.addToToc(tocs_, *buffer_);
 192                         switch (inset.lyxCode()) {
 193                         case Inset::OPTARG_CODE: {
 194                                 if (!tocstring.empty())
 195                                         break;
 196                                 Paragraph const & par =
 197                                         *static_cast<InsetOptArg&>(inset).paragraphs().begin();
 198                                 if (!pit->getLabelstring().empty())
 199                                         tocstring = pit->getLabelstring() + ' ';
 200                                 tocstring += par.asString(*buffer_, false);
 201                                 break;
 202                         }
 203                         default:
 204                                 break;
 205                         }
 206                 }
 207
 208                 /// now the toc entry for the paragraph
 209                 int const toclevel = pit->layout()->toclevel;
 210                 if (toclevel != Layout::NOT_IN_TOC
 211                     && toclevel >= min_toclevel) {
 212                         // insert this into the table of contents
 213                         if (tocstring.empty())
 214                                 tocstring = pit->asString(*buffer_, true);
 215                         toc.push_back(
 216                                 TocItem(pit, toclevel - min_toclevel, tocstring));
 217                 }
 218         }
 219 }
 220
 221
 222 TocIterator const TocBackend::item(
 223         std::string const & type, ParConstIterator const & par_it) const
 224 {
 225         TocList::const_iterator toclist_it = tocs_.find(type);
 226         // Is the type supported?
 227         BOOST_ASSERT(toclist_it != tocs_.end());
 228
 229         Toc const & toc_vector = toclist_it->second;
 230         TocIterator last = toc_vector.begin();
 231         TocIterator it = toc_vector.end();
 232         if (it == last)
 233                 return it;
 234
 235         --it;
 236
 237         ParConstIterator par_it_text = par_it;
 238         if (par_it_text.inMathed())
 239                 // It would be better to do
 240                 //   par_it_text.backwardInset();
 241                 // but this method does not exist.
 242                 while (par_it_text.inMathed())
 243                         par_it_text.backwardPos();
 244
 245         for (; it != last; --it)
 246                 if (it->par_it_ <= par_it_text)
 247                         return it;
 248
 249         // We are before the first Toc Item:
 250         return last;
 251 }
 252
 253
 254 void TocBackend::writePlaintextTocList(string const & type, odocstream & os) const
 255 {
 256         TocList::const_iterator cit = tocs_.find(type);
 257         if (cit != tocs_.end()) {
 258                 TocIterator ccit = cit->second.begin();
 259                 TocIterator end = cit->second.end();
 260                 for (; ccit != end; ++ccit)
 261                         os << ccit->asString() << '\n';
 262         }
 263 }
 264
 265
 266 } // namespace lyx