capacitor-sora-editor 1.0.10 → 1.2.1

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/annotations/InvalidateRequired.java

@@ -0,0 +1,40 @@
+/*
+ *    sora-editor - the awesome code editor for Android
+ *    https://github.com/abc15018045126/sora-editor
+ *    Copyright (C) 2020-2024  abc15018045126
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation; either
+ *     version 2.1 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
+ *     Lesser General Public License for more details.
+ *
+ *     You should have received a copy of the GNU Lesser General Public
+ *     License along with this library; if not, write to the Free Software
+ *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ *     USA
+ *
+ *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     additional information or have any questions
+ */
+package io.github.abc15018045126.sora.annotations;
+
+import android.view.View;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks you must call {@link View#invalidate()} after changing this property
+ */
+@Retention(RetentionPolicy.CLASS)
+@Target({ElementType.FIELD})
+public @interface InvalidateRequired {
+}
+

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/annotations/UnsupportedUserUsage.java

@@ -0,0 +1,39 @@
+/*
+ *    sora-editor - the awesome code editor for Android
+ *    https://github.com/abc15018045126/sora-editor
+ *    Copyright (C) 2020-2024  abc15018045126
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation; either
+ *     version 2.1 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
+ *     Lesser General Public License for more details.
+ *
+ *     You should have received a copy of the GNU Lesser General Public
+ *     License along with this library; if not, write to the Free Software
+ *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ *     USA
+ *
+ *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     additional information or have any questions
+ */
+package io.github.abc15018045126.sora.annotations;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * Marks that this member is internally used and that it is not recommended using this
+ * member at your side.
+ */
+@Retention(RetentionPolicy.CLASS)
+@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.TYPE})
+public @interface UnsupportedUserUsage {
+}
+

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/event/ClickEvent.java

@@ -0,0 +1,49 @@
+/*
+ *    sora-editor - the awesome code editor for Android
+ *    https://github.com/abc15018045126/sora-editor
+ *    Copyright (C) 2020-2024  abc15018045126
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation; either
+ *     version 2.1 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
+ *     Lesser General Public License for more details.
+ *
+ *     You should have received a copy of the GNU Lesser General Public
+ *     License along with this library; if not, write to the Free Software
+ *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ *     USA
+ *
+ *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     additional information or have any questions
+ */
+package io.github.abc15018045126.sora.event;
+
+import android.view.MotionEvent;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import io.github.abc15018045126.sora.lang.styling.Span;
+import io.github.abc15018045126.sora.text.CharPosition;
+import io.github.abc15018045126.sora.text.TextRange;
+import io.github.abc15018045126.sora.widget.CodeEditor;
+
+/**
+ * Report a single click
+ *
+ * @author abc15018045126
+ */
+public class ClickEvent extends EditorMotionEvent {
+
+    public ClickEvent(@NonNull CodeEditor editor, @NonNull CharPosition position, @NonNull MotionEvent event,
+                      @Nullable Span span, @Nullable TextRange spanRange, int motionRegion, int motionBound) {
+        super(editor, position, event, span, spanRange, motionRegion, motionBound);
+    }
+
+}
+

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/event/ColorSchemeUpdateEvent.kt

@@ -0,0 +1,43 @@
+/*******************************************************************************
+ *    sora-editor - the awesome code editor for Android
+ *    https://github.com/abc15018045126/sora-editor
+ *    Copyright (C) 2020-2024  abc15018045126
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation; either
+ *     version 2.1 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
+ *     Lesser General Public License for more details.
+ *
+ *     You should have received a copy of the GNU Lesser General Public
+ *     License along with this library; if not, write to the Free Software
+ *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ *     USA
+ *
+ *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     additional information or have any questions
+ ******************************************************************************/
+
+package io.github.abc15018045126.sora.event
+
+import io.github.abc15018045126.sora.widget.CodeEditor
+
+/**
+ * Event trigger when any updates to the editor color scheme, including setting a new color and setting
+ *  a new color scheme
+ *
+ *  @author abc15018045126
+ */
+class ColorSchemeUpdateEvent(editor: CodeEditor) : Event(editor) {
+
+    /**
+     * Updated color scheme (the new one if new color scheme is set)
+     */
+    val colorScheme
+        get() = editor.colorScheme
+
+}

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/event/ContentChangeEvent.java

@@ -0,0 +1,122 @@
+/*
+ *    sora-editor - the awesome code editor for Android
+ *    https://github.com/abc15018045126/sora-editor
+ *    Copyright (C) 2020-2024  abc15018045126
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation; either
+ *     version 2.1 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
+ *     Lesser General Public License for more details.
+ *
+ *     You should have received a copy of the GNU Lesser General Public
+ *     License along with this library; if not, write to the Free Software
+ *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ *     USA
+ *
+ *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     additional information or have any questions
+ */
+package io.github.abc15018045126.sora.event;
+
+import androidx.annotation.NonNull;
+
+import io.github.abc15018045126.sora.text.CharPosition;
+import io.github.abc15018045126.sora.widget.CodeEditor;
+
+/**
+ * This event happens when {@link CodeEditor#setText(CharSequence)} is called or
+ * user edited the displaying content.
+ * <p>
+ * Note that you should not update the content at this time. Otherwise, there might be some
+ * exceptions causing the editor framework to crash. If you do need to update the content, you should
+ * post your actions to the main thread so that the user's modification will be successful.
+ *
+ * @author abc15018045126
+ */
+public class ContentChangeEvent extends Event {
+
+    /**
+     * Notify that {@link CodeEditor#setText(CharSequence)} is called
+     */
+    public final static int ACTION_SET_NEW_TEXT = 1;
+
+    /**
+     * Notify that user inserted some texts to the content
+     */
+    public final static int ACTION_INSERT = 2;
+
+    /**
+     * Notify that user deleted some texts in the content
+     */
+    public final static int ACTION_DELETE = 3;
+
+    private final int action;
+    private final CharPosition start;
+    private final CharPosition end;
+    private final CharSequence textChanged;
+    private final boolean causedByUndoManager;
+
+    public ContentChangeEvent(@NonNull CodeEditor editor, int action, @NonNull CharPosition changeStart, @NonNull CharPosition changeEnd, @NonNull CharSequence textChanged, boolean causeByUndoManager) {
+        super(editor);
+        this.action = action;
+        start = changeStart;
+        end = changeEnd;
+        this.textChanged = textChanged;
+        causedByUndoManager = causeByUndoManager;
+    }
+
+    /**
+     * Get action code of the event.
+     *
+     * @see #ACTION_SET_NEW_TEXT
+     * @see #ACTION_INSERT
+     * @see #ACTION_DELETE
+     */
+    public int getAction() {
+        return action;
+    }
+
+    /**
+     * Return the CharPosition indicating the start of changed region.
+     * <p>
+     * Note that you can not modify the values in the returned instance.
+     */
+    @NonNull
+    public CharPosition getChangeStart() {
+        return start;
+    }
+
+    /**
+     * Return the CharPosition indicating the end of changed region.
+     * <p>
+     * Note that you can not modify the values in the returned instance.
+     */
+    @NonNull
+    public CharPosition getChangeEnd() {
+        return end;
+    }
+
+    /**
+     * Return the changed text in this modification.
+     * If action is {@link #ACTION_SET_NEW_TEXT}, Content instance is returned.
+     * If action is {@link #ACTION_INSERT}, inserted text is returned.
+     * If action is {@link #ACTION_DELETE}, deleted text is returned.
+     */
+    @NonNull
+    public CharSequence getChangedText() {
+        return textChanged;
+    }
+
+    /**
+     * If the content change is caused by undo/redo
+     */
+    public boolean isCausedByUndoManager() {
+        return causedByUndoManager;
+    }
+}
+

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/event/DoubleClickEvent.java

@@ -0,0 +1,50 @@
+/*
+ *    sora-editor - the awesome code editor for Android
+ *    https://github.com/abc15018045126/sora-editor
+ *    Copyright (C) 2020-2024  abc15018045126
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation; either
+ *     version 2.1 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
+ *     Lesser General Public License for more details.
+ *
+ *     You should have received a copy of the GNU Lesser General Public
+ *     License along with this library; if not, write to the Free Software
+ *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ *     USA
+ *
+ *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     additional information or have any questions
+ */
+package io.github.abc15018045126.sora.event;
+
+import android.view.MotionEvent;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+import io.github.abc15018045126.sora.lang.styling.Span;
+import io.github.abc15018045126.sora.text.CharPosition;
+import io.github.abc15018045126.sora.text.TextRange;
+import io.github.abc15018045126.sora.widget.CodeEditor;
+
+/**
+ * Report double click in editor.
+ * This event can be intercepted.
+ *
+ * @author abc15018045126
+ */
+public class DoubleClickEvent extends EditorMotionEvent {
+
+    public DoubleClickEvent(@NonNull CodeEditor editor, @NonNull CharPosition position, @NonNull MotionEvent event,
+                            @Nullable Span span, @Nullable TextRange spanRange, int motionRegion, int motionBound) {
+        super(editor, position, event, span, spanRange, motionRegion, motionBound);
+    }
+
+}
+

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/event/EditorKeyEvent.java

@@ -0,0 +1,157 @@
+/*
+ *    sora-editor - the awesome code editor for Android
+ *    https://github.com/abc15018045126/sora-editor
+ *    Copyright (C) 2020-2024  abc15018045126
+ *
+ *     This library is free software; you can redistribute it and/or
+ *     modify it under the terms of the GNU Lesser General Public
+ *     License as published by the Free Software Foundation; either
+ *     version 2.1 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
+ *     Lesser General Public License for more details.
+ *
+ *     You should have received a copy of the GNU Lesser General Public
+ *     License along with this library; if not, write to the Free Software
+ *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ *     USA
+ *
+ *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     additional information or have any questions
+ */
+package io.github.abc15018045126.sora.event;
+
+import android.view.KeyEvent;
+
+import androidx.annotation.NonNull;
+
+import io.github.abc15018045126.sora.text.method.KeyMetaStates;
+import io.github.abc15018045126.sora.widget.CodeEditor;
+
+/**
+ * Receives key related events in editor.
+ * <p>
+ * You may set a boolean for editor to return to the Android KeyEvent framework.
+ *
+ * @author abc15018045126
+ * @see ResultedEvent#setResult(Object)
+ * <p>
+ * This class mirrors methods of {@link KeyEvent}, but some methods are changed:
+ * @see #isAltPressed()
+ * @see #isShiftPressed()
+ */
+public class EditorKeyEvent extends ResultedEvent<Boolean> {
+
+    private final KeyEvent src;
+    private final Type type;
+    private final boolean shiftPressed;
+    private final boolean altPressed;
+
+    public EditorKeyEvent(@NonNull CodeEditor editor, @NonNull KeyEvent src, @NonNull Type type) {
+        super(editor);
+        this.src = src;
+        this.type = type;
+        shiftPressed = getEditor().getKeyMetaStates().isShiftPressed();
+        altPressed = getEditor().getKeyMetaStates().isAltPressed();
+    }
+
+    @Override
+    public boolean canIntercept() {
+        return true;
+    }
+
+    public int getAction() {
+        return src.getAction();
+    }
+
+    public int getKeyCode() {
+        return src.getKeyCode();
+    }
+
+    public int getRepeatCount() {
+        return src.getRepeatCount();
+    }
+
+    public int getMetaState() {
+        return src.getMetaState();
+    }
+
+    public int getModifiers() {
+        return src.getModifiers();
+    }
+
+    public long getDownTime() {
+        return src.getDownTime();
+    }
+
+    /**
+     * Get the key event type.
+     *
+     * @return The key event type.
+     */
+    @NonNull
+    public Type getEventType() {
+        return this.type;
+    }
+
+    @Override
+    public long getEventTime() {
+        return src.getEventTime();
+    }
+
+    /**
+     * editor change: track shift/alt by {@link KeyMetaStates}
+     */
+    public boolean isShiftPressed() {
+        return shiftPressed;
+    }
+
+    /**
+     * editor change: track shift/alt by {@link KeyMetaStates}
+     */
+    public boolean isAltPressed() {
+        return altPressed;
+    }
+
+    public boolean isCtrlPressed() {
+        return (src.getMetaState() & KeyEvent.META_CTRL_ON) != 0;
+    }
+
+    public void markAsConsumed() {
+        interceptAndSetResult(true);
+    }
+
+    public final boolean result(boolean editorResult) {
+        var res = getResult();
+        var userResult = res != null && res;
+        if (isIntercepted()) {
+            return userResult;
+        } else {
+            return userResult || editorResult;
+        }
+    }
+
+    /**
+     * The type of {@link EditorKeyEvent}.
+     */
+    public enum Type {
+
+        /**
+         * Used for {@link CodeEditor#onKeyUp(int, KeyEvent)}.
+         */
+        UP,
+
+        /**
+         * Used for {@link CodeEditor#onKeyDown(int, KeyEvent)}.
+         */
+        DOWN,
+
+        /**
+         * Used for {@link CodeEditor#onKeyMultiple(int, int, KeyEvent)}.
+         */
+        MULTIPLE
+    }
+}
+