X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fodr.h;h=eb12dd4ad27e2ee2485c6c91cf23018eae6f56a4;hp=f4a0c26a7c6e272e8f568ce4b33a6c88d714cbe1;hb=f2891d8771cb23cc70d973c6785bec20e31f511e;hpb=ec1f815d5348cd21e393f76bc212c910c34bbc45 diff --git a/include/yaz/odr.h b/include/yaz/odr.h index f4a0c26..eb12dd4 100644 --- a/include/yaz/odr.h +++ b/include/yaz/odr.h @@ -1,29 +1,33 @@ -/* - * Copyright (c) 1995-2003, Index Data. - * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: - * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. - * - * 2. The name of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2010 Index Data. + * All rights reserved. + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * * Neither the name of Index Data nor the names of its contributors + * may be used to endorse or promote products derived from this + * software without specific prior written permission. * - * $Id: odr.h,v 1.11 2003-05-20 19:55:29 adam Exp $ + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY + * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY + * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND + * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** + * \file odr.h + * \brief Header for ODR (Open Data Representation) */ #ifndef ODR_H @@ -35,8 +39,15 @@ #include #include +/* for definition of Odr_oid */ +#include + YAZ_BEGIN_CDECL +typedef nmem_int_t Odr_int; +typedef nmem_bool_t Odr_bool; +#define ODR_INT_PRINTF NMEM_INT_PRINTF + #ifndef bool_t #define bool_t int #endif @@ -104,52 +115,31 @@ typedef struct odr_bitmask int top; } Odr_bitmask; -typedef int Odr_oid; /* terminate by -1 */ - -typedef struct odr_constack -{ - const unsigned char *base; /* starting point of data */ - int base_offset; - int len; /* length of data, if known, else -1 - (decoding only) */ - const unsigned char *lenb; /* where to encode length */ - int len_offset; - int lenlen; /* length of length-field */ -} odr_constack; - #define ODR_S_SET 0 #define ODR_S_CUR 1 #define ODR_S_END 2 -typedef struct odr +typedef struct odr *ODR; + +/** ODR handle and the public structs */ +struct odr { int direction; /* the direction of this stream */ - int error; /* current error state (0==OK) */ + int error; /* current error state (0==OK) */ - int can_grow; /* are we allowed to reallocate */ unsigned char *buf; /* memory handle */ - int size; /* current buffer size */ + int top; /* top of buffer (max pos when encoding) */ + int size; /* current buffer size (encoding+decoding) */ - int pos; /* current position */ - int top; /* top of buffer (max pos when decoding) */ + int pos; /* current position (encoding) */ const unsigned char *bp; /* position in buffer (decoding) */ - int t_class; /* implicit tagging (-1==default tag) */ - int t_tag; - - int enable_bias; /* force choice enable flag */ - int choice_bias; /* force choice */ - int lenlen; /* force length-of-lenght (odr_setlen()) */ - - FILE *print; /* output file for direction print */ - int indent; /* current indent level for printing */ - NMEM mem; /* memory handle for decoding (primarily) */ struct Odr_private *op; -} *ODR; +}; typedef int (*Odr_fun)(ODR, char **, int, const char *); @@ -185,19 +175,23 @@ extern char *odr_errlist[]; YAZ_EXPORT int odr_geterror(ODR o); YAZ_EXPORT int odr_geterrorx(ODR o, int *x); YAZ_EXPORT void odr_seterror(ODR o, int errorno, int errorid); -YAZ_EXPORT void odr_setaddinfo(ODR o, const char *addinfo); -YAZ_EXPORT char *odr_getaddinfo(ODR o); -YAZ_EXPORT void odr_perror(ODR o, char *message); +YAZ_EXPORT void odr_setelement(ODR o, const char *addinfo); +YAZ_EXPORT const char *odr_getelement(ODR o); +YAZ_EXPORT void odr_perror(ODR o, const char *message); YAZ_EXPORT void odr_setprint(ODR o, FILE *file); YAZ_EXPORT ODR odr_createmem(int direction); YAZ_EXPORT void odr_reset(ODR o); YAZ_EXPORT void odr_destroy(ODR o); YAZ_EXPORT void odr_setbuf(ODR o, char *buf, int len, int can_grow); YAZ_EXPORT char *odr_getbuf(ODR o, int *len, int *size); -YAZ_EXPORT void *odr_malloc(ODR o, int size); +YAZ_EXPORT void *odr_malloc(ODR o, size_t size); YAZ_EXPORT char *odr_strdup(ODR o, const char *str); YAZ_EXPORT char *odr_strdupn(ODR o, const char *str, size_t n); -YAZ_EXPORT int *odr_intdup(ODR o, int v); +YAZ_EXPORT char *odr_strdup_null(ODR o, const char *str); +YAZ_EXPORT Odr_int *odr_intdup(ODR o, Odr_int v); +YAZ_EXPORT Odr_bool *odr_booldup(ODR o, Odr_bool v); +YAZ_EXPORT Odr_oct *odr_create_Odr_oct(ODR o, const unsigned char *buf, + int sz); YAZ_EXPORT NMEM odr_extract_mem(ODR o); YAZ_EXPORT Odr_null *odr_nullval(void); #define odr_release_mem(m) nmem_destroy(m) @@ -230,28 +224,27 @@ YAZ_EXPORT Odr_null *odr_nullval(void); #define odr_offset(o) ((o)->bp - (o)->buf) #define odr_ok(o) (!(o)->error) #define odr_getmem(o) ((o)->mem) -#define odr_setmem(o, v) ((o)->mem = (v)) #define ODR_MAXNAME 256 YAZ_EXPORT int ber_boolean(ODR o, int *val); YAZ_EXPORT int ber_tag(ODR o, void *p, int zclass, int tag, - int *constructed, int opt, const char *name); + int *constructed, int opt, const char *name); YAZ_EXPORT int ber_enctag(ODR o, int zclass, int tag, int constructed); YAZ_EXPORT int ber_dectag(const unsigned char *buf, int *zclass, - int *tag, int *constructed, int max); -YAZ_EXPORT int odr_bool(ODR o, int **p, int opt, const char *name); -YAZ_EXPORT int odr_integer(ODR o, int **p, int opt, const char *name); -YAZ_EXPORT int odr_enum(ODR o, int **p, int opt, const char *name); + int *tag, int *constructed, int max); +YAZ_EXPORT int odr_bool(ODR o, Odr_bool **p, int opt, const char *name); +YAZ_EXPORT int odr_integer(ODR o, Odr_int **p, int opt, const char *name); +YAZ_EXPORT int odr_enum(ODR o, Odr_int **p, int opt, const char *name); YAZ_EXPORT int odr_implicit_settag(ODR o, int zclass, int tag); YAZ_EXPORT int ber_enclen(ODR o, int len, int lenlen, int exact); YAZ_EXPORT int ber_declen(const unsigned char *buf, int *len, int max); YAZ_EXPORT void odr_prname(ODR o, const char *name); YAZ_EXPORT int ber_null(ODR o); YAZ_EXPORT int odr_null(ODR o, Odr_null **p, int opt, const char *name); -YAZ_EXPORT int ber_integer(ODR o, int *val); +YAZ_EXPORT int ber_integer(ODR o, Odr_int *val); YAZ_EXPORT int odr_constructed_begin(ODR o, void *p, int zclass, int tag, - const char *name); + const char *name); YAZ_EXPORT int odr_constructed_end(ODR o); YAZ_EXPORT int odr_sequence_begin(ODR o, void *p, int size, const char *name); YAZ_EXPORT int odr_set_begin(ODR o, void *p, int size, const char *name); @@ -262,33 +255,41 @@ YAZ_EXPORT int odr_octetstring(ODR o, Odr_oct **p, int opt, const char *name); YAZ_EXPORT int odp_more_chunks(ODR o, const unsigned char *base, int len); YAZ_EXPORT int odr_constructed_more(ODR o); YAZ_EXPORT int odr_bitstring(ODR o, Odr_bitmask **p, int opt, - const char *name); + const char *name); YAZ_EXPORT int ber_bitstring(ODR o, Odr_bitmask *p, int cons); YAZ_EXPORT int odr_generalstring(ODR o, char **p, int opt, const char *name); -YAZ_EXPORT int ber_oidc(ODR o, Odr_oid *p); +YAZ_EXPORT int ber_oidc(ODR o, Odr_oid *p, int max_oid_size); YAZ_EXPORT int odr_oid(ODR o, Odr_oid **p, int opt, const char *name); YAZ_EXPORT int odr_choice(ODR o, Odr_arm arm[], void *p, void *whichp, - const char *name); + const char *name); YAZ_EXPORT int odr_cstring(ODR o, char **p, int opt, const char *name); YAZ_EXPORT int odr_iconv_string(ODR o, char **p, int opt, const char *name); YAZ_EXPORT int odr_sequence_of(ODR o, Odr_fun type, void *p, int *num, - const char *name); + const char *name); YAZ_EXPORT int odr_set_of(ODR o, Odr_fun type, void *p, int *num, - const char *name); + const char *name); YAZ_EXPORT int odr_any(ODR o, Odr_any **p, int opt, const char *name); + YAZ_EXPORT int ber_any(ODR o, Odr_any **p); +/** \brief determine whether a buffer is a complete BER buffer + \param buf BER buffer + \param len length of buffer + \retval 0 package is incomplete + \retval >0 package is complete and length is return value +*/ YAZ_EXPORT int completeBER(const unsigned char *buf, int len); + YAZ_EXPORT void odr_begin(ODR o); YAZ_EXPORT void odr_end(ODR o); -YAZ_EXPORT Odr_oid *odr_oiddup(ODR odr, Odr_oid *o); -YAZ_EXPORT Odr_oid *odr_oiddup_nmem(NMEM nmem, Odr_oid *o); +YAZ_EXPORT Odr_oid *odr_oiddup(ODR odr, const Odr_oid *o); +YAZ_EXPORT Odr_oid *odr_oiddup_nmem(NMEM nmem, const Odr_oid *o); YAZ_EXPORT int odr_grow_block(ODR b, int min_bytes); YAZ_EXPORT int odr_write(ODR o, unsigned char *buf, int bytes); YAZ_EXPORT int odr_seek(ODR o, int whence, int offset); YAZ_EXPORT int odr_dumpBER(FILE *f, const char *buf, int len); YAZ_EXPORT void odr_choice_bias(ODR o, int what); YAZ_EXPORT void odr_choice_enable_bias(ODR o, int mode); -YAZ_EXPORT int odr_total(ODR o); +YAZ_EXPORT size_t odr_total(ODR o); YAZ_EXPORT char *odr_errmsg(int n); YAZ_EXPORT Odr_oid *odr_getoidbystr(ODR o, const char *str); YAZ_EXPORT Odr_oid *odr_getoidbystr_nmem(NMEM o, const char *str); @@ -297,11 +298,12 @@ YAZ_EXPORT int odr_initmember(ODR o, void *p, int size); YAZ_EXPORT int odr_peektag(ODR o, int *zclass, int *tag, int *cons); YAZ_EXPORT void odr_setlenlen(ODR o, int len); YAZ_EXPORT int odr_missing(ODR o, int opt, const char *name); +YAZ_EXPORT char *odr_prepend(ODR o, const char *prefix, const char *old); typedef struct Odr_external { Odr_oid *direct_reference; /* OPTIONAL */ - int *indirect_reference; /* OPTIONAL */ + Odr_int *indirect_reference; /* OPTIONAL */ char *descriptor; /* OPTIONAL */ int which; #define ODR_EXTERNAL_single 0 @@ -309,25 +311,50 @@ typedef struct Odr_external #define ODR_EXTERNAL_arbitrary 2 union { - Odr_any *single_ASN1_type; - Odr_oct *octet_aligned; - Odr_bitmask *arbitrary; /* we aren't really equipped for this*/ + Odr_any *single_ASN1_type; + Odr_oct *octet_aligned; + Odr_bitmask *arbitrary; /* we aren't really equipped for this*/ } u; } Odr_external; YAZ_EXPORT int odr_external(ODR o, Odr_external **p, int opt, - const char *name); + const char *name); YAZ_EXPORT int odr_visiblestring(ODR o, char **p, int opt, - const char *name); + const char *name); YAZ_EXPORT int odr_graphicstring(ODR o, char **p, int opt, - const char *name); + const char *name); YAZ_EXPORT int odr_generalizedtime(ODR o, char **p, int opt, - const char *name); + const char *name); YAZ_EXPORT int odr_set_charset(ODR o, const char *to, const char *from); +YAZ_EXPORT void odr_set_stream(ODR o, void *handle, + void (*stream_write)(ODR o, + void *handle, + int type, + const char *buf, + int len), + void (*stream_close)(void *handle)); + +YAZ_EXPORT void odr_printf(ODR o, const char *fmt, ...); + +YAZ_EXPORT const char **odr_get_element_path(ODR o); + +YAZ_EXPORT Odr_int odr_atoi(const char *s); + +YAZ_EXPORT Odr_int odr_strtol(const char *nptr, char **endptr, int base); + YAZ_END_CDECL #include #endif +/* + * Local variables: + * c-basic-offset: 4 + * c-file-style: "Stroustrup" + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +