Internat Class Reference

Internationalisation support. More...

#include <Internat.h>

Static Public Member Functions
static void	Init ()
	Initialize internationalisation support. Call this once at program start. More...
static wxChar	GetDecimalSeparator ()
	Get the decimal separator for the current locale. More...
static void	SetCeeNumberFormat ()
static bool	CompatibleToDouble (const wxString &stringToConvert, double *result)
	Convert a string to a number. More...
static double	CompatibleToDouble (const wxString &stringToConvert)
static wxString	ToString (double numberToConvert, int digitsAfterDecimalPoint=-1)
	Convert a number to a string, always uses the dot as decimal separator. More...
static wxString	ToDisplayString (double numberToConvert, int digitsAfterDecimalPoint=-1)
	Convert a number to a string, uses the user's locale's decimal separator. More...
static TranslatableString	FormatSize (wxLongLong size)
	Convert a number to a string while formatting it in bytes, KB, MB, GB. More...
static TranslatableString	FormatSize (double size)
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 "visibly" changed (not necessarily equivalent to character-wise changed) More...
static const wxArrayString &	GetExcludedCharacters ()

Static Private Attributes
static wxChar	mDecimalSeparator = wxT('.')
static wxArrayString	exclude

Detailed Description

Internationalisation support.

This class is used to help internationalisation and in general compatibility with different locales and character sets. It deals mostly with converting numbers, but also has important functions to convert to/from UTF-8, which is used in XML files and on Mac OS X for the filesystem.

Definition at line 104 of file Internat.h.

Member Function Documentation

CompatibleToDouble() [1/2]

double Internat::CompatibleToDouble ( const wxString &  stringToConvert )

static

Definition at line 148 of file Internat.cpp.

{
   double result = 0;
   Internat::CompatibleToDouble(stringToConvert, &result);
   return result;
}

References CompatibleToDouble().

Here is the call graph for this function:

CompatibleToDouble() [2/2]

bool Internat::CompatibleToDouble ( const wxString &  stringToConvert, double *  result  )

static

Convert a string to a number.

This function will accept BOTH point and comma as a decimal separator, regardless of the current locale. Returns 'true' on success, and 'false' if an error occurs.

Definition at line 139 of file Internat.cpp.

{
   // Regardless of the locale, always respect comma _and_ point
   wxString s = stringToConvert;
   s.Replace(wxT(","), wxString(GetDecimalSeparator()));
   s.Replace(wxT("."), wxString(GetDecimalSeparator()));
   return s.ToDouble(result);
}

References GetDecimalSeparator().

Referenced by PCMAliasBlockFile::BuildFromXML(), SimpleBlockFile::BuildFromXML(), CompatibleToDouble(), NyquistEffect::GetCtrlValue(), AUPImportFileHandle::HandleImport(), AUPImportFileHandle::HandleProject(), SelectedRegion::HandleXMLAttribute(), EffectEqualization::HandleXMLTag(), VSTEffect::HandleXMLTag(), EnvPoint::HandleXMLTag(), NoteTrack::HandleXMLTag(), ProjectFileIO::HandleXMLTag(), TimeTrack::HandleXMLTag(), WaveClip::HandleXMLTag(), WaveTrack::HandleXMLTag(), LabelStruct::Import(), LOFImportFileHandle::lofOpenFiles(), LadspaEffect::OnTextCtrl(), WrappedType::ReadAsDouble(), ViewInfo::ReadXMLAttribute(), and WrappedType::WriteToAsString().

Here is the call graph for this function:

Here is the caller graph for this function:

FormatSize() [1/2]

TranslatableString Internat::FormatSize ( double  size )

static

Definition at line 217 of file Internat.cpp.

{
   TranslatableString sizeStr;
 
   if (size == -1)
      sizeStr = XO("Unable to determine");
   else {
      /* make it look nice, by formatting into k, MB, etc */
      if (size < 1024.0)
         sizeStr = XO("%s bytes").Format( ToDisplayString(size) );
      else if (size < 1024.0 * 1024.0) {
         /* i18n-hint: Abbreviation for Kilo bytes */
         sizeStr = XO("%s KB").Format( ToDisplayString(size / 1024.0, 1) );
      }
      else if (size < 1024.0 * 1024.0 * 1024.0) {
         /* i18n-hint: Abbreviation for Mega bytes */
         sizeStr = XO("%s MB").Format( ToDisplayString(size / (1024.0 * 1024.0), 1) );
      }
      else {
         /* i18n-hint: Abbreviation for Giga bytes */
         sizeStr = XO("%s GB").Format( ToDisplayString(size / (1024.0 * 1024.0 * 1024.0), 1) );
      }
   }
 
   return sizeStr;
}

References ToDisplayString(), and XO.

Here is the call graph for this function:

FormatSize() [2/2]

TranslatableString Internat::FormatSize ( wxLongLong  size )

static

Convert a number to a string while formatting it in bytes, KB, MB, GB.

Definition at line 208 of file Internat.cpp.

{
   /* wxLongLong contains no built-in conversion to double */
   double dSize = size.GetHi() * pow(2.0, 32);  // 2 ^ 32
   dSize += size.GetLo();
 
   return FormatSize(dSize);
}

Referenced by ProjectFileManager::Compact(), HistoryDialog::DoUpdate(), UndoManager::GetLongDescription(), HistoryDialog::OnCompact(), DependencyDialog::OnCopyToClipboard(), DirectoriesPrefs::OnTempText(), and DependencyDialog::PopulateList().

Here is the caller graph for this function:

GetDecimalSeparator()

wxChar Internat::GetDecimalSeparator ( )

static

Get the decimal separator for the current locale.

Normally, this is a decimal point ('.'), but e.g. Germany uses a comma (',').

Definition at line 134 of file Internat.cpp.

{
   return mDecimalSeparator;
}

References mDecimalSeparator.

Referenced by CompatibleToDouble(), ToDisplayString(), and ToString().

Here is the caller graph for this function:

GetExcludedCharacters()

static const wxArrayString& Internat::GetExcludedCharacters ( )

inlinestatic

Definition at line 150 of file Internat.h.

   { return exclude; }

Referenced by ExportMultipleDialog::MakeFileName().

Here is the caller graph for this function:

Init()

void Internat::Init ( )

static

Initialize internationalisation support. Call this once at program start.

Definition at line 83 of file Internat.cpp.

{
   // Save decimal point character
   struct lconv * localeInfo = localeconv();
   if (localeInfo)
      mDecimalSeparator = wxString(wxSafeConvertMB2WX(localeInfo->decimal_point)).GetChar(0);
 
//   wxLogDebug(wxT("Decimal separator set to '%c'"), mDecimalSeparator);
 
   // Setup list of characters that aren't allowed in file names
   // Hey!  The default wxPATH_NATIVE does not do as it should.
#if defined(__WXMAC__)
   wxPathFormat format = wxPATH_MAC;
#elif defined(__WXGTK__)
   wxPathFormat format = wxPATH_UNIX;
#elif defined(__WXMSW__)
   wxPathFormat format = wxPATH_WIN;
#endif
 
   // This is supposed to return characters not permitted in paths to files
   // or to directories
   auto forbid = wxFileName::GetForbiddenChars(format);
 
   for (auto cc: forbid) {
#if defined(__WXGTK__)
      if (cc == wxT('*') || cc == wxT('?')) {
         continue;
      }
#endif
      exclude.push_back(wxString{ cc });
   }
 
   // The path separators may not be forbidden, so add them
   //auto separators = wxFileName::GetPathSeparators(format);
 
   // Bug 1441 exclude all separators from filenames on all platforms.
   auto separators = wxString("\\/");
 
   for(auto cc: separators) {
      if (forbid.Find(cc) == wxNOT_FOUND)
         exclude.push_back(wxString{ cc });
   }
}

References format, and mDecimalSeparator.

Referenced by GUIPrefs::SetLang().

Here is the caller graph for this function:

SanitiseFilename()

bool Internat::SanitiseFilename ( wxString &  name, const wxString &  sub  )

static

Check a proposed file name string for illegal characters and remove them return true iff name is "visibly" changed (not necessarily equivalent to character-wise changed)

Definition at line 244 of file Internat.cpp.

{
   bool result = false;
   for(const auto &item : exclude)
   {
      if(name.Contains(item))
      {
         name.Replace(item, sub);
         result = true;
      }
   }
 
#ifdef __WXMAC__
   // Special Mac stuff
   // '/' is permitted in file names as seen in dialogs, even though it is
   // the path separator.  The "real" filename as seen in the terminal has ':'.
   // Do NOT return true if this is the only substitution.
   name.Replace(wxT("/"), wxT(":"));
#endif
 
   return result;
}

References exclude, and name.

Referenced by ExportMultipleDialog::MakeFileName().

Here is the caller graph for this function:

SetCeeNumberFormat()

void Internat::SetCeeNumberFormat ( )

static

Definition at line 127 of file Internat.cpp.

{
   wxSetlocale( LC_NUMERIC, "C" );
   mDecimalSeparator = '.';
}

References mDecimalSeparator.

Referenced by GUIPrefs::SetLang().

Here is the caller graph for this function:

ToDisplayString()

wxString Internat::ToDisplayString ( double  numberToConvert, int  digitsAfterDecimalPoint = -1  )

static

Convert a number to a string, uses the user's locale's decimal separator.

Definition at line 166 of file Internat.cpp.

{
   wxString decSep = wxString(GetDecimalSeparator());
   wxString result;
 
   if (digitsAfterDecimalPoint == -1)
   {
      result.Printf(wxT("%f"), numberToConvert);
 
      // Not all libcs respect the decimal separator, so always convert
      // any dots found to the decimal separator.
      result.Replace(wxT("."), decSep);
 
      if (result.Find(decSep) != -1)
      {
         // Strip trailing zeros, but leave one, and decimal separator.
         int pos = result.length() - 1;
         while ((pos > 1) &&
                  (result.GetChar(pos) == wxT('0')) &&
                  (result.GetChar(pos - 1) != decSep))
            pos--;
         // (Previous code removed all of them and decimal separator.)
         //    if (result.GetChar(pos) == decSep)
         //       pos--; // strip point before empty fractional part
         result = result.Left(pos+1);
      }
   }
   else
   {
      wxString format;
      format.Printf(wxT("%%.%if"), digitsAfterDecimalPoint);
      result.Printf(format, numberToConvert);
 
      // Not all libcs respect the decimal separator, so always convert
      // any dots found to the decimal separator
      result.Replace(wxT("."), decSep);
   }
 
   return result;
}

References format, and GetDecimalSeparator().

Referenced by LV2Effect::BuildPlain(), FormatSize(), EffectAutoDuckPanel::OnPaint(), LadspaEffect::OnSlider(), VampEffect::PopulateOrExchange(), LadspaEffect::PopulateUI(), LadspaEffect::RefreshControls(), and ToString().

Here is the call graph for this function:

Here is the caller graph for this function:

ToString()

wxString Internat::ToString ( double  numberToConvert, int  digitsAfterDecimalPoint = -1  )

static

Convert a number to a string, always uses the dot as decimal separator.

Definition at line 155 of file Internat.cpp.

{
   wxString result = ToDisplayString(
      numberToConvert, digitsAfterDecimalPoint);
 
   result.Replace(wxString(GetDecimalSeparator()), wxT("."));
 
   return result;
}

References GetDecimalSeparator(), and ToDisplayString().

Referenced by LabelStruct::Export(), Sequence::HandleXMLEndTag(), Sequence::Paste(), NyquistEffect::Process(), NyquistEffect::ProcessOne(), XMLWriter::WriteAttr(), and Sequence::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

exclude

wxArrayString Internat::exclude

staticprivate

Definition at line 156 of file Internat.h.

Referenced by SanitiseFilename().

mDecimalSeparator

wxChar Internat::mDecimalSeparator = wxT('.')

staticprivate

Definition at line 154 of file Internat.h.

Referenced by GetDecimalSeparator(), Init(), and SetCeeNumberFormat().

---

The documentation for this class was generated from the following files:

• Internat.h
• Internat.cpp