Apply new glyph-image conventions for `ucs@*', `adobe-japan1-*',
[chise/xemacs-chise.git.1] / lib-src / gnuserv.h
1 /* -*-C-*-
2
3  Header file for the GNU Emacs server and client C code.
4
5  This file is part of GNU Emacs.
6
7  Copying is permitted under those conditions described by the GNU
8  General Public License.
9
10  Copyright (C) 1989 Free Software Foundation, Inc.
11
12  Author: Andy Norman (ange@hplb.hpl.hp.com), based on 
13          'etc/server.c' and 'etc/emacsclient.c' from the 18.52 GNU
14          Emacs distribution.
15
16  Please mail bugs and suggestions to the author at the above address.
17 */
18
19 /* HISTORY 
20  * 11-Nov-1990          bristor@simba   
21  *    Added EOT stuff.
22  */
23
24 /*
25  * This file incorporates new features added by Bob Weiner <weiner@mot.com>,
26  * Darrell Kindred <dkindred@cmu.edu> and Arup Mukherjee <arup@cmu.edu>.
27  * Please see the note at the end of the README file for details.
28  *
29  * (If gnuserv came bundled with your emacs, the README file is probably
30  * ../etc/gnuserv.README relative to the directory containing this file)
31  */
32
33 #define GNUSERV_VERSION "3.12"
34
35 /* Note: this setting can cause client-server connection failure if the
36  * value of TMPDIR is not shared by client and server at run-time.
37  */
38 #define USE_TMPDIR
39
40 #define PATCHLEVEL 2
41
42 #define NO_SHORTNAMES
43 /* gnuserv should not be compiled using SOCKS */
44 #define DO_NOT_SOCKSIFY
45 #define DONT_ENCAPSULATE
46 #include <config.h>
47 #undef signal
48
49 /* Define the communication method between server and clients:
50  *   You can have either or both kinds of sockets, but you can't mix
51  *   sockets with sysv ipc
52  */
53
54
55 #define INTERNET_DOMAIN_SOCKETS
56 #ifdef HAVE_SYS_UN_H
57 #define UNIX_DOMAIN_SOCKETS 
58 /* #define SYSV_IPC  */
59 #endif
60
61 /*
62  * Define additional authentication protocols to be used. These methods will
63  * be tried before falling back to the default gnuserv protocol (based on
64  * the GNU_SECURE environment variable). Currently, only MIT-MAGIC-COOKIE-1
65  * is also supported.
66  *
67  * Comment out the next line(s) if you don't want to enable the
68  * appropriate authentication protocol.
69  */
70
71 #if defined (HAVE_XAUTH)
72 #define AUTH_MAGIC_COOKIE
73 #endif /* HAVE_XAUTH */
74
75 /*
76  * stuff related to supporting MIT-MAGIC-COOKIE-1
77  */
78
79 #define MCOOKIE_SCREEN "999"     /* screen # to use as the gnuserv cookie */
80 #define MCOOKIE_NAME   "MAGIC-1" /* authentication protocol name */
81 #define MCOOKIE_X_NAME "MIT-MAGIC-COOKIE-1"  /* as needed by X */
82
83
84 #define DEFAUTH_NAME "GNU-SECURE"  /* name of default auth protocol */
85 #define AUTH_TIMEOUT  15           /* # seconds to wait for auth data */
86 #define AUTH_NAMESZ   15           /* max allows auth protocol name size */
87
88
89 /*
90  * Pick a default communication scheme, if none was specified.
91  */
92
93 #if !defined(SYSV_IPC) && !defined(UNIX_DOMAIN_SOCKETS) && !defined(INTERNET_DOMAIN_SOCKETS)
94
95 #ifdef HAVE_SYSVIPC
96 #define SYSV_IPC                /* SYSV systems use SYSV IPC by default */
97 #endif /* HAVE_SYSVIPC */
98
99 #ifdef BSD
100 #define UNIX_DOMAIN_SOCKETS     /* BSD systems use Unix Domain sockets by default */
101 #endif /* BSD */
102
103 #endif /* No communication method pre-defined */
104
105 #include <sys/types.h>
106 #include <sys/param.h>
107 #include <sys/stat.h>
108 #include <stdio.h>
109 #include <stdlib.h>
110 #include <string.h>
111 #include <signal.h>
112 #include <errno.h>
113
114 #ifdef HAVE_UNISTD_H
115 #include <unistd.h>
116 #endif
117
118 #ifdef HAVE_SYS_TIME_H
119 #include <sys/time.h>
120 #endif
121
122 /*
123  * If you are using SYSV_IPC, you might want to make the buffer size bigger
124  * since it limits the size of requests and responses. Don't make it bigger
125  * than your system's max message size though (usually a couple of k) or else
126  * msgsend will start failing. For sockets, using the system BUFSIZ is usually
127  * what you want. 
128  */
129
130 # define GSERV_BUFSZ BUFSIZ
131
132
133 #ifdef SYSV_IPC
134 #include <sys/ipc.h>
135 #include <sys/msg.h>
136
137 #define send_string(s,str) \
138   if (strlen(msgp->mtext) + strlen(str) < GSERV_BUFSZ) \
139      strcat(msgp->mtext,str); \
140   else \
141   { \
142     fprintf(stderr,"%s: not enough message buffer space\n",progname); \
143      exit(1); \
144   } \
145
146 #endif /* SYSV_IPC */
147
148 #if defined(INTERNET_DOMAIN_SOCKETS) || defined(UNIX_DOMAIN_SOCKETS)
149 #include <sys/socket.h>
150 #endif /* INTERNET_DOMAIN_SOCKETS || UNIX_DOMAIN_SOCKETS */
151
152 #ifdef INTERNET_DOMAIN_SOCKETS
153 #include <netdb.h>
154 #include <netinet/in.h>
155 #include <arpa/inet.h>
156 #define TABLE_SIZE 101          /* The number of entries in the hash table */
157 #define HASH(host) host         /* Rather simplistic hash function */
158 #define DEFAULT_PORT 21490      /* default port number to use is
159                                  * DEFAULT_PORT + uid */
160 #endif /* INTERNET_DOMAIN_SOCKETS */
161
162 #ifdef UNIX_DOMAIN_SOCKETS
163 #include <sys/un.h>
164 #define HIDE_UNIX_SOCKET        /* put the unix socket in a protected dir */
165 #endif /* UNIX_DOMAIN_SOCKETS */
166
167 /* On some platforms, we need to do the equivalent of "stty litout" to get
168  * characters like ^D to pass through to emacs.  This problem has only
169  * been observed under emacs18; fsf19 and lemacs are probably okay without it.
170  */
171 #ifndef DONT_USE_LITOUT
172 #if !defined(HAVE_TERMIO) && !defined(HAVE_TERMIOS) && !defined(VMS)
173 #if !defined(BSD4_1)
174 #define USE_LITOUT
175 #endif
176 #endif
177 #endif
178
179
180 #define HOSTNAMSZ 255           /* max size of a hostname */
181 #define REPLYSIZ 300            /* max size of reply from server to client */
182 #undef FALSE
183 #define FALSE 0
184 #undef TRUE
185 #define TRUE 1
186
187 extern char *optarg;
188 extern int optind;
189 extern char *progname;
190 extern char *tmpdir;
191
192 /* The casts shut Sun's compiler up and are safe in the context these
193    are actually used. */
194 #define max2(x,y) (((int) (x) > (int) (y)) ? (x) : (y))
195 #define min2(x,y) (((int) (x) < (int) (y)) ? (x) : (y))
196
197 #ifndef _NFILE            /* rough guess at maximum number of open files */
198 #define _NFILE 20
199 #endif
200
201 #define EOT_STR "\004"
202 #define EOT_CHR '\004'
203
204 /* connection types */
205 #define CONN_UNIX     0
206 #define CONN_INTERNET 1
207 #define CONN_IPC      2
208
209 /* function declarations */
210 int make_connection (char *hostarg, int portarg, int *s);
211 #ifdef SYSV_IPC
212 void disconnect_from_ipc_server();
213 #endif
214 #if defined(INTERNET_DOMAIN_SOCKETS) || defined(UNIX_DOMAIN_SOCKETS)
215 void send_string (int s, const char *msg);
216 void disconnect_from_server (int s, int echo);
217 int read_line (int s, char *dest);
218 #endif
219 #ifdef INTERNET_DOMAIN_SOCKETS
220 int internet_addr (char *host);
221 #endif