/*
* Cppcheck - A tool for static C/C++ code analysis
* Copyright (C) 2007-2026 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 "importproject.h"
#include "path.h"
#include "pathmatch.h"
#include "settings.h"
#include "standards.h"
#include "suppressions.h"
#include "token.h"
#include "tokenlist.h"
#include "utils.h"
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include "xml.h"
#include "json.h"
std::string ImportProject::collectArgs(const std::string &cmd, std::vector &args)
{
args.clear();
std::string::size_type pos = 0;
const std::string::size_type end = cmd.size();
std::string arg;
bool inDoubleQuotes = false;
bool inSingleQuotes = false;
while (pos < end) {
char c = cmd[pos++];
if (c == ' ') {
if (inDoubleQuotes || inSingleQuotes) {
arg.push_back(c);
continue;
}
if (!arg.empty())
args.push_back(arg);
arg.clear();
pos = cmd.find_first_not_of(' ', pos);
continue;
}
if (c == '\"' && !inSingleQuotes) {
inDoubleQuotes = !inDoubleQuotes;
continue;
}
if (c == '\'' && !inDoubleQuotes) {
inSingleQuotes = !inSingleQuotes;
continue;
}
if (c == '\\' && !inSingleQuotes) {
if (pos == end) {
arg.push_back('\\');
break;
}
c = cmd[pos++];
if (!std::strchr("\\\"\' ", c))
arg.push_back('\\');
arg.push_back(c);
continue;
}
arg.push_back(c);
}
if (inSingleQuotes || inDoubleQuotes)
return "Missing closing quote in command string";
if (!arg.empty())
args.push_back(std::move(arg));
return "";
}
void ImportProject::parseArgs(FileSettings &fs, const std::vector &args)
{
const auto getOptArg = [&args](std::initializer_list optNames,
std::size_t &i) {
const auto &arg = args[i];
const auto *const it = std::find_if(optNames.begin(),
optNames.end(),
[&arg] (const std::string &optName) {
return startsWith(arg, optName);
});
if (it == optNames.end())
return std::string();
const std::size_t optLen = it->size();
if (arg.size() == optLen)
return ++i >= args.size() ? std::string() : args[i];
return arg.substr(optLen);
};
std::string defs;
for (std::size_t i = 0; i < args.size(); i++) {
std::string optArg;
if (!(optArg = getOptArg({ "-I", "/I" }, i)).empty()) {
if (std::none_of(fs.includePaths.cbegin(), fs.includePaths.cend(),
[&](const std::string &path) {
return path == optArg;
}))
fs.includePaths.push_back(std::move(optArg));
continue;
}
if (!(optArg = getOptArg({ "-isystem" }, i)).empty()) {
fs.systemIncludePaths.push_back(std::move(optArg));
continue;
}
if (!(optArg = getOptArg({ "-D", "/D" }, i)).empty()) {
defs += optArg + ";";
continue;
}
if (!(optArg = getOptArg({ "-U", "/U" }, i)).empty()) {
fs.undefs.insert(std::move(optArg));
continue;
}
if (!(optArg = getOptArg({ "-std=", "/std:" }, i)).empty()) {
fs.standard = std::move(optArg);
continue;
}
if (!(optArg = getOptArg({ "-f" }, i)).empty()) {
if (optArg == "pic")
defs += "__pic__;";
else if (optArg == "PIC")
defs += "__PIC__;";
else if (optArg == "pie")
defs += "__pie__;";
else if (optArg == "PIE")
defs += "__PIE__;";
continue;
}
if (!(optArg = getOptArg({ "-m" }, i)).empty()) {
if (optArg == "unicode")
defs += "UNICODE;";
continue;
}
}
fsSetDefines(fs, std::move(defs));
}
void ImportProject::ignorePaths(const std::vector &ipaths, bool debug)
{
PathMatch matcher(ipaths, Path::getCurrentPath());
for (auto it = fileSettings.cbegin(); it != fileSettings.cend();) {
if (matcher.match(it->filename())) {
if (debug)
std::cout << "ignored path: " << it->filename() << std::endl;
it = fileSettings.erase(it);
}
else
++it;
}
}
void ImportProject::ignoreOtherConfigs(const std::string &cfg)
{
for (auto it = fileSettings.cbegin(); it != fileSettings.cend();) {
if (it->cfg != cfg)
it = fileSettings.erase(it);
else
++it;
}
}
void ImportProject::fsSetDefines(FileSettings& fs, std::string defs)
{
while (defs.find(";%(") != std::string::npos) {
const std::string::size_type pos1 = defs.find(";%(");
const std::string::size_type pos2 = defs.find(';', pos1+1);
defs.erase(pos1, pos2 == std::string::npos ? pos2 : (pos2-pos1));
}
while (defs.find(";;") != std::string::npos)
defs.erase(defs.find(";;"),1);
while (!defs.empty() && defs[0] == ';')
defs.erase(0, 1);
while (!defs.empty() && endsWith(defs,';'))
defs.pop_back();
bool eq = false;
for (std::size_t pos = 0; pos < defs.size(); ++pos) {
if (defs[pos] == '(' || defs[pos] == '=')
eq = true;
else if (defs[pos] == ';') {
if (!eq) {
defs.insert(pos,"=1");
pos += 3;
}
if (pos < defs.size())
eq = false;
}
}
if (!eq && !defs.empty())
defs += "=1";
fs.defines.swap(defs);
}
static bool simplifyPathWithVariables(std::string &s, std::map &variables)
{
std::set expanded;
std::string::size_type start = 0;
while ((start = s.find("$(")) != std::string::npos) {
const std::string::size_type end = s.find(')',start);
if (end == std::string::npos)
break;
const std::string var = s.substr(start+2,end-start-2);
if (expanded.find(var) != expanded.end())
break;
expanded.insert(var);
auto it1 = utils::as_const(variables).find(var);
// variable was not found within defined variables
if (it1 == variables.end()) {
const char *envValue = std::getenv(var.c_str());
if (!envValue) {
//! \todo generate a debug/info message about undefined variable
break;
}
variables[var] = std::string(envValue);
it1 = variables.find(var);
}
s.replace(start, end - start + 1, it1->second);
}
if (s.find("$(") != std::string::npos)
return false;
s = Path::simplifyPath(std::move(s));
return true;
}
void ImportProject::fsSetIncludePaths(FileSettings& fs, const std::string &basepath, const std::list &in, std::map &variables)
{
std::set found;
// NOLINTNEXTLINE(performance-unnecessary-copy-initialization)
const std::list copyIn(in);
fs.includePaths.clear();
for (const std::string &ipath : copyIn) {
if (ipath.empty())
continue;
if (startsWith(ipath,"%("))
continue;
std::string s(Path::fromNativeSeparators(ipath));
if (!found.insert(s).second)
continue;
if (s[0] == '/' || (s.size() > 1U && s.compare(1,2,":/") == 0)) {
if (!endsWith(s,'/'))
s += '/';
fs.includePaths.push_back(std::move(s));
continue;
}
if (endsWith(s,'/')) // this is a temporary hack, simplifyPath can crash if path ends with '/'
s.pop_back();
if (s.find("$(") == std::string::npos) {
s = Path::simplifyPath(basepath + s);
} else {
if (!simplifyPathWithVariables(s, variables))
continue;
}
if (s.empty())
continue;
fs.includePaths.push_back(s.back() == '/' ? s : (s + '/'));
}
}
ImportProject::Type ImportProject::import(const std::string &filename, Settings *settings, Suppressions *supprs)
{
std::ifstream fin(filename);
if (!fin.is_open())
return ImportProject::Type::MISSING;
mPath = Path::getPathFromFilename(Path::fromNativeSeparators(filename));
if (!mPath.empty() && !endsWith(mPath,'/'))
mPath += '/';
const std::vector fileFilters =
settings ? settings->fileFilters : std::vector();
if (endsWith(filename, ".json")) {
if (importCompileCommands(fin)) {
setRelativePaths(filename);
return ImportProject::Type::COMPILE_DB;
}
} else if (endsWith(filename, ".sln")) {
if (importSln(fin, mPath, fileFilters)) {
setRelativePaths(filename);
return ImportProject::Type::VS_SLN;
}
} else if (endsWith(filename, ".slnx")) {
if (importSlnx(filename, fileFilters)) {
setRelativePaths(filename);
return ImportProject::Type::VS_SLNX;
}
} else if (endsWith(filename, ".vcxproj")) {
std::map variables;
std::vector sharedItemsProjects;
if (importVcxproj(filename, variables, "", fileFilters, sharedItemsProjects)) {
setRelativePaths(filename);
return ImportProject::Type::VS_VCXPROJ;
}
} else if (endsWith(filename, ".bpr")) {
if (importBcb6Prj(filename)) {
setRelativePaths(filename);
return ImportProject::Type::BORLAND;
}
} else if (settings && supprs && endsWith(filename, ".cppcheck")) {
if (importCppcheckGuiProject(fin, *settings, *supprs)) {
setRelativePaths(filename);
return ImportProject::Type::CPPCHECK_GUI;
}
} else {
return ImportProject::Type::UNKNOWN;
}
return ImportProject::Type::FAILURE;
}
bool ImportProject::importCompileCommands(std::istream &istr)
{
picojson::value compileCommands;
istr >> compileCommands;
if (!compileCommands.is()) {
errors.emplace_back("compilation database is not a JSON array");
return false;
}
std::map fsFileIds;
for (const picojson::value &fileInfo : compileCommands.get()) {
picojson::object obj = fileInfo.get();
if (obj.count("directory") == 0) {
errors.emplace_back("'directory' field in compilation database entry missing");
return false;
}
if (!obj["directory"].is()) {
errors.emplace_back("'directory' field in compilation database entry is not a string");
return false;
}
std::string dirpath = Path::fromNativeSeparators(obj["directory"].get());
/* CMAKE produces the directory without trailing / so add it if not
* there - it is needed by setIncludePaths() */
if (!endsWith(dirpath, '/'))
dirpath += '/';
const std::string directory = std::move(dirpath);
std::vector arguments;
if (obj.count("arguments")) {
if (obj["arguments"].is()) {
for (const picojson::value& arg : obj["arguments"].get()) {
if (arg.is())
arguments.push_back(arg.get());
}
} else {
errors.emplace_back("'arguments' field in compilation database entry is not a JSON array");
return false;
}
} else if (obj.count("command")) {
std::string command;
if (obj["command"].is()) {
command = obj["command"].get();
} else {
errors.emplace_back("'command' field in compilation database entry is not a string");
return false;
}
std::string error = collectArgs(command, arguments);
if (!error.empty()) {
errors.emplace_back(error);
return false;
}
} else {
errors.emplace_back("no 'arguments' or 'command' field found in compilation database entry");
return false;
}
if (!obj.count("file") || !obj["file"].is()) {
errors.emplace_back("skip compilation database entry because it does not have a proper 'file' field");
continue;
}
std::string file = Path::fromNativeSeparators(obj["file"].get());
// Accept file?
if (!Path::acceptFile(file))
continue;
std::string path;
if (Path::isAbsolute(file))
path = Path::simplifyPath(std::move(file));
#ifdef _WIN32
else if (file[0] == '/' && directory.size() > 2 && std::isalpha(directory[0]) && directory[1] == ':')
// directory: C:\foo\bar
// file: /xy/z.c
// => c:/xy/z.c
path = Path::simplifyPath(directory.substr(0,2) + file);
#endif
else
path = Path::simplifyPath(directory + file);
FileSettings fs{path, Standards::Language::None, 0}; // file will be identified later on
parseArgs(fs, arguments);
std::map variables;
fsSetIncludePaths(fs, directory, fs.includePaths, variables);
// Assign a unique index to each file path. If the file path already exists in the map,
// increment the index to handle duplicate file entries.
fs.file.setFsFileId(fsFileIds[path]++);
fileSettings.push_back(std::move(fs));
}
return true;
}
bool ImportProject::importSln(std::istream &istr, const std::string &path, const std::vector &fileFilters)
{
std::string line;
if (!std::getline(istr,line)) {
errors.emplace_back("Visual Studio solution file is empty");
return false;
}
if (!startsWith(line, "Microsoft Visual Studio Solution File")) {
// Skip BOM
if (!std::getline(istr, line) || !startsWith(line, "Microsoft Visual Studio Solution File")) {
errors.emplace_back("Visual Studio solution file header not found");
return false;
}
}
std::map variables;
variables["SolutionDir"] = path;
bool found = false;
std::vector sharedItemsProjects;
while (std::getline(istr,line)) {
if (!startsWith(line,"Project("))
continue;
const std::string::size_type pos = line.find(".vcxproj");
if (pos == std::string::npos)
continue;
const std::string::size_type pos1 = line.rfind('\"',pos);
if (pos1 == std::string::npos)
continue;
std::string vcxproj(line.substr(pos1+1, pos-pos1+7));
vcxproj = Path::toNativeSeparators(std::move(vcxproj));
if (!Path::isAbsolute(vcxproj))
vcxproj = path + vcxproj;
vcxproj = Path::fromNativeSeparators(std::move(vcxproj));
if (!importVcxproj(vcxproj, variables, "", fileFilters, sharedItemsProjects)) {
errors.emplace_back("failed to load '" + vcxproj + "' from Visual Studio solution");
return false;
}
found = true;
}
if (!found) {
errors.emplace_back("no projects found in Visual Studio solution file");
return false;
}
return true;
}
bool ImportProject::importSlnx(const std::string& filename, const std::vector& fileFilters)
{
tinyxml2::XMLDocument doc;
const tinyxml2::XMLError error = doc.LoadFile(filename.c_str());
if (error != tinyxml2::XML_SUCCESS) {
errors.emplace_back(std::string("Visual Studio solution file is not a valid XML - ") + tinyxml2::XMLDocument::ErrorIDToName(error));
return false;
}
const tinyxml2::XMLElement* const rootnode = doc.FirstChildElement();
if (rootnode == nullptr) {
errors.emplace_back("Visual Studio solution file has no XML root node");
return false;
}
std::map variables;
variables["SolutionDir"] = Path::simplifyPath(Path::getPathFromFilename(filename));
bool found = false;
std::vector sharedItemsProjects;
for (const tinyxml2::XMLElement* node = rootnode->FirstChildElement(); node; node = node->NextSiblingElement()) {
const char* name = node->Name();
if (std::strcmp(name, "Project") == 0) {
const char* labelAttribute = node->Attribute("Path");
if (labelAttribute) {
std::string vcxproj(labelAttribute);
vcxproj = Path::toNativeSeparators(std::move(vcxproj));
if (!Path::isAbsolute(vcxproj))
vcxproj = variables["SolutionDir"] + vcxproj;
vcxproj = Path::fromNativeSeparators(std::move(vcxproj));
if (!importVcxproj(vcxproj, variables, "", fileFilters, sharedItemsProjects)) {
errors.emplace_back("failed to load '" + vcxproj + "' from Visual Studio solution");
return false;
}
found = true;
}
}
}
if (!found) {
errors.emplace_back("no projects found in Visual Studio solution file");
return false;
}
return true;
}
namespace {
struct ProjectConfiguration {
ProjectConfiguration() = default;
explicit ProjectConfiguration(const tinyxml2::XMLElement *cfg) {
const char *a = cfg->Attribute("Include");
if (a)
name = a;
for (const tinyxml2::XMLElement *e = cfg->FirstChildElement(); e; e = e->NextSiblingElement()) {
const char * const text = e->GetText();
if (!text)
continue;
const char * ename = e->Name();
if (std::strcmp(ename,"Configuration")==0)
configuration = text;
else if (std::strcmp(ename,"Platform")==0) {
platformStr = text;
if (platformStr == "Win32")
platform = Win32;
else if (platformStr == "x64")
platform = x64;
else
platform = Unknown;
}
}
}
std::string name;
std::string configuration;
enum : std::uint8_t { Win32, x64, Unknown } platform = Unknown;
std::string platformStr;
};
struct ConditionalGroup {
explicit ConditionalGroup(const tinyxml2::XMLElement *idg){
const char *condAttr = idg->Attribute("Condition");
if (condAttr)
mCondition = condAttr;
}
static void replaceAll(std::string &c, const std::string &from, const std::string &to) {
std::string::size_type pos;
while ((pos = c.find(from)) != std::string::npos) {
c.erase(pos,from.size());
c.insert(pos,to);
}
}
// see https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-conditions
// properties are .NET String objects and you can call any of its members on them
bool conditionIsTrue(const ProjectConfiguration &p, const std::string &filename, std::vector &errors) const {
if (mCondition.empty())
return true;
try {
return evalCondition(mCondition, p);
}
catch (const std::runtime_error& r)
{
errors.emplace_back(filename + ": Can not evaluate condition '" + mCondition + "': " + r.what());
return false;
}
}
static bool evalCondition(const std::string& condition, const ProjectConfiguration &p) {
std::string c = '(' + condition + ")";
replaceAll(c, "$(Configuration)", p.configuration);
replaceAll(c, "$(Platform)", p.platformStr);
const Settings s;
TokenList tokenlist(s, Standards::Language::C);
if (!tokenlist.createTokensFromBuffer(c.data(), c.size())) {
throw std::runtime_error("Can not tokenize condition");
}
// generate links
{
std::stack lpar;
for (Token* tok2 = tokenlist.front(); tok2; tok2 = tok2->next()) {
if (tok2->str() == "(")
lpar.push(tok2);
else if (tok2->str() == ")") {
if (lpar.empty())
throw std::runtime_error("unmatched ')' in condition " + condition);
Token::createMutualLinks(lpar.top(), tok2);
lpar.pop();
}
}
if (!lpar.empty())
throw std::runtime_error("'(' without closing ')'!");
}
// Replace "And" and "Or" with "&&" and "||"
for (Token *tok = tokenlist.front(); tok; tok = tok->next()) {
if (tok->str() == "And")
tok->str("&&");
else if (tok->str() == "Or")
tok->str("||");
}
tokenlist.createAst();
// Locate ast top and execute the condition
for (const Token *tok = tokenlist.front(); tok; tok = tok->next()) {
if (tok->astParent()) {
return execute(tok->astTop(), p) == "True";
}
}
throw std::runtime_error("Invalid condition: '" + condition + "'");
}
private:
static std::string executeOp1(const Token* tok, const ProjectConfiguration &p) {
return execute(tok->astOperand1(), p);
}
static std::string executeOp2(const Token* tok, const ProjectConfiguration &p) {
return execute(tok->astOperand2(), p);
}
static std::string execute(const Token* tok, const ProjectConfiguration &p) {
if (!tok)
throw std::runtime_error("Missing operator");
auto boolResult = [](bool b) -> std::string {
return b ? "True" : "False";
};
if (tok->isUnaryOp("!"))
return boolResult(executeOp1(tok, p) == "False");
if (tok->str() == "==")
return boolResult(executeOp1(tok, p) == executeOp2(tok, p));
if (tok->str() == "!=")
return boolResult(executeOp1(tok, p) != executeOp2(tok, p));
if (tok->str() == "&&")
return boolResult(executeOp1(tok, p) == "True" && executeOp2(tok, p) == "True");
if (tok->str() == "||")
return boolResult(executeOp1(tok, p) == "True" || executeOp2(tok, p) == "True");
if (tok->str() == "(" && Token::Match(tok->previous(), "$ ( %name% . %name% (")) {
const std::string& propertyName = tok->strAt(1);
std::string propertyValue;
if (propertyName == "Configuration")
propertyValue = p.configuration;
else if (propertyName == "Platform")
propertyValue = p.platformStr;
else
throw std::runtime_error("Unhandled property '" + propertyName + "'");
const std::string& method = tok->strAt(3);
std::string arg = executeOp2(tok->tokAt(4), p);
if (arg.size() >= 2 && arg[0] == '\'')
arg = arg.substr(1, arg.size() - 2);
if (method == "Contains")
return boolResult(propertyValue.find(arg) != std::string::npos);
if (method == "EndsWith")
return boolResult(endsWith(propertyValue,arg.c_str(),arg.size()));
if (method == "StartsWith")
return boolResult(startsWith(propertyValue,arg));
throw std::runtime_error("Unhandled method '" + method + "'");
}
if (tok->str().size() >= 2 && tok->str()[0] == '\'') // String Literal
return tok->str();
throw std::runtime_error("Unknown/unhandled operator/operand '" + tok->str() + "'");
}
std::string mCondition;
};
struct ItemDefinitionGroup : ConditionalGroup {
explicit ItemDefinitionGroup(const tinyxml2::XMLElement *idg, std::string includePaths) : ConditionalGroup(idg), additionalIncludePaths(std::move(includePaths)) {
for (const tinyxml2::XMLElement *e1 = idg->FirstChildElement(); e1; e1 = e1->NextSiblingElement()) {
const char* name = e1->Name();
if (std::strcmp(name, "ClCompile") == 0) {
enhancedInstructionSet = "StreamingSIMDExtensions2";
for (const tinyxml2::XMLElement *e = e1->FirstChildElement(); e; e = e->NextSiblingElement()) {
const char * const text = e->GetText();
if (!text)
continue;
const char * const ename = e->Name();
if (std::strcmp(ename, "PreprocessorDefinitions") == 0)
preprocessorDefinitions = text;
else if (std::strcmp(ename, "AdditionalIncludeDirectories") == 0) {
if (!additionalIncludePaths.empty())
additionalIncludePaths += ';';
additionalIncludePaths += text;
} else if (std::strcmp(ename, "LanguageStandard") == 0) {
if (std::strcmp(text, "stdcpp14") == 0)
cppstd = Standards::CPP14;
else if (std::strcmp(text, "stdcpp17") == 0)
cppstd = Standards::CPP17;
else if (std::strcmp(text, "stdcpp20") == 0)
cppstd = Standards::CPP20;
else if (std::strcmp(text, "stdcpplatest") == 0)
cppstd = Standards::CPPLatest;
} else if (std::strcmp(ename, "EnableEnhancedInstructionSet") == 0) {
enhancedInstructionSet = text;
}
}
}
else if (std::strcmp(name, "Link") == 0) {
for (const tinyxml2::XMLElement *e = e1->FirstChildElement(); e; e = e->NextSiblingElement()) {
const char * const text = e->GetText();
if (!text)
continue;
if (std::strcmp(e->Name(), "EntryPointSymbol") == 0) {
entryPointSymbol = text;
}
}
}
}
}
std::string enhancedInstructionSet;
std::string preprocessorDefinitions;
std::string additionalIncludePaths;
std::string entryPointSymbol; // TODO: use this
Standards::cppstd_t cppstd = Standards::CPPLatest;
};
struct ConfigurationPropertyGroup : ConditionalGroup {
explicit ConfigurationPropertyGroup(const tinyxml2::XMLElement *idg) : ConditionalGroup(idg) {
for (const tinyxml2::XMLElement *e = idg->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (std::strcmp(e->Name(), "UseOfMfc") == 0) {
useOfMfc = true;
} else if (std::strcmp(e->Name(), "CharacterSet") == 0) {
useUnicode = std::strcmp(e->GetText(), "Unicode") == 0;
}
}
}
bool useOfMfc = false;
bool useUnicode = false;
};
}
static std::list toStringList(const std::string &s)
{
std::list ret;
std::string::size_type pos1 = 0;
std::string::size_type pos2;
while ((pos2 = s.find(';',pos1)) != std::string::npos) {
ret.push_back(s.substr(pos1, pos2-pos1));
pos1 = pos2 + 1;
if (pos1 >= s.size())
break;
}
if (pos1 < s.size())
ret.push_back(s.substr(pos1));
return ret;
}
static void importPropertyGroup(const tinyxml2::XMLElement *node, std::map &variables, std::string &includePath)
{
const char* labelAttribute = node->Attribute("Label");
if (labelAttribute && std::strcmp(labelAttribute, "UserMacros") == 0) {
for (const tinyxml2::XMLElement *propertyGroup = node->FirstChildElement(); propertyGroup; propertyGroup = propertyGroup->NextSiblingElement()) {
const char* name = propertyGroup->Name();
const char *text = empty_if_null(propertyGroup->GetText());
variables[name] = text;
}
} else if (!labelAttribute) {
for (const tinyxml2::XMLElement *propertyGroup = node->FirstChildElement(); propertyGroup; propertyGroup = propertyGroup->NextSiblingElement()) {
if (std::strcmp(propertyGroup->Name(), "IncludePath") != 0)
continue;
const char *text = propertyGroup->GetText();
if (!text)
continue;
std::string path(text);
const std::string::size_type pos = path.find("$(IncludePath)");
if (pos != std::string::npos)
path.replace(pos, 14U, includePath);
includePath = std::move(path);
}
}
}
static void loadVisualStudioProperties(const std::string &props, std::map &variables, std::string &includePath, const std::string &additionalIncludeDirectories, std::list &itemDefinitionGroupList)
{
std::string filename(props);
// variables can't be resolved
if (!simplifyPathWithVariables(filename, variables))
return;
// prepend project dir (if it exists) to transform relative paths into absolute ones
if (!Path::isAbsolute(filename) && variables.count("ProjectDir") > 0)
filename = Path::getAbsoluteFilePath(variables.at("ProjectDir") + filename);
tinyxml2::XMLDocument doc;
if (doc.LoadFile(filename.c_str()) != tinyxml2::XML_SUCCESS)
return;
const tinyxml2::XMLElement * const rootnode = doc.FirstChildElement();
if (rootnode == nullptr)
return;
for (const tinyxml2::XMLElement *node = rootnode->FirstChildElement(); node; node = node->NextSiblingElement()) {
const char* name = node->Name();
if (std::strcmp(name, "ImportGroup") == 0) {
const char *labelAttribute = node->Attribute("Label");
if (labelAttribute == nullptr || std::strcmp(labelAttribute, "PropertySheets") != 0)
continue;
for (const tinyxml2::XMLElement *importGroup = node->FirstChildElement(); importGroup; importGroup = importGroup->NextSiblingElement()) {
if (std::strcmp(importGroup->Name(), "Import") == 0) {
const char *projectAttribute = importGroup->Attribute("Project");
if (projectAttribute == nullptr)
continue;
std::string loadprj(projectAttribute);
if (loadprj.find('$') == std::string::npos) {
loadprj = Path::getPathFromFilename(filename) + loadprj;
}
loadVisualStudioProperties(loadprj, variables, includePath, additionalIncludeDirectories, itemDefinitionGroupList);
}
}
} else if (std::strcmp(name,"PropertyGroup")==0) {
importPropertyGroup(node, variables, includePath);
} else if (std::strcmp(name,"ItemDefinitionGroup")==0) {
itemDefinitionGroupList.emplace_back(node, additionalIncludeDirectories);
}
}
}
bool ImportProject::importVcxproj(const std::string &filename,
std::map &variables,
const std::string &additionalIncludeDirectories,
const std::vector &fileFilters,
std::vector &cache)
{
tinyxml2::XMLDocument doc;
const tinyxml2::XMLError error = doc.LoadFile(filename.c_str());
if (error != tinyxml2::XML_SUCCESS) {
errors.emplace_back(std::string("Visual Studio project file is not a valid XML - ") + tinyxml2::XMLDocument::ErrorIDToName(error));
return false;
}
return importVcxproj(filename, doc, variables, additionalIncludeDirectories, fileFilters, cache);
}
bool ImportProject::importVcxproj(const std::string &filename, const tinyxml2::XMLDocument &doc, std::map &variables, const std::string &additionalIncludeDirectories, const std::vector &fileFilters, std::vector &cache)
{
variables["ProjectDir"] = Path::simplifyPath(Path::getPathFromFilename(filename));
std::list projectConfigurationList;
std::list compileList;
std::list itemDefinitionGroupList;
std::vector configurationPropertyGroups;
std::string includePath;
std::vector sharedItemsProjects;
const tinyxml2::XMLElement * const rootnode = doc.FirstChildElement();
if (rootnode == nullptr) {
errors.emplace_back("Visual Studio project file has no XML root node");
return false;
}
for (const tinyxml2::XMLElement *node = rootnode->FirstChildElement(); node; node = node->NextSiblingElement()) {
const char* name = node->Name();
if (std::strcmp(name, "ItemGroup") == 0) {
const char *labelAttribute = node->Attribute("Label");
if (labelAttribute && std::strcmp(labelAttribute, "ProjectConfigurations") == 0) {
for (const tinyxml2::XMLElement *cfg = node->FirstChildElement(); cfg; cfg = cfg->NextSiblingElement()) {
if (std::strcmp(cfg->Name(), "ProjectConfiguration") == 0) {
const ProjectConfiguration p(cfg);
if (p.platform != ProjectConfiguration::Unknown) {
projectConfigurationList.emplace_back(cfg);
mAllVSConfigs.insert(p.configuration);
}
}
}
} else {
for (const tinyxml2::XMLElement *e = node->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (std::strcmp(e->Name(), "ClCompile") == 0) {
const char *include = e->Attribute("Include");
if (include && Path::acceptFile(include)) {
std::string toInclude = Path::simplifyPath(Path::isAbsolute(include) ? include : Path::getPathFromFilename(filename) + include);
compileList.emplace_back(toInclude);
}
}
}
}
} else if (std::strcmp(name, "ItemDefinitionGroup") == 0) {
itemDefinitionGroupList.emplace_back(node, additionalIncludeDirectories);
} else if (std::strcmp(name, "PropertyGroup") == 0) {
const char* labelAttribute = node->Attribute("Label");
if (labelAttribute && std::strcmp(labelAttribute, "Configuration") == 0) {
configurationPropertyGroups.emplace_back(node);
} else {
importPropertyGroup(node, variables, includePath);
}
} else if (std::strcmp(name, "ImportGroup") == 0) {
const char *labelAttribute = node->Attribute("Label");
if (labelAttribute && std::strcmp(labelAttribute, "PropertySheets") == 0) {
for (const tinyxml2::XMLElement *e = node->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (std::strcmp(e->Name(), "Import") == 0) {
const char *projectAttribute = e->Attribute("Project");
if (projectAttribute)
loadVisualStudioProperties(projectAttribute, variables, includePath, additionalIncludeDirectories, itemDefinitionGroupList);
}
}
} else if (labelAttribute && std::strcmp(labelAttribute, "Shared") == 0) {
for (const tinyxml2::XMLElement *e = node->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (std::strcmp(e->Name(), "Import") == 0) {
const char *projectAttribute = e->Attribute("Project");
if (projectAttribute) {
// Path to shared items project is relative to current project directory,
// unless the string starts with $(SolutionDir)
std::string pathToSharedItemsFile;
if (std::string(projectAttribute).rfind("$(SolutionDir)", 0) == 0) {
pathToSharedItemsFile = projectAttribute;
} else {
pathToSharedItemsFile = variables["ProjectDir"] + projectAttribute;
}
if (!simplifyPathWithVariables(pathToSharedItemsFile, variables)) {
errors.emplace_back("Could not simplify path to referenced shared items project");
return false;
}
SharedItemsProject toAdd = importVcxitems(pathToSharedItemsFile, fileFilters, cache);
if (!toAdd.successful) {
errors.emplace_back("Could not load shared items project \"" + pathToSharedItemsFile + "\" from original path \"" + std::string(projectAttribute) + "\".");
return false;
}
sharedItemsProjects.emplace_back(toAdd);
}
}
}
}
}
}
// # TODO: support signedness of char via /J (and potential XML option for it)?
// we can only set it globally but in this context it needs to be treated per file
// Include shared items project files
std::vector sharedItemsIncludePaths;
for (const auto& sharedProject : sharedItemsProjects) {
for (const auto &file : sharedProject.sourceFiles) {
std::string pathToFile = Path::simplifyPath(Path::getPathFromFilename(sharedProject.pathToProjectFile) + file);
compileList.emplace_back(std::move(pathToFile));
}
for (const auto &p : sharedProject.includePaths) {
std::string path = Path::simplifyPath(Path::getPathFromFilename(sharedProject.pathToProjectFile) + p);
sharedItemsIncludePaths.emplace_back(std::move(path));
}
}
// Project files
PathMatch filtermatcher(fileFilters, Path::getCurrentPath());
for (const std::string &cfilename : compileList) {
if (!fileFilters.empty() && !filtermatcher.match(cfilename))
continue;
for (const ProjectConfiguration &p : projectConfigurationList) {
if (!guiProject.checkVsConfigs.empty()) {
const bool doChecking = std::any_of(guiProject.checkVsConfigs.cbegin(), guiProject.checkVsConfigs.cend(), [&](const std::string& c) {
return c == p.configuration;
});
if (!doChecking)
continue;
}
FileSettings fs{cfilename, Standards::Language::None, 0}; // file will be identified later on
fs.cfg = p.name;
// TODO: detect actual MSC version
fs.msc = true;
fs.defines = "_WIN32=1";
if (p.platform == ProjectConfiguration::Win32)
fs.platformType = Platform::Type::Win32W;
else if (p.platform == ProjectConfiguration::x64) {
fs.platformType = Platform::Type::Win64;
fs.defines += ";_WIN64=1";
}
std::string additionalIncludePaths;
for (const ItemDefinitionGroup &i : itemDefinitionGroupList) {
if (!i.conditionIsTrue(p, cfilename, errors))
continue;
fs.standard = Standards::getCPP(i.cppstd);
fs.defines += ';' + i.preprocessorDefinitions;
if (i.enhancedInstructionSet == "StreamingSIMDExtensions")
fs.defines += ";__SSE__";
else if (i.enhancedInstructionSet == "StreamingSIMDExtensions2")
fs.defines += ";__SSE2__";
else if (i.enhancedInstructionSet == "AdvancedVectorExtensions")
fs.defines += ";__AVX__";
else if (i.enhancedInstructionSet == "AdvancedVectorExtensions2")
fs.defines += ";__AVX2__";
else if (i.enhancedInstructionSet == "AdvancedVectorExtensions512")
fs.defines += ";__AVX512__";
additionalIncludePaths += ';' + i.additionalIncludePaths;
}
bool useUnicode = false;
for (const ConfigurationPropertyGroup &c : configurationPropertyGroups) {
if (!c.conditionIsTrue(p, cfilename, errors))
continue;
// in msbuild the last definition wins
useUnicode = c.useUnicode;
fs.useMfc = c.useOfMfc;
}
if (useUnicode) {
fs.defines += ";UNICODE=1;_UNICODE=1";
}
fsSetDefines(fs, fs.defines);
fsSetIncludePaths(fs, Path::getPathFromFilename(filename), toStringList(includePath + ';' + additionalIncludePaths), variables);
for (const auto &path : sharedItemsIncludePaths) {
fs.includePaths.emplace_back(path);
}
fileSettings.push_back(std::move(fs));
}
}
return true;
}
ImportProject::SharedItemsProject ImportProject::importVcxitems(const std::string& filename, const std::vector& fileFilters, std::vector &cache)
{
auto isInCacheCheck = [filename](const ImportProject::SharedItemsProject& e) -> bool {
return filename == e.pathToProjectFile;
};
const auto iterator = std::find_if(cache.begin(), cache.end(), isInCacheCheck);
if (iterator != std::end(cache)) {
return *iterator;
}
SharedItemsProject result;
result.pathToProjectFile = filename;
PathMatch filtermatcher(fileFilters, Path::getCurrentPath());
tinyxml2::XMLDocument doc;
const tinyxml2::XMLError error = doc.LoadFile(filename.c_str());
if (error != tinyxml2::XML_SUCCESS) {
errors.emplace_back(std::string("Visual Studio project file is not a valid XML - ") + tinyxml2::XMLDocument::ErrorIDToName(error));
return result;
}
const tinyxml2::XMLElement * const rootnode = doc.FirstChildElement();
if (rootnode == nullptr) {
errors.emplace_back("Visual Studio project file has no XML root node");
return result;
}
for (const tinyxml2::XMLElement *node = rootnode->FirstChildElement(); node; node = node->NextSiblingElement()) {
if (std::strcmp(node->Name(), "ItemGroup") == 0) {
for (const tinyxml2::XMLElement *e = node->FirstChildElement(); e; e = e->NextSiblingElement()) {
if (std::strcmp(e->Name(), "ClCompile") == 0) {
const char* include = e->Attribute("Include");
if (include && Path::acceptFile(include)) {
std::string file(include);
findAndReplace(file, "$(MSBuildThisFileDirectory)", "./");
// Skip file if it doesn't match the filter
if (!fileFilters.empty() && !filtermatcher.match(file))
continue;
result.sourceFiles.emplace_back(file);
} else {
errors.emplace_back("Could not find shared items source file");
return result;
}
}
}
} else if (std::strcmp(node->Name(), "ItemDefinitionGroup") == 0) {
ItemDefinitionGroup temp(node, "");
for (const auto& includePath : toStringList(temp.additionalIncludePaths)) {
if (includePath == "%(AdditionalIncludeDirectories)")
continue;
std::string toAdd(includePath);
findAndReplace(toAdd, "$(MSBuildThisFileDirectory)", "./");
result.includePaths.emplace_back(toAdd);
}
}
}
result.successful = true;
cache.emplace_back(result);
return result;
}
bool ImportProject::importBcb6Prj(const std::string &projectFilename)
{
tinyxml2::XMLDocument doc;
const tinyxml2::XMLError error = doc.LoadFile(projectFilename.c_str());
if (error != tinyxml2::XML_SUCCESS) {
errors.emplace_back(std::string("Borland project file is not a valid XML - ") + tinyxml2::XMLDocument::ErrorIDToName(error));
return false;
}
const tinyxml2::XMLElement * const rootnode = doc.FirstChildElement();
if (rootnode == nullptr) {
errors.emplace_back("Borland project file has no XML root node");
return false;
}
const std::string& projectDir = Path::simplifyPath(Path::getPathFromFilename(projectFilename));
std::list compileList;
std::string includePath;
std::string userdefines;
std::string sysdefines;
std::string cflag1;
for (const tinyxml2::XMLElement *node = rootnode->FirstChildElement(); node; node = node->NextSiblingElement()) {
const char* name = node->Name();
if (std::strcmp(name, "FILELIST") == 0) {
for (const tinyxml2::XMLElement *f = node->FirstChildElement(); f; f = f->NextSiblingElement()) {
if (std::strcmp(f->Name(), "FILE") == 0) {
const char *filename = f->Attribute("FILENAME");
if (filename && Path::acceptFile(filename))
compileList.emplace_back(filename);
}
}
} else if (std::strcmp(name, "MACROS") == 0) {
for (const tinyxml2::XMLElement *m = node->FirstChildElement(); m; m = m->NextSiblingElement()) {
const char* mname = m->Name();
if (std::strcmp(mname, "INCLUDEPATH") == 0) {
const char *v = m->Attribute("value");
if (v)
includePath = v;
} else if (std::strcmp(mname, "USERDEFINES") == 0) {
const char *v = m->Attribute("value");
if (v)
userdefines = v;
} else if (std::strcmp(mname, "SYSDEFINES") == 0) {
const char *v = m->Attribute("value");
if (v)
sysdefines = v;
}
}
} else if (std::strcmp(name, "OPTIONS") == 0) {
for (const tinyxml2::XMLElement *m = node->FirstChildElement(); m; m = m->NextSiblingElement()) {
if (std::strcmp(m->Name(), "CFLAG1") == 0) {
const char *v = m->Attribute("value");
if (v)
cflag1 = v;
}
}
}
}
std::set cflags;
// parse cflag1 and fill the cflags set
{
std::string arg;
for (const char i : cflag1) {
if (i == ' ' && !arg.empty()) {
cflags.insert(arg);
arg.clear();
continue;
}
arg += i;
}
if (!arg.empty()) {
cflags.insert(std::move(arg));
}
// cleanup: -t is "An alternate name for the -Wxxx switches; there is no difference"
// -> Remove every known -txxx argument and replace it with its -Wxxx counterpart.
// This way, we know what we have to check for later on.
static const std::map synonyms = {
{ "-tC","-WC" },
{ "-tCDR","-WCDR" },
{ "-tCDV","-WCDV" },
{ "-tW","-W" },
{ "-tWC","-WC" },
{ "-tWCDR","-WCDR" },
{ "-tWCDV","-WCDV" },
{ "-tWD","-WD" },
{ "-tWDR","-WDR" },
{ "-tWDV","-WDV" },
{ "-tWM","-WM" },
{ "-tWP","-WP" },
{ "-tWR","-WR" },
{ "-tWU","-WU" },
{ "-tWV","-WV" }
};
for (auto i = synonyms.cbegin(); i != synonyms.cend(); ++i) {
if (cflags.erase(i->first) > 0) {
cflags.insert(i->second);
}
}
}
std::string predefines;
std::string cppPredefines;
// Collecting predefines. See BCB6 help topic "Predefined macros"
{
cppPredefines +=
// Defined if you've selected C++ compilation; will increase in later releases.
// value 0x0560 (but 0x0564 for our BCB6 SP4)
// @see http://docwiki.embarcadero.com/RADStudio/Tokyo/en/Predefined_Macros#C.2B.2B_Compiler_Versions_in_Predefined_Macros
";__BCPLUSPLUS__=0x0560"
// Defined if in C++ mode; otherwise, undefined.
";__cplusplus=1"
// Defined as 1 for C++ files(meaning that templates are supported); otherwise, it is undefined.
";__TEMPLATES__=1"
// Defined only for C++ programs to indicate that wchar_t is an intrinsically defined data type.
";_WCHAR_T"
// Defined only for C++ programs to indicate that wchar_t is an intrinsically defined data type.
";_WCHAR_T_DEFINED"
// Defined in any compiler that has an optimizer.
";__BCOPT__=1"
// Version number.
// BCB6 is 0x056X (SP4 is 0x0564)
// @see http://docwiki.embarcadero.com/RADStudio/Tokyo/en/Predefined_Macros#C.2B.2B_Compiler_Versions_in_Predefined_Macros
";__BORLANDC__=0x0560"
";__TCPLUSPLUS__=0x0560"
";__TURBOC__=0x0560";
// Defined if Calling Convention is set to cdecl; otherwise undefined.
const bool useCdecl = (cflags.find("-p") == cflags.end()
&& cflags.find("-pm") == cflags.end()
&& cflags.find("-pr") == cflags.end()
&& cflags.find("-ps") == cflags.end());
if (useCdecl)
predefines += ";__CDECL=1";
// Defined by default indicating that the default char is unsigned char. Use the -K compiler option to undefine this macro.
const bool treatCharAsUnsignedChar = (cflags.find("-K") != cflags.end());
if (treatCharAsUnsignedChar)
predefines += ";_CHAR_UNSIGNED=1";
// Defined whenever one of the CodeGuard compiler options is used; otherwise it is undefined.
const bool codeguardUsed = (cflags.find("-vGd") != cflags.end()
|| cflags.find("-vGt") != cflags.end()
|| cflags.find("-vGc") != cflags.end());
if (codeguardUsed)
predefines += ";__CODEGUARD__";
// When defined, the macro indicates that the program is a console application.
const bool isConsoleApp = (cflags.find("-WC") != cflags.end());
if (isConsoleApp)
predefines += ";__CONSOLE__=1";
// Enable stack unwinding. This is true by default; use -xd- to disable.
const bool enableStackUnwinding = (cflags.find("-xd-") == cflags.end());
if (enableStackUnwinding)
predefines += ";_CPPUNWIND=1";
// Defined whenever the -WD compiler option is used; otherwise it is undefined.
const bool isDLL = (cflags.find("-WD") != cflags.end());
if (isDLL)
predefines += ";__DLL__=1";
// Defined when compiling in 32-bit flat memory model.
// TODO: not sure how to switch to another memory model or how to read configuration from project file
predefines += ";__FLAT__=1";
// Always defined. The default value is 300. You can change the value to 400 or 500 by using the /4 or /5 compiler options.
if (cflags.find("-6") != cflags.end())
predefines += ";_M_IX86=600";
else if (cflags.find("-5") != cflags.end())
predefines += ";_M_IX86=500";
else if (cflags.find("-4") != cflags.end())
predefines += ";_M_IX86=400";
else
predefines += ";_M_IX86=300";
// Defined only if the -WM option is used. It specifies that the multithread library is to be linked.
const bool linkMtLib = (cflags.find("-WM") != cflags.end());
if (linkMtLib)
predefines += ";__MT__=1";
// Defined if Calling Convention is set to Pascal; otherwise undefined.
const bool usePascalCallingConvention = (cflags.find("-p") != cflags.end());
if (usePascalCallingConvention)
predefines += ";__PASCAL__=1";
// Defined if you compile with the -A compiler option; otherwise, it is undefined.
const bool useAnsiKeywordExtensions = (cflags.find("-A") != cflags.end());
if (useAnsiKeywordExtensions)
predefines += ";__STDC__=1";
// Thread Local Storage. Always true in C++Builder.
predefines += ";__TLC__=1";
// Defined for Windows-only code.
const bool isWindowsTarget = (cflags.find("-WC") != cflags.end()
|| cflags.find("-WCDR") != cflags.end()
|| cflags.find("-WCDV") != cflags.end()
|| cflags.find("-WD") != cflags.end()
|| cflags.find("-WDR") != cflags.end()
|| cflags.find("-WDV") != cflags.end()
|| cflags.find("-WM") != cflags.end()
|| cflags.find("-WP") != cflags.end()
|| cflags.find("-WR") != cflags.end()
|| cflags.find("-WU") != cflags.end()
|| cflags.find("-WV") != cflags.end());
if (isWindowsTarget)
predefines += ";_Windows";
// Defined for console and GUI applications.
// TODO: I'm not sure about the difference to define "_Windows".
// From description, I would assume __WIN32__ is only defined for
// executables, while _Windows would also be defined for DLLs, etc.
// However, in a newly created DLL project, both __WIN32__ and
// _Windows are defined. -> treating them the same for now.
// Also boost uses __WIN32__ for OS identification.
const bool isConsoleOrGuiApp = isWindowsTarget;
if (isConsoleOrGuiApp)
predefines += ";__WIN32__=1";
}
// Include paths may contain variables like "$(BCB)\include" or "$(BCB)\include\vcl".
// Those get resolved by ImportProject::FileSettings::setIncludePaths by
// 1. checking the provided variables map ("BCB" => "C:\\Program Files (x86)\\Borland\\CBuilder6")
// 2. checking env variables as a fallback
// Setting env is always possible. Configuring the variables via cli might be an addition.
// Reading the BCB6 install location from registry in windows environments would also be possible,
// but I didn't see any such functionality around the source. Not in favor of adding it only
// for the BCB6 project loading.
std::map variables;
const std::string defines = predefines + ";" + sysdefines + ";" + userdefines;
const std::string cppDefines = cppPredefines + ";" + defines;
const bool forceCppMode = (cflags.find("-P") != cflags.end());
for (const std::string &c : compileList) {
// C++ compilation is selected by file extension by default, so these
// defines have to be configured on a per-file base.
//
// > Files with the .CPP extension compile as C++ files. Files with a .C
// > extension, with no extension, or with extensions other than .CPP,
// > .OBJ, .LIB, or .ASM compile as C files.
// (http://docwiki.embarcadero.com/RADStudio/Tokyo/en/BCC32.EXE,_the_C%2B%2B_32-bit_Command-Line_Compiler)
//
// We can also force C++ compilation for all files using the -P command line switch.
const bool cppMode = forceCppMode || Path::getFilenameExtensionInLowerCase(c) == ".cpp";
// TODO: needs to set language and ignore later identification and language enforcement
FileSettings fs{Path::simplifyPath(Path::isAbsolute(c) ? c : projectDir + c), Standards::Language::None, 0}; // file will be identified later on
fsSetIncludePaths(fs, projectDir, toStringList(includePath), variables);
fsSetDefines(fs, cppMode ? cppDefines : defines);
fileSettings.push_back(std::move(fs));
}
return true;
}
static std::string joinRelativePath(const std::string &path1, const std::string &path2)
{
if (!path1.empty() && !Path::isAbsolute(path2))
return path1 + path2;
return path2;
}
static std::list readXmlStringList(const tinyxml2::XMLElement *node, const std::string &path, const char name[], const char attribute[])
{
std::list ret;
for (const tinyxml2::XMLElement *child = node->FirstChildElement(); child; child = child->NextSiblingElement()) {
if (strcmp(child->Name(), name) != 0)
continue;
const char *attr = attribute ? child->Attribute(attribute) : child->GetText();
if (attr)
ret.emplace_back(joinRelativePath(path, attr));
}
return ret;
}
static std::list readXmlPathMatchList(const tinyxml2::XMLElement *node, const std::string &path, const char name[], const char attribute[])
{
std::list ret;
for (const tinyxml2::XMLElement *child = node->FirstChildElement(); child; child = child->NextSiblingElement()) {
if (strcmp(child->Name(), name) != 0)
continue;
const char *attr = attribute ? child->Attribute(attribute) : child->GetText();
if (attr)
ret.emplace_back(PathMatch::joinRelativePattern(path, attr));
}
return ret;
}
static std::string join(const std::list &strlist, const char *sep)
{
std::string ret;
for (const std::string &s : strlist) {
ret += (ret.empty() ? "" : sep) + s;
}
return ret;
}
static std::string istream_to_string(std::istream &istr)
{
std::istreambuf_iterator eos;
return std::string(std::istreambuf_iterator(istr), eos);
}
bool ImportProject::importCppcheckGuiProject(std::istream &istr, Settings &settings, Suppressions &supprs)
{
tinyxml2::XMLDocument doc;
const std::string xmldata = istream_to_string(istr);
const tinyxml2::XMLError error = doc.Parse(xmldata.data(), xmldata.size());
if (error != tinyxml2::XML_SUCCESS) {
errors.emplace_back(std::string("Cppcheck GUI project file is not a valid XML - ") + tinyxml2::XMLDocument::ErrorIDToName(error));
return false;
}
const tinyxml2::XMLElement * const rootnode = doc.FirstChildElement();
if (rootnode == nullptr || strcmp(rootnode->Name(), CppcheckXml::ProjectElementName) != 0) {
errors.emplace_back("Cppcheck GUI project file has no XML root node");
return false;
}
const std::string &path = mPath;
std::list paths;
std::list suppressions;
Settings temp;
// default to --check-level=normal for import for now
temp.setCheckLevel(Settings::CheckLevel::normal);
// TODO: this should support all available command-line options
for (const tinyxml2::XMLElement *node = rootnode->FirstChildElement(); node; node = node->NextSiblingElement()) {
const char* name = node->Name();
if (strcmp(name, CppcheckXml::RootPathName) == 0) {
const char* attr = node->Attribute(CppcheckXml::RootPathNameAttrib);
if (attr) {
temp.basePaths.push_back(Path::fromNativeSeparators(joinRelativePath(path, attr)));
temp.relativePaths = true;
}
} else if (strcmp(name, CppcheckXml::BuildDirElementName) == 0)
temp.buildDir = joinRelativePath(path, empty_if_null(node->GetText()));
else if (strcmp(name, CppcheckXml::IncludeDirElementName) == 0)
temp.includePaths = readXmlStringList(node, path, CppcheckXml::DirElementName, CppcheckXml::DirNameAttrib); // TODO: append instead of overwrite
else if (strcmp(name, CppcheckXml::DefinesElementName) == 0)
temp.userDefines = join(readXmlStringList(node, "", CppcheckXml::DefineName, CppcheckXml::DefineNameAttrib), ";"); // TODO: append instead of overwrite
else if (strcmp(name, CppcheckXml::UndefinesElementName) == 0) {
for (const std::string &u : readXmlStringList(node, "", CppcheckXml::UndefineName, nullptr))
temp.userUndefs.insert(u);
} else if (strcmp(name, CppcheckXml::UserIncludeElementName) == 0) {
const char* i = node->GetText();
if (i)
temp.userIncludes.emplace_back(i);
} else if (strcmp(name, CppcheckXml::ImportProjectElementName) == 0) {
const std::string t_str = empty_if_null(node->GetText());
if (!t_str.empty())
guiProject.projectFile = path + t_str;
}
else if (strcmp(name, CppcheckXml::PathsElementName) == 0)
paths = readXmlStringList(node, path, CppcheckXml::PathName, CppcheckXml::PathNameAttrib);
else if (strcmp(name, CppcheckXml::ExcludeElementName) == 0)
guiProject.excludedPaths = readXmlPathMatchList(node, path, CppcheckXml::ExcludePathName, CppcheckXml::ExcludePathNameAttrib); // TODO: append instead of overwrite
else if (strcmp(name, CppcheckXml::FunctionContracts) == 0)
;
else if (strcmp(name, CppcheckXml::VariableContractsElementName) == 0)
;
else if (strcmp(name, CppcheckXml::IgnoreElementName) == 0)
guiProject.excludedPaths = readXmlPathMatchList(node, path, CppcheckXml::IgnorePathName, CppcheckXml::IgnorePathNameAttrib); // TODO: append instead of overwrite
else if (strcmp(name, CppcheckXml::LibrariesElementName) == 0)
guiProject.libraries = readXmlStringList(node, "", CppcheckXml::LibraryElementName, nullptr); // TODO: append instead of overwrite
else if (strcmp(name, CppcheckXml::SuppressionsElementName) == 0) {
for (const tinyxml2::XMLElement *child = node->FirstChildElement(); child; child = child->NextSiblingElement()) {
if (strcmp(child->Name(), CppcheckXml::SuppressionElementName) != 0)
continue;
SuppressionList::Suppression s;
s.errorId = empty_if_null(child->GetText());
s.fileName = empty_if_null(child->Attribute("fileName"));
if (!s.fileName.empty())
s.fileName = joinRelativePath(path, s.fileName);
s.lineNumber = child->IntAttribute("lineNumber", SuppressionList::Suppression::NO_LINE); // TODO: should not depend on Suppression
s.symbolName = empty_if_null(child->Attribute("symbolName"));
s.hash = strToInt(default_if_null(child->Attribute("hash"), "0"));
suppressions.push_back(std::move(s));
}
} else if (strcmp(name, CppcheckXml::VSConfigurationElementName) == 0)
guiProject.checkVsConfigs = readXmlStringList(node, "", CppcheckXml::VSConfigurationName, nullptr);
else if (strcmp(name, CppcheckXml::PlatformElementName) == 0)
guiProject.platform = empty_if_null(node->GetText());
else if (strcmp(name, CppcheckXml::AnalyzeAllVsConfigsElementName) == 0)
temp.analyzeAllVsConfigs = std::string(empty_if_null(node->GetText())) != "false";
else if (strcmp(name, CppcheckXml::Parser) == 0)
temp.clang = true;
else if (strcmp(name, CppcheckXml::AddonsElementName) == 0) {
const auto& addons = readXmlStringList(node, "", CppcheckXml::AddonElementName, nullptr);
temp.addons.insert(addons.cbegin(), addons.cend());
if (settings.premium) {
auto it = temp.addons.find("misra");
if (it != temp.addons.end()) {
temp.addons.erase(it);
temp.premiumArgs += " --misra-c-2012";
}
}
}
else if (strcmp(name, CppcheckXml::TagsElementName) == 0)
node->Attribute(CppcheckXml::TagElementName); // FIXME: Write some warning
else if (strcmp(name, CppcheckXml::ToolsElementName) == 0) {
const std::list toolList = readXmlStringList(node, "", CppcheckXml::ToolElementName, nullptr);
for (const std::string &toolName : toolList) {
if (toolName == CppcheckXml::ClangTidy)
temp.clangTidy = true;
}
} else if (strcmp(name, CppcheckXml::CheckHeadersElementName) == 0)
temp.checkHeaders = (strcmp(default_if_null(node->GetText(), ""), "true") == 0);
else if (strcmp(name, CppcheckXml::CheckLevelReducedElementName) == 0)
temp.setCheckLevel(Settings::CheckLevel::reduced);
else if (strcmp(name, CppcheckXml::CheckLevelNormalElementName) == 0)
temp.setCheckLevel(Settings::CheckLevel::normal);
else if (strcmp(name, CppcheckXml::CheckLevelExhaustiveElementName) == 0)
temp.setCheckLevel(Settings::CheckLevel::exhaustive);
else if (strcmp(name, CppcheckXml::CheckUnusedTemplatesElementName) == 0)
temp.checkUnusedTemplates = (strcmp(default_if_null(node->GetText(), ""), "true") == 0);
else if (strcmp(name, CppcheckXml::InlineSuppression) == 0)
temp.inlineSuppressions = (strcmp(default_if_null(node->GetText(), ""), "true") == 0);
else if (strcmp(name, CppcheckXml::MaxCtuDepthElementName) == 0)
temp.maxCtuDepth = strToInt(default_if_null(node->GetText(), "2")); // TODO: bail out when missing?
else if (strcmp(name, CppcheckXml::MaxTemplateRecursionElementName) == 0)
temp.maxTemplateRecursion = strToInt(default_if_null(node->GetText(), "100")); // TODO: bail out when missing?
else if (strcmp(name, CppcheckXml::CheckUnknownFunctionReturn) == 0)
; // TODO
else if (strcmp(name, Settings::SafeChecks::XmlRootName) == 0) {
for (const tinyxml2::XMLElement *child = node->FirstChildElement(); child; child = child->NextSiblingElement()) {
const char* childname = child->Name();
if (strcmp(childname, Settings::SafeChecks::XmlClasses) == 0)
temp.safeChecks.classes = true;
else if (strcmp(childname, Settings::SafeChecks::XmlExternalFunctions) == 0)
temp.safeChecks.externalFunctions = true;
else if (strcmp(childname, Settings::SafeChecks::XmlInternalFunctions) == 0)
temp.safeChecks.internalFunctions = true;
else if (strcmp(childname, Settings::SafeChecks::XmlExternalVariables) == 0)
temp.safeChecks.externalVariables = true;
else {
errors.emplace_back("Unknown '" + std::string(Settings::SafeChecks::XmlRootName) + "' element '" + childname + "' in Cppcheck GUI project file");
return false;
}
}
} else if (strcmp(name, CppcheckXml::TagWarningsElementName) == 0)
; // TODO
// Cppcheck Premium features
else if (strcmp(name, CppcheckXml::BughuntingElementName) == 0)
temp.premiumArgs += " --bughunting";
else if (strcmp(name, CppcheckXml::CertIntPrecisionElementName) == 0)
temp.premiumArgs += std::string(" --cert-c-int-precision=") + default_if_null(node->GetText(), "0");
else if (strcmp(name, CppcheckXml::CodingStandardsElementName) == 0) {
for (const tinyxml2::XMLElement *child = node->FirstChildElement(); child; child = child->NextSiblingElement()) {
if (strcmp(child->Name(), CppcheckXml::CodingStandardElementName) == 0) {
const char* text = child->GetText();
if (text)
temp.premiumArgs += std::string(" --") + text;
}
}
}
else if (strcmp(name, CppcheckXml::ProjectNameElementName) == 0)
; // no-op
else {
errors.emplace_back("Unknown element '" + std::string(name) + "' in Cppcheck GUI project file");
return false;
}
}
settings.basePaths = temp.basePaths; // TODO: append instead of overwrite
settings.relativePaths |= temp.relativePaths;
settings.buildDir = temp.buildDir;
settings.includePaths = temp.includePaths; // TODO: append instead of overwrite
settings.userDefines = temp.userDefines; // TODO: append instead of overwrite
settings.userUndefs = temp.userUndefs; // TODO: append instead of overwrite
settings.userIncludes = temp.userIncludes; // TODO: append instead of overwrite
for (const std::string &addon : temp.addons)
settings.addons.emplace(addon);
settings.clang = temp.clang;
settings.clangTidy = temp.clangTidy;
settings.analyzeAllVsConfigs = temp.analyzeAllVsConfigs;
if (!settings.premiumArgs.empty())
settings.premiumArgs += temp.premiumArgs;
else if (!temp.premiumArgs.empty())
settings.premiumArgs = temp.premiumArgs.substr(1);
for (const std::string &p : paths)
guiProject.pathNames.push_back(Path::fromNativeSeparators(p));
supprs.nomsg.addSuppressions(std::move(suppressions)); // TODO: check result
settings.checkHeaders = temp.checkHeaders;
settings.checkUnusedTemplates = temp.checkUnusedTemplates;
settings.maxCtuDepth = temp.maxCtuDepth;
settings.maxTemplateRecursion = temp.maxTemplateRecursion;
settings.inlineSuppressions |= temp.inlineSuppressions;
settings.safeChecks = temp.safeChecks;
settings.setCheckLevel(temp.checkLevel);
return true;
}
void ImportProject::selectOneVsConfig(Platform::Type platform)
{
std::set filenames;
for (auto it = fileSettings.cbegin(); it != fileSettings.cend();) {
if (it->cfg.empty()) {
++it;
continue;
}
const FileSettings &fs = *it;
bool remove = false;
if (!startsWith(fs.cfg,"Debug"))
remove = true;
if (platform == Platform::Type::Win64 && fs.platformType != platform)
remove = true;
else if ((platform == Platform::Type::Win32A || platform == Platform::Type::Win32W) && fs.platformType == Platform::Type::Win64)
remove = true;
else if (filenames.find(fs.filename()) != filenames.end())
remove = true;
if (remove) {
it = fileSettings.erase(it);
} else {
filenames.insert(fs.filename());
++it;
}
}
}
void ImportProject::selectVsConfigurations(Platform::Type platform, const std::vector &configurations)
{
for (auto it = fileSettings.cbegin(); it != fileSettings.cend();) {
if (it->cfg.empty()) {
++it;
continue;
}
const FileSettings &fs = *it;
const auto config = fs.cfg.substr(0, fs.cfg.find('|'));
bool remove = false;
if (std::find(configurations.begin(), configurations.end(), config) == configurations.end())
remove = true;
if (platform == Platform::Type::Win64 && fs.platformType != platform)
remove = true;
else if ((platform == Platform::Type::Win32A || platform == Platform::Type::Win32W) && fs.platformType == Platform::Type::Win64)
remove = true;
if (remove) {
it = fileSettings.erase(it);
} else {
++it;
}
}
}
std::list ImportProject::getVSConfigs()
{
return std::list(mAllVSConfigs.cbegin(), mAllVSConfigs.cend());
}
void ImportProject::setRelativePaths(const std::string &filename)
{
if (Path::isAbsolute(filename))
return;
const std::vector basePaths{Path::fromNativeSeparators(Path::getCurrentPath())};
for (auto &fs: fileSettings) {
fs.file.setPath(Path::getRelativePath(fs.filename(), basePaths));
for (auto &includePath: fs.includePaths)
includePath = Path::getRelativePath(includePath, basePaths);
}
}
// only used by tests (testimportproject.cpp::testVcxprojConditions):
// cppcheck-suppress unusedFunction
bool cppcheck::testing::evaluateVcxprojCondition(const std::string& condition, const std::string& configuration,
const std::string& platform)
{
ProjectConfiguration p;
p.configuration = configuration;
p.platformStr = platform;
return ConditionalGroup::evalCondition(condition, p);
}