BmnFileProcessingFlags.h File Reference

#include "BmnEnums.h"
#include <cstdint>

Include dependency graph for BmnFileProcessingFlags.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	BmnFileProcessingFlags_h

Enumerations
enum class	BmnFileType : uint8_t {   Unknown , Raw , ZStd , ZLib ,   ZLib_ng , XZ_LZMA }
enum class	BmnFileStreamResults : uint8_t {   Success , ReachedEOF , InvalidParameters , TryingToReadBadStream ,   FileNotOpen , UnexpectedFail }
enum class	BmnBinaryFileProcessingOptions : uint32_t {   None = 0 , WriteBinary = 1 << 0 , ReadBinary = 1 << 1 , LeaveOldData = 1 << 2 ,   StartFromNull = 1 << 3 , StartFromEnd = 1 << 4 , AlwaysWriteAtTheEnd = 1 << 5 , MaximalCompression = 1 << 6 ,   HighCompression = 1 << 7 , NormalCompression = 1 << 7 , DefaultCompression = 1 << 9 , LowCompression = 1 << 10 ,   MinimalCompression = 1 << 11 , HighCompressionMemory = 1 << 12 , IntermediateCompressionMemory = 1 << 13 , DefaultCompressionMemory = 1 << 14 }

Functions
template<typename T>
T &	operator+= (T &initialString, const BmnFileType fileType)
template<typename T>
T	operator+ (const T &initialString, const BmnFileType fileType)
	MAKE_ENUM_BITMASK (BmnBinaryFileProcessingOptions)

Variables
constexpr BmnBinaryFileProcessingOptions	cg_writeFileFlags
constexpr BmnBinaryFileProcessingOptions	cg_compressionIntensityFlags
constexpr BmnBinaryFileProcessingOptions	cg_compressionMemoryFlags

Macro Definition Documentation

BmnFileProcessingFlags_h

#define BmnFileProcessingFlags_h

Definition at line 3 of file BmnFileProcessingFlags.h.

Enumeration Type Documentation

BmnBinaryFileProcessingOptions

enum class BmnBinaryFileProcessingOptions : uint32_t

strong

Enumerator
None	0
WriteBinary	1 << 0
ReadBinary	1 << 1
LeaveOldData	1 << 2
StartFromNull	1 << 3
StartFromEnd	1 << 4
AlwaysWriteAtTheEnd	1 << 5
MaximalCompression	1 << 6
HighCompression	1 << 7
NormalCompression	1 << 7
DefaultCompression	1 << 9
LowCompression	1 << 10
MinimalCompression	1 << 11
HighCompressionMemory	1 << 12
IntermediateCompressionMemory	1 << 13
DefaultCompressionMemory	1 << 14

Definition at line 94 of file BmnFileProcessingFlags.h.

BmnFileStreamResults

enum class BmnFileStreamResults : uint8_t

strong

Enumerator
Success
ReachedEOF
InvalidParameters
TryingToReadBadStream
FileNotOpen
UnexpectedFail

Definition at line 69 of file BmnFileProcessingFlags.h.

BmnFileType

enum class BmnFileType : uint8_t

strong

Enumerator
Unknown
Raw
ZStd
ZLib
ZLib_ng
XZ_LZMA

Definition at line 15 of file BmnFileProcessingFlags.h.

Function Documentation

MAKE_ENUM_BITMASK()

MAKE_ENUM_BITMASK

(

BmnBinaryFileProcessingOptions

)

operator+()

template<typename T>

T operator+ ( const T & initialString, const BmnFileType fileType )

inlinenodiscard

Definition at line 62 of file BmnFileProcessingFlags.h.

operator+=()

template<typename T>

T & operator+= ( T & initialString, const BmnFileType fileType )

inline

Definition at line 33 of file BmnFileProcessingFlags.h.

References Raw, Unknown, XZ_LZMA, ZLib, ZLib_ng, and ZStd.

Variable Documentation

cg_compressionIntensityFlags

BmnBinaryFileProcessingOptions cg_compressionIntensityFlags

constexpr

Initial value:

                                                                  =
BmnBinaryFileProcessingOptions::MaximalCompression | BmnBinaryFileProcessingOptions::HighCompression
| BmnBinaryFileProcessingOptions::NormalCompression | BmnBinaryFileProcessingOptions::DefaultCompression
| BmnBinaryFileProcessingOptions::LowCompression | BmnBinaryFileProcessingOptions::MinimalCompression

Definition at line 153 of file BmnFileProcessingFlags.h.

Referenced by BmnIFileReader::PerformStandardChecksBeforeOpening().

cg_compressionMemoryFlags

BmnBinaryFileProcessingOptions cg_compressionMemoryFlags

constexpr

Initial value:

                                                               =
BmnBinaryFileProcessingOptions::HighCompressionMemory
| BmnBinaryFileProcessingOptions::IntermediateCompressionMemory
| BmnBinaryFileProcessingOptions::DefaultCompressionMemory

Definition at line 158 of file BmnFileProcessingFlags.h.

Referenced by BmnIFileReader::PerformStandardChecksBeforeOpening().

cg_writeFileFlags

BmnBinaryFileProcessingOptions cg_writeFileFlags

constexpr

Initial value:

                                                       =
BmnBinaryFileProcessingOptions::WriteBinary | BmnBinaryFileProcessingOptions::LeaveOldData
| BmnBinaryFileProcessingOptions::StartFromNull | BmnBinaryFileProcessingOptions::StartFromEnd
| BmnBinaryFileProcessingOptions::AlwaysWriteAtTheEnd

Definition at line 148 of file BmnFileProcessingFlags.h.

Referenced by BmnIFileReader::PerformStandardChecksBeforeOpening().