ruby-brs 1.0.1 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 779dc2709fa1dc4c1316cafb41ec7ca289ddab6e3e93302c8c9d730d5e13062c
-  data.tar.gz: b9e44118ae67ccc3ddc80a4976c946ef1b4d0801192b5b2f7f286bbf7b6f1446
+  metadata.gz: 169f9d5837ac233e808610055a4edee6c5e133c78bd1047e951c218bd731e74d
+  data.tar.gz: bd9ddc4653f00f5a5dd855a14f5c2b8013fd90ffce741334f523197621cacb15
 SHA512:
-  metadata.gz: fd2f3127fa61d8e5d1523c331edbb96823976622d81ba61ff4d10965ed9f536773a2abbea59c3fd1a03b9d6df9b4fbe9662a0d47cdaed5aa19e481544cc9952a
-  data.tar.gz: d487532c19995e7307f68b1b5ccc091e9445e02b8a53c3c9039765e8fbb6dd11960563d6860aaba236dc7b7b424674d12f471163cd52940511dbd4803799a250
+  metadata.gz: 1f7014703dbf00857e5c829aef7742c85d6251858047ed7bb234ec6b18c433615a5c72f0a48ce943cd34c9074f4104af23077beb27763ad6d8d68aa2a0cace6a
+  data.tar.gz: 581c2b4e7d0b2cbab7c8b54427c05305238ecda8ef8e6f1a98493e01176f7e98b5a0f1009ec2f95beeb54ed6562511a08994ae24d7f75d0fed4ac7017f7eb21c

data/README.md

@@ -1,13 +1,14 @@
 # Ruby bindings for brotli library
 
-[![Travis build status](https://travis-ci.org/andrew-aladev/ruby-brs.svg?branch=master)](https://travis-ci.org/andrew-aladev/ruby-brs)
-[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-brs?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-brs/branch/master)
+| Travis | AppVeyor | Circle | Codecov |
+| :---:  | :---:    | :---:  | :---:   |
+| [![Travis test status](https://travis-ci.com/andrew-aladev/ruby-brs.svg?branch=master)](https://travis-ci.com/andrew-aladev/ruby-brs) | [![AppVeyor test status](https://ci.appveyor.com/api/projects/status/github/andrew-aladev/ruby-brs?branch=master&svg=true)](https://ci.appveyor.com/project/andrew-aladev/ruby-brs/branch/master) | [![Circle test status](https://circleci.com/gh/andrew-aladev/ruby-brs/tree/master.svg?style=shield)](https://circleci.com/gh/andrew-aladev/ruby-brs/tree/master) | [![Codecov](https://codecov.io/gh/andrew-aladev/ruby-brs/branch/master/graph/badge.svg)](https://codecov.io/gh/andrew-aladev/ruby-brs) |
 
 See [brotli library](https://github.com/google/brotli).
 
 ## Installation
 
-Please install brotli library first.
+Please install brotli library first, use latest 1.0.0+ version.
 
 ```sh
 gem install ruby-brs
@@ -20,6 +21,8 @@ rake gem
 gem install pkg/ruby-brs-*.gem
 ```
 
+You can also use [overlay](https://github.com/andrew-aladev/overlay) for gentoo.
+
 ## Usage
 
 There are simple APIs: `String` and `File`. Also you can use generic streaming API: `Stream::Writer` and `Stream::Reader`.
@@ -35,6 +38,27 @@ BRS::File.decompress "file.txt.br", "file.txt"
 
 BRS::Stream::Writer.open("file.txt.br") { |writer| writer << "sample string" }
 puts BRS::Stream::Reader.open("file.txt.br") { |reader| reader.read }
+
+writer = BRS::Stream::Writer.new output_socket
+begin
+  bytes_written = writer.write_nonblock "sample string"
+  # handle "bytes_written"
+rescue IO::WaitWritable
+  # handle wait
+ensure
+  writer.close
+end
+
+reader = BRS::Stream::Reader.new input_socket
+begin
+  puts reader.read_nonblock(512)
+rescue IO::WaitReadable
+  # handle wait
+rescue ::EOFError
+  # handle eof
+ensure
+  reader.close
+end
 ```
 
 You can create and read `tar.br` archives with `minitar` for example.
@@ -61,72 +85,38 @@ end
 
 ## Options
 
-Each API supports several options:
-
-```
-:source_buffer_length
-:destination_buffer_length
-```
+| Option                             | Values       | Default      | Description |
+|------------------------------------|--------------|--------------|-------------|
+| `source_buffer_length`             | `0 - inf`    | `0 (auto)`   | internal buffer length for source data |
+| `destination_buffer_length`        | `0 - inf`    | `0 (auto)`   | internal buffer length for description data |
+| `mode`                             | `MODES`      | `:generic`   | compressor mode |
+| `quality`                          | `0 - 11`     | `11`         | compression level |
+| `lgwin`                            | `10 - 24`    | `22`         | compressor window size |
+| `lgblock`                          | `16 - 24`    | `nil (auto)` | compressor input block size |
+| `disable_literal_context_modeling` | `true/false` | `false`      | disables literal context modeling format |
+| `disable_ring_buffer_reallocation` | `true/false` | `false`      | disables ring buffer reallocation |
+| `size_hint`                        | `0 - inf`    | `0 (auto)`   | size of input (if known) |
+| `large_window`                     | `true/false` | `false`      | enables large window |
 
 There are internal buffers for compressed and decompressed data.
-For example you want to use 1 KB as source buffer length for compressor - please use 256 B as destination buffer length.
-You want to use 256 B as source buffer length for decompressor - please use 1 KB as destination buffer length.
+For example you want to use 1 KB as `source_buffer_length` for compressor - please use 256 B as `destination_buffer_length`.
+You want to use 256 B as `source_buffer_length` for decompressor - please use 1 KB as `destination_buffer_length`.
 
-Values: 0 - infinity, default value: 0.
-0 means automatic buffer length selection.
+`String` and `File` will set `:size_hint` automaticaly.
 
-```
-:mode
-```
+You can also read brotli docs for more info about options.
 
-Values: [`:text`, `:font`, `:generic`], default value: `:generic`.
-
-```
-:quality
-```
-
-Values: 0 - 11, default value: 11.
-
-```
-:lgwin
-```
-
-Values: 10 - 24, default value: 22.
-
-```
-:lgblock
-```
-
-Values: 16 - 24, default value: none.
-
-```
-:disable_literal_context_modeling
-```
-
-Values: true/false, default value: false.
-
-```
-:disable_ring_buffer_reallocation
-```
-
-Values: true/false, default value: false.
-
-```
-:size_hint
-```
-
-Values: 0 - infinity, default value: 0.
-
-```
-:large_window
-```
-
-Values: true/false, default value: false.
-
-Please read brotli docs for more info about options.
+| Option    | Related constants |
+|-----------|-------------------|
+| `mode`    | `BRS::Option::MODES = %i[text font generic]` |
+| `quality` | `BRS::Option::MIN_QUALITY = 0`, `BRS::Option::MAX_QUALITY = 11` |
+| `lgwin`   | `BRS::Option::MIN_LGWIN = 10`, `BRS::Option::MAX_LGWIN = 24` |
+| `lgblock` | `BRS::Option::MIN_LGBLOCK = 16`, `BRS::Option::MAX_LGBLOCK = 24` |
 
 Possible compressor options:
 ```
+:source_buffer_length
+:destination_buffer_length
 :mode
 :quality
 :lgwin
@@ -138,6 +128,8 @@ Possible compressor options:
 
 Possible decompressor options:
 ```
+:source_buffer_length
+:destination_buffer_length
 :disable_ring_buffer_reallocation
 :large_window
 ```
@@ -151,7 +143,7 @@ data = BRS::String.compress "sample string", :quality => 5
 puts BRS::String.decompress(data, :disable_ring_buffer_reallocation => true)
 ```
 
-Default options are compatible with HTTP (`Content-Encoding: br`):
+HTTP encoding (`Content-Encoding: br`) using default options:
 
 ```ruby
 require "brs"
@@ -187,7 +179,7 @@ File maintains both source and destination buffers, it accepts both `source_buff
 
 ## Stream::Writer
 
-Its behaviour is similar to builtin [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipWriter.html).
+Its behaviour is similar to builtin [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html).
 
 Writer maintains destination buffer only, so it accepts `destination_buffer_length` option only.
 
@@ -198,6 +190,8 @@ Writer maintains destination buffer only, so it accepts `destination_buffer_leng
 Open file path and create stream writer associated with opened file.
 Data will be transcoded to `:external_encoding` using `:transcode_options` before compressing.
 
+It may be tricky to use both `:size_hint` and `:transcode_options`. You have to provide size of transcoded input.
+
 ```
 ::new(destination_io, options = {}, :external_encoding => nil, :transcode_options => {})
 ```
@@ -205,6 +199,8 @@ Data will be transcoded to `:external_encoding` using `:transcode_options` befor
 Create stream writer associated with destination io.
 Data will be transcoded to `:external_encoding` using `:transcode_options` before compressing.
 
+It may be tricky to use both `:size_hint` and `:transcode_options`. You have to provide size of transcoded input.
+
 ```
 #set_encoding(external_encoding, nil, transcode_options)
 ```
@@ -221,7 +217,7 @@ Set another encodings, `nil` is just for compatibility with `IO`.
 #tell
 ```
 
-See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 
 ```
 #write(*objects)
@@ -231,7 +227,7 @@ See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
 #closed?
 ```
 
-See [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
+See [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
 
 ```
 #write_nonblock(object, *options)
@@ -253,11 +249,11 @@ Behaviour is the same as `IO#write_nonblock` method.
 #puts(*objects)
 ```
 
-Typical helpers, see [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
+Typical helpers, see [`Zlib::GzipWriter`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipWriter.html) docs.
 
 ## Stream::Reader
 
-Its behaviour is similar to builtin [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipReader.html).
+Its behaviour is similar to builtin [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html).
 
 Reader maintains both source and destination buffers, it accepts both `source_buffer_length` and `destination_buffer_length` options.
 
@@ -292,7 +288,7 @@ Set another encodings.
 #tell
 ```
 
-See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 
 ```
 #read(bytes_to_read = nil, out_buffer = nil)
@@ -302,14 +298,14 @@ See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
 #closed?
 ```
 
-See [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+See [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
 
 ```
 #readpartial(bytes_to_read = nil, out_buffer = nil)
 #read_nonblock(bytes_to_read, out_buffer = nil, *options)
 ```
 
-See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
+See [`IO`](https://ruby-doc.org/core-2.7.0/IO.html) docs.
 
 ```
 #getbyte
@@ -332,7 +328,13 @@ See [`IO`](https://ruby-doc.org/core-2.6.1/IO.html) docs.
 #ungetline(line)
 ```
 
-Typical helpers, see [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.6.1/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+Typical helpers, see [`Zlib::GzipReader`](https://ruby-doc.org/stdlib-2.7.0/libdoc/zlib/rdoc/Zlib/GzipReader.html) docs.
+
+## CI
+
+See universal test script [scripts/ci_test.sh](scripts/ci_test.sh) for CI.
+Please visit [scripts/test-images](scripts/test-images).
+You can run this test script using many native and cross images.
 
 ## License
 

data/ext/brs_ext/buffer.c

@@ -5,12 +5,24 @@
 
 #include "ruby.h"
 
+VALUE brs_ext_create_string_buffer(VALUE length)
+{
+  return rb_str_new(NULL, NUM2SIZET(length));
+}
+
+VALUE brs_ext_resize_string_buffer(VALUE args)
+{
+  VALUE buffer = rb_ary_entry(args, 0);
+  VALUE length = rb_ary_entry(args, 1);
+  return rb_str_resize(buffer, NUM2SIZET(length));
+}
+
 void brs_ext_buffer_exports(VALUE root_module)
 {
-  VALUE option = rb_define_module_under(root_module, "Buffer");
+  VALUE module = rb_define_module_under(root_module, "Buffer");
 
-  rb_define_const(option, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR", UINT2NUM(BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR));
-  rb_define_const(option, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR", UINT2NUM(BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR));
-  rb_define_const(option, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR", UINT2NUM(BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR));
-  rb_define_const(option, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR", UINT2NUM(BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR));
+  rb_define_const(module, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR", SIZET2NUM(BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_COMPRESSOR));
+  rb_define_const(module, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR", SIZET2NUM(BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR));
+  rb_define_const(module, "DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR", SIZET2NUM(BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR));
+  rb_define_const(module, "DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR", SIZET2NUM(BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR));
 }

data/ext/brs_ext/buffer.h

@@ -12,6 +12,18 @@
 #define BRS_DEFAULT_SOURCE_BUFFER_LENGTH_FOR_DECOMPRESSOR (1 << 16)      // 64 KB
 #define BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR (1 << 18) // 256 KB
 
+VALUE brs_ext_create_string_buffer(VALUE length);
+
+#define BRS_EXT_CREATE_STRING_BUFFER(buffer, length, exception) \
+  VALUE buffer = rb_protect(brs_ext_create_string_buffer, SIZET2NUM(length), &exception);
+
+VALUE brs_ext_resize_string_buffer(VALUE args);
+
+#define BRS_EXT_RESIZE_STRING_BUFFER(buffer, length, exception)            \
+  VALUE args = rb_ary_new_from_args(2, buffer, SIZET2NUM(length));         \
+  buffer     = rb_protect(brs_ext_resize_string_buffer, args, &exception); \
+  RB_GC_GUARD(args);
+
 void brs_ext_buffer_exports(VALUE root_module);
 
 #endif // BRS_EXT_BUFFER_H

data/ext/brs_ext/common.h

@@ -10,4 +10,7 @@
 
 typedef uint_fast8_t brs_ext_result_t;
 
+typedef uint8_t      brs_ext_byte_t;
+typedef uint_fast8_t brs_ext_byte_fast_t;
+
 #endif // BRS_EXT_COMMON_H

data/ext/brs_ext/error.c

@@ -5,7 +5,6 @@
 
 #include <brotli/decode.h>
 
-#include "brs_ext/common.h"
 #include "ruby.h"
 
 brs_ext_result_t brs_ext_get_decompressor_error(BrotliDecoderErrorCode error_code)
@@ -47,9 +46,9 @@ static inline NORETURN(void raise(const char* name, const char* description))
   rb_raise(error, "%s", description);
 }
 
-void brs_ext_raise_error(brs_ext_result_t result)
+void brs_ext_raise_error(brs_ext_result_t ext_result)
 {
-  switch (result) {
+  switch (ext_result) {
     case BRS_EXT_ERROR_ALLOCATE_FAILED:
       raise("AllocateError", "allocate error");
     case BRS_EXT_ERROR_VALIDATE_FAILED:

data/ext/brs_ext/error.h

@@ -29,6 +29,6 @@ enum {
 
 brs_ext_result_t brs_ext_get_decompressor_error(BrotliDecoderErrorCode error_code);
 
-NORETURN(void brs_ext_raise_error(brs_ext_result_t result));
+NORETURN(void brs_ext_raise_error(brs_ext_result_t ext_result));
 
 #endif // BRS_EXT_ERROR_H

data/ext/brs_ext/io.c

@@ -5,13 +5,12 @@
 
 #include <brotli/decode.h>
 #include <brotli/encode.h>
-#include <stdint.h>
+#include <brotli/types.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include "brs_ext/buffer.h"
-#include "brs_ext/common.h"
 #include "brs_ext/error.h"
 #include "brs_ext/io.h"
 #include "brs_ext/macro.h"
@@ -25,7 +24,7 @@ enum {
 
 // -- file --
 
-static inline brs_ext_result_t read_file(FILE* source_file, uint8_t* source_buffer, size_t* source_length_ptr, size_t source_buffer_length)
+static inline brs_ext_result_t read_file(FILE* source_file, brs_ext_byte_t* source_buffer, size_t* source_length_ptr, size_t source_buffer_length)
 {
   size_t read_length = fread(source_buffer, 1, source_buffer_length, source_file);
   if (read_length == 0 && feof(source_file)) {
@@ -41,7 +40,7 @@ static inline brs_ext_result_t read_file(FILE* source_file, uint8_t* source_buff
   return 0;
 }
 
-static inline brs_ext_result_t write_file(FILE* destination_file, uint8_t* destination_buffer, size_t destination_length)
+static inline brs_ext_result_t write_file(FILE* destination_file, brs_ext_byte_t* destination_buffer, size_t destination_length)
 {
   size_t written_length = fwrite(destination_buffer, 1, destination_length, destination_file);
   if (written_length != destination_length) {
@@ -54,15 +53,15 @@ static inline brs_ext_result_t write_file(FILE* destination_file, uint8_t* desti
 // -- buffer --
 
 static inline brs_ext_result_t create_buffers(
-  uint8_t** source_buffer_ptr, size_t source_buffer_length,
-  uint8_t** destination_buffer_ptr, size_t destination_buffer_length)
+  brs_ext_byte_t** source_buffer_ptr, size_t source_buffer_length,
+  brs_ext_byte_t** destination_buffer_ptr, size_t destination_buffer_length)
 {
-  uint8_t* source_buffer = malloc(source_buffer_length);
+  brs_ext_byte_t* source_buffer = malloc(source_buffer_length);
   if (source_buffer == NULL) {
     return BRS_EXT_ERROR_ALLOCATE_FAILED;
   }
 
-  uint8_t* destination_buffer = malloc(destination_buffer_length);
+  brs_ext_byte_t* destination_buffer = malloc(destination_buffer_length);
   if (destination_buffer == NULL) {
     free(source_buffer);
     return BRS_EXT_ERROR_ALLOCATE_FAILED;
@@ -81,12 +80,12 @@ static inline brs_ext_result_t create_buffers(
 // Algorithm can use same buffer again.
 
 static inline brs_ext_result_t read_more_source(
-  FILE*           source_file,
-  const uint8_t** source_ptr, size_t* source_length_ptr,
-  uint8_t* source_buffer, size_t source_buffer_length)
+  FILE*                  source_file,
+  const brs_ext_byte_t** source_ptr, size_t* source_length_ptr,
+  brs_ext_byte_t* source_buffer, size_t source_buffer_length)
 {
-  const uint8_t* source        = *source_ptr;
-  size_t         source_length = *source_length_ptr;
+  const brs_ext_byte_t* source        = *source_ptr;
+  size_t                source_length = *source_length_ptr;
 
   if (source != source_buffer) {
     if (source_length != 0) {
@@ -103,8 +102,8 @@ static inline brs_ext_result_t read_more_source(
     return BRS_EXT_ERROR_NOT_ENOUGH_SOURCE_BUFFER;
   }
 
-  uint8_t* remaining_source_buffer = source_buffer + source_length;
-  size_t   new_source_length;
+  brs_ext_byte_t* remaining_source_buffer = source_buffer + source_length;
+  size_t          new_source_length;
 
   brs_ext_result_t ext_result = read_file(source_file, remaining_source_buffer, &new_source_length, remaining_source_buffer_length);
   if (ext_result != 0) {
@@ -116,37 +115,51 @@ static inline brs_ext_result_t read_more_source(
   return 0;
 }
 
-#define BUFFERED_READ_SOURCE(function, ...)                \
-  while (true) {                                           \
-    ext_result = function(__VA_ARGS__);                    \
-    if (ext_result != 0) {                                 \
-      return ext_result;                                   \
-    }                                                      \
-                                                           \
-    ext_result = read_more_source(                         \
-      source_file,                                         \
-      &source, &source_length,                             \
-      source_buffer, source_buffer_length);                \
-                                                           \
-    if (ext_result == BRS_EXT_FILE_READ_FINISHED) {        \
-      if (source_length != 0) {                            \
-        /* Brotli wont provide any remainder by design. */ \
-        return BRS_EXT_ERROR_READ_IO;                      \
-      }                                                    \
-      break;                                               \
-    }                                                      \
-    else if (ext_result != 0) {                            \
-      return ext_result;                                   \
-    }                                                      \
-  }
+#define BUFFERED_READ_SOURCE(function, ...)                   \
+  do {                                                        \
+    bool is_function_called = false;                          \
+                                                              \
+    while (true) {                                            \
+      ext_result = read_more_source(                          \
+        source_file,                                          \
+        &source, &source_length,                              \
+        source_buffer, source_buffer_length);                 \
+                                                              \
+      if (ext_result == BRS_EXT_FILE_READ_FINISHED) {         \
+        if (source_length != 0) {                             \
+          /* Brotli won't provide any remainder by design. */ \
+          return BRS_EXT_ERROR_READ_IO;                       \
+        }                                                     \
+        break;                                                \
+      }                                                       \
+      else if (ext_result != 0) {                             \
+        return ext_result;                                    \
+      }                                                       \
+                                                              \
+      ext_result = function(__VA_ARGS__);                     \
+      if (ext_result != 0) {                                  \
+        return ext_result;                                    \
+      }                                                       \
+                                                              \
+      is_function_called = true;                              \
+    }                                                         \
+                                                              \
+    if (!is_function_called) {                                \
+      /* Function should be called at least once. */          \
+      ext_result = function(__VA_ARGS__);                     \
+      if (ext_result != 0) {                                  \
+        return ext_result;                                    \
+      }                                                       \
+    }                                                         \
+  } while (false);
 
 // Algorithm has written data into destination buffer.
 // We need to write this data into file.
 // Than algorithm can use same buffer again.
 
 static inline brs_ext_result_t flush_destination_buffer(
-  FILE*    destination_file,
-  uint8_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
+  FILE*           destination_file,
+  brs_ext_byte_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
 {
   if (*destination_length_ptr == 0) {
     // We want to write more data at once, than buffer has.
@@ -163,7 +176,7 @@ static inline brs_ext_result_t flush_destination_buffer(
   return 0;
 }
 
-static inline brs_ext_result_t write_remaining_destination(FILE* destination_file, uint8_t* destination_buffer, size_t destination_length)
+static inline brs_ext_result_t write_remaining_destination(FILE* destination_file, brs_ext_byte_t* destination_buffer, size_t destination_length)
 {
   if (destination_length == 0) {
     return 0;
@@ -188,18 +201,19 @@ static inline brs_ext_result_t write_remaining_destination(FILE* destination_fil
 // -- compress --
 
 static inline brs_ext_result_t buffered_compress(
-  BrotliEncoderState* state_ptr,
-  const uint8_t** source_ptr, size_t* source_length_ptr,
-  FILE* destination_file, uint8_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
+  BrotliEncoderState*    state_ptr,
+  const brs_ext_byte_t** source_ptr, size_t* source_length_ptr,
+  FILE* destination_file, brs_ext_byte_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
 {
+  BROTLI_BOOL      result;
   brs_ext_result_t ext_result;
 
   while (true) {
-    uint8_t* remaining_destination_buffer             = destination_buffer + *destination_length_ptr;
-    size_t   remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
-    size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
+    brs_ext_byte_t* remaining_destination_buffer             = destination_buffer + *destination_length_ptr;
+    size_t          remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
+    size_t          prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
-    BROTLI_BOOL result = BrotliEncoderCompressStream(
+    result = BrotliEncoderCompressStream(
       state_ptr,
       BROTLI_OPERATION_PROCESS,
       source_length_ptr, source_ptr,
@@ -232,19 +246,20 @@ static inline brs_ext_result_t buffered_compress(
 
 static inline brs_ext_result_t buffered_compressor_finish(
   BrotliEncoderState* state_ptr,
-  FILE* destination_file, uint8_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
+  FILE* destination_file, brs_ext_byte_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
 {
+  BROTLI_BOOL      result;
   brs_ext_result_t ext_result;
 
-  const uint8_t* source        = NULL;
-  size_t         source_length = 0;
+  const brs_ext_byte_t* source        = NULL;
+  size_t                source_length = 0;
 
   while (true) {
-    uint8_t* remaining_destination_buffer             = destination_buffer + *destination_length_ptr;
-    size_t   remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
-    size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
+    brs_ext_byte_t* remaining_destination_buffer             = destination_buffer + *destination_length_ptr;
+    size_t          remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
+    size_t          prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
-    BROTLI_BOOL result = BrotliEncoderCompressStream(
+    result = BrotliEncoderCompressStream(
       state_ptr,
       BROTLI_OPERATION_FINISH,
       &source_length, &source,
@@ -277,14 +292,14 @@ static inline brs_ext_result_t buffered_compressor_finish(
 
 static inline brs_ext_result_t compress(
   BrotliEncoderState* state_ptr,
-  FILE* source_file, uint8_t* source_buffer, size_t source_buffer_length,
-  FILE* destination_file, uint8_t* destination_buffer, size_t destination_buffer_length)
+  FILE* source_file, brs_ext_byte_t* source_buffer, size_t source_buffer_length,
+  FILE* destination_file, brs_ext_byte_t* destination_buffer, size_t destination_buffer_length)
 {
   brs_ext_result_t ext_result;
 
-  const uint8_t* source             = source_buffer;
-  size_t         source_length      = 0;
-  size_t         destination_length = 0;
+  const brs_ext_byte_t* source             = source_buffer;
+  size_t                source_length      = 0;
+  size_t                destination_length = 0;
 
   BUFFERED_READ_SOURCE(
     buffered_compress,
@@ -330,8 +345,8 @@ VALUE brs_ext_compress_io(VALUE BRS_EXT_UNUSED(self), VALUE source, VALUE destin
     destination_buffer_length = BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_COMPRESSOR;
   }
 
-  uint8_t* source_buffer;
-  uint8_t* destination_buffer;
+  brs_ext_byte_t* source_buffer;
+  brs_ext_byte_t* destination_buffer;
 
   ext_result = create_buffers(
     &source_buffer, source_buffer_length,
@@ -364,18 +379,19 @@ VALUE brs_ext_compress_io(VALUE BRS_EXT_UNUSED(self), VALUE source, VALUE destin
 // -- decompress --
 
 static inline brs_ext_result_t buffered_decompress(
-  BrotliDecoderState* state_ptr,
-  const uint8_t** source_ptr, size_t* source_length_ptr,
-  FILE* destination_file, uint8_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
+  BrotliDecoderState*    state_ptr,
+  const brs_ext_byte_t** source_ptr, size_t* source_length_ptr,
+  FILE* destination_file, brs_ext_byte_t* destination_buffer, size_t* destination_length_ptr, size_t destination_buffer_length)
 {
-  brs_ext_result_t ext_result;
+  BrotliDecoderResult result;
+  brs_ext_result_t    ext_result;
 
   while (true) {
-    uint8_t* remaining_destination_buffer             = destination_buffer + *destination_length_ptr;
-    size_t   remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
-    size_t   prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
+    brs_ext_byte_t* remaining_destination_buffer             = destination_buffer + *destination_length_ptr;
+    size_t          remaining_destination_buffer_length      = destination_buffer_length - *destination_length_ptr;
+    size_t          prev_remaining_destination_buffer_length = remaining_destination_buffer_length;
 
-    BrotliDecoderResult result = BrotliDecoderDecompressStream(
+    result = BrotliDecoderDecompressStream(
       state_ptr,
       source_length_ptr, source_ptr,
       &remaining_destination_buffer_length, &remaining_destination_buffer,
@@ -411,14 +427,14 @@ static inline brs_ext_result_t buffered_decompress(
 
 static inline brs_ext_result_t decompress(
   BrotliDecoderState* state_ptr,
-  FILE* source_file, uint8_t* source_buffer, size_t source_buffer_length,
-  FILE* destination_file, uint8_t* destination_buffer, size_t destination_buffer_length)
+  FILE* source_file, brs_ext_byte_t* source_buffer, size_t source_buffer_length,
+  FILE* destination_file, brs_ext_byte_t* destination_buffer, size_t destination_buffer_length)
 {
   brs_ext_result_t ext_result;
 
-  const uint8_t* source             = source_buffer;
-  size_t         source_length      = 0;
-  size_t         destination_length = 0;
+  const brs_ext_byte_t* source             = source_buffer;
+  size_t                source_length      = 0;
+  size_t                destination_length = 0;
 
   BUFFERED_READ_SOURCE(
     buffered_decompress,
@@ -456,8 +472,8 @@ VALUE brs_ext_decompress_io(VALUE BRS_EXT_UNUSED(self), VALUE source, VALUE dest
     destination_buffer_length = BRS_DEFAULT_DESTINATION_BUFFER_LENGTH_FOR_DECOMPRESSOR;
   }
 
-  uint8_t* source_buffer;
-  uint8_t* destination_buffer;
+  brs_ext_byte_t* source_buffer;
+  brs_ext_byte_t* destination_buffer;
 
   ext_result = create_buffers(
     &source_buffer, source_buffer_length,