F:/My Projects/LSEngine/Modules/LSCompressionLib/Src/LZW/LSCLzwEncodingDict.h

#ifndef __LSC_LZWENCODINGDICT_H__
#define __LSC_LZWENCODINGDICT_H__

#include "../LSCCompressionLib.h"
#include "Allocator/LSTLAllocator.h"

namespace lsc {

        class CLzwEncodingDict {
        public :
                // == Various constructors.
                LSE_CALLCTOR                                                    CLzwEncodingDict();
                LSE_CALLCTOR                                                    ~CLzwEncodingDict();


                // == Enumerations.
                enum LSN_LZW_INVALID_CODE {
                        LSN_LZW_INVALID_CODE                            = ~0UL,
                        LSN_LZW_FORCE_DWORD                                     = 0x7FFFFFFFUL,
                };


                // == Types.
                typedef struct LSN_LZW_DICT_ENTRY {
                        LSUINT32                                                        ui32Code;
                        
                        LSUINT32                                                        ui32BaseCode;
                        
                        LSUINT8                                                         ui8Char;
                } * LPLSN_LZW_DICT_ENTRY, * const LPCLSN_LZW_DICT_ENTRY;


                // == Functions.
                LSVOID  LSE_CALL                                                Reset();

                LSVOID LSE_CALL                                                 SetAllocator( CStdAllocator * _psaAllocator );
                
                LSBOOL LSE_CALL                                                 InitDict( LSUINT32 _ui32RootCodes, LSUINT32 _ui32MaxBits );
                
                LSUINT32 LSE_CALL                                               GetEntryIndex( LSUINT32 _ui32Code, LSUINT32 _ui32Char ) const;

                const LSN_LZW_DICT_ENTRY & LSE_CALL             GetEntry( LSUINT32 _ui32Index ) const;
                
                LSVOID LSE_CALL                                                 AddEntry( LSUINT32 _ui32Index, LSUINT32 _ui32BaseCode, LSUINT32 _ui32Char );

                LSUINT32 LSE_CALL                                               TotalEntries() const;

                LSUINT32 LSE_CALL                                               GetMaxDictionarySize() const;

                LSUINT32 LSE_CALL                                               GetStartingBits() const;

                LSUINT32 LSE_CALL                                               GetResetCode() const;

                LSUINT32 LSE_CALL                                               GetEndStreamCode() const;

                LSUINT32 LSE_CALL                                               GetBits() const;


        protected :
                // == Members.
                CAllocator                                                              m_caAllocator;
                
                LSUINT32                                                                m_ui32AllocatedDictSize;

                LSUINT32                                                                m_ui32MaxBits;
                
                LSUINT32                                                                m_ui32DictSize;

                LSUINT16                                                                m_ui16MinBits;

                LSUINT16                                                                m_ui16StartingBits;

                LSUINT32                                                                m_ui32RootCodes;

                LPLSN_LZW_DICT_ENTRY                                    m_lpldeDictionary;
                
        };

}       // namespace lsc

#endif  // __LSC_LZWENCODINGDICT_H__