Inheritance diagram for anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter:

Collaboration diagram for anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter:

Public Member Functions
	ParsedNumericConverterFormatter (NumericConverterType type, const TranslatableString &untranslatedFormat, const FormatterContext &context)

bool	IsTimeRelatedFormat () const

void	ParseFormatString ()

void	UpdateFormat ()

ConversionResult	ValueToString (double rawValue, bool nearest) const override

std::optional< double >	StringToValue (const wxString &valueString) const override

double	SingleStep (double value, int digitIndex, bool upwards) const override

void	UpdatePrefs () override

Public Member Functions inherited from NumericConverterFormatter
virtual	~NumericConverterFormatter ()

virtual void	UpdateFormatForValue (double value, bool canShrink)
	Potentially updates the format so it can fit the `value`. Default implementation is empty. More...

virtual ConversionResult	ValueToString (double value, bool nearest) const =0

virtual std::optional< double >	StringToValue (const wxString &value) const =0

virtual double	SingleStep (double value, int digitIndex, bool upwards) const =0

const wxString &	GetPrefix () const

const NumericFields &	GetFields () const

const DigitInfos &	GetDigitInfos () const

Public Member Functions inherited from Observer::Publisher< NumericConverterFormatChangedMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Public Member Functions inherited from PrefsListener
	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

Private Attributes
const FormatterContext	mContext

const NumericConverterType	mType

wxString	mFormat

const TranslatableString	mUntranslatedFormat

std::vector< FieldConfig >	mFieldConfigs

double	mScalingFactor

double	mSampleRate { 1.0 }

Observer::Subscription	mProjectRateChangedSubscription

bool	mScalingFactorIsSamples { false }

bool	mNtscDrop

Additional Inherited Members
Public Types inherited from Observer::Publisher< NumericConverterFormatChangedMessage >
using	message_type = NumericConverterFormatChangedMessage

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const NumericConverterFormatChangedMessage &) >
	Type of functions that can be connected to the Publisher. More...

Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Static Public Attributes inherited from Observer::Publisher< NumericConverterFormatChangedMessage >
static constexpr bool	notifies_all

Protected Member Functions inherited from Observer::Publisher< NumericConverterFormatChangedMessage >
CallbackReturn	Publish (const NumericConverterFormatChangedMessage &message)
	Send a message to connected callbacks. More...

Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

Protected Attributes inherited from NumericConverterFormatter
wxString	mPrefix

NumericFields	mFields

DigitInfos	mDigits

Detailed Description

Definition at line 159 of file ParsedNumericConverterFormatter.cpp.

Constructor & Destructor Documentation

◆ ParsedNumericConverterFormatter()

anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter::ParsedNumericConverterFormatter	(	NumericConverterType	type,
		const TranslatableString &	untranslatedFormat,
		const FormatterContext &	context
	)

inline

Definition at line 164 of file ParsedNumericConverterFormatter.cpp.

       : mContext { context }
       , mType { type }
       , mFormat { untranslatedFormat.Translation() }
       , mUntranslatedFormat { untranslatedFormat }
   {
      UpdateFormat();
 
      if (IsTimeRelatedFormat())
      {
         auto project = mContext.GetProject();
 
         if (project != nullptr)
         {
            // We need a non const object to subscribe...
            mProjectRateChangedSubscription =
               const_cast<ProjectRate&>(ProjectRate::Get(*project))
                  .Subscribe([this](const auto&) { UpdateFormat(); });
         }
      }
   }

References ProjectRate::Get(), and project.

Here is the call graph for this function:

Member Function Documentation

◆ IsTimeRelatedFormat()

bool anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter::IsTimeRelatedFormat ( ) const

inline

Definition at line 187 of file ParsedNumericConverterFormatter.cpp.

   {
      return mType == NumericConverterType_TIME() ||
             mType == NumericConverterType_DURATION();
   }

References NumericConverterType_DURATION(), and NumericConverterType_TIME().

Here is the call graph for this function:

◆ ParseFormatString()

void anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter::ParseFormatString ( )

inline

Definition at line 194 of file ParsedNumericConverterFormatter.cpp.

   {
      mPrefix.clear();
      mFields.clear();
      mDigits.clear();
      mFieldConfigs.clear();
 
      mScalingFactor = 1.0;
 
      // We will change inFrac to true when we hit our first decimal point.
      bool inFrac = false;
      int fracMult = 1;
      int numWholeFields = 0;
      int numFracFields = 0;
      wxString numStr;
      wxString delimStr;
      unsigned int i;
 
      mNtscDrop = false;
      for (i = 0; i < mFormat.length(); i++)
      {
         bool handleDelim = false;
         bool handleNum = false;
 
         if (mFormat[i] == '|')
         {
            wxString remainder = mFormat.Right(mFormat.length() - i - 1);
            // For languages which use , as a separator.
            remainder.Replace(wxT(","), wxT("."));
 
            mScalingFactorIsSamples = remainder == wxT("#");
 
            if (mScalingFactorIsSamples)
            {
               mScalingFactor = mSampleRate;
            }
            else if (remainder == wxT("N"))
            {
               mNtscDrop = true;
            }
            else
               // Use the C locale here for string to number.
               // Translations are often incomplete.
               // We can't rely on the correct ',' or '.' in the
               // translation, so we work based on '.' for decimal point.
               remainder.ToCDouble(&mScalingFactor);
            i = mFormat.length() - 1; // force break out of loop
            if (!delimStr.empty())
               handleDelim = true;
            if (!numStr.empty())
               handleNum = true;
         }
         else if (
            (mFormat[i] >= '0' && mFormat[i] <= '9') ||
            mFormat[i] == wxT('*') || mFormat[i] == wxT('#'))
         {
            numStr += mFormat[i];
            if (!delimStr.empty())
               handleDelim = true;
         }
         else
         {
            delimStr += mFormat[i];
            if (!numStr.empty())
               handleNum = true;
         }
 
         if (i == mFormat.length() - 1)
         {
            if (!numStr.empty())
               handleNum = true;
            if (!delimStr.empty())
               handleDelim = true;
         }
 
         if (handleNum)
         {
            bool zeropad = false;
            long range = 0;
 
            if (numStr.Right(1) == wxT("#"))
               range = static_cast<long int>(mSampleRate);
            else if (numStr.Right(1) != wxT("*"))
            {
               numStr.ToLong(&range);
            }
            if (numStr.GetChar(0) == '0' && numStr.length() > 1)
               zeropad = true;
 
            // Hack: always zeropad
            zeropad = true;
 
            if (inFrac)
            {
               int base = fracMult * range;
               mFieldConfigs.push_back({ inFrac, base, range });
               mFields.push_back(NumericField::ForRange(range, zeropad));
               fracMult *= range;
               numFracFields++;
            }
            else
            {
               unsigned int j;
               for (j = 0; j < mFields.size(); j++)
                  mFieldConfigs[j].base *= range;
               mFieldConfigs.push_back({ inFrac, 1, range });
               mFields.push_back(NumericField::ForRange(range, zeropad));
               numWholeFields++;
            }
            numStr = wxT("");
         }
 
         if (handleDelim)
         {
            bool goToFrac = false;
 
            if (!inFrac)
            {
               wxChar delim = delimStr[delimStr.length() - 1];
               if (delim == '<' || delim == '>')
               {
                  goToFrac = true;
                  if (delimStr.length() > 1)
                     delimStr = delimStr.BeforeLast(delim);
               }
            }
 
            if (inFrac)
            {
               if (numFracFields == 0)
               {
                  // Should never happen
                  return;
               }
               if (handleNum && numFracFields > 1)
                  mFields[mFields.size() - 2].label = delimStr;
               else
                  mFields[mFields.size() - 1].label = delimStr;
            }
            else
            {
               if (numWholeFields == 0)
                  mPrefix = delimStr;
               else
               {
                  delimStr.Replace(wxT("<"), wxT(","));
                  delimStr.Replace(wxT(">"), wxT("."));
                  mFields[numWholeFields - 1].label = delimStr;
               }
            }
 
            if (goToFrac)
               inFrac = true;
            delimStr = wxT("");
         }
      }
 
      size_t pos = 0;
 
      pos += mPrefix.length();
 
      for (i = 0; i < mFields.size(); i++)
      {
         mFields[i].pos = pos;
 
         for (size_t j = 0; j < mFields[i].digits; j++)
         {
            mDigits.push_back(DigitInfo { i, j, pos });
            pos++;
         }
 
         pos += mFields[i].label.length();
      }
 
      // This Publish will happen from the
      // constructor as well, despite it is not
      // possible to catch it there
      Publish({});
   }

References NumericField::ForRange(), and wxT().

Here is the call graph for this function:

◆ SingleStep()

double anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter::SingleStep	(	double	value,
		int	digitIndex,
		bool	upwards
	)		const

inlineoverridevirtual

Implements NumericConverterFormatter.

Definition at line 577 of file ParsedNumericConverterFormatter.cpp.

   {
      const auto dir = upwards ? 1 : -1;
      for (size_t i = 0; i < mFields.size(); i++)
      {
         if (
            (mDigits[digitIndex].pos >= mFields[i].pos) &&
            (mDigits[digitIndex].pos < mFields[i].pos + mFields[i].digits))
         { // it's this field
            if (value < 0)
               value = 0;
 
            value *= mScalingFactor;
 
            const double mult = pow(
               10., mFields[i].digits -
                       (mDigits[digitIndex].pos - mFields[i].pos) - 1);
 
            if (mFieldConfigs[i].frac)
            {
               value += ((mult / (double)mFieldConfigs[i].base) * dir);
            }
            else
            {
               value += ((mult * (double)mFieldConfigs[i].base) * dir);
            }
 
            if (mNtscDrop)
            {
               if ((value - (int)value) * 30 < 2)
               {
                  if ((((int)value) % 60 == 0) && (((int)value) % 600 != 0))
                  {
                     value = (int)value + (dir > 0 ? 2. : -1.) / 30.;
                  }
               }
            }
 
            if (value < 0.)
            {
               value = 0.;
            }
 
            value /= mScalingFactor;
 
            if (mNtscDrop)
            {
               mNtscDrop = false;
               auto result = ValueToString(value, false);
               mNtscDrop = true;
               return *StringToValue(result.valueString);
            }
 
            return value;
         }
      }
 
      return value;
   }

◆ StringToValue()

std::optional< double > anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter::StringToValue ( const wxString & valueString ) const

inlineoverridevirtual

Implements NumericConverterFormatter.

Definition at line 511 of file ParsedNumericConverterFormatter.cpp.

   {
      unsigned int i;
      double t = 0.0;
 
      if (
         mFields.size() > 0 &&
         valueString.Mid(mFields[0].pos, 1) == wxChar('-'))
         return std::nullopt;
 
      for (i = 0; i < mFields.size(); i++)
      {
         const auto pos = mFields[i].pos;
         const auto digits = mFields[i].digits;
 
         if (pos >= valueString.size() || pos + digits > valueString.size())
            return std::nullopt;
 
         long val;
 
         const auto fieldStringValue =
            valueString.Mid(mFields[i].pos, mFields[i].digits);
 
         if (!fieldStringValue.ToLong(&val))
            return std::nullopt;
 
         if (mFieldConfigs[i].frac)
            t += (val / (double)mFieldConfigs[i].base);
         else
            t += (val * (double)mFieldConfigs[i].base);
      }
 
      t /= mScalingFactor;
 
      if (mNtscDrop)
      {
         int t_int = (int)(t + .000000001);
         double t_frac = (t - t_int);
         int tenMins = t_int / 600;
         double frames = tenMins * 17982;
         t_int -= tenMins * 600;
         int mins = t_int / 60;
         int addMins = 0;
         if (mins > 0)
         {
            frames += 1800;
            addMins = mins - 1;
         }
         frames += addMins * 1798;
         t_int -= mins * 60;
         if (mins == 0) // first min of a block of 10, don't drop frames 0 and 1
            frames += t_int * 30 + t_frac * 30.;
         else
         { // drop frames 0 and 1 of first seconds of these minutes
            if (t_int > 0)
               frames += 28 + (t_int - 1) * 30 + t_frac * 30.;
            else
               frames += t_frac * 30. - 2.;
         }
         t = frames * 1.001 / 30.;
      }
 
      return t;
   }

◆ UpdateFormat()

void anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter::UpdateFormat ( )

inline

Definition at line 374 of file ParsedNumericConverterFormatter.cpp.

   {
      const auto newSampleRate = mContext.GetSampleRate();
 
      const bool sampleRateChanged = newSampleRate != mSampleRate;
 
      mSampleRate = newSampleRate;
 
      if (mFields.empty() || (sampleRateChanged && mScalingFactorIsSamples))
         ParseFormatString();
   }

◆ UpdatePrefs()

void anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter::UpdatePrefs ( )

inlineoverridevirtual

Implements PrefsListener.

Definition at line 637 of file ParsedNumericConverterFormatter.cpp.

   {
      auto newFormat = mUntranslatedFormat.Translation();
 
      if (mFormat == newFormat)
         return;
 
      mFormat = newFormat;
      ParseFormatString();
   }

◆ ValueToString()

ConversionResult anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter::ValueToString	(	double	value,
		bool	nearest
	)		const

inlineoverridevirtual

Postcondition: result: GetFields().size() == result.fieldValueStrings.size()

Implements NumericConverterFormatter.

Definition at line 386 of file ParsedNumericConverterFormatter.cpp.

   {
      ConversionResult result;
 
      if (IsTimeRelatedFormat() && mContext.HasSampleRate())
         rawValue = floor(rawValue * mSampleRate + (nearest ? 0.5f : 0.0f)) /
                    mSampleRate; // put on a sample
      double theValue = rawValue * mScalingFactor
         // PRL:  what WAS this .000001 for?  Nobody could explain.
         // + .000001
         ;
 
      sampleCount t_int;
      bool round = true;
      // We round on the last field.  If we have a fractional field we round
      // using it. Otherwise we round to nearest integer.
      for (size_t i = 0; i < mFields.size(); i++)
      {
         if (mFieldConfigs[i].frac)
            round = false;
      }
      if (theValue < 0)
         t_int = -1;
      else if (round)
         t_int = sampleCount(theValue + (nearest ? 0.5f : 0.0f));
      else
      {
         wxASSERT(mFieldConfigs.back().frac);
         theValue += (nearest ? 0.5f : 0.0f) / mFieldConfigs.back().base;
         t_int = sampleCount(theValue);
      }
      double t_frac;
      if (theValue < 0)
         t_frac = -1;
      else
         t_frac = (theValue - t_int.as_double());
      
      int tenMins;
      int mins;
      int addMins;
      int secs;
      int frames;
 
      result.valueString = mPrefix;
 
      if (mNtscDrop && theValue >= 0)
      {
         frames = (int)(theValue * 30. / 1.001 + (nearest ? 0.5f : 0.0f));
         tenMins = frames / 17982;
         frames -= tenMins * 17982;
         mins = tenMins * 10;
         if (frames >= 1800)
         {
            frames -= 1800;
            mins++;
            addMins = frames / 1798;
            frames -= addMins * 1798;
            mins += addMins;
            secs = frames / 30;
            frames -= secs * 30;
            frames += 2;
            if (frames >= 30)
            {
               secs++;
               frames -= 30;
            }
         }
         else
         {
            secs = frames / 30;
            frames -= secs * 30;
         }
         t_int = mins * 60 + secs;
         t_frac = frames / 30.;
      }
 
      for (size_t i = 0; i < mFields.size(); i++)
      {
         long long value = -1;
 
         if (mFieldConfigs[i].frac)
         {
            // JKC: This old code looks bogus to me.
            // The rounding is not propagating to earlier fields in the frac
            // case.
            // value = (int)(t_frac * mFields[i].base + 0.5);  // +0.5 as
            // rounding required
            // I did the rounding earlier.
            if (t_frac >= 0)
               value = t_frac * mFieldConfigs[i].base;
            // JKC: TODO: Find out what the range is supposed to do.
            // It looks bogus too.
            // if (mFields[i].range > 0)
            //   value = value % mFields[i].range;
         }
         else
         {
            if (t_int >= 0)
            {
               value = t_int.as_long_long() / mFieldConfigs[i].base;
               if (mFieldConfigs[i].range > 0)
                  value = value % mFieldConfigs[i].range;
            }
         }
 
         wxString field;
 
         if (value < 0)
         {
            for (int ii = 0; ii < mFields[i].digits; ++ii)
               field += wxT("-");
         }
         else
            field = wxString::Format(mFields[i].formatStr, (int)value);
 
         result.fieldValueStrings.push_back(field);
 
         result.valueString += field;
         result.valueString += mFields[i].label;
      }
 
      return result;
   }