/*
- * Copyright (C) 1994-1995, Index Data I/S
+ * Copyright (C) 1994-1997, Index Data I/S
* All rights reserved.
* Sebastian Hammer, Adam Dickmeiss
*
* $Log: bfile.h,v $
- * Revision 1.12 1996-03-26 16:00:44 adam
+ * Revision 1.15 1997-09-17 12:19:07 adam
+ * Zebra version corresponds to YAZ version 1.4.
+ * Changed Zebra server so that it doesn't depend on global common_resource.
+ *
+ * Revision 1.14 1997/09/05 15:29:58 adam
+ * Changed prototype for chr_map_input - added const.
+ * Added support for C++, headers uses extern "C" for public definitions.
+ *
+ * Revision 1.13 1996/10/29 13:43:07 adam
+ * Added a few comments.
+ *
+ * Revision 1.12 1996/03/26 16:00:44 adam
* The directory of the shadow table can be specified by the new
* bf_lockDir call.
*
#ifndef BFILE_H
#define BFILE_H
-#include <alexutil.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
{
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 wflag);
+
+/* 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 'num' 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 num, void *buf);
+
+/* bf_write: writes bytes to bfile 'bf'.
+ writes 'num' 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 num, const void *buf);
-void bf_cache (int enableFlag);
-void bf_lockDir (const char *lockDir);
-int bf_commitExists (void);
-void bf_commitExec (void);
-void bf_commitClean (void);
+
+/* 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