/* * Copyright (C) 2008 Search Solution Corporation. All rights reserved by Search Solution. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; version 2 of the License. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * */ /* * object_domain.h: data type definitions */ #ifndef _OBJECT_DOMAIN_H_ #define _OBJECT_DOMAIN_H_ #ident "$Id$" #include "config.h" #include #include "error_manager.h" #include "object_representation.h" #include "object_primitive.h" #include "area_alloc.h" /* * TP_DOMAIN_SELF_REF is used as an argument * to tp_domain_construct so that the self_ref flag can be set */ #define TP_DOMAIN_SELF_REF -1 typedef struct tp_domain { struct tp_domain *next; /* next in the same domain list */ struct tp_domain *next_list; /* next domain list */ struct pr_type *type; int precision; int scale; struct db_object *class_mop; /* swizzled class oid if on client */ unsigned self_ref:1; /* object self reference */ struct tp_domain *setdomain; /* hierarchical domain for sets */ OID class_oid; /* Class OID if type is tp_Object */ unsigned char codeset; /* codeset if national char */ /* * merge this with self_ref when we get a chance to rebuild the whole * system */ unsigned is_cached:1; /* set when the domain has been cached */ /* built-in reference number */ int built_in_index; /* non-zero if this type can be parameterized */ unsigned is_parameterized:1; unsigned is_desc:1; /* desc order for index key_type */ /* run-time flag used during domain comparison */ unsigned is_visited:1; } TP_DOMAIN; /* * We probably should make this 0 rather than -1 so that we can more easily * represent precisions with unsigned integers. Zero is not a valid * precision. */ #define TP_FLOATING_PRECISION_VALUE -1 /* * TP_ALLOC_CONTEXT * This structure is used in places where the storage allocation of * certain structures must be controlled. * */ typedef struct tp_alloc_context { void *(*alloc_func) (int size, ...); /* optional second argument */ void *alloc_args; void (*free_func) (void *mem, ...); /* optional second argument */ void *free_args; } TP_ALLOC_CONTEXT; #define TP_ALLOC(con, size) \ (*(con)->alloc_func)(size, (con)->alloc_args) #define TP_FREE(con, mem) \ (*(con)->free_func)(mem, (con)->free_args) /* DOMAIN ALLOCATION */ extern AREA *tp_Domain_area; /* * BUILT IN DOMAINS */ extern TP_DOMAIN tp_Null_domain; extern TP_DOMAIN tp_Integer_domain; extern TP_DOMAIN tp_Float_domain; extern TP_DOMAIN tp_Double_domain; extern TP_DOMAIN tp_String_domain; extern TP_DOMAIN tp_Object_domain; extern TP_DOMAIN tp_Set_domain; extern TP_DOMAIN tp_Multiset_domain; extern TP_DOMAIN tp_Sequence_domain; extern TP_DOMAIN tp_Elo_domain; extern TP_DOMAIN tp_Time_domain; extern TP_DOMAIN tp_Utime_domain; extern TP_DOMAIN tp_Date_domain; extern TP_DOMAIN tp_Monetary_domain; extern TP_DOMAIN tp_Variable_domain; extern TP_DOMAIN tp_Substructure_domain; extern TP_DOMAIN tp_Pointer_domain; extern TP_DOMAIN tp_Error_domain; extern TP_DOMAIN tp_Short_domain; extern TP_DOMAIN tp_Vobj_domain; extern TP_DOMAIN tp_Oid_domain; extern TP_DOMAIN tp_Numeric_domain; extern TP_DOMAIN tp_Char_domain; extern TP_DOMAIN tp_NChar_domain; extern TP_DOMAIN tp_VarNChar_domain; extern TP_DOMAIN tp_Bit_domain; extern TP_DOMAIN tp_VarBit_domain; extern TP_DOMAIN tp_Midxkey_domain; /* Type id to domain mapping array */ extern TP_DOMAIN *tp_Domains[]; /* * TP_DOMAIN_STATUS * This is used to defined a set of possible return codes * for the domain comparison and checking functions. * These don't set errors but rather rely on the higher level * modules to set a more appropriate error. */ typedef enum tp_domain_status { DOMAIN_COMPATIBLE = 0, /* success */ DOMAIN_INCOMPATIBLE, /* can't be coerced */ DOMAIN_OVERFLOW, /* value out of range */ DOMAIN_ERROR /* an error has been set */ } TP_DOMAIN_STATUS; /* * TP_MATCH * This is used to describe the amount of "tolerance" to be exhibited by * domain matching functions when looking for compatible domains. */ typedef enum tp_match { TP_ANY_MATCH, /* Any coercible domain matches. */ TP_EXACT_MATCH, /* Domain must match exactly. */ TP_STR_MATCH, /* "String" domains match subject to length * constraints and fixed/varying types, i.e., a * varying domain with precision n "matches" a * fixed domain with precision m if n >= m. * Only used in very special circumstances * where we're trying to avoid copying strings. */ TP_SET_MATCH } TP_MATCH; /* * TP_IS_SET_TYPE * Macros for detecting the set types, saves a function call. */ /* * !!! DB_TYPE_VOBJ probably should be added to this macro as this * is now the behavior of pr_is_set_type() which we should try to * phase out in favor of the faster inlin macro. Unfortunately, there * are a number of usages of both TP_IS_SET_TYPE that may break if * we change the semantics. Will have to think carefully about this */ #define TP_IS_SET_TYPE(typenum) \ ((((typenum) == DB_TYPE_SET) || ((typenum) == DB_TYPE_MULTISET) || \ ((typenum) == DB_TYPE_SEQUENCE)) ? true : false) /* * TP_IS_BIT_TYPE * Tests to see if the type id is one of the binary string types. */ #define TP_IS_BIT_TYPE(typeid) \ (((typeid) == DB_TYPE_VARBIT) || ((typeid) == DB_TYPE_BIT)) /* * TP_IS_CHAR_TYPE * Tests to see if a type is any one of the character types. */ #define TP_IS_CHAR_TYPE(typeid) \ (((typeid) == DB_TYPE_VARCHAR) || ((typeid) == DB_TYPE_CHAR) || \ ((typeid) == DB_TYPE_VARNCHAR) || ((typeid) == DB_TYPE_NCHAR)) /* * TP_IS_CHAR_BIT_TYPE * Tests to see if a type is one of the character or bit types. */ #define TP_IS_CHAR_BIT_TYPE(typeid) \ (TP_IS_CHAR_TYPE(typeid) || TP_IS_BIT_TYPE(typeid)) #define TP_IS_STRING_TYPE(typeid) \ TP_IS_CHAR_BIT_TYPE((typeid)) #define TP_IS_NUMERIC_TYPE(typeid) \ (((typeid) == DB_TYPE_INTEGER) || ((typeid) == DB_TYPE_FLOAT) || \ ((typeid) == DB_TYPE_DOUBLE) || ((typeid) == DB_TYPE_SMALLINT) || \ ((typeid) == DB_TYPE_NUMERIC) || ((typeid) == DB_TYPE_MONETARY)) /* * FUNCTIONS */ /* called during workspace initialization */ extern void tp_area_init (void); /* Domain support functions */ extern void tp_init (void); extern void tp_final (void); extern TP_DOMAIN *tp_domain_resolve (DB_TYPE domain_type, DB_OBJECT * class_obj, int precision, int scale, TP_DOMAIN * setdomain); extern TP_DOMAIN *tp_domain_resolve_default (DB_TYPE type); extern void tp_domain_free (TP_DOMAIN * dom); extern TP_DOMAIN *tp_domain_new (DB_TYPE type); extern TP_DOMAIN *tp_domain_copy (const TP_DOMAIN * dom, bool check_cache); extern TP_DOMAIN *tp_domain_construct (DB_TYPE domain_type, DB_OBJECT * class_obj, int precision, int scale, TP_DOMAIN * setdomain); extern void tp_init_value_domain (TP_DOMAIN * domain, DB_VALUE * value); extern TP_DOMAIN *tp_domain_cache (TP_DOMAIN * domain); extern int tp_domain_add (TP_DOMAIN ** dlist, TP_DOMAIN * domain); extern int tp_domain_drop (TP_DOMAIN ** dlist, TP_DOMAIN * domain); extern int tp_domain_filter_list (TP_DOMAIN * dlist); extern int tp_domain_size (const TP_DOMAIN * domain); extern int tp_domain_match (const TP_DOMAIN * dom1, const TP_DOMAIN * dom2, TP_MATCH exact); extern int tp_domain_compatible (const TP_DOMAIN * dom1, const TP_DOMAIN * dom2); extern TP_DOMAIN *tp_domain_select (const TP_DOMAIN * domain_list, const DB_VALUE * value, int allow_coercion, TP_MATCH exact_match); #if !defined (SERVER_MODE) extern TP_DOMAIN *tp_domain_select_type (const TP_DOMAIN * domain_list, DB_TYPE type, DB_OBJECT * class_mop, int allow_coercion); #endif extern TP_DOMAIN_STATUS tp_domain_check (const TP_DOMAIN * domain, const DB_VALUE * value, TP_MATCH exact_match); TP_DOMAIN *tp_domain_find_noparam (DB_TYPE type, bool is_desc); TP_DOMAIN *tp_domain_find_numeric (DB_TYPE type, int precision, int scale, bool is_desc); TP_DOMAIN *tp_domain_find_charbit (DB_TYPE type, int codeset, int precision, bool is_desc); TP_DOMAIN *tp_domain_find_object (DB_TYPE type, OID * class_oid, struct db_object *class_, bool is_desc); TP_DOMAIN *tp_domain_find_set (DB_TYPE type, TP_DOMAIN * setdomain, bool is_desc); TP_DOMAIN *tp_domain_resolve_value (DB_VALUE * val, TP_DOMAIN * dbuf); TP_DOMAIN *tp_create_domain_resolve_value (DB_VALUE * val, TP_DOMAIN * domain); int tp_can_steal_string (const DB_VALUE * val, const DB_DOMAIN * desired_domain); int tp_domain_references_objects (const TP_DOMAIN * dom); /* value functions */ extern TP_DOMAIN_STATUS tp_value_coerce (const DB_VALUE * src, DB_VALUE * dest, const TP_DOMAIN * desired_domain); extern TP_DOMAIN_STATUS tp_value_cast (const DB_VALUE * src, DB_VALUE * dest, const TP_DOMAIN * desired_domain, bool implicit_coercion); extern TP_DOMAIN_STATUS tp_value_cast_no_domain_select (const DB_VALUE * src, DB_VALUE * dest, const TP_DOMAIN * desired_domain, bool implicit_coercion); extern int tp_value_equal (const DB_VALUE * value1, const DB_VALUE * value2, int allow_coercion); extern int tp_more_general_type (const DB_TYPE type1, const DB_TYPE type2); extern int tp_value_compare (const DB_VALUE * value1, const DB_VALUE * value2, int allow_coercion, int total_order); extern int tp_set_compare (const DB_VALUE * value1, const DB_VALUE * value2, int allow_coercion, int total_order); /* printed representations */ extern int tp_domain_name (TP_DOMAIN * domain, char *buffer, int maxlen); extern int tp_value_domain_name (DB_VALUE * value, char *buffer, int maxlen); /* misc info */ extern int tp_domain_disk_size (TP_DOMAIN * domain); extern int tp_domain_memory_size (TP_DOMAIN * domain); extern TP_DOMAIN_STATUS tp_check_value_size (TP_DOMAIN * domain, DB_VALUE * value); extern int tp_valid_indextype (DB_TYPE type); extern void tp_dump_domain (TP_DOMAIN * domain); extern void tp_domain_print (TP_DOMAIN * domain); extern void tp_domain_fprint (FILE * fp, TP_DOMAIN * domain); extern int tp_domain_attach (TP_DOMAIN ** dlist, TP_DOMAIN * domain); #endif /* _OBJECT_DOMAIN_H_ */