root/lib/util.h

/*   */

INCLUDED FROM

DEFINITIONS

1. mc_propagate_error
2. is_exe

   1 /** \file lib/util.h
   2  *  \brief Header: various utilities
   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>           /* uintmax_t */
  11 #include <unistd.h>
  12 
  13 #include "lib/global.h"         /* include <glib.h> */
  14 
  15 #include "lib/vfs/vfs.h"
  16 
  17 /*** typedefs(not structures) and defined constants **********************************************/
  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 /* gnulib efa15594e17fc20827dba66414fb391e99905394
  42 
  43  *_GL_CMP (n1, n2) performs a three-valued comparison on n1 vs. n2.
  44  *  It returns
  45  *    1  if n1 > n2
  46  *    0  if n1 == n2
  47  *    -1 if n1 < n2
  48  *  The native code   (n1 > n2 ? 1 : n1 < n2 ? -1 : 0)  produces a conditional
  49  *  jump with nearly all GCC versions up to GCC 10.
  50  *  This variant      (n1 < n2 ? -1 : n1 > n2)  produces a conditional with many
  51  *  GCC versions up to GCC 9.
  52  *  The better code  (n1 > n2) - (n1 < n2)  from Hacker's Delight para 2-9
  53  *  avoids conditional jumps in all GCC versions >= 3.4.
  54  */
  55 #define _GL_CMP(n1, n2) (((n1) > (n2)) - ((n1) < (n2)))
  56 
  57 /* Difference of zero */
  58 #define DOZ(a, b) ((a) > (b) ? (a) - (b) : 0)
  59 
  60 /*** enums ***************************************************************************************/
  61 
  62 /* Pathname canonicalization */
  63 typedef enum
  64 {
  65     CANON_PATH_JOINSLASHES = 1L << 0,   /* Multiple '/'s are collapsed to a single '/'. */
  66     CANON_PATH_REMSLASHDOTS = 1L << 1,  /* Leading './'s, '/'s and trailing '/.'s are removed. */
  67     CANON_PATH_REMDOUBLEDOTS = 1L << 3, /* Non-leading '../'s and trailing '..'s are handled by removing */
  68     CANON_PATH_GUARDUNC = 1L << 4,      /* Detect and preserve UNC paths: //server/... */
  69     CANON_PATH_ALL = CANON_PATH_JOINSLASHES
  70         | CANON_PATH_REMSLASHDOTS | CANON_PATH_REMDOUBLEDOTS | CANON_PATH_GUARDUNC
  71 } CANON_PATH_FLAGS;
  72 
  73 enum compression_type
  74 {
  75     COMPRESSION_NONE,
  76     COMPRESSION_GZIP,
  77     COMPRESSION_BZIP,
  78     COMPRESSION_BZIP2,
  79     COMPRESSION_LZIP,
  80     COMPRESSION_LZ4,
  81     COMPRESSION_LZMA,
  82     COMPRESSION_XZ,
  83     COMPRESSION_ZSTD,
  84 };
  85 
  86 /* stdout or stderr stream of child process */
  87 typedef struct
  88 {
  89     /* file descriptor */
  90     int fd;
  91     /* data read from fd */
  92     char buf[MC_PIPE_BUFSIZE];
  93     /* current position in @buf (used by mc_pstream_get_string()) */
  94     size_t pos;
  95     /* positive: length of data in buf;
  96      * MC_PIPE_STREAM_EOF: EOF of fd;
  97      * MC_PIPE_STREAM_UNREAD: there was not read from fd;
  98      * MC_PIPE_ERROR_READ: reading error from fd.
  99      */
 100     ssize_t len;
 101     /* whether buf is null-terminated or not */
 102     gboolean null_term;
 103     /* error code in case of len == MC_PIPE_ERROR_READ */
 104     int error;
 105 } mc_pipe_stream_t;
 106 
 107 /* Pipe descriptor for child process */
 108 typedef struct
 109 {
 110     /* PID of child process */
 111     GPid child_pid;
 112     /* stdout of child process */
 113     mc_pipe_stream_t out;
 114     /* stderr of child process */
 115     mc_pipe_stream_t err;
 116 } mc_pipe_t;
 117 
 118 /*** structures declarations (and typedefs of structures)*****************************************/
 119 
 120 /* keys are set only during sorting */
 121 typedef struct
 122 {
 123     /* File attributes */
 124     GString *fname;
 125     struct stat st;
 126     /* key used for comparing names */
 127     char *sort_key;
 128     /* key used for comparing extensions */
 129     char *second_sort_key;
 130 
 131     /* Flags */
 132     struct
 133     {
 134         unsigned int marked:1;  /* File marked in pane window */
 135         unsigned int link_to_dir:1;     /* If this is a link, does it point to directory? */
 136         unsigned int stale_link:1;      /* If this is a symlink and points to Charon's land */
 137         unsigned int dir_size_computed:1;       /* Size of directory was computed with dirsizes_cmd */
 138     } f;
 139 } file_entry_t;
 140 
 141 /*** global variables defined in .c file *********************************************************/
 142 
 143 extern struct sigaction startup_handler;
 144 
 145 /*** declarations of public functions ************************************************************/
 146 
 147 int is_printable (int c);
 148 
 149 /* Quote the filename for the purpose of inserting it into the command
 150  * line.  If quote_percent is 1, replace "%" with "%%" - the percent is
 151  * processed by the mc command line. */
 152 char *name_quote (const char *c, gboolean quote_percent);
 153 
 154 /* returns a duplicate of c. */
 155 char *fake_name_quote (const char *c, gboolean quote_percent);
 156 
 157 /* path_trunc() is the same as str_trunc() but
 158  * it deletes possible password from path for security
 159  * reasons. */
 160 const char *path_trunc (const char *path, size_t trunc_len);
 161 
 162 /* return a static string representing size, appending "K" or "M" for
 163  * big sizes.
 164  * NOTE: uses the same static buffer as size_trunc_sep. */
 165 const char *size_trunc (uintmax_t size, gboolean use_si);
 166 
 167 /* return a static string representing size, appending "K" or "M" for
 168  * big sizes. Separates every three digits by ",".
 169  * NOTE: uses the same static buffer as size_trunc. */
 170 const char *size_trunc_sep (uintmax_t size, gboolean use_si);
 171 
 172 /* Print file SIZE to BUFFER, but don't exceed LEN characters,
 173  * not including trailing 0. BUFFER should be at least LEN+1 long.
 174  *
 175  * Units: size units (0=bytes, 1=Kbytes, 2=Mbytes, etc.) */
 176 void size_trunc_len (char *buffer, unsigned int len, uintmax_t size, int units, gboolean use_si);
 177 const char *string_perm (mode_t mode_bits);
 178 
 179 const char *extension (const char *);
 180 const char *unix_error_string (int error_num);
 181 const char *skip_separators (const char *s);
 182 const char *skip_numbers (const char *s);
 183 char *strip_ctrl_codes (char *s);
 184 
 185 /* Replaces "\\E" and "\\e" with "\033". Replaces "^" + [a-z] with
 186  * ((char) 1 + (c - 'a')). The same goes for "^" + [A-Z].
 187  * Returns a newly allocated string. */
 188 char *convert_controls (const char *s);
 189 
 190 /* overwrites passwd with '\0's and frees it. */
 191 void wipe_password (char *passwd);
 192 
 193 char *diff_two_paths (const vfs_path_t * vpath1, const vfs_path_t * vpath2);
 194 
 195 /* Returns the basename of fname. The result is a pointer into fname. */
 196 const char *x_basename (const char *fname);
 197 
 198 char *load_mc_home_file (const char *from, const char *filename, char **allocated_filename,
 199                          size_t * length);
 200 
 201 /* uid/gid managing */
 202 void init_groups (void);
 203 void destroy_groups (void);
 204 int get_user_permissions (struct stat *buf);
 205 
 206 void init_uid_gid_cache (void);
 207 const char *get_group (gid_t gid);
 208 const char *get_owner (uid_t uid);
 209 
 210 /* Returns a copy of *s until a \n is found and is below top */
 211 const char *extract_line (const char *s, const char *top);
 212 
 213 /* Process spawning */
 214 int my_system (int flags, const char *shell, const char *command);
 215 int my_systeml (int flags, const char *shell, ...);
 216 int my_systemv (const char *command, char *const argv[]);
 217 int my_systemv_flags (int flags, const char *command, char *const argv[]);
 218 
 219 mc_pipe_t *mc_popen (const char *command, gboolean read_out, gboolean read_err, GError ** error);
 220 void mc_pread (mc_pipe_t * p, GError ** error);
 221 void mc_pclose (mc_pipe_t * p, GError ** error);
 222 
 223 GString *mc_pstream_get_string (mc_pipe_stream_t * ps);
 224 
 225 void my_exit (int status);
 226 void save_stop_handler (void);
 227 
 228 /* Tilde expansion */
 229 char *tilde_expand (const char *directory);
 230 
 231 void custom_canonicalize_pathname (char *path, CANON_PATH_FLAGS flags);
 232 void canonicalize_pathname (char *path);
 233 
 234 char *mc_realpath (const char *path, char *resolved_path);
 235 
 236 /* Looks for "magic" bytes at the start of the VFS file to guess the
 237  * compression type. Side effect: modifies the file position. */
 238 enum compression_type get_compression_type (int fd, const char *name);
 239 const char *decompress_extension (int type);
 240 
 241 GList *list_append_unique (GList * list, char *text);
 242 
 243 /* Position saving and restoring */
 244 /* Load position for the given filename */
 245 void load_file_position (const vfs_path_t * filename_vpath, long *line, long *column,
 246                          off_t * offset, GArray ** bookmarks);
 247 /* Save position for the given filename */
 248 void save_file_position (const vfs_path_t * filename_vpath, long line, long column, off_t offset,
 249                          GArray * bookmarks);
 250 
 251 
 252 /* if ch is in [A-Za-z], returns the corresponding control character,
 253  * else returns the argument. */
 254 extern int ascii_alpha_to_cntrl (int ch);
 255 
 256 #undef Q_
 257 const char *Q_ (const char *s);
 258 
 259 gboolean mc_util_make_backup_if_possible (const char *file_name, const char *backup_suffix);
 260 gboolean mc_util_restore_from_backup_if_possible (const char *file_name, const char *backup_suffix);
 261 gboolean mc_util_unlink_backup_if_possible (const char *file_name, const char *backup_suffix);
 262 
 263 char *guess_message_value (void);
 264 
 265 char *mc_build_filename (const char *first_element, ...);
 266 char *mc_build_filenamev (const char *first_element, va_list args);
 267 
 268 const char *mc_get_profile_root (void);
 269 
 270 /* *INDENT-OFF* */
 271 void mc_propagate_error (GError ** dest, int code, const char *format, ...) G_GNUC_PRINTF (3, 4);
     /*   */
 272 void mc_replace_error (GError ** dest, int code, const char *format, ...) G_GNUC_PRINTF (3, 4);
 273 /* *INDENT-ON* */
 274 
 275 gboolean mc_time_elapsed (gint64 * timestamp, gint64 delay);
 276 
 277 /*** inline functions **************************************************/
 278 
 279 static inline gboolean
 280 exist_file (const char *name)
 281 {
 282     return (access (name, R_OK) == 0);
 283 }
 284 
 285 static inline gboolean
 286 is_exe (mode_t mode)
     /*   */
 287 {
 288     return ((mode & (S_IXUSR | S_IXGRP | S_IXOTH)) != 0);
 289 }
 290 
 291 #endif /* MC_UTIL_H */

/*   */