src/libgame/misc.h

   1 /***********************************************************
   2 * Artsoft Retro-Game Library                               *
   3 *----------------------------------------------------------*
   4 * (c) 1994-2002 Artsoft Entertainment                      *
   5 *               Holger Schemel                             *
   6 *               Detmolder Strasse 189                      *
   7 *               33604 Bielefeld                            *
   8 *               Germany                                    *
   9 *               e-mail: info@artsoft.org                   *
  10 *----------------------------------------------------------*
  11 * misc.h                                                   *
  12 ***********************************************************/
  13
  14 #ifndef MISC_H
  15 #define MISC_H
  16
  17 #include <stdlib.h>
  18 #include <stdio.h>
  19
  20 #include "system.h"
  21
  22
  23 /* values for InitCounter() and Counter() */
  24 #define INIT_COUNTER                    0
  25 #define READ_COUNTER                    1
  26
  27 /* values for InitRND() */
  28 #define NEW_RANDOMIZE                   -1
  29
  30 #define InitRND(seed)                   init_random_number(0, seed)
  31 #define InitSimpleRND(seed)             init_random_number(1, seed)
  32 #define RND(max)                        get_random_number(0, max)
  33 #define SimpleRND(max)                  get_random_number(1, max)
  34
  35 /* values for Error() */
  36 #define ERR_RETURN                      0
  37 #define ERR_RETURN_LINE                 (1 << 0)
  38 #define ERR_WARN                        (1 << 1)
  39 #define ERR_EXIT                        (1 << 2)
  40 #define ERR_HELP                        (1 << 3)
  41 #define ERR_SOUND_SERVER                (1 << 4)
  42 #define ERR_NETWORK_SERVER              (1 << 5)
  43 #define ERR_NETWORK_CLIENT              (1 << 6)
  44 #define ERR_FROM_SERVER                 (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
  45 #define ERR_EXIT_HELP                   (ERR_EXIT | ERR_HELP)
  46 #define ERR_EXIT_SOUND_SERVER           (ERR_EXIT | ERR_SOUND_SERVER)
  47 #define ERR_EXIT_NETWORK_SERVER         (ERR_EXIT | ERR_NETWORK_SERVER)
  48 #define ERR_EXIT_NETWORK_CLIENT         (ERR_EXIT | ERR_NETWORK_CLIENT)
  49
  50 /* values for getFile...() and putFile...() */
  51 #define BYTE_ORDER_BIG_ENDIAN           0
  52 #define BYTE_ORDER_LITTLE_ENDIAN        1
  53
  54 /* values for cursor bitmap creation */
  55 #define BIT_ORDER_MSB                   0
  56 #define BIT_ORDER_LSB                   1
  57
  58 /* values for createDirectory() */
  59 #define PERMS_PRIVATE                   0
  60 #define PERMS_PUBLIC                    1
  61
  62 /* values for general file handling stuff */
  63 #define MAX_FILENAME_LEN                256
  64 #define MAX_LINE_LEN                    1024
  65
  66 /* values for general username handling stuff */
  67 #define MAX_USERNAME_LEN                1024
  68
  69
  70 void fprintf_line(FILE *, char *, int);
  71 void printf_line(char *, int);
  72 char *int2str(int, int);
  73 char *i_to_a(unsigned int);
  74
  75 void InitCounter(void);
  76 unsigned long Counter(void);
  77 void Delay(unsigned long);
  78 boolean FrameReached(unsigned long *, unsigned long);
  79 boolean DelayReached(unsigned long *, unsigned long);
  80 void WaitUntilDelayReached(unsigned long *, unsigned long);
  81
  82 #if 0
  83 unsigned int SimpleRND(unsigned int);
  84 unsigned int InitSimpleRND(long);
  85 unsigned int RND(unsigned int);
  86 unsigned int InitRND(long);
  87 #endif
  88
  89 unsigned int init_random_number(int, long);
  90 unsigned int get_random_number(int, int);
  91
  92 char *getLoginName(void);
  93 char *getRealName(void);
  94 char *getHomeDir(void);
  95
  96 char *getPath2(char *, char *);
  97 char *getPath3(char *, char *, char*);
  98 char *getStringCat2(char *, char *);
  99 char *getStringCopy(char *);
 100 char *getStringToLower(char *);
 101 void setString(char **, char *);
 102
 103 void GetOptions(char **, void (*print_usage_function)(void));
 104
 105 void SetError(char *, ...);
 106 char *GetError(void);
 107 void Error(int, char *, ...);
 108
 109 void *checked_malloc(unsigned long);
 110 void *checked_calloc(unsigned long);
 111 void *checked_realloc(void *, unsigned long);
 112
 113 inline void swap_numbers(int *, int *);
 114 inline void swap_number_pairs(int *, int *, int *, int *);
 115
 116 short getFile16BitInteger(FILE *, int);
 117 void putFile16BitInteger(FILE *, short, int);
 118 int getFile32BitInteger(FILE *, int);
 119 void putFile32BitInteger(FILE *, int, int);
 120 boolean getFileChunk(FILE *, char *, int *, int);
 121 void putFileChunk(FILE *, char *, int, int);
 122 int getFileVersion(FILE *);
 123 void putFileVersion(FILE *, int);
 124 void ReadUnusedBytesFromFile(FILE *, unsigned long);
 125 void WriteUnusedBytesToFile(FILE *, unsigned long);
 126
 127 #define getFile8Bit(f)        fgetc(f)
 128 #define putFile8Bit(f,x)      fputc(x, f)
 129 #define getFile16BitBE(f)     getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 130 #define getFile16BitLE(f)     getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 131 #define putFile16BitBE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 132 #define putFile16BitLE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 133 #define getFile32BitBE(f)     getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 134 #define getFile32BitLE(f)     getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 135 #define putFile32BitBE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 136 #define putFile32BitLE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 137 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 138 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 139 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 140 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 141
 142 char *getKeyNameFromKey(Key);
 143 char *getX11KeyNameFromKey(Key);
 144 Key getKeyFromKeyName(char *);
 145 Key getKeyFromX11KeyName(char *);
 146 char getCharFromKey(Key);
 147
 148 int get_integer_from_string(char *);
 149 boolean get_boolean_from_string(char *);
 150
 151 ListNode *newListNode(void);
 152 void addNodeToList(ListNode **, char *, void *);
 153 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
 154 ListNode *getNodeFromKey(ListNode *, char *);
 155 int getNumNodes(ListNode *);
 156
 157 boolean fileExists(char *);
 158 boolean FileIsGraphic(char *);
 159 boolean FileIsSound(char *);
 160 boolean FileIsMusic(char *);
 161 boolean FileIsArtworkType(char *, int);
 162
 163 int get_parameter_value(char *, char *, int);
 164 int get_auto_parameter_value(char *, char *);
 165
 166 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
 167                                            struct ConfigInfo *, char **, int);
 168 void LoadArtworkConfig(struct ArtworkListInfo *);
 169 void ReloadCustomArtworkList(struct ArtworkListInfo *);
 170 void FreeCustomArtworkLists(struct ArtworkListInfo *);
 171
 172 #if !defined(PLATFORM_UNIX)
 173 void initErrorFile();
 174 FILE *openErrorFile();
 175 void dumpErrorFile();
 176 #endif
 177
 178 void debug_print_timestamp(int, char *);
 179
 180 #endif /* MISC_H */