123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631 |
- /*
- misc.h - miscellaneous functions
- Copyright (c) 1999 - 2004 NoisyB
- Copyright (c) 2001 - 2004, 2015 dbjh
- Copyright (c) 2002 - 2004 Jan-Erik Karlsson (Amiga code)
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- */
- #ifndef MISC_H
- #define MISC_H
- #ifdef HAVE_CONFIG_H
- #include "config.h" // USE_ZLIB, USE_ANSI_COLOR support
- #endif
- #ifdef __cplusplus
- extern "C" {
- #endif
- #include <string.h>
- #ifdef _MSC_VER
- #pragma warning(push)
- #pragma warning(disable: 4820) // 'bytes' bytes padding added after construct 'member_name'
- #endif
- #include <time.h> // gauge() prototype contains time_t
- #ifdef _MSC_VER
- #pragma warning(pop)
- #endif
- #include <stdio.h>
- #ifdef USE_ZLIB
- #include "misc_z.h"
- #endif // USE_ZLIB
- #ifdef __sun
- #ifdef __SVR4
- #define __solaris__
- #endif
- #endif
- #ifdef HAVE_INTTYPES_H
- #include <inttypes.h>
- #else // __MSDOS__, _WIN32 (VC++)
- #ifndef OWN_INTTYPES
- #define OWN_INTTYPES // signal that these are defined
- typedef unsigned char uint8_t;
- typedef signed char int8_t;
- typedef unsigned short int uint16_t;
- typedef signed short int int16_t;
- typedef unsigned int uint32_t;
- typedef signed int int32_t;
- #ifndef _WIN32
- typedef unsigned long long int uint64_t;
- typedef signed long long int int64_t;
- #else
- typedef unsigned __int64 uint64_t;
- typedef signed __int64 int64_t;
- #endif
- #endif // OWN_INTTYPES
- #endif
- #if (defined __unix__ && !defined __MSDOS__) || defined __BEOS__ || \
- defined AMIGA || defined __APPLE__ // Mac OS X actually
- // GNU/Linux, Solaris, FreeBSD, Cygwin, BeOS, Amiga, Mac (OS X)
- #define DIR_SEPARATOR '/'
- #define DIR_SEPARATOR_S "/"
- #else // DJGPP, Win32
- #define DIR_SEPARATOR '\\'
- #define DIR_SEPARATOR_S "\\"
- #endif
- #ifndef MAXBUFSIZE
- #define MAXBUFSIZE 32768
- #endif // MAXBUFSIZE
- #ifndef ARGS_MAX
- #define ARGS_MAX 128
- #endif // ARGS_MAX
- #if (!defined TRUE || !defined FALSE)
- #define FALSE 0
- #define TRUE (!FALSE)
- #endif
- #ifndef MIN
- #define MIN(a,b) ((a)<(b)?(a):(b))
- #endif
- #ifndef MAX
- #define MAX(a,b) ((a)>(b)?(a):(b))
- #endif
- #define LIB_VERSION(ver, rel, seq) (((ver) << 16) | ((rel) << 8) | (seq))
- #define NULL_TO_EMPTY(str) ((str) ? (str) : (""))
- //#define RANDOM(min, max) ((rand () % (max - min)) + min)
- #define OFFSET(a, offset) ((((unsigned char *)&(a))+(offset))[0])
- #ifdef WORDS_BIGENDIAN
- #undef WORDS_BIGENDIAN
- #endif
- #if defined _LIBC || defined __GLIBC__
- #include <endian.h>
- #if __BYTE_ORDER == __BIG_ENDIAN
- #define WORDS_BIGENDIAN 1
- #endif
- #elif defined AMIGA || defined __sparc__ || defined __BIG_ENDIAN__ || \
- defined __APPLE__
- #define WORDS_BIGENDIAN 1
- #endif
- #ifdef __MSDOS__ // __MSDOS__ must come before __unix__,
- #define CURRENT_OS_S "MS-DOS" // because DJGPP defines both
- #elif defined __unix__
- #ifdef __CYGWIN__
- #define CURRENT_OS_S "Win32 (Cygwin)"
- #elif defined __FreeBSD__
- #define CURRENT_OS_S "UNIX (FreeBSD)"
- #elif defined __OpenBSD__
- #define CURRENT_OS_S "UNIX (OpenBSD)"
- #elif defined __linux__
- #define CURRENT_OS_S "UNIX (Linux)"
- #elif defined __solaris__
- #ifdef __sparc__
- #define CURRENT_OS_S "UNIX (Solaris/Sparc)"
- #else
- #define CURRENT_OS_S "UNIX (Solaris/i386)"
- #endif
- #else
- #define CURRENT_OS_S "UNIX"
- #endif
- #elif defined _WIN32
- #ifdef __MINGW32__
- #define CURRENT_OS_S "Win32 (MinGW)"
- #else
- #define CURRENT_OS_S "Win32 (Visual C++)"
- #endif
- #elif defined __APPLE__
- #if defined __POWERPC__ || defined __ppc__
- #define CURRENT_OS_S "Apple (PPC)"
- #else
- #define CURRENT_OS_S "Apple"
- #endif
- #elif defined __BEOS__
- #define CURRENT_OS_S "BeOS"
- #elif defined AMIGA
- #if defined __PPC__
- #define CURRENT_OS_S "Amiga (PPC)"
- #else
- #define CURRENT_OS_S "Amiga (68K)"
- #endif
- #else
- #define CURRENT_OS_S "?"
- #endif
- /*
- mem functions
- memwcmp() memcmp with wildcard support
- mem_search() search for a byte sequence
- mem_swap_b() swap n bytes of buffer
- mem_swap_w() swap n/2 words of buffer
- mem_hexdump() hexdump n bytes of buffer; you can use here a virtual_start for the displayed counter
- */
- #ifdef HAVE_BYTESWAP_H
- #include <byteswap.h>
- #else
- extern uint16_t bswap_16 (uint16_t x);
- extern uint32_t bswap_32 (uint32_t x);
- extern uint64_t bswap_64 (uint64_t x);
- #endif
- #ifdef WORDS_BIGENDIAN
- #define me2be_16(x) (x)
- #define me2be_32(x) (x)
- #define me2be_64(x) (x)
- #define me2le_16(x) (bswap_16(x))
- #define me2le_32(x) (bswap_32(x))
- #define me2le_64(x) (bswap_64(x))
- #define be2me_16(x) (x)
- #define be2me_32(x) (x)
- #define be2me_64(x) (x)
- #define le2me_16(x) (bswap_16(x))
- #define le2me_32(x) (bswap_32(x))
- #define le2me_64(x) (bswap_64(x))
- #else
- #define me2be_16(x) (bswap_16(x))
- #define me2be_32(x) (bswap_32(x))
- #define me2be_64(x) (bswap_64(x))
- #define me2le_16(x) (x)
- #define me2le_32(x) (x)
- #define me2le_64(x) (x)
- #define be2me_16(x) (bswap_16(x))
- #define be2me_32(x) (bswap_32(x))
- #define be2me_64(x) (bswap_64(x))
- #define le2me_16(x) (x)
- #define le2me_32(x) (x)
- #define le2me_64(x) (x)
- #endif
- extern int memwcmp (const void *buffer, const void *search, uint32_t searchlen, int wildcard);
- extern void *mem_search (const void *buffer, uint32_t buflen, const void *search, uint32_t searchlen);
- extern void *mem_swap_b (void *buffer, uint32_t n);
- extern void *mem_swap_w (void *buffer, uint32_t n);
- extern void mem_hexdump (const void *buffer, uint32_t n, int virtual_start);
- /*
- String manipulation
- isfname() test if char could be used for filenames
- isprint2() test if char could be used for stdout
- tofname() replaces chars that can not be used for filenames
- toprint2() replaces chars that should not be used for stdout
- is_func() use all is*() functions on an array of char
- to_func() use all to*() functions on an array of char
- strtrim() trim isspace()'s from start and end of string
- strncpy2() a safer strncpy that DOES terminate a string
- is_upper2() wrapper for is_upper() (DAMN stupid programmers!)
- set_suffix() set/replace suffix of filename with suffix
- suffix means in this case the suffix INCLUDING the dot '.'
- set_suffix_i() like set_suffix(), but doesn't change the case
- get_suffix() get suffix of filename
- basename2() DJGPP basename() clone
- dirname2() DJGPP dirname() clone
- realpath2() realpath() replacement
- one_file() returns 1 if two filenames refer to one file, otherwise it
- returns 0
- one_filesystem() returns 1 if two filenames refer to files on one file
- system, otherwise it returns 0
- mkdir2() mkdir() wrapper who automatically cares for rights, etc.
- rename2() renames oldname to newname even if oldname and newname are not
- on one file system
- truncate2() don't use truncate() to enlarge files, because the result is
- undefined (by POSIX) use truncate2() instead which does both
- strarg() break a string into tokens
- */
- extern int isfname (int c);
- extern int isprint2 (int c);
- extern int tofname (int c);
- extern int toprint2 (int c);
- extern int is_func (char *s, int size, int (*func) (int));
- extern char *to_func (char *s, int size, int (*func) (int));
- #define strupr(s) (to_func(s, strlen(s), toupper))
- #define strlwr(s) (to_func(s, strlen(s), tolower))
- //#ifndef HAVE_STRCASESTR
- // strcasestr is GNU only
- extern char *strcasestr2 (const char *str, const char *search);
- #define stristr strcasestr2
- //#else
- //#define stristr strcasestr
- //#endif
- #ifndef _WIN32
- #define stricmp strcasecmp
- #define strnicmp strncasecmp
- #endif
- extern char *strtrim (char *str);
- extern char *strncpy2 (char *dest, const char *src, size_t size);
- extern int isupper2 (int c);
- extern char *set_suffix (char *filename, const char *suffix);
- extern char *set_suffix_i (char *filename, const char *suffix);
- extern const char *get_suffix (const char *filename);
- extern char *basename2 (const char *path);
- // override a possible XPG basename() which modifies its arg
- #define basename basename2
- extern char *dirname2 (const char *path);
- #define dirname dirname2
- extern int one_file (const char *filename1, const char *filename2);
- extern int one_filesystem (const char *filename1, const char *filename2);
- extern char *realpath2 (const char *src, char *full_path);
- extern int mkdir2 (const char *name);
- extern int rename2 (const char *oldname, const char *newname);
- extern int truncate2 (const char *filename, int size);
- extern int strarg (char **argv, char *str, const char *separator_s, int max_args);
- /*
- Misc stuff
- change_mem{2}() see header of implementation for usage
- build_cm_patterns() helper function for change_mem2() to read search patterns
- from a file
- cleanup_cm_patterns() helper function for build_cm_patterns() to free all
- memory allocated for a (list of) st_pattern_t structure(s)
- clear_line () clear the current line (79 spaces)
- ansi_init() initialize ANSI output
- ansi_strip() strip ANSI codes from a string
- gauge() init_time == time when gauge() was first started or when
- the transfer started
- pos == current position
- size == full size
- gauge given these three values will calculate many
- informative things like time, status bar, cps, etc.
- it can be used for procedures which take some time to
- inform the user about the actual progress
- getenv2() getenv() clone for enviroments w/o HOME, TMP or TEMP variables
- tmpnam2() replacement for tmpnam() temp must have the size of FILENAME_MAX
- renlwr() renames all files tolower()
- drop_privileges() switch to the real user and group id (leave "root mode")
- register_func() atexit() replacement
- returns -1 if it fails, 0 if it was successful
- unregister_func() unregisters a previously registered function
- returns -1 if it fails, 0 if it was successful
- handle_registered_funcs() calls all the registered functions
- wait2 wait (sleep) a specified number of milliseconds
- */
- typedef struct st_cm_set
- {
- char *data;
- int size;
- } st_cm_set_t;
- typedef struct st_cm_pattern
- {
- #ifdef _MSC_VER
- #pragma warning(push)
- #pragma warning(disable: 4820) // 'bytes' bytes padding added after construct 'member_name'
- #endif
- char *search, wildcard, escape, *replace;
- #ifdef _MSC_VER
- #pragma warning(pop)
- #endif
- int search_size, replace_size, offset, n_sets;
- st_cm_set_t *sets;
- } st_cm_pattern_t;
- extern int change_mem (char *buf, int bufsize, char *searchstr, int strsize,
- char wc, char esc, char *newstr, int newsize, int offset, ...);
- extern int change_mem2 (char *buf, int bufsize, char *searchstr, int strsize,
- char wc, char esc, char *newstr, int newsize,
- int offset, st_cm_set_t *sets);
- extern int build_cm_patterns (st_cm_pattern_t **patterns, const char *filename, int verbose);
- extern void cleanup_cm_patterns (st_cm_pattern_t **patterns, int n_patterns);
- extern void clear_line (void);
- extern int ansi_init (void);
- extern char *ansi_strip (char *str);
- extern int gauge (time_t init_time, int pos, int size);
- extern char *getenv2 (const char *variable);
- extern char *tmpnam2 (char *temp);
- //extern int renlwr (const char *path);
- #if defined __unix__ && !defined __MSDOS__
- extern int drop_privileges (void);
- #endif
- extern int register_func (void (*func) (void));
- extern int unregister_func (void (*func) (void));
- extern void handle_registered_funcs (void);
- extern void wait2 (int nmillis);
- /*
- Extended getopt(), usage and workflow handling
- getopt2_usage() a renderer for a nice usage output
- takes an st_getopt2_t array
- getop2_parse_usage() parse usage output into st_getopt2_t
- array (for development)
- getopt2_long() turn st_getopt2_t into struct option for getopt1()
- getopt2_short() turn st_getopt2_t shortoptions string for getopt1()
- getopt2_get_index_by_val()
- */
- #include "getopt.h" // getopt2 needs struct option from getopt1
- #define OPTION '-'
- #define OPTION_S "-"
- #define OPTION_LONG_S "--"
- #define OPTARG '='
- #define OPTARG_S "="
- typedef struct
- {
- const char *name; // see getopt()
- int has_arg; // see getopt()
- int *flag; // see getopt()
- int val; // see getopt()
- const char *arg_name; // name of the options arg as it should be
- // displayed in the --help output
- // "--name=arg_name" if has_arg == 1
- // "--name[=arg_name]" if has_arg == 2
- const char *help; // --help, -h, -? output for the current option
- void *object; // could be used for workflow objects
- } st_getopt2_t;
- extern void getopt2_usage (const st_getopt2_t *option);
- #ifdef DEBUG
- extern void getopt2_parse_usage (const char *usage_output);
- #endif
- extern int getopt2_long (struct option *long_option, const st_getopt2_t *option, int n);
- extern int getopt2_short (char *short_option, const st_getopt2_t *option, int n);
- extern const st_getopt2_t *getopt2_get_index_by_val (const st_getopt2_t *option, int val);
- /*
- Quick I/O
- mode
- "r", "rb", "w", "wb", "a", "ab"
- quick_io_c() returns byte read or fputc()'s status
- quick_io() returns number of bytes read or written
- Macros
- q_fread() same as fread but takes start and src is a filename
- q_fwrite() same as fwrite but takes start and dest is a filename; mode
- is the same as fopen() modes
- q_fgetc() same as fgetc but takes filename instead of FILE and a pos
- q_fputc() same as fputc but takes filename instead of FILE and a pos
- b,s,l,f,m == buffer,start,len,filename,mode
- Misc
- q_fncmp() search in filename from start len bytes for the first appearance
- of search which has searchlen
- wildcard could be one character or -1 (wildcard off)
- q_fcpy() copy src from start for len to dest with mode (fopen(..., mode))
- q_rfcpy() copy src to dest without looking at the file data (no
- decompression like with q_fcpy())
- q_fswap() swap len bytes of file starting from start
- q_fbackup()
- modes
- BAK_DUPE (default)
- rename file to keep attributes and copy it back to old name and return
- new name
- filename -> rename() -> buf -> f_cpy() -> filename -> return buf
- BAK_MOVE
- just rename file and return new name (static)
- filename -> rename() -> buf -> return buf
- */
- extern int quick_io (void *buffer, size_t start, size_t len, const char *fname, const char *mode);
- extern int quick_io_c (int value, size_t start, const char *fname, const char *mode);
- #define q_fread(b,s,l,f) (quick_io(b,s,l,f,"rb"))
- #define q_fwrite(b,s,l,f,m) (quick_io((void *)b,s,l,f,m))
- #define q_fgetc(f,s) (quick_io_c(0,s,f,"rb"))
- #define q_fputc(f,s,b,m) (quick_io_c(b,s,f,m))
- typedef enum { SWAP_BYTE, SWAP_WORD } swap_t;
- extern int q_fncmp (const char *filename, int start, int len,
- const char *search, int searchlen, int wildcard);
- extern int q_fcpy (const char *src, int start, int len, const char *dest, const char *mode);
- extern int q_rfcpy (const char *src, const char *dest);
- extern int q_fswap (const char *filename, int start, int len, swap_t type);
- #define q_fswap_b(f, s, l) q_fswap(f, s, l, SWAP_BYTE)
- #define q_fswap_w(f, s, l) q_fswap(f, s, l, SWAP_WORD)
- #if 1
- #define BAK_DUPE 0
- #define BAK_MOVE 1
- extern char *q_fbackup (const char *filename, int mode);
- #else
- extern char *q_fbackup (char *move_name, const char *filename);
- #endif
- #ifndef USE_ZLIB
- extern int q_fsize (const char *filename);
- #endif
- /*
- Configuration file handling
- get_property() get value of propname from filename or return value of env
- with name like propname or return def
- get_property_int() like get_property() but returns an integer which is 0
- if the value of propname was 0, [Nn] or [Nn][Oo] and an
- integer or at least 1 for every other case
- get_property_fname() like get_property() but specifically for filenames,
- i.e., it runs realpath2() on the filename and fixes the
- characters if necessary (Cygwin)
- set_property() set propname with value in filename
- DELETE_PROPERTY() like set_property but when value of propname is NULL the
- whole property will disappear from filename
- */
- #define PROPERTY_SEPARATOR '='
- #define PROPERTY_SEPARATOR_S "="
- #define PROPERTY_COMMENT '#'
- #define PROPERTY_COMMENT_S "#"
- extern char *get_property (const char *filename, const char *propname,
- char *value, const char *def);
- extern int32_t get_property_int (const char *filename, const char *propname);
- extern char *get_property_fname (const char *filename, const char *propname,
- char *buffer, const char *def);
- extern int set_property (const char *filename, const char *propname,
- const char *value, const char *comment);
- #define DELETE_PROPERTY(a, b) (set_property(a, b, NULL, NULL))
- /*
- Portability (conio.h, etc...)
-
- init_conio() init console I/O
- deinit_conio() stop console I/O
- getch()
- kbhit()
- truncate()
- sync()
- popen()
- pclose()
- vprintf2()
- printf2()
- fprintf2()
- */
- #if (defined __unix__ && !defined __MSDOS__) || defined __BEOS__ || \
- defined __APPLE__ // Mac OS X actually
- extern void init_conio (void);
- extern void deinit_conio (void);
- #define getch getchar // getchar() acts like DOS getch() after init_conio()
- extern int kbhit (void); // may only be used after init_conio()!
- #elif defined __MSDOS__
- #include <conio.h> // getch()
- #include <pc.h> // kbhit()
- #elif defined _WIN32
- #include <conio.h> // kbhit() & getch()
- #elif defined AMIGA
- extern int kbhit (void);
- //#define getch getchar
- // Gonna use my (Jan-Erik) fake one. Might work better and more like the real
- // getch().
- #endif
- #ifdef _WIN32
- // Note that _WIN32 is defined by cl.exe while the other constants (like WIN32)
- // are defined in header files. MinGW's gcc.exe defines all constants.
- #include <sys/types.h>
- extern int truncate (const char *path, off_t size);
- extern int sync (void);
- // For MinGW popen() and pclose() are unavailable for DLL's. For DLL's _popen()
- // and _pclose() should be used. Visual C++ only has the latter two.
- #ifndef pclose // misc_z.h's definition gets higher precedence
- #define pclose _pclose
- #endif
- #ifndef popen // idem
- #define popen _popen
- #endif
- #ifdef USE_ANSI_COLOR
- #include <stdarg.h>
- extern int vprintf2 (const char *format, va_list argptr);
- extern int printf2 (const char *format, ...);
- extern int fprintf2 (FILE *file, const char *format, ...);
- #define vprintf vprintf2
- #define printf printf2
- #define fprintf fprintf2
- #endif // USE_ANSI_COLOR
- #ifndef __MINGW32__
- #ifdef _MSC_VER
- #pragma warning(push)
- #pragma warning(disable: 4820) // 'bytes' bytes padding added after construct 'member_name'
- #endif
- #include <io.h>
- #include <sys/stat.h> // According to MSDN <sys/stat.h> must
- #ifdef _MSC_VER // come after <sys/types.h>. Yep, that's M$.
- #pragma warning(pop)
- #endif
- #include <direct.h>
- #define S_IWUSR _S_IWRITE
- #define S_IRUSR _S_IREAD
- #define S_ISDIR(mode) ((mode) & _S_IFDIR ? 1 : 0)
- #define S_ISREG(mode) ((mode) & _S_IFREG ? 1 : 0)
- #define F_OK 00
- #define W_OK 02
- #define R_OK 04
- #define X_OK R_OK // this is correct for dirs, but not for exes
- #define STDIN_FILENO (fileno (stdin))
- #define STDOUT_FILENO (fileno (stdout))
- #define STDERR_FILENO (fileno (stderr))
- #else
- #ifdef DLL
- #define access _access
- #define chmod _chmod
- //#define fileno _fileno
- #define getcwd _getcwd
- #define isatty _isatty
- #define rmdir _rmdir
- #define stat _stat
- #define strdup _strdup
- #define stricmp _stricmp
- #define strnicmp _strnicmp
- #endif // DLL
- #endif // !__MINGW32__
- #elif defined AMIGA // _WIN32
- // custom _popen() and _pclose(), because the standard ones (named popen() and
- // pclose()) are buggy
- #ifndef pclose // misc_z.h's definition gets higher precedence
- #define pclose _pclose
- #endif
- #ifndef popen // idem
- #define popen _popen
- #endif
- extern FILE *_popen (const char *path, const char *mode);
- extern int _pclose (FILE *stream);
- #endif // AMIGA
- #ifdef __cplusplus
- }
- #endif
- #endif // MISC_H
|