]> git.donarmstrong.com Git - lilypond.git/blobdiff - lily/relocate.cc
Run grand-replace (issue 3765)
[lilypond.git] / lily / relocate.cc
index 635b4165c9b2039bdda7fe8654795665ff81beaa..f4cee071af9b048d9aa9aebad6ed7de7b9a95cd7 100644 (file)
@@ -1,17 +1,26 @@
 /*
-  relocate.cc -- implement relocation based on argv0
+  This file is part of LilyPond, the GNU music typesetter.
 
-  source file of the GNU LilyPond music typesetter
+  Copyright (C) 2005--2014 Han-Wen Nienhuys <hanwen@xs4all.nl>
 
-  (c) 2005--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+  LilyPond 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 3 of the License, or
+  (at your option) any later version.
 
+  LilyPond is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  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 LilyPond.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 #include "relocate.hh"
 
 #include "config.hh"
 
-
 /* TODO: autoconf support */
 
 #include <sys/types.h>
 #define FRAMEWORKDIR ".."
 
 int
-sane_putenv (char const *key, string value, bool overwrite)
+sane_putenv (char const *key, const string &value, bool overwrite)
 {
   if (overwrite || !getenv (key))
     {
       string combine = string (key) + "=" + value;
       char *s = strdup (combine.c_str ());
 
-      if (be_verbose_global)
-       progress_indication (_f ("Setting %s to %s" , key, value.c_str ())
-                            + "\n");
-                            
-      int retval =  putenv (s);
+      debug_output (_f ("Setting %s to %s", key, value.c_str ())
+                    + "\n");
+
+      int retval = putenv (s);
       /*
-       unfortunately, we can't portably free S here,
-       due to various bugs in glibc prior to 2.1.1
-       */ 
+        unfortunately, we can't portably free S here,
+        due to various bugs in glibc prior to 2.1.1
+      */
       return retval;
     }
-  
+
   return -1;
 }
 
 static int
-set_env_file (char const *key, string value, bool overwrite = false)
+set_env_file (char const *key, const string &value, bool overwrite = false)
 {
   if (is_file (value))
     return sane_putenv (key, value, overwrite);
-  else if (be_verbose_global)
+  else if (is_loglevel (LOG_DEBUG))
+    // this warning should only be printed in debug mode!
     warning (_f ("no such file: %s for %s", value, key));
   return -1;
 }
 
 static int
-set_env_dir (char const *key, string value)
+set_env_dir (char const *key, const string &value)
 {
   if (is_dir (value))
     return sane_putenv (key, value, false);
-  else if (be_verbose_global)
+  else if (is_loglevel (LOG_DEBUG))
+    // this warning should only be printed in debug mode!
     warning (_f ("no such directory: %s for %s", value, key));
   return -1;
 }
@@ -80,15 +90,15 @@ prepend_env_path (char const *key, string value)
 {
   if (is_dir (value))
     {
-      if (be_verbose_global)
-       progress_indication (_f ("%s=%s (prepend)\n", key, value.c_str ())); 
+      debug_output (_f ("%s=%s (prepend)\n", key, value.c_str ()), false);
 
       if (char const *cur = getenv (key))
-       value += to_string (PATHSEP) + cur;
+        value += to_string (PATHSEP) + cur;
 
       return sane_putenv (key, value.c_str (), true);
     }
-  else if (be_verbose_global)
+  else if (is_loglevel (LOG_DEBUG))
+    // this warning should only be printed in debug mode
     warning (_f ("no such directory: %s for %s", value, key));
   return -1;
 }
@@ -97,23 +107,22 @@ prepend_env_path (char const *key, string value)
 #include <winbase.h>
 #endif
 
-void
-prefix_relocation (string prefix)
+static void
+prefix_relocation (const string &prefix)
 {
-  if (be_verbose_global)
-    warning (_f ("Relocation: compile prefix=%s, new prefix=%s",
-                prefix_directory,
-                prefix.c_str ()));
-  
   string bindir = prefix + "/bin";
   string datadir = prefix + "/share";
   string localedir = datadir + "/locale";
-  string lilypond_datadir = datadir + "/lilypond/";
+  string package_datadir = datadir + "/lilypond/";
+  string old_lilypond_datadir = lilypond_datadir;
 
-  if (is_dir (lilypond_datadir + "/" + TOPLEVEL_VERSION))
-    prefix_directory = lilypond_datadir + "/" + TOPLEVEL_VERSION;
-  else if (is_dir (lilypond_datadir + "/current"))
-    prefix_directory = lilypond_datadir + "/current";
+  if (is_dir (package_datadir + "/" + TOPLEVEL_VERSION))
+    lilypond_datadir = package_datadir + "/" + TOPLEVEL_VERSION;
+  else if (is_dir (package_datadir + "/current"))
+    lilypond_datadir = package_datadir + "/current";
+  else
+    warning (_f ("not relocating, no %s/ or current/ found under %s",
+                 TOPLEVEL_VERSION, package_datadir.c_str ()));
 
 #if HAVE_GETTEXT
   if (is_dir (localedir))
@@ -121,212 +130,194 @@ prefix_relocation (string prefix)
 #endif
 
   prepend_env_path ("PATH", bindir);
+
+  debug_output (_f ("Relocation: compile datadir=%s, new datadir=%s",
+                    old_lilypond_datadir.c_str (),
+                    lilypond_datadir.c_str ()));
 }
 
 /*
   UGH : this is a complete mess.
- */
+*/
 
-void
-framework_relocation (string prefix)
+static void
+framework_relocation (const string &prefix)
 {
-  if (be_verbose_global)
-    warning (_f ("Relocation: framework_prefix=%s", prefix));
+  debug_output (_f ("Relocation: framework_prefix=%s", prefix));
 
   sane_putenv ("INSTALLER_PREFIX", prefix, true);
-              
+
   read_relocation_dir (prefix + "/etc/relocate/");
 
   string bindir = prefix + "/bin";
-  
+
   prepend_env_path ("PATH", bindir);
 }
 
 /*
   UGH : this is a complete mess.
- */
+*/
 void
 setup_paths (char const *argv0_ptr)
 {
   File_name argv0_filename (argv0_ptr);
-  
-  prefix_directory = LILYPOND_DATADIR;
-  if (relocate_binary
-      && getenv ("LILYPOND_RELOCATE_PREFIX"))
-    {
-      prefix_directory = getenv ("LILYPOND_RELOCATE_PREFIX");
-#ifdef __MINGW32__
-      /* Normalize file name.  */
-      prefix_directory = File_name (prefix_directory).to_string ();
-#endif /* __MINGW32__ */
-      
-      prefix_relocation (prefix_directory);
-      string bindir = prefix_directory + "/bin";
-      framework_relocation (bindir);
-    }
-  else if (relocate_binary)
+
+  if (relocate_binary)
     {
+      string prefix_directory;
       string argv0_abs;
       if (argv0_filename.is_absolute ())
-       {
-         argv0_abs = argv0_filename.to_string ();
-         if (be_verbose_global)
-           warning (_f ("Relocation: is absolute: argv0=%s", argv0_ptr));
-       }
+        {
+          argv0_abs = argv0_filename.to_string ();
+          debug_output (_f ("Relocation: is absolute: argv0=%s\n", argv0_ptr));
+        }
       else if (argv0_filename.dir_.length ())
-       {
-         argv0_abs = get_working_directory ()
-           + "/" + string (argv0_filename.to_string ());
-         if (be_verbose_global)
-           warning (_f ("Relocation: from cwd: argv0=%s", argv0_ptr));
-       }
+        {
+          argv0_abs = get_working_directory ()
+                      + "/" + string (argv0_filename.to_string ());
+          debug_output (_f ("Relocation : from cwd: argv0=%s\n", argv0_ptr));
+        }
       else
-       {
-         /* Find absolute ARGV0 name, using PATH.  */
-         File_path path;
-         path.parse_path (getenv ("PATH"));
-
-         if (be_verbose_global)
-           warning (_f ("Relocation: from PATH=%s\nargv0=%s",
-                        path.to_string ().c_str (), argv0_ptr));
+        {
+          /* Find absolute ARGV0 name, using PATH.  */
+          File_path path;
+          path.parse_path (getenv ("PATH"));
 
 #ifndef __MINGW32__
-         argv0_abs = path.find (argv0_filename.to_string ());
+          argv0_abs = path.find (argv0_filename.to_string ());
 #else /* __MINGW32__ */
-         char const *ext[] = {"exe", "", 0 };
-         argv0_abs = path.find (argv0_filename.to_string (), ext);
+          path.prepend (get_working_directory ());
+          char const *ext[] = {"exe", "", 0 };
+          argv0_abs = path.find (argv0_filename.to_string (), ext);
 #endif /* __MINGW32__ */
 
-         if (argv0_abs.empty ())
-           programming_error ("cannot find absolute argv0");
-       }
+          debug_output (_f ("Relocation: from PATH=%s\nargv0=%s\n",
+                            path.to_string ().c_str (), argv0_ptr), true);
+
+          if (argv0_abs.empty ())
+            programming_error ("cannot find absolute argv0");
+        }
 
       string bindir = dir_name (argv0_abs);
       string argv0_prefix = dir_name (bindir);
-      string compile_prefix = dir_name (dir_name (dir_name (prefix_directory)));
+      string compile_prefix = dir_name (dir_name (dir_name (lilypond_datadir)));
       if (argv0_prefix != compile_prefix)
-       {
-         prefix_relocation (argv0_prefix);
-         prefix_directory = argv0_prefix;
-       }
+        {
+          prefix_relocation (argv0_prefix);
+          prefix_directory = argv0_prefix;
+        }
       if (argv0_prefix != compile_prefix || string (FRAMEWORKDIR) != "..")
-       {
-         framework_relocation (bindir + "/" + FRAMEWORKDIR);
-         prefix_directory = bindir + "/" + FRAMEWORKDIR;
-       }
+        {
+          framework_relocation (bindir + "/" + FRAMEWORKDIR);
+          prefix_directory = bindir + "/" + FRAMEWORKDIR;
+        }
+
+      lilypond_datadir = prefix_directory
+                         + "/share/lilypond/" TOPLEVEL_VERSION;
     }
 
-  /* FIXME: use LILYPOND_DATADIR.  */
-  if (char const *env = getenv ("LILYPONDPREFIX"))
+  if (getenv ("LILYPONDPREFIX"))
+    error (_ ("LILYPONDPREFIX is obsolete, use LILYPOND_DATADIR"));
+
+  if (char const *env = getenv ("LILYPOND_DATADIR"))
     {
-#ifdef __MINGW32__
       /* Normalize file name.  */
-      prefix_directory = File_name (env).to_string ();
-#else
-      prefix_directory = env;
-#endif
+      lilypond_datadir = File_name (env).to_string ();
     }
 
-  global_path.append ("");
+  /* When running from build dir, a full LILYPOND_DATADIR is set-up at
+     $(OUTBASE)/{share, lib}/lilypond/current.  Configure lily using
+     ./configure --prefix=$(pwd)/out */
+  string build_datadir_current = dir_name (lilypond_datadir) + "/current";
+  if (!is_dir (lilypond_datadir.c_str ())
+      && is_dir (build_datadir_current.c_str ()))
+    lilypond_datadir = build_datadir_current;
 
+  lilypond_datadir = File_name (lilypond_datadir).canonicalized ().to_string ();
 
-  /*
-    When running from build dir, a full LILYPOND_PREFIX is set-up at
-
-        $(OUTBASE)/{share, lib}/lilypond/current
+  global_path.append ("");
 
-  */
-  
-  string build_prefix_current = prefix_directory + "/share/lilypond/" "current";
-  string build_prefix_version = prefix_directory + "/share/lilypond/" TOPLEVEL_VERSION;
-  if (is_dir (build_prefix_version.c_str ()))
-    prefix_directory = build_prefix_version;
-  else if (is_dir (build_prefix_current.c_str ()))
-    prefix_directory = build_prefix_current;
-  
   /* Adding mf/out make lilypond unchanged source directory, when setting
      LILYPONDPREFIX to lilypond-x.y.z */
   char const *suffixes[] = {"ly", "ps", "scm", 0 };
-  
+
   vector<string> dirs;
   for (char const **s = suffixes; *s; s++)
     {
-      string path = prefix_directory + to_string ('/') + string (*s);
+      string path = lilypond_datadir + to_string ('/') + string (*s);
       dirs.push_back (path);
     }
-  
-  dirs.push_back (prefix_directory + "/fonts/otf/");
-  dirs.push_back (prefix_directory + "/fonts/type1/");
-  dirs.push_back (prefix_directory + "/fonts/svg/");
-  
+
+  dirs.push_back (lilypond_datadir + "/fonts/otf/");
+  dirs.push_back (lilypond_datadir + "/fonts/type1/");
+  dirs.push_back (lilypond_datadir + "/fonts/svg/");
+
   for (vsize i = 0; i < dirs.size (); i++)
     global_path.prepend (dirs[i]);
 }
 
-
-
 string
-expand_environment_variables (string orig)
+expand_environment_variables (const string &orig)
 {
-  const char *start_ptr = orig.c_str ();
-  const char *ptr = orig.c_str ();
+  char const *start_ptr = orig.c_str ();
+  char const *ptr = orig.c_str ();
   size_t len = orig.length ();
 
   string out;
   while (ptr < start_ptr + len)
     {
-      char *dollar = strchr (ptr, '$');
-      
+      char const *dollar = strchr (ptr, '$');
+
       if (dollar != NULL)
-       {
-         char *start_var = dollar + 1;
-         char *end_var = start_var;
-         char *start_next = end_var;
-         
-         out += string (ptr, dollar - ptr);
-         ptr = dollar;
-
-         if (*start_var == '{')
-           {
-             start_var ++;
-             
-             end_var = strchr (start_var, '}');
-             
-             if (end_var == NULL)
-               {
-                 end_var = start_var + len;
-                 start_next = end_var;
-               }
-             else
-               {
-                 start_next = end_var + 1; 
-               }
-           }
-         else 
-           {
-             /*
-               Hmm. what to do for $1 , $~ etc.?
-              */
-             do
-               {
-                 end_var ++;
-               }
-             while (isalnum (*end_var) || *end_var == '_');
-             start_next = end_var;
-           }
-
-         if (start_var < end_var)
-           {
-             string var_name (start_var, end_var - start_var);
-             const char *value = getenv (var_name.c_str ());
-             if (value != NULL)
-               out += string (value);
-
-             ptr = start_next;
-           }
-       }
+        {
+          char const *start_var = dollar + 1;
+          char const *end_var = start_var;
+          char const *start_next = end_var;
+
+          out += string (ptr, dollar - ptr);
+          ptr = dollar;
+
+          if (*start_var == '{')
+            {
+              start_var++;
+
+              end_var = strchr (start_var, '}');
+
+              if (end_var == NULL)
+                {
+                  end_var = start_var + len;
+                  start_next = end_var;
+                }
+              else
+                {
+                  start_next = end_var + 1;
+                }
+            }
+          else
+            {
+              /*
+                Hmm. what to do for $1 , $~ etc.?
+              */
+              do
+                {
+                  end_var++;
+                }
+              while (isalnum (*end_var) || *end_var == '_');
+              start_next = end_var;
+            }
+
+          if (start_var < end_var)
+            {
+              string var_name (start_var, end_var - start_var);
+              char const *value = getenv (var_name.c_str ());
+              if (value != NULL)
+                out += string (value);
+
+              ptr = start_next;
+            }
+        }
       else
-       break;
+        break;
 
     }
 
@@ -335,26 +326,23 @@ expand_environment_variables (string orig)
   return out;
 }
 
-
-string
+// Ugh - very inefficient, but safer than fgets.
+static string
 read_line (FILE *f)
 {
   string out;
-  
+
   int c = 0;
   while ((c = fgetc (f)) != EOF && c != '\n')
-    out += c;
+    out += char (c);
 
   return out;
 }
 
 void
-read_relocation_file (string filename)
+read_relocation_file (const string &filename)
 {
-  if (be_verbose_global)
-    progress_indication (_f ("Relocation file: %s", filename.c_str ())
-                        + "\n");
-      
+  debug_output (_f ("Relocation file: %s", filename.c_str ()) + "\n");
   char const *cname = filename.c_str ();
   FILE *f = fopen (cname, "r");
   if (!f)
@@ -365,13 +353,13 @@ read_relocation_file (string filename)
       string line = read_line (f);
       size_t idx = line.find (' ');
       if (idx == NPOS)
-       continue;
-      
+        continue;
+
       string command = line.substr (0, idx);
       line = line.substr (idx + 1);
-      
+
       if (idx == NPOS)
-       continue;
+        continue;
       idx = line.find ('=');
 
       string variable = line.substr (0, idx);
@@ -380,28 +368,28 @@ read_relocation_file (string filename)
       value = expand_environment_variables (value);
 
       if (command == "set")
-       sane_putenv (variable.c_str (), value, true);
+        sane_putenv (variable.c_str (), value, true);
       else if (command == "setdir")
-       set_env_dir (variable.c_str (), value);
+        set_env_dir (variable.c_str (), value);
       else if (command == "setfile")
-       set_env_file (variable.c_str (), value);
+        set_env_file (variable.c_str (), value);
       else if (command == "prependdir")
-       prepend_env_path (variable.c_str (), value);
+        prepend_env_path (variable.c_str (), value);
       else
-       error (_f ("Unknown relocation command %s", command));
+        error (_f ("Unknown relocation command %s", command));
     }
 
   fclose (f);
 }
 
 void
-read_relocation_dir (string dirname)
+read_relocation_dir (const string &dirname)
 {
   if (DIR *dir = opendir (dirname.c_str ()))
     while (struct dirent *ent = readdir (dir))
       {
-       File_name name (ent->d_name);
-       if (name.ext_ == "reloc")
-           read_relocation_file (dirname + "/" + name.to_string ());
+        File_name name (ent->d_name);
+        if (name.ext_ == "reloc")
+          read_relocation_file (dirname + "/" + name.to_string ());
       }
 }