1*1c78a5d6SAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*1c78a5d6SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*1c78a5d6SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*1c78a5d6SAndrew Rist * distributed with this work for additional information 6*1c78a5d6SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*1c78a5d6SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*1c78a5d6SAndrew Rist * "License"); you may not use this file except in compliance 9*1c78a5d6SAndrew Rist * with the License. You may obtain a copy of the License at 10*1c78a5d6SAndrew Rist * 11*1c78a5d6SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*1c78a5d6SAndrew Rist * 13*1c78a5d6SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*1c78a5d6SAndrew Rist * software distributed under the License is distributed on an 15*1c78a5d6SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*1c78a5d6SAndrew Rist * KIND, either express or implied. See the License for the 17*1c78a5d6SAndrew Rist * specific language governing permissions and limitations 18*1c78a5d6SAndrew Rist * under the License. 19*1c78a5d6SAndrew Rist * 20*1c78a5d6SAndrew Rist *************************************************************/ 21*1c78a5d6SAndrew Rist 22*1c78a5d6SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef ARY_DOC_D_NODE_HXX 25cdf0e10cSrcweir #define ARY_DOC_D_NODE_HXX 26cdf0e10cSrcweir 27cdf0e10cSrcweir // BASE CLASSES 28cdf0e10cSrcweir #include <cosv/tpl/processor.hxx> 29cdf0e10cSrcweir // USED SERVICES 30cdf0e10cSrcweir #include <cosv/tpl/vvector.hxx> 31cdf0e10cSrcweir #include <ary/doc/d_types4doc.hxx> 32cdf0e10cSrcweir 33cdf0e10cSrcweir 34cdf0e10cSrcweir 35cdf0e10cSrcweir 36cdf0e10cSrcweir namespace ary 37cdf0e10cSrcweir { 38cdf0e10cSrcweir namespace doc 39cdf0e10cSrcweir { 40cdf0e10cSrcweir 41cdf0e10cSrcweir 42cdf0e10cSrcweir /** The abstract base class for any type of documentation content. 43cdf0e10cSrcweir 44cdf0e10cSrcweir A ->Documentation has as content a hierarchy of Nodes, each can be a 45cdf0e10cSrcweir different kind of content, like descriptions of single items or structs 46cdf0e10cSrcweir or lists of Nodes. 47cdf0e10cSrcweir */ 48cdf0e10cSrcweir class Node : public csv::ConstProcessorClient 49cdf0e10cSrcweir { 50cdf0e10cSrcweir public: 51cdf0e10cSrcweir // LIFECYCLE 52cdf0e10cSrcweir virtual ~Node(); 53cdf0e10cSrcweir 54cdf0e10cSrcweir // OPERATIONS 55cdf0e10cSrcweir void Add_toChain( 56cdf0e10cSrcweir DYN Node & pass_nextNode ); 57cdf0e10cSrcweir // INQUIRY 58cdf0e10cSrcweir nodetype::id Type() const; 59cdf0e10cSrcweir const Node * Next() const; 60cdf0e10cSrcweir bool IsSingle() const; 61cdf0e10cSrcweir uintt ListSize() const; 62cdf0e10cSrcweir 63cdf0e10cSrcweir protected: 64cdf0e10cSrcweir explicit Node( 65cdf0e10cSrcweir nodetype::id i_type); 66cdf0e10cSrcweir private: 67cdf0e10cSrcweir // Forbid copies: 68cdf0e10cSrcweir Node(const Node&); 69cdf0e10cSrcweir Node & operator=(const Node&); 70cdf0e10cSrcweir 71cdf0e10cSrcweir // DATA 72cdf0e10cSrcweir nodetype::id nType; 73cdf0e10cSrcweir Dyn<Node> pNext; /// Next ->Node in same list. 74cdf0e10cSrcweir }; 75cdf0e10cSrcweir 76cdf0e10cSrcweir typedef csv::VirtualVector<Node> NodeList; 77cdf0e10cSrcweir 78cdf0e10cSrcweir 79cdf0e10cSrcweir 80cdf0e10cSrcweir 81cdf0e10cSrcweir // IMPLEMENTATION 82cdf0e10cSrcweir inline nodetype::id Type() const83cdf0e10cSrcweirNode::Type() const 84cdf0e10cSrcweir { 85cdf0e10cSrcweir return nType; 86cdf0e10cSrcweir } 87cdf0e10cSrcweir 88cdf0e10cSrcweir inline const Node * Next() const89cdf0e10cSrcweirNode::Next() const 90cdf0e10cSrcweir { 91cdf0e10cSrcweir return pNext.Ptr(); 92cdf0e10cSrcweir } 93cdf0e10cSrcweir 94cdf0e10cSrcweir inline bool IsSingle() const95cdf0e10cSrcweirNode::IsSingle() const 96cdf0e10cSrcweir { 97cdf0e10cSrcweir return pNext.operator bool(); 98cdf0e10cSrcweir } 99cdf0e10cSrcweir 100cdf0e10cSrcweir 101cdf0e10cSrcweir 102cdf0e10cSrcweir 103cdf0e10cSrcweir } // namespace doc 104cdf0e10cSrcweir } // namespace ary 105cdf0e10cSrcweir #endif 106