libcamera/include/libcamera/base/file.h
Kieran Bingham e228c290c9 libcamera/base: Validate internal headers as private
Headers which must not be exposed as part of the public libcamera API
should include base/private.h.

Any interface which includes the private.h header will only be able to
build if the libcamera_private dependency is used (or the
libcamera_base_private dependency directly).

Build targets which are intended to use the private API's will use the
libcamera_private to handle the automatic definition of the inclusion
guard.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2021-06-25 16:11:11 +01:00

80 lines
1.4 KiB
C++

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2020, Google Inc.
*
* file.h - File I/O operations
*/
#ifndef __LIBCAMERA_BASE_FILE_H__
#define __LIBCAMERA_BASE_FILE_H__
#include <sys/types.h>
#include <map>
#include <string>
#include <libcamera/base/private.h>
#include <libcamera/base/class.h>
#include <libcamera/base/span.h>
namespace libcamera {
class File
{
public:
enum MapFlag {
MapNoOption = 0,
MapPrivate = (1 << 0),
};
enum OpenMode {
NotOpen = 0,
ReadOnly = (1 << 0),
WriteOnly = (1 << 1),
ReadWrite = ReadOnly | WriteOnly,
};
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_ != -1; }
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,
MapFlag flags = MapNoOption);
bool unmap(uint8_t *addr);
static bool exists(const std::string &name);
private:
LIBCAMERA_DISABLE_COPY(File)
void unmapAll();
std::string name_;
int fd_;
OpenMode mode_;
int error_;
std::map<void *, size_t> maps_;
};
} /* namespace libcamera */
#endif /* __LIBCAMERA_BASE_FILE_H__ */