_ccl_abstract_wrapper.h

/*
 * This file is part of cf4ocl (C Framework for OpenCL).
 *
 * cf4ocl is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * cf4ocl 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with cf4ocl. If not, see
 * <http://www.gnu.org/licenses/>.
 * */

#ifndef __CCL_ABSTRACT_WRAPPER_H_
#define __CCL_ABSTRACT_WRAPPER_H_

#include "ccl_oclversions.h"
#include "ccl_common.h"
#include "ccl_errors.h"

typedef struct ccl_wrapper_info_table CCLWrapperInfoTable;

struct ccl_wrapper {

    CCLClass class;

    void* cl_object;

    CCLWrapperInfoTable* info;

    int ref_count;

};

typedef void (*ccl_wrapper_release_fields)(CCLWrapper* wrapper);

typedef CL_API_ENTRY cl_int
    (CL_API_CALL* ccl_wrapper_release_cl_object)(void* cl_object);

typedef CL_API_ENTRY cl_int (CL_API_CALL* ccl_wrapper_info_fp1)(
    void* cl_object, cl_uint param_name, size_t param_value_size,
    void* param_value, size_t* param_value_size_ret);

typedef CL_API_ENTRY cl_int (CL_API_CALL* ccl_wrapper_info_fp2)(
    void* cl_object1, void* cl_object2, cl_uint param_name,
    size_t param_value_size, void* param_value,
    size_t* param_value_size_ret);

/* Create a new wrapper object. This function is called by the
 * concrete wrapper constructors. */
CCLWrapper* ccl_wrapper_new(CCLClass class, void* cl_object, size_t size);

/* Decrements the reference count of the wrapper object.
 * If it reaches 0, the wrapper object is destroyed. */
cl_bool ccl_wrapper_unref(CCLWrapper* wrapper, size_t size,
    ccl_wrapper_release_fields rel_fields_fun,
    ccl_wrapper_release_cl_object rel_cl_fun, CCLErr** err);

/* Add a ::CCLWrapperInfo object to the info table of the
 * given wrapper. */
void ccl_wrapper_add_info(CCLWrapper* wrapper, cl_uint param_name,
    CCLWrapperInfo* info);

/* Create a new CCLWrapperInfo* object with a given value size. */
CCLWrapperInfo* ccl_wrapper_info_new(size_t size);

/* Destroy a ::CCLWrapperInfo object. */
void ccl_wrapper_info_destroy(CCLWrapperInfo* info);

#endif