//-----------------------------------------------------------------------------
//  (c) 2006 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  Alexander Happe
//  $Header$
//
//  License: This file is published under the license of the EMVA GenICam  Standard Group.
//  A text file describing the legal terms is included in  your installation as 'GenICam_license.pdf'.
//  If for some reason you are missing  this file please contact the EMVA or visit the website
//  (http://www.genicam.org) for a full copy.
//
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD  GROUP
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL,
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT  LIMITED TO,
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  DATA, OR PROFITS;
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE)
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
/*!
\file
\brief    Definition of the RegisterT class template
\ingroup GenApi_Implementation
*/

#ifndef GENAPI_REGISTERT_H
#define GENAPI_REGISTERT_H

#include "../IRegister.h"
#include "GenApi/Log.h"
#include "Exception.h"
#include "GenApi/Compatibility.h"

#ifndef _WIN32
#  define _snprintf snprintf
#endif

namespace GenApi
{

#   pragma warning ( push )
#   pragma warning ( disable : 4996 ) // depcretaced function
    /**
        \brief Implementation of the IRegister interface
    */
    template <class Base>
    class GENAPI_DECL RegisterT
        : public Base
    {
    public:

        //! Implementation of IRegister::Set()
        virtual void Set(const uint8_t *pBuffer, int64_t Length, bool Verify = true)
        {
            // a list of callbacks to fire held outside(!) the autolock on the stack(!)
            std::list<CNodeCallback*> CallbacksToFire;
            {
                AutoLock l(Base::GetLock());
                typename Base::EntryMethodFinalizer E( this, meSet );

                if( Base::m_pValueLog && Base::m_pValueLog->isInfoEnabled() )
                {
                    {
                        static const char fmt[] =
                            "Set( %" FMT_I64 "d, 0x";
                        static const int BufferLen(256);
                        char _pBuffer[256];

                        int BufferLeft(_snprintf(_pBuffer, BufferLen, fmt, Length));

                        /* MANTIS 0000062 */
                        for(int i = 0; i < Length; i++)
                        {
                            const int n =_snprintf(_pBuffer + BufferLeft,
                                                   BufferLen - BufferLeft,
                                                   "%02X", (unsigned int) pBuffer[i]);
#pragma BullseyeCoverage off
                            #ifdef _MSC_VER
                            if (n < 0)
                            #else
                            if (BufferLeft + n >= BufferLen)
                            #endif
                                break;
#pragma BullseyeCoverage on
                            BufferLeft += n;
                        }

                        GCLOG_INFO_PUSH(Base::m_pValueLog)("%s )...", _pBuffer);
                    }
                }

                if( Verify && !IsWritable( this ) )
                    throw  ACCESS_EXCEPTION_NODE("Node is not writable");

                {
                    typename Base::PostSetValueFinalizer PostSetValueCaller(this, CallbacksToFire);  // dtor calls Base::PostSetValue

                    Base::PreSetValue(); // invalidates all nodes if this is the first call in a chain of SetValue like calls
                    Base::InternalSet(pBuffer, Length);

                    if( Verify )
                        Base::InternalCheckError();
                }

                GCLOG_INFO_POP(Base::m_pValueLog)("...Set" );

                // fire callbacks inside the lock
                std::list<CNodeCallback*>::iterator ptrCallback;
                for( ptrCallback = CallbacksToFire.begin(); ptrCallback != CallbacksToFire.end(); ptrCallback++ )
                {
                    (*ptrCallback)->operator ()(cbPostInsideLock);
                }
            }

            // fire callbacks outside the lock
            std::list<CNodeCallback*>::iterator ptrCallback;
            for( ptrCallback = CallbacksToFire.begin(); ptrCallback != CallbacksToFire.end(); ptrCallback++ )
            {
                (*ptrCallback)->operator ()(cbPostOutsideLock);
            }
        }


        //! Implementation of IRegister::Get()
        virtual void Get(uint8_t *pBuffer, int64_t Length, bool Verify = false, bool IgnoreCache = false)
        {
            AutoLock l(Base::GetLock());
            typename Base::EntryMethodFinalizer E( this, meGet, IgnoreCache );

            GCLOG_INFO_PUSH(Base::m_pValueLog)("Get...");

            // Note that readability is tested regardless of Verify
            if( !IsReadable( this ) )
                throw ACCESS_EXCEPTION_NODE("Node is not readable");

            Base::InternalGet(pBuffer, Length, Verify, IgnoreCache );

            if( Verify )
                Base::InternalCheckError();

            if( Base::m_pValueLog && Base::m_pValueLog->isInfoEnabled() )
            {
                static const char fmt[] =
                    "...Get( %" FMT_I64 "d ) = 0x";

                static const int BufferLen(256);
                char _pBuffer[256];
                int BufferLeft(_snprintf(_pBuffer, BufferLen, fmt, Length));

                /* MANTIS 0000062 */
                for(int i = 0; i < Length; i++)
                {
                    const int n = _snprintf(_pBuffer + BufferLeft,
                                            BufferLen - BufferLeft,
                                            "%02X", (unsigned int) pBuffer[i]);
#pragma BullseyeCoverage off
                    #ifdef _MSC_VER
                        if (n < 0)
                            break;
                    #else
                        if (BufferLeft + n >= BufferLen)
                            break;
                    #endif
#pragma BullseyeCoverage on
                    BufferLeft += n;
                }
                GCLOG_INFO_POP(Base::m_pValueLog)("%s", _pBuffer);
            }
        }

        //! Implementation of IRegister::GetLength()
        virtual int64_t GetLength()
        {
            AutoLock l(Base::GetLock());

            return Base::InternalGetLength();
        }

        //! Retrieves the Address of the register
        virtual int64_t GetAddress()
        {
            AutoLock l(Base::GetLock());

            return Base::InternalGetAddress();
        }

    };
#   pragma warning ( pop )

} // namespace GenApi

#endif // GENAPI_REGISTERT_H
