clones/php-src
1
0
Fork 0
mirror of https://github.com/php/php-src.git synced 2024-10-01 14:56:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
28f39fba95
php-src/scripts/ext_skel_ng/php_function.php
Hartmut Holzgraefe c1fb09e34e Resource handling fixed and improved: 
- resources may have an additional type specifier in prototypes
- the 'alloc' attribute specifies whether to emalloc/efree
  the resource payload in generated code or not

Example code generation for function return types

Small docbook generation fixes in function documentation
2003-04-23 16:19:08 +00:00

334 lines
8.6 KiB
PHP
Raw Blame History

<?php
class php_function extends php_element {
// all known php types
function php_function($name, $summary, $proto, $desc="", $code="", $role="") {
$this->name = $name;
$this->summary = $summary;
$this->desc = empty($desc) ? "&warn.undocumented.func;" : $desc;
$this->code = $code;
$this->role = empty($role) ? "public" : $role;
if($this->role === "public") $this->status = $this->parse_proto($proto);
}
function parse_proto($proto) {
// 'tokenize' it
$len=strlen($proto);
$name="";
$tokens=array();
for($n=0;$n<$len;$n++) {
$char = $proto{$n};
if(ereg("[a-zA-Z0-9_]",$char)) {
$name.=$char;
} else {
if($name) $tokens[]=$name;
$name="";
if(trim($char)) $tokens[]=$char;
}
}
if($name) $tokens[]=$name;
$n=0;
$opts=0;
$params=array();
$return_type = ($this->is_type($tokens[$n])) ? $tokens[$n++] : "void";
$function_name = $tokens[$n++];
if($return_type === "resource" && $tokens[$n] !== "(") {
$return_subtype = $function_name;
$function_name = $tokens[$n++];
}
if(! $this->is_name($function_name)) {
return("$function_name is not a valid function name");
}
if($function_name != $this->name) {
return "proto function name is '$function_name' instead of '{$this->name}'";
}
if($tokens[$n]!='(') return("'(' expected instead of '$tokens[$n]'");
if($tokens[++$n]!=')') {
for($param=0;$tokens[$n];$n++,$param++) {
if($tokens[$n]=='[') {
$params[$param]['optional']=true;
$opts++;
$n++;
if($param>0) {
if ($tokens[$n]!=',') return("',' expected after '[' instead of '$token[$n]'");
$n++;
}
}
if(!$this->is_type($tokens[$n])) return("type name expected instead of '$tokens[$n]'");
$params[$param]['type']=$tokens[$n];
$n++;
if($this->is_name($tokens[$n])) {
$params[$param]['name']=$tokens[$n];
$n++;
}
if($params[$param]['type'] === "resource" && $this->is_name($tokens[$n])) {
$params[$param]['subtype'] = $params[$param]['name'];
$params[$param]['name'] = $tokens[$n];
$n++;
}
if($tokens[$n]=='[') {
$n--;
continue;
}
if($tokens[$n]==',') continue;
if($tokens[$n]==']') break;
if($tokens[$n]==')') break;
}
}
$numopts=$opts;
while($tokens[$n]==']') {
$n++;
$opts--;
}
if($opts!=0) return ("'[' / ']' count mismatch");
if($tokens[$n] != ')') return("')' expected instead of '$tokens[$n]'");
$this->name = $function_name;
$this->returns = $return_type;
if(isset($return_subtype)) {
$this->returns .= " $return_subtype";
}
$this->params = $params;
$this->optional = $numopts;
return true;
}
function c_code(&$extension) {
$code = "";
$returns = explode(" ", $this->returns);
switch($this->role) {
case "public":
$code .= "\n/* {{{ proto {$this->returns} {$this->name}(";
if(isset($this->params)) {
foreach($this->params as $key => $param) {
if(!empty($param['optional']))
$code.=" [";
if($key)
$code.=", ";
$code .= $param['type']." ";
if(isset($param['subtype'])) {
$code .= $param['subtype']." ";
}
if($param['type'] !== 'void') {
$code .= $param['name'];
}
}
}
for($n=$this->optional; $n>0; $n--) {
$code .= "]";
}
$code .= ")\n ";
if(!empty($this->summary)) {
$code .= $this->summary;
}
$code .= " */\n";
$code .= "PHP_FUNCTION({$this->name})\n";
$code .= "{\n";
if($returns[0] === "resource" && isset($returns[1])) {
$resource = $extension->resources[$returns[1]];
if($resource->alloc === "yes") {
$payload = $resource->payload;
$code .= "\t$payload * return_res = ($payload *)emalloc(sizeof($payload));\n";
}
}
if(isset($this->params) && count($this->params)) {
$arg_string="";
$arg_pointers=array();
$optional=false;
$res_fetch="";
foreach($this->params as $key => $param) {
if($param["type"] === "void") continue;
$name = $param['name'];
$arg_pointers[]="&$name";
if(isset($param['optional'])&&!$optional) {
$optional=true;
$arg_string.="|";
}
switch($param['type']) {
case "bool":
$arg_string.="b";
$code .= " zend_bool $name = 0;\n";
break;
case "int":
$arg_string.="l";
$code .= " long $name = 0;\n";
break;
case "float":
$arg_string.="d";
$code .= " double $name = 0.0;\n";
break;
case "string":
$arg_string.="s";
$code .= " char * $name = NULL;\n";
$code .= " int {$name}_len = 0;\n";
$arg_pointers[]="&{$name}_len";
break;
case "array":
$arg_string.="a";
$code .= " zval * $name = NULL;\n";
break;
case "object":
$arg_string.="o";
$code .= " zval * $name = NULL;\n";
break;
case "resource":
$arg_string.="r";
$code .= " zval * $name = NULL;\n";
$code .= " int {$name}_id = -1;\n";
// dummfug? $arg_pointers[]="&{$name}_id";
if(isset($param['subtype'])) {
$resource = $extension->resources[$param['subtype']];
$varname = "res_{$name}";
$code .= " {$resource->payload} * $varname;\n";
$res_fetch.=" if ($name) {\n"
." ZEND_FETCH_RESOURCE($varname, {$resource->payload} *, &$name, {$name}_id, \"$param[subtype]\", le_$param[subtype]);\n"
." }\n";
} else {
$res_fetch.=" if ($name) {\n"
." ZEND_FETCH_RESOURCE(???, ???, $name, {$name}_id, \"???\", ???_rsrc_id);\n"
." }\n";
}
break;
case "mixed":
case "callback":
$arg_string.="z";
$code .= " zval * $name = NULL;\n";
break;
}
}
}
if(isset($arg_string) && strlen($arg_string)) {
$code .= " int argc = ZEND_NUM_ARGS();\n\n";
$code .= "\n if (zend_parse_parameters(argc TSRMLS_CC, \"$arg_string\", ".join(", ",$arg_pointers).") == FAILURE) return;\n";
if($res_fetch) $code.="\n$res_fetch\n";
} else {
$code .= " if (ZEND_NUM_ARGS()>0) { WRONG_PARAM_COUNT; }\n\n";
}
if($this->code) {
$code .= "\t{\n$this->code\t}\n"; // {...} for local variables ...
} else {
$code .= " php_error(E_WARNING, \"{$this->name}: not yet implemented\"); RETURN_FALSE;\n\n";
switch($returns[0]) {
case "void":
break;
case "bool":
$code .= "\tRETURN_FALSE;\n";
break;
case "int":
$code .= "\tRETURN_LONG(0);\n";
break;
case "float":
$code .= "\tRETURN_DOUBLE(0.0);\n";
break;
case "string":
$code .= "\tRETURN_STRINGL(\"\", 0, 1);\n";
break;
case "array":
$code .= "\tarray_init(return_value);\n";
break;
case "object":
$code .= "\tobject_init(return_value)\n";
break;
case "resource":
if($returns[1]) {
$code .= "\tZEND_REGISTER_RESOURCE(return_value, return_res, le_$returns[1]);\n";
} else {
$code .= "\t/* RETURN_RESOURCE(...); /*\n";
}
break;
case "mixed":
$code .= "\t/* RETURN_...(...); /*\n";
break;
default:
$code .= "\t/* UNKNOWN RETURN TYPE '$this->returns' /*\n";
break;
}
}
$code .= "}\n/* }}} */\n\n";
break;
case "internal":
if(!empty($this->code)) {
$code .= " {\n";
$code .= $this->code."\n";
$code .= " }\n";
}
break;
case "private":
$code .= $this->code."\n";
break;
}
return $code;
}
function docbook_xml() {
$xml =
'<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry id="function.'.strtolower(str_replace("_","-",$this->name)).'">
<refnamediv>
<refname>'.$this->name.'</refname>
<refpurpose>'.$this->summary.'</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
';
$xml .= " <type>{$this->returns}</type><methodname>{$this->name}</methodname>\n";
if(empty($this->params) || $this->params[0]["type"]==="void") {
$xml .= " <void/>\n";
} else {
foreach($this->params as $key => $param) {
if(isset($param['optional'])) {
$xml .= " <methodparam choice='opt'>";
} else {
$xml .= " <methodparam>";
}
$xml .= "<type>$param[type]</type><parameter>$param[name]</parameter>";
$xml .= "</methodparam>\n";
}
}
$desc = $this->desc;
if(!strstr($this->desc,"<para>")) {
$desc = " <para>\n$desc </para>\n";
}
$xml .=
' </methodsynopsis>
'.$desc.'
</refsect1>
</refentry>
';
$xml .= $this->docbook_editor_footer(4);
return $xml;
}
}
?>
Reference in New Issue View Git Blame Copy Permalink