storagebase.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_OOX_HELPER_STORAGEBASE_HXX
#define INCLUDED_OOX_HELPER_STORAGEBASE_HXX
 
#include <functional>
#include <memory>
#include <vector>
 
#include <com/sun/star/uno/Reference.hxx>
#include <oox/dllapi.h>
#include <oox/helper/refmap.hxx>
#include <rtl/ustring.hxx>
 
namespace com::sun::star {
    namespace embed { class XStorage; }
    namespace io { class XInputStream; }
    namespace io { class XOutputStream; }
    namespace io { class XStream; }
}
 
namespace oox {
 
 
class StorageBase;
typedef std::shared_ptr< StorageBase > StorageRef;
 
class OOX_DLLPUBLIC StorageBase
{
public:
    explicit            StorageBase(
                            const css::uno::Reference< css::io::XInputStream >& rxInStream,
                            bool bBaseStreamAccess );
 
    explicit            StorageBase(
                            const css::uno::Reference< css::io::XStream >& rxOutStream,
                            bool bBaseStreamAccess );
 
    virtual             ~StorageBase();
 
    bool                isStorage() const;
 
    bool                isRootStorage() const;
 
    bool                isReadOnly() const { return mbReadOnly;}
 
    css::uno::Reference< css::embed::XStorage >
                        getXStorage() const;
 
    const OUString& getName() const { return maStorageName;}
 
    OUString     getPath() const;
 
    void                getElementNames( ::std::vector< OUString >& orElementNames ) const;
 
    StorageRef          openSubStorage( const OUString& rStorageName, bool bCreateMissing );
 
    css::uno::Reference< css::io::XInputStream >
                        openInputStream( const OUString& rStreamName );
 
    css::uno::Reference< css::io::XOutputStream >
                        openOutputStream( const OUString& rStreamName );
 
    void                copyToStorage( StorageBase& rDestStrg, const OUString& rElementName );
 
    void                copyStorageToStorage( StorageBase& rDestStrg );
 
    void                commit();
 
protected:
    explicit            StorageBase( const StorageBase& rParentStorage, OUString aStorageName, bool bReadOnly );
 
private:
                        StorageBase( const StorageBase& ) = delete;
    StorageBase&        operator=( const StorageBase& ) = delete;
 
    virtual bool        implIsStorage() const = 0;
 
    virtual css::uno::Reference< css::embed::XStorage >
                        implGetXStorage() const = 0;
 
    virtual void        implGetElementNames( ::std::vector< OUString >& orElementNames ) const = 0;
 
    virtual StorageRef  implOpenSubStorage( const OUString& rElementName, bool bCreate ) = 0;
 
    virtual css::uno::Reference< css::io::XInputStream >
                        implOpenInputStream( const OUString& rElementName ) = 0;
 
    virtual css::uno::Reference< css::io::XOutputStream >
                        implOpenOutputStream( const OUString& rElementName ) = 0;
 
    virtual void        implCommit() const = 0;
 
    StorageRef          getSubStorage( const OUString& rElementName, bool bCreateMissing );
 
private:
    RefMap< OUString, StorageBase >
                        maSubStorages;      
    css::uno::Reference< css::io::XInputStream >
                        mxInStream;         
    css::uno::Reference< css::io::XStream >
                        mxOutStream;        
    OUString            maParentPath;       
    OUString            maStorageName;      
    bool                mbBaseStreamAccess; 
    bool                mbReadOnly;         
};
 
 
} // namespace oox
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */