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 /* values for Error() */
  31 #define ERR_RETURN                      0
  32 #define ERR_RETURN_LINE                 (1 << 0)
  33 #define ERR_WARN                        (1 << 1)
  34 #define ERR_EXIT                        (1 << 2)
  35 #define ERR_HELP                        (1 << 3)
  36 #define ERR_SOUND_SERVER                (1 << 4)
  37 #define ERR_NETWORK_SERVER              (1 << 5)
  38 #define ERR_NETWORK_CLIENT              (1 << 6)
  39 #define ERR_FROM_SERVER                 (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
  40 #define ERR_EXIT_HELP                   (ERR_EXIT | ERR_HELP)
  41 #define ERR_EXIT_SOUND_SERVER           (ERR_EXIT | ERR_SOUND_SERVER)
  42 #define ERR_EXIT_NETWORK_SERVER         (ERR_EXIT | ERR_NETWORK_SERVER)
  43 #define ERR_EXIT_NETWORK_CLIENT         (ERR_EXIT | ERR_NETWORK_CLIENT)
  44
  45 /* values for getFile...() and putFile...() */
  46 #define BYTE_ORDER_BIG_ENDIAN           0
  47 #define BYTE_ORDER_LITTLE_ENDIAN        1
  48
  49 /* values for createDirectory() */
  50 #define PERMS_PRIVATE                   0
  51 #define PERMS_PUBLIC                    1
  52
  53 /* values for general file handling stuff */
  54 #define MAX_FILENAME_LEN                256
  55 #define MAX_LINE_LEN                    1000
  56
  57 void fprintf_line(FILE *, char *, int);
  58 void printf_line(char *, int);
  59 char *int2str(int, int);
  60
  61 void InitCounter(void);
  62 unsigned long Counter(void);
  63 void Delay(unsigned long);
  64 boolean FrameReached(unsigned long *, unsigned long);
  65 boolean DelayReached(unsigned long *, unsigned long);
  66 void WaitUntilDelayReached(unsigned long *, unsigned long);
  67
  68 unsigned int SimpleRND(unsigned int);
  69 unsigned int RND(unsigned int);
  70 unsigned int InitRND(long);
  71
  72 char *getLoginName(void);
  73 char *getRealName(void);
  74 char *getHomeDir(void);
  75
  76 char *getPath2(char *, char *);
  77 char *getPath3(char *, char *, char*);
  78 char *getStringCopy(char *);
  79 char *getStringToLower(char *);
  80
  81 void GetOptions(char **);
  82
  83 void SetError(char *, ...);
  84 char *GetError(void);
  85 void Error(int, char *, ...);
  86
  87 void *checked_malloc(unsigned long);
  88 void *checked_calloc(unsigned long);
  89 void *checked_realloc(void *, unsigned long);
  90
  91 inline void swap_numbers(int *, int *);
  92 inline void swap_number_pairs(int *, int *, int *, int *);
  93
  94 short getFile16BitInteger(FILE *, int);
  95 void putFile16BitInteger(FILE *, short, int);
  96 int getFile32BitInteger(FILE *, int);
  97 void putFile32BitInteger(FILE *, int, int);
  98 boolean getFileChunk(FILE *, char *, int *, int);
  99 void putFileChunk(FILE *, char *, int, int);
 100 int getFileVersion(FILE *);
 101 void putFileVersion(FILE *, int);
 102 void ReadUnusedBytesFromFile(FILE *, unsigned long);
 103 void WriteUnusedBytesToFile(FILE *, unsigned long);
 104
 105 #define getFile16BitBE(f)     getFile16BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 106 #define getFile16BitLE(f)     getFile16BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 107 #define putFile16BitBE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 108 #define putFile16BitLE(f,x)   putFile16BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 109 #define getFile32BitBE(f)     getFile32BitInteger(f,BYTE_ORDER_BIG_ENDIAN)
 110 #define getFile32BitLE(f)     getFile32BitInteger(f,BYTE_ORDER_LITTLE_ENDIAN)
 111 #define putFile32BitBE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_BIG_ENDIAN)
 112 #define putFile32BitLE(f,x)   putFile32BitInteger(f,x,BYTE_ORDER_LITTLE_ENDIAN)
 113 #define getFileChunkBE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 114 #define getFileChunkLE(f,s,x) getFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 115 #define putFileChunkBE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_BIG_ENDIAN)
 116 #define putFileChunkLE(f,s,x) putFileChunk(f,s,x,BYTE_ORDER_LITTLE_ENDIAN)
 117
 118 char *getKeyNameFromKey(Key);
 119 char *getX11KeyNameFromKey(Key);
 120 Key getKeyFromKeyName(char *);
 121 Key getKeyFromX11KeyName(char *);
 122 char getCharFromKey(Key);
 123
 124 int get_integer_from_string(char *);
 125 boolean get_boolean_from_string(char *);
 126
 127 ListNode *newListNode(void);
 128 void addNodeToList(ListNode **, char *, void *);
 129 void deleteNodeFromList(ListNode **, char *, void (*function)(void *));
 130 ListNode *getNodeFromKey(ListNode *, char *);
 131 int getNumNodes(ListNode *);
 132
 133 boolean FileIsGraphic(char *);
 134 boolean FileIsSound(char *);
 135 boolean FileIsMusic(char *);
 136 boolean FileIsArtworkType(char *, int);
 137
 138 struct FileInfo *getFileListFromConfigList(struct ConfigInfo *,
 139                                            struct ConfigInfo *, int);
 140 void LoadArtworkConfig(struct ArtworkListInfo *);
 141 void ReloadCustomArtworkList(struct ArtworkListInfo *);
 142 void FreeCustomArtworkList(struct ArtworkListInfo *);
 143
 144 #if !defined(PLATFORM_UNIX)
 145 void initErrorFile();
 146 FILE *openErrorFile();
 147 void dumpErrorFile();
 148 #endif
 149
 150 void debug_print_timestamp(int, char *);
 151
 152 #endif /* MISC_H */