7#ifndef __LIBCAMERA_BASE_FILE_H__
8#define __LIBCAMERA_BASE_FILE_H__
15#include <libcamera/base/private.h>
19#include <libcamera/base/span.h>
42 File(
const std::string &name);
46 const std::string &
fileName()
const {
return name_; }
51 bool isOpen()
const {
return fd_ != -1; }
55 int error()
const {
return error_; }
61 ssize_t
read(
const Span<uint8_t> &data);
62 ssize_t
write(
const Span<const uint8_t> &data);
64 Span<uint8_t>
map(off_t offset = 0, ssize_t
size = -1,
66 bool unmap(uint8_t *addr);
68 static bool exists(
const std::string &name);
80 std::map<void *, size_t> maps_;
Utilities to help constructing class interfaces.
#define LIBCAMERA_DISABLE_COPY(klass)
Disable copy construction and assignment of the klass.
Interface for I/O operations on files.
Definition: file.h:24
MapFlag
Flags for the File::map() function.
Definition: file.h:26
@ NoOption
No option (used as default value)
@ Private
The memory region is mapped as private, changes are not reflected in the file constents.
int error() const
Retrieve the file error status.
Definition: file.h:55
const std::string & fileName() const
Retrieve the file name.
Definition: file.h:46
bool exists() const
Check if the file specified by fileName() exists.
Definition: file.cpp:151
bool open(OpenMode mode)
Open the file in the given mode.
Definition: file.cpp:169
ssize_t write(const Span< const uint8_t > &data)
Write data to the file.
Definition: file.cpp:339
void close()
Close the file.
Definition: file.cpp:210
OpenModeFlag
Mode in which a file is opened.
Definition: file.h:33
@ ReadOnly
The file is open for reading.
@ WriteOnly
The file is open for writing.
@ ReadWrite
The file is open for reading and writing.
@ NotOpen
The file is not open.
bool isOpen() const
Check if the file is open.
Definition: file.h:51
~File()
Destroy a File instance.
Definition: file.cpp:107
File()
Construct a File without an associated name.
Definition: file.cpp:96
Flags< OpenModeFlag > OpenMode
A bitwise combination of File::OpenModeFlag values.
Definition: file.h:40
OpenMode openMode() const
Retrieve the file open mode.
Definition: file.h:52
Flags< MapFlag > MapFlags
A bitwise combination of File::MapFlag values.
Definition: file.h:31
ssize_t read(const Span< uint8_t > &data)
Read data from the file.
Definition: file.cpp:301
off_t seek(off_t pos)
Set the read or write position.
Definition: file.cpp:274
Span< uint8_t > map(off_t offset=0, ssize_t size=-1, MapFlags flags=MapFlag::NoOption)
Map a region of the file in the process memory.
Definition: file.cpp:384
bool unmap(uint8_t *addr)
Unmap a region mapped with map()
Definition: file.cpp:431
ssize_t size() const
Retrieve the file size.
Definition: file.cpp:240
off_t pos() const
Return current read or write position.
Definition: file.cpp:260
void setFileName(const std::string &name)
Set the name of the file.
Definition: file.cpp:128
Type-safe container for enum-based bitfields.
Definition: flags.h:16
#define LIBCAMERA_FLAGS_ENABLE_OPERATORS(_enum)
Enable bitwise operations on the enum enumeration.
Top-level libcamera namespace.
Definition: backtrace.h:17