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.6 2007-05-06 20:12:20 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;
45 /** \brief returns standard OID database
46 \retval OID database handle
49 yaz_oid_db_t yaz_oid_std(void);
51 /** \brief maps named OID string to raw OID by database lookup
52 \param oid_db OID database
53 \param oclass class of string (enum oid_class)
55 \returns raw OID or NULL if name is unknown (bad)
57 This function only maps known names in the database provided.
58 Use yaz_string_to_oid_nmem or yaz_string_to_oid_odr to map
59 any named OID in dot-notation (1.2.8).
62 const int *yaz_string_to_oid(yaz_oid_db_t oid_db,
63 int oclass, const char *name);
66 /** \brief creates NMEM malloc'ed OID from string
67 \param oid_db OID database
68 \param oclass class of string (enum oid_class)
70 \param nmem memory for returned OID
71 \returns raw OID or NULL if name is unknown (bad)
74 int *yaz_string_to_oid_nmem(yaz_oid_db_t oid_db,
75 int oclass, const char *name, NMEM nmem);
77 /** \brief creates ODR malloc'ed OID from string
78 \param oid_db OID database
79 \param oclass class of string (enum oid_class)
81 \param odr memory for returned OID
82 \returns raw OID or NULL if name is unknown (bad)
85 int *yaz_string_to_oid_odr(yaz_oid_db_t oid_db,
86 int oclass, const char *name, ODR odr);
88 /** \brief maps raw OID to string
89 \param oid_db OID database
91 \param oclass holds OID class if found (output parameter)
92 \returns OID name or NULL if not found in database
95 const char *yaz_oid_to_string(yaz_oid_db_t oid_db,
96 const int *oid, int *oclass);
99 /** \brief maps any OID to string (named or dot-notation)
101 \param oclass holds OID class if found (output parameter)
102 \param buf string buffer for result (must be of size OID_STR_MAX)
103 \returns OID string (named or dot notatition)
106 const char *yaz_oid_to_string_buf(const int *oid, int *oclass, char *buf);
108 /** \brief traverses OIDs in a database
109 \param oid_db OID database
110 \param func function to be called for each OID
111 \param client_data data to be passed to func (custom defined)
113 YAZ_EXPORT void yaz_oid_trav(yaz_oid_db_t oid_db,
114 void (*func)(const int *oid,
115 int oclass, const char *name,
119 /** \brief checks if OID refers to MARC transfer syntax
121 \retval 1 OID is a MARC type
122 \retval 0 OID is not a MARC type
125 int yaz_oid_is_iso2709(const int *oid);
127 /** \brief adds new OID entry to database
128 \param oid_db database
129 \param oclass OID class
130 \param name name of OID
131 \param new_oid OID value (raw OID)
133 \retval -1 OID name+oclass already exists
136 int yaz_oid_add(yaz_oid_db_t oid_db, int oclass, const char *name,
139 struct yaz_oid_entry {
147 #define Z3950_PREFIX 1, 2, 840, 10003
149 #include <yaz/oid_std.h>
155 * indent-tabs-mode: nil
157 * vim: shiftwidth=4 tabstop=8 expandtab