crazywhalecc/static-php-cli
1
0
Fork 0
mirror of https://github.com/crazywhalecc/static-php-cli.git synced 2026-07-04 23:35:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add lib skeleton command and sort config, spc_mode suuport, etc...

Browse Source
This commit is contained in:
crazywhalecc
2025-12-18 15:43:58 +08:00
parent 1707c679e8
commit dd5762fbd3
19 changed files with 866 additions and 109 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
src/StaticPHP/Skeleton/ArtifactGenerator.php
View File

@@ -1,11 +1,21 @@
<?php
declare(strict_types=1);
namespace StaticPHP\Skeleton;
use StaticPHP\Exception\FileSystemException;
use StaticPHP\Exception\ValidationException;
use StaticPHP\Util\FileSystem;
class ArtifactGenerator
{
protected ?array $source = null;
protected ?array $binary = null;
protected ?string $config_file = null;
protected bool $generate_class = false;
protected bool $generate_custom_source_func = false;
@@ -45,13 +55,61 @@ class ArtifactGenerator
return $this->source;
}
public function generateConfig(): array
public function setBinary(string $os, array $config): static
{
$clone = clone $this;
if ($clone->binary === null) {
$clone->binary = [$os => $config];
} else {
$clone->binary[$os] = $config;
}
return $clone;
}
public function generateConfigArray(): array
{
$config = [];
if ($this->source) {
$config['source'] = $this->source;
}
if ($this->binary) {
$config['binary'] = $this->binary;
}
return $config;
}
public function setConfigFile(string $file): static
{
$clone = clone $this;
$clone->config_file = $file;
return $clone;
}
/**
* Write the artifact configuration to the config file.
*/
public function writeConfigFile(): string
{
if ($this->config_file === null) {
throw new ValidationException('Config file path is not set.');
}
$config_array = $this->generateConfigArray();
$config_file_json = json_decode(FileSystem::readFile($this->config_file), true);
if (!is_array($config_file_json)) {
throw new ValidationException('Existing config file is not a valid JSON array.');
}
$config_file_json[$this->name] = $config_array;
// sort keys
ksort($config_file_json);
$json_content = json_encode($config_file_json, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
if ($json_content === false) {
throw new ValidationException('Failed to encode config array to JSON.');
}
if (file_put_contents($this->config_file, $json_content) === false) {
throw new FileSystemException("Failed to write config file: {$this->config_file}");
}
return $this->config_file;
}
}

20
src/StaticPHP/Skeleton/ExecutorGenerator.php
View File

@@ -1,9 +1,14 @@
<?php
declare(strict_types=1);
namespace StaticPHP\Skeleton;
use StaticPHP\Exception\ValidationException;
use StaticPHP\Runtime\Executor\Executor;
use StaticPHP\Runtime\Executor\UnixAutoconfExecutor;
use StaticPHP\Runtime\Executor\UnixCMakeExecutor;
use StaticPHP\Runtime\Executor\WindowsCMakeExecutor;
class ExecutorGenerator
{
@@ -13,4 +18,19 @@ class ExecutorGenerator
throw new ValidationException('Executor class must extend ' . Executor::class);
}
}
/**
* Generate the code to create an instance of the executor.
*
* @return array{0: string, 1: string} an array containing the class name and the code string
*/
public function generateCode(): array
{
return match ($this->class) {
UnixCMakeExecutor::class => [UnixCMakeExecutor::class, 'UnixCMakeExecutor::create($package)->build();'],
UnixAutoconfExecutor::class => [UnixAutoconfExecutor::class, 'UnixAutoconfExecutor::create($package)->build();'],
WindowsCMakeExecutor::class => [WindowsCMakeExecutor::class, 'WindowsCMakeExecutor::create($package)->build();'],
default => throw new ValidationException("Unsupported executor class: {$this->class}"),
};
}
}

239
src/StaticPHP/Skeleton/PackageGenerator.php
View File

@@ -1,33 +1,49 @@
<?php
declare(strict_types=1);
namespace StaticPHP\Skeleton;
use Nette\PhpGenerator\PhpFile;
use Nette\PhpGenerator\Printer;
use StaticPHP\Attribute\Package\BuildFor;
use StaticPHP\Attribute\Package\Extension;
use StaticPHP\Attribute\Package\Library;
use StaticPHP\Attribute\Package\Target;
use StaticPHP\Exception\FileSystemException;
use StaticPHP\Exception\ValidationException;
use StaticPHP\Package\LibraryPackage;
use StaticPHP\Package\PackageInstaller;
use StaticPHP\Package\PhpExtensionPackage;
use StaticPHP\Package\TargetPackage;
use StaticPHP\Util\FileSystem;
/**
* A skeleton class for generating package files and configs.
*/
class PackageGenerator
{
/** @var array<''|'unix'|'windows'|'macos'|'linux', string[]> $depends An array of dependencies required by the package, categorized by operating system. */
/** @var array<''|'linux'|'macos'|'unix'|'windows', string[]> $depends An array of dependencies required by the package, categorized by operating system. */
protected array $depends = [];
/** @var array<''|'unix'|'windows'|'macos'|'linux', string[]> $suggests An array of suggested packages for the package, categorized by operating system. */
/** @var array<''|'linux'|'macos'|'unix'|'windows', string[]> $suggests An array of suggested packages for the package, categorized by operating system. */
protected array $suggests = [];
/** @var array<string> $frameworks An array of macOS frameworks for the package */
protected array $frameworks = [];
/** @var array<''|'unix'|'windows'|'macos'|'linux', string[]> $static_libs An array of static libraries required by the package, categorized by operating system. */
/** @var array<''|'linux'|'macos'|'unix'|'windows', string[]> $static_libs An array of static libraries required by the package, categorized by operating system. */
protected array $static_libs = [];
/** @var array<''|'unix'|'windows'|'macos'|'linux', string[]> $headers An array of header files required by the package, categorized by operating system. */
/** @var array<''|'linux'|'macos'|'unix'|'windows', string[]> $headers An array of header files required by the package, categorized by operating system. */
protected array $headers = [];
/** @var array<''|'unix'|'windows'|'macos'|'linux', string[]> $static_bins An array of static binaries required by the package, categorized by operating system. */
/** @var array<''|'linux'|'macos'|'unix'|'windows', string[]> $static_bins An array of static binaries required by the package, categorized by operating system. */
protected array $static_bins = [];
/** @var ArtifactGenerator|null $artifact Artifact */
protected ?string $config_file = null;
/** @var null|ArtifactGenerator $artifact Artifact */
protected ?ArtifactGenerator $artifact = null;
/** @var array $licenses Licenses */
@@ -44,28 +60,28 @@ class PackageGenerator
protected array $func_executor_binding = [];
/**
* @param string $package_name Package name
* @param 'library'|'target'|'virtual-target'|'php-extension' $type Package type ('library', 'target', 'virtual-target', etc.)
* @param string $package_name Package name
* @param 'library'|'php-extension'|'target'|'virtual-target' $type Package type ('library', 'target', 'virtual-target', etc.)
*/
public function __construct(protected string $package_name, protected string $type) {}
/**
* Add package dependency.
*
* @param string $package Package name
* @param string $os Operating system ('' for all OSes, '@unix', '@windows', '@macos')
* @param string $package Package name
* @param string $os_category Operating system ('' for all OSes, 'unix', 'windows', 'macos')
*/
public function addDependency(string $package, string $os = ''): static
public function addDependency(string $package, string $os_category = ''): static
{
if (!in_array($os, ['', 'unix', 'windows', 'macos', 'linux'], true)) {
throw new ValidationException("Invalid OS suffix: {$os}");
if (!in_array($os_category, ['', ...SUPPORTED_OS_CATEGORY], true)) {
throw new ValidationException("Invalid OS suffix: {$os_category}");
}
$clone = clone $this;
if (!isset($clone->depends[$os])) {
$clone->depends[$os] = [];
if (!isset($clone->depends[$os_category])) {
$clone->depends[$os_category] = [];
}
if (!in_array($package, $clone->depends[$os], true)) {
$clone->depends[$os][] = $package;
if (!in_array($package, $clone->depends[$os_category], true)) {
$clone->depends[$os_category][] = $package;
}
return $clone;
}
@@ -73,78 +89,78 @@ class PackageGenerator
/**
* Add package suggestion.
*
* @param string $package Package name
* @param string $os Operating system ('' for all OSes, '@unix', '@windows', '@macos')
* @param string $package Package name
* @param string $os_category Operating system ('' for all OSes)
*/
public function addSuggestion(string $package, string $os = ''): static
public function addSuggestion(string $package, string $os_category = ''): static
{
if (!in_array($os, ['', 'unix', 'windows', 'macos', 'linux'], true)) {
throw new ValidationException("Invalid OS suffix: {$os}");
if (!in_array($os_category, ['', ...SUPPORTED_OS_CATEGORY], true)) {
throw new ValidationException("Invalid OS suffix: {$os_category}");
}
$clone = clone $this;
if (!isset($clone->suggests[$os])) {
$clone->suggests[$os] = [];
if (!isset($clone->suggests[$os_category])) {
$clone->suggests[$os_category] = [];
}
if (!in_array($package, $clone->suggests[$os], true)) {
$clone->suggests[$os][] = $package;
if (!in_array($package, $clone->suggests[$os_category], true)) {
$clone->suggests[$os_category][] = $package;
}
return $clone;
}
public function addStaticLib(string $lib_a, string $os = ''): static
public function addStaticLib(string $lib_a, string $os_category = ''): static
{
if (!in_array($os, ['', 'unix', 'windows', 'macos', 'linux'], true)) {
throw new ValidationException("Invalid OS suffix: {$os}");
if (!in_array($os_category, ['', ...SUPPORTED_OS_CATEGORY], true)) {
throw new ValidationException("Invalid OS suffix: {$os_category}");
}
if (!str_ends_with($lib_a, '.lib') && !str_ends_with($lib_a, '.a')) {
throw new ValidationException("Static library must end with .lib or .a, got: {$lib_a}");
}
if (str_ends_with($lib_a, '.lib') && in_array($os, ['unix', 'linux', 'macos'], true)) {
if (str_ends_with($lib_a, '.lib') && in_array($os_category, ['unix', 'linux', 'macos'], true)) {
throw new ValidationException("Static library with .lib extension cannot be added for non-Windows OS: {$lib_a}");
}
if (str_ends_with($lib_a, '.a') && $os === 'windows') {
if (str_ends_with($lib_a, '.a') && $os_category === 'windows') {
throw new ValidationException("Static library with .a extension cannot be added for Windows OS: {$lib_a}");
}
if (isset($this->static_libs[$os]) && in_array($lib_a, $this->static_libs[$os], true)) {
if (isset($this->static_libs[$os_category]) && in_array($lib_a, $this->static_libs[$os_category], true)) {
// already exists
return $this;
}
$clone = clone $this;
if (!isset($clone->static_libs[$os])) {
$clone->static_libs[$os] = [];
if (!isset($clone->static_libs[$os_category])) {
$clone->static_libs[$os_category] = [];
}
if (!in_array($lib_a, $clone->static_libs[$os], true)) {
$clone->static_libs[$os][] = $lib_a;
if (!in_array($lib_a, $clone->static_libs[$os_category], true)) {
$clone->static_libs[$os_category][] = $lib_a;
}
return $clone;
}
public function addHeader(string $header_file, string $os = ''): static
public function addHeader(string $header_file, string $os_category = ''): static
{
if (!in_array($os, ['', 'unix', 'windows', 'macos', 'linux'], true)) {
throw new ValidationException("Invalid OS suffix: {$os}");
if (!in_array($os_category, ['', ...SUPPORTED_OS_CATEGORY], true)) {
throw new ValidationException("Invalid OS suffix: {$os_category}");
}
$clone = clone $this;
if (!isset($clone->headers[$os])) {
$clone->headers[$os] = [];
if (!isset($clone->headers[$os_category])) {
$clone->headers[$os_category] = [];
}
if (!in_array($header_file, $clone->headers[$os], true)) {
$clone->headers[$os][] = $header_file;
if (!in_array($header_file, $clone->headers[$os_category], true)) {
$clone->headers[$os_category][] = $header_file;
}
return $clone;
}
public function addStaticBin(string $bin_file, string $os = ''): static
public function addStaticBin(string $bin_file, string $os_category = ''): static
{
if (!in_array($os, ['', 'unix', 'windows', 'macos', 'linux'], true)) {
throw new ValidationException("Invalid OS suffix: {$os}");
if (!in_array($os_category, ['', ...SUPPORTED_OS_CATEGORY], true)) {
throw new ValidationException("Invalid OS suffix: {$os_category}");
}
$clone = clone $this;
if (!isset($clone->static_bins[$os])) {
$clone->static_bins[$os] = [];
if (!isset($clone->static_bins[$os_category])) {
$clone->static_bins[$os_category] = [];
}
if (!in_array($bin_file, $clone->static_bins[$os], true)) {
$clone->static_bins[$os][] = $bin_file;
if (!in_array($bin_file, $clone->static_bins[$os_category], true)) {
$clone->static_bins[$os_category][] = $bin_file;
}
return $clone;
}
@@ -194,9 +210,9 @@ class PackageGenerator
/**
* Enable build for specific OS.
*
* @param 'Windows'|'Linux'|'Darwin'|array<'Windows'|'Linux'|'Darwin'> $build_for Build for OS
* @param 'Darwin'|'Linux'|'Windows'|array<'Darwin'|'Linux'|'Windows'> $build_for Build for OS
*/
public function enableBuild(string|array $build_for, ?string $build_function_name = null): static
public function enableBuild(array|string $build_for, ?string $build_function_name = null): static
{
$clone = clone $this;
if (is_array($build_for)) {
@@ -205,6 +221,9 @@ class PackageGenerator
}
return $clone;
}
if (!in_array($build_for, SUPPORTED_OS_FAMILY, true)) {
throw new ValidationException("Unsupported build_for value: {$build_for}");
}
$clone->build_for_enables[$build_for] = $build_function_name ?? "buildFor{$build_for}";
return $clone;
}
@@ -212,8 +231,8 @@ class PackageGenerator
/**
* Bind function executor.
*
* @param string $func_name Function name
* @param ExecutorGenerator $executor Executor generator
* @param string $func_name Function name
* @param ExecutorGenerator $executor Executor generator
*/
public function addFunctionExecutorBinding(string $func_name, ExecutorGenerator $executor): static
{
@@ -222,10 +241,73 @@ class PackageGenerator
return $clone;
}
public function generatePackageClassFile(string $namespace, bool $uppercase = false): string
{
$printer = new class extends Printer {
public string $indentation = ' ';
};
$file = new PhpFile();
$namespace = $file->setStrictTypes()->addNamespace($namespace);
$uses = [];
// class name and package attribute
$class_name = str_replace('-', '_', $uppercase ? ucwords($this->package_name, '-') : $this->package_name);
$class_attribute = match ($this->type) {
'library' => Library::class,
'php-extension' => Extension::class,
'target', 'virtual-target' => Target::class,
};
$package_class = match ($this->type) {
'library' => LibraryPackage::class,
'php-extension' => PhpExtensionPackage::class,
'target', 'virtual-target' => TargetPackage::class,
};
$uses[] = $class_attribute;
$uses[] = $package_class;
$uses[] = BuildFor::class;
$uses[] = PackageInstaller::class;
foreach ($uses as $use) {
$namespace->addUse($use);
}
// add class attribute
$class = $namespace->addClass($class_name);
$class->addAttribute($class_attribute, [$this->package_name]);
// add build functions if enabled
$funcs = [];
foreach ($this->build_for_enables as $os_family => $func_name) {
if ($func_name !== null) {
$funcs[$func_name][] = $os_family;
}
}
foreach ($funcs as $name => $oss) {
$method = $class->addMethod(name: $name ?: 'build')
->setPublic()
->setReturnType('void');
// check if function executor is bound
if (isset($this->func_executor_binding[$name])) {
$executor = $this->func_executor_binding[$name];
[$executor_use, $code] = $executor->generateCode();
$namespace->addUse($executor_use);
$method->setBody($code);
}
$method->addParameter('package')->setType($package_class);
$method->addParameter('installer')->setType(PackageInstaller::class);
foreach ($oss as $os) {
$method->addAttribute(BuildFor::class, [$os]);
}
}
return $printer->printFile($file);
}
/**
* Generate package config
*/
public function generateConfig(): array
public function generateConfigArray(): array
{
$config = ['type' => $this->type];
@@ -280,4 +362,51 @@ class PackageGenerator
return $config;
}
public function setConfigFile(string $config_file): static
{
$clone = clone $this;
$clone->config_file = $config_file;
return $clone;
}
public function writeConfigFile(): string
{
if ($this->config_file === null) {
throw new ValidationException('Config file path is not set.');
}
$config_array = $this->generateConfigArray();
$config_file_json = json_decode(FileSystem::readFile($this->config_file), true);
if (!is_array($config_file_json)) {
throw new ValidationException('Existing config file is not a valid JSON array.');
}
$config_file_json[$this->package_name] = $config_array;
ksort($config_file_json);
$json_content = json_encode($config_file_json, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
if ($json_content === false) {
throw new ValidationException('Failed to encode package config to JSON.');
}
if (file_put_contents($this->config_file, $json_content) === false) {
throw new FileSystemException("Failed to write config file: {$this->config_file}");
}
return $this->config_file;
}
public function writeAll(): array
{
// write config
$package_config_file = $this->writeConfigFile();
$artifact_config_file = $this->artifact->writeConfigFile();
// write class file
$package_class_file_content = $this->generatePackageClassFile('StaticPHP\Packages');
$package_class_file_path = str_replace('-', '_', $this->package_name) . '.php';
// file_put_contents($package_class_file_path, $package_class_file_content); // Uncomment this line to actually write the file
return [
'package_config' => $package_config_file,
'artifact_config' => $artifact_config_file,
'package_class_file' => $package_class_file_path,
'package_class_content' => $package_class_file_content,
];
}
}