note/src/project/ProjectDetector.cpp at dev · vixcpp/note · GitHub

History

403 lines (319 loc) · 8.18 KB

Raw

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

/**

* @file ProjectDetector.cpp

* @author Gaspard Kirira

* https://github.com/vixcpp/note

* Use of this source code is governed by a MIT license

* that can be found in the LICENSE file.

* Vix Note

#include <vix/note/project/ProjectDetector.hpp>

#include <filesystem>

#include <fstream>

#include <sstream>

#include <string>

#include <system_error>

#include <utility>

namespace fs = std::filesystem;

namespace vix::note

{

namespace

{

bool exists_path(const fs::path &path)

{

std::error_code ec;

return fs::exists(path, ec) && !ec;

}

bool is_directory_path(const fs::path &path)

{

std::error_code ec;

return fs::is_directory(path, ec) && !ec;

}

bool is_regular_file_path(const fs::path &path)

{

std::error_code ec;

return fs::is_regular_file(path, ec) && !ec;

}

fs::path absolute_normal_path(const fs::path &path)

{

std::error_code ec;

fs::path absolute = fs::absolute(path, ec);

if (ec)

{

return path.lexically_normal();

}

return absolute.lexically_normal();

}

std::string trim_copy(std::string value)

{

while (!value.empty() &&

(value.front() == ' ' ||

value.front() == '\t' ||

value.front() == '\n' ||

value.front() == '\r'))

{

value.erase(value.begin());

}

while (!value.empty() &&

(value.back() == ' ' ||

value.back() == '\t' ||

value.back() == '\n' ||

value.back() == '\r'))

{

value.pop_back();

}

return value;

}

std::string read_vix_json_include_field(const fs::path &manifest)

{

std::ifstream in(manifest, std::ios::binary);

if (!in.is_open())

{

return {};

}

std::ostringstream buffer;

buffer << in.rdbuf();

const std::string text = buffer.str();

const std::string key = "\"include\"";

const std::size_t pos = text.find(key);

if (pos == std::string::npos)

{

return {};

}

const std::size_t colon = text.find(':', pos + key.size());

if (colon == std::string::npos)

{

return {};

}

const std::size_t quoteBegin = text.find('"', colon + 1);

if (quoteBegin == std::string::npos)

{

return {};

}

const std::size_t quoteEnd = text.find('"', quoteBegin + 1);

if (quoteEnd == std::string::npos)

{

return {};

}

return trim_copy(

text.substr(

quoteBegin + 1,

quoteEnd - quoteBegin - 1));

}

void add_unique_include_path(

ProjectContext &context,

const fs::path &path)

{

if (!is_directory_path(path))

{

return;

}

const fs::path normalized =

absolute_normal_path(path);

for (const auto &existing : context.includePaths)

{

if (absolute_normal_path(existing) == normalized)

{

return;

}

context.includePaths.push_back(normalized);

}

void add_include_path_if_exists(

ProjectContext &context,

const fs::path &path)

{

add_unique_include_path(context, path);

}

fs::path parent_or_self_directory(const fs::path &path)

{

if (path.empty())

{

return absolute_normal_path(fs::current_path());

}

const fs::path absolute = absolute_normal_path(path);

if (is_regular_file_path(absolute))

{

return absolute.parent_path();

}

if (is_directory_path(absolute))

{

return absolute;

}

if (absolute.has_extension())

{

return absolute.parent_path();

}

return absolute;

}

bool is_project_root(const fs::path &dir)

{

return exists_path(dir / "vix.app") ||

exists_path(dir / "vix.json") ||

exists_path(dir / "CMakeLists.txt") ||

exists_path(dir / ".vix") ||

exists_path(dir / ".git");

}

fs::path find_project_root(

fs::path start,

bool searchParents)

{

start = absolute_normal_path(start);

if (!searchParents)

{

return is_project_root(start) ? start : fs::path{};

}

fs::path current = start;

while (!current.empty())

{

if (is_project_root(current))

{

return current;

}

const fs::path parent = current.parent_path();

if (parent == current)

{

break;

}

current = parent;

}

return {};

}

std::string project_name_from_root(const fs::path &root)

{

if (root.empty())

{

return {};

}

return root.filename().string();

}

fs::path detect_manifest(const fs::path &root)

{

if (root.empty())

{

return {};

}

const fs::path vixJson = root / "vix.json";

if (is_regular_file_path(vixJson))

{

return vixJson;

}

const fs::path vixApp = root / "vix.app";

if (is_regular_file_path(vixApp))

{

return vixApp;

}

const fs::path manifest = root / ".vix" / "manifest.vix";

if (is_regular_file_path(manifest))

{

return manifest;

}

return {};

}

void add_deps_include_paths(

ProjectContext &context,

const fs::path &depsDirectory)

{

if (!is_directory_path(depsDirectory))

{

return;

}

std::error_code ec;

for (const auto &entry : fs::directory_iterator(depsDirectory, ec))

{

if (ec)

{

break;

}

std::error_code entryEc;

if (!entry.is_directory(entryEc) || entryEc)

{

continue;

}

const fs::path packageRoot = entry.path();

add_unique_include_path(

context,

packageRoot / "include");

const fs::path packageManifest =

packageRoot / "vix.json";

const std::string includeValue =

read_vix_json_include_field(packageManifest);

if (!includeValue.empty())

{

add_unique_include_path(

context,

packageRoot / includeValue);

}

ProjectDetector::ProjectDetector() = default;

ProjectDetector::ProjectDetector(ProjectDetectOptions options)

: options_(options)

{

}

const ProjectDetectOptions &ProjectDetector::options() const noexcept

{

return options_;

}

void ProjectDetector::set_options(ProjectDetectOptions options) noexcept

{

options_ = options;

}

ProjectContext ProjectDetector::detect(const fs::path &notePath) const

{

const fs::path start =

parent_or_self_directory(notePath);

return detect_from(start, notePath);

}

ProjectContext ProjectDetector::detect_from(

const fs::path &startPath,

const fs::path &notePath) const

{

ProjectContext context;

context.notePath = absolute_normal_path(notePath);

const fs::path start =

parent_or_self_directory(startPath);

const fs::path root =

find_project_root(start, options_.searchParents);

if (root.empty())

{

context.enabled = false;

context.workingDirectory = start;

return context;

}

context.enabled = true;

context.projectRoot = root;

context.workingDirectory = root;

context.projectName = project_name_from_root(root);

context.manifestPath = detect_manifest(root);

const fs::path deps = root / ".vix" / "deps";

if (is_directory_path(deps))

{

context.depsDirectory = deps;

}

if (options_.includeProjectIncludeDirectory)

{

add_include_path_if_exists(context, root / "include");

}

if (options_.includeProjectSourceDirectory)

{

add_include_path_if_exists(context, root / "src");

}

if (options_.detectDeps && context.has_deps())

{

add_deps_include_paths(context, context.depsDirectory);

}

return context;

}

ProjectContext detect_project_context(const fs::path &notePath)

{

return ProjectDetector().detect(notePath);

}

note/src/project/ProjectDetector.cpp at dev · vixcpp/note · GitHub

Uh oh!

Expand file tree

Breadcrumbs

ProjectDetector.cpp

Latest commit

History

Breadcrumbs

ProjectDetector.cpp

File metadata and controls