plomlompom.com Git - plomrogue/blob - src/client/command_db.h

   1 /* src/client/command_db.h
   2  *
   3  * The Command DB collects identifiers and verbal descriptions of all commands
   4  * the user can give.
   5  */
   6
   7 #ifndef COMMAND_DB_H
   8 #define COMMAND_DB_H
   9
  10 #include <stdint.h> /* uint8_t */
  11
  12
  13
  14 struct Command
  15 {
  16     char * dsc_short; /* short string name of command to be used internally */
  17     char * dsc_long;  /* long string description of command for the user */
  18 };
  19
  20 struct CommandDB
  21 {
  22     struct Command * cmds; /* memory area for sequence of all Command structs */
  23     uint8_t n;             /* number of Command structs in database */
  24 };
  25
  26
  27
  28 /* Give short description of command ("dsc_short"), get long description. */
  29 extern char * get_command_longdsc(char * dsc_short);
  30
  31 /* Reads CommandDB from CommandDB file, line by line, until first empty line. */
  32 extern void init_command_db();
  33
  34 /* Free all memory allocated with init_command_db. */
  35 extern void free_command_db();
  36
  37
  38
  39 #endif