F:/My Projects/LSEngine/Modules/LSImageLib/Src/LZW/LSILzwDictionary.h

#ifndef __LSI_LZWDICTIONARY_H__
#define __LSI_LZWDICTIONARY_H__

#include "../LSIImageLib.h"
#include "Vector/LSTLVectorPoD.h"

namespace lsi {

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

                
                // == Types.
                typedef LSUINT16                                        LSI_LZW_CODE;

                typedef struct LSI_LZW_DICT_ENTRY_DECOMPRESS {
                        LSUINT32                                                lcBaseCode      : 12;

                        LSUINT32                                                ui8Char         : 8;
                } * LPLSI_LZW_DICT_ENTRY_DECOMPRESS, * const LPCLSI_LZW_DICT_ENTRY_DECOMPRESS;


                // == Functions.
                LSVOID LSE_CALL                                         SetAllocator( CAllocator * _paAllocator );
                
                LSBOOL LSE_CALL                                         InitializeDictionary( LSUINT32 _ui32Len, LSUINT32 _ui32MaxBits );
                
                LSBOOL LSE_CALL                                         IsClearCode( LSI_LZW_CODE _lcCode ) const;
                
                LSBOOL LSE_CALL                                         IsEndOfInputCode( LSI_LZW_CODE _lcCode ) const;
                
                LSUINT32 LSE_CALL                                       GetTotal() const;

                LSUINT32 LSE_CALL                                       GetEntryIndex( LSI_LZW_CODE _lcCode ) const;

                LSE_INLINE LSUINT32 LSE_CALL            GetBitsNeeded() const;

                LSVOID LSE_CALL                                         AddCode( LSI_LZW_CODE _lcCode, LSUINT8 _ui8Char );

                LSUINT32 LSE_CALL                                       GetString( LSI_LZW_CODE _lcCode, LSUINT8 * _pui8String ) const;
                
                static LSUINT32 LSE_CALL                        GetBits( const LSUINT8 * _pui8Stream, LSUINT64 &_ui64BitIndex, LSUINT32 _ui32Total );

        protected :
                // == Members.
                CVectorPoD<LSI_LZW_DICT_ENTRY_DECOMPRESS, LSUINT32>
                                                                                        m_vDecompDictionary;
                
                LSUINT32                                                        m_ui32MaxSize;
                
                LSUINT32                                                        m_ui32MaxBits;
                
                LSUINT32                                                        m_ui32ClearCode;
                
                LSUINT32                                                        m_ui32EndOfInput;

                LSUINT32                                                        m_ui32BitsNeeded;
                
                
                // == Functions.
                LSBOOL LSE_CALL                                         Alloc( LSUINT32 _ui32Total );
                
                LSVOID LSE_CALL                                         Reset();

                LSUINT32 LSE_CALL                                       DeriveBitsNeeded() const;
        };


        // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
        // DEFINITIONS
        // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
        // == Functions.
        LSE_INLINE LSUINT32 LSE_CALL CLzwDictionary::GetBitsNeeded() const {
                return CStd::Min<LSUINT32>( m_ui32BitsNeeded, m_ui32MaxBits );
        }

}       // namespace lsi

#endif  // __LSI_LZWDICTIONARY_H__