For OIDs use Odr_oid type everywhere, i.e. do not assume Odr_oid=int.
[yaz-moved-to-github.git] / include / yaz / oid_util.h
1 /*
2  * Copyright (c) 1995-2007, 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 /* $Id: oid_util.h,v 1.4 2007-05-08 08:22:35 adam Exp $ */
28
29 /**
30  * \file oid_util.h
31  * \brief Header for OID basic functions
32  */
33 #ifndef OID_UTIL_H
34 #define OID_UTIL_H
35
36 #include <yaz/yconfig.h>
37
38 YAZ_BEGIN_CDECL
39
40 #define OID_SIZE 20
41 #define OID_STR_MAX 256
42
43 typedef short Odr_oid;   /* terminate by -1 */
44
45 typedef enum oid_proto
46 {
47     PROTO_NOP=0,
48     PROTO_Z3950,
49     PROTO_SR,
50     PROTO_GENERAL,
51     PROTO_WAIS,
52     PROTO_HTTP
53 } oid_proto;
54
55 YAZ_EXPORT void oid_oidcpy(Odr_oid *t, const Odr_oid *s);
56 YAZ_EXPORT void oid_oidcat(Odr_oid *t, const Odr_oid *s);
57 YAZ_EXPORT int oid_oidcmp(const Odr_oid *o1, const Odr_oid *o2);
58 YAZ_EXPORT int oid_oidlen(const Odr_oid *o);
59 YAZ_EXPORT char *oid_oid_to_dotstring(const Odr_oid *oid, char *oidbuf);
60 YAZ_EXPORT int oid_dotstring_to_oid(const char *name, Odr_oid *oid);
61
62 YAZ_END_CDECL
63
64 #endif
65 /*
66  * Local variables:
67  * c-basic-offset: 4
68  * indent-tabs-mode: nil
69  * End:
70  * vim: shiftwidth=4 tabstop=8 expandtab
71  */
72