mirror of
https://git.libcamera.org/libcamera/libcamera.git
synced 2025-07-12 14:59:44 +03:00
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>
87 lines
1.6 KiB
C++
87 lines
1.6 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2020, Google Inc.
|
|
*
|
|
* File I/O operations
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <sys/types.h>
|
|
|
|
#include <map>
|
|
#include <string>
|
|
|
|
#include <libcamera/base/private.h>
|
|
|
|
#include <libcamera/base/class.h>
|
|
#include <libcamera/base/flags.h>
|
|
#include <libcamera/base/span.h>
|
|
#include <libcamera/base/unique_fd.h>
|
|
|
|
namespace libcamera {
|
|
|
|
class File
|
|
{
|
|
public:
|
|
enum class MapFlag {
|
|
NoOption = 0,
|
|
Private = (1 << 0),
|
|
};
|
|
|
|
using MapFlags = Flags<MapFlag>;
|
|
|
|
enum class OpenModeFlag {
|
|
NotOpen = 0,
|
|
ReadOnly = (1 << 0),
|
|
WriteOnly = (1 << 1),
|
|
ReadWrite = ReadOnly | WriteOnly,
|
|
};
|
|
|
|
using OpenMode = Flags<OpenModeFlag>;
|
|
|
|
File(const std::string &name);
|
|
File();
|
|
~File();
|
|
|
|
const std::string &fileName() const { return name_; }
|
|
void setFileName(const std::string &name);
|
|
bool exists() const;
|
|
|
|
bool open(OpenMode mode);
|
|
bool isOpen() const { return fd_.isValid(); }
|
|
OpenMode openMode() const { return mode_; }
|
|
void close();
|
|
|
|
int error() const { return error_; }
|
|
ssize_t size() const;
|
|
|
|
off_t pos() const;
|
|
off_t seek(off_t pos);
|
|
|
|
ssize_t read(const Span<uint8_t> &data);
|
|
ssize_t write(const Span<const uint8_t> &data);
|
|
|
|
Span<uint8_t> map(off_t offset = 0, ssize_t size = -1,
|
|
MapFlags flags = MapFlag::NoOption);
|
|
bool unmap(uint8_t *addr);
|
|
|
|
static bool exists(const std::string &name);
|
|
|
|
private:
|
|
LIBCAMERA_DISABLE_COPY(File)
|
|
|
|
void unmapAll();
|
|
|
|
std::string name_;
|
|
UniqueFD fd_;
|
|
OpenMode mode_;
|
|
|
|
int error_;
|
|
std::map<void *, size_t> maps_;
|
|
};
|
|
|
|
LIBCAMERA_FLAGS_ENABLE_OPERATORS(File::MapFlag)
|
|
LIBCAMERA_FLAGS_ENABLE_OPERATORS(File::OpenModeFlag)
|
|
|
|
} /* namespace libcamera */
|