Quelle  configaccess.hxx   Sprache: C

/* -*- 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 .
 */

#pragma once

#include <com/sun/star/uno/XComponentContext.hpp>
#include <rtl/ustring.hxx>
#include <mutex>

namespace framework{

/**
    @short  implements a simple configuration access
    @descr  Sometimes it's better to have direct config access
            instead of using specialized config items of the svtools
            project. This class can wrap such configuration access.
 */
class ConfigAccess final
{

    public:

        /** represent the possible modes of the internal wrapped configuration access */
        enum EOpenMode
        {
            /// config isn't used yet
            E_CLOSED,
            /// config access is open for reading only
            E_READONLY,
            /// config access is open for reading/writing data
            E_READWRITE
        };

    // member

    private:
        mutable std::mutex m_mutex;

        /**
            reference to the uno service manager
            It's necessary to instantiate own needed services.
         */
        css::uno::Reference< css::uno::XComponentContext > m_xContext;

        /** hold an opened configuration alive */
        css::uno::Reference< css::uno::XInterface > m_xConfig;

        /** knows the root of the opened config access point */
        OUString m_sRoot;

        /** represent the current open mode */
        EOpenMode m_eMode;

    // native interface methods

        void      closeImpl();
    public:

                 ConfigAccess( css::uno::Reference< css::uno::XComponentContext > xContext,
                               OUString                                     sRoot );
                 ~ConfigAccess();

        void      open   ( EOpenMode eMode );
        void      close  (                 );
        EOpenMode getMode(                 ) const;

        const css::uno::Reference< css::uno::XInterface >& cfg();
};

} // namespace framework

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */