summaryrefslogtreecommitdiff
path: root/pango/pangofc-fontmap-private.h
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2019-07-04 20:36:00 +0000
committerMatthias Clasen <mclasen@redhat.com>2019-07-04 17:28:40 -0400
commitd21ea13a22b1cab8c9cb604aa3fcd2ca8073befd (patch)
tree8d79daeb8f4254e319fede8bcc970f80cec83a2a /pango/pangofc-fontmap-private.h
parent5112387e2c5d4e298d5781070b2f0749a2f7f005 (diff)
downloadpango-d21ea13a22b1cab8c9cb604aa3fcd2ca8073befd.tar.gz
Header cleanup
Abolish the PANGO_ENABLE_BACKEND and PANGO_ENABLE_ENGINE defines. All backend-only apis are moved into private headers, all apis that were engine-only are marked as deprecated, since engines are.
Diffstat (limited to 'pango/pangofc-fontmap-private.h')
-rw-r--r--pango/pangofc-fontmap-private.h194
1 files changed, 194 insertions, 0 deletions
diff --git a/pango/pangofc-fontmap-private.h b/pango/pangofc-fontmap-private.h
new file mode 100644
index 00000000..4d8d8c59
--- /dev/null
+++ b/pango/pangofc-fontmap-private.h
@@ -0,0 +1,194 @@
+/* Pango
+ * pangofc-fontmap.h: Base fontmap type for fontconfig-based backends
+ *
+ * Copyright (C) 2003 Red Hat Software
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#ifndef __PANGO_FC_FONT_MAP_PRIVATE_H__
+#define __PANGO_FC_FONT_MAP_PRIVATE_H__
+
+#include <pango/pangofc-fontmap.h>
+#include <pango/pangofc-decoder.h>
+#include <pango/pangofc-font-private.h>
+#include <pango/pango-fontmap-private.h>
+#include <pango/pango-fontset-private.h>
+
+#include <fontconfig/fontconfig.h>
+
+G_BEGIN_DECLS
+
+
+/**
+ * PangoFcFontsetKey:
+ *
+ * An opaque structure containing all the information needed for
+ * loading a fontset with the PangoFc fontmap.
+ *
+ * Since: 1.24
+ **/
+typedef struct _PangoFcFontsetKey PangoFcFontsetKey;
+
+PANGO_AVAILABLE_IN_1_24
+PangoLanguage *pango_fc_fontset_key_get_language (const PangoFcFontsetKey *key);
+PANGO_AVAILABLE_IN_1_24
+const PangoFontDescription *pango_fc_fontset_key_get_description (const PangoFcFontsetKey *key);
+PANGO_AVAILABLE_IN_1_24
+const PangoMatrix *pango_fc_fontset_key_get_matrix (const PangoFcFontsetKey *key);
+PANGO_AVAILABLE_IN_1_24
+double pango_fc_fontset_key_get_absolute_size (const PangoFcFontsetKey *key);
+PANGO_AVAILABLE_IN_1_24
+double pango_fc_fontset_key_get_resolution (const PangoFcFontsetKey *key);
+PANGO_AVAILABLE_IN_1_24
+gpointer pango_fc_fontset_key_get_context_key (const PangoFcFontsetKey *key);
+
+/**
+ * PangoFcFontKey:
+ *
+ * An opaque structure containing all the information needed for
+ * loading a font with the PangoFc fontmap.
+ *
+ * Since: 1.24
+ **/
+typedef struct _PangoFcFontKey PangoFcFontKey;
+
+PANGO_AVAILABLE_IN_1_24
+const FcPattern *pango_fc_font_key_get_pattern (const PangoFcFontKey *key);
+PANGO_AVAILABLE_IN_1_24
+const PangoMatrix *pango_fc_font_key_get_matrix (const PangoFcFontKey *key);
+PANGO_AVAILABLE_IN_1_24
+gpointer pango_fc_font_key_get_context_key (const PangoFcFontKey *key);
+PANGO_AVAILABLE_IN_1_40
+const char *pango_fc_font_key_get_variations (const PangoFcFontKey *key);
+
+
+#define PANGO_FC_FONT_MAP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PANGO_TYPE_FC_FONT_MAP, PangoFcFontMapClass))
+#define PANGO_IS_FC_FONT_MAP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PANGO_TYPE_FC_FONT_MAP))
+#define PANGO_FC_FONT_MAP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PANGO_TYPE_FC_FONT_MAP, PangoFcFontMapClass))
+
+/**
+ * PangoFcFontMap:
+ *
+ * #PangoFcFontMap is a base class for font map implementations
+ * using the Fontconfig and FreeType libraries. To create a new
+ * backend using Fontconfig and FreeType, you derive from this class
+ * and implement a new_font() virtual function that creates an
+ * instance deriving from #PangoFcFont.
+ **/
+struct _PangoFcFontMap
+{
+ PangoFontMap parent_instance;
+
+ PangoFcFontMapPrivate *priv;
+};
+
+/**
+ * PangoFcFontMapClass:
+ * @default_substitute: (nullable): Substitutes in default
+ * values for unspecified fields in a #FcPattern. This will
+ * be called prior to creating a font for the pattern. May be
+ * %NULL. Deprecated in favor of @font_key_substitute().
+ * @new_font: Creates a new #PangoFcFont for the specified
+ * pattern of the appropriate type for this font map. The
+ * @pattern argument must be passed to the "pattern" property
+ * of #PangoFcFont when you call g_object_new(). Deprecated
+ * in favor of @create_font().
+ * @get_resolution: Gets the resolution (the scale factor
+ * between logical and absolute font sizes) that the backend
+ * will use for a particular fontmap and context. @context
+ * may be null.
+ * @context_key_get: Gets an opaque key holding backend
+ * specific options for the context that will affect
+ * fonts created by @create_font(). The result must point to
+ * persistant storage owned by the fontmap. This key
+ * is used to index hash tables used to look up fontsets
+ * and fonts.
+ * @context_key_copy: Copies a context key. Pango uses this
+ * to make a persistant copy of the value returned from
+ * @context_key_get.
+ * @context_key_free: Frees a context key copied with
+ * @context_key_copy.
+ * @context_key_hash: Gets a hash value for a context key
+ * @context_key_equal: Compares two context keys for equality.
+ * @fontset_key_substitute: (nullable): Substitutes in
+ * default values for unspecified fields in a
+ * #FcPattern. This will be called prior to creating a font
+ * for the pattern. May be %NULL. (Since: 1.24)
+ * @create_font: (nullable): Creates a new #PangoFcFont for
+ * the specified pattern of the appropriate type for this
+ * font map using information from the font key that is
+ * passed in. The @pattern member of @font_key can be
+ * retrieved using pango_fc_font_key_get_pattern() and must
+ * be passed to the "pattern" property of #PangoFcFont when
+ * you call g_object_new(). If %NULL, new_font() is used.
+ * (Since: 1.24)
+ *
+ * Class structure for #PangoFcFontMap.
+ **/
+struct _PangoFcFontMapClass
+{
+ /*< private >*/
+ PangoFontMapClass parent_class;
+
+ /*< public >*/
+ /* Deprecated in favor of fontset_key_substitute */
+ void (*default_substitute) (PangoFcFontMap *fontmap,
+ FcPattern *pattern);
+ /* Deprecated in favor of create_font */
+ PangoFcFont *(*new_font) (PangoFcFontMap *fontmap,
+ FcPattern *pattern);
+
+ double (*get_resolution) (PangoFcFontMap *fcfontmap,
+ PangoContext *context);
+
+ gconstpointer (*context_key_get) (PangoFcFontMap *fcfontmap,
+ PangoContext *context);
+ gpointer (*context_key_copy) (PangoFcFontMap *fcfontmap,
+ gconstpointer key);
+ void (*context_key_free) (PangoFcFontMap *fcfontmap,
+ gpointer key);
+ guint32 (*context_key_hash) (PangoFcFontMap *fcfontmap,
+ gconstpointer key);
+ gboolean (*context_key_equal) (PangoFcFontMap *fcfontmap,
+ gconstpointer key_a,
+ gconstpointer key_b);
+ void (*fontset_key_substitute)(PangoFcFontMap *fontmap,
+
+ PangoFcFontsetKey *fontsetkey,
+ FcPattern *pattern);
+ PangoFcFont *(*create_font) (PangoFcFontMap *fontmap,
+ PangoFcFontKey *fontkey);
+ /*< private >*/
+
+ /* Padding for future expansion */
+ void (*_pango_reserved1) (void);
+ void (*_pango_reserved2) (void);
+ void (*_pango_reserved3) (void);
+ void (*_pango_reserved4) (void);
+};
+
+#ifndef PANGO_DISABLE_DEPRECATED
+PANGO_DEPRECATED_IN_1_22_FOR(pango_font_map_create_context)
+PangoContext * pango_fc_font_map_create_context (PangoFcFontMap *fcfontmap);
+#endif
+PANGO_AVAILABLE_IN_1_4
+void pango_fc_font_map_shutdown (PangoFcFontMap *fcfontmap);
+
+
+G_END_DECLS
+
+#endif /* __PANGO_FC_FONT_MAP_PRIVATE_H__ */