3 * Automatically generated by running "php schema.php bzip2".
5 * You may modify the file, but re-running schema.php against this file will
6 * standardize the format without losing your schema changes. It does lose
7 * any changes that are not part of schema. Use "note" field to comment on
8 * schema itself, and "note" fields are not used in any code generation but
9 * only staying within this file.
11 ///////////////////////////////////////////////////////////////////////////////
12 // Preamble: C++ code inserted at beginning of ext_{name}.h
19 ///////////////////////////////////////////////////////////////////////////////
23 // 'name' => name of the constant
24 // 'type' => type of the constant
25 // 'note' => additional note about this constant's schema
29 ///////////////////////////////////////////////////////////////////////////////
33 // 'name' => name of the function
34 // 'desc' => description of the function's purpose
35 // 'flags' => attributes of the function, see base.php for possible values
36 // 'opt' => optimization callback function's name for compiler
37 // 'note' => additional note about this function's schema
40 // 'type' => return type, use Reference for ref return
41 // 'desc' => description of the return value
43 // 'args' => arguments
45 // 'name' => name of the argument
46 // 'type' => type of the argument, use Reference for output parameter
47 // 'value' => default value of the argument
48 // 'desc' => description of the argument
55 'desc' => "Closes the given bzip2 file pointer.",
56 'flags' => HasDocComment
,
59 'desc' => "Returns TRUE on success or FALSE on failure.",
65 'desc' => "The file pointer. It must be valid and must point to a file successfully opened by bzopen().",
68 'taint_observer' => false,
74 'desc' => "bzopen() opens a bzip2 (.bz2) file for reading or writing.",
75 'flags' => HasDocComment
,
78 'desc' => "If the open fails, bzopen() returns FALSE, otherwise it returns a pointer to the newly opened file.",
84 'desc' => "The name of the file to open.",
89 'desc' => "Similar to the fopen() function, only 'r' (read) and 'w' (write) are supported. Everything else will cause bzopen to return FALSE.",
92 'taint_observer' => false,
98 'desc' => "bzread() reads from the given bzip2 file pointer.\n\nReading stops when length (uncompressed) bytes have been read or EOF is reached, whichever comes first.",
99 'flags' => HasDocComment
,
102 'desc' => "Returns the uncompressed data, or FALSE on error.",
108 'desc' => "The file pointer. It must be valid and must point to a file successfully opened by bzopen().",
114 'desc' => "If not specified, bzread() will read 1024 (uncompressed) bytes at a time.",
117 'taint_observer' => array(
118 'set_mask' => "TAINT_BIT_ALL_NO_TRACE",
119 'clear_mask' => "TAINT_BIT_NONE",
126 'desc' => "bzwrite() writes a string into the given bzip2 file stream.",
127 'flags' => HasDocComment
,
130 'desc' => "Returns the number of bytes written, or FALSE on error.",
136 'desc' => "The file pointer. It must be valid and must point to a file successfully opened by bzopen().",
141 'desc' => "The written data.",
147 'desc' => "If supplied, writing will stop after length (uncompressed) bytes have been written or the end of data is reached, whichever comes first.",
150 'taint_observer' => false,
156 'desc' => "Forces a write of all buffered bzip2 data for the file pointer bz.",
157 'flags' => HasDocComment
,
160 'desc' => "Returns TRUE on success or FALSE on failure.",
166 'desc' => "The file pointer. It must be valid and must point to a file successfully opened by bzopen().",
169 'taint_observer' => false,
174 'name' => "bzerrstr",
175 'desc' => "Gets the error string of any bzip2 error returned by the given file pointer.",
176 'flags' => HasDocComment
,
179 'desc' => "Returns a string containing the error message.",
185 'desc' => "The file pointer. It must be valid and must point to a file successfully opened by bzopen().",
188 'taint_observer' => false,
194 'desc' => "Returns the error number and error string of any bzip2 error returned by the given file pointer.",
195 'flags' => HasDocComment
,
198 'desc' => "Returns an associative array, with the error code in the errno entry, and the error message in the errstr entry.",
204 'desc' => "The file pointer. It must be valid and must point to a file successfully opened by bzopen().",
207 'taint_observer' => false,
213 'desc' => "Returns the error number of any bzip2 error returned by the given file pointer.",
214 'flags' => HasDocComment
,
217 'desc' => "Returns the error number as an integer.",
223 'desc' => "The file pointer. It must be valid and must point to a file successfully opened by bzopen().",
226 'taint_observer' => false,
231 'name' => "bzcompress",
232 'desc' => "bzcompress() compresses the given string and returns it as bzip2 encoded data.",
233 'flags' => HasDocComment
,
236 'desc' => "The compressed string or number of error in case of error.",
242 'desc' => "The string to compress.",
245 'name' => "blocksize",
248 'desc' => "Specifies the blocksize used during compression and should be a number from 1 to 9 with 9 giving the best compression, but using more resources to do so.",
251 'name' => "workfactor",
254 'desc' => "Controls how the compression phase behaves when presented with worst case, highly repetitive, input data. The value can be between 0 and 250 with 0 being a special case.\n\nRegardless of the workfactor, the generated output is the same.",
257 'taint_observer' => array(
258 'set_mask' => "TAINT_BIT_MUTATED",
259 'clear_mask' => "TAINT_BIT_NONE",
265 'name' => "bzdecompress",
266 'desc' => "bzdecompress() decompresses the given string containing bzip2 encoded data.",
267 'flags' => HasDocComment
,
270 'desc' => "The decompressed string or number of error in case of error.",
276 'desc' => "The string to decompress.",
282 'desc' => "If TRUE, an alternative decompression algorithm will be used which uses less memory (the maximum memory requirement drops to around 2300K) but works at roughly half the speed.\n\nSee the ยป bzip2 documentation for more information about this feature.",
285 'taint_observer' => array(
286 'set_mask' => "TAINT_BIT_MUTATED",
287 'clear_mask' => "TAINT_BIT_NONE",
292 ///////////////////////////////////////////////////////////////////////////////
297 // 'name' => name of the class
298 // 'desc' => description of the class's purpose
299 // 'flags' => attributes of the class, see base.php for possible values
300 // 'note' => additional note about this class's schema
301 // 'parent' => parent class name, if any
302 // 'ifaces' => array of interfaces tihs class implements
303 // 'bases' => extra internal and special base classes this class requires
304 // 'footer' => extra C++ inserted at end of class declaration
307 // DefineConstant(..)
308 // DefineConstant(..)
310 // DefineFunction(..)
311 // DefineFunction(..)
317 // 'name' => name of the property
318 // 'type' => type of the property
319 // 'flags' => attributes of the property
320 // 'desc' => description of the property
321 // 'note' => additional note about this property's schema