--- /dev/null
+/*
+ * Copyright (c) 1995-2007, 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:
+ *
+ * * 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.
+ *
+ * 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.
+ */
+/* $Id: oid_db.h,v 1.1 2007-04-12 13:52:57 adam Exp $ */
+
+/**
+ * \file oid_db.h
+ * \brief Header for OID database
+ */
+#ifndef OID_DB_H
+#define OID_DB_H
+
+#include <yaz/yconfig.h>
+#include <yaz/oid_util.h>
+#include <yaz/odr.h>
+
+YAZ_BEGIN_CDECL
+
+/** \brief OID database */
+typedef struct yaz_oid_entry *yaz_oid_db_t;
+
+/** \brief returns standard OID database
+ \retval OID database handle
+*/
+YAZ_EXPORT
+yaz_oid_db_t yaz_oid_std(void);
+
+/** \brief maps named OID string to raw OID by database lookup
+ \param oid_db OID database
+ \param oclass class of string (enum oid_class)
+ \param name OID name
+ \returns raw OID or NULL if name is unknown (bad)
+
+ This function only maps known names in the database provided.
+ Use yaz_string_to_oid_nmem or yaz_string_to_oid_odr to map
+ any named OID in dot-notation (1.2.8).
+*/
+YAZ_EXPORT
+const int *yaz_string_to_oid(yaz_oid_db_t oid_db,
+ int oclass, const char *name);
+
+
+/** \brief creates NMEM malloc'ed OID from string
+ \param oid_db OID database
+ \param oclass class of string (enum oid_class)
+ \param name OID name
+ \param nmem memory for returned OID
+ \returns raw OID or NULL if name is unknown (bad)
+*/
+YAZ_EXPORT
+int *yaz_string_to_oid_nmem(yaz_oid_db_t oid_db,
+ int oclass, const char *name, NMEM nmem);
+
+/** \brief creates ODR malloc'ed OID from string
+ \param oid_db OID database
+ \param oclass class of string (enum oid_class)
+ \param name OID name
+ \param odr memory for returned OID
+ \returns raw OID or NULL if name is unknown (bad)
+*/
+YAZ_EXPORT
+int *yaz_string_to_oid_odr(yaz_oid_db_t oid_db,
+ int oclass, const char *name, ODR odr);
+
+/** \brief maps raw OID to string
+ \param oid_db OID database
+ \param oid raw OID
+ \param oclass holds OID class if found (output parameter)
+ \returns OID name or NULL if not found in database
+*/
+YAZ_EXPORT
+const char *yaz_oid_to_string(yaz_oid_db_t oid_db,
+ const int *oid, int *oclass);
+
+
+/** \brief maps any OID to string (named or dot-notation)
+ \param oid raw OID
+ \param oclass holds OID class if found (output parameter)
+ \param buf string buffer for result (must be of size OID_STR_MAX)
+ \returns OID string (named or dot notatition)
+*/
+YAZ_EXPORT
+const char *yaz_oid_to_string_buf(const int *oid, int *oclass, char *buf);
+
+/** \brief traverses OIDs in a database
+ \param oid_db OID database
+ \param func function to be called for each OID
+ \param client_data data to be passed to func (custom defined)
+*/
+YAZ_EXPORT void yaz_oid_trav(yaz_oid_db_t oid_db,
+ void (*func)(const int *oid,
+ int oclass, const char *name,
+ void *client_data),
+ void *client_data);
+
+/** \brief checks if OID refers to MARC transfer syntax
+ \param oid raw OID
+ \retval 1 OID is a MARC type
+ \retval 0 OID is not a MARC type
+*/
+YAZ_EXPORT
+int yaz_oid_is_iso2709(const int *oid);
+
+#define OID_STR_BIB1 "Bib-1"
+#define OID_STR_DIAG1 "Diag-1"
+#define OID_STR_USMARC "USmarc"
+#define OID_STR_XML "XML"
+#define OID_STR_SOIF "SOIF"
+#define OID_STR_APPLICATION_XML "application-XML"
+#define OID_STR_HTML "html"
+#define OID_STR_GRS1 "GRS-1"
+#define OID_STR_POSTSCRIPT "postscript"
+#define OID_STR_SUTRS "SUTRS"
+#define OID_STR_OPAC "OPAC"
+#define OID_STR_EXPLAIN "Explain"
+#define OID_STR_SUMMARY "Summary"
+#define OID_STR_EXTENDED "Extended"
+#define OID_STR_COOKIE "Cookie"
+#define OID_STR_PROXY "Proxy"
+#define OID_STR_CLIENT_IP "Client-IP"
+#define OID_STR_ILL_1 "ISOILL-1"
+#define OID_STR_ADMIN "Admin"
+#define OID_STR_XMLES "XML-ES"
+#define OID_STR_EXT_UPDATE "DB. Update"
+#define OID_STR_ITEMORDER "Item order"
+#define OID_STR_USERINFO_1 "UserInfo-1"
+#define OID_STR_ID_CHARSET "ID-Charset"
+#define OID_STR_CHARNEG_3 "CharSetandLanguageNegotiation-3"
+#define OID_STR_CHARNEG_4 "CharSetandLanguageNegotiation-4"
+
+YAZ_END_CDECL
+
+#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+
projects / yaz-moved-to-github.git / blobdiff