+## Features
-You can also use the micro binary file to combine php binary and php source code into one for distribution! (micro SAPI)
+static-php-cli (you can call it `spc`) has a lot of features:
-
+- :handbag: Build single-file php executable, without any dependencies
+- :hamburger: Build **[phpmicro](https://github.com/dixyes/phpmicro)** self-extracted executable (glue php binary and php source code into one file)
+- :pill: Automatic build environment checker (Doctor module)
+- :zap: `Linux`, `macOS`, `FreeBSD`, `Windows` support
+- :wrench: Configurable source code patches
+- :books: Build dependency management
+- 📦 Provide `spc` own standalone executable (built by spc and [box](https://github.com/box-project/box))
+- :fire: Support many popular [extensions](https://static-php.dev/en/guide/extensions.html)
+- :floppy_disk: UPX integration (significantly reduces binary size)
-> This SAPI feature is from the [Fork](https://github.com/static-php/phpmicro) of [dixyes/phpmicro](https://github.com/dixyes/phpmicro).
+**Single-file standalone php-cli:**
-[]()
-[]()
-[](https://github.com/crazywhalecc/static-php-cli/actions/workflows/build.yml)
-[](https://github.com/crazywhalecc/static-php-cli/actions/workflows/build.yml)
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/.vitepress/components/DependencyUtil.js b/docs/.vitepress/components/DependencyUtil.js
new file mode 100644
index 00000000..fd1f75bd
--- /dev/null
+++ b/docs/.vitepress/components/DependencyUtil.js
@@ -0,0 +1,193 @@
+export function getMetaList(meta, type, name, list_name) {
+ if (meta.os === 'linux') {
+ return meta[type][name][list_name + '-linux'] ?? meta[type][name][list_name + '-unix'] ?? meta[type][name][list_name] ?? [];
+ }
+ if (meta.os === 'macos') {
+ return meta[type][name][list_name + '-macos'] ?? meta[type][name][list_name + '-unix'] ?? meta[type][name][list_name] ?? [];
+ }
+ if (meta.os === 'windows') {
+ return meta[type][name][list_name + '-windows'] ?? meta[type][name][list_name] ?? [];
+ }
+ return [];
+}
+
+export function getExtDepends(meta, ext_name) {
+ return getMetaList(meta, 'ext', ext_name, 'ext-depends');
+}
+
+export function getExtSuggests(meta, ext_name) {
+ return getMetaList(meta, 'ext', ext_name, 'ext-suggests');
+}
+
+export function getExtLibDepends(meta, ext_name) {
+ const ls = getMetaList(meta, 'ext', ext_name, 'lib-depends');
+ return ls;
+}
+
+export function getExtLibSuggests(meta, ext_name) {
+ return getMetaList(meta, 'ext', ext_name, 'lib-suggests');
+}
+
+export function getLibDepends(meta, lib_name) {
+ return getMetaList(meta, 'lib', lib_name, 'lib-depends');
+}
+
+export function getLibSuggests(meta, lib_name) {
+ return getMetaList(meta, 'lib', lib_name, 'lib-suggests');
+}
+
+/**
+ * Obtain the dependent lib list according to the required ext list, and sort according to the dependency
+ * @param meta
+ * @param exts
+ */
+export function getExtLibsByDeps(meta, exts) {
+ const sorted = [];
+ const visited = new Set();
+ const notIncludedExts = [];
+ exts.forEach((ext) => {
+ if (!visited.has(ext)) {
+ visitExtDeps(meta, ext, visited, sorted);
+ }
+ });
+
+ const sortedSuggests = [];
+ const visitedSuggests = new Set();
+ const final = [];
+ exts.forEach((ext) => {
+ if (!visited.has(ext)) {
+ visitExtAllDeps(meta, ext, visitedSuggests, sortedSuggests);
+ }
+ });
+ sortedSuggests.forEach((suggest) => {
+ if (sorted.indexOf(suggest) !== -1) {
+ final.push(suggest);
+ }
+ });
+ const libs = [];
+ final.forEach((ext) => {
+ if (exts.indexOf(ext) === -1) {
+ notIncludedExts.push(ext);
+ }
+ getExtLibDepends(meta, ext).forEach((lib) => {
+ if (libs.indexOf(lib) === -1) {
+ libs.push(lib);
+ }
+ });
+ });
+
+ return { exts: final, libs: getLibsByDeps(meta, libs), notIncludedExts: notIncludedExts };
+}
+
+export function getAllExtLibsByDeps(meta, exts) {
+ const sorted = [];
+ const visited = new Set();
+ const notIncludedExts = [];
+ exts.forEach((ext) => {
+ if (!visited.has(ext)) {
+ visitExtAllDeps(meta, ext, visited, sorted);
+ }
+ });
+ const libs = [];
+ sorted.forEach((ext) => {
+ if (exts.indexOf(ext) === -1) {
+ notIncludedExts.push(ext);
+ }
+ const allLibs = [...getExtLibDepends(meta, ext), ...getExtLibSuggests(meta, ext)];
+ allLibs.forEach((dep) => {
+ if (libs.indexOf(dep) === -1) {
+ libs.push(dep);
+ }
+ });
+ });
+ return { exts: sorted, libs: getAllLibsByDeps(meta, libs), notIncludedExts: notIncludedExts };
+}
+
+export function getAllLibsByDeps(meta, libs) {
+ const sorted = [];
+ const visited = new Set();
+
+ libs.forEach((lib) => {
+ if (!visited.has(lib)) {
+ console.log('before visited');
+ console.log(visited);
+ visitLibAllDeps(meta, lib, visited, sorted);
+ console.log('after visited');
+ console.log(visited);
+ }
+ });
+ return sorted;
+}
+
+export function getLibsByDeps(meta, libs) {
+ const sorted = [];
+ const visited = new Set();
+
+ libs.forEach((lib) => {
+ if (!visited.has(lib)) {
+ visitLibDeps(meta, lib, visited, sorted);
+ }
+ });
+
+ const sortedSuggests = [];
+ const visitedSuggests = new Set();
+ const final = [];
+ libs.forEach((lib) => {
+ if (!visitedSuggests.has(lib)) {
+ visitLibAllDeps(meta, lib, visitedSuggests, sortedSuggests);
+ }
+ });
+ sortedSuggests.forEach((suggest) => {
+ if (sorted.indexOf(suggest) !== -1) {
+ final.push(suggest);
+ }
+ });
+ return final;
+}
+
+export function visitLibAllDeps(meta, lib_name, visited, sorted) {
+ if (visited.has(lib_name)) {
+ return;
+ }
+ visited.add(lib_name);
+ const allLibs = [...getLibDepends(meta, lib_name), ...getLibSuggests(meta, lib_name)];
+ allLibs.forEach((dep) => {
+ visitLibDeps(meta, dep, visited, sorted);
+ });
+ sorted.push(lib_name);
+}
+
+export function visitLibDeps(meta, lib_name, visited, sorted) {
+ if (visited.has(lib_name)) {
+ return;
+ }
+ visited.add(lib_name);
+ getLibDepends(meta, lib_name).forEach((dep) => {
+ visitLibDeps(meta, dep, visited, sorted);
+ });
+ sorted.push(lib_name);
+}
+
+export function visitExtDeps(meta, ext_name, visited, sorted) {
+ if (visited.has(visited)) {
+ return;
+ }
+ visited.add(ext_name);
+ getExtDepends(meta, ext_name).forEach((dep) => {
+ visitExtDeps(meta, dep, visited, sorted);
+ });
+ sorted.push(ext_name);
+}
+
+export function visitExtAllDeps(meta, ext_name, visited, sorted) {
+ if (visited.has(ext_name)) {
+ return;
+ }
+ visited.add(ext_name);
+
+ const allExts = [...getExtDepends(meta, ext_name), ...getExtSuggests(meta, ext_name)];
+ allExts.forEach((dep) => {
+ visitExtDeps(meta, dep, visited, sorted);
+ });
+ sorted.push(ext_name);
+}
\ No newline at end of file
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
new file mode 100644
index 00000000..7205a606
--- /dev/null
+++ b/docs/.vitepress/config.ts
@@ -0,0 +1,52 @@
+import sidebarEn from "./sidebar.en";
+import sidebarZh from "./sidebar.zh";
+
+
+// https://vitepress.dev/reference/site-config
+export default {
+ title: "static-php-cli",
+ description: "Build single static PHP binary, with PHP project together, with popular extensions included.",
+ locales: {
+ en: {
+ label: 'English',
+ lang: 'en',
+ themeConfig: {
+ nav: [
+ {text: 'Guide', link: '/en/guide/',},
+ {text: 'Advanced', link: '/en/develop/'},
+ {text: 'Contributing', link: '/en/contributing/'},
+ {text: 'FAQ', link: '/en/faq/'},
+ ],
+ sidebar: sidebarEn,
+ footer: {
+ message: 'Released under the MIT License.',
+ copyright: 'Copyright © 2023-present crazywhalecc'
+ }
+ },
+ },
+ zh: {
+ label: '简体中文',
+ lang: 'zh', // optional, will be added as `lang` attribute on `html` tag
+ themeConfig: {
+ nav: [
+ {text: '构建指南', link: '/zh/guide/'},
+ {text: '进阶', link: '/zh/develop/'},
+ {text: '贡献', link: '/zh/contributing/'},
+ {text: 'FAQ', link: '/zh/faq/'},
+ ],
+ sidebar: sidebarZh,
+ footer: {
+ message: 'Released under the MIT License.',
+ copyright: 'Copyright © 2023-present crazywhalecc'
+ }
+ },
+ }
+ },
+ themeConfig: {
+ // https://vitepress.dev/reference/default-theme-config
+ nav: [],
+ socialLinks: [
+ {icon: 'github', link: 'https://github.com/crazywhalecc/static-php-cli'}
+ ]
+ }
+}
diff --git a/docs/.vitepress/sidebar.en.ts b/docs/.vitepress/sidebar.en.ts
new file mode 100644
index 00000000..b9c80aae
--- /dev/null
+++ b/docs/.vitepress/sidebar.en.ts
@@ -0,0 +1,54 @@
+export default {
+ '/en/guide/': [
+ {
+ text: 'Guide',
+ items: [
+ {text: 'Guide', link: '/en/guide/'},
+ {text: 'Actions Build', link: '/en/guide/action-build'},
+ {text: 'Manual Build', link: '/en/guide/manual-build'},
+ {text: 'Extension List', link: '/en/guide/extensions'},
+ {text: 'Extension Notes', link: '/en/guide/extension-notes'},
+ {text: 'Command Generator', link: '/en/guide/cli-generator'},
+ {text: 'Environment Variables', link: '/en/guide/env-vars', collapsed: true,},
+ {text: 'Dependency Table', link: '/en/guide/deps-map'},
+ ]
+ },
+ {
+ items: [
+ {text: 'Troubleshooting', link: '/en/guide/troubleshooting'},
+ {text: 'Build on Windows', link: '/en/guide/build-on-windows'},
+ ],
+ }
+ ],
+ '/en/develop/': [
+ {
+ text: 'Development',
+ items: [
+ {text: 'Get Started', link: '/en/develop/'},
+ {text: 'Project Structure', link: '/en/develop/structure'},
+ {text: 'PHP Source Modification', link: '/en/develop/php-src-changes'},
+ ],
+ },
+ {
+ text: 'Module',
+ items: [
+ {text: 'Doctor ', link: '/en/develop/doctor-module'},
+ {text: 'Source', link: '/en/develop/source-module'},
+ ]
+ },
+ {
+ text: 'Extra',
+ items: [
+ {text: 'Compilation Tools', link: '/en/develop/system-build-tools'},
+ ]
+ }
+ ],
+ '/en/contributing/': [
+ {
+ text: 'Contributing',
+ items: [
+ {text: 'Contributing', link: '/en/contributing/'},
+ ],
+ }
+ ],
+};
diff --git a/docs/.vitepress/sidebar.zh.ts b/docs/.vitepress/sidebar.zh.ts
new file mode 100644
index 00000000..a17ac0f0
--- /dev/null
+++ b/docs/.vitepress/sidebar.zh.ts
@@ -0,0 +1,54 @@
+export default {
+ '/zh/guide/': [
+ {
+ text: '构建指南',
+ items: [
+ {text: '指南', link: '/zh/guide/'},
+ {text: 'Actions 构建', link: '/zh/guide/action-build'},
+ {text: '本地构建', link: '/zh/guide/manual-build'},
+ {text: '扩展列表', link: '/zh/guide/extensions'},
+ {text: '扩展注意事项', link: '/zh/guide/extension-notes'},
+ {text: '编译命令生成器', link: '/zh/guide/cli-generator'},
+ {text: '环境变量列表', link: '/zh/guide/env-vars'},
+ {text: '依赖关系图表', link: '/zh/guide/deps-map'},
+ ]
+ },
+ {
+ items: [
+ {text: '故障排除', link: '/zh/guide/troubleshooting'},
+ {text: '在 Windows 上构建', link: '/zh/guide/build-on-windows'},
+ ],
+ }
+ ],
+ '/zh/develop/': [
+ {
+ text: '开发指南',
+ items: [
+ { text: '开发简介', link: '/zh/develop/' },
+ { text: '项目结构简介', link: '/zh/develop/structure' },
+ {text: '对 PHP 源码的修改', link: '/zh/develop/php-src-changes'},
+ ],
+ },
+ {
+ text: '模块',
+ items: [
+ { text: 'Doctor 环境检查工具', link: '/zh/develop/doctor-module' },
+ { text: '资源模块', link: '/zh/develop/source-module' },
+ ]
+ },
+ {
+ text: '其他',
+ items: [
+ {text: '系统编译工具', link: '/zh/develop/system-build-tools'},
+ ]
+ }
+ ],
+ '/zh/contributing/': [
+ {
+ text: '贡献指南',
+ items: [
+ {text: '贡献指南', link: '/zh/contributing/'},
+ ],
+ }
+ ],
+};
diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
new file mode 100644
index 00000000..8dd36ba8
--- /dev/null
+++ b/docs/.vitepress/theme/index.ts
@@ -0,0 +1,16 @@
+// docs/.vitepress/theme/index.ts
+import DefaultTheme from 'vitepress/theme'
+import {inBrowser, useData} from "vitepress";
+import {watchEffect} from "vue";
+
+export default {
+ ...DefaultTheme,
+ setup() {
+ const { lang } = useData()
+ watchEffect(() => {
+ if (inBrowser) {
+ document.cookie = `nf_lang=${lang.value}; expires=Mon, 1 Jan 2024 00:00:00 UTC; path=/`
+ }
+ })
+ }
+}
\ No newline at end of file
diff --git a/docs/deps-map-ext.md b/docs/deps-map-ext.md
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/deps-map-lib.md b/docs/deps-map-lib.md
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/en/contributing/index.md b/docs/en/contributing/index.md
new file mode 100644
index 00000000..6dc5ecf5
--- /dev/null
+++ b/docs/en/contributing/index.md
@@ -0,0 +1,63 @@
+# Contributing
+
+Thank you for being here, this project welcomes your contributions!
+
+## Contribution Guide
+
+If you have code or documentation to contribute, here's what you need to know first.
+
+1. What type of code are you contributing? (new extensions, bug fixes, security issues, project framework optimizations, documentation)
+2. If you contribute new files or new snippets, is your code checked by `php-cs-fixer` and `phpstan`?
+3. Have you fully read the [Developer Guide](../develop/) before contributing code?
+
+If you can answer the above questions and have made changes to the code,
+you can initiate a Pull Request in the project GitHub repository in time.
+After the code review is completed, the code can be modified according to the suggestion, or directly merged into the main branch.
+
+## Contribution Type
+
+The main purpose of this project is to compile statically linked PHP binaries,
+and the command line processing function is written based on `symfony/console`.
+Before development, if you are not familiar with it,
+Check out the [symfony/console documentation](https://symfony.com/doc/current/components/console.html) first.
+
+### Security Update
+
+Because this project is basically a PHP project running locally, generally speaking, there will be no remote attacks.
+But if you find such a problem, please **DO NOT submit a PR or Issue in the GitHub repository,
+You need to contact the project maintainer (crazywhalecc) via [mail](mailto:admin@zhamao.me).
+
+### Fix Bugs
+
+Fixing bugs generally does not involve modification of the project structure and framework,
+so if you can locate the wrong code and fix it directly, please submit a PR directly.
+
+### New Extensions
+
+For adding a new extension,
+you need to understand some basic structure of the project and how to add a new extension according to the existing logic.
+It will be covered in detail in the next section on this page.
+In general, you will need:
+
+1. Evaluate whether the extension can be compiled inline into PHP.
+2. Evaluate whether the extension's dependent libraries (if any) can be compiled statically.
+3. Write library compile commands on different platforms.
+4. Verify that the extension and its dependencies are compatible with existing extensions and dependencies.
+5. Verify that the extension works normally in `cli`, `micro`, `fpm`, `embed` SAPIs.
+6. Write documentation and add your extension.
+
+### Project Framework Optimization
+
+If you are already familiar with the working principle of `symfony/console`,
+and at the same time want to make some modifications or optimizations to the framework of the project,
+please understand the following things first:
+
+1. Adding extensions does not belong to project framework optimization,
+but if you find that you have to optimize the framework when adding new extensions,
+you need to modify the framework itself before adding extensions.
+2. For some large-scale logical modifications (such as those involving LibraryBase, Extension objects, etc.),
+it is recommended to submit an Issue or Draft PR for discussion first.
+3. In the early stage of the project, it was a pure private development project, and there were some Chinese comments in the code.
+After internationalizing your project you can submit a PR to translate these comments into English.
+4. Please do not submit more useless code fragments in the code,
+such as a large number of unused variables, methods, classes, and code that has been rewritten many times.
diff --git a/docs/en/develop/doctor-module.md b/docs/en/develop/doctor-module.md
new file mode 100644
index 00000000..64aed4af
--- /dev/null
+++ b/docs/en/develop/doctor-module.md
@@ -0,0 +1,70 @@
+# Doctor module
+
+The Doctor module is a relatively independent module used to check the system environment, which can be entered with the command `bin/spc doctor`, and the entry command class is in `DoctorCommand.php`.
+
+The Doctor module is a checklist with a series of check items and automatic repair items.
+These items are stored in the `src/SPC/doctor/item/` directory,
+And two Attributes are used as check item tags and auto-fix item tags: `#[AsCheckItem]` and `#[AsFixItem]`.
+
+Take the existing check item `if necessary tools are installed`,
+which is used to check whether the packages necessary for compilation are installed in the macOS system.
+The following is its source code:
+
+```php
+use SPC\doctor\AsCheckItem;
+use SPC\doctor\AsFixItem;
+use SPC\doctor\CheckResult;
+
+#[AsCheckItem('if necessary tools are installed', limit_os: 'Darwin', level: 997)]
+public function checkCliTools(): ?CheckResult
+{
+ $missing = [];
+ foreach (self::REQUIRED_COMMANDS as $cmd) {
+ if ($this->findCommand($cmd) === null) {
+ $missing[] = $cmd;
+ }
+ }
+ if (!empty($missing)) {
+ return CheckResult::fail('missing system commands: ' . implode(', ', $missing), 'build-tools', [$missing]);
+ }
+ return CheckResult::ok();
+}
+```
+
+The first parameter of the attribute is the name of the check item,
+and the following `limit_os` parameter restricts the check item to be triggered only under the specified system,
+and `level` is the priority of executing the check item, the larger the number, the higher the priority higher.
+
+The `$this->findCommand()` method used in it is the method of `SPC\builder\traits\UnixSystemUtilTrait`,
+the purpose is to find the location of the system command, and return NULL if it cannot be found.
+
+Each check item method should return a `SPC\doctor\CheckResult`:
+
+- When returning `CheckResult::fail()`, the first parameter is used to output the error prompt of the terminal,
+ and the second parameter is the name of the repair item when this check item can be automatically repaired.
+- When `CheckResult::ok()` is returned, the check passed. You can also pass a parameter to return the check result, for example: `CheckResult::ok('OS supported')`.
+- When returning `CheckResult::fail()`, if the third parameter is included, the array of the third parameter will be used as the parameter of `AsFixItem`.
+
+The following is the method for automatically repairing items corresponding to this check item:
+
+```php
+#[AsFixItem('build-tools')]
+public function fixBuildTools(array $missing): bool
+{
+ foreach ($missing as $cmd) {
+ try {
+ shell(true)->exec('brew install ' . escapeshellarg($cmd));
+ } catch (RuntimeException) {
+ return false;
+ }
+ }
+ return true;
+}
+```
+
+`#[AsFixItem()]` first parameter is the name of the fix item, and this method must return True or False.
+When False is returned, the automatic repair failed and manual handling is required.
+
+In the code here, `shell()->exec()` is the method of executing commands of the project,
+which is used to replace `exec()` and `system()`, and also provides debugging, obtaining execution status,
+entering directories, etc. characteristic.
diff --git a/docs/en/develop/index.md b/docs/en/develop/index.md
new file mode 100644
index 00000000..33e4163f
--- /dev/null
+++ b/docs/en/develop/index.md
@@ -0,0 +1,35 @@
+# Start Developing
+
+Developing this project requires the installation and deployment of a PHP environment,
+as well as some extensions and Composer commonly used in PHP projects.
+
+The development environment and running environment of the project are almost exactly the same.
+You can refer to the **Manual Build** section to install system PHP or use the pre-built static PHP of this project as the environment.
+I will not go into details here.
+
+Regardless of its purpose, this project itself is actually a `php-cli` program. You can edit and develop it as a normal PHP project.
+At the same time, you need to understand the Shell languages of different systems.
+
+The current purpose of this project is to compile statically compiled independent PHP,
+but the main part also includes compiling static versions of many dependent libraries,
+so you can reuse this set of compilation logic to build independent binary versions of other programs, such as Nginx, etc.
+
+## Environment preparation
+
+A PHP environment is required to develop this project. You can use the PHP that comes with the system,
+or you can use the static PHP built by this project.
+
+Regardless of which PHP you use, in your development environment you need to install these extensions:
+
+```
+curl,dom,filter,mbstring,openssl,pcntl,phar,posix,sodium,tokenizer,xml,xmlwriter
+```
+
+The static-php-cli project itself does not require so many extensions, but during the development process,
+you will use tools such as Composer and PHPUnit, which require these extensions.
+
+> For micro self-executing binaries built by static-php-cli itself, only `pcntl,posix,mbstring,tokenizer,phar` is required.
+
+## Start development
+
+Continuing down to see the project structure documentation, you can learn how `static-php-cli` works.
diff --git a/docs/en/develop/php-src-changes.md b/docs/en/develop/php-src-changes.md
new file mode 100644
index 00000000..19070259
--- /dev/null
+++ b/docs/en/develop/php-src-changes.md
@@ -0,0 +1,59 @@
+# Modifications to PHP source code
+
+During the static compilation process, static-php-cli made some modifications to the PHP source code
+in order to achieve good compatibility, performance, and security.
+The following is a description of the current modifications to the PHP source code.
+
+## Micro related patches
+
+Based on the patches provided by the phpmicro project,
+static-php-cli has made some modifications to the PHP source code to meet the needs of static compilation.
+The patches currently used by static-php-cli during compilation in the [patch list](https://github.com/easysoft/phpmicro/tree/master/patches) are:
+
+- static_opcache
+- static_extensions_win32
+- cli_checks
+- disable_huge_page
+- vcruntime140
+- win32
+- zend_stream
+- cli_static
+- macos_iconv
+- phar
+
+## PHP <= 8.1 libxml patch
+
+Because PHP only provides security updates for 8.1 and stops updating older versions,
+static-php-cli applies the libxml compilation patch that has been applied in newer versions of PHP to PHP 8.1 and below.
+
+## gd extension Windows patch
+
+Compiling the gd extension under Windows requires major changes to the `config.w32` file.
+static-php-cli has made some changes to the gd extension to make it easier to compile under Windows.
+
+## YAML extension Windows patch
+
+YAML extension needs to modify the `config.w32` file to compile under Windows.
+static-php-cli has made some modifications to the YAML extension to make it easier to compile under Windows.
+
+## static-php-cli version information insertion
+
+When compiling, static-php-cli will insert the static-php-cli version information into the PHP version information for easy identification.
+
+## Add option to hardcode INI
+
+When using the `-I` parameter to hardcode INI into static PHP functionality,
+static-php-cli will modify the PHP source code to insert the hardcoded content.
+
+## Linux system repair patch
+
+Some compilation environments may lack some system header files or libraries.
+static-php-cli will automatically fix these problems during compilation, such as:
+
+- HAVE_STRLCAT missing problem
+- HAVE_STRLCPY missing problem
+
+## Fiber issue fix patch for Windows
+
+When compiling PHP on Windows, there will be some issues with the Fiber extension.
+static-php-cli will automatically fix these issues during compilation (modify `config.w32` in php-src).
diff --git a/docs/en/develop/source-module.md b/docs/en/develop/source-module.md
new file mode 100644
index 00000000..4b1b1fc0
--- /dev/null
+++ b/docs/en/develop/source-module.md
@@ -0,0 +1,340 @@
+# Source module
+
+The download source module of static-php-cli is a major module.
+It includes dependent libraries, external extensions, PHP source code download methods and file decompression methods.
+The download configuration file mainly involves the `source.json` and `pkg.json` file, which records the download method of all downloadable sources.
+
+The main commands involved in the download function are `bin/spc download` and `bin/spc extract`.
+The `download` command is a downloader that downloads sources according to the configuration file,
+and the `extract` command is an extractor that extract sources from downloaded files.
+
+Generally speaking, downloading sources may be slow because these sources come from various official websites, GitHub,
+and other different locations.
+At the same time, they also occupy a large space, so you can download the sources once and reuse them.
+
+The configuration file of the downloader is `source.json`, which contains the download methods of all sources.
+You can add the source download methods you need, or modify the existing source download methods.
+
+The download configuration structure of each source is as follows.
+The following is the source download configuration corresponding to the `libevent` extension:
+
+```json
+{
+ "libevent": {
+ "type": "ghrel",
+ "repo": "libevent/libevent",
+ "match": "libevent.+\\.tar\\.gz",
+ "provide-pre-built": true,
+ "license": {
+ "type": "file",
+ "path": "LICENSE"
+ }
+ }
+}
+```
+
+The most important field here is `type`. Currently, the types it supports are:
+
+- `url`: Directly use URL to download, for example: `https://download.libsodium.org/libsodium/releases/libsodium-1.0.18.tar.gz`.
+- `ghrel`: Use the GitHub Release API to download, download the artifacts uploaded from the latest version released by maintainers.
+- `ghtar`: Use the GitHub Release API to download.
+ Different from `ghrel`, `ghtar` is downloaded from the `source code (tar.gz)` in the latest Release of the project.
+- `ghtagtar`: Use GitHub Release API to download.
+ Compared with `ghtar`, `ghtagtar` can find the latest one from the `tags` list and download the source code in `tar.gz` format
+ (because some projects only use `tag` release version).
+- `bitbuckettag`: Download using BitBucket API, basically the same as `ghtagtar`, except this one applies to BitBucket.
+- `git`: Clone the project directly from a Git address to download sources, applicable to any public Git repository.
+- `filelist`: Use a crawler to crawl the Web download site that provides file index,
+ and get the latest version of the file name and download it.
+- `custom`: If none of the above download methods are satisfactory, you can write `custom`,
+ create a new class under `src/SPC/store/source/`, extends `CustomSourceBase`, and write the download script yourself.
+
+## source.json Common parameters
+
+Each source file in source.json has the following params:
+
+- `license`: the open source license of the source code, see **Open Source License** section below
+- `type`: must be one of the types mentioned above
+- `path` (optional): release the source code to the specified directory instead of `source/{name}`
+- `provide-pre-built` (optional): whether to provide precompiled binary files.
+ If `true`, it will automatically try to download precompiled binary files when running `bin/spc download`
+
+::: tip
+The `path` parameter in `source.json` can specify a relative or absolute path. When specified as a relative path, the path is based on `source/`.
+:::
+
+## Download type - url
+
+URL type sources refer to downloading files directly from the URL.
+
+The parameters included are:
+
+- `url`: The download address of the file, such as `https://example.com/file.tgz`
+- `filename` (optional): The file name saved to the local area. If not specified, the file name of the url will be used.
+
+Example (download the imagick extension and extract it to the extension storage path of the php source code):
+
+```json
+{
+ "ext-imagick": {
+ "type": "url",
+ "url": "https://pecl.php.net/get/imagick",
+ "path": "php-src/ext/imagick",
+ "filename": "imagick.tgz",
+ "license": {
+ "type": "file",
+ "path": "LICENSE"
+ }
+ }
+}
+```
+
+## Download type - ghrel
+
+ghrel will download files from Assets uploaded in GitHub Release.
+First use the GitHub Release API to get the latest version, and then download the corresponding files according to the regular matching method.
+
+The parameters included are:
+
+- `repo`: GitHub repository name
+- `match`: regular expression matching Assets files
+- `prefer-stable`: Whether to download stable versions first (default is `false`)
+
+Example (download the libsodium library, matching the libsodium-x.y.tar.gz file in Release):
+
+```json
+{
+ "libsodium": {
+ "type": "ghrel",
+ "repo": "jedisct1/libsodium",
+ "match": "libsodium-\\d+(\\.\\d+)*\\.tar\\.gz",
+ "license": {
+ "type": "file",
+ "path": "LICENSE"
+ }
+ }
+}
+```
+
+## Download type - ghtar
+
+ghtar will download the file from the GitHub Release Tag.
+Unlike `ghrel`, `ghtar` will download the `source code (tar.gz)` from the latest Release of the project.
+
+The parameters included are:
+
+- `repo`: GitHub repository name
+- `prefer-stable`: Whether to download stable versions first (default is `false`)
+
+Example (brotli library):
+
+```json
+{
+ "brotli": {
+ "type": "ghtar",
+ "repo": "google/brotli",
+ "license": {
+ "type": "file",
+ "path": "LICENSE"
+ }
+ }
+}
+```
+
+## Download type - ghtagtar
+
+Use the GitHub Release API to download.
+Compared with `ghtar`, `ghtagtar` can find the latest one from the `tags` list and download the source code in `tar.gz` format
+(because some projects only use the `tag` version).
+
+The parameters included are:
+
+- `repo`: GitHub repository name
+- `prefer-stable`: Whether to download stable versions first (default is `false`)
+
+Example (gmp library):
+
+```json
+{
+ "gmp": {
+ "type": "ghtagtar",
+ "repo": "alisw/GMP",
+ "license": {
+ "type": "text",
+ "text": "EXAMPLE LICENSE"
+ }
+ }
+}
+```
+
+## Download Type - bitbuckettag
+
+Download using BitBucket API, basically the same as `ghtagtar`, except this one works with BitBucket.
+
+The parameters included are:
+
+- `repo`: BitBucket repository name
+
+## Download type - git
+
+Clone the project directly from a Git address to download sources, applicable to any public Git repository.
+
+The parameters included are:
+
+- `url`: Git link (HTTPS only)
+- `rev`: branch name
+
+```json
+{
+ "imap": {
+ "type": "git",
+ "url": "https://github.com/static-php/imap.git",
+ "rev": "master",
+ "license": {
+ "type": "file",
+ "path": "LICENSE"
+ }
+ }
+}
+```
+
+## Download type - filelist
+
+Use a crawler to crawl a web download site that provides a file index and get the latest version of the file name and download it.
+
+Note that this method is only applicable to static sites with page index functions such as mirror sites and GNU official websites.
+
+The parameters included are:
+
+- `url`: The URL of the page to crawl the latest version of the file
+- `regex`: regular expression matching file names and download links
+
+Example (download the libiconv library from the GNU official website):
+
+```json
+{
+ "libiconv": {
+ "type": "filelist",
+ "url": "https://ftp.gnu.org/gnu/libiconv/",
+ "regex": "/href=\"(?{{ I18N[lang].selectedSystem }}
+
+
+
+
+
+
+ {{ I18N[lang].selectExt }}{{ checkedExts.length > 0 ? (' (' + checkedExts.length + ')') : '' }}
+
+
+
+
+
+
+
+
+
+ {{ I18N[lang].selectCommon }}
+ {{ I18N[lang].selectNone }}
+
+
+
+ {{ I18N[lang].buildLibs }}{{ checkedLibs.length > 0 ? (' (' + checkedLibs.length + ')') : '' }}
+
+
+
+
+
+
+
+
+ TIP
+{{ I18N[lang].depTips }}
+{{ I18N[lang].buildTarget }}
+
+
+
+
+
+
+
+
+ WARNING
+{{ I18N[lang].microUnavailable }}
+
+
+ WARNING
+{{ I18N[lang].windowsSAPIUnavailable }}
+{{ I18N[lang].buildOptions }}
+ +| {{ I18N[lang].buildEnvironment }} | ++ + | +
| {{ I18N[lang].downloadPhpVersion }} | ++ + | +
| {{ I18N[lang].useDebug }} | ++ + + + + | +
| {{ I18N[lang].useZTS }} | ++ + + + + | +
| {{ I18N[lang].resultShowDownload }} | ++ + + + + | +
| {{ I18N[lang].usePreBuilt }} | ++ + + + + | +
| {{ I18N[lang].useUPX }} | ++ + + + + | +
{{ I18N[lang].hardcodedINI }}
+ +{{ I18N[lang].resultShow }}
+
+ {{ I18N[lang].downloadSPCBinaryCommand }}
+
+
+ curl -fsSL -o spc.tgz https://dl.static-php.dev/static-php-cli/spc-bin/nightly/spc-{{ selectedSystem }}-{{ selectedArch }}.tar.gz && tar -zxvf spc.tgz && rm spc.tgz
+
+ +
+
+
+
+ WARNING
+{{ I18N[lang].windowsDownSPCWarning }}
+
+ {{ I18N[lang].downloadExtOnlyCommand }}
+
+ {{ spcCommand }} download --with-php={{ selectedPhpVersion }} --for-extensions "{{ extList }}"{{ preBuilt ? ' --prefer-pre-built' : '' }}{{ debug ? ' --debug' : '' }}
+
+ {{ I18N[lang].downloadAllCommand }}
+
+ {{ spcCommand }} download --all --with-php={{ selectedPhpVersion }}{{ preBuilt ? ' --prefer-pre-built' : '' }}{{ debug ? ' --debug' : '' }}
+
+ {{ I18N[lang].downloadUPXCommand }}
+
+ {{ spcCommand }} install-pkg upx{{ debug ? ' --debug' : '' }}
+
+ {{ I18N[lang].compileCommand }}
+
+ {{ spcCommand }} build {{ buildCommand }} "{{ extList }}"{{ additionalLibs }}{{ debug ? ' --debug' : '' }}{{ zts ? ' --enable-zts' : '' }}{{ enableUPX ? ' --with-upx-pack' : '' }}{{ displayINI }}
+ ', $ext['ext-depends-linux'] ?? $ext['ext-depends-unix'] ?? $ext['ext-depends'] ?? []), + implode('
', $ext['ext-suggests-linux'] ?? $ext['ext-suggests-unix'] ?? $ext['ext-suggests'] ?? []), + implode('
', $ext['lib-depends-linux'] ?? $ext['lib-depends-unix'] ?? $ext['lib-depends'] ?? []), + implode('
', $ext['lib-suggests-linux'] ?? $ext['lib-suggests-unix'] ?? $ext['lib-suggests'] ?? []), + ]; + $this->applyMaxLen($max_linux, $line_linux); + if ($this->isSupported($ext, 'Linux') && !$this->isEmptyLine($line_linux)) { + $md_lines_linux[] = $line_linux; + } + $line_macos = [ + "{$ext_name}", + implode('
', $ext['ext-depends-macos'] ?? $ext['ext-depends-unix'] ?? $ext['ext-depends'] ?? []), + implode('
', $ext['ext-suggests-macos'] ?? $ext['ext-suggests-unix'] ?? $ext['ext-suggests'] ?? []), + implode('
', $ext['lib-depends-macos'] ?? $ext['lib-depends-unix'] ?? $ext['lib-depends'] ?? []), + implode('
', $ext['lib-suggests-macos'] ?? $ext['lib-suggests-unix'] ?? $ext['lib-suggests'] ?? []), + ]; + $this->applyMaxLen($max_macos, $line_macos); + if ($this->isSupported($ext, 'macOS') && !$this->isEmptyLine($line_macos)) { + $md_lines_macos[] = $line_macos; + } + $line_windows = [ + "{$ext_name}", + implode('
', $ext['ext-depends-windows'] ?? $ext['ext-depends-win'] ?? $ext['ext-depends'] ?? []), + implode('
', $ext['ext-suggests-windows'] ?? $ext['ext-suggests-win'] ?? $ext['ext-suggests'] ?? []), + implode('
', $ext['lib-depends-windows'] ?? $ext['lib-depends-win'] ?? $ext['lib-depends'] ?? []), + implode('
', $ext['lib-suggests-windows'] ?? $ext['lib-suggests-win'] ?? $ext['lib-suggests'] ?? []), + ]; + $this->applyMaxLen($max_windows, $line_windows); + if ($this->isSupported($ext, 'Windows') && !$this->isEmptyLine($line_windows)) { + $md_lines_windows[] = $line_windows; + } + $line_freebsd = [ + "{$ext_name}", + implode('
', $ext['ext-depends-freebsd'] ?? $ext['ext-depends-bsd'] ?? $ext['ext-depends-unix'] ?? $ext['ext-depends'] ?? []), + implode('
', $ext['ext-suggests-freebsd'] ?? $ext['ext-suggests-bsd'] ?? $ext['ext-suggests-unix'] ?? $ext['ext-suggests'] ?? []), + implode('
', $ext['lib-depends-freebsd'] ?? $ext['lib-depends-bsd'] ?? $ext['lib-depends-unix'] ?? $ext['lib-depends'] ?? []), + implode('
', $ext['lib-suggests-freebsd'] ?? $ext['lib-suggests-bsd'] ?? $ext['lib-suggests-unix'] ?? $ext['lib-suggests'] ?? []), + ]; + $this->applyMaxLen($max_freebsd, $line_freebsd); + if ($this->isSupported($ext, 'BSD') && !$this->isEmptyLine($line_freebsd)) { + $md_lines_freebsd[] = $line_freebsd; + } + } + + // Generate markdown + if (!empty($md_lines_linux)) { + $content .= "### Linux\n\n"; + $content .= '| '; + $pads = ['Extension Name', 'Required Extensions', 'Suggested Extensions', 'Required Libraries', 'Suggested Libraries']; + // 生成首行 + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad($pad, $max_linux[$i]), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + // 生成第二行表格分割符 | --- | --- | --- | --- | --- | + $content .= '| '; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad('', $max_linux[$i], '-'), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + foreach ($md_lines_linux as $line) { + $content .= '| ' . implode(' | ', array_map(fn ($i, $pad) => str_pad($line[$i], $max_linux[$i]), array_keys($line), $line)) . ' |' . PHP_EOL; + } + } + if (!empty($md_lines_macos)) { + $content .= "\n\n### macOS\n\n"; + $content .= '| '; + $pads = ['Extension Name', 'Required Extensions', 'Suggested Extensions', 'Required Libraries', 'Suggested Libraries']; + // 生成首行 + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad($pad, $max_macos[$i]), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + // 生成第二行表格分割符 | --- | --- | --- | --- | --- | + $content .= '| '; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad('', $max_macos[$i], '-'), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + foreach ($md_lines_macos as $line) { + $content .= '| ' . implode(' | ', array_map(fn ($i, $pad) => str_pad($line[$i], $max_macos[$i]), array_keys($line), $line)) . ' |' . PHP_EOL; + } + } + if (!empty($md_lines_windows)) { + $content .= "\n\n### Windows\n\n"; + $content .= '| '; + $pads = ['Extension Name', 'Required Extensions', 'Suggested Extensions', 'Required Libraries', 'Suggested Libraries']; + // 生成首行 + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad($pad, $max_windows[$i]), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + // 生成第二行表格分割符 | --- | --- | --- | --- | --- | + $content .= '| '; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad('', $max_windows[$i], '-'), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + foreach ($md_lines_windows as $line) { + $content .= '| ' . implode(' | ', array_map(fn ($i, $pad) => str_pad($line[$i], $max_windows[$i]), array_keys($line), $line)) . ' |' . PHP_EOL; + } + } + if (!empty($md_lines_freebsd)) { + $content .= "\n\n### FreeBSD\n\n"; + $content .= '| '; + $pads = ['Extension Name', 'Required Extensions', 'Suggested Extensions', 'Required Libraries', 'Suggested Libraries']; + // 生成首行 + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad($pad, $max_freebsd[$i]), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + // 生成第二行表格分割符 | --- | --- | --- | --- | --- | + $content .= '| '; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad('', $max_freebsd[$i], '-'), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + foreach ($md_lines_freebsd as $line) { + $content .= '| ' . implode(' | ', array_map(fn ($i, $pad) => str_pad($line[$i], $max_freebsd[$i]), array_keys($line), $line)) . ' |' . PHP_EOL; + } + } + + $this->output->writeln($content); + return static::SUCCESS; + } + + private function applyMaxLen(array &$max, array $lines): void + { + foreach ($max as $k => $v) { + $max[$k] = max($v, strlen($lines[$k])); + } + } + + private function isSupported(array $ext, string $os): bool + { + return !in_array($ext['support'][$os] ?? 'yes', ['no', 'wip']); + } + + private function isEmptyLine(array $line): bool + { + return $line[1] === '' && $line[2] === '' && $line[3] === '' && $line[4] === ''; + } +} diff --git a/src/SPC/command/dev/GenerateExtDocCommand.php b/src/SPC/command/dev/GenerateExtDocCommand.php new file mode 100644 index 00000000..c53e529d --- /dev/null +++ b/src/SPC/command/dev/GenerateExtDocCommand.php @@ -0,0 +1,80 @@ + $ext) { + // notes is optional + $name = ($ext['notes'] ?? false) === true ? "[{$ext_name}](./extension-notes#{$ext_name})" : $ext_name; + // calculate max length + $max_name = max($max_name, strlen($name)); + + // linux + $linux = match ($ext['support']['Linux'] ?? 'yes') { + 'wip' => '', + default => $ext['support']['Linux'] ?? 'yes', + }; + $max_linux = max($max_linux, strlen($linux)); + + // macos + $macos = match ($ext['support']['Darwin'] ?? 'yes') { + 'wip' => '', + default => $ext['support']['Darwin'] ?? 'yes', + }; + $max_macos = max($max_macos, strlen($macos)); + + // freebsd + $freebsd = match ($ext['support']['BSD'] ?? 'yes') { + 'wip' => '', + default => $ext['support']['BSD'] ?? 'yes', + }; + $max_freebsd = max($max_freebsd, strlen($freebsd)); + + // windows + $windows = match ($ext['support']['Windows'] ?? 'yes') { + 'wip' => '', + default => $ext['support']['Windows'] ?? 'yes', + }; + $max_windows = max($max_windows, strlen($windows)); + $md_lines[] = [ + $name, + $linux, + $macos, + $freebsd, + $windows, + ]; + } + + // generate markdown + $md = '| ' . str_pad('Extension Name', $max_name) . ' | ' . str_pad('Linux', $max_linux) . ' | ' . str_pad('macOS', $max_macos) . ' | ' . str_pad('FreeBSD', $max_freebsd) . ' | ' . str_pad('Windows', $max_windows) . ' |' . PHP_EOL; + $md .= '| ' . str_repeat('-', $max_name) . ' | ' . str_repeat('-', $max_linux) . ' | ' . str_repeat('-', $max_macos) . ' | ' . str_repeat('-', $max_freebsd) . ' | ' . str_repeat('-', $max_windows) . ' |' . PHP_EOL; + foreach ($md_lines as $line) { + $md .= '| ' . str_pad($line[0], $max_name) . ' | ' . str_pad($line[1], $max_linux) . ' | ' . str_pad($line[2], $max_macos) . ' | ' . str_pad($line[3], $max_freebsd) . ' | ' . str_pad($line[4], $max_windows) . ' |' . PHP_EOL; + } + $this->output->writeln($md); + return static::SUCCESS; + } +} diff --git a/src/SPC/command/dev/GenerateLibDepDocsCommand.php b/src/SPC/command/dev/GenerateLibDepDocsCommand.php new file mode 100644 index 00000000..feee99af --- /dev/null +++ b/src/SPC/command/dev/GenerateLibDepDocsCommand.php @@ -0,0 +1,172 @@ +support_lib_list[$os] = []; + $classes = FileSystem::getClassesPsr4( + FileSystem::convertPath(ROOT_DIR . '/src/SPC/builder/' . $os . '/library'), + 'SPC\builder\\' . $os . '\library' + ); + foreach ($classes as $class) { + if (defined($class . '::NAME') && $class::NAME !== 'unknown' && Config::getLib($class::NAME) !== null) { + $this->support_lib_list[$os][$class::NAME] = $class; + } + } + } + + // Get lib.json + $libs = json_decode(FileSystem::readFile(ROOT_DIR . '/config/lib.json'), true); + ConfigValidator::validateLibs($libs); + + // Markdown table needs format, we need to calculate the max length of each column + $content = ''; + + // Calculate table column max length + $max_linux = [0, 20, 19]; + $max_macos = [0, 20, 19]; + $max_windows = [0, 20, 19]; + $max_freebsd = [0, 20, 19]; + + $md_lines_linux = []; + $md_lines_macos = []; + $md_lines_windows = []; + $md_lines_freebsd = []; + + foreach ($libs as $lib_name => $lib) { + $line_linux = [ + "{$lib_name}", + implode('
', $lib['lib-depends-linux'] ?? $lib['lib-depends-unix'] ?? $lib['lib-depends'] ?? []), + implode('
', $lib['lib-suggests-linux'] ?? $lib['lib-suggests-unix'] ?? $lib['lib-suggests'] ?? []), + ]; + $this->applyMaxLen($max_linux, $line_linux); + if ($this->isSupported($lib_name, 'linux') && !$this->isEmptyLine($line_linux)) { + $md_lines_linux[] = $line_linux; + } + $line_macos = [ + "{$lib_name}", + implode('
', $lib['lib-depends-macos'] ?? $lib['lib-depends-unix'] ?? $lib['lib-depends'] ?? []), + implode('
', $lib['lib-suggests-macos'] ?? $lib['lib-suggests-unix'] ?? $lib['lib-suggests'] ?? []), + ]; + $this->applyMaxLen($max_macos, $line_macos); + if ($this->isSupported($lib_name, 'macos') && !$this->isEmptyLine($line_macos)) { + $md_lines_macos[] = $line_macos; + } + $line_windows = [ + "{$lib_name}", + implode('
', $lib['lib-depends-windows'] ?? $lib['lib-depends-win'] ?? $lib['lib-depends'] ?? []), + implode('
', $lib['lib-suggests-windows'] ?? $lib['lib-suggests-win'] ?? $lib['lib-suggests'] ?? []), + ]; + $this->applyMaxLen($max_windows, $line_windows); + if ($this->isSupported($lib_name, 'windows') && !$this->isEmptyLine($line_windows)) { + $md_lines_windows[] = $line_windows; + } + $line_freebsd = [ + "{$lib_name}", + implode('
', $lib['lib-depends-freebsd'] ?? $lib['lib-depends-bsd'] ?? $lib['lib-depends-unix'] ?? $lib['lib-depends'] ?? []), + implode('
', $lib['lib-suggests-freebsd'] ?? $lib['lib-suggests-bsd'] ?? $lib['lib-suggests-unix'] ?? $lib['lib-suggests'] ?? []), + ]; + $this->applyMaxLen($max_freebsd, $line_freebsd); + if ($this->isSupported($lib_name, 'freebsd') && !$this->isEmptyLine($line_freebsd)) { + $md_lines_freebsd[] = $line_freebsd; + } + } + + // Generate markdown + if (!empty($md_lines_linux)) { + $content .= "### Linux\n\n"; + $content .= '| '; + $pads = ['Library Name', 'Required Libraries', 'Suggested Libraries']; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad($pad, $max_linux[$i]), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + $content .= '| '; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad('', $max_linux[$i], '-'), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + foreach ($md_lines_linux as $line) { + $content .= '| ' . implode(' | ', array_map(fn ($i, $pad) => str_pad($line[$i], $max_linux[$i]), array_keys($line), $line)) . ' |' . PHP_EOL; + } + } + + if (!empty($md_lines_macos)) { + $content .= "### macOS\n\n"; + $content .= '| '; + $pads = ['Library Name', 'Required Libraries', 'Suggested Libraries']; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad($pad, $max_macos[$i]), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + $content .= '| '; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad('', $max_macos[$i], '-'), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + foreach ($md_lines_macos as $line) { + $content .= '| ' . implode(' | ', array_map(fn ($i, $pad) => str_pad($line[$i], $max_macos[$i]), array_keys($line), $line)) . ' |' . PHP_EOL; + } + } + + if (!empty($md_lines_windows)) { + $content .= "### Windows\n\n"; + $content .= '| '; + $pads = ['Library Name', 'Required Libraries', 'Suggested Libraries']; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad($pad, $max_windows[$i]), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + $content .= '| '; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad('', $max_windows[$i], '-'), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + foreach ($md_lines_windows as $line) { + $content .= '| ' . implode(' | ', array_map(fn ($i, $pad) => str_pad($line[$i], $max_windows[$i]), array_keys($line), $line)) . ' |' . PHP_EOL; + } + } + + if (!empty($md_lines_freebsd)) { + $content .= "### FreeBSD\n\n"; + $content .= '| '; + $pads = ['Library Name', 'Required Libraries', 'Suggested Libraries']; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad($pad, $max_freebsd[$i]), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + $content .= '| '; + $content .= implode(' | ', array_map(fn ($i, $pad) => str_pad('', $max_freebsd[$i], '-'), array_keys($pads), $pads)); + $content .= ' |' . PHP_EOL; + foreach ($md_lines_freebsd as $line) { + $content .= '| ' . implode(' | ', array_map(fn ($i, $pad) => str_pad($line[$i], $max_freebsd[$i]), array_keys($line), $line)) . ' |' . PHP_EOL; + } + } + + $this->output->writeln($content); + return static::SUCCESS; + } + + private function applyMaxLen(array &$max, array $lines): void + { + foreach ($max as $k => $v) { + $max[$k] = max($v, strlen($lines[$k])); + } + } + + private function isSupported(string $ext_name, string $os): bool + { + if (!in_array($os, ['linux', 'macos', 'freebsd', 'windows'])) { + throw new \InvalidArgumentException('Invalid os: ' . $os); + } + return isset($this->support_lib_list[$os][$ext_name]); + } + + private function isEmptyLine(array $line): bool + { + return $line[1] === '' && $line[2] === ''; + } +} diff --git a/src/SPC/command/dev/LibVerCommand.php b/src/SPC/command/dev/LibVerCommand.php new file mode 100644 index 00000000..717fd155 --- /dev/null +++ b/src/SPC/command/dev/LibVerCommand.php @@ -0,0 +1,60 @@ +addArgument('library', InputArgument::REQUIRED, 'The library name'); + } + + public function initialize(InputInterface $input, OutputInterface $output): void + { + $this->no_motd = true; + parent::initialize($input, $output); + } + + public function handle(): int + { + // Get lib object + $builder = BuilderProvider::makeBuilderByInput($this->input); + $builder->setLibsOnly(); + + // check lib name exist in lib.json + try { + Config::getLib($this->getArgument('library')); + } catch (WrongUsageException $e) { + $this->output->writeln("