File: filelist.h

package info (click to toggle)
cppcheck 2.17.1-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 25,384 kB
  • sloc: cpp: 263,341; python: 19,737; ansic: 7,953; sh: 1,018; makefile: 996; xml: 994; cs: 291
file content (101 lines) | stat: -rw-r--r-- 3,233 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/* -*- C++ -*-
 * Cppcheck - A tool for static C/C++ code analysis
 * Copyright (C) 2007-2024 Cppcheck team.
 *
 * 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/>.
 */

#ifndef FILELIST_H
#define FILELIST_H

#include <QFileInfo>
#include <QFileInfoList>
#include <QString>
#include <QStringList>

/**
 * @brief A class for listing files and directories to check.
 * This class creates a list of files to check. If directory name is given then
 * all files in the directory matching the filter will be added. The directory
 * can be also added recursively when all files in subdirectories are added too.
 * The filenames are matched against the filter and only those files whose
 * filename extension is included in the filter list are added.
 *
 * This class also handles filtering of paths against ignore filters given. If
 * there is ignore filters then only paths not matching those filters are
 * returned.
 */
class FileList {
public:

    /**
     * @brief Add filename to the list.
     * @param filepath Full path to the file.
     */
    void addFile(const QString &filepath);

    /**
     * @brief Add files in the directory to the list.
     * @param directory Full pathname to directory to add.
     * @param recursive If true also files in subdirectories are added.
     */
    void addDirectory(const QString &directory, bool recursive = false);

    /**
     * @brief Add list of filenames and directories to the list.
     * @param paths List of paths to add.
     */
    void addPathList(const QStringList &paths);

    /**
     * @brief Return list of filenames (to check).
     * @return list of filenames to check.
     */
    QStringList getFileList() const;

    /**
     * @brief Add list of paths to exclusion list.
     * @param paths Paths to exclude.
     */
    void addExcludeList(const QStringList &paths);

    /**
     * @brief Return list of default filename extensions included.
     * @return list of default filename extensions included.
     */
    static QStringList getDefaultFilters();

protected:

    /**
     * @brief Test if filename matches the filename extensions filtering.
     * @return true if filename matches filtering.
     */
    static bool filterMatches(const QFileInfo &inf);

    /**
     * @brief Get filtered list of paths.
     * This method takes the list of paths and applies the exclude lists to
     * it. And then returns the list of paths that did not match the
     * exclude filters.
     * @return Filtered list of paths.
     */
    QStringList applyExcludeList() const;

private:
    QFileInfoList mFileList;
    QStringList mExcludedPaths;
};

#endif // FILELIST_H