Add constants to handle options and add test case for options

Author: cracksalad

README.md

@@ -130,27 +130,22 @@ LZ4 compression to frame.
 * _max\_block\_size_
 
   Maximum uncompressed size of each block.
+  Pass any of the following values:
 
-  * 4 = 64 KB
-  * 5 = 256 KB
-  * 6 = 1 MB
-  * 7 = 4 MB
-  * any other value: 64 KB
+  * _LZ4\_BLOCK\_SIZE\_64KB_
+  * _LZ4\_BLOCK\_SIZE\_256KB_
+  * _LZ4\_BLOCK\_SIZE\_1MB_
+  * _LZ4\_BLOCK\_SIZE\_4MB_
+  
+  Any other value will be treated as _LZ4\_BLOCK\_SIZE\_64KB_.
 
 * _checksums_
 
   Enable/disable frame level and block level checksums.
-  The value is a bitmask using this bit interpretation:
+  Pass a bitwise combination of the following constants:
 
-  * bit 0: frame level checksum
-  * bit 1: block level checksum
-
-  Which leads to the following:
-
-  * 0 = no checksums
-  * 1 = frame level checksum
-  * 2 = block level checksum
-  * 3 = both checksums
+  * _LZ4\_CHECKSUM\_FRAME_: frame level checksum
+  * _LZ4\_CHECKSUM\_BLOCK_: block level checksum
 
 #### Return Values
 

lz4.c

@@ -67,6 +67,9 @@
 #define PHP_LZ4_CLEVEL_MIN 3
 #endif
 
+#define PHP_LZ4_CHECKSUM_FRAME (1<<0)
+#define PHP_LZ4_CHECKSUM_BLOCK (1<<1)
+
 static ZEND_FUNCTION(lz4_compress);
 static ZEND_FUNCTION(lz4_uncompress);
 static ZEND_FUNCTION(lz4_compress_frame);
@@ -115,6 +118,12 @@ static PHP_MINIT_FUNCTION(lz4)
     REGISTER_LONG_CONSTANT("LZ4_CLEVEL_MAX", PHP_LZ4_CLEVEL_MAX, CONST_CS | CONST_PERSISTENT);
     REGISTER_LONG_CONSTANT("LZ4_VERSION_NUMBER", LZ4_versionNumber(), CONST_CS | CONST_PERSISTENT);
     REGISTER_STRING_CONSTANT("LZ4_VERSION_TEXT", (char *)LZ4_versionString(), CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("LZ4_CHECKSUM_FRAME", PHP_LZ4_CHECKSUM_FRAME, CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("LZ4_CHECKSUM_BLOCK", PHP_LZ4_CHECKSUM_BLOCK, CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("LZ4_BLOCK_SIZE_64KB", LZ4F_max64KB, CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("LZ4_BLOCK_SIZE_256KB", LZ4F_max256KB, CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("LZ4_BLOCK_SIZE_1MB", LZ4F_max1MB, CONST_CS | CONST_PERSISTENT);
+    REGISTER_LONG_CONSTANT("LZ4_BLOCK_SIZE_4MB", LZ4F_max4MB, CONST_CS | CONST_PERSISTENT);
 
 #if PHP_MAJOR_VERSION >= 7 && defined(HAVE_APCU_SUPPORT)
     apc_register_serializer("lz4",
@@ -294,8 +303,8 @@ static int php_lz4_compress_frame(char* in, const int in_len,
     }
     preferences.frameInfo.blockSizeID = max_block_size;
     preferences.frameInfo.contentSize = in_len;
-    preferences.frameInfo.contentChecksumFlag = checksums & 0x01;
-    preferences.frameInfo.blockChecksumFlag = (checksums & 0x02) >> 1;
+    preferences.frameInfo.contentChecksumFlag = (checksums & PHP_LZ4_CHECKSUM_FRAME) > 0;
+    preferences.frameInfo.blockChecksumFlag = (checksums & PHP_LZ4_CHECKSUM_BLOCK) > 0;
     preferences.compressionLevel = level;
 
     var_len = LZ4F_compressFrameBound(in_len, &preferences);

lz4.stub.php

@@ -26,15 +26,51 @@
    */
   const LZ4_VERSION_NUMBER = UNKNOWN;
 
+  /**
+   * @var int
+   * @cvalue LZ4_CHECKSUM_FRAME
+   */
+  const LZ4_CHECKSUM_FRAME = UNKNOWN;
+
+  /**
+   * @var int
+   * @cvalue LZ4_CHECKSUM_BLOCK
+   */
+  const LZ4_CHECKSUM_BLOCK = UNKNOWN;
+
+  /**
+   * @var int
+   * @cvalue LZ4_BLOCK_SIZE_64KB
+   */
+  const LZ4_BLOCK_SIZE_64KB = UNKNOWN;
+
+  /**
+   * @var int
+   * @cvalue LZ4_BLOCK_SIZE_256KB
+   */
+  const LZ4_BLOCK_SIZE_256KB = UNKNOWN;
+
+  /**
+   * @var int
+   * @cvalue LZ4_BLOCK_SIZE_1MB
+   */
+  const LZ4_BLOCK_SIZE_1MB = UNKNOWN;
+
+  /**
+   * @var int
+   * @cvalue LZ4_BLOCK_SIZE_4MB
+   */
+  const LZ4_BLOCK_SIZE_4MB = UNKNOWN;
+
 
   function lz4_compress(string $data, int $level = 0, string $extra = NULL): string|false {}
 
 
   function lz4_uncompress(string $data, int $maxsize = -1, int $offset = -1): string|false {}
 
   /**
-   * @param int $max_block_size 4: 64KB, 5: 256KB, 6: 1MB, 7: 4MB, all other values: 64KB
-   * @param int $checksums 0: none, 1: frame content, 2: each block, 3: frame content + each block
+   * @param int $max_block_size any of the LZ4_BLOCK_SIZE_* constants
+   * @param int $checksums bitmask of the LZ4_CHECKSUM_* constants
    */
   function lz4_compress_frame(string $data, int $level = 0, int $max_block_size = 0, int $checksums = 0): string|false {}
 

tests/frame_002.phpt

@@ -0,0 +1,37 @@
+--TEST--
+Test lz4_compress_frame() function : with all parameters
+--SKIPIF--
+--FILE--
+<?php
+if (!extension_loaded('lz4')) {
+    dl('lz4.' . PHP_SHLIB_SUFFIX);
+}
+
+include(dirname(__FILE__) . '/data.inc');
+
+echo "*** Testing lz4_compress_frame() : with all parameters ***\n";
+
+// Initialise all required variables
+
+$smallstring = "A small string to compress\n";
+
+// Compressing a big string
+echo "-- Compression --\n";
+$output = lz4_compress_frame($data, 6, LZ4_BLOCK_SIZE_256KB, LZ4_CHECKSUM_FRAME | LZ4_CHECKSUM_BLOCK);
+var_dump(strcmp(lz4_uncompress_frame($output), $data));
+
+// Compressing a smaller string
+echo "-- Compression --\n";
+$output = lz4_compress_frame($smallstring, 6, LZ4_BLOCK_SIZE_256KB, LZ4_CHECKSUM_FRAME | LZ4_CHECKSUM_BLOCK);
+var_dump(bin2hex($output));
+var_dump(strcmp(lz4_uncompress_frame($output), $smallstring));
+?>
+===Done===
+--EXPECT--
+*** Testing lz4_compress_frame() : with all parameters ***
+-- Compression --
+int(0)
+-- Compression --
+string(116) "04224d187c401b00000000000000981b0000804120736d616c6c20737472696e6720746f20636f6d70726573730a2f4da318000000002f4da318"
+int(0)
+===Done===