150 lines
5.7 KiB
C++
150 lines
5.7 KiB
C++
/***************************************************************************
|
|
* Copyright (c) 2005 Jürgen Riegel <juergen.riegel@web.de> *
|
|
* *
|
|
* This file is part of the FreeCAD CAx development system. *
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU Library General Public License (LGPL) *
|
|
* as published by the Free Software Foundation; either version 2 of *
|
|
* the License, or (at your option) any later version. *
|
|
* for detail see the LICENCE text file. *
|
|
* *
|
|
* FreeCAD is distributed in the hope that it will be useful, *
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
|
|
* GNU Library General Public License for more details. *
|
|
* *
|
|
* You should have received a copy of the GNU Library General Public *
|
|
* License along with FreeCAD; if not, write to the Free Software *
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
|
* USA *
|
|
* *
|
|
***************************************************************************/
|
|
|
|
|
|
#ifndef BASE_FILEINFO_H
|
|
#define BASE_FILEINFO_H
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
#include <Base/TimeInfo.h>
|
|
|
|
|
|
namespace Base
|
|
{
|
|
|
|
/** File name unification
|
|
* This class handles everything related to file names
|
|
* the file names are internal generally UTF-8 encoded on
|
|
* all platforms.
|
|
*/
|
|
class BaseExport FileInfo
|
|
{
|
|
public:
|
|
enum Permissions {
|
|
WriteOnly = 0x01,
|
|
ReadOnly = 0x02,
|
|
ReadWrite = 0x03,
|
|
};
|
|
|
|
/// Construction
|
|
FileInfo (const char* _FileName="");
|
|
FileInfo (const std::string &_FileName);
|
|
/// Set a new file name
|
|
void setFile(const char* name);
|
|
/// Set a new file name
|
|
void setFile(const std::string &name){setFile(name.c_str());}
|
|
|
|
|
|
/** @name extraction of information */
|
|
//@{
|
|
/// Returns the file name, including the path (which may be absolute or relative).
|
|
std::string filePath () const;
|
|
/// Returns the dir path name (which may be absolute or relative).
|
|
std::string dirPath () const;
|
|
/// Returns the name of the file, excluding the path, including the extension.
|
|
std::string fileName () const;
|
|
/// Returns the name of the file, excluding the path and the extension.
|
|
std::string fileNamePure () const;
|
|
/// Convert the path name into a UCS-2 encoded wide string format.
|
|
std::wstring toStdWString() const;
|
|
/** Returns the extension of the file.
|
|
* The extension consists of all characters in the file after (but not including)
|
|
* the last '.' character.
|
|
*@code
|
|
* FileInfo fi( "/tmp/archive.tar.gz" );
|
|
* ext = fi.extension(); // ext = "gz"
|
|
*@endcode
|
|
*/
|
|
std::string extension () const;
|
|
/** Returns the complete extension of the file.
|
|
* The complete extension consists of all characters in the file after (but not including)
|
|
* the first '.' character.
|
|
*@code
|
|
* FileInfo fi( "/tmp/archive.tar.gz" );
|
|
* ext = fi.completeExtension(); // ext = "tar.gz"
|
|
*@endcode
|
|
*/
|
|
std::string completeExtension () const;
|
|
/// Checks for a special extension, NOT case sensetive
|
|
bool hasExtension (const char* Ext) const;
|
|
//@}
|
|
|
|
/** @name methods to test the status of the file or dir */
|
|
//@{
|
|
/// Does the file exist?
|
|
bool exists () const;
|
|
/// Checks if the file exist and is readable
|
|
bool isReadable () const;
|
|
/// Checks if the file exist and is writable
|
|
bool isWritable () const;
|
|
/// Tries to set the file permission
|
|
bool setPermissions (Permissions);
|
|
/// Checks if it is a file (not a directory)
|
|
bool isFile () const;
|
|
/// Checks if it is a directory (not a file)
|
|
bool isDir () const;
|
|
/// The size of the file
|
|
unsigned int size () const;
|
|
/// Returns the time when the file was last modified.
|
|
TimeInfo lastModified() const;
|
|
/// Returns the time when the file was last read (accessed).
|
|
TimeInfo lastRead() const;
|
|
//@}
|
|
|
|
/** @name Directory management*/
|
|
//@{
|
|
/// Creates a directory. Returns true if successful; otherwise returns false.
|
|
bool createDirectory( void ) const;
|
|
/// Get a list of the directory content
|
|
std::vector<Base::FileInfo> getDirectoryContent(void) const;
|
|
/// Delete an empty directory
|
|
bool deleteDirectory(void) const;
|
|
/// Delete a directory and all its content.
|
|
bool deleteDirectoryRecursive(void) const;
|
|
//@}
|
|
|
|
/// Delete the file
|
|
bool deleteFile(void) const;
|
|
/// Rename the file
|
|
bool renameFile(const char* NewName);
|
|
/// Rename the file
|
|
bool copyTo(const char* NewName) const;
|
|
|
|
/** @name Tools */
|
|
//@{
|
|
/// Get a unique File Name in the given or (if 0) in the temp path
|
|
static std::string getTempFileName(const char* FileName=0, const char* path=0);
|
|
/// Get the path to the dir which is considered to temp files
|
|
static const std::string &getTempPath(void);
|
|
//@}
|
|
|
|
protected:
|
|
std::string FileName;
|
|
};
|
|
|
|
} //namespace Base
|
|
|
|
|
|
#endif // BASE_FILEINFO_H
|