13
0
livetrax/libs/pbd/pbd/file_utils.h
Carl Hetherington 3b89d9eaa0 Remove most using declarations from header files.
git-svn-id: svn://localhost/ardour2/branches/3.0@5069 d708f5d6-7413-0410-9779-e7cbd77b26cf
2009-05-12 17:03:42 +00:00

97 lines
3.1 KiB
C++

/*
Copyright (C) 2007 Tim Mayberry
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef PBD_FILE_UTILS_INCLUDED
#define PBD_FILE_UTILS_INCLUDED
#include <string>
#include <vector>
#include <glibmm/pattern.h>
#include "pbd/search_path.h"
namespace PBD {
/**
* Get a list of files in a directory.
* @note You must join path with result to get the absolute path
* to the file.
*
* @param path An Absolute path to a directory
* @param result A vector of filenames.
*/
void
get_files_in_directory (const sys::path& path,
std::vector<std::string>& result);
/**
* Takes a directory path and returns all the files in the directory
* matching a particular pattern.
*
* @param directory A directory path
* @param pattern A Glib::PatternSpec used to match the files.
* @param result A vector in which to place the resulting matches.
*/
void
find_matching_files_in_directory (const sys::path& directory,
const Glib::PatternSpec& pattern,
std::vector<sys::path>& result);
/**
* Takes a number of directory paths and returns all the files matching
* a particular pattern.
*
* @param paths A vector containing the Absolute paths
* @param pattern A Glib::PatternSpec used to match the files
* @param result A vector in which to place the resulting matches.
*/
void
find_matching_files_in_directories (const std::vector<sys::path>& directory_paths,
const Glib::PatternSpec& pattern,
std::vector<sys::path>& result);
/**
* Takes a SearchPath and puts a list of all the files in the search path
* that match pattern into the result vector.
*
* @param search_path A SearchPath
* @param pattern A Glib::PatternSpec used to match the files
* @param result A vector in which to place the resulting matches.
*/
void
find_matching_files_in_search_path (const SearchPath& search_path,
const Glib::PatternSpec& pattern,
std::vector<sys::path>& result);
/**
* Takes a search path and a file name and place the full path
* to that file in result if it is found within the search path.
*
* @return true If file is found within the search path.
*/
bool
find_file_in_search_path (const SearchPath& search_path,
const std::string& filename,
sys::path& result);
} // namespace PBD
#endif