ntr::fmt::BMG Struct Reference

Inheritance diagram for ntr::fmt::BMG:

Classes
struct	DataSection
struct	Header
struct	InfoSection
struct	Message
struct	MessageEscape
struct	MessageIdSection
struct	MessageToken

Public Types
enum class	Encoding : u8 { CP1252 = 1 , UTF16 = 2 , ShiftJIS = 3 , UTF8 = 4 }
enum class	MessageTokenType : u8 { Text , Escape }

Public Member Functions
	BMG (const BMG &)=delete
bool	HasMessageIds ()
Result	CreateFrom (const Encoding enc, const bool has_message_ids, const size_t attr_size, const std::vector< Message > &msgs, const u32 file_id, const ntr::fs::FileCompression comp=ntr::fs::FileCompression::None)
Result	ValidateImpl (const std::string &path, std::shared_ptr< fs::FileHandle > file_handle, const fs::FileCompression comp) override
Result	ReadImpl (const std::string &path, std::shared_ptr< fs::FileHandle > file_handle, const fs::FileCompression comp) override
Result	WriteImpl (const std::string &path, std::shared_ptr< fs::FileHandle > file_handle, const fs::FileCompression comp) override
Public Member Functions inherited from ntr::fs::FileFormat
Result	Validate (const std::string &path, std::shared_ptr< fs::FileHandle > file_handle, const fs::FileCompression comp=fs::FileCompression::None)
Result	ReadFrom (const std::string &path, std::shared_ptr< fs::FileHandle > file_handle, const fs::FileCompression comp=fs::FileCompression::None)
Result	ReadCompressedFrom (const std::string &path, std::shared_ptr< fs::FileHandle > file_handle)
Result	WriteTo (const std::string &path, std::shared_ptr< fs::FileHandle > file_handle)
Result	WriteTo (std::shared_ptr< fs::FileHandle > file_handle)

Static Public Member Functions
static constexpr size_t	GetCharacterSize (const Encoding enc)
static constexpr bool	IsValidEncoding (const Encoding enc)

Public Attributes
Header	header
InfoSection	info
DataSection	data
std::optional< MessageIdSection >	msg_id
std::vector< Message >	messages
Public Attributes inherited from ntr::fs::FileFormat
std::string	read_path
std::shared_ptr< fs::FileHandle >	read_file_handle
std::string	write_path
std::shared_ptr< fs::FileHandle >	write_file_handle
fs::FileCompression	comp

Member Function Documentation

ReadImpl()

Result ntr::fmt::BMG::ReadImpl ( const std::string & path, std::shared_ptr< fs::FileHandle > file_handle, const fs::FileCompression comp )

overridevirtual

Implements ntr::fs::FileFormat.

ValidateImpl()

Result ntr::fmt::BMG::ValidateImpl ( const std::string & path, std::shared_ptr< fs::FileHandle > file_handle, const fs::FileCompression comp )

overridevirtual

Implements ntr::fs::FileFormat.

WriteImpl()

Result ntr::fmt::BMG::WriteImpl ( const std::string & path, std::shared_ptr< fs::FileHandle > file_handle, const fs::FileCompression comp )

overridevirtual

Implements ntr::fs::FileFormat.

---

The documentation for this struct was generated from the following files:

• libnedit/include/ntr/fmt/fmt_BMG.hpp
• libnedit/source/ntr/fmt/fmt_BMG.cpp