626172a16b
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>
109 lines
2 KiB
C++
109 lines
2 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2020, Google Inc.
|
|
*
|
|
* Utilities and helpers for classes
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#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; \
|
|
template <bool B = true> \
|
|
const Private *_d() const \
|
|
{ \
|
|
return Extensible::_d<Private>(); \
|
|
} \
|
|
template <bool B = true> \
|
|
Private *_d() \
|
|
{ \
|
|
return Extensible::_d<Private>(); \
|
|
}
|
|
|
|
#define LIBCAMERA_DECLARE_PUBLIC(klass) \
|
|
friend class klass; \
|
|
using Public = klass;
|
|
|
|
#define LIBCAMERA_O_PTR() \
|
|
_o<Public>()
|
|
|
|
#else
|
|
#define LIBCAMERA_DECLARE_PRIVATE()
|
|
#define LIBCAMERA_DECLARE_PUBLIC(klass)
|
|
#define LIBCAMERA_O_PTR()
|
|
#endif
|
|
|
|
class Extensible
|
|
{
|
|
public:
|
|
class Private
|
|
{
|
|
public:
|
|
Private();
|
|
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:
|
|
/* To initialize o_ from Extensible. */
|
|
friend class Extensible;
|
|
Extensible *const o_;
|
|
};
|
|
|
|
Extensible(std::unique_ptr<Private> d);
|
|
|
|
protected:
|
|
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());
|
|
}
|
|
|
|
private:
|
|
const std::unique_ptr<Private> d_;
|
|
};
|
|
|
|
} /* namespace libcamera */
|