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

#ifndef __LSC_LZWDECODINGDICT_H__
#define __LSC_LZWDECODINGDICT_H__

#include "../LSCCompressionLib.h"
#include "String/LSTLString.h"

namespace lsc {

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


                // == Types.
                typedef LSUINT32                                                LSN_LZW_CODE;

                typedef struct LSN_LZW_DICT_ENTRY {
                        // The code on which this is based.
                        LSUINT32                                                        ui32BaseCode    : 24;
                        
                        // The character appended to the base code which creates this entry.
                        LSUINT32                                                        ui8Char                 : 8;
                } * LPLSN_LZW_DICT_ENTRY, * const LPCLSN_LZW_DICT_ENTRY;


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

                LSVOID LSE_CALL                                                 SetAllocator( CStdAllocator * _psaAllocator );

                LSVOID LSE_CALL                                                 InitializeDictionary( LSUINT32 _ui32Len, LSUINT32 _ui32MaxBits );

                LSBOOL LSE_CALL                                                 IsClearCode( LSN_LZW_CODE _lcCode ) const;
                
                LSBOOL LSE_CALL                                                 IsEndOfInputCode( LSN_LZW_CODE _lcCode ) const;

                LSUINT32 LSE_CALL                                               GetTotal() const;

                LSBOOL LSE_CALL                                                 AddCode( LSN_LZW_CODE _lcCode, LSUINT8 _ui8Char );

                LSBOOL LSE_CALL                                                 GetString( LSN_LZW_CODE _lcCode, CString &_sString ) const;

                LSE_INLINE LSUINT32 LSE_CALL                    GetBitsNeeded() const;


        protected :
                // == Members.
                CAllocator                                                              m_aAllocator;

                LPLSN_LZW_DICT_ENTRY                                    m_lpldeDictionary;

                LSUINT32                                                                m_ui32Total,
                                                                                                m_ui32Alloc;

                LSUINT32                                                                m_ui32RootLen;

                LSUINT32                                                                m_ui32MaxSize;

                LSUINT32                                                                m_ui32MaxBits;

                LSUINT32                                                                m_ui32BitsNeeded;


                // == Functions.
                LSBOOL LSE_CALL                                                 Alloc();

                LSUINT32 LSE_CALL                                               DeriveBitsNeeded() const;
        };


        // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
        // DEFINITIONS
        // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
        // == Functions.
        LSE_INLINE LSUINT32 LSE_CALL CLzwDecodingDict::GetBitsNeeded() const {
                return m_ui32BitsNeeded;
        }

}       // namespace lsc

#endif  // __LSC_LZWDECODINGDICT_H__