/* 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 Free Software Foundation, Inc.
+ 2005, 2006, 2007, 2008, 2009, 2010 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
#else /* !WINDOWSNT */
-# include <sys/types.h>
+# 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 <darpa/inet.h>
+# include <arpa/inet.h>
# define INVALID_SOCKET -1
# define HSOCKET int
# define CLOSE_SOCKET close
# define INITIALIZE()
+# ifndef WCONTINUED
+# define WCONTINUED 8
+# endif
+
#endif /* !WINDOWSNT */
#undef signal
#include <stdio.h>
#include "getopt.h"
#ifdef HAVE_UNISTD_H
-#include <unistd.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) ();
+char *getenv (const char *), *getwd (char *);
+#ifdef HAVE_GETCWD
+char *(getcwd) (char *, size_t);
+#endif
#ifdef WINDOWSNT
-char *w32_getenv ();
+char *w32_getenv (char *);
#define egetenv(VAR) w32_getenv(VAR)
#else
#define egetenv(VAR) getenv(VAR)
#define TRUE 1
#endif
-#ifndef NO_RETURN
-#define NO_RETURN
-#endif
-
/* Additional space when allocating buffers for filenames, etc. */
#define EXTRA_SPACE 100
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;
+void print_help_and_exit (void) NO_RETURN;
+void fail (void) NO_RETURN;
+
struct option longopts[] =
{
#ifndef WINDOWSNT
{ "display", required_argument, NULL, 'd' },
#endif
+ { "parent-id", required_argument, NULL, 'p' },
{ 0, 0, 0, 0 }
};
/* Like malloc but get fatal error if memory is exhausted. */
long *
-xmalloc (size)
- unsigned int size;
+xmalloc (unsigned int size)
{
long *result = (long *) malloc (size);
if (result == NULL)
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;
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 enviroment
+ 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;
return NULL;
}
+void
+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");
+ if (shell)
+ {
+ set_user_model
+ = (void *) GetProcAddress (shell,
+ "SetCurrentProcessExplicitAppUserModelID");
+ /* If the function is defined, then we are running on Windows 7
+ or newer, and the UI uses this to group related windows
+ together. Since emacs, runemacs, emacsclient are related, we
+ want them grouped even though the executables are different,
+ so we need to set a consistent ID between them. */
+ if (set_user_model)
+ set_user_model (L"GNU.Emacs");
+
+ FreeLibrary (shell);
+ }
+}
+
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, ...)
+message (int is_error, const char *message, ...)
{
- char msg [2048];
+ char msg[2048];
va_list args;
va_start (args, message);
The global variable `optind' will say how many arguments we used up. */
void
-decode_options (argc, argv)
- int argc;
- char **argv;
+decode_options (int argc, char **argv)
{
alternate_editor = egetenv ("ALTERNATE_EDITOR");
current_frame = 0;
break;
+ case 'p':
+ parent_id = optarg;
+ current_frame = 0;
+ break;
+
case 'H':
print_help_and_exit ();
break;
inconvenient. So we force users to use "--display $DISPLAY" if
they want Emacs to connect to their current display. */
if (!current_frame && !tty && !display)
- display = egetenv ("DISPLAY");
+ {
+ display = egetenv ("DISPLAY");
+#ifdef NS_IMPL_COCOA
+ /* Under Cocoa, we don't really use displays the same way as in X,
+ so provide a dummy. */
+ if (!display || strlen (display) == 0)
+ display = "ns";
+#endif
+ }
/* A null-string display is invalid. */
if (display && strlen (display) == 0)
arguments or expressions given. */
if (nowait && tty && argc - optind > 0)
current_frame = 1;
+
+#ifdef WINDOWSNT
+ if (alternate_editor && alternate_editor[0] == '\0')
+ {
+ message (TRUE, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
+an empty string");
+ exit (EXIT_FAILURE);
+ }
+#endif /* WINDOWSNT */
}
\f
void
-print_help_and_exit ()
+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\
--d, --display=DISPLAY Visit the file in the given display\n"
+-d DISPLAY, --display=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-name=FILENAME\n\
+"-s SOCKET, --socket-name=SOCKET\n\
Set filename of the UNIX socket for communication\n"
#endif
-"-f, --server-file=FILENAME\n\
+"-f SERVER, --server-file=SERVER\n\
Set filename of the TCP authentication file\n\
--a, --alternate-editor=EDITOR\n\
- Editor to fallback to if the server is not running\n\
-\n\
-Report bugs to bug-gnu-emacs@gnu.org.\n", progname);
+-a EDITOR, --alternate-editor=EDITOR\n\
+ Editor to fallback to if the server is not running\n"
+#ifndef WINDOWSNT
+" If EDITOR is the empty string, start Emacs in daemon\n\
+ mode and try connecting again\n"
+#endif /* not WINDOWSNT */
+"\n\
+Report bugs with M-x report-emacs-bug.\n", progname);
exit (EXIT_SUCCESS);
}
#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;
+sock_err_message (const char *function_name)
{
#ifdef WINDOWSNT
char* msg = NULL;
- the buffer is full (but this shouldn't happen)
Otherwise, we just accumulate it. */
void
-send_to_emacs (s, data)
- HSOCKET s;
- char *data;
+send_to_emacs (HSOCKET s, const char *data)
{
while (data)
{
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. */
+ Does not change the string. Outputs the result to S. */
void
-quote_argument (s, str)
- HSOCKET s;
- char *str;
+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;
modifying the string in place. Returns STR. */
char *
-unquote_argument (str)
- char *str;
+unquote_argument (char *str)
{
char *p, *q;
\f
int
-file_name_absolute_p (filename)
- const unsigned char *filename;
+file_name_absolute_p (const unsigned char *filename)
{
/* Sanity check, it shouldn't happen. */
if (! filename) return FALSE;
#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;
* the Emacs server: host, port, pid and authentication string.
*/
int
-get_server_config (server, authentication)
- struct sockaddr_in *server;
- char *authentication;
+get_server_config (struct sockaddr_in *server, char *authentication)
{
char dotted[32];
char *port;
}
HSOCKET
-set_tcp_socket ()
+set_tcp_socket (void)
{
HSOCKET s;
struct sockaddr_in server;
/* 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));
}
0 - success: none of the above */
static int
-socket_status (socket_name)
- char *socket_name;
+socket_status (char *socket_name)
{
struct stat statbfr;
HSOCKET
-set_local_socket ()
+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 (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. */
#endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
HSOCKET
-set_socket ()
+set_socket (int no_exit_if_error)
{
HSOCKET s;
if (socket_name)
{
s = set_local_socket ();
- if ((s != INVALID_SOCKET) || alternate_editor)
+ if ((s != INVALID_SOCKET) || no_exit_if_error)
return s;
message (TRUE, "%s: error accessing socket \"%s\"\n",
progname, socket_name);
if (server_file)
{
s = set_tcp_socket ();
- if ((s != INVALID_SOCKET) || alternate_editor)
+ if ((s != INVALID_SOCKET) || no_exit_if_error)
return s;
message (TRUE, "%s: error accessing server file \"%s\"\n",
/* Implicit server file. */
server_file = "server";
s = set_tcp_socket ();
- if ((s != INVALID_SOCKET) || alternate_editor)
+ if ((s != INVALID_SOCKET) || no_exit_if_error)
return s;
/* No implicit or explicit socket, and no alternate editor. */
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)
{
- HMODULE hUser32;
+ HANDLE user32;
/* It shouldn't happen when dealing with TCP sockets. */
if (!emacs_pid) return;
- if (!(hUser32 = LoadLibrary ("user32.dll"))) return;
+ user32 = GetModuleHandle ("user32.dll");
+
+ if (!user32)
+ return;
/* Modern Windows restrict which processes can set the foreground window.
emacsclient can allow Emacs to grab the focus by calling the function
AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
NT) lack this function, so we have to check its availability. */
- if ((set_fg = GetProcAddress (hUser32, "AllowSetForegroundWindow"))
- && (get_wc = GetProcAddress (hUser32, "RealGetWindowClassA")))
+ if ((set_fg = GetProcAddress (user32, "AllowSetForegroundWindow"))
+ && (get_wc = GetProcAddress (user32, "RealGetWindowClassA")))
EnumWindows (w32_find_emacs_process, (LPARAM) 0);
-
- FreeLibrary (hUser32);
}
#endif
+/* Start the emacs daemon and try to connect to it. */
+
+void
+start_daemon_and_retry_set_socket (void)
+{
+#ifndef WINDOWSNT
+ pid_t dpid;
+ int status;
+
+ dpid = fork ();
+
+ if (dpid > 0)
+ {
+ pid_t w;
+ w = waitpid (dpid, &status, WUNTRACED | WCONTINUED);
+
+ if ((w == -1) || !WIFEXITED (status) || WEXITSTATUS (status))
+ {
+ message (TRUE, "Error: Could not start the Emacs daemon\n");
+ exit (EXIT_FAILURE);
+ }
+
+ /* Try connecting, the daemon should have started by now. */
+ message (TRUE, "Emacs daemon should have started, trying to connect again\n");
+ if ((emacs_socket = set_socket (1)) == INVALID_SOCKET)
+ {
+ message (TRUE, "Error: Cannot connect even after starting the Emacs daemon\n");
+ exit (EXIT_FAILURE);
+ }
+ }
+ else if (dpid < 0)
+ {
+ fprintf (stderr, "Error: Cannot fork!\n");
+ exit (1);
+ }
+ else
+ {
+ char emacs[] = "emacs";
+ char daemon[] = "--daemon";
+ char *d_argv[] = {emacs, daemon, 0 };
+ if (socket_name != NULL)
+ {
+ /* Pass --daemon=socket_name as argument. */
+ const char *deq = "--daemon=";
+ char *daemon_arg = alloca (strlen (deq)
+ + strlen (socket_name) + 1);
+ strcpy (daemon_arg, deq);
+ strcat (daemon_arg, socket_name);
+ d_argv[1] = daemon_arg;
+ }
+ execvp ("emacs", d_argv);
+ message (TRUE, "%s: error starting emacs daemon\n", progname);
+ }
+#endif /* WINDOWSNT */
+}
+
int
-main (argc, argv)
- int argc;
- char **argv;
+main (int argc, char **argv)
{
int i, rl, needlf = 0;
char *cwd, *str;
char string[BUFSIZ+1];
+ int null_socket_name, null_server_file, start_daemon_if_needed;
main_argv = argv;
progname = argv[0];
+#ifdef WINDOWSNT
+ /* On Windows 7 and later, we need to explicitly associate emacsclient
+ with emacs so the UI behaves sensibly. */
+ w32_set_user_model_id ();
+#endif
+
/* Process options. */
decode_options (argc, argv);
exit (EXIT_FAILURE);
}
- if ((emacs_socket = set_socket ()) == INVALID_SOCKET)
- fail ();
+ /* If alternate_editor is the empty string, start the emacs daemon
+ in case of failure to connect. */
+ start_daemon_if_needed = (alternate_editor
+ && (alternate_editor[0] == '\0'));
+ if (start_daemon_if_needed)
+ {
+ /* set_socket changes the values for socket_name and
+ server_file, we need to reset them, if they were NULL before
+ for the second call to set_socket. */
+ null_socket_name = (socket_name == NULL);
+ 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 ();
cwd = get_current_dir_name ();
if (cwd == 0)
quote_argument (emacs_socket, environ[i]);
send_to_emacs (emacs_socket, " ");
}
- send_to_emacs (emacs_socket, "-dir ");
- quote_argument (emacs_socket, cwd);
- send_to_emacs (emacs_socket, "/");
- send_to_emacs (emacs_socket, " ");
}
+ send_to_emacs (emacs_socket, "-dir ");
+ quote_argument (emacs_socket, cwd);
+ send_to_emacs (emacs_socket, "/");
+ send_to_emacs (emacs_socket, " ");
retry:
if (nowait)
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. */
{
for (i = optind; i < argc; i++)
{
- int relative = 0;
if (eval)
{
send_to_emacs (emacs_socket, " ");
continue;
}
- else
- relative = 1;
}
- else if (! file_name_absolute_p (argv[i]))
-#ifndef WINDOWSNT
- relative = 1;
-#else
- /* Call GetFullPathName so filenames of the form X:Y, where X is
- a valid drive designator, are interpreted as drive:path, not
- file:stream, and treated as absolute.
- The user can still pass a file:stream if desired (for example,
- .\X:Y), but it is not very useful, as Emacs currently does a
- very bad job of dealing with NTFS streams. */
+#ifdef WINDOWSNT
+ else if (! file_name_absolute_p (argv[i])
+ && (isalpha (argv[i][0]) && argv[i][1] == ':'))
+ /* Windows can have a different default directory for each
+ drive, so the cwd passed via "-dir" is not sufficient
+ to account for that.
+ If the user uses <drive>:<relpath>, we hence need to be
+ careful to expand <relpath> with the default directory
+ corresponding to <drive>. */
{
char *filename = (char *) xmalloc (MAX_PATH);
DWORD size;
if (size > 0 && size < MAX_PATH)
argv[i] = filename;
else
- {
- relative = 1;
- free (filename);
- }
+ free (filename);
}
#endif
send_to_emacs (emacs_socket, "-file ");
- if (relative)
- {
- quote_argument (emacs_socket, cwd);
- send_to_emacs (emacs_socket, "/");
- }
quote_argument (emacs_socket, argv[i]);
send_to_emacs (emacs_socket, " ");
}