* added more usefull print hash function, so one can now use the list to render UI...

[citadel.git] / libcitadel / lib / libcitadel.h

diff --git a/libcitadel/lib/libcitadel.h b/libcitadel/lib/libcitadel.h
index 3a9bbbd671c12d9a2c609c4a080815062ffec1de..4657ad5311b625d26ac132f461f235b8d9f412c9 100644 (file)
--- a/libcitadel/lib/libcitadel.h
+++ b/libcitadel/lib/libcitadel.h
@@ -4,13 +4,12 @@
  */
 
 
-
 /*
  * since we reference time_t...
  */
 #include <time.h>
 #include <stdlib.h>
-#define LIBCITADEL_VERSION_NUMBER      108
+#define LIBCITADEL_VERSION_NUMBER      111
 
 /*
  * Here's a bunch of stupid magic to make the MIME parser portable.
@@ -177,15 +176,21 @@ void the_mime_parser(char *partnum,
 const char *GuessMimeType(char *data, size_t dlen);
 const char* GuessMimeByFilename(const char *what, size_t len);
 
-/** Run once at Programstart */
+/* Run once at Programstart */
 int LoadIconDir(const char *DirName);
-/** guess an icon to the mimetype */
+
+/* Select the icon for a given MIME type */
 const char *GetIconFilename(char *MimeType, size_t len);
+
 void ShutDownLibCitadel(void);
 
 
 /* tools */
 
+int Ctdl_IsUtf8SequenceStart(char Char);
+int Ctdl_GetUtf8SequenceLength(char Char);
+int Ctdl_Utf8StrLen(char *str);
+char *Ctdl_Utf8StrCut(char *str, int maxlen);
 
 
 int safestrncpy(char *dest, const char *src, size_t n);
@@ -251,10 +256,10 @@ char *vcard_serialize(struct vCard *);
 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
 void remove_charset_attribute(char *strbuf);
 
-/**
- * Citadels Hashlist Implementation
+/*
+ * Hash list implementation for Citadel
  */
-
+#define HKEY(a) a, sizeof(a) - 1
 typedef struct HashList HashList;
 
 typedef struct HashKey HashKey;
@@ -264,20 +269,26 @@ typedef struct HashPos HashPos;
 typedef void (*DeleteHashDataFunc)(void * Data);
 typedef const char *(*PrintHashContent)(void * Data);
 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
+typedef int (*HashFunc)(const char *Str, long Len);
+typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
+typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
 
-HashList *NewHash(void);
+HashList *NewHash(int Uniq, HashFunc F);
 
 void DeleteHash(HashList **Hash);
 
 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
 
-void Put(HashList *Hash, char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
+void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
 
 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
 
 int GetHashKeys(HashList *Hash, char ***List);
 
-int PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
+int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
+
+
+int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
 
 HashPos *GetNewHashPos(void);
 
@@ -285,9 +296,43 @@ void DeleteHashPos(HashPos **DelMe);
 
 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, char **HashKey, void **Data);
 
-void SortByHashKey(HashList *Hash);
+void SortByHashKey(HashList *Hash, int Order);
 void SortByHashKeyStr(HashList *Hash);
 
 const void *GetSearchPayload(const void *HashVoid);
 void SortByPayload(HashList *Hash, CompareFunc SortBy);
 
+void convert_spaces_to_underscores(char *str);
+
+/*
+ * Convert 4 bytes char into an Integer.
+ * usefull for easy inexpensive hashing 
+ * of for char strings.
+ */
+#define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
+
+/* vNote implementation */
+
+#define CTDL_VNOTE_MAGIC       0xa1fa
+
+struct vnote {
+       int magic;
+       char *uid;
+       char *summary;
+       char *body;
+       int pos_left;
+       int pos_top;
+       int pos_width;
+       int pos_height;
+       int color_red;
+       int color_green;
+       int color_blue;
+};
+
+
+
+struct vnote *vnote_new(void);
+struct vnote *vnote_new_from_str(char *s);
+void vnote_free(struct vnote *v);
+char *vnote_serialize(struct vnote *v);
+void vnote_serialize_output_field(char *append_to, char *field, char *label);