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