inc/Article.h

   1 //! \file Article.h
   2
   3 #ifndef WIKIWALKER_ARTICLE_H
   4 #define WIKIWALKER_ARTICLE_H
   5
   6 #include <memory>
   7 #include <string>
   8 #include <utility>
   9 #include <vector>
  10
  11 namespace WikiWalker
  12 {
  13   /*!
  14    * represents a Wikipedia (Mediawiki) article and its links
  15    */
  16   class Article
  17   {
  18   public:
  19     //! representation of single link to other articles
  20     using link = std::weak_ptr<const Article>;
  21     //! representation of collection of links to other articles
  22     using link_collection = std::vector<link>;
  23     //! representation of iterator over links
  24     using ArticleLinkIterator = link_collection::iterator;
  25     //! representation of const iterator over links
  26     using ArticleLinkConstIterator = link_collection::const_iterator;
  27
  28     /*! Create a new article from a title
  29      * \param articleTitle The title of the article
  30      */
  31     explicit Article(std::string articleTitle)
  32         : title_(std::move(articleTitle)), analyzed_(false), marked_(false)
  33     {
  34     }
  35
  36     /*! Get the title of the article
  37      * \return title of the article
  38      */
  39     std::string title() const
  40     {
  41       return title_;
  42     }
  43
  44     /*! get the number of links the article has.
  45      * This throws an exception if state has not been set to anaylzed.
  46      * \return number of links the article has.
  47      * This also includes links to articles that are nullptr / already deleted
  48      * by the smart pointers.
  49      *
  50      * \see analyzed(bool)
  51      * \see addLink
  52      */
  53     size_t countLinks() const;
  54
  55     /*! Add a link to another article.
  56      * \param[in] article Pointer to the article this article links
  57      * to
  58      * \returns Whether adding woth successful. Returns false if
  59      * instance / pointer is already included.
  60      *
  61      * Automatically sets state to analyzed
  62      * \see analyzed() const
  63      * \see analyzed(bool)
  64      */
  65     bool addLink(link article);
  66
  67     /*! Set article to be analyzed.
  68      * State is automatically set by #addLink, but if
  69      * article has no outgoing links, this must be called,
  70      * otherwise #numLinks will throw an exception
  71      * \param analyzed whether article has been analyzed
  72      * \see addLink
  73      */
  74     void analyzed(bool analyzed);
  75
  76     /*! Get state if article was analyzed (for out links).
  77      * \returns whether article was analyzed for outgoing links
  78      */
  79     bool analyzed() const;
  80
  81     /*! Set article to be marked.
  82      * Some kind of "marking" for output usage. May be start point,
  83      * may be end point, may be point of special interest.
  84      * \param marked whether article is marked
  85      */
  86     void marked(bool marked);
  87
  88     /*! Get state whether article was marked.
  89      * \returns Whether article is marked.
  90      */
  91     bool marked() const;
  92
  93     /*! Get const_iterator to first linked article
  94      * \returns const iterator to beginning of linked articles
  95      */
  96     ArticleLinkConstIterator linkBegin() const;
  97
  98     /*! Get const_iterator to last linked article
  99      * \returns const iterator to end of linked articles (behind last one)
 100      */
 101     ArticleLinkConstIterator linkEnd() const;
 102
 103   private:
 104     std::string title_;
 105     link_collection links_;
 106     bool analyzed_;
 107     bool marked_;
 108   };
 109 }  // namespace WikiWalker
 110 #endif  // WIKIWALKER_ARTICLE_H