lib/global.h

   1 /** \file global.h
   2  *  \brief Header: %global definitions for compatibility
   3  *
   4  *  This file should be included after all system includes and before all local includes.
   5  */
   6
   7 #ifndef MC_GLOBAL_H
   8 #define MC_GLOBAL_H
   9
  10 #if defined(HAVE_STRING_H)
  11 #include <string.h>
  12    /* An ANSI string.h and pre-ANSI memory.h might conflict */
  13 #elif defined(HAVE_MEMORY_H)
  14 #include <memory.h>
  15 #else
  16 #include <strings.h>
  17     /* memory and strings.h conflict on other systems */
  18 #endif /* !STDC_HEADERS & !HAVE_STRING_H */
  19
  20 #ifdef HAVE_SYS_PARAM_H
  21 #include <sys/param.h>
  22 #endif
  23
  24 /* for O_* macros */
  25 #include <fcntl.h>
  26
  27 /* for sig_atomic_t */
  28 #include <signal.h>
  29
  30 /*** typedefs(not structures) and defined constants **********************************************/
  31
  32 /* The O_BINARY definition was taken from gettext */
  33 #if !defined O_BINARY && defined _O_BINARY
  34   /* For MSC-compatible compilers.  */
  35 #define O_BINARY _O_BINARY
  36 #endif
  37 #ifdef __BEOS__
  38   /* BeOS 5 has O_BINARY, but is has no effect.  */
  39 #undef O_BINARY
  40 #endif
  41 /* On reasonable systems, binary I/O is the default.  */
  42 #ifndef O_BINARY
  43 #define O_BINARY 0
  44 #endif
  45
  46 /* Replacement for O_NONBLOCK */
  47 #ifndef O_NONBLOCK
  48 #ifdef O_NDELAY                 /* SYSV */
  49 #define O_NONBLOCK O_NDELAY
  50 #else /* BSD */
  51 #define O_NONBLOCK FNDELAY
  52 #endif /* !O_NDELAY */
  53 #endif /* !O_NONBLOCK */
  54
  55 #ifdef HAVE_SYS_SELECT_H
  56 #include <sys/select.h>
  57 #endif
  58
  59 #if defined(__QNX__) && !defined(__QNXNTO__)
  60 /* exec*() from <process.h> */
  61 #include <unix.h>
  62 #endif
  63
  64 #include <glib.h>
  65 #include "glibcompat.h"
  66
  67 /* For SMB VFS only */
  68 #ifndef __GNUC__
  69 #define __attribute__(x)
  70 #endif
  71
  72 /* Solaris9 doesn't have PRIXMAX */
  73 #ifndef PRIXMAX
  74 #define PRIXMAX PRIxMAX
  75 #endif
  76
  77 #ifdef ENABLE_NLS
  78 #include <libintl.h>
  79 #define _(String) gettext (String)
  80 #ifdef gettext_noop
  81 #define N_(String) gettext_noop (String)
  82 #else
  83 #define N_(String) (String)
  84 #endif
  85 #else /* Stubs that do something close enough.  */
  86 #define textdomain(String) 1
  87 #define gettext(String) (String)
  88 #define ngettext(String1,String2,Num) (((Num) == 1) ? (String1) : (String2))
  89 #define dgettext(Domain,Message) (Message)
  90 #define dcgettext(Domain,Message,Type) (Message)
  91 #define bindtextdomain(Domain,Directory) 1
  92 #define _(String) (String)
  93 #define N_(String) (String)
  94 #endif /* !ENABLE_NLS */
  95
  96 #include "fs.h"
  97 #include "shell.h"
  98
  99 #ifdef USE_MAINTAINER_MODE
 100 #include "lib/logging.h"
 101 #endif
 102
 103 #ifdef min
 104 #undef min
 105 #endif
 106
 107 #ifdef max
 108 #undef max
 109 #endif
 110
 111 #define min(x, y) ((x) > (y) ? (y) : (x))
 112 #define max(x, y) ((x) > (y) ? (x) : (y))
 113
 114 /* Just for keeping Your's brains from invention a proper size of the buffer :-) */
 115 #define BUF_10K 10240L
 116 #define BUF_8K  8192L
 117 #define BUF_4K  4096L
 118 #define BUF_1K  1024L
 119
 120 #define BUF_LARGE  BUF_1K
 121 #define BUF_MEDIUM 512
 122 #define BUF_SMALL 128
 123 #define BUF_TINY 64
 124
 125 /* ESC_CHAR is defined in /usr/include/langinfo.h in some systems */
 126 #ifdef ESC_CHAR
 127 #undef ESC_CHAR
 128 #endif
 129 /* AIX compiler doesn't understand '\e' */
 130 #define ESC_CHAR '\033'
 131 #define ESC_STR  "\033"
 132
 133 /* OS specific defines */
 134 #define PATH_SEP '/'
 135 #define PATH_SEP_STR "/"
 136 #define IS_PATH_SEP(c) ((c) == PATH_SEP)
 137 #define PATH_ENV_SEP ':'
 138 #define TMPDIR_DEFAULT "/tmp"
 139 #define SCRIPT_SUFFIX ""
 140 #define get_default_editor() "vi"
 141 #define OS_SORT_CASE_SENSITIVE_DEFAULT 1
 142 #define UTF8_CHAR_LEN 6
 143
 144 /* Used to distinguish between a normal MC termination and */
 145 /* one caused by typing 'exit' or 'logout' in the subshell */
 146 #define SUBSHELL_EXIT 128
 147
 148 /* C++ style type casts */
 149 #define const_cast(m_type, m_expr) ((m_type) (m_expr))
 150
 151 #if 0
 152 #ifdef MC_ENABLE_DEBUGGING_CODE
 153 #undef NDEBUG
 154 #else
 155 #define NDEBUG
 156 #endif
 157 #ifdef HAVE_ASSERT_H
 158 #include <assert.h>
 159 #endif
 160 #endif
 161
 162 #define MC_ERROR g_quark_from_static_string (PACKAGE)
 163
 164 #define DEFAULT_CHARSET "ASCII"
 165
 166 #include "lib/timer.h"          /* mc_timer_t */
 167
 168 /*** enums ***************************************************************************************/
 169
 170 /* run mode and params */
 171 typedef enum
 172 {
 173     MC_RUN_FULL = 0,
 174     MC_RUN_EDITOR,
 175     MC_RUN_VIEWER,
 176     MC_RUN_DIFFVIEWER
 177 } mc_run_mode_t;
 178
 179 /*** structures declarations (and typedefs of structures)*****************************************/
 180
 181 typedef struct
 182 {
 183     mc_run_mode_t mc_run_mode;
 184     /* global timer */
 185     mc_timer_t *timer;
 186     /* Used so that widgets know if they are being destroyed or shut down */
 187     gboolean midnight_shutdown;
 188
 189     /* sysconfig_dir: Area for default settings from maintainers of distributuves
 190        default is /etc/mc or may be defined by MC_DATADIR */
 191     char *sysconfig_dir;
 192     /* share_data_dir: Area for default settings from developers */
 193     char *share_data_dir;
 194
 195 #ifdef HAVE_CHARSET
 196     /* Numbers of (file I/O) and (input/display) codepages. -1 if not selected */
 197     int source_codepage;
 198     int display_codepage;
 199 #else
 200     /* If true, allow characters in the range 160-255 */
 201     int eight_bit_clean;
 202     /*
 203      * If true, also allow characters in the range 128-159.
 204      * This is reported to break on many terminals (xterm, qansi-m).
 205      */
 206     int full_eight_bits;
 207 #endif                          /* !HAVE_CHARSET */
 208     /*
 209      * If utf-8 terminal utf8_display = TRUE
 210      * Display bits set UTF-8
 211      */
 212     gboolean utf8_display;
 213
 214     /* Set if the nice message (hint) bar is visible */
 215     int message_visible;
 216     /* Set if the nice and useful keybar is visible */
 217     int keybar_visible;
 218
 219 #ifdef ENABLE_BACKGROUND
 220     /* If true, this is a background process */
 221     gboolean we_are_background;
 222 #endif                          /* ENABLE_BACKGROUND */
 223
 224     struct
 225     {
 226         /* Asks for confirmation before clean up of history */
 227         gboolean confirm_history_cleanup;
 228
 229         /* Set if you want the possible completions dialog for the first time */
 230         gboolean show_all_if_ambiguous;
 231
 232         /* Ugly hack in order to distinguish between left and right panel in menubar */
 233         /* Set if the command is being run from the "Right" menu */
 234         gboolean is_right;      /* If the selected menu was the right */
 235     } widget;
 236
 237     /* The user's shell */
 238     mc_shell_t *shell;
 239
 240     struct
 241     {
 242         /* Use the specified skin */
 243         char *skin;
 244
 245         char *setup_color_string;
 246         char *term_color_string;
 247         char *color_terminal_string;
 248         /* colors specified on the command line: they override any other setting */
 249         char *command_line_colors;
 250
 251 #ifndef LINUX_CONS_SAVER_C
 252         /* Used only in mc, not in cons.saver */
 253         char console_flag;
 254 #endif                          /* !LINUX_CONS_SAVER_C */
 255         /* If using a subshell for evaluating commands this is true */
 256         gboolean use_subshell;
 257
 258 #ifdef ENABLE_SUBSHELL
 259         /* File descriptors of the pseudoterminal used by the subshell */
 260         int subshell_pty;
 261 #endif                          /* !ENABLE_SUBSHELL */
 262
 263         /* This flag is set by xterm detection routine in function main() */
 264         /* It is used by function view_other_cmd() */
 265         gboolean xterm_flag;
 266
 267         /* disable x11 support */
 268         gboolean disable_x11;
 269
 270         /* For slow terminals */
 271         /* If true lines are shown by spaces */
 272         gboolean slow_terminal;
 273
 274         /* Set to force black and white display at program startup */
 275         gboolean disable_colors;
 276
 277         /* If true use +, -, | for line drawing */
 278         gboolean ugly_line_drawing;
 279
 280         /* Tries to use old highlight mouse tracking */
 281         gboolean old_mouse;
 282
 283         /* If true, use + and \ keys normally and select/unselect do if M-+ / M-\.
 284            and M-- and keypad + / - */
 285         gboolean alternate_plus_minus;
 286
 287         /* Set if the window has changed it's size */
 288         SIG_ATOMIC_VOLATILE_T winch_flag;
 289     } tty;
 290
 291     struct
 292     {
 293         /* Set when cd symlink following is desirable (bash mode) */
 294         gboolean cd_symlinks;
 295
 296         /* Preallocate space before file copying */
 297         gboolean preallocate_space;
 298
 299     } vfs;
 300 } mc_global_t;
 301
 302 /*** global variables defined in .c file *********************************************************/
 303
 304 extern mc_global_t mc_global;
 305
 306 /*** declarations of public functions ************************************************************/
 307
 308 /*** inline functions ****************************************************************************/
 309 #endif