Improve fatal error messages with instructions

Author: szapp

.github/workflows/build.yml

@@ -7,8 +7,6 @@ on:
       - "!.*"
       - "!.github/**/*"
       - "!README.md"
-    tags-ignore:
-      - "**"
   workflow_dispatch:
 
 jobs:

Makefile

@@ -171,6 +171,8 @@ FUNC_BASE		:=	freeVdfArray								\
 					dispatch									\
 					parseVersionString							\
 					scriptPathInvalid							\
+					reportVersionMismatch						\
+					reportIllegalVdf							\
 					debugMessage								\
 					zCPar_Symbol__GetNext_fix					\
 					createSymbol								\

src/core.asm

@@ -26,6 +26,8 @@ section .text
 %include "func/dispatch.asm"
 %include "func/parseVersionString.asm"
 %include "func/scriptPathInvalid.asm"
+%include "func/reportVersionMismatch.asm"
+%include "func/reportIllegalVdf.asm"
 %include "func/debugMessage.asm"
 %include "func/zCPar_Symbol__GetNext_fix.asm"
 %include "func/createSymbol.asm"

src/data/messages.asm

@@ -28,19 +28,18 @@ NINJA_SYMBOL_FAILED      db   AUTHOR_PREFIX, ':NINJA: Failed to add symbol: ', 0
 NINJA_STRINGCOUNT_APPLY  db   AUTHOR_PREFIX, ':NINJA: Adjusting string count to ', 0
 NINJA_STRINGCOUNT_FAILED db   AUTHOR_PREFIX, ':NINJA: Failed to adjust string count', 0
 NINJA_SKIPPING           db   AUTHOR_PREFIX, ':NINJA: Skipping : ', 0
-NINJA_OUTDATED_PATCH     db   AUTHOR_PREFIX, ':NINJA: Outdated VDF found (Ninja < 2)', 0
-NINJA_INVALID_PATCH      db   AUTHOR_PREFIX, ':NINJA: Illegal VDF: ', 0
-NINJA_MISSING_TOOLKIT    db   AUTHOR_PREFIX, ':NINJA: Missing dependency. Please install Toolkit', 0
 NINJA_VERIFY_PATH        db   AUTHOR_PREFIX, ':NINJA: Verifying file path', 0
 NINJA_VERIFY_VERSION     db   AUTHOR_PREFIX, ':NINJA: Verifying version', 0
 NINJA_COMPARE_VERSIONS   db   AUTHOR_PREFIX, ':NINJA: Comparing versions', 0
-NINJA_PARSER_FAILED      db   AUTHOR_PREFIX, ':NINJA: Version mismatch of ', 0
-NINJA_PARSER_FAILED_2    db   '. ', 10, 13
+
+; Fatal errors
+NINJA_INVALID_PATCH      db   'Illegal VDF found "%s.VDF". ', 10, 13
+                         db   'Remove it from /Data/ to continue.', 0
+NINJA_MISSING_TOOLKIT    db   'Missing dependency. Please install Toolkit. ', 10, 13
+                         db   NINJA_WEBSITE, '/toolkit', 0
 NINJA_PATH_INVALID       db   'Ikarus/LeGo must not be contained in any patch.', 0
-NINJA_LEGO_VER_ERROR     db   AUTHOR_PREFIX, ':NINJA: LeGo version invalid: ', 0
-NINJA_LEGO_END           db   'No onset.', 0
-NINJA_LEGO_BMM           db   'BMM incomplete.', 0
-NINJA_VERSION_INVALID    db   AUTHOR_PREFIX, ':NINJA: Version mismatch of %s. ', 10, 13
-                         db   'Game: %09d, Toolkit: %09d ', 10, 13
-                         db   'Please update Toolkit or report this to ', 10, 13
-                         db   '<', NINJA_WEBSITE, '>', 0
+NINJA_LEGO_VER_ERROR     db   'LeGo version invalid.', 0
+NINJA_VERSION_INVALID    db   'Version mismatch of %s. ', 10, 13
+                         db   'Expected: %09d, Toolkit: %09d ', 10, 13
+                         db   'Please update Ninja and Toolkit or report this to ', 10, 13
+                         db   NINJA_WEBSITE, 0

src/exec/createVdfArray.asm

@@ -50,21 +50,14 @@ createVdfArray:
         add     esp, 0x14
 
 %if GOTHIC_BASE_VERSION == 1 || GOTHIC_BASE_VERSION == 2
-        mov     al, [SystemPack_version_info+g1g2(0xD,,,0xB)]          ; Check for old Ninja system
+        mov     al, [SystemPack_version_info+g1g2(0xD,,,0xB)]              ; Check for old Ninja system
         cmp     al, 'N'
         jnz     .registerConsole
 
-        sub     esp, 0x14
-        mov     ecx, esp
-        push    NINJA_OUTDATED_PATCH
-        call    zSTRING__zSTRING
-    addStack 4
-        push    ecx
-        call    zERROR__Fatal
+        push    char_NUL
+        call    ninja_reportIllegalVdf
     addStack 4
-        ; mov     ecx, esp                                                 ; Never reached: Safe some space
-        ; call    zSTRING___zSTRING
-        add     esp, 0x14
+        ; jmp     .back                                                    ; Never reached: Safe some space
 %endif
 
 .registerConsole:
@@ -332,20 +325,10 @@ createVdfArray:
         test    eax, eax
         jz      .findDirEnd                                                ; This patch is based on Ninja: confirmed
 
-        sub     esp, 0x14                                                  ; Only allow patches with directory of same name
-        mov     ecx, esp
-        push    NINJA_INVALID_PATCH
-        call    zSTRING__zSTRING
-    addStack 4
-        push    DWORD [esp+stackoffset+var_patchname]
-        call    zSTRING__operator_plusEq
+        push    DWORD [esp+stackoffset+var_patchname]                      ; Only allow patches with directory of same name
+        call    ninja_reportIllegalVdf
     addStack 4
-        push    ecx
-        call    zERROR__Fatal
-    addStack 4
-        ; mov     ecx, esp                                                 ; Never reached: Safe some space
-        ; call    zSTRING___zSTRING
-        add     esp, 0x14
+        ; jmp     .back                                                    ; Never reached: Safe some space
 
 .dirLoopNext:
         mov     ecx, [edi+VDFentry.type]                                   ; Advance to next entry if not last one

src/exec/parse.asm

@@ -287,25 +287,13 @@ parser_verify_ikarus_version:
         cmp     ebx, IKARUS_VERSION
         jge     .verifyFilePath
 
-        sub     esp, 0x14
-        mov     ecx, esp
-        push    NINJA_PARSER_FAILED
-        call    zSTRING__zSTRING
-    addStack 4
+        push    ebx
+        push    IKARUS_VERSION
         push    char_ikarus
-        call    zSTRING__operator_plusEq
-    addStack 4
-        push    NINJA_PARSER_FAILED_2
-        call    zSTRING__operator_plusEq
-    addStack 4
-        push    eax
-        call    zERROR__Fatal
-    addStack 4
-        ; mov     ecx, esp                                                 ; Never reached: Safe some space
-        ; call    zSTRING___zSTRING
-        add     esp, 0x14
+        call    ninja_reportVersionMismatch
+    addStack 3*4
     verifyStackoffset g1g2(0x398,0x38C,0x3F0,0x3F0) + 0xC
-        jmp     .back
+        ; jmp     .back                                                    ; Never reached: Safe some space
 
 .verifyFilePath:
         push    NINJA_PATH_IKARUS
@@ -333,40 +321,13 @@ parser_verify_ikarus_version:
     verifyStackoffset g1g2(0x398,0x38C,0x3F0,0x3F0) + 0xC
         jge     .back
 
-        push    edi
-        mov     edi, eax
-        sub     esp, 0x4
-        push    0x200
-        call    operator_new
-        add     esp, 0x4
-        push    0x1FF
-        push    0x20
-        push    eax
-        call    _memset
-        add     esp, 0xC
-        mov     BYTE [eax+0x1FF], 0x0                                      ; Null-terminated
-        sub     esp, 0x14
-        mov     ecx, esp
-        push    eax
-        call    zSTRING__zSTRING
-    addStack 4
         push    ebx
-        push    edi
+        push    eax
         push    char_ikarus
-        push    NINJA_VERSION_INVALID
-        push    ecx
-        call    zSTRING__Sprintf
-        add     esp, 0x14
-        push    esp
-        call    zERROR__Fatal
-    addStack 4
-        ; mov     ecx, esp                                                 ; Never reached: Safe some space
-        ; call    zSTRING___zSTRING
-        add     esp, 0x14
-        push    esp
-        call    operator_delete
-        add     esp, 0x8
-        pop     edi
+        call    ninja_reportVersionMismatch
+    addStack 3*4
+    verifyStackoffset g1g2(0x398,0x38C,0x3F0,0x3F0) + 0xC
+        ; jmp     .back                                                    ; Never reached: Safe some space
 
 .skip:
         mov     ebx, DWORD [esp+var_newvalue]                              ; New value of symbol (content)
@@ -489,14 +450,8 @@ parser_verify_lego_version:
 .invalidVersion:
         sub     esp, 0x14
         mov     ecx, esp
-        push    NINJA_PARSER_FAILED
+        push    NINJA_PATH_INVALID
         call    zSTRING__zSTRING
-    addStack 4
-        push    char_lego
-        call    zSTRING__operator_plusEq
-    addStack 4
-        push    NINJA_PARSER_FAILED_2
-        call    zSTRING__operator_plusEq
     addStack 4
         push    eax
         call    zERROR__Fatal
@@ -505,7 +460,7 @@ parser_verify_lego_version:
         ; call    zSTRING___zSTRING
         add     esp, 0x14
     verifyStackoffset g1g2(0x394,0x388,0x3EC,0x3EC) + 0x10
-        jmp     .back
+        ; jmp     .back                                                    ; Never reached: Safe some space
 
 .verifyFilePath:
         push    NINJA_PATH_LEGO
@@ -540,41 +495,13 @@ parser_verify_lego_version:
     verifyStackoffset g1g2(0x394,0x388,0x3EC,0x3EC) + 0x10
         jge     .back
 
-        push    edi
-        mov     edi, eax
-        sub     esp, 0x4
-        push    0x200
-        call    operator_new
-        add     esp, 0x4
-        push    0x1FF
-        push    0x20
-        push    eax
-        call    _memset
-        add     esp, 0xC
-        mov     BYTE [eax+0x1FF], 0x0                                      ; Null-terminated
-        sub     esp, 0x14
-        mov     ecx, esp
         push    eax
-        call    zSTRING__zSTRING
-    addStack 4
-        push    edi
         push    ebx
         push    char_lego
-        push    NINJA_VERSION_INVALID
-        push    ecx
-        call    zSTRING__Sprintf
-        add     esp, 0x14
-        push    esp
-        call    zERROR__Fatal
-    addStack 4
-        ; mov     ecx, esp                                                 ; Never reached: Safe some space
-        ; call    zSTRING___zSTRING
-        add     esp, 0x14
-        ; push    esp                                                      ; Never reached: Safe some space
-        ; call    operator_delete
-        ; add     esp, 0x4
-        add     esp, 0x4
-        pop     edi
+        call    ninja_reportVersionMismatch
+    addStack 3*4
+    verifyStackoffset g1g2(0x394,0x388,0x3EC,0x3EC) + 0x10
+        ; jmp     .back                                                    ; Never reached: Safe some space
 
 .skip:
         mov     ecx, [ebp+zCPar_Symbol_content_offset]

src/func/parseVersionString.asm

@@ -28,7 +28,7 @@ ninja_parseVersionString:
         mov     ecx, [esi+edi]
         cmp     cl, 0
     verifyStackoffset 0x10+var_total
-        jz      .failed1
+        jz      .reportError
 
         inc     edi
         cmp     cl, ' '
@@ -71,7 +71,7 @@ ninja_parseVersionString:
 .done:
         cmp     edx, var_minor
     verifyStackoffset 0x10+var_total
-        jg      .failed2
+        jg      .reportError
         jz      .foundOffset
 
 .final:
@@ -85,21 +85,11 @@ ninja_parseVersionString:
     verifyStackoffset 0x10+var_total
         jmp     .funcEnd
 
-.failed1:
-        mov     esi, NINJA_LEGO_END
-        jmp     .reportError
-
-.failed2:
-        mov     esi, NINJA_LEGO_BMM
-
 .reportError:
         sub     esp, 0x14
         mov     ecx, esp
         push    NINJA_LEGO_VER_ERROR
         call    zSTRING__zSTRING
-    addStack 4
-        push    esi
-        call    zSTRING__operator_plusEq
     addStack 4
         push    eax
         call    zERROR__Fatal

src/func/reportIllegalVdf.asm

@@ -0,0 +1,44 @@
+; void __stdcall ninja_reportIllegalVdf(char *)
+; Report an illegal VDF archive and terminate (does not return)
+global ninja_reportIllegalVdf
+ninja_reportIllegalVdf:
+        resetStackoffset
+        %assign arg_1      +0x4                                            ; char *
+        %assign arg_total   0x4
+
+        ; pusha                                                            ; Function never returns: Safe some space
+
+        sub     esp, 0x4
+        push    0x200
+        call    operator_new
+        add     esp, 0x4
+        push    0x1FF
+        push    0x20
+        push    eax
+        call    _memset
+        add     esp, 0xC
+        mov     BYTE [eax+0x1FF], 0x0                                      ; Null-terminated
+        sub     esp, 0x14
+        mov     ecx, esp
+        push    eax
+        call    zSTRING__zSTRING
+    addStack 4
+        push    DWORD [esp+stackoffset+arg_1]
+        push    NINJA_INVALID_PATCH
+        push    ecx
+        call    zSTRING__Sprintf
+        add     esp, 0xC
+        push    esp
+        call    zERROR__Fatal
+    addStack 4
+        ; mov     ecx, esp                                                 ; Never reached: Safe some space
+        ; call    zSTRING___zSTRING
+        add     esp, 0x14
+        ; push    esp                                                      ; Never reached: Safe some space
+        ; call    operator_delete
+        ; add     esp, 0x4
+        add     esp, 0x4
+
+        ; popa                                                             ; Function never returns: Safe some space
+        ; ret     arg_total
+    verifyStackoffset

src/func/reportVersionMismatch.asm

@@ -0,0 +1,48 @@
+; void __stdcall ninja_reportVersionMismatch(char *, int, int)
+; Report an invalid version and terminate (does not return)
+global ninja_reportVersionMismatch
+ninja_reportVersionMismatch:
+        resetStackoffset
+        %assign arg_1      +0x4                                            ; char *
+        %assign arg_2      +0x8                                            ; int
+        %assign arg_3      +0xC                                            ; int
+        %assign arg_total   0xC
+
+        ; pusha                                                            ; Function never returns: Safe some space
+
+        sub     esp, 0x4
+        push    0x200
+        call    operator_new
+        add     esp, 0x4
+        push    0x1FF
+        push    0x20
+        push    eax
+        call    _memset
+        add     esp, 0xC
+        mov     BYTE [eax+0x1FF], 0x0                                      ; Null-terminated
+        sub     esp, 0x14
+        mov     ecx, esp
+        push    eax
+        call    zSTRING__zSTRING
+    addStack 4
+        push    DWORD [esp+stackoffset+arg_3]
+        push    DWORD [esp+stackoffset+arg_2]
+        push    DWORD [esp+stackoffset+arg_1]
+        push    NINJA_VERSION_INVALID
+        push    ecx
+        call    zSTRING__Sprintf
+        add     esp, 0x14
+        push    esp
+        call    zERROR__Fatal
+    addStack 4
+        ; mov     ecx, esp                                                 ; Never reached: Safe some space
+        ; call    zSTRING___zSTRING
+        add     esp, 0x14
+        ; push    esp                                                      ; Never reached: Safe some space
+        ; call    operator_delete
+        ; add     esp, 0x4
+        add     esp, 0x4
+
+        ; popa                                                             ; Function never returns: Safe some space
+        ; ret     arg_total
+    verifyStackoffset