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 ADC_DISPLAY_OUT_NODE_HXX 29*cdf0e10cSrcweir #define ADC_DISPLAY_OUT_NODE_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir namespace output 35*cdf0e10cSrcweir { 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir /** @resp 39*cdf0e10cSrcweir Represents a tree of names where each node can have only one parent, 40*cdf0e10cSrcweir but a list of children. 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir @see Position 43*cdf0e10cSrcweir @see Tree 44*cdf0e10cSrcweir */ 45*cdf0e10cSrcweir class Node 46*cdf0e10cSrcweir { 47*cdf0e10cSrcweir public: 48*cdf0e10cSrcweir typedef std::vector< Node* > List; 49*cdf0e10cSrcweir typedef UINT32 relative_id; 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir // LIFECYCLE 52*cdf0e10cSrcweir enum E_NullObject { null_object }; 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir Node(); 55*cdf0e10cSrcweir explicit Node( 56*cdf0e10cSrcweir E_NullObject ); 57*cdf0e10cSrcweir ~Node(); 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir // OPERATORS 60*cdf0e10cSrcweir bool operator==( 61*cdf0e10cSrcweir const Node & i_node ) const 62*cdf0e10cSrcweir { return pParent == i_node.pParent AND sName == i_node.sName; } 63*cdf0e10cSrcweir bool operator!=( 64*cdf0e10cSrcweir const Node & i_node ) const 65*cdf0e10cSrcweir { return NOT operator==(i_node); } 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir // OPERATIONS 68*cdf0e10cSrcweir /// Seek, and if not existent, create. 69*cdf0e10cSrcweir Node & Provide_Child( 70*cdf0e10cSrcweir const String & i_name ); 71*cdf0e10cSrcweir /// Seek, and if not existent, create. 72*cdf0e10cSrcweir Node & Provide_Child( 73*cdf0e10cSrcweir const StringVector & 74*cdf0e10cSrcweir i_path ) 75*cdf0e10cSrcweir { return provide_Child(i_path.begin(), i_path.end()); } 76*cdf0e10cSrcweir // INQUIRY 77*cdf0e10cSrcweir intt Depth() const { return nDepth; } 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir const String & Name() const { return sName; } 80*cdf0e10cSrcweir /// @return Id of a namespace or class etc. this directory represents. 81*cdf0e10cSrcweir relative_id RelatedNameRoom() const { return nNameRoomId; } 82*cdf0e10cSrcweir /// @return No delimiter at start, with delimiter at end. 83*cdf0e10cSrcweir void Get_Path( 84*cdf0e10cSrcweir StreamStr & o_result, 85*cdf0e10cSrcweir intt i_maxDepth = -1 ) const; 86*cdf0e10cSrcweir void Get_Chain( 87*cdf0e10cSrcweir StringVector & o_result, 88*cdf0e10cSrcweir intt i_maxDepth = -1 ) const; 89*cdf0e10cSrcweir // ACCESS 90*cdf0e10cSrcweir void Set_RelatedNameRoom( 91*cdf0e10cSrcweir relative_id i_nNameRoomId ) 92*cdf0e10cSrcweir { nNameRoomId = i_nNameRoomId; } 93*cdf0e10cSrcweir Node * Parent() { return pParent; } 94*cdf0e10cSrcweir Node * Child( 95*cdf0e10cSrcweir const String & i_name ) 96*cdf0e10cSrcweir { return find_Child(i_name); } 97*cdf0e10cSrcweir List & Children() { return aChildren; } 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir /// @return a reference to a Node with Depth() == -1. 100*cdf0e10cSrcweir static Node & Null_(); 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir private: 103*cdf0e10cSrcweir // Local 104*cdf0e10cSrcweir Node( 105*cdf0e10cSrcweir const String & i_name, 106*cdf0e10cSrcweir Node & i_parent ); 107*cdf0e10cSrcweir 108*cdf0e10cSrcweir Node * find_Child( 109*cdf0e10cSrcweir const String & i_name ); 110*cdf0e10cSrcweir Node & add_Child( 111*cdf0e10cSrcweir const String & i_name ); 112*cdf0e10cSrcweir Node & provide_Child( 113*cdf0e10cSrcweir StringVector::const_iterator 114*cdf0e10cSrcweir i_next, 115*cdf0e10cSrcweir StringVector::const_iterator 116*cdf0e10cSrcweir i_end ); 117*cdf0e10cSrcweir // Data 118*cdf0e10cSrcweir String sName; 119*cdf0e10cSrcweir Node * pParent; 120*cdf0e10cSrcweir List aChildren; 121*cdf0e10cSrcweir intt nDepth; 122*cdf0e10cSrcweir relative_id nNameRoomId; 123*cdf0e10cSrcweir }; 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir } // namespace output 129*cdf0e10cSrcweir #endif 130