2 * Copyright (c) 1995-2007, Index Data
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 /* $Id: oid_db.h,v 1.10 2007-11-30 11:42:04 adam Exp $ */
31 * \brief Header for OID database
36 #include <yaz/yconfig.h>
37 #include <yaz/oid_util.h>
42 /** \brief OID database */
43 typedef struct yaz_oid_db *yaz_oid_db_t;
46 typedef enum oid_class
68 /** \brief returns standard OID database
69 \retval OID database handle
72 yaz_oid_db_t yaz_oid_std(void);
74 /** \brief maps named OID string to raw OID by database lookup
75 \param oid_db OID database
76 \param oclass class of string (enum oid_class)
78 \returns raw OID or NULL if name is unknown (bad)
80 This function only maps known names in the database provided.
81 Use yaz_string_to_oid_nmem or yaz_string_to_oid_odr to map
82 any named OID in dot-notation (1.2.8).
85 const Odr_oid *yaz_string_to_oid(yaz_oid_db_t oid_db,
86 oid_class oclass, const char *name);
89 /** \brief creates NMEM malloc'ed OID from string
90 \param oid_db OID database
91 \param oclass class of string (enum oid_class)
93 \param nmem memory for returned OID
94 \returns raw OID or NULL if name is unknown (bad)
97 Odr_oid *yaz_string_to_oid_nmem(yaz_oid_db_t oid_db,
98 oid_class oclass, const char *name, NMEM nmem);
100 /** \brief creates ODR malloc'ed OID from string
101 \param oid_db OID database
102 \param oclass class of string (enum oid_class)
104 \param odr memory for returned OID
105 \returns raw OID or NULL if name is unknown (bad)
108 Odr_oid *yaz_string_to_oid_odr(yaz_oid_db_t oid_db,
109 oid_class oclass, const char *name, ODR odr);
111 /** \brief maps raw OID to string
112 \param oid_db OID database
114 \param oclass holds OID class if found (output parameter)
115 \returns OID name or NULL if not found in database
118 const char *yaz_oid_to_string(yaz_oid_db_t oid_db,
119 const Odr_oid *oid, oid_class *oclass);
122 /** \brief maps any OID to string (named or dot-notation)
124 \param oclass holds OID class if found (output parameter)
125 \param buf string buffer for result (must be of size OID_STR_MAX)
126 \returns OID string (named or dot notatition)
129 const char *yaz_oid_to_string_buf(const Odr_oid *oid,
130 oid_class *oclass, char *buf);
133 /** \brief maps named from standard database to dot notation
134 \param oclass class of string (enum oid_class)
135 \param name named OID
136 \param oid_buf buffer for result (must be of size OID_STR_MAX)
137 \returns OID string or NULL if name is not registered in database
140 char *oid_name_to_dotstring(oid_class oclass, const char *name, char *oid_buf);
143 /** \brief traverses OIDs in a database
144 \param oid_db OID database
145 \param func function to be called for each OID
146 \param client_data data to be passed to func (custom defined)
148 YAZ_EXPORT void yaz_oid_trav(yaz_oid_db_t oid_db,
149 void (*func)(const Odr_oid *oid,
150 oid_class oclass, const char *name,
154 /** \brief checks if OID refers to MARC transfer syntax
156 \retval 1 OID is a MARC type
157 \retval 0 OID is not a MARC type
160 int yaz_oid_is_iso2709(const Odr_oid *oid);
162 /** \brief adds new OID entry to database
163 \param oid_db database
164 \param oclass OID class
165 \param name name of OID
166 \param new_oid OID value (raw OID)
168 \retval -1 OID name+oclass already exists
171 int yaz_oid_add(yaz_oid_db_t oid_db, oid_class oclass, const char *name,
172 const Odr_oid *new_oid);
175 /** \brief creates empty OID database
179 yaz_oid_db_t yaz_oid_db_new(void);
181 /** \brief destroys OID database
182 \param oid_db database
185 void yaz_oid_db_destroy(yaz_oid_db_t oid_db);
187 struct yaz_oid_entry {
188 enum oid_class oclass;
195 #define Z3950_PREFIX 1, 2, 840, 10003
197 #include <yaz/oid_std.h>
203 * indent-tabs-mode: nil
205 * vim: shiftwidth=4 tabstop=8 expandtab