sol-flow-metatype.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * 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.
 */

#pragma once

#include "sol-flow.h"
#include "sol-str-slice.h"
#include "sol-buffer.h"
#include "sol-vector.h"
#include <stdbool.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct sol_flow_metatype_context {
    struct sol_str_slice name; 
    struct sol_str_slice contents; 
    int (*read_file)(
        const struct sol_flow_metatype_context *ctx,
        const char *name, struct sol_buffer *buf);

    int (*store_type)(
        const struct sol_flow_metatype_context *ctx,
        struct sol_flow_node_type *type);
} sol_flow_metatype_context;

typedef struct sol_flow_metatype_port_description {
    char *name; 
    char *type; 
    int array_size; 
    int idx; 
} sol_flow_metatype_port_description;

typedef struct sol_flow_metatype_option_description {
    char *name; 
    char *data_type; 
} sol_flow_metatype_option_description;

typedef int (*sol_flow_metatype_create_type_func)(const struct sol_flow_metatype_context *ctx, struct sol_flow_node_type **type);

typedef int (*sol_flow_metatype_generate_code_func)(const struct sol_flow_metatype_context *ctx, struct sol_buffer *out);

typedef int (*sol_flow_metatype_ports_description_func)(const struct sol_flow_metatype_context *ctx, struct sol_vector *in, struct sol_vector *out);

typedef int (*sol_flow_metatype_options_description_func)(struct sol_vector *opts);

sol_flow_metatype_generate_code_func sol_flow_metatype_get_generate_code_start_func(const struct sol_str_slice name);

sol_flow_metatype_generate_code_func sol_flow_metatype_get_generate_code_type_func(const struct sol_str_slice name);

sol_flow_metatype_generate_code_func sol_flow_metatype_get_generate_code_end_func(const struct sol_str_slice name);

sol_flow_metatype_ports_description_func sol_flow_metatype_get_ports_description_func(const struct sol_str_slice name);

sol_flow_metatype_options_description_func sol_flow_metatype_get_options_description_func(const struct sol_str_slice name);

const char *sol_flow_metatype_get_options_symbol(const struct sol_str_slice name);

#define SOL_FLOW_METATYPE_API_VERSION (1)

typedef struct sol_flow_metatype {
#ifndef SOL_NO_API_VERSION
    uint16_t api_version; 
#endif

    const char *name; 
    const char *options_symbol; 
    sol_flow_metatype_create_type_func create_type; 
    sol_flow_metatype_generate_code_func generate_type_start; 
    sol_flow_metatype_generate_code_func generate_type_body; 
    sol_flow_metatype_generate_code_func generate_type_end; 
    sol_flow_metatype_ports_description_func ports_description; 
    sol_flow_metatype_options_description_func options_description; 
} sol_flow_metatype;

#ifdef SOL_FLOW_METATYPE_MODULE_EXTERNAL

#define SOL_FLOW_METATYPE(_NAME, decl ...) \
    SOL_API const struct sol_flow_metatype *SOL_FLOW_METATYPE = \
        &((const struct sol_flow_metatype) { \
            SOL_SET_API_VERSION(.api_version = SOL_FLOW_METATYPE_API_VERSION, ) \
            decl \
        })
#else

#define SOL_FLOW_METATYPE(_NAME, decl ...) \
    const struct sol_flow_metatype SOL_FLOW_METATYPE_ ## _NAME = { \
        SOL_SET_API_VERSION(.api_version = SOL_FLOW_METATYPE_API_VERSION, ) \
        decl \
    }
#endif

#ifdef __cplusplus
}
#endif