zend_enum.h

/*
 +----------------------------------------------------------------------+
 | Zend Engine |
 +----------------------------------------------------------------------+
 | Copyright (c) Zend Technologies Ltd. (http://www.zend.com) |
 +----------------------------------------------------------------------+
 | This source file is subject to version 2.00 of the Zend license, |
 | that is bundled with this package in the file LICENSE, and is |
 | available through the world-wide-web at the following url: |
 | http://www.zend.com/license/2_00.txt. |
 | If you did not receive a copy of the Zend license and are unable to |
 | obtain it through the world-wide-web, please send a note to |
 | license@zend.com so we can mail you a copy immediately. |
 +----------------------------------------------------------------------+
 | Authors: Ilija Tovilo <ilutov@php.net> |
 +----------------------------------------------------------------------+
*/

#ifndefZEND_ENUM_H
#defineZEND_ENUM_H

#include"zend.h"
#include"zend_API.h"

#include<stdint.h>

BEGIN_EXTERN_C()

externZEND_APIzend_class_entry*zend_ce_unit_enum;
externZEND_APIzend_class_entry*zend_ce_backed_enum;
externZEND_APIzend_object_handlerszend_enum_object_handlers;

voidzend_register_enum_ce(void);
voidzend_enum_add_interfaces(zend_class_entry*ce);
zend_resultzend_enum_build_backed_enum_table(zend_class_entry*ce);
zend_object*zend_enum_new(zval*result, zend_class_entry*ce, zend_string*case_name, zval*backing_value_zv);
voidzend_verify_enum(constzend_class_entry*ce);
voidzend_enum_register_funcs(zend_class_entry*ce);
voidzend_enum_register_props(zend_class_entry*ce);

ZEND_APIzend_class_entry*zend_register_internal_enum(
constchar*name, uint8_ttype, constzend_function_entry*functions);
ZEND_APIvoidzend_enum_add_case(zend_class_entry*ce, zend_string*case_name, zval*value);
ZEND_APIvoidzend_enum_add_case_cstr(zend_class_entry*ce, constchar*name, zval*value);
ZEND_APIzend_object*zend_enum_get_case(zend_class_entry*ce, zend_string*name);
ZEND_APIzend_object*zend_enum_get_case_cstr(zend_class_entry*ce, constchar*name);
ZEND_APIzend_resultzend_enum_get_case_by_value(zend_object**result, zend_class_entry*ce, zend_longlong_key, zend_string*string_key, booltry_from);

staticzend_always_inlinezval*zend_enum_fetch_case_name(zend_object*zobj)
{
ZEND_ASSERT(zobj->ce->ce_flags&ZEND_ACC_ENUM);
returnOBJ_PROP_NUM(zobj, 0);
}

staticzend_always_inlinezval*zend_enum_fetch_case_value(zend_object*zobj)
{
ZEND_ASSERT(zobj->ce->ce_flags&ZEND_ACC_ENUM);
ZEND_ASSERT(zobj->ce->enum_backing_type!=IS_UNDEF);
returnOBJ_PROP_NUM(zobj, 1);
}

END_EXTERN_C()

#endif/* ZEND_ENUM_H */