recognition::magic::magic_private Class Reference

Classes
struct	flags_converter
struct	libmagic_pair_converter

Public Types
enum	identify_file_options : unsigned long long {   check_nothing = 0ULL , check_is_valid = 1ULL << 0 , check_path_empty = 1ULL << 1 , check_path_exists = 1ULL << 2 ,   check_path = check_path_empty | check_path_exists , check_everything = check_is_valid | check_path }
using	identify_file_options_mask_t = std::bitset<3uz>

Public Member Functions
	magic_private () noexcept=default
	magic_private (flags_mask_t flags_mask, const std::filesystem::path &database_file)
	magic_private (flags_mask_t flags_mask, const std::nothrow_t &tag, const std::filesystem::path &database_file) noexcept
	magic_private (const flags_container_t &flags_container, const std::filesystem::path &database_file)
	magic_private (const flags_container_t &flags_container, const std::nothrow_t &tag, const std::filesystem::path &database_file) noexcept
	magic_private (magic_private &&) noexcept=default
	magic_private (const magic_private &)=delete
magic_private &	operator= (magic_private &&) noexcept=default
magic_private &	operator= (const magic_private &)=delete
	~magic_private ()=default
bool	check (const std::filesystem::path &database_file) const noexcept
bool	compile (const std::filesystem::path &database_file) const noexcept
flags_container_t	get_flags () const
std::optional< flags_container_t >	get_flags (const std::nothrow_t &tag) const noexcept
std::size_t	get_parameter (parameters parameter) const
std::optional< std::size_t >	get_parameter (parameters parameter, const std::nothrow_t &tag) const noexcept
parameter_value_map_t	get_parameters () const
std::optional< parameter_value_map_t >	get_parameters (const std::nothrow_t &tag) const noexcept
file_type_t	identify_file (const std::filesystem::path &path, identify_file_options_mask_t options) const
expected_file_type_t	identify_file (const std::filesystem::path &path, identify_file_options_mask_t options, const std::nothrow_t &tag) const noexcept
default_file_container_t	identify_directory_preliminary_checks (const std::filesystem::path &directory, std::filesystem::directory_options option, tracker_t tracker) const
std::optional< default_file_container_t >	identify_directory_preliminary_checks (const std::filesystem::path &directory, const std::nothrow_t &tag, std::filesystem::directory_options option, tracker_t tracker) const noexcept
void	identify_container_preliminary_checks (tracker_t tracker) const
bool	identify_container_preliminary_checks (const std::nothrow_t &tag, tracker_t tracker) const noexcept
types_of_files_t	identify_files (const default_file_container_t &files, identify_file_options_mask_t option, tracker_t tracker) const
expected_types_of_files_t	identify_files (const default_file_container_t &files, const std::nothrow_t &tag, identify_file_options_mask_t option, tracker_t tracker) const noexcept
bool	is_database_loaded () const noexcept
bool	is_open () const noexcept
bool	is_valid () const noexcept
void	load_database_file (const std::filesystem::path &database_file)
bool	load_database_file (const std::nothrow_t &tag, const std::filesystem::path &database_file) noexcept
void	open (flags_mask_t flags_mask)
bool	open (flags_mask_t flags_mask, const std::nothrow_t &tag) noexcept
void	open (const flags_container_t &flags_container)
bool	open (const flags_container_t &flags_container, const std::nothrow_t &tag) noexcept
void	set_flags (flags_mask_t flags_mask)
bool	set_flags (flags_mask_t flags_mask, const std::nothrow_t &tag) noexcept
void	set_flags (const flags_container_t &flags_container)
bool	set_flags (const flags_container_t &flags_container, const std::nothrow_t &tag) noexcept
void	set_parameter (parameters parameter, std::size_t value)
bool	set_parameter (parameters parameter, std::size_t value, const std::nothrow_t &tag) noexcept
void	set_parameters (const parameter_value_map_t &parameters)
bool	set_parameters (const parameter_value_map_t &parameters, const std::nothrow_t &tag) noexcept

Static Public Member Functions
template<std::derived_from< magic_exception > ExceptionType, typename ResultType , typename... ExceptionArgs> requires std::same_as<ResultType, int> || std::same_as<ResultType, bool>
static void	throw_exception_on_failure (ResultType result, ExceptionArgs &&... args)
	Throws an ExceptionType exception with ExceptionArgs if the result is false or equal to libmagic_error.

Private Types
using	cookie_t
using	libmagic_value_t = int
using	libmagic_value_name_t = std::string
using	libmagic_pair_t = std::pair<libmagic_value_t, const char*>
using	libmagic_flags_t = std::array<libmagic_pair_t, libmagic_flags_count>
using	libmagic_parameters_t

Private Member Functions
std::string	get_error_message () const noexcept

Private Attributes
cookie_t	m_cookie {nullptr}
flags_mask_t	m_flags_mask {0}
bool	m_is_database_loaded {false}

Static Private Attributes
static constexpr identify_file_options_mask_t	check_is_valid_option
static constexpr identify_file_options_mask_t	check_path_empty_option
static constexpr identify_file_options_mask_t	check_path_exists_option
static constexpr auto	libmagic_error = -1
static constexpr auto	libmagic_flags_count = flags_mask_t{}.size()
static constexpr auto	libmagic_parameter_count = 10uz
static constexpr libmagic_pair_t	libmagic_flag_none
static constexpr libmagic_flags_t	libmagic_flags
static constexpr libmagic_parameters_t	libmagic_parameters

Friends
std::string	to_string (magic::flags flag)
	Convert the magic::flags to string.
std::string	to_string (magic::parameters parameter)
	Convert the magic::parameters to string.

Member Typedef Documentation

cookie_t

using recognition::magic::magic_private::cookie_t

private

Initial value:

 std::unique_ptr<
        detail::magic_set,
        decltype([](detail::magic_t cookie) noexcept {
            detail::magic_close(cookie);
        })>

identify_file_options_mask_t

using recognition::magic::magic_private::identify_file_options_mask_t = std::bitset<3uz>

libmagic_flags_t

using recognition::magic::magic_private::libmagic_flags_t = std::array<libmagic_pair_t, libmagic_flags_count>

private

libmagic_pair_t

using recognition::magic::magic_private::libmagic_pair_t = std::pair<libmagic_value_t, const char*>

private

libmagic_parameters_t

using recognition::magic::magic_private::libmagic_parameters_t

private

Initial value:

 std::array<
        libmagic_pair_t,
        libmagic_parameter_count>

libmagic_value_name_t

using recognition::magic::magic_private::libmagic_value_name_t = std::string

private

libmagic_value_t

using recognition::magic::magic_private::libmagic_value_t = int

private

Member Enumeration Documentation

identify_file_options

enum recognition::magic::magic_private::identify_file_options : unsigned long long

Enumerator
check_nothing	0ULL
check_is_valid	1ULL << 0
check_path_empty	1ULL << 1
check_path_exists	1ULL << 2
check_path	check_path_empty | check_path_exists
check_everything	check_is_valid | check_path

Constructor & Destructor Documentation

magic_private() [1/7]

recognition::magic::magic_private::magic_private ( )

defaultnoexcept

magic_private() [2/7]

recognition::magic::magic_private::magic_private ( flags_mask_t flags_mask, const std::filesystem::path & database_file )

inline

magic_private() [3/7]

recognition::magic::magic_private::magic_private ( flags_mask_t flags_mask, const std::nothrow_t & tag, const std::filesystem::path & database_file )

inlinenoexcept

magic_private() [4/7]

recognition::magic::magic_private::magic_private ( const flags_container_t & flags_container, const std::filesystem::path & database_file )

inline

magic_private() [5/7]

recognition::magic::magic_private::magic_private ( const flags_container_t & flags_container, const std::nothrow_t & tag, const std::filesystem::path & database_file )

inlinenoexcept

magic_private() [6/7]

recognition::magic::magic_private::magic_private ( magic_private && )

defaultnoexcept

magic_private() [7/7]

recognition::magic::magic_private::magic_private ( const magic_private & )

delete

~magic_private()

recognition::magic::magic_private::~magic_private ( )

default

Member Function Documentation

check()

bool recognition::magic::magic_private::check ( const std::filesystem::path & database_file ) const

inlinenodiscardnoexcept

compile()

bool recognition::magic::magic_private::compile ( const std::filesystem::path & database_file ) const

inlinenodiscardnoexcept

get_error_message()

std::string recognition::magic::magic_private::get_error_message ( ) const

inlinenodiscardprivatenoexcept

get_flags() [1/2]

flags_container_t recognition::magic::magic_private::get_flags ( ) const

inlinenodiscard

get_flags() [2/2]

std::optional< flags_container_t > recognition::magic::magic_private::get_flags ( const std::nothrow_t & tag ) const

inlinenodiscardnoexcept

get_parameter() [1/2]

std::size_t recognition::magic::magic_private::get_parameter ( parameters parameter ) const

inlinenodiscard

get_parameter() [2/2]

std::optional< std::size_t > recognition::magic::magic_private::get_parameter ( parameters parameter, const std::nothrow_t & tag ) const

inlinenodiscardnoexcept

get_parameters() [1/2]

parameter_value_map_t recognition::magic::magic_private::get_parameters ( ) const

inlinenodiscard

get_parameters() [2/2]

std::optional< parameter_value_map_t > recognition::magic::magic_private::get_parameters ( const std::nothrow_t & tag ) const

inlinenodiscardnoexcept

identify_container_preliminary_checks() [1/2]

bool recognition::magic::magic_private::identify_container_preliminary_checks ( const std::nothrow_t & tag, tracker_t tracker ) const

inlinenoexcept

identify_container_preliminary_checks() [2/2]

void recognition::magic::magic_private::identify_container_preliminary_checks ( tracker_t tracker ) const

inline

identify_directory_preliminary_checks() [1/2]

std::optional< default_file_container_t > recognition::magic::magic_private::identify_directory_preliminary_checks ( const std::filesystem::path & directory, const std::nothrow_t & tag, std::filesystem::directory_options option, tracker_t tracker ) const

inlinenodiscardnoexcept

identify_directory_preliminary_checks() [2/2]

default_file_container_t recognition::magic::magic_private::identify_directory_preliminary_checks ( const std::filesystem::path & directory, std::filesystem::directory_options option, tracker_t tracker ) const

inlinenodiscard

identify_file() [1/2]

file_type_t recognition::magic::magic_private::identify_file ( const std::filesystem::path & path, identify_file_options_mask_t options ) const

inlinenodiscard

identify_file() [2/2]

expected_file_type_t recognition::magic::magic_private::identify_file ( const std::filesystem::path & path, identify_file_options_mask_t options, const std::nothrow_t & tag ) const

inlinenodiscardnoexcept

identify_files() [1/2]

expected_types_of_files_t recognition::magic::magic_private::identify_files ( const default_file_container_t & files, const std::nothrow_t & tag, identify_file_options_mask_t option, tracker_t tracker ) const

inlinenodiscardnoexcept

identify_files() [2/2]

types_of_files_t recognition::magic::magic_private::identify_files ( const default_file_container_t & files, identify_file_options_mask_t option, tracker_t tracker ) const

inlinenodiscard

is_database_loaded()

bool recognition::magic::magic_private::is_database_loaded ( ) const

inlinenodiscardnoexcept

is_open()

bool recognition::magic::magic_private::is_open ( ) const

inlinenodiscardnoexcept

is_valid()

bool recognition::magic::magic_private::is_valid ( ) const

inlinenodiscardnoexcept

load_database_file() [1/2]

void recognition::magic::magic_private::load_database_file ( const std::filesystem::path & database_file )

inline

load_database_file() [2/2]

bool recognition::magic::magic_private::load_database_file ( const std::nothrow_t & tag, const std::filesystem::path & database_file )

inlinenodiscardnoexcept

open() [1/4]

void recognition::magic::magic_private::open ( const flags_container_t & flags_container )

inline

open() [2/4]

bool recognition::magic::magic_private::open ( const flags_container_t & flags_container, const std::nothrow_t & tag )

inlinenodiscardnoexcept

open() [3/4]

void recognition::magic::magic_private::open ( flags_mask_t flags_mask )

inline

open() [4/4]

bool recognition::magic::magic_private::open ( flags_mask_t flags_mask, const std::nothrow_t & tag )

inlinenodiscardnoexcept

operator=() [1/2]

magic_private & recognition::magic::magic_private::operator= ( const magic_private & )

delete

operator=() [2/2]

magic_private & recognition::magic::magic_private::operator= ( magic_private && )

defaultnoexcept

set_flags() [1/4]

void recognition::magic::magic_private::set_flags ( const flags_container_t & flags_container )

inline

set_flags() [2/4]

bool recognition::magic::magic_private::set_flags ( const flags_container_t & flags_container, const std::nothrow_t & tag )

inlinenodiscardnoexcept

set_flags() [3/4]

void recognition::magic::magic_private::set_flags ( flags_mask_t flags_mask )

inline

set_flags() [4/4]

bool recognition::magic::magic_private::set_flags ( flags_mask_t flags_mask, const std::nothrow_t & tag )

inlinenodiscardnoexcept

set_parameter() [1/2]

void recognition::magic::magic_private::set_parameter ( parameters parameter, std::size_t value )

inline

set_parameter() [2/2]

bool recognition::magic::magic_private::set_parameter ( parameters parameter, std::size_t value, const std::nothrow_t & tag )

inlinenodiscardnoexcept

set_parameters() [1/2]

void recognition::magic::magic_private::set_parameters ( const parameter_value_map_t & parameters )

inline

set_parameters() [2/2]

bool recognition::magic::magic_private::set_parameters ( const parameter_value_map_t & parameters, const std::nothrow_t & tag )

inlinenodiscardnoexcept

throw_exception_on_failure()

template<std::derived_from< magic_exception > ExceptionType, typename ResultType , typename... ExceptionArgs>
requires std::same_as<ResultType, int> || std::same_as<ResultType, bool>

static void recognition::magic::magic_private::throw_exception_on_failure ( ResultType result, ExceptionArgs &&... args )

inlinestatic

Throws an ExceptionType exception with ExceptionArgs if the result is false or equal to libmagic_error.

Friends And Related Symbol Documentation

to_string [1/2]

std::string to_string ( magic::flags flag )

friend

Convert the magic::flags to string.

Parameters

[in]

flag

The flag.

Returns

The flag as a string.

to_string [2/2]

std::string to_string ( magic::parameters parameter )

friend

Convert the magic::parameters to string.

Parameters

[in]

parameter

The parameter.

Returns

The parameter as a string.

Member Data Documentation

check_is_valid_option

identify_file_options_mask_t recognition::magic::magic_private::check_is_valid_option

staticconstexprprivate

Initial value:

{
        identify_file_options::check_is_valid
    }

check_path_empty_option

identify_file_options_mask_t recognition::magic::magic_private::check_path_empty_option

staticconstexprprivate

Initial value:

{
        identify_file_options::check_path_empty
    }

check_path_exists_option

identify_file_options_mask_t recognition::magic::magic_private::check_path_exists_option

staticconstexprprivate

Initial value:

{
        identify_file_options::check_path_exists
    }

libmagic_error

auto recognition::magic::magic_private::libmagic_error = -1

staticconstexprprivate

libmagic_flag_none

libmagic_pair_t recognition::magic::magic_private::libmagic_flag_none

staticconstexprprivate

Initial value:

{
        std::make_pair(MAGIC_NONE, "none")
    }

libmagic_flags

libmagic_flags_t recognition::magic::magic_private::libmagic_flags

staticconstexprprivate

libmagic_flags_count

auto recognition::magic::magic_private::libmagic_flags_count = flags_mask_t{}.size()

staticconstexprprivate

libmagic_parameter_count

auto recognition::magic::magic_private::libmagic_parameter_count = 10uz

staticconstexprprivate

libmagic_parameters

libmagic_parameters_t recognition::magic::magic_private::libmagic_parameters

staticconstexprprivate

Initial value:

{
        std::make_pair(MAGIC_PARAM_INDIR_MAX, "indir_max"),
        std::make_pair(MAGIC_PARAM_NAME_MAX, "name_max"),
        std::make_pair(MAGIC_PARAM_ELF_PHNUM_MAX, "elf_phnum_max"),
        std::make_pair(MAGIC_PARAM_ELF_SHNUM_MAX, "elf_shnum_max"),
        std::make_pair(MAGIC_PARAM_ELF_NOTES_MAX, "elf_notes_max"),
        std::make_pair(MAGIC_PARAM_REGEX_MAX, "regex_max"),
        std::make_pair(MAGIC_PARAM_BYTES_MAX, "bytes_max"),
        std::make_pair(MAGIC_PARAM_ENCODING_MAX, "encoding_max"),
        std::make_pair(MAGIC_PARAM_ELF_SHSIZE_MAX, "elf_shsize_max"),
        std::make_pair(MAGIC_PARAM_MAGWARN_MAX, "mag_warn_max")
    }

m_cookie

cookie_t recognition::magic::magic_private::m_cookie {nullptr}

private

m_flags_mask

flags_mask_t recognition::magic::magic_private::m_flags_mask {0}

private

m_is_database_loaded

bool recognition::magic::magic_private::m_is_database_loaded {false}

private

---

The documentation for this class was generated from the following file:

• magic.cpp