include/yaz/oid_util.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2013 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   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.
  15  *
  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.
  26  */
  27
  28 /**
  29  * \file oid_util.h
  30  * \brief Header for OID basic functions
  31  */
  32 #ifndef OID_UTIL_H
  33 #define OID_UTIL_H
  34
  35 #include <yaz/yconfig.h>
  36
  37 YAZ_BEGIN_CDECL
  38
  39 #define OID_SIZE 20
  40 #define OID_STR_MAX 256
  41
  42 typedef short Odr_oid;   /* terminate by -1 */
  43
  44 typedef enum oid_proto
  45 {
  46     PROTO_NOP=0,
  47     PROTO_Z3950,
  48     PROTO_SR,
  49     PROTO_HTTP
  50 } oid_proto;
  51
  52
  53 /** \brief copies OID
  54     \param t destination OID
  55     \param s source OID
  56 */
  57 YAZ_EXPORT void oid_oidcpy(Odr_oid *t, const Odr_oid *s);
  58
  59 /** \brief appends to OID
  60     \param t destination OID
  61     \param s source OID
  62 */
  63 YAZ_EXPORT void oid_oidcat(Odr_oid *t, const Odr_oid *s);
  64
  65
  66 /** \brief compares OIDs
  67     \param o1 first OID
  68     \param o2 second OID
  69     \retval 0 equal
  70     \retval >0 o1 greater than o2
  71     \retval <0 o1 less than o2
  72 */
  73 YAZ_EXPORT int oid_oidcmp(const Odr_oid *o1, const Odr_oid *o2);
  74
  75
  76 /** \brief returns length of OIDs
  77     \param o OID
  78     \returns length as number of Odr_oids
  79 */
  80 YAZ_EXPORT int oid_oidlen(const Odr_oid *o);
  81
  82 /** \brief converts OID to string (dot notation)
  83     \param oid OID
  84     \param oidbuf resulting buffer which should be at least of size OID_STR_MAX
  85     \returns result (same as oidbuf)
  86 */
  87 YAZ_EXPORT char *oid_oid_to_dotstring(const Odr_oid *oid, char *oidbuf);
  88
  89
  90 /** \brief converts dot string to OID
  91     \param name dot string OID, e.g. "1.2.840.10003.2.1"
  92     \param oid resulting OID buffer which should be at least of size OID_SIZE
  93     \retval 0 OK
  94     \retval -1 failure
  95 */
  96 YAZ_EXPORT int oid_dotstring_to_oid(const char *name, Odr_oid *oid);
  97
  98 YAZ_END_CDECL
  99
 100 #endif
 101 /*
 102  * Local variables:
 103  * c-basic-offset: 4
 104  * c-file-style: "Stroustrup"
 105  * indent-tabs-mode: nil
 106  * End:
 107  * vim: shiftwidth=4 tabstop=8 expandtab
 108  */
 109