autodoc/inc/ary/doc/d_node.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef ARY_DOC_D_NODE_HXX
  21 #define ARY_DOC_D_NODE_HXX
  22
  23 // BASE CLASSES
  24 #include <cosv/tpl/processor.hxx>
  25 // USED SERVICES
  26 #include <cosv/tpl/vvector.hxx>
  27 #include <ary/doc/d_types4doc.hxx>
  28
  29
  30
  31
  32 namespace ary
  33 {
  34 namespace doc
  35 {
  36
  37
  38 /** The abstract base class for any type of documentation content.
  39
  40     A ->Documentation has as content a hierarchy of Nodes, each can be a
  41     different kind of content, like descriptions of single items or structs
  42     or lists of Nodes.
  43 */
  44 class Node : public csv::ConstProcessorClient
  45 {
  46   public:
  47     // LIFECYCLE
  48     virtual             ~Node();
  49
  50     // OPERATIONS
  51     void                Add_toChain(
  52                             DYN Node &          pass_nextNode );
  53     // INQUIRY
  54     nodetype::id        Type() const;
  55     const Node *        Next() const;
  56     bool                IsSingle() const;
  57     uintt               ListSize() const;
  58
  59   protected:
  60     explicit            Node(
  61                             nodetype::id        i_type);
  62   private:
  63     // Forbid copies:
  64     Node(const Node&);
  65     Node & operator=(const Node&);
  66
  67     // DATA
  68     nodetype::id        nType;
  69     Dyn<Node>           pNext;      /// Next ->Node in same list.
  70 };
  71
  72 typedef csv::VirtualVector<Node>    NodeList;
  73
  74
  75
  76
  77 // IMPLEMENTATION
  78 inline nodetype::id
  79 Node::Type() const
  80 {
  81     return nType;
  82 }
  83
  84 inline const Node *
  85 Node::Next() const
  86 {
  87     return pNext.Ptr();
  88 }
  89
  90 inline bool
  91 Node::IsSingle() const
  92 {
  93     return pNext.operator bool();
  94 }
  95
  96
  97
  98
  99 }   // namespace doc
 100 }   // namespace ary
 101 #endif
 102
 103 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */