isomorfeus-ferret 0.17.1 → 0.17.2

data/ext/isomorfeus_ferret_ext/frt_out_stream.h

@@ -0,0 +1,198 @@
+#ifndef FRT_OUT_STREAM_H
+#define FRT_OUT_STREAM_H
+
+#include "frt_global.h"
+#include "frt_ram_store.h"
+
+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);
+};
+
+struct FrtOutStream {
+    FrtBuffer buf;
+    frt_off_t pointer;             /* only used by RAMOut */
+    FrtStore  *store;
+    union {
+        int fd;
+        FrtRAMFile *rf;
+    } file;
+    const struct FrtOutStreamMethods *m;
+};
+
+
+/**
+ * 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);
+
+extern int frt_os_write_compressed_bytes(FrtOutStream* out_stream, frt_uchar *data, int length, FrtCompressionType compression);
+
+#endif

data/ext/isomorfeus_ferret_ext/frt_ram_store.h

@@ -0,0 +1,12 @@
+#ifndef FRT_RAM_STORE_H
+#define FRT_RAM_STORE_H
+
+typedef struct FrtRAMFile {
+    char        *name;
+    frt_uchar   **buffers;
+    int         bufcnt;
+    frt_off_t   len;
+    _Atomic unsigned int ref_cnt;
+} FrtRAMFile;
+
+#endif