This source file includes following definitions.
- mc_propagate_error
- is_exe
- canonicalize_pathname
1
2
3
4
5 #ifndef MC_UTIL_H
6 #define MC_UTIL_H
7
8 #include <sys/types.h>
9 #include <sys/stat.h>
10 #include <inttypes.h>
11 #include <unistd.h>
12
13 #include "lib/global.h"
14
15 #include "lib/vfs/vfs.h"
16
17
18
19 #ifndef MAXSYMLINKS
20 #define MAXSYMLINKS 32
21 #endif
22
23 #define MAX_SAVED_BOOKMARKS 10
24
25 #define MC_PTR_FREE(ptr) do { g_free (ptr); (ptr) = NULL; } while (0)
26
27 #define mc_return_if_error(mcerror) do { if (mcerror != NULL && *mcerror != NULL) return; } while (0)
28 #define mc_return_val_if_error(mcerror, mcvalue) do { if (mcerror != NULL && *mcerror != NULL) return mcvalue; } while (0)
29
30 #define whitespace(c) ((c) == ' ' || (c) == '\t')
31 #define whiteness(c) (whitespace (c) || (c) == '\n')
32
33 #define MC_PIPE_BUFSIZE BUF_8K
34 #define MC_PIPE_STREAM_EOF 0
35 #define MC_PIPE_STREAM_UNREAD -1
36 #define MC_PIPE_ERROR_CREATE_PIPE -2
37 #define MC_PIPE_ERROR_PARSE_COMMAND -3
38 #define MC_PIPE_ERROR_CREATE_PIPE_STREAM -4
39 #define MC_PIPE_ERROR_READ -5
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55 #define _GL_CMP(n1, n2) (((n1) > (n2)) - ((n1) < (n2)))
56
57
58 #define DOZ(a, b) ((a) > (b) ? (a) - (b) : 0)
59
60
61
62
63
64 typedef enum
65 {
66 CANON_PATH_NOCHANGE = 0,
67 CANON_PATH_JOINSLASHES = 1L << 0,
68 CANON_PATH_REMSLASHDOTS = 1L << 1,
69 CANON_PATH_REMDOUBLEDOTS = 1L << 3,
70
71 CANON_PATH_GUARDUNC = 1L << 4,
72 CANON_PATH_ALL = CANON_PATH_JOINSLASHES | CANON_PATH_REMSLASHDOTS
73 | CANON_PATH_REMDOUBLEDOTS | CANON_PATH_GUARDUNC
74 } canon_path_flags_t;
75
76
77 enum compression_type
78 {
79 COMPRESSION_NONE,
80 COMPRESSION_ZIP,
81 COMPRESSION_GZIP,
82 COMPRESSION_BZIP,
83 COMPRESSION_BZIP2,
84 COMPRESSION_LZIP,
85 COMPRESSION_LZ4,
86 COMPRESSION_LZMA,
87 COMPRESSION_XZ,
88 COMPRESSION_ZSTD,
89 };
90
91
92 typedef struct
93 {
94
95 int fd;
96
97 char buf[MC_PIPE_BUFSIZE];
98
99 size_t pos;
100
101
102
103
104
105 ssize_t len;
106
107 gboolean null_term;
108
109 int error;
110 } mc_pipe_stream_t;
111
112
113 typedef struct
114 {
115
116 GPid child_pid;
117
118 mc_pipe_stream_t out;
119
120 mc_pipe_stream_t err;
121 } mc_pipe_t;
122
123
124
125
126
127 extern struct sigaction startup_handler;
128
129
130
131 int is_printable (int c);
132
133
134
135
136 char *name_quote (const char *c, gboolean quote_percent);
137
138
139 char *fake_name_quote (const char *c, gboolean quote_percent);
140
141
142
143
144 const char *path_trunc (const char *path, size_t trunc_len);
145
146
147
148
149 const char *size_trunc (uintmax_t size, gboolean use_si);
150
151
152
153
154 const char *size_trunc_sep (uintmax_t size, gboolean use_si);
155
156
157
158
159
160 void size_trunc_len (char *buffer, unsigned int len, uintmax_t size, int units, gboolean use_si);
161 const char *string_perm (mode_t mode_bits);
162
163 const char *extension (const char *);
164 const char *unix_error_string (int error_num);
165 const char *skip_separators (const char *s);
166 const char *skip_numbers (const char *s);
167 char *strip_ctrl_codes (char *s);
168
169
170
171
172 char *convert_controls (const char *s);
173
174
175 void wipe_password (char *passwd);
176
177 char *diff_two_paths (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
178
179
180 const char *x_basename (const char *fname);
181
182 char *load_mc_home_file (const char *from, const char *filename, char **allocated_filename,
183 size_t * length);
184
185
186 void init_groups (void);
187 void destroy_groups (void);
188 int get_user_permissions (struct stat *buf);
189
190 void init_uid_gid_cache (void);
191 const char *get_group (gid_t gid);
192 const char *get_owner (uid_t uid);
193
194
195 const char *extract_line (const char *s, const char *top);
196
197
198 int my_system (int flags, const char *shell, const char *command);
199 int my_systeml (int flags, const char *shell, ...);
200 int my_systemv (const char *command, char *const argv[]);
201 int my_systemv_flags (int flags, const char *command, char *const argv[]);
202
203 mc_pipe_t *mc_popen (const char *command, gboolean read_out, gboolean read_err, GError ** error);
204 void mc_pread (mc_pipe_t * p, GError ** error);
205 void mc_pclose (mc_pipe_t * p, GError ** error);
206
207 GString *mc_pstream_get_string (mc_pipe_stream_t * ps);
208
209 void my_exit (int status);
210 void save_stop_handler (void);
211
212
213 char *tilde_expand (const char *directory);
214
215 void canonicalize_pathname_custom (char *path, canon_path_flags_t flags);
216
217 char *mc_realpath (const char *path, char *resolved_path);
218
219
220
221 enum compression_type get_compression_type (int fd, const char *name);
222 const char *decompress_extension (int type);
223
224 GList *list_append_unique (GList * list, char *text);
225
226
227
228 void load_file_position (const vfs_path_t * filename_vpath, long *line, long *column,
229 off_t * offset, GArray ** bookmarks);
230
231 void save_file_position (const vfs_path_t * filename_vpath, long line, long column, off_t offset,
232 GArray * bookmarks);
233
234
235
236
237 extern int ascii_alpha_to_cntrl (int ch);
238
239 #undef Q_
240 const char *Q_ (const char *s);
241
242 gboolean mc_util_make_backup_if_possible (const char *file_name, const char *backup_suffix);
243 gboolean mc_util_restore_from_backup_if_possible (const char *file_name, const char *backup_suffix);
244 gboolean mc_util_unlink_backup_if_possible (const char *file_name, const char *backup_suffix);
245
246 char *guess_message_value (void);
247
248 char *mc_build_filename (const char *first_element, ...);
249 char *mc_build_filenamev (const char *first_element, va_list args);
250
251 const char *mc_get_profile_root (void);
252
253
254 void mc_propagate_error (GError ** dest, int code, const char *format, ...) G_GNUC_PRINTF (3, 4);
255 void mc_replace_error (GError ** dest, int code, const char *format, ...) G_GNUC_PRINTF (3, 4);
256
257
258 gboolean mc_time_elapsed (gint64 * timestamp, gint64 delay);
259
260
261
262
263
264 static inline gboolean
265 exist_file (const char *name)
266 {
267 return (access (name, R_OK) == 0);
268 }
269
270
271
272 static inline gboolean
273 is_exe (mode_t mode)
274 {
275 return ((mode & (S_IXUSR | S_IXGRP | S_IXOTH)) != 0);
276 }
277
278
279
280
281
282
283
284
285
286
287
288
289 static inline void
290 canonicalize_pathname (char *path)
291 {
292 canonicalize_pathname_custom (path, CANON_PATH_ALL);
293 }
294
295
296
297 #endif