Inheritance diagram for anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter:

Collaboration diagram for anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter:

Public Member Functions
	BeatsFormatter (const FormatterContext &context, int fracPart, bool timeFormat)

bool	CheckField (size_t fieldIndex, int value) const noexcept
	Check that field exists and has enough digits to fit the value. More...

bool	CheckFracField (int newLts) const noexcept

void	UpdateFields (size_t barsDigits)

void	UpdateFormat (const AudacityProject &project)

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

void	UpdateResultString (ConversionResult &result) const

ConversionResult	ValueToString (double value, bool) 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

Static Public Attributes
static constexpr std::array< size_t, 3 >	MIN_DIGITS { 3, 2, 2 }

static constexpr std::array< size_t, 3 >	UPPER_BOUNDS

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

Private Attributes
const FormatterContext	mContext

Observer::Subscription	mTimeSignatureChangedSubscription

double	mTempo { 0.0 }

int	mUpperTimeSignature { 0 }

int	mLowerTimeSignature { 0 }

const int	mFracPart

const int	mFieldValueOffset

std::array< double, 3 >	mFieldLengths {}

wxString	mBarString

wxString	mBeatString

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...

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 40 of file BeatsNumericConverterFormatter.cpp.

Constructor & Destructor Documentation

◆ BeatsFormatter()

anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::BeatsFormatter	(	const FormatterContext &	context,
		int	fracPart,
		bool	timeFormat
	)

inline

Definition at line 51 of file BeatsNumericConverterFormatter.cpp.

       : mContext { context }
       , mFracPart { fracPart }
       , mFieldValueOffset { timeFormat ? 1 : 0 }
   {
      auto project = mContext.GetProject();
 
      if (!project)
         return;
 
      mBarString = BarString.Translation();
      mBeatString = BeatString.Translation();
 
      UpdateFormat(*project);
 
      // Subscribing requires non-const reference
      mTimeSignatureChangedSubscription =
         const_cast<ProjectTimeSignature&>(ProjectTimeSignature::Get(*project))
            .Subscribe(
               [this](const auto&)
               {
                  // Receiving this message means that project is
                  // alive and well
                  UpdateFormat(*mContext.GetProject());
                  Publish({});
               });
   }

References anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BarString, anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatString, ProjectTimeSignature::Get(), and project.

Here is the call graph for this function:

Member Function Documentation

◆ CheckField()

bool anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::CheckField	(	size_t	fieldIndex,
		int	value
	)		const

inlinenoexcept

Check that field exists and has enough digits to fit the value.

Definition at line 80 of file BeatsNumericConverterFormatter.cpp.

   {
      if (fieldIndex >= mFields.size())
         return false;
 
      const auto digitsCount = mFields[fieldIndex].digits;
 
      // Format always allows at least two digits
      const auto lowerRange =
         digitsCount > MIN_DIGITS[fieldIndex] ? Get10Pow(digitsCount - 1) : 0;
 
      const auto upperRange = Get10Pow(digitsCount);
 
      return value >= int(lowerRange) && value < int(upperRange);
   }

References anonymous_namespace{BeatsNumericConverterFormatter.cpp}::Get10Pow().

Here is the call graph for this function:

◆ CheckFracField()

bool anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::CheckFracField ( int newLts ) const

inlinenoexcept

Definition at line 96 of file BeatsNumericConverterFormatter.cpp.

   {
      if (mFracPart > newLts)
         return CheckField(2, mFracPart / mLowerTimeSignature);
      else
         return mFields.size() == 2;
   }

◆ SingleStep()

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

inlineoverridevirtual

Implements NumericConverterFormatter.

Definition at line 303 of file BeatsNumericConverterFormatter.cpp.

   {
      if (digitIndex < 0 || size_t(digitIndex) >= mDigits.size())
         return value;
 
      const auto& digit = mDigits[digitIndex];
      const auto& fieldIndex = digit.field;
      const auto& field = mFields[fieldIndex];
 
      const auto stepSize = mFieldLengths[fieldIndex] *
                            std::pow(10, field.digits - digit.index - 1);
 
      return upwards ? value + stepSize : value - stepSize;
   }

References field.

◆ StringToValue()

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

inlineoverridevirtual

Implements NumericConverterFormatter.

Definition at line 268 of file BeatsNumericConverterFormatter.cpp.

   {
      if (
         mFields.size() > 0 &&
         valueString.Mid(mFields[0].pos, 1) == wxChar('-'))
         return std::nullopt;
 
      double t = 0.0;
      size_t lastIndex = 0;
      
      for (size_t i = 0; i < mFields.size(); i++)
      {
         const auto& field = mFields[i];
 
         const size_t labelIndex = field.label.empty() ?
                                      wxString::npos :
                                      valueString.find(field.label, lastIndex); 
            
         long val;
 
         const auto fieldStringValue = valueString.Mid(
            lastIndex,
            labelIndex == wxString::npos ? labelIndex : labelIndex - lastIndex);
 
         if (!fieldStringValue.ToLong(&val))
            return std::nullopt;
 
         t += (val - mFieldValueOffset) * mFieldLengths[i];
 
         lastIndex = labelIndex + field.label.Length();
      }
 
      return t;
   }

References field, and Tuple::detail::npos().

Here is the call graph for this function:

◆ UpdateFields()

void anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::UpdateFields ( size_t barsDigits )

inline

Definition at line 104 of file BeatsNumericConverterFormatter.cpp.

   {
      mFields.clear();
      mDigits.clear();
 
      // Range is assumed to allow 999 bars.
      auto& barsField =
         mFields.emplace_back(NumericField::WithDigits(barsDigits));
 
      barsField.label = L" " + mBarString + L" ";
 
      // Beats format is 1 based. For the time point "0" the expected output is
      // "1 bar 1 beat [1]" For this reason we use (uts + 1) as the "range". On
      // top of that, we want at least two digits to be shown. NumericField
      // accepts range as in [0, range), so add 1.
 
      auto& beatsField = mFields.emplace_back(NumericField::ForRange(
         std::max<size_t>(UPPER_BOUNDS[1], mUpperTimeSignature + 1)));
 
      beatsField.label = L" " + mBeatString;
 
      const auto hasFracPart = mFracPart > mLowerTimeSignature;
 
      if (hasFracPart)
      {
         beatsField.label += L" ";
         // See the reasoning above about the range
         auto& fracField = mFields.emplace_back(NumericField::ForRange(
            std::max(11, mFracPart / mLowerTimeSignature + 1)));
      }
 
      // Fill the aux mDigits structure
      size_t pos = 0;
      for (size_t 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();
      }
   }

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

Here is the call graph for this function:

◆ UpdateFormat()

void anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::UpdateFormat ( const AudacityProject & project )

inline

Definition at line 151 of file BeatsNumericConverterFormatter.cpp.

   {
      auto& timeSignature = ProjectTimeSignature::Get(project);
 
      const double newTempo = timeSignature.GetTempo();
      const int newUts = timeSignature.GetUpperTimeSignature();
      const int newLts = timeSignature.GetLowerTimeSignature();
 
      if (newTempo == mTempo && newUts == mUpperTimeSignature && newLts == mLowerTimeSignature)
         return ;
 
      const bool formatOk = CheckField(1, newUts) && CheckFracField(newLts);
      
      mTempo = newTempo;
      mUpperTimeSignature = newUts;
      mLowerTimeSignature = newLts;
 
      // 1/4 = BPM is used for now
      const auto quarterLength = 60.0 / mTempo;
      const auto beatLength = quarterLength * 4.0 / mLowerTimeSignature;
      const auto barLength = mUpperTimeSignature * beatLength;
 
      mFieldLengths[0] = barLength;
      mFieldLengths[1] = beatLength;
 
      const auto hasFracPart = mFracPart > mLowerTimeSignature;
 
      if (hasFracPart)
      {
         const auto fracLength = beatLength * mLowerTimeSignature / mFracPart;
         mFieldLengths[2] = fracLength;
      }
 
      if (formatOk)
         return ;
      
      UpdateFields(MIN_DIGITS[0]);
   }

References ProjectTimeSignature::Get(), and project.

Here is the call graph for this function:

◆ UpdateFormatForValue()

void anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::UpdateFormatForValue	(	double	value,
		bool	canShrink
	)

inlineoverridevirtual

Potentially updates the format so it can fit the value. Default implementation is empty.

Reimplemented from NumericConverterFormatter.

Definition at line 190 of file BeatsNumericConverterFormatter.cpp.

   {
      // Beats formatter does not support negative values
      value = std::max(0.0, value);
 
      // ForRange has a preserved weird behavior
      const auto barsCount =
         // Range is not inclusive
         1 +
         // Bars can start from 1
         mFieldValueOffset +
         static_cast<int>(std::floor(value / mFieldLengths[0]));
 
      const auto barsField = NumericField::ForRange(
         barsCount, true, MIN_DIGITS[0]);
 
      const auto oldDigits = mFields[0].digits;
 
      const bool updateNeeded = canShrink ? oldDigits != barsField.digits :
                                            oldDigits < barsField.digits;
 
      if (!updateNeeded)
         return;
 
      UpdateFields(barsField.digits);
      Publish({ value, oldDigits > mFields[0].digits });
   }

References NumericField::ForRange().

Here is the call graph for this function:

◆ UpdatePrefs()

void anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::UpdatePrefs ( )

inlineoverridevirtual

Implements PrefsListener.

Definition at line 318 of file BeatsNumericConverterFormatter.cpp.

   {
      auto project = mContext.GetProject();
 
      if (!project)
         return;
 
      auto barString = BarString.Translation();
      auto beatString = BeatString.Translation();
 
      if (barString == mBarString && beatString == mBeatString)
         return;
 
      mBarString = barString;
      mBeatString = beatString;
      
      UpdateFormat(*project);
   }

References anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BarString, anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatString, and project.

◆ UpdateResultString()

void anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::UpdateResultString ( ConversionResult & result ) const

inline

Definition at line 218 of file BeatsNumericConverterFormatter.cpp.

   {
      for (size_t fieldIndex = 0; fieldIndex < mFields.size(); ++fieldIndex)
      {
         result.valueString +=
            result.fieldValueStrings[fieldIndex] + mFields[fieldIndex].label;
      }
   }

References NumericConverterFormatter::ConversionResult::fieldValueStrings, and NumericConverterFormatter::ConversionResult::valueString.

◆ ValueToString()

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

inlineoverridevirtual

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

Implements NumericConverterFormatter.

Definition at line 227 of file BeatsNumericConverterFormatter.cpp.

   {
      ConversionResult result;
      result.fieldValueStrings.resize(mFields.size());
 
      if (value < 0)
      {
         for (size_t fieldIndex = 0; fieldIndex < mFields.size (); ++fieldIndex)
         {
            const auto digitsCount = mFields[fieldIndex].digits;
            auto& fieldValue = result.fieldValueStrings[fieldIndex];
            for (int digitIndex = 0; digitIndex < digitsCount; ++digitIndex)
               fieldValue += L"-";
         }
 
         UpdateResultString(result);
 
         return result;
      }
 
      // Calculate the epsilon only once, so the total loss of precision is addressed.
      // This is a "multiplicative" epsilon, so there is no need to calculate 1 + eps every time.
      const auto eps =
         1.0 + std::max(1.0, value) * std::numeric_limits<double>::epsilon();
 
      for (size_t fieldIndex = 0; fieldIndex < mFields.size(); ++fieldIndex)
      {
         const auto fieldLength = mFieldLengths[fieldIndex];
         const auto fieldValue = std::max(
            0, static_cast<int>(std::floor(value * eps / fieldLength)));
 
         result.fieldValueStrings[fieldIndex] = wxString::Format(
            mFields[fieldIndex].formatStr, fieldValue + mFieldValueOffset);
 
         value = value - fieldValue * fieldLength;
      }
 
      UpdateResultString(result);
      return result;
   }

References NumericConverterFormatter::ConversionResult::fieldValueStrings.

Member Data Documentation

◆ mBarString

wxString anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mBarString

private

Definition at line 353 of file BeatsNumericConverterFormatter.cpp.

◆ mBeatString

wxString anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mBeatString

private

Definition at line 354 of file BeatsNumericConverterFormatter.cpp.

◆ mContext

const FormatterContext anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mContext

private

Definition at line 338 of file BeatsNumericConverterFormatter.cpp.

◆ mFieldLengths

std::array<double, 3> anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mFieldLengths {}

private

Definition at line 351 of file BeatsNumericConverterFormatter.cpp.

◆ mFieldValueOffset

const int anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mFieldValueOffset

private

Definition at line 349 of file BeatsNumericConverterFormatter.cpp.

◆ mFracPart

const int anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mFracPart

private

Definition at line 347 of file BeatsNumericConverterFormatter.cpp.

◆ MIN_DIGITS

constexpr std::array<size_t, 3> anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::MIN_DIGITS { 3, 2, 2 }

staticconstexpr

Definition at line 45 of file BeatsNumericConverterFormatter.cpp.

◆ mLowerTimeSignature

int anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mLowerTimeSignature { 0 }

private

Definition at line 345 of file BeatsNumericConverterFormatter.cpp.

◆ mTempo

double anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mTempo { 0.0 }

private

Definition at line 342 of file BeatsNumericConverterFormatter.cpp.

◆ mTimeSignatureChangedSubscription

Observer::Subscription anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mTimeSignatureChangedSubscription

private

Definition at line 340 of file BeatsNumericConverterFormatter.cpp.

◆ mUpperTimeSignature

int anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::mUpperTimeSignature { 0 }

private

Definition at line 344 of file BeatsNumericConverterFormatter.cpp.

◆ UPPER_BOUNDS

constexpr std::array<size_t, 3> anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter::UPPER_BOUNDS

staticconstexpr

Initial value:

{
      Get10Pow(MIN_DIGITS[0] - 1) + 1, Get10Pow(MIN_DIGITS[1] - 1) + 1,
      Get10Pow(MIN_DIGITS[2] - 1) + 1
   }

Definition at line 46 of file BeatsNumericConverterFormatter.cpp.

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

BeatsNumericConverterFormatter.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BeatsFormatter()

Member Function Documentation

◆ CheckField()

◆ CheckFracField()

◆ SingleStep()

◆ StringToValue()

◆ UpdateFields()

◆ UpdateFormat()

◆ UpdateFormatForValue()

◆ UpdatePrefs()

◆ UpdateResultString()

◆ ValueToString()

Member Data Documentation

◆ mBarString

◆ mBeatString

◆ mContext

◆ mFieldLengths

◆ mFieldValueOffset

◆ mFracPart

◆ MIN_DIGITS

◆ mLowerTimeSignature

◆ mTempo

◆ mTimeSignatureChangedSubscription

◆ mUpperTimeSignature

◆ UPPER_BOUNDS