Prevent users from creating Sdl2TtfContext out of nothing and use SDL's reference counting init/quit (#1437)

* prevent users from creating `Sdl2TtfContext` out of nothing

and various other changes, including:
- allow multiple `ttf::init` calls, the same way it works with TTF_Init
- return last sdl error instead of I/O error (like stale pr #1348, fixes #1347 and closes #1348)
- implement `Clone` for `Sdl2TtfContext`, SDL C code will do the reference counting
- make `ttf::font::internal_*` `pub(super)`
- make `ttf::font::Font::raw` safe (obtaining a raw pointer is safe, using it is unsafe)

* remove `InitError` because only one variant was used

* update changelog

Author: antonilol

changelog.md

@@ -3,6 +3,8 @@ when upgrading from a version of rust-sdl2 to another.
 
 ### Next
 
+[PR #1437](https://github.com/Rust-SDL2/rust-sdl2/pull/1437) **BREAKING CHANGE** Prevent users from creating `Sdl2TtfContext` out of nothing and use SDL's reference counting init/quit
+
 [PR #1464](https://github.com/Rust-SDL2/rust-sdl2/pull/1464) Added binding for `Mix_OpenAudioDevice`
 
 [PR #1451](https://github.com/Rust-SDL2/rust-sdl2/pull/1451) Add `gamma_ramp_arrays` and `calculate_gamma_ramp`.

src/sdl2/ttf/context.rs

@@ -2,7 +2,6 @@ use get_error;
 use rwops::RWops;
 use std::error;
 use std::fmt;
-use std::io;
 use std::os::raw::{c_int, c_long};
 use std::path::Path;
 use sys::ttf;
@@ -14,7 +13,14 @@ use super::font::{
 
 /// A context manager for `SDL2_TTF` to manage C code initialization and clean-up.
 #[must_use]
-pub struct Sdl2TtfContext;
+pub struct Sdl2TtfContext(());
+
+impl Clone for Sdl2TtfContext {
+    fn clone(&self) -> Self {
+        // This should not return an error because SDL_ttf is already initialized
+        init().unwrap()
+    }
+}
 
 // Clean up the context once it goes out of scope
 impl Drop for Sdl2TtfContext {
@@ -54,7 +60,7 @@ impl Sdl2TtfContext {
         point_size: u16,
     ) -> Result<Font<'ttf, 'r>, String> {
         let raw = unsafe { ttf::TTF_OpenFontRW(rwops.raw(), 0, point_size as c_int) };
-        if (raw as *mut ()).is_null() {
+        if raw.is_null() {
             Err(get_error())
         } else {
             Ok(internal_load_font_from_ll(raw, Some(rwops)))
@@ -72,7 +78,7 @@ impl Sdl2TtfContext {
         let raw = unsafe {
             ttf::TTF_OpenFontIndexRW(rwops.raw(), 0, point_size as c_int, index as c_long)
         };
-        if (raw as *mut ()).is_null() {
+        if raw.is_null() {
             Err(get_error())
         } else {
             Ok(internal_load_font_from_ll(raw, Some(rwops)))
@@ -82,52 +88,25 @@ impl Sdl2TtfContext {
 
 /// Returns the version of the dynamically linked `SDL_TTF` library
 pub fn get_linked_version() -> Version {
-    unsafe { Version::from_ll(*ttf::TTF_Linked_Version()) }
-}
-
-/// An error for when `sdl2_ttf` is attempted initialized twice
-/// Necessary for context management, unless we find a way to have a singleton
-#[derive(Debug)]
-pub enum InitError {
-    InitializationError(io::Error),
-    AlreadyInitializedError,
-}
-
-impl error::Error for InitError {
-    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
-        match *self {
-            InitError::AlreadyInitializedError => None,
-            InitError::InitializationError(ref error) => Some(error),
-        }
-    }
-}
-
-impl fmt::Display for InitError {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        match self {
-            Self::AlreadyInitializedError => {
-                write!(f, "SDL2_TTF has already been initialized")
-            }
-            Self::InitializationError(error) => write!(f, "SDL2_TTF initialization error: {error}"),
-        }
-    }
+    Version::from_ll(unsafe { *ttf::TTF_Linked_Version() })
 }
 
 /// Initializes the truetype font API and returns a context manager which will
 /// clean up the library once it goes out of scope.
-pub fn init() -> Result<Sdl2TtfContext, InitError> {
-    unsafe {
-        if ttf::TTF_WasInit() == 1 {
-            Err(InitError::AlreadyInitializedError)
-        } else if ttf::TTF_Init() == 0 {
-            Ok(Sdl2TtfContext)
-        } else {
-            Err(InitError::InitializationError(io::Error::last_os_error()))
-        }
+#[doc(alias = "TTF_Init")]
+pub fn init() -> Result<Sdl2TtfContext, String> {
+    if unsafe { ttf::TTF_Init() } == 0 {
+        Ok(Sdl2TtfContext(()))
+    } else {
+        Err(get_error())
     }
 }
 
 /// Returns whether library has been initialized already.
 pub fn has_been_initialized() -> bool {
-    unsafe { ttf::TTF_WasInit() == 1 }
+    amount_of_times_initialized() != 0
+}
+
+fn amount_of_times_initialized() -> c_int {
+    unsafe { ttf::TTF_WasInit() }
 }

src/sdl2/ttf/font.rs

@@ -251,7 +251,7 @@ impl<'ttf, 'r> Drop for Font<'ttf, 'r> {
 }
 
 /// Internally used to load a font (for internal visibility).
-pub fn internal_load_font<'ttf, P: AsRef<Path>>(
+pub(super) fn internal_load_font<'ttf, P: AsRef<Path>>(
     path: P,
     ptsize: u16,
 ) -> Result<Font<'ttf, 'static>, String> {
@@ -271,7 +271,10 @@ pub fn internal_load_font<'ttf, P: AsRef<Path>>(
 }
 
 /// Internally used to load a font (for internal visibility).
-pub fn internal_load_font_from_ll<'ttf, 'r, R>(raw: *mut ttf::TTF_Font, rwops: R) -> Font<'ttf, 'r>
+pub(super) fn internal_load_font_from_ll<'ttf, 'r, R>(
+    raw: *mut ttf::TTF_Font,
+    rwops: R,
+) -> Font<'ttf, 'r>
 where
     R: Into<Option<RWops<'r>>>,
 {
@@ -283,7 +286,7 @@ where
 }
 
 /// Internally used to load a font (for internal visibility).
-pub fn internal_load_font_at_index<'ttf, P: AsRef<Path>>(
+pub(super) fn internal_load_font_at_index<'ttf, P: AsRef<Path>>(
     path: P,
     index: u32,
     ptsize: u16,

src/sdl2/ttf/mod.rs

@@ -23,9 +23,7 @@
 mod context;
 mod font;
 
-pub use self::context::{
-    get_linked_version, has_been_initialized, init, InitError, Sdl2TtfContext,
-};
+pub use self::context::{get_linked_version, has_been_initialized, init, Sdl2TtfContext};
 pub use self::font::{
     Font, FontError, FontResult, FontStyle, GlyphMetrics, Hinting, PartialRendering,
 };