pg 1.5.9 → 1.7.0

data/ext/pg_coder.c

@@ -95,13 +95,13 @@ const rb_data_type_t pg_coder_type = {
 		(RUBY_DATA_FUNC) NULL,
 		RUBY_TYPED_DEFAULT_FREE,
 		pg_coder_memsize,
-		pg_compact_callback(pg_coder_compact),
+		pg_coder_compact,
 	},
 	0,
 	0,
 	// IMPORTANT: WB_PROTECTED objects must only use the RB_OBJ_WRITE()
 	// macro to update VALUE references, as to trigger write barriers.
-	RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | PG_RUBY_TYPED_FROZEN_SHAREABLE,
+	RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_FROZEN_SHAREABLE,
 };
 
 static VALUE
@@ -119,11 +119,11 @@ static const rb_data_type_t pg_composite_coder_type = {
 		(RUBY_DATA_FUNC) NULL,
 		RUBY_TYPED_DEFAULT_FREE,
 		pg_composite_coder_memsize,
-		pg_compact_callback(pg_composite_coder_compact),
+		pg_composite_coder_compact,
 	},
 	&pg_coder_type,
 	0,
-	RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | PG_RUBY_TYPED_FROZEN_SHAREABLE,
+	RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_FROZEN_SHAREABLE,
 };
 
 static VALUE
@@ -135,6 +135,7 @@ pg_composite_encoder_allocate( VALUE klass )
 	this->elem = NULL;
 	this->needs_quotation = 1;
 	this->delimiter = ',';
+	this->dimensions = -1;
 	rb_iv_set( self, "@elements_type", Qnil );
 	return self;
 }
@@ -157,6 +158,7 @@ pg_composite_decoder_allocate( VALUE klass )
 	this->elem = NULL;
 	this->needs_quotation = 1;
 	this->delimiter = ',';
+	this->dimensions = -1;
 	rb_iv_set( self, "@elements_type", Qnil );
 	return self;
 }
@@ -175,7 +177,7 @@ static VALUE
 pg_coder_encode(int argc, VALUE *argv, VALUE self)
 {
 	VALUE res;
-	VALUE intermediate;
+	VALUE intermediate = Qnil;
 	VALUE value;
 	int len, len2;
 	int enc_idx;
@@ -213,8 +215,6 @@ pg_coder_encode(int argc, VALUE *argv, VALUE self)
 	}
 	rb_str_set_len( res, len2 );
 
-	RB_GC_GUARD(intermediate);
-
 	return res;
 }
 
@@ -364,6 +364,7 @@ pg_coder_flags_get(VALUE self)
  * Specifies whether the assigned #elements_type requires quotation marks to
  * be transferred safely. Encoding with #needs_quotation=false is somewhat
  * faster.
+ * It is only used by text coders and ignored by binary coders.
  *
  * The default is +true+. This option is ignored for decoding of values.
  */
@@ -397,6 +398,7 @@ pg_coder_needs_quotation_get(VALUE self)
  * Specifies the character that separates values within the composite type.
  * The default is a comma.
  * This must be a single one-byte character.
+ * It is only used by text coders and ignored by binary coders.
  */
 static VALUE
 pg_coder_delimiter_set(VALUE self, VALUE delimiter)
@@ -423,6 +425,49 @@ pg_coder_delimiter_get(VALUE self)
 	return rb_str_new(&this->delimiter, 1);
 }
 
+/*
+ * call-seq:
+ *    coder.dimensions = Integer
+ *    coder.dimensions = nil
+ *
+ * Set number of array dimensions to be encoded.
+ *
+ * This property ensures, that this number of dimensions is always encoded.
+ * If less dimensions than this number are in the given value, an ArgumentError is raised.
+ * If more dimensions than this number are in the value, the Array value is passed to the next encoder.
+ *
+ * Setting dimensions is especially useful, when a Record shall be encoded into an Array, since the Array encoder can not distinguish if the array shall be encoded as a higher dimension or as a record otherwise.
+ *
+ * The default is +nil+.
+ *
+ * See #dimensions
+ */
+static VALUE
+pg_coder_dimensions_set(VALUE self, VALUE dimensions)
+{
+	t_pg_composite_coder *this = RTYPEDDATA_DATA(self);
+	rb_check_frozen(self);
+	if(!NIL_P(dimensions) && NUM2INT(dimensions) < 0)
+		rb_raise( rb_eArgError, "dimensions must be nil or >= 0");
+	this->dimensions = NIL_P(dimensions) ? -1 : NUM2INT(dimensions);
+	return dimensions;
+}
+
+/*
+ * call-seq:
+ *    coder.dimensions -> Integer | nil
+ *
+ * Get number of enforced array dimensions or +nil+ if not set.
+ *
+ * See #dimensions=
+ */
+static VALUE
+pg_coder_dimensions_get(VALUE self)
+{
+	t_pg_composite_coder *this = RTYPEDDATA_DATA(self);
+	return this->dimensions < 0 ? Qnil : INT2NUM(this->dimensions);
+}
+
 /*
  * call-seq:
  *    coder.elements_type = coder
@@ -460,7 +505,7 @@ static const rb_data_type_t pg_coder_cfunc_type = {
 	},
 	0,
 	0,
-	RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | PG_RUBY_TYPED_FROZEN_SHAREABLE,
+	RUBY_TYPED_FREE_IMMEDIATELY | RUBY_TYPED_WB_PROTECTED | RUBY_TYPED_FROZEN_SHAREABLE,
 };
 
 VALUE
@@ -586,7 +631,7 @@ init_pg_coder(void)
 	/*
 	 * Name of the coder or the corresponding data type.
 	 *
-	 * This accessor is only used in PG::Coder#inspect .
+	 * This accessor is used by PG::Coder#inspect and PG::Connection#embed_params .
 	 */
 	rb_define_attr(   rb_cPG_Coder, "name", 1, 1 );
 
@@ -604,6 +649,8 @@ init_pg_coder(void)
 	 *
 	 * This is the base class for all type cast classes of PostgreSQL types,
 	 * that are made up of some sub type.
+	 *
+	 * See PG::TextEncoder::Array, PG::TextDecoder::Array, PG::BinaryEncoder::Array, PG::BinaryDecoder::Array, etc.
 	 */
 	rb_cPG_CompositeCoder = rb_define_class_under( rb_mPG, "CompositeCoder", rb_cPG_Coder );
 	rb_define_method( rb_cPG_CompositeCoder, "elements_type=", pg_coder_elements_type_set, 1 );
@@ -612,6 +659,8 @@ init_pg_coder(void)
 	rb_define_method( rb_cPG_CompositeCoder, "needs_quotation?", pg_coder_needs_quotation_get, 0 );
 	rb_define_method( rb_cPG_CompositeCoder, "delimiter=", pg_coder_delimiter_set, 1 );
 	rb_define_method( rb_cPG_CompositeCoder, "delimiter", pg_coder_delimiter_get, 0 );
+	rb_define_method( rb_cPG_CompositeCoder, "dimensions=", pg_coder_dimensions_set, 1 );
+	rb_define_method( rb_cPG_CompositeCoder, "dimensions", pg_coder_dimensions_get, 0 );
 
 	/* Document-class: PG::CompositeEncoder < PG::CompositeCoder */
 	rb_cPG_CompositeEncoder = rb_define_class_under( rb_mPG, "CompositeEncoder", rb_cPG_CompositeCoder );