1 /* Copyright (c) 2008 The NetBSD Foundation, Inc.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
14 * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
15 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
16 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
18 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
20 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
22 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
23 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
24 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
26 #if !defined(ATF_C_DETAIL_FS_H)
27 #define ATF_C_DETAIL_FS_H
29 #include <sys/types.h>
35 #include <atf-c/detail/dynstr.h>
36 #include <atf-c/error_fwd.h>
38 /* ---------------------------------------------------------------------
39 * The "atf_fs_path" type.
40 * --------------------------------------------------------------------- */
45 typedef struct atf_fs_path atf_fs_path_t;
47 /* Constructors/destructors. */
48 atf_error_t atf_fs_path_init_ap(atf_fs_path_t *, const char *, va_list);
49 atf_error_t atf_fs_path_init_fmt(atf_fs_path_t *, const char *, ...);
50 atf_error_t atf_fs_path_copy(atf_fs_path_t *, const atf_fs_path_t *);
51 void atf_fs_path_fini(atf_fs_path_t *);
54 atf_error_t atf_fs_path_branch_path(const atf_fs_path_t *, atf_fs_path_t *);
55 const char *atf_fs_path_cstring(const atf_fs_path_t *);
56 atf_error_t atf_fs_path_leaf_name(const atf_fs_path_t *, atf_dynstr_t *);
57 bool atf_fs_path_is_absolute(const atf_fs_path_t *);
58 bool atf_fs_path_is_root(const atf_fs_path_t *);
61 atf_error_t atf_fs_path_append_ap(atf_fs_path_t *, const char *, va_list);
62 atf_error_t atf_fs_path_append_fmt(atf_fs_path_t *, const char *, ...);
63 atf_error_t atf_fs_path_append_path(atf_fs_path_t *, const atf_fs_path_t *);
64 atf_error_t atf_fs_path_to_absolute(const atf_fs_path_t *, atf_fs_path_t *);
67 bool atf_equal_fs_path_fs_path(const atf_fs_path_t *,
68 const atf_fs_path_t *);
70 /* ---------------------------------------------------------------------
71 * The "atf_fs_stat" type.
72 * --------------------------------------------------------------------- */
78 typedef struct atf_fs_stat atf_fs_stat_t;
81 extern const int atf_fs_stat_blk_type;
82 extern const int atf_fs_stat_chr_type;
83 extern const int atf_fs_stat_dir_type;
84 extern const int atf_fs_stat_fifo_type;
85 extern const int atf_fs_stat_lnk_type;
86 extern const int atf_fs_stat_reg_type;
87 extern const int atf_fs_stat_sock_type;
88 extern const int atf_fs_stat_wht_type;
90 /* Constructors/destructors. */
91 atf_error_t atf_fs_stat_init(atf_fs_stat_t *, const atf_fs_path_t *);
92 void atf_fs_stat_copy(atf_fs_stat_t *, const atf_fs_stat_t *);
93 void atf_fs_stat_fini(atf_fs_stat_t *);
96 dev_t atf_fs_stat_get_device(const atf_fs_stat_t *);
97 ino_t atf_fs_stat_get_inode(const atf_fs_stat_t *);
98 mode_t atf_fs_stat_get_mode(const atf_fs_stat_t *);
99 off_t atf_fs_stat_get_size(const atf_fs_stat_t *);
100 int atf_fs_stat_get_type(const atf_fs_stat_t *);
101 bool atf_fs_stat_is_owner_readable(const atf_fs_stat_t *);
102 bool atf_fs_stat_is_owner_writable(const atf_fs_stat_t *);
103 bool atf_fs_stat_is_owner_executable(const atf_fs_stat_t *);
104 bool atf_fs_stat_is_group_readable(const atf_fs_stat_t *);
105 bool atf_fs_stat_is_group_writable(const atf_fs_stat_t *);
106 bool atf_fs_stat_is_group_executable(const atf_fs_stat_t *);
107 bool atf_fs_stat_is_other_readable(const atf_fs_stat_t *);
108 bool atf_fs_stat_is_other_writable(const atf_fs_stat_t *);
109 bool atf_fs_stat_is_other_executable(const atf_fs_stat_t *);
111 /* ---------------------------------------------------------------------
113 * --------------------------------------------------------------------- */
115 extern const int atf_fs_access_f;
116 extern const int atf_fs_access_r;
117 extern const int atf_fs_access_w;
118 extern const int atf_fs_access_x;
120 atf_error_t atf_fs_eaccess(const atf_fs_path_t *, int);
121 atf_error_t atf_fs_exists(const atf_fs_path_t *, bool *);
122 atf_error_t atf_fs_getcwd(atf_fs_path_t *);
123 atf_error_t atf_fs_mkdtemp(atf_fs_path_t *);
124 atf_error_t atf_fs_mkstemp(atf_fs_path_t *, int *);
125 atf_error_t atf_fs_rmdir(const atf_fs_path_t *);
126 atf_error_t atf_fs_unlink(const atf_fs_path_t *);
128 #endif /* !defined(ATF_C_DETAIL_FS_H) */