Imported Upstream version 2.5.1
[debian/amanda] / common-src / tapelist.h
1 /*
2  * Amanda, The Advanced Maryland Automatic Network Disk Archiver
3  * Copyright (c) 1991-1998 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: tapelist.h,v 1.2 2006/05/25 01:47:12 johnfranks Exp $
28  *
29  */
30
31 #ifndef TAPELIST_H
32 #define TAPELIST_H
33
34 #include "amanda.h"
35
36 /* XXX This looks like a lot of other things, apart from the string
37  * marshalling and unmarshalling.  Things like the EXTRACT_LIST in amrecover's
38  * innards are functionally similar, so there's probably a lot of opportunity
39  * to pare down extraneous code here by mushing things like that in.  Rainy
40  * day project, perhaps.
41  */
42
43 typedef struct tapelist_s {
44     struct tapelist_s *next;
45     char *label;
46     int isafile; /* set to 1 and make *label the path to the file */
47     off_t *files;
48     int numfiles;
49 } tapelist_t;
50
51 int num_entries(tapelist_t *tapelist);
52 tapelist_t *append_to_tapelist(tapelist_t *tapelist, char *label,
53                                         off_t file, int isafile);
54 char *marshal_tapelist(tapelist_t *tapelist, int escape);
55 tapelist_t *unmarshal_tapelist_str(char *tapelist_str);
56 char *escape_label(char *label);
57 char *unescape_label(char *label);
58 void free_tapelist(tapelist_t *tapelist);
59 void dump_tapelist(tapelist_t *);
60  
61 #endif /* !TAPELIST_H */