autodoc/inc/ary/doc/d_node.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: d_node.hxx,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef ARY_DOC_D_NODE_HXX
  32 #define ARY_DOC_D_NODE_HXX
  33
  34 // BASE CLASSES
  35 #include <cosv/tpl/processor.hxx>
  36 // USED SERVICES
  37 #include <cosv/tpl/vvector.hxx>
  38 #include <ary/doc/d_types4doc.hxx>
  39
  40
  41
  42
  43 namespace ary
  44 {
  45 namespace doc
  46 {
  47
  48
  49 /** The abstract base class for any type of documentation content.
  50
  51     A ->Documentation has as content a hierarchy of Nodes, each can be a
  52     different kind of content, like descriptions of single items or structs
  53     or lists of Nodes.
  54 */
  55 class Node : public csv::ConstProcessorClient
  56 {
  57   public:
  58     // LIFECYCLE
  59     virtual                             ~Node();
  60
  61     // OPERATIONS
  62     void                Add_toChain(
  63                             DYN Node &          pass_nextNode );
  64     // INQUIRY
  65     nodetype::id        Type() const;
  66     const Node *        Next() const;
  67     bool                IsSingle() const;
  68     uintt               ListSize() const;
  69
  70   protected:
  71     explicit            Node(
  72                             nodetype::id        i_type);
  73   private:
  74     // Forbid copies:
  75     Node(const Node&);
  76     Node & operator=(const Node&);
  77
  78     // DATA
  79     nodetype::id        nType;
  80     Dyn<Node>           pNext;      /// Next ->Node in same list.
  81 };
  82
  83 typedef csv::VirtualVector<Node>    NodeList;
  84
  85
  86
  87
  88 // IMPLEMENTATION
  89 inline nodetype::id
  90 Node::Type() const
  91 {
  92     return nType;
  93 }
  94
  95 inline const Node *
  96 Node::Next() const
  97 {
  98     return pNext.Ptr();
  99 }
 100
 101 inline bool
 102 Node::IsSingle() const
 103 {
 104     return pNext.operator bool();
 105 }
 106
 107
 108
 109
 110 }   // namespace doc
 111 }   // namespace ary
 112 #endif