]> asedeno.scripts.mit.edu Git - PuTTY.git/blob - misc.h
Move base64_decode_atom into misc.c.
[PuTTY.git] / misc.h
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 size_t host_strcspn(const char *s, const char *set);
28 char *host_strchr(const char *s, int c);
29 char *host_strrchr(const char *s, int c);
30 char *host_strduptrim(const char *s);
31
32 char *dupstr(const char *s);
33 char *dupcat(const char *s1, ...);
34 char *dupprintf(const char *fmt, ...)
35 #ifdef __GNUC__
36     __attribute__ ((format (printf, 1, 2)))
37 #endif
38     ;
39 char *dupvprintf(const char *fmt, va_list ap);
40 void burnstr(char *string);
41
42 int toint(unsigned);
43
44 char *fgetline(FILE *fp);
45
46 void base64_encode_atom(unsigned char *data, int n, char *out);
47 int base64_decode_atom(char *atom, unsigned char *out);
48
49 struct bufchain_granule;
50 typedef struct bufchain_tag {
51     struct bufchain_granule *head, *tail;
52     int buffersize;                    /* current amount of buffered data */
53 } bufchain;
54
55 void bufchain_init(bufchain *ch);
56 void bufchain_clear(bufchain *ch);
57 int bufchain_size(bufchain *ch);
58 void bufchain_add(bufchain *ch, const void *data, int len);
59 void bufchain_prefix(bufchain *ch, void **data, int *len);
60 void bufchain_consume(bufchain *ch, int len);
61 void bufchain_fetch(bufchain *ch, void *data, int len);
62
63 struct tm ltime(void);
64
65 void smemclr(void *b, size_t len);
66
67 /*
68  * Debugging functions.
69  *
70  * Output goes to debug.log
71  *
72  * debug(()) (note the double brackets) is like printf().
73  *
74  * dmemdump() and dmemdumpl() both do memory dumps.  The difference
75  * is that dmemdumpl() is more suited for when the memory address is
76  * important (say because you'll be recording pointer values later
77  * on).  dmemdump() is more concise.
78  */
79
80 #ifdef DEBUG
81 void debug_printf(char *fmt, ...);
82 void debug_memdump(void *buf, int len, int L);
83 #define debug(x) (debug_printf x)
84 #define dmemdump(buf,len) debug_memdump (buf, len, 0);
85 #define dmemdumpl(buf,len) debug_memdump (buf, len, 1);
86 #else
87 #define debug(x)
88 #define dmemdump(buf,len)
89 #define dmemdumpl(buf,len)
90 #endif
91
92 #ifndef lenof
93 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
94 #endif
95
96 #ifndef min
97 #define min(x,y) ( (x) < (y) ? (x) : (y) )
98 #endif
99 #ifndef max
100 #define max(x,y) ( (x) > (y) ? (x) : (y) )
101 #endif
102
103 #define GET_32BIT_LSB_FIRST(cp) \
104   (((unsigned long)(unsigned char)(cp)[0]) | \
105   ((unsigned long)(unsigned char)(cp)[1] << 8) | \
106   ((unsigned long)(unsigned char)(cp)[2] << 16) | \
107   ((unsigned long)(unsigned char)(cp)[3] << 24))
108
109 #define PUT_32BIT_LSB_FIRST(cp, value) ( \
110   (cp)[0] = (unsigned char)(value), \
111   (cp)[1] = (unsigned char)((value) >> 8), \
112   (cp)[2] = (unsigned char)((value) >> 16), \
113   (cp)[3] = (unsigned char)((value) >> 24) )
114
115 #define GET_16BIT_LSB_FIRST(cp) \
116   (((unsigned long)(unsigned char)(cp)[0]) | \
117   ((unsigned long)(unsigned char)(cp)[1] << 8))
118
119 #define PUT_16BIT_LSB_FIRST(cp, value) ( \
120   (cp)[0] = (unsigned char)(value), \
121   (cp)[1] = (unsigned char)((value) >> 8) )
122
123 #define GET_32BIT_MSB_FIRST(cp) \
124   (((unsigned long)(unsigned char)(cp)[0] << 24) | \
125   ((unsigned long)(unsigned char)(cp)[1] << 16) | \
126   ((unsigned long)(unsigned char)(cp)[2] << 8) | \
127   ((unsigned long)(unsigned char)(cp)[3]))
128
129 #define GET_32BIT(cp) GET_32BIT_MSB_FIRST(cp)
130
131 #define PUT_32BIT_MSB_FIRST(cp, value) ( \
132   (cp)[0] = (unsigned char)((value) >> 24), \
133   (cp)[1] = (unsigned char)((value) >> 16), \
134   (cp)[2] = (unsigned char)((value) >> 8), \
135   (cp)[3] = (unsigned char)(value) )
136
137 #define PUT_32BIT(cp, value) PUT_32BIT_MSB_FIRST(cp, value)
138
139 #define GET_16BIT_MSB_FIRST(cp) \
140   (((unsigned long)(unsigned char)(cp)[0] << 8) | \
141   ((unsigned long)(unsigned char)(cp)[1]))
142
143 #define PUT_16BIT_MSB_FIRST(cp, value) ( \
144   (cp)[0] = (unsigned char)((value) >> 8), \
145   (cp)[1] = (unsigned char)(value) )
146
147 #endif