Imported Upstream version 3.1.0
[debian/amanda] / common-src / timestamp.h
1 /*
2  * Amanda, The Advanced Maryland Automatic Network Disk Archiver
3  * Copyright (c) 1991-1999 University of Maryland at College Park
4  * All Rights Reserved.
5  *
6  * Permission to use, copy, modify, distribute, and sell this software and its
7  * documentation for any purpose is hereby granted without fee, provided that
8  * the above copyright notice appear in all copies and that both that
9  * copyright notice and this permission notice appear in supporting
10  * documentation, and that the name of U.M. not be used in advertising or
11  * publicity pertaining to distribution of the software without specific,
12  * written prior permission.  U.M. makes no representations about the
13  * suitability of this software for any purpose.  It is provided "as is"
14  * without express or implied warranty.
15  *
16  * U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
18  * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
19  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
20  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
21  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22  *
23  * Authors: the Amanda Development Team.  Its members are listed in a
24  * file named AUTHORS, in the root directory of this distribution.
25  */
26 /*
27  * $Id$
28  *
29  * Date and time utility functions
30  */
31
32 #ifndef TIMESTAMP_H
33 #define TIMESTAMP_H
34
35 #include "amanda.h"
36
37 /* These functions do the opposite; they formats a time_t for
38    network or media storage. The return value is allocated with
39    malloc(). If time == 0, then these functions will use the current
40    time. */
41 char * get_timestamp_from_time(time_t time);
42 char * get_datestamp_from_time(time_t time);
43 char * get_proper_stamp_from_time(time_t time);
44 time_t get_time_from_timestamp(char *timestamp);
45
46 typedef enum {
47     TIME_STATE_REPLACE,
48     TIME_STATE_UNDEF,
49     TIME_STATE_SET
50 } time_state_t;
51
52 /* Returns the state of a timestamp. */
53 time_state_t get_timestamp_state(char * timestamp);
54
55 /* Returns a "X" timestamp. */
56 char * get_undef_timestamp(void);
57
58 #endif /* TIMESTAMP_H */
59