Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : #ifndef _TOOLS_TEMPFILE_HXX
      20             : #define _TOOLS_TEMPFILE_HXX
      21             : 
      22             : #include <tools/string.hxx>
      23             : #include "tools/toolsdllapi.h"
      24             : 
      25             : struct TempFile_Impl;
      26             : class TOOLS_DLLPUBLIC TempFile
      27             : {
      28             :     TempFile_Impl*  pImp;
      29             :     sal_Bool        bKillingFileEnabled;
      30             : 
      31             : public:
      32             :     /** Create a temporary file or directory in a given folder or the default
      33             :         tempfile folder. */
      34             :     TempFile( const String* pParent=NULL, sal_Bool bDirectory=sal_False );
      35             : 
      36             :     /** Create a temporary file or directory in a given folder or the default
      37             :         tempfile folder; its name starts with some given characters followed by
      38             :         a counter ( example: rLeadingChars="abc" means "abc0","abc1" and so on,
      39             :         depending on existing files in that folder ).
      40             : 
      41             :         The extension string may be f.e. ".txt" or "", if no extension string is
      42             :         given, ".tmp" is used.
      43             :     */
      44             :     TempFile( const String& rLeadingChars, const String* pExtension=NULL, const String* pParent=NULL, sal_Bool bDirectory=sal_False );
      45             : 
      46             :     /** TempFile will be removed from disk in dtor if EnableKillingTempFile was
      47             :         called before. TempDirs will be removed recursively in that case. */
      48             :     ~TempFile();
      49             : 
      50             :     sal_Bool IsValid() const;
      51             : 
      52             :     /** Returns the real name of the tempfile in file URL scheme. */
      53             :     String GetName() const;
      54             : 
      55             :     /** If enabled the file will be removed from disk when the dtor is called
      56             :         (default is not enabled) */
      57           0 :     void EnableKillingFile( sal_Bool bEnable=sal_True ) { bKillingFileEnabled = bEnable; }
      58             : 
      59             :     sal_Bool IsKillingFileEnabled() const { return bKillingFileEnabled; }
      60             : 
      61             :     /** Only create a name for a temporary file that would be valid at that moment. */
      62             :     static String   CreateTempName( const String* pParent=NULL );
      63             : };
      64             : 
      65             : #endif
      66             : 
      67             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */