rnd-20091211-1-src
[rocksndiamonds.git] / src / libgame / misc.h
index db836823007b5d242b35a7886c1bd304589d90ee..6ac3d994c990a9fe74348168d3675b04b8b816bb 100644 (file)
@@ -1,7 +1,7 @@
 /***********************************************************
 * Artsoft Retro-Game Library                               *
 *----------------------------------------------------------*
-* (c) 1994-2002 Artsoft Entertainment                      *
+* (c) 1994-2006 Artsoft Entertainment                      *
 *               Holger Schemel                             *
 *               Detmolder Strasse 189                      *
 *               33604 Bielefeld                            *
 #define READ_COUNTER                   1
 
 /* values for InitRND() */
-#define NEW_RANDOMIZE                  -1
+#define NEW_RANDOMIZE                  0
 
-#define InitEngineRND(seed)            init_random_number(0, seed)
-#define InitSimpleRND(seed)            init_random_number(1, seed)
-#define RND(max)                       get_random_number(0, max)
-#define SimpleRND(max)                 get_random_number(1, max)
+#define RANDOM_ENGINE                  0
+#define RANDOM_SIMPLE                  1
+
+#define InitEngineRandom(seed)         init_random_number(RANDOM_ENGINE, seed)
+#define InitSimpleRandom(seed)         init_random_number(RANDOM_SIMPLE, seed)
+#define GetEngineRandom(max)           get_random_number(RANDOM_ENGINE, max)
+#define GetSimpleRandom(max)           get_random_number(RANDOM_SIMPLE, max)
 
 /* values for Error() */
-#define ERR_RETURN                     0
-#define ERR_RETURN_LINE                        (1 << 0)
+#define ERR_INFO                       0
+#define ERR_INFO_LINE                  (1 << 0)
 #define ERR_WARN                       (1 << 1)
 #define ERR_EXIT                       (1 << 2)
 #define ERR_HELP                       (1 << 3)
 
 void fprintf_line(FILE *, char *, int);
 void printf_line(char *, int);
+void printf_line_with_prefix(char *, char *, int);
 char *int2str(int, int);
 char *i_to_a(unsigned int);
 int log_2(unsigned int);
 
+boolean getTokenValueFromString(char *, char **, char **);
+
 void InitCounter(void);
 unsigned long Counter(void);
 void Delay(unsigned long);
@@ -80,26 +86,32 @@ boolean FrameReached(unsigned long *, unsigned long);
 boolean DelayReached(unsigned long *, unsigned long);
 void WaitUntilDelayReached(unsigned long *, unsigned long);
 
-#if 0
-unsigned int SimpleRND(unsigned int);
-unsigned int InitSimpleRND(long);
-unsigned int RND(unsigned int);
-unsigned int InitRND(long);
-#endif
-
 unsigned int init_random_number(int, long);
 unsigned int get_random_number(int, int);
 
 char *getLoginName(void);
 char *getRealName(void);
-char *getHomeDir(void);
 
+char *getBasePath(char *);
+char *getBaseName(char *);
+char *getBaseNamePtr(char *);
+
+char *getStringCat2WithSeparator(char *, char *, char *);
+char *getStringCat3WithSeparator(char *, char *, char *, char *);
+char *getStringCat2(char *, char *);
+char *getStringCat3(char *, char *, char *);
 char *getPath2(char *, char *);
 char *getPath3(char *, char *, char*);
-char *getStringCat2(char *, char *);
 char *getStringCopy(char *);
+char *getStringCopyN(char *, int);
 char *getStringToLower(char *);
 void setString(char **, char *);
+boolean strEqual(char *, char *);
+boolean strEqualN(char *, char *, int);
+boolean strPrefix(char *, char *);
+boolean strSuffix(char *, char *);
+boolean strPrefixLower(char *, char *);
+boolean strSuffixLower(char *, char *);
 
 void GetOptions(char **, void (*print_usage_function)(void));
 
@@ -111,23 +123,31 @@ void *checked_malloc(unsigned long);
 void *checked_calloc(unsigned long);
 void *checked_realloc(void *, unsigned long);
 void checked_free(void *);
+void clear_mem(void *, unsigned long);
 
-inline void swap_numbers(int *, int *);
-inline void swap_number_pairs(int *, int *, int *, int *);
+void swap_numbers(int *, int *);
+void swap_number_pairs(int *, int *, int *, int *);
 
+int getFile8BitInteger(FILE *);
+int putFile8BitInteger(FILE *, int);
 int getFile16BitInteger(FILE *, int);
-void putFile16BitInteger(FILE *, int, int);
+int putFile16BitInteger(FILE *, int, int);
 int getFile32BitInteger(FILE *, int);
-void putFile32BitInteger(FILE *, int, int);
+int putFile32BitInteger(FILE *, int, int);
+
 boolean getFileChunk(FILE *, char *, int *, int);
-void putFileChunk(FILE *, char *, int, int);
+int putFileChunk(FILE *, char *, int, int);
 int getFileVersion(FILE *);
-void putFileVersion(FILE *, int);
+int putFileVersion(FILE *, int);
+
+void ReadBytesFromFile(FILE *, byte *, unsigned long);
+void WriteBytesToFile(FILE *, byte *, unsigned long);
+
 void ReadUnusedBytesFromFile(FILE *, unsigned long);
 void WriteUnusedBytesToFile(FILE *, unsigned long);
 
-#define getFile8Bit(f)        fgetc(f)
-#define putFile8Bit(f,x)      fputc(x, f)
+#define getFile8Bit(f)        getFile8BitInteger(f)
+#define putFile8Bit(f,x)      putFile8BitInteger(f,x)
 #define getFile16BitBE(f)     getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 #define getFile16BitLE(f)     getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 #define putFile16BitBE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
@@ -136,6 +156,7 @@ void WriteUnusedBytesToFile(FILE *, unsigned long);
 #define getFile32BitLE(f)     getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 #define putFile32BitBE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 #define putFile32BitLE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
+
 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
@@ -146,9 +167,11 @@ char *getX11KeyNameFromKey(Key);
 Key getKeyFromKeyName(char *);
 Key getKeyFromX11KeyName(char *);
 char getCharFromKey(Key);
+char getValidConfigValueChar(char);
 
 int get_integer_from_string(char *);
 boolean get_boolean_from_string(char *);
+int get_switch3_from_string(char *);
 
 ListNode *newListNode(void);
 void addNodeToList(ListNode **, char *, void *);
@@ -165,7 +188,9 @@ boolean FileIsArtworkType(char *, int);
 char *get_mapped_token(char *);
 
 int get_parameter_value(char *, char *, int);
-int get_auto_parameter_value(char *, char *);
+
+struct ScreenModeInfo *get_screen_mode_from_string(char *);
+void get_aspect_ratio_from_screen_mode(struct ScreenModeInfo *, int *x, int *y);
 
 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
                                           struct ConfigTypeInfo *,
@@ -174,11 +199,11 @@ void LoadArtworkConfig(struct ArtworkListInfo *);
 void ReloadCustomArtworkList(struct ArtworkListInfo *);
 void FreeCustomArtworkLists(struct ArtworkListInfo *);
 
-#if !defined(PLATFORM_UNIX)
-void initErrorFile();
-FILE *openErrorFile();
+char *getErrorFilename(char *);
+void openErrorFile();
+void closeErrorFile();
 void dumpErrorFile();
-#endif
+void NotifyUserAboutErrorFile();
 
 void debug_print_timestamp(int, char *);