configmgr/source/api2/apinodeaccess.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: apinodeaccess.hxx,v $
  10  * $Revision: 1.13 $
  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_API_NODEACCESS_HXX_
  32 #define CONFIGMGR_API_NODEACCESS_HXX_
  33
  34 #include "sal/config.h"
  35
  36 #include "boost/utility.hpp"
  37
  38 #include "datalock.hxx"
  39 #include "utility.hxx"
  40 #include "noderef.hxx"
  41
  42 namespace osl { class Mutex; }
  43
  44 namespace configmgr
  45 {
  46     namespace configuration
  47     {
  48         class AnyNodeRef;
  49         class NodeRef;
  50         class Tree;
  51     }
  52     namespace configapi
  53     {
  54         class Factory;
  55         class Notifier;
  56         class SetElement;
  57
  58         class ApiTreeImpl;
  59
  60         namespace uno = com::sun::star::uno;
  61
  62         // API object implementation wrappers
  63         // these objects just provide the pieces needed to navigate and manipulate trees and nodes
  64
  65         // The common part of all nodes, provides all you need to read and listen
  66         class NodeAccess : private boost::noncopyable
  67         {
  68         public:
  69             virtual ~NodeAccess();
  70
  71         // model access
  72             configuration::NodeRef      getNodeRef() const;
  73             rtl::Reference< configuration::Tree > getTreeRef() const;
  74             rtl::Reference< configuration::Tree > getTree() const;
  75
  76         // self-locked methods for dispose handling
  77             void checkAlive() const;
  78             void disposeNode();
  79
  80         // api object handling
  81             uno::XInterface*                    getUnoInstance() const
  82             { return doGetUnoInstance(); }
  83             Factory&                            getFactory() const;
  84             Notifier                            getNotifier() const;
  85
  86         protected:
  87             virtual configuration::NodeRef      doGetNode() const = 0;
  88             virtual uno::XInterface*    doGetUnoInstance() const = 0;
  89             virtual ApiTreeImpl&        getApiTree() const = 0;
  90         };
  91
  92         /** builds a Uno <type scope='com::sun::star::uno'>Any</type> representing node <var>aNode</var>.
  93             <p> Uses the <type scope='configmgr::configapi'>Factory</type> provided
  94                 to create service implementations wrapping inner nodes</p>
  95             <p> returns VOID if <var>aNode</var> is empty.</p>
  96         */
  97         uno::Any        makeElement(configapi::Factory& rFactory, rtl::Reference< configuration::Tree > const& aTree, configuration::AnyNodeRef const& aNode);
  98
  99         /** builds a Uno <type scope='com::sun::star::uno'>Any</type> representing inner node <var>aNode</var>.
 100             <p> Uses the <type scope='configmgr::configapi'>Factory</type> provided
 101                 to create service implementations wrapping inner nodes</p>
 102             <p> returns VOID if <var>aNode</var> is empty.</p>
 103         */
 104         uno::Any        makeInnerElement(configapi::Factory& rFactory, rtl::Reference< configuration::Tree > const& aTree, configuration::NodeRef const& aNode);
 105
 106         /** builds a Uno <type scope='com::sun::star::uno'>Any</type> representing set element <var>aElement</var>.
 107             <p> Uses the <type scope='configmgr::configapi'>Factory</type> provided
 108                 to create service implementations wrapping inner nodes</p>
 109             <p> returns VOID if <var>aNode</var> is empty.</p>
 110         */
 111         uno::Any        makeElement(configapi::Factory& rFactory, rtl::Reference< configuration::ElementTree > const& aTree);
 112
 113
 114         // Info interfaces for Group Nodes
 115         class NodeGroupInfoAccess : public NodeAccess
 116         {
 117         public:
 118             // currently only used for tagging group nodes
 119         };
 120
 121         // Info interfaces for Set Nodes
 122         class NodeSetInfoAccess : public NodeAccess
 123         {
 124             friend class SetElement;
 125         public:
 126             rtl::Reference< configuration::Template > getElementInfo() const;
 127         };
 128
 129         /** extracts a <type scope='configmgr::configuration'>ElementTree</type> from a <type scope='com::sun::star::uno'>Any</type>
 130             which must contain an object which wraps an instance of the template available in <var>aTemplate</var>.
 131             <p> Uses the <type scope='configmgr::configapi'>Factory</type> provided
 132                 to resolve inner nodes (which may suppose that the object was created using the same factory)</p>
 133             <p> returns an empty tree if <var>aElement</var> is empty.</p>
 134             <p> May throw exceptions if the type doesn't match the template.</p>
 135         */
 136         rtl::Reference< configuration::ElementTree > extractElementTree(Factory& rFactory, uno::Any const& aElement, rtl::Reference< configuration::Template > const& aTemplate );
 137
 138         /// wraps a NodeAccess; provides both object and provider (read) locks,
 139         // ensures object was not disposed
 140         template <class Access>
 141         class GuardedNodeData
 142         {
 143             UnoApiLock              m_aLock;
 144             Access & m_rNode;
 145         public:
 146             GuardedNodeData(Access& rNode);
 147         public:
 148             Access&     get()            const { return m_rNode; }
 149
 150             rtl::Reference< configuration::Tree > getTree() const;
 151             configuration::NodeRef  getNode() const;
 152         };
 153
 154         template <class Access>
 155         GuardedNodeData<Access>::GuardedNodeData(Access& rNode)
 156         : m_rNode(rNode)
 157         {
 158             rNode.checkAlive();
 159         }
 160
 161         template <class Access>
 162         rtl::Reference< configuration::Tree > GuardedNodeData<Access>::getTree() const
 163         {
 164             return m_rNode.getTree();
 165         }
 166
 167         template <class Access>
 168         configuration::NodeRef GuardedNodeData<Access>::getNode() const
 169         {
 170             return m_rNode.getNodeRef();
 171         }
 172     }
 173 }
 174
 175 #endif // CONFIGMGR_API_NODEACCESS_HXX_