root/lib/global.h

/*   */

INCLUDED FROM

   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 #include <glib.h>
  11 
  12 #if defined(__has_attribute)
  13 #define MC_HAS_ATTRIBUTE(ATTR) __has_attribute (ATTR)
  14 #else
  15 #define MC_HAS_ATTRIBUTE(ATTR) 0
  16 #endif
  17 
  18 #if MC_HAS_ATTRIBUTE(weak) && defined(HAVE_TESTS)
  19 #define MC_MOCKABLE __attribute__ ((weak))
  20 #else
  21 #define MC_MOCKABLE
  22 #endif
  23 
  24 #if defined(HAVE_TESTS)
  25 #define MC_TESTABLE
  26 #else
  27 #define MC_TESTABLE static
  28 #endif
  29 
  30 #include "glibcompat.h"
  31 
  32 #include "unixcompat.h"
  33 
  34 #include "fs.h"
  35 #include "shell.h"
  36 #include "mcconfig.h"
  37 
  38 /*** typedefs(not structures) and defined constants **********************************************/
  39 
  40 #ifdef ENABLE_NLS
  41 #include <libintl.h>
  42 #define _(String) gettext (String)
  43 #ifdef gettext_noop
  44 #define N_(String) gettext_noop (String)
  45 #else
  46 #define N_(String) (String)
  47 #endif
  48 #else  // Stubs that do something close enough.
  49 #define textdomain(String)                1
  50 #define gettext(String)                   (String)
  51 #define ngettext(String1, String2, Num)   (((Num) == 1) ? (String1) : (String2))
  52 #define dgettext(Domain, Message)         (Message)
  53 #define dcgettext(Domain, Message, Type)  (Message)
  54 #define bindtextdomain(Domain, Directory) 1
  55 #define _(String)                         (String)
  56 #define N_(String)                        (String)
  57 #endif
  58 
  59 #if MC_HAS_ATTRIBUTE(fallthrough)
  60 #define MC_FALLTHROUGH __attribute__ ((fallthrough))
  61 #else
  62 #define MC_FALLTHROUGH
  63 #endif
  64 
  65 #if MC_HAS_ATTRIBUTE(unused)
  66 #define MC_UNUSED __attribute__ ((unused))
  67 #else
  68 #define MC_UNUSED
  69 #endif
  70 
  71 #if MC_HAS_ATTRIBUTE(nonstring)
  72 #define MC_NONSTRING __attribute__ ((nonstring))
  73 #else
  74 #define MC_NONSTRING
  75 #endif
  76 
  77 #ifdef USE_MAINTAINER_MODE
  78 #include "lib/logging.h"
  79 #endif
  80 
  81 /* Just for keeping Your's brains from invention a proper size of the buffer :-) */
  82 #define BUF_10K    10240L
  83 #define BUF_8K     8192L
  84 #define BUF_4K     4096L
  85 #define BUF_2K     2048L
  86 #define BUF_1K     1024L
  87 
  88 #define BUF_LARGE  BUF_1K
  89 #define BUF_MEDIUM 512
  90 #define BUF_SMALL  128
  91 #define BUF_TINY   64
  92 
  93 /* Used to distinguish between a normal MC termination and */
  94 /* one caused by typing 'exit' or 'logout' in the subshell */
  95 #define SUBSHELL_EXIT   128
  96 
  97 #define MC_ERROR        g_quark_from_static_string (PACKAGE)
  98 
  99 #define DEFAULT_CHARSET "ASCII"
 100 
 101 /*** enums ***************************************************************************************/
 102 
 103 /* run mode and params */
 104 typedef enum
 105 {
 106     MC_RUN_FULL = 0,
 107     MC_RUN_EDITOR,
 108     MC_RUN_VIEWER,
 109     MC_RUN_DIFFVIEWER
 110 } mc_run_mode_t;
 111 
 112 /*** structures declarations (and typedefs of structures)*****************************************/
 113 
 114 typedef struct
 115 {
 116     const char *mc_version;
 117 
 118     mc_run_mode_t mc_run_mode;
 119     gboolean run_from_parent_mc;
 120     // Used so that widgets know if they are being destroyed or shut down
 121     gboolean midnight_shutdown;
 122 
 123     /* sysconfig_dir: Area for default settings from maintainers of distributuves
 124        default is /etc/mc or may be defined by MC_DATADIR */
 125     char *sysconfig_dir;
 126     // share_data_dir: Area for default settings from developers
 127     char *share_data_dir;
 128 
 129     char *profile_name;
 130 
 131     mc_config_t *main_config;
 132     mc_config_t *panels_config;
 133 
 134     // Numbers of (file I/O) and (input/display) codepages. -1 if not selected
 135     int source_codepage;
 136     int display_codepage;
 137 
 138     // If utf-8 terminal utf8_display = TRUE
 139     gboolean utf8_display;
 140 
 141     // Set if the main menu is visible
 142     gboolean menubar_visible;
 143     // Set if the hint bar is visible
 144     gboolean hint_visible;
 145     // Set if the prompt and the command line are visible
 146     gboolean cmdline_visible;
 147     // Set if the nice and useful keybar is visible
 148     gboolean keybar_visible;
 149 
 150 #ifdef ENABLE_BACKGROUND
 151     // If true, this is a background process
 152     gboolean we_are_background;
 153 #endif
 154 
 155     struct
 156     {
 157         // Asks for confirmation before clean up of history
 158         gboolean confirm_history_cleanup;
 159 
 160         // Set if you want the possible completions dialog for the first time
 161         gboolean show_all_if_ambiguous;
 162 
 163         // Ugly hack in order to distinguish between left and right panel in menubar
 164         // Set if the command is being run from the "Right" menu
 165         gboolean is_right;  // If the selected menu was the right
 166     } widget;
 167 
 168     // The user's shell
 169     mc_shell_t *shell;
 170 
 171     struct
 172     {
 173         // Use the specified skin
 174         char *skin;
 175         // Dialog window and drop down menu have a shadow
 176         gboolean shadows;
 177 
 178         char *setup_color_string;
 179         char *term_color_string;
 180         char *color_terminal_string;
 181 
 182 #ifndef LINUX_CONS_SAVER_C
 183         // Used only in mc, not in cons.saver
 184         char console_flag;
 185 #endif
 186         // If using a subshell for evaluating commands this is true
 187         gboolean use_subshell;
 188 
 189 #ifdef ENABLE_SUBSHELL
 190         // File descriptors of the pseudoterminal used by the subshell
 191         int subshell_pty;
 192 #endif
 193 
 194         // This flag is set by xterm detection routine in function main()
 195         // It is used by function toggle_subshell()
 196         gboolean xterm_flag;
 197 
 198         // disable x11 support
 199         gboolean disable_x11;
 200 
 201         // For slow terminals
 202         // If true lines are shown by spaces
 203         gboolean slow_terminal;
 204 
 205         // Set to force black and white display at program startup
 206         gboolean disable_colors;
 207 
 208         // If true use +, -, | for line drawing
 209         gboolean ugly_line_drawing;
 210 
 211         // Tries to use old highlight mouse tracking
 212         gboolean old_mouse;
 213 
 214         /* If true, use + and \ keys normally and select/unselect do if M-+ / M-\.
 215            and M-- and keypad + / - */
 216         gboolean alternate_plus_minus;
 217     } tty;
 218 
 219     struct
 220     {
 221         // Set when cd symlink following is desirable (bash mode)
 222         gboolean cd_symlinks;
 223 
 224         // Preallocate space before file copying
 225         gboolean preallocate_space;
 226 
 227         // Use COW file cloning on supported filesystems
 228         gboolean file_cloning;
 229     } vfs;
 230 } mc_global_t;
 231 
 232 /*** global variables defined in .c file *********************************************************/
 233 
 234 extern mc_global_t mc_global;
 235 
 236 /*** declarations of public functions ************************************************************/
 237 
 238 char *mc_get_package_copyright (void);
 239 
 240 /*** inline functions ****************************************************************************/
 241 #endif

/*   */