src/util.h

   1 #ifndef INCLUDE_util_h__
   2 #define INCLUDE_util_h__
   3
   4 #define ARRAY_SIZE(x) (sizeof(x)/sizeof(x[0]))
   5 #define bitsizeof(x)  (CHAR_BIT * sizeof(x))
   6 #define MSB(x, bits) ((x) & (~0ULL << (bitsizeof(x) - (bits))))
   7
   8 /*
   9  * Custom memory allocation wrappers
  10  * that set error code and error message
  11  * on allocation failure
  12  */
  13 GIT_INLINE(void *) git__malloc(size_t len)
  14 {
  15         void *ptr = malloc(len);
  16         if (!ptr)
  17                 git__throw(GIT_ENOMEM, "Out of memory. Failed to allocate %d bytes.", (int)len);
  18         return ptr;
  19 }
  20
  21 GIT_INLINE(void *) git__calloc(size_t nelem, size_t elsize)
  22 {
  23         void *ptr = calloc(nelem, elsize);
  24         if (!ptr)
  25                 git__throw(GIT_ENOMEM, "Out of memory. Failed to allocate %d bytes.", (int)elsize);
  26         return ptr;
  27 }
  28
  29 GIT_INLINE(char *) git__strdup(const char *str)
  30 {
  31         char *ptr = strdup(str);
  32         if (!ptr)
  33                 git__throw(GIT_ENOMEM, "Out of memory. Failed to duplicate string");
  34         return ptr;
  35 }
  36
  37 GIT_INLINE(char *) git__strndup(const char *str, size_t n)
  38 {
  39         size_t length;
  40         char *ptr;
  41
  42         length = strlen(str);
  43         if (n < length)
  44                 length = n;
  45
  46         ptr = (char*)malloc(length + 1);
  47         if (!ptr)
  48                 git__throw(GIT_ENOMEM, "Out of memory. Failed to duplicate string");
  49
  50         memcpy(ptr, str, length);
  51         ptr[length] = 0;
  52
  53         return ptr;
  54 }
  55
  56 GIT_INLINE(void *) git__realloc(void *ptr, size_t size)
  57 {
  58         void *new_ptr = realloc(ptr, size);
  59         if (!new_ptr)
  60                 git__throw(GIT_ENOMEM, "Out of memory. Failed to allocate %d bytes.", (int)size);
  61         return new_ptr;
  62 }
  63
  64 extern int git__fmt(char *, size_t, const char *, ...)
  65         GIT_FORMAT_PRINTF(3, 4);
  66 extern int git__prefixcmp(const char *str, const char *prefix);
  67 extern int git__suffixcmp(const char *str, const char *suffix);
  68
  69 extern int git__strtol32(long *n, const char *buff, const char **end_buf, int base);
  70
  71 /*
  72  * The dirname() function shall take a pointer to a character string
  73  * that contains a pathname, and return a pointer to a string that is a
  74  * pathname of the parent directory of that file. Trailing '/' characters
  75  * in the path are not counted as part of the path.
  76  *
  77  * If path does not contain a '/', then dirname() shall return a pointer to
  78  * the string ".". If path is a null pointer or points to an empty string,
  79  * dirname() shall return a pointer to the string "." .
  80  *
  81  * The `git__dirname` implementation is thread safe. The returned
  82  * string must be manually free'd.
  83  *
  84  * The `git__dirname_r` implementation expects a string allocated
  85  * by the user with big enough size.
  86  */
  87 extern char *git__dirname(const char *path);
  88 extern int git__dirname_r(char *buffer, size_t bufflen, const char *path);
  89
  90 /*
  91  * This function returns the basename of the file, which is the last
  92  * part of its full name given by fname, with the drive letter and
  93  * leading directories stripped off. For example, the basename of
  94  * c:/foo/bar/file.ext is file.ext, and the basename of a:foo is foo.
  95  *
  96  * Trailing slashes and backslashes are significant: the basename of
  97  * c:/foo/bar/ is an empty string after the rightmost slash.
  98  *
  99  * The `git__basename` implementation is thread safe. The returned
 100  * string must be manually free'd.
 101  *
 102  * The `git__basename_r` implementation expects a string allocated
 103  * by the user with big enough size.
 104  */
 105 extern char *git__basename(const char *path);
 106 extern int git__basename_r(char *buffer, size_t bufflen, const char *path);
 107
 108 extern const char *git__topdir(const char *path);
 109
 110 /**
 111  * Join two paths together. Takes care of properly fixing the
 112  * middle slashes and everything
 113  *
 114  * The paths are joined together into buffer_out; this is expected
 115  * to be an user allocated buffer of `GIT_PATH_MAX` size
 116  */
 117 extern void git__joinpath_n(char *buffer_out, int npath, ...);
 118
 119 GIT_INLINE(void) git__joinpath(char *buffer_out, const char *path_a, const char *path_b)
 120 {
 121         git__joinpath_n(buffer_out, 2, path_a, path_b);
 122 }
 123
 124 extern void git__hexdump(const char *buffer, size_t n);
 125 extern uint32_t git__hash(const void *key, int len, uint32_t seed);
 126
 127
 128 /** @return true if p fits into the range of a size_t */
 129 GIT_INLINE(int) git__is_sizet(git_off_t p)
 130 {
 131         size_t r = (size_t)p;
 132         return p == (git_off_t)r;
 133 }
 134
 135 /* 32-bit cross-platform rotl */
 136 #ifdef _MSC_VER /* use built-in method in MSVC */
 137 #       define git__rotl(v, s) (uint32_t)_rotl(v, s)
 138 #else /* use bitops in GCC; with o2 this gets optimized to a rotl instruction */
 139 #       define git__rotl(v, s) (uint32_t)(((uint32_t)(v) << (s)) | ((uint32_t)(v) >> (32 - (s))))
 140 #endif
 141
 142 extern char *git__strtok(char **end, const char *sep);
 143
 144 extern void git__strntolower(char *str, int len);
 145 extern void git__strtolower(char *str);
 146
 147 #define STRLEN(str) (sizeof(str) - 1)
 148
 149 #define GIT_OID_LINE_LENGTH(header) (STRLEN(header) + 1 + GIT_OID_HEXSZ + 1)
 150
 151 extern int git__fnmatch(const char *pattern, const char *name, int flags);
 152
 153 /*
 154  * Realloc the buffer pointed at by variable 'x' so that it can hold
 155  * at least 'nr' entries; the number of entries currently allocated
 156  * is 'alloc', using the standard growing factor alloc_nr() macro.
 157  *
 158  * DO NOT USE any expression with side-effect for 'x' or 'alloc'.
 159  */
 160 #define alloc_nr(x) (((x)+16)*3/2)
 161 #define ALLOC_GROW(x, nr, alloc) \
 162         do { \
 163                 if ((nr) > alloc) { \
 164                         if (alloc_nr(alloc) < (nr)) \
 165                                 alloc = (nr); \
 166                         else \
 167                                 alloc = alloc_nr(alloc); \
 168                         x = xrealloc((x), alloc * sizeof(*(x))); \
 169                 } \
 170         } while (0)
 171
 172 #endif /* INCLUDE_util_h__ */