cppcheck/cli/filelister.h

93 lines
3.5 KiB
C
Raw Normal View History

2008-12-18 22:28:57 +01:00
/*
* Cppcheck - A tool for static C/C++ code analysis
2021-07-04 08:08:51 +02:00
* Copyright (C) 2007-2021 Cppcheck team.
2008-12-18 22:28:57 +01:00
*
* 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 3 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, see <http://www.gnu.org/licenses/>.
2008-12-18 22:28:57 +01:00
*/
#ifndef filelisterH
#define filelisterH
2008-12-18 22:28:57 +01:00
2017-05-27 04:33:47 +02:00
#include <cstddef>
#include <map>
2017-05-27 04:33:47 +02:00
#include <set>
#include <string>
2008-12-18 22:28:57 +01:00
class PathMatch;
/// @addtogroup CLI
/// @{
/** @brief Cross-platform FileLister */
2011-10-13 20:53:06 +02:00
class FileLister {
2008-12-18 22:28:57 +01:00
public:
/**
* @brief Recursively add source files to a map.
2010-07-19 15:33:10 +02:00
* Add source files from given directory and all subdirectries to the
* given map. Only files with accepted extensions
2010-07-19 15:33:10 +02:00
* (*.c;*.cpp;*.cxx;*.c++;*.cc;*.txx) are added.
* @param files output map that associates the size of each file with its name
* @param path root path
* @param ignored ignored paths
* @return On success, an empty string is returned. On error, a error message is returned.
*/
static std::string recursiveAddFiles(std::map<std::string, std::size_t> &files, const std::string &path, const PathMatch& ignored) {
const std::set<std::string> extra;
return recursiveAddFiles(files, path, extra, ignored);
}
/**
* @brief Recursively add source files to a map.
* Add source files from given directory and all subdirectries to the
* given map. Only files with accepted extensions
* (*.c;*.cpp;*.cxx;*.c++;*.cc;*.txx) are added.
* @param files output map that associates the size of each file with its name
* @param path root path
* @param extra Extra file extensions
* @param ignored ignored paths
* @return On success, an empty string is returned. On error, a error message is returned.
*/
static std::string recursiveAddFiles(std::map<std::string, std::size_t> &files, const std::string &path, const std::set<std::string> &extra, const PathMatch& ignored);
/**
* @brief (Recursively) add source files to a map.
* Add source files from given directory and all subdirectries to the
* given map. Only files with accepted extensions
* (*.c;*.cpp;*.cxx;*.c++;*.cc;*.txx) are added.
* @param files output map that associates the size of each file with its name
* @param path root path
* @param extra Extra file extensions
2015-04-08 21:08:18 +02:00
* @param recursive Enable recursion
* @param ignored ignored paths
* @return On success, an empty string is returned. On error, a error message is returned.
*/
static std::string addFiles(std::map<std::string, std::size_t> &files, const std::string &path, const std::set<std::string> &extra, bool recursive, const PathMatch& ignored);
/**
* @brief Is given path a directory?
* @return returns true if the path is a directory
*/
static bool isDirectory(const std::string &path);
2008-12-18 22:28:57 +01:00
/**
2021-08-07 20:51:18 +02:00
* @brief Check if the given path is a file and if it exists?
* @return true if path points to file and the file exists.
*/
static bool fileExists(const std::string &path);
};
/// @}
#endif // #ifndef filelisterH