25#include <libcamera/base/private.h>
31#define O_TMPFILE (020000000 | O_DIRECTORY)
40const char *
basename(
const char *path);
43std::string
dirname(
const std::string &path);
46std::vector<typename T::key_type>
map_keys(
const T &map)
48 std::vector<typename T::key_type> keys;
49 std::transform(map.begin(), map.end(), std::back_inserter(keys),
50 [](
const auto &value) { return value.first; });
54template<
class InputIt1,
class InputIt2>
56 InputIt2 first2, InputIt2 last2)
58 unsigned int count = 0;
60 while (first1 != last1 && first2 != last2) {
61 if (*first1 < *first2) {
64 if (!(*first2 < *first1))
73using clock = std::chrono::steady_clock;
74using duration = std::chrono::steady_clock::duration;
86std::basic_ostream<char, std::char_traits<char>> &
87operator<<(std::basic_ostream<
char, std::char_traits<char>> &stream,
const _hex &h);
91 std::enable_if_t<std::is_integral<T>::value> * =
nullptr>
92_hex
hex(T value,
unsigned int width = 0);
96inline _hex
hex<int8_t>(int8_t value,
unsigned int width)
98 return {
static_cast<uint64_t
>(value), width ? width : 2 };
102inline _hex hex<uint8_t>(uint8_t value,
unsigned int width)
104 return {
static_cast<uint64_t
>(value), width ? width : 2 };
108inline _hex hex<int16_t>(int16_t value,
unsigned int width)
110 return {
static_cast<uint64_t
>(value), width ? width : 4 };
116 return {
static_cast<uint64_t
>(value), width ? width : 4 };
120inline _hex
hex<int32_t>(int32_t value,
unsigned int width)
122 return {
static_cast<uint64_t
>(value), width ? width : 8 };
128 return {
static_cast<uint64_t
>(value), width ? width : 8 };
132inline _hex
hex<int64_t>(int64_t value,
unsigned int width)
134 return {
static_cast<uint64_t
>(value), width ? width : 16 };
140 return {
static_cast<uint64_t
>(value), width ? width : 16 };
144size_t strlcpy(
char *dst,
const char *src,
size_t size);
147template<
typename Container,
typename UnaryOp>
148std::string
join(
const Container &items,
const std::string &sep, UnaryOp op)
150 std::ostringstream ss;
153 for (
typename Container::const_iterator it = std::begin(items);
154 it != std::end(items); ++it) {
166template<
typename Container>
167std::string
join(
const Container &items,
const std::string &sep)
169 std::ostringstream ss;
172 for (
typename Container::const_iterator it = std::begin(items);
173 it != std::end(items); ++it) {
185template<
typename Container,
typename UnaryOp>
186std::string
join(
const Container &items,
const std::string &sep, UnaryOp op =
nullptr);
194 StringSplitter(
const std::string &str,
const std::string &delim);
199 using difference_type = std::size_t;
200 using value_type = std::string;
201 using pointer = value_type *;
202 using reference = value_type &;
203 using iterator_category = std::input_iterator_tag;
205 iterator(
const StringSplitter *ss, std::string::size_type pos);
207 iterator &operator++();
210 bool operator==(
const iterator &other)
const
212 return pos_ == other.pos_;
215 bool operator!=(
const iterator &other)
const
217 return !(*
this == other);
221 const StringSplitter *ss_;
222 std::string::size_type pos_;
223 std::string::size_type next_;
226 iterator begin()
const
233 return {
this, std::string::npos };
243details::StringSplitter
split(
const std::string &str,
const std::string &delim);
245std::string
toAscii(
const std::string &str);
250constexpr unsigned int alignDown(
unsigned int value,
unsigned int alignment)
252 return value / alignment * alignment;
255constexpr unsigned int alignUp(
unsigned int value,
unsigned int alignment)
257 return (value + alignment - 1) / alignment * alignment;
263struct reverse_adapter {
268auto begin(reverse_adapter<T> r)
270 return std::rbegin(r.iterable);
274auto end(reverse_adapter<T> r)
276 return std::rend(r.iterable);
282details::reverse_adapter<T>
reverse(T &&iterable)
289template<
typename Base>
290class enumerate_iterator
293 using base_reference =
typename std::iterator_traits<Base>::reference;
296 using difference_type =
typename std::iterator_traits<Base>::difference_type;
297 using value_type = std::pair<const std::size_t, base_reference>;
298 using pointer = value_type *;
299 using reference = value_type &;
300 using iterator_category = std::input_iterator_tag;
302 explicit enumerate_iterator(Base iter)
303 : current_(iter), pos_(0)
307 enumerate_iterator &operator++()
314 bool operator!=(
const enumerate_iterator &other)
const
316 return current_ != other.current_;
319 value_type operator*()
const
321 return { pos_, *current_ };
329template<
typename Base>
330class enumerate_adapter
333 using iterator = enumerate_iterator<Base>;
335 enumerate_adapter(Base begin, Base end)
336 : begin_(begin), end_(end)
340 iterator begin()
const
342 return iterator{ begin_ };
347 return iterator{ end_ };
358auto enumerate(T &iterable) -> details::enumerate_adapter<
decltype(iterable.begin())>
360 return { std::begin(iterable), std::end(iterable) };
364template<
typename T,
size_t N>
365auto enumerate(T (&iterable)[N]) -> details::enumerate_adapter<T *>
367 return { std::begin(iterable), std::end(iterable) };
371class Duration :
public std::chrono::duration<double, std::nano>
373 using BaseDuration = std::chrono::duration<double, std::nano>;
376 Duration() =
default;
378 template<
typename Rep>
384 template<
typename Rep,
typename Period>
385 constexpr Duration(
const std::chrono::duration<Rep, Period> &d)
390 template<
typename Period>
393 auto const c = std::chrono::duration_cast<std::chrono::duration<double, Period>>(*this);
397 explicit constexpr operator bool()
const
399 return *
this != BaseDuration::zero();
412double strtod(
const char *__restrict nptr,
char **__restrict endptr);
417 return static_cast<std::underlying_type_t<Enum>
>(e);
425 void operator+=(std::function<
void()> &&action);
429 std::vector<std::function<void()>> actions_;
437 template<
typename Fn,
438 std::enable_if_t<!std::is_same_v<std::remove_cv_t<std::remove_reference_t<Fn>>, scope_exit> &&
439 std::is_constructible_v<EF, Fn>> * =
nullptr>
440 explicit scope_exit(Fn &&fn)
441 : exitFunction_(std::forward<Fn>(fn))
443 static_assert(std::is_nothrow_constructible_v<EF, Fn>);
465scope_exit(EF) -> scope_exit<EF>;
472template<
class CharT,
class Traits>
473std::basic_ostream<CharT, Traits> &operator<<(std::basic_ostream<CharT, Traits> &os,
474 const utils::Duration &d);
Utilities to help constructing class interfaces.
#define LIBCAMERA_DISABLE_COPY_AND_MOVE(klass)
Disable copy and move construction and assignment of the klass.
Definition class.h:29
constexpr Duration(const Rep &r)
Construct a Duration with r ticks.
Definition utils.h:379
double get() const
Retrieve the tick count, converted to the timebase provided by the template argument Period of type s...
Definition utils.h:391
constexpr Duration(const std::chrono::duration< Rep, Period > &d)
Construct a Duration by converting an arbitrary std::chrono::duration.
Definition utils.h:385
An object that performs actions upon destruction.
Definition utils.h:421
void release()
Remove all exit actions.
Definition utils.cpp:646
void operator+=(std::function< void()> &&action)
Add an exit action.
Definition utils.cpp:634
Top-level libcamera namespace.
Definition backtrace.h:17
std::ostream & operator<<(std::ostream &out, const Point &p)
Insert a text representation of a Point into an output stream.
Definition geometry.cpp:91
Matrix< U, Rows, Cols > operator*(T d, const Matrix< U, Rows, Cols > &m)
Multiply the matrix by a scalar.
Definition matrix.h:133
unsigned int set_overlap(InputIt1 first1, InputIt1 last1, InputIt2 first2, InputIt2 last2)
Count the number of elements in the intersection of two ranges.
Definition utils.h:55
constexpr unsigned int alignUp(unsigned int value, unsigned int alignment)
Align value up to alignment.
Definition utils.h:255
std::chrono::steady_clock::duration duration
The libcamera duration related to libcamera::utils::clock.
Definition utils.h:74
const char * basename(const char *path)
Strip the directory prefix from the path.
Definition utils.cpp:37
details::StringSplitter split(const std::string &str, const std::string &delim)
Split a string based on a delimiter.
Definition utils.cpp:308
std::string time_point_to_string(const time_point &time)
Convert a time point to a string representation.
Definition utils.cpp:175
std::chrono::steady_clock::time_point time_point
The libcamera time point related to libcamera::utils::clock.
Definition utils.h:75
std::string join(const Container &items, const std::string &sep, UnaryOp op=nullptr)
Join elements of a container in a string with a separator.
_hex hex(T value, unsigned int width=0)
Write an hexadecimal value to an output string.
std::string libcameraSourcePath()
Retrieve the path to the source directory.
Definition source_paths.cpp:114
std::string toAscii(const std::string &str)
Remove any non-ASCII characters from a string.
Definition utils.cpp:322
constexpr unsigned int alignDown(unsigned int value, unsigned int alignment)
Align value down to alignment.
Definition utils.h:250
size_t strlcpy(char *dst, const char *src, size_t size)
Copy a string with a size limit.
Definition utils.cpp:240
char * secure_getenv(const char *name)
Get an environment variable.
Definition utils.cpp:61
std::chrono::steady_clock clock
The libcamera clock (monotonic)
Definition utils.h:73
details::reverse_adapter< T > reverse(T &&iterable)
Wrap an iterable to reverse iteration in a range-based loop.
Definition utils.h:282
decltype(auto) abs_diff(const T &a, const T &b)
Calculates the absolute value of the difference between two elements.
Definition utils.h:404
std::vector< typename T::key_type > map_keys(const T &map)
Retrieve the keys of a std::map<>
Definition utils.h:46
std::string libcameraBuildPath()
Retrieve the path to the build directory.
Definition source_paths.cpp:74
struct timespec duration_to_timespec(const duration &value)
Convert a duration to a timespec.
Definition utils.cpp:161
auto enumerate(T &iterable) -> details::enumerate_adapter< decltype(iterable.begin())>
Wrap an iterable to enumerate index and value in a range-based loop.
Definition utils.h:358
constexpr std::underlying_type_t< Enum > to_underlying(Enum e) noexcept
Convert an enumeration to its underlygin type.
Definition utils.h:415
std::string dirname(const std::string &path)
Identify the dirname portion of a path.
Definition utils.cpp:83