Merge pull request #2684 from AllenInstitute/feature/2684-prepend-module-name-functions

PrependModuleNameIfStatic_TS: Add it and use it

Author: t-b

Packages/MIES/MIES_Debugging.ipf

@@ -22,11 +22,16 @@ static Function FindFirstOutsideCaller(string &func, string &line, string &file)
 
 	for(i = numCallers - 2; i >= 0; i -= 1)
 		caller = StringFromList(i, stacktrace)
-		func   = StringFromList(0, caller, ",")
-		file   = StringFromList(1, caller, ",")
-		line   = StringFromList(2, caller, ",")
+
+		file = StringFromList(1, caller, ",")
 
 		if(cmpstr("MIES_DEBUGGING.ipf", file))
+
+			func = StringFromList(0, caller, ",")
+			line = StringFromList(2, caller, ",")
+
+			func = PrependModuleNameIfStatic_TS(func, file)
+
 			return NaN
 		endif
 	endfor

Packages/MIES/MIES_Utilities_ProgramFlow.ipf

@@ -83,6 +83,41 @@ Function DoAbortNow(string msg)
 	Abort
 End
 
+#if IgorVersion() < 10
+
+/// @brief Prepend the regular module name (if available) for static functions to the function name
+///
+/// Due to this feature being IP10 only we always return just the function name.
+threadsafe Function/S PrependModuleNameIfStatic_TS(string func, string procWin)
+
+	return func
+End
+
+#else
+
+/// @brief Prepend the regular module name (if available) for static functions to the function name
+threadsafe Function/S PrependModuleNameIfStatic_TS(string func, string procWin)
+
+	string info, module
+
+	info = FunctionInfo(func, procWin)
+
+	if(!cmpstr(StringByKey("SPECIAL", info), "static"))
+		module = StringByKey("MODULE", info)
+
+		if(IsEmpty(module))
+			// not in a regular module
+			return func
+		endif
+
+		return module + "#" + func
+	endif
+
+	return func
+End
+
+#endif
+
 /// @brief Return a nicely formatted multiline stacktrace
 threadsafe Function/S GetStackTrace([string prefix])
 
@@ -110,9 +145,13 @@ threadsafe Function/S GetStackTrace([string prefix])
 
 	for(i = 0; i < (numCallers - 2); i += 1)
 		entry = StringFromList(i, stacktrace)
-		func  = StringFromList(0, entry, ",")
-		file  = StringFromList(1, entry, ",")
-		line  = StringFromList(2, entry, ",")
+
+		func = StringFromList(0, entry, ",")
+		file = StringFromList(1, entry, ",")
+		line = StringFromList(2, entry, ",")
+
+		func = PrependModuleNameIfStatic_TS(func, file)
+
 		sprintf str, "%s%s(...)#L%s [%s]\r", prefix, func, line, file
 		output += str
 	endfor

Packages/tests/Basic/UTF_Utils_ProgramFlow.ipf

@@ -167,3 +167,51 @@ Function RunningInMainThread_Main()
 End
 
 /// @}
+
+/// PrependModuleNameIfStatic_TS
+/// @{
+
+Function PMNW_Helper_IGNORE()
+End
+
+static Function PMNW_Helper_static_IGNORE()
+End
+
+threadsafe static Function PMNW_Helper_static_TS_IGNORE()
+End
+
+threadsafe Function PMNW_Helper_TS_IGNORE()
+End
+
+Function PMNWorks()
+
+	string module, func, funcWithMod
+
+	module = "UTILSTEST_PROGRAMFLOW"
+
+	func        = "PMNW_Helper_IGNORE"
+	funcWithMod = func
+	CHECK_EQUAL_STR(PrependModuleNameIfStatic_TS(func, "UTF_Utils_ProgramFlow.ipf"), func)
+
+	func        = "PMNW_Helper_TS_IGNORE"
+	funcWithMod = func
+	CHECK_EQUAL_STR(PrependModuleNameIfStatic_TS(func, "UTF_Utils_ProgramFlow.ipf"), funcWithMod)
+
+	func = "PMNW_Helper_static_IGNORE"
+#if IgorVersion() >= 10
+	funcWithMod = module + "#" + func
+#else
+	funcWithMod = func
+#endif
+	CHECK_EQUAL_STR(PrependModuleNameIfStatic_TS(func, "UTF_Utils_ProgramFlow.ipf"), funcWithMod)
+
+	func = "PMNW_Helper_static_TS_IGNORE"
+#if IgorVersion() >= 10
+	funcWithMod = module + "#" + func
+#else
+	funcWithMod = func
+#endif
+	CHECK_EQUAL_STR(PrependModuleNameIfStatic_TS(func, "UTF_Utils_ProgramFlow.ipf"), funcWithMod)
+End
+
+/// @}