cli/src/build/BuildStyle.cpp at main · vixcpp/cli · GitHub

History

976 lines (801 loc) · 22.9 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

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

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

/**

* @file BuildStyle.cpp

* @author Gaspard Kirira

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

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

* that can be found in the License file.

* Vix.cpp

* Reusable build output style

#include <vix/cli/build/BuildStyle.hpp>

#include <cctype>

#include <iostream>

#include <optional>

#include <regex>

#include <sstream>

#include <system_error>

#include <vector>

#include <iomanip>

#include <vix/cli/Style.hpp>

#include <vix/cli/util/Strings.hpp>

#ifdef _WIN32

#include <io.h>

#else

#include <unistd.h>

#endif

namespace vix::cli::build

{

namespace style = vix::cli::style;

namespace

{

bool output_is_tty(std::ostream &out) noexcept

{

if (&out != &std::cout)

return false;

#ifdef _WIN32

return _isatty(_fileno(stdout)) != 0;

#else

return ::isatty(STDOUT_FILENO) != 0;

#endif

}

const char *duration_color(long long milliseconds) noexcept

{

if (milliseconds >= 10000)

return style::RED;

if (milliseconds >= 3000)

return style::YELLOW;

return style::GREEN;

}

} // namespace

static std::string colorize(

const char *color,

const std::string &value)

{

return std::string(color) + value + style::RESET;

}

namespace

{

static bool is_absolute_or_relative_path_like(const std::string &value)

{

if (value.empty())

return false;

if (value.find('/') != std::string::npos)

return true;

#ifdef _WIN32

if (value.find('\\') != std::string::npos)

return true;

if (value.size() > 2 &&

std::isalpha(static_cast<unsigned char>(value[0])) &&

value[1] == ':')

{

return true;

}

#endif

return value.find('.') != std::string::npos;

}

static std::string make_pointer_line(std::size_t column)

{

if (column == 0)

return "";

std::string out;

out.append(column > 1 ? column - 1 : 0, ' ');

out.push_back('^');

return out;

}

static std::string label_color(const std::string &label)

{

if (label == "error:")

return style::RED;

if (label == "hint:")

return style::YELLOW;

if (label == "location:")

return style::CYAN;

if (label == "code:")

return style::CYAN;

if (label == "message:")

return style::CYAN;

return style::GRAY;

}

static void print_label(

std::ostream &out,

const std::string &label)

{

out << " "

<< colorize(label_color(label).c_str(), label)

<< "\n";

}

static void print_compact_optional_line(

std::ostream &out,

const std::string &label,

const std::string &value)

{

if (value.empty())

return;

out << " "

<< colorize(label_color(label).c_str(), label)

<< " "

<< value

<< "\n";

}

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

{

while (!value.empty() &&

std::isspace(static_cast<unsigned char>(value.front())) != 0)

{

value.erase(value.begin());

}

while (!value.empty() &&

std::isspace(static_cast<unsigned char>(value.back())) != 0)

{

value.pop_back();

}

return value;

}

static std::string extract_warning_flag(const std::string &message)

{

static const std::regex flagRe(R"(\[(-W[^\]]+)\])");

std::smatch match;

if (!std::regex_search(message, match, flagRe))

return {};

return match[1].str();

}

static std::string strip_warning_flag(std::string message)

{

static const std::regex flagRe(R"(\s*\[-W[^\]]+\]\s*$)");

return trim_copy(std::regex_replace(message, flagRe, ""));

}

static std::string shorten_cpp_signature(std::string value)

{

const std::size_t paren = value.find('(');

if (paren != std::string::npos)

value = value.substr(0, paren);

const std::string anonymous = "{anonymous}::";

const std::size_t anonymousPos = value.find(anonymous);

if (anonymousPos != std::string::npos)

value = value.substr(anonymousPos + anonymous.size());

const std::size_t ns = value.rfind("::");

if (ns != std::string::npos)

value = value.substr(ns + 2);

if (value.size() >= 2 &&

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

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

{

value = value.substr(1, value.size() - 2);

}

const std::string leftQuote = "‘";

const std::string rightQuote = "’";

if (value.size() >= leftQuote.size() + rightQuote.size() &&

value.rfind(leftQuote, 0) == 0 &&

value.compare(

value.size() - rightQuote.size(),

rightQuote.size(),

rightQuote) == 0)

{

value = value.substr(

leftQuote.size(),

value.size() - leftQuote.size() - rightQuote.size());

}

return trim_copy(value);

}

static std::string extract_quoted_symbol(const std::string &message)

{

const std::size_t start = message.find("‘");

const std::size_t end = message.find("’", start + 1);

if (start != std::string::npos &&

end != std::string::npos &&

end > start)

{

return message.substr(start + std::string("‘").size(),

end - (start + std::string("‘").size()));

}

{

const std::size_t start = message.find('\'');

const std::size_t end = message.find('\'', start + 1);

if (start != std::string::npos &&

end != std::string::npos &&

end > start)

{

return message.substr(start + 1, end - start - 1);

}

return {};

}

} // namespace

void print_build_header_full(

std::ostream &out,

const std::string &target,

const std::string &preset,

const std::optional<std::string> &launcher,

const std::optional<std::string> &fastLinkerFlag,

int jobs)

{

out << style::CYAN

<< style::BOLD

<< "Compiling"

<< style::RESET;

if (!target.empty())

{

out << " "

<< style::CYAN

<< style::BOLD

<< target

<< style::RESET;

}

if (!preset.empty())

out << " " << colorize(style::GRAY, "(" + preset + ")");

out << "\n";

std::vector<std::string> meta;

if (launcher && !launcher->empty())

{

meta.push_back(

"launcher: " + colorize(style::MAGENTA, *launcher));

}

if (fastLinkerFlag && !fastLinkerFlag->empty())

{

const std::string name =

fastLinkerFlag->find("mold") != std::string::npos

? "mold"

: "lld";

meta.push_back(

"linker: " + colorize(style::MAGENTA, name));

}

if (jobs > 0)

{

meta.push_back(

"jobs: " + colorize(style::MAGENTA, std::to_string(jobs)));

}

if (!meta.empty())

{

out << style::GRAY << " * " << style::RESET;

for (std::size_t i = 0; i < meta.size(); ++i)

{

if (i > 0)

out << style::GRAY << " | " << style::RESET;

out << meta[i];

}

out << "\n";

}

void print_build_success_timed(

std::ostream &out,

const std::string &message,

long long milliseconds)

{

out << " "

<< colorize(style::GREEN, "ok")

<< " "

<< message;

if (milliseconds > 0)

{

const double seconds = static_cast<double>(milliseconds) / 1000.0;

std::ostringstream time;

time.setf(std::ios::fixed);

time.precision(seconds >= 10.0 ? 1 : 2);

time << seconds << "s";

out << " " << colorize(style::GRAY, "| " + time.str());

}

out << "\n";

}

std::string format_build_duration(long long milliseconds)

{

if (milliseconds > 0 && milliseconds < 1000)

return std::to_string(milliseconds) + "ms";

return util::format_seconds(milliseconds);

}

void write_build_duration(

std::ostream &out,

long long milliseconds)

{

const std::string duration = format_build_duration(milliseconds);

if (output_is_tty(out))

out << duration_color(milliseconds) << style::BOLD

<< duration << style::RESET;

else

out << duration;

}

bool BuildLocation::valid() const

{

return !file.empty();

}

bool BuildCodeFrame::valid() const

{

return location.valid() && !lines.empty();

}

bool BuildDiagnostic::has_location() const

{

return location.valid();

}

bool BuildDiagnostic::has_code_frame() const

{

return codeFrame.valid();

}

bool BuildProgress::valid() const

{

return !action.empty() ||

!target.empty() ||

total > 0;

}

std::string build_message_prefix(BuildMessageKind kind)

{

switch (kind)

{

case BuildMessageKind::Info:

return colorize(style::CYAN, "•");

case BuildMessageKind::Step:

return colorize(style::CYAN, "›");

case BuildMessageKind::Success:

return colorize(style::GREEN, "✔");

case BuildMessageKind::Warning:

return colorize(style::YELLOW, "!");

case BuildMessageKind::Error:

return colorize(style::RED, "✖");

default:

return "•";

}

void print_build_message(

std::ostream &out,

BuildMessageKind kind,

const std::string &message)

{

out << " "

<< build_message_prefix(kind)

<< " "

<< message

<< "\n";

}

void print_build_info(

std::ostream &out,

const std::string &message)

{

print_build_message(out, BuildMessageKind::Info, message);

}

void print_build_step(

std::ostream &out,

const std::string &message)

{

print_build_message(out, BuildMessageKind::Step, message);

}

void print_build_success(

std::ostream &out,

const std::string &message)

{

print_build_message(out, BuildMessageKind::Success, message);

}

void print_build_warning(

std::ostream &out,

const std::string &message)

{

print_build_message(out, BuildMessageKind::Warning, message);

}

void print_build_error(

std::ostream &out,

const std::string &message)

{

print_build_message(out, BuildMessageKind::Error, message);

}

void print_build_header(

std::ostream &out,

const std::string &target,

const std::string &preset)

{

out << colorize(style::BOLD, "Building");

if (!target.empty())

out << " " << colorize(style::CYAN, target);

if (!preset.empty())

out << " " << colorize(style::GRAY, "[" + preset + "]");

out << "\n";

}

void print_build_progress(

std::ostream &out,

const BuildProgress &progress)

{

if (!progress.valid())

return;

out << " " << colorize(style::CYAN, "›") << " ";

if (progress.total > 0)

{

out << "["

<< progress.current

<< "/"

<< progress.total

<< "] ";

}

if (!progress.action.empty())

out << progress.action;

if (!progress.target.empty())

out << " " << colorize(style::GRAY, progress.target);

out << "\n";

}

void print_build_done(

std::ostream &out,

const std::string &profile,

const std::string &duration)

{

out << " "

<< colorize(style::GREEN, "✔")

<< " Finished";

if (!profile.empty())

out << " " << profile;

if (!duration.empty())

out << " in " << duration;

out << "\n";

}

void print_build_diagnostic(

std::ostream &out,

const BuildDiagnostic &diagnostic)

{

const std::string title =

diagnostic.title.empty()

? std::string("Build failed")

: diagnostic.title;

out << " "

<< style::RED

<< style::BOLD

<< "✖ "

<< title

<< style::RESET

<< "\n";

print_compact_optional_line(out, "message:", diagnostic.message);

if (diagnostic.has_location())

{

out << " "

<< colorize(label_color("location:").c_str(), "location:")

<< " "

<< format_build_location(diagnostic.location)

<< "\n";

}

print_compact_optional_line(out, "error:", diagnostic.error);

if (diagnostic.has_code_frame())

{

print_label(out, "code:");

const std::size_t firstLine =

diagnostic.codeFrame.location.line > diagnostic.codeFrame.lines.size()

? diagnostic.codeFrame.location.line - diagnostic.codeFrame.lines.size() + 1

: 1;

for (std::size_t i = 0; i < diagnostic.codeFrame.lines.size(); ++i)

{

const std::size_t lineNumber = firstLine + i;

out << " "

<< lineNumber

<< " | "

<< diagnostic.codeFrame.lines[i]

<< "\n";

if (lineNumber == diagnostic.codeFrame.location.line)

{

const std::string pointer =

make_pointer_line(diagnostic.codeFrame.location.column);

if (!pointer.empty())

{

out << " | "

<< colorize(style::RED, pointer)

<< "\n";

}

out << "\n";

}

print_compact_optional_line(out, "hint:", diagnostic.hint);

}

std::string format_build_location(

const BuildLocation &location)

{

if (!location.valid())

return "";

std::ostringstream out;

out << location.file.string();

if (location.line > 0)

{

out << ":" << location.line;

if (location.column > 0)

out << ":" << location.column;

}

return out.str();

}

std::string relative_build_path(

const fs::path &path,

const fs::path &base)

{

if (path.empty())

return "";

if (base.empty())

return path.lexically_normal().string();

std::error_code ec;

const fs::path relative = fs::relative(path, base, ec);

if (!ec && !relative.empty())

return relative.lexically_normal().string();

return path.lexically_normal().string();

}

std::optional<BuildLocation> parse_build_location(

const std::string &text)

{

static const std::regex pattern(

R"(([^:\s][^:\n\r]*):([0-9]+):([0-9]+))");

std::smatch match;

if (!std::regex_search(text, match, pattern))

return std::nullopt;

const std::string path = match[1].str();

if (!is_absolute_or_relative_path_like(path))

return std::nullopt;

BuildLocation location;

location.file = fs::path(path);

try

{

location.line = static_cast<std::size_t>(

std::stoull(match[2].str()));

location.column = static_cast<std::size_t>(

std::stoull(match[3].str()));

}

catch (...)

{

return std::nullopt;

}

return location;

}

void print_task_header_full(

std::ostream &out,

const std::string &action,

const std::string &target,

const std::string &preset,

const std::vector<std::pair<std::string, std::string>> &meta)

{

out << style::CYAN

<< style::BOLD

<< action

<< style::RESET;

if (!target.empty())

{

out << " "

<< style::CYAN

<< style::BOLD

<< target

<< style::RESET;

}

if (!preset.empty())

out << " " << colorize(style::GRAY, "(" + preset + ")");

out << "\n";

if (meta.empty())

return;

out << style::GRAY << " * " << style::RESET;

for (std::size_t i = 0; i < meta.size(); ++i)

{

if (i > 0)

out << style::GRAY << " | " << style::RESET;

out << meta[i].first << ": "

<< colorize(style::MAGENTA, meta[i].second);

}

out << "\n";

}

void print_task_success_timed(

std::ostream &out,

const std::string &message,

long long milliseconds)

{

std::ostringstream oss;

oss << std::fixed << std::setprecision(1)

<< (static_cast<double>(milliseconds) / 1000.0);

out << " "

<< colorize(style::GREEN, "✔")

<< " "

<< message

<< " in "

<< oss.str()

<< "s\n";

}

void print_task_failure_timed(

std::ostream &out,

const std::string &message,

long long milliseconds)

{

std::ostringstream oss;

oss << std::fixed << std::setprecision(1)

<< (static_cast<double>(milliseconds) / 1000.0);

out << " "

<< colorize(style::RED, "✖")

<< " "

<< message

<< " after "

<< oss.str()

<< "s\n";

}

bool BuildWarning::has_location() const

{

return !file.empty();

}

std::optional<BuildWarning> parse_build_warning(

const std::string &text)

{

static const std::regex pattern(

R"(([^:\n\r]+):([0-9]+):([0-9]+):\s+warning:\s+(.+))");

std::smatch match;

if (!std::regex_search(text, match, pattern))

return std::nullopt;

BuildWarning warning;

warning.file = fs::path(match[1].str());

try

{

warning.line = static_cast<std::size_t>(

std::stoull(match[2].str()));

warning.column = static_cast<std::size_t>(

std::stoull(match[3].str()));

}

catch (...)

{

return std::nullopt;

}

warning.message = match[4].str();

warning.raw = text;

return humanize_build_warning(std::move(warning));

}

void print_build_warnings_summary(

std::ostream &out,

const std::vector<BuildWarning> &warnings,

std::size_t total)

{

if (total == 0)

return;

out << " "

<< colorize(style::YELLOW, "warning")

<< " "

<< colorize(style::BOLD, std::to_string(total))

<< " compiler warning"

<< (total > 1 ? "s" : "")

<< "\n";

const std::size_t shown = warnings.size();

for (const BuildWarning &warning : warnings)

{

out << " "

<< colorize(style::YELLOW, "•")

<< " ";

if (warning.has_location())

{

out << colorize(style::CYAN, warning.file.filename().string());

if (warning.line > 0)

{

out << style::GRAY

<< ":"

<< warning.line;

if (warning.column > 0)

out << ":" << warning.column;

out << style::RESET;

}

out << "\n";

}

out << " "

<< (warning.message.empty() ? warning.raw : warning.message)

<< "\n";

if (!warning.hint.empty())

{

out << " "

<< colorize(style::GRAY, "hint:")

<< " "

<< warning.hint

<< "\n";

}

if (total > shown)

{

out << " "

<< colorize(style::GRAY, "• ")

<< colorize(

style::GRAY,

std::to_string(total - shown) +

" more warning" +

((total - shown) > 1 ? "s" : "") +

" hidden")

<< "\n";

}

out << " "

<< colorize(style::GRAY, "hint:")

<< " run "

<< colorize(style::CYAN, "vix build --warnings")

<< " to view all warnings"

<< "\n\n";

}

BuildWarning humanize_build_warning(BuildWarning warning)

{

const std::string message = warning.message;

warning.flag = extract_warning_flag(message);

const std::string cleanMessage = strip_warning_flag(message);

const std::string quoted = extract_quoted_symbol(cleanMessage);

if (cleanMessage.find("defined but not used") != std::string::npos)

{

warning.kind = BuildWarningKind::UnusedFunction;

warning.symbol = shorten_cpp_signature(quoted);

warning.message =

warning.symbol.empty()

? "unused function"

: "unused function: " + warning.symbol;

warning.hint = "remove it, use it, or mark it [[maybe_unused]]";

return warning;

}

if (cleanMessage.find("unused variable") != std::string::npos)

{

warning.kind = BuildWarningKind::UnusedVariable;

warning.symbol = shorten_cpp_signature(quoted);

warning.message =

warning.symbol.empty()

? "unused variable"

: "unused variable: " + warning.symbol;

warning.hint = "remove it or mark it [[maybe_unused]]";

return warning;

}

if (cleanMessage.find("unused parameter") != std::string::npos)

{

warning.kind = BuildWarningKind::UnusedParameter;

warning.symbol = shorten_cpp_signature(quoted);

warning.message =

warning.symbol.empty()

? "unused parameter"

: "unused parameter: " + warning.symbol;

warning.hint = "remove the parameter name or mark it [[maybe_unused]]";

return warning;

}

if (cleanMessage.find("shadows a previous local") != std::string::npos ||

(cleanMessage.find("declaration of") != std::string::npos &&

cleanMessage.find("shadows") != std::string::npos))

{

warning.kind = BuildWarningKind::ShadowedVariable;

warning.symbol = shorten_cpp_signature(quoted);

warning.message =

warning.symbol.empty()

? "variable shadows another variable"

: "variable shadows another variable: " + warning.symbol;

warning.hint = "rename the inner variable to avoid confusion";

return warning;

}

if (cleanMessage.find("deprecated") != std::string::npos)

{

warning.kind = BuildWarningKind::DeprecatedDeclaration;

warning.symbol = shorten_cpp_signature(quoted);

warning.message =

warning.symbol.empty()

? "deprecated API used"

: "deprecated API used: " + warning.symbol;

warning.hint = "replace it with the recommended API";

return warning;

}

if (warning.flag == "-Wsign-compare")

{

warning.kind = BuildWarningKind::SignCompare;

warning.message = "comparison mixes signed and unsigned values";

warning.hint = "use matching integer types before comparing";

return warning;

}

if (warning.flag == "-Wconversion")

{

warning.kind = BuildWarningKind::Conversion;

warning.message = "implicit conversion may change the value";

warning.hint = "use an explicit cast or a safer target type";

return warning;

}

if (warning.flag == "-Wreorder")

{

warning.kind = BuildWarningKind::Reorder;

warning.message = "constructor initializes members in a different order";

warning.hint = "match the initializer list order with the class field order";

return warning;

}

if (warning.flag == "-Wmissing-field-initializers")

{

warning.kind = BuildWarningKind::MissingFieldInitializer;

warning.message = "some fields are not initialized";

warning.hint = "initialize all fields explicitly";

return warning;

}

warning.kind = BuildWarningKind::Unknown;

warning.message = cleanMessage;

warning.hint = warning.flag.empty()

? "review this compiler warning"

: "review this compiler warning: " + warning.flag;

return warning;

}

} // namespace vix::cli::build

cli/src/build/BuildStyle.cpp at main · vixcpp/cli · GitHub

Uh oh!

Expand file tree

Breadcrumbs

BuildStyle.cpp

Latest commit

History

Breadcrumbs

BuildStyle.cpp

File metadata and controls