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