]> code.delx.au - gnu-emacs/blobdiff - nt/addpm.c
merge trunk
[gnu-emacs] / nt / addpm.c
index 8069652f7fb1b45c3c06e631d808c76dd3572a6c..9bdfafc2a3e45b854a283f8b44d13bce5a595419 100644 (file)
@@ -1,12 +1,13 @@
 /* Add entries to the GNU Emacs Program Manager folder.
-   Copyright (C) 1995 Free Software Foundation, Inc.
+   Copyright (C) 1995, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
+     2008, 2009, 2010  Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
-GNU Emacs is free software; you can redistribute it and/or modify
+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 2, or (at your option)
-any later version.
+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
@@ -14,9 +15,7 @@ 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; see the file COPYING.  If not, write to
-the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.  */
+along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
 
 /****************************************************************************
  *
@@ -24,15 +23,30 @@ Boston, MA 02111-1307, USA.  */
  *
  * Usage:
  *     argv[1] = install path for emacs
- *     argv[2] = full path to icon for emacs (optional)
+ *
+ * argv[2] used to be an optional argument for setting the icon.
+ * But now Emacs has a professional looking icon of its own.
+ * If users really want to change it, they can go into the settings of
+ * the shortcut that is created and do it there.
  */
 
+/* Use parts of shell API that were introduced by the merge of IE4
+   into the desktop shell.  If Windows 95 or NT4 users do not have IE4
+   installed, then the DDE fallback for creating icons the Windows 3.1
+   progman way will be used instead, but that is prone to lockups
+   caused by other applications not servicing their message queues.  */
+#define _WIN32_IE 0x400
+/* Request C Object macros for COM interfaces.  */
+#define COBJMACROS 1
+
 #include <windows.h>
+#include <shlobj.h>
 #include <ddeml.h>
 #include <stdlib.h>
 #include <stdio.h>
+#include <malloc.h>
 
-HDDEDATA CALLBACK 
+HDDEDATA CALLBACK
 DdeCallback (UINT uType, UINT uFmt, HCONV hconv,
             HSZ hsz1, HSZ hsz2, HDDEDATA hdata,
             DWORD dwData1, DWORD dwData2)
@@ -41,104 +55,306 @@ DdeCallback (UINT uType, UINT uFmt, HCONV hconv,
 }
 
 #define DdeCommand(str)        \
-       DdeClientTransaction (str, strlen (str)+1, HConversation, (HSZ)NULL, \
+       DdeClientTransaction (str, strlen (str)+1, conversation, (HSZ)NULL, \
                              CF_TEXT, XTYP_EXECUTE, 30000, NULL)
 
 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
+#define REG_GTK "SOFTWARE\\GTK\\2.0"
+#define REG_APP_PATH \
+  "SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\App Paths\\emacs.exe"
 
 static struct entry
 {
   char *name;
   char *value;
-} 
-env_vars[] = 
+}
+env_vars[] =
 {
   {"emacs_dir", NULL},
-  {"EMACSLOADPATH", "%emacs_dir%/lisp"},
-  {"SHELL", "%COMSPEC%"},
+  {"EMACSLOADPATH", "%emacs_dir%/site-lisp;%emacs_dir%/../site-lisp;%emacs_dir%/lisp;%emacs_dir%/leim"},
+  {"SHELL", "%emacs_dir%/bin/cmdproxy.exe"},
   {"EMACSDATA", "%emacs_dir%/etc"},
   {"EMACSPATH", "%emacs_dir%/bin"},
-  {"EMACSLOCKDIR", "%emacs_dir%/lock"},
-  {"INFOPATH", "%emacs_dir%/info"},
+  /* We no longer set INFOPATH because Info-default-directory-list
+     is then ignored.  */
+  /*  {"INFOPATH", "%emacs_dir%/info"},  */
   {"EMACSDOC", "%emacs_dir%/etc"},
   {"TERM", "cmd"}
 };
 
-BOOL 
+BOOL
 add_registry (path)
      char *path;
 {
   HKEY hrootkey = NULL;
-  DWORD dwDisp;
   int i;
   BOOL ok = TRUE;
-  
-  /* Check both the current user and the local machine to see if we 
+  DWORD size;
+
+  /* Record the location of Emacs to the App Paths key if we have
+     sufficient permissions to do so.  This helps Windows find emacs quickly
+     if the user types emacs.exe in the "Run Program" dialog without having
+     emacs on their path.  Some applications also use the same registry key
+     to discover the installation directory for programs they are looking for.
+     Multiple installations cannot be handled by this method, but it does not
+     affect the general operation of other installations of Emacs, and we
+     are blindly overwriting the Start Menu entries already.
+  */
+  if (RegCreateKeyEx (HKEY_LOCAL_MACHINE, REG_APP_PATH, 0, "",
+                      REG_OPTION_NON_VOLATILE, KEY_WRITE, NULL,
+                      &hrootkey, NULL) == ERROR_SUCCESS)
+    {
+      int len;
+      char *emacs_path;
+      HKEY gtk_key = NULL;
+
+      len = strlen (path) + 15; /* \bin\emacs.exe + terminator.  */
+      emacs_path = (char *) alloca (len);
+      sprintf (emacs_path, "%s\\bin\\emacs.exe", path);
+
+      RegSetValueEx (hrootkey, NULL, 0, REG_SZ, emacs_path, len);
+
+      /* Look for a GTK installation. If found, add it to the library search
+         path for Emacs so that the image libraries it provides are available
+         to Emacs regardless of whether it is in the path or not.  */
+      if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, REG_GTK, REG_OPTION_NON_VOLATILE,
+                        KEY_READ, &gtk_key) == ERROR_SUCCESS)
+        {
+          if (RegQueryValueEx (gtk_key, "DllPath", NULL, NULL,
+                               NULL, &size) == ERROR_SUCCESS)
+            {
+              char *gtk_path = (char *) alloca (size);
+              if (RegQueryValueEx (gtk_key, "DllPath", NULL, NULL,
+                                   gtk_path, &size) == ERROR_SUCCESS)
+                {
+                  /* Make sure the emacs bin directory continues to be searched
+                     first by including it as well.  */
+                  char *dll_paths;
+                  len = strlen (path) + 5 + size;
+                  dll_paths = (char *) alloca (size + strlen (path) + 1);
+                  sprintf (dll_paths, "%s\\bin;%s", path, gtk_path);
+                  RegSetValueEx (hrootkey, "Path", 0, REG_SZ, dll_paths, len);
+                }
+            }
+          RegCloseKey (gtk_key);
+        }
+      RegCloseKey (hrootkey);
+    }
+
+  /* Previous versions relied on registry settings, but we do not need
+     them any more.  If registry settings are installed from a previous
+     version, replace them to ensure they are the current settings.
+     Otherwise, do nothing.  */
+
+  /* Check both the current user and the local machine to see if we
      have any resources.  */
-  
-  if (RegCreateKeyEx (HKEY_LOCAL_MACHINE, REG_ROOT,
-                     0, "", REG_OPTION_NON_VOLATILE,
-                     KEY_WRITE, NULL, &hrootkey, &dwDisp) != ERROR_SUCCESS 
-      && RegCreateKeyEx (HKEY_CURRENT_USER, REG_ROOT,
-                        0, "", REG_OPTION_NON_VOLATILE,
-                        KEY_WRITE, NULL, &hrootkey, &dwDisp) != ERROR_SUCCESS)
+
+  if (RegOpenKeyEx (HKEY_LOCAL_MACHINE, REG_ROOT,
+                     REG_OPTION_NON_VOLATILE,
+                     KEY_WRITE, &hrootkey) != ERROR_SUCCESS
+      && RegOpenKeyEx (HKEY_CURRENT_USER, REG_ROOT,
+                        REG_OPTION_NON_VOLATILE,
+                        KEY_WRITE, &hrootkey) != ERROR_SUCCESS)
     {
       return FALSE;
     }
-  
-  for (i = 0; i < (sizeof (env_vars) / sizeof (env_vars[0])); i++) 
+
+  for (i = 0; i < (sizeof (env_vars) / sizeof (env_vars[0])); i++)
     {
       char * value = env_vars[i].value ? env_vars[i].value : path;
-       
+
       if (RegSetValueEx (hrootkey, env_vars[i].name,
                         0, REG_EXPAND_SZ,
                         value, lstrlen (value) + 1) != ERROR_SUCCESS)
        ok = FALSE;
-    }                        
-  
+    }
+
   RegCloseKey (hrootkey);
-  
+
   return (ok);
 }
 
 int
 main (argc, argv)
      int argc;
-     char *argv[];                     
+     char *argv[];
 {
-  DWORD idDde;
-  HCONV HConversation;
-  HSZ ProgMan;
-  char additem[MAX_PATH*2 + 100];
-  char *lpext;
+  char start_folder[MAX_PATH + 1];
+  int shortcuts_created = 0;
+  int com_available = 1;
+  char modname[MAX_PATH];
+  char *prog_name;
+  char *emacs_path;
+  char *p;
+  int quiet = 0;
+  HRESULT result;
+  IShellLinkA *shortcut;
 
-  if (argc < 2 || argc > 3)
+  /* If no args specified, use our location to set emacs_path.  */
+
+  if (argc > 1
+      && (argv[1][0] == '/' || argv[1][0] == '-')
+      && argv[1][1] == 'q')
     {
-      fprintf (stderr, "usage: addpm emacs_path [icon_path]\n");
-      exit (1);
+      quiet = 1;
+      --argc;
+      ++argv;
     }
 
-  lpext = add_registry (argv[1]) ? "exe" : "bat";
+  if (argc > 1)
+    emacs_path = argv[1];
+  else
+    {
+      if (!GetModuleFileName (NULL, modname, MAX_PATH) ||
+         (p = strrchr (modname, '\\')) == NULL)
+       {
+         fprintf (stderr, "fatal error");
+         exit (1);
+       }
+      *p = 0;
 
-  DdeInitialize (&idDde, (PFNCALLBACK)DdeCallback, APPCMD_CLIENTONLY, 0);
+      /* Set emacs_path to emacs_dir if we are in "%emacs_dir%\bin".  */
+      if ((p = strrchr (modname, '\\')) && stricmp (p, "\\bin") == 0)
+       {
+         *p = 0;
+         emacs_path = modname;
+       }
+      else
+       {
+         fprintf (stderr, "usage: addpm emacs_path\n");
+         exit (1);
+       }
 
-  ProgMan = DdeCreateStringHandle (idDde, "PROGMAN", CP_WINANSI);
+      /* Tell user what we are going to do.  */
+      if (!quiet)
+       {
+         int result;
 
-  if (HConversation = DdeConnect (idDde, ProgMan, ProgMan, NULL))
+         char msg[ MAX_PATH ];
+         sprintf (msg, "Install Emacs at %s?\n", emacs_path);
+         result = MessageBox (NULL, msg, "Install Emacs",
+                              MB_OKCANCEL | MB_ICONQUESTION);
+         if (result != IDOK)
+           {
+             fprintf (stderr, "Install cancelled\n");
+             exit (1);
+           }
+       }
+    }
+
+  add_registry (emacs_path);
+  prog_name =  "runemacs.exe";
+
+  /* Try to install globally.  */
+
+  if (!SUCCEEDED (CoInitialize (NULL))
+      || !SUCCEEDED (CoCreateInstance (&CLSID_ShellLink, NULL,
+                                       CLSCTX_INPROC_SERVER, &IID_IShellLinkA,
+                                       (void **) &shortcut)))
+    {
+      com_available = 0;
+    }
+
+  if (com_available
+      && SHGetSpecialFolderPath (NULL, start_folder, CSIDL_COMMON_PROGRAMS, 0))
+    {
+      if (strlen (start_folder) < (MAX_PATH - 20))
+       {
+         BOOL retval;
+
+         strcat (start_folder, "\\Gnu Emacs");
+         if (CreateDirectory (start_folder, NULL)
+             || GetLastError () == ERROR_ALREADY_EXISTS)
+           {
+             char full_emacs_path[MAX_PATH + 1];
+             IPersistFile *lnk;
+             strcat (start_folder, "\\Emacs.lnk");
+             sprintf (full_emacs_path, "%s\\bin\\%s", emacs_path, prog_name);
+             IShellLinkA_SetPath (shortcut, full_emacs_path);
+             IShellLinkA_SetDescription (shortcut, "GNU Emacs");
+             result = IShellLinkA_QueryInterface (shortcut, &IID_IPersistFile,
+                                                  (void **) &lnk);
+             if (SUCCEEDED (result))
+               {
+                 wchar_t unicode_path[MAX_PATH];
+                 MultiByteToWideChar (CP_ACP, 0, start_folder, -1,
+                                      unicode_path, MAX_PATH);
+                 if (SUCCEEDED (IPersistFile_Save (lnk, unicode_path, TRUE)))
+                   shortcuts_created = 1;
+                 IPersistFile_Release (lnk);
+               }
+           }
+       }
+    }
+
+  if (!shortcuts_created && com_available
+      && SHGetSpecialFolderPath (NULL, start_folder, CSIDL_PROGRAMS, 0))
     {
-      DdeCommand ("[CreateGroup (Gnu Emacs)]");
-      DdeCommand ("[ReplaceItem (Emacs)]");
-      sprintf (additem, "[AddItem (%s\\bin\\runemacs.%s, Emacs%c%s)]",
-              argv[1], lpext, (argc>2 ? ',' : ' '),
-              (argc>2 ? argv[2] : ""));
-      DdeCommand (additem);
-
-      DdeDisconnect (HConversation);
+      /* Ensure there is enough room for "...\GNU Emacs\Emacs.lnk".  */
+      if (strlen (start_folder) < (MAX_PATH - 20))
+       {
+         BOOL retval;
+
+         strcat (start_folder, "\\Gnu Emacs");
+         if (CreateDirectory (start_folder, NULL)
+             || GetLastError () == ERROR_ALREADY_EXISTS)
+           {
+             char full_emacs_path[MAX_PATH + 1];
+             IPersistFile *lnk;
+             strcat (start_folder, "\\Emacs.lnk");
+             sprintf (full_emacs_path, "%s\\bin\\%s", emacs_path, prog_name);
+             IShellLinkA_SetPath (shortcut, full_emacs_path);
+             IShellLinkA_SetDescription (shortcut, "GNU Emacs");
+             result = IShellLinkA_QueryInterface (shortcut, &IID_IPersistFile,
+                                                  (void **) &lnk);
+             if (SUCCEEDED (result))
+               {
+                 wchar_t unicode_path[MAX_PATH];
+                 MultiByteToWideChar (CP_ACP, 0, start_folder, -1,
+                                      unicode_path, MAX_PATH);
+                 if (SUCCEEDED (IPersistFile_Save (lnk, unicode_path, TRUE)))
+                   shortcuts_created = 1;
+                 IPersistFile_Release (lnk);
+                 
+               }
+           }
+       }      
     }
 
-  DdeFreeStringHandle (idDde, ProgMan);
+  if (com_available)
+    IShellLinkA_Release (shortcut);
 
-  DdeUninitialize (idDde);
+  /* Need to call uninitialize, even if ComInitialize failed.  */
+  CoUninitialize ();
+
+  /* Fallback on old DDE method if the above failed.  */
+  if (!shortcuts_created)
+    {
+      DWORD dde = 0;
+      HCONV conversation;
+      HSZ progman;
+      char add_item[MAX_PATH*2 + 100];
 
-  return (0);
+      DdeInitialize (&dde, (PFNCALLBACK) DdeCallback, APPCMD_CLIENTONLY, 0);
+      progman = DdeCreateStringHandle (dde, "PROGMAN", CP_WINANSI);
+      conversation = DdeConnect (dde, progman, progman, NULL);
+      if (conversation)
+       {
+         DdeCommand ("[CreateGroup (\"Gnu Emacs\")]");
+         DdeCommand ("[ReplaceItem (Emacs)]");
+         sprintf (add_item, "[AddItem (\"%s\\bin\\%s\", Emacs)]",
+                  emacs_path, prog_name);
+         DdeCommand (add_item);
+
+         DdeDisconnect (conversation);
+       }
+
+      DdeFreeStringHandle (dde, progman);
+      DdeUninitialize (dde);
+   }
+
+  return 0;
 }
+
+/* arch-tag: f923609d-b781-4ef4-abce-ca0da29cbbf0
+   (do not change this comment) */