SnapUtils.h File Reference

#include "Callable.h"
#include "Prefs.h"
#include "Registry.h"
#include <functional>
#include <string_view>

Include dependency graph for SnapUtils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	SnapResult
struct	SnapRegistryTraits
struct	SnapRegistryGroupData
struct	SnapRegistryGroup
struct	SnapRegistryItem
struct	SnapFunctionsRegistry
struct	SnapFunctionSuperGroup

Typedefs
using	SnapRegistryVisitor = Registry::VisitorFunctions< SnapRegistryTraits >
using	MultiplierFunctor = std::function< double(const AudacityProject &)>
using	SnapRegistryItemRegistrator = Registry::RegisteredItem< SnapFunctionsRegistry >

Enumerations
enum class	SnapMode { SNAP_OFF , SNAP_NEAREST , SNAP_PRIOR }

Functions
SNAPPING_API SnapMode	ReadSnapMode ()
SNAPPING_API Identifier	ReadSnapTo ()
std::unique_ptr< SnapRegistryItem >	TimeInvariantSnapFunction (const Identifier &functionId, const TranslatableString &label, double multiplier)
std::unique_ptr< SnapRegistryItem >	TimeInvariantSnapFunction (const Identifier &functionId, const TranslatableString &label, MultiplierFunctor functor)

Variables
SNAPPING_API StringSetting	SnapToSetting
SNAPPING_API EnumSetting< SnapMode >	SnapModeSetting
constexpr auto	SnapFunctionGroup
constexpr auto	SnapFunctionItems

Typedef Documentation

MultiplierFunctor

using MultiplierFunctor = std::function<double(const AudacityProject&)>

Definition at line 92 of file SnapUtils.h.

SnapRegistryItemRegistrator

using SnapRegistryItemRegistrator = Registry::RegisteredItem<SnapFunctionsRegistry>

Definition at line 114 of file SnapUtils.h.

SnapRegistryVisitor

using SnapRegistryVisitor = Registry::VisitorFunctions<SnapRegistryTraits>

Definition at line 56 of file SnapUtils.h.

Enumeration Type Documentation

SnapMode

enum class SnapMode

strong

---

Audacity: A Digital Audio Editor

SnapUtils.h

Dmitry Vedenko

Enumerator
SNAP_OFF
SNAP_NEAREST
SNAP_PRIOR

Definition at line 20 of file SnapUtils.h.

{
   SNAP_OFF,
   SNAP_NEAREST,
   SNAP_PRIOR
};

Function Documentation

ReadSnapMode()

SNAPPING_API SnapMode ReadSnapMode

(

)

Definition at line 38 of file SnapUtils.cpp.

{
   if (gPrefs->HasEntry(SnapModeKey))
      return SnapModeSetting.ReadEnum();
 
   return static_cast<SnapMode>(gPrefs->Read(OldSnapToKey, 0L));
}

References gPrefs, audacity::BasicSettings::HasEntry(), anonymous_namespace{SnapUtils.cpp}::OldSnapToKey, audacity::BasicSettings::Read(), anonymous_namespace{SnapUtils.cpp}::SnapModeKey, and SnapModeSetting.

Here is the call graph for this function:

ReadSnapTo()

SNAPPING_API Identifier ReadSnapTo

(

)

Definition at line 90 of file SnapUtils.cpp.

{
   if (gPrefs->HasEntry(SnapToKey))
      return SnapToSetting.Read();
 
   // Try to perform the config migration once
   const auto snapTo = DeduceSnapTo();
   SnapToSetting.Write(snapTo);
   gPrefs->Flush();
 
 
   return snapTo;
}

References DeduceSnapTo(), audacity::BasicSettings::Flush(), gPrefs, audacity::BasicSettings::HasEntry(), Setting< T >::Read(), anonymous_namespace{SnapUtils.cpp}::SnapToKey, SnapToSetting, and Setting< T >::Write().

Referenced by anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::GetStringValue(), anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::Init(), and anonymous_namespace{SnappingToolBar.cpp}::SnapModePopup::OnPopup().

Here is the call graph for this function:

Here is the caller graph for this function:

TimeInvariantSnapFunction() [1/2]

std::unique_ptr< SnapRegistryItem > TimeInvariantSnapFunction	(	const Identifier &	functionId,
		const TranslatableString &	label,
		double	multiplier
	)

Definition at line 294 of file SnapUtils.cpp.

{
   return std::make_unique<ConstantMultiplierSnapItem>(
      functionId, label, multiplier);
}

References label.

TimeInvariantSnapFunction() [2/2]

std::unique_ptr< SnapRegistryItem > TimeInvariantSnapFunction	(	const Identifier &	functionId,
		const TranslatableString &	label,
		MultiplierFunctor	functor
	)

Definition at line 286 of file SnapUtils.cpp.

{
   return std::make_unique<ProjectDependentMultiplierSnapItem>(
      functionId, label, std::move(functor));
}

References label.

Variable Documentation

SnapFunctionGroup

constexpr auto SnapFunctionGroup

constexpr

Initial value:

= Callable::UniqueMaker<
   SnapRegistryGroup, const Identifier &, SnapRegistryGroupData>()

Definition at line 98 of file SnapUtils.h.

SnapFunctionItems

constexpr auto SnapFunctionItems

constexpr

Initial value:

=
   Callable::UniqueMaker<SnapFunctionSuperGroup>()

Definition at line 123 of file SnapUtils.h.

SnapModeSetting

SNAPPING_API EnumSetting<SnapMode> SnapModeSetting

extern

Definition at line 31 of file SnapUtils.cpp.

Referenced by anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), ReadSnapMode(), and ProjectSnap::SetSnapMode().

SnapToSetting

SNAPPING_API StringSetting SnapToSetting

extern

Definition at line 29 of file SnapUtils.cpp.

Referenced by DeduceSnapTo(), anonymous_namespace{PluginMenus.cpp}::OnResetConfig(), ReadSnapTo(), and ProjectSnap::SetSnapTo().