sol-flow-static.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"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct sol_flow_static_node_spec {
    const struct sol_flow_node_type *type; 
    const char *name; 
    const struct sol_flow_node_options *opts; 
} sol_flow_static_node_spec;

typedef struct sol_flow_static_conn_spec {
    uint16_t src; 
    uint16_t src_port; 
    uint16_t dst; 
    uint16_t dst_port; 
} sol_flow_static_conn_spec;

typedef struct sol_flow_static_port_spec {
    uint16_t node; 
    uint16_t port; 
} sol_flow_static_port_spec;

/* Use these guards as the last element of the spec arrays. */

#define SOL_FLOW_STATIC_NODE_SPEC_GUARD { }

#define SOL_FLOW_STATIC_CONN_SPEC_GUARD { .src = UINT16_MAX }

#define SOL_FLOW_STATIC_PORT_SPEC_GUARD { .node = UINT16_MAX }


typedef struct sol_flow_static_spec {
#ifndef SOL_NO_API_VERSION
#define SOL_FLOW_STATIC_API_VERSION (1) 
    uint16_t api_version; 
#endif
    uint16_t flags;

    const struct sol_flow_static_node_spec *nodes;

    const struct sol_flow_static_conn_spec *conns;

    const struct sol_flow_static_port_spec *exported_in;

    const struct sol_flow_static_port_spec *exported_out;

    int (*child_opts_set)(const struct sol_flow_node_type *type,
        uint16_t child_index,
        const struct sol_flow_node_options *opts,
        struct sol_flow_node_options *child_opts);

    void (*dispose)(const void *type_data);
} sol_flow_static_spec;

struct sol_flow_node *sol_flow_static_new(struct sol_flow_node *parent, const struct sol_flow_static_node_spec nodes[], const struct sol_flow_static_conn_spec conns[]);

struct sol_flow_node *sol_flow_static_get_node(struct sol_flow_node *node, uint16_t index);

struct sol_flow_node_type *sol_flow_static_new_type(
    const struct sol_flow_static_spec *spec);

#ifdef __cplusplus
}
#endif