| 1 | /* |
| 2 | * Header for misc.c. |
| 3 | */ |
| 4 | |
| 5 | #ifndef PUTTY_MISC_H |
| 6 | #define PUTTY_MISC_H |
| 7 | |
| 8 | #include "puttymem.h" |
| 9 | |
| 10 | #include <stdio.h> /* for FILE * */ |
| 11 | #include <stdarg.h> /* for va_list */ |
| 12 | #include <time.h> /* for struct tm */ |
| 13 | |
| 14 | #ifndef FALSE |
| 15 | #define FALSE 0 |
| 16 | #endif |
| 17 | #ifndef TRUE |
| 18 | #define TRUE 1 |
| 19 | #endif |
| 20 | |
| 21 | typedef struct Filename Filename; |
| 22 | typedef struct FontSpec FontSpec; |
| 23 | |
| 24 | unsigned long parse_blocksize(const char *bs); |
| 25 | char ctrlparse(char *s, char **next); |
| 26 | |
| 27 | char *dupstr(const char *s); |
| 28 | char *dupcat(const char *s1, ...); |
| 29 | char *dupprintf(const char *fmt, ...); |
| 30 | char *dupvprintf(const char *fmt, va_list ap); |
| 31 | void burnstr(char *string); |
| 32 | |
| 33 | int toint(unsigned); |
| 34 | |
| 35 | char *fgetline(FILE *fp); |
| 36 | |
| 37 | void base64_encode_atom(unsigned char *data, int n, char *out); |
| 38 | |
| 39 | struct bufchain_granule; |
| 40 | typedef struct bufchain_tag { |
| 41 | struct bufchain_granule *head, *tail; |
| 42 | int buffersize; /* current amount of buffered data */ |
| 43 | } bufchain; |
| 44 | |
| 45 | void bufchain_init(bufchain *ch); |
| 46 | void bufchain_clear(bufchain *ch); |
| 47 | int bufchain_size(bufchain *ch); |
| 48 | void bufchain_add(bufchain *ch, const void *data, int len); |
| 49 | void bufchain_prefix(bufchain *ch, void **data, int *len); |
| 50 | void bufchain_consume(bufchain *ch, int len); |
| 51 | void bufchain_fetch(bufchain *ch, void *data, int len); |
| 52 | |
| 53 | struct tm ltime(void); |
| 54 | |
| 55 | void smemclr(void *b, size_t len); |
| 56 | |
| 57 | /* |
| 58 | * Debugging functions. |
| 59 | * |
| 60 | * Output goes to debug.log |
| 61 | * |
| 62 | * debug(()) (note the double brackets) is like printf(). |
| 63 | * |
| 64 | * dmemdump() and dmemdumpl() both do memory dumps. The difference |
| 65 | * is that dmemdumpl() is more suited for when the memory address is |
| 66 | * important (say because you'll be recording pointer values later |
| 67 | * on). dmemdump() is more concise. |
| 68 | */ |
| 69 | |
| 70 | #ifdef DEBUG |
| 71 | void debug_printf(char *fmt, ...); |
| 72 | void debug_memdump(void *buf, int len, int L); |
| 73 | #define debug(x) (debug_printf x) |
| 74 | #define dmemdump(buf,len) debug_memdump (buf, len, 0); |
| 75 | #define dmemdumpl(buf,len) debug_memdump (buf, len, 1); |
| 76 | #else |
| 77 | #define debug(x) |
| 78 | #define dmemdump(buf,len) |
| 79 | #define dmemdumpl(buf,len) |
| 80 | #endif |
| 81 | |
| 82 | #ifndef lenof |
| 83 | #define lenof(x) ( (sizeof((x))) / (sizeof(*(x)))) |
| 84 | #endif |
| 85 | |
| 86 | #ifndef min |
| 87 | #define min(x,y) ( (x) < (y) ? (x) : (y) ) |
| 88 | #endif |
| 89 | #ifndef max |
| 90 | #define max(x,y) ( (x) > (y) ? (x) : (y) ) |
| 91 | #endif |
| 92 | |
| 93 | #define GET_32BIT_LSB_FIRST(cp) \ |
| 94 | (((unsigned long)(unsigned char)(cp)[0]) | \ |
| 95 | ((unsigned long)(unsigned char)(cp)[1] << 8) | \ |
| 96 | ((unsigned long)(unsigned char)(cp)[2] << 16) | \ |
| 97 | ((unsigned long)(unsigned char)(cp)[3] << 24)) |
| 98 | |
| 99 | #define PUT_32BIT_LSB_FIRST(cp, value) ( \ |
| 100 | (cp)[0] = (unsigned char)(value), \ |
| 101 | (cp)[1] = (unsigned char)((value) >> 8), \ |
| 102 | (cp)[2] = (unsigned char)((value) >> 16), \ |
| 103 | (cp)[3] = (unsigned char)((value) >> 24) ) |
| 104 | |
| 105 | #define GET_16BIT_LSB_FIRST(cp) \ |
| 106 | (((unsigned long)(unsigned char)(cp)[0]) | \ |
| 107 | ((unsigned long)(unsigned char)(cp)[1] << 8)) |
| 108 | |
| 109 | #define PUT_16BIT_LSB_FIRST(cp, value) ( \ |
| 110 | (cp)[0] = (unsigned char)(value), \ |
| 111 | (cp)[1] = (unsigned char)((value) >> 8) ) |
| 112 | |
| 113 | #define GET_32BIT_MSB_FIRST(cp) \ |
| 114 | (((unsigned long)(unsigned char)(cp)[0] << 24) | \ |
| 115 | ((unsigned long)(unsigned char)(cp)[1] << 16) | \ |
| 116 | ((unsigned long)(unsigned char)(cp)[2] << 8) | \ |
| 117 | ((unsigned long)(unsigned char)(cp)[3])) |
| 118 | |
| 119 | #define GET_32BIT(cp) GET_32BIT_MSB_FIRST(cp) |
| 120 | |
| 121 | #define PUT_32BIT_MSB_FIRST(cp, value) ( \ |
| 122 | (cp)[0] = (unsigned char)((value) >> 24), \ |
| 123 | (cp)[1] = (unsigned char)((value) >> 16), \ |
| 124 | (cp)[2] = (unsigned char)((value) >> 8), \ |
| 125 | (cp)[3] = (unsigned char)(value) ) |
| 126 | |
| 127 | #define PUT_32BIT(cp, value) PUT_32BIT_MSB_FIRST(cp, value) |
| 128 | |
| 129 | #define GET_16BIT_MSB_FIRST(cp) \ |
| 130 | (((unsigned long)(unsigned char)(cp)[0] << 8) | \ |
| 131 | ((unsigned long)(unsigned char)(cp)[1])) |
| 132 | |
| 133 | #define PUT_16BIT_MSB_FIRST(cp, value) ( \ |
| 134 | (cp)[0] = (unsigned char)((value) >> 8), \ |
| 135 | (cp)[1] = (unsigned char)(value) ) |
| 136 | |
| 137 | #endif |