/* Client process that communicates with GNU Emacs acting as server.
- Copyright (C) 1986, 1987, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
- 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+ Copyright (C) 1986-1987, 1994, 1999-2011 Free Software Foundation, Inc.
This file is part of GNU Emacs.
along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
-#ifdef HAVE_CONFIG_H
#include <config.h>
-#endif
#ifdef WINDOWSNT
# include <stdlib.h>
# include <windows.h>
# include <commctrl.h>
+# include <io.h>
+# include <winsock2.h>
# define NO_SOCKETS_IN_FILE_SYSTEM
# define CLOSE_SOCKET closesocket
# define INITIALIZE() (initialize_sockets ())
+char *w32_getenv (char *);
+#define egetenv(VAR) w32_getenv(VAR)
+
#else /* !WINDOWSNT */
# include "syswait.h"
# ifdef HAVE_INET_SOCKETS
# include <netinet/in.h>
+# ifdef HAVE_SOCKETS
+# include <sys/types.h>
+# include <sys/socket.h>
+# include <sys/un.h>
+# endif /* HAVE_SOCKETS */
# endif
-
# include <arpa/inet.h>
# define INVALID_SOCKET -1
# define WCONTINUED 8
# endif
+#define egetenv(VAR) getenv(VAR)
+
#endif /* !WINDOWSNT */
#undef signal
#include <stdarg.h>
#include <ctype.h>
#include <stdio.h>
-#include "getopt.h"
-#ifdef HAVE_UNISTD_H
+#include <getopt.h>
#include <unistd.h>
-#endif
-#ifdef WINDOWSNT
-# include <io.h>
-#else /* not WINDOWSNT */
-# include <pwd.h>
-#endif /* not WINDOWSNT */
+#include <pwd.h>
#include <sys/stat.h>
-
#include <signal.h>
#include <errno.h>
-\f
-char *getenv (), *getwd ();
-char *(getcwd) ();
-#ifdef WINDOWSNT
-char *w32_getenv ();
-#define egetenv(VAR) w32_getenv(VAR)
-#else
-#define egetenv(VAR) getenv(VAR)
+\f
+char *getenv (const char *), *getwd (char *);
+#ifdef HAVE_GETCWD
+char *(getcwd) (char *, size_t);
#endif
#ifndef VERSION
#define TRUE 1
#endif
-#ifndef NO_RETURN
-#define NO_RETURN
-#endif
-
/* Additional space when allocating buffers for filenames, etc. */
#define EXTRA_SPACE 100
+/* Use this to suppress gcc's `...may be used before initialized' warnings. */
+#ifdef lint
+# define IF_LINT(Code) Code
+#else
+# define IF_LINT(Code) /* empty */
+#endif
+
\f
/* Name used to invoke this program. */
-char *progname;
+const char *progname;
/* The second argument to main. */
char **main_argv;
/* Nonzero means don't wait for a response from Emacs. --no-wait. */
int nowait = 0;
+/* Nonzero means don't print messages for successful operations. --quiet. */
+int quiet = 0;
+
/* Nonzero means args are expressions to be evaluated. --eval. */
int eval = 0;
int current_frame = 1;
/* The display on which Emacs should work. --display. */
-char *display = NULL;
+const char *display = NULL;
+
+/* The parent window ID, if we are opening a frame via XEmbed. */
+char *parent_id = NULL;
/* Nonzero means open a new Emacs frame on the current terminal. */
int tty = 0;
char *socket_name = NULL;
/* If non-NULL, the filename of the authentication file. */
-char *server_file = NULL;
+const char *server_file = NULL;
/* PID of the Emacs server process. */
int emacs_pid = 0;
-void print_help_and_exit () NO_RETURN;
+static void print_help_and_exit (void) NO_RETURN;
+static void fail (void) NO_RETURN;
+
struct option longopts[] =
{
{ "no-wait", no_argument, NULL, 'n' },
+ { "quiet", no_argument, NULL, 'q' },
{ "eval", no_argument, NULL, 'e' },
{ "help", no_argument, NULL, 'H' },
{ "version", no_argument, NULL, 'V' },
#ifndef WINDOWSNT
{ "display", required_argument, NULL, 'd' },
#endif
+ { "parent-id", required_argument, NULL, 'p' },
{ 0, 0, 0, 0 }
};
\f
/* Like malloc but get fatal error if memory is exhausted. */
-long *
-xmalloc (size)
- unsigned int size;
+static long *
+xmalloc (unsigned int size)
{
long *result = (long *) malloc (size);
if (result == NULL)
return result;
}
-/* Like strdup but get a fatal error if memory is exhausted. */
-
-char *
-xstrdup (const char *s)
-{
- char *result = strdup (s);
- if (result == NULL)
- {
- perror ("strdup");
- exit (EXIT_FAILURE);
- }
- return result;
-}
-
/* From sysdep.c */
#if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
Any other returned value must be freed with free. This is used
only when get_current_dir_name is not defined on the system. */
char*
-get_current_dir_name ()
+get_current_dir_name (void)
{
char *buf;
- char *pwd;
+ const char *pwd;
struct stat dotstat, pwdstat;
/* If PWD is accurate, use it instead of calling getwd. PWD is
sometimes a nicer name, and using it may avoid a fatal error if a
#ifdef WINDOWSNT
+/* Like strdup but get a fatal error if memory is exhausted. */
+
+char *
+xstrdup (const char *s)
+{
+ char *result = strdup (s);
+ if (result == NULL)
+ {
+ perror ("strdup");
+ exit (EXIT_FAILURE);
+ }
+ return result;
+}
+
#define REG_ROOT "SOFTWARE\\GNU\\Emacs"
/* Retrieve an environment variable from the Emacs subkeys of the registry.
Return NULL if the variable was not found, or it was empty.
This code is based on w32_get_resource (w32.c). */
char *
-w32_get_resource (predefined, key, type)
- HKEY predefined;
- char *key;
- LPDWORD type;
+w32_get_resource (HKEY predefined, char *key, LPDWORD type)
{
HKEY hrootkey = NULL;
char *result = NULL;
/*
getenv wrapper for Windows
- This is needed to duplicate Emacs's behavior, which is to look for environment
- variables in the registry if they don't appear in the environment.
-*/
+ Value is allocated on the heap, and can be free'd.
+
+ This is needed to duplicate Emacs's behavior, which is to look for
+ environment variables in the registry if they don't appear in the
+ environment. */
char *
-w32_getenv (envvar)
- char *envvar;
+w32_getenv (char *envvar)
{
char *value;
DWORD dwType;
if (value = getenv (envvar))
- /* Found in the environment. */
- return value;
+ /* Found in the environment. strdup it, because values returned
+ by getenv cannot be free'd. */
+ return xstrdup (value);
if (! (value = w32_get_resource (HKEY_CURRENT_USER, envvar, &dwType)) &&
! (value = w32_get_resource (HKEY_LOCAL_MACHINE, envvar, &dwType)))
}
void
-w32_set_user_model_id ()
+w32_set_user_model_id (void)
{
HMODULE shell;
HRESULT (WINAPI * set_user_model) (wchar_t * id);
/* On Windows 7 and later, we need to set the user model ID
to associate emacsclient launched files with Emacs frames
in the UI. */
- shell = LoadLibrary("shell32.dll");
+ shell = LoadLibrary ("shell32.dll");
if (shell)
{
set_user_model
}
int
-w32_window_app ()
+w32_window_app (void)
{
static int window_app = -1;
char szTitle[MAX_PATH];
nonconsole apps. Testing for the console title seems to work. */
window_app = (GetConsoleTitleA (szTitle, MAX_PATH) == 0);
if (window_app)
- InitCommonControls();
+ InitCommonControls ();
}
return window_app;
This is necessary due to the broken implementation of exec* routines in
the Microsoft libraries: they concatenate the arguments together without
quoting special characters, and pass the result to CreateProcess, with
- predictably bad results. By contrast, Posix execvp passes the arguments
+ predictably bad results. By contrast, POSIX execvp passes the arguments
directly into the argv array of the child process.
*/
int
-w32_execvp (path, argv)
- char *path;
- char **argv;
+w32_execvp (const char *path, char **argv)
{
int i;
/* Display a normal or error message.
On Windows, use a message box if compiled as a Windows app. */
-void
-message (int is_error, char *message, ...)
+static void
+message (int is_error, const char *format, ...)
{
- char msg [2048];
+ char msg[2048];
va_list args;
- va_start (args, message);
- vsprintf (msg, message, args);
+ va_start (args, format);
+ vsprintf (msg, format, args);
va_end (args);
#ifdef WINDOWSNT
/* Decode the options from argv and argc.
The global variable `optind' will say how many arguments we used up. */
-void
-decode_options (argc, argv)
- int argc;
- char **argv;
+static void
+decode_options (int argc, char **argv)
{
alternate_editor = egetenv ("ALTERNATE_EDITOR");
{
int opt = getopt_long_only (argc, argv,
#ifndef NO_SOCKETS_IN_FILE_SYSTEM
- "VHnea:s:f:d:tc",
+ "VHneqa:s:f:d:tc",
#else
- "VHnea:f:d:tc",
+ "VHneqa:f:d:tc",
#endif
longopts, 0);
eval = 1;
break;
+ case 'q':
+ quiet = 1;
+ break;
+
case 'V':
message (FALSE, "emacsclient %s\n", VERSION);
exit (EXIT_SUCCESS);
current_frame = 0;
break;
+ case 'p':
+ parent_id = optarg;
+ current_frame = 0;
+ break;
+
case 'H':
print_help_and_exit ();
break;
}
\f
-void
-print_help_and_exit ()
+static void
+print_help_and_exit (void)
{
/* Spaces and tabs are significant in this message; they're chosen so the
message aligns properly both in a tty and in a Windows message box.
use the current Emacs frame\n\
-e, --eval Evaluate the FILE arguments as ELisp expressions\n\
-n, --no-wait Don't wait for the server to return\n\
+-q, --quiet Don't display messages on success\n\
-d DISPLAY, --display=DISPLAY\n\
- Visit the file in the given display\n"
+ Visit the file in the given display\n\
+--parent-id=ID Open in parent window ID, via XEmbed\n"
#ifndef NO_SOCKETS_IN_FILE_SYSTEM
"-s SOCKET, --socket-name=SOCKET\n\
Set filename of the UNIX socket for communication\n"
defined-- exit with an errorcode.
Uses argv, but gets it from the global variable main_argv.
*/
-void
+static void
fail (void)
{
if (alternate_editor)
#if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
int
-main (argc, argv)
- int argc;
- char **argv;
+main (int argc, char **argv)
{
main_argv = argv;
progname = argv[0];
#else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
-#ifdef WINDOWSNT
-# include <winsock2.h>
-#else
-# include <sys/types.h>
-# include <sys/socket.h>
-# include <sys/un.h>
-#endif
-
#define AUTH_KEY_LENGTH 64
#define SEND_BUFFER_SIZE 4096
-extern char *strerror ();
-extern int errno;
+extern char *strerror (int);
/* Buffer to accumulate data to send in TCP connections. */
char send_buffer[SEND_BUFFER_SIZE + 1];
/* On Windows, the socket library was historically separate from the standard
C library, so errors are handled differently. */
-void
-sock_err_message (function_name)
- char *function_name;
+static void
+sock_err_message (const char *function_name)
{
#ifdef WINDOWSNT
char* msg = NULL;
- the data ends in "\n", or
- the buffer is full (but this shouldn't happen)
Otherwise, we just accumulate it. */
-void
-send_to_emacs (s, data)
- HSOCKET s;
- char *data;
+static void
+send_to_emacs (HSOCKET s, const char *data)
{
while (data)
{
- int dlen = strlen (data);
+ size_t dlen = strlen (data);
if (dlen + sblen >= SEND_BUFFER_SIZE)
{
int part = SEND_BUFFER_SIZE - sblen;
any initial -. Change spaces to underscores, too, so that the
return value never contains a space.
- Does not change the string. Outputs the result to STREAM. */
-void
-quote_argument (s, str)
- HSOCKET s;
- char *str;
+ Does not change the string. Outputs the result to S. */
+static void
+quote_argument (HSOCKET s, const char *str)
{
char *copy = (char *) xmalloc (strlen (str) * 2 + 1);
- char *p, *q;
+ const char *p;
+ char *q;
p = str;
q = copy;
/* The inverse of quote_argument. Removes quoting in string STR by
modifying the string in place. Returns STR. */
-char *
-unquote_argument (str)
- char *str;
+static char *
+unquote_argument (char *str)
{
char *p, *q;
}
\f
-int
-file_name_absolute_p (filename)
- const unsigned char *filename;
+static int
+file_name_absolute_p (const char *filename)
{
/* Sanity check, it shouldn't happen. */
if (! filename) return FALSE;
#ifdef WINDOWSNT
/* X:\xxx is always absolute. */
- if (isalpha (filename[0])
+ if (isalpha ((unsigned char) filename[0])
&& filename[1] == ':' && (filename[2] == '\\' || filename[2] == '/'))
return TRUE;
#ifdef WINDOWSNT
/* Wrapper to make WSACleanup a cdecl, as required by atexit. */
-void
-__cdecl close_winsock ()
+void __cdecl
+close_winsock (void)
{
WSACleanup ();
}
/* Initialize the WinSock2 library. */
void
-initialize_sockets ()
+initialize_sockets (void)
{
WSADATA wsaData;
\f
/*
* Read the information needed to set up a TCP comm channel with
- * the Emacs server: host, port, pid and authentication string.
+ * the Emacs server: host, port, and authentication string.
*/
-int
-get_server_config (server, authentication)
- struct sockaddr_in *server;
- char *authentication;
+static int
+get_server_config (struct sockaddr_in *server, char *authentication)
{
char dotted[32];
char *port;
- char *pid;
FILE *config = NULL;
if (file_name_absolute_p (server_file))
config = fopen (server_file, "rb");
else
{
- char *home = egetenv ("HOME");
+ const char *home = egetenv ("HOME");
if (home)
{
return FALSE;
if (fgets (dotted, sizeof dotted, config)
- && (port = strchr (dotted, ':'))
- && (pid = strchr (port, ' ')))
- {
- *port++ = '\0';
- *pid++ = '\0';
- }
+ && (port = strchr (dotted, ':')))
+ *port++ = '\0';
else
{
message (TRUE, "%s: invalid configuration info\n", progname);
fclose (config);
- emacs_pid = atoi (pid);
-
return TRUE;
}
-HSOCKET
-set_tcp_socket ()
+static HSOCKET
+set_tcp_socket (void)
{
HSOCKET s;
struct sockaddr_in server;
if (! get_server_config (&server, auth_string))
return INVALID_SOCKET;
- if (server.sin_addr.s_addr != inet_addr ("127.0.0.1"))
+ if (server.sin_addr.s_addr != inet_addr ("127.0.0.1") && !quiet)
message (FALSE, "%s: connected to remote socket at %s\n",
progname, inet_ntoa (server.sin_addr));
/* Returns 1 if PREFIX is a prefix of STRING. */
static int
-strprefix (char *prefix, char *string)
+strprefix (const char *prefix, const char *string)
{
return !strncmp (prefix, string, strlen (prefix));
}
and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
is zero, or return 0 if NOABORT is non-zero. */
-int
-find_tty (char **tty_type, char **tty_name, int noabort)
+static int
+find_tty (const char **tty_type, const char **tty_name, int noabort)
{
- char *type = egetenv ("TERM");
- char *name = ttyname (fileno (stdout));
+ const char *type = egetenv ("TERM");
+ const char *name = ttyname (fileno (stdout));
if (!name)
{
0 - success: none of the above */
static int
-socket_status (socket_name)
- char *socket_name;
+socket_status (char *name)
{
struct stat statbfr;
- if (stat (socket_name, &statbfr) == -1)
+ if (stat (name, &statbfr) == -1)
return 2;
if (statbfr.st_uid != geteuid ())
/* A signal handler that passes the signal to the Emacs process.
Useful for SIGWINCH. */
-SIGTYPE
+static SIGTYPE
pass_signal_to_emacs (int signalnum)
{
int old_errno = errno;
/* Signal handler for SIGCONT; notify the Emacs process that it can
now resume our tty frame. */
-SIGTYPE
+static SIGTYPE
handle_sigcont (int signalnum)
{
int old_errno = errno;
reality, we may get a SIGTSTP on C-z. Handling this signal and
notifying Emacs about it should get things under control again. */
-SIGTYPE
+static SIGTYPE
handle_sigtstp (int signalnum)
{
int old_errno = errno;
/* Set up signal handlers before opening a frame on the current tty. */
-void
+static void
init_signals (void)
{
/* Set up signal handlers. */
}
-HSOCKET
-set_local_socket ()
+static HSOCKET
+set_local_socket (void)
{
HSOCKET s;
struct sockaddr_un server;
int sock_status = 0;
int default_sock = !socket_name;
int saved_errno = 0;
- char *server_name = "server";
- char *tmpdir;
+ const char *server_name = "server";
+ const char *tmpdir IF_LINT ( = NULL);
- if (socket_name && !index (socket_name, '/') && !index (socket_name, '\\'))
- { /* socket_name is a file name component. */
+ if (socket_name && !strchr (socket_name, '/')
+ && !strchr (socket_name, '\\'))
+ {
+ /* socket_name is a file name component. */
server_name = socket_name;
socket_name = NULL;
default_sock = 1; /* Try both UIDs. */
associated with the name. This is reminiscent of the logic
that init_editfns uses to set the global Vuser_full_name. */
- char *user_name = (char *) egetenv ("LOGNAME");
+ const char *user_name = egetenv ("LOGNAME");
if (!user_name)
- user_name = (char *) egetenv ("USER");
+ user_name = egetenv ("USER");
if (user_name)
{
}
#endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
-HSOCKET
+static HSOCKET
set_socket (int no_exit_if_error)
{
HSOCKET s;
FARPROC get_wc; /* Pointer to RealGetWindowClassA. */
BOOL CALLBACK
-w32_find_emacs_process (hWnd, lParam)
- HWND hWnd;
- LPARAM lParam;
+w32_find_emacs_process (HWND hWnd, LPARAM lParam)
{
DWORD pid;
char class[6];
* process id = emacs_pid. If found, allow it to grab the focus.
*/
void
-w32_give_focus ()
+w32_give_focus (void)
{
HANDLE user32;
/* Start the emacs daemon and try to connect to it. */
-void
+static void
start_daemon_and_retry_set_socket (void)
{
#ifndef WINDOWSNT
pid_t w;
w = waitpid (dpid, &status, WUNTRACED | WCONTINUED);
- if ((w == -1) || !WIFEXITED (status) || WEXITSTATUS(status))
+ if ((w == -1) || !WIFEXITED (status) || WEXITSTATUS (status))
{
message (TRUE, "Error: Could not start the Emacs daemon\n");
exit (EXIT_FAILURE);
else if (dpid < 0)
{
fprintf (stderr, "Error: Cannot fork!\n");
- exit (1);
+ exit (EXIT_FAILURE);
}
else
{
- char *d_argv[] = {"emacs", "--daemon", 0 };
+ char emacs[] = "emacs";
+ char daemon_option[] = "--daemon";
+ char *d_argv[] = {emacs, daemon_option, 0 };
if (socket_name != NULL)
{
/* Pass --daemon=socket_name as argument. */
- char *deq = "--daemon=";
+ const char *deq = "--daemon=";
char *daemon_arg = alloca (strlen (deq)
+ strlen (socket_name) + 1);
strcpy (daemon_arg, deq);
}
int
-main (argc, argv)
- int argc;
- char **argv;
+main (int argc, char **argv)
{
- int i, rl, needlf = 0;
+ int rl, needlf = 0;
char *cwd, *str;
char string[BUFSIZ+1];
- int null_socket_name, null_server_file, start_daemon_if_needed;
+ int null_socket_name IF_LINT ( = 0);
+ int null_server_file IF_LINT ( = 0);
+ int start_daemon_if_needed;
+ int exit_status = EXIT_SUCCESS;
main_argv = argv;
progname = argv[0];
null_server_file = (server_file == NULL);
}
- if ((emacs_socket = set_socket (alternate_editor
- || start_daemon_if_needed)) == INVALID_SOCKET)
- if (start_daemon_if_needed)
- {
- /* Reset socket_name and server_file if they were NULL
- before the set_socket call. */
- if (null_socket_name)
- socket_name = NULL;
- if (null_server_file)
- server_file = NULL;
-
- start_daemon_and_retry_set_socket ();
- }
- else
- fail ();
+ emacs_socket = set_socket (alternate_editor || start_daemon_if_needed);
+ if (emacs_socket == INVALID_SOCKET)
+ {
+ if (! start_daemon_if_needed)
+ fail ();
+
+ /* Reset socket_name and server_file if they were NULL
+ before the set_socket call. */
+ if (null_socket_name)
+ socket_name = NULL;
+ if (null_server_file)
+ server_file = NULL;
+
+ start_daemon_and_retry_set_socket ();
+ }
cwd = get_current_dir_name ();
if (cwd == 0)
int i;
for (i = 0; environ[i]; i++)
{
- char *name = xstrdup (environ[i]);
- char *value = strchr (name, '=');
send_to_emacs (emacs_socket, "-env ");
quote_argument (emacs_socket, environ[i]);
send_to_emacs (emacs_socket, " ");
send_to_emacs (emacs_socket, " ");
}
+ if (parent_id)
+ {
+ send_to_emacs (emacs_socket, "-parent-id ");
+ quote_argument (emacs_socket, parent_id);
+ send_to_emacs (emacs_socket, " ");
+ }
+
/* If using the current frame, send tty information to Emacs anyway.
In daemon mode, Emacs may need to occupy this tty if no other
frame is available. */
if (tty || (current_frame && !eval))
{
- char *tty_type, *tty_name;
+ const char *tty_type, *tty_name;
if (find_tty (&tty_type, &tty_name, !tty))
{
if ((argc - optind > 0))
{
+ int i;
for (i = optind; i < argc; i++)
{
send_to_emacs (emacs_socket, "\n");
/* Wait for an answer. */
- if (!eval && !tty && !nowait)
+ if (!eval && !tty && !nowait && !quiet)
{
printf ("Waiting for Emacs...");
needlf = 2;
fsync (1);
/* Now, wait for an answer and print any messages. */
- while ((rl = recv (emacs_socket, string, BUFSIZ, 0)) > 0)
+ while (exit_status == EXIT_SUCCESS)
{
char *p;
+ do
+ {
+ errno = 0;
+ rl = recv (emacs_socket, string, BUFSIZ, 0);
+ }
+ /* If we receive a signal (e.g. SIGWINCH, which we pass
+ through to Emacs), on some OSes we get EINTR and must retry. */
+ while (rl < 0 && errno == EINTR);
+
+ if (rl <= 0)
+ break;
+
string[rl] = '\0';
p = string + strlen (string) - 1;
printf ("\n");
fprintf (stderr, "*ERROR*: %s", str);
needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
+ exit_status = EXIT_FAILURE;
}
#ifdef SIGSTOP
else if (strprefix ("-suspend ", string))
if (needlf)
printf ("\n");
printf ("*ERROR*: Unknown message: %s", string);
- needlf = string[0] == '\0' ? needlf : string[strlen (string) - 1] != '\n';
+ needlf = string[0]
+ == '\0' ? needlf : string[strlen (string) - 1] != '\n';
}
}
fflush (stdout);
fsync (1);
+ if (rl < 0)
+ exit_status = EXIT_FAILURE;
+
CLOSE_SOCKET (emacs_socket);
- return EXIT_SUCCESS;
+ return exit_status;
}
#endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
#endif /* ! HAVE_STRERROR */
-/* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
- (do not change this comment) */
/* emacsclient.c ends here */