354 lines
13 KiB
Java
354 lines
13 KiB
Java
/* Communication module for Android terminals. -*- c-file-style: "GNU" -*-
|
||
|
||
Copyright (C) 2023-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/>. */
|
||
|
||
package org.gnu.emacs;
|
||
|
||
import android.content.res.AssetManager;
|
||
|
||
import android.graphics.Bitmap;
|
||
|
||
import android.view.inputmethod.ExtractedText;
|
||
import android.view.inputmethod.ExtractedTextRequest;
|
||
import android.view.inputmethod.SurroundingText;
|
||
import android.view.inputmethod.TextAttribute;
|
||
import android.view.inputmethod.TextSnapshot;
|
||
|
||
public final class EmacsNative
|
||
{
|
||
/* List of native libraries that must be loaded during class
|
||
initialization. */
|
||
private static final String[] libraryDeps;
|
||
|
||
|
||
/* Obtain the fingerprint of this build of Emacs. The fingerprint
|
||
can be used to determine the dump file name. */
|
||
public static native String getFingerprint ();
|
||
|
||
/* Set certain parameters before initializing Emacs.
|
||
|
||
assetManager must be the asset manager associated with the
|
||
context that is loading Emacs. It is saved and remains for the
|
||
remainder the lifetime of the Emacs process.
|
||
|
||
filesDir must be the package's data storage location for the
|
||
current Android user.
|
||
|
||
libDir must be the package's data storage location for native
|
||
libraries. It is used as PATH.
|
||
|
||
cacheDir must be the package's cache directory. It is used as
|
||
the `temporary-file-directory'.
|
||
|
||
pixelDensityX and pixelDensityY are the DPI values that will be
|
||
used by Emacs.
|
||
|
||
scaledDensity is the DPI value used to translate point sizes to
|
||
pixel sizes when loading fonts.
|
||
|
||
classPath must be the classpath of this app_process process, or
|
||
NULL.
|
||
|
||
emacsService must be the EmacsService singleton, or NULL.
|
||
|
||
apiLevel is the version of Android being run. */
|
||
public static native void setEmacsParams (AssetManager assetManager,
|
||
String filesDir,
|
||
String libDir,
|
||
String cacheDir,
|
||
float pixelDensityX,
|
||
float pixelDensityY,
|
||
float scaledDensity,
|
||
String classPath,
|
||
EmacsService emacsService,
|
||
int apiLevel);
|
||
|
||
/* Initialize Emacs with the argument array ARGV. Each argument
|
||
must contain a NULL terminated string, or else the behavior is
|
||
undefined.
|
||
|
||
DUMPFILE is the dump file to use, or NULL if Emacs is to load
|
||
loadup.el itself. */
|
||
public static native void initEmacs (String argv[], String dumpFile);
|
||
|
||
/* Call shut_down_emacs to auto-save and unlock files in the main
|
||
thread, then return. */
|
||
public static native void shutDownEmacs ();
|
||
|
||
/* Garbage collect and clear each frame's image cache. */
|
||
public static native void onLowMemory ();
|
||
|
||
/* Abort and generate a native core dump. */
|
||
public static native void emacsAbort ();
|
||
|
||
/* Set Vquit_flag to t, resulting in Emacs quitting as soon as
|
||
possible. */
|
||
public static native void quit ();
|
||
|
||
/* Send an ANDROID_CONFIGURE_NOTIFY event. The values of all the
|
||
functions below are the serials of the events sent. */
|
||
public static native long sendConfigureNotify (long window, long time,
|
||
int x, int y, int width,
|
||
int height);
|
||
|
||
/* Send an ANDROID_KEY_PRESS event. */
|
||
public static native long sendKeyPress (long window, long time, int state,
|
||
int keyCode, int unicodeChar);
|
||
|
||
/* Send an ANDROID_KEY_RELEASE event. */
|
||
public static native long sendKeyRelease (long window, long time, int state,
|
||
int keyCode, int unicodeChar);
|
||
|
||
/* Send an ANDROID_FOCUS_IN event. */
|
||
public static native long sendFocusIn (long window, long time);
|
||
|
||
/* Send an ANDROID_FOCUS_OUT event. */
|
||
public static native long sendFocusOut (long window, long time);
|
||
|
||
/* Send an ANDROID_WINDOW_ACTION event. */
|
||
public static native long sendWindowAction (long window, int action);
|
||
|
||
/* Send an ANDROID_ENTER_NOTIFY event. */
|
||
public static native long sendEnterNotify (long window, int x, int y,
|
||
long time);
|
||
|
||
/* Send an ANDROID_LEAVE_NOTIFY event. */
|
||
public static native long sendLeaveNotify (long window, int x, int y,
|
||
long time);
|
||
|
||
/* Send an ANDROID_MOTION_NOTIFY event. */
|
||
public static native long sendMotionNotify (long window, int x, int y,
|
||
long time);
|
||
|
||
/* Send an ANDROID_BUTTON_PRESS event. */
|
||
public static native long sendButtonPress (long window, int x, int y,
|
||
long time, int state,
|
||
int button);
|
||
|
||
/* Send an ANDROID_BUTTON_RELEASE event. */
|
||
public static native long sendButtonRelease (long window, int x, int y,
|
||
long time, int state,
|
||
int button);
|
||
|
||
/* Send an ANDROID_TOUCH_DOWN event. */
|
||
public static native long sendTouchDown (long window, int x, int y,
|
||
long time, int pointerID,
|
||
int flags);
|
||
|
||
/* Send an ANDROID_TOUCH_UP event. */
|
||
public static native long sendTouchUp (long window, int x, int y,
|
||
long time, int pointerID,
|
||
int flags);
|
||
|
||
/* Send an ANDROID_TOUCH_MOVE event. */
|
||
public static native long sendTouchMove (long window, int x, int y,
|
||
long time, int pointerID,
|
||
int flags);
|
||
|
||
/* Send an ANDROID_WHEEL event. */
|
||
public static native long sendWheel (long window, int x, int y,
|
||
long time, int state,
|
||
float xDelta, float yDelta);
|
||
|
||
/* Send an ANDROID_ICONIFIED event. */
|
||
public static native long sendIconified (long window);
|
||
|
||
/* Send an ANDROID_DEICONIFIED event. */
|
||
public static native long sendDeiconified (long window);
|
||
|
||
/* Send an ANDROID_CONTEXT_MENU event. */
|
||
public static native long sendContextMenu (long window, int menuEventID,
|
||
int menuEventSerial);
|
||
|
||
/* Send an ANDROID_EXPOSE event. */
|
||
public static native long sendExpose (long window, int x, int y,
|
||
int width, int height);
|
||
|
||
/* Send an ANDROID_DND_DRAG event. */
|
||
public static native long sendDndDrag (long window, int x, int y);
|
||
|
||
/* Send an ANDROID_DND_URI event. */
|
||
public static native long sendDndUri (long window, int x, int y,
|
||
String text);
|
||
|
||
/* Send an ANDROID_DND_TEXT event. */
|
||
public static native long sendDndText (long window, int x, int y,
|
||
String text);
|
||
|
||
/* Send an ANDROID_NOTIFICATION_CANCELED event. */
|
||
public static native void sendNotificationDeleted (String tag);
|
||
|
||
/* Send an ANDROID_NOTIFICATION_ACTION event. */
|
||
public static native void sendNotificationAction (String tag, String action);
|
||
|
||
/* Return the file name associated with the specified file
|
||
descriptor, or NULL if there is none. */
|
||
public static native byte[] getProcName (int fd);
|
||
|
||
/* Notice that the Emacs thread will now start waiting for the main
|
||
thread's looper to respond. */
|
||
public static native void beginSynchronous ();
|
||
|
||
/* Notice that the Emacs thread will has finished waiting for the
|
||
main thread's looper to respond. */
|
||
public static native void endSynchronous ();
|
||
|
||
/* Prevent deadlocks while reliably allowing queries from the Emacs
|
||
thread to the main thread to complete by waiting for a query to
|
||
start from the main thread, then answer it; assume that a query
|
||
is certain to start shortly. */
|
||
public static native void answerQuerySpin ();
|
||
|
||
/* Return whether or not KEYCODE_VOLUME_DOWN, KEYCODE_VOLUME_UP and
|
||
KEYCODE_VOLUME_MUTE should be forwarded to Emacs. */
|
||
public static native boolean shouldForwardMultimediaButtons ();
|
||
|
||
/* Return whether KEYCODE_SPACE combined with META_CTRL_MASK should
|
||
be prevented from reaching the system input method. */
|
||
public static native boolean shouldForwardCtrlSpace ();
|
||
|
||
/* Return the keycode repeated activation of which should signal
|
||
quit. */
|
||
public static native int getQuitKeycode ();
|
||
|
||
/* Initialize the current thread, by blocking signals that do not
|
||
interest it. */
|
||
public static native void setupSystemThread ();
|
||
|
||
|
||
|
||
/* Input connection functions. These mostly correspond to their
|
||
counterparts in Android's InputConnection. */
|
||
|
||
public static native void beginBatchEdit (long window);
|
||
public static native void endBatchEdit (long window);
|
||
public static native void commitCompletion (long window, String text,
|
||
int position);
|
||
public static native void commitText (long window, String text,
|
||
int position);
|
||
public static native void deleteSurroundingText (long window,
|
||
int leftLength,
|
||
int rightLength);
|
||
public static native void finishComposingText (long window);
|
||
public static native void replaceText (long window, int start, int end,
|
||
String text, int newCursorPosition,
|
||
TextAttribute attributes);
|
||
public static native String getSelectedText (long window, int flags);
|
||
public static native String getTextAfterCursor (long window, int length,
|
||
int flags);
|
||
public static native String getTextBeforeCursor (long window, int length,
|
||
int flags);
|
||
public static native void setComposingText (long window, String text,
|
||
int newCursorPosition);
|
||
public static native void setComposingRegion (long window, int start,
|
||
int end);
|
||
public static native void setSelection (long window, int start, int end);
|
||
public static native void performEditorAction (long window,
|
||
int editorAction);
|
||
public static native void performContextMenuAction (long window,
|
||
int contextMenuAction);
|
||
public static native ExtractedText getExtractedText (long window,
|
||
ExtractedTextRequest req,
|
||
int flags);
|
||
public static native void requestSelectionUpdate (long window);
|
||
public static native void requestCursorUpdates (long window, int mode);
|
||
public static native void clearInputFlags (long window);
|
||
public static native SurroundingText getSurroundingText (long window,
|
||
int left, int right,
|
||
int flags);
|
||
public static native TextSnapshot takeSnapshot (long window);
|
||
|
||
|
||
/* Return the current value of the selection, or -1 upon
|
||
failure. */
|
||
public static native int[] getSelection (long window);
|
||
|
||
|
||
/* Graphics functions used as replacements for potentially buggy
|
||
Android APIs. */
|
||
|
||
public static native void blitRect (Bitmap src, Bitmap dest, int x1,
|
||
int y1, int x2, int y2);
|
||
|
||
/* Increment the generation ID of the specified BITMAP, forcing its
|
||
texture to be re-uploaded to the GPU. */
|
||
public static native void notifyPixelsChanged (Bitmap bitmap);
|
||
|
||
|
||
/* Functions used to synchronize document provider access with the
|
||
main thread. */
|
||
|
||
/* Wait for a call to `safPostRequest' while also reading async
|
||
input.
|
||
|
||
If asynchronous input arrives and sets Vquit_flag, return 1. */
|
||
public static native int safSyncAndReadInput ();
|
||
|
||
/* Wait for a call to `safPostRequest'. */
|
||
public static native void safSync ();
|
||
|
||
/* Post the semaphore used to await the completion of SAF
|
||
operations. */
|
||
public static native void safPostRequest ();
|
||
|
||
/* Detect and return FD is writable. FD may be truncated to 0 bytes
|
||
in the process. */
|
||
public static native boolean ftruncate (int fd);
|
||
|
||
|
||
/* Functions that assist in generating content file names. */
|
||
|
||
/* Calculate an 8 digit checksum for the byte array DISPLAYNAME
|
||
suitable for inclusion in a content file name. */
|
||
public static native String displayNameHash (byte[] displayName);
|
||
|
||
static
|
||
{
|
||
/* A library search path misconfiguration prevents older versions of
|
||
Android from successfully loading application shared libraries
|
||
unless all requisite shared libraries provided by the application
|
||
are explicitly loaded from Java. The build process arranges that
|
||
EmacsConfig.EMACS_SHARED_LIBRARIES hold the names of each of
|
||
these libraries in the correct order, so load them now. */
|
||
|
||
libraryDeps = EmacsConfig.EMACS_SHARED_LIBRARIES;
|
||
|
||
for (String dependency : libraryDeps)
|
||
{
|
||
/* Remove the "lib" prefix, if any. */
|
||
if (dependency.startsWith ("lib"))
|
||
dependency = dependency.substring (3);
|
||
|
||
/* If this library is provided by the operating system, don't
|
||
link to it. */
|
||
if (dependency.equals ("z")
|
||
|| dependency.equals ("c")
|
||
|| dependency.equals ("m")
|
||
|| dependency.equals ("dl")
|
||
|| dependency.equals ("log")
|
||
|| dependency.equals ("android"))
|
||
continue;
|
||
|
||
System.loadLibrary (dependency);
|
||
}
|
||
|
||
/* At this point, it should be alright to load Emacs. */
|
||
System.loadLibrary ("emacs");
|
||
};
|
||
};
|