1 /*
2  * Copyright (C) 2000-2005 Chris Ross and various contributors
3  * Copyright (C) 1999-2000 Chris Ross
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * o Redistributions of source code must retain the above copyright notice, this
10  *   list of conditions and the following disclaimer.
11  * o Redistributions in binary form must reproduce the above copyright notice,
12  *   this list of conditions and the following disclaimer in the documentation
13  *   and/or other materials provided with the distribution.
14  * o Neither the name of the ferite software nor the names of its contributors may
15  *   be used to endorse or promote products derived from this software without
16  *   specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #ifndef __FERITE_CLASS_H__
32 #define __FERITE_CLASS_H__
33 
34 #define FE_ITEM_IS_PRIVATE   0
35 #define FE_ITEM_IS_PROTECTED 1
36 #define FE_ITEM_IS_PUBLIC    2
37 #define FE_ITEM_IS_ABSTRACT  3
38 #define FE_ITEM_IS_FINAL     4
39 #define FE_ITEM_IS_PROTOCOL  5
40 
41 /* Class */
42 FERITE_API FeriteClass     *ferite_class_variable_class( FeriteScript *script, FeriteClass *klass, char *name );
43 FERITE_API int              ferite_class_has_function(FeriteScript *script, FeriteClass *cls, char *name);
44 FERITE_API FeriteVariable  *ferite_class_get_var( FeriteScript *script, FeriteClass *klass, char *name );
45 FERITE_API int              ferite_class_is_subclass( FeriteClass *klass, FeriteClass *subklass );
46 FERITE_API FeriteClass     *ferite_class_dup( FeriteScript *script, FeriteClass *klass, FeriteNamespace *container );
47 FERITE_API void             ferite_class_call_static_constructor( FeriteScript *script, FeriteClass *klass );
48 FERITE_API void             ferite_class_call_static_destructor( FeriteScript *script, FeriteClass *klass );
49 FERITE_API void             ferite_class_finish( FeriteScript *script, FeriteClass *klass );
50 FERITE_API FeriteFunction  *ferite_class_get_function(FeriteScript *script, FeriteClass *cls, char *name);
51 FERITE_API FeriteFunction  *ferite_class_get_function_for_params( FeriteScript *script, FeriteClass *klass, char *name, FeriteVariable **params );
52 
53 /* Deleting things */
54 FERITE_API void             ferite_delete_object_variable_list( FeriteScript *script, FeriteObjectVariable *ov );
55 FERITE_API void             ferite_delete_class( FeriteScript *script, FeriteClass *classp );
56 FERITE_API void             ferite_delete_object( FeriteObject *obj );
57 FERITE_API void             ferite_delete_class_object( FeriteScript *script, FeriteObject *obj, int do_destructor );
58 FERITE_API void             ferite_delete_objects( FeriteObject *obj );
59 
60 /* Duplication */
61 FERITE_API FeriteObjectVariable *ferite_duplicate_object_variable_list( FeriteScript *script, FeriteClass *klass );
62 
63 /* Finding things */
64 FERITE_API FeriteClass     *ferite_find_class( FeriteScript *script, FeriteNamespace *ns, char *name );
65 FERITE_API long             ferite_find_class_id( FeriteScript *script, FeriteNamespace *ns, char *name );
66 FERITE_API FeriteObject    *ferite_find_object( FeriteScript *script, FeriteObject *parent, char *obj );
67 FERITE_API FeriteFunction  *ferite_find_constructor( FeriteScript *script, FeriteObject *object, FeriteVariable **params );
68 FERITE_API FeriteFunction  *ferite_find_static_constructor( FeriteScript *script, FeriteClass *klass, FeriteVariable **params );
69 FERITE_API char            *ferite_generate_namespace_fqn( FeriteScript *script, FeriteNamespace *ns );
70 FERITE_API char            *ferite_generate_class_fqn( FeriteScript *script, FeriteClass *klass );
71 
72 /* Objects */
73 FERITE_API FeriteClass     *ferite_object_variable_class( FeriteScript *script, FeriteObject *object, char *name );
74 FERITE_API FeriteVariable  *ferite_object_call_super( FeriteScript *script, FeriteVariable *container, FeriteVariable **params );
75 FERITE_API int              ferite_object_is_sublass( FeriteObject *obj, char *name );
76 FERITE_API void             ferite_object_set_var(FeriteScript* script,FeriteObject* obj, char *id, FeriteVariable *data);
77 FERITE_API FeriteVariable  *ferite_object_get_var( FeriteScript *script, FeriteObject *object, char *name );
78 FERITE_API FeriteFunction  *ferite_object_get_function( FeriteScript *script, FeriteObject *object, char *name );
79 FERITE_API FeriteFunction  *ferite_object_get_function_for_params( FeriteScript *script, FeriteObject *object, char *name, FeriteVariable **params );
80 FERITE_API int              ferite_object_has_var(FeriteScript* script, FeriteObject* obj, char *id);
81 
82 /* State */
83 FERITE_API char            *ferite_state_to_str( int state );
84 
85 #endif /* __FERITE_CLASS_H__ */
86