File: rbzoompackage.c

package info (click to toggle)
ruby-zoom 0.5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 264 kB
  • sloc: ansic: 680; xml: 262; ruby: 255; makefile: 4
file content (199 lines) | stat: -rw-r--r-- 5,206 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/*
 * Copyright (C) 2007 Katipo Communications, Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include "rbzoom.h"
#include <stdio.h>

#ifdef MAKING_RDOC_HAPPY
mZoom = rb_define_module("ZOOM");
#endif

/* Document-class: ZOOM::Package
 *
 * This class represents an Extended Services Package: an instruction to the server 
 * to do something not covered by the core parts of the Z39.50 standard 
 */
static VALUE cZoomPackage;


static ZOOM_package
rbz_package_get (VALUE obj)
{
    ZOOM_package package;

	if (cZoomPackage == Qnil)
		rb_raise(rb_eRuntimeError, "cZoomPackage is nil: has destroy() already been called on this Package?");
        
    Data_Get_Struct (obj, struct ZOOM_package_p, package);
    assert (package != NULL);

    return package;
}


/*
 * call-seq: 
 * 	make(connection, options)
*
*  Creates a ZOOM::Package from the connection and options specified.
*
*  Returns: the created ZOOM::Package or Qnil.
*/
VALUE
rbz_package_make (ZOOM_connection connection, ZOOM_options options)
{

  ZOOM_package package;

  package =  ZOOM_connection_package(connection, options);

  if (cZoomPackage == Qnil)
	rb_raise(rb_eRuntimeError, "cZoomPackage is nil: has destroy() already been called on this Package?");

  return package != NULL
      ? Data_Wrap_Struct (cZoomPackage,
                          NULL,
                          ZOOM_package_destroy,
                          package)
      : Qnil;
}


/*
 * call-seq:
 * 	set_option(key, value)
 *
 * key: the name of the option, as a string.
 *
 * value: the value of this option (as a string, integer or boolean).
 *
 * Sets an option on the package.
 * 
 * Returns: self.
 */
static VALUE
rbz_package_set_option (VALUE self, VALUE key, VALUE val)
{   

	ZOOM_package package;
    
    package = rbz_package_get (self);
    ZOOM_package_option_set (package,
                                RVAL2CSTR (key),
                                RVAL2CSTR (rb_obj_as_string (val)));
   
    return self;
}


/*
 * call-seq:
 * 	get_option(key)
 *
 * key: the name of the option, as a string.
 *
 * Gets the value of a package's option.
 * 
 * Returns: the value of the given option, as a string, integer or boolean.
 */
static VALUE
rbz_package_get_option (VALUE self, VALUE key)
{
	ZOOM_package package;
    const char *value;
 
    package = rbz_package_get (self);
 
    value = ZOOM_package_option_get (package,
                                        RVAL2CSTR (key));

    return zoom_option_value_to_ruby_value (value);
}

/*
 * call-seq:
 * 	send(type)
 *
 * type:  the actual extended service package type to be sent, as a string.
 *
 * Sends the package.
 * 
 * Returns: self.
 */
static VALUE
rbz_package_send(VALUE self, VALUE type)
{
    ZOOM_package package;
	const char *typeChar;

    package = rbz_package_get (self);

    typeChar = StringValuePtr(type);
    ZOOM_package_send(package, typeChar);
  
    return self;
}



/* Interface to a subset of the Z39.50 extended services.
*/
void
Init_zoom_package (VALUE mZoom)
{
    VALUE c;
    
    c = rb_define_class_under (mZoom, "Package", rb_cObject); 

	/* Remove the default constructor to force initialization through Connection#package. */
    rb_undef_method (CLASS_OF (c), "new");

	/* Instance methods */
    rb_define_method (c, "set_option", rbz_package_set_option, 2);
    rb_define_method (c, "get_option", rbz_package_get_option, 1);
    rb_define_method (c, "send", rbz_package_send, 1);

	// Common Options
    define_zoom_option (c, "package-name");
	define_zoom_option (c, "user-id");
	define_zoom_option (c, "function");
	define_zoom_option (c, "waitAction");
	define_zoom_option (c, "targetReference");
	
	// Item Order, type must be set to itemorder in ZOOM_package_send.
	define_zoom_option (c, "contact-name");
	define_zoom_option (c, "contact-phone");
	define_zoom_option (c, "contact-email");
	define_zoom_option (c, "itemorder-item");
	
	// Record Update, type must be set to update in ZOOM_package_send.
	define_zoom_option (c, "action");
	define_zoom_option (c, "recordIdOpaque");
	define_zoom_option (c, "recordIdNumber");
	define_zoom_option (c, "record");
	define_zoom_option (c, "syntax");
	define_zoom_option (c, "databaseName");
	define_zoom_option (c, "correlationInfo.note");
	define_zoom_option (c, "correlationInfo.id");
	define_zoom_option (c, "elementSetName");
	
	// Database Create, type must be set to create in ZOOM_package_send.
	// Database Drop, type must be set to drop in ZOOM_package_send.
	    
    cZoomPackage = c;
}