isomorfeus-ferret 0.17.2 → 0.17.4

data/ext/isomorfeus_ferret_ext/frt_search.h

@@ -68,7 +68,7 @@ extern FrtMatchVector *frt_matchv_compact_with_breaks(FrtMatchVector *self);
  ***************************************************************************/
 
 typedef struct FrtHit {
-    int   doc;
+    int   doc_num;
     float score;
 } FrtHit;
 
@@ -504,7 +504,7 @@ struct FrtSpanEnum {
     FrtQuery *query;
     bool     (*next)(FrtSpanEnum *self);
     bool     (*skip_to)(FrtSpanEnum *self, int target_doc);
-    int      (*doc)(FrtSpanEnum *self);
+    int      (*doc_num)(FrtSpanEnum *self);
     int      (*start)(FrtSpanEnum *self);
     int      (*end)(FrtSpanEnum *self);
     char     *(*to_s)(FrtSpanEnum *self);
@@ -645,7 +645,7 @@ extern FrtQuery *frt_spanprq_new(ID field, const char *prefix);
 
 struct FrtScorer {
     FrtSimilarity  *similarity;
-    int            doc;
+    int            doc_num;
     float          (*score)(FrtScorer *self);
     bool           (*next)(FrtScorer *self);
     bool           (*skip_to)(FrtScorer *self, int doc_num);
@@ -795,7 +795,7 @@ struct FrtSearcher {
     int            (*doc_freq)(FrtSearcher *self, ID field, const char *term);
     FrtDocument    *(*get_doc)(FrtSearcher *self, int doc_num);
     FrtLazyDoc     *(*get_lazy_doc)(FrtSearcher *self, int doc_num);
-    int            (*max_doc)(FrtSearcher *self);
+    int            (*max_doc_num)(FrtSearcher *self);
     FrtWeight      *(*create_weight)(FrtSearcher *self, FrtQuery *query);
     FrtTopDocs     *(*search)(FrtSearcher *self, FrtQuery *query, int first_doc, int num_docs, FrtFilter *filter, FrtSort *sort, FrtPostFilter *post_filter, bool load_fields);
     FrtTopDocs     *(*search_w)(FrtSearcher *self, FrtWeight *weight, int first_doc, int num_docs, FrtFilter *filter, FrtSort *sort, FrtPostFilter *post_filter, bool load_fields);
@@ -822,7 +822,7 @@ struct FrtSearcher {
 
 #define frt_searcher_get_doc(s, dn)         s->get_doc(s, dn)
 #define frt_searcher_get_lazy_doc(s, dn)    s->get_lazy_doc(s, dn)
-#define frt_searcher_max_doc(s)             s->max_doc(s)
+#define frt_searcher_max_doc(s)             s->max_doc_num(s)
 #define frt_searcher_rewrite(s, q)          s->rewrite(s, q)
 #define frt_searcher_explain(s, q, dn)      s->explain(s, q, dn)
 #define frt_searcher_close(s)               s->close(s)
@@ -868,7 +868,7 @@ typedef struct FrtMultiSearcher {
     int         s_cnt;
     FrtSearcher **searchers;
     int         *starts;
-    int         max_doc;
+    int         max_doc_num;
 } FrtMultiSearcher;
 
 extern FrtSearcher *frt_msea_alloc(void);

data/ext/isomorfeus_ferret_ext/frt_similarity.c

@@ -20,20 +20,17 @@ FrtTerm *frt_term_new(ID field, const char *text) {
     return t;
 }
 
-void frt_term_destroy(FrtTerm *self)
-{
+void frt_term_destroy(FrtTerm *self) {
     free(self->text);
     free(self);
 }
 
-int frt_term_eq(const void *t1, const void *t2)
-{
+int frt_term_eq(const void *t1, const void *t2) {
     return ((strcmp(((FrtTerm *)t1)->text, ((FrtTerm *)t2)->text) == 0) &&
         (((FrtTerm *)t1)->field == ((FrtTerm *)t2)->field));
 }
 
-unsigned long long frt_term_hash(const void *t)
-{
+unsigned long long frt_term_hash(const void *t) {
     return frt_str_hash(((FrtTerm *)t)->text) * frt_str_hash(rb_id2name(((FrtTerm *)t)->field));
 }
 
@@ -49,27 +46,24 @@ static float simdef_length_norm(FrtSimilarity *s, ID field, int num_terms) {
     return (float)(1.0 / sqrt(num_terms));
 }
 
-static float simdef_query_norm(struct FrtSimilarity *s, float sum_of_squared_weights)
-{
+static float simdef_query_norm(struct FrtSimilarity *s, float sum_of_squared_weights) {
     (void)s;
     return (float)(1.0 / sqrt(sum_of_squared_weights));
 }
 
-static float simdef_tf(struct FrtSimilarity *s, float freq)
-{
+static float simdef_tf(struct FrtSimilarity *s, float freq) {
     (void)s;
     return (float)sqrt(freq);
 }
 
-static float simdef_sloppy_freq(struct FrtSimilarity *s, int distance)
-{
+static float simdef_sloppy_freq(struct FrtSimilarity *s, int distance) {
     (void)s;
     return (float)(1.0 / (double)(distance + 1));
 }
 
 static float simdef_idf_term(struct FrtSimilarity *s, ID field, char *term, FrtSearcher *searcher) {
     return s->idf(s, searcher->doc_freq(searcher, field, term),
-                  searcher->max_doc(searcher));
+                  searcher->max_doc_num(searcher));
 }
 
 static float simdef_idf_phrase(struct FrtSimilarity *s, ID field, FrtPhrasePosition *positions, int pp_cnt, FrtSearcher *searcher) {
@@ -84,31 +78,26 @@ static float simdef_idf_phrase(struct FrtSimilarity *s, ID field, FrtPhrasePosit
     return idf;
 }
 
-static float simdef_idf(struct FrtSimilarity *s, int doc_freq, int num_docs)
-{
+static float simdef_idf(struct FrtSimilarity *s, int doc_freq, int num_docs) {
     (void)s;
     return (float)(log((float)num_docs/(float)(doc_freq+1)) + 1.0);
 }
 
-static float simdef_coord(struct FrtSimilarity *s, int overlap, int max_overlap)
-{
+static float simdef_coord(struct FrtSimilarity *s, int overlap, int max_overlap) {
     (void)s;
     return (float)((double)overlap / (double)max_overlap);
 }
 
-static float simdef_decode_norm(struct FrtSimilarity *s, frt_uchar b)
-{
+static float simdef_decode_norm(struct FrtSimilarity *s, frt_uchar b) {
     return s->norm_table[b];
 }
 
-static frt_uchar simdef_encode_norm(struct FrtSimilarity *s, float f)
-{
+static frt_uchar simdef_encode_norm(struct FrtSimilarity *s, float f) {
     (void)s;
     return frt_float2byte(f);
 }
 
-static void simdef_destroy(FrtSimilarity *s)
-{
+static void simdef_destroy(FrtSimilarity *s) {
     (void)s;
     /* nothing to do here */
 }

data/ext/isomorfeus_ferret_ext/frt_similarity.h

@@ -25,8 +25,7 @@ extern unsigned long long frt_term_hash(const void *t);
  *
  ***************************************************************************/
 
-typedef struct FrtPhrasePosition
-{
+typedef struct FrtPhrasePosition {
     int pos;
     char **terms;
 } FrtPhrasePosition;

data/ext/isomorfeus_ferret_ext/frt_sort.c

@@ -145,12 +145,12 @@ FrtSortField *FRT_SORT_FIELD_SCORE_REV;
 
 void frt_sort_field_doc_get_val(void *index, FrtHit *hit, FrtComparable *comparable) {
     (void)index;
-    comparable->val.l = hit->doc;
+    comparable->val.l = hit->doc_num;
 }
 
 int frt_sort_field_doc_compare(void *index_ptr, FrtHit *hit1, FrtHit *hit2) {
-    int val1 = hit1->doc;
-    int val2 = hit2->doc;
+    int val1 = hit1->doc_num;
+    int val2 = hit2->doc_num;
     (void)index_ptr;
 
     if (val1 > val2) return 1;
@@ -174,12 +174,12 @@ FrtSortField *FRT_SORT_FIELD_DOC_REV;
  ***************************************************************************/
 
 static void sf_byte_get_val(void *index, FrtHit *hit, FrtComparable *comparable) {
-    comparable->val.l = ((long *)index)[hit->doc];
+    comparable->val.l = ((long *)index)[hit->doc_num];
 }
 
 static int sf_byte_compare(void *index, FrtHit *hit1, FrtHit *hit2) {
-    long val1 = ((long *)index)[hit1->doc];
-    long val2 = ((long *)index)[hit2->doc];
+    long val1 = ((long *)index)[hit1->doc_num];
+    long val2 = ((long *)index)[hit2->doc_num];
     if (val1 > val2) return 1;
     else if (val1 < val2) return -1;
     else return 0;
@@ -198,12 +198,12 @@ FrtSortField *frt_sort_field_byte_new(ID field, bool reverse) {
  ***************************************************************************/
 
 static void sf_int_get_val(void *index, FrtHit *hit, FrtComparable *comparable) {
-    comparable->val.l = ((long *)index)[hit->doc];
+    comparable->val.l = ((long *)index)[hit->doc_num];
 }
 
 static int sf_int_compare(void *index, FrtHit *hit1, FrtHit *hit2) {
-    long val1 = ((long *)index)[hit1->doc];
-    long val2 = ((long *)index)[hit2->doc];
+    long val1 = ((long *)index)[hit1->doc_num];
+    long val2 = ((long *)index)[hit2->doc_num];
     if (val1 > val2) return 1;
     else if (val1 < val2) return -1;
     else return 0;
@@ -222,12 +222,12 @@ FrtSortField *frt_sort_field_int_new(ID field, bool reverse) {
  ***************************************************************************/
 
 static void sf_float_get_val(void *index, FrtHit *hit, FrtComparable *comparable) {
-    comparable->val.f = ((float *)index)[hit->doc];
+    comparable->val.f = ((float *)index)[hit->doc_num];
 }
 
 static int sf_float_compare(void *index, FrtHit *hit1, FrtHit *hit2) {
-    float val1 = ((float *)index)[hit1->doc];
-    float val2 = ((float *)index)[hit2->doc];
+    float val1 = ((float *)index)[hit1->doc_num];
+    float val2 = ((float *)index)[hit2->doc_num];
     if (val1 > val2) return 1;
     else if (val1 < val2) return -1;
     else return 0;
@@ -248,14 +248,14 @@ FrtSortField *frt_sort_field_float_new(ID field, bool reverse) {
 static void sf_string_get_val(void *index, FrtHit *hit, FrtComparable *comparable) {
     comparable->val.s
         = ((FrtStringIndex *)index)->values[
-        ((FrtStringIndex *)index)->index[hit->doc]];
+        ((FrtStringIndex *)index)->index[hit->doc_num]];
 }
 
 static int sf_string_compare(void *index, FrtHit *hit1, FrtHit *hit2) {
     char *s1 = ((FrtStringIndex *)index)->values[
-        ((FrtStringIndex *)index)->index[hit1->doc]];
+        ((FrtStringIndex *)index)->index[hit1->doc_num]];
     char *s2 = ((FrtStringIndex *)index)->values[
-        ((FrtStringIndex *)index)->index[hit2->doc]];
+        ((FrtStringIndex *)index)->index[hit2->doc_num]];
 
     if (s1 == NULL) return s2 ? 1 : 0;
     if (s2 == NULL) return -1;
@@ -427,7 +427,7 @@ static bool fshq_lt(Sorter *sorter, FrtHit *hit1, FrtHit *hit2) {
     if (diff != 0) {
         return diff > 0;
     } else {
-        return hit1->doc > hit2->doc;
+        return hit1->doc_num > hit2->doc_num;
     }
 }
 
@@ -584,7 +584,7 @@ bool frt_fdshq_lt(FrtFieldDoc *fd1, FrtFieldDoc *fd2) {
                     else { all_equal = false; }
                     break;
                 case FRT_SORT_TYPE_DOC:
-                    if (fd1->hit.doc < fd2->hit.doc) { all_equal = false; c = true; }
+                    if (fd1->hit.doc_num < fd2->hit.doc_num) { all_equal = false; c = true; }
                     break;
                 case FRT_SORT_TYPE_INTEGER:
                     if (cmps1[i].val.l < cmps2[i].val.l) { all_equal = false; c = true; }
@@ -631,7 +631,7 @@ bool frt_fdshq_lt(FrtFieldDoc *fd1, FrtFieldDoc *fd2) {
                     else { all_equal = false; }
                     break;
                 case FRT_SORT_TYPE_DOC:
-                    if (fd1->hit.doc > fd2->hit.doc) { all_equal = false; c = true; }
+                    if (fd1->hit.doc_num > fd2->hit.doc_num) { all_equal = false; c = true; }
                     break;
                 case FRT_SORT_TYPE_INTEGER:
                     if (cmps1[i].val.l > cmps2[i].val.l) { all_equal = false; c = true; }
@@ -670,9 +670,9 @@ bool frt_fdshq_lt(FrtFieldDoc *fd1, FrtFieldDoc *fd2) {
     }
     if (all_equal) {
         if (cmps1[0].reverse) {
-            if (fd1->hit.doc > fd2->hit.doc) c = true;
+            if (fd1->hit.doc_num > fd2->hit.doc_num) c = true;
         } else {
-            if (fd1->hit.doc > fd2->hit.doc) c = true;
+            if (fd1->hit.doc_num > fd2->hit.doc_num) c = true;
         }
     }
     return c;

data/ext/isomorfeus_ferret_ext/frt_store.c

@@ -1,9 +1,6 @@
 #include "frt_store.h"
 #include <string.h>
 
-
-
-
 /*
  * TODO: add try finally
  */
@@ -18,8 +15,8 @@ void frt_with_lock(FrtLock *lock, void (*func)(void *arg), void *arg) {
 /*
  * TODO: add try finally
  */
-void frt_with_lock_name(FrtStore *store, const char *lock_name, void (*func)(void *arg), void *arg) {
-    FrtLock *lock = store->open_lock_i(store, lock_name);
+void frt_with_lock_name(FrtStore *store, const char *folder_name, const char *lock_name, void (*func)(void *arg), void *arg) {
+    FrtLock *lock = store->open_lock_i(store, folder_name, lock_name);
     if (!lock->obtain(lock)) {
         FRT_RAISE(FRT_LOCK_ERROR, "couldn't obtain lock \"%s\"", lock->name);
     }
@@ -28,20 +25,17 @@ void frt_with_lock_name(FrtStore *store, const char *lock_name, void (*func)(voi
     store->close_lock_i(lock);
 }
 
-FrtLock *frt_open_lock(FrtStore *store, const char *lockname)
-{
-    FrtLock *lock = store->open_lock_i(store, lockname);
+FrtLock *frt_open_lock(FrtStore *store, const char *folder_name, const char *lockname) {
+    FrtLock *lock = store->open_lock_i(store, folder_name, lockname);
     frt_hs_add(store->locks, lock);
     return lock;
 }
 
-void frt_close_lock(FrtLock *lock)
-{
+void frt_close_lock(FrtLock *lock) {
     frt_hs_del(lock->store->locks, lock);
 }
 
-static void frt_close_lock_i(FrtLock *lock)
-{
+static void frt_close_lock_i(FrtLock *lock) {
     lock->store->close_lock_i(lock);
 }
 
@@ -94,14 +88,12 @@ void frt_store_close(FrtStore *store) {
  * @param filename the name of the file to check
  * @return 1 (true) if the file is a lock file, 0 (false) otherwise
  */
-int frt_file_is_lock(const char *filename)
-{
+int frt_file_is_lock(const char *filename) {
     int start = (int) strlen(filename) - 4;
     return ((start > 0) && (strcmp(FRT_LOCK_EXT, &filename[start]) == 0));
 }
 
-void frt_is2os_copy_bytes(FrtInStream *is, FrtOutStream *os, int cnt)
-{
+void frt_is2os_copy_bytes(FrtInStream *is, FrtOutStream *os, int cnt) {
     int len;
     frt_uchar buf[FRT_BUFFER_SIZE];
 
@@ -112,8 +104,7 @@ void frt_is2os_copy_bytes(FrtInStream *is, FrtOutStream *os, int cnt)
     }
 }
 
-void frt_is2os_copy_vints(FrtInStream *is, FrtOutStream *os, int cnt)
-{
+void frt_is2os_copy_vints(FrtInStream *is, FrtOutStream *os, int cnt) {
     frt_uchar b;
     for (; cnt > 0; cnt--) {
         while (((b = frt_is_read_byte(is)) & 0x80) != 0) {
@@ -126,8 +117,7 @@ void frt_is2os_copy_vints(FrtInStream *is, FrtOutStream *os, int cnt)
 /**
  * Test argument used to test the store->each function
  */
-struct FileNameListArg
-{
+struct FileNameListArg {
     int count;
     int size;
     int total_len;
@@ -137,8 +127,7 @@ struct FileNameListArg
 /**
  * Test function used to test store->each function
  */
-static void add_file_name(const char *fname, void *arg)
-{
+static void add_file_name(const char *fname, void *arg) {
     struct FileNameListArg *fnl = (struct FileNameListArg *)arg;
     if (fnl->count >= fnl->size) {
         fnl->size *= 2;
@@ -148,8 +137,7 @@ static void add_file_name(const char *fname, void *arg)
     fnl->total_len += strlen(fname) + 2;
 }
 
-char *frt_store_to_s(FrtStore *store)
-{
+char *frt_store_folder_to_s(FrtStore *store, const char *folder_name) {
     struct FileNameListArg fnl;
     char *buf, *b;
     int i;
@@ -158,7 +146,7 @@ char *frt_store_to_s(FrtStore *store)
     fnl.total_len = 10;
     fnl.files = FRT_ALLOC_N(char *, 16);
 
-    store->each(store, &add_file_name, &fnl);
+    store->each(store, folder_name, &add_file_name, &fnl);
     qsort(fnl.files, fnl.count, sizeof(char *), &frt_scmp);
     b = buf = FRT_ALLOC_N(char, fnl.total_len);
 

data/ext/isomorfeus_ferret_ext/frt_store.h

@@ -21,7 +21,8 @@ typedef struct FrtStore FrtStore;
 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);
@@ -30,8 +31,9 @@ struct FrtLock {
 };
 
 typedef struct MDBXInfo {
-    MDBX_env *env;
-    char     *path;
+    MDBX_env   *env;
+    const char *path;
+    FrtStore   *temp_store;
 } MDBXInfo;
 
 struct FrtStore {
@@ -39,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;
@@ -51,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 store self
+     * @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 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
@@ -104,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
@@ -188,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.
@@ -220,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 ==
@@ -294,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
@@ -325,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