scintilla/gtk/Wrappers.h

   1 // Scintilla source code edit control
   2 // Wrappers.h - Encapsulation of GLib, GObject, Pango, Cairo, GTK, and GDK types
   3 // Copyright 2022 by Neil Hodgson <neilh@scintilla.org>
   4 // The License.txt file describes the conditions under which this software may be distributed.
   5
   6 #ifndef WRAPPERS_H
   7 #define WRAPPERS_H
   8
   9 namespace Scintilla::Internal {
  10
  11 // GLib
  12
  13 struct GFreeReleaser {
  14         template <class T>
  15         void operator()(T *object) noexcept {
  16                 g_free(object);
  17         }
  18 };
  19
  20 using UniqueStr = std::unique_ptr<gchar, GFreeReleaser>;
  21
  22 // GObject
  23
  24 struct GObjectReleaser {
  25         // Called by unique_ptr to destroy/free the object
  26         template <class T>
  27         void operator()(T *object) noexcept {
  28                 g_object_unref(object);
  29         }
  30 };
  31
  32 // Pango
  33
  34 using UniquePangoContext = std::unique_ptr<PangoContext, GObjectReleaser>;
  35 using UniquePangoLayout = std::unique_ptr<PangoLayout, GObjectReleaser>;
  36 using UniquePangoFontMap = std::unique_ptr<PangoFontMap, GObjectReleaser>;
  37
  38 struct FontDescriptionReleaser {
  39         void operator()(PangoFontDescription *fontDescription) noexcept {
  40                 pango_font_description_free(fontDescription);
  41         }
  42 };
  43
  44 using UniquePangoFontDescription = std::unique_ptr<PangoFontDescription, FontDescriptionReleaser>;
  45
  46 struct FontMetricsReleaser {
  47         void operator()(PangoFontMetrics *metrics) noexcept {
  48                 pango_font_metrics_unref(metrics);
  49         }
  50 };
  51
  52 using UniquePangoFontMetrics = std::unique_ptr<PangoFontMetrics, FontMetricsReleaser>;
  53
  54 struct LayoutIterReleaser {
  55         // Called by unique_ptr to destroy/free the object
  56         void operator()(PangoLayoutIter *iter) noexcept {
  57                 pango_layout_iter_free(iter);
  58         }
  59 };
  60
  61 using UniquePangoLayoutIter = std::unique_ptr<PangoLayoutIter, LayoutIterReleaser>;
  62
  63 // Cairo
  64
  65 struct CairoReleaser {
  66         void operator()(cairo_t *context) noexcept {
  67                 cairo_destroy(context);
  68         }
  69 };
  70
  71 using UniqueCairo = std::unique_ptr<cairo_t, CairoReleaser>;
  72
  73 struct CairoSurfaceReleaser {
  74         void operator()(cairo_surface_t *psurf) noexcept {
  75                 cairo_surface_destroy(psurf);
  76         }
  77 };
  78
  79 using UniqueCairoSurface = std::unique_ptr<cairo_surface_t, CairoSurfaceReleaser>;
  80
  81 // GTK
  82
  83 using UniqueIMContext = std::unique_ptr<GtkIMContext, GObjectReleaser>;
  84
  85 // GDK
  86
  87 struct GdkEventReleaser {
  88         void operator()(GdkEvent *ev) noexcept {
  89                 gdk_event_free(ev);
  90         }
  91 };
  92
  93 using UniqueGdkEvent = std::unique_ptr<GdkEvent, GdkEventReleaser>;
  94
  95 inline void UnRefCursor(GdkCursor *cursor) noexcept {
  96 #if GTK_CHECK_VERSION(3,0,0)
  97         g_object_unref(cursor);
  98 #else
  99         gdk_cursor_unref(cursor);
 100 #endif
 101 }
 102
 103 [[nodiscard]] inline GdkWindow *WindowFromWidget(GtkWidget *w) noexcept {
 104         return gtk_widget_get_window(w);
 105 }
 106
 107 }
 108
 109 #endif