File: cpl_version.c

package info (click to toggle)
cpl 6.1.1-2
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 18,764 kB
  • sloc: ansic: 111,368; sh: 14,549; makefile: 626
file content (179 lines) | stat: -rw-r--r-- 3,833 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
/* $Id: cpl_version.c,v 1.4 2006/11/03 09:28:13 rpalsa Exp $
 *
 * This file is part of the ESO Common Pipeline Library
 * Copyright (C) 2001-2006 European Southern Observatory
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

/*
 * $Author: rpalsa $
 * $Date: 2006/11/03 09:28:13 $
 * $Revision: 1.4 $
 * $Name: cpl-6_1_1 $
 */

#ifdef HAVE_CONFIG_H
#  include <config.h>
#endif

#include "cpl_version.h"


/**
 * @defgroup cpl_version Library Version Information
 *
 * This module provides functions to access the library's version
 * information.
 *
 * The library version applies to all component libraries of the Common
 * pipeline library, and changes if any of the component libraries changes.
 *
 * The library version is a version code made up of three components, the
 * major, minor and micro version number, and is usually represented by a
 * string of the form "major.minor.micro".
 *
 * @par Synopsis:
 * @code
 *   #include <cpl_version.h>
 * @endcode
 */

/**@{*/


/**
 * @brief
 *   Get the library's major version number.
 *
 * @return
 *   The function returns the library's major version number.
 *
 * The function returns the major version number of the library.
 */

unsigned int
cpl_version_get_major(void)
{
    return CPL_MAJOR_VERSION;
}


/**
 * @brief
 *   Get the library's minor version number.
 *
 * @return
 *   The function returns the library's minor version number.
 *
 * The function returns the minor version number of the library.
 */

unsigned int
cpl_version_get_minor(void)
{
    return CPL_MINOR_VERSION;
}


/**
 * @brief
 *   Get the library's micro version number.
 *
 * @return
 *   The function returns the library's micro version number.
 *
 * The function returns the micro version number of the library.
 */

unsigned int
cpl_version_get_micro(void)
{
    return CPL_MICRO_VERSION;
}


/**
 * @brief
 *   Get the library's interface age.
 *
 * @return
 *   The function returns the library's interface age.
 *
 * The function returns the interface age of the library.
 */

unsigned int
cpl_version_get_interface_age(void)
{
    return CPL_INTERFACE_AGE;
}


/**
 * @brief
 *   Get the library's binary age.
 *
 * @return
 *   The function returns the library's binary age.
 *
 * The function returns the binary age of the library.
 */

unsigned int
cpl_version_get_binary_age(void)
{
    return CPL_BINARY_AGE;
}


/**
 * @brief
 *   Get the library's version string.
 *
 * @return
 *   The function returns the library's version string.
 *
 * The function returns the package version of the library as a string. The
 * returned version string is composed of the major, minor and, possibly, the
 * micro version of the library separated by dots. The micro version may
 * not be there if it is @c 0.
 */

const char *
cpl_version_get_version(void)
{
    return PACKAGE_VERSION;
}


/**
 * @brief
 *   Get the library's binary version number.
 *
 * @return
 *   The function returns the library's version number.
 *
 * The function returns the version number of the library encoded as a single
 * integer number.
 */

unsigned int
cpl_version_get_binary_version(void)
{
    return CPL_BINARY_VERSION;
}

/**@}*/