audacity::sqlite::RunContext Class Reference

A class representing a context of a run operation. More...

#include <Statement.h>

Collaboration diagram for audacity::sqlite::RunContext:

Public Member Functions
	RunContext (const RunContext &)=delete
	RunContext (RunContext &&) noexcept
RunContext &	operator= (const RunContext &)=delete
RunContext &	operator= (RunContext &&) noexcept
RunContext &	Bind (int index, const void *data, int64_t size, bool makeCopy=true)
RunContext &	Bind (int index, const std::string &value, bool makeCopy=true)
RunContext &	Bind (int index, std::string_view value, bool makeCopy=true)
RunContext &	Bind (int index, const char *value, bool makeCopy=true)
RunContext &	Bind (int index, bool value)
RunContext &	Bind (int index, int value)
RunContext &	Bind (int index, long value)
RunContext &	Bind (int index, long long value)
RunContext &	Bind (int index, std::size_t value)
RunContext &	Bind (int index, float value)
RunContext &	Bind (int index, double value)
RunContext &	Bind (int index, std::nullptr_t)
RunContext &	BindZeroBlob (int index, int64_t size)
template<typename T >
RunContext &	Bind (const std::string &name, const T &value)
template<typename T >
RunContext &	Bind (const std::string &name, const T &value, bool make_copy)
template<typename... Args>
RunContext &	BindAll (Args &&... args)
int	GetParameterIndex (const std::string &name) const noexcept
RunResult	Run ()

Private Member Functions
	RunContext (StatementHandlePtr statement) noexcept
template<typename Binder >
RunContext &	DoBind (Binder binder)

Private Attributes
StatementHandlePtr	mStatement {}
std::vector< Error >	mErrors {}
bool	mNeedsReset { false }

Friends
class	Statement

Detailed Description

A class representing a context of a run operation.

Indices are 1-based

Definition at line 132 of file Statement.h.

Constructor & Destructor Documentation

RunContext() [1/3]

audacity::sqlite::RunContext::RunContext ( StatementHandlePtr  statement )

explicitprivatenoexcept

Definition at line 62 of file Statement.cpp.

    : mStatement { std::move(stmt) }
{
}

RunContext() [2/3]

audacity::sqlite::RunContext::RunContext ( const RunContext &  )

delete

RunContext() [3/3]

audacity::sqlite::RunContext::RunContext ( RunContext &&  rhs )

noexcept

Definition at line 67 of file Statement.cpp.

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

Member Function Documentation

Bind() [1/14]

template<typename T >

RunContext & audacity::sqlite::RunContext::Bind ( const std::string &  name, const T &  value  )

inline

Definition at line 162 of file Statement.h.

   {
      return Bind(GetParameterIndex(name), value);
   }

References name.

Bind() [2/14]

template<typename T >

RunContext & audacity::sqlite::RunContext::Bind ( const std::string &  name, const T &  value, bool  make_copy  )

inline

Definition at line 168 of file Statement.h.

   {
      return Bind(GetParameterIndex(name), value, make_copy);
   }

References name.

Bind() [3/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		bool	value
	)

Definition at line 137 of file Statement.cpp.

{
   return Bind(index, static_cast<long long>(value));
}

References Bind().

Here is the call graph for this function:

Bind() [4/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		const char *	value,
		bool	makeCopy = true
	)

Definition at line 131 of file Statement.cpp.

{
   return Bind(index, std::string_view { value }, makeCopy);
}

References Bind().

Here is the call graph for this function:

Bind() [5/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		const std::string &	value,
		bool	makeCopy = true
	)

Definition at line 107 of file Statement.cpp.

{
   return Bind(index, std::string_view { value }, makeCopy);
}

References Bind().

Here is the call graph for this function:

Bind() [6/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		const void *	data,
		int64_t	size,
		bool	makeCopy = true
	)

Definition at line 91 of file Statement.cpp.

{
   if (data == nullptr)
      return BindZeroBlob(index, size);
 
   return DoBind(
      [&]
      {
         return sqlite3_bind_blob64(
            *mStatement, index, data, size,
            makeCopy ? SQLITE_TRANSIENT : SQLITE_STATIC);
      });
}

References BindZeroBlob(), DoBind(), mStatement, and size.

Referenced by Bind().

Here is the call graph for this function:

Here is the caller graph for this function:

Bind() [7/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		double	value
	)

Definition at line 172 of file Statement.cpp.

{
   return DoBind([&] { return sqlite3_bind_double(*mStatement, index, value); });
}

References DoBind(), and mStatement.

Here is the call graph for this function:

Bind() [8/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		float	value
	)

Definition at line 166 of file Statement.cpp.

{
   return Bind(index, static_cast<double>(value));
}

References Bind().

Here is the call graph for this function:

Bind() [9/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		int	value
	)

Definition at line 143 of file Statement.cpp.

{
   return Bind(index, static_cast<long long>(value));
}

References Bind().

Here is the call graph for this function:

Bind() [10/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		long long	value
	)

Definition at line 155 of file Statement.cpp.

{
   return DoBind([&] { return sqlite3_bind_int64(*mStatement, index, value); });
}

References DoBind(), and mStatement.

Here is the call graph for this function:

Bind() [11/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		long	value
	)

Definition at line 149 of file Statement.cpp.

{
   return Bind(index, static_cast<long long>(value));
}

References Bind().

Here is the call graph for this function:

Bind() [12/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		std::nullptr_t
	)

Definition at line 178 of file Statement.cpp.

{
   return DoBind([&] { return sqlite3_bind_null(*mStatement, index); });
}

References DoBind(), and mStatement.

Here is the call graph for this function:

Bind() [13/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		std::size_t	value
	)

Definition at line 160 of file Statement.cpp.

{
   return DoBind([&] { return sqlite3_bind_int64(*mStatement, index, value); });
}

Bind() [14/14]

RunContext & audacity::sqlite::RunContext::Bind	(	int	index,
		std::string_view	value,
		bool	makeCopy = true
	)

Definition at line 113 of file Statement.cpp.

{
   return DoBind(
      [&]
      {
         if (mNeedsReset)
         {
            mNeedsReset = false;
            sqlite3_reset(*mStatement);
         }
 
         return sqlite3_bind_text(
            *mStatement, index, value.data(), value.size(),
            makeCopy ? SQLITE_TRANSIENT : SQLITE_STATIC);
      });
}

References DoBind(), mNeedsReset, and mStatement.

Here is the call graph for this function:

BindAll()

template<typename... Args>

RunContext & audacity::sqlite::RunContext::BindAll ( Args &&...  args )

inline

Definition at line 173 of file Statement.h.

   {
      int index = 0;
      (Bind(++index, std::forward<Args>(args)), ...);
      return *this;
   }

Referenced by audacity::sqlite::Statement::Prepare().

Here is the caller graph for this function:

BindZeroBlob()

RunContext & audacity::sqlite::RunContext::BindZeroBlob	(	int	index,
		int64_t	size
	)

Definition at line 184 of file Statement.cpp.

{
   return DoBind([&]
                 { return sqlite3_bind_zeroblob64(*mStatement, index, size); });
}

References DoBind(), mStatement, and size.

Referenced by Bind().

Here is the call graph for this function:

Here is the caller graph for this function:

DoBind()

template<typename Binder >

RunContext & audacity::sqlite::RunContext::DoBind ( Binder  binder )

private

Definition at line 81 of file Statement.cpp.

{
   if (mStatement == nullptr)
       mErrors.emplace_back(Error(SQLITE_MISUSE));
   else if (int result = binder(); result != SQLITE_OK)
      mErrors.emplace_back(Error(result));
 
   return *this;
}

References mErrors, and mStatement.

Referenced by Bind(), and BindZeroBlob().

Here is the caller graph for this function:

GetParameterIndex()

int audacity::sqlite::RunContext::GetParameterIndex ( const std::string &  name ) const

noexcept

Definition at line 190 of file Statement.cpp.

{
   return mStatement != nullptr ?
             sqlite3_bind_parameter_index(*mStatement, name.data()) :
             -1;
}

References name.

operator=() [1/2]

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

delete

operator=() [2/2]

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

noexcept

Definition at line 72 of file Statement.cpp.

{
   std::swap(mStatement, rhs.mStatement);
   std::swap(mErrors, rhs.mErrors);
 
   return *this;
}

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

Here is the call graph for this function:

Run()

RunResult audacity::sqlite::RunContext::Run

(

)

Definition at line 197 of file Statement.cpp.

{
   mNeedsReset = true;
   return RunResult { mStatement, std::move(mErrors) };
}

References mErrors, mNeedsReset, and mStatement.

Friends And Related Function Documentation

Statement

friend class Statement

friend

Definition at line 134 of file Statement.h.

Member Data Documentation

mErrors

std::vector<Error> audacity::sqlite::RunContext::mErrors {}

private

Definition at line 188 of file Statement.h.

Referenced by DoBind(), and Run().

mNeedsReset

bool audacity::sqlite::RunContext::mNeedsReset { false }

private

Definition at line 189 of file Statement.h.

Referenced by Bind(), and Run().

mStatement

StatementHandlePtr audacity::sqlite::RunContext::mStatement {}

private

Definition at line 187 of file Statement.h.

Referenced by Bind(), BindZeroBlob(), DoBind(), and Run().

---

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

• Statement.h
• Statement.cpp