configmgr/source/treemgr/viewnode.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: viewnode.hxx,v $
  10  * $Revision: 1.6 $
  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 CONFIGMGR_VIEWNODE_HXX_
  32 #define CONFIGMGR_VIEWNODE_HXX_
  33
  34 #include "tree.hxx"
  35
  36 namespace configmgr
  37 {
  38 //-----------------------------------------------------------------------------
  39     namespace configuration
  40     {
  41         struct ElementTreeData;
  42     }
  43     namespace sharable { struct GroupNode; }
  44 //-----------------------------------------------------------------------------
  45     namespace view
  46     {
  47     //-------------------------------------------------------------------------
  48         struct Node
  49         {
  50             Node(configuration::Tree * _tree, configuration::NodeData* _addr)
  51             : m_tree(_tree), m_addr(_addr)
  52             {}
  53
  54             Node(configuration::Tree * _tree, unsigned int _offs)
  55                 : m_tree(_tree), m_addr( _tree->nodeData(_offs))
  56             {}
  57
  58             bool is() const { return m_addr != 0; }
  59
  60             Node getParent() const;
  61
  62             bool isSetNode()    const { return is() && data().isSetNode(); }
  63             bool isGroupNode()  const { return is() && data().isGroupNode(); }
  64             bool isValueNode()  const { return is() && data().isValueElementNode(); }
  65
  66         // low-level access
  67 //            configuration::NodeImpl * operator->() const { return &data().nodeImpl(); }
  68
  69             configuration::NodeData& data() const { return *m_addr; }
  70
  71             configuration::NodeImpl * get_impl() const
  72             { return is() ? &data().nodeImpl() : NULL; }
  73
  74             unsigned int get_offset() const
  75             { return is() ? m_tree->nodeOffset( this->data() ) : 0; }
  76
  77             configuration::Tree * tree() const   // has a tree
  78             { return m_tree; }
  79
  80             sharable::Node * getAccessRef() const;   // has a Node
  81
  82         private:
  83             configuration::Tree *        m_tree;   // has a Tree + Accessor
  84             configuration::NodeData*   m_addr;       // has a configuration::NodeImpl *
  85         };
  86     //-------------------------------------------------------------------------
  87         struct ValueNode        // has/is a Node
  88         {
  89             Node m_node;
  90
  91             explicit
  92             ValueNode(Node const& _node)
  93             : m_node(_node)
  94             {}
  95
  96             bool is() const { return m_node.isValueNode(); }
  97
  98         // low-level access
  99  //           configuration::ValueElementNodeImpl* operator->() const { return &m_node.data().valueElementImpl(); }
 100
 101             configuration::ValueElementNodeImpl* get_impl() const
 102             { return is() ? &m_node.data().valueElementImpl() : NULL; }
 103
 104             Node node() const   // has a Node
 105             { return m_node; }
 106
 107             configuration::Tree * tree() const   // has a tree
 108             { return m_node.tree(); }
 109         };
 110     //-------------------------------------------------------------------------
 111         struct GroupNode        // has/is a Node
 112         {
 113             Node m_node;
 114
 115             explicit
 116             GroupNode(Node const& _node)
 117             : m_node(_node)
 118             {}
 119
 120             bool is() const { return m_node.isGroupNode(); }
 121
 122             Node findChild(rtl::OUString const& _aName) const;
 123             Node getFirstChild() const;
 124             Node getNextChild(Node const& _aAfterNode) const;
 125
 126 //            configuration::GroupNodeImpl* operator->() const { return &m_node.data().groupImpl(); }
 127
 128             configuration::GroupNodeImpl* get_impl() const
 129             { return is() ? &m_node.data().groupImpl() : NULL; }
 130
 131             Node node() const   // has a Node
 132             { return m_node; }
 133
 134             configuration::Tree * tree() const   // has a tree
 135             { return m_node.tree(); }
 136
 137             sharable::GroupNode * getAccess() const;   // has a GroupNode
 138         };
 139     //-------------------------------------------------------------------------
 140         struct SetNode          // has/is a Node
 141         {
 142             Node m_node;
 143
 144             explicit
 145             SetNode(Node const& _node)
 146             : m_node(_node)
 147             {}
 148
 149             bool is() const { return m_node.isSetNode(); }
 150
 151    //         configuration::SetNodeImpl* operator->() const  { return &m_node.data().setImpl(); }
 152
 153             configuration::SetNodeImpl* get_impl() const
 154             { return is() ? &m_node.data().setImpl() : 0; }
 155
 156             Node node() const   // has a Node
 157             { return m_node; }
 158
 159             configuration::Tree * tree() const   // has a tree
 160             { return m_node.tree(); }
 161
 162             sharable::SetNode * getAccess() const;   // has a SetNode
 163         };
 164     //-------------------------------------------------------------------------
 165         inline
 166         Node getRootNode(configuration::Tree * _aTree)
 167         {
 168             return Node(_aTree,_aTree->nodeData(configuration::Tree::ROOT));
 169         }
 170
 171     //-------------------------------------------------------------------------
 172         inline
 173         rtl::OUString getSimpleRootName(configuration::Tree * _aTree)
 174         {
 175             return _aTree->getSimpleRootName();
 176         }
 177
 178     //-------------------------------------------------------------------------
 179         inline
 180         bool isValidNode(Node const & _aNode)
 181         {
 182             configuration::Tree* pTreeData = _aNode.tree();
 183             return pTreeData->isValidNode(_aNode.get_offset());
 184         }
 185
 186     //-------------------------------------------------------------------------
 187         inline
 188         rtl::OUString getSimpleNodeName(Node const & _aNode)
 189         {
 190             configuration::Tree* pTreeData = _aNode.tree();
 191             return pTreeData->getSimpleNodeName(_aNode.get_offset());
 192         }
 193
 194     //-------------------------------------------------------------------------
 195         extern
 196         rtl::Reference< view::ViewStrategy > getViewBehavior(configuration::Tree * _aTree);
 197     //-------------------------------------------------------------------------
 198     }
 199 //-----------------------------------------------------------------------------
 200 }
 201 //-----------------------------------------------------------------------------
 202
 203 #endif // CONFIGMGR_VIEWNODE_HXX_