pg 0.17.1 → 0.18.4

data/ext/pg_type_map_by_column.c

@@ -0,0 +1,312 @@
+/*
+ * pg_column_map.c - PG::ColumnMap class extension
+ * $Id: pg_type_map_by_column.c,v fcf731d3dff7 2015/09/08 12:25:06 jfali $
+ *
+ */
+
+#include "pg.h"
+
+static VALUE rb_cTypeMapByColumn;
+static ID s_id_decode;
+static ID s_id_encode;
+
+static VALUE pg_tmbc_s_allocate( VALUE klass );
+
+static VALUE
+pg_tmbc_fit_to_result( VALUE self, VALUE result )
+{
+	int nfields;
+	t_tmbc *this = DATA_PTR( self );
+	t_typemap *default_tm;
+	VALUE sub_typemap;
+
+	nfields = PQnfields( pgresult_get(result) );
+	if ( this->nfields != nfields ) {
+		rb_raise( rb_eArgError, "number of result fields (%d) does not match number of mapped columns (%d)",
+				nfields, this->nfields );
+	}
+
+	/* Ensure that the default type map fits equaly. */
+	default_tm = DATA_PTR( this->typemap.default_typemap );
+	sub_typemap = default_tm->funcs.fit_to_result( this->typemap.default_typemap, result );
+
+	/* Did the default type return the same object ? */
+	if( sub_typemap == this->typemap.default_typemap ){
+		return self;
+	} else {
+		/* Our default type map built a new object, so we need to propagate it
+		 * and build a copy of this type map and set it as default there.. */
+		VALUE new_typemap = pg_tmbc_s_allocate( rb_cTypeMapByColumn );
+		size_t struct_size = sizeof(t_tmbc) + sizeof(struct pg_tmbc_converter) * nfields;
+		t_tmbc *p_new_typemap = (t_tmbc *)xmalloc(struct_size);
+
+		memcpy( p_new_typemap, this, struct_size );
+		p_new_typemap->typemap.default_typemap = sub_typemap;
+		DATA_PTR(new_typemap) = p_new_typemap;
+		return new_typemap;
+	}
+}
+
+static VALUE
+pg_tmbc_fit_to_query( VALUE self, VALUE params )
+{
+	int nfields;
+	t_tmbc *this = DATA_PTR( self );
+	t_typemap *default_tm;
+
+	nfields = (int)RARRAY_LEN( params );
+	if ( this->nfields != nfields ) {
+		rb_raise( rb_eArgError, "number of result fields (%d) does not match number of mapped columns (%d)",
+				nfields, this->nfields );
+	}
+
+	/* Ensure that the default type map fits equaly. */
+	default_tm = DATA_PTR( this->typemap.default_typemap );
+	default_tm->funcs.fit_to_query( this->typemap.default_typemap, params );
+
+	return self;
+}
+
+static int
+pg_tmbc_fit_to_copy_get( VALUE self )
+{
+	t_tmbc *this = DATA_PTR( self );
+
+	/* Ensure that the default type map fits equaly. */
+	t_typemap *default_tm = DATA_PTR( this->typemap.default_typemap );
+	default_tm->funcs.fit_to_copy_get( this->typemap.default_typemap );
+
+	return this->nfields;
+}
+
+
+VALUE
+pg_tmbc_result_value( t_typemap *p_typemap, VALUE result, int tuple, int field )
+{
+	t_pg_coder *p_coder = NULL;
+	t_pg_result *p_result = pgresult_get_this(result);
+	t_tmbc *this = (t_tmbc *) p_typemap;
+	t_typemap *default_tm;
+
+	if (PQgetisnull(p_result->pgresult, tuple, field)) {
+		return Qnil;
+	}
+
+	p_coder = this->convs[field].cconv;
+
+	if( p_coder ){
+		char * val = PQgetvalue( p_result->pgresult, tuple, field );
+		int len = PQgetlength( p_result->pgresult, tuple, field );
+
+		if( p_coder->dec_func ){
+			return p_coder->dec_func(p_coder, val, len, tuple, field, ENCODING_GET(result));
+		} else {
+			t_pg_coder_dec_func dec_func;
+			dec_func = pg_coder_dec_func( p_coder, PQfformat(p_result->pgresult, field) );
+			return dec_func(p_coder, val, len, tuple, field, ENCODING_GET(result));
+		}
+	}
+
+	default_tm = DATA_PTR( this->typemap.default_typemap );
+	return default_tm->funcs.typecast_result_value( default_tm, result, tuple, field );
+}
+
+static t_pg_coder *
+pg_tmbc_typecast_query_param( t_typemap *p_typemap, VALUE param_value, int field )
+{
+	t_tmbc *this = (t_tmbc *) p_typemap;
+
+	/* Number of fields were already checked in pg_tmbc_fit_to_query() */
+	t_pg_coder *p_coder = this->convs[field].cconv;
+
+	if( !p_coder ){
+		t_typemap *default_tm = DATA_PTR( this->typemap.default_typemap );
+		return default_tm->funcs.typecast_query_param( default_tm, param_value, field );
+	}
+
+	return p_coder;
+}
+
+static VALUE
+pg_tmbc_typecast_copy_get( t_typemap *p_typemap, VALUE field_str, int fieldno, int format, int enc_idx )
+{
+	t_tmbc *this = (t_tmbc *) p_typemap;
+	t_pg_coder *p_coder;
+	t_pg_coder_dec_func dec_func;
+
+	if ( fieldno >= this->nfields || fieldno < 0 ) {
+		rb_raise( rb_eArgError, "number of copy fields (%d) exceeds number of mapped columns (%d)",
+				fieldno, this->nfields );
+	}
+
+	p_coder = this->convs[fieldno].cconv;
+
+	if( !p_coder ){
+		t_typemap *default_tm = DATA_PTR( this->typemap.default_typemap );
+		return default_tm->funcs.typecast_copy_get( default_tm, field_str, fieldno, format, enc_idx );
+	}
+
+	dec_func = pg_coder_dec_func( p_coder, format );
+
+	/* Is it a pure String conversion? Then we can directly send field_str to the user. */
+	if( dec_func == pg_text_dec_string ){
+		PG_ENCODING_SET_NOCHECK( field_str, enc_idx );
+		return field_str;
+	}
+	if( dec_func == pg_bin_dec_bytea ){
+		PG_ENCODING_SET_NOCHECK( field_str, rb_ascii8bit_encindex() );
+		return field_str;
+	}
+
+	return dec_func( p_coder, RSTRING_PTR(field_str), RSTRING_LEN(field_str), 0, fieldno, enc_idx );
+}
+
+const struct pg_typemap_funcs pg_tmbc_funcs = {
+	pg_tmbc_fit_to_result,
+	pg_tmbc_fit_to_query,
+	pg_tmbc_fit_to_copy_get,
+	pg_tmbc_result_value,
+	pg_tmbc_typecast_query_param,
+	pg_tmbc_typecast_copy_get
+};
+
+static void
+pg_tmbc_mark( t_tmbc *this )
+{
+	int i;
+
+	/* allocated but not initialized ? */
+	if( this == (t_tmbc *)&pg_typemap_funcs ) return;
+
+	rb_gc_mark(this->typemap.default_typemap);
+	for( i=0; i<this->nfields; i++){
+		t_pg_coder *p_coder = this->convs[i].cconv;
+		if( p_coder )
+			rb_gc_mark(p_coder->coder_obj);
+	}
+}
+
+static void
+pg_tmbc_free( t_tmbc *this )
+{
+	/* allocated but not initialized ? */
+	if( this == (t_tmbc *)&pg_typemap_funcs ) return;
+	xfree( this );
+}
+
+static VALUE
+pg_tmbc_s_allocate( VALUE klass )
+{
+	/* Use pg_typemap_funcs as interim struct until #initialize is called. */
+	return Data_Wrap_Struct( klass, pg_tmbc_mark, pg_tmbc_free, (t_tmbc *)&pg_typemap_funcs );
+}
+
+VALUE
+pg_tmbc_allocate()
+{
+	return pg_tmbc_s_allocate(rb_cTypeMapByColumn);
+}
+
+/*
+ * call-seq:
+ *    PG::TypeMapByColumn.new( coders )
+ *
+ * Builds a new type map and assigns a list of coders for the given column.
+ * +coders+ must be an Array of PG::Coder objects or +nil+ values.
+ * The length of the Array corresponds to
+ * the number of columns or bind parameters this type map is usable for.
+ *
+ * A +nil+ value will forward the given field to the #default_type_map .
+ */
+static VALUE
+pg_tmbc_init(VALUE self, VALUE conv_ary)
+{
+	int i;
+	t_tmbc *this;
+	int conv_ary_len;
+
+	Check_Type(self, T_DATA);
+	Check_Type(conv_ary, T_ARRAY);
+	conv_ary_len = RARRAY_LEN(conv_ary);
+	this = xmalloc(sizeof(t_tmbc) + sizeof(struct pg_tmbc_converter) * conv_ary_len);
+	/* Set nfields to 0 at first, so that GC mark function doesn't access uninitialized memory. */
+	this->nfields = 0;
+	this->typemap.funcs = pg_tmbc_funcs;
+	this->typemap.default_typemap = pg_typemap_all_strings;
+	DATA_PTR(self) = this;
+
+	for(i=0; i<conv_ary_len; i++)
+	{
+		VALUE obj = rb_ary_entry(conv_ary, i);
+
+		if( obj == Qnil ){
+			/* no type cast */
+			this->convs[i].cconv = NULL;
+		} else if( rb_obj_is_kind_of(obj, rb_cPG_Coder) ){
+			Data_Get_Struct(obj, t_pg_coder, this->convs[i].cconv);
+		} else {
+			rb_raise(rb_eArgError, "argument %d has invalid type %s (should be nil or some kind of PG::Coder)",
+							 i+1, rb_obj_classname( obj ));
+		}
+	}
+
+	this->nfields = conv_ary_len;
+
+	return self;
+}
+
+/*
+ * call-seq:
+ *    typemap.coders -> Array
+ *
+ * Array of PG::Coder objects. The length of the Array corresponds to
+ * the number of columns or bind parameters this type map is usable for.
+ */
+static VALUE
+pg_tmbc_coders(VALUE self)
+{
+	int i;
+	t_tmbc *this = DATA_PTR( self );
+	VALUE ary_coders = rb_ary_new();
+
+	for( i=0; i<this->nfields; i++){
+		t_pg_coder *conv = this->convs[i].cconv;
+		if( conv ) {
+			rb_ary_push( ary_coders, conv->coder_obj );
+		} else {
+			rb_ary_push( ary_coders, Qnil );
+		}
+	}
+
+	return rb_obj_freeze(ary_coders);
+}
+
+void
+init_pg_type_map_by_column()
+{
+	s_id_decode = rb_intern("decode");
+	s_id_encode = rb_intern("encode");
+
+	/*
+	 * Document-class: PG::TypeMapByColumn < PG::TypeMap
+	 *
+	 * This type map casts values by a coder assigned per field/column.
+	 *
+	 * Each PG:TypeMapByColumn has a fixed list of either encoders or decoders,
+	 * that is defined at #new . A type map with encoders is usable for type casting
+	 * query bind parameters and COPY data for PG::Connection#put_copy_data .
+	 * A type map with decoders is usable for type casting of result values and
+	 * COPY data from PG::Connection#get_copy_data .
+	 *
+	 * PG::TypeMapByColumns are in particular useful in conjunction with prepared statements,
+	 * since they can be cached alongside with the statement handle.
+	 *
+	 * This type map strategy is also used internally by PG::TypeMapByOid, when the
+	 * number of rows of a result set exceeds a given limit.
+	 */
+	rb_cTypeMapByColumn = rb_define_class_under( rb_mPG, "TypeMapByColumn", rb_cTypeMap );
+	rb_define_alloc_func( rb_cTypeMapByColumn, pg_tmbc_s_allocate );
+	rb_define_method( rb_cTypeMapByColumn, "initialize", pg_tmbc_init, 1 );
+	rb_define_method( rb_cTypeMapByColumn, "coders", pg_tmbc_coders, 0 );
+	rb_include_module( rb_cTypeMapByColumn, rb_mDefaultTypeMappable );
+}

data/ext/pg_type_map_by_mri_type.c

@@ -0,0 +1,284 @@
+/*
+ * pg_type_map_by_mri_type.c - PG::TypeMapByMriType class extension
+ * $Id: pg_type_map_by_mri_type.c,v 1269b8ad77b8 2015/02/06 16:38:23 lars $
+ *
+ * This type map can be used to select value encoders based on the MRI-internal
+ * value type code.
+ *
+ */
+
+#include "pg.h"
+
+static VALUE rb_cTypeMapByMriType;
+
+#define FOR_EACH_MRI_TYPE(func) \
+	func(T_FIXNUM) \
+	func(T_TRUE) \
+	func(T_FALSE) \
+	func(T_FLOAT) \
+	func(T_BIGNUM) \
+	func(T_COMPLEX) \
+	func(T_RATIONAL) \
+	func(T_ARRAY) \
+	func(T_STRING) \
+	func(T_SYMBOL) \
+	func(T_OBJECT) \
+	func(T_CLASS) \
+	func(T_MODULE) \
+	func(T_REGEXP) \
+	func(T_HASH) \
+	func(T_STRUCT) \
+	func(T_FILE) \
+	func(T_DATA)
+
+#define DECLARE_CODER(type) \
+	t_pg_coder *coder_##type; \
+	VALUE ask_##type; \
+	VALUE coder_obj_##type;
+
+typedef struct {
+	t_typemap typemap;
+	struct pg_tmbmt_converter {
+		FOR_EACH_MRI_TYPE( DECLARE_CODER )
+	} coders;
+} t_tmbmt;
+
+
+#define CASE_AND_GET(type) \
+	case type: \
+		p_coder = this->coders.coder_##type; \
+		ask_for_coder = this->coders.ask_##type; \
+		break;
+
+static t_pg_coder *
+pg_tmbmt_typecast_query_param( t_typemap *p_typemap, VALUE param_value, int field )
+{
+	t_tmbmt *this = (t_tmbmt *)p_typemap;
+	t_pg_coder *p_coder;
+	VALUE ask_for_coder;
+
+	switch(TYPE(param_value)){
+			FOR_EACH_MRI_TYPE( CASE_AND_GET )
+		default:
+			/* unknown MRI type */
+			p_coder = NULL;
+			ask_for_coder = Qnil;
+	}
+
+	if( !NIL_P(ask_for_coder) ){
+		/* No static Coder object, but proc/method given to ask for the Coder to use. */
+		VALUE obj;
+
+		obj = rb_funcall(ask_for_coder, rb_intern("call"), 1, param_value);
+
+		if( rb_obj_is_kind_of(obj, rb_cPG_Coder) ){
+			Data_Get_Struct(obj, t_pg_coder, p_coder);
+		}else{
+			rb_raise(rb_eTypeError, "argument %d has invalid type %s (should be nil or some kind of PG::Coder)",
+						field+1, rb_obj_classname( obj ));
+		}
+	}
+
+	if( !p_coder ){
+		t_typemap *default_tm = DATA_PTR( this->typemap.default_typemap );
+		return default_tm->funcs.typecast_query_param( default_tm, param_value, field );
+	}
+
+	return p_coder;
+}
+
+static VALUE
+pg_tmbmt_fit_to_query( VALUE self, VALUE params )
+{
+	t_tmbmt *this = (t_tmbmt *)DATA_PTR(self);
+	/* Nothing to check at this typemap, but ensure that the default type map fits. */
+	t_typemap *default_tm = DATA_PTR( this->typemap.default_typemap );
+	default_tm->funcs.fit_to_query( this->typemap.default_typemap, params );
+	return self;
+}
+
+#define GC_MARK_AS_USED(type) \
+	rb_gc_mark( this->coders.ask_##type ); \
+	rb_gc_mark( this->coders.coder_obj_##type );
+
+static void
+pg_tmbmt_mark( t_tmbmt *this )
+{
+	rb_gc_mark(this->typemap.default_typemap);
+	FOR_EACH_MRI_TYPE( GC_MARK_AS_USED );
+}
+
+#define INIT_VARIABLES(type) \
+	this->coders.coder_##type = NULL; \
+	this->coders.ask_##type = Qnil; \
+	this->coders.coder_obj_##type = Qnil;
+
+static VALUE
+pg_tmbmt_s_allocate( VALUE klass )
+{
+	t_tmbmt *this;
+	VALUE self;
+
+	self = Data_Make_Struct( klass, t_tmbmt, pg_tmbmt_mark, -1, this );
+	this->typemap.funcs.fit_to_result = pg_typemap_fit_to_result;
+	this->typemap.funcs.fit_to_query = pg_tmbmt_fit_to_query;
+	this->typemap.funcs.fit_to_copy_get = pg_typemap_fit_to_copy_get;
+	this->typemap.funcs.typecast_result_value = pg_typemap_result_value;
+	this->typemap.funcs.typecast_query_param = pg_tmbmt_typecast_query_param;
+	this->typemap.funcs.typecast_copy_get = pg_typemap_typecast_copy_get;
+	this->typemap.default_typemap = pg_typemap_all_strings;
+
+	FOR_EACH_MRI_TYPE( INIT_VARIABLES );
+
+	return self;
+}
+
+#define COMPARE_AND_ASSIGN(type) \
+	else if(!strcmp(p_mri_type, #type)){ \
+		this->coders.coder_obj_##type = coder; \
+		if(NIL_P(coder)){ \
+			this->coders.coder_##type = NULL; \
+			this->coders.ask_##type = Qnil; \
+		}else if(rb_obj_is_kind_of(coder, rb_cPG_Coder)){ \
+			Data_Get_Struct(coder, t_pg_coder, this->coders.coder_##type); \
+			this->coders.ask_##type = Qnil; \
+		}else if(RB_TYPE_P(coder, T_SYMBOL)){ \
+			this->coders.coder_##type = NULL; \
+			this->coders.ask_##type = rb_obj_method( self, coder ); \
+		}else{ \
+			this->coders.coder_##type = NULL; \
+			this->coders.ask_##type = coder; \
+		} \
+	}
+
+/*
+ * call-seq:
+ *    typemap.[mri_type] = coder
+ *
+ * Assigns a new PG::Coder object to the type map. The encoder
+ * is registered for type casts of the given +mri_type+ .
+ *
+ * +coder+ can be one of the following:
+ * * +nil+        - Values are forwarded to the #default_type_map .
+ * * a PG::Coder  - Values are encoded by the given encoder
+ * * a Symbol     - The method of this type map (or a derivation) that is called for each value to sent.
+ *   It must return a PG::Coder.
+ * * a Proc       - The Proc object is called for each value. It must return a PG::Coder.
+ *
+ * +mri_type+ must be one of the following strings:
+ * * +T_FIXNUM+
+ * * +T_TRUE+
+ * * +T_FALSE+
+ * * +T_FLOAT+
+ * * +T_BIGNUM+
+ * * +T_COMPLEX+
+ * * +T_RATIONAL+
+ * * +T_ARRAY+
+ * * +T_STRING+
+ * * +T_SYMBOL+
+ * * +T_OBJECT+
+ * * +T_CLASS+
+ * * +T_MODULE+
+ * * +T_REGEXP+
+ * * +T_HASH+
+ * * +T_STRUCT+
+ * * +T_FILE+
+ * * +T_DATA+
+ */
+static VALUE
+pg_tmbmt_aset( VALUE self, VALUE mri_type, VALUE coder )
+{
+	t_tmbmt *this = DATA_PTR( self );
+	char *p_mri_type;
+
+	p_mri_type = StringValueCStr(mri_type);
+
+	if(0){}
+	FOR_EACH_MRI_TYPE( COMPARE_AND_ASSIGN )
+	else{
+		VALUE mri_type_inspect = rb_inspect( mri_type );
+		rb_raise(rb_eArgError, "unknown mri_type %s", StringValueCStr(mri_type_inspect));
+	}
+
+	return self;
+}
+
+#define COMPARE_AND_GET(type) \
+	else if(!strcmp(p_mri_type, #type)){ \
+		coder = this->coders.coder_obj_##type; \
+	}
+
+/*
+ * call-seq:
+ *    typemap.[mri_type] -> coder
+ *
+ * Returns the encoder object for the given +mri_type+
+ *
+ * See #[]= for allowed +mri_type+ .
+ */
+static VALUE
+pg_tmbmt_aref( VALUE self, VALUE mri_type )
+{
+	VALUE coder;
+	t_tmbmt *this = DATA_PTR( self );
+	char *p_mri_type;
+
+	p_mri_type = StringValueCStr(mri_type);
+
+	if(0){}
+	FOR_EACH_MRI_TYPE( COMPARE_AND_GET )
+	else{
+		VALUE mri_type_inspect = rb_inspect( mri_type );
+		rb_raise(rb_eArgError, "unknown mri_type %s", StringValueCStr(mri_type_inspect));
+	}
+
+	return coder;
+}
+
+#define ADD_TO_HASH(type) \
+	rb_hash_aset( hash_coders, rb_obj_freeze(rb_str_new2(#type)), this->coders.coder_obj_##type );
+
+
+/*
+ * call-seq:
+ *    typemap.coders -> Hash
+ *
+ * Returns all mri types and their assigned encoder object.
+ */
+static VALUE
+pg_tmbmt_coders( VALUE self )
+{
+	t_tmbmt *this = DATA_PTR( self );
+	VALUE hash_coders = rb_hash_new();
+
+	FOR_EACH_MRI_TYPE( ADD_TO_HASH );
+
+	return rb_obj_freeze(hash_coders);
+}
+
+void
+init_pg_type_map_by_mri_type()
+{
+	/*
+	 * Document-class: PG::TypeMapByMriType < PG::TypeMap
+	 *
+	 * This type map casts values based on the Ruby object type code of the given value
+	 * to be sent.
+	 *
+	 * This type map is usable for type casting query bind parameters and COPY data
+	 * for PG::Connection#put_copy_data . Therefore only encoders might be assigned by
+	 * the #[]= method.
+	 *
+	 * _Note_ : This type map is not portable across Ruby implementations and is less flexible
+	 * than PG::TypeMapByClass.
+	 * It is kept only for performance comparisons, but PG::TypeMapByClass proved to be equally
+	 * fast in almost all cases.
+	 *
+	 */
+	rb_cTypeMapByMriType = rb_define_class_under( rb_mPG, "TypeMapByMriType", rb_cTypeMap );
+	rb_define_alloc_func( rb_cTypeMapByMriType, pg_tmbmt_s_allocate );
+	rb_define_method( rb_cTypeMapByMriType, "[]=", pg_tmbmt_aset, 2 );
+	rb_define_method( rb_cTypeMapByMriType, "[]", pg_tmbmt_aref, 1 );
+	rb_define_method( rb_cTypeMapByMriType, "coders", pg_tmbmt_coders, 0 );
+	rb_include_module( rb_cTypeMapByMriType, rb_mDefaultTypeMappable );
+}