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 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 wxString	FormatSize (wxLongLong size)
	Convert a number to a string while formatting it in bytes, KB, MB, GB. More...
static wxString	FormatSize (double size)
static bool	SanitiseFilename (wxString &name, const wxString &sub)
	Protect against Unicode to multi-byte conversion failures on Windows. More...
static wxString	StripAccelerators (const wxString &str)
	Remove accelerator charactors from strings. More...
static const wxArrayString &	GetExcludedCharacters ()

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

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 86 of file Internat.h.

Member Function Documentation

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 122 of file Internat.cpp.

References GetDecimalSeparator().

Referenced by PCMAliasBlockFile::BuildFromXML(), SimpleBlockFile::BuildFromXML(), CompatibleToDouble(), NyquistEffect::GetCtrlValue(), SelectedRegion::HandleXMLAttribute(), EnvPoint::HandleXMLTag(), TimeTrack::HandleXMLTag(), ImportXMLTagHandler::HandleXMLTag(), EffectEqualization::HandleXMLTag(), WaveTrack::HandleXMLTag(), WaveClip::HandleXMLTag(), AudacityProject::HandleXMLTag(), LabelStruct::Import(), LOFImportFileHandle::lofOpenFiles(), LadspaEffect::OnTextCtrl(), EffectAmplify::PopulateOrExchange(), WrappedType::ReadAsDouble(), ViewInfo::ReadXMLAttribute(), and WrappedType::WriteToAsString().

{
   // 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);
}

double Internat::CompatibleToDouble ( const wxString &  stringToConvert )

static

Definition at line 131 of file Internat.cpp.

References CompatibleToDouble().

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

wxString Internat::FormatSize ( wxLongLong  size )

static

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

Definition at line 191 of file Internat.cpp.

Referenced by HistoryWindow::DoUpdate(), UndoManager::GetLongDescription(), DependencyDialog::OnCopyToClipboard(), DependencyDialog::PopulateList(), and DirectoriesPrefs::UpdateFreeSpace().

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

   return FormatSize(dSize);
}

wxString Internat::FormatSize ( double  size )

static

Definition at line 200 of file Internat.cpp.

References _(), and ToDisplayString().

{
   wxString sizeStr;

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

   return sizeStr;
}

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 117 of file Internat.cpp.

References mDecimalSeparator.

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

{
   return mDecimalSeparator;
}

static const wxArrayString& Internat::GetExcludedCharacters ( )

inlinestatic

Definition at line 146 of file Internat.h.

References exclude.

Referenced by ExportMultiple::MakeFileName().

   { return exclude; }

void Internat::Init ( )

static

Initialize internationalisation support. Call this once at program start.

Definition at line 82 of file Internat.cpp.

References exclude, format, and mDecimalSeparator.

Referenced by AudacityApp::InitLang().

{
   // 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)
      exclude.Add(wxString{ cc });

   // The path separators may not be forbidden, so add them
   auto separators = wxFileName::GetPathSeparators(format);

   for(auto cc: separators) {
      if (forbid.Find(cc) == wxNOT_FOUND)
         exclude.Add(wxString{ cc });
   }
}

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

static

Protect against Unicode to multi-byte conversion failures on Windows.

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 267 of file Internat.cpp.

References exclude.

Referenced by ExportMultiple::MakeFileName().

{
   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 subsitution.
   name.Replace(wxT("/"), wxT(":"));
#endif

   return result;
}

wxString Internat::StripAccelerators ( const wxString &  str )

static

Remove accelerator charactors from strings.

Utility function - takes a translatable string to be used as a menu item, for example _("&Splash...\tAlt+S"), and strips all of the menu accelerator stuff from it, to make "Splash". That way the same translatable string can be used both when accelerators are needed and when they aren't, saving translators effort.

Definition at line 290 of file Internat.cpp.

{
   wxString result;
   result.Alloc(s.Length());
   for(size_t i = 0; i < s.Length(); i++) {
      if (s[i] == '\t')
         break;
      if (s[i] != '&' && s[i] != '.')
         result += s[i];
   }
   return result;
}

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 149 of file Internat.cpp.

References format, and GetDecimalSeparator().

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

{
   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;
}

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 138 of file Internat.cpp.

References GetDecimalSeparator(), and ToDisplayString().

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

{
   wxString result = ToDisplayString(
      numberToConvert, digitsAfterDecimalPoint);

   result.Replace(wxString(GetDecimalSeparator()), wxT("."));

   return result;
}

Member Data Documentation

wxArrayString Internat::exclude

staticprivate

Definition at line 153 of file Internat.h.

Referenced by GetExcludedCharacters(), Init(), and SanitiseFilename().

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

staticprivate

Definition at line 150 of file Internat.h.

Referenced by GetDecimalSeparator(), and Init().

wxCharBuffer Internat::mFilename

staticprivate

Definition at line 155 of file Internat.h.

---

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

• Internat.h
• Internat.cpp