nt/runemacs.c

   1 /* runemacs --- Simple program to start Emacs with its console window hidden.
   2
   3 Copyright (C) 2001-2017 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Emacs.
   6
   7 GNU Emacs is free software: you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation, either version 3 of the License, or (at
  10 your option) any later version.
  11
  12 GNU Emacs is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20
  21 /*
  22   Simple program to start Emacs with its console window hidden.
  23
  24   This program is provided purely for convenience, since most users will
  25   use Emacs in windowing (GUI) mode, and will not want to have an extra
  26   console window lying around.  */
  27
  28 /*
  29    You may want to define this if you want to be able to install updated
  30    emacs binaries even when other users are using the current version.
  31    The problem with some file servers (notably Novell) is that an open
  32    file cannot be overwritten, deleted, or even renamed.  So if someone
  33    is running emacs.exe already, you cannot install a newer version.
  34    By defining CHOOSE_NEWEST_EXE, you can name your new emacs.exe
  35    something else which matches "emacs*.exe", and runemacs will
  36    automatically select the newest emacs executable in the bin directory.
  37    (So you'll probably be able to delete the old version some hours/days
  38    later).
  39 */
  40
  41 /* #define CHOOSE_NEWEST_EXE */
  42
  43 #include <windows.h>
  44 #include <string.h>
  45 #include <malloc.h>
  46
  47 static void set_user_model_id (void);
  48 static int ensure_unicows_dll (void);
  49
  50 int WINAPI
  51 WinMain (HINSTANCE hSelf, HINSTANCE hPrev, LPSTR cmdline, int nShow)
  52 {
  53   STARTUPINFO start;
  54   SECURITY_ATTRIBUTES sec_attrs;
  55   PROCESS_INFORMATION child;
  56   int wait_for_child = FALSE;
  57   DWORD priority_class = NORMAL_PRIORITY_CLASS;
  58   DWORD ret_code = 0;
  59   char *new_cmdline;
  60   char *p;
  61   char modname[MAX_PATH];
  62   static const char iconic_opt[] = "--iconic ", maximized_opt[] = "--maximized ";
  63
  64   if (!ensure_unicows_dll ())
  65     goto error;
  66
  67   set_user_model_id ();
  68
  69   if (!GetModuleFileName (NULL, modname, MAX_PATH))
  70     goto error;
  71   if ((p = strrchr (modname, '\\')) == NULL)
  72     goto error;
  73   *p = 0;
  74
  75   new_cmdline = alloca (MAX_PATH
  76                         + strlen (cmdline)
  77                         + ((nShow == SW_SHOWMINNOACTIVE
  78                             || nShow == SW_SHOWMAXIMIZED)
  79                            ? max (sizeof (iconic_opt), sizeof (maximized_opt))
  80                            : 0)
  81                         + 3);
  82   /* Quote executable name in case of spaces in the path. */
  83   *new_cmdline = '"';
  84   strcpy (new_cmdline + 1, modname);
  85   /* Detect and handle un-installed runemacs.exe in nt/ subdirectory,
  86      while emacs.exe is in src/.  */
  87   if ((p = strrchr (new_cmdline, '\\')) != NULL
  88       && stricmp (p, "\\nt") == 0)
  89     strcpy (p, "\\src");
  90
  91 #ifdef CHOOSE_NEWEST_EXE
  92   {
  93     /* Silly hack to allow new versions to be installed on
  94        server even when current version is in use. */
  95
  96     char * best_name = alloca (MAX_PATH + 1);
  97     FILETIME best_time = {0,0};
  98     WIN32_FIND_DATA wfd;
  99     HANDLE fh;
 100     p = new_cmdline + strlen (new_cmdline);
 101     strcpy (p, "\\emacs*.exe\" ");
 102     fh = FindFirstFile (new_cmdline, &wfd);
 103     if (fh == INVALID_HANDLE_VALUE)
 104       goto error;
 105     do
 106       {
 107         if (wfd.ftLastWriteTime.dwHighDateTime > best_time.dwHighDateTime
 108             || (wfd.ftLastWriteTime.dwHighDateTime == best_time.dwHighDateTime
 109                 && wfd.ftLastWriteTime.dwLowDateTime > best_time.dwLowDateTime))
 110           {
 111             best_time = wfd.ftLastWriteTime;
 112             strcpy (best_name, wfd.cFileName);
 113           }
 114       }
 115     while (FindNextFile (fh, &wfd));
 116     FindClose (fh);
 117     *p++ = '\\';
 118     strcpy (p, best_name);
 119     strcat (p, " ");
 120   }
 121 #else
 122   strcat (new_cmdline, "\\emacs.exe\" ");
 123 #endif
 124
 125   /* Append original arguments if any; first look for arguments we
 126      recognize (-wait, -high, and -low), and apply them ourselves.  */
 127   while (cmdline[0] == '-' || cmdline[0] == '/')
 128     {
 129       if (strncmp (cmdline+1, "wait", 4) == 0)
 130         {
 131           wait_for_child = TRUE;
 132           cmdline += 5;
 133         }
 134       else if (strncmp (cmdline+1, "high", 4) == 0)
 135         {
 136           priority_class = HIGH_PRIORITY_CLASS;
 137           cmdline += 5;
 138         }
 139       else if (strncmp (cmdline+1, "low", 3) == 0)
 140         {
 141           priority_class = IDLE_PRIORITY_CLASS;
 142           cmdline += 4;
 143         }
 144       else
 145         break;
 146       /* Look for next argument.  */
 147       while (*++cmdline == ' ');
 148     }
 149
 150   /* If the desktop shortcut properties tell to invoke runemacs
 151      minimized, or if they invoked runemacs via "start /min", pass
 152      '--iconic' to Emacs, as that's what users will expect.  Likewise
 153      with invoking runemacs maximized: pass '--maximized' to Emacs.  */
 154   if (nShow == SW_SHOWMINNOACTIVE)
 155     strcat (new_cmdline, iconic_opt);
 156   else if (nShow == SW_SHOWMAXIMIZED)
 157     strcat (new_cmdline, maximized_opt);
 158   strcat (new_cmdline, cmdline);
 159
 160   /* Set emacs_dir variable if runemacs was in "%emacs_dir%\bin".  */
 161   if ((p = strrchr (modname, '\\')) && stricmp (p, "\\bin") == 0)
 162     {
 163       *p = 0;
 164       for (p = modname; *p; p++)
 165         if (*p == '\\') *p = '/';
 166       SetEnvironmentVariable ("emacs_dir", modname);
 167     }
 168
 169   memset (&start, 0, sizeof (start));
 170   start.cb = sizeof (start);
 171   start.dwFlags = STARTF_USESHOWWINDOW | STARTF_USECOUNTCHARS;
 172   start.wShowWindow = SW_HIDE;
 173   /* Ensure that we don't waste memory if the user has specified a huge
 174      default screen buffer for command windows.  */
 175   start.dwXCountChars = 80;
 176   start.dwYCountChars = 25;
 177
 178   sec_attrs.nLength = sizeof (sec_attrs);
 179   sec_attrs.lpSecurityDescriptor = NULL;
 180   sec_attrs.bInheritHandle = FALSE;
 181
 182   if (CreateProcess (NULL, new_cmdline, &sec_attrs, NULL, TRUE, priority_class,
 183                      NULL, NULL, &start, &child))
 184     {
 185       if (wait_for_child)
 186         {
 187           WaitForSingleObject (child.hProcess, INFINITE);
 188           GetExitCodeProcess (child.hProcess, &ret_code);
 189         }
 190       CloseHandle (child.hThread);
 191       CloseHandle (child.hProcess);
 192     }
 193   else
 194     goto error;
 195   return (int) ret_code;
 196
 197 error:
 198   MessageBox (NULL, "Could not start Emacs.", "Error", MB_ICONSTOP);
 199   return 1;
 200 }
 201
 202 void
 203 set_user_model_id (void)
 204 {
 205   HMODULE shell;
 206   HRESULT (WINAPI * set_user_model) (const wchar_t * id);
 207
 208   /* On Windows 7 and later, we need to set the user model ID
 209      to associate emacsclient launched files with Emacs frames
 210      in the UI.  */
 211   shell = LoadLibrary ("shell32.dll");
 212   if (shell)
 213     {
 214       set_user_model
 215         = (void *) GetProcAddress (shell,
 216                                    "SetCurrentProcessExplicitAppUserModelID");
 217
 218       /* If the function is defined, then we are running on Windows 7
 219          or newer, and the UI uses this to group related windows
 220          together.  Since emacs, runemacs, emacsclient are related, we
 221          want them grouped even though the executables are different,
 222          so we need to set a consistent ID between them.  */
 223       if (set_user_model)
 224         set_user_model (L"GNU.Emacs");
 225
 226       FreeLibrary (shell);
 227     }
 228 }
 229
 230 static int
 231 ensure_unicows_dll (void)
 232 {
 233   OSVERSIONINFO os_ver;
 234   HMODULE h;
 235
 236   ZeroMemory (&os_ver, sizeof (OSVERSIONINFO));
 237   os_ver.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
 238   if (!GetVersionEx (&os_ver))
 239     return 0;
 240
 241   if (os_ver.dwPlatformId == VER_PLATFORM_WIN32_WINDOWS)
 242     {
 243       h = LoadLibrary ("Unicows.dll");
 244       if (!h)
 245         {
 246           int button;
 247
 248           button = MessageBox (NULL,
 249                                "Emacs cannot load the UNICOWS.DLL library.\n"
 250                                "This library is essential for using Emacs\n"
 251                                "on this system.  You need to install it.\n\n"
 252                                "Emacs will exit when you click OK.",
 253                                "Emacs cannot load UNICOWS.DLL",
 254                                MB_ICONERROR | MB_TASKMODAL
 255                                | MB_SETFOREGROUND | MB_OK);
 256           switch (button)
 257             {
 258               case IDOK:
 259               default:
 260                 return 0;
 261             }
 262         }
 263       FreeLibrary (h);
 264       return 1;
 265     }
 266   return 1;
 267 }