src/util.h

   1
   2 /** \file util.h
   3  *  \brief Header: various utilities
   4  */
   5
   6 #ifndef MC_UTIL_H
   7 #define MC_UTIL_H
   8
   9 #include <sys/types.h>
  10 #include <assert.h>
  11 #include <string.h>
  12 #include <sys/stat.h>
  13
  14 /* Returns its argument as a "modifiable" string. This function is
  15  * intended to pass strings to legacy libraries that don't know yet
  16  * about the "const" modifier. The return value of this function
  17  * MUST NOT be modified. */
  18 extern char *str_unconst (const char *);
  19
  20 /* String managing functions */
  21
  22 extern const char *cstrcasestr (const char *haystack, const char *needle);
  23 extern const char *cstrstr (const char *haystack, const char *needle);
  24
  25 void str_replace(char *s, char from, char to);
  26 int  is_printable (int c);
  27 void msglen (const char *text, /*@out@*/ int *lines, /*@out@*/ int *columns);
  28
  29 /* Copy from s to d, and trim the beginning if necessary, and prepend
  30  * "..." in this case.  The destination string can have at most len
  31  * bytes, not counting trailing 0. */
  32 char *trim (const char *s, char *d, int len);
  33
  34 /* Quote the filename for the purpose of inserting it into the command
  35  * line.  If quote_percent is 1, replace "%" with "%%" - the percent is
  36  * processed by the mc command line. */
  37 char *name_quote (const char *c, int quote_percent);
  38
  39 /* returns a duplicate of c. */
  40 char *fake_name_quote (const char *c, int quote_percent);
  41
  42 /* Remove the middle part of the string to fit given length.
  43  * Use "~" to show where the string was truncated.
  44  * Return static buffer, no need to free() it. */
  45 const char *name_trunc (const char *txt, size_t trunc_len);
  46
  47 /* path_trunc() is the same as name_trunc() above but
  48  * it deletes possible password from path for security
  49  * reasons. */
  50 const char *path_trunc (const char *path, size_t trunc_len);
  51
  52 /* return a static string representing size, appending "K" or "M" for
  53  * big sizes.
  54  * NOTE: uses the same static buffer as size_trunc_sep. */
  55 const char *size_trunc (double size);
  56
  57 /* return a static string representing size, appending "K" or "M" for
  58  * big sizes. Separates every three digits by ",".
  59  * NOTE: uses the same static buffer as size_trunc. */
  60 const char *size_trunc_sep (double size);
  61
  62 /* Print file SIZE to BUFFER, but don't exceed LEN characters,
  63  * not including trailing 0. BUFFER should be at least LEN+1 long.
  64  *
  65  * Units: size units (0=bytes, 1=Kbytes, 2=Mbytes, etc.) */
  66 void size_trunc_len (char *buffer, int len, off_t size, int units);
  67 int  is_exe (mode_t mode);
  68 const char *string_perm (mode_t mode_bits);
  69
  70 /* @modifies path. @returns pointer into path. */
  71 char *strip_password (char *path, int has_prefix);
  72
  73 /* @returns a pointer into a static buffer. */
  74 const char *strip_home_and_password (const char *dir);
  75
  76 const char *extension (const char *);
  77 char *concat_dir_and_file (const char *dir, const char *file);
  78 const char *unix_error_string (int error_num);
  79 const char *skip_separators (const char *s);
  80 const char *skip_numbers (const char *s);
  81 char *strip_ctrl_codes (char *s);
  82
  83 /* Replaces "\\E" and "\\e" with "\033". Replaces "^" + [a-z] with
  84  * ((char) 1 + (c - 'a')). The same goes for "^" + [A-Z].
  85  * Returns a newly allocated string. */
  86 char *convert_controls (const char *s);
  87
  88 /* overwrites passwd with '\0's and frees it. */
  89 void wipe_password (char *passwd);
  90
  91 char *diff_two_paths (const char *first, const char *second);
  92
  93 /* Returns the basename of fname. The result is a pointer into fname. */
  94 const char *x_basename (const char *fname);
  95
  96 char *load_file (const char *filename);
  97 char *load_mc_home_file (const char *filename, char ** allocated_filename);
  98
  99 /* uid/gid managing */
 100 void init_groups (void);
 101 void destroy_groups (void);
 102 int get_user_permissions (struct stat *buf);
 103
 104 void init_uid_gid_cache (void);
 105 char *get_group (int);
 106 char *get_owner (int);
 107
 108 #define MAX_I18NTIMELENGTH 14
 109 #define MIN_I18NTIMELENGTH 10
 110 #define STD_I18NTIMELENGTH 12
 111
 112 size_t i18n_checktimelength (void);
 113 const char *file_date (time_t);
 114
 115 int exist_file (const char *name);
 116
 117 /* Check if the file exists. If not copy the default */
 118 int check_for_default (const char *default_file, const char *file);
 119
 120 /* Returns a copy of *s until a \n is found and is below top */
 121 const char *extract_line (const char *s, const char *top);
 122
 123 /* Matching */
 124 enum {
 125     match_file,                 /* match a filename, use easy_patterns */
 126     match_normal,               /* match pattern, use easy_patterns */
 127     match_regex                 /* match pattern, force using regex */
 128 };
 129
 130 extern int easy_patterns;
 131
 132 /* Error pipes */
 133 void open_error_pipe (void);
 134 void check_error_pipe (void);
 135 int close_error_pipe (int error, const char *text);
 136
 137 /* Process spawning */
 138 int my_system (int flags, const char *shell, const char *command);
 139 void save_stop_handler (void);
 140 extern struct sigaction startup_handler;
 141
 142 /* Tilde expansion */
 143 char *tilde_expand (const char *);
 144
 145 /* Pathname canonicalization */
 146 void canonicalize_pathname (char *);
 147
 148 /* Misc Unix functions */
 149 char *get_current_wd (char *buffer, int size);
 150 int my_mkdir (const char *s, mode_t mode);
 151 int my_rmdir (const char *s);
 152
 153 /* Rotating dash routines */
 154 void use_dash (int flag); /* Disable/Enable rotate_dash routines */
 155 void rotate_dash (void);
 156
 157 /* Creating temporary files safely */
 158 const char *mc_tmpdir (void);
 159 int mc_mkstemps(char **pname, const char *prefix, const char *suffix);
 160
 161 #ifndef PATH_MAX
 162 #ifdef _POSIX_VERSION
 163 #define PATH_MAX _POSIX_PATH_MAX
 164 #else
 165 #ifdef MAXPATHLEN
 166 #define PATH_MAX MAXPATHLEN
 167 #else
 168 #define PATH_MAX 1024
 169 #endif
 170 #endif
 171 #endif
 172
 173 #ifndef MAXSYMLINKS
 174 #define MAXSYMLINKS 32
 175 #endif
 176
 177 char *mc_realpath(const char *path, char resolved_path[]);
 178
 179 enum compression_type {
 180         COMPRESSION_NONE,
 181         COMPRESSION_GZIP,
 182         COMPRESSION_BZIP,
 183         COMPRESSION_BZIP2,
 184         COMPRESSION_LZMA,
 185         COMPRESSION_XZ
 186 };
 187
 188 /* Looks for ``magic'' bytes at the start of the VFS file to guess the
 189  * compression type. Side effect: modifies the file position. */
 190 enum compression_type get_compression_type (int fd);
 191 const char *decompress_extension (int type);
 192
 193 /* Hook functions */
 194
 195 typedef struct hook {
 196     void (*hook_fn)(void *);
 197     void *hook_data;
 198     struct hook *next;
 199 } Hook;
 200
 201 void add_hook (Hook **hook_list, void (*hook_fn)(void *), void *data);
 202 void execute_hooks (Hook *hook_list);
 203 void delete_hook (Hook **hook_list, void (*hook_fn)(void *));
 204 int hook_present (Hook *hook_list, void (*hook_fn)(void *));
 205
 206 GList *list_append_unique (GList *list, char *text);
 207
 208 /* Position saving and restoring */
 209
 210 /* file where positions are stored */
 211 #define MC_FILEPOS ".mc/filepos"
 212 /* temporary file */
 213 #define MC_FILEPOS_TMP ".mc/filepos.tmp"
 214 /* maximum entries in MC_FILEPOS */
 215 #define MC_FILEPOS_ENTRIES 1024
 216 /* Load position for the given filename */
 217 void load_file_position (const char *filename, long *line, long *column);
 218 /* Save position for the given filename */
 219 void save_file_position (const char *filename, long line, long column);
 220
 221
 222 /* OS specific defines */
 223 #define PATH_SEP '/'
 224 #define PATH_SEP_STR "/"
 225 #define PATH_ENV_SEP ':'
 226 #define TMPDIR_DEFAULT "/tmp"
 227 #define SCRIPT_SUFFIX ""
 228 #define get_default_editor() "vi"
 229 #define OS_SORT_CASE_SENSITIVE_DEFAULT 1
 230 #define STRCOMP strcmp
 231 #define STRNCOMP strncmp
 232 #define MC_ARCH_FLAGS 0
 233
 234 /* taken from regex.c: */
 235 /* Jim Meyering writes:
 236
 237    "... Some ctype macros are valid only for character codes that
 238    isascii says are ASCII (SGI's IRIX-4.0.5 is one such system --when
 239    using /bin/cc or gcc but without giving an ansi option).  So, all
 240    ctype uses should be through macros like ISPRINT...  If
 241    STDC_HEADERS is defined, then autoconf has verified that the ctype
 242    macros don't need to be guarded with references to isascii. ...
 243    Defining isascii to 1 should let any compiler worth its salt
 244    eliminate the && through constant folding."  */
 245
 246 #if defined (STDC_HEADERS) || (!defined (isascii) && !defined (HAVE_ISASCII))
 247 #define ISASCII(c) 1
 248 #else
 249 #define ISASCII(c) isascii(c)
 250 #endif
 251
 252 /* usage: str_cmp ("foo", !=, "bar") */
 253 #define str_cmp(a,rel,b) (strcmp ((a), (b)) rel 0)
 254
 255 /* if ch is in [A-Za-z], returns the corresponding control character,
 256  * else returns the argument. */
 257 extern int ascii_alpha_to_cntrl (int ch);
 258
 259 #undef Q_
 260 const char *Q_ (const char *s);
 261
 262 #define str_dup_range(s_start, s_bound) (g_strndup(s_start, s_bound - s_start))
 263
 264 /*
 265  * strcpy is unsafe on overlapping memory areas, so define memmove-alike
 266  * string function.
 267  * Have sense only when:
 268  *  * dest <= src
 269  *   AND
 270  *  * dest and str are pointers to one object (as Roland Illig pointed).
 271  *
 272  * We can't use str*cpy funs here:
 273  * http://kerneltrap.org/mailarchive/openbsd-misc/2008/5/27/1951294
 274  */
 275 static inline char * str_move(char * dest, const char * src)
 276 {
 277     size_t n;
 278
 279     assert (dest<=src);
 280
 281     n = strlen (src) + 1; /* + '\0' */
 282
 283     return memmove (dest, src, n);
 284 }
 285
 286 #define MC_PTR_FREE(ptr) do { g_free(ptr); (ptr) = NULL; } while (0)
 287
 288 #endif