Revert to old Lock mode (still called Lock).
[ardour.git] / libs / ardour / utils.cc
index 63125ed8cb8652ab0adafbe79489fa00d872c95c..6d6511bb9f5f377c29d7cd4eb014fcdefe54e45f 100644 (file)
@@ -25,6 +25,8 @@
 
 #include <cstdio> /* for sprintf */
 #include <cstring>
+#include <climits>
+#include <cstdlib>
 #include <cmath>
 #include <cctype>
 #include <cstring>
 #include <sys/stat.h>
 #include <sys/time.h>
 #include <fcntl.h>
+#ifndef COMPILER_MSVC
 #include <dirent.h>
+#endif
 #include <errno.h>
+#include <regex.h>
 
 #include <glibmm/miscutils.h>
 #include <glibmm/fileutils.h>
 
-#ifdef HAVE_WORDEXP
-#include <wordexp.h>
-#endif
-
 #include "pbd/cpus.h"
 #include "pbd/error.h"
 #include "pbd/stacktrace.h"
 #include "pbd/xml++.h"
 #include "pbd/basename.h"
 #include "pbd/strsplit.h"
+#include "pbd/replace_all.h"
 
 #include "ardour/utils.h"
 #include "ardour/rc_configuration.h"
@@ -60,12 +62,15 @@ using namespace ARDOUR;
 using namespace std;
 using namespace PBD;
 
-string
-legalize_for_path (const string& str)
+static string
+replace_chars (const string& str, const string& illegal_chars)
 {
        string::size_type pos;
-       string illegal_chars = "/\\"; /* DOS, POSIX. Yes, we're going to ignore HFS */
-       string legal;
+       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;
@@ -77,9 +82,80 @@ legalize_for_path (const string& str)
 
        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
+ARDOUR::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
+ARDOUR::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
-bump_name_once (const std::string& name, char delimiter)
+ARDOUR::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 
+ARDOUR::legalize_for_path_2X (const string& str)
+{
+       string::size_type pos;
+       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_not_of (legal_chars, pos)) != string::npos) {
+               legal.replace (pos, 1, "_");
+               pos += 1;
+       }
+
+       return string (legal);
+}
+
+string
+ARDOUR::bump_name_once (const std::string& name, char delimiter)
 {
        string::size_type delim;
        string newname;
@@ -120,48 +196,34 @@ bump_name_once (const std::string& name, char delimiter)
 
 }
 
-bool
-could_be_a_valid_path (const string& path)
+string
+ARDOUR::bump_name_number (const std::string& name)
 {
-        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;
-                        }
-                }
-        }
+       size_t pos = name.length();
+       size_t num = 0;
+       bool have_number = false;
+       while (pos > 0 && isdigit(name.at(--pos))) {
+               have_number = true;
+               num = pos;
+       }
 
-        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;
-                        }
-                }
-        }
+       string newname;
+       if (have_number) {
+               int32_t seq = strtol (name.c_str() + num, (char **)NULL, 10);
+               char buf[32];
+               snprintf (buf, sizeof(buf), "%d", seq + 1);
+               newname = name.substr (0, num);
+               newname += buf;
+       } else {
+               newname = name;
+               newname += "1";
+       }
 
-        return true;
+       return newname;
 }
 
-
 XMLNode *
-find_named_node (const XMLNode& node, string name)
+ARDOUR::find_named_node (const XMLNode& node, string name)
 {
        XMLNodeList nlist;
        XMLNodeConstIterator niter;
@@ -182,7 +244,7 @@ find_named_node (const XMLNode& node, string name)
 }
 
 int
-cmp_nocase (const string& s, const string& s2)
+ARDOUR::cmp_nocase (const string& s, const string& s2)
 {
        string::const_iterator p = s.begin();
        string::const_iterator p2 = s2.begin();
@@ -199,7 +261,43 @@ cmp_nocase (const string& s, const string& s2)
 }
 
 int
-touch_file (string path)
+ARDOUR::cmp_nocase_utf8 (const string& s1, const string& s2)
+{
+       const char *cstr1 = s1.c_str();
+       const char *cstr2 = s2.c_str();
+       gchar *cstr1folded = NULL;
+       gchar *cstr2folded = NULL;
+       int retval;
+
+       if (!g_utf8_validate (cstr1, -1, NULL) ||
+               !g_utf8_validate (cstr2, -1, NULL)) {
+               // fall back to comparing ASCII
+               return g_ascii_strcasecmp (cstr1, cstr2);
+       }
+
+       cstr1folded = g_utf8_casefold (cstr1, -1);
+       cstr2folded = g_utf8_casefold (cstr2, -1);
+
+       if (cstr1folded && cstr2folded) {
+               retval = strcmp (cstr1folded, cstr2folded);
+       } else {
+               // this shouldn't happen, make the best of it
+               retval = g_ascii_strcasecmp (cstr1, cstr2);
+       }
+
+       if (cstr1folded) {
+               g_free (cstr1folded);
+       }
+
+       if (cstr2folded) {
+               g_free (cstr2folded);
+       }
+
+       return retval;
+}
+
+int
+ARDOUR::touch_file (string path)
 {
        int fd = open (path.c_str(), O_RDWR|O_CREAT, 0660);
        if (fd >= 0) {
@@ -210,7 +308,7 @@ touch_file (string path)
 }
 
 string
-region_name_from_path (string path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
+ARDOUR::region_name_from_path (string path, bool strip_channels, bool add_channel_suffix, uint32_t total, uint32_t this_one)
 {
        path = PBD::basename_nosuffix (path);
 
@@ -242,7 +340,7 @@ region_name_from_path (string path, bool strip_channels, bool add_channel_suffix
 }
 
 bool
-path_is_paired (string path, string& pair_base)
+ARDOUR::path_is_paired (string path, string& pair_base)
 {
        string::size_type pos;
 
@@ -273,51 +371,9 @@ path_is_paired (string path, string& pair_base)
        return false;
 }
 
-string
-path_expand (string path)
-{
-        if (path.empty()) {
-                return path;
-        }
-
-#ifdef HAVE_WORDEXP
-       /* Handle tilde and environment variable expansion in session path */
-       string ret = path;
-
-       wordexp_t expansion;
-       switch (wordexp (path.c_str(), &expansion, WRDE_NOCMD|WRDE_UNDEF)) {
-       case 0:
-               break;
-       default:
-               error << string_compose (_("illegal or badly-formed string used for path (%1)"), path) << endmsg;
-               goto out;
-       }
-
-       if (expansion.we_wordc > 1) {
-               string all;
-               for (unsigned int i = 0; i < expansion.we_wordc; ++i) {
-                       if (i > 0) {
-                               all += " | ";
-                       } 
-                       all += expansion.we_wordv[i];
-               }
-               error << string_compose (_("path (%1) is ambiguous: %2"), path, all) << endmsg;
-               goto out;
-       }
-
-       ret = expansion.we_wordv[0];
-  out:
-       wordfree (&expansion);
-       return ret;
-
-#else
-       return path;
-#endif
-}
-
 #if __APPLE__
 string
-CFStringRefToStdString(CFStringRef stringRef)
+ARDOUR::CFStringRefToStdString(CFStringRef stringRef)
 {
        CFIndex size =
                CFStringGetMaximumSizeForEncoding(CFStringGetLength(stringRef) ,
@@ -335,7 +391,7 @@ CFStringRefToStdString(CFStringRef stringRef)
 #endif // __APPLE__
 
 void
-compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
+ARDOUR::compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
 {
        double step;
 
@@ -361,22 +417,24 @@ compute_equal_power_fades (framecnt_t nframes, float* in, float* out)
 }
 
 EditMode
-string_to_edit_mode (string str)
+ARDOUR::string_to_edit_mode (string str)
 {
        if (str == _("Splice")) {
                return Splice;
        } else if (str == _("Slide")) {
                return Slide;
+       } else if (str == _("Ripple")) {
+               return Ripple;
        } else if (str == _("Lock")) {
                return Lock;
        }
        fatal << string_compose (_("programming error: unknown edit mode string \"%1\""), str) << endmsg;
-       /*NOTREACHED*/
+       abort(); /*NOTREACHED*/
        return Slide;
 }
 
 const char*
-edit_mode_to_string (EditMode mode)
+ARDOUR::edit_mode_to_string (EditMode mode)
 {
        switch (mode) {
        case Slide:
@@ -385,6 +443,9 @@ edit_mode_to_string (EditMode mode)
        case Lock:
                return _("Lock");
 
+       case Ripple:
+               return _("Ripple");
+
        default:
        case Splice:
                return _("Splice");
@@ -392,7 +453,7 @@ edit_mode_to_string (EditMode mode)
 }
 
 SyncSource
-string_to_sync_source (string str)
+ARDOUR::string_to_sync_source (string str)
 {
        if (str == _("MIDI Timecode") || str == _("MTC")) {
                return MTC;
@@ -403,20 +464,23 @@ string_to_sync_source (string str)
        }
 
        if (str == _("JACK")) {
-               return JACK;
+               return Engine;
        }
 
        fatal << string_compose (_("programming error: unknown sync source string \"%1\""), str) << endmsg;
-       /*NOTREACHED*/
-       return JACK;
+       abort(); /*NOTREACHED*/
+       return Engine;
 }
 
 /** @param sh Return a short version of the string */
 const char*
-sync_source_to_string (SyncSource src, bool sh)
+ARDOUR::sync_source_to_string (SyncSource src, bool sh)
 {
        switch (src) {
-       case JACK:
+       case Engine:
+               /* no other backends offer sync for now ... deal with this if we
+                * ever have to.
+                */
                return _("JACK");
 
        case MTC:
@@ -427,14 +491,21 @@ 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");
 }
 
 float
-meter_falloff_to_float (MeterFalloff falloff)
+ARDOUR::meter_falloff_to_float (MeterFalloff falloff)
 {
        switch (falloff) {
        case MeterFalloffOff:
@@ -443,8 +514,12 @@ meter_falloff_to_float (MeterFalloff falloff)
                return METER_FALLOFF_SLOWEST;
        case MeterFalloffSlow:
                return METER_FALLOFF_SLOW;
+       case MeterFalloffSlowish:
+               return METER_FALLOFF_SLOWISH;
        case MeterFalloffMedium:
                return METER_FALLOFF_MEDIUM;
+       case MeterFalloffModerate:
+               return METER_FALLOFF_MODERATE;
        case MeterFalloffFast:
                return METER_FALLOFF_FAST;
        case MeterFalloffFaster:
@@ -457,7 +532,7 @@ meter_falloff_to_float (MeterFalloff falloff)
 }
 
 MeterFalloff
-meter_falloff_from_float (float val)
+ARDOUR::meter_falloff_from_float (float val)
 {
        if (val == METER_FALLOFF_OFF) {
                return MeterFalloffOff;
@@ -468,6 +543,12 @@ meter_falloff_from_float (float val)
        else if (val <= METER_FALLOFF_SLOW) {
                return MeterFalloffSlow;
        }
+       else if (val <= METER_FALLOFF_SLOWISH) {
+               return MeterFalloffSlowish;
+       }
+       else if (val <= METER_FALLOFF_MODERATE) {
+               return MeterFalloffModerate;
+       }
        else if (val <= METER_FALLOFF_MEDIUM) {
                return MeterFalloffMedium;
        }
@@ -496,7 +577,7 @@ ARDOUR::string_to_auto_state (std::string str)
        }
 
        fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState string: ", str) << endmsg;
-       /*NOTREACHED*/
+       abort(); /*NOTREACHED*/
        return Touch;
 }
 
@@ -520,7 +601,7 @@ ARDOUR::auto_state_to_string (AutoState as)
        }
 
        fatal << string_compose (_("programming error: %1 %2"), "illegal AutoState type: ", as) << endmsg;
-       /*NOTREACHED*/
+       abort(); /*NOTREACHED*/
        return "";
 }
 
@@ -534,7 +615,7 @@ ARDOUR::string_to_auto_style (std::string str)
        }
 
        fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle string: ", str) << endmsg;
-       /*NOTREACHED*/
+       abort(); /*NOTREACHED*/
        return Trim;
 }
 
@@ -553,7 +634,7 @@ ARDOUR::auto_style_to_string (AutoStyle as)
        }
 
        fatal << string_compose (_("programming error: %1 %2"), "illegal AutoStyle type: ", as) << endmsg;
-       /*NOTREACHED*/
+       abort(); /*NOTREACHED*/
        return "";
 }
 
@@ -563,27 +644,8 @@ 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)
+ARDOUR::native_header_format_extension (HeaderFormat hf, const DataType& type)
 {
         if (type == DataType::MIDI) {
                 return ".mid";
@@ -607,12 +669,12 @@ native_header_format_extension (HeaderFormat hf, const DataType& type)
         }
 
         fatal << string_compose (_("programming error: unknown native header format: %1"), hf);
-        /*NOTREACHED*/
+        abort(); /*NOTREACHED*/
         return ".wav";
 }
 
 bool
-matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
+ARDOUR::matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
 {
         string bws = basename_nosuffix (path);
        struct dirent* dentry;
@@ -657,7 +719,7 @@ matching_unsuffixed_filename_exists_in (const string& dir, const string& path)
 }
 
 uint32_t
-how_many_dsp_threads ()
+ARDOUR::how_many_dsp_threads ()
 {
         /* CALLER MUST HOLD PROCESS LOCK */
 
@@ -690,12 +752,14 @@ how_many_dsp_threads ()
         return num_threads;
 }
 
-double gain_to_slider_position_with_max (double g, double max_gain)
+double
+ARDOUR::gain_to_slider_position_with_max (double g, double max_gain)
 {
         return gain_to_slider_position (g * 2.0/max_gain);
 }
 
-double slider_position_to_gain_with_max (double g, double max_gain)
+double
+ARDOUR::slider_position_to_gain_with_max (double g, double max_gain)
 {
        return slider_position_to_gain (g * max_gain/2.0);
 }