f90ca9ab0a95a506162ff51e658bca8b86801b57
[yaz-moved-to-github.git] / include / yaz / yaz-version.h.in
1 /* This file is part of the YAZ toolkit.
2  * Copyright (C) 1995-2008 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  * \file yaz-version.h
29  * \brief Defines YAZ version.
30  */
31 #ifndef YAZ_VERSION
32
33 #include <yaz/yconfig.h>
34
35 #define YAZ_VERSION "@VERSION@"
36 #define YAZ_VERSIONL 0x@YAZ_VERSION_HEX@
37
38 #define YAZ_FILEVERSION @WIN_FILEVERSION@
39
40 #define YAZ_VERSION_SHA1 "@VERSION_SHA1@"
41
42 #define YAZ_DATE 1
43
44
45 #ifdef WIN32
46 #ifdef NDEBUG
47 #define YAZ_OS "WIN32 Release"
48 #else
49 #define YAZ_OS "WIN32 Debug"
50 #endif
51 #endif
52
53 YAZ_BEGIN_CDECL
54
55 /** \brief returns YAZ version
56     \param version_str holds version upon completion (YAZ_VERSION)
57     \param sha1_str holds SHA1 (Git) upon completion (YAZ_VERSION_SHA1)
58     \returns long version value (YAZ_VERSIONL)
59
60     The version_str may be NULL in which case version is not returned.
61     When not-null, version_str, should point to a buffer of at least 20
62     charcters in size (including "\0").
63     The sha1_str may be NULL in which case the SHA1 is not returnd.
64     When not-null, sha1_str whould point to a buffer of at least 41 characters
65     in size (including "\0"). 
66   */
67 YAZ_EXPORT unsigned long yaz_version(char *version_str, char *sha1_str);
68
69 YAZ_END_CDECL
70
71 #endif
72
73 /*
74  * Local variables:
75  * c-basic-offset: 4
76  * indent-tabs-mode: nil
77  * End:
78  * vim: shiftwidth=4 tabstop=8 expandtab
79  */
80