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_VARIABLES_H__
32 #define __FERITE_VARIABLES_H__
33 
34 #define F_VAR_VOID           1
35 #define F_VAR_LONG           2
36 #define F_VAR_STR            3
37 #define F_VAR_DOUBLE         4
38 #define F_VAR_OBJ            5
39 #define F_VAR_NS             6  /* hidden internal to make things work */
40 #define F_VAR_CLASS          7  /* blart, and again :) */
41 #define F_VAR_UARRAY         8
42 #define F_VAR_NUM            F_VAR_LONG
43 
44 #define FE_ALLOC  0
45 #define FE_STATIC  1
46 
47 #define VAI( var )  var->data.lval
48 #define VAF( var )  var->data.dval
49 #define VAS( var )  var->data.sval
50 #define VAP( var )  var->data.pval
51 #define VAO( var )  var->data.oval
52 #define VAUA( var ) var->data.aval
53 #define VAN( var )  var->data.nval
54 #define VAC( var )  var->data.cval
55 
56 #define PTR2VAR( var ) ((FeriteVariable *)var)
57 #define PARGX( var )   ((FeriteRegex *)(var))
58 
59 #define MARK_VARIABLE_AS_DISPOSABLE( var )    if( var != NULL ) var->flags |= FE_FLAG_DISPOSABLE;
60 #define UNMARK_VARIABLE_AS_DISPOSABLE( var )  if( var != NULL ) var->flags &= ~FE_FLAG_DISPOSABLE;
61 #define MARK_VARIABLE_AS_COMPILED( var )      if( var != NULL ) var->flags |= FE_FLAG_COMPILED;
62 #define UNMARK_VARIABLE_AS_COMPILED( var )    if( var != NULL ) var->flags &= ~FE_FLAG_COMPILED;
63 #define MARK_VARIABLE_AS_FINAL( var )         if( var != NULL ) var->flags |= FE_FLAG_FINAL;
64 #define UNMARK_VARIABLE_AS_FINAL( var )       if( var != NULL ) var->flags &= ~FE_FLAG_FINAL;
65 #define MARK_VARIABLE_AS_FINALSET( var )      if( var != NULL ) var->flags |= FE_FLAG_FINALSET;
66 #define UNMARK_VARIABLE_AS_FINALSET( var )    if( var != NULL ) var->flags &= ~FE_FLAG_FINALSET;
67 #define MARK_VARIABLE_AS_STATIC( var )        if( var != NULL ) var->flags |= FE_FLAG_IS_STATIC;
68 #define UNMARK_VARIABLE_AS_STATIC( var )      if( var != NULL ) var->flags &= ~FE_FLAG_IS_STATIC;
69 #define MARK_VARIABLE_AS_PLACEHOLDER( var )   if( var != NULL ) var->flags |= FE_FLAG_PLACEHOLDER;
70 #define UNMARK_VARIABLE_AS_PLACEHOLDER( var ) if( var != NULL ) var->flags &= ~FE_FLAG_PLACEHOLDER;
71 #define MARK_VARIABLENAME_AS_STATIC( var )    if( var != NULL ) var->flags |= FE_FLAG_STATIC_NAME;
72 #define UNMARK_VARIABLENAME_AS_STATIC( var )  if( var != NULL ) var->flags &= ~FE_FLAG_STATIC_NAME;
73 
74 #define FE_VAR_IS_DISPOSABLE( var )  ( var->flags & FE_FLAG_DISPOSABLE )
75 #define FE_VAR_IS_COMPILED( var )  ( var->flags & FE_FLAG_COMPILED )
76 #define FE_VAR_IS_FINAL( var )    ( var->flags & FE_FLAG_FINAL )
77 #define FE_VAR_IS_FINALSET( var )  ( var->flags & FE_FLAG_FINALSET )
78 #define FE_VAR_IS_STATIC( var )    ( var->flags & FE_FLAG_IS_STATIC )
79 #define FE_VAR_IS_PLACEHOLDER( var )  ( var->flags & FE_FLAG_PLACEHOLDER )
80 #define FE_VAR_NAME_IS_STATIC( var )  ( var->flags & FE_FLAG_STATIC_NAME )
81 
82 FERITE_API int                 ferite_variable_hash_loc( char *name, int size );
83 FERITE_API FeriteVariable     *ferite_variable_alloc(FeriteScript *script);
84 FERITE_API void                ferite_variable_destroy( FeriteScript *script, FeriteVariable *var );
85 FERITE_API FeriteVariable     *ferite_get_variable_ref( FeriteScript *script, FeriteVariable *variable );
86 FERITE_API FeriteVariableHash *ferite_variable_hash_alloc( FeriteScript *script, int size );
87 FERITE_API FeriteVariableHash *ferite_duplicate_variable_hash( FeriteScript *script, FeriteVariableHash *hash );
88 FERITE_API void                ferite_delete_variable_hash( FeriteScript *script, FeriteVariableHash *hash );
89 FERITE_API void                ferite_add_variable_to_hash( FeriteScript *script, FeriteVariableHash *hash, FeriteVariable *var );
90 FERITE_API FeriteVariable     *ferite_get_variable_from_hash( FeriteScript *script, FeriteVariableHash *hash, char *name );
91 
92 FERITE_API FeriteVariable     *ferite_create_string_variable( FeriteScript *script, char *name, FeriteString *data, int alloc );
93 FERITE_API FeriteVariable     *ferite_create_string_variable_from_ptr( FeriteScript *script, char *name, char *data, size_t length, int encoding, int alloc );
94 FERITE_API FeriteVariable     *ferite_create_number_long_variable( FeriteScript *script, char *name, long data, int alloc );
95 FERITE_API FeriteVariable     *ferite_create_number_double_variable( FeriteScript *script, char *name, double data, int alloc );
96 FERITE_API FeriteVariable     *ferite_create_object_variable( FeriteScript *script, char *name, int alloc );
97 FERITE_API FeriteVariable     *ferite_create_object_variable_with_data( FeriteScript *script, char *name, FeriteObject *o, int alloc );
98 FERITE_API FeriteVariable     *ferite_create_uarray_variable( FeriteScript *script, char *name, int size, int alloc );
99 FERITE_API FeriteVariable     *ferite_duplicate_variable( FeriteScript *script, FeriteVariable *var, void *extra );
100 FERITE_API FeriteVariable     *ferite_create_void_variable( FeriteScript *script, char *name, int alloc );
101 FERITE_API FeriteVariable     *ferite_create_class_variable( FeriteScript *script, char *name, FeriteClass *klass, int alloc );
102 FERITE_API FeriteVariable     *ferite_create_namespace_variable( FeriteScript *script, char *name, FeriteNamespace *ns, int alloc );
103 FERITE_API void                ferite_variables_dump( FeriteVariableHash *hash );
104 FERITE_API char               *ferite_variable_id_to_str( FeriteScript *script, int variable );
105 FERITE_API int                 ferite_variable_is_false( FeriteScript *script, FeriteVariable *var );
106 
107 FERITE_API long                ferite_number_as_long( FeriteScript *script, FeriteVariable *var );
108 FERITE_API double              ferite_number_as_double( FeriteScript *script, FeriteVariable *var );
109 FERITE_API FeriteString       *ferite_variable_to_str( FeriteScript *script, FeriteVariable *var,int quote);
110 FERITE_API void                ferite_create_variable_accessors( FeriteScript *script, FeriteVariable *var, void *get, void *set, void *cleanup, void *odata );
111 FERITE_API void                ferite_set_variable_name( FeriteScript *script, FeriteVariable *var, char *newname );
112 FERITE_API void                ferite_set_static_variable_name( FeriteScript *script, FeriteVariable *var, char *newname );
113 FERITE_API int                 ferite_types_are_equal( FeriteScript *script, int typea, int typeb );
114 FERITE_API void                ferite_variable_convert_to_type( FeriteScript *script, FeriteVariable *var, int type );
115 FERITE_API char                ferite_variable_type_to_char( FeriteScript *script, int type );
116 FERITE_API void                ferite_delete_pointer( FeriteScript *script, void *p );
117 
118 #endif /* __FERITE_VARIABLES_H__ */
119 
120