NumberFormatter Class Reference

#include <numformatter.h>

Public Types
enum	Style {   Style_None = 0x00 , Style_WithThousandsSep = 0x01 , Style_NoTrailingZeroes = 0x02 , Style_OneTrailingZero = 0x04 ,   Style_TwoTrailingZeroes = 0x08 , Style_ThreeTrailingZeroes = 0x10 }

Static Public Member Functions
static wxString	ToString (long val, int style=Style_WithThousandsSep)
static wxString	ToString (wxLongLong_t val, int style=Style_WithThousandsSep)
static wxString	ToString (double val, int precision, int style=Style_WithThousandsSep)
static bool	FromString (const wxString &s, long *val)
static bool	FromString (const wxString &s, wxLongLong_t *val)
static bool	FromString (const wxString &s, double *val)
static wxChar	GetDecimalSeparator ()
static bool	GetThousandsSeparatorIfUsed (wxChar *sep)

Static Protected Member Functions
static void	RemoveTrailingZeroes (wxString &s, size_t retain=0)

Static Private Member Functions
static wxString	PostProcessIntString (const wxString &s, int style)
static void	AddThousandsSeparators (wxString &s)
static void	RemoveThousandsSeparators (wxString &s)

Friends
class	FloatingPointValidatorBase

Detailed Description

Definition at line 27 of file numformatter.h.

Member Enumeration Documentation

Style

enum NumberFormatter::Style

Enumerator
Style_None
Style_WithThousandsSep
Style_NoTrailingZeroes
Style_OneTrailingZero
Style_TwoTrailingZeroes
Style_ThreeTrailingZeroes

Definition at line 31 of file numformatter.h.

   {
      Style_None                = 0x00,
      Style_WithThousandsSep    = 0x01,
      Style_NoTrailingZeroes    = 0x02,     // Only for floating point numbers
      Style_OneTrailingZero     = 0x04,     // Only for floating point numbers
      Style_TwoTrailingZeroes   = 0x08,     // Only for floating point numbers
      Style_ThreeTrailingZeroes = 0x10      // Only for floating point numbers
   };

Member Function Documentation

AddThousandsSeparators()

void NumberFormatter::AddThousandsSeparators ( wxString &  s )

staticprivate

Definition at line 180 of file numformatter.cpp.

{
    wxChar thousandsSep;
    if ( !GetThousandsSeparatorIfUsed(&thousandsSep) )
        return;
 
    size_t pos = s.find(GetDecimalSeparator());
    if ( pos == wxString::npos )
    {
        // Start grouping at the end of an integer number.
        pos = s.length();
    }
 
    // End grouping at the beginning of the digits -- there could be at a sign
    // before their start.
    const size_t start = s.find_first_of(wxT("0123456789"));
 
    // We currently group digits by 3 independently of the locale. This is not
    // the right thing to do and we should use lconv::grouping (under POSIX)
    // and GetLocaleInfo(LOCALE_SGROUPING) (under MSW) to get information about
    // the correct grouping to use. This is something that needs to be done at
    // wxLocale level first and then used here in the future (TODO).
    const size_t GROUP_LEN = 3;
 
    while ( pos > start + GROUP_LEN )
    {
        pos -= GROUP_LEN;
        s.insert(pos, thousandsSep);
    }
}

References GetDecimalSeparator(), GetThousandsSeparatorIfUsed(), Tuple::detail::npos(), and wxT().

Referenced by PostProcessIntString(), and ToString().

Here is the call graph for this function:

Here is the caller graph for this function:

FromString() [1/3]

bool NumberFormatter::FromString ( const wxString &  s, double *  val  )

static

Definition at line 263 of file numformatter.cpp.

{
   wxString s(sArg);
 
   RemoveThousandsSeparators(s);
   return s.ToDouble(val);
}

References RemoveThousandsSeparators().

Here is the call graph for this function:

FromString() [2/3]

bool NumberFormatter::FromString ( const wxString &  s, long *  val  )

static

Definition at line 244 of file numformatter.cpp.

{
   wxString s(sArg);
   RemoveThousandsSeparators(s);
   return s.ToLong(val);
}

References RemoveThousandsSeparators().

Here is the call graph for this function:

FromString() [3/3]

bool NumberFormatter::FromString ( const wxString &  s, wxLongLong_t *  val  )

static

Definition at line 253 of file numformatter.cpp.

{
   wxString s(sArg);
 
   RemoveThousandsSeparators(s);
   return s.ToLongLong(val);
}

References RemoveThousandsSeparators().

Here is the call graph for this function:

GetDecimalSeparator()

wxChar NumberFormatter::GetDecimalSeparator ( )

static

Definition at line 56 of file numformatter.cpp.

{
#if wxUSE_INTL
   struct lconv *info = localeconv();
   wxString s = info ? wxString::FromUTF8(info->decimal_point) : wxString(".");
   if (s.empty())
   {
      // We really must have something for decimal separator, so fall
      // back to the C locale default.
      s = wxT(".");
   }
 
   return s[0];
#else // !wxUSE_INTL
   return wxT('.');
#endif // wxUSE_INTL/!wxUSE_INTL
}

References wxT().

Referenced by AddThousandsSeparators(), and RemoveTrailingZeroes().

Here is the call graph for this function:

Here is the caller graph for this function:

GetThousandsSeparatorIfUsed()

bool NumberFormatter::GetThousandsSeparatorIfUsed ( wxChar *  sep )

static

Definition at line 74 of file numformatter.cpp.

{
#if wxUSE_INTL
   struct lconv *info = localeconv();
   wxString s = info ? wxString::FromUTF8(info->thousands_sep) : wxString{};
 
   if (s.empty())
   {
      return false;
   }
 
   *sep = s[0];
   return true;
#else // !wxUSE_INTL
    wxUnusedVar(sep);
    return false;
#endif // wxUSE_INTL/!wxUSE_INTL
}

Referenced by AddThousandsSeparators(), and RemoveThousandsSeparators().

Here is the caller graph for this function:

PostProcessIntString()

wxString NumberFormatter::PostProcessIntString ( const wxString &  s, int  style  )

staticprivate

Definition at line 97 of file numformatter.cpp.

{
   wxString s(sArg);
 
    if ( style & Style_WithThousandsSep )
        AddThousandsSeparators(s);
 
    wxASSERT_MSG( !(style & Style_NoTrailingZeroes),
                  wxT("Style_NoTrailingZeroes can't be used with integer values") );
    wxASSERT_MSG( !(style & Style_OneTrailingZero),
                  wxT("Style_OneTrailingZero can't be used with integer values") );
    wxASSERT_MSG( !(style & Style_TwoTrailingZeroes),
                  wxT("Style_TwoTrailingZeroes can't be used with integer values") );
    wxASSERT_MSG( !(style & Style_ThreeTrailingZeroes),
                  wxT("Style_ThreeTrailingZeroes can't be used with integer values") );
 
    return s;
}

References AddThousandsSeparators(), anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, Style_NoTrailingZeroes, Style_OneTrailingZero, Style_ThreeTrailingZeroes, Style_TwoTrailingZeroes, Style_WithThousandsSep, and wxT().

Referenced by ToString().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveThousandsSeparators()

void NumberFormatter::RemoveThousandsSeparators ( wxString &  s )

staticprivate

Definition at line 235 of file numformatter.cpp.

{
    wxChar thousandsSep;
    if ( !GetThousandsSeparatorIfUsed(&thousandsSep) )
        return;
 
    s.Replace(wxString(thousandsSep), wxString());
}

References GetThousandsSeparatorIfUsed().

Referenced by FromString().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveTrailingZeroes()

void NumberFormatter::RemoveTrailingZeroes ( wxString &  s, size_t  retain = 0  )

staticprotected

Definition at line 211 of file numformatter.cpp.

{
   const size_t posDecSep = s.find(GetDecimalSeparator());
   wxCHECK_RET( posDecSep != wxString::npos,
               wxString::Format(wxT("No decimal separator in \"%s\""), s) );
   wxCHECK_RET( posDecSep, wxT("Can't start with decimal separator" ));
 
   // Find the last character to keep.
   size_t posLastCharacterToKeep = s.find_last_not_of(wxT("0"));
 
   // If it's the decimal separator itself, remove it.
   if ((posLastCharacterToKeep == posDecSep) && (retain == 0)) {
      posLastCharacterToKeep--;
   } else if ((posLastCharacterToKeep - posDecSep) < retain) {
      posLastCharacterToKeep = retain + posDecSep;
   }
 
   s.erase(posLastCharacterToKeep + 1);
}

References GetDecimalSeparator(), Tuple::detail::npos(), and wxT().

Referenced by ToString().

Here is the call graph for this function:

Here is the caller graph for this function:

ToString() [1/3]

wxString NumberFormatter::ToString ( double  val, int  precision, int  style = Style_WithThousandsSep  )

static

Definition at line 131 of file numformatter.cpp.

{
    wxString format;
    if ( precision == -1 )
    {
        format = wxT("%g");
    }
    else // Use fixed precision.
    {
        format.Printf(wxT("%%.%df"), precision);
    }
 
    if (std::isnan(val))
    {
        return _("NaN");
    }
    if (std::isinf(val))
    {
       if (val == std::numeric_limits<double>::infinity())
       {
          return _("Infinity");
       }
       else
       {
          return _("-Infinity");
       }
    }
    wxString s = wxString::Format(format, val);
 
    if ( style & Style_WithThousandsSep )
        AddThousandsSeparators(s);
 
    if ( precision != -1 )
    {
        if ( style & Style_NoTrailingZeroes )
            RemoveTrailingZeroes(s, 0);
 
        if ( style & Style_OneTrailingZero )
            RemoveTrailingZeroes(s, 1);
 
        if ( style & Style_TwoTrailingZeroes )
            RemoveTrailingZeroes(s, 2);
 
        if ( style & Style_ThreeTrailingZeroes )
            RemoveTrailingZeroes(s, 3);
    }
    return s;
}

References _, AddThousandsSeparators(), anonymous_namespace{ExportPCM.cpp}::format, RemoveTrailingZeroes(), anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, Style_NoTrailingZeroes, Style_OneTrailingZero, Style_ThreeTrailingZeroes, Style_TwoTrailingZeroes, Style_WithThousandsSep, and wxT().

Here is the call graph for this function:

ToString() [2/3]

wxString NumberFormatter::ToString ( long  val, int  style = Style_WithThousandsSep  )

static

Definition at line 116 of file numformatter.cpp.

{
    return PostProcessIntString(wxString::Format(wxT("%ld"), val), style);
}

References PostProcessIntString(), anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style, and wxT().

Here is the call graph for this function:

ToString() [3/3]

wxString NumberFormatter::ToString ( wxLongLong_t  val, int  style = Style_WithThousandsSep  )

static

Definition at line 123 of file numformatter.cpp.

{
   return PostProcessIntString(wxString::Format("%" wxLongLongFmtSpec "d", val),
                                style);
}

References PostProcessIntString(), and anonymous_namespace{AudacityDontAskAgainMessageDialog.cpp}::style.

Here is the call graph for this function:

Friends And Related Function Documentation

FloatingPointValidatorBase

friend class FloatingPointValidatorBase

friend

Definition at line 91 of file numformatter.h.

---

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

• numformatter.h
• numformatter.cpp