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 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564
|
#include "clFileSystemWorkspaceConfig.hpp"
#include "ICompilerLocator.h"
#include "build_settings_config.h"
#include "clFileSystemWorkspace.hpp"
#include "compiler_command_line_parser.h"
#include "ctags_manager.h"
#include "debuggermanager.h"
#include "dirsaver.h"
#include "event_notifier.h"
#include "file_logger.h"
#include "fileextmanager.h"
#include "macromanager.h"
#include "procutils.h"
#define DEFAULT_FILE_EXTENSIONS \
"*.cpp;*.c;*.txt;*.json;*.hpp;*.cc;*.cxx;*.xml;*.h;*.wxcp;*.py;*.php;*.rb;*.html;*.js;*.ts;*.rs;*.iss;*.md;*.bat;" \
"*.sh;*.cmake"
#define WORKSPACE_TYPE "File System Workspace"
#define DEFAULT_EXCLUDE_FILE_PATTERN "*.o;*.pyc;*.obj;*.workspace;*.o.d;*.exe;*.dll;*.project"
wxDEFINE_EVENT(wxEVT_FSW_SETTINGS_SAVED, clCommandEvent);
wxDEFINE_EVENT(wxEVT_FSW_SETTINGS_LOADED, clCommandEvent);
clFileSystemWorkspaceConfig::clFileSystemWorkspaceConfig()
: m_fileExtensions(DEFAULT_FILE_EXTENSIONS)
, m_excludeFilesPattern(DEFAULT_EXCLUDE_FILE_PATTERN)
{
m_buildTargets.insert({ "build", "" });
m_buildTargets.insert({ "clean", "" });
m_debugger = DebuggerMgr::Get().GetActiveDebuggerName();
CompilerPtr compiler = BuildSettingsConfigST::Get()->GetDefaultCompiler(COMPILER_DEFAULT_FAMILY);
if(compiler) {
m_compiler = compiler->GetName();
}
}
///===-------------------------------------
/// A single workspace configuration
///===-------------------------------------
std::pair<JSONItem, JSONItem> clFileSystemWorkspaceConfig::ToJSON() const
{
// we store items in two locations:
// local & shared
// the local shared is only accessible to the current machine
// while the shared can be stored in git or any other source control
JSONItem shared = JSONItem::createObject();
shared.addProperty("name", GetName());
JSONItem arrTargets = shared.AddArray("targets");
for(const auto& vt : m_buildTargets) {
JSONItem target = JSONItem::createArray();
arrTargets.arrayAppend(target);
target.arrayAppend(vt.first);
target.arrayAppend(vt.second);
}
shared.addProperty("file_extensions", m_fileExtensions);
shared.addProperty("excludeFilesPattern", m_excludeFilesPattern);
shared.addProperty("excludePaths", m_excludePaths);
shared.addProperty("debugger", m_debugger);
// Local items
JSONItem local = JSONItem::createObject();
local.addProperty("name", GetName());
local.addProperty("flags", m_flags);
local.addProperty("compile_flags", m_compileFlags);
local.addProperty("executable", m_executable);
local.addProperty("arguments", m_args);
local.addProperty("environment", m_environment);
local.addProperty("compiler", m_compiler);
local.addProperty("remoteFolder", m_remoteFolder);
local.addProperty("remoteAccount", m_remoteAccount);
local.addProperty("workingDirectory", m_workingDirectory);
local.addProperty("debuggerPath", m_debuggerPath);
local.addProperty("debuggerCommands", m_debuggerCommands);
local.addProperty("last_executables", m_lastExecutables);
return { shared, local };
}
void clFileSystemWorkspaceConfig::FromSharedJSON(const JSONItem& json)
{
m_name = json.namedObject("name").toString();
JSONItem arrTargets = json.namedObject("targets");
int nCount = arrTargets.arraySize();
m_buildTargets.clear();
for(int i = 0; i < nCount; ++i) {
JSONItem target = arrTargets.arrayItem(i);
if(target.arraySize() != 2) {
continue;
}
m_buildTargets.insert({ target[0].toString(), target[1].toString() });
}
m_fileExtensions = json.namedObject("file_extensions").toString(m_fileExtensions);
m_excludeFilesPattern = json.namedObject("excludeFilesPattern").toString(m_excludeFilesPattern);
m_excludePaths = json.namedObject("excludePaths").toString(m_excludePaths);
m_debugger = json.namedObject("debugger").toString(m_debugger);
}
void clFileSystemWorkspaceConfig::FromLocalJSON(const JSONItem& json)
{
m_name = json["name"].toString();
m_flags = json["flags"].toSize_t(m_flags);
m_compileFlags = json["compile_flags"].toArrayString();
m_executable = json["executable"].toString();
wxArrayString last_execs = json["last_executables"].toArrayString();
// calling SetLastExecutables ensures that we dont add empty paths
SetLastExecutables(last_execs);
m_args = json["arguments"].toString();
m_environment = json["environment"].toString();
m_compiler = json["compiler"].toString(m_compiler);
m_remoteFolder = json["remoteFolder"].toString();
m_remoteAccount = json["remoteAccount"].toString();
m_workingDirectory = json["workingDirectory"].toString();
m_debuggerPath = json["debuggerPath"].toString();
m_debuggerCommands = json["debuggerCommands"].toString();
}
void clFileSystemWorkspaceConfig::FromJSONOld(const JSONItem& json)
{
FromSharedJSON(json);
FromLocalJSON(json);
}
wxArrayString clFileSystemWorkspaceConfig::GetSearchPaths(const wxFileName& workspaceFile) const
{
// Update the parser search paths (the default compiler paths)
auto backticks_cache = clFileSystemWorkspace::Get().GetBackticksCache();
wxArrayString searchPaths = TagsManagerST::Get()->GetCtagsOptions().GetParserSearchPaths();
wxArrayString userPaths = ExpandUserCompletionFlags(workspaceFile.GetPath(), backticks_cache, false);
// Append the lists
searchPaths.insert(searchPaths.end(), userPaths.begin(), userPaths.end());
wxArrayString uniquePaths;
std::unordered_set<wxString> S;
for(const wxString& path : searchPaths) {
wxFileName fn(path, "");
wxString fixedPath = fn.GetPath();
if(S.count(fixedPath) == 0) {
S.insert(fixedPath);
uniquePaths.Add(fixedPath);
}
}
return uniquePaths;
}
wxString clFileSystemWorkspaceConfig::GetCompileFlagsAsString() const
{
wxString s;
for(const wxString& l : m_compileFlags) {
if(!l.IsEmpty()) {
s << l << "\n";
}
}
return s.Trim();
}
void clFileSystemWorkspaceConfig::SetCompileFlags(const wxString& compileFlags)
{
m_compileFlags = ::wxStringTokenize(compileFlags, "\r\n", wxTOKEN_STRTOK);
}
clFileSystemWorkspaceConfig::Ptr_t clFileSystemWorkspaceConfig::Clone() const
{
return clFileSystemWorkspaceConfig::Ptr_t(new clFileSystemWorkspaceConfig(*this));
}
static wxArrayString GetExtraFlags(CompilerPtr compiler)
{
wxArrayString flags;
if(compiler->HasMetadata()) {
auto md = compiler->GetMetadata();
if(!md.GetTarget().IsEmpty()) {
flags.Add("-target");
flags.Add(md.GetTarget());
}
}
return flags;
}
wxArrayString clFileSystemWorkspaceConfig::GetCompilerOptions(clBacktickCache::ptr_t backticks) const
{
wxArrayString searchPaths;
wxUnusedVar(backticks);
// Add the compiler paths
CompilerPtr compiler = BuildSettingsConfigST::Get()->GetCompiler(GetCompiler());
if(compiler) {
wxArrayString compilerPaths = compiler->GetDefaultIncludePaths();
if(!compiler->GetGlobalIncludePath().IsEmpty()) {
wxArrayString globalIncludePaths =
::wxStringTokenize(compiler->GetGlobalIncludePath(), ";", wxTOKEN_STRTOK);
compilerPaths.insert(compilerPaths.end(), globalIncludePaths.begin(), globalIncludePaths.end());
}
for(wxString& compilerPath : compilerPaths) {
compilerPath.Prepend("-I");
}
searchPaths.insert(searchPaths.end(), compilerPaths.begin(), compilerPaths.end());
auto extraFlags = GetExtraFlags(compiler);
if(!extraFlags.empty()) {
searchPaths.insert(searchPaths.end(), extraFlags.begin(), extraFlags.end());
}
}
return searchPaths;
}
wxArrayString clFileSystemWorkspaceConfig::ExpandUserCompletionFlags(const wxString& workingDirectory,
clBacktickCache::ptr_t backticks,
bool withPrefix) const
{
wxArrayString searchPaths;
for(const auto& line : m_compileFlags) {
// we support up to one backtick in a line
wxString backtick = line.AfterFirst('`');
backtick = backtick.BeforeLast('`');
wxString prefix;
wxString suffix;
if(line.Index('`') != wxString::npos) {
prefix = line.BeforeFirst('`');
suffix = line.AfterLast('`');
} else {
prefix = line;
}
wxString backtick_expanded;
if(!backtick.empty()) {
if(backticks && backticks->HasCommand(backtick)) {
backtick_expanded = backticks->GetExpanded(backtick);
} else {
// we got backtick, expand it
DirSaver ds;
::wxSetWorkingDirectory(workingDirectory);
// Now run the command
clDEBUG() << "Working directory is set to:" << workingDirectory << clEndl;
clDEBUG() << "Running command:" << backtick << clEndl;
backtick_expanded = ProcUtils::SafeExecuteCommand(backtick);
backtick_expanded.Trim().Trim(false);
// keep the result for future lookups
if(backticks) {
backticks->SetCommand(backtick, backtick_expanded);
backticks->Save();
}
clDEBUG() << "Output:" << backtick_expanded << clEndl;
}
}
wxString line_expanded = prefix + backtick_expanded + suffix;
// Incase we got backticks, we need to apply the environment
CompilerCommandLineParser cclp(line_expanded, workingDirectory);
// Get the include paths (-I)
if(withPrefix) {
searchPaths.insert(searchPaths.end(), cclp.GetIncludesWithPrefix().begin(),
cclp.GetIncludesWithPrefix().end());
} else {
searchPaths.insert(searchPaths.end(), cclp.GetIncludes().begin(), cclp.GetIncludes().end());
}
// Get the macros (-D)
searchPaths.insert(searchPaths.end(), cclp.GetMacrosWithPrefix().begin(), cclp.GetMacrosWithPrefix().end());
if(!cclp.GetStandard().empty()) {
// -std=NNN
searchPaths.push_back(cclp.GetStandardWithPrefix());
}
// Other options
searchPaths.insert(searchPaths.end(), cclp.GetOtherOptions().begin(), cclp.GetOtherOptions().end());
}
// expand any macro
for(auto& path : searchPaths) {
path = MacroManager::Instance()->Expand(path, nullptr, "", "");
}
return searchPaths;
}
wxArrayString clFileSystemWorkspaceConfig::GetWorkspaceIncludes(bool withPrefix) const
{
auto all_files = clFileSystemWorkspace::Get().GetFiles();
// collect list of paths from the workspace
wxArrayString workspaceDirsArr;
wxStringSet_t workspaceDirsSet;
for(const auto& file : all_files) {
if(!FileExtManager::IsCxxFile(file.GetFullName())) {
continue;
}
wxString path = file.GetPath();
if(path.Contains("/CMakeFiles")) {
// CMake internal folder, ignore it
continue;
}
if(workspaceDirsSet.count(path) == 0) {
workspaceDirsSet.insert(path);
wxString fixedPath;
if(withPrefix) {
fixedPath << "-I";
}
fixedPath << path;
workspaceDirsArr.Add(fixedPath);
}
}
return workspaceDirsArr;
}
void clFileSystemWorkspaceConfig::SetLastExecutables(const wxArrayString& lastExecutables)
{
m_lastExecutables.clear();
m_lastExecutables.reserve(lastExecutables.size());
for(auto path : lastExecutables) {
path.Trim().Trim(false);
if(path.empty()) {
continue;
}
m_lastExecutables.Add(path);
}
}
const wxArrayString& clFileSystemWorkspaceConfig::GetLastExecutables() const { return m_lastExecutables; }
///===-------------------------------------
/// Workspace settings
///===-------------------------------------
clFileSystemWorkspaceSettings::clFileSystemWorkspaceSettings()
{
Clear(); // Create with the default "Debug" target
}
clFileSystemWorkspaceSettings::~clFileSystemWorkspaceSettings() {}
void clFileSystemWorkspaceSettings::ToJSON(JSONItem& shared, JSONItem& local) const
{
// add the shared items
shared.addProperty("workspace_type", WORKSPACE_TYPE);
shared.addProperty("name", m_name);
// Add the shared items
{
JSONItem configs = shared.AddArray("configs");
for(const auto& config : m_configsMap) {
configs.arrayAppend(config.second->ToJSON().first);
}
}
// add the local items
{
local.addProperty("selected_config", m_selectedConfig);
JSONItem configs = local.AddArray("configs");
for(const auto& config : m_configsMap) {
configs.arrayAppend(config.second->ToJSON().second);
}
}
}
void clFileSystemWorkspaceSettings::FromJSON(const JSONItem& shared, const JSONItem& local)
{
// first load the settings from the shared workspace config
m_workspaceType = shared.namedObject("workspace_type").toString(WORKSPACE_TYPE);
m_name = shared.namedObject("name").toString();
// The "selected config" is kept in the local workspace
m_selectedConfig = local.namedObject("selected_config").toString();
// load the configurations
JSONItem sharedConfigs = shared.namedObject("configs");
JSONItem localConfigs = local.namedObject("configs");
if(sharedConfigs.arraySize() != localConfigs.arraySize()) {
clSYSTEM() << "Notice: File System Workspace: local config and shared configs do not match!" << endl;
}
// Loop over the local configs and keep them in a map
// this is because the number of confiugration entires in
// the local workspace does not match to the shared one
// this can happen when loading the workspace on different
// machines (when the shared version is kept in SCM)
std::unordered_map<wxString, JSONItem> localConfigsMap;
int localCount = localConfigs.arraySize();
for(int i = 0; i < localCount; ++i) {
auto c = localConfigs[i];
localConfigsMap.insert({ c["name"].toString(), c });
}
int nCount = sharedConfigs.arraySize();
wxString firstConfig;
bool selectedConfigFound = false;
m_configsMap.clear();
for(int i = 0; i < nCount; ++i) {
clFileSystemWorkspaceConfig::Ptr_t conf(new clFileSystemWorkspaceConfig);
conf->FromSharedJSON(sharedConfigs.arrayItem(i));
auto iter = localConfigsMap.find(conf->GetName());
if(iter != localConfigsMap.end()) {
conf->FromLocalJSON(iter->second);
}
if(firstConfig.empty()) {
firstConfig = conf->GetName();
}
if(!selectedConfigFound && (conf->GetName() == m_selectedConfig)) {
selectedConfigFound = true;
}
m_configsMap.insert({ conf->GetName(), conf });
}
if(!selectedConfigFound && !firstConfig.IsEmpty()) {
m_selectedConfig = firstConfig;
}
}
bool clFileSystemWorkspaceSettings::Save(const wxFileName& filename, const wxFileName& localSettings)
{
// store the
wxFileName localWorkspace;
if(localSettings.IsOk()) {
localWorkspace = localSettings;
} else {
localWorkspace = filename;
localWorkspace.AppendDir(".codelite");
}
localWorkspace.Mkdir(wxS_DIR_DEFAULT, wxPATH_MKDIR_FULL);
JSON root_local(cJSON_Object);
JSON root_shared(cJSON_Object);
JSONItem itemLocal = root_local.toElement();
JSONItem itemShared = root_shared.toElement();
ToJSON(itemShared, itemLocal);
root_shared.save(filename);
root_local.save(localWorkspace);
clCommandEvent eventSaved(wxEVT_FSW_SETTINGS_SAVED);
EventNotifier::Get()->AddPendingEvent(eventSaved);
return true;
}
bool clFileSystemWorkspaceSettings::Load(const wxFileName& filename, const wxFileName& localSettings)
{
wxFileName localWorkspace;
if(localSettings.IsOk()) {
localWorkspace = localSettings;
} else {
localWorkspace = filename;
localWorkspace.AppendDir(".codelite");
};
JSON root_shared(filename);
if(!root_shared.isOk()) {
clWARNING() << "Invalid File System Workspace file:" << filename << endl;
return false;
}
JSON root_local(localWorkspace);
if(!root_local.isOk()) {
// old version
clDEBUG() << "clFileSystemWorkspaceSettings: no local file found. Loading from shared file" << clEndl;
auto iShared = root_shared.toElement();
FromJSON(iShared, iShared);
} else {
clDEBUG() << "clFileSystemWorkspaceSettings: loading settings from:" << filename << "and" << localWorkspace
<< clEndl;
auto iShared = root_shared.toElement();
auto iLocal = root_local.toElement();
FromJSON(iShared, iLocal);
}
clCommandEvent eventSaved(wxEVT_FSW_SETTINGS_LOADED);
EventNotifier::Get()->AddPendingEvent(eventSaved);
return true;
}
bool clFileSystemWorkspaceSettings::AddConfig(const wxString& name, const wxString& copyfrom)
{
if(m_configsMap.count(name)) {
// already exists
clWARNING() << "Can't add new configurtion:" << name << ". Already exists" << endl;
return false;
}
clFileSystemWorkspaceConfig::Ptr_t conf;
if(!copyfrom.IsEmpty() && GetConfig(copyfrom)) {
// clone the config
conf = GetConfig(copyfrom)->Clone();
} else {
// create an empty one
conf.reset(new clFileSystemWorkspaceConfig());
}
conf->SetName(name);
m_configsMap.insert({ name, conf });
if(m_configsMap.size() == 1) {
m_selectedConfig = conf->GetName();
}
return true;
}
bool clFileSystemWorkspaceSettings::DeleteConfig(const wxString& name)
{
if(m_configsMap.count(name) == 0) {
return false;
}
m_configsMap.erase(name);
if(m_selectedConfig == name) {
m_selectedConfig.clear();
if(!m_configsMap.empty()) {
m_selectedConfig = m_configsMap.begin()->second->GetName();
}
}
return true;
}
clFileSystemWorkspaceConfig::Ptr_t clFileSystemWorkspaceSettings::GetSelectedConfig() const
{
// sanity
if(m_configsMap.empty()) {
return clFileSystemWorkspaceConfig::Ptr_t(nullptr);
}
if(m_selectedConfig.empty() || (m_configsMap.count(m_selectedConfig) == 0)) {
return clFileSystemWorkspaceConfig::Ptr_t(nullptr);
}
return m_configsMap.find(m_selectedConfig)->second;
}
clFileSystemWorkspaceConfig::Ptr_t clFileSystemWorkspaceSettings::GetConfig(const wxString& name) const
{
if(name.empty()) {
return GetSelectedConfig();
}
if(m_configsMap.count(name) == 0) {
return clFileSystemWorkspaceConfig::Ptr_t(nullptr);
}
return m_configsMap.find(name)->second;
}
void clFileSystemWorkspaceSettings::Clear()
{
m_configsMap.clear();
m_selectedConfig.clear();
m_name.clear();
AddConfig("Debug");
}
bool clFileSystemWorkspaceSettings::SetSelectedConfig(const wxString& name)
{
if(m_configsMap.count(name) == 0) {
return false;
}
m_selectedConfig = name;
return true;
}
bool clFileSystemWorkspaceSettings::IsOk(const wxFileName& filename)
{
JSON root(filename);
if(!root.isOk()) {
return false;
}
return root.toElement().namedObject("workspace_type").toString() == WORKSPACE_TYPE;
}
wxArrayString clFileSystemWorkspaceSettings::GetConfigs() const
{
wxArrayString arr;
for(const auto& vt : m_configsMap) {
arr.Add(vt.first);
}
return arr;
}
|