Minor.

[idzebra-moved-to-github.git] / include / bfile.h

diff --git a/include/bfile.h b/include/bfile.h
index 2262915..af8c209 100644 (file)
--- a/include/bfile.h
+++ b/include/bfile.h
@@ -1,30 +1,75 @@
 /*
- * Copyright (C) 1994, Index Data I/S 
+ * Copyright (C) 1994-1999, Index Data
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
- * $Log: bfile.h,v $
- * Revision 1.2  1994-08-17 13:32:33  adam
- * Use cache in dict - not in bfile.
- *
- * Revision 1.1  1994/08/16  16:16:02  adam
- * bfile header created.
- *
+ * $Id: bfile.h,v 1.17 1999-05-12 13:08:06 adam Exp $
  */
 
 #ifndef BFILE_H
 #define BFILE_H
-#include <util.h>
+
+#include <mfile.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define bf_blocksize(bf) mf_blocksize(bf->mf)
+
+typedef struct BFiles_struct *BFiles;
+
+BFiles bfs_create (const char *spec);
+void bfs_destroy (BFiles bfiles);
 
 typedef struct BFile_struct
 {
-    int fd;
-    int block_size;
-} *BFile;
+    MFile mf;
+    struct CFile_struct *cf;
+} *BFile, BFile_struct;
 
+/* bf_close: closes bfile.
+   returns 0 if successful; non-zero otherwise 
+ */
 int bf_close (BFile);
-BFile bf_open (const char *name, int block_size, int rw);
-int bf_read (BFile bf, int no, void *buf);
-int bf_write (BFile bf, int no, const void *buf);
+
+/* bf_open: opens bfile.
+   opens bfile with name 'name' and with 'block_size' as block size.
+   returns bfile handle is successful; NULL otherwise 
+ */
+BFile bf_open (BFiles bfs, const char *name, int block_size, int wflag);
+
+/* bf_read: reads bytes from bfile 'bf'.
+   reads 'nbytes' bytes (or whole block if 0) from offset 'offset' from
+   block 'no'. stores contents in buffer 'buf'.
+   returns 1 if whole block could be read; 0 otherwise.
+ */
+int bf_read (BFile bf, int no, int offset, int nbytes, void *buf);
+
+/* bf_write: writes bytes to bfile 'bf'.
+   writes 'nbytes' bytes (or whole block if 0) at offset 'offset' to
+   block 'no'. retrieves contents from buffer 'buf'.
+   returns 0 if successful; non-zero otherwise.
+ */
+int bf_write (BFile bf, int no, int offset, int nbytes, const void *buf);
+
+/* bf_cache: enables bfile cache if spec is not NULL */
+void bf_cache (BFiles bfs, const char *spec);
+
+/* bf_lockDir: specifies locking directory for the cache system */
+void bf_lockDir (BFiles bfs, const char *lockDir);
+
+/* bf_commitExists: returns 1 if commit is pending; 0 otherwise */
+int bf_commitExists (BFiles bfs);
+
+/* bf_commitExec: executes commit */
+void bf_commitExec (BFiles bfs);
+
+/* bf_commitClean: cleans commit files, etc */
+void bf_commitClean (BFiles bfs, const char *spec);
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif