Merge branch 'master' into asar_2_beta

Author: RPGHacker

README.md

@@ -14,11 +14,18 @@ If you'd rather not build from source, check out the [Releases](https://github.c
 Asar can also be built as a DLL. This makes it easier and faster to use in other programs (such as a sprite insertion tool). You can find documentation on the DLL API in the respective bindings (asardll.h, asar.cs, asar.py).
 
 ## Asar as a static library
-Asar can also be build as a static library. All "out-facing" functions are in interface-lib.h. This is useful for embedding Asar in other programs which don't want to use DLLs. The easiest way to add asar as a static library to your project, assuming you are using CMake (at least 3.11), is to use [FetchContent](https://cmake.org/cmake/help/latest/module/FetchContent.html) to fetch the source code, then add the following to your CMakeLists.txt:
+Asar can also be built as a static library. All "out-facing" functions are in interface-lib.h. This is useful for embedding Asar in other programs which don't want to use DLLs. The easiest way to add asar as a static library to your project is to add it as a git submodule 
+
+`git submodule add https://github.com/RPGHacker/asar <path-to-subdir>`
+
+then add the following to your CMakeLists.txt:
 ```CMake
-target_include_directories(YourTarget PUBLIC ${asar_SOURCE_DIR}/src)
+add_subdirectory(<path-to-subdir>/src)
+get_target_property(ASAR_INCLUDE_DIR asar-static INCLUDE_DIRECTORIES)
+include_directories(${ASAR_INCLUDE_DIR})
+target_link_libraries(YourTarget PUBLIC asar-static)
 ```
-to be able to include the header files. It is also recommended to add `set(ASAR_TESTING_DISABLED TRUE)` to your CMakeLists.txt to disable building tests.
+to be able to include the header files. It is also recommended to turn off every build in target in asar except the static one using the appropriate CMake options. You will need to make sure that your project has an Asar compatible license.
 
 ## Folder layout
 * `docs` contains the source of the manual and changelog.
@@ -46,7 +53,7 @@ These two characters should precede each test line, so that Asar sees them as co
 * 2 hex digits - a byte for it to check for 
   * You can specify more than one, like in the examples below, and it will automatically increment the offset.
 * A line starting with `+` tells the testing app to patch the SMW ROM instead of creating a new ROM
-* `errEXXXX` and `warnWXXXX` (where `XXXX` is an ID number) means that the test is expected to throw that specific error or warning while patching. The test will succeed only if the number and order of errors and warnings thrown exactly matches what's specified here. Be wary that Asar uses multiple passes and throws errors and warnings across multiple of them. This can make the actual order in which errors and warnings are thrown a bit unintuitive.
+* `errE{name}` and `warnW{name}` (where `{name}` is the name of an error or warning) means that the test is expected to throw that specific error or warning while patching. The test will succeed only if the number and order of errors and warnings thrown exactly matches what's specified here. Be wary that Asar uses multiple passes and throws errors and warnings across multiple of them. This can make the actual order in which errors and warnings are thrown a bit unintuitive.
 
 In addition to the format mentioned above, it's also possible to check for user prints a patch is expected to output (by `print`, `error`, `warn` or `assert` commands). This is done by starting the line with one of the following sequences:
 ```
@@ -68,17 +75,17 @@ This line tests that `22`, `20`, `80` and `90` were written to the ROM offset `0
 ;`007606 22 20 80 90
 ```
 
-This line tests that assembling the patch throws error `5117` twice and warning `1030` once.
+This line tests that assembling the patch throws error `Eunknown_command` twice and warning `Wfeature_deprecated` once.
 ```
-;`errE5117
-;`errE5117
-;`warnW1030
+;`errEunknown_command
+;`errEunknown_command
+;`warnWfeature_deprecated
 ```
 
-This line tests that the byte `FF` was written to the start of the ROM, that the string `This is a print.` was printed and that the string `This is a user error.` was output via the error command (which itself also causes error `E5159`to be thrown once).
+This line tests that the byte `FF` was written to the start of the ROM, that the string `This is a print.` was printed and that the string `This is a user error.` was output via the error command (which itself also causes error `Eerror_command` to be thrown once).
 ```
 ;`FF
 ;P>This is a print.
 ;E>This is a user error.
-;`errE5159
+;`errEerror_command
 ```

docs/changelog/index.html

@@ -102,6 +102,11 @@ <h3>Deprecated features:</h3>
 		<ul>
 		</ul></div>
 
+		<h3>Deprecated features:</h3>
+		<ul>
+			<li>Warning and error IDs: Asar now uses named warnings and errors. (p4plus2, RPG Hacker)</li>
+		</ul></div>
+
 		<hr />
 
 		<div><h2>v1.81</h2>

src/asar-tests/test.cpp

@@ -714,8 +714,8 @@ int main(int argc, char * argv[])
 
 		int numiter = 1;
 
-		std::vector<int> expected_errors;
-		std::vector<int> expected_warnings;
+		std::vector<std::string> expected_errors;
+		std::vector<std::string> expected_warnings;
 		std::vector<std::string> expected_prints;
 		std::vector<std::string> expected_error_prints;
 		std::vector<std::string> expected_warn_prints;
@@ -771,30 +771,16 @@ int main(int argc, char * argv[])
 					if (strncmp(cur_word.c_str(), token, strlen(token)) == 0)
 					{
 						const char* idstr = cur_word.c_str() + strlen(token);
-						char* endpos = nullptr;
-						long int id = strtol(idstr, &endpos, 10);
 
-						if (endpos == nullptr || *endpos != '\0')
-						{
-							dief("Error: Invalid %s declaration!\n", token);
-						}
-
-						expected_errors.push_back((int)id);
+						expected_errors.push_back(idstr-1);
 					}
 
 					token = "warnW";
 					if (strncmp(cur_word.c_str(), token, strlen(token)) == 0)
 					{
 						const char* idstr = cur_word.c_str() + strlen(token);
-						char* endpos = nullptr;
-						long int id = strtol(idstr, &endpos, 10);
-
-						if (endpos == nullptr || *endpos != '\0')
-						{
-							dief("Error: Invalid %s declaration!\n", token);
-						}
 
-						expected_warnings.push_back((int)id);
+						expected_warnings.push_back(idstr-1);
 					}
 
 					if (pos > len) len = pos;
@@ -1022,8 +1008,8 @@ int main(int argc, char * argv[])
 		}
 #endif
 
-		std::vector<int> actual_errors;
-		std::vector<int> actual_warnings;
+		std::vector<std::string> actual_errors;
+		std::vector<std::string> actual_warnings;
 		std::vector<std::string> actual_prints;
 		std::vector<std::string> actual_error_prints;
 		std::vector<std::string> actual_warn_prints;
@@ -1042,20 +1028,20 @@ int main(int argc, char * argv[])
 					size_t found = log_line.find(token);
 					if (found != std::string::npos)
 					{
-						char* endpos = nullptr;
-						long int num = strtol(log_line.c_str() + found + strlen(token), &endpos, 10);
+						size_t found_end = log_line.find(')', found + 1);
 
-						if (endpos == nullptr || *endpos != ')')
+						if (found_end == std::string::npos)
 						{
-							dief("Error: Failed parsing error code from Asar output!\n");
+							dief("Error: Failed parsing error name from Asar output!\n");
 						}
 
-						actual_errors.push_back(num);
+						size_t start_pos = found + strlen(token) - 1;
+						actual_errors.push_back(log_line.substr(start_pos, found_end - start_pos));
 
 						// RPG Hacker: Check if it's the error command. If so, we also need to add a print as well.
 						{
 							std::string command_token = ": error command: ";
-							std::string remainder = endpos;
+							std::string remainder = log_line.substr(found_end+1);
 							size_t command_found = remainder.find(command_token);
 
 							if (command_found != std::string::npos)
@@ -1067,7 +1053,7 @@ int main(int argc, char * argv[])
 						// RPG Hacker: Same goes for the assert command.
 						{
 							std::string command_token = ": Assertion failed: ";
-							std::string remainder = endpos;
+							std::string remainder = log_line.substr(found_end + 1);
 							size_t command_found = remainder.find(command_token);
 
 							if (command_found != std::string::npos)
@@ -1084,20 +1070,20 @@ int main(int argc, char * argv[])
 					found = log_line.find(token);
 					if (found != std::string::npos)
 					{
-						char* endpos = nullptr;
-						long int num = strtol(log_line.c_str() + found + strlen(token), &endpos, 10);
+						size_t found_end = log_line.find(')', found + 1);
 
-						if (endpos == nullptr || *endpos != ')')
+						if (found_end == std::string::npos)
 						{
 							dief("Error: Failed parsing warning code from Asar output!\n");
 						}
 
-						actual_warnings.push_back(num);
+						size_t start_pos = found + strlen(token) - 1;
+						actual_warnings.push_back(log_line.substr(start_pos, found_end - start_pos));
 
 						// RPG Hacker: Check if it's the warn command. If so, we also need to add a print as well.
 						{
 							std::string command_token = ": warn command: ";
-							std::string remainder = endpos;
+							std::string remainder = log_line.substr(found_end + 1);
 							size_t command_found = remainder.find(command_token);
 
 							if (command_found != std::string::npos)
@@ -1178,28 +1164,28 @@ int main(int argc, char * argv[])
 			printf("\nExpected errors: ");
 			for (auto it = expected_errors.begin(); it != expected_errors.end(); ++it)
 			{
-				printf("%sE%d", (it != expected_errors.begin() ? "," : ""), *it);
+				printf("%s%s", (it != expected_errors.begin() ? "," : ""), it->c_str());
 			}
 			printf("\n");
 
 			printf("Actual errors: ");
 			for (auto it = actual_errors.begin(); it != actual_errors.end(); ++it)
 			{
-				printf("%sE%d", (it != actual_errors.begin() ? "," : ""), *it);
+				printf("%s%s", (it != actual_errors.begin() ? "," : ""), it->c_str());
 			}
 			printf("\n");
 
 			printf("\nExpected warnings: ");
 			for (auto it = expected_warnings.begin(); it != expected_warnings.end(); ++it)
 			{
-				printf("%sW%d", (it != expected_warnings.begin() ? "," : ""), *it);
+				printf("%s%s", (it != expected_warnings.begin() ? "," : ""), it->c_str());
 			}
 			printf("\n");
 
 			printf("Actual warnings: ");
 			for (auto it = actual_warnings.begin(); it != actual_warnings.end(); ++it)
 			{
-				printf("%sW%d", (it != actual_warnings.begin() ? "," : ""), *it);
+				printf("%s%s", (it != actual_warnings.begin() ? "," : ""), it->c_str());
 			}
 			printf("\n");
 
@@ -1243,7 +1229,7 @@ int main(int argc, char * argv[])
 		memcpy(truerom, out_rom_data.data(), out_rom_data.size());
 #endif
 		bool fail = false;
-		for (int i = 0;i < min(len, truelen);i++)
+		for (int i = 0;i < min(len, truelen); i++)
 		{
 			if (truerom[i] != expectedrom[i] && !(i >= 0x07FDC && i <= 0x07FDF && (expectedrom[i] == 0x00 || expectedrom[i] == smwrom[i])))
 			{