/*
 * Copyright 2025-2026 NVIDIA CORPORATION & AFFILIATES.  All rights reserved.
 *
 * NOTICE TO LICENSEE:
 *
 * This source code and/or documentation ("Licensed Deliverables") are
 * subject to NVIDIA intellectual property rights under U.S. and
 * international Copyright laws.
 *
 * These Licensed Deliverables contained herein is PROPRIETARY and
 * CONFIDENTIAL to NVIDIA and is being provided under the terms and
 * conditions of a form of NVIDIA software license agreement by and
 * between NVIDIA and Licensee ("License Agreement") or electronically
 * accepted by Licensee.  Notwithstanding any terms or conditions to
 * the contrary in the License Agreement, reproduction or disclosure
 * of the Licensed Deliverables to any third party without the express
 * written consent of NVIDIA is prohibited.
 *
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, NVIDIA MAKES NO REPRESENTATION ABOUT THE
 * SUITABILITY OF THESE LICENSED DELIVERABLES FOR ANY PURPOSE.  IT IS
 * PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY OF ANY KIND.
 * NVIDIA DISCLAIMS ALL WARRANTIES WITH REGARD TO THESE LICENSED
 * DELIVERABLES, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY,
 * NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE.
 * NOTWITHSTANDING ANY TERMS OR CONDITIONS TO THE CONTRARY IN THE
 * LICENSE AGREEMENT, IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY
 * SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, OR ANY
 * DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
 * WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
 * ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THESE LICENSED DELIVERABLES.
 *
 * U.S. Government End Users.  These Licensed Deliverables are a
 * "commercial item" as that term is defined at 48 C.F.R. 2.101 (OCT
 * 1995), consisting of "commercial computer software" and "commercial
 * computer software documentation" as such terms are used in 48
 * C.F.R. 12.212 (SEPT 1995) and is provided to the U.S. Government
 * only as a commercial end item.  Consistent with 48 C.F.R.12.212 and
 * 48 C.F.R. 227.7202-1 through 227.7202-4 (JUNE 1995), all
 * U.S. Government End Users acquire the Licensed Deliverables with
 * only those rights set forth herein.
 *
 * Any use of the Licensed Deliverables in individual and commercial
 * software must include, in the user documentation and internal
 * comments to the code, the above Disclaimer and U.S. Government End
 * Users Notice.
 */

#ifndef QUERY_API_H
#define QUERY_API_H

#include <stddef.h>
#include <stdint.h>

#include "../macros.h"
#include "../types/cuest_types.h"
#include "../types/workspace_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief Query an attribute of a cuEST opaque handle.
 * @ingroup Query
 *
 * The result pointer \c attributeValue must reference sufficient memory for the type matching the specified attribute.
 * Note that char* attributes are allocated internally and must be freed by the caller using free(). This allocation
 * only occurs when the function completes successfully (returns \c CUEST_STATUS_SUCCESS). On any error status no
 * allocation is made and \c attributeValue is left unchanged — cuEST never writes to it on a failing path — so a
 * caller that pre-initializes \c attributeValue (e.g. to \c NULL) can rely on that value afterward for a
 * deterministic cleanup pattern, and there is nothing to free.
 *
 * @param[in]  handle              cuEST handle. Must not be NULL.
 * @param[in]  type                enum indicating which type of object is being queried
 * @param[in]  object              cuEST object to be queried (opaque handle). Must not be NULL.
 * @param[in]  attribute           Attribute/property to query. (Should be an enum appropriate to the type of object.)
 * @param[out] attributeValue      Pointer to memory for result (type depends on attribute). Must not be NULL.
 * @param[in]  attributeValueSize  Number of bytes in \c attributeValue. Must match sizeof(type).
 *
 * @return
 *   - \c CUEST_STATUS_SUCCESS on success;
 *   - \c CUEST_STATUS_INVALID_HANDLE if the cuEST handle is NULL;
 *   - \c CUEST_STATUS_NULL_POINTER if \c object or \c attributeValue is NULL;
 *   - \c CUEST_STATUS_INVALID_TYPE if \c object is not of the specified \c type;
 *   - \c CUEST_STATUS_INVALID_SIZE if \c attributeValueSize does not match \c attribute type size;
 *   - \c CUEST_STATUS_INVALID_ATTRIBUTE if \c attribute is not recognized;
 *   - \c CUEST_STATUS_EXCEPTION or \c CUEST_STATUS_UNKNOWN_ERROR for internal errors.
 */
CUEST_API
cuestStatus_t cuestQuery(
    cuestHandle_t handle,
    cuestType_t type,
    const void* object,
    int attribute,
    void* attributeValue,
    size_t attributeValueSize);

#ifdef __cplusplus
}
#endif

#endif /* QUERY_API_H */
