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 stop_async_timeouts(void);
  75 void start_async_timeouts(void);
  76 void slow_down_interrupts(void);
  77 void speed_up_interrupts(void);
  78 void init_poll_for_quit(void);
  79 void reset_poll_for_quit(void);
  80
  81 /* Used so that signals can break out of system calls that aren't
  82    naturally interruptible. */
  83
  84 extern JMP_BUF break_system_call_jump;
  85 extern volatile int can_break_system_calls;
  86
  87 ssize_t sys_write_1(int fildes, const void *buf, size_t nbyte, int allow_quit);
  88 ssize_t sys_read_1(int fildes, void *buf, size_t nbyte, int allow_quit);
  89
  90 /* Call these functions if you want to change some terminal parameter --
  91    reset the console, change the parameter, and init it again. */
  92 void init_one_console(struct console *c);
  93 void reset_one_console(struct console *c);
  94 void init_one_device(struct device *d);
  95 void reset_one_device(struct device *d);
  96
  97 /* Prepare all terminals for exiting Emacs; move the cursor to the
  98    bottom of the frame, turn off special modes, etc.  Called at exit.
  99    This calls reset_one_console() on all consoles and does some other
 100    stuff (e.g. fix the foreground pgroup). */
 101
 102 void reset_all_consoles(void);
 103
 104 /* Call these functions if you are going to temporarily exit back to
 105    the shell (e.g. when suspending).  This calls reset_one_console()
 106    on the initial console and does some other stuff (e.g. fix the
 107    foreground pgroup). */
 108
 109 void reset_initial_console(void);
 110 void reinit_initial_console(void);
 111
 112 /* We muck around with our process group.  This function needs
 113    to be called at startup.  The rest of the mucking is done as
 114    part of the functions reset_all_consoles(), reset_initial_console(),
 115    and reinit_initial_console(). */
 116
 117 void init_process_group(void);
 118 void munge_tty_process_group(void);
 119 void unmunge_tty_process_group(void);
 120
 121 void disconnect_controlling_terminal(void);
 122
 123 /* Return nonzero if safe to use tabs in output.
 124    At the time this is called, init_sys_modes has not been done yet.  */
 125 int tabs_safe_p(struct device *d);
 126
 127 /* Get terminal size from system.
 128    If zero or a negative number is stored, the value is not valid.  */
 129 void get_tty_device_size(struct device *d, int *widthp, int *heightp);
 130 /* Set the logical window size associated with descriptor FD */
 131 int set_window_size(int fd, int height, int width);
 132
 133 /* Set up the proper status flags for use of a pty.  */
 134 void setup_pty(int fd);
 135
 136 /* Return the address of the start of the text segment prior to unexec. */
 137 char *start_of_text(void);
 138 /* Return the address of the start of the data segment prior to unexec. */
 139 void *start_of_data(void);
 140 /* Return the address of the end of the text segment prior to unexec. */
 141 char *end_of_text(void);
 142 /* Return the address of the end of the data segment prior to unexec. */
 143 char *end_of_data(void);
 144
 145 /* Get_system_name returns as its value a string for system-name to return. */
 146 void init_system_name(void);
 147
 148 #ifndef HAVE_GETCWD
 149 char *getcwd(char *pathname, size_t size);
 150 #endif
 151
 152 #ifndef HAVE_RENAME
 153 int rename(const char *from, const char *to);
 154 #endif
 155
 156 #ifndef HAVE_DUP2
 157 int dup2(int oldd, int newd);
 158 #endif
 159
 160 #ifndef HAVE_STRERROR
 161 /* X11R6 defines strerror as a macro */
 162 # ifdef strerror
 163 # undef strerror
 164 # endif
 165 const char *strerror(int);
 166 #endif
 167
 168 int interruptible_open(const char *path, int oflag, int mode);
 169
 170 #ifndef HAVE_H_ERRNO
 171 extern int h_errno;
 172 #endif
 173
 174 #ifdef HAVE_REALPATH
 175 #define xrealpath realpath
 176 #else
 177 char *xrealpath(const char *path, char restrict resolved_path[]);
 178 #endif
 179
 180 extern_inline size_t xmin_size_t(size_t a, size_t b);
 181 extern_inline void x__dirname(char *restrict res, const char *file, size_t len);
 182 extern_inline size_t x__dirlen(const char *file, size_t len);
 183 extern_inline char *xdirname(const char *file);
 184
 185 \f
 186 /* str funs */
 187 /* thought these were defined already :O */
 188 #define xstrlen         strlen
 189 #define xstrcmp         strcmp
 190 #define xstrcat         strcat
 191 #define xstrncmp        strncmp
 192 #define xstrncpy        strncpy
 193 #define xstrncat        strncat
 194 #if defined HAVE_STPCPY
 195 # define xstpcpy        stpcpy
 196 #else
 197 extern_inline char*
 198 xstpcpy(char *target, const char *source)
 199         __attribute__((always_inline));
 200 extern_inline char*
 201 xstpcpy(char *target, const char *source)
 202 {
 203         char *p = target;
 204         size_t len = xstrlen(source);
 205
 206         strcpy(target, source);
 207         p += len;
 208         return p;
 209 }
 210 #endif  /* !HAVE_STPCPY */
 211 #if defined HAVE_STPNCPY
 212 # define xstpncpy       stpncpy
 213 #else
 214 extern_inline char*
 215 xstpncpy(char *target, const char *source, size_t len)
 216         __attribute__((always_inline));
 217 extern_inline char*
 218 xstpncpy(char *target, const char *source, size_t len)
 219 {
 220         char *p = target;
 221         strncpy(target, source, len);
 222         p += len;
 223         return p;
 224 }
 225 #endif  /* !HAVE_STPNCPY */
 226
 227 #define xmemcmp         memcmp
 228 #define xmemcpy         memcpy
 229
 230 extern_inline size_t
 231 xmin_size_t(size_t a, size_t b)
 232 {
 233         if (a < b) {
 234                 return a;
 235         } else {
 236                 return b;
 237         }
 238 }
 239
 240 \f
 241 /* big dirname magic, some of it stolen from dirname.c from coreutils 6.9 */
 242 /* POSIX says:
 243  | The dirname() function may modify the string pointed to by path, and
 244  | may return a pointer to static storage that may then be overwritten
 245  | by subsequent calls to dirname().
 246  */
 247 #ifdef HAVE_LIBGEN_H
 248 #include <libgen.h>
 249 #endif
 250
 251 #ifndef DIRECTORY_SEPARATOR
 252 #define DIRECTORY_SEPARATOR '/'
 253 #endif
 254 #define FILE_SYSTEM_PREFIX_LEN(f)       0
 255
 256 #ifndef ISSLASH
 257 #define ISSLASH(C)      ((C) == DIRECTORY_SEPARATOR)
 258 #endif
 259
 260 extern_inline size_t
 261 x__dirlen(const char *file, size_t len)
 262 {
 263         /* return the offset of the last / in FILE */
 264         size_t pre = FILE_SYSTEM_PREFIX_LEN(file);
 265         char p;
 266
 267         /* just start at the back and walk frontwards */
 268         for (p = file[--len]; len > pre; p--, --len) {
 269                 if (ISSLASH(p)) {
 270                         return len;
 271                 }
 272         }
 273         return len;
 274 }
 275
 276 #if defined(HAVE_DIRNAME) && defined(DIRNAME_SIDE_EFFECT)
 277 extern_inline void
 278 x__dirname(char *restrict res, const char *file, size_t len)
 279 {
 280         /* assumes res is malloc'd of size LEN */
 281         xstrncpy(res, file, len);
 282         dirname(res);
 283         return;
 284 }
 285 #elif defined(HAVE_DIRNAME) && !defined(DIRNAME_ACCEPTS_PROTMEM)
 286 extern_inline void
 287 x__dirname(char *restrict res, const char *file, size_t len)
 288 {
 289         /* assumes res is malloc'd of size LEN */
 290         char *result;
 291         xstrncpy(res, file, len);
 292         /* if we were using side effects we woulda matched the above cond */
 293         result = dirname(res);
 294         xstrncpy(res, result, xmin_size_t(len, xstrlen(result)));
 295         return;
 296 }
 297 #elif defined(HAVE_DIRNAME)
 298 extern_inline void
 299 x__dirname(char *restrict res, const char *file, size_t len)
 300 {
 301         /* assumes res is malloc'd of size LEN */
 302         char *result = dirname(res);
 303         xstrncpy(res, result, xmin_size_t(len, xstrlen(result)));
 304         return;
 305 }
 306 #endif
 307
 308 extern_inline char*
 309 xdirname(const char *file)
 310 {
 311         size_t len = xstrlen(file);
 312         char *res = xmalloc_atomic(len);
 313
 314         x__dirname(res, file, len);
 315         return res;
 316 }
 317
 318 #endif  /* INCLUDED_sysdep_h_ */