cgit.sxemacs.org Git - sxemacs/blob - src/sysdep.h

   1 /*** System-dependent prototypes
   2  *
   3  *  Copyright (C) 2008  Sebastian Freundt
   4  *  Copyright (C) 1985, 1993, 1994 Free Software Foundation, Inc.
   5  *
   6  *
   7  * This file is part of SXEmacs
   8  *
   9  * SXEmacs is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * SXEmacs is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  ***/
  23
  24
  25 /* Synched up with: FSF 19.30.  Split out of sysdep.c/emacs.c. */
  26
  27 #ifndef INCLUDED_sysdep_h_
  28 #define INCLUDED_sysdep_h_
  29
  30 #include <setjmp.h>
  31
  32 extern char **environ;
  33
  34 #ifdef PDUMP
  35 int pdump_read_file(char **pdump_start_pos, size_t * pdump_length);
  36 #endif
  37
  38 int eight_bit_tty(struct device *d);
  39
  40 void stuff_char(struct console *con, int c);
  41
  42 void init_baud_rate(struct device *d);
  43
  44 void set_exclusive_use(int fd);
  45
  46 void set_descriptor_non_blocking(int fd);
  47
  48 void wait_without_blocking(void);
  49
  50 int get_pty_max_bytes(int fd);
  51 Bufbyte get_eof_char(int fd);
  52
  53 /* Wait for subprocess with process id `pid' to terminate and
  54    make sure it will get eliminated (not remain forever as a zombie) */
  55 void wait_for_termination(int pid);
  56
  57 /* flush any pending output
  58  * (may flush input as well; it does not matter the way we use it)
  59  */
  60 void flush_pending_output(int channel);
  61
  62 void child_setup_tty(int out);
  63
  64 /* Suspend the Emacs process; give terminal to its superior.  */
  65 void sys_suspend(void);
  66 /* Suspend a process if possible; give terminal to its superior. */
  67 void sys_suspend_process(int process);
  68
  69 void request_sigio(void);
  70 void unrequest_sigio(void);
  71
  72 void stop_interrupts(void);
  73 void start_interrupts(void);
  74 void slow_down_interrupts(void);
  75 void speed_up_interrupts(void);
  76 void init_poll_for_quit(void);
  77 void reset_poll_for_quit(void);
  78
  79 /* Used so that signals can break out of system calls that aren't
  80    naturally interruptible. */
  81
  82 extern JMP_BUF break_system_call_jump;
  83 extern volatile int can_break_system_calls;
  84
  85 ssize_t sys_write_1(int fildes, const void *buf, size_t nbyte, int allow_quit);
  86 ssize_t sys_read_1(int fildes, void *buf, size_t nbyte, int allow_quit);
  87
  88 /* Call these functions if you want to change some terminal parameter --
  89    reset the console, change the parameter, and init it again. */
  90 void init_one_console(struct console *c);
  91 void reset_one_console(struct console *c);
  92 void init_one_device(struct device *d);
  93 void reset_one_device(struct device *d);
  94
  95 /* Prepare all terminals for exiting Emacs; move the cursor to the
  96    bottom of the frame, turn off special modes, etc.  Called at exit.
  97    This calls reset_one_console() on all consoles and does some other
  98    stuff (e.g. fix the foreground pgroup). */
  99
 100 void reset_all_consoles(void);
 101
 102 /* Call these functions if you are going to temporarily exit back to
 103    the shell (e.g. when suspending).  This calls reset_one_console()
 104    on the initial console and does some other stuff (e.g. fix the
 105    foreground pgroup). */
 106
 107 void reset_initial_console(void);
 108 void reinit_initial_console(void);
 109
 110 /* We muck around with our process group.  This function needs
 111    to be called at startup.  The rest of the mucking is done as
 112    part of the functions reset_all_consoles(), reset_initial_console(),
 113    and reinit_initial_console(). */
 114
 115 void init_process_group(void);
 116 void munge_tty_process_group(void);
 117 void unmunge_tty_process_group(void);
 118
 119 void disconnect_controlling_terminal(void);
 120
 121 /* Return nonzero if safe to use tabs in output.
 122    At the time this is called, init_sys_modes has not been done yet.  */
 123 int tabs_safe_p(struct device *d);
 124
 125 /* Get terminal size from system.
 126    If zero or a negative number is stored, the value is not valid.  */
 127 void get_tty_device_size(struct device *d, int *widthp, int *heightp);
 128 /* Set the logical window size associated with descriptor FD */
 129 int set_window_size(int fd, int height, int width);
 130
 131 /* Set up the proper status flags for use of a pty.  */
 132 void setup_pty(int fd);
 133
 134 /* Return the address of the start of the text segment prior to unexec. */
 135 char *start_of_text(void);
 136 /* Return the address of the start of the data segment prior to unexec. */
 137 void *start_of_data(void);
 138 /* Return the address of the end of the text segment prior to unexec. */
 139 char *end_of_text(void);
 140 /* Return the address of the end of the data segment prior to unexec. */
 141 char *end_of_data(void);
 142
 143 /* Get_system_name returns as its value a string for system-name to return. */
 144 void init_system_name(void);
 145
 146 #ifndef HAVE_GETCWD
 147 char *getcwd(char *pathname, size_t size);
 148 #endif
 149
 150 #ifndef HAVE_RENAME
 151 int rename(const char *from, const char *to);
 152 #endif
 153
 154 #ifndef HAVE_DUP2
 155 int dup2(int oldd, int newd);
 156 #endif
 157
 158 #ifndef HAVE_STRERROR
 159 /* X11R6 defines strerror as a macro */
 160 # ifdef strerror
 161 # undef strerror
 162 # endif
 163 const char *strerror(int);
 164 #endif
 165
 166 int interruptible_open(const char *path, int oflag, int mode);
 167
 168 #ifndef HAVE_H_ERRNO
 169 extern int h_errno;
 170 #endif
 171
 172 #ifdef HAVE_REALPATH
 173 #define xrealpath realpath
 174 #else
 175 char *xrealpath(const char *path, char restrict resolved_path[]);
 176 #endif
 177
 178 extern_inline size_t xmin_size_t(size_t a, size_t b);
 179 extern_inline void x__dirname(char *restrict res, const char *file, size_t len);
 180 extern_inline size_t x__dirlen(const char *file, size_t len);
 181 extern_inline char *xdirname(const char *file);
 182
 183 \f
 184 /* str funs */
 185 /* thought these were defined already :O */
 186 #define xstrlen         strlen
 187 #define xstrcmp         strcmp
 188 #define xstrcat         strcat
 189 #define xstrncmp        strncmp
 190 #define xstrncpy        strncpy
 191 #define xstrncat        strncat
 192 #if defined HAVE_STPCPY
 193 # define xstpcpy        stpcpy
 194 #else
 195 extern_inline char*
 196 xstpcpy(char *target, const char *source)
 197         __attribute__((always_inline));
 198 extern_inline char*
 199 xstpcpy(char *target, const char *source)
 200 {
 201         char *p = target;
 202         size_t len = xstrlen(source);
 203
 204         strcpy(target, source);
 205         p += len;
 206         return p;
 207 }
 208 #endif  /* !HAVE_STPCPY */
 209 #if defined HAVE_STPNCPY
 210 # define xstpncpy       stpncpy
 211 #else
 212 extern_inline char*
 213 xstpncpy(char *target, const char *source, size_t len)
 214         __attribute__((always_inline));
 215 extern_inline char*
 216 xstpncpy(char *target, const char *source, size_t len)
 217 {
 218         char *p = target;
 219         strncpy(target, source, len);
 220         p += len;
 221         return p;
 222 }
 223 #endif  /* !HAVE_STPNCPY */
 224
 225 #define xmemcmp         memcmp
 226 #define xmemcpy         memcpy
 227
 228 extern_inline size_t
 229 xmin_size_t(size_t a, size_t b)
 230 {
 231         if (a < b) {
 232                 return a;
 233         } else {
 234                 return b;
 235         }
 236 }
 237
 238 \f
 239 /* big dirname magic, some of it stolen from dirname.c from coreutils 6.9 */
 240 /* POSIX says:
 241  | The dirname() function may modify the string pointed to by path, and
 242  | may return a pointer to static storage that may then be overwritten
 243  | by subsequent calls to dirname().
 244  */
 245 #ifdef HAVE_LIBGEN_H
 246 #include <libgen.h>
 247 #endif
 248
 249 #ifndef DIRECTORY_SEPARATOR
 250 #define DIRECTORY_SEPARATOR '/'
 251 #endif
 252 #define FILE_SYSTEM_PREFIX_LEN(f)       0
 253
 254 #ifndef ISSLASH
 255 #define ISSLASH(C)      ((C) == DIRECTORY_SEPARATOR)
 256 #endif
 257
 258 extern_inline size_t
 259 x__dirlen(const char *file, size_t len)
 260 {
 261         /* return the offset of the last / in FILE */
 262         size_t pre = FILE_SYSTEM_PREFIX_LEN(file);
 263         char p;
 264
 265         /* just start at the back and walk frontwards */
 266         for (p = file[--len]; len > pre; p--, --len) {
 267                 if (ISSLASH(p)) {
 268                         return len;
 269                 }
 270         }
 271         return len;
 272 }
 273
 274 #if defined(HAVE_DIRNAME) && defined(DIRNAME_SIDE_EFFECT)
 275 extern_inline void
 276 x__dirname(char *restrict res, const char *file, size_t len)
 277 {
 278         /* assumes res is malloc'd of size LEN */
 279         xstrncpy(res, file, len);
 280         dirname(res);
 281         return;
 282 }
 283 #elif defined(HAVE_DIRNAME) && !defined(DIRNAME_ACCEPTS_PROTMEM)
 284 extern_inline void
 285 x__dirname(char *restrict res, const char *file, size_t len)
 286 {
 287         /* assumes res is malloc'd of size LEN */
 288         char *result;
 289         xstrncpy(res, file, len);
 290         /* if we were using side effects we woulda matched the above cond */
 291         result = dirname(res);
 292         xstrncpy(res, result, xmin_size_t(len, xstrlen(result)));
 293         return;
 294 }
 295 #elif defined(HAVE_DIRNAME)
 296 extern_inline void
 297 x__dirname(char *restrict res, const char *file, size_t len)
 298 {
 299         /* assumes res is malloc'd of size LEN */
 300         char *result = dirname(res);
 301         xstrncpy(res, result, xmin_size_t(len, xstrlen(result)));
 302         return;
 303 }
 304 #endif
 305
 306 extern_inline char*
 307 xdirname(const char *file)
 308 {
 309         size_t len = xstrlen(file);
 310         char *res = xmalloc_atomic(len);
 311
 312         x__dirname(res, file, len);
 313         return res;
 314 }
 315
 316 #endif  /* INCLUDED_sysdep_h_ */