xref: /PHP-7.1/ext/intl/collator/collator_class.c (revision 5f07a895)
1 /*
2    +----------------------------------------------------------------------+
3    | PHP Version 7                                                        |
4    +----------------------------------------------------------------------+
5    | This source file is subject to version 3.01 of the PHP license,      |
6    | that is bundled with this package in the file LICENSE, and is        |
7    | available through the world-wide-web at the following url:           |
8    | http://www.php.net/license/3_01.txt                                  |
9    | If you did not receive a copy of the PHP license and are unable to   |
10    | obtain it through the world-wide-web, please send a note to          |
11    | license@php.net so we can mail you a copy immediately.               |
12    +----------------------------------------------------------------------+
13    | Authors: Vadim Savchuk <vsavchuk@productengine.com>                  |
14    |          Dmitry Lakhtyuk <dlakhtyuk@productengine.com>               |
15    +----------------------------------------------------------------------+
16  */
17 
18 #include "collator_class.h"
19 #include "php_intl.h"
20 #include "collator_attr.h"
21 #include "collator_compare.h"
22 #include "collator_sort.h"
23 #include "collator_convert.h"
24 #include "collator_locale.h"
25 #include "collator_create.h"
26 #include "collator_error.h"
27 #include "intl_error.h"
28 
29 #include <unicode/ucol.h>
30 
31 zend_class_entry *Collator_ce_ptr = NULL;
32 static zend_object_handlers Collator_handlers;
33 
34 /*
35  * Auxiliary functions needed by objects of 'Collator' class
36  */
37 
38 /* {{{ Collator_objects_free */
Collator_objects_free(zend_object * object)39 void Collator_objects_free(zend_object *object )
40 {
41 	Collator_object* co = php_intl_collator_fetch_object(object);
42 
43 	zend_object_std_dtor(&co->zo );
44 
45 	collator_object_destroy(co );
46 }
47 /* }}} */
48 
49 /* {{{ Collator_object_create */
Collator_object_create(zend_class_entry * ce)50 zend_object *Collator_object_create(zend_class_entry *ce )
51 {
52 	Collator_object*     intern;
53 
54 	intern = ecalloc(1, sizeof(Collator_object) + zend_object_properties_size(ce));
55 	intl_error_init(COLLATOR_ERROR_P(intern));
56 	zend_object_std_init(&intern->zo, ce );
57 	object_properties_init(&intern->zo, ce);
58 
59 	intern->zo.handlers = &Collator_handlers;
60 
61 	return &intern->zo;
62 }
63 /* }}} */
64 
65 /*
66  * 'Collator' class registration structures & functions
67  */
68 
69 /* {{{ Collator methods arguments info */
70 /* NOTE: modifying 'collator_XX_args' do not forget to
71        modify approptiate 'collator_XX_args' for
72        the procedural API.
73 */
74 ZEND_BEGIN_ARG_INFO_EX( collator_0_args, 0, 0, 0 )
75 ZEND_END_ARG_INFO()
76 
77 ZEND_BEGIN_ARG_INFO_EX( collator_1_arg, 0, 0, 1 )
78 	ZEND_ARG_INFO( 0, arg1 )
79 ZEND_END_ARG_INFO()
80 
81 ZEND_BEGIN_ARG_INFO_EX( collator_2_args, 0, 0, 2 )
82 	ZEND_ARG_INFO( 0, arg1 )
83 	ZEND_ARG_INFO( 0, arg2 )
84 ZEND_END_ARG_INFO()
85 
86 ZEND_BEGIN_ARG_INFO_EX( collator_sort_args, 0, 0, 1 )
87 	ZEND_ARG_ARRAY_INFO( 1, arr, 0 )
88 	ZEND_ARG_INFO( 0, flags )
89 ZEND_END_ARG_INFO()
90 
91 ZEND_BEGIN_ARG_INFO_EX( collator_sort_with_sort_keys_args, 0, 0, 1 )
92 	ZEND_ARG_ARRAY_INFO( 1, arr, 0 )
93 ZEND_END_ARG_INFO()
94 
95 /* }}} */
96 
97 /* {{{ Collator_class_functions
98  * Every 'Collator' class method has an entry in this table
99  */
100 
101 zend_function_entry Collator_class_functions[] = {
102 	PHP_ME( Collator, __construct, collator_1_arg, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR )
103 	ZEND_FENTRY( create, ZEND_FN( collator_create ), collator_1_arg, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC )
104 	PHP_NAMED_FE( compare, ZEND_FN( collator_compare ), collator_2_args )
105 	PHP_NAMED_FE( sort, ZEND_FN( collator_sort ), collator_sort_args )
106 	PHP_NAMED_FE( sortWithSortKeys, ZEND_FN( collator_sort_with_sort_keys ), collator_sort_with_sort_keys_args )
107 	PHP_NAMED_FE( asort, ZEND_FN( collator_asort ), collator_sort_args )
108 	PHP_NAMED_FE( getAttribute, ZEND_FN( collator_get_attribute ), collator_1_arg )
109 	PHP_NAMED_FE( setAttribute, ZEND_FN( collator_set_attribute ), collator_2_args )
110 	PHP_NAMED_FE( getStrength, ZEND_FN( collator_get_strength ), collator_0_args )
111 	PHP_NAMED_FE( setStrength, ZEND_FN( collator_set_strength ), collator_1_arg )
112 	PHP_NAMED_FE( getLocale, ZEND_FN( collator_get_locale ), collator_1_arg )
113 	PHP_NAMED_FE( getErrorCode, ZEND_FN( collator_get_error_code ), collator_0_args )
114 	PHP_NAMED_FE( getErrorMessage, ZEND_FN( collator_get_error_message ), collator_0_args )
115 	PHP_NAMED_FE( getSortKey, ZEND_FN( collator_get_sort_key ), collator_1_arg )
116 	PHP_FE_END
117 };
118 /* }}} */
119 
120 /* {{{ collator_register_Collator_class
121  * Initialize 'Collator' class
122  */
collator_register_Collator_class(void)123 void collator_register_Collator_class( void )
124 {
125 	zend_class_entry ce;
126 
127 	/* Create and register 'Collator' class. */
128 	INIT_CLASS_ENTRY( ce, "Collator", Collator_class_functions );
129 	ce.create_object = Collator_object_create;
130 	Collator_ce_ptr = zend_register_internal_class( &ce );
131 
132 	memcpy(&Collator_handlers, zend_get_std_object_handlers(),
133 		sizeof Collator_handlers);
134 	/* Collator has no usable clone semantics - ucol_cloneBinary/ucol_openBinary require binary buffer
135 	   for which we don't have the place to keep */
136 	Collator_handlers.offset = XtOffsetOf(Collator_object, zo);
137 	Collator_handlers.clone_obj = NULL;
138 	Collator_handlers.free_obj = Collator_objects_free;
139 
140 	/* Declare 'Collator' class properties. */
141 	if( !Collator_ce_ptr )
142 	{
143 		zend_error( E_ERROR,
144 			"Collator: attempt to create properties "
145 			"on a non-registered class." );
146 		return;
147 	}
148 }
149 /* }}} */
150 
151 /* {{{ void collator_object_init( Collator_object* co )
152  * Initialize internals of Collator_object.
153  * Must be called before any other call to 'collator_object_...' functions.
154  */
collator_object_init(Collator_object * co)155 void collator_object_init( Collator_object* co )
156 {
157 	if( !co )
158 		return;
159 
160 	intl_error_init( COLLATOR_ERROR_P( co ) );
161 }
162 /* }}} */
163 
164 /* {{{ void collator_object_destroy( Collator_object* co )
165  * Clean up mem allocted by internals of Collator_object
166  */
collator_object_destroy(Collator_object * co)167 void collator_object_destroy( Collator_object* co )
168 {
169 	if( !co )
170 		return;
171 
172 	if( co->ucoll )
173 	{
174 		ucol_close( co->ucoll );
175 		co->ucoll = NULL;
176 	}
177 
178 	intl_error_reset( COLLATOR_ERROR_P( co ) );
179 }
180 /* }}} */
181 
182 /*
183  * Local variables:
184  * tab-width: 4
185  * c-basic-offset: 4
186  * End:
187  * vim600: noet sw=4 ts=4 fdm=marker
188  * vim<600: noet sw=4 ts=4
189  */
190