dpkg (1.18.25) stretch; urgency=medium
[dpkg] / lib / dpkg / atomic-file.h
CommitLineData
1479465f
GJ
1/*
2 * libdpkg - Debian packaging suite library routines
3 * atomic-file.h - atomic file helper functions
4 *
5 * Copyright © 2011-2014 Guillem Jover <guillem@debian.org>
6 *
7 * This is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
19 */
20
21#ifndef LIBDPKG_ATOMIC_FILE_H
22#define LIBDPKG_ATOMIC_FILE_H
23
24#include <stdio.h>
25
26#include <dpkg/macros.h>
27
28DPKG_BEGIN_DECLS
29
30/**
31 * @defgroup atomic-file Atomic file operations
32 * @ingroup dpkg-internal
33 * @{
34 */
35
36enum atomic_file_flags {
37 ATOMIC_FILE_BACKUP = DPKG_BIT(0),
38};
39
40struct atomic_file {
41 enum atomic_file_flags flags;
42 char *name;
43 char *name_new;
44 FILE *fp;
45};
46
47struct atomic_file *
48atomic_file_new(const char *filename, enum atomic_file_flags flags);
49void atomic_file_open(struct atomic_file *file);
50void atomic_file_sync(struct atomic_file *file);
51void atomic_file_close(struct atomic_file *file);
52void atomic_file_commit(struct atomic_file *file);
53void atomic_file_remove(struct atomic_file *file);
54void atomic_file_free(struct atomic_file *file);
55
56/** @} */
57
58DPKG_END_DECLS
59
60#endif /* LIBDPKG_ATOMIC_FILE_H */