/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup NdkBinder
 * @{
 */

/**
 * @file binder_ibinder_jni.h
 * @brief Conversions between AIBinder and android.os.IBinder
 */

#pragma once

#include <android/binder_ibinder.h>

#include <jni.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Converts an android.os.IBinder object into an AIBinder* object.
 *
 * If the binder is null, null is returned. If this binder object was originally an
 * AIBinder object, the original object is returned. The returned object has one refcount
 * associated with it, and so this should be accompanied with an AIBinder_decStrong call.
 *
 * Available since API level 29.
 *
 * \param env Java environment. Must not be null.
 * \param binder android.os.IBinder java object.
 *
 * \return an AIBinder object representing the Java binder object. If either parameter is null, or
 * the Java object is of the wrong type, this will return null.
 */
__attribute__((warn_unused_result)) AIBinder* AIBinder_fromJavaBinder(JNIEnv* env, jobject binder)
        __INTRODUCED_IN(29);

/**
 * Converts an AIBinder* object into an android.os.IBinder object.
 *
 * If the binder is null, null is returned. If this binder object was originally an IBinder object,
 * the original java object will be returned.
 *
 * WARNING: this function returns global and local references. This can be
 * figured out using GetObjectRefType. Though, when this function is called
 * from within a Java context, the local ref will automatically be cleaned
 * up. If this is called outside of a Java frame,
 * PushObjectFrame/PopObjectFrame can simulate this automatic cleanup.
 *
 * Available since API level 29.
 *
 * \param env Java environment. Must not be null.
 * \param binder the object to convert.
 *
 * \return an android.os.IBinder object or null if the parameters were null.
 */
__attribute__((warn_unused_result)) jobject AIBinder_toJavaBinder(JNIEnv* env, AIBinder* binder)
        __INTRODUCED_IN(29);

#ifdef __cplusplus
}
#endif

/** @} */
