src/TortoisePlink/MISC.H

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