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 int validate_manual_hostkey(char *key);
  64
  65 struct tm ltime(void);
  66
  67 void smemclr(void *b, size_t len);
  68
  69 /*
  70  * Debugging functions.
  71  *
  72  * Output goes to debug.log
  73  *
  74  * debug(()) (note the double brackets) is like printf().
  75  *
  76  * dmemdump() and dmemdumpl() both do memory dumps.  The difference
  77  * is that dmemdumpl() is more suited for when the memory address is
  78  * important (say because you'll be recording pointer values later
  79  * on).  dmemdump() is more concise.
  80  */
  81
  82 #ifdef DEBUG
  83 void debug_printf(char *fmt, ...);
  84 void debug_memdump(void *buf, int len, int L);
  85 #define debug(x) (debug_printf x)
  86 #define dmemdump(buf,len) debug_memdump (buf, len, 0);
  87 #define dmemdumpl(buf,len) debug_memdump (buf, len, 1);
  88 #else
  89 #define debug(x)
  90 #define dmemdump(buf,len)
  91 #define dmemdumpl(buf,len)
  92 #endif
  93
  94 #ifndef lenof
  95 #define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))
  96 #endif
  97
  98 #ifndef min
  99 #define min(x,y) ( (x) < (y) ? (x) : (y) )
 100 #endif
 101 #ifndef max
 102 #define max(x,y) ( (x) > (y) ? (x) : (y) )
 103 #endif
 104
 105 #define GET_32BIT_LSB_FIRST(cp) \
 106   (((unsigned long)(unsigned char)(cp)[0]) | \
 107   ((unsigned long)(unsigned char)(cp)[1] << 8) | \
 108   ((unsigned long)(unsigned char)(cp)[2] << 16) | \
 109   ((unsigned long)(unsigned char)(cp)[3] << 24))
 110
 111 #define PUT_32BIT_LSB_FIRST(cp, value) ( \
 112   (cp)[0] = (unsigned char)(value), \
 113   (cp)[1] = (unsigned char)((value) >> 8), \
 114   (cp)[2] = (unsigned char)((value) >> 16), \
 115   (cp)[3] = (unsigned char)((value) >> 24) )
 116
 117 #define GET_16BIT_LSB_FIRST(cp) \
 118   (((unsigned long)(unsigned char)(cp)[0]) | \
 119   ((unsigned long)(unsigned char)(cp)[1] << 8))
 120
 121 #define PUT_16BIT_LSB_FIRST(cp, value) ( \
 122   (cp)[0] = (unsigned char)(value), \
 123   (cp)[1] = (unsigned char)((value) >> 8) )
 124
 125 #define GET_32BIT_MSB_FIRST(cp) \
 126   (((unsigned long)(unsigned char)(cp)[0] << 24) | \
 127   ((unsigned long)(unsigned char)(cp)[1] << 16) | \
 128   ((unsigned long)(unsigned char)(cp)[2] << 8) | \
 129   ((unsigned long)(unsigned char)(cp)[3]))
 130
 131 #define GET_32BIT(cp) GET_32BIT_MSB_FIRST(cp)
 132
 133 #define PUT_32BIT_MSB_FIRST(cp, value) ( \
 134   (cp)[0] = (unsigned char)((value) >> 24), \
 135   (cp)[1] = (unsigned char)((value) >> 16), \
 136   (cp)[2] = (unsigned char)((value) >> 8), \
 137   (cp)[3] = (unsigned char)(value) )
 138
 139 #define PUT_32BIT(cp, value) PUT_32BIT_MSB_FIRST(cp, value)
 140
 141 #define GET_16BIT_MSB_FIRST(cp) \
 142   (((unsigned long)(unsigned char)(cp)[0] << 8) | \
 143   ((unsigned long)(unsigned char)(cp)[1]))
 144
 145 #define PUT_16BIT_MSB_FIRST(cp, value) ( \
 146   (cp)[0] = (unsigned char)((value) >> 8), \
 147   (cp)[1] = (unsigned char)(value) )
 148
 149 #endif