ProjectFormatExtensionsRegistry Class Reference

The class that allows evaluating the minimum version of Audacity required to support the project. More...

#include <ProjectFormatExtensionsRegistry.h>

Inheritance diagram for ProjectFormatExtensionsRegistry:

Collaboration diagram for ProjectFormatExtensionsRegistry:

Classes
struct	Extension
	A struct to register the project extension that requires a different project version. More...

Public Types
using	ProjectVersionResolver = ProjectFormatVersion(*)(const AudacityProject &)

Public Member Functions
ProjectFormatVersion	GetRequiredVersion (const AudacityProject &project) const
	Returns the minimum possible version that can be used to save the project. More...
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static const ProjectFormatExtensionsRegistry &	Get ()

Private Member Functions
void	Register (ProjectVersionResolver resolver)

Private Attributes
std::vector< ProjectVersionResolver >	mRegisteredExtensions

Detailed Description

The class that allows evaluating the minimum version of Audacity required to support the project.

Definition at line 22 of file ProjectFormatExtensionsRegistry.h.

Member Typedef Documentation

ProjectVersionResolver

using ProjectFormatExtensionsRegistry::ProjectVersionResolver = ProjectFormatVersion (*)(const AudacityProject&)

Definition at line 26 of file ProjectFormatExtensionsRegistry.h.

Member Function Documentation

Get()

const ProjectFormatExtensionsRegistry & ProjectFormatExtensionsRegistry::Get ( )

static

Definition at line 24 of file ProjectFormatExtensionsRegistry.cpp.

{
   return GetProjectFormatExtensionsRegistry();
}

References GetProjectFormatExtensionsRegistry().

Referenced by ProjectFileIO::WriteDoc().

Here is the call graph for this function:

Here is the caller graph for this function:

GetRequiredVersion()

ProjectFormatVersion ProjectFormatExtensionsRegistry::GetRequiredVersion

(

const AudacityProject &

project

)

const

Returns the minimum possible version that can be used to save the project.

Definition at line 35 of file ProjectFormatExtensionsRegistry.cpp.

{
   ProjectFormatVersion minVersion = BaseProjectFormatVersion;
 
   for (auto formatExtension : mRegisteredExtensions)
   {
      if (!formatExtension)
         continue;
      
      const auto formatExtensionVersion = formatExtension(project);
 
      if (minVersion < formatExtensionVersion)
         minVersion = formatExtensionVersion;
   }
 
   return minVersion;
}

References BaseProjectFormatVersion, mRegisteredExtensions, and project.

Referenced by ProjectFileIO::WriteDoc().

Here is the caller graph for this function:

Register()

void ProjectFormatExtensionsRegistry::Register ( ProjectVersionResolver  resolver )

private

Definition at line 29 of file ProjectFormatExtensionsRegistry.cpp.

{
   mRegisteredExtensions.emplace_back(std::move(formatExtension));
}

References mRegisteredExtensions.

Referenced by ProjectFormatExtensionsRegistry::Extension::Extension().

Here is the caller graph for this function:

Member Data Documentation

mRegisteredExtensions

std::vector<ProjectVersionResolver> ProjectFormatExtensionsRegistry::mRegisteredExtensions

private

Definition at line 42 of file ProjectFormatExtensionsRegistry.h.

Referenced by GetRequiredVersion(), and Register().

---

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

• ProjectFormatExtensionsRegistry.h
• ProjectFormatExtensionsRegistry.cpp