capacitor-sora-editor 1.2.1 → 1.8.2

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/graphics/TextRowParams.kt

@@ -18,7 +18,7 @@
  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  *     USA
  *
- *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     Please contact abc15018045126 by email abc15018045126@gmail.com if you need
  *     additional information or have any questions
  ******************************************************************************/
 

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/graphics/inlayHint/ColorInlayHintRenderer.kt

@@ -18,7 +18,7 @@
  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  *     USA
  *
- *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     Please contact abc15018045126 by email abc15018045126@gmail.com if you need
  *     additional information or have any questions
  ******************************************************************************/
 

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/graphics/inlayHint/InlayHintRenderer.kt

@@ -18,7 +18,7 @@
  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  *     USA
  *
- *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     Please contact abc15018045126 by email abc15018045126@gmail.com if you need
  *     additional information or have any questions
  ******************************************************************************/
 
@@ -42,7 +42,7 @@
  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  *     USA
  *
- *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     Please contact abc15018045126 by email abc15018045126@gmail.com if you need
  *     additional information or have any questions
  ******************************************************************************/
 

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/graphics/inlayHint/InlayHintRendererProvider.kt

@@ -18,7 +18,7 @@
  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  *     USA
  *
- *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     Please contact abc15018045126 by email abc15018045126@gmail.com if you need
  *     additional information or have any questions
  ******************************************************************************/
 

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/graphics/inlayHint/TextInlayHintRenderer.kt

@@ -18,7 +18,7 @@
  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  *     USA
  *
- *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     Please contact abc15018045126 by email abc15018045126@gmail.com if you need
  *     additional information or have any questions
  ******************************************************************************/
 
@@ -42,7 +42,7 @@
  *     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  *     USA
  *
- *     Please contact abc15018045126 by email 2073412493@qq.com if you need
+ *     Please contact abc15018045126 by email abc15018045126@gmail.com if you need
  *     additional information or have any questions
  ******************************************************************************/
 

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/lang/EmptyLanguage.kt

@@ -0,0 +1,94 @@
+package io.github.abc15018045126.sora.lang
+
+import android.os.Bundle
+import io.github.abc15018045126.sora.lang.analysis.AnalyzeManager
+import io.github.abc15018045126.sora.lang.completion.CompletionPublisher
+import io.github.abc15018045126.sora.lang.format.Formatter
+import io.github.abc15018045126.sora.lang.smartEnter.NewlineHandler
+import io.github.abc15018045126.sora.lang.util.BaseAnalyzeManager
+import io.github.abc15018045126.sora.text.CharPosition
+import io.github.abc15018045126.sora.text.Content
+import io.github.abc15018045126.sora.text.ContentReference
+import io.github.abc15018045126.sora.text.TextRange
+import io.github.abc15018045126.sora.widget.SymbolPairMatch
+
+/**
+ * Empty language
+ *
+ * @author abc15018045126
+ */
+open class EmptyLanguage : Language {
+
+    override val formatter: Formatter
+        get() = EmptyFormatter.INSTANCE
+
+    override val symbolPairs: SymbolPairMatch
+        get() = EMPTY_SYMBOL_PAIRS
+
+    override fun requireAutoComplete(
+        content: ContentReference,
+        position: CharPosition,
+        publisher: CompletionPublisher,
+        extraArguments: Bundle
+    ) {
+    }
+
+    override val interruptionLevel: Int
+        get() = Language.INTERRUPTION_LEVEL_STRONG
+
+    override val newlineHandlers: Array<NewlineHandler>?
+        get() = emptyArray()
+
+    override val analyzeManager: AnalyzeManager
+        get() = EmptyAnalyzeManager.INSTANCE
+
+    override fun getIndentAdvance(content: ContentReference, line: Int, column: Int): Int {
+        return 0
+    }
+
+    override val quickQuoteHandler: QuickQuoteHandler?
+        get() = null
+
+    override fun destroy() {}
+
+    override fun useTab(): Boolean {
+        return false
+    }
+
+    class EmptyFormatter : Formatter {
+        override fun format(text: Content, cursorRange: TextRange) {}
+
+        override fun formatRegion(text: Content, rangeToFormat: TextRange, cursorRange: TextRange) {}
+
+        override fun setReceiver(receiver: Formatter.FormatResultReceiver?) {}
+
+        override fun isRunning(): Boolean {
+            return false
+        }
+
+        override fun destroy() {}
+
+        companion object {
+            @JvmField
+            val INSTANCE = EmptyFormatter()
+        }
+    }
+
+    class EmptyAnalyzeManager : BaseAnalyzeManager() {
+        override fun insert(start: CharPosition, end: CharPosition, insertedContent: CharSequence) {}
+
+        override fun delete(start: CharPosition, end: CharPosition, deletedContent: CharSequence) {}
+
+        override fun rerun() {}
+
+        companion object {
+            @JvmField
+            val INSTANCE = EmptyAnalyzeManager()
+        }
+    }
+
+    companion object {
+        @JvmField
+        val EMPTY_SYMBOL_PAIRS = SymbolPairMatch()
+    }
+}

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/lang/Language.kt

@@ -0,0 +1,188 @@
+package io.github.abc15018045126.sora.lang
+
+import android.os.Bundle
+import androidx.annotation.UiThread
+import androidx.annotation.WorkerThread
+import io.github.abc15018045126.sora.lang.analysis.AnalyzeManager
+import io.github.abc15018045126.sora.lang.completion.CompletionCancelledException
+import io.github.abc15018045126.sora.lang.completion.CompletionPublisher
+import io.github.abc15018045126.sora.lang.format.Formatter
+import io.github.abc15018045126.sora.lang.smartEnter.NewlineHandler
+import io.github.abc15018045126.sora.text.CharPosition
+import io.github.abc15018045126.sora.text.ContentReference
+import io.github.abc15018045126.sora.widget.SymbolPairMatch
+
+/**
+ * Language for editor
+ *
+ * A Language helps editor to highlight text and provide auto-completion.
+ * Implement this interface when you want to add new language support for editor.
+ *
+ * **NOTE:** A language must not be single instance.
+ * One language instance should always serve for only one editor.
+ * It means that you should not give one language object to other editor instances
+ * after it has been applied to one editor.
+ *
+ * @author abc15018045126
+ */
+interface Language {
+
+    /**
+     * Get [AnalyzeManager] of the language.
+     * This is called from time to time by the editor. Cache your instance please.
+     */
+    val analyzeManager: AnalyzeManager
+
+    /**
+     * Get the interruption level for auto-completion.
+     *
+     * @see INTERRUPTION_LEVEL_STRONG
+     * @see INTERRUPTION_LEVEL_SLIGHT
+     * @see INTERRUPTION_LEVEL_NONE
+     */
+    val interruptionLevel: Int
+
+    /**
+     * Request to auto-complete the code at the given `position`.
+     * This is called in a worker thread other than UI thread.
+     *
+     * @param content        Read-only reference of content
+     * @param position       The position for auto-complete
+     * @param publisher      The publisher used to update items
+     * @param extraArguments Arguments set by [io.github.abc15018045126.sora.widget.CodeEditor.setText]
+     * @throws io.github.abc15018045126.sora.lang.completion.CompletionCancelledException This thread can be abandoned
+     * by the editor framework because the auto-completion items of
+     * this invocation are no longer needed by the user. This can either be thrown
+     * by [ContentReference] or [CompletionPublisher].
+     * How the exceptions will be thrown is according to
+     * your settings: [interruptionLevel]
+     * @see ContentReference
+     * @see CompletionPublisher
+     * @see interruptionLevel
+     */
+    @WorkerThread
+    @Throws(CompletionCancelledException::class)
+    fun requireAutoComplete(
+        content: ContentReference, position: CharPosition,
+        publisher: CompletionPublisher,
+        extraArguments: Bundle
+    )
+
+    /**
+     * Get delta indent spaces count.
+     *
+     * @param content Content of given line.
+     * @param line    0-indexed line number. The indentation is applied on line index: `line + 1`.
+     * @param column  Column on the given line, where a line separator is inserted.
+     * @return Delta count of indent spaces. It can be a negative/positive number or zero.
+     */
+    @UiThread
+    fun getIndentAdvance(content: ContentReference, line: Int, column: Int): Int
+
+    /**
+     * Get delta indent spaces count.
+     *
+     * @param content          Content of given line.
+     * @param line             0-indexed line number. The indentation is applied on line index: `line + 1`.
+     * @param column           Column on the given line, where a line separator is inserted.
+     * @param spaceCountOnLine The number of spaces on `line`.
+     * @param tabCountOnLine   The number of tabs on `line`.
+     * @return Delta count of indent spaces. It can be a negative/positive number or zero.
+     */
+    @UiThread
+    fun getIndentAdvance(
+        content: ContentReference,
+        line: Int,
+        column: Int,
+        spaceCountOnLine: Int,
+        tabCountOnLine: Int
+    ): Int {
+        return getIndentAdvance(content, line, column)
+    }
+
+    /**
+     * Use tab to format
+     */
+    @UiThread
+    fun useTab(): Boolean
+
+
+    /**
+     * Get the code formatter for the current language.
+     * The formatter is expected to be the same one during the lifecycle of a language instance.
+     *
+     * @return The code formatter for the current language.
+     */
+    @get:UiThread
+    val formatter: Formatter
+
+    /**
+     * Returns language specified symbol pairs.
+     * The method is called only once when the language is applied.
+     */
+    @get:UiThread
+    val symbolPairs: SymbolPairMatch?
+
+    /**
+     * Get newline handlers of this language.
+     * This method is called each time the user presses ENTER key.
+     *
+     * Pay attention to the performance as this method is called frequently
+     *
+     * @return NewlineHandlers , maybe null
+     */
+    @get:UiThread
+    val newlineHandlers: Array<NewlineHandler>?
+
+    /**
+     * Get newline handlers of this language.
+     * This method is called each time the user types a single character (or a single code point)
+     * and some text is currently selected.
+     *
+     * Pay attention to the performance as this method is called frequently
+     *
+     * @return QuickQuoteHandler, maybe null
+     */
+    @get:UiThread
+    val quickQuoteHandler: QuickQuoteHandler?
+        get() = null
+
+    /**
+     * Destroy this [Language] object.
+     *
+     * When called, you should stop your resource-taking actions and remove any reference
+     * of editor or other objects related to editor (such as references to text in editor) to avoid
+     * memory leaks and resource waste.
+     */
+    @UiThread
+    fun destroy()
+
+    companion object {
+        /**
+         * Set the thread's interrupted flag by calling [Thread.interrupt].
+         *
+         * Throw [CompletionCancelledException] exceptions
+         * from [ContentReference] and [CompletionPublisher].
+         *
+         * Set thread's flag for abortion.
+         */
+        const val INTERRUPTION_LEVEL_STRONG = 0
+
+        /**
+         * Throw [CompletionCancelledException] exceptions
+         * from [ContentReference] and [CompletionPublisher].
+         *
+         * Set thread's flag for abortion.
+         */
+        const val INTERRUPTION_LEVEL_SLIGHT = 1
+
+        /**
+         * Throw [CompletionCancelledException] exceptions
+         * from [ContentReference]
+         *
+         * Set thread's flag for abortion.
+         */
+        const val INTERRUPTION_LEVEL_NONE = 2
+    }
+
+}

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/lang/QuickQuoteHandler.kt

@@ -0,0 +1,46 @@
+package io.github.abc15018045126.sora.lang
+
+import io.github.abc15018045126.sora.lang.styling.Styles
+import io.github.abc15018045126.sora.text.Content
+import io.github.abc15018045126.sora.text.TextRange
+
+interface QuickQuoteHandler {
+
+    /**
+     * Checks whether the given input matches the requirement to invoke this handler
+     *
+     * @param candidateCharacter The character going to be inserted. Length can be 1 or 2.
+     * @param text               Current text in editor
+     * @param cursor             The range of cursor
+     * @param style              Current code styles
+     * @return Whether this handler consumed the event
+     */
+    fun onHandleTyping(
+        candidateCharacter: String,
+        text: Content,
+        cursor: TextRange,
+        style: Styles?
+    ): HandleResult
+
+    class HandleResult(
+        private var consumed: Boolean,
+        private var newCursorRange: TextRange?
+    ) {
+        fun isConsumed(): Boolean = consumed
+        
+        fun setConsumed(consumed: Boolean) {
+            this.consumed = consumed
+        }
+        
+        fun getNewCursorRange(): TextRange? = newCursorRange
+        
+        fun setNewCursorRange(newCursorRange: TextRange?) {
+            this.newCursorRange = newCursorRange
+        }
+        
+        companion object {
+            @JvmField
+            val NOT_CONSUMED = HandleResult(false, null)
+        }
+    }
+}

package/android/sora-editor/editor/src/main/java/io/github/abc15018045126/sora/lang/analysis/AnalyzeManager.kt

@@ -0,0 +1,67 @@
+package io.github.abc15018045126.sora.lang.analysis
+
+import android.os.Bundle
+import io.github.abc15018045126.sora.text.CharPosition
+import io.github.abc15018045126.sora.text.ContentReference
+
+/**
+ * AnalyzeManager receives text updates and do its work to start lexers/parsers to analyze the code
+ * so that we can provide syntax-highlighting and exact auto-completion.
+ *
+ * @author abc15018045126
+ */
+interface AnalyzeManager {
+
+    /**
+     * Set the span receiver of the manager.
+     *
+     * This is called when the [io.github.abc15018045126.sora.lang.Language] is going to be used by
+     * an editor. It will also be called when the instance is no longer used.
+     * Make sure you check the exact receiver at the time you send results to it.
+     * Thus, you should save the instance at your side.
+     */
+    var receiver: StyleReceiver?
+
+    /**
+     * Called when new text is set in editor by either [io.github.abc15018045126.sora.widget.CodeEditor.setText]
+     * or [io.github.abc15018045126.sora.widget.CodeEditor.setText].
+     *
+     * @param content        New text, read-only. Accesses to it are not validated. It is not recommended saving
+     * this object for reading. You can make a copy of the text and update it. But for
+     * memory saving, you may want to store it.
+     * @param extraArguments Arguments set by [io.github.abc15018045126.sora.widget.CodeEditor.setText]
+     */
+    fun reset(content: ContentReference, extraArguments: Bundle)
+
+    /**
+     * The [ContentReference] set by [reset] has inserted
+     * text with the given position and text.
+     *
+     * @param start           The insertion start
+     * @param end             The insertion end
+     * @param insertedContent The content inserted
+     */
+    fun insert(start: CharPosition, end: CharPosition, insertedContent: CharSequence)
+
+    /**
+     * The [ContentReference] set by [reset] has deleted
+     * text with the given position and text.
+     *
+     * @param start          The deletion start
+     * @param end            The deletion end
+     * @param deletedContent The text deleted. Generated by [io.github.abc15018045126.sora.text.Content] object.
+     */
+    fun delete(start: CharPosition, end: CharPosition, deletedContent: CharSequence)
+
+    /**
+     * Rerun the analysis forcibly
+     */
+    fun rerun()
+
+    /**
+     * Destroy the manager. Release any resources held.
+     * Make sure that you will not call the receiver anymore.
+     */
+    fun destroy()
+
+}