Feature: Improve EKS

app/src/main/java/io/neoterm/customize/NeoTermPath.kt

@@ -9,4 +9,5 @@ object NeoTermPath {
     const val HOME_PATH = "$ROOT_PATH/home"
 
     const val EKS_PATH = "$USR_PATH/share/eks"
+    const val EKS_DEFAULT_FILE = "$EKS_PATH/default.eks"
 }

app/src/main/java/io/neoterm/customize/shortcut/ShortcutConfig.kt

@@ -1,6 +1,6 @@
 package io.neoterm.customize.shortcut
 
-import io.neoterm.view.ExtraKeysView
+import io.neoterm.view.eks.ExtraButton
 
 /**
  * @author kiva
@@ -8,5 +8,6 @@ import io.neoterm.view.ExtraKeysView
 class ShortcutConfig {
     var version: Int = -1
     val programNames: MutableList<String> = mutableListOf()
-    val shortcutKeys: MutableList<ExtraKeysView.ExtraButton> = mutableListOf()
+    val shortcutKeys: MutableList<ExtraButton> = mutableListOf()
+    var withDefaultKeys: Boolean = true
 }

app/src/main/java/io/neoterm/customize/shortcut/ShortcutConfigLoader.kt

@@ -11,6 +11,9 @@ import java.io.File
 object ShortcutConfigLoader {
     class ConfiguredShortcutKey(val config: ShortcutConfig) : ShortcutKey {
         override fun applyShortcutKeys(extraKeysView: ExtraKeysView) {
+            if (config.withDefaultKeys) {
+                extraKeysView.loadDefaultUserDefinedExtraKeys()
+            }
             for (button in config.shortcutKeys) {
                 extraKeysView.addExternalButton(button)
             }
@@ -26,6 +29,12 @@ object ShortcutConfigLoader {
             try {
                 parser.setInput(file)
                 val config = parser.parse()
+
+                // "default" is a reserved program used for default extra keys
+                // see ExtraKeysView.loadDefaultUserDefinedExtraKeys()
+                if (config.programNames.contains("default")) {
+                    continue
+                }
                 registerConfig(config)
             } catch (e: Exception) {
                 Log.e("NeoTerm-EKS", "Load $file failed: " + e.toString())

app/src/main/java/io/neoterm/customize/shortcut/ShortcutConfigParser.kt

@@ -1,6 +1,6 @@
 package io.neoterm.customize.shortcut
 
-import io.neoterm.view.ExtraKeysView
+import io.neoterm.view.eks.TextButton
 import java.io.*
 
 /**
@@ -8,7 +8,7 @@ import java.io.*
  */
 class ShortcutConfigParser {
     companion object {
-        const val PARSER_VERSION = 1
+        const val PARSER_VERSION = 2
     }
 
     private lateinit var source: BufferedReader
@@ -42,6 +42,8 @@ class ShortcutConfigParser {
                 parseProgram(line, config)
             } else if (line.startsWith("define")) {
                 parseKeyDefine(line, config)
+            } else if (line.startsWith("with-default")) {
+                parseWithDefault(line, config)
             }
             line = source.readLine()
         }
@@ -55,6 +57,11 @@ class ShortcutConfigParser {
         return config
     }
 
+    private fun parseWithDefault(line: String, config: ShortcutConfig) {
+        val value = line.substring("with-default".length).trim().trimEnd()
+        config.withDefaultKeys = value == "true"
+    }
+
     private fun parseKeyDefine(line: String, config: ShortcutConfig) {
         val keyDefine = line.substring("define".length).trim().trimEnd()
         val keyValues = keyDefine.split(" ")
@@ -65,7 +72,7 @@ class ShortcutConfigParser {
         val buttonText = keyValues[0]
         val withEnter = keyValues[1] == "true"
 
-        config.shortcutKeys.add(ExtraKeysView.TextButton(buttonText, withEnter))
+        config.shortcutKeys.add(TextButton(buttonText, withEnter))
     }
 
     private fun parseProgram(line: String, config: ShortcutConfig) {

app/src/main/java/io/neoterm/customize/shortcut/ShortcutKeysManager.kt

@@ -19,7 +19,7 @@ object ShortcutKeysManager {
             return
         }
 
-        extraKeysView.resetExternalButtons()
+        extraKeysView.loadDefaultUserDefinedExtraKeys()
     }
 
     fun registerShortcutKeys(program: String, shortcutKey: ShortcutKey?) {

app/src/main/java/io/neoterm/customize/shortcut/builtin/BuiltinShortcutKeys.kt

@@ -11,9 +11,9 @@ import java.io.File
 object BuiltinShortcutKeys {
     private const val vimKeys = "version ${ShortcutConfigParser.PARSER_VERSION}\n" +
             "program vim neovim vi\n" +
-            "define / false\n" +
-            "define :w true\n" +
             "define dd true\n" +
+            "define :x true\n" +
+            "define :w true\n" +
             "define :q true\n"
 
     private const val moreKeys = "version ${ShortcutConfigParser.PARSER_VERSION}\n" +

app/src/main/java/io/neoterm/preference/NeoTermPreference.kt

@@ -84,7 +84,7 @@ object NeoTermPreference {
         return null
     }
 
-    fun buildEnvironment(cwd: String?, systemShell: Boolean): Array<String> {
+    fun buildEnvironment(cwd: String?, systemShell: Boolean, executablePath: String): Array<String> {
         var cwd = cwd
         File(NeoTermPath.HOME_PATH).mkdirs()
 

app/src/main/java/io/neoterm/services/NeoTermService.kt

@@ -93,7 +93,9 @@ class NeoTermService : Service() {
             arguments = arrayOf<String>(executablePath)
         }
 
-        val session = TerminalSession(executablePath, cwd, arguments, env ?: NeoTermPreference.buildEnvironment(cwd, systemShell), sessionCallback)
+        val session = TerminalSession(executablePath, cwd, arguments,
+                env ?: NeoTermPreference.buildEnvironment(cwd, systemShell, executablePath),
+                sessionCallback)
         mTerminalSessions.add(session)
         updateNotification()
         return session

app/src/main/java/io/neoterm/view/ExtraKeysView.java

@@ -2,7 +2,6 @@ package io.neoterm.view;
 
 import android.content.Context;
 import android.util.AttributeSet;
-import android.util.Log;
 import android.view.Gravity;
 import android.view.HapticFeedbackConstants;
 import android.view.KeyEvent;
@@ -11,121 +10,67 @@ import android.widget.Button;
 import android.widget.GridLayout;
 import android.widget.ToggleButton;
 
+import java.io.File;
 import java.util.ArrayList;
 import java.util.List;
 
 import io.neoterm.R;
 import io.neoterm.backend.TerminalSession;
+import io.neoterm.customize.NeoTermPath;
+import io.neoterm.customize.shortcut.ShortcutConfig;
+import io.neoterm.customize.shortcut.ShortcutConfigParser;
+import io.neoterm.preference.NeoTermPreference;
+import io.neoterm.utils.FileUtils;
+import io.neoterm.view.eks.ControlButton;
+import io.neoterm.view.eks.ExtraButton;
+import io.neoterm.view.eks.StatedControlButton;
 
 /**
  * A view showing extra keys (such as Escape, Ctrl, Alt) not normally available on an Android soft
  * keyboard.
  */
 public final class ExtraKeysView extends GridLayout {
-    public static abstract class ExtraButton implements OnClickListener {
+    public static final String KEY_ESC = "Esc";
-        public String buttonText;
+    public static final String KEY_TAB = "Tab";
+    public static final String KEY_CTRL = "Ctrl";
 
-        @Override
+    public static final ControlButton ESC = new ControlButton(KEY_ESC);
-        public abstract void onClick(View view);
+    public static final ControlButton TAB = new ControlButton(KEY_TAB);
-    }
+    public static final StatedControlButton CTRL = new StatedControlButton(KEY_CTRL);
-
-    public static class ControlButton extends ExtraButton {
-        public ControlButton(String text) {
-            buttonText = text;
-        }
-
-        @Override
-        public void onClick(View view) {
-            ExtraKeysView.sendKey(view, buttonText);
-        }
-    }
-
-    public static class TextButton extends ExtraButton {
-        boolean withEnter = false;
-
-        public TextButton(String text) {
-            this(text, false);
-        }
-
-        public TextButton(String text, boolean withEnter) {
-            this.buttonText = text;
-            this.withEnter = withEnter;
-        }
-
-        @Override
-        public void onClick(View view) {
-            ExtraKeysView.sendKey(view, buttonText);
-            if (withEnter) {
-                ExtraKeysView.sendKey(view, "\n");
-            }
-        }
-    }
-
-    public static class StatedControlButton extends ControlButton {
-        public ToggleButton toggleButton;
-
-        public StatedControlButton(String text) {
-            super(text);
-        }
-
-        @Override
-        public void onClick(View view) {
-            toggleButton.setChecked(toggleButton.isChecked());
-            toggleButton.setTextColor(toggleButton.isChecked() ? 0xFF80DEEA : TEXT_COLOR);
-        }
-
-        public boolean readState() {
-            if (toggleButton.isPressed()) return true;
-            boolean result = toggleButton.isChecked();
-            if (result) {
-                toggleButton.setChecked(false);
-                toggleButton.setTextColor(TEXT_COLOR);
-            }
-            return result;
-        }
-    }
-
-    public static final ControlButton ESC = new ControlButton("ESC");
-    public static final ControlButton TAB = new ControlButton("TAB");
-    public static final StatedControlButton CTRL = new StatedControlButton("CTRL");
-    public static final StatedControlButton ALT = new StatedControlButton("ALT");
-    public static final StatedControlButton FN = new StatedControlButton("FN");
 
     public static final ControlButton ARROW_UP = new ControlButton("▲");
     public static final ControlButton ARROW_DOWN = new ControlButton("▼");
     public static final ControlButton ARROW_LEFT = new ControlButton("◀");
     public static final ControlButton ARROW_RIGHT = new ControlButton("▶");
 
-    public static final TextButton HORIZONTAL = new TextButton("-");
+    public static final String DEFAULT_FILE_CONTENT = "version " + ShortcutConfigParser.PARSER_VERSION + "\n" +
-    public static final TextButton SLASH = new TextButton("/");
+            "program default\n" +
-    public static final TextButton PIPE = new TextButton("|");
+            "define - false\n" +
+            "define / false\n" +
+            "define | false\n";
 
-    private static final int TEXT_COLOR = 0xFFFFFFFF;
+    public static final int NORMAL_TEXT_COLOR = 0xFFFFFFFF;
 
-    private List<ExtraButton> extraButtons;
+    private List<ExtraButton> builtinExtraKeys;
-    private List<ExtraButton> externalButtons;
+    private List<ExtraButton> userDefinedExtraKeys;
 
     public ExtraKeysView(Context context, AttributeSet attrs) {
         super(context, attrs);
-        try {
+        builtinExtraKeys = new ArrayList<>(7);
-            externalButtons = new ArrayList<>(3);
+        userDefinedExtraKeys = new ArrayList<>(7);
-            extraButtons = new ArrayList<>();
+        loadDefaultBuiltinExtraKeys();
-            resetExternalButtons();
+        loadDefaultUserDefinedExtraKeys();
         updateButtons();
-        } catch (Throwable e) {
-            Log.e("NeoTerm", e.toString());
-            throw e;
-        }
     }
 
     public static void sendKey(View view, String keyName) {
         int keyCode = 0;
         String chars = null;
         switch (keyName) {
-            case "ESC":
+            case KEY_ESC:
                 keyCode = KeyEvent.KEYCODE_ESCAPE;
                 break;
-            case "TAB":
+            case KEY_TAB:
                 keyCode = KeyEvent.KEYCODE_TAB;
                 break;
             case "▲":
@@ -162,55 +107,58 @@ public final class ExtraKeysView extends GridLayout {
     }
 
     public boolean readAltButton() {
-        return ALT.readState();
+        return false;
-    }
-
-    public boolean readFnButton() {
-        return FN.readState();
     }
 
     public void addExternalButton(ExtraButton button) {
-        externalButtons.add(button);
+        userDefinedExtraKeys.add(button);
-    }
-
-    public void removeExternalButton(ExtraButton button) {
-        externalButtons.remove(button);
     }
 
     public void clearExternalButton() {
-        externalButtons.clear();
+        userDefinedExtraKeys.clear();
+    }
+
+    public void loadDefaultUserDefinedExtraKeys() {
+        File defaultFile = new File(NeoTermPath.EKS_DEFAULT_FILE);
+        if (!defaultFile.exists()) {
+            generateDefaultFile(defaultFile);
         }
 
-    public void resetExternalButtons() {
         clearExternalButton();
-        externalButtons.add(ALT);
+        try {
-        externalButtons.add(HORIZONTAL);
+            ShortcutConfigParser parser = new ShortcutConfigParser();
-        externalButtons.add(SLASH);
+            parser.setInput(defaultFile);
-        externalButtons.add(PIPE);
+            ShortcutConfig config = parser.parse();
+            userDefinedExtraKeys.addAll(config.getShortcutKeys());
+        } catch (Exception ignore) {
+        }
     }
 
-    void loadDefaultButtons(List<ExtraButton> buttons) {
+    private void generateDefaultFile(File defaultFile) {
-        buttons.add(ESC);
+        FileUtils.INSTANCE.writeFile(defaultFile, DEFAULT_FILE_CONTENT.getBytes());
-        buttons.add(CTRL);
-        buttons.add(TAB);
     }
 
-    void loadExternalButtons(List<ExtraButton> buttons) {
+    void loadDefaultBuiltinExtraKeys() {
-        buttons.addAll(externalButtons);
+        builtinExtraKeys.clear();
+        builtinExtraKeys.add(ESC);
+        builtinExtraKeys.add(CTRL);
+        builtinExtraKeys.add(TAB);
+        builtinExtraKeys.add(ARROW_LEFT);
+        builtinExtraKeys.add(ARROW_RIGHT);
+        builtinExtraKeys.add(ARROW_UP);
+        builtinExtraKeys.add(ARROW_DOWN);
     }
 
     public void updateButtons() {
         removeAllViews();
+        List[] buttons = new List[]{userDefinedExtraKeys, builtinExtraKeys};
 
-        extraButtons.clear();
+        setRowCount(buttons[0].size() == 0 ? 1 : 2);
-        loadDefaultButtons(extraButtons);
+        setColumnCount(buttons[1].size());
-        loadExternalButtons(extraButtons);
 
-        setRowCount(1);
+        for (int row = 0; row < buttons.length; row++) {
-        setColumnCount(extraButtons.size());
+            for (int col = 0; col < buttons[row].size(); col++) {
-
+                final ExtraButton extraButton = (ExtraButton) buttons[row].get(col);
-        for (int col = 0; col < extraButtons.size(); col++) {
-            final ExtraButton extraButton = extraButtons.get(col);
 
                 Button button;
                 if (extraButton instanceof StatedControlButton) {
@@ -222,7 +170,7 @@ public final class ExtraKeysView extends GridLayout {
                 }
 
                 button.setText(extraButton.buttonText);
-            button.setTextColor(TEXT_COLOR);
+                button.setTextColor(NORMAL_TEXT_COLOR);
                 button.setAllCaps(false);
 
                 final Button finalButton = button;
@@ -239,13 +187,18 @@ public final class ExtraKeysView extends GridLayout {
                 param.height = param.width = 0;
                 param.rightMargin = param.topMargin = 0;
                 param.setGravity(Gravity.START);
-            float weight = "▲▼◀▶".contains(extraButton.buttonText) ? 0.7f : 1.f;
+
+                float weight = 1.f;
+                if (NeoTermPreference.INSTANCE.loadBoolean(R.string.key_ui_wide_char_weigh_explicit, false)) {
+                    weight = "▲▼◀▶".contains(extraButton.buttonText) ? 0.7f : 1.f;
+                }
                 param.columnSpec = GridLayout.spec(col, GridLayout.FILL, weight);
-            param.rowSpec = GridLayout.spec(0, GridLayout.FILL, 1.f);
+                param.rowSpec = GridLayout.spec(row, GridLayout.FILL, 1.f);
                 button.setLayoutParams(param);
 
                 addView(button);
             }
         }
+    }
 
 }

app/src/main/java/io/neoterm/view/eks/ControlButton.java

@@ -0,0 +1,20 @@
+package io.neoterm.view.eks;
+
+import android.view.View;
+
+import io.neoterm.view.ExtraKeysView;
+
+/**
+ * @author kiva
+ */
+
+public class ControlButton extends ExtraButton {
+    public ControlButton(String text) {
+        buttonText = text;
+    }
+
+    @Override
+    public void onClick(View view) {
+        ExtraKeysView.sendKey(view, buttonText);
+    }
+}

app/src/main/java/io/neoterm/view/eks/ExtraButton.java

@@ -0,0 +1,14 @@
+package io.neoterm.view.eks;
+
+import android.view.View;
+
+/**
+ * @author kiva
+ */
+
+public abstract class ExtraButton implements View.OnClickListener {
+    public String buttonText;
+
+    @Override
+    public abstract void onClick(View view);
+}

app/src/main/java/io/neoterm/view/eks/StatedControlButton.java

@@ -0,0 +1,34 @@
+package io.neoterm.view.eks;
+
+import android.view.View;
+import android.widget.ToggleButton;
+
+import io.neoterm.view.ExtraKeysView;
+
+/**
+ * @author kiva
+ */
+
+public class StatedControlButton extends ControlButton {
+    public ToggleButton toggleButton;
+
+    public StatedControlButton(String text) {
+        super(text);
+    }
+
+    @Override
+    public void onClick(View view) {
+        toggleButton.setChecked(toggleButton.isChecked());
+        toggleButton.setTextColor(toggleButton.isChecked() ? 0xFF80DEEA : ExtraKeysView.NORMAL_TEXT_COLOR);
+    }
+
+    public boolean readState() {
+        if (toggleButton.isPressed()) return true;
+        boolean result = toggleButton.isChecked();
+        if (result) {
+            toggleButton.setChecked(false);
+            toggleButton.setTextColor(ExtraKeysView.NORMAL_TEXT_COLOR);
+        }
+        return result;
+    }
+}

app/src/main/java/io/neoterm/view/eks/TextButton.java

@@ -0,0 +1,30 @@
+package io.neoterm.view.eks;
+
+import android.view.View;
+
+import io.neoterm.view.ExtraKeysView;
+
+/**
+ * @author kiva
+ */
+
+public class TextButton extends ExtraButton {
+    boolean withEnter = false;
+
+    public TextButton(String text) {
+        this(text, false);
+    }
+
+    public TextButton(String text, boolean withEnter) {
+        this.buttonText = text;
+        this.withEnter = withEnter;
+    }
+
+    @Override
+    public void onClick(View view) {
+        ExtraKeysView.sendKey(view, buttonText);
+        if (withEnter) {
+            ExtraKeysView.sendKey(view, "\n");
+        }
+    }
+}

app/src/main/java/io/neoterm/view/tab/TermTab.kt

@@ -41,6 +41,8 @@ class TermTab(title: CharSequence) : Tab(title) {
         toolbar?.title = title
         if (NeoTermPreference.loadBoolean(R.string.key_ui_suggestions, true)) {
             viewClient?.updateSuggestions(title)
+        } else {
+            viewClient?.removeSuggestions()
         }
     }
 

app/src/main/java/io/neoterm/view/tab/TermViewClient.kt

@@ -110,11 +110,15 @@ class TermViewClient(val context: Context) : TerminalViewClient {
         }
 
         if (lastTitle != title || force) {
-            extraKeysView?.clearExternalButton()
+            removeSuggestions()
             ShortcutKeysManager.showShortcutKeys(title, extraKeysView)
             extraKeysView?.updateButtons()
             lastTitle = title
         }
     }
 
+    fun removeSuggestions() {
+        extraKeysView?.clearExternalButton()
+    }
+
 }

app/src/main/res/layout/term.xml

@@ -17,7 +17,7 @@
         android:id="@+id/extra_keys"
         style="?android:buttonBarStyle"
         android:layout_width="match_parent"
-        android:layout_height="36dp"
+        android:layout_height="@dimen/eks_height_two_line"
         android:layout_alignParentBottom="true"
         android:background="@color/terminal_background"
         android:orientation="horizontal" />

app/src/main/res/values-zh/strings.xml

@@ -22,6 +22,8 @@
     <string name="pref_ui_fullscreen">全屏</string>
     <string name="pref_ui_suggestions">显示建议 (需要 oh-my-zsh)</string>
     <string name="pref_ui_suggestions_desc">使用一些软件时，屏幕下方显示快捷键</string>
+    <string name="pref_ui_wide_char_weight_explicit">为宽字符设置权重</string>
+    <string name="pref_ui_wide_char_weight_explicit_desc">如果快捷输入栏显示不正确，请勾选本项</string>
     <string name="settings">设置</string>
     <string name="text_selection_more">更多</string>
     <string name="toggle_ime">切换输入法</string>

app/src/main/res/values/dimens.xml

@@ -2,4 +2,6 @@
     <dimen name="app_bar_height">180dp</dimen>
     <dimen name="fab_margin">16dp</dimen>
     <dimen name="text_margin">16dp</dimen>
+    <dimen name="eks_height">36dp</dimen>
+    <dimen name="eks_height_two_line">72dp</dimen>
 </resources>

app/src/main/res/values/preference_keys.xml

@@ -10,6 +10,7 @@
     <string name="key_ui_color_scheme" translatable="false">neoterm_ui_color_scheme</string>
     <string name="key_ui_next_tab_anim" translatable="false">neoterm_ui_next_tab_anim</string>
     <string name="key_ui_suggestions" translatable="false">neoterm_ui_suggestions</string>
+    <string name="key_ui_wide_char_weigh_explicit">neoterm_ui_wide_char_explicit</string>
 
     <string name="key_package_source" translatable="false">neoterm_package_source</string>
 </resources>

app/src/main/res/values/strings.xml

@@ -28,6 +28,8 @@
     <string name="pref_ui_close_tab_anim_next_tab_desc">Switch to the next tab instead of the previous tab when closing tab</string>
     <string name="pref_ui_suggestions">Show Suggestions (oh-my-zsh required)</string>
     <string name="pref_ui_suggestions_desc">When using some programs, show shortcut keys</string>
+    <string name="pref_ui_wide_char_weight_explicit">Use explicit weight for wide char</string>
+    <string name="pref_ui_wide_char_weight_explicit_desc">If suggestion bar show incorrect, please enable this</string>
     <string name="pref_package_source">Source</string>
     <string name="toggle_ime">Toggle IME</string>
 

app/src/main/res/xml/settings_ui.xml

@@ -18,6 +18,12 @@
         android:summary="@string/pref_ui_suggestions_desc"
         android:title="@string/pref_ui_suggestions" />
 
+    <CheckBoxPreference
+        android:defaultValue="false"
+        android:key="@string/key_ui_wide_char_weigh_explicit"
+        android:summary="@string/pref_ui_wide_char_weight_explicit_desc"
+        android:title="@string/pref_ui_wide_char_weight_explicit" />
+
     <EditTextPreference
         android:key="@string/key_ui_font"
         android:title="@string/pref_ui_font" />

build.gradle

@@ -7,7 +7,7 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:3.0.0-alpha3'
+        classpath 'com.android.tools.build:gradle:3.0.0-alpha4'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
 
         // NOTE: Do not place your application dependencies here; they belong

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
-#Sun Jun 11 16:46:54 CST 2017
+#Fri Jun 16 12:14:31 CST 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.0-milestone-1-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.0-rc-1-all.zip