/* * Cppcheck - A tool for static C/C++ code analysis * Copyright (C) 2007-2016 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 . */ #include "preprocessor.h" #include "path.h" #include "errorlogger.h" #include "settings.h" #include "simplecpp.h" #include #include #include #include #include #include /** * Remove heading and trailing whitespaces from the input parameter. * If string is all spaces/tabs, return empty string. * @param s The string to trim. */ static std::string trim(const std::string& s) { const std::string::size_type beg = s.find_first_not_of(" \t"); if (beg == std::string::npos) return ""; const std::string::size_type end = s.find_last_not_of(" \t"); return s.substr(beg, end - beg + 1); } Directive::Directive(const std::string &_file, const int _linenr, const std::string &_str): file(_file), linenr(_linenr), str(_str) { str = trim(str); } bool Preprocessor::missingIncludeFlag; bool Preprocessor::missingSystemIncludeFlag; char Preprocessor::macroChar = char(1); Preprocessor::Preprocessor(Settings& settings, ErrorLogger *errorLogger) : _settings(settings), _errorLogger(errorLogger) { } Preprocessor::~Preprocessor() { for (std::map::iterator it = tokenlists.begin(); it != tokenlists.end(); ++it) delete it->second; } static void inlineSuppressions(const simplecpp::TokenList &tokens, Settings &_settings) { std::list suppressionIDs; for (const simplecpp::Token *tok = tokens.cfront(); tok; tok = tok->next) { if (tok->comment) { std::istringstream iss(tok->str.substr(2)); std::string word; iss >> word; if (word != "cppcheck-suppress") continue; iss >> word; if (iss) suppressionIDs.push_back(word); continue; } if (suppressionIDs.empty()) continue; // Relative filename std::string relativeFilename(tok->location.file()); if (_settings.relativePaths) { for (std::size_t j = 0U; j < _settings.basePaths.size(); ++j) { const std::string bp = _settings.basePaths[j] + "/"; if (relativeFilename.compare(0,bp.size(),bp)==0) { relativeFilename = relativeFilename.substr(bp.size()); } } } // Add the suppressions. for (std::list::const_iterator it = suppressionIDs.begin(); it != suppressionIDs.end(); ++it) { _settings.nomsg.addSuppression(*it, relativeFilename, tok->location.line); } suppressionIDs.clear(); } } void Preprocessor::inlineSuppressions(const simplecpp::TokenList &tokens) { if (!_settings.inlineSuppressions) return; ::inlineSuppressions(tokens, _settings); for (std::map::const_iterator it = tokenlists.begin(); it != tokenlists.end(); ++it) { if (it->second) ::inlineSuppressions(*it->second, _settings); } } void Preprocessor::setDirectives(const simplecpp::TokenList &tokens1) { // directive list.. directives.clear(); std::list list; list.push_back(&tokens1); for (std::map::const_iterator it = tokenlists.begin(); it != tokenlists.end(); ++it) { list.push_back(it->second); } for (std::list::const_iterator it = list.begin(); it != list.end(); ++it) { for (const simplecpp::Token *tok = (*it)->cfront(); tok; tok = tok ? tok->next : nullptr) { if ((tok->op != '#') || (tok->previous && tok->previous->location.line == tok->location.line)) continue; if (tok->next && tok->next->str == "endfile") continue; Directive directive(tok->location.file(), tok->location.line, ""); for (const simplecpp::Token *tok2 = tok; tok2 && tok2->location.line == directive.linenr; tok2 = tok2->next) { if (tok2->comment) continue; if (!directive.str.empty() && (tok2->location.col > tok2->previous->location.col + tok2->previous->str.size())) directive.str += ' '; if (directive.str == "#" && tok2->str == "file") directive.str += "include"; else directive.str += tok2->str; } directives.push_back(directive); } } } static bool sameline(const simplecpp::Token *tok1, const simplecpp::Token *tok2) { return tok1 && tok2 && tok1->location.sameline(tok2->location); } static std::string readcondition(const simplecpp::Token *iftok, const std::set &defined) { const simplecpp::Token *cond = iftok->next; if (!sameline(iftok,cond)) return ""; const simplecpp::Token *next1 = cond->next; const simplecpp::Token *next2 = next1 ? next1->next : nullptr; const simplecpp::Token *next3 = next2 ? next2->next : nullptr; unsigned int len = 1; if (sameline(iftok,next1)) len = 2; if (sameline(iftok,next2)) len = 3; if (sameline(iftok,next3)) len = 4; if (len == 1 && cond->str == "0") return "0"; if (len == 1 && cond->name) { if (defined.find(cond->str) == defined.end()) return cond->str; } if (len == 3 && cond->op == '(' && next1->name && next2->op == ')') { if (defined.find(next1->str) == defined.end()) return next1->str; } if (len == 3 && cond->name && next1->str == "==" && next2->number) { if (defined.find(cond->str) == defined.end()) return cond->str + '=' + cond->next->next->str; } std::set configset; for (; sameline(iftok,cond); cond = cond->next) { if (cond->op == '!') break; if (cond->str != "defined") continue; const simplecpp::Token *dtok = cond->next; if (!dtok) break; if (dtok->op == '(') dtok = dtok->next; if (sameline(iftok,dtok) && dtok->name && defined.find(dtok->str) == defined.end()) configset.insert(dtok->str); } std::string cfg; for (std::set::const_iterator it = configset.begin(); it != configset.end(); ++it) { if (!cfg.empty()) cfg += ';'; cfg += *it; } return cfg; } static std::string cfg(const std::vector &configs) { std::set configs2(configs.begin(), configs.end()); std::string ret; for (std::set::const_iterator it = configs2.begin(); it != configs2.end(); ++it) { if (it->empty()) continue; if (*it == "0") return ""; if (!ret.empty()) ret += ';'; ret += *it; } return ret; } static void getConfigs(const simplecpp::TokenList &tokens, std::set &defined, const std::set &undefined, std::set &ret) { std::vector configs_if; std::vector configs_ifndef; for (const simplecpp::Token *tok = tokens.cfront(); tok; tok = tok->next) { if (tok->op != '#' || sameline(tok->previous, tok)) continue; const simplecpp::Token *cmdtok = tok->next; if (!sameline(tok, cmdtok)) continue; if (cmdtok->str == "ifdef" || cmdtok->str == "ifndef" || cmdtok->str == "if") { std::string config; if (cmdtok->str == "ifdef" || cmdtok->str == "ifndef") { const simplecpp::Token *expr1 = cmdtok->next; if (sameline(tok,expr1) && expr1->name && !sameline(tok,expr1->next)) config = expr1->str; if (defined.find(config) != defined.end()) config.clear(); } else if (cmdtok->str == "if") { config = readcondition(cmdtok, defined); } if (undefined.find(config) != undefined.end()) config.clear(); configs_if.push_back((cmdtok->str == "ifndef") ? std::string() : config); configs_ifndef.push_back((cmdtok->str == "ifndef") ? config : std::string()); ret.insert(cfg(configs_if)); } else if (cmdtok->str == "elif") { if (!configs_if.empty()) configs_if.pop_back(); std::string config = readcondition(cmdtok, defined); if (undefined.find(config) != undefined.end()) config.clear(); configs_if.push_back(config); ret.insert(cfg(configs_if)); } else if (cmdtok->str == "else") { if (!configs_if.empty()) configs_if.pop_back(); if (!configs_ifndef.empty()) { configs_if.push_back(configs_ifndef.back()); ret.insert(cfg(configs_if)); } } else if (cmdtok->str == "endif" && !sameline(tok, cmdtok->next)) { if (!configs_if.empty()) configs_if.pop_back(); if (!configs_ifndef.empty()) configs_ifndef.pop_back(); } else if (cmdtok->str == "define" && sameline(tok, cmdtok->next) && cmdtok->next->name) { defined.insert(cmdtok->next->str); } } } std::set Preprocessor::getConfigs(const simplecpp::TokenList &tokens) const { std::set ret; ret.insert(""); if (!tokens.cfront()) return ret; std::set defined; defined.insert("__cplusplus"); ::getConfigs(tokens, defined, _settings.userUndefs, ret); for (std::map::const_iterator it = tokenlists.begin(); it != tokenlists.end(); ++it) ::getConfigs(*(it->second), defined, _settings.userUndefs, ret); return ret; } void Preprocessor::preprocess(std::istream &istr, std::map &result, const std::string &filename, const std::list &includePaths) { (void)includePaths; simplecpp::OutputList outputList; std::vector files; const simplecpp::TokenList tokens1(istr, files, filename, &outputList); const std::set configs = getConfigs(tokens1); for (std::set::const_iterator it = configs.begin(); it != configs.end(); ++it) { if (_settings.userUndefs.find(*it) == _settings.userUndefs.end()) { result[ *it ] = getcode(tokens1, *it, files, false); } } } std::string Preprocessor::removeSpaceNearNL(const std::string &str) { std::string tmp; char prev = '\n'; // treat start of file as newline for (std::size_t i = 0; i < str.size(); i++) { if (str[i] == ' ' && (prev == '\n' || i + 1 >= str.size() || // treat end of file as newline str[i+1] == '\n' ) ) { // Ignore space that has new line in either side of it } else { tmp.append(1, str[i]); prev = str[i]; } } return tmp; } void Preprocessor::preprocessWhitespaces(std::string &processedFile) { // Replace all tabs with spaces.. std::replace(processedFile.begin(), processedFile.end(), '\t', ' '); // Remove space characters that are after or before new line character processedFile = removeSpaceNearNL(processedFile); } void Preprocessor::preprocess(std::istream &srcCodeStream, std::string &processedFile, std::list &resultConfigurations, const std::string &filename, const std::list &includePaths) { (void)includePaths; if (file0.empty()) file0 = filename; simplecpp::OutputList outputList; std::vector files; const simplecpp::TokenList tokens1(srcCodeStream, files, filename, &outputList); const std::set configs = getConfigs(tokens1); for (std::set::const_iterator it = configs.begin(); it != configs.end(); ++it) resultConfigurations.push_back(*it); processedFile = tokens1.stringify(); } static void splitcfg(const std::string &cfg, std::list &defines, const std::string &defaultValue) { for (std::string::size_type pos1 = 0U; pos1 < cfg.size();) { const std::string::size_type pos2 = cfg.find(";",pos1); std::string def = (pos2 == std::string::npos) ? cfg.substr(pos1) : cfg.substr(pos1, pos2 - pos1); if (!defaultValue.empty() && def.find("=") == std::string::npos) def += '=' + defaultValue; defines.push_back(def); pos1 = (pos2 == std::string::npos) ? pos2 : pos2 + 1U; } } static simplecpp::DUI createDUI(const Settings &_settings, const std::string &cfg, const std::string &filename) { simplecpp::DUI dui; splitcfg(_settings.userDefines, dui.defines, "1"); if (!cfg.empty()) splitcfg(cfg, dui.defines, ""); for (std::vector::const_iterator it = _settings.library.defines.begin(); it != _settings.library.defines.end(); ++it) { if (it->compare(0,8,"#define ")!=0) continue; std::string s = it->substr(8); std::string::size_type pos = s.find_first_of(" ("); if (pos == std::string::npos) { dui.defines.push_back(s); continue; } if (s[pos] == ' ') { s[pos] = '='; } else { s[s.find(")")+1] = '='; } dui.defines.push_back(s); } if (Path::isCPP(filename)) dui.defines.push_back("__cplusplus"); dui.undefined = _settings.userUndefs; // -U dui.includePaths = _settings.includePaths; // -I dui.includes = _settings.userIncludes; // --include return dui; } static bool hasErrors(const simplecpp::OutputList &outputList) { for (simplecpp::OutputList::const_iterator it = outputList.begin(); it != outputList.end(); ++it) { switch (it->type) { case simplecpp::Output::ERROR: case simplecpp::Output::INCLUDE_NESTED_TOO_DEEPLY: case simplecpp::Output::SYNTAX_ERROR: return true; case simplecpp::Output::WARNING: case simplecpp::Output::MISSING_HEADER: break; }; } return false; } void Preprocessor::loadFiles(const simplecpp::TokenList &rawtokens, std::vector &files) { const simplecpp::DUI dui = createDUI(_settings, "", files[0]); simplecpp::OutputList outputList; tokenlists = simplecpp::load(rawtokens, files, dui, &outputList); } void Preprocessor::removeComments() { for (std::map::iterator it = tokenlists.begin(); it != tokenlists.end(); ++it) { if (it->second) it->second->removeComments(); } } void Preprocessor::setPlatformInfo(simplecpp::TokenList *tokens) const { tokens->sizeOfType["bool"] = _settings.sizeof_bool; tokens->sizeOfType["short"] = _settings.sizeof_short; tokens->sizeOfType["int"] = _settings.sizeof_int; tokens->sizeOfType["long"] = _settings.sizeof_long; tokens->sizeOfType["long long"] = _settings.sizeof_long_long; tokens->sizeOfType["float"] = _settings.sizeof_float; tokens->sizeOfType["double"] = _settings.sizeof_double; tokens->sizeOfType["long double"] = _settings.sizeof_long_double; tokens->sizeOfType["bool *"] = _settings.sizeof_pointer; tokens->sizeOfType["short *"] = _settings.sizeof_pointer; tokens->sizeOfType["int *"] = _settings.sizeof_pointer; tokens->sizeOfType["long *"] = _settings.sizeof_pointer; tokens->sizeOfType["long long *"] = _settings.sizeof_pointer; tokens->sizeOfType["float *"] = _settings.sizeof_pointer; tokens->sizeOfType["double *"] = _settings.sizeof_pointer; tokens->sizeOfType["long double *"] = _settings.sizeof_pointer; } std::string Preprocessor::getcode(const simplecpp::TokenList &tokens1, const std::string &cfg, std::vector &files, const bool writeLocations) { const std::string filename(files[0]); const simplecpp::DUI dui = createDUI(_settings, cfg, filename); simplecpp::OutputList outputList; std::list macroUsage; simplecpp::TokenList tokens2(files); simplecpp::preprocess(tokens2, tokens1, files, tokenlists, dui, &outputList, ¯oUsage); bool showerror = (!_settings.userDefines.empty() && !_settings.force); reportOutput(outputList, showerror); if (hasErrors(outputList)) return ""; // ensure that guessed define macros without value are not used in the code if (!validateCfg(cfg, macroUsage)) return ""; // assembler code locations.. std::set assemblerLocations; for (std::list::const_iterator dirIt = directives.begin(); dirIt != directives.end(); ++dirIt) { const Directive &d1 = *dirIt; if (d1.str.compare(0, 11, "#pragma asm") != 0) continue; std::list::const_iterator dirIt2 = dirIt; ++dirIt2; if (dirIt2 == directives.end()) continue; const Directive &d2 = *dirIt2; if (d2.str.compare(0,14,"#pragma endasm") != 0 || d1.file != d2.file) continue; simplecpp::Location loc(files); loc.fileIndex = ~0U; loc.col = 0U; for (unsigned int i = 0; i < files.size(); ++i) { if (files[i] == d1.file) { loc.fileIndex = i; break; } } for (unsigned int linenr = d1.linenr + 1U; linenr < d2.linenr; linenr++) { loc.line = linenr; assemblerLocations.insert(loc); } } unsigned int prevfile = 0; unsigned int line = 1; std::ostringstream ret; for (const simplecpp::Token *tok = tokens2.cfront(); tok; tok = tok->next) { if (writeLocations && tok->location.fileIndex != prevfile) { ret << "\n#line " << tok->location.line << " \"" << tok->location.file() << "\"\n"; prevfile = tok->location.fileIndex; line = tok->location.line; } if (tok->previous && line == tok->location.line) ret << ' '; bool newline = false; while (tok->location.line > line) { ret << '\n'; line++; newline = true; } if (newline) { simplecpp::Location loc = tok->location; loc.col = 0U; if (assemblerLocations.find(loc) != assemblerLocations.end()) { ret << "asm();"; while (assemblerLocations.find(loc) != assemblerLocations.end()) { loc.line++; } while (tok && tok->location.line < loc.line) tok = tok->next; if (!tok) break; while (line < tok->location.line) { ret << '\n'; ++line; } } } if (!tok->macro.empty()) ret << Preprocessor::macroChar; ret << tok->str; } return ret.str(); } std::string Preprocessor::getcode(const std::string &filedata, const std::string &cfg, const std::string &filename) { simplecpp::OutputList outputList; std::vector files; std::istringstream istr(filedata); simplecpp::TokenList tokens1(istr, files, Path::simplifyPath(filename), &outputList); inlineSuppressions(tokens1); tokens1.removeComments(); removeComments(); setDirectives(tokens1); reportOutput(outputList, true); if (hasErrors(outputList)) return ""; return getcode(tokens1, cfg, files, filedata.find("#file") != std::string::npos); } void Preprocessor::reportOutput(const simplecpp::OutputList &outputList, bool showerror) { for (simplecpp::OutputList::const_iterator it = outputList.begin(); it != outputList.end(); ++it) { switch (it->type) { case simplecpp::Output::ERROR: if (it->msg.compare(0,6,"#error")!=0 || showerror) error(it->location.file(), it->location.line, it->msg); break; case simplecpp::Output::WARNING: break; case simplecpp::Output::MISSING_HEADER: { const std::string::size_type pos1 = it->msg.find_first_of("<\""); const std::string::size_type pos2 = it->msg.find_first_of(">\"", pos1 + 1U); if (pos1 < pos2 && pos2 != std::string::npos) missingInclude(it->location.file(), it->location.line, it->msg.substr(pos1+1, pos2-pos1-1), it->msg[pos1] == '\"' ? UserHeader : SystemHeader); } break; case simplecpp::Output::INCLUDE_NESTED_TOO_DEEPLY: case simplecpp::Output::SYNTAX_ERROR: error(it->location.file(), it->location.line, it->msg); break; }; } } void Preprocessor::error(const std::string &filename, unsigned int linenr, const std::string &msg) { std::list locationList; if (!filename.empty()) { ErrorLogger::ErrorMessage::FileLocation loc(filename, linenr); locationList.push_back(loc); } _errorLogger->reportErr(ErrorLogger::ErrorMessage(locationList, file0, Severity::error, msg, "preprocessorErrorDirective", false)); } // Report that include is missing void Preprocessor::missingInclude(const std::string &filename, unsigned int linenr, const std::string &header, HeaderTypes headerType) { const std::string fname = Path::fromNativeSeparators(filename); if (_settings.nomsg.isSuppressed("missingInclude", fname, linenr)) return; if (headerType == SystemHeader && _settings.nomsg.isSuppressed("missingIncludeSystem", fname, linenr)) return; if (headerType == SystemHeader) missingSystemIncludeFlag = true; else missingIncludeFlag = true; if (_errorLogger && _settings.checkConfiguration) { std::list locationList; if (!filename.empty()) { ErrorLogger::ErrorMessage::FileLocation loc; loc.line = linenr; loc.setfile(Path::toNativeSeparators(filename)); locationList.push_back(loc); } ErrorLogger::ErrorMessage errmsg(locationList, file0, Severity::information, (headerType==SystemHeader) ? "Include file: <" + header + "> not found. Please note: Cppcheck does not need standard library headers to get proper results." : "Include file: \"" + header + "\" not found.", (headerType==SystemHeader) ? "missingIncludeSystem" : "missingInclude", false); _errorLogger->reportInfo(errmsg); } } bool Preprocessor::validateCfg(const std::string &cfg, const std::list ¯oUsageList) { bool ret = true; std::list defines; splitcfg(cfg, defines, std::string()); for (std::list::const_iterator defineIt = defines.begin(); defineIt != defines.end(); ++defineIt) { if (defineIt->find("=") != std::string::npos) continue; const std::string macroName(defineIt->substr(0, defineIt->find("("))); for (std::list::const_iterator usageIt = macroUsageList.begin(); usageIt != macroUsageList.end(); ++usageIt) { const simplecpp::MacroUsage &mu = *usageIt; if (mu.macroName != macroName) continue; bool directiveLocation = false; for (std::list::const_iterator dirIt = directives.begin(); dirIt != directives.end(); ++dirIt) { if (mu.useLocation.file() == dirIt->file && mu.useLocation.line == dirIt->linenr) { directiveLocation = true; break; } } if (!directiveLocation) { if (_settings.isEnabled("information")) validateCfgError(mu.useLocation.file(), mu.useLocation.line, cfg, macroName); ret = false; } } } return ret; } void Preprocessor::validateCfgError(const std::string &file, const unsigned int line, const std::string &cfg, const std::string ¯o) { const std::string id = "ConfigurationNotChecked"; std::list locationList; ErrorLogger::ErrorMessage::FileLocation loc(file, line); locationList.push_back(loc); ErrorLogger::ErrorMessage errmsg(locationList, file0, Severity::information, "Skipping configuration '" + cfg + "' since the value of '" + macro + "' is unknown. Use -D if you want to check it. You can use -U to skip it explicitly.", id, false); _errorLogger->reportInfo(errmsg); } void Preprocessor::getErrorMessages(ErrorLogger *errorLogger, const Settings *settings) { Settings settings2(*settings); Preprocessor preprocessor(settings2, errorLogger); settings2.checkConfiguration=true; preprocessor.missingInclude("", 1, "", UserHeader); preprocessor.missingInclude("", 1, "", SystemHeader); preprocessor.validateCfgError("", 1, "X", "X"); preprocessor.error("", 1, "#error message"); // #error .. } void Preprocessor::dump(std::ostream &out) const { // Create a xml directive dump. // The idea is not that this will be readable for humans. It's a // data dump that 3rd party tools could load and get useful info from. std::list::const_iterator it; out << " " << std::endl; for (it = directives.begin(); it != directives.end(); ++it) { out << " file << "\" " << "linenr=\"" << it->linenr << "\" " // str might contain characters such as '"', '<' or '>' which // could result in invalid XML, so run it through toxml(). << "str=\"" << ErrorLogger::toxml(it->str) << "\"/>" << std::endl; } out << " " << std::endl; }