1fca6228fe
The LIBCAMERA_DECLARE_PRIVATE() macro, used by the library classes that inherit from libcamera::Extensible in order to implement the PIMPL pattern, expands to: public: \ class Private; \ friend class Private; The 'klass' argument is not used and it might confuse developers as it might hint that the class that defines the pattern's implementation can be freely named, while it is actually hardcoded to 'Private'. Drop the argument from the macro definition. Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> Reviewed-by: Hanlin Chen <hanlinchen@google.com> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
106 lines
1.9 KiB
C++
106 lines
1.9 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2020, Google Inc.
|
|
*
|
|
* class.h - Utilities and helpers for classes
|
|
*/
|
|
#ifndef __LIBCAMERA_CLASS_H__
|
|
#define __LIBCAMERA_CLASS_H__
|
|
|
|
#include <memory>
|
|
|
|
namespace libcamera {
|
|
|
|
#ifndef __DOXYGEN__
|
|
#define LIBCAMERA_DISABLE_COPY(klass) \
|
|
klass(const klass &) = delete; \
|
|
klass &operator=(const klass &) = delete;
|
|
|
|
#define LIBCAMERA_DISABLE_MOVE(klass) \
|
|
klass(klass &&) = delete; \
|
|
klass &operator=(klass &&) = delete;
|
|
|
|
#define LIBCAMERA_DISABLE_COPY_AND_MOVE(klass) \
|
|
LIBCAMERA_DISABLE_COPY(klass) \
|
|
LIBCAMERA_DISABLE_MOVE(klass)
|
|
#else
|
|
#define LIBCAMERA_DISABLE_COPY(klass)
|
|
#define LIBCAMERA_DISABLE_MOVE(klass)
|
|
#define LIBCAMERA_DISABLE_COPY_AND_MOVE(klass)
|
|
#endif
|
|
|
|
#ifndef __DOXYGEN__
|
|
#define LIBCAMERA_DECLARE_PRIVATE() \
|
|
public: \
|
|
class Private; \
|
|
friend class Private;
|
|
|
|
#define LIBCAMERA_DECLARE_PUBLIC(klass) \
|
|
friend class klass; \
|
|
using Public = klass;
|
|
|
|
#define LIBCAMERA_D_PTR() \
|
|
_d<Private>();
|
|
|
|
#define LIBCAMERA_O_PTR() \
|
|
_o<Public>();
|
|
|
|
#else
|
|
#define LIBCAMERA_DECLARE_PRIVATE()
|
|
#define LIBCAMERA_DECLARE_PUBLIC(klass)
|
|
#define LIBCAMERA_D_PTR(klass)
|
|
#define LIBCAMERA_O_PTR(klass)
|
|
#endif
|
|
|
|
class Extensible
|
|
{
|
|
public:
|
|
class Private
|
|
{
|
|
public:
|
|
Private(Extensible *o);
|
|
virtual ~Private();
|
|
|
|
#ifndef __DOXYGEN__
|
|
template<typename T>
|
|
const T *_o() const
|
|
{
|
|
return static_cast<const T *>(o_);
|
|
}
|
|
|
|
template<typename T>
|
|
T *_o()
|
|
{
|
|
return static_cast<T *>(o_);
|
|
}
|
|
#endif
|
|
|
|
private:
|
|
Extensible *const o_;
|
|
};
|
|
|
|
Extensible(Private *d);
|
|
|
|
protected:
|
|
#ifndef __DOXYGEN__
|
|
template<typename T>
|
|
const T *_d() const
|
|
{
|
|
return static_cast<const T *>(d_.get());
|
|
}
|
|
|
|
template<typename T>
|
|
T *_d()
|
|
{
|
|
return static_cast<T *>(d_.get());
|
|
}
|
|
#endif
|
|
|
|
private:
|
|
const std::unique_ptr<Private> d_;
|
|
};
|
|
|
|
} /* namespace libcamera */
|
|
|
|
#endif /* __LIBCAMERA_CLASS_H__ */
|