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

//! The raw bindings for `pikchr.c`.
//!
//! Using [`pikchr`] will require manually freeing the buffer. Quoting the C source code:
//!
//! > This file implements a C-language subroutine that accepts a string
//! > of PIKCHR language text and generates a second string of SVG output that
//! > renders the drawing defined by the input.  Space to hold the returned
//! > string is obtained from malloc() and should be freed by the caller.
//! > NULL might be returned if there is a memory allocation error.
//!
//! The [`pikchr`] arguments are defined as follows:
//!
//! - `zText`: Input PIKCHR markup. Zero terminated.
//! - `zClass`: The value to add to the SVG `class` attribute. It can be NULL.
//! - `mFlags`: Flags to control the rendering behaviour.
//! - `pnWidth`: The value for the SVG `width` attribute. It can be NULL.
//! - `pnHeight`: The value for the SVG `height` attribute. It can be NULL.
//!
//! ## Example
//!
//! ```no_run
//! let input = "box \"example\"";
//! let mut width: c_int = 0;
//! let mut height: c_int = 0;
//! let input = CString::new(input)?;
//!
//! let res: *mut c_char = unsafe {
//!     pikchr(
//!         input.as_ptr() as *const c_char,
//!         std::ptr::null(),
//!         PIKCHR_PLAINTEXT_ERRORS,
//!         &mut width as *mut c_int,
//!         &mut height as *mut c_int,
//!     )
//! };
//!
//! let cstr = unsafe { CStr::from_ptr(res) };
//! let output = String::from_utf8_lossy(cstr.to_bytes()).into_owned();
//!
//! unsafe { free(res as *mut c_void) };
//! ```
//!
//! ## Errors
//!
//! If an error occurs, the _width_ will be `-1` and the buffer will contain the error message.
include!(concat!(env!("OUT_DIR"), "/bindings.rs"));

#[cfg(test)]
mod tests {
    use super::*;
    use libc::free;
    use std::ffi::{CStr, CString};
    use std::os::raw::*;

    #[test]
    fn simple_raw_box() {
        let input = "box \"pikchr\"";
        let expected = "<svg xmlns='http://www.w3.org/2000/svg' viewBox=\"0 0 112.32 76.32\">\n<path d=\"M2,74L110,74L110,2L2,2Z\"  style=\"fill:none;stroke-width:2.16;stroke:rgb(0,0,0);\" />\n<text x=\"56\" y=\"38\" text-anchor=\"middle\" fill=\"rgb(0,0,0)\" dominant-baseline=\"central\">pikchr</text>\n</svg>\n";

        let source = CString::new(input).unwrap();
        let flags = PIKCHR_PLAINTEXT_ERRORS;
        let mut width: c_int = 0;
        let mut height: c_int = 0;

        let res: *mut c_char = unsafe {
            pikchr(
                source.as_ptr() as *const c_char,
                std::ptr::null(),
                flags,
                &mut width as *mut c_int,
                &mut height as *mut c_int,
            )
        };
        let cstr = unsafe { CStr::from_ptr(res) };
        let actual = String::from_utf8_lossy(cstr.to_bytes()).into_owned();

        unsafe { free(res as *mut c_void) };

        assert_eq!(&actual, expected);
    }
}