Full call stack for DLL interface

Author: RPGHacker

src/asar-dll-bindings/c/asardll.h

@@ -9,14 +9,21 @@
 #include <stddef.h> // for size_t
 
 // These structures are returned from various functions
+struct stackentry {
+	const char * fullpath;
+	const char * prettypath;
+	int lineno;
+	const char * details;
+};
+
 struct errordata {
 	const char * fullerrdata;
 	const char * rawerrdata;
 	const char * block;
 	const char * filename;
 	int line;
-	const char * callerfilename;
-	int callerline;
+	const struct stackentry * callstack;
+	int callstacksize;
 	const char * errname;
 };
 

src/asar/asar.h

@@ -161,6 +161,14 @@ struct callstack_entry {
 };
 
 
+struct printable_callstack_entry {
+	string fullpath;
+	string prettypath;
+	int lineno;
+	string details;
+};
+
+
 extern autoarray<callstack_entry> callstack;
 extern bool simple_callstacks;
 
@@ -182,11 +190,7 @@ const char* get_current_file_name();
 int get_current_line();
 const char* get_current_block();
 
-// RPG Hacker: We only need to keep these two functions around
-// until we bump the DLL API version number and update the
-// interface to make use of the full callstack.
-const char* get_previous_file_name();
-int get_previous_file_line_no();
+void get_full_printable_callstack(autoarray<printable_callstack_entry>* out, int indentation, bool add_lines);
 
 #if !defined(NO_USE_THREADS) && !defined(RUN_VIA_THREAD)
 // RPG Hacker: This is currently disabled for debug builds, because it causes random crashes

src/asar/interface-lib.cpp

@@ -34,6 +34,16 @@ struct patchparams_base {
 	int structsize;
 };
 
+
+/* $EXPORTSTRUCT$
+ */
+struct stackentry {
+	const char * fullpath;
+	const char * prettypath;
+	int lineno;
+	const char * details;
+};
+
 /* $EXPORTSTRUCT$
  */
 struct errordata {
@@ -42,8 +52,8 @@ struct errordata {
 	const char * block;
 	const char * filename;
 	int line;
-	const char * callerfilename;
-	int callerline;
+	const struct stackentry * callstack;
+	int callstacksize;
 	const char * errname;
 };
 static  autoarray<errordata> errors;
@@ -100,11 +110,23 @@ static void fillerror(errordata& myerr, const char* errname, const char * type,
 	string details;
 	get_current_line_details(&location, &details);
 	myerr.fullerrdata= duplicate_string(location+": "+type+str+details+get_callstack());
-	// RPG Hacker: TODO: Rework this into a full call stack return value once we bump the DLL API version again.
-	myerr.callerline=get_previous_file_line_no();
-	const char* prev_file = get_previous_file_name();
-	myerr.callerfilename=prev_file ? duplicate_string(prev_file) : nullptr;
 	myerr.errname = duplicate_string(errname);
+
+	autoarray<printable_callstack_entry> printable_stack;
+	get_full_printable_callstack(&printable_stack, 0, false);
+
+	myerr.callstacksize = printable_stack.count;
+	myerr.callstack = static_cast<stackentry*>(malloc(sizeof(stackentry) * myerr.callstacksize));
+
+	for (int i = 0; i < myerr.callstacksize; ++i)
+	{
+		stackentry& entry = const_cast<stackentry&>(myerr.callstack[i]);
+
+		entry.fullpath = duplicate_string(printable_stack[i].fullpath);
+		entry.prettypath = duplicate_string(printable_stack[i].prettypath);
+		entry.lineno = printable_stack[i].lineno;
+		entry.details = duplicate_string(printable_stack[i].details);
+	}
 }
 
 static bool ismath=false;
@@ -149,9 +171,17 @@ static void resetdllstuff()
 		free_and_null(errors[i].filename);
 		free_and_null(errors[i].rawerrdata);
 		free_and_null(errors[i].fullerrdata);
-		free_and_null(errors[i].callerfilename);
 		free_and_null(errors[i].block);
 		free_and_null(errors[i].errname);
+
+		for (int j=0;j<errors[i].callstacksize;++j)
+		{
+			stackentry& entry = const_cast<stackentry&>(errors[i].callstack[j]);
+			free_and_null(entry.fullpath);
+			free_and_null(entry.prettypath);
+			free_and_null(entry.details);
+		}
+		free_and_null(errors[i].callstack);
 	}
 	errors.reset();
 	numerror=0;
@@ -161,8 +191,17 @@ static void resetdllstuff()
 		free_and_null(warnings[i].filename);
 		free_and_null(warnings[i].rawerrdata);
 		free_and_null(warnings[i].fullerrdata);
-		free_and_null(warnings[i].callerfilename);
 		free_and_null(warnings[i].block);
+		free_and_null(warnings[i].errname);
+
+		for (int j=0;j<warnings[i].callstacksize;++j)
+		{
+			stackentry& entry = const_cast<stackentry&>(warnings[i].callstack[j]);
+			free_and_null(entry.fullpath);
+			free_and_null(entry.prettypath);
+			free_and_null(entry.details);
+		}
+		free_and_null(warnings[i].callstack);
 	}
 	warnings.reset();
 	numwarn=0;

src/asar/interface-lib.h

@@ -8,14 +8,21 @@
 #include <stddef.h> // for size_t
 
 //These structures are returned from various functions.
+struct stackentry {
+	const char * fullpath;
+	const char * prettypath;
+	int lineno;
+	const char * details;
+};
+
 struct errordata {
 	const char * fullerrdata;
 	const char * rawerrdata;
 	const char * block;
 	const char * filename;
 	int line;
-	const char * callerfilename;
-	int callerline;
+	const struct stackentry * callstack;
+	int callstacksize;
 	const char * errname;
 };
 

src/asar/main.cpp

@@ -136,18 +136,23 @@ string generate_call_details_string(const char* current_block, const char* curre
 	return e;
 }
 
-string generate_filename_and_line(const char* current_file, int current_line_no)
+string get_pretty_filename(const char* current_file)
 {
 	// RPG Hacker: One could make an argument that we shouldn't shorten paths
 	// here, since some IDEs support jumping to files by double-clicking their
 	// paths. However, AFAIK, no IDE supports this for Asar yet, and if it's
 	// ever desired, we could just make it a command line option. Until then,
 	// I think it's more important to optimize for pretty command line display.
-	return STR shorten_to_relative_path(get_top_level_directory(), current_file)
+	return shorten_to_relative_path(get_top_level_directory(), current_file);
+}
+
+string generate_filename_and_line(const char* current_file, int current_line_no)
+{
+	return STR current_file
 		+ (current_line_no>=0?STR ":"+dec(current_line_no+1):"");
 }
 
-void push_stack_line(autoarray<string>* lines, const char* current_file, const char* current_block, const char* current_call, int current_line_no, int stack_frame_index)
+string format_stack_line(const printable_callstack_entry& entry, int stack_frame_index)
 {
 	string indent = "\n|   ";
 	indent += dec(stack_frame_index);
@@ -156,10 +161,19 @@ void push_stack_line(autoarray<string>* lines, const char* current_file, const c
 	// hundreds even, so this very specific, lazy solution suffices.
 	if (stack_frame_index < 100) indent += " ";
 	if (stack_frame_index < 10) indent += " ";
-	lines->append(indent 
-		+ generate_filename_and_line(current_file, current_line_no)
-		+ generate_call_details_string(current_block, current_call, 12, true)
-	);
+	return indent 
+		+ generate_filename_and_line(entry.prettypath, entry.lineno)
+		+ entry.details;
+}
+
+void push_stack_line(autoarray<printable_callstack_entry>* out, const char* current_file, const char* current_block, const char* current_call, int current_line_no, int indentation, bool add_lines)
+{
+	printable_callstack_entry new_entry;
+	new_entry.fullpath = current_file;
+	new_entry.prettypath = get_pretty_filename(current_file);
+	new_entry.lineno = current_line_no;
+	new_entry.details = strip_whitespace(generate_call_details_string(current_block, current_call, indentation, add_lines).raw());
+	out->append(new_entry);
 }
 
 void get_current_line_details(string* location, string* details, bool exclude_block)
@@ -175,7 +189,7 @@ void get_current_line_details(string* location, string* details, bool exclude_bl
 			case callstack_entry_type::FILE:
 				current_file = callstack[i].content;
 				if (exclude_block) current_block = nullptr;
-				*location = generate_filename_and_line(current_file, current_line_no);
+				*location = generate_filename_and_line(get_pretty_filename(current_file), current_line_no);
 				*details = generate_call_details_string(current_block, current_call, 4, false);
 				return;
 			case callstack_entry_type::MACRO_CALL:
@@ -194,9 +208,9 @@ void get_current_line_details(string* location, string* details, bool exclude_bl
 	*details = "";
 }
 
-string get_full_callstack()
+void get_full_printable_callstack(autoarray<printable_callstack_entry>* out, int indentation, bool add_lines)
 {
-	autoarray<string> lines;
+	out->reset();
 	const char* current_file = nullptr;
 	const char* current_block = nullptr;
 	const char* current_call = nullptr;
@@ -208,7 +222,7 @@ string get_full_callstack()
 			case callstack_entry_type::FILE:
 				if (current_file != nullptr)
 				{
-					push_stack_line(&lines, current_file, current_block, current_call, current_line_no, lines.count);
+					push_stack_line(out, current_file, current_block, current_call, current_line_no, indentation, add_lines);
 				}
 				current_file = callstack[i].content;
 				current_block = nullptr;
@@ -228,16 +242,21 @@ string get_full_callstack()
 				break;
 		}
 	}
-	// RPG Hacker: This pop here is incorrect, because with the
-	// way we traverse the call stack, the highest level is
-	// already automatically excluded, anyways.
-	//if (lines.count > 0) lines.remove(lines.count-1);
-	
+}
+
+string get_full_callstack()
+{
+	autoarray<printable_callstack_entry> printable_stack;
+	get_full_printable_callstack(&printable_stack, 12, true);
+
 	string e;
-	if (lines.count > 0)
+	if (printable_stack.count > 0)
 	{
 		e += "\nFull call stack:";
-		for (int i = lines.count-1; i >= 0; --i) e += lines[i];
+		for (int i = printable_stack.count-1; i >= 0; --i)
+		{
+			e += format_stack_line(printable_stack[i], i);
+		}
 	}
 	return e;
 }
@@ -293,7 +312,7 @@ string get_simple_callstack()
 	string e;
 	if (current_call != nullptr && current_file != nullptr)
 	{
-		e += STR "\n    called from: " + generate_filename_and_line(current_file, current_line_no)
+		e += STR "\n    called from: " + generate_filename_and_line(get_pretty_filename(current_file), current_line_no)
 			+ ": [%" + current_call + "]";
 	}
 	return e;
@@ -1156,38 +1175,6 @@ const char* get_current_block()
 	return nullptr;
 }
 
-const char* get_previous_file_name()
-{
-	int num_files = 0;
-	for (int i = callstack.count-1; i >= 0; --i)
-	{
-		if (callstack[i].type == callstack_entry_type::FILE)
-		{
-			num_files++;
-			if (num_files > 1) return callstack[i].content.raw();
-		}			
-	}
-	return nullptr;
-}
-
-int get_previous_file_line_no()
-{
-	int num_files = 0;
-	for (int i = callstack.count-1; i >= 0; --i)
-	{
-		if (callstack[i].type == callstack_entry_type::FILE)
-		{
-			num_files++;
-			if (num_files > 1) return -1;
-		}
-		else if (callstack[i].type == callstack_entry_type::LINE)
-		{
-			if (num_files == 1) return callstack[i].lineno;
-		}
-	}
-	return -1;
-}
-
 
 void reseteverything()
 {