Description:

This header-file is part of the ALib C++ Framework.

#include "alib/alib.inl"

Macros
#define	ALIB_FILES_FORCE_STD_SCANNER 0
#define	ALIB_FILES_SCANNER_IMPL ALIB_FILES_SCANNER_POSIX
#define	ALIB_FILES_SCANNER_POSIX 2
#define	ALIB_FILES_SCANNER_STDFS 1

Macro Definition Documentation

◆ ALIB_FILES_FORCE_STD_SCANNER

#define ALIB_FILES_FORCE_STD_SCANNER 0

If given, platform-specific code for scanning files is ignored and instead overloaded function ScanFiles uses an implementation based on C++ library std::filesystem. This flag was is used by the developers of ALib to test the standard implementation and should not be set otherwise, because platform-specific implementations are more feature reach and better performing.

Definition at line 22 of file files.prepro.hpp.

◆ ALIB_FILES_SCANNER_IMPL

#define ALIB_FILES_SCANNER_IMPL ALIB_FILES_SCANNER_POSIX

This configuration macro is evaluated internally with the inclusion of ALib.Files.H. It allows determining the implementation of the file scanner used. As of today, the following values are possible:

The configuration macro must not be set from outside. To manipulate the choice, use configuration macro ALIB_FILES_FORCE_STD_SCANNER instead.

Definition at line 37 of file files.prepro.hpp.

◆ ALIB_FILES_SCANNER_POSIX

#define ALIB_FILES_SCANNER_POSIX 2

A possible value of ALIB_FILES_SCANNER_IMPL, evaluating to 2, and denoting the implementation using the Posix library calls.
Must not be set from outside.

This group of code selection macros is defined with the use of module ALox and used to select the inclusion of log code. The macros are seldom to be used by end-user code. Instead, the macros used for the log statements themselves (see debug logging macros and release logging macros.) are variably defined based on these macros.

Definition at line 30 of file files.prepro.hpp.

◆ ALIB_FILES_SCANNER_STDFS

#define ALIB_FILES_SCANNER_STDFS 1

A possible value of ALIB_FILES_SCANNER_IMPL, evaluating to 1, and denoting the implementation using C++ library std::filesystem.
Must not be set from outside.