Audacity  3.0.3
Internat.cpp
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity: A Digital Audio Editor
4 
5  Internat.cpp
6 
7  Markus Meyer
8  Dominic Mazzoni (Mac OS X code)
9 
10 *******************************************************************//*******************************************************************/
22 
23 #include "Internat.h"
24 
25 #include <wx/log.h>
26 #include <wx/intl.h>
27 #include <wx/filename.h>
28 
29 #include <locale.h>
30 #include <math.h> // for pow()
31 
32 // in order for the static member variables to exist, they must appear here
33 // (_outside_) the class definition, in order to be allocated some storage.
34 // Otherwise, you get link errors.
35 
36 wxChar Internat::mDecimalSeparator = wxT('.'); // default
37 // exclude is used by SanitiseFilename.
38 wxArrayString Internat::exclude;
39 
40 // DA: Use tweaked translation mechanism to replace 'Audacity' by 'DarkAudacity'.
41 #ifdef EXPERIMENTAL_DA
42 // This function allows us to replace Audacity by DarkAudacity without peppering
43 // the source code with changes. We split out this step, the customisation, as
44 // it is used on its own (without translation) in the wxTS macro.
45 STRINGS_API const wxString& GetCustomSubstitution(const wxString& str2)
46 {
47  // If contains 'DarkAudacity, already converted.
48  if( str2.Contains( "DarkAudacity" ))
49  return str2;
50  // If does not contain 'Audacity', nothing to do.
51  if( !str2.Contains( "Audacity" ))
52  return str2;
53  wxString str3 = str2;
54  str3.Replace( "Audacity", "DarkAudacity" );
55  str3.Replace( " an DarkAudacity", " a DarkAudacity" );
56  // DA also renames sync-lock(ed) as time-lock(ed).
57  str3.Replace( "Sync-Lock", "Time-Lock" );
58  str3.Replace( "Sync-&Lock", "Time-&Lock" );
59  str3.Replace( "Sync Lock", "Time Lock" );
60  return wxTranslations::GetUntranslatedString(str3);
61 }
62 #else
63 STRINGS_API const wxString& GetCustomSubstitution(const wxString& str1)
64 {
65  return str1 ;
66 }
67 #endif
68 
69 // In any translated string, we can replace the name 'Audacity' by 'DarkAudacity'
70 // without requiring translators to see extra strings for the two versions.
71 STRINGS_API const wxString& GetCustomTranslation(const wxString& str1)
72 {
73  const wxString& str2 = wxGetTranslation( str1 );
74  return GetCustomSubstitution( str2 );
75 }
76 
77 
79 {
80  // Save decimal point character
81  struct lconv * localeInfo = localeconv();
82  if (localeInfo)
83  mDecimalSeparator = wxString(wxSafeConvertMB2WX(localeInfo->decimal_point)).GetChar(0);
84 
85 // wxLogDebug(wxT("Decimal separator set to '%c'"), mDecimalSeparator);
86 
87  // Setup list of characters that aren't allowed in file names
88  // Hey! The default wxPATH_NATIVE does not do as it should.
89 #if defined(__WXMAC__)
90  wxPathFormat format = wxPATH_MAC;
91 #elif defined(__WXGTK__)
92  wxPathFormat format = wxPATH_UNIX;
93 #elif defined(__WXMSW__)
94  wxPathFormat format = wxPATH_WIN;
95 #endif
96 
97  // This is supposed to return characters not permitted in paths to files
98  // or to directories
99  auto forbid = wxFileName::GetForbiddenChars(format);
100 
101  for (auto cc: forbid) {
102 #if defined(__WXGTK__)
103  if (cc == wxT('*') || cc == wxT('?')) {
104  continue;
105  }
106 #endif
107  exclude.push_back(wxString{ cc });
108  }
109 
110  // The path separators may not be forbidden, so add them
111  //auto separators = wxFileName::GetPathSeparators(format);
112 
113  // Bug 1441 exclude all separators from filenames on all platforms.
114  auto separators = wxString("\\/");
115 
116  for(auto cc: separators) {
117  if (forbid.Find(cc) == wxNOT_FOUND)
118  exclude.push_back(wxString{ cc });
119  }
120 }
121 
123 {
124  wxSetlocale( LC_NUMERIC, "C" );
125  mDecimalSeparator = '.';
126 }
127 
128 
130 {
131  return mDecimalSeparator;
132 }
133 
134 bool Internat::CompatibleToDouble(const wxString& stringToConvert, double* result)
135 {
136  // Regardless of the locale, always respect comma _and_ point
137  wxString s = stringToConvert;
138  s.Replace(wxT(","), wxString(GetDecimalSeparator()));
139  s.Replace(wxT("."), wxString(GetDecimalSeparator()));
140  return s.ToDouble(result);
141 }
142 
143 double Internat::CompatibleToDouble(const wxString& stringToConvert)
144 {
145  double result = 0;
146  Internat::CompatibleToDouble(stringToConvert, &result);
147  return result;
148 }
149 
150 wxString Internat::ToString(double numberToConvert,
151  int digitsAfterDecimalPoint /* = -1 */)
152 {
153  wxString result = ToDisplayString(
154  numberToConvert, digitsAfterDecimalPoint);
155 
156  result.Replace(wxString(GetDecimalSeparator()), wxT("."));
157 
158  return result;
159 }
160 
161 wxString Internat::ToDisplayString(double numberToConvert,
162  int digitsAfterDecimalPoint /* = -1 */)
163 {
164  wxString decSep = wxString(GetDecimalSeparator());
165  wxString result;
166 
167  if (digitsAfterDecimalPoint == -1)
168  {
169  result.Printf(wxT("%f"), numberToConvert);
170 
171  // Not all libcs respect the decimal separator, so always convert
172  // any dots found to the decimal separator.
173  result.Replace(wxT("."), decSep);
174 
175  if (result.Find(decSep) != -1)
176  {
177  // Strip trailing zeros, but leave one, and decimal separator.
178  int pos = result.length() - 1;
179  while ((pos > 1) &&
180  (result.GetChar(pos) == wxT('0')) &&
181  (result.GetChar(pos - 1) != decSep))
182  pos--;
183  // (Previous code removed all of them and decimal separator.)
184  // if (result.GetChar(pos) == decSep)
185  // pos--; // strip point before empty fractional part
186  result = result.Left(pos+1);
187  }
188  }
189  else
190  {
191  wxString format;
192  format.Printf(wxT("%%.%if"), digitsAfterDecimalPoint);
193  result.Printf(format, numberToConvert);
194 
195  // Not all libcs respect the decimal separator, so always convert
196  // any dots found to the decimal separator
197  result.Replace(wxT("."), decSep);
198  }
199 
200  return result;
201 }
202 
204 {
205  /* wxLongLong contains no built-in conversion to double */
206  double dSize = size.GetHi() * pow(2.0, 32); // 2 ^ 32
207  dSize += size.GetLo();
208 
209  return FormatSize(dSize);
210 }
211 
213 {
214  TranslatableString sizeStr;
215 
216  if (size == -1)
217  sizeStr = XO("Unable to determine");
218  else {
219  /* make it look nice, by formatting into k, MB, etc */
220  if (size < 1024.0)
221  sizeStr = XO("%s bytes").Format( ToDisplayString(size) );
222  else if (size < 1024.0 * 1024.0) {
223  /* i18n-hint: Abbreviation for Kilo bytes */
224  sizeStr = XO("%s KB").Format( ToDisplayString(size / 1024.0, 1) );
225  }
226  else if (size < 1024.0 * 1024.0 * 1024.0) {
227  /* i18n-hint: Abbreviation for Mega bytes */
228  sizeStr = XO("%s MB").Format( ToDisplayString(size / (1024.0 * 1024.0), 1) );
229  }
230  else {
231  /* i18n-hint: Abbreviation for Giga bytes */
232  sizeStr = XO("%s GB").Format( ToDisplayString(size / (1024.0 * 1024.0 * 1024.0), 1) );
233  }
234  }
235 
236  return sizeStr;
237 }
238 
239 bool Internat::SanitiseFilename(wxString &name, const wxString &sub)
240 {
241  bool result = false;
242  for(const auto &item : exclude)
243  {
244  if(name.Contains(item))
245  {
246  name.Replace(item, sub);
247  result = true;
248  }
249  }
250 
251 #ifdef __WXMAC__
252  // Special Mac stuff
253  // '/' is permitted in file names as seen in dialogs, even though it is
254  // the path separator. The "real" filename as seen in the terminal has ':'.
255  // Do NOT return true if this is the only substitution.
256  name.Replace(wxT("/"), wxT(":"));
257 #endif
258 
259  return result;
260 }
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition: TranslatableString.h:32
GetCustomSubstitution
STRINGS_API const wxString & GetCustomSubstitution(const wxString &str1)
Definition: Internat.cpp:63
Internat::GetDecimalSeparator
static wxChar GetDecimalSeparator()
Get the decimal separator for the current locale.
Definition: Internat.cpp:129
XO
#define XO(s)
Definition: Internat.h:31
GetCustomTranslation
STRINGS_API const wxString & GetCustomTranslation(const wxString &str1)
Definition: Internat.cpp:71
Internat::FormatSize
static TranslatableString FormatSize(wxLongLong size)
Convert a number to a string while formatting it in bytes, KB, MB, GB.
Definition: Internat.cpp:203
name
const TranslatableString name
Definition: Distortion.cpp:98
format
int format
Definition: ExportPCM.cpp:56
Internat.h
Internat::SetCeeNumberFormat
static void SetCeeNumberFormat()
Definition: Internat.cpp:122
Internat::mDecimalSeparator
static wxChar mDecimalSeparator
Definition: Internat.h:153
Internat::ToDisplayString
static wxString ToDisplayString(double numberToConvert, int digitsAfterDecimalPoint=-1)
Convert a number to a string, uses the user's locale's decimal separator.
Definition: Internat.cpp:161
Internat::ToString
static wxString ToString(double numberToConvert, int digitsAfterDecimalPoint=-1)
Convert a number to a string, always uses the dot as decimal separator.
Definition: Internat.cpp:150
Internat::SanitiseFilename
static bool SanitiseFilename(wxString &name, const wxString &sub)
Check a proposed file name string for illegal characters and remove them return true iff name is "vis...
Definition: Internat.cpp:239
Internat::exclude
static wxArrayString exclude
Definition: Internat.h:155
Internat::CompatibleToDouble
static bool CompatibleToDouble(const wxString &stringToConvert, double *result)
Convert a string to a number.
Definition: Internat.cpp:134
Internat::Init
static void Init()
Initialize internationalisation support. Call this once at program start.
Definition: Internat.cpp:78