Skip to content

Feat/named argument support #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kjdev merged 2 commits into from
Jul 31, 2025
Merged

Feat/named argument support #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c144a6
feat: named arguments support (PHP 8.0+)
kjdev Jul 31, 2025
8b8e84c
test: add named arguments
kjdev Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 132 additions & 0 deletions tests/dictionary_named_args.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
--TEST--
dict function with use named arguments
--SKIPIF--
<?php
if (PHP_VERSION_ID < 80000) die("skip requires PHP 8.0+");
?>
--FILE--
<?php
include(dirname(__FILE__) . '/data.inc');
$dict = file_get_contents(dirname(__FILE__) . '/data.dic');

$level = ZSTD_COMPRESS_LEVEL_MAX;

echo "** zstd_compress_dict() **\n";
try {
var_dump(gettype(zstd_compress_dict()));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress_dict(data:) **\n";
try {
var_dump(gettype(zstd_compress_dict(data: $data)));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress_dict(dict:) **\n";
try {
var_dump(gettype(zstd_compress_dict(dict: $dict)));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress_dict(level:) **\n";
try {
var_dump(gettype(zstd_compress_dict(level: $level)));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress_dict(data:, level:) **\n";
try {
var_dump(gettype(zstd_compress_dict(data: $data, level: $level)));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress_dict(data:, dict:) **\n";
try {
var_dump(gettype(zstd_compress_dict(data: $data, dict: $dict)));
var_dump(zstd_uncompress_dict(zstd_compress_dict(data: $data, dict: $dict), $dict) === $data);
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress_dict(level:, dict:) **\n";
try {
var_dump(gettype(zstd_compress_dict(level: $level, dict: $dict)));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress_dict(data:, dict:, level:) **\n";
try {
var_dump(gettype(zstd_compress_dict(data: $data, dict: $dict, level: $level)));
var_dump(zstd_uncompress_dict(zstd_compress_dict(data: $data, dict: $dict, level: $level), $dict) === $data);
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

$compressed = zstd_compress_dict(data: $data, dict: $dict);

echo "** zstd_uncompress_dict(): false **\n";
try {
var_dump(gettype(zstd_uncompress_dict()));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_uncompress_dict(data:) **\n";
try {
var_dump(gettype(zstd_uncompress_dict(data: $compressed)));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_uncompress_dict(dict:) **\n";
try {
var_dump(gettype(zstd_uncompress_dict(dict: $dict)));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_uncompress_dict(data:, dict:) **\n";
try {
var_dump(gettype(zstd_uncompress_dict(data: $compressed, dict: $dict)));
var_dump(zstd_uncompress_dict(data: $compressed, dict: $dict) === $data);
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}
?>
===DONE===
--EXPECTF--
** zstd_compress_dict() **
zstd_compress_dict() expects at least 2 arguments, 0 given
** zstd_compress_dict(data:) **
zstd_compress_dict() expects at least 2 arguments, 1 given
** zstd_compress_dict(dict:) **
zstd_compress_dict(): Argument #1 ($data) not passed
** zstd_compress_dict(level:) **
zstd_compress_dict(): Argument #1 ($data) not passed
** zstd_compress_dict(data:, level:) **
zstd_compress_dict(): Argument #2 ($dict) not passed
** zstd_compress_dict(data:, dict:) **
string(6) "string"
bool(true)
** zstd_compress_dict(level:, dict:) **
zstd_compress_dict(): Argument #1 ($data) not passed
** zstd_compress_dict(data:, dict:, level:) **
string(6) "string"
bool(true)
** zstd_uncompress_dict(): false **
zstd_uncompress_dict() expects exactly 2 arguments, 0 given
** zstd_uncompress_dict(data:) **
zstd_uncompress_dict() expects exactly 2 arguments, 1 given
** zstd_uncompress_dict(dict:) **
zstd_uncompress_dict(): Argument #1 ($data) not passed
** zstd_uncompress_dict(data:, dict:) **
string(6) "string"
bool(true)
===DONE===
77 changes: 77 additions & 0 deletions tests/inc_named_args.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
--TEST--
incremental function with use named arguments
--SKIPIF--
<?php
if (PHP_VERSION_ID < 80000) die("skip requires PHP 8.0+");
?>
--FILE--
<?php
include(dirname(__FILE__) . '/data.inc');

function test($data, $level = 0) {
echo "level={$level}\n";

$compressed = '';

$context = zstd_compress_init(level: $level);
if ($context === false) {
echo "ERROR\n";
return;
}
foreach (str_split($data, 6) as $var) {
$compressed .= zstd_compress_add(
context: $context,
data: $var,
end: false,
);
}
$compressed .= zstd_compress_add(
context: $context,
data: '',
end: true,
);

if ($data === zstd_uncompress(data: $compressed)) {
echo "OK\n";
} else {
echo "ERROR: uncompress\n";
}

$out = '';
$context = zstd_uncompress_init();
foreach (str_split($compressed, 6) as $var) {
$out .= zstd_uncompress_add(
context: $context,
data: $var,
);
}
if ($data === $out) {
echo "Ok\n";
} else {
echo "Error: increment uncompress\n";
}
}

foreach ([0, 9, 22, 30, -1] as $level) {
test($data, $level, 0);
}
?>
===DONE===
--EXPECTF--
level=0
OK
Ok
level=9
OK
Ok
level=22
OK
Ok
level=30

Warning: zstd_compress_init(): compression level (30) must be within 1..22 or smaller then 0 in %s on line %d
ERROR
level=-1
OK
Ok
===DONE===
77 changes: 77 additions & 0 deletions tests/named_args.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
--TEST--
use named arguments
--SKIPIF--
<?php
if (PHP_VERSION_ID < 80000) die("skip requires PHP 8.0+");
?>
--FILE--
<?php
include(dirname(__FILE__) . '/data.inc');

$level = ZSTD_COMPRESS_LEVEL_MAX;

echo "** zstd_compress() **\n";
try {
var_dump(gettype(zstd_compress()));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress(data:) **\n";
try {
var_dump(gettype(zstd_compress(data: $data)));
var_dump(zstd_uncompress(zstd_compress(data: $data)) === $data);
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress(level:) **\n";
try {
var_dump(gettype(zstd_compress(level: $level)));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_compress(data:, level:) **\n";
try {
var_dump(gettype(zstd_compress(data: $data, level: $level)));
var_dump(zstd_uncompress(zstd_compress(data: $data, level: $level)) === $data);
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

$compressed = zstd_compress(data: $data);

echo "** zstd_uncompress(): false **\n";
try {
var_dump(gettype(zstd_uncompress()));
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}

echo "** zstd_uncompress(data:) **\n";
try {
var_dump(gettype(zstd_uncompress(data: $compressed)));
var_dump(zstd_uncompress(data: $compressed) === $data);
} catch (Error $e) {
echo $e->getMessage(), PHP_EOL;
}
?>
===DONE===
--EXPECTF--
** zstd_compress() **
zstd_compress() expects at least 1 argument, 0 given
** zstd_compress(data:) **
string(6) "string"
bool(true)
** zstd_compress(level:) **
zstd_compress(): Argument #1 ($data) not passed
** zstd_compress(data:, level:) **
string(6) "string"
bool(true)
** zstd_uncompress(): false **
zstd_uncompress() expects exactly 1 argument, 0 given
** zstd_uncompress(data:) **
string(6) "string"
bool(true)
===DONE===
50 changes: 48 additions & 2 deletions zstd.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,43 +316,89 @@ static php_zstd_context* php_zstd_output_handler_context_init(void)
#define php_zstd_output_handler_context_free(ctx) php_zstd_context_free(ctx)

/* One-shot functions */
#if PHP_VERSION_ID >= 80000
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_zstd_compress, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, level, IS_LONG, 0, "ZSTD_COMPRESS_LEVEL_DEFAULT")
#else
ZEND_BEGIN_ARG_INFO_EX(arginfo_zstd_compress, 0, 0, 1)
ZEND_ARG_INFO(0, data)
ZEND_ARG_INFO(0, level)
#endif
ZEND_END_ARG_INFO()

#if PHP_VERSION_ID >= 80000
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_zstd_uncompress, 0, 1, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
#else
ZEND_BEGIN_ARG_INFO_EX(arginfo_zstd_uncompress, 0, 0, 1)
ZEND_ARG_INFO(0, data)
#endif
ZEND_END_ARG_INFO()

#if PHP_VERSION_ID >= 80000
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_zstd_compress_dict, 0, 2, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
ZEND_ARG_TYPE_INFO(0, dict, IS_STRING, 0)
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, level, IS_LONG, 0, "ZSTD_COMPRESS_LEVEL_DEFAULT")
#else
ZEND_BEGIN_ARG_INFO_EX(arginfo_zstd_compress_dict, 0, 0, 2)
ZEND_ARG_INFO(0, data)
ZEND_ARG_INFO(0, dictBuffer)
ZEND_ARG_INFO(0, dict)
ZEND_ARG_INFO(0, level)
#endif
ZEND_END_ARG_INFO()

#if PHP_VERSION_ID >= 80000
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_zstd_uncompress_dict, 0, 2, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
ZEND_ARG_TYPE_INFO(0, dict, IS_STRING, 0)
#else
ZEND_BEGIN_ARG_INFO_EX(arginfo_zstd_uncompress_dict, 0, 0, 2)
ZEND_ARG_INFO(0, data)
ZEND_ARG_INFO(0, dictBuffer)
ZEND_ARG_INFO(0, dict)
#endif
ZEND_END_ARG_INFO()

/* Incremental functions */
#if PHP_VERSION_ID >= 80000
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_zstd_compress_init, 0, 0, Zstd\\Compress\\Context, MAY_BE_FALSE)
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, level, IS_LONG, 0, "ZSTD_COMPRESS_LEVEL_DEFAULT")
#else
ZEND_BEGIN_ARG_INFO_EX(arginfo_zstd_compress_init, 0, 0, 0)
ZEND_ARG_INFO(0, level)
#endif
ZEND_END_ARG_INFO()

#if PHP_VERSION_ID >= 80000
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_zstd_compress_add, 0, 2, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_OBJ_INFO(0, context, Zstd\\Compress\\Context, 0)
ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, end, _IS_BOOL, 0, "false")
#else
ZEND_BEGIN_ARG_INFO_EX(arginfo_zstd_compress_add, 0, 0, 2)
ZEND_ARG_INFO(0, context)
ZEND_ARG_INFO(0, data)
ZEND_ARG_INFO(0, end)
#endif
ZEND_END_ARG_INFO()

#if PHP_VERSION_ID >= 80000
ZEND_BEGIN_ARG_WITH_RETURN_OBJ_TYPE_MASK_EX(arginfo_zstd_uncompress_init, 0, 0, Zstd\\UnCompress\\Context, MAY_BE_FALSE)
#else
ZEND_BEGIN_ARG_INFO_EX(arginfo_zstd_uncompress_init, 0, 0, 0)
#endif
ZEND_END_ARG_INFO()

#if PHP_VERSION_ID >= 80000
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_MASK_EX(arginfo_zstd_uncompress_add, 0, 2, MAY_BE_STRING|MAY_BE_FALSE)
ZEND_ARG_OBJ_INFO(0, context, Zstd\\UnCompress\\Context, 0)
ZEND_ARG_TYPE_INFO(0, data, IS_STRING, 0)
#else
ZEND_BEGIN_ARG_INFO_EX(arginfo_zstd_uncompress_add, 0, 0, 2)
ZEND_ARG_INFO(0, context)
ZEND_ARG_INFO(0, data)
#endif
ZEND_END_ARG_INFO()

#if PHP_VERSION_ID >= 80000
Expand Down