php_output.h

/*
 +----------------------------------------------------------------------+
 | Copyright (c) The PHP Group |
 +----------------------------------------------------------------------+
 | This source file is subject to version 3.01 of the PHP license, |
 | that is bundled with this package in the file LICENSE, and is |
 | available through the world-wide-web at the following url: |
 | https://www.php.net/license/3_01.txt |
 | If you did not receive a copy of the PHP license and are unable to |
 | obtain it through the world-wide-web, please send a note to |
 | license@php.net so we can mail you a copy immediately. |
 +----------------------------------------------------------------------+
 | Author: Michael Wallner <mike@php.net> |
 +----------------------------------------------------------------------+
*/

#ifndefPHP_OUTPUT_H
#definePHP_OUTPUT_H

#definePHP_OUTPUT_NEWAPI 1

/* handler ops */
#definePHP_OUTPUT_HANDLER_WRITE 0x00 /* standard passthru */
#definePHP_OUTPUT_HANDLER_START 0x01 /* start */
#definePHP_OUTPUT_HANDLER_CLEAN 0x02 /* restart */
#definePHP_OUTPUT_HANDLER_FLUSH 0x04 /* pass along as much as possible */
#definePHP_OUTPUT_HANDLER_FINAL 0x08 /* finalize */
#definePHP_OUTPUT_HANDLER_CONT PHP_OUTPUT_HANDLER_WRITE
#definePHP_OUTPUT_HANDLER_END PHP_OUTPUT_HANDLER_FINAL

/* handler types */
#definePHP_OUTPUT_HANDLER_INTERNAL 0x0000
#definePHP_OUTPUT_HANDLER_USER 0x0001

/* handler ability flags */
#definePHP_OUTPUT_HANDLER_CLEANABLE 0x0010
#definePHP_OUTPUT_HANDLER_FLUSHABLE 0x0020
#definePHP_OUTPUT_HANDLER_REMOVABLE 0x0040
#definePHP_OUTPUT_HANDLER_STDFLAGS 0x0070

/* handler status flags */
#definePHP_OUTPUT_HANDLER_STARTED 0x1000
#definePHP_OUTPUT_HANDLER_DISABLED 0x2000
#definePHP_OUTPUT_HANDLER_PROCESSED 0x4000

/* handler op return values */
typedefenum_php_output_handler_status_t {
PHP_OUTPUT_HANDLER_FAILURE,
PHP_OUTPUT_HANDLER_SUCCESS,
PHP_OUTPUT_HANDLER_NO_DATA
} php_output_handler_status_t;

/* php_output_stack_pop() flags */
#definePHP_OUTPUT_POP_TRY 0x000
#definePHP_OUTPUT_POP_FORCE 0x001
#definePHP_OUTPUT_POP_DISCARD 0x010
#definePHP_OUTPUT_POP_SILENT 0x100

/* real global flags */
#definePHP_OUTPUT_IMPLICITFLUSH 0x01
#definePHP_OUTPUT_DISABLED 0x02
#definePHP_OUTPUT_WRITTEN 0x04
#definePHP_OUTPUT_SENT 0x08
/* supplementary flags for php_output_get_status() */
#definePHP_OUTPUT_ACTIVE 0x10
#definePHP_OUTPUT_LOCKED 0x20
/* output layer is ready to use */
#definePHP_OUTPUT_ACTIVATED 0x100000

/* handler hooks */
typedefenum_php_output_handler_hook_t {
PHP_OUTPUT_HANDLER_HOOK_GET_OPAQ,
PHP_OUTPUT_HANDLER_HOOK_GET_FLAGS,
PHP_OUTPUT_HANDLER_HOOK_GET_LEVEL,
PHP_OUTPUT_HANDLER_HOOK_IMMUTABLE,
PHP_OUTPUT_HANDLER_HOOK_DISABLE,
/* unused */
PHP_OUTPUT_HANDLER_HOOK_LAST
} php_output_handler_hook_t;

#definePHP_OUTPUT_HANDLER_INITBUF_SIZE(s) \
( ((s) > 1) ? \
 (s) + PHP_OUTPUT_HANDLER_ALIGNTO_SIZE - ((s) % (PHP_OUTPUT_HANDLER_ALIGNTO_SIZE)) : \
 PHP_OUTPUT_HANDLER_DEFAULT_SIZE \
)
#definePHP_OUTPUT_HANDLER_ALIGNTO_SIZE 0x1000
#definePHP_OUTPUT_HANDLER_DEFAULT_SIZE 0x4000

typedefstruct_php_output_buffer {
char*data;
size_tsize;
size_tused;
uint32_tfree:1;
uint32_t_reserved:31;
} php_output_buffer;

typedefstruct_php_output_context {
intop;
php_output_bufferin;
php_output_bufferout;
} php_output_context;

/* old-style, stateless callback */
typedefvoid (*php_output_handler_func_t)(char*output, size_toutput_len, char**handled_output, size_t*handled_output_len, intmode);
/* new-style, opaque context callback */
typedefint (*php_output_handler_context_func_t)(void**handler_context, php_output_context*output_context);
/* output handler context dtor */
typedefvoid (*php_output_handler_context_dtor_t)(void*opaq);
/* conflict check callback */
typedefint (*php_output_handler_conflict_check_t)(constchar*handler_name, size_thandler_name_len);
/* ctor for aliases */
typedefstruct_php_output_handler*(*php_output_handler_alias_ctor_t)(constchar*handler_name, size_thandler_name_len, size_tchunk_size, intflags);

typedefstruct_php_output_handler_user_func_t {
zend_fcall_infofci;
zend_fcall_info_cachefcc;
zvalzoh;
} php_output_handler_user_func_t;

typedefstruct_php_output_handler {
zend_string*name;
intflags;
intlevel;
size_tsize;
php_output_bufferbuffer;

void*opaq;
void (*dtor)(void*opaq);

union {
php_output_handler_user_func_t*user;
php_output_handler_context_func_tinternal;
 } func;
} php_output_handler;

ZEND_BEGIN_MODULE_GLOBALS(output)
zend_stackhandlers;
php_output_handler*active;
php_output_handler*running;
zend_string*output_start_filename;
intoutput_start_lineno;
intflags;
ZEND_END_MODULE_GLOBALS(output)

PHPAPIZEND_EXTERN_MODULE_GLOBALS(output)

/* there should not be a need to use OG() from outside of output.c */
#ifdefZTS
# defineOG(v) ZEND_TSRMG(output_globals_id, zend_output_globals *, v)
#else
# defineOG(v) (output_globals.v)
#endif

/* convenience macros */
#definePHPWRITE(str, str_len) php_output_write((str), (str_len))
#definePHPWRITE_H(str, str_len) php_output_write_unbuffered((str), (str_len))

#definePUTC(c) php_output_write((const char *) &(c), 1)
#definePUTC_H(c) php_output_write_unbuffered((const char *) &(c), 1)

#definePUTS(str) do { \
 const char *__str = (str); \
 php_output_write(__str, strlen(__str)); \
} while (0)
#definePUTS_H(str) do { \
 const char *__str = (str); \
 php_output_write_unbuffered(__str, strlen(__str)); \
} while (0)


BEGIN_EXTERN_C()

externconstcharphp_output_default_handler_name[sizeof("default output handler")];
externconstcharphp_output_devnull_handler_name[sizeof("null output handler")];

#definephp_output_tearup() \
 php_output_startup(); \
 php_output_activate()
#definephp_output_teardown() \
 php_output_end_all(); \
 php_output_deactivate(); \
 php_output_shutdown()

/* MINIT */
PHPAPIvoidphp_output_startup(void);
/* MSHUTDOWN */
PHPAPIvoidphp_output_shutdown(void);

/* RINIT */
PHPAPIintphp_output_activate(void);
/* RSHUTDOWN */
PHPAPIvoidphp_output_deactivate(void);

PHPAPIvoidphp_output_set_status(intstatus);
PHPAPIintphp_output_get_status(void);
PHPAPIvoidphp_output_set_implicit_flush(intflush);
PHPAPIconstchar*php_output_get_start_filename(void);
PHPAPIintphp_output_get_start_lineno(void);

PHPAPIsize_tphp_output_write_unbuffered(constchar*str, size_tlen);
PHPAPIsize_tphp_output_write(constchar*str, size_tlen);

PHPAPIintphp_output_flush(void);
PHPAPIvoidphp_output_flush_all(void);
PHPAPIintphp_output_clean(void);
PHPAPIvoidphp_output_clean_all(void);
PHPAPIintphp_output_end(void);
PHPAPIvoidphp_output_end_all(void);
PHPAPIintphp_output_discard(void);
PHPAPIvoidphp_output_discard_all(void);

PHPAPIintphp_output_get_contents(zval*p);
PHPAPIintphp_output_get_length(zval*p);
PHPAPIintphp_output_get_level(void);
PHPAPIphp_output_handler*php_output_get_active_handler(void);

PHPAPIintphp_output_start_default(void);
PHPAPIintphp_output_start_devnull(void);

PHPAPIintphp_output_start_user(zval*output_handler, size_tchunk_size, intflags);
PHPAPIintphp_output_start_internal(constchar*name, size_tname_len, php_output_handler_func_toutput_handler, size_tchunk_size, intflags);

PHPAPIphp_output_handler*php_output_handler_create_user(zval*handler, size_tchunk_size, intflags);
PHPAPIphp_output_handler*php_output_handler_create_internal(constchar*name, size_tname_len, php_output_handler_context_func_thandler, size_tchunk_size, intflags);

PHPAPIvoidphp_output_handler_set_context(php_output_handler*handler, void*opaq, void (*dtor)(void*));
PHPAPIintphp_output_handler_start(php_output_handler*handler);
PHPAPIintphp_output_handler_started(constchar*name, size_tname_len);
PHPAPIintphp_output_handler_hook(php_output_handler_hook_ttype, void*arg);
PHPAPIvoidphp_output_handler_dtor(php_output_handler*handler);
PHPAPIvoidphp_output_handler_free(php_output_handler**handler);

PHPAPIintphp_output_handler_conflict(constchar*handler_new, size_thandler_new_len, constchar*handler_set, size_thandler_set_len);
PHPAPIintphp_output_handler_conflict_register(constchar*handler_name, size_thandler_name_len, php_output_handler_conflict_check_tcheck_func);
PHPAPIintphp_output_handler_reverse_conflict_register(constchar*handler_name, size_thandler_name_len, php_output_handler_conflict_check_tcheck_func);

PHPAPIphp_output_handler_alias_ctor_tphp_output_handler_alias(constchar*handler_name, size_thandler_name_len);
PHPAPIintphp_output_handler_alias_register(constchar*handler_name, size_thandler_name_len, php_output_handler_alias_ctor_tfunc);

END_EXTERN_C()

#endif