retVal.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2020, Institut fuer Technische Optik (ITO),
    Universitaet Stuttgart, Germany

    This file is part of itom and its software development toolkit (SDK).

    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
   
    In addition, as a special exception, the Institut fuer Technische
    Optik (ITO) gives you certain additional rights.
    These rights are described in the ITO LGPL Exception version 1.0,
    which can be found in the file LGPL_EXCEPTION.txt in this package.

    itom is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library
    General Public Licence for more details.

    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************** */

#ifndef RETVAL_H
#define RETVAL_H

#ifdef __APPLE__
extern "C++" {
#endif

/* includes */
#include "commonGlobal.h"
#include "typeDefs.h"
#include "byteArray.h"

#include <stdarg.h>

namespace ito
{

//----------------------------------------------------------------------------------------------------------------------------------
class ITOMCOMMON_EXPORT RetVal
{       
    private:
        tRetValue m_retValue;    
        int m_retCode;           
        ByteArray m_retMessage;  
    public:
        inline RetVal() : m_retValue(ito::retOk), m_retCode(0) {}
        
        RetVal(tRetValue retValue) : m_retValue(retValue), m_retCode(0) {}
        
        RetVal(int retValue) : m_retValue((tRetValue)retValue), m_retCode(0) {}
        
        //RetVal(tRetValue retValue, int retCode, char *pRetMessage)
        RetVal(ito::tRetValue retValue, int retCode, const char *pRetMessage);
        
        inline ~RetVal() {}

        //RetVal & operator = (const RetVal &rhs);
        RetVal &operator=(const RetVal &rhs);


        //----------------------------------------------------------------------------------------------------------------------------------
        RetVal & operator += (const RetVal &rhs);

        //----------------------------------------------------------------------------------------------------------------------------------
        RetVal operator + (const RetVal &rhs)
        {
            return (*this += rhs);
        }

        //----------------------------------------------------------------------------------------------------------------------------------
        inline char operator == (const RetVal &rhs) //Todo: make this method const
        {
            return m_retValue == rhs.m_retValue;
        }

        //----------------------------------------------------------------------------------------------------------------------------------
        inline char operator != (const RetVal &rhs) //Todo: make this method const
        {
            return !(m_retValue == rhs.m_retValue);
        }

        //----------------------------------------------------------------------------------------------------------------------------------
        inline char operator == (const tRetValue rhs) //Todo: make this method const
        {
            return m_retValue == rhs;
        }

        //----------------------------------------------------------------------------------------------------------------------------------
        inline char operator != (const tRetValue rhs) //Todo: make this method const
        {
            return !(m_retValue == rhs);
        }

        //----------------------------------------------------------------------------------------------------------------------------------
        void appendRetMessage(const char *addRetMessage);

        //----------------------------------------------------------------------------------------------------------------------------------
        inline int containsWarning() const { return (m_retValue & retWarning); }              
        inline int containsError() const { return (m_retValue & retError); }                 
        inline int containsWarningOrError() const { return (m_retValue & (retError | retWarning)); }  
        inline bool hasErrorMessage() const { return m_retMessage.size() > 0; } 
        inline int errorCode() const { return m_retCode; } 
        inline const char *errorMessage() const { return m_retMessage.data(); } 
        //----------------------------------------------------------------------------------------------------------------------------------

        static RetVal format(ito::tRetValue retValue, int retCode, const char *pRetMessage, ...);

};


} //end namespace ito

#ifdef __APPLE__
}
#endif

#endif