MAJOR re-write. Split plomrogue into a server and a client. Re-wrote large parts

[plomrogue] / src / client / command_db.h

diff --git a/src/client/command_db.h b/src/client/command_db.h
new file mode 100644 (file)
index 0000000..769670b
--- /dev/null
+++ b/src/client/command_db.h
@@ -0,0 +1,46 @@
+/* src/client/command_db.h
+ *
+ * The Command DB collects identifiers and verbal descriptions of all commands
+ * the user can give.
+ */
+
+#ifndef COMMAND_DB_H
+#define COMMAND_DB_H
+
+#include <stdint.h> /* uint8_t */
+
+
+
+struct Command
+{
+    char * dsc_short; /* short string name of command to be used internally */
+    char * dsc_long;  /* long string description of command for the user */
+    uint8_t id;       /* unique identifier of command */
+};
+
+struct CommandDB
+{
+    struct Command * cmds; /* memory area for sequence of all Command structs */
+    uint8_t n;             /* number of Command structs in database */
+};
+
+
+
+/* Is "id" the ID of command whose dsc_short is "shortdsc"? Answer in binary. */
+extern uint8_t is_command_id_shortdsc(uint8_t id, char * shortdsc);
+
+/* Give short description of command ("dsc_short"), get its ID. */
+extern uint8_t get_command_id(char * dsc_short);
+
+/* Give short description of command ("dsc_short"), get long description. */
+extern char * get_command_longdsc(char * dsc_short);
+
+/* Reads CommandDB from CommandDB file, line by line, until first empty line. */
+extern void init_command_db();
+
+/* Free all memory allocated with init_command_db. */
+extern void free_command_db();
+
+
+
+#endif