ManimPango 0.6.1__cp311-cp311-macosx_10_13_x86_64.whl

manimpango/enums.pyx

@@ -0,0 +1,113 @@
+from enum import Enum
+
+from pango cimport *
+
+
+class Style(Enum):
+    """
+    An enumeration specifying the various slant styles possible for a font.
+
+    Attributes
+    ----------
+
+    NORMAL :
+        the font is upright.
+
+    ITALIC :
+        the font is slanted, but in a roman style.
+
+    OBLIQUE:
+        the font is slanted in an italic style.
+    """
+    NORMAL = PANGO_STYLE_NORMAL
+    ITALIC = PANGO_STYLE_ITALIC
+    OBLIQUE = PANGO_STYLE_OBLIQUE
+
+class Weight(Enum):
+    """
+    An enumeration specifying the weight (boldness) of a font.
+    This is a numerical value ranging from 100 to 1000, but there are some predefined values
+    Using numerical value other then that defined here is not supported.
+
+    Attributes
+    ----------
+
+    NORMAL :
+        the default weight (= 400)
+
+    BOLD :
+        the bold weight( = 700)
+
+    THIN :
+        the thin weight( = 100; Since: 1.24)
+
+    ULTRALIGHT :
+        the ultralight weight( = 200)
+
+    LIGHT :
+        the light weight( = 300)
+
+    BOOK :
+        the book weight( = 380; Since: 1.24)
+
+    MEDIUM :
+        the normal weight( = 500; Since: 1.24)
+
+    SEMIBOLD :
+        the semibold weight( = 600)
+
+    ULTRABOLD :
+        the ultrabold weight( = 800)
+
+    HEAVY :
+        the heavy weight( = 900)
+
+    ULTRAHEAVY :
+        the ultraheavy weight( = 1000; Since: 1.24)
+    """
+    NORMAL = PANGO_WEIGHT_NORMAL
+    BOLD = PANGO_WEIGHT_BOLD
+    THIN = PANGO_WEIGHT_THIN
+    ULTRALIGHT = PANGO_WEIGHT_ULTRALIGHT
+    LIGHT = PANGO_WEIGHT_LIGHT
+    BOOK = PANGO_WEIGHT_BOOK
+    MEDIUM = PANGO_WEIGHT_MEDIUM
+    SEMIBOLD = PANGO_WEIGHT_SEMIBOLD
+    ULTRABOLD = PANGO_WEIGHT_ULTRABOLD
+    HEAVY = PANGO_WEIGHT_HEAVY
+    ULTRAHEAVY = PANGO_WEIGHT_ULTRAHEAVY
+
+class Variant(Enum):
+    """
+    An enumeration specifying capitalization variant of the font.
+
+    Attributes
+    ----------
+
+    NORMAL :
+        A normal font.
+
+    SMALL_CAPS :
+        A font with the lower case characters replaced by smaller variants
+        of the capital characters.
+    """
+    NORMAL = PANGO_VARIANT_NORMAL
+    SMALL_CAPS = PANGO_VARIANT_SMALL_CAPS
+
+class Alignment(Enum):
+    """
+    An enumeration specifying alignment.
+
+    Attributes
+    ----------
+
+    NORMAL :
+        A normal font.
+
+    SMALL_CAPS :
+        A font with the lower case characters replaced by smaller variants
+        of the capital characters.
+    """
+    LEFT = PANGO_ALIGN_LEFT
+    CENTER = PANGO_ALIGN_CENTER
+    RIGHT = PANGO_ALIGN_RIGHT

manimpango/glib.pxd

@@ -0,0 +1,13 @@
+cdef extern from "glib.h":
+    ctypedef void* gpointer
+    ctypedef int gint
+    ctypedef unsigned int guint
+    ctypedef gint gboolean
+    ctypedef unsigned short guint16
+    ctypedef char gchar
+    ctypedef struct GError:
+        gint code
+        gchar *message
+    void g_error_free (GError *error)
+    void g_object_unref(gpointer object)
+    void g_free(gpointer mem)

manimpango/pango.pxd

@@ -0,0 +1,193 @@
+from cairo cimport *
+from glib cimport *
+
+
+cdef extern from "pango/pangocairo.h":
+    int PANGO_SCALE
+    int pango_units_from_double(double d)
+    double pango_units_to_double (int i)
+    ctypedef struct PangoLayout:
+        pass
+    ctypedef struct PangoContext:
+        pass
+    ctypedef struct PangoFontMap:
+        pass
+    ctypedef struct PangoFontDescription:
+        pass
+    ctypedef struct PangoFontFamily:
+        pass
+    ctypedef enum PangoStyle:
+        PANGO_STYLE_NORMAL
+        PANGO_STYLE_OBLIQUE
+        PANGO_STYLE_ITALIC
+    ctypedef enum PangoWeight:
+        PANGO_WEIGHT_THIN
+        PANGO_WEIGHT_ULTRALIGHT
+        PANGO_WEIGHT_LIGHT
+        PANGO_WEIGHT_BOOK
+        PANGO_WEIGHT_NORMAL
+        PANGO_WEIGHT_MEDIUM
+        PANGO_WEIGHT_SEMIBOLD
+        PANGO_WEIGHT_BOLD
+        PANGO_WEIGHT_ULTRABOLD
+        PANGO_WEIGHT_HEAVY
+        PANGO_WEIGHT_ULTRAHEAVY
+    ctypedef enum PangoVariant:
+        PANGO_VARIANT_NORMAL
+        PANGO_VARIANT_SMALL_CAPS
+    ctypedef enum PangoWrapMode:
+        PANGO_WRAP_WORD
+        PANGO_WRAP_CHAR
+        PANGO_WRAP_WORD_CHAR
+    ctypedef enum PangoAlignment:
+        PANGO_ALIGN_LEFT
+        PANGO_ALIGN_CENTER
+        PANGO_ALIGN_RIGHT
+    PangoLayout* pango_cairo_create_layout(cairo_t* cr)
+    void pango_cairo_show_layout(
+        cairo_t* cr,
+        PangoLayout* layout
+    )
+    void pango_cairo_update_layout(
+        cairo_t* cr,
+        PangoLayout* layout
+    )
+    PangoFontDescription* pango_font_description_new()
+    void pango_font_description_set_size(
+        PangoFontDescription* desc,
+        gint size
+    )
+    void pango_font_description_set_family(
+        PangoFontDescription* desc,
+        const char* family
+    )
+    void pango_font_description_set_style(
+        PangoFontDescription* desc,
+        PangoStyle style
+    )
+    void pango_font_description_set_weight(
+        PangoFontDescription* desc,
+        PangoWeight weight
+    )
+    void pango_font_description_set_variant(
+        PangoFontDescription* desc,
+        PangoVariant variant
+    )
+
+    void pango_layout_set_width(
+        PangoLayout* layout,
+        int width
+    )
+    void pango_layout_set_font_description(
+        PangoLayout* layout,
+        const PangoFontDescription* desc
+    )
+    void pango_layout_set_text(
+        PangoLayout* layout,
+        const char* text,
+        int length
+    )
+    void pango_layout_set_wrap(
+        PangoLayout *layout,
+        PangoWrapMode wrap
+    )
+    void pango_layout_set_markup(
+        PangoLayout *layout,
+        const char *markup,
+        int length
+    )
+    void pango_layout_get_size(
+        PangoLayout* layout,
+        int* width,
+        int* height
+    )
+    const char* pango_version_string()
+    void pango_font_description_free(
+        PangoFontDescription *desc
+    )
+    gboolean pango_parse_markup(
+       const char *markup_text,
+       int length,
+       unsigned int accel_marker,
+       void* attr_list,
+       void* text,
+       void* accel_char,
+       void* error
+    )
+    PangoFontMap* pango_cairo_font_map_new()
+    void pango_font_map_list_families(
+        PangoFontMap *fontmap,
+        PangoFontFamily ***families,
+        int *n_families
+    )
+    PangoFontFamily* pango_font_map_get_family(
+        PangoFontMap *fontmap,
+        const char *name
+    )
+    const char* pango_font_family_get_name(
+        PangoFontFamily *family
+    )
+    void pango_layout_set_justify(
+        PangoLayout *layout,
+        gboolean justify
+    )
+    void pango_layout_set_indent(
+        PangoLayout *layout,
+        int indent
+    )
+    void pango_layout_set_alignment(
+        PangoLayout *layout,
+        PangoAlignment alignment
+    )
+    PangoFontMap* pango_context_get_font_map(
+        PangoContext* context
+    )
+    PangoContext* pango_layout_get_context(
+        PangoLayout* layout
+    )
+
+
+
+cdef extern from *:
+    """
+    #if _WIN32
+        #include <pango/pangowin32.h>
+    #endif
+    #if PANGO_VERSION_CHECK(1,44,0)
+        int set_line_width(PangoLayout *layout,float spacing)
+        {
+          pango_layout_set_line_spacing(layout, spacing);
+          return 1;
+        }
+    #else
+        int set_line_width(PangoLayout *layout,float spacing){return 0;}
+    #endif
+
+    #if _WIN32 && PANGO_VERSION_CHECK(1,52,0)
+        gboolean font_map_add_font_file(PangoFontMap *font_map,
+                                    const char   *font_file_path,
+                                    GError      **error)
+        {
+          return pango_win32_font_map_add_font_file(font_map, font_file_path, error);
+        }
+    #else
+        gboolean font_map_add_font_file(PangoFontMap *font_map,
+                                    const char   *font_file_path,
+                                    GError      **error)
+        {
+            return 1;
+        }
+    #endif
+
+    """
+    # The above docs string is C which is used to
+    # check for the Pango Version there at run time.
+    # pango_layout_set_line_spacing is only avaiable only for
+    # pango>=1.44.0 but we support pango>=1.30.0 that why this
+    # conditionals.
+    bint set_line_width(PangoLayout *layout,float spacing)
+
+    # only for windows and 1.52.0+
+    gboolean font_map_add_font_file(PangoFontMap *font_map,
+                                    const char   *font_file_path,
+                                    GError      **error)

manimpango/register_font.py

@@ -0,0 +1,156 @@
+# -*- coding: utf-8 -*-
+from __future__ import annotations
+
+from functools import lru_cache
+
+from ._register_font import (
+    RegisteredFont,
+    _fc_register_font,
+    _fc_unregister_font,
+    _list_fonts,
+    _register_font,
+    _unregister_font,
+)
+
+__all__ = [
+    "fc_register_font",
+    "fc_unregister_font",
+    "list_fonts",
+    "register_font",
+    "unregister_font",
+    "registered_fonts",
+    "RegisteredFont",
+]
+
+# An set of all registered font paths
+registered_fonts: set[RegisteredFont] = set()
+
+
+def fc_register_font(font_path: str) -> None:
+    """This function registers the font file using ``fontconfig`` so that
+    it is available for use by Pango. On Linux it is aliased to
+    :func:`register_font` and on Windows and macOS this would work only when
+    using ``fontconfig`` backend.
+
+    Parameters
+    ==========
+    font_path : :class:`str`
+        Relative or absolute path to font file.
+
+    Returns
+    =======
+    :class:`bool`
+            True means it worked without any error.
+            False means there was an unknown error
+
+    Examples
+    ========
+    >>> register_font("/home/roboto.tff")
+    True
+
+    Raises
+    ======
+    AssertionError
+        The :param:`font_path` specified doesn't exist.
+    """
+    return _fc_register_font(registered_fonts, font_path)
+
+
+def fc_unregister_font(font_path: str) -> None:
+    """This function unregister (removes) the font file using
+    ``fontconfig``. It is mostly optional to call this.
+    Mainly used in tests. On Linux it is aliased to
+    :func:`unregister_font` and on Windows and macOS this
+    would work only when using ``fontconfig`` backend.
+
+    Parameters
+    ==========
+    font_path: :class:`str`
+        For compatibility with the windows function.
+
+    Returns
+    =======
+    :class:`bool`
+            True means it worked without any error.
+            False means there was an unknown error
+
+    """
+    return _fc_unregister_font(registered_fonts, font_path)
+
+
+def register_font(font_path: str) -> None:
+    """This function registers the font file using native OS API
+    to make the font available for use by Pango. On Linux it is
+    aliased to :func:`fc_register_font` and on Windows and macOS
+    it uses the native API.
+
+    Parameters
+    ==========
+    font_path: :class:`str`
+        Relative or absolute path to font file.
+
+    Returns
+    =======
+    :class:`bool`
+            True means it worked without any error.
+            False means there was an unknown error
+
+    Examples
+    ========
+    >>> register_font("C:/home/roboto.tff")
+    True
+
+    Raises
+    ======
+    AssertionError
+        The :param:`font_path` specified doesn't exist.
+    """
+    return _register_font(registered_fonts, font_path)
+
+
+def unregister_font(font_path: str) -> None:
+    """This function unregister (removes) the font file using native OS API.
+    It is mostly optional to call this. Mainly used in tests. On Linux it is
+    aliased to :func:`fc_unregister_font` and on Windows and macOS it uses
+    the native API.
+
+    Parameters
+    ==========
+    font_path: :class:`str`
+        Relative or absolute path to font file.
+
+    Returns
+    =======
+    :class:`bool`
+            True means it worked without any error.
+            False means there was an unknown error
+
+    Examples
+    ========
+    >>> unregister_font("C:/home/roboto.tff")
+    True
+
+    Raises
+    ======
+    AssertionError
+        The :param:`font_path` specified doesn't exist.
+
+    """
+    return _unregister_font(registered_fonts, font_path)
+
+
+def list_fonts() -> list:
+    """Lists the fonts available to Pango.
+    This is usually same as system fonts but it also
+    includes the fonts added through :func:`register_font`
+    or :func:`fc_register_font`.
+
+    Returns
+    -------
+
+    :class:`list` :
+        List of fonts sorted alphabetically.
+    """
+    return lru_cache(maxsize=None)(_list_fonts)(
+        tuple(sorted(registered_fonts, key=lambda x: x.path))
+    )

manimpango/utils.py

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+import re
+
+from .enums import Style, Weight
+
+
+class PangoUtils:
+    @staticmethod
+    def str2style(string: str) -> Style:
+        """Internally used function. Converts text to Pango Understandable Styles."""
+        styles = {
+            "NORMAL": Style.NORMAL,
+            "ITALIC": Style.ITALIC,
+            "OBLIQUE": Style.OBLIQUE,
+        }
+        try:
+            return styles[string]
+        except KeyError:
+            raise AttributeError("There is no Style Called %s" % string)
+
+    @staticmethod
+    def str2weight(string: str) -> Weight:
+        """Internally used function. Convert text to Pango Understandable Weight"""
+        weights = {
+            "NORMAL": Weight.NORMAL,
+            "BOLD": Weight.BOLD,
+            "THIN": Weight.THIN,
+            "ULTRALIGHT": Weight.ULTRALIGHT,
+            "LIGHT": Weight.LIGHT,
+            "BOOK": Weight.BOOK,
+            "MEDIUM": Weight.MEDIUM,
+            "SEMIBOLD": Weight.SEMIBOLD,
+            "ULTRABOLD": Weight.ULTRABOLD,
+            "HEAVY": Weight.HEAVY,
+            "ULTRAHEAVY": Weight.ULTRAHEAVY,
+        }
+        try:
+            return weights[string]
+        except KeyError:
+            raise AttributeError("There is no Font Weight Called %s" % string)
+
+    @staticmethod
+    def remove_last_M(file_name: str) -> None:
+        """Remove element from the SVG file in order to allow comparison."""
+        with open(file_name, "r") as fpr:
+            content = fpr.read()
+        content = re.sub(r'Z M [^A-Za-z]*? "\/>', 'Z "/>', content)
+        with open(file_name, "w") as fpw:
+            fpw.write(content)