move path_expand() and search_path_expand() into libpbd, and use them to expand searc...
[ardour.git] / libs / ardour / utils.cc
index 0cefd62137edf12037a92fc73943e5c567bd83a1..aedc78988fb293a137536ad7e01a48d66ea15c5e 100644 (file)
@@ -60,17 +60,91 @@ using namespace ARDOUR;
 using namespace std;
 using namespace PBD;
 
+static string
+replace_chars (const string& str, const string& illegal_chars)
+{
+       string::size_type pos;
+       Glib::ustring legal;
+
+       /* this is the one place in Ardour where we need to iterate across
+        * potential multibyte characters, and thus we need Glib::ustring
+        */
+
+       legal = str;
+       pos = 0;
+
+       while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
+               legal.replace (pos, 1, "_");
+               pos += 1;
+       }
+
+       return string (legal);
+}
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 3.X
+ * and later version of this code. It defines a very small number of characters
+ * that are not allowed in a path on the build target filesystem (basically,
+ * POSIX or Windows) and replaces any instances of them with an underscore.
+ *
+ * NOTE: this is intended only to legalize for the filesystem that Ardour
+ * is running on. Export should use legalize_for_universal_path() since
+ * the goal there is to be legal across filesystems.
+ */
 string
 legalize_for_path (const string& str)
+{
+       return replace_chars (str, "/\\");
+}
+
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 3.X
+ * and later version of this code. It defines a small number
+ * of characters that are not allowed in a path on any of our target
+ * filesystems, and replaces any instances of them with an underscore.
+ *
+ * NOTE: this is intended to create paths that should be legal on
+ * ANY filesystem.
+ */
+string
+legalize_for_universal_path (const string& str)
+{
+       return replace_chars (str, "<>:\"/\\|?*");
+}
+
+/** Legalize for a URI path component.  This is like
+ * legalize_for_universal_path, but stricter, disallowing spaces and hash.
+ * This avoids %20 escapes in URIs, but probably needs work to be more strictly
+ * correct.
+ */
+string
+legalize_for_uri (const string& str)
+{
+       return replace_chars (str, "<>:\"/\\|?* #");
+}
+
+/** take an arbitrary string as an argument, and return a version of it
+ * suitable for use as a path (directory/folder name). This is the Ardour 2.X
+ * version of this code, which used an approach that came to be seen as
+ * problematic: defining the characters that were allowed and replacing all
+ * others with underscores. See legalize_for_path() for the 3.X and later
+ * version.
+ */
+
+string 
+legalize_for_path_2X (const string& str)
 {
        string::size_type pos;
-       string illegal_chars = "/\\"; /* DOS, POSIX. Yes, we're going to ignore HFS */
-       string legal;
+       string legal_chars = "abcdefghijklmnopqrtsuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_+=: ";
+        Glib::ustring legal;
+       
+       /* this is the one place in Ardour where we need to iterate across
+        * potential multibyte characters, and thus we need Glib::ustring
+        */
 
        legal = str;
        pos = 0;
 
-       while ((pos = legal.find_first_of (illegal_chars, pos)) != string::npos) {
+       while ((pos = legal.find_first_not_of (legal_chars, pos)) != string::npos) {
                legal.replace (pos, 1, "_");
                pos += 1;
        }
@@ -120,46 +194,6 @@ bump_name_once (const std::string& name, char delimiter)
 
 }
 
-bool
-could_be_a_valid_path (const string& path)
-{
-        vector<string> posix_dirs;
-        vector<string> dos_dirs;
-        string testpath;
-
-        split (path, posix_dirs, '/');
-        split (path, dos_dirs, '\\');
-
-        /* remove the last component of each */
-
-        posix_dirs.erase (--posix_dirs.end());
-        dos_dirs.erase (--dos_dirs.end());
-
-        if (G_DIR_SEPARATOR == '/') {
-                for (vector<string>::iterator x = posix_dirs.begin(); x != posix_dirs.end(); ++x) {
-                        testpath = Glib::build_filename (testpath, *x);
-                        cerr << "Testing " << testpath << endl;
-                        if (!Glib::file_test (testpath, Glib::FILE_TEST_IS_DIR|Glib::FILE_TEST_EXISTS)) {
-                                return false;
-                        }
-                }
-        }
-
-        if (G_DIR_SEPARATOR == '\\') {
-                testpath = "";
-                for (vector<string>::iterator x = dos_dirs.begin(); x != dos_dirs.end(); ++x) {
-                        testpath = Glib::build_filename (testpath, *x);
-                        cerr << "Testing " << testpath << endl;
-                        if (!Glib::file_test (testpath, Glib::FILE_TEST_IS_DIR|Glib::FILE_TEST_EXISTS)) {
-                                return false;
-                        }
-                }
-        }
-
-        return true;
-}
-
-
 XMLNode *
 find_named_node (const XMLNode& node, string name)
 {
@@ -273,79 +307,6 @@ path_is_paired (string path, string& pair_base)
        return false;
 }
 
-string
-path_expand (string path)
-{
-        if (path.empty()) {
-                return path;
-        }
-
-        /* tilde expansion */
-
-        if (path[0] == '~') {
-                if (path.length() == 1) {
-                        return Glib::get_home_dir();
-                }
-
-                if (path[1] == '/') {
-                        path.replace (0, 1, Glib::get_home_dir());
-                } else {
-                        /* can't handle ~roger, so just leave it */
-                }
-        }
-
-       /* now do $VAR substitution, since wordexp isn't reliable */
-
-       regex_t compiled_pattern;
-       const int nmatches = 100;
-       regmatch_t matches[nmatches];
-       
-       if (regcomp (&compiled_pattern, "\\$([a-zA-Z_][a-zA-Z0-9_]*|\\{[a-zA-Z_][a-zA-Z0-9_]*\\})", REG_EXTENDED)) {
-                cerr << "bad regcomp\n";
-                return path;
-        }
-
-       while (true) { 
-
-                cerr << "working on " << path << endl;
-
-               if (regexec (&compiled_pattern, path.c_str(), nmatches, matches, 0)) {
-                       break;
-               }
-               
-               /* matches[0] gives the entire match */
-               
-               string match = path.substr (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so);
-               
-               /* try to get match from the environment */
-
-                if (match[1] == '{') {
-                        /* ${FOO} form */
-                        match = match.substr (2, match.length() - 3);
-                }
-
-               char* matched_value = getenv (match.c_str());
-
-               if (matched_value) {
-                       path.replace (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so, matched_value);
-               } else {
-                       path.replace (matches[0].rm_so, matches[0].rm_eo - matches[0].rm_so, string());
-                }
-
-               /* go back and do it again with whatever remains after the
-                * substitution 
-                */
-       }
-
-       regfree (&compiled_pattern);
-
-       /* canonicalize */
-
-       char buf[PATH_MAX+1];
-       realpath (path.c_str(), buf);
-       return buf;
-}
-
 #if __APPLE__
 string
 CFStringRefToStdString(CFStringRef stringRef)
@@ -458,7 +419,14 @@ sync_source_to_string (SyncSource src, bool sh)
                }
 
        case MIDIClock:
-               return _("MIDI Clock");
+               if (sh) {
+                       return _("M-Clock");
+               } else {
+                       return _("MIDI Clock");
+               }
+
+       case LTC:
+               return _("LTC");
        }
        /* GRRRR .... stupid, stupid gcc - you can't get here from there, all enum values are handled */
        return _("JACK");
@@ -594,25 +562,6 @@ bool_as_string (bool yn)
        return (yn ? "yes" : "no");
 }
 
-bool
-string_is_affirmative (const std::string& str)
-{
-       /* to be used only with XML data - not intended to handle user input */
-
-       if (str.empty ()) {
-               return false;
-       }
-
-       /* the use of g_strncasecmp() is solely to get around issues with
-        * charsets posed by trying to use C++ for the same
-        * comparison. switching a std::string to its lower- or upper-case
-        * version has several issues, but handled by default
-        * in the way we desire when doing it in C.
-        */
-
-       return str == "1" || str == "y" || str == "Y" || (!g_strncasecmp(str.c_str(), "yes", str.length()));
-}
-
 const char*
 native_header_format_extension (HeaderFormat hf, const DataType& type)
 {