graphannis-capi 4.1.4

This is the C-API to the ANNIS linguistic search and visualization system.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

use super::{cast_const, cstr};
use crate::{cerror::ErrorList, data::IterPtr, map_cerr};
use graphannis::{
    AnnotationGraph,
    errors::GraphAnnisError,
    graph::{Annotation, Edge, Match, NodeID},
    model::{AnnotationComponent, AnnotationComponentType},
};
use itertools::Itertools;
use std::ffi::CString;

/// Get the type of the given component.
#[unsafe(no_mangle)]
pub extern "C" fn annis_component_type(c: *const AnnotationComponent) -> AnnotationComponentType {
    let c: &AnnotationComponent = cast_const(c);
    c.get_type()
}

/// Get the layer of the given component.
///
/// The returned string must be deallocated by the caller using annis_str_free()!
#[unsafe(no_mangle)]
pub extern "C" fn annis_component_layer(c: *const AnnotationComponent) -> *mut libc::c_char {
    let c: &AnnotationComponent = cast_const(c);
    let as_string: &str = &c.layer;
    CString::new(as_string).unwrap_or_default().into_raw()
}

/// Get the name of the given component.
///
/// The returned string must be deallocated by the caller using annis_str_free()!
#[unsafe(no_mangle)]
pub extern "C" fn annis_component_name(c: *const AnnotationComponent) -> *mut libc::c_char {
    let c: &AnnotationComponent = cast_const(c);
    let as_string: &str = &c.name;
    CString::new(as_string).unwrap_or_default().into_raw()
}

/// Return an iterator over all nodes of the graph `g` and the given `node_type` (e.g. "node" or "corpus").
#[unsafe(no_mangle)]
pub extern "C" fn annis_graph_nodes_by_type(
    g: *const AnnotationGraph,
    node_type: *const libc::c_char,
) -> *mut IterPtr<NodeID> {
    let db: &AnnotationGraph = cast_const(g);
    let node_type = cstr(node_type);
    let it = db
        .get_node_annos()
        .exact_anno_search(Some("annis"), "node_type", Some(node_type.as_ref()).into())
        .map_ok(|m: Match| m.node)
        .map(|n| n.map_err(GraphAnnisError::from));
    Box::into_raw(Box::new(Box::new(it)))
}

/// Return a vector of all annotations for the given `node` in the graph `g`.
///
/// - `err` - Pointer to a list of errors. If any error occured, this list will be non-empty.
#[unsafe(no_mangle)]
pub extern "C" fn annis_graph_annotations_for_node(
    g: *const AnnotationGraph,
    node: NodeID,
    err: *mut *mut ErrorList,
) -> *mut Vec<Annotation> {
    let db: &AnnotationGraph = cast_const(g);

    map_cerr(db.get_node_annos().get_annotations_for_item(&node), err)
        .map(|annos| {
            let anno = Box::new(annos);
            Box::into_raw(anno)
        })
        .unwrap_or_else(std::ptr::null_mut)
}

/// Return a vector of all components for the graph `g`.
#[unsafe(no_mangle)]
pub extern "C" fn annis_graph_all_components(
    g: *const AnnotationGraph,
) -> *mut Vec<AnnotationComponent> {
    let db: &AnnotationGraph = cast_const(g);

    Box::into_raw(Box::new(db.get_all_components(None, None)))
}

/// Return a vector of all components for the graph `g` and the given component type.
#[unsafe(no_mangle)]
pub extern "C" fn annis_graph_all_components_by_type(
    g: *const AnnotationGraph,
    ctype: AnnotationComponentType,
) -> *mut Vec<AnnotationComponent> {
    let db: &AnnotationGraph = cast_const(g);

    Box::into_raw(Box::new(db.get_all_components(Some(ctype), None)))
}

/// Return a vector of all outgoing edges for the graph `g`, the `source` node and the given `component`.
///
/// - `err` - Pointer to a list of errors. If any error occured, this list will be non-empty.
#[unsafe(no_mangle)]
pub extern "C" fn annis_graph_outgoing_edges(
    g: *const AnnotationGraph,
    source: NodeID,
    component: *const AnnotationComponent,
    err: *mut *mut ErrorList,
) -> *mut Vec<Edge> {
    let db: &AnnotationGraph = cast_const(g);
    let component: &AnnotationComponent = cast_const(component);

    let mut result: Vec<Edge> = Vec::new();

    if let Some(gs) = db.get_graphstorage(component) {
        for target in gs.get_outgoing_edges(source) {
            if let Some(target) = map_cerr(target, err) {
                result.push(Edge { source, target })
            }
        }
    }

    Box::into_raw(Box::new(result))
}

/// Return a vector of annnotations for the given `edge` in the `component` of graph `g.
///
/// - `err` - Pointer to a list of errors. If any error occured, this list will be non-empty.
#[unsafe(no_mangle)]
pub extern "C" fn annis_graph_annotations_for_edge(
    g: *const AnnotationGraph,
    edge: Edge,
    component: *const AnnotationComponent,
    err: *mut *mut ErrorList,
) -> *mut Vec<Annotation> {
    let db: &AnnotationGraph = cast_const(g);
    let component: &AnnotationComponent = cast_const(component);

    if let Some(gs) = db.get_graphstorage(component) {
        map_cerr(gs.get_anno_storage().get_annotations_for_item(&edge), err)
            .map(|annos| Box::into_raw(Box::new(annos)))
            .unwrap_or_else(std::ptr::null_mut)
    } else {
        Box::into_raw(Box::default())
    }
}