Generalized the handlebars code.

include/dawn/dawn.h

@@ -66,6 +66,7 @@
 #include "util/list.h"
 #include "util/math.h"
 #include "util/rand.h"
+#include "util/string.h"
 
 // Visual Novel Objects
 #include "vn/vncharacter.h"

include/dawn/locale/language.h

@@ -10,11 +10,6 @@
 
 #define LANGUAGE_STRING_MAX 512
 
-typedef struct {
-  char *name;
-  char *value;
-} languagevariable_t;
-
 typedef struct {
   char *key;
   char *text;

include/dawn/util/string.h

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2021 Dominic Masters
+ * 
+ * This software is released under the MIT License.
+ * https://opensource.org/licenses/MIT
+ */
+
+#pragma once
+#include "../libs.h"
+
+#define STRING_HANDLEBAR_KEY_MAXLENGTH 32
+
+/** Representation of a String Handlebar Variable */
+typedef struct {
+  /** The key to use to replace in the source */
+  char *key;
+  /** The value to replace it with */
+  char *value;
+} stringhandlebarvariable_t;

src/locale/language.c

@@ -43,97 +43,11 @@ char * languageGetText(language_t *language, languagestring_t *string) {
 
 int32_t languageGetTextWithVariables(
   language_t *language, languagestring_t *string,
-  languagevariable_t *variables, int32_t variableCount,
+  stringhandlebarvariable_t *variables, int32_t variableCount,
   char *buffer
 ) {
-  int32_t i, l, n;
-  char *text;
-  char c;
-  char keyBuffer[32];
-  languagevariable_t *variable;
-
-  text = languageGetText(language, string);
-  if(text == NULL) return 0;
-
-  // Start two counters. I holds source index, L holds target index.
-  i = 0;
-  l = 0;
-
-  while(true) {
-    c = text[i];
-    if(c == '\0') break;// Break on end of string.
-
-    // Look for {{, if not {{ then just treat as normal string.
-    if(c != '{' || text[i + 1] != '{') {
-      buffer[l] = c;
-      i++;
-      l++;
-      continue;
-    }
-
-    //Ignore those two chars
-    i += 2;
-
-    // Skip space(s)
-    while(true) {
-      c = text[i];
-      if(c != ' ') break;
-      i++;
-    }
-
-    // Get the key name
-    n = 0;// Will hold the index within keyBuffer to copy chars into.
-    while(true) {
-      c = text[i];
-
-      // Don't overflow
-      if(c == '\0') break;
-      
-      // Skip spaces
-      if(c == ' ') {
-        i++;
-        continue;
-      }
-
-      // Handle end of key
-      if(c == '}') {
-        i++;
-        if(text[i] == '}') i++;// For }} then skip the second }
-        break;
-      }
-
-      // Add to buffer.
-      keyBuffer[n] = c;
-      n++;
-      i++;
-    }
-
-    // Seal the keyBuffer string
-    keyBuffer[n] = '\0';
-
-    // Now check each variable for a match.
-    for(n = 0; n < variableCount; n++) {
-      variable = variables + n;
-      if(strcmp(keyBuffer, variable->name) != 0) continue;// Does the key match?
-
-      // Begin copying the variables' value into the string.
-      n = 0;
-      while(true) {
-        if(variable->value[n] == '\0') break;// Handle end of variable value
-        buffer[l] = variable->value[n];
-        l++;
-        n++;
-      }
-      // We found the value, so break.
-      break;
-    }
-
-    // Continue looking for next {{ variable }}...
-  }
-
-  // Buffer has been fully cloned, seal the string.
-  buffer[l] = '\0';
-
-  // Return the count of chars we wrote to the buffer. -1 due to null term.
-  return l - 1;
+  char *source;
+  source = languageGetText(language, string);
+  if(source == NULL) return 0;
+  return stringHandlebarsBuffer(source, variables, variableCount, buffer);
 }

src/locale/language.h

@@ -7,6 +7,7 @@
 
 #pragma once
 #include <dawn/dawn.h>
+#include "../util/string.h"
 
 /**
  * Initializes a language.
@@ -54,6 +55,6 @@ char * languageGetText(language_t *language, languagestring_t *string);
  */
 int32_t languageGetTextWithVariables(
   language_t *language, languagestring_t *string,
-  languagevariable_t *variables, int32_t variableCount,
+  stringhandlebarvariable_t *variables, int32_t variableCount,
   char *buffer
 );

src/util/string.c

@@ -0,0 +1,100 @@
+/**
+ * Copyright (c) 2021 Dominic Masters
+ * 
+ * This software is released under the MIT License.
+ * https://opensource.org/licenses/MIT
+ */
+
+#include "string.h"
+
+int32_t stringHandlebarsBuffer(char *source,
+  stringhandlebarvariable_t *variables, int32_t variableCount, char *buffer
+) {
+  
+  int32_t i, l, n;
+  char c;
+  char keyBuffer[STRING_HANDLEBAR_KEY_MAXLENGTH];
+  stringhandlebarvariable_t *variable;
+
+  // Start two counters. I holds source index, L holds target index.
+  i = 0;
+  l = 0;
+
+  while(true) {
+    c = source[i];
+    if(c == '\0') break;// Break on end of string.
+
+    // Look for {{, if not {{ then just treat as normal string.
+    if(c != '{' || source[i + 1] != '{') {
+      buffer[l] = c;
+      i++;
+      l++;
+      continue;
+    }
+
+    //Ignore those two chars
+    i += 2;
+
+    // Skip space(s)
+    while(true) {
+      c = source[i];
+      if(c != ' ') break;
+      i++;
+    }
+
+    // Get the key name
+    n = 0;// Will hold the index within keyBuffer to copy chars into.
+    while(true) {
+      c = source[i];
+
+      // Don't overflow
+      if(c == '\0') break;
+      
+      // Skip spaces
+      if(c == ' ') {
+        i++;
+        continue;
+      }
+
+      // Handle end of key
+      if(c == '}') {
+        i++;
+        if(source[i] == '}') i++;// For }} then skip the second }
+        break;
+      }
+
+      // Add to buffer.
+      keyBuffer[n] = c;
+      n++;
+      i++;
+    }
+
+    // Seal the keyBuffer string
+    keyBuffer[n] = '\0';
+
+    // Now check each variable for a match.
+    for(n = 0; n < variableCount; n++) {
+      variable = variables + n;
+      if(strcmp(keyBuffer, variable->key) != 0) continue;// Does the key match?
+
+      // Begin copying the variables' value into the string.
+      n = 0;
+      while(true) {
+        if(variable->value[n] == '\0') break;// Handle end of variable value
+        buffer[l] = variable->value[n];
+        l++;
+        n++;
+      }
+      // We found the value, so break.
+      break;
+    }
+
+    // Continue looking for next {{ variable }}...
+  }
+
+  // Buffer has been fully cloned, seal the string.
+  buffer[l] = '\0';
+
+  // Return the count of chars we wrote to the buffer. -1 due to null term.
+  return l - 1;
+}

src/util/string.h

@@ -0,0 +1,24 @@
+// Copyright (c) 2021 Dominic Masters
+// 
+// This software is released under the MIT License.
+// https://opensource.org/licenses/MIT
+
+#pragma once
+#include <dawn/dawn.h>
+
+/**
+ * Replaces handlebars within the string with items from the list of variables.
+ * Output of replacement is stored in the buffer provided. Handlebars within the
+ * string should be in the format of; "{{ key }}", spaces within the bars will
+ * be skipped. Variable keys cannot exceed STRING_HANDLEBAR_KEY_MAXLENGTH in
+ * length.
+ * 
+ * @param string String to parse.
+ * @param variables Variables to use in the parsing.
+ * @param variableCount How many variables in the array.
+ * @param buffer Buffer to write characters in to.
+ * @return The count of characters that were written to the buffer.
+ */
+int32_t stringHandlebarsBuffer(char *source,
+  stringhandlebarvariable_t *variables, int32_t variableCount, char *buffer
+);