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 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
|
/* -*- 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 preprocessorH
#define preprocessorH
//---------------------------------------------------------------------------
#include "config.h"
#include <cstddef>
#include <cstdint>
#include <istream>
#include <list>
#include <map>
#include <set>
#include <string>
#include <utility>
#include <vector>
#include <simplecpp.h>
class ErrorLogger;
class Settings;
class SuppressionList;
/**
* @brief A preprocessor directive
* Each preprocessor directive (\#include, \#define, \#undef, \#if, \#ifdef, \#else, \#endif)
* will be recorded as an instance of this class.
*
* file and linenr denote the location where the directive is defined.
*
*/
struct CPPCHECKLIB Directive {
/** name of (possibly included) file where directive is defined */
std::string file;
/** line number in (possibly included) file where directive is defined */
unsigned int linenr;
/** the actual directive text */
std::string str;
struct DirectiveToken {
explicit DirectiveToken(const simplecpp::Token & _tok);
int line;
int column;
std::string tokStr;
};
std::vector<DirectiveToken> strTokens;
/** record a directive (possibly filtering src) */
Directive(const simplecpp::Location & _loc, std::string _str);
Directive(std::string _file, int _linenr, std::string _str);
};
class CPPCHECKLIB RemarkComment {
public:
RemarkComment(std::string file, unsigned int lineNumber, std::string str)
: file(std::move(file))
, lineNumber(lineNumber)
, str(std::move(str))
{}
/** name of file */
std::string file;
/** line number for the code that the remark comment is about */
unsigned int lineNumber;
/** remark text */
std::string str;
};
/// @addtogroup Core
/// @{
/**
* @brief The cppcheck preprocessor.
* The preprocessor has special functionality for extracting the various ifdef
* configurations that exist in a source file.
*/
class CPPCHECKLIB WARN_UNUSED Preprocessor {
// TODO: get rid of this
friend class PreprocessorHelper;
friend class TestPreprocessor;
friend class TestUnusedVar;
public:
/** character that is inserted in expanded macros */
static char macroChar;
explicit Preprocessor(const Settings& settings, ErrorLogger &errorLogger);
virtual ~Preprocessor();
void inlineSuppressions(const simplecpp::TokenList &tokens, SuppressionList &suppressions);
std::list<Directive> createDirectives(const simplecpp::TokenList &tokens) const;
std::set<std::string> getConfigs(const simplecpp::TokenList &tokens) const;
std::vector<RemarkComment> getRemarkComments(const simplecpp::TokenList &tokens) const;
bool loadFiles(const simplecpp::TokenList &rawtokens, std::vector<std::string> &files);
void removeComments(simplecpp::TokenList &tokens);
static void setPlatformInfo(simplecpp::TokenList &tokens, const Settings& settings);
simplecpp::TokenList preprocess(const simplecpp::TokenList &tokens1, const std::string &cfg, std::vector<std::string> &files, bool throwError = false);
std::string getcode(const simplecpp::TokenList &tokens1, const std::string &cfg, std::vector<std::string> &files, bool writeLocations);
/**
* Calculate HASH. Using toolinfo, tokens1, filedata.
*
* @param tokens1 Sourcefile tokens
* @param toolinfo Arbitrary extra toolinfo
* @return HASH
*/
std::size_t calculateHash(const simplecpp::TokenList &tokens1, const std::string &toolinfo) const;
void simplifyPragmaAsm(simplecpp::TokenList &tokenList) const;
static void getErrorMessages(ErrorLogger &errorLogger, const Settings &settings);
/**
* dump all directives present in source file
*/
void dump(std::ostream &out) const;
static bool hasErrors(const simplecpp::Output &output);
private:
void handleErrors(const simplecpp::OutputList &outputList, bool throwError);
void reportOutput(const simplecpp::OutputList &outputList, bool showerror);
static void simplifyPragmaAsmPrivate(simplecpp::TokenList &tokenList);
/**
* Include file types.
*/
enum HeaderTypes : std::uint8_t {
UserHeader = 1,
SystemHeader
};
void missingInclude(const std::string &filename, unsigned int linenr, const std::string &header, HeaderTypes headerType);
void error(const std::string &filename, unsigned int linenr, const std::string &msg);
static bool hasErrors(const simplecpp::OutputList &outputList);
void addRemarkComments(const simplecpp::TokenList &tokens, std::vector<RemarkComment> &remarkComments) const;
const Settings& mSettings;
ErrorLogger &mErrorLogger;
/** list of all directives met while preprocessing file */
std::map<std::string, simplecpp::TokenList *> mTokenLists;
/** filename for cpp/c file - useful when reporting errors */
std::string mFile0;
/** simplecpp tracking info */
std::list<simplecpp::MacroUsage> mMacroUsage;
std::list<simplecpp::IfCond> mIfCond;
};
/// @}
//---------------------------------------------------------------------------
#endif // preprocessorH
|