isomorfeus-ferret 0.17.1 → 0.17.3

data/ext/isomorfeus_ferret_ext/frt_store.h

@@ -10,142 +10,19 @@
 #define HAVE_STRUCT_IOVEC
 #endif
 #include "mdbx.h"
+#include "frt_ram_store.h"
+#include "frt_in_stream.h"
+#include "frt_out_stream.h"
 
 #define FRT_LOCK_PREFIX "ferret-"
 #define FRT_LOCK_EXT ".lck"
 
-typedef struct FrtBuffer {
-    frt_uchar buf[FRT_BUFFER_SIZE];
-    frt_off_t start;
-    frt_off_t pos;
-    frt_off_t len;
-} FrtBuffer;
-
 typedef struct FrtStore FrtStore;
-typedef struct FrtOutStream FrtOutStream;
-struct FrtOutStreamMethods {
-    /* internal functions for the FrtInStream */
-    /**
-     * Flush +len+ characters from +src+ to the output stream +os+
-     *
-     * @param os self
-     * @param src the characters to write to the output stream
-     * @param len the number of characters to write
-     * @raise FRT_IO_ERROR if there is an error writing the characters
-     */
-    void (*flush_i)(struct FrtOutStream *os, const frt_uchar *buf, int len);
-
-    /**
-     * Seek +pos+ in the output stream
-     *
-     * @param os self
-     * @param pos the position to seek in the stream
-     * @raise FRT_IO_ERROR if there is an error seeking in the output stream
-     */
-    void (*seek_i)(struct FrtOutStream *os, frt_off_t pos);
-
-    /**
-     * Close any resources used by the output stream +os+
-     *
-     * @param os self
-     * @raise FRT_IO_ERROR if there is an error closing the file
-     */
-    void (*close_i)(struct FrtOutStream *os);
-};
-
-typedef struct FrtRAMFile {
-    char        *name;
-    frt_uchar   **buffers;
-    int         bufcnt;
-    frt_off_t   len;
-    _Atomic unsigned int ref_cnt;
-} FrtRAMFile;
-
-struct FrtOutStream {
-    FrtBuffer buf;
-    frt_off_t pointer;             /* only used by RAMOut */
-    FrtStore  *store;
-    union {
-        int fd;
-        FrtRAMFile *rf;
-    } file;
-    const struct FrtOutStreamMethods *m;
-};
-
-typedef struct FrtCompoundInStream FrtCompoundInStream;
-
-typedef struct FrtInStream FrtInStream;
-
-struct FrtInStreamMethods {
-    /**
-     * Read +len+ characters from the input stream into the +offset+ position in
-     * +buf+, an array of unsigned characters.
-     *
-     * @param is self
-     * @param buf an array of characters which must be allocated with  at least
-     *          +offset+ + +len+ bytes
-     * @param len the number of bytes to read
-     * @raise FRT_IO_ERROR if there is an error reading from the input stream
-     */
-    void (*read_i)(struct FrtInStream *is, frt_uchar *buf, int len);
-
-    /**
-     * Seek position +pos+ in input stream +is+
-     *
-     * @param is self
-     * @param pos the position to seek
-     * @raise FRT_IO_ERROR if the seek fails
-     */
-    void (*seek_i)(struct FrtInStream *is, frt_off_t pos);
-
-    /**
-     * Returns the length of the input stream +is+
-     *
-     * @param is self
-     * @raise FRT_IO_ERROR if there is an error getting the file length
-     */
-    frt_off_t (*length_i)(struct FrtInStream *is);
-
-    /**
-     * Close the resources allocated to the inputstream +is+
-     *
-     * @param is self
-     * @raise FRT_IO_ERROR if the close fails
-     */
-    void (*close_i)(struct FrtInStream *is);
-};
-
-typedef struct FrtInStreamFile {
-    _Atomic unsigned int ref_cnt;
-    union {
-        int fd;
-        FrtRAMFile *rf;
-    } file;
-} FrtInStreamFile;
-
-struct FrtInStream {
-    FrtBuffer buf;
-    struct FrtInStreamFile *f;
-    union {
-        frt_off_t pointer;      /* only used by RAMIn */
-        char *path;             /* only used by FSIn */
-        FrtCompoundInStream *cis;
-    } d;
-    _Atomic unsigned int ref_cnt;
-    const struct FrtInStreamMethods *m;
-};
-
-struct FrtCompoundInStream {
-    FrtInStream *sub;
-    frt_off_t offset;
-    frt_off_t length;
-};
-
-#define frt_is_length(mis) mis->m->length_i(mis)
-
 typedef struct FrtLock FrtLock;
+
 struct FrtLock {
-    char *name;
+    const char *folder_name;
+    const char *name;
     FrtStore *store;
     int (*obtain)(FrtLock *lock);
     int (*is_locked)(FrtLock *lock);
@@ -153,16 +30,10 @@ struct FrtLock {
     VALUE rlock;
 };
 
-typedef struct FrtCompoundStore {
-    FrtStore *store;
-    const char *name;
-    FrtHash *entries;
-    FrtInStream *stream;
-} FrtCompoundStore;
-
 typedef struct MDBXInfo {
-    MDBX_env *env;
-    char     *path;
+    MDBX_env   *env;
+    const char *path;
+    FrtStore   *temp_store;
 } MDBXInfo;
 
 struct FrtStore {
@@ -170,7 +41,6 @@ struct FrtStore {
     pthread_mutex_t      mutex_i;        /* for internal use only */
     pthread_mutex_t      mutex;          /* external mutex for use outside */
     union {
-        char             *path; /* for fs_store only */
         FrtHash          *ht;   /* for ram_store only */
         MDBXInfo         *mdbx;  /* for mdbx store only */
     } dir;
@@ -182,52 +52,76 @@ struct FrtStore {
     FrtHashSet  *locks;
 
     /**
-     * Create the file +filename+ in the +store+.
+     * Create the folder +folder_name+ in the store if it
+     * doesn't exist.
+     *
+     * @param self store
+     * @param folder_name the name of the folder to create
+     * @raise FRT_IO_ERROR if the folder cannot be created
+     */
+    void (*create_folder)(FrtStore *self, const char *folder_name);
+
+    /**
+     * Remove the folder +folder_name+ from the store.
+     *
+     * @param self store
+     * @param folder_name the name of the folder to remove
+     * @raise FRT_IO_ERROR if the folder cannot be created
+     */
+    void (*remove_folder)(FrtStore *self, const char *folder_name);
+
+    /**
+     * Create the file +filename+ in the store.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param filename the name of the file to create
      * @raise FRT_IO_ERROR if the file cannot be created
      */
-    void (*touch)(FrtStore *store, const char *filename);
+    void (*touch)(FrtStore *self, const char *folder_name, const char *filename);
 
     /**
-     * Return true if a file of name +filename+ exists in +store+.
+     * Return true if a file of name +filename+ exists in store.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param filename the name of the file to check for
      * @returns true if the file exists
-     * @raise FRT_IO_ERROR if there is an error checking for the files existance
+     * @raise FRT_IO_ERROR if there is an error checking for the files existence
      */
-    int (*exists)(FrtStore *store, const char *filename);
+    int (*exists)(FrtStore *self, const char *folder_name, const char *filename);
 
     /**
-     * Remove the file +filename+ from the +store+
+     * Remove the file +filename+ from the store.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param filename the name of the file to remove
      * @returns On success, zero is returned.  On error, -1 is returned, and errno
      *          is set appropriately.
      */
-    int (*remove)(FrtStore *store, const char *filename);
+    int (*remove)(FrtStore *self, const char *folder_name, const char *filename);
 
     /**
-     * Rename the file in the +store+ from the name +from+ to the name +to+.
+     * Rename the file in the store from the name +from+ to the name +to+.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param from the name of the file to rename
      * @param to the new name of the file
      * @raise FRT_IO_ERROR if there is an error renaming the file
      */
-    void (*rename)(FrtStore *store, const char *from, const char *to);
+    void (*rename)(FrtStore *self, const char *folder_name, const char *from, const char *to);
 
     /**
      * Returns the number of files in the store.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @return the number of files in the store
      * @raise FRT_IO_ERROR if there is an error opening the directory
      */
-    int (*count)(FrtStore *store);
+    int (*count)(FrtStore *self, const char *folder_name);
 
     /**
      * Call the function +func+ with each filename in the store and the arg
@@ -235,80 +129,87 @@ struct FrtStore {
      * as the argument. If you need to pass more than one argument, you should
      * pass a struct.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param func the function to call with each files name and the +arg+
      *   passed
      * @param arg the argument to pass to the function
      * @raise FRT_IO_ERROR if there is an error opening the directory
      */
-    void (*each)(FrtStore *store, void (*func)(const char *fname, void *arg),
-                  void *arg);
+    void (*each)(FrtStore *self, const char *folder_name, void (*func)(const char *fname, void *arg), void *arg);
 
     /**
      * Clear all the locks in the store.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @raise FRT_IO_ERROR if there is an error opening the directory
      */
-    void (*clear_locks)(FrtStore *store);
+    void (*clear_locks)(FrtStore *self, const char *folder_name);
 
     /**
      * Clear all files from the store except the lock files.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @raise FRT_IO_ERROR if there is an error deleting the files
      */
-    void (*clear)(FrtStore *store);
+    void (*clear)(FrtStore *self, const char *folder_name);
 
     /**
      * Clear all files from the store including the lock files.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @raise FRT_IO_ERROR if there is an error deleting the files
      */
-    void (*clear_all)(FrtStore *store);
+    void (*clear_all)(FrtStore *self, const char *folder_name);
 
     /**
-     * Return the length of the file +filename+ in +store+
+     * Return the length of the file +filename+ in +store+.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param the name of the file to check the length of
      * @return the length of the file in bytes
      * @raise FRT_IO_ERROR if there is an error checking the file length
      */
-    frt_off_t (*length)(FrtStore *store, const char *filename);
+    frt_off_t (*length)(FrtStore *self, const char *folder_name, const char *filename);
 
     /**
      * Allocate the resources needed for the output stream in the +store+ with
-     * the name +filename+
+     * the name +filename+.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param filename the name of the output stream
-     * @return a newly allocated filestream
+     * @return a newly allocated file stream
      * @raise FRT_IO_ERROR if there is an error opening the output stream
      *   resources
      */
-    FrtOutStream *(*new_output)(FrtStore *store, const char *filename);
+    FrtOutStream *(*new_output)(FrtStore *self, const char *folder_name, const char *filename);
 
     /**
-     * Open an input stream in the +store+ with the name +filename+
+     * Open an input stream in the +store+ with the name +filename+.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param filename the name of the input stream
      * @raise FRT_FILE_NOT_FOUND_ERROR if the input stream cannot be opened
      */
-    FrtInStream *(*open_input)(FrtStore *store, const char *filename);
+    FrtInStream *(*open_input)(FrtStore *self, const char *folder_name, const char *filename);
 
     /**
-     * Obtain a lock on the lock +lock+
+     * Obtain a lock on the lock +lock+.
      *
-     * @param store self
+     * @param self store
+     * @param folder_name the name of the folder
      * @param lock the lock to obtain
      */
-    FrtLock *(*open_lock_i)(FrtStore *store, const char *lockname);
+    FrtLock *(*open_lock_i)(FrtStore *self, const char *folder_name, const char *lockname);
 
     /**
-     * Returns true if +lock+ is locked. To test if the file is locked:wq
+     * Returns true if +lock+ is locked. To test if the file is locked:wq.
      *
      * @param lock the lock to test
      * @raise FRT_IO_ERROR if there is an error detecting the lock status
@@ -319,9 +220,9 @@ struct FrtStore {
      * Internal function to close the store freeing implementation specific
      * resources.
      *
-     * @param store self
+     * @param self store
      */
-    void (*close_i)(FrtStore *store);
+    void (*close_i)(FrtStore *self);
 
     /**
      * Reference to be used within ruby realm.
@@ -351,12 +252,13 @@ extern FrtStore *frt_open_ram_store(FrtStore *new_store);
  * method would be used for example to read an index into memory for faster
  * searching.
  *
- * @param store the whose contents will be copied into the newly allocated RAM
- *   store
- * @param close_store close the store whose contents where copied
+ * @param to_store the target store
+ * @param from_store the store, whose contents will be copied into the newly allocated RAM store
+ * @param folder_name folder to be copied, will be create in the target store, if it doesn't exist
+ * @param close_store close the from_store whose contents where copied
  * @return a newly allocated RAM FrtStore.
  */
-extern FrtStore *frt_open_ram_store_and_copy(FrtStore *store, FrtStore *from_store, bool close_store);
+extern FrtStore *frt_open_ram_store_and_copy(FrtStore *to_store, FrtStore *from_store, const char *folder_name, bool close_store);
 
 /*
  * == RamStore functions ==
@@ -425,7 +327,7 @@ extern void frt_with_lock(FrtLock *lock, void (*func)(void *arg), void *arg);
  * @raise FRT_IO_ERROR  if the lock is already locked
  * @see frt_with_lock
  */
-extern void frt_with_lock_name(FrtStore *store, const char *lock_name, void (*func)(void *arg), void *arg);
+extern void frt_with_lock_name(FrtStore *store, const char *folder_name, const char *lock_name, void (*func)(void *arg), void *arg);
 
 /**
  * Remove a reference to the store. If the reference count gets to zero free
@@ -435,314 +337,6 @@ extern void frt_with_lock_name(FrtStore *store, const char *lock_name, void (*fu
  */
 extern void frt_store_close(FrtStore *store);
 
-/**
- * Flush the buffered contents of the FrtOutStream to the store.
- *
- * @param os the FrtOutStream to flush
- */
-extern void frt_os_flush(FrtOutStream *os);
-
-/**
- * Close the FrtOutStream after flushing the buffers, also freeing all allocated
- * resources.
- *
- * @param os the FrtOutStream to close
- */
-extern void frt_os_close(FrtOutStream *os);
-
-/**
- * Return the current position of FrtOutStream +os+.
- *
- * @param os the FrtOutStream to get the position from
- * @return the current position in FrtOutStream +os+
- */
-extern frt_off_t frt_os_pos(FrtOutStream *os);
-
-/**
- * Set the current position in FrtOutStream +os+.
- *
- * @param os the FrtOutStream to set the position in
- * @param pos the new position in the FrtOutStream
- * @raise FRT_IO_ERROR if there is a file-system IO error seeking the file
- */
-extern void frt_os_seek(FrtOutStream *os, frt_off_t new_pos);
-
-/**
- * Write a single byte +b+ to the FrtOutStream +os+
- *
- * @param os the FrtOutStream to write to @param b  the byte to write @raise
- * FRT_IO_ERROR if there is an IO error writing to the file-system
- */
-extern void frt_os_write_byte(FrtOutStream *os, frt_uchar b);
-/**
- * Write +len+ bytes from buffer +buf+ to the FrtOutStream +os+.
- *
- * @param os  the FrtOutStream to write to
- * @param len the number of bytes to write
- * @param buf the buffer from which to get the bytes to write.
- * @raise FRT_IO_ERROR if there is an IO error writing to the file-system
- */
-extern void frt_os_write_bytes(FrtOutStream *os, const frt_uchar *buf, int len);
-
-/**
- * Write a 32-bit signed integer to the FrtOutStream
- *
- * @param os FrtOutStream to write to
- * @param num the 32-bit signed integer to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_i32(FrtOutStream *os, frt_i32 num);
-
-/**
- * Write a 64-bit signed integer to the FrtOutStream
- *
- *
- * @param os FrtOutStream to write to
- * @param num the 64-bit signed integer to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_i64(FrtOutStream *os, frt_i64 num);
-
-/**
- * Write a 32-bit unsigned integer to the FrtOutStream
- *
- * @param os FrtOutStream to write to
- * @param num the 32-bit unsigned integer to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_u32(FrtOutStream *os, frt_u32 num);
-
-/**
- * Write a 64-bit unsigned integer to the FrtOutStream
- *
- * @param os FrtOutStream to write to
- * @param num the 64-bit unsigned integer to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_u64(FrtOutStream *os, frt_u64 num);
-
-/**
- * Write an unsigned integer to FrtOutStream in compressed VINT format.
- * TODO: describe VINT format
- *
- * @param os FrtOutStream to write to
- * @param num the integer to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_vint(FrtOutStream *os, register unsigned int num);
-
-/**
- * Write an unsigned frt_off_t to FrtOutStream in compressed VINT format.
- * TODO: describe VINT format
- *
- * @param os FrtOutStream to write to
- * @param num the frt_off_t to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_voff_t(FrtOutStream *os, register frt_off_t num);
-
-/**
- * Write an unsigned 64bit int to FrtOutStream in compressed VINT format.
- * TODO: describe VINT format
- *
- * @param os FrtOutStream to write to
- * @param num the 64bit int to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_vll(FrtOutStream *os, register frt_u64 num);
-
-/**
- * Write a string with known length to the FrtOutStream. A string is an
- * integer +length+ in VINT format (see frt_os_write_vint) followed by
- * +length+ bytes. The string can then be read using frt_is_read_string.
- *
- * @param os FrtOutStream to write to
- * @param str the string to write
- * @param len the length of the string to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_string_len(FrtOutStream *os,
-                                               const char *str,
-                                               int len);
-
-/**
- * Write a string to the FrtOutStream. A string is an integer +length+ in VINT
- * format (see frt_os_write_vint) followed by +length+ bytes. The string can then
- * be read using frt_is_read_string.
- *
- * @param os FrtOutStream to write to
- * @param str the string to write
- * @raise FRT_IO_ERROR if there is an error writing to the file-system
- */
-extern void frt_os_write_string(FrtOutStream *os, const char *str);
-
-/**
- * Get the current position within an FrtInStream.
- *
- * @param is the FrtInStream to get the current position from
- * @return the current position within the FrtInStream +is+
- */
-extern frt_off_t frt_is_pos(FrtInStream *is);
-
-/**
- * Set the current position in FrtInStream +is+ to +pos+.
- *
- * @param is the FrtInStream to set the current position in
- * @param pos the position in FrtInStream to seek
- * @raise FRT_IO_ERROR if there is a error seeking from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to seek past the end of the file
- */
-extern void frt_is_seek(FrtInStream *is, frt_off_t pos);
-
-/**
- * Close the FrtInStream freeing all allocated resources.
- *
- * @param is the FrtInStream to close
- * @raise FRT_IO_ERROR if there is an error closing the associated file
- */
-extern void frt_is_close(FrtInStream *is);
-
-/**
- * Clone the FrtInStream allocating a new FrtInStream structure
- *
- * @param is the FrtInStream to clone
- * @return a newly allocated FrtInStream which is a clone of +is+
- */
-extern FrtInStream *frt_is_clone(FrtInStream *is);
-
-/**
- * Read a singly byte (unsigned char) from the FrtInStream +is+.
- *
- * @param is the Instream to read from
- * @return a single unsigned char read from the FrtInStream +is+
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern frt_uchar frt_is_read_byte(FrtInStream *is);
-
-/**
- * Read +len+ bytes from FrtInStream +is+ and write them to buffer +buf+
- *
- * @param is     the FrtInStream to read from
- * @param buf    the buffer to read into, that is copy the bytes read to
- * @param len    the number of bytes to read
- * @return       the resultant buffer +buf+
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern frt_uchar *frt_is_read_bytes(FrtInStream *is, frt_uchar *buf, int len);
-
-/**
- * Read a 32-bit unsigned integer from the FrtInStream.
- *
- * @param is the FrtInStream to read from
- * @return a 32-bit unsigned integer
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern frt_i32 frt_is_read_i32(FrtInStream *is);
-
-/**
- * Read a 64-bit unsigned integer from the FrtInStream.
- *
- * @param is the FrtInStream to read from
- * @return a 64-bit unsigned integer
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern frt_i64 frt_is_read_i64(FrtInStream *is);
-
-/**
- * Read a 32-bit signed integer from the FrtInStream.
- *
- * @param is the FrtInStream to read from
- * @return a 32-bit signed integer
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern frt_u32 frt_is_read_u32(FrtInStream *is);
-
-/**
- * Read a 64-bit signed integer from the FrtInStream.
- *
- * @param is the FrtInStream to read from
- * @return a 64-bit signed integer
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern frt_u64 frt_is_read_u64(FrtInStream *is);
-
-/**
- * Read a compressed (VINT) unsigned integer from the FrtInStream.
- * TODO: describe VINT format
- *
- * @param is the FrtInStream to read from
- * @return an int
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern unsigned int frt_is_read_vint(FrtInStream *is);
-
-/**
- * Skip _cnt_ vints. This is a convenience method used for performance reasons
- * to skip large numbers of vints. It is mostly used by TermDocEnums. When
- * skipping positions os the proximity index file.
- *
- * @param is the FrtInStream to read from
- * @param cnt the number of vints to skip
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern void frt_is_skip_vints(FrtInStream *is, register int cnt);
-
-/**
- * Read a compressed (VINT) unsigned frt_off_t from the FrtInStream.
- * TODO: describe VINT format
- *
- * @param is the FrtInStream to read from
- * @return a frt_off_t
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern frt_off_t frt_is_read_voff_t(FrtInStream *is);
-
-/**
- * Read a compressed (VINT) unsigned 64bit int from the FrtInStream.
- * TODO: describe VINT format
- *
- * @param is the FrtInStream to read from
- * @return a 64bit int
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern frt_u64 frt_is_read_vll(FrtInStream *is);
-
-/**
- * Read a string from the FrtInStream. A string is an integer +length+ in vint
- * format (see frt_is_read_vint) followed by +length+ bytes. This is the format
- * used by frt_os_write_string.
- *
- * @param is the FrtInStream to read from
- * @return a null byte delimited string
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern char *frt_is_read_string(FrtInStream *is);
-
-/**
- * Read a string from the FrtInStream. A string is an integer +length+ in vint
- * format (see frt_is_read_vint) followed by +length+ bytes. This is the format
- * used by frt_os_write_string. This method is similar to +frt_is_read_string+ except
- * that it will safely free all memory if there is an error reading the
- * string.
- *
- * @param is the FrtInStream to read from
- * @return a null byte delimited string
- * @raise FRT_IO_ERROR if there is a error reading from the file-system
- * @raise FRT_EOF_ERROR if there is an attempt to read past the end of the file
- */
-extern char *frt_is_read_string_safe(FrtInStream *is);
-
 /**
  * Copy cnt bytes from Instream _is_ to FrtOutStream _os_.
  *
@@ -764,13 +358,14 @@ extern void frt_is2os_copy_bytes(FrtInStream *is, FrtOutStream *os, int cnt);
 extern void frt_is2os_copy_vints(FrtInStream *is, FrtOutStream *os, int cnt);
 
 /**
- * Print the filenames in a store to a buffer.
+ * Print the filenames in a store folder to a buffer.
  *
  * @param store the store to get the filenames from
+ * @param folder_name the folder to get the filenames from
  */
-extern char *frt_store_to_s(FrtStore *store);
+extern char *frt_store_folder_to_s(FrtStore *store, const char *folder_name);
 
-extern FrtLock *frt_open_lock(FrtStore *store, const char *lockname);
+extern FrtLock *frt_open_lock(FrtStore *store, const char *folder_name, const char *lockname);
 extern void frt_close_lock(FrtLock *lock);
 
 /* required by submodules