src/libgame/misc.h

   1 /***********************************************************
   2 *  Rocks'n'Diamonds -- McDuffin Strikes Back!              *
   3 *----------------------------------------------------------*
   4 *  (c) 1995-98 Artsoft Entertainment                       *
   5 *              Holger Schemel                              *
   6 *              Oststrasse 11a                              *
   7 *              33604 Bielefeld                             *
   8 *              phone: ++49 +521 290471                     *
   9 *              email: aeglos@valinor.owl.de                *
  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 "libgame.h"
  21
  22 /* values for InitCounter() and Counter() */
  23 #define INIT_COUNTER                    0
  24 #define READ_COUNTER                    1
  25
  26 /* values for InitRND() */
  27 #define NEW_RANDOMIZE                   -1
  28
  29 /* values for Error() */
  30 #define ERR_RETURN                      0
  31 #define ERR_WARN                        (1 << 0)
  32 #define ERR_EXIT                        (1 << 1)
  33 #define ERR_HELP                        (1 << 2)
  34 #define ERR_SOUND_SERVER                (1 << 3)
  35 #define ERR_NETWORK_SERVER              (1 << 4)
  36 #define ERR_NETWORK_CLIENT              (1 << 5)
  37 #define ERR_FROM_SERVER                 (ERR_SOUND_SERVER | ERR_NETWORK_SERVER)
  38 #define ERR_EXIT_HELP                   (ERR_EXIT | ERR_HELP)
  39 #define ERR_EXIT_SOUND_SERVER           (ERR_EXIT | ERR_SOUND_SERVER)
  40 #define ERR_EXIT_NETWORK_SERVER         (ERR_EXIT | ERR_NETWORK_SERVER)
  41 #define ERR_EXIT_NETWORK_CLIENT         (ERR_EXIT | ERR_NETWORK_CLIENT)
  42
  43 /* values for getFile...() and putFile...() */
  44 #define BYTE_ORDER_BIG_ENDIAN           0
  45 #define BYTE_ORDER_LITTLE_ENDIAN        1
  46
  47 void InitCounter(void);
  48 unsigned long Counter(void);
  49 void Delay(unsigned long);
  50 boolean FrameReached(unsigned long *, unsigned long);
  51 boolean DelayReached(unsigned long *, unsigned long);
  52 void WaitUntilDelayReached(unsigned long *, unsigned long);
  53 char *int2str(int, int);
  54 unsigned int SimpleRND(unsigned int);
  55 unsigned int RND(unsigned int);
  56 unsigned int InitRND(long);
  57 char *getLoginName(void);
  58 char *getRealName(void);
  59 char *getHomeDir(void);
  60 char *getPath2(char *, char *);
  61 char *getPath3(char *, char *, char*);
  62 char *getStringCopy(char *);
  63 char *getStringToLower(char *);
  64 void GetOptions(char **);
  65 void Error(int, char *, ...);
  66 void *checked_malloc(unsigned long);
  67 void *checked_calloc(unsigned long);
  68 short getFile16BitInteger(FILE *, int);
  69 void putFile16BitInteger(FILE *, short, int);
  70 int getFile32BitInteger(FILE *, int);
  71 void putFile32BitInteger(FILE *, int, int);
  72 void getFileChunk(FILE *, char *, int *, int);
  73 void putFileChunk(FILE *, char *, int, int);
  74 char *getKeyNameFromKey(Key);
  75 char *getX11KeyNameFromKey(Key);
  76 Key getKeyFromX11KeyName(char *);
  77 char getCharFromKey(Key);
  78 char *getJoyNameFromJoySymbol(int);
  79 int getJoySymbolFromJoyName(char *);
  80 int getJoystickNrFromDeviceName(char *);
  81
  82 struct LevelDirInfo *newLevelDirInfo();
  83 void pushLevelDirInfo(struct LevelDirInfo **, struct LevelDirInfo *);
  84 int numLevelDirInfo(struct LevelDirInfo *);
  85 boolean validLevelSeries(struct LevelDirInfo *);
  86 struct LevelDirInfo *getFirstValidLevelSeries(struct LevelDirInfo *);
  87 struct LevelDirInfo *getLevelDirInfoFirstGroupEntry(struct LevelDirInfo *);
  88 int numLevelDirInfoInGroup(struct LevelDirInfo *);
  89 int posLevelDirInfo(struct LevelDirInfo *);
  90 struct LevelDirInfo *getLevelDirInfoFromPos(struct LevelDirInfo *, int);
  91 struct LevelDirInfo *getLevelDirInfoFromFilename(char *);
  92 void dumpLevelDirInfo(struct LevelDirInfo *, int);
  93 void sortLevelDirInfo(struct LevelDirInfo **,
  94                       int (*compare_function)(const void *, const void *));
  95
  96 inline void swap_numbers(int *, int *);
  97 inline void swap_number_pairs(int *, int *, int *, int *);
  98
  99 char *getUserDataDir(void);
 100 void createDirectory(char *, char *);
 101 void InitUserDataDirectory(void);
 102
 103 #if !defined(PLATFORM_UNIX)
 104 void initErrorFile();
 105 FILE *openErrorFile();
 106 void dumpErrorFile();
 107 #endif
 108
 109 void debug_print_timestamp(int, char *);
 110
 111 #endif /* MISC_H */