dfb4e5038d
git-svn-id: http://find-object.googlecode.com/svn/trunk/find_object@110 620bd6b2-0a58-f614-fd9a-1bd335dccda9
140 lines
3.8 KiB
C++
140 lines
3.8 KiB
C++
// Taken from UtiLite library r185 [www.utilite.googlecode.com]
|
|
|
|
/*
|
|
* utilite is a cross-platform library with
|
|
* useful utilities for fast and small developing.
|
|
* Copyright (C) 2010 Mathieu Labbe
|
|
*
|
|
* utilite is free library: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* utilite 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 Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef UDIRECTORY_H
|
|
#define UDIRECTORY_H
|
|
|
|
//#include "utilite/UtiLiteExp.h" // DLL export/import defines
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
#include <list>
|
|
|
|
/**
|
|
* Class UDirectory.
|
|
*
|
|
* This class can be used to get file names in a directory.
|
|
*/
|
|
class UDirectory
|
|
{
|
|
public:
|
|
/**
|
|
* Check if a directory exists.
|
|
* @param dirPath the directory path
|
|
* @return true if the directory exists
|
|
*/
|
|
static bool exists(const std::string & dirPath);
|
|
|
|
/**
|
|
* Get the directory path of a file path.
|
|
* @param filePath the file path
|
|
* @return the directory path of the file
|
|
*/
|
|
static std::string getDir(const std::string & filePath);
|
|
|
|
/**
|
|
* Get the current directory.
|
|
* @param trailingSeparator If true, a '/' is added to the path.
|
|
* @return the current directory
|
|
*/
|
|
static std::string currentDir(bool trailingSeparator = false);
|
|
|
|
/**
|
|
* Make a directory.
|
|
* @param dirPath the directory path
|
|
* @return true on success, false otherwise.
|
|
*/
|
|
static bool makeDir(const std::string & dirPath);
|
|
|
|
/**
|
|
* Remove a directory.
|
|
* @param dirPath the directory path
|
|
* @return true on success, false otherwise.
|
|
*/
|
|
static bool removeDir(const std::string & dirPath);
|
|
|
|
/**
|
|
* Return the "home" directory.
|
|
* @return the directory path.
|
|
*/
|
|
static std::string homeDir();
|
|
|
|
/**
|
|
* Return \ (Win32) or / (Unix) depending of the platform.
|
|
*/
|
|
static std::string separator();
|
|
|
|
public:
|
|
/**
|
|
* Create a UDirectory object with path initialized to an existing "path" and with filter "extensions".
|
|
* @param path the path to an existing directory
|
|
* @param extensions filter to get only file names with the extensions specified, format is a
|
|
* list of extensions separated by a space: "jpg bmp" get only file names finishing by jpg or bmp.
|
|
*/
|
|
UDirectory(const std::string & path = "", const std::string & extensions = "");
|
|
UDirectory(const UDirectory & dir);
|
|
UDirectory & operator=(const UDirectory & dir);
|
|
~UDirectory();
|
|
|
|
/**
|
|
* Set path of the directory.
|
|
* @param path the new directory path.
|
|
*/
|
|
void setPath(const std::string & path, const std::string & extensions = "");
|
|
|
|
/**
|
|
* Update indexed file names (if the directory changed).
|
|
*/
|
|
void update();
|
|
|
|
/**
|
|
* Check is the directory exists.
|
|
* @return if directory exists.
|
|
*/
|
|
bool isValid();
|
|
|
|
/**
|
|
* Get the next file name.
|
|
* @return the next file name
|
|
*/
|
|
std::string getNextFileName();
|
|
|
|
/**
|
|
* Get all file names.
|
|
* @see UDirectory()
|
|
* @return all the file names in directory matching the set extensions.
|
|
*/
|
|
const std::list<std::string> & getFileNames() const {return fileNames_;}
|
|
|
|
/**
|
|
* Return the pointer of file names to beginning.
|
|
*/
|
|
void rewind();
|
|
|
|
private:
|
|
std::string path_;
|
|
std::vector<std::string> extensions_;
|
|
std::list<std::string> fileNames_;
|
|
std::list<std::string>::iterator iFileName_;
|
|
};
|
|
|
|
#endif /* UDIRECTORY_H */
|