Move Termux Preferences to com.termux.app.settings.preferences package

The termux preferences handling was mixed in with termux properties before an earlier commit. They are now moved out of into a separate sub package, the following classes are added:

- `TermuxPreferenceConstants` class that defines shared constants of the preferences used by Termux app and its plugins. This class should be imported by other termux plugin apps instead of copying and defining their own constants.
- `TermuxSharedPreferences` class that acts as manager for handling termux preferences.

Author: agnostic-apollo

app/src/main/java/com/termux/app/TermuxActivity.java

@@ -48,6 +48,7 @@
 
 import com.termux.R;
 import com.termux.app.TermuxConstants.TERMUX_APP.TERMUX_ACTIVITY;
+import com.termux.app.settings.preferences.TermuxSharedPreferences;
 import com.termux.app.terminal.BellHandler;
 import com.termux.app.terminal.TermuxViewClient;
 import com.termux.app.terminal.extrakeys.ExtraKeysView;
@@ -119,9 +120,9 @@ public final class TermuxActivity extends Activity implements ServiceConnection
 
     ExtraKeysView mExtraKeysView;
 
-    TermuxPreferences mSettings;
+    private TermuxSharedPreferences mPreferences;
 
-    TermuxSharedProperties mProperties;
+    private TermuxSharedProperties mProperties;
 
     /** Initialized in {@link #onServiceConnected(ComponentName, IBinder)}. */
     ArrayAdapter<TerminalSession> mListViewAdapter;
@@ -212,7 +213,7 @@ public boolean ensureStoragePermissionGranted() {
 
     @Override
     public void onCreate(Bundle bundle) {
-        mSettings = new TermuxPreferences(this);
+        mPreferences = new TermuxSharedPreferences(this);
         mProperties = new TermuxSharedProperties(this);
 
         mIsUsingBlackUI = mProperties.isUsingBlackUI();
@@ -246,12 +247,12 @@ public void onCreate(Bundle bundle) {
         mTerminalView = findViewById(R.id.terminal_view);
         mTerminalView.setOnKeyListener(new TermuxViewClient(this));
 
-        mTerminalView.setTextSize(mSettings.getFontSize());
-        mTerminalView.setKeepScreenOn(mSettings.isScreenAlwaysOn());
+        mTerminalView.setTextSize(mPreferences.getFontSize());
+        mTerminalView.setKeepScreenOn(mPreferences.getKeepScreenOn());
         mTerminalView.requestFocus();
 
         final ViewPager viewPager = findViewById(R.id.viewpager);
-        if (mSettings.mShowExtraKeys) viewPager.setVisibility(View.VISIBLE);
+        if (mPreferences.getShowExtraKeys()) viewPager.setVisibility(View.VISIBLE);
 
 
         ViewGroup.LayoutParams layoutParams = viewPager.getLayoutParams();
@@ -382,7 +383,7 @@ void sendOpenedBroadcast() {
 
     public void toggleShowExtraKeys() {
         final ViewPager viewPager = findViewById(R.id.viewpager);
-        final boolean showNow = mSettings.toggleShowExtraKeys(TermuxActivity.this);
+        final boolean showNow = mPreferences.toggleShowExtraKeys();
         viewPager.setVisibility(showNow ? View.VISIBLE : View.GONE);
         if (showNow && viewPager.getCurrentItem() == 1) {
             // Focus the text input view if just revealed.
@@ -636,7 +637,7 @@ protected void onStop() {
         super.onStop();
         mIsVisible = false;
         TerminalSession currentSession = getCurrentTermSession();
-        if (currentSession != null) TermuxPreferences.storeCurrentSession(this, currentSession);
+        if (currentSession != null) mPreferences.setCurrentSession(currentSession.mHandle);
         unregisterReceiver(mBroadcastReceiever);
         getDrawer().closeDrawers();
     }
@@ -739,7 +740,7 @@ public void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuIn
         menu.add(Menu.NONE, CONTEXTMENU_RESET_TERMINAL_ID, Menu.NONE, R.string.reset_terminal);
         menu.add(Menu.NONE, CONTEXTMENU_KILL_PROCESS_ID, Menu.NONE, getResources().getString(R.string.kill_process, getCurrentTermSession().getPid())).setEnabled(currentSession.isRunning());
         menu.add(Menu.NONE, CONTEXTMENU_STYLING_ID, Menu.NONE, R.string.style_terminal);
-        menu.add(Menu.NONE, CONTEXTMENU_TOGGLE_KEEP_SCREEN_ON, Menu.NONE, R.string.toggle_keep_screen_on).setCheckable(true).setChecked(mSettings.isScreenAlwaysOn());
+        menu.add(Menu.NONE, CONTEXTMENU_TOGGLE_KEEP_SCREEN_ON, Menu.NONE, R.string.toggle_keep_screen_on).setCheckable(true).setChecked(mPreferences.getKeepScreenOn());
         menu.add(Menu.NONE, CONTEXTMENU_HELP_ID, Menu.NONE, R.string.help);
     }
 
@@ -950,10 +951,10 @@ public boolean onContextItemSelected(MenuItem item) {
             case CONTEXTMENU_TOGGLE_KEEP_SCREEN_ON: {
                 if(mTerminalView.getKeepScreenOn()) {
                     mTerminalView.setKeepScreenOn(false);
-                    mSettings.setScreenAlwaysOn(this, false);
+                    mPreferences.setKeepScreenOn(false);
                 } else {
                     mTerminalView.setKeepScreenOn(true);
-                    mSettings.setScreenAlwaysOn(this, true);
+                    mPreferences.setKeepScreenOn(true);
                 }
                 return true;
             }
@@ -978,8 +979,8 @@ public void onRequestPermissionsResult(int requestCode, @NonNull String[] permis
     }
 
     public void changeFontSize(boolean increase) {
-        mSettings.changeFontSize(this, increase);
-        mTerminalView.setTextSize(mSettings.getFontSize());
+        mPreferences.changeFontSize(this, increase);
+        mTerminalView.setTextSize(mPreferences.getFontSize());
     }
 
     public void doPaste() {
@@ -995,12 +996,21 @@ public void doPaste() {
 
     /** The current session as stored or the last one if that does not exist. */
     public TerminalSession getStoredCurrentSessionOrLast() {
-        TerminalSession stored = TermuxPreferences.getCurrentSession(this);
+        TerminalSession stored = getCurrentSession(this);
         if (stored != null) return stored;
         List<TerminalSession> sessions = mTermService.getSessions();
         return sessions.isEmpty() ? null : sessions.get(sessions.size() - 1);
     }
 
+    private TerminalSession getCurrentSession(TermuxActivity context) {
+        String sessionHandle = mPreferences.getCurrentSession();
+        for (int i = 0, len = context.getTermService().getSessions().size(); i < len; i++) {
+            TerminalSession session = context.getTermService().getSessions().get(i);
+            if (session.mHandle.equals(sessionHandle)) return session;
+        }
+        return null;
+    }
+
     /** Show a toast and dismiss the last one if still visible. */
     void showToast(String text, boolean longDuration) {
         if (mLastToast != null) mLastToast.cancel();

app/src/main/java/com/termux/app/TermuxPreferences.java

@@ -24,6 +24,7 @@
 import com.termux.R;
 import com.termux.app.TermuxConstants.TERMUX_APP.TERMUX_ACTIVITY;
 import com.termux.app.TermuxConstants.TERMUX_APP.TERMUX_SERVICE;
+import com.termux.app.settings.preferences.TermuxSharedPreferences;
 import com.termux.terminal.EmulatorDebug;
 import com.termux.terminal.TerminalSession;
 import com.termux.terminal.TerminalSession.SessionChangedCallback;
@@ -148,7 +149,8 @@ public int onStartCommand(Intent intent, int flags, int startId) {
                 }
 
                 // Make the newly created session the current one to be displayed:
-                TermuxPreferences.storeCurrentSession(this, newSession);
+                TermuxSharedPreferences preferences = new TermuxSharedPreferences(this);
+                preferences.setCurrentSession(newSession.mHandle);
 
                 // Launch the main Termux app, which will now show the current session:
                 startActivity(new Intent(this, TermuxActivity.class).addFlags(Intent.FLAG_ACTIVITY_NEW_TASK));

app/src/main/java/com/termux/app/TermuxService.java

@@ -0,0 +1,50 @@
+package com.termux.app.settings.preferences;
+
+import com.termux.app.TermuxConstants;
+
+/*
+ * Version: v0.1.0
+ *
+ * Changelog
+ *
+ * - 0.1.0 (2021-03-12)
+ *      - Initial Release.
+ *
+ */
+
+/**
+ * A class that defines shared constants of the Shared preferences used by Termux app and its plugins.
+ * This class will be hosted by termux-app and should be imported by other termux plugin apps as is
+ * instead of copying constants to random classes. The 3rd party apps can also import it for
+ * interacting with termux apps. If changes are made to this file, increment the version number
+ * and add an entry in the Changelog section above.
+ *
+ * The properties are loaded from the first file found at
+ * {@link TermuxConstants#TERMUX_PROPERTIES_PRIMARY_FILE_PATH} or
+ * {@link TermuxConstants#TERMUX_PROPERTIES_SECONDARY_FILE_PATH}
+ */
+public final class TermuxPreferenceConstants {
+
+    /** Defines the key for whether to show extra keys in termux terminal view */
+    public static final String KEY_SHOW_EXTRA_KEYS = "show_extra_keys";
+    public static final boolean DEFAULT_VALUE_SHOW_EXTRA_KEYS = true;
+
+
+
+    /** Defines the key for whether to always keep screen on */
+    public static final String KEY_KEEP_SCREEN_ON = "screen_always_on";
+    public static final boolean DEFAULT_VALUE_KEEP_SCREEN_ON = true;
+
+
+
+    /** Defines the key for font size of termux terminal view */
+    public static final String KEY_FONTSIZE = "fontsize";
+
+
+
+    /** Defines the key for current termux terminal session */
+    public static final String KEY_CURRENT_SESSION = "current_session";
+
+
+
+}