/*******************************************************************************
 * Copyright IBM Corp. and others 2019
 *
 * This program and the accompanying materials are made available under
 * the terms of the Eclipse Public License 2.0 which accompanies this
 * distribution and is available at https://www.eclipse.org/legal/epl-2.0/
 * or the Apache License, Version 2.0 which accompanies this distribution
 * and is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License, v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception [1] and GNU General Public
 * License, version 2 with the OpenJDK Assembly Exception [2].
 *
 * [1] https://www.gnu.org/software/classpath/license.html
 * [2] https://openjdk.org/legal/assembly-exception.html
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 *******************************************************************************/

#ifndef TR_REAL_REGISTER_INCL
#define TR_REAL_REGISTER_INCL

#include "codegen/OMRRealRegister.hpp"

#include <stddef.h> // for NULL
#include <stdint.h> // for uint16_t
#include "codegen/Register.hpp" // for Register
#include "codegen/RegisterConstants.hpp" // for TR_RegisterKinds
#include "infra/Assert.hpp" // for TR_ASSERT

namespace TR {
class CodeGenerator;
}

namespace TR {

class OMR_EXTENSIBLE RealRegister : public OMR::RealRegisterConnector {
public:
    RealRegister(TR::CodeGenerator *cg)
        : OMR::RealRegisterConnector(cg)
    {}

    RealRegister(TR_RegisterKinds rk, uint16_t w, RegState s, RegNum rn, RegMask m, TR::CodeGenerator *cg)
        : OMR::RealRegisterConnector(rk, w, s, rn, m, cg)
    {}

    RealRegister(TR_RegisterKinds rk, uint16_t w, RegState s, RegNum rn, TR::CodeGenerator *cg)
        : OMR::RealRegisterConnector(rk, w, s, rn, noRegMask, cg)
    {}
};

} // namespace TR

inline TR::RealRegister *toRealRegister(TR::Register *r)
{
    TR_ASSERT(r == NULL || r->getRealRegister() != NULL, "trying to convert a non-real register to a real register");
    return static_cast<TR::RealRegister *>(r);
}

inline TR::RealRegister::RegNum &operator++(TR::RealRegister::RegNum &rn)
{
    rn = static_cast<TR::RealRegister::RegNum>(static_cast<int>(rn + 1));
    return rn;
}

inline TR::RealRegister::RegNum operator++(TR::RealRegister::RegNum &in, int)
{
    TR::RealRegister::RegNum out = in;
    ++in;
    return out;
}
#endif
