confignode.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef INCLUDED_UNOTOOLS_CONFIGNODE_HXX
#define INCLUDED_UNOTOOLS_CONFIGNODE_HXX
 
#include <unotools/unotoolsdllapi.h>
#include <unotools/eventlisteneradapter.hxx>
 
namespace com::sun::star::container { class XHierarchicalNameAccess; }
namespace com::sun::star::container { class XNameAccess; }
namespace com::sun::star::container { class XNameContainer; }
namespace com::sun::star::container { class XNameReplace; }
namespace com::sun::star::lang { class XMultiServiceFactory; }
namespace com::sun::star::uno { class XComponentContext; }
namespace com::sun::star::util { class XChangesBatch; }
 
namespace utl
{
 
    class UNOTOOLS_DLLPUBLIC OConfigurationNode : public ::utl::OEventListenerAdapter
    {
    private:
        css::uno::Reference< css::container::XHierarchicalNameAccess >
                    m_xHierarchyAccess;     
        css::uno::Reference< css::container::XNameAccess >
                    m_xDirectAccess;        
        css::uno::Reference< css::container::XNameReplace >
                    m_xReplaceAccess;       
        css::uno::Reference< css::container::XNameContainer >
                    m_xContainerAccess;     
        bool        m_bEscapeNames;         
 
        OConfigurationNode  insertNode(const OUString& _rName,const css::uno::Reference< css::uno::XInterface >& _xNode) const noexcept;
 
    protected:
        OConfigurationNode(
            const css::uno::Reference< css::uno::XInterface >& _rxNode
        );
 
        const css::uno::Reference< css::container::XNameAccess >&
            getUNONode() const { return m_xDirectAccess; }
 
    public:
        OConfigurationNode() :m_bEscapeNames(false) { }
        OConfigurationNode(const OConfigurationNode& _rSource);
        OConfigurationNode(OConfigurationNode&& _rSource);
 
        OConfigurationNode& operator=(const OConfigurationNode& _rSource);
        OConfigurationNode& operator=(OConfigurationNode&& _rSource);
 
        OUString     getLocalName() const;
 
        OConfigurationNode  openNode(const OUString& _rPath) const noexcept;
 
        OConfigurationNode  openNode( const char* _pAsciiPath ) const
        {
            return openNode( OUString::createFromAscii( _pAsciiPath ) );
        }
 
        OConfigurationNode  createNode(const OUString& _rName) const noexcept;
 
        bool            removeNode(const OUString& _rName) const noexcept;
 
        css::uno::Any       getNodeValue(const OUString& _rPath) const noexcept;
 
        css::uno::Any       getNodeValue( const char* _pAsciiPath ) const
        {
            return getNodeValue( OUString::createFromAscii( _pAsciiPath ) );
        }
 
        bool            setNodeValue(const OUString& _rPath, const css::uno::Any& _rValue) const noexcept;
 
        bool            setNodeValue( const char* _pAsciiPath, const css::uno::Any& _rValue ) const
        {
            return setNodeValue( OUString::createFromAscii( _pAsciiPath ), _rValue );
        }
 
        css::uno::Sequence< OUString >
                            getNodeNames() const noexcept;
 
        virtual void clear() noexcept;
 
        // meta information about the node
 
        bool isSetNode() const;
 
        bool hasByName(const OUString& _rName) const noexcept;
 
        bool hasByHierarchicalName( const OUString& _rName ) const noexcept;
 
        bool isValid() const { return m_xHierarchyAccess.is(); }
 
        bool isReadonly() const { return !m_xReplaceAccess.is(); }
 
    protected:
        // OEventListenerAdapter
        virtual void _disposing( const css::lang::EventObject& _rSource ) override;
 
    protected:
        enum NAMEORIGIN
        {
            NO_CONFIGURATION,       
            NO_CALLER               
        };
        OUString normalizeName(const OUString& _rName, NAMEORIGIN _eOrigin) const;
    };
 
    //= OConfigurationTreeRoot
 
    class UNOTOOLS_DLLPUBLIC OConfigurationTreeRoot final : public OConfigurationNode
    {
        css::uno::Reference< css::util::XChangesBatch >
                                m_xCommitter;
        OConfigurationTreeRoot(
            const css::uno::Reference< css::uno::XInterface >& _rxRootNode
        );
 
    public:
        enum CREATION_MODE
        {
            CM_READONLY,
            CM_UPDATABLE
        };
 
    public:
        OConfigurationTreeRoot() {}
 
        OConfigurationTreeRoot(
            const css::uno::Reference<css::uno::XComponentContext> & i_rContext,
            const OUString& i_rNodePath,
            const bool i_bUpdatable
        );
 
        static OConfigurationTreeRoot createWithProvider(
                const css::uno::Reference< css::lang::XMultiServiceFactory >& _rxConfProvider,
                const OUString& _rPath,
                sal_Int32 _nDepth,
                CREATION_MODE _eMode
            );
 
        static OConfigurationTreeRoot createWithComponentContext(const css::uno::Reference< css::uno::XComponentContext >& _rxContext,
            const OUString& _rPath, sal_Int32 _nDepth = -1, CREATION_MODE _eMode = CM_UPDATABLE);
 
        static OConfigurationTreeRoot tryCreateWithComponentContext( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
            const OUString& _rPath, sal_Int32 _nDepth = -1, CREATION_MODE _eMode = CM_UPDATABLE );
 
        bool commit() const noexcept;
 
        virtual void clear() noexcept override;
    };
 
}   // namespace utl
 
#endif // INCLUDED_UNOTOOLS_CONFIGNODE_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */