emacs/src/xwidget.h

244 lines
6.6 KiB
Objective-C

/* Support for embedding graphical components in a buffer.
Copyright (C) 2011-2024 Free Software Foundation, Inc.
This file is part of GNU Emacs.
GNU Emacs is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.
GNU Emacs 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
#ifndef XWIDGET_H_INCLUDED
#define XWIDGET_H_INCLUDED
#include "lisp.h"
struct glyph_matrix;
struct glyph_string;
struct xwidget;
struct xwidget_view;
struct window;
#ifdef HAVE_XWIDGETS
#if defined (USE_GTK)
#include <gtk/gtk.h>
#ifndef HAVE_PGTK
#include <X11/Xlib.h>
#include "xterm.h"
#else
#include "pgtkterm.h"
#endif
#elif defined (NS_IMPL_COCOA) && defined (__OBJC__)
#import <AppKit/NSView.h>
#import "nsxwidget.h"
#endif
#ifdef HAVE_XINPUT2
#include <X11/extensions/XInput2.h>
#endif
struct xwidget
{
union vectorlike_header header;
/* Auxiliary data. */
Lisp_Object plist;
/* The widget type. */
Lisp_Object type;
/* The buffer where the xwidget lives. */
Lisp_Object buffer;
/* A title used for button labels, for instance. */
Lisp_Object title;
/* Vector of currently executing scripts with callbacks. */
Lisp_Object script_callbacks;
/* Here ends the Lisp part. script_callbacks is the marker field. */
int height;
int width;
uint32_t xwidget_id;
char *find_text;
#if defined (USE_GTK)
/* For offscreen widgets, unused if not osr. */
GtkWidget *widget_osr;
GtkWidget *widgetwindow_osr;
struct frame *embedder;
struct xwidget_view *embedder_view;
guint hit_result;
#elif defined (NS_IMPL_COCOA)
# ifdef __OBJC__
/* For offscreen widgets, unused if not osr. */
NSView *xwWidget;
XwWindow *xwWindow;
/* Used only for xwidget types (such as webkit2) enforcing 1 to 1
relationship between model and view. */
struct xwidget_view *xv;
# else
void *xwWidget;
void *xwWindow;
struct xwidget_view *xv;
# endif
#endif
/* Kill silently if Emacs is exited. */
bool_bf kill_without_query : 1;
} GCALIGNED_STRUCT;
struct xwidget_view
{
union vectorlike_header header;
Lisp_Object model;
Lisp_Object w;
/* Here ends the lisp part. "w" is the marker field. */
/* If touched by redisplay. */
bool redisplayed;
/* The "live" instance isn't drawn. */
bool hidden;
enum glyph_row_area area;
#if defined (USE_GTK)
#ifndef HAVE_PGTK
Display *dpy;
Window wdesc;
GdkWindow *last_crossing_window;
guint last_crossing_cursor_signal;
GtkWidget *passive_grab;
guint passive_grab_destruction_signal;
guint passive_grab_drag_signal;
#else
struct pgtk_display_info *dpyinfo;
GtkWidget *widget;
#endif
Emacs_Cursor cursor;
struct frame *frame;
cairo_surface_t *cr_surface;
cairo_t *cr_context;
int just_resized;
#elif defined (NS_IMPL_COCOA)
# ifdef __OBJC__
XvWindow *xvWindow;
NSView *emacswindow;
# else
void *xvWindow;
void *emacswindow;
# endif
#endif
int x;
int y;
int clip_right;
int clip_bottom;
int clip_top;
int clip_left;
long handler_id;
} GCALIGNED_STRUCT;
#endif
/* Test for xwidget pseudovector. */
#define XWIDGETP(x) PSEUDOVECTORP (x, PVEC_XWIDGET)
#define XXWIDGET(a) (eassert (XWIDGETP (a)), \
XUNTAG (a, Lisp_Vectorlike, struct xwidget))
#define XWIDGET_LIVE_P(w) (!NILP ((w)->buffer))
#define CHECK_XWIDGET(x) \
CHECK_TYPE (XWIDGETP (x), Qxwidgetp, x)
#define CHECK_LIVE_XWIDGET(x) \
CHECK_TYPE ((XWIDGETP (x) \
&& XWIDGET_LIVE_P (XXWIDGET (x))), \
Qxwidget_live_p, x)
/* Test for xwidget_view pseudovector. */
#define XWIDGET_VIEW_P(x) PSEUDOVECTORP (x, PVEC_XWIDGET_VIEW)
#define XXWIDGET_VIEW(a) (eassert (XWIDGET_VIEW_P (a)), \
XUNTAG (a, Lisp_Vectorlike, struct xwidget_view))
#define CHECK_XWIDGET_VIEW(x) \
CHECK_TYPE (XWIDGET_VIEW_P (x), Qxwidget_view_p, x)
#define XG_XWIDGET "emacs_xwidget"
#define XG_XWIDGET_VIEW "emacs_xwidget_view"
#ifdef HAVE_XWIDGETS
void syms_of_xwidget (void);
bool valid_xwidget_spec_p (Lisp_Object);
void xwidget_view_delete_all_in_window (struct window *);
void x_draw_xwidget_glyph_string (struct glyph_string *);
struct xwidget *lookup_xwidget (Lisp_Object spec);
void xwidget_end_redisplay (struct window *, struct glyph_matrix *);
void kill_buffer_xwidgets (Lisp_Object);
/* Defined in 'xwidget.c'. */
void store_xwidget_event_string (struct xwidget *xw,
const char *eventname,
const char *eventstr);
void store_xwidget_download_callback_event (struct xwidget *xw,
const char *url,
const char *mimetype,
const char *filename);
void store_xwidget_js_callback_event (struct xwidget *xw,
Lisp_Object proc,
Lisp_Object argument);
extern struct xwidget *xwidget_from_id (uint32_t id);
#ifdef HAVE_X_WINDOWS
struct xwidget_view *xwidget_view_from_window (Window wdesc);
void xwidget_expose (struct xwidget_view *xv);
extern void lower_frame_xwidget_views (struct frame *f);
#endif
#ifndef NS_IMPL_COCOA
extern void kill_frame_xwidget_views (struct frame *f);
#endif
#ifdef HAVE_X_WINDOWS
extern void xwidget_button (struct xwidget_view *, bool, int,
int, int, int, Time);
extern void xwidget_motion_or_crossing (struct xwidget_view *,
const XEvent *);
#ifdef HAVE_XINPUT2
extern void xwidget_motion_notify (struct xwidget_view *, double,
double, double, double, uint, Time);
extern void xwidget_scroll (struct xwidget_view *, double, double,
double, double, uint, Time, bool);
#ifdef HAVE_XINPUT2_4
extern void xwidget_pinch (struct xwidget_view *, XIGesturePinchEvent *);
#endif
#endif
#endif
#else
INLINE_HEADER_BEGIN
INLINE void syms_of_xwidget (void) {}
INLINE bool valid_xwidget_spec_p (Lisp_Object obj) { return false; }
INLINE void xwidget_view_delete_all_in_window (struct window *w) {}
INLINE void x_draw_xwidget_glyph_string (struct glyph_string *s) { eassume (0); }
INLINE struct xwidget *lookup_xwidget (Lisp_Object obj) { eassume (0); }
INLINE void xwidget_end_redisplay (struct window *w, struct glyph_matrix *m) {}
INLINE void kill_buffer_xwidgets (Lisp_Object buf) {}
INLINE_HEADER_END
#endif
#endif /* XWIDGET_H_INCLUDED */