Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.
Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment block.
The change was generated with the following script:
----------------------------------------
dirs="include/libcamera src test utils"
declare -rA patterns=(
['c']=' \* '
['cpp']=' \* '
['h']=' \* '
['py']='# '
['sh']='# '
)
for ext in ${!patterns[@]} ; do
files=$(for dir in $dirs ; do find $dir -name "*.${ext}" ; done)
pattern=${patterns[${ext}]}
for file in $files ; do
name=$(basename ${file})
sed -i "s/^\(${pattern}\)${name} - /\1/" "$file"
done
done
----------------------------------------
This misses several files that are out of sync with the comment block
header. Those will be addressed separately and manually.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
225 lines
4.9 KiB
C++
225 lines
4.9 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2019, Google Inc.
|
|
*
|
|
* Method bind and invocation
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <memory>
|
|
#include <tuple>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
|
|
namespace libcamera {
|
|
|
|
class Object;
|
|
|
|
enum ConnectionType {
|
|
ConnectionTypeAuto,
|
|
ConnectionTypeDirect,
|
|
ConnectionTypeQueued,
|
|
ConnectionTypeBlocking,
|
|
};
|
|
|
|
class BoundMethodPackBase
|
|
{
|
|
public:
|
|
virtual ~BoundMethodPackBase() = default;
|
|
};
|
|
|
|
template<typename R, typename... Args>
|
|
class BoundMethodPack : public BoundMethodPackBase
|
|
{
|
|
public:
|
|
BoundMethodPack(const Args &... args)
|
|
: args_(args...)
|
|
{
|
|
}
|
|
|
|
R returnValue()
|
|
{
|
|
return ret_;
|
|
}
|
|
|
|
std::tuple<typename std::remove_reference_t<Args>...> args_;
|
|
R ret_;
|
|
};
|
|
|
|
template<typename... Args>
|
|
class BoundMethodPack<void, Args...> : public BoundMethodPackBase
|
|
{
|
|
public:
|
|
BoundMethodPack(const Args &... args)
|
|
: args_(args...)
|
|
{
|
|
}
|
|
|
|
void returnValue()
|
|
{
|
|
}
|
|
|
|
std::tuple<typename std::remove_reference_t<Args>...> args_;
|
|
};
|
|
|
|
class BoundMethodBase
|
|
{
|
|
public:
|
|
BoundMethodBase(void *obj, Object *object, ConnectionType type)
|
|
: obj_(obj), object_(object), connectionType_(type)
|
|
{
|
|
}
|
|
virtual ~BoundMethodBase() = default;
|
|
|
|
template<typename T, std::enable_if_t<!std::is_same<Object, T>::value> * = nullptr>
|
|
bool match(T *obj) { return obj == obj_; }
|
|
bool match(Object *object) { return object == object_; }
|
|
|
|
Object *object() const { return object_; }
|
|
|
|
virtual void invokePack(BoundMethodPackBase *pack) = 0;
|
|
|
|
protected:
|
|
bool activatePack(std::shared_ptr<BoundMethodPackBase> pack,
|
|
bool deleteMethod);
|
|
|
|
void *obj_;
|
|
Object *object_;
|
|
|
|
private:
|
|
ConnectionType connectionType_;
|
|
};
|
|
|
|
template<typename R, typename... Args>
|
|
class BoundMethodArgs : public BoundMethodBase
|
|
{
|
|
public:
|
|
using PackType = BoundMethodPack<R, Args...>;
|
|
|
|
private:
|
|
template<std::size_t... I, typename T = R>
|
|
std::enable_if_t<!std::is_void<T>::value, void>
|
|
invokePack(BoundMethodPackBase *pack, std::index_sequence<I...>)
|
|
{
|
|
PackType *args = static_cast<PackType *>(pack);
|
|
args->ret_ = invoke(std::get<I>(args->args_)...);
|
|
}
|
|
|
|
template<std::size_t... I, typename T = R>
|
|
std::enable_if_t<std::is_void<T>::value, void>
|
|
invokePack(BoundMethodPackBase *pack, std::index_sequence<I...>)
|
|
{
|
|
/* args is effectively unused when the sequence I is empty. */
|
|
PackType *args [[gnu::unused]] = static_cast<PackType *>(pack);
|
|
invoke(std::get<I>(args->args_)...);
|
|
}
|
|
|
|
public:
|
|
BoundMethodArgs(void *obj, Object *object, ConnectionType type)
|
|
: BoundMethodBase(obj, object, type) {}
|
|
|
|
void invokePack(BoundMethodPackBase *pack) override
|
|
{
|
|
invokePack(pack, std::make_index_sequence<sizeof...(Args)>{});
|
|
}
|
|
|
|
virtual R activate(Args... args, bool deleteMethod = false) = 0;
|
|
virtual R invoke(Args... args) = 0;
|
|
};
|
|
|
|
template<typename T, typename R, typename Func, typename... Args>
|
|
class BoundMethodFunctor : public BoundMethodArgs<R, Args...>
|
|
{
|
|
public:
|
|
using PackType = typename BoundMethodArgs<R, Args...>::PackType;
|
|
|
|
BoundMethodFunctor(T *obj, Object *object, Func func,
|
|
ConnectionType type = ConnectionTypeAuto)
|
|
: BoundMethodArgs<R, Args...>(obj, object, type), func_(func)
|
|
{
|
|
}
|
|
|
|
R activate(Args... args, bool deleteMethod = false) override
|
|
{
|
|
if (!this->object_)
|
|
return func_(args...);
|
|
|
|
auto pack = std::make_shared<PackType>(args...);
|
|
bool sync = BoundMethodBase::activatePack(pack, deleteMethod);
|
|
return sync ? pack->returnValue() : R();
|
|
}
|
|
|
|
R invoke(Args... args) override
|
|
{
|
|
return func_(args...);
|
|
}
|
|
|
|
private:
|
|
Func func_;
|
|
};
|
|
|
|
template<typename T, typename R, typename... Args>
|
|
class BoundMethodMember : public BoundMethodArgs<R, Args...>
|
|
{
|
|
public:
|
|
using PackType = typename BoundMethodArgs<R, Args...>::PackType;
|
|
|
|
BoundMethodMember(T *obj, Object *object, R (T::*func)(Args...),
|
|
ConnectionType type = ConnectionTypeAuto)
|
|
: BoundMethodArgs<R, Args...>(obj, object, type), func_(func)
|
|
{
|
|
}
|
|
|
|
bool match(R (T::*func)(Args...)) const { return func == func_; }
|
|
|
|
R activate(Args... args, bool deleteMethod = false) override
|
|
{
|
|
if (!this->object_) {
|
|
T *obj = static_cast<T *>(this->obj_);
|
|
return (obj->*func_)(args...);
|
|
}
|
|
|
|
auto pack = std::make_shared<PackType>(args...);
|
|
bool sync = BoundMethodBase::activatePack(pack, deleteMethod);
|
|
return sync ? pack->returnValue() : R();
|
|
}
|
|
|
|
R invoke(Args... args) override
|
|
{
|
|
T *obj = static_cast<T *>(this->obj_);
|
|
return (obj->*func_)(args...);
|
|
}
|
|
|
|
private:
|
|
R (T::*func_)(Args...);
|
|
};
|
|
|
|
template<typename R, typename... Args>
|
|
class BoundMethodStatic : public BoundMethodArgs<R, Args...>
|
|
{
|
|
public:
|
|
BoundMethodStatic(R (*func)(Args...))
|
|
: BoundMethodArgs<R, Args...>(nullptr, nullptr, ConnectionTypeAuto),
|
|
func_(func)
|
|
{
|
|
}
|
|
|
|
bool match(R (*func)(Args...)) const { return func == func_; }
|
|
|
|
R activate(Args... args, [[maybe_unused]] bool deleteMethod = false) override
|
|
{
|
|
return (*func_)(args...);
|
|
}
|
|
|
|
R invoke(Args...) override
|
|
{
|
|
return R();
|
|
}
|
|
|
|
private:
|
|
R (*func_)(Args...);
|
|
};
|
|
|
|
} /* namespace libcamera */
|