#include <SFXBuffer.h.hpp>

class SFXBuffer;

SFMTYPEDEFCLASS(SFXBuffer)

[ public, explicit ]
SFXBuffer(Void);

[ public ]
SFXBuffer(
    SFXBufferConstRef buffer   // コピーするバッファ
);

[ public, explicit ]
SFXBuffer(
    VoidConstPtr buffer   // バッファとして使うメモリブロック
    UInt32 size           // メモリブロックのサイズ
);

[ public, explicit ]
SFXBuffer(
    Byte byte   // バッファとして使う1バイトの値
);

[ public, explicit ]
SFXBuffer(
    SFXAnsiStringConstRef string   // バッファとして使う文字列
);

[ public, explicit ]
SFXBuffer(
    SFXWideStringConstRef string   // バッファとして使う文字列
);

[ public, explicit ]
SFXBuffer(
    UInt16 threshold   // 内部バッファメモリの最小サイズ
    UInt16 cluster     // 内部バッファメモリのクラスタサイズ
);

[ public ]
~SFXBuffer(Void);

[ public ]
SFCError Add(
    SFXBufferConstRef buffer   // 追加するバッファ
);

[ public ]
SFCError Add(
    VoidConstPtr buffer   // 追加するメモリブロック
    UInt32 size           // メモリブロックのサイズ
);

[ public ]
SFCError Add(
    Byte byte   // バッファに追加する 1 バイトの値
);

[ public ]
SFCError Allocate(
    UInt32 size   // 割り当てるメモリサイズ
);

[ public ]
SFCError Attach(
    SFXBufferPtr buffer   // 別の SFXBuffer オブジェクト
);

[ public ]
SFCError Attach(
    VoidPtr buffer   // 使用するメモリブロック
    UInt32 size      // メモリブロックのサイズ
);

[ public ]
SFCError Attach(
    SFXAnsiStringPtr string   // SFXAnsiString オブジェクト
);

[ public ]
SFCError Attach(
    SFXWideStringPtr string   // SFXWideString オブジェクト
);

[ public ]
SFCError AttachSFXAnsiString(
    SFXAnsiStringPtr string   // SFXAnsiString オブジェクト
);

[ public ]
SFCError AttachSFXWideString(
    SFXWideStringPtr string   // SFXWideString オブジェクト
);

[ public, const ]
SInt32 Compare(
    SFXBufferConstRef buffer   // 比較するバッファ
);

[ public, const ]
SInt32 Compare(
    VoidConstPtr buffer   // 比較するメモリブロック
    UInt32 size           // メモリブロックのサイズ
);

[ public ]
SFCError Copy(
    UInt32 index               // 上書き開始位置
    SFXBufferConstRef buffer   // コピーするバッファ
);

[ public ]
SFCError Copy(
    UInt32 index          // 上書き開始位置
    VoidConstPtr buffer   // コピーするメモリブロック
    UInt32 size           // メモリブロックのサイズ
);

[ public ]
SFCError Detach(
    SFXBufferPtr buffer   // 別の SFXBuffer オブジェクト
);

[ public ]
VoidPtr Detach(
    UInt32Ptr size = null   // データのサイズ
);

[ public ]
SFCError Detach(
    SFXAnsiStringPtr string   // SFXAnsiString オブジェクト
);

[ public ]
SFCError Detach(
    SFXWideStringPtr string   // SFXWideString オブジェクト
);

[ public ]
SFCError DetachSFXAnsiString(
    SFXAnsiStringPtr string   // SFXAnsiString オブジェクト
);

[ public ]
SFCError DetachSFXWideString(
    SFXWideStringPtr string   // SFXWideString オブジェクト
);

[ public, static ]
SFXBufferConstRef EmptyInstance(Void);

[ public, const ]
Bool EndsWith(
    SFXBufferConstRef buffer   // 調べるバッファ
);

[ public, const ]
Bool EndsWith(
    VoidConstPtr buffer   // 調べるバッファ
    UInt32 size           // 調べるバッファのサイズ
);

[ public, const ]
Bool EndsWith(
    Byte byte   // 調べる 1 バイト
);

[ public, const ]
Bool Equals(
    SFXBufferConstRef buffer   // 比較するバッファ
);

[ public, const ]
Bool Equals(
    VoidConstPtr buffer   // 比較するメモリブロック
    UInt32 size           // メモリブロックのサイズ
);

[ public ]
Void Fill(
    Byte data   // データ
);

[ public, const ]
SInt32 FirstIndexOf(
    SFXBufferConstRef buffer        // 検索するバッファ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);

[ public, const ]
SInt32 FirstIndexOf(
    VoidConstPtr buffer             // 検索するバッファ
    UInt32 size                     // 検索するバッファのサイズ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);

[ public, const ]
SInt32 FirstIndexOf(
    Byte byte                       // 検索する Byte データ
    SInt32 index = SINT32_MINIMUM   // 検索開始位置
);

[ public ]
Void Free(Void);

[ public ]
VoidPtr GetBuffer(Void);

[ public, const ]
VoidConstPtr GetBuffer(Void);

[ public, const ]
Byte GetByte(
    UInt32 index   // 取得する位置
);

[ public, const ]
UInt16 GetCluster(Void);

[ public, const ]
UInt32 GetSize(Void);

[ public, const ]
UInt16 GetThreshold(Void);

[ public ]
SFCError Insert(
    UInt32 index               // 挿入する位置
    SFXBufferConstRef buffer   // 挿入するバッファ
);

[ public ]
SFCError Insert(
    UInt32 index          // 挿入する位置
    VoidConstPtr buffer   // 挿入するデータ
    UInt32 size           // データのサイズ
);

[ public ]
SFCError Insert(
    Byte byte   // バッファに挿入する 1 バイトの値
);

[ public, const ]
Bool IsEmpty(Void);

[ public, const ]
SInt32 LastIndexOf(
    SFXBufferConstRef buffer        // 検索するバッファ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);

[ public, const ]
SInt32 LastIndexOf(
    VoidConstPtr buffer             // 検索するバッファ
    UInt32 size                     // 検索するバッファのサイズ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);

[ public, const ]
SInt32 LastIndexOf(
    Byte byte                       // 検索する Byte データ
    SInt32 index = SINT32_MAXIMUM   // 検索開始位置
);

[ public ]
SFCError Mul(
    SInt32 repeat   // 繰り返す回数
);

[ public ]
Void Remove(
    UInt32 begin   // 開始位置
    UInt32 end     // 終了位置
);

[ public ]
SFCError Set(
    SFXBufferConstRef buffer   // コピーするバッファ
);

[ public ]
SFCError Set(
    VoidConstPtr buffer   // コピーするメモリブロック
    UInt32 size           // メモリブロックのサイズ
);

[ public ]
SFCError Set(
    Byte byte   // バッファとして使用する 1 バイトの値
);

[ public ]
SFCError Set(
    SFXAnsiStringConstRef string   // バッファとして使用する文字列
);

[ public ]
SFCError Set(
    SFXWideStringConstRef string   // バッファとして使用する文字列
);

[ public ]
SFCError SetByte(
    UInt32 index   // 設定する位置
    Byte data      // データ
);

[ public ]
Void SetCluster(
    UInt16 size   // 設定するクラスタサイズ
);

[ public ]
SFCError SetSize(
    UInt32 size   // 設定するサイズ
);

[ public ]
Void SetThreshold(
    UInt16 size   // 設定する最小値 [単位: バイト]
);

[ public ]
Void Slice(
    UInt32 begin   // 残す部分の先頭のインデックス
    UInt32 end     // 残す部分の終端のインデックス
);

[ public, const ]
Bool StartsWith(
    SFXBufferConstRef buffer   // 調べるバッファ
);

[ public, const ]
Bool StartsWith(
    VoidConstPtr buffer   // 調べるバッファ
    UInt32 size           // 調べるバッファのサイズ
);

[ public, const ]
Bool StartsWith(
    Byte byte   // 調べる 1 バイトの値
);

[ public ]
SFXBufferRef operator=(
    SFXBufferConstRef buffer   // 右側のバッファ
);

[ public, friend ]
Bool operator==(
    SFXBufferConstRef left    // 左側のバッファ
    SFXBufferConstRef right   // 右側のバッファ
);

[ public, friend ]
Bool operator>=(
    SFXBufferConstRef left    // 左側のバッファ
    SFXBufferConstRef right   // 右側のバッファ
);

[ public, friend ]
Bool operator>(
    SFXBufferConstRef left    // 左側のバッファ
    SFXBufferConstRef right   // 右側のバッファ
);

[ public ]
ByteRef operator[](
    UInt32 index   // インデックス位置
);

[ public, const ]
ByteConstRef operator[](
    UInt32 index   // インデックス位置
);

[ public, friend ]
SFXBufferRef operator<<(
    SFXBufferRef left         // 左側のバッファ
    SFXBufferConstRef right   // 右側のバッファ
);

[ public, friend ]
Bool operator<=(
    SFXBufferConstRef left    // 左側のバッファ
    SFXBufferConstRef right   // 右側のバッファ
);

[ public, friend ]
Bool operator<(
    SFXBufferConstRef left    // 左側のバッファ
    SFXBufferConstRef right   // 右側のバッファ
);

[ public ]
SFXBufferRef operator*=(
    SInt32 repeat   // 右側の回数
);

[ public, friend ]
SFXBuffer operator*(
    SFXBufferConstRef left   // 左側のバッファ
    SInt32 right             // 右側の回数
);

[ public, friend ]
Bool operator!=(
    SFXBufferConstRef left    // 左側のバッファ
    SFXBufferConstRef right   // 右側のバッファ
);

[ public ]
SFXBufferRef operator+=(
    SFXBufferConstRef buffer   // 右側のバッファ
);

[ public ]
SFXBufferRef operator+=(
    Byte byte   // 右側のバッファ（バイト値）
);

[ public, friend ]
SFXBuffer operator+(
    SFXBufferConstRef left    // 左側のバッファ
    SFXBufferConstRef right   // 右側のバッファ
);

[ public, friend ]
SFXBuffer operator+(
    SFXBufferConstRef left   // 左側のバッファ
    Byte right               // 右側のバッファ
);

enum DefaultEnum {
    DEFAULT_THRESHOLD = 16,     // 内部バッファメモリの最小値 [単位: バイト]
    DEFAULT_CLUSTER   = 8       // 内部バッファメモリのクラスタサイズ(メモリ確保の最小単位) [単位: バイト]
};