[翻译][php扩展和嵌入式]第18章-php的扩展自动生成

 

全部翻译内容pdf文档下载地址: http://download.csdn.net/detail/lgg201/5107012

本书目前在github上由laruence(http://www.laruence.com)和walu(http://www.walu.cc)两位大牛组织翻译. 该翻译项目地址为: https://github.com/walu/phpbook

本书在github上的地址: https://github.com/goosman-lei/php-eae

未来本书将可能部分合并到phpbook项目中, 同时保留一份独立版本.

原书名: <Extending and Embedding PHP>

原作者: Sara Golemon

译者: goosman.lei(雷果国)

译者Email: [email protected]

译者Blog: http://blog.csdn.net/lgg201

权利声明

此译本在不获利的情况下, 可以无限制自由传播.

扩展生成

毫无疑问你已经注意到, 每个php扩展都包含一些非常公共的并且非常单调的结构和文件. 当开始一个新扩展开发的时候, 如果这些公共的结构已经存在, 我们只用考虑填充功能代码是很有意义的. 为此, 在php中包含了一个简单但是很有用的shell脚本.

ext_skel

切换到你的php源代码树下ext/目录中, 执行下面的命令:

jdoe@devbox:/home/jdoe/cvs/php-src/ext/$ ./ext_skel extname=sample7

稍等便可, 输出一些文本, 你将看到下面的这些输出:

To use your new extension, you will have to execute the following steps:



1.  $ cd ..

2.  $ vi ext/sample7/config.m4

3.  $ ./buildconf

4.  $ ./configure [with|enable]-sample7

5.  $ make

6.  $ ./php -f ext/sample7/sample7.php

7.  $ vi ext/sample7/sample7.c

8.  $ make



Repeat steps 3-6 until you are satisfied with ext/sample7/config.m4 and

step 6 confirms that your module is compiled into PHP. Then, start writing

code and repeat the last two steps as often as necessary.

此刻观察ext/sample7目录, 你将看到在第5章"你的第一个扩展"中你编写的扩展骨架代码的注释版本. 只是现在你还不能编译它; 不过只需要对config.m4做少许修改就可以让它工作了, 这样你就可以避免第5章中你所做的大部分工作.

生成函数原型

如果你要编写一个对第三方库的包装扩展, 那么你就已经有了一个函数原型及基本行为的机器刻度版本的描述(头文件), 通过传递一个额外的参数给./ext_skel, 它将自动的扫描你的头文件并创建对应于接口的简单PHP_FUCNTION()块. 下面是使用./ext_skel指令解析zlib头:

jdoe@devbox:/home/jdoe/cvs/php-src/ext/$ ./ext_skel extname=sample8 \

proto=/usr/local/include/zlib/zlib.h

现在在ext/sample8/sample8.c中, 你就可以看到许多PHP_FUNCTION()定义, 每个zlib函数对应一个. 要注意, 骨架生成程序会对某些未知资源类型产生警告消息. 你需要对这些函数特别注意, 并且为了将这些内部的复杂结构体和用户空间可访问的变量关联起来, 可能会需要使用你在第9章"资源数据类型"中学到的知识.

PECL_Gen

还有一种更加完善但也更加复杂的代码生成器: PECL_Gen, 可以在PECL(http://pecl.php.net)中找到它, 使用pear install PECL_Gen命令可以安装它.

译者注: PECL_Gen已经迁移为CodeGen_PECL(http://pear.php.net/package/CodeGen_PECL). 本章涉及代码测试使用CodeGen_PECL的版本信息为: "php 1.1.3, Copyright (c) 2003-2006 Hartmut Holzgraefe", 如果您的环境使用有问题, 请参考译序中译者的环境配置.

一旦安装完成, 它就可以像ext_skel一样运行, 接受相同的输入参数, 产生大致相同的输出, 或者如果提供了一个完整的xml定义文件, 则产生一个更加健壮和完整可编译版本的扩展. PECL_Gen并不会节省你编写扩展核心功能的时间; 而是提供一种可选的方式高效的生成扩展骨架代码.

specfile.xml

下面是最简单的扩展定义文件:

 

<?xml version="1.0" encoding="utf-8" ?>

<extension name="sample9">

 <functions>

  <function name="sample9_hello_world" role="public">

   <code>

<![CDATA[



    php_printf("Hello World!");

]]>

   </code>

  </function>

 </functions>

</extension>

 

译注: 请注意, 译者使用的原著中第一行少了后面的问号, 导致不能使用, 加上就OK.

通过PECL_Gen命令运行这个文件:

jdoe@devbox:/home/jdoe/cvs/php-src/ext/$ pecl-gen specfile.xml

则会产生一个名为sample9的扩展, 并暴露一个用户空间函数sample9_hello_world().

关于扩展

除了你已经熟悉的功能文件, PECL_Gen还会产生一个package.xml文件 它可以用于pear安装. 如果你计划发布包到PECL库, 或者哪怕你只是想要使用pear包系统交付内容, 有这个文件都会很有用.

总之, 你可以在PECL_Gen的specfile.xml中指定多数package.xml文件的元素.

<?xml version="1.0" encoding="UTF-8" ?>

<extension name="sample9">

    <summary>Extension 9 generated by PECL_Gen</summary>

    <description>Another sample of PHP Extension Writing</description>

    <maintainers>

        <maintainer>

            <name>John D. Bookreader</name>

            <email>[email protected]</email>

            <role>lead</role>

        </maintainer>

    </maintainers>

    <release>

        <version>0.1</version>

        <date>2006-01-01</date>

        <state>beta</state>

        <notes>Initial Release</notes>

    </release>

    ...

</extension>

当PECL_Gen创建扩展时, 这些信息将被翻译到最终的package.xml文件中.

依赖

如你在第17章"配置和链接"中所见, 依赖可以扫描出来用于config.m4和config.w32文件. PECL_Gen可以使用<deps>定义各种类型的依赖完成扫描工作. 默认情况下, 列在<deps>标签下的依赖会同时应用到Unix和win32构建中, 除非显式的是否用platform属性指定某个目标

<?xml version="1.0" encoding="UTF-8" ?>

<extension name="sample9">

    ...

    <deps platform="unix">

        <! UNIX specific dependencies >

    </deps>

    <deps platform="win32">

        <! Win32 specific dependencies >

    </deps>

    <deps platform="all">

        <! Dependencies that apply to all platforms >

    </deps>

    ...

</extension>

with

通常, 扩展在配置时使用--enable-extname样式的配置选项. 通过增加一个或多个<with>标签到<deps>块中, 则不仅配置选项被修改为--with-extname, 而且同时需要扫描头文件:

deps platform="unix">

    <with defaults="/usr:/usr/local:/opt"

        testfile="include/zlib/zlib.h">zlib headers</with>

</deps>

库

必须的库也列在<deps>下, 使用<lib>标签.

<deps platform="all">

    <lib name="ssleay" platform="win32"/>

    <lib name="crypto" platform="unix"/>

    <lib name="z" platform="unix" function="inflate"/>

</deps>

在前面两个例子中, 只是检查了库是否存在; 第三个例子中, 库将被真实的加载并扫描以确认inflate()函数是否定义.

尽管<deps>标签实际已经命名了目标平台, 但<lib>标签也有一个platform属性可以覆盖<deps>标签的platform设置. 当它们混合使用的时候要格外小心.

<header>

此外, 需要包含的文件也可以通过在<deps>块中使用<header>标签在你的代码中追加一个#include指令列表. 要强制某个头先包含, 可以在<header>标签上增加属性prepend="yes". 和<lib>依赖类似, <header>也可以严格限制平台:

<deps>

    <header name="sys/types.h" platform="unix" prepend="yes"/>

    <header name="zlib/zlib.h"/>

</deps>

译注: 经测试, 译者的环境<header>标签不支持platform属性.

常量

用户空间常量使用<constants>块中的一个或多个<constant>标签定义. 每个标签需要一个name和一个value属性, 以及一个值必须是int, float, string之一的type属性.

    <constants>

        <constant name="SAMPLE9_APINO" type="int" value="20060101"/>

        <constant name="SAMPLE9_VERSION" type="float" value="1.0"/>

        <constant name="SAMPLE9_AUTHOR" type="string" value="John Doe"/>

    </constants>

全局变量

线程安全全局变量的定义方式几乎相同. 唯一的不同在于type参数需要使用C语言原型而不是php用户空间描述. 一旦定义并构建, 全局变量就可以使用第12章"启动, 终止, 以及其中的一些点"中学习的EXTNAME_G(global_name)的宏用法进行访问. 在这里, value属性表示变量在请求启动时的默认值. 要注意在specfile.xml中这个默认值只能指定为简单的标量数值. 字符串和其他复杂结构应该在RINIT阶段手动设置.

    <globals>

        <global name="greeting" type="char *"/>

        <global name="greeting_was_issued" type="zend_bool" value="1"/>

    </globals>

INI选项

要绑定线程安全的全局变量到php.ini设置, 则需要使用<phpini>标签而不是<globa>. 这个标签需要两个额外的参数: onupdate="updatemethod"标识INI的修改应该怎样处理, access="mode"和第13章"INI设置"中介绍的模式含义相同, "mode"值可以是: all, user, perdir, system.

    <globals>

        <phpini name="mysetting" type="int" value="42" onupdate="OnUpdateLong" access="all"/>

    </globals>

函数

你已经看到了最基本的函数定义; 不过, <function>标签在PECL_Gen的specfile中实际上支持两种不同类型的函数.

两个版本都支持你已经在<extension>级别上使用过的<summary>和<description>属性; 两种类型都必须的元素是<code>标签, 它包含了将要被放入你的源代码文件中的原文C语言代码.

role="public"

如你所想, 所有定义为public角色的函数都将包装恰当的PHP_FUNCTION()头和花括号, 对应到扩展的函数表向量中的条目.

除了其他函数支持的标签, public类型还允许指定一个<proto>标签. 这个标签的格式应该匹配php在线手册中的原型展示, 它将被文档生成器解析.

    <functions>

        <function role="public" name="sample9_greet_me">

            <summary>Greet a person by name</summary>

            <description>Accept a name parameter as a string and say hello to that person. Returns TRUE.</description>

            <proto>bool sample9_greet_me(string name)</proto>

            <code>

            <![CDATA[

            char *name;

            int name_len;



            if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s",

                        &name, &name_len) == FAILURE) {

                return;

            }



            php_printf("Hello ");

            PHPWRITE(name, name_len);

            php_printf("!\n");

            RETURN_TRUE;

            ]]>

            </code>

        </function>

    </functions>

role="internal"

内部函数涉及5个zend_module_entry函数: MINIT, MSHUTDOWN, RINIT, RSHUTDOWN, MINFO. 如果指定的名字不是这5个之一将会产生pecl-gen无法处理的错误.

    <functions>

        <function role="internal" name="MINFO">

            <code>

            <![CDATA[

            php_info_print_table_start();

            php_info_print_table_header(2, "Column1", "Column2");

            php_info_print_table_end();

            ]]>

            </code>

        </function>

    </functions>

自定义代码

所有其他需要存在于你的扩展中的代码都可以使用<code>标签包含. 要放置任意代码到你的目标文件extname.c中, 使用role="code"; 或者说使用role="header"将代码放到目标文件php_extname.h中. 默认情况下, 代码将放到代码或头文件的底部, 除非指定了position="top"属性.

    <code role="header" position="bottom">

    <![CDATA[

    typedef struct _php_sample9_data {

        long val;

    } php_sample9_data;

    ]]>

    </code>

    <code role="code" position="top">

    <![CDATA[

    static php_sample9_data *php_sample9_data_ctor(long value)

    {

        php_sample9_data *ret;

        ret = emalloc(sizeof(php_sample9_data));

        ret->val = value;

        return ret;

    }

    ]]>

    </code>

译注: 译者的环境中不支持原著中<code>标签的name属性.

小结

使用本章讨论的工具, 你就可以快速的开发php扩展, 并且让你的代码相比手写更加不容易产生bug. 现在是时候转向将php嵌入到其他项目了. 剩下的章节中, 你将利用php环境和强大的php引擎为你的已有项目增加脚本能力, 使它可以为你的客户提供更多更有用的功能.

目录

上一章: php源代码的配置和链接
下一章: 设置宿主环境