tempfile.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 .
 */
#pragma once
 
#include <unotools/unotoolsdllapi.h>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/io/XSeekable.hpp>
#include <com/sun/star/io/XTruncate.hpp>
#include <cppuhelper/implbase.hxx>
#include <tools/stream.hxx>
#include <memory>
#include <mutex>
#include <optional>
 
namespace utl
{
 
 
class UNOTOOLS_DLLPUBLIC TempFileFast
{
    std::unique_ptr<SvFileStream> mxStream;
 
public:
                    TempFileFast();
                    TempFileFast(TempFileFast && other) noexcept;
                    ~TempFileFast();
 
    SvStream*       GetStream( StreamMode eMode );
 
    void            CloseStream();
 
};
 
UNOTOOLS_DLLPUBLIC OUString CreateTempName();
 
UNOTOOLS_DLLPUBLIC OUString CreateTempURL( const OUString* pParent=nullptr, bool bDirectory=false );
 
UNOTOOLS_DLLPUBLIC OUString CreateTempURL( std::u16string_view rLeadingChars, bool _bStartWithZero=true, std::u16string_view pExtension={},
                          const OUString* pParent=nullptr, bool bCreateParentDirs=false );
 
UNOTOOLS_DLLPUBLIC OUString SetTempNameBaseDirectory( const OUString &rBaseName );
 
// Return the URL of the temp directory (the one set with SetTempNameBaseDirectory or the
// default tempfile folder):
UNOTOOLS_DLLPUBLIC OUString GetTempNameBaseDirectory();
 
class UNOTOOLS_DLLPUBLIC TempFileNamed
{
friend UNOTOOLS_DLLPUBLIC OUString SetTempNameBaseDirectory( const OUString & );
    OUString    aName;
    std::unique_ptr<SvStream>
                pStream;
    bool        bIsDirectory;
    bool        bKillingFileEnabled;
 
public:
                    TempFileNamed( const OUString* pParent=nullptr, bool bDirectory=false );
 
                    TempFileNamed( std::u16string_view rLeadingChars, bool _bStartWithZero=true, std::u16string_view pExtension={},
                              const OUString* pParent = nullptr, bool bCreateParentDirs=false );
 
                    TempFileNamed(TempFileNamed && other) noexcept;
 
                    ~TempFileNamed();
 
    bool            IsValid() const;
 
    OUString const & GetURL() const;
 
    OUString        GetFileName() const;
 
    SvStream*       GetStream( StreamMode eMode );
 
    void            CloseStream();
 
    void            EnableKillingFile( bool bEnable=true )
                    { bKillingFileEnabled = bEnable; }
 
};
 
 
typedef ::cppu::WeakImplHelper<
     css::io::XStream
    , css::io::XSeekable
    , css::io::XInputStream
    , css::io::XOutputStream
    , css::io::XTruncate> TempFileFastService_Base;
class UNOTOOLS_DLLPUBLIC TempFileFastService final : public TempFileFastService_Base
{
    std::optional<utl::TempFileFast> mpTempFile;
    std::mutex maMutex;
    SvStream* mpStream;
    bool mbInClosed;
    bool mbOutClosed;
 
    void checkError () const;
    void checkConnected ();
 
public:
    explicit TempFileFastService ();
    virtual ~TempFileFastService () override;
 
    // XInputStream
    virtual ::sal_Int32 SAL_CALL readBytes( css::uno::Sequence< ::sal_Int8 >& aData, ::sal_Int32 nBytesToRead ) override;
    virtual ::sal_Int32 SAL_CALL readSomeBytes( css::uno::Sequence< ::sal_Int8 >& aData, ::sal_Int32 nMaxBytesToRead ) override;
    virtual void SAL_CALL skipBytes( ::sal_Int32 nBytesToSkip ) override;
    virtual ::sal_Int32 SAL_CALL available(  ) override;
    virtual void SAL_CALL closeInput(  ) override;
    // XOutputStream
    virtual void SAL_CALL writeBytes( const css::uno::Sequence< ::sal_Int8 >& aData ) override;
    virtual void SAL_CALL flush(  ) override;
    virtual void SAL_CALL closeOutput(  ) override;
    // XSeekable
    virtual void SAL_CALL seek( sal_Int64 location ) override;
    virtual sal_Int64 SAL_CALL getPosition(  ) override;
    virtual sal_Int64 SAL_CALL getLength(  ) override;
    // XStream
    virtual css::uno::Reference< css::io::XInputStream > SAL_CALL getInputStream(  ) override;
    virtual css::uno::Reference< css::io::XOutputStream > SAL_CALL getOutputStream(  ) override;
    // XTruncate
    virtual void SAL_CALL truncate() override;
 
};
 
 
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */