yaze::cli::DiagnosticFinding Struct Reference

A single diagnostic finding. More...

#include <diagnostic_types.h>

Public Member Functions
std::string	FormatText () const
	Format finding for text output.
std::string	FormatJson () const
	Format finding as JSON object string.

Public Attributes
std::string	id
DiagnosticSeverity	severity
std::string	message
std::string	location
std::string	suggested_action
bool	fixable = false

Detailed Description

A single diagnostic finding.

Definition at line 39 of file diagnostic_types.h.

Member Function Documentation

FormatText()

std::string yaze::cli::DiagnosticFinding::FormatText ( ) const

inline

Format finding for text output.

Definition at line 50 of file diagnostic_types.h.

References fixable, yaze::cli::kCritical, yaze::cli::kError, yaze::cli::kInfo, yaze::cli::kWarning, location, message, and severity.

FormatJson()

std::string yaze::cli::DiagnosticFinding::FormatJson ( ) const

inline

Format finding as JSON object string.

Definition at line 71 of file diagnostic_types.h.

References fixable, location, message, severity, yaze::cli::SeverityToString(), and suggested_action.

Here is the call graph for this function:

Member Data Documentation

id

std::string yaze::cli::DiagnosticFinding::id

Definition at line 40 of file diagnostic_types.h.

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{dungeon_doctor_commands.cc}::CheckUnusedRooms(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckZScreamHeuristics(), yaze::cli::anonymous_namespace{dungeon_doctor_commands.cc}::DiagnoseRoom(), 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().

severity

DiagnosticSeverity yaze::cli::DiagnosticFinding::severity

Definition at line 41 of file diagnostic_types.h.

Referenced by yaze::cli::DiagnosticReport::AddFinding(), 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{dungeon_doctor_commands.cc}::CheckUnusedRooms(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckZScreamHeuristics(), yaze::cli::anonymous_namespace{dungeon_doctor_commands.cc}::DiagnoseRoom(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), FormatJson(), FormatText(), 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().

message

std::string yaze::cli::DiagnosticFinding::message

Definition at line 42 of file diagnostic_types.h.

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{dungeon_doctor_commands.cc}::CheckUnusedRooms(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckZScreamHeuristics(), yaze::cli::anonymous_namespace{dungeon_doctor_commands.cc}::DiagnoseRoom(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), FormatJson(), FormatText(), 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().

location

std::string yaze::cli::DiagnosticFinding::location

Definition at line 43 of file diagnostic_types.h.

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{dungeon_doctor_commands.cc}::CheckUnusedRooms(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckZScreamHeuristics(), yaze::cli::anonymous_namespace{dungeon_doctor_commands.cc}::DiagnoseRoom(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), FormatJson(), FormatText(), 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().

suggested_action

std::string yaze::cli::DiagnosticFinding::suggested_action

Definition at line 44 of file diagnostic_types.h.

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{dungeon_doctor_commands.cc}::CheckUnusedRooms(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckZScreamHeuristics(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), FormatJson(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::ValidateExpandedTables(), yaze::cli::anonymous_namespace{overworld_doctor_commands.cc}::ValidateMapPointers(), and yaze::cli::anonymous_namespace{message_doctor_commands.cc}::ValidateTerminators().

fixable

bool yaze::cli::DiagnosticFinding::fixable = false

Definition at line 45 of file diagnostic_types.h.

Referenced by yaze::cli::DiagnosticReport::AddFinding(), 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{dungeon_doctor_commands.cc}::CheckUnusedRooms(), yaze::cli::anonymous_namespace{rom_doctor_commands.cc}::CheckZScreamHeuristics(), yaze::cli::anonymous_namespace{dungeon_doctor_commands.cc}::DiagnoseRoom(), yaze::cli::MessageDoctorCommandHandler::Execute(), yaze::cli::OverworldDoctorCommandHandler::Execute(), yaze::cli::RomDoctorCommandHandler::Execute(), FormatJson(), FormatText(), 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().

---

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

• src/cli/handlers/tools/diagnostic_types.h