src/w32.h

#ifndef EMACS_W32_H
#define EMACS_W32_H

/* Support routines for the NT version of Emacs.
   Copyright (C) 1994, 2001-2013 Free Software Foundation, Inc.

This file is part of GNU Emacs.

GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */

#ifdef CYGWIN
#error "w32.h is not compatible with Cygwin"
#endif

#include <windows.h>


/* File descriptor set emulation.  */

/* MSVC runtime library has limit of 64 descriptors by default */
#define FD_SETSIZE  64
typedef struct {
  unsigned int bits[FD_SETSIZE / 32];
} fd_set;

/* standard access macros */
#define FD_SET(n, p) \
  do { \
    if ((n) < FD_SETSIZE) { \
      (p)->bits[(n)/32] |= (1 << (n)%32); \
    } \
  } while (0)
#define FD_CLR(n, p) \
  do { \
    if ((n) < FD_SETSIZE) { \
      (p)->bits[(n)/32] &= ~(1 << (n)%32); \
    } \
  } while (0)
#define FD_ISSET(n, p) ((n) < FD_SETSIZE ? ((p)->bits[(n)/32] & (1 << (n)%32)) : 0)
#define FD_ZERO(p) memset((p), 0, sizeof(fd_set))

#define SELECT_TYPE fd_set

/* ------------------------------------------------------------------------- */

/* child_process.status values */
enum {
  STATUS_READ_ERROR = -1,
  STATUS_READ_READY,
  STATUS_READ_IN_PROGRESS,
  STATUS_READ_FAILED,
  STATUS_READ_SUCCEEDED,
  STATUS_READ_ACKNOWLEDGED
};

/* This structure is used for both pipes and sockets; for
   a socket, the process handle in pi is NULL. */
typedef struct _child_process
{
  /* File descriptor for sockets and serial port connections, and for
     reading output from async subprocesses; otherwise -1.  */
  int                 fd;
  /* PID for subprocess, either async or not; otherwise -1.  */
  int                 pid;
  /* Handle to an event object that is signaled when a read operation
     is completed, either successfully (in which case there're indeed
     "characters available") or not.  Used by sys_select to wait for
     output from subprocesses or socket/serial connections.  */
  HANDLE              char_avail;
  /* Handle to an event that is signaled to wake up the reader thread
     and tell it to try reading more output from a subprocess.  */
  HANDLE              char_consumed;
  /* Handle to the reader thread to read output from a subprocess or a
     socket or a comm port.  */
  HANDLE              thrd;
  /* Handle to the console window of a subprocess.  Used to forcibly
     terminate it by sys_kill.  */
  HWND                hwnd;
  /* Information about subprocess returned by CreateProcess.  Includes
     handles to the subprocess and its primary thread, and the
     corresponding process ID and thread ID numbers.  The PID is
     mirrored by the 'pid' member above.  The process handle is used
     to wait on it.  */
  PROCESS_INFORMATION procinfo;
  /* Status of subprocess/connection and of reading its output.  For
     values, see the enumeration above.  */
  volatile int        status;
  /* Holds a single character read by _sys_read_ahead, when a
     subprocess has some output ready.  */
  char                chr;
  /* Used for async read operations on serial comm ports.  */
  OVERLAPPED          ovl_read;
  /* Used for async write operations on serial comm ports.  */
  OVERLAPPED          ovl_write;
  /* Input file, if any, for this subprocess.  Should only be non-NULL
     for async subprocesses.  */
  char               *input_file;
  /* If non-zero, the subprocess input file is temporary and should be
     deleted when the subprocess exits.  */
  int                 pending_deletion;
} child_process;

#define MAXDESC FD_SETSIZE
#define MAX_CHILDREN  MAXDESC/2
#define CHILD_ACTIVE(cp) ((cp)->char_avail != NULL)

/* parallel array of private info on file handles */
typedef struct
{
  unsigned         flags;
  HANDLE           hnd;
  child_process *  cp;
} filedesc;

extern filedesc fd_info [ MAXDESC ];

/* fd_info flag definitions */
#define FILE_READ               0x0001
#define FILE_WRITE              0x0002
#define FILE_LISTEN		0x0004
#define FILE_BINARY             0x0010
#define FILE_LAST_CR            0x0020
#define FILE_AT_EOF             0x0040
#define FILE_SEND_SIGCHLD       0x0080
#define FILE_PIPE               0x0100
#define FILE_SOCKET             0x0200
#define FILE_NDELAY             0x0400
#define FILE_SERIAL             0x0800

extern child_process * new_child (void);
extern void delete_child (child_process *cp);

/* ------------------------------------------------------------------------- */

/* Equivalent of strerror for W32 error codes.  */
extern char * w32_strerror (int error_no);

/* Validate a pointer.  */
extern int w32_valid_pointer_p (void *, int);

/* Get long (aka "true") form of file name, if it exists.  */
extern BOOL w32_get_long_filename (char * name, char * buf, int size);

/* Prepare our standard handles for proper inheritance by child processes.  */
extern void prepare_standard_handles (int in, int out,
				      int err, HANDLE handles[4]);

/* Reset our standard handles to their original state.  */
extern void reset_standard_handles (int in, int out,
				    int err, HANDLE handles[4]);

/* Return the string resource associated with KEY of type TYPE.  */
extern LPBYTE w32_get_resource (char * key, LPDWORD type);

extern void init_ntproc (int);
extern void term_ntproc (int);
extern void globals_of_w32 (void);

extern void term_timers (void);
extern void init_timers (void);

extern int _sys_read_ahead (int fd);
extern int _sys_wait_accept (int fd);

extern Lisp_Object QCloaded_from;
extern HMODULE w32_delayed_load (Lisp_Object);

extern void init_environment (char **);
extern void check_windows_init_file (void);
extern void syms_of_ntproc (void);
extern void syms_of_ntterm (void);
extern void dostounix_filename (register char *, int);
extern void unixtodos_filename (register char *);
extern BOOL init_winsock (int load_now);
extern void srandom (int);
extern int random (void);

extern int fchmod (int, mode_t);
extern int sys_rename_replace (char const *, char const *, BOOL);
extern int pipe2 (int *, int);

extern void set_process_dir (char *);
extern int sys_spawnve (int, char *, char **, char **);
extern void register_child (pid_t, int);
extern void record_infile (pid_t, char *);
extern void record_pending_deletion (char *);

extern void sys_sleep (int);
extern int sys_link (const char *, const char *);


#ifdef HAVE_GNUTLS
#include <gnutls/gnutls.h>

/* GnuTLS pull (read from remote) interface.  */
extern ssize_t emacs_gnutls_pull (gnutls_transport_ptr_t p,
                                  void* buf, size_t sz);

/* GnuTLS push (write to remote) interface.  */
extern ssize_t emacs_gnutls_push (gnutls_transport_ptr_t p,
                                  const void* buf, size_t sz);
#endif /* HAVE_GNUTLS */

#endif /* EMACS_W32_H */
Commit	Line	Data
	1	#ifndef EMACS_W32_H
	2	#define EMACS_W32_H
	3
	4	/* Support routines for the NT version of Emacs.
	5	Copyright (C) 1994, 2001-2013 Free Software Foundation, Inc.
	6
	7	This file is part of GNU Emacs.
	8
	9	GNU Emacs 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	GNU Emacs 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
	21
	22	#ifdef CYGWIN
	23	#error "w32.h is not compatible with Cygwin"
	24	#endif
	25
	26	#include <windows.h>
	27
	28
	29	/* File descriptor set emulation. */
	30
	31	/* MSVC runtime library has limit of 64 descriptors by default */
	32	#define FD_SETSIZE 64
	33	typedef struct {
	34	unsigned int bits[FD_SETSIZE / 32];
	35	} fd_set;
	36
	37	/* standard access macros */
	38	#define FD_SET(n, p) \
	39	do { \
	40	if ((n) < FD_SETSIZE) { \
	41	(p)->bits[(n)/32] \|= (1 << (n)%32); \
	42	} \
	43	} while (0)
	44	#define FD_CLR(n, p) \
	45	do { \
	46	if ((n) < FD_SETSIZE) { \
	47	(p)->bits[(n)/32] &= ~(1 << (n)%32); \
	48	} \
	49	} while (0)
	50	#define FD_ISSET(n, p) ((n) < FD_SETSIZE ? ((p)->bits[(n)/32] & (1 << (n)%32)) : 0)
	51	#define FD_ZERO(p) memset((p), 0, sizeof(fd_set))
	52
	53	#define SELECT_TYPE fd_set
	54
	55	/* ------------------------------------------------------------------------- */
	56
	57	/* child_process.status values */
	58	enum {
	59	STATUS_READ_ERROR = -1,
	60	STATUS_READ_READY,
	61	STATUS_READ_IN_PROGRESS,
	62	STATUS_READ_FAILED,
	63	STATUS_READ_SUCCEEDED,
	64	STATUS_READ_ACKNOWLEDGED
	65	};
	66
	67	/* This structure is used for both pipes and sockets; for
	68	a socket, the process handle in pi is NULL. */
	69	typedef struct _child_process
	70	{
	71	/* File descriptor for sockets and serial port connections, and for
	72	reading output from async subprocesses; otherwise -1. */
	73	int fd;
	74	/* PID for subprocess, either async or not; otherwise -1. */
	75	int pid;
	76	/* Handle to an event object that is signaled when a read operation
	77	is completed, either successfully (in which case there're indeed
	78	"characters available") or not. Used by sys_select to wait for
	79	output from subprocesses or socket/serial connections. */
	80	HANDLE char_avail;
	81	/* Handle to an event that is signaled to wake up the reader thread
	82	and tell it to try reading more output from a subprocess. */
	83	HANDLE char_consumed;
	84	/* Handle to the reader thread to read output from a subprocess or a
	85	socket or a comm port. */
	86	HANDLE thrd;
	87	/* Handle to the console window of a subprocess. Used to forcibly
	88	terminate it by sys_kill. */
	89	HWND hwnd;
	90	/* Information about subprocess returned by CreateProcess. Includes
	91	handles to the subprocess and its primary thread, and the
	92	corresponding process ID and thread ID numbers. The PID is
	93	mirrored by the 'pid' member above. The process handle is used
	94	to wait on it. */
	95	PROCESS_INFORMATION procinfo;
	96	/* Status of subprocess/connection and of reading its output. For
	97	values, see the enumeration above. */
	98	volatile int status;
	99	/* Holds a single character read by _sys_read_ahead, when a
	100	subprocess has some output ready. */
	101	char chr;
	102	/* Used for async read operations on serial comm ports. */
	103	OVERLAPPED ovl_read;
	104	/* Used for async write operations on serial comm ports. */
	105	OVERLAPPED ovl_write;
	106	/* Input file, if any, for this subprocess. Should only be non-NULL
	107	for async subprocesses. */
	108	char *input_file;
	109	/* If non-zero, the subprocess input file is temporary and should be
	110	deleted when the subprocess exits. */
	111	int pending_deletion;
	112	} child_process;
	113
	114	#define MAXDESC FD_SETSIZE
	115	#define MAX_CHILDREN MAXDESC/2
	116	#define CHILD_ACTIVE(cp) ((cp)->char_avail != NULL)
	117
	118	/* parallel array of private info on file handles */
	119	typedef struct
	120	{
	121	unsigned flags;
	122	HANDLE hnd;
	123	child_process * cp;
	124	} filedesc;
	125
	126	extern filedesc fd_info [ MAXDESC ];
	127
	128	/* fd_info flag definitions */
	129	#define FILE_READ 0x0001
	130	#define FILE_WRITE 0x0002
	131	#define FILE_LISTEN 0x0004
	132	#define FILE_BINARY 0x0010
	133	#define FILE_LAST_CR 0x0020
	134	#define FILE_AT_EOF 0x0040
	135	#define FILE_SEND_SIGCHLD 0x0080
	136	#define FILE_PIPE 0x0100
	137	#define FILE_SOCKET 0x0200
	138	#define FILE_NDELAY 0x0400
	139	#define FILE_SERIAL 0x0800
	140
	141	extern child_process * new_child (void);
	142	extern void delete_child (child_process *cp);
	143
	144	/* ------------------------------------------------------------------------- */
	145
	146	/* Equivalent of strerror for W32 error codes. */
	147	extern char * w32_strerror (int error_no);
	148
	149	/* Validate a pointer. */
	150	extern int w32_valid_pointer_p (void *, int);
	151
	152	/* Get long (aka "true") form of file name, if it exists. */
	153	extern BOOL w32_get_long_filename (char * name, char * buf, int size);
	154
	155	/* Prepare our standard handles for proper inheritance by child processes. */
	156	extern void prepare_standard_handles (int in, int out,
	157	int err, HANDLE handles[4]);
	158
	159	/* Reset our standard handles to their original state. */
	160	extern void reset_standard_handles (int in, int out,
	161	int err, HANDLE handles[4]);
	162
	163	/* Return the string resource associated with KEY of type TYPE. */
	164	extern LPBYTE w32_get_resource (char * key, LPDWORD type);
	165
	166	extern void init_ntproc (int);
	167	extern void term_ntproc (int);
	168	extern void globals_of_w32 (void);
	169
	170	extern void term_timers (void);
	171	extern void init_timers (void);
	172
	173	extern int _sys_read_ahead (int fd);
	174	extern int _sys_wait_accept (int fd);
	175
	176	extern Lisp_Object QCloaded_from;
	177	extern HMODULE w32_delayed_load (Lisp_Object);
	178
	179	extern void init_environment (char **);
	180	extern void check_windows_init_file (void);
	181	extern void syms_of_ntproc (void);
	182	extern void syms_of_ntterm (void);
	183	extern void dostounix_filename (register char *, int);
	184	extern void unixtodos_filename (register char *);
	185	extern BOOL init_winsock (int load_now);
	186	extern void srandom (int);
	187	extern int random (void);
	188
	189	extern int fchmod (int, mode_t);
	190	extern int sys_rename_replace (char const , char const , BOOL);
	191	extern int pipe2 (int *, int);
	192
	193	extern void set_process_dir (char *);
	194	extern int sys_spawnve (int, char , char , char *);
	195	extern void register_child (pid_t, int);
	196	extern void record_infile (pid_t, char *);
	197	extern void record_pending_deletion (char *);
	198
	199	extern void sys_sleep (int);
	200	extern int sys_link (const char , const char );
	201
	202
	203
	204	#ifdef HAVE_GNUTLS
	205	#include <gnutls/gnutls.h>
	206
	207	/* GnuTLS pull (read from remote) interface. */
	208	extern ssize_t emacs_gnutls_pull (gnutls_transport_ptr_t p,
	209	void* buf, size_t sz);
	210
	211	/* GnuTLS push (write to remote) interface. */
	212	extern ssize_t emacs_gnutls_push (gnutls_transport_ptr_t p,
	213	const void* buf, size_t sz);
	214	#endif /* HAVE_GNUTLS */
	215
	216	#endif /* EMACS_W32_H */