CPatch: New memory management

[TortoiseGit.git] / src / TortoisePlink / MISC.H

/*\r
 * Header for misc.c.\r
 */\r
\r
#ifndef PUTTY_MISC_H\r
#define PUTTY_MISC_H\r
\r
#include "puttymem.h"\r
\r
#include <stdio.h>                     /* for FILE * */\r
#include <stdarg.h>                    /* for va_list */\r
#include <time.h>                      /* for struct tm */\r
\r
#ifndef FALSE\r
#define FALSE 0\r
#endif\r
#ifndef TRUE\r
#define TRUE 1\r
#endif\r
\r
typedef struct Filename Filename;\r
typedef struct FontSpec FontSpec;\r
\r
unsigned long parse_blocksize(const char *bs);\r
char ctrlparse(char *s, char **next);\r
\r
size_t host_strcspn(const char *s, const char *set);\r
char *host_strchr(const char *s, int c);\r
char *host_strrchr(const char *s, int c);\r
char *host_strduptrim(const char *s);\r
\r
char *dupstr(const char *s);\r
char *dupcat(const char *s1, ...);\r
char *dupprintf(const char *fmt, ...)\r
#ifdef __GNUC__\r
    __attribute__ ((format (printf, 1, 2)))\r
#endif\r
    ;\r
char *dupvprintf(const char *fmt, va_list ap);\r
void burnstr(char *string);\r
typedef struct strbuf strbuf;\r
strbuf *strbuf_new(void);\r
void strbuf_free(strbuf *buf);\r
char *strbuf_str(strbuf *buf);         /* does not free buf */\r
char *strbuf_to_str(strbuf *buf); /* does free buf, but you must free result */\r
void strbuf_catf(strbuf *buf, const char *fmt, ...);\r
void strbuf_catfv(strbuf *buf, const char *fmt, va_list ap);\r
\r
/* String-to-Unicode converters that auto-allocate the destination and\r
 * work around the rather deficient interface of mb_to_wc.\r
 *\r
 * These actually live in miscucs.c, not misc.c (the distinction being\r
 * that the former is only linked into tools that also have the main\r
 * Unicode support). */\r
wchar_t *dup_mb_to_wc_c(int codepage, int flags, const char *string, int len);\r
wchar_t *dup_mb_to_wc(int codepage, int flags, const char *string);\r
\r
int toint(unsigned);\r
\r
char *fgetline(FILE *fp);\r
char *chomp(char *str);\r
int strstartswith(const char *s, const char *t);\r
int strendswith(const char *s, const char *t);\r
\r
void base64_encode_atom(const unsigned char *data, int n, char *out);\r
int base64_decode_atom(const char *atom, unsigned char *out);\r
\r
struct bufchain_granule;\r
struct bufchain_tag {\r
    struct bufchain_granule *head, *tail;\r
    int buffersize;                    /* current amount of buffered data */\r
};\r
#ifndef BUFCHAIN_TYPEDEF\r
typedef struct bufchain_tag bufchain;  /* rest of declaration in misc.c */\r
#define BUFCHAIN_TYPEDEF\r
#endif\r
\r
void bufchain_init(bufchain *ch);\r
void bufchain_clear(bufchain *ch);\r
int bufchain_size(bufchain *ch);\r
void bufchain_add(bufchain *ch, const void *data, int len);\r
void bufchain_prefix(bufchain *ch, void **data, int *len);\r
void bufchain_consume(bufchain *ch, int len);\r
void bufchain_fetch(bufchain *ch, void *data, int len);\r
\r
int validate_manual_hostkey(char *key);\r
\r
struct tm ltime(void);\r
\r
/* Wipe sensitive data out of memory that's about to be freed. Simpler\r
 * than memset because we don't need the fill char parameter; also\r
 * attempts (by fiddly use of volatile) to inhibit the compiler from\r
 * over-cleverly trying to optimise the memset away because it knows\r
 * the variable is going out of scope. */\r
void smemclr(void *b, size_t len);\r
\r
/* Compare two fixed-length chunks of memory for equality, without\r
 * data-dependent control flow (so an attacker with a very accurate\r
 * stopwatch can't try to guess where the first mismatching byte was).\r
 * Returns 0 for mismatch or 1 for equality (unlike memcmp), hinted at\r
 * by the 'eq' in the name. */\r
int smemeq(const void *av, const void *bv, size_t len);\r
\r
/* Extracts an SSH-marshalled string from the start of *data. If\r
 * successful (*datalen is not too small), advances data/datalen past\r
 * the string and returns a pointer to the string itself and its\r
 * length in *stringlen. Otherwise does nothing and returns NULL.\r
 *\r
 * Like strchr, this function can discard const from its parameter.\r
 * Treat it as if it was a family of two functions, one returning a\r
 * non-const string given a non-const pointer, and one taking and\r
 * returning const. */\r
void *get_ssh_string(int *datalen, const void **data, int *stringlen);\r
/* Extracts an SSH uint32, similarly. Returns TRUE on success, and\r
 * leaves the extracted value in *ret. */\r
int get_ssh_uint32(int *datalen, const void **data, unsigned *ret);\r
/* Given a not-necessarily-zero-terminated string in (length,data)\r
 * form, check if it equals an ordinary C zero-terminated string. */\r
int match_ssh_id(int stringlen, const void *string, const char *id);\r
\r
char *buildinfo(const char *newline);\r
\r
/*\r
 * Debugging functions.\r
 *\r
 * Output goes to debug.log\r
 *\r
 * debug(()) (note the double brackets) is like printf().\r
 *\r
 * dmemdump() and dmemdumpl() both do memory dumps.  The difference\r
 * is that dmemdumpl() is more suited for when the memory address is\r
 * important (say because you'll be recording pointer values later\r
 * on).  dmemdump() is more concise.\r
 */\r
\r
#ifdef DEBUG\r
void debug_printf(const char *fmt, ...);\r
void debug_memdump(const void *buf, int len, int L);\r
#define debug(x) (debug_printf x)\r
#define dmemdump(buf,len) debug_memdump (buf, len, 0);\r
#define dmemdumpl(buf,len) debug_memdump (buf, len, 1);\r
#else\r
#define debug(x)\r
#define dmemdump(buf,len)\r
#define dmemdumpl(buf,len)\r
#endif\r
\r
#ifndef lenof\r
#define lenof(x) ( (sizeof((x))) / (sizeof(*(x))))\r
#endif\r
\r
#ifndef min\r
#define min(x,y) ( (x) < (y) ? (x) : (y) )\r
#endif\r
#ifndef max\r
#define max(x,y) ( (x) > (y) ? (x) : (y) )\r
#endif\r
\r
#define GET_32BIT_LSB_FIRST(cp) \\r
  (((unsigned long)(unsigned char)(cp)[0]) | \\r
  ((unsigned long)(unsigned char)(cp)[1] << 8) | \\r
  ((unsigned long)(unsigned char)(cp)[2] << 16) | \\r
  ((unsigned long)(unsigned char)(cp)[3] << 24))\r
\r
#define PUT_32BIT_LSB_FIRST(cp, value) ( \\r
  (cp)[0] = (unsigned char)(value), \\r
  (cp)[1] = (unsigned char)((value) >> 8), \\r
  (cp)[2] = (unsigned char)((value) >> 16), \\r
  (cp)[3] = (unsigned char)((value) >> 24) )\r
\r
#define GET_16BIT_LSB_FIRST(cp) \\r
  (((unsigned long)(unsigned char)(cp)[0]) | \\r
  ((unsigned long)(unsigned char)(cp)[1] << 8))\r
\r
#define PUT_16BIT_LSB_FIRST(cp, value) ( \\r
  (cp)[0] = (unsigned char)(value), \\r
  (cp)[1] = (unsigned char)((value) >> 8) )\r
\r
#define GET_32BIT_MSB_FIRST(cp) \\r
  (((unsigned long)(unsigned char)(cp)[0] << 24) | \\r
  ((unsigned long)(unsigned char)(cp)[1] << 16) | \\r
  ((unsigned long)(unsigned char)(cp)[2] << 8) | \\r
  ((unsigned long)(unsigned char)(cp)[3]))\r
\r
#define GET_32BIT(cp) GET_32BIT_MSB_FIRST(cp)\r
\r
#define PUT_32BIT_MSB_FIRST(cp, value) ( \\r
  (cp)[0] = (unsigned char)((value) >> 24), \\r
  (cp)[1] = (unsigned char)((value) >> 16), \\r
  (cp)[2] = (unsigned char)((value) >> 8), \\r
  (cp)[3] = (unsigned char)(value) )\r
\r
#define PUT_32BIT(cp, value) PUT_32BIT_MSB_FIRST(cp, value)\r
\r
#define GET_16BIT_MSB_FIRST(cp) \\r
  (((unsigned long)(unsigned char)(cp)[0] << 8) | \\r
  ((unsigned long)(unsigned char)(cp)[1]))\r
\r
#define PUT_16BIT_MSB_FIRST(cp, value) ( \\r
  (cp)[0] = (unsigned char)((value) >> 8), \\r
  (cp)[1] = (unsigned char)(value) )\r
\r
/* Replace NULL with the empty string, permitting an idiom in which we\r
 * get a string (pointer,length) pair that might be NULL,0 and can\r
 * then safely say things like printf("%.*s", length, NULLTOEMPTY(ptr)) */\r
#define NULLTOEMPTY(s) ((s)?(s):"")\r
\r
#endif\r