audacity::sqlite::AggregateFunction Class Reference

A class representing an aggregate function in a SQLite database. More...

#include <Function.h>

Collaboration diagram for audacity::sqlite::AggregateFunction:

Public Member Functions
	AggregateFunction ()=default
	AggregateFunction (const AggregateFunction &)=delete
	AggregateFunction (AggregateFunction &&) noexcept
AggregateFunction &	operator= (const AggregateFunction &)=delete
AggregateFunction &	operator= (AggregateFunction &&) noexcept
	~AggregateFunction ()

Private Member Functions
template<typename StepFunctionType , typename FinalFunctionType >
	AggregateFunction (sqlite3 *connection, std::string name, StepFunctionType stepFunction, FinalFunctionType finalFunction)
void	Register (std::size_t arity)

Static Private Member Functions
static void	CallStepFunction (sqlite3_context *context, int argc, sqlite3_value **argv)
static void	CallFinalFunction (sqlite3_context *context)

Private Attributes
sqlite3 *	mConnection { nullptr }
std::string	mName
details::SQLiteFunctorWithArgs	mStepFunctor
details::SQLiteFunctor	mFinalFunctor

Friends
class	Connection

Detailed Description

A class representing an aggregate function in a SQLite database.

Definition at line 180 of file Function.h.

Constructor & Destructor Documentation

AggregateFunction() [1/4]

template<typename StepFunctionType , typename FinalFunctionType >

audacity::sqlite::AggregateFunction::AggregateFunction ( sqlite3 *  connection, std::string  name, StepFunctionType  stepFunction, FinalFunctionType  finalFunction  )

inlineprivate

Definition at line 183 of file Function.h.

       : mConnection { connection }
       , mName { std::move(name) }
       , mStepFunctor { details::MakeSQLiteFunctorWithArgs(
            std::move(stepFunction)) }
       , mFinalFunctor { details::MakeSQLiteFunctor(std::move(finalFunction)) }
   {
      Register(details::GetFunctionArity<StepFunctionType>());
   }

AggregateFunction() [2/4]

audacity::sqlite::AggregateFunction::AggregateFunction ( )

default

AggregateFunction() [3/4]

audacity::sqlite::AggregateFunction::AggregateFunction ( const AggregateFunction &  )

delete

AggregateFunction() [4/4]

audacity::sqlite::AggregateFunction::AggregateFunction ( AggregateFunction &&  rhs )

noexcept

Definition at line 212 of file Function.cpp.

{
   *this = std::move(rhs);
}

~AggregateFunction()

audacity::sqlite::AggregateFunction::~AggregateFunction

(

)

Definition at line 227 of file Function.cpp.

{
   if (mConnection)
   {
      sqlite3_create_function (
         mConnection, mName.c_str(), 0, SQLITE_UTF8, nullptr,
         nullptr, nullptr, nullptr);
   }
}

References mConnection, and mName.

Member Function Documentation

CallFinalFunction()

void audacity::sqlite::AggregateFunction::CallFinalFunction ( sqlite3_context *  context )

staticprivate

Definition at line 206 of file Function.cpp.

{
   auto* function = static_cast<AggregateFunction*>(sqlite3_user_data(context));
   function->mFinalFunctor(context);
}

References mFinalFunctor.

Referenced by Register().

Here is the caller graph for this function:

CallStepFunction()

void audacity::sqlite::AggregateFunction::CallStepFunction ( sqlite3_context *  context, int  argc, sqlite3_value **  argv  )

staticprivate

Definition at line 199 of file Function.cpp.

{
   auto* function = static_cast<AggregateFunction*>(sqlite3_user_data(context));
   function->mStepFunctor(context, argc, argv);
}

References CommandLineArgs::argc, CommandLineArgs::argv, and mStepFunctor.

Referenced by Register().

Here is the caller graph for this function:

operator=() [1/2]

AggregateFunction & audacity::sqlite::AggregateFunction::operator= ( AggregateFunction &&  rhs )

noexcept

Definition at line 217 of file Function.cpp.

{
   std::swap(mConnection, rhs.mConnection);
   std::swap(mName, rhs.mName);
   std::swap(mStepFunctor, rhs.mStepFunctor);
   std::swap(mFinalFunctor, rhs.mFinalFunctor);
 
   return *this;
}

References anonymous_namespace{NoteTrack.cpp}::swap().

Here is the call graph for this function:

operator=() [2/2]

AggregateFunction & audacity::sqlite::AggregateFunction::operator= ( const AggregateFunction &  )

delete

Register()

void audacity::sqlite::AggregateFunction::Register ( std::size_t  arity )

private

Definition at line 192 of file Function.cpp.

{
   sqlite3_create_function (
      mConnection, mName.c_str(), arity, SQLITE_UTF8, this,
      nullptr, &CallStepFunction, &CallFinalFunction);
}

References CallFinalFunction(), CallStepFunction(), mConnection, and mName.

Here is the call graph for this function:

Friends And Related Function Documentation

Connection

friend class Connection

friend

Definition at line 217 of file Function.h.

Member Data Documentation

mConnection

sqlite3* audacity::sqlite::AggregateFunction::mConnection { nullptr }

private

Definition at line 213 of file Function.h.

Referenced by Register(), and ~AggregateFunction().

mFinalFunctor

details::SQLiteFunctor audacity::sqlite::AggregateFunction::mFinalFunctor

private

Definition at line 216 of file Function.h.

Referenced by CallFinalFunction().

mName

std::string audacity::sqlite::AggregateFunction::mName

private

Definition at line 214 of file Function.h.

Referenced by Register(), and ~AggregateFunction().

mStepFunctor

details::SQLiteFunctorWithArgs audacity::sqlite::AggregateFunction::mStepFunctor

private

Definition at line 215 of file Function.h.

Referenced by CallStepFunction().

---

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

• Function.h
• Function.cpp