Laurent Pinchart
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>
124 lines
3.2 KiB
C++
124 lines
3.2 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2021, Google Inc.
|
|
*
|
|
* File descriptor wrapper that owns a file descriptor
|
|
*/
|
|
|
|
#include <libcamera/base/unique_fd.h>
|
|
|
|
#include <unistd.h>
|
|
#include <utility>
|
|
|
|
#include <libcamera/base/log.h>
|
|
|
|
/**
|
|
* \file base/unique_fd.h
|
|
* \brief File descriptor wrapper that owns a file descriptor
|
|
*/
|
|
|
|
namespace libcamera {
|
|
|
|
LOG_DEFINE_CATEGORY(UniqueFD)
|
|
|
|
/**
|
|
* \class UniqueFD
|
|
* \brief unique_ptr-like wrapper for a file descriptor
|
|
*
|
|
* The UniqueFD is a wrapper that owns and manages the lifetime of a file
|
|
* descriptor. It is constructed from a numerical file descriptor, and takes
|
|
* over its ownership. The file descriptor is closed when the UniqueFD is
|
|
* destroyed, or when it is assigned another file descriptor with operator=()
|
|
* or reset().
|
|
*/
|
|
|
|
/**
|
|
* \fn UniqueFD::UniqueFD()
|
|
* \brief Construct a UniqueFD that owns no file descriptor
|
|
*/
|
|
|
|
/**
|
|
* \fn UniqueFD::UniqueFD(int fd)
|
|
* \brief Construct a UniqueFD that owns \a fd
|
|
* \param[in] fd A file descriptor to manage
|
|
*/
|
|
|
|
/**
|
|
* \fn UniqueFD::UniqueFD(UniqueFD &&other)
|
|
* \brief Move constructor, create a UniqueFD by taking over \a other
|
|
* \param[in] other The other UniqueFD
|
|
*
|
|
* Create a UniqueFD by transferring ownership of the file descriptor owned by
|
|
* \a other. Upon return, the \a other UniqueFD is invalid.
|
|
*/
|
|
|
|
/**
|
|
* \fn UniqueFD::~UniqueFD()
|
|
* \brief Destroy the UniqueFD instance
|
|
*
|
|
* If a file descriptor is owned, it is closed.
|
|
*/
|
|
|
|
/**
|
|
* \fn UniqueFD::operator=(UniqueFD &&other)
|
|
* \brief Move assignment operator, replace a UniqueFD by taking over \a other
|
|
* \param[in] other The other UniqueFD
|
|
*
|
|
* If this UniqueFD owns a file descriptor, the file descriptor is closed
|
|
* first. The file descriptor is then replaced by the one of \a other. Upon
|
|
* return, \a other is invalid.
|
|
*
|
|
* \return A reference to this UniqueFD
|
|
*/
|
|
|
|
/**
|
|
* \fn UniqueFD::release()
|
|
* \brief Release ownership of the file descriptor without closing it
|
|
*
|
|
* This function releases and returns the owned file descriptor without closing
|
|
* it. The caller owns the returned value and must take care of handling its
|
|
* life time to avoid file descriptor leakages. Upon return this UniqueFD is
|
|
* invalid.
|
|
*
|
|
* \return The managed file descriptor, or -1 if no file descriptor was owned
|
|
*/
|
|
|
|
/**
|
|
* \brief Replace the managed file descriptor
|
|
* \param[in] fd The new file descriptor to manage
|
|
*
|
|
* Close the managed file descriptor, if any, and replace it with the new \a fd.
|
|
*
|
|
* Self-resetting (passing an \a fd already managed by this instance) is invalid
|
|
* and results in undefined behaviour.
|
|
*/
|
|
void UniqueFD::reset(int fd)
|
|
{
|
|
ASSERT(!isValid() || fd != fd_);
|
|
|
|
std::swap(fd, fd_);
|
|
|
|
if (fd >= 0)
|
|
close(fd);
|
|
}
|
|
|
|
/**
|
|
* \fn UniqueFD::swap(UniqueFD &other)
|
|
* \brief Swap the managed file descriptors with another UniqueFD
|
|
* \param[in] other Another UniqueFD to swap the file descriptor with
|
|
*/
|
|
|
|
/**
|
|
* \fn UniqueFD::get()
|
|
* \brief Retrieve the managed file descriptor
|
|
* \return The managed file descriptor, or -1 if no file descriptor is owned
|
|
*/
|
|
|
|
/**
|
|
* \fn UniqueFD::isValid()
|
|
* \brief Check if the UniqueFD owns a valid file descriptor
|
|
* \return True if the UniqueFD owns a valid file descriptor, false otherwise
|
|
*/
|
|
|
|
} /* namespace libcamera */
|