summaryrefslogtreecommitdiffstats
path: root/src/opk.h
blob: 049953fb83ea60b0f6e92c8c2fcea0e8b832ab4c (plain)
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
/*
 * Copyright (C) 2023  Patrick McDermott
 *
 * This file is part of opkg-opkg.
 *
 * opkg-opkg 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 3 of the License, or
 * (at your option) any later version.
 *
 * opkg-opkg 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 opkg-opkg.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef OPKG_OPK_OPK_H_
#define OPKG_OPK_OPK_H_

#include "ustar.h"

struct opkg_opk_opk;

/*
 * Allocates a package structure.  Free with opkg_opk_opk_free().
 * Returns:
 * - Allocated package structure on success.  Free with opkg_opk_opk_free().
 * - NULL on memory exhaustion.
 */
struct opkg_opk_opk *
opkg_opk_opk_init(void);

/*
 * Adds a name to a list of control files to print when opkg_opk_opk_read() is
 * called.
 * Parameters:
 * - opk:  Package structure.
 * - name: Name of control file to print.
 * Returns:
 * - OPKG_OPK_OK if the name was added to the list.
 * - OPKG_OPK_ERROR on memory exhaustion.
 */
int
opkg_opk_opk_print_control(struct opkg_opk_opk *opk, const char *name);

/*
 * Adds a name to a list of data files to print when opkg_opk_opk_read() is
 * called.
 * Parameters:
 * - opk:  Package structure.
 * - name: Name of data file to print.
 * Returns:
 * - OPKG_OPK_OK if the name was added to the list.
 * - OPKG_OPK_ERROR on memory exhaustion.
 */
int
opkg_opk_opk_print_data(struct opkg_opk_opk *opk, const char *name);

/*
 * Lists control files when opkg_opk_opk_read() is called.
 * Parameters:
 * - opk: Package structure.
 * Returns:
 * - OPKG_OPK_OK.
 */
int
opkg_opk_opk_list_control(struct opkg_opk_opk *opk);

/*
 * Lists data files when opkg_opk_opk_read() is called.
 * Parameters:
 * - opk: Package structure.
 * Returns:
 * - OPKG_OPK_OK.
 */
int
opkg_opk_opk_list_data(struct opkg_opk_opk *opk);

/*
 * Sets the directory into which to extract control files.  The directory (but
 * not its ancestors) will be created if it doesn't exist.
 * Parameters:
 * - opk: Package structure.
 * - dir: Directory.
 * Returns:
 * - OPKG_OPK_OK.
 */
int
opkg_opk_opk_control_dir(struct opkg_opk_opk *opk, const char *dir);

/*
 * Performs the configured read actions.
 * Parameters:
 * - file_name: Package's file name.
 */
int
opkg_opk_opk_read(struct opkg_opk_opk *opk, const char *file_name);

/*
 * Frees a package structure.
 * Parameters:
 * - opk: Package structure.
 */
void
opkg_opk_opk_free(struct opkg_opk_opk *opk);

#endif  /* OPKG_OPK_OPK_H_ */