mupdf 0.6.0

Safe Rust wrapper to MuPDF
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

use std::ffi::NulError;
use std::fmt;
use std::io;
use std::num::TryFromIntError;
use std::ptr::NonNull;

use mupdf_sys::*;

#[derive(Debug, Clone)]
pub struct MuPdfError {
    pub code: i32,
    pub message: String,
}

impl fmt::Display for MuPdfError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "MuPDF error, code: {}, message: {}",
            self.code, &self.message
        )
    }
}

impl std::error::Error for MuPdfError {}

/// # Safety
///
/// * `ptr` must point to a valid, well-aligned instance of [`mupdf_error_t`].
///
/// * The pointers stored in this [`mupdf_error_t`] must also be non-null, well-aligned, and point
///   to valid instances of what they claim to represent.
///
/// * The [`field@mupdf_error_t::message`] ptr in `ptr` must point to a null-terminated c-string
pub unsafe fn ffi_error(ptr: NonNull<mupdf_error_t>) -> MuPdfError {
    use std::ffi::CStr;

    // SAFETY: Upheld by caller
    let err = unsafe { *ptr.as_ptr() };
    let code = err.type_;
    let c_msg = err.message;

    // SAFETY: Upheld by caller
    let c_str = unsafe { CStr::from_ptr(c_msg) };
    let message = c_str.to_string_lossy().to_string();

    // SAFETY: Upheld by caller; if it's pointing to a valid instance then it can be dropped
    unsafe { mupdf_drop_error(ptr.as_ptr()) };
    MuPdfError { code, message }
}

macro_rules! ffi_try {
    ($func:ident($($arg:expr),+)) => ({
        use std::ptr;
        let mut err = ptr::null_mut();
        // SAFETY: Upheld by the caller of the macro
        let res = $func($($arg),+, (&mut err) as *mut *mut ::mupdf_sys::mupdf_error_t);
        ::core::ptr::NonNull::new(err)
            .map_or(Ok(res), |err| Err(
                // SAFETY: We're trusting the FFI call to provide us with a valid ptr if it is not
                // null.
                $crate::Error::MuPdf($crate::ffi_error(err))
            ))
    });
}

#[derive(Debug)]
#[non_exhaustive]
pub enum Error {
    Io(io::Error),
    InvalidLanguage(String),
    InvalidPdfDocument,
    MuPdf(MuPdfError),
    Nul(NulError),
    IntConversion(TryFromIntError),
    InvalidUtf8,
    UnexpectedNullPtr,
    UnknownEnumVariant,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Io(err) => err.fmt(f),
            Error::InvalidLanguage(lang) => write!(f, "invalid language {lang}"),
            Error::InvalidPdfDocument => write!(f, "invalid pdf document"),
            Error::MuPdf(err) => err.fmt(f),
            Error::Nul(err) => err.fmt(f),
            Error::IntConversion(err) => err.fmt(f),
            Error::InvalidUtf8 => f.write_str("string contained invalid utf-8"),
            Error::UnexpectedNullPtr => write!(
                f,
                "An FFI function call returned a null ptr when we expected a non-null ptr"
            ),
            Error::UnknownEnumVariant => write!(f, "unknown enum variant provided"),
        }
    }
}

impl std::error::Error for Error {}

impl From<io::Error> for Error {
    fn from(err: io::Error) -> Self {
        Self::Io(err)
    }
}

impl From<MuPdfError> for Error {
    fn from(err: MuPdfError) -> Self {
        Self::MuPdf(err)
    }
}

impl From<NulError> for Error {
    fn from(err: NulError) -> Self {
        Self::Nul(err)
    }
}

impl From<TryFromIntError> for Error {
    fn from(value: TryFromIntError) -> Self {
        Self::IntConversion(value)
    }
}