Merge pull request #6725 from Goober5000/time_lib_stuff

enhance scripted time library a bit

Author: Goober5000

code/globalincs/toolchain/clang.h

@@ -16,6 +16,7 @@
  * include toolchain.h which will pull in the file appropriate to
  * the detected toolchain.
  */
+#pragma once
 
 #if defined(__clang__)
 
@@ -63,6 +64,9 @@
 #define SIZE_T_ARG    "%zu"
 #define PTRDIFF_T_ARG "%zd"
 
+#define UINT64_T_ARG  "%" PRIu64
+#define  INT64_T_ARG  "%" PRId64
+
 #define likely(x)    __builtin_expect((long) !!(x), 1L)
 #define unlikely(x)  __builtin_expect((long) !!(x), 0L)
 

code/globalincs/toolchain/doxygen.h

@@ -5,6 +5,7 @@
  * or otherwise commercially exploit the source or things you created based on
  * the source.
  */
+#pragma once
 
 #if defined(DOXYGEN)
 /**
@@ -46,6 +47,22 @@
  */
 #define PTRDIFF_T_ARG "%zd"
 
+/**
+ * @brief Format specifier for a @c uint64_t argument
+ *
+ * Due to different runtimes using different format specifier for these types
+ * it's necessary to hide these changes behind a macro.
+ */
+#define UINT64_T_ARG  "%" PRIu64
+
+/**
+ * @brief Format specifier for an @c int64_t argument
+ *
+ * Due to different runtimes using different format specifier for these types
+ * it's necessary to hide these changes behind a macro.
+ */
+#define  INT64_T_ARG  "%" PRId64
+
 /**
  * @brief Attribute for forcing a static variable to be instantiated
  *

code/globalincs/toolchain/gcc.h

@@ -16,8 +16,10 @@
  * include toolchain.h which will pull in the file appropriate to
  * the detected toolchain.
  */
+#pragma once
 
-#if defined(__GNUC__)
+// per toolchain.h, clang takes precedence over gcc if they are both defined
+#if defined(__GNUC__) && !defined(__clang__)
 
 #define SCP_FORMAT_STRING
 #define SCP_FORMAT_STRING_ARGS(x,y)  __attribute__((format(printf, x, y)))
@@ -62,6 +64,9 @@
 #define SIZE_T_ARG    "%zu"
 #define PTRDIFF_T_ARG "%zd"
 
+#define UINT64_T_ARG  "%" PRIu64
+#define  INT64_T_ARG  "%" PRId64
+
 #define likely(x)    __builtin_expect((long) !!(x), 1L)
 #define unlikely(x)  __builtin_expect((long) !!(x), 0L)
 

code/globalincs/toolchain/mingw.h

@@ -16,6 +16,7 @@
  * include toolchain.h which will pull in the file appropriate to
  * the detected toolchain.
  */
+#pragma once
 
 #if defined(__MINGW32__)
 
@@ -59,6 +60,9 @@
 #define SIZE_T_ARG    "%zu"
 #define PTRDIFF_T_ARG "%zd"
 
+#define UINT64_T_ARG  "%" PRIu64
+#define  INT64_T_ARG  "%" PRId64
+
 #define likely(x)    __builtin_expect((long) !!(x), 1L)
 #define unlikely(x)  __builtin_expect((long) !!(x), 0L)
 

code/globalincs/toolchain/msvc.h

@@ -16,6 +16,7 @@
  * include toolchain.h which will pull in the file appropriate to
  * the detected toolchain.
  */
+#pragma once
 
 #if defined(_MSC_VER)
 
@@ -60,6 +61,9 @@
 #define SIZE_T_ARG    "%Iu"
 #define PTRDIFF_T_ARG "%Id"
 
+#define UINT64_T_ARG  "%I64u"
+#define  INT64_T_ARG  "%I64d"
+
 #define likely(x) (x)
 #define unlikely(x) (x)
 

code/parse/sexp_container.cpp

@@ -10,7 +10,6 @@
 
 #include "gamesequence/gamesequence.h"
 #include "globalincs/pstypes.h"
-#include "globalincs/toolchain.h"
 #include "mission/missiongoals.h"
 #include "parse/generic_log.h"
 #include "parse/parselo.h"

code/scripting/api/objs/time_obj.cpp

@@ -1,11 +1,12 @@
 //
 //
 #include "time_obj.h"
+#include "globalincs/pstypes.h"
 
 namespace scripting {
 namespace api {
 
-ADE_OBJ(l_Timestamp, uint64_t, "timestamp", "A real time time stamp of unspecified precision and resolution.");
+ADE_OBJ(l_Timestamp, uint64_t, "timestamp", "A real-time timestamp of unspecified precision and resolution.");
 
 ADE_FUNC(__sub, l_Timestamp, "timestamp other", "Computes the difference between two timestamps", "timespan",
          "The time difference")
@@ -20,9 +21,44 @@ ADE_FUNC(__sub, l_Timestamp, "timestamp other", "Computes the difference between
 	return ade_set_args(L, "o", l_TimeSpan.Set(diff));
 }
 
+ADE_FUNC(__tostring, l_Timestamp, nullptr, "Converts a timestamp to a string", "string", "Timestamp as string, or empty string if handle is invalid")
+{
+	uint64_t value = 0;
+	if (!ade_get_args(L, "o", l_Timestamp.Get(&value)))
+		return ade_set_error(L, "s", "");
+
+	char buf[32];
+	sprintf(buf, UINT64_T_ARG, value);
+
+	return ade_set_args(L, "s", buf);
+}
+
+ADE_FUNC(getSeconds, l_Timestamp, nullptr, "Gets the value of this timestamp in seconds", "number", "The timestamp value in seconds")
+{
+	uint64_t value = 0;
+	if (!ade_get_args(L, "o", l_Timestamp.Get(&value)))
+		return ade_set_error(L, "f", 0.0f);
+
+	// Timestamps and spans are stored in nanoseconds
+	return ade_set_args(L, "f", static_cast<float>(static_cast<long double>(value) / static_cast<long double>(NANOSECONDS_PER_SECOND)));
+}
+
+
 ADE_OBJ(l_TimeSpan, int64_t, "timespan", "A difference between two time stamps");
 
-ADE_FUNC(getSeconds, l_TimeSpan, nullptr, "Gets the value of this timestamp in seconds", "number",
+ADE_FUNC(__tostring, l_TimeSpan, nullptr, "Converts a timespan to a string", "string", "Timespan as string, or empty string if handle is invalid")
+{
+	int64_t value = 0;
+	if (!ade_get_args(L, "o", l_TimeSpan.Get(&value)))
+		return ade_set_error(L, "s", "");
+
+	char buf[32];
+	sprintf(buf, INT64_T_ARG, value);
+
+	return ade_set_args(L, "s", buf);
+}
+
+ADE_FUNC(getSeconds, l_TimeSpan, nullptr, "Gets the value of this timespan in seconds", "number",
          "The timespan value in seconds")
 {
 	int64_t value = 0;
@@ -31,7 +67,7 @@ ADE_FUNC(getSeconds, l_TimeSpan, nullptr, "Gets the value of this timestamp in s
 	}
 
 	// Timestamps and spans are stored in nanoseconds
-	return ade_set_args(L, "f", (float)((long double)value / (long double)NANOSECONDS_PER_SECOND));
+	return ade_set_args(L, "f", static_cast<float>(static_cast<long double>(value) / static_cast<long double>(NANOSECONDS_PER_SECOND)));
 }
 
 } // namespace api