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>
54 lines
1.1 KiB
C++
54 lines
1.1 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2019, Google Inc.
|
|
*
|
|
* Camera controls
|
|
*/
|
|
|
|
#include "libcamera/internal/camera_controls.h"
|
|
|
|
#include <libcamera/camera.h>
|
|
#include <libcamera/controls.h>
|
|
|
|
/**
|
|
* \file camera_controls.h
|
|
* \brief Controls for Camera instances
|
|
*/
|
|
|
|
namespace libcamera {
|
|
|
|
/**
|
|
* \class CameraControlValidator
|
|
* \brief A control validator for Camera instances
|
|
*
|
|
* This ControlValidator specialisation validates that controls exist in the
|
|
* Camera associated with the validator.
|
|
*/
|
|
|
|
/**
|
|
* \brief Construst a CameraControlValidator for the \a camera
|
|
* \param[in] camera The camera
|
|
*/
|
|
CameraControlValidator::CameraControlValidator(Camera *camera)
|
|
: camera_(camera)
|
|
{
|
|
}
|
|
|
|
const std::string &CameraControlValidator::name() const
|
|
{
|
|
return camera_->id();
|
|
}
|
|
|
|
/**
|
|
* \brief Validate a control
|
|
* \param[in] id The control ID
|
|
* \return True if the control is valid, false otherwise
|
|
*/
|
|
bool CameraControlValidator::validate(unsigned int id) const
|
|
{
|
|
const ControlInfoMap &controls = camera_->controls();
|
|
return controls.find(id) != controls.end();
|
|
}
|
|
|
|
} /* namespace libcamera */
|