opnsense-src/lib/libutil++/libutil++.hh
John Baldwin b3127a2dc2 libutil++: New library containing C++ utility classes for use in base
- freebsd::FILE_up is a wrapper class for std::unique_ptr<> for FILE
  objects which uses a custom deleter that calls fclose().

- freebsd::malloc_up<T> is a wrapper class for std::unique_ptr<> which
  uses a custom deleter that calls free().  It is useful for pointers
  allocated by malloc() such as strdup().

- The freebsd::stringf() functions return a std::string constructed
  using a printf format string.

  The current implementation of freebsd::stringf() uses fwopen() where
  the write function appends to a std::string.

Sponsored by:	Chelsio Communications
Pull Request:	https://github.com/freebsd/freebsd-src/pull/1794
2025-08-04 15:38:06 -04:00

55 lines
1.2 KiB
C++

/*-
* SPDX-License-Identifier: BSD-2-Clause
*
* Copyright (c) 2025 Chelsio Communications, Inc.
* Written by: John Baldwin <jhb@FreeBSD.org>
*/
#ifndef __LIBUTILPP_HH__
#define __LIBUTILPP_HH__
#include <cstdarg>
#include <cstdio>
#include <cstdlib>
#include <memory>
namespace freebsd {
/*
* FILE_up is a std::unique_ptr<> for FILE objects which uses
* fclose() to destroy the wrapped pointer.
*/
struct fclose_deleter {
void operator() (std::FILE *fp) const
{
std::fclose(fp);
}
};
using FILE_up = std::unique_ptr<std::FILE, fclose_deleter>;
/*
* malloc_up<T> is a std::unique_ptr<> which uses free() to
* destroy the wrapped pointer. This can be used to wrap
* pointers allocated implicitly by malloc() such as those
* returned by strdup().
*/
template <class T>
struct free_deleter {
void operator() (T *p) const
{
std::free(p);
}
};
template <class T>
using malloc_up = std::unique_ptr<T, free_deleter<T>>;
/*
* Returns a std::string containing the same output as
* sprintf(). Throws std::bad_alloc if an error occurs.
*/
std::string stringf(const char *fmt, ...) __printflike(1, 2);
std::string stringf(const char *fmt, std::va_list ap);
}
#endif /* !__LIBUTILPP_HH__ */