QhpSectionTree Class Reference

Collaboration diagram for QhpSectionTree:

Classes
struct	Node

Public Member Functions
void	addSection (const QCString &title, const QCString &ref)
void	incLevel ()
void	decLevel ()
void	writeToc (TextStream &t) const

Private Member Functions
void	traverse (const Node &root, TextStream &t, int indent) const

Private Attributes
Node	m_root
Node *	m_current = &m_root

Detailed Description

Definition at line 45 of file qhp.cpp.

Member Function Documentation

addSection()

void QhpSectionTree::addSection ( const QCString & title, const QCString & ref )

inline

Definition at line 123 of file qhp.cpp.

    {
      m_current->children.push_back(std::make_unique<Node>(m_current,title,ref));
    }

References m_current.

decLevel()

void QhpSectionTree::decLevel ( )

inline

Definition at line 133 of file qhp.cpp.

    {
      assert(m_current->parent!=nullptr);
      if (m_current->parent)
      {
        m_current = m_current->parent;
      }
    }

References m_current.

incLevel()

void QhpSectionTree::incLevel ( )

inline

Definition at line 127 of file qhp.cpp.

    {
      auto newNode = new Node(m_current);
      m_current->children.push_back(std::unique_ptr<Node>(newNode));
      m_current = newNode;
    }

References m_current.

traverse()

void QhpSectionTree::traverse ( const Node & root, TextStream & t, int indent ) const

inlineprivate

Definition at line 68 of file qhp.cpp.

    {
      /* Input:          Output:
       * =================================================
       * Section1        <section title=".." ref="..">
       * Dir1
       *   Section2         <section title=".." ref="..">
       *   Dir2
       *     Section3          <section title=".." ref=".."/>
       *                    </section>
       *                 </section>
       * Section4        <section title=".." ref="..>
       * Dir3
       *   Dir4
       *     Section5       <section title=.." ref=.."/>
       *                 </section>
       * Section6        <section title=".." ref=".."/>
       */
      size_t numChildren = root.children.size();
      size_t i=0;
      while (i<numChildren)
      {
        if (root.children[i]->type==Node::Type::Section)
        {
          i++;
          if (i<numChildren && root.children[i]->type==Node::Type::Dir)
          {
            // we have a dir node
            writeIndent(t,indent);
            t << "<section title=\"" << convertToXML(root.children[i-1]->title) << "\""
              <<         " ref=\""   << convertToXML(root.children[i-1]->ref)   << "\">\n";
            while (i<numChildren && root.children[i]->type==Node::Type::Dir)
            {
              traverse(*root.children[i].get(),t,indent+1);
              i++;
            }
            writeIndent(t,indent);
            t << "</section>\n";
          }
          else // we have a leaf section node
          {
            writeIndent(t,indent);
            t << "<section title=\"" << convertToXML(root.children[i-1]->title) << "\""
              <<           " ref=\"" << convertToXML(root.children[i-1]->ref)   << "\"/>\n";
          }
        }
        else // dir without preceding section (no extra indent)
        {
          traverse(*root.children[i].get(),t,indent);
          i++;
        }
      }
    }

References QhpSectionTree::Node::children, convertToXML(), QhpSectionTree::Node::Dir, QhpSectionTree::Node::Section, traverse(), and writeIndent().

Referenced by traverse(), and writeToc().

writeToc()

void QhpSectionTree::writeToc ( TextStream & t ) const

inline

Definition at line 141 of file qhp.cpp.

    {
      writeIndent(t,2);
      t << "<toc>\n";
      traverse(m_root,t,3);
      writeIndent(t,2);
      t << "</toc>\n";
    }

References m_root, traverse(), and writeIndent().

Member Data Documentation

m_current

Node* QhpSectionTree::m_current = &m_root

private

Definition at line 66 of file qhp.cpp.

Referenced by addSection(), decLevel(), and incLevel().

m_root

Node QhpSectionTree::m_root

private

Definition at line 65 of file qhp.cpp.

Referenced by writeToc().

---

The documentation for this class was generated from the following file:

• src/qhp.cpp