1 /***********************************************************
2 * Artsoft Retro-Game Library *
3 *----------------------------------------------------------*
4 * (c) 1994-2006 Artsoft Entertainment *
6 * Detmolder Strasse 189 *
9 * e-mail: info@artsoft.org *
10 *----------------------------------------------------------*
12 ***********************************************************/
23 /* values for InitCounter() and Counter() */
24 #define INIT_COUNTER 0
25 #define READ_COUNTER 1
27 /* values for InitRND() */
28 #define NEW_RANDOMIZE -1
30 #define RANDOM_ENGINE 0
31 #define RANDOM_SIMPLE 1
33 #define InitEngineRandom(seed) init_random_number(RANDOM_ENGINE, seed)
34 #define InitSimpleRandom(seed) init_random_number(RANDOM_SIMPLE, seed)
35 #define GetEngineRandom(max) get_random_number(RANDOM_ENGINE, max)
36 #define GetSimpleRandom(max) get_random_number(RANDOM_SIMPLE, max)
38 /* values for Error() */
40 #define ERR_INFO_LINE (1 << 0)
41 #define ERR_WARN (1 << 1)
42 #define ERR_EXIT (1 << 2)
43 #define ERR_HELP (1 << 3)
44 #define ERR_SOUND_SERVER (1 << 4)
45 #define ERR_NETWORK_SERVER (1 << 5)
46 #define ERR_NETWORK_CLIENT (1 << 6)
47 #define ERR_FROM_SERVER (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
48 #define ERR_EXIT_HELP (ERR_EXIT | ERR_HELP)
49 #define ERR_EXIT_SOUND_SERVER (ERR_EXIT | ERR_SOUND_SERVER)
50 #define ERR_EXIT_NETWORK_SERVER (ERR_EXIT | ERR_NETWORK_SERVER)
51 #define ERR_EXIT_NETWORK_CLIENT (ERR_EXIT | ERR_NETWORK_CLIENT)
53 /* values for getFile...() and putFile...() */
54 #define BYTE_ORDER_BIG_ENDIAN 0
55 #define BYTE_ORDER_LITTLE_ENDIAN 1
57 /* values for cursor bitmap creation */
58 #define BIT_ORDER_MSB 0
59 #define BIT_ORDER_LSB 1
61 /* values for createDirectory() */
62 #define PERMS_PRIVATE 0
63 #define PERMS_PUBLIC 1
65 /* values for general file handling stuff */
66 #define MAX_FILENAME_LEN 256
67 #define MAX_LINE_LEN 1024
69 /* values for general username handling stuff */
70 #define MAX_USERNAME_LEN 1024
73 void fprintf_line(FILE *, char *, int);
74 void printf_line(char *, int);
75 void printf_line_with_prefix(char *, char *, int);
76 char *int2str(int, int);
77 char *i_to_a(unsigned int);
78 int log_2(unsigned int);
80 boolean getTokenValueFromString(char *, char **, char **);
82 void InitCounter(void);
83 unsigned long Counter(void);
84 void Delay(unsigned long);
85 boolean FrameReached(unsigned long *, unsigned long);
86 boolean DelayReached(unsigned long *, unsigned long);
87 void WaitUntilDelayReached(unsigned long *, unsigned long);
89 unsigned int init_random_number(int, long);
90 unsigned int get_random_number(int, int);
92 char *getLoginName(void);
93 char *getRealName(void);
95 char *getBasePath(char *);
96 char *getBaseName(char *);
97 char *getBaseNamePtr(char *);
99 char *getStringCat2WithSeparator(char *, char *, char *);
100 char *getStringCat3WithSeparator(char *, char *, char *, char *);
101 char *getStringCat2(char *, char *);
102 char *getStringCat3(char *, char *, char *);
103 char *getPath2(char *, char *);
104 char *getPath3(char *, char *, char*);
105 char *getStringCopy(char *);
106 char *getStringToLower(char *);
107 void setString(char **, char *);
108 boolean strEqual(char *, char *);
110 void GetOptions(char **, void (*print_usage_function)(void));
112 void SetError(char *, ...);
113 char *GetError(void);
114 void Error(int, char *, ...);
116 void *checked_malloc(unsigned long);
117 void *checked_calloc(unsigned long);
118 void *checked_realloc(void *, unsigned long);
119 void checked_free(void *);
121 void swap_numbers(int *, int *);
122 void swap_number_pairs(int *, int *, int *, int *);
124 int getFile8BitInteger(FILE *);
125 int putFile8BitInteger(FILE *, int);
126 int getFile16BitInteger(FILE *, int);
127 int putFile16BitInteger(FILE *, int, int);
128 int getFile32BitInteger(FILE *, int);
129 int putFile32BitInteger(FILE *, int, int);
131 boolean getFileChunk(FILE *, char *, int *, int);
132 int putFileChunk(FILE *, char *, int, int);
133 int getFileVersion(FILE *);
134 int putFileVersion(FILE *, int);
136 void ReadBytesFromFile(FILE *, byte *, unsigned long);
137 void WriteBytesToFile(FILE *, byte *, unsigned long);
139 void ReadUnusedBytesFromFile(FILE *, unsigned long);
140 void WriteUnusedBytesToFile(FILE *, unsigned long);
142 #define getFile8Bit(f) getFile8BitInteger(f)
143 #define putFile8Bit(f,x) putFile8BitInteger(f,x)
144 #define getFile16BitBE(f) getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
145 #define getFile16BitLE(f) getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
146 #define putFile16BitBE(f,x) putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
147 #define putFile16BitLE(f,x) putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
148 #define getFile32BitBE(f) getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
149 #define getFile32BitLE(f) getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
150 #define putFile32BitBE(f,x) putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
151 #define putFile32BitLE(f,x) putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
153 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
154 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
155 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
156 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
158 char *getKeyNameFromKey(Key);
159 char *getX11KeyNameFromKey(Key);
160 Key getKeyFromKeyName(char *);
161 Key getKeyFromX11KeyName(char *);
162 char getCharFromKey(Key);
163 char getValidConfigValueChar(char);
165 int get_integer_from_string(char *);
166 boolean get_boolean_from_string(char *);
168 ListNode *newListNode(void);
169 void addNodeToList(ListNode **, char *, void *);
170 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
171 ListNode *getNodeFromKey(ListNode *, char *);
172 int getNumNodes(ListNode *);
174 boolean fileExists(char *);
175 boolean FileIsGraphic(char *);
176 boolean FileIsSound(char *);
177 boolean FileIsMusic(char *);
178 boolean FileIsArtworkType(char *, int);
180 char *get_mapped_token(char *);
182 int get_parameter_value(char *, char *, int);
184 struct ScreenModeInfo *get_screen_mode_from_string(char *);
185 void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *, int *x, int *y);
187 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
188 struct ConfigTypeInfo *,
190 void LoadArtworkConfig(struct ArtworkListInfo *);
191 void ReloadCustomArtworkList(struct ArtworkListInfo *);
192 void FreeCustomArtworkLists(struct ArtworkListInfo *);
194 char *getErrorFilename(char *);
195 void openErrorFile();
196 void closeErrorFile();
197 void dumpErrorFile();
198 void NotifyUserAboutErrorFile();
200 void debug_print_timestamp(int, char *);