yaze 0.3.2
Link to the Past ROM Editor
 
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
yaze::cli::DiagnosticReport Struct Reference

Complete diagnostic report. More...

#include <diagnostic_types.h>

Collaboration diagram for yaze::cli::DiagnosticReport:
Collaboration graph
[legend]

Public Member Functions

void AddFinding (const DiagnosticFinding &finding)
 Add a finding and update counts.
 
bool HasProblems () const
 Check if report has any critical or error findings.
 
bool HasFixable () const
 Check if report has any fixable findings.
 
int TotalFindings () const
 Get total finding count.
 

Public Attributes

std::string rom_path
 
RomFeatures features
 
MapPointerStatus map_status
 
Tile16Status tile16_status
 
std::vector< DiagnosticFinding > findings
 
int info_count = 0
 
int warning_count = 0
 
int error_count = 0
 
int critical_count = 0
 
int fixable_count = 0
 

Detailed Description

Complete diagnostic report.

Definition at line 137 of file diagnostic_types.h.

Member Function Documentation

◆ AddFinding()

void yaze::cli::DiagnosticReport::AddFinding ( const DiagnosticFinding & finding)
inline

Add a finding and update counts.

Definition at line 154 of file diagnostic_types.h.

References critical_count, error_count, findings, yaze::cli::DiagnosticFinding::fixable, fixable_count, info_count, yaze::cli::kCritical, yaze::cli::kError, yaze::cli::kInfo, yaze::cli::kWarning, yaze::cli::DiagnosticFinding::severity, and warning_count.

Referenced by yaze::cli::anonymous_namespace{sprite_doctor_commands.cc}::CheckCommonSpriteIssues(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckCorruptionHeuristics(), yaze::cli::anonymous_namespace{message_doctor_commands.cc}::CheckCorruptionPatterns(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckParallelWorldsHeuristics(), yaze::cli::anonymous_namespace{graphics_doctor_commands.cc}::CheckSheetIntegrity(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::CheckTile16Corruption(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckZScreamHeuristics(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::anonymous_namespace{graphics_doctor_commands.cc}::ValidateBlocksets(), yaze::cli::anonymous_namespace{graphics_doctor_commands.cc}::ValidateCompression(), yaze::cli::anonymous_namespace{message_doctor_commands.cc}::ValidateControlCodes(), yaze::cli::anonymous_namespace{message_doctor_commands.cc}::ValidateDictionaryRefs(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::ValidateExpandedTables(), yaze::cli::anonymous_namespace{graphics_doctor_commands.cc}::ValidateGraphicsPointerTable(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::ValidateMapPointers(), yaze::cli::anonymous_namespace{sprite_doctor_commands.cc}::ValidateRoomSprites(), yaze::cli::anonymous_namespace{sprite_doctor_commands.cc}::ValidateSpritePointerTable(), yaze::cli::anonymous_namespace{sprite_doctor_commands.cc}::ValidateSpritesets(), and yaze::cli::anonymous_namespace{message_doctor_commands.cc}::ValidateTerminators().

◆ HasProblems()

bool yaze::cli::DiagnosticReport::HasProblems ( ) const
inline

Check if report has any critical or error findings.

Definition at line 168 of file diagnostic_types.h.

References critical_count, and error_count.

Referenced by yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::GraphicsDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::SpriteDoctorCommandHandler::Execute(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputSummaryJson().

◆ HasFixable()

bool yaze::cli::DiagnosticReport::HasFixable ( ) const
inline

Check if report has any fixable findings.

Definition at line 175 of file diagnostic_types.h.

References fixable_count.

Referenced by yaze::cli::OverworldDoctorCommandHandler::Execute().

◆ TotalFindings()

int yaze::cli::DiagnosticReport::TotalFindings ( ) const
inline

Get total finding count.

Definition at line 182 of file diagnostic_types.h.

References findings.

Referenced by yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::GraphicsDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::SpriteDoctorCommandHandler::Execute(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputSummaryJson(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary().

Member Data Documentation

◆ rom_path

std::string yaze::cli::DiagnosticReport::rom_path

Definition at line 138 of file diagnostic_types.h.

Referenced by yaze::cli::OverworldDoctorCommandHandler::Execute(), and yaze::cli::RomDoctorCommandHandler::Execute().

◆ features

RomFeatures yaze::cli::DiagnosticReport::features

Definition at line 139 of file diagnostic_types.h.

Referenced by yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::CheckTile16Corruption(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckZScreamHeuristics(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::ValidateExpandedTables(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::ValidateMapPointers().

◆ map_status

MapPointerStatus yaze::cli::DiagnosticReport::map_status

Definition at line 140 of file diagnostic_types.h.

Referenced by yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::ValidateMapPointers().

◆ tile16_status

Tile16Status yaze::cli::DiagnosticReport::tile16_status

Definition at line 141 of file diagnostic_types.h.

Referenced by yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::CheckTile16Corruption(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::RepairTile16Region().

◆ findings

std::vector<DiagnosticFinding> yaze::cli::DiagnosticReport::findings

Definition at line 142 of file diagnostic_types.h.

Referenced by AddFinding(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::GraphicsDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::SpriteDoctorCommandHandler::Execute(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputFindingsJson(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextFindings(), and TotalFindings().

◆ info_count

int yaze::cli::DiagnosticReport::info_count = 0

Definition at line 145 of file diagnostic_types.h.

Referenced by AddFinding(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::GraphicsDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::SpriteDoctorCommandHandler::Execute(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputSummaryJson(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary().

◆ warning_count

int yaze::cli::DiagnosticReport::warning_count = 0

Definition at line 146 of file diagnostic_types.h.

Referenced by AddFinding(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::GraphicsDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::SpriteDoctorCommandHandler::Execute(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputSummaryJson(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary().

◆ error_count

int yaze::cli::DiagnosticReport::error_count = 0

Definition at line 147 of file diagnostic_types.h.

Referenced by AddFinding(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::GraphicsDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::SpriteDoctorCommandHandler::Execute(), HasProblems(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputSummaryJson(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary().

◆ critical_count

int yaze::cli::DiagnosticReport::critical_count = 0

Definition at line 148 of file diagnostic_types.h.

Referenced by AddFinding(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::GraphicsDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), yaze::cli::SpriteDoctorCommandHandler::Execute(), HasProblems(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputSummaryJson(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary().

◆ fixable_count

int yaze::cli::DiagnosticReport::fixable_count = 0

Definition at line 149 of file diagnostic_types.h.

Referenced by AddFinding(), yaze::cli::MessageDoctorCommandHandler::Execute(), HasFixable(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputSummaryJson(), and yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::OutputTextSummary().

The documentation for this struct was generated from the following file: