//  IBM_PROLOG_BEGIN_TAG
//  This is an automatically generated prolog.
//
//  $Source: src/usr/hwpf/fapi/fapiReturnCodeDataRef.C $
//
//  IBM CONFIDENTIAL
//
//  COPYRIGHT International Business Machines Corp. 2011
//
//  p1
//
//  Object Code Only (OCO) source materials
//  Licensed Internal Code Source Materials
//  IBM HostBoot Licensed Internal Code
//
//  The source code for this program is not published or other-
//  wise divested of its trade secrets, irrespective of what has
//  been deposited with the U.S. Copyright Office.
//
//  Origin: 30
//
//  IBM_PROLOG_END
/**
 *  @file fapiReturnCodeDataRef.C
 *
 *  @brief Implements the FAPI part of the ReturnCodeDataRef class.
 */

/*
 * Change Log ******************************************************************
 * Flag     Defect/Feature  User        Date        Description
 * ------   --------------  ----------  ----------- ----------------------------
 *                          mjjones     04/13/2011  Created.
 *                          camvanng	05/31/2011  Added debug traces
 *                          mjjones     06/30/2011  Added #include
 *                          mjjones     07/05/2011  Removed const from data
 *                          mjjones     07/25/2011  Added support for FFDC
 *                          mjjones     09/22/2100  Added support for Error Info
 */

#include <string.h>
#include <fapiReturnCodeDataRef.H>
#include <fapiUtil.H>
#include <fapiPlatTrace.H>

namespace fapi
{

//******************************************************************************
// Constructor
//******************************************************************************
ReturnCodeDataRef::ReturnCodeDataRef()
: iv_refCount(1),
  iv_pPlatData(NULL),
  iv_pErrorInfo(NULL)
{

}

//******************************************************************************
// Destructor
//******************************************************************************
ReturnCodeDataRef::~ReturnCodeDataRef()
{
    if (iv_refCount != 0)
    {
        FAPI_ERR("ReturnCodeDataRef. Bug. Destruct with refcount: %d",
                 iv_refCount);
        fapiAssert(false);
    }

    deletePlatData();
    delete iv_pErrorInfo;
    iv_pErrorInfo = NULL;
}

//******************************************************************************
// incRefCount function
//******************************************************************************
void ReturnCodeDataRef::incRefCount()
{
	FAPI_DBG("ReturnCodeDataRef::incRefCount: iv_refCount = %d on entry",
             iv_refCount);
    iv_refCount++;
}

//******************************************************************************
// decRefCountCheckZero function
//******************************************************************************
bool ReturnCodeDataRef::decRefCountCheckZero()
{
	FAPI_DBG("ReturnCodeDataRef::decRefCountCheckZero: iv_refCount = %d on "
             "entry", iv_refCount);

    if (iv_refCount == 0)
    {
        FAPI_ERR("ReturnCodeDataRef. Bug. Dec with zero refcount");
        fapiAssert(false);
    }
    else
    {
        iv_refCount--;
    }
    return (iv_refCount == 0);
}

//******************************************************************************
// setPlatData function
//******************************************************************************
void ReturnCodeDataRef::setPlatData(void * i_pPlatData)
{
    // Delete any current PlatData
    if (iv_pPlatData)
    {
        FAPI_ERR("ReturnCodeDataRef. setPlatData when existing data");
        deletePlatData();
    }

    iv_pPlatData = i_pPlatData;
}

//******************************************************************************
// getPlatData function
//******************************************************************************
void * ReturnCodeDataRef::getPlatData() const
{
    return iv_pPlatData;
}

//******************************************************************************
// releasePlatData function
//******************************************************************************
void * ReturnCodeDataRef::releasePlatData()
{
    void * l_pPlatData = iv_pPlatData;
    iv_pPlatData = NULL;
    return l_pPlatData;
}

//******************************************************************************
// getErrorInfo function
//******************************************************************************
ErrorInfo * ReturnCodeDataRef::getErrorInfo()
{
    return iv_pErrorInfo;
}

//******************************************************************************
// getCreateErrorInfo function
//******************************************************************************
ErrorInfo & ReturnCodeDataRef::getCreateErrorInfo()
{
    if (iv_pErrorInfo == NULL)
    {
        iv_pErrorInfo = new ErrorInfo();
    }

    return *iv_pErrorInfo;
}

}