README

Hoa 是一套 模块化、可扩展 和 结构化 的 PHP 库。
此外，Hoa 致力于成为工业界和学术界之间的桥梁。

Hoa\Compiler

该库允许操作 LL(1) 和 LL(k) 编译器编译器。为后者提供了一个专门的语法描述语言：PP 语言。

安装

使用 Composer，要将此库包含到依赖中，您需要要求 hoa/compiler

$ composer require hoa/compiler '~3.0'

有关更多安装说明，请阅读源代码页面。

测试

在运行测试套件之前，必须安装开发依赖项

$ composer install

然后，要运行所有测试套件

$ vendor/bin/hoa test:run

有关更多信息，请阅读贡献指南。

快速使用

作为一个快速概述，我们将查看 PP 语言和 LL(k) 编译器编译器。

PP 语言

语法由标记（单词的单元）和规则（请参阅文档以了解语言理论的介绍）组成。PP 语言使用以下结构声明标记

%token [source_namespace:]name value [-> destination_namespace]

默认命名空间是 default。标记的值由一个 PCRE 表示。我们可以使用 %skip 结构跳过标记。

以 JSON 语言的简化语法为例。完整的语法在 hoa://Library/Json/Grammar.pp 文件中。因此

%skip   space          \s
// Scalars.
%token  true           true
%token  false          false
%token  null           null
// Strings.
%token  quote_         "        -> string
%token  string:string  [^"]+
%token  string:_quote  "        -> default
// Objects.
%token  brace_         {
%token _brace          }
// Arrays.
%token  bracket_       \[
%token _bracket        \]
// Rest.
%token  colon          :
%token  comma          ,
%token  number         \d+

value:
    <true> | <false> | <null> | string() | object() | array() | number()

string:
    ::quote_:: <string> ::_quote::

number:
    <number>

#object:
    ::brace_:: pair() ( ::comma:: pair() )* ::_brace::

#pair:
    string() ::colon:: value()

#array:
    ::bracket_:: value() ( ::comma:: value() )* ::_bracket::

我们可以看到 PP 结构

rule() 调用规则；
<token> 和 ::token:: 声明标记；
| 表示析取；
(…) 将多个声明分组；
e? 表示 e 是可选的；
e+ 表示 e 至少出现 1 次；
e* 表示 e 可以出现 0 或多次；
e{x,y} 表示 e 可以出现 x 到 y 次；
#node 用于创建 AST（结果树）中的节点；
token[i] 用于统一标记值。

统一非常有用。例如，如果我们有一个表示引号（简单或双引号）的标记，我们可以有

%token  quote   "|'
%token  handle  \w+

string:
    ::quote:: <handle> ::quote::

因此，数据 "foo" 和 'foo' 将是有效的，但还可以是 "foo' 和 'foo"！为了避免这种情况，我们可以通过统一来添加新的标记值约束，从而

string:
    ::quote[0]:: <handle> ::quote[0]::

所有针对规则实例的 quote[0] 必须具有相同的值。另一个例子是 XML 标签名称的统一。

LL(k) 编译器编译器

Hoa\Compiler\Llk\Llk 类提供了操作（加载或保存）编译器的辅助工具。以下代码将使用之前的语法创建编译器，我们将解析 JSON 字符串。如果解析成功，它将生成一个我们可以访问的 AST（抽象语法树），例如，用于转储 AST

// 1. Load grammar.
$compiler = Hoa\Compiler\Llk\Llk::load(new Hoa\File\Read('Json.pp'));

// 2. Parse a data.
$ast = $compiler->parse('{"foo": true, "bar": [null, 42]}');

// 3. Dump the AST.
$dump = new Hoa\Compiler\Visitor\Dump();
echo $dump->visit($ast);

/**
 * Will output:
 *     >  #object
 *     >  >  #pair
 *     >  >  >  token(string, foo)
 *     >  >  >  token(true, true)
 *     >  >  #pair
 *     >  >  >  token(string, bar)
 *     >  >  >  #array
 *     >  >  >  >  token(null, null)
 *     >  >  >  >  token(number, 42)
 */

非常简单。

CLI 中的编译器

这个库提出了一种脚本，用于解析并应用特定语法的访问者到一个数据中。非常有用。此外，我们可以使用管道（因为 Hoa\File\Read ——请参阅Hoa\File 库—— 支持 0 作为 stdin），因此

$ echo '[1, [1, [2, 3], 5], 8]' | hoa compiler:pp Json.pp 0 --visitor dump
>  #array
>  >  token(number, 1)
>  >  #array
>  >  >  token(number, 1)
>  >  >  #array
>  >  >  >  token(number, 2)
>  >  >  >  token(number, 3)
>  >  >  token(number, 5)
>  >  token(number, 8)

你可以应用任何访问者类。

错误

错误被很好地展示

$ echo '{"foo" true}' | hoa compiler:pp Json.pp 0 --visitor dump
Uncaught exception (Hoa\Compiler\Exception\UnexpectedToken):
Hoa\Compiler\Llk\Parser::parse(): (0) Unexpected token "true" (true) at line 1
and column 8:
{"foo" true}
       ↑
in hoa://Library/Compiler/Llk/Parser.php at line 1

采样器

一些算法可用于根据语法生成数据。我们将仅使用基于覆盖率的生成算法的示例，该算法将激活语法中的所有分支和标记

$sampler = new Hoa\Compiler\Llk\Sampler\Coverage(
    // Grammar.
    Hoa\Compiler\Llk\Llk::load(new Hoa\File\Read('Json.pp')),
    // Token sampler.
    new Hoa\Regex\Visitor\Isotropic(new Hoa\Math\Sampler\Random())
);

foreach ($sampler as $i => $data) {
    echo $i, ' => ', $data, "\n";
}

/**
 * Will output:
 *     0 => true
 *     1 => {" )o?bz " : null , " %3W) " : [false, 130    , " 6"   ]  }
 *     2 => [{" ny  " : true } ]
 *     3 => {" Ne;[3 " :[ true , true ] , " th: " : true," C[8} " :   true }
 */

研究论文

在 PHP 中使用真实域进行基于语法的测试，在 A-MOST 2012（加拿大蒙特利尔）提出（文章，演示，详情）。

文档

Hoa\Compiler 的黑客手册包含了有关如何使用此库以及它如何工作的详细信息。

要本地生成文档，请执行以下命令

$ composer require --dev hoa/devtools
$ vendor/bin/hoa devtools:documentation --open

更多文档可以在项目网站上找到：hoa-project.net。

获取帮助

主要有两种方法可以获得帮助

在 #hoaproject IRC 频道中，
在 users.hoa-project.net 的论坛上。

贡献

你想贡献吗？谢谢！详细的贡献指南解释了你需要知道的一切。

许可

Hoa 采用新 BSD 许可证（BSD-3-Clause）。请参阅 LICENSE 以获取详细信息。

hoa / compiler

维护者

详细信息