src/util.h

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