]> mj.ucw.cz Git - libucw.git/blobdiff - lib/lib.h
Added license notices to all library files which are not specific
[libucw.git] / lib / lib.h
index 2f27ffe43d0c7085479144e783498889c4fe2f53..ad19f505f38ea191ac9e34406b66d7d8db63d368 100644 (file)
--- a/lib/lib.h
+++ b/lib/lib.h
 /*
  *     Sherlock Library -- Miscellaneous Functions
  *
- *     (c) 1997 Martin Mares, <mj@atrey.karlin.mff.cuni.cz>
+ *     (c) 1997--2001 Martin Mares <mj@ucw.cz>
+ *
+ *     This software may be freely distributed and used according to the terms
+ *     of the GNU Lesser General Public License.
  */
 
-#include <lib/config.h>
-
-/* Temporary Files */
-
-#define TMP_DIR "tmp"
-#define TMP_DIR_LEN 3
+/*
+ *  This file should be included as the very first include in all
+ *  source files, especially before all OS includes since it sets
+ *  up libc feature macros.
+ */
 
-struct tempfile {
-  int fh;
-  byte name[32];
-};
+#ifndef _SHERLOCK_LIB_H
+#define _SHERLOCK_LIB_H
 
-void open_temp(struct tempfile *, byte *);
-void delete_temp(struct tempfile *);
-ulg temprand(uns);
+#include "lib/config.h"
 
-#define TF_GENERIC "t"
-#define TF_QUEUE_CONTROL "c"
-#define TF_QUEUE_DATA "d"
-#define TF_DECODE "x"
+/* Tell libc we're going to use all extensions available */
 
-/* Config Files */
+#define _GNU_SOURCE
 
-struct cfitem {
-  byte *name;
-  int type;
-  void *var;
-};
+/* Ugly structure handling macros */
 
-#define CI_STOP 0
-#define CI_INT 1
-#define CI_STRING 2
-#define CI_FUNCTION 3
+#define OFFSETOF(s, i) ((unsigned int)&((s *)0)->i)
+#define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i)))
+#define ALIGN(s, a) (((s)+a-1)&~(a-1))
+#define UNALIGNED_PART(ptr, type) (((long) (ptr)) % sizeof(type))
 
-typedef byte *(*ci_func)(struct cfitem *, byte *);
+/* Some other macros */
 
-void cf_read(byte *, struct cfitem *);
+#define MIN(a,b) (((a)<(b))?(a):(b))
+#define MAX(a,b) (((a)>(b))?(a):(b))
+#define CLAMP(x,min,max) ({ int _t=x; (_t < min) ? min : (_t > max) ? max : _t; })
+#define ABS(x) ((x) < 0 ? -(x) : (x))
+#define ARRAY_SIZE(a) (sizeof(a)/sizeof(*(a)))
 
 /* Logging */
 
-#define L_DEBUG "<0>"
-#define L_INFO "<2>"
-#define L_WARN "<4>"
-#define L_ERROR "<6>"
-#define L_FATAL "<9>"
+#define L_DEBUG                'D'             /* Debugging messages */
+#define L_INFO         'I'             /* Informational msgs, warnings and errors */
+#define L_WARN         'W'
+#define L_ERROR                'E'
+#define L_INFO_R       'i'             /* Errors caused by external events */
+#define L_WARN_R       'w'
+#define L_ERROR_R      'e'
+#define L_FATAL                '!'             /* die() */
 
-void log(byte *, ...);
+void log(unsigned int cat, const char *msg, ...) __attribute__((format(printf,2,3)));
 void die(byte *, ...) NONRET;
-void initlog(byte *);
-
-/* Allocation */
-
-void *xmalloc(uns);
-byte *stralloc(byte *);
-
-/* Content-Type pattern matching and filters */
-
-struct ct_filter;
+void assert_failed(char *assertion, char *file, int line) NONRET;
+void log_init(byte *);
+void log_file(byte *);
+void log_fork(void);
 
-int match_ct_patt(byte *, byte *);
+#ifdef DEBUG
+#define ASSERT(x) do { if (!(x)) assert_failed(#x, __FILE__, __LINE__); } while(0)
+#else
+#define ASSERT(x) do { } while(0)
+#endif
 
-struct ct_filter *new_ct_filter(void);
-byte *add_ct_filter(struct ct_filter *, byte *);
-int match_ct_filter(struct ct_filter *, byte *);
+#ifdef LOCAL_DEBUG
+#define DBG(x,y...) log(L_DEBUG, x,##y)
+#else
+#define DBG(x,y...) do { } while(0)
+#endif
 
-/* Binary log */
+/* Memory allocation */
 
-#ifdef HAVE_FFS
-#define log2(x) (ffs(x) - 1)
+#ifdef DMALLOC
+/*
+ * The standard dmalloc macros tend to produce lots of namespace
+ * conflicts and we use only xmalloc and xfree, so we can define
+ * the stubs ourselves.
+ */
+#define DMALLOC_DISABLE
+#include <dmalloc.h>
+#define xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size)
+#define xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size)
+#define xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr)
 #else
-int log2(ulg);
+/*
+ * Unfortunately, several libraries we might want to link to define
+ * their own xmalloc and we don't want to interfere with them, hence
+ * the renaming.
+ */
+#define xmalloc sh_xmalloc
+void *xmalloc(unsigned);
+void *xrealloc(void *, unsigned);
+#define xfree(x) free(x)
 #endif
 
-/* obj.c */
+void *xmalloc_zero(unsigned);
+byte *stralloc(byte *);
+
+/* Objects */
+
+struct fastbuf;
 
 struct odes {                          /* Object description */
   struct oattr *attrs;
+  struct mempool *pool, *local_pool;
 };
 
 struct oattr {                         /* Object attribute */
-  struct oattr *next, *same;
+  struct oattr *next, *same, *last_same;
   byte attr;
   byte val[1];
 };
 
 void obj_dump(struct odes *);
-struct odes *obj_fload(FILE *);
-struct odes *obj_new(void);
-struct odes *obj_load(byte *);
-void obj_fwrite(FILE *, struct odes *);        /* Closes the file afterwards... */
+struct odes *obj_new(struct mempool *);
 void obj_free(struct odes *);
-struct oattr *find_attr(struct odes *, uns);
-struct oattr *find_attr_last(struct odes *, uns);
-byte *find_aval(struct odes *, uns);
-struct oattr *set_attr(struct odes *, uns, byte *);
-struct oattr *set_attr_num(struct odes *, uns, uns);
-struct oattr *add_attr(struct odes *, struct oattr *, uns, byte *);
-struct oattr *prepend_attr(struct odes *, uns, byte *);
+int obj_read(struct fastbuf *, struct odes *);
+void obj_write(struct fastbuf *, struct odes *);
+struct oattr *obj_find_attr(struct odes *, uns);
+struct oattr *obj_find_attr_last(struct odes *, uns);
+uns obj_del_attr(struct odes *, struct oattr *);
+byte *obj_find_aval(struct odes *, uns);
+struct oattr *obj_set_attr(struct odes *, uns, byte *);
+struct oattr *obj_set_attr_num(struct odes *, uns, uns);
+struct oattr *obj_add_attr(struct odes *, struct oattr *, uns, byte *);
+struct oattr *obj_prepend_attr(struct odes *, uns, byte *);
+struct oattr *obj_insert_attr(struct odes *o, struct oattr *first, struct oattr *after, byte *v);
 
-/* oname.c */
+/* Content-Type pattern matching and filters */
+
+int match_ct_patt(byte *, byte *);
 
-void mk_obj_name(byte *, ulg, byte *);
-FILE *create_obj_file(byte *, ulg);
+/* log2.c */
+
+int log2(u32);
 
 /* wordsplit.c */
 
 int wordsplit(byte *, byte **, uns);
 
-/* patmatch.c */
+/* pat(i)match.c: Matching of shell patterns */
 
 int match_pattern(byte *, byte *);
+int match_pattern_nocase(byte *, byte *);
+
+/* md5hex.c */
+
+void md5_to_hex(byte *, byte *);
+void hex_to_md5(byte *, byte *);
+
+#define MD5_SIZE 16
+#define MD5_HEX_SIZE 33
+
+/* prime.c */
+
+int isprime(uns);
+uns nextprime(uns);
+
+/* timer.c */
+
+void init_timer(void);
+uns get_timer(void);
+
+/* regex.c */
+
+typedef struct regex regex;
+
+regex *rx_compile(byte *r, int icase);
+void rx_free(regex *r);
+int rx_match(regex *r, byte *s);
+int rx_subst(regex *r, byte *by, byte *src, byte *dest, uns destlen);
+
+/* random.c */
+
+uns random_max(uns);
+
+/* mmap.c */
+
+void *mmap_file(byte *name, unsigned *len, int writeable);
+void munmap_file(void *start, unsigned len);
+
+/* proctitle.c */
+
+void setproctitle_init(int argc, char **argv);
+void setproctitle(char *msg, ...) __attribute__((format(printf,1,2)));
+
+/* randomkey.c */
+
+void randomkey(byte *buf, uns size);
+
+#endif