Warning system (#189)

* first draft

* take vt.h from mm repo

* Colors

* Fix argument types

* Add argument parser to errorhandler

* Rename ErrorHandler to WarningHandler

* Add -Wno- and more warning types

* header and body in warnings

* Small cleanup

* Replace a bunch of warnings with the new system

Co-authored-by: EllipticEllipsis <EllipticEllipsis@users.noreply.github.com>

* Move stuff around

* Move stuff to header

* Make some more VT macros, new Warning_Build function + macro, ZBackground

* Add remaining warnings

* Add ZResource* param to Warning_Resource

* Add warning help message

* Simplify help message a bit

* Refactor warnings into lots of helper functions

* Fix HANG_INDT in the wild

* Builds now

* Update macros to use bold

* Fix body printing and error colour

* Add -Werror=

* Add warningType to HANDLE_ERROR

* Change some throws into HANDLE_ERROR

* Create init and main maps and write new help printer

* Changed ZTextureAnimation to new w/e

* Typo

* Delete build warnings list file

* Use ERROR in ZResource and ZPath

* Remove extra structs

* Move ifdef into the InitMap, add descriptions

* Actually move into initMap and add descriptions...

* Remove Everything from the WarningType enum

* Make more of the handler arguments const for compatibility

* Fix warning

* Document macros a bit

* Add ImageBackend ERRRORs

* Note on Weverything, rename InvalidData to InvalidExtractedData

* add texture and mesh warnings/errors

* InvalidExtractedData

* Add description for InvalidPNG

* print which warnings are enabled by using debug verbosity

* Fix everything

* Fix some newlines

* Move help to the end, start some documentation

* Remove unnecessary `WarningHandler::`s

* Remove commented code

* Some more documentation

* Make first letters consistenty lowercase, more docs

* Consistently use lowercase, more docs

* Format consistently, more detail in documentation

* Simplify enabled warnings checks

* Rename HANDLE_WARNING_BUILD and add HANDLE_ERROR_PROCESS

* Delete BuildInfo.cpp

* Use PROCESS where possible, bit more documentation

* Add documenation to README, sort when printing help

* Add an example, escalate the rest of the invalids by default

* Format warning names in table

* format readme

* Remove old flags info

* Remove obsolete variables

* Format

* assert.h -> cassert

* Replace some asserts in ZTexture

* Remove test file

* Minor cleanup

* Bit more in the help

* Fix header includes

* Format

* One character in readme

* Update README.md

Co-authored-by: Anghelo Carvajal <angheloalf95@gmail.com>

* Some Morita inspiration

* Convert new errors

* Static warnings/errors

* Merge remote-tracking branch 'upstream/master' into errorlib

* Add explanation for switch control flow

* format

* whooops

* Fix segment warning that doesn't apply now we assume no segment means use VRAM

* Comment out MM in Jenkinsfile

Co-authored-by: Angie <angheloalf95@gmail.com>
Co-authored-by: EllipticEllipsis <EllipticEllipsis@users.noreply.github.com>

1 files changed, 43 insertions, 81 deletions

diff --git a/ZAPD/ZTextureAnimation.cpp b/ZAPD/ZTextureAnimation.cpp
index 4332fcf..698054f 100644
--- a/ZAPD/ZTextureAnimation.cpp
+++ b/ZAPD/ZTextureAnimation.cpp
@@ -2,8 +2,8 @@
  * File: ZTextureAnimation.cpp
  * ZResources defined: ZTextureAnimation, ZTextureAnimationParams (XML declaration not supported for
  * the latter)
- * Purpose: extracting texture animating structures from asset files Note: data type is exclusive to
- * Majora's Mask
+ * Purpose: extracting texture animating structures from asset files
+ * Note: data type is exclusive to Majora's Mask
  *
  * Structure of data:
  * A texture animation consists of a main array of data of the form
@@ -82,6 +82,7 @@
 
 #include "Globals.h"
 #include "Utils/BitConverter.h"
+#include "WarningHandler.h"
 #include "ZFile.h"
 #include "ZResource.h"
 #include "tinyxml2.h"
@@ -115,7 +116,7 @@ void ZTextureAnimationParams::ExtractFromBinary(uint32_t nRawDataIndex)
 	ParseRawData();
 }
 
-// Implemented by TextureScrollingParams only[
+// Implemented by TextureScrollingParams only
 void ZTextureAnimationParams::ExtractFromBinary([[maybe_unused]] uint32_t nRawDataIndex,
                                                 [[maybe_unused]] int count)
 {
@@ -217,19 +218,8 @@ void TextureColorChangingParams::ParseRawData()
 		((type == TextureAnimationParamsType::ColorChange) ? animLength : colorListCount);
 
 	if (listLength == 0)
-		throw std::runtime_error(StringHelper::Sprintf(
-			"When processing file %s: in input binary file %s, offset 0x%06X:"
-			"\n\t"
-			"\033[97m"
-			"TextureColorChangingParams::ParseRawData:"
-			"\033[0m"
-			"\033[91m"
-			" error: "
-			"\033[0m"
-			"\033[97m"
-			"color list length cannot be 0\n"
-			"\033[0m",
-			Globals::Instance->inputPath.c_str(), parent->GetName().c_str(), rawDataIndex));
+		HANDLE_ERROR_RESOURCE(WarningType::Always, parent, this, rawDataIndex,
+		                      "color list length cannot be 0", "");
 
 	primColorListAddress = BitConverter::ToUInt32BE(rawData, rawDataIndex + 4);
 	envColorListAddress = BitConverter::ToUInt32BE(rawData, rawDataIndex + 8);
@@ -378,20 +368,8 @@ void TextureCyclingParams::ParseRawData()
 
 	cycleLength = BitConverter::ToUInt16BE(rawData, rawDataIndex);
 	if (cycleLength == 0)
-		throw std::runtime_error(
-			StringHelper::Sprintf("When processing file %s: in input binary file %s, offset 0x%06X:"
-		                          "\n\t"
-		                          "\033[97m"
-		                          "TextureCyclingParams::ParseRawData:"
-		                          "\033[0m"
-		                          "\033[91m"
-		                          " error: "
-		                          "\033[0m"
-		                          "\033[97m"
-		                          "cycleLength cannot be 0\n"
-		                          "\033[0m",
-		                          Globals::Instance->inputPath.c_str(), parent->GetName().c_str(),
-		                          Seg2Filespace(rawDataIndex, 0)));
+		HANDLE_ERROR_RESOURCE(WarningType::Always, parent, this, rawDataIndex,
+		                      "cycle length cannot be 0", "");
 
 	textureListAddress = BitConverter::ToUInt32BE(rawData, rawDataIndex + 4);
 	textureIndexListAddress = BitConverter::ToUInt32BE(rawData, rawDataIndex + 8);
@@ -454,21 +432,12 @@ void TextureCyclingParams::DeclareReferences([[maybe_unused]] const std::string&
 			{
 				comment = " // Raw pointer, declare texture in XML to use proper symbol";
 
-				fprintf(stderr,
-				        "When processing file %s: in input binary file %s, offset 0x%06X:"
-				        "\n\t"
-				        "\033[97m"
-				        "TextureCyclingParams::DeclareReferences:"
-				        "\033[0m"
-				        "\033[95m"
-				        " warning: "
-				        "\033[0m"
-				        "\033[97m"
-				        "TexCycle declared here points to unknown texture at address %s. "
-				        "Please declare the texture in the XML to use the proper symbol.\n"
-				        "\033[0m",
-				        Globals::Instance->inputPath.c_str(), parent->GetName().c_str(),
-				        Seg2Filespace(textureListAddress, parent->baseAddress), texName.c_str());
+				auto msgHeader = StringHelper::Sprintf(
+					"TexCycle texture array declared here points to unknown texture at address %s",
+					texName.c_str());
+				HANDLE_WARNING_RESOURCE(
+					WarningType::HardcodedPointer, parent, this, rawDataIndex, msgHeader,
+					"Please declare the texture in the XML to use the proper symbol.");
 			}
 			texturesBodyStr += StringHelper::Sprintf("\t%s,%s\n", texName.c_str(), comment.c_str());
 		}
@@ -546,22 +515,14 @@ void ZTextureAnimation::ParseRawData()
 
 		if ((type < 0) || (type > 6))
 		{
-			throw std::runtime_error(StringHelper::Sprintf(
-				"When processing file %s: in input binary file %s, offset 0x%06X:"
-				"\n\t"
-				"\033[97m"
-				"ZTextureAnimation::ParseRawData:"
-				"\033[0m"
-				"\033[91m"
-				" error: "
-				"\033[0m"
-				"\033[97m"
-				"unknown TextureAnimationParams type 0x%02X in TextureAnimation: entry reads\n\t{ "
-				"0x%02X, 0x%02X, 0x%08X }\n(type should be between "
-				"0x00 and 0x06)\n"
-				"\033[0m",
-				Globals::Instance->inputPath.c_str(), parent->GetName().c_str(), rawDataIndex, type,
-				currentEntry.segment, type, currentEntry.paramsPtr));
+			HANDLE_ERROR_RESOURCE(
+				WarningType::Always, parent, this, rawDataIndex,
+				StringHelper::Sprintf(
+					"unknown TextureAnimationParams type 0x%02X in TextureAnimation", type),
+				StringHelper::Sprintf(
+					"Entry reads  { 0x%02X, 0x%02X, 0x%08X } , but type should be "
+					"between 0x00 and 0x06 inclusive.",
+					currentEntry.segment, type, currentEntry.paramsPtr));
 		}
 
 		if (currentEntry.segment <= 0)
@@ -589,13 +550,24 @@ void ZTextureAnimation::DeclareReferences(const std::string& prefix)
 			if (!parent->HasDeclaration(paramsOffset))
 			{
 				ZTextureAnimationParams* params;
-				int count = 2;
+				int count;
 				switch (entry.type)
 				{
 				case TextureAnimationParamsType::SingleScroll:
-					count = 1;
-					[[fallthrough]];
-				case TextureAnimationParamsType::DualScroll:
+					if (true)
+					{
+						count = 1;
+						// The else now allows SingleScroll to fall through to params = ... without
+						// touching the code in the else block
+					}
+					else
+					{
+						// The contents of this block can only be run by jumping into it with the
+						// case label
+						[[fallthrough]];
+					case TextureAnimationParamsType::DualScroll:
+						count = 2;
+					}
 					params = new TextureScrollingParams(parent);
 					params->ExtractFromBinary(paramsOffset, count);
 					break;
@@ -614,22 +586,12 @@ void ZTextureAnimation::DeclareReferences(const std::string& prefix)
 					break;
 
 				case TextureAnimationParamsType::Empty:
-					fprintf(stderr,
-					        "When processing file %s: in input binary file %s: offset 0x%06X:"
-					        "\n\t"
-					        "\033[97m"
-					        "ZTextureAnimation::DeclareReferences:"
-					        "\033[0m"
-					        "\033[95m"
-					        " warning: "
-					        "\033[0m"
-					        "\033[97m"
-					        "TextureAnimationParams entry has empty type (6), but params pointer "
-					        "is not NULL. Params read\n\t\t"
-					        "{ 0x%02X, 0x%02X, 0x%08X }\n"
-					        "\033[0m",
-					        Globals::Instance->inputPath.c_str(), parent->GetName().c_str(),
-					        rawDataIndex, entry.segment, (int)entry.type, entry.paramsPtr);
+					HANDLE_WARNING_RESOURCE(
+						WarningType::InvalidExtractedData, parent, this, rawDataIndex,
+						"TextureAnimationParams entry has empty type (6), but params pointer is "
+						"not NULL",
+						StringHelper::Sprintf("Params read { 0x%02X, 0x%02X, 0x%08X } .",
+					                          entry.segment, (int)entry.type, entry.paramsPtr));
 					return;
 				default:
 					// Because GCC is worried this could happen