Merge branch 'master' into DefaultUser/trigger_cleanup

[xonotic/xonotic-data.pk3dir.git] / qcsrc / lib / string.qh

diff --git a/qcsrc/lib/string.qh b/qcsrc/lib/string.qh
index d79552187929a03511a56febd3f20c763aa82784..96e8a3a276258d568380219e0b1d8218ac9b7cf5 100644 (file)
--- a/qcsrc/lib/string.qh
+++ b/qcsrc/lib/string.qh
@@ -4,6 +4,25 @@
 #include "sort.qh"
 #include "oo.qh"
 
+// string logic
+//
+// true: is truthy
+// == "": is equal to ""
+// is "": has the same string index as the string constant ""
+// strunzone: can be strunzoned
+//
+// |              | true | == "" | is "" | strunzone |
+// | :----------: | :--: | :---: | :---: | :-------: |
+// | nil          |      | yes   |       |           |
+// | strcat(nil)  | yes  | yes   |       |           |
+// | strzone(nil) | yes  | yes   |       | yes       |
+// | ""           | yes  | yes   | yes   |           |
+// | strcat("")   | yes  | yes   |       |           |
+// | strzone("")  | yes  | yes   |       | yes       |
+// | "s"          | yes  |       |       |           |
+// | strcat("s")  | yes  |       |       |           |
+// | strzone("s") | yes  |       |       | yes       |
+
 #ifdef CSQC
        float stringwidth_colors(string s, vector theSize)
        {
@@ -34,6 +53,13 @@
        this = strzone(s); \
 MACRO_END
 
+#define strfree(this) MACRO_BEGIN \
+       if (this) { \
+               strunzone(this); \
+       } \
+       this = string_null; \
+MACRO_END
+
 ERASEABLE
 string seconds_tostring(float sec)
 {