audacity::sqlite::ScalarFunction Class Reference

A class representing a scalar function in a SQLite database. More...

#include <Function.h>

Collaboration diagram for audacity::sqlite::ScalarFunction:

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

Private Member Functions
template<typename ScalarFunctionType >
	ScalarFunction (sqlite3 *connection, std::string name, ScalarFunctionType function)
void	Register (std::size_t arity)

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

Private Attributes
sqlite3 *	mConnection { nullptr }
std::string	mName
details::SQLiteFunctorWithArgs	mFunctor

Friends
class	Connection

Detailed Description

A class representing a scalar function in a SQLite database.

Definition at line 147 of file Function.h.

Constructor & Destructor Documentation

ScalarFunction() [1/4]

template<typename ScalarFunctionType >

audacity::sqlite::ScalarFunction::ScalarFunction ( sqlite3 *  connection, std::string  name, ScalarFunctionType  function  )

inlineprivate

Definition at line 150 of file Function.h.

       : mConnection { connection }
       , mName { std::move(name) }
       , mFunctor { details::MakeSQLiteFunctorWithArgs(std::move(function)) }
   {
      Register(details::GetFunctionArity<ScalarFunctionType>());
   }

ScalarFunction() [2/4]

audacity::sqlite::ScalarFunction::ScalarFunction ( )

default

ScalarFunction() [3/4]

audacity::sqlite::ScalarFunction::ScalarFunction ( const ScalarFunction &  )

delete

ScalarFunction() [4/4]

audacity::sqlite::ScalarFunction::ScalarFunction ( ScalarFunction &&  rhs )

noexcept

Definition at line 154 of file Function.cpp.

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

~ScalarFunction()

audacity::sqlite::ScalarFunction::~ScalarFunction

(

)

Definition at line 168 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

CallFunction()

void audacity::sqlite::ScalarFunction::CallFunction ( sqlite3_context *  context, int  argc, sqlite3_value **  argv  )

staticprivate

Definition at line 185 of file Function.cpp.

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

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

Referenced by Register().

Here is the caller graph for this function:

operator=() [1/2]

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

delete

operator=() [2/2]

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

noexcept

Definition at line 159 of file Function.cpp.

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

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

Here is the call graph for this function:

Register()

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

private

Definition at line 178 of file Function.cpp.

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

References CallFunction(), mConnection, and mName.

Here is the call graph for this function:

Friends And Related Function Documentation

Connection

friend class Connection

friend

Definition at line 176 of file Function.h.

Member Data Documentation

mConnection

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

private

Definition at line 173 of file Function.h.

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

mFunctor

details::SQLiteFunctorWithArgs audacity::sqlite::ScalarFunction::mFunctor

private

Definition at line 175 of file Function.h.

Referenced by CallFunction().

mName

std::string audacity::sqlite::ScalarFunction::mName

private

Definition at line 174 of file Function.h.

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

---

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

• Function.h
• Function.cpp