Add *.so to .gitignore

This fixes https://github.com/termux/termux-widget/issues/2, which
was caused by the terminal launching the terminal session process
before the terminal size was known.

Also remove the built JNI libraries from source control.

.gitignore

@@ -5,6 +5,7 @@
 # Built application files
 build/
 *.apk
+*.so
 
 # Crashlytics configuations
 com_crashlytics_export_strings.xml

README.md

@@ -20,7 +20,7 @@ Released under [the GPLv3 license](https://www.gnu.org/licenses/gpl.html). Conta
 
 Building JNI libraries
 ======================
-For ease of use, the JNI libraries are checked into version control. Execute the `build-jnilibs.sh` script to rebuild them.
+Execute the `build-jnilibs.sh` script to build the required JNI libraries.
 
 Terminal resources
 ==================

app/build.gradle

@@ -18,8 +18,8 @@ android {
         applicationId "com.termux"
         minSdkVersion 21
         targetSdkVersion 23
-        versionCode 26
+        versionCode 28
-        versionName "0.26"
+        versionName "0.28"
     }
 
     buildTypes {

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

@@ -132,7 +132,7 @@ final class TermuxPreferences {
 					break;
 			}
 
-			mBackIsEscape = "escape".equals(props.getProperty("back-key", "escape"));
+			mBackIsEscape = "escape".equals(props.getProperty("back-key", "back"));
 		} catch (Exception e) {
 			Toast.makeText(context, "Error loading properties: " + e.getMessage(), Toast.LENGTH_LONG).show();
 			Log.e("termux", "Error loading props", e);

app/src/main/java/com/termux/terminal/JNI.java

@@ -28,7 +28,7 @@ final class JNI {
 	 * @return the file descriptor resulting from opening /dev/ptmx master device. The sub process will have opened the
 	 *         slave device counterpart (/dev/pts/$N) and have it as stdint, stdout and stderr.
 	 */
-	public static native int createSubprocess(String cmd, String cwd, String[] args, String[] envVars, int[] processId);
+	public static native int createSubprocess(String cmd, String cwd, String[] args, String[] envVars, int[] processId, int rows, int columns);
 
 	/** Set the window size for a given pty, which allows connected programs to learn how large their screen is. */
 	public static native void setPtyWindowSize(int fd, int rows, int cols);

app/src/main/java/com/termux/terminal/TerminalEmulator.java

@@ -218,7 +218,7 @@ public final class TerminalEmulator {
 	 */
 	private int mScrollCounter = 0;
 
-	private int mUtf8ToFollow, mUtf8Index;
+	private byte mUtf8ToFollow, mUtf8Index;
 	private final byte[] mUtf8InputBuffer = new byte[4];
 
 	public final TerminalColors mColors = new TerminalColors();
@@ -424,7 +424,11 @@ public final class TerminalEmulator {
 						processCodePoint(/* escape (hexadecimal=0x1B, octal=033): */27);
 						processCodePoint((codePoint & 0x7F) + 0x40);
 					} else {
-						if (Character.UNASSIGNED == Character.getType(codePoint)) codePoint = UNICODE_REPLACEMENT_CHAR;
+						switch (Character.getType(codePoint)) {
+							case Character.UNASSIGNED:
+							case Character.SURROGATE:
+								codePoint = UNICODE_REPLACEMENT_CHAR;
+						}
 						processCodePoint(codePoint);
 					}
 				}
@@ -907,8 +911,9 @@ public final class TerminalEmulator {
 	/** Process byte while in the {@link #ESC_CSI_QUESTIONMARK} escape state. */
 	private void doCsiQuestionMark(int b) {
 		switch (b) {
-		case 'J': // Selective erase in display (DECSED - http://www.vt100.net/docs/vt510-rm/DECSED).
+		case 'J': // Selective erase in display (DECSED) - http://www.vt100.net/docs/vt510-rm/DECSED.
-		case 'K': // Selective erase in line (DECSEL - http://vt100.net/docs/vt510-rm/DECSEL).
+		case 'K': // Selective erase in line (DECSEL) - http://vt100.net/docs/vt510-rm/DECSEL.
+			mAboutToAutoWrap = false;
 			int fillChar = ' ';
 			int startCol = -1;
 			int startRow = -1;
@@ -1229,6 +1234,11 @@ public final class TerminalEmulator {
 				mScreen.blockSet(mRightMargin - 1, mTopMargin, 1, rows, ' ', TextStyle.encode(mForeColor, mBackColor, 0));
 			}
 			break;
+		case 'c': // RIS - Reset to Initial State (http://vt100.net/docs/vt510-rm/RIS).
+			reset();
+			blockClear(0, 0, mColumns, mRows);
+			setCursorPosition(0, 0);
+			break;
 		case 'D': // INDEX
 			doLinefeed();
 			break;
@@ -1321,9 +1331,8 @@ public final class TerminalEmulator {
 			continueSequence(ESC_CSI_ARGS_ASTERIX);
 			break;
 		case '@': {
-			// ESC [ Pn @ - ICH Insert Characters.
+			// "CSI{n}@" -  Insert ${n} space characters (ICH) - http://www.vt100.net/docs/vt510-rm/ICH.
-			// "This control function inserts one or more space (SP) characters starting at the cursor position."
+			mAboutToAutoWrap = false;
-			// http://www.vt100.net/docs/vt510-rm/ICH
 			int columnsAfterCursor = mColumns - mCursorCol;
 			int spacesToInsert = Math.min(getArg0(1), columnsAfterCursor);
 			int charsToMove = columnsAfterCursor - spacesToInsert;
@@ -1360,7 +1369,7 @@ public final class TerminalEmulator {
 		case 'I': // Cursor Horizontal Forward Tabulation (CHT). Move the active position n tabs forward.
 			setCursorCol(nextTabStop(getArg0(1)));
 			break;
-		case 'J': // ESC [ Pn J - ED - Erase in Display
+		case 'J': // "${CSI}${0,1,2}J" - Erase in Display (ED)
 			// ED ignores the scrolling margins.
 			switch (getArg0(0)) {
 			case 0: // Erase from the active position to the end of the screen, inclusive (default).
@@ -1377,8 +1386,9 @@ public final class TerminalEmulator {
 				break;
 			default:
 				unknownSequence(b);
-				break;
+				return;
 			}
+			mAboutToAutoWrap = false;
 			break;
 		case 'K': // "CSI{n}K" - Erase in line (EL).
 			switch (getArg0(0)) {
@@ -1393,8 +1403,9 @@ public final class TerminalEmulator {
 				break;
 			default:
 				unknownSequence(b);
-				break;
+				return;
 			}
+			mAboutToAutoWrap = false;
 			break;
 		case 'L': // "${CSI}{N}L" - insert ${N} lines (IL).
 		{
@@ -1407,6 +1418,7 @@ public final class TerminalEmulator {
 			break;
 		case 'M': // "${CSI}${N}M" - delete N lines (DL).
 		{
+			mAboutToAutoWrap = false;
 			int linesAfterCursor = mBottomMargin - mCursorRow;
 			int linesToDelete = Math.min(getArg0(1), linesAfterCursor);
 			int linesToMove = linesAfterCursor - linesToDelete;
@@ -1421,6 +1433,7 @@ public final class TerminalEmulator {
 			// As characters are deleted, the remaining characters between the cursor and right margin move to the left.
 			// Character attributes move with the characters. The terminal adds blank spaces with no visual character
 			// attributes at the right margin. DCH has no effect outside the scrolling margins."
+			mAboutToAutoWrap = false;
 			int cellsAfterCursor = mColumns - mCursorCol;
 			int cellsToDelete = Math.min(getArg0(1), cellsAfterCursor);
 			int cellsToMove = cellsAfterCursor - cellsToDelete;
@@ -1451,6 +1464,7 @@ public final class TerminalEmulator {
 			}
 			break;
 		case 'X': // "${CSI}${N}X" - Erase ${N:=1} character(s) (ECH). FIXME: Clears character attributes?
+			mAboutToAutoWrap = false;
 			mScreen.blockSet(mCursorCol, mCursorRow, Math.min(getArg0(1), mColumns - mCursorCol), 1, ' ', getStyle());
 			break;
 		case 'Z': // Cursor Backward Tabulation (CBT). Move the active position n tabs backward.

app/src/main/java/com/termux/terminal/TerminalSession.java

@@ -82,14 +82,17 @@ public final class TerminalSession extends TerminalOutput {
 	/** Callback which gets notified when a session finishes or changes title. */
 	final SessionChangedCallback mChangeCallback;
 
-	/** The pid of the shell process or -1 if not running. */
+	/** The pid of the shell process. 0 if not started and -1 if finished running. */
 	int mShellPid;
-	int mShellExitStatus = -1;
+
+	/** The exit status of the shell process. Only valid if ${@link #mShellPid} is -1. */
+	int mShellExitStatus;
+
 	/**
 	 * The file descriptor referencing the master half of a pseudo-terminal pair, resulting from calling
 	 * {@link JNI#createSubprocess(String, String, String[], String[], int[])}.
 	 */
-	final int mTerminalFileDescriptor;
+	private int mTerminalFileDescriptor;
 
 	/** Set by the application for user identification of session, not by terminal. */
 	public String mSessionName;
@@ -128,20 +131,26 @@ public final class TerminalSession extends TerminalOutput {
 		}
 	};
 
+	private final String mShellPath;
+	private final String mCwd;
+	private final String[] mArgs;
+	private final String[] mEnv;
+
 	public TerminalSession(String shellPath, String cwd, String[] args, String[] env, SessionChangedCallback changeCallback) {
 		mChangeCallback = changeCallback;
 
-		int[] processId = new int[1];
+		this.mShellPath = shellPath;
-		mTerminalFileDescriptor = JNI.createSubprocess(shellPath, cwd, args, env, processId);
+		this.mCwd = cwd;
-		mShellPid = processId[0];
+		this.mArgs = args;
+		this.mEnv = env;
 	}
 
 	/** Inform the attached pty of the new size and reflow or initialize the emulator. */
 	public void updateSize(int columns, int rows) {
-		JNI.setPtyWindowSize(mTerminalFileDescriptor, rows, columns);
 		if (mEmulator == null) {
 			initializeEmulator(columns, rows);
 		} else {
+			JNI.setPtyWindowSize(mTerminalFileDescriptor, rows, columns);
 			mEmulator.resize(columns, rows);
 		}
 	}
@@ -161,6 +170,11 @@ public final class TerminalSession extends TerminalOutput {
 	 */
 	public void initializeEmulator(int columns, int rows) {
 		mEmulator = new TerminalEmulator(this, columns, rows, /* transcript= */5000);
+
+		int[] processId = new int[1];
+		mTerminalFileDescriptor = JNI.createSubprocess(mShellPath, mCwd, mArgs, mEnv, processId, rows, columns);
+		mShellPid = processId[0];
+
 		final FileDescriptor terminalFileDescriptorWrapped = wrapFileDescriptor(mTerminalFileDescriptor);
 
 		new Thread("TermSessionInputReader[pid=" + mShellPid + "]") {
@@ -204,7 +218,7 @@ public final class TerminalSession extends TerminalOutput {
 	/** Write data to the shell process. */
 	@Override
 	public void write(byte[] data, int offset, int count) {
-		mTerminalToProcessIOQueue.write(data, offset, count);
+		if (mShellPid > 0) mTerminalToProcessIOQueue.write(data, offset, count);
 	}
 
 	/** Write the Unicode code point to the terminal encoded in UTF-8. */

app/src/main/java/com/termux/view/TerminalView.java

@@ -10,6 +10,7 @@ import android.graphics.Canvas;
 import android.graphics.Rect;
 import android.graphics.Typeface;
 import android.graphics.drawable.BitmapDrawable;
+import android.media.AudioManager;
 import android.os.Build;
 import android.text.InputType;
 import android.text.TextUtils;
@@ -692,6 +693,10 @@ public final class TerminalView extends View {
 				// As left alt+b, jumping forward in readline:
 				codePoint = 'b';
 				leftAltDownFromEvent = true;
+			} else if (codePoint == 'v' || codePoint == 'V') {
+				codePoint = -1;
+				AudioManager audio = (AudioManager) getContext().getSystemService(Context.AUDIO_SERVICE);
+				audio.adjustSuggestedStreamVolume(AudioManager.ADJUST_SAME, AudioManager.USE_DEFAULT_STREAM_TYPE, AudioManager.FLAG_SHOW_UI);
 			}
 		}
 

app/src/main/jni/termux.c

@@ -22,7 +22,14 @@ static int throw_runtime_exception(JNIEnv* env, char const* message)
         return -1;
 }
 
-static int create_subprocess(JNIEnv* env, char const* cmd, char const* cwd, char* const argv[], char** envp, int* pProcessId)
+static int create_subprocess(JNIEnv* env,
+                             char const* cmd,
+                             char const* cwd,
+                             char* const argv[],
+                             char** envp,
+                             int* pProcessId,
+                             jint rows,
+                             jint columns)
 {
         int ptm = open("/dev/ptmx", O_RDWR | O_CLOEXEC);
         if (ptm < 0) return throw_runtime_exception(env, "Cannot open /dev/ptmx");
@@ -49,8 +56,8 @@ static int create_subprocess(JNIEnv* env, char const* cmd, char const* cwd, char
         tios.c_iflag &= ~(IXON | IXOFF);
         tcsetattr(ptm, TCSANOW, &tios);
 
-		/** Set initial winsize (better too small than too large). */
+        /** Set initial winsize. */
-        struct winsize sz = { .ws_row = 20, .ws_col = 20 };
+        struct winsize sz = { .ws_row = rows, .ws_col = columns };
         ioctl(ptm, TIOCSWINSZ, &sz);
 
         pid_t pid = fork();
@@ -105,7 +112,16 @@ static int create_subprocess(JNIEnv* env, char const* cmd, char const* cwd, char
         }
 }
 
-JNIEXPORT jint JNICALL Java_com_termux_terminal_JNI_createSubprocess(JNIEnv* env, jclass TERMUX_UNUSED(clazz), jstring cmd, jstring cwd, jobjectArray args, jobjectArray envVars, jintArray processIdArray)
+JNIEXPORT jint JNICALL Java_com_termux_terminal_JNI_createSubprocess(
+    JNIEnv* env,
+    jclass TERMUX_UNUSED(clazz),
+    jstring cmd,
+    jstring cwd,
+    jobjectArray args,
+    jobjectArray envVars,
+    jintArray processIdArray,
+    jint rows,
+    jint columns)
 {
         jsize size = args ? (*env)->GetArrayLength(env, args) : 0;
         char** argv = NULL;
@@ -140,7 +156,7 @@ JNIEXPORT jint JNICALL Java_com_termux_terminal_JNI_createSubprocess(JNIEnv* env
         int procId = 0;
 	char const* cmd_cwd = (*env)->GetStringUTFChars(env, cwd, NULL);
         char const* cmd_utf8 = (*env)->GetStringUTFChars(env, cmd, NULL);
-        int ptm = create_subprocess(env, cmd_utf8, cmd_cwd, argv, envp, &procId);
+        int ptm = create_subprocess(env, cmd_utf8, cmd_cwd, argv, envp, &procId, rows, columns);
         (*env)->ReleaseStringUTFChars(env, cmd, cmd_utf8);
         (*env)->ReleaseStringUTFChars(env, cmd, cmd_cwd);
 

app/src/test/java/com/termux/terminal/ControlSequenceIntroducerTest.java

@@ -20,4 +20,13 @@ public class ControlSequenceIntroducerTest extends TerminalTestCase {
 		withTerminalSized(3, 4).enterString("1\r\n2\r\n3\r\nhi\033[Sy").assertLinesAre("2  ", "3  ", "hi ", "  y");
 	}
 
+	/** CSI Ps X  Erase Ps Character(s) (default = 1) (ECH). */
+	public void testCsiX() {
+		// See https://code.google.com/p/chromium/issues/detail?id=212712 where test was extraced from.
+		withTerminalSized(13, 2).enterString("abcdefghijkl\b\b\b\b\b\033[X").assertLinesAre("abcdefg ijkl ", "             ");
+		withTerminalSized(13, 2).enterString("abcdefghijkl\b\b\b\b\b\033[1X").assertLinesAre("abcdefg ijkl ", "             ");
+		withTerminalSized(13, 2).enterString("abcdefghijkl\b\b\b\b\b\033[2X").assertLinesAre("abcdefg  jkl ", "             ");
+		withTerminalSized(13, 2).enterString("abcdefghijkl\b\b\b\b\b\033[20X").assertLinesAre("abcdefg      ", "             ");
+	}
+
 }

app/src/test/java/com/termux/terminal/CursorAndScreenTest.java

@@ -172,4 +172,45 @@ public class CursorAndScreenTest extends TerminalTestCase {
 		}
 	}
 
+	/**
+	 * Test interactions between the cursor overflow bit and various escape sequences.
+	 * <p/>
+	 * Adapted from hterm:
+	 * https://chromium.googlesource.com/chromiumos/platform/assets/+/2337afa5c063127d5ce40ec7fec9b602d096df86%5E%21/#F2
+	 */
+	public void testClearingOfAutowrap() {
+		// Fill a row with the last hyphen wrong, then run a command that
+		// modifies the screen, then add a hyphen. The wrap bit should be
+		// cleared, so the extra hyphen can fix the row.
+		withTerminalSized(15, 6);
+
+		enterString("-----  1  ----X");
+		enterString("\033[K-");  // EL
+
+		enterString("-----  2  ----X");
+		enterString("\033[J-");  // ED
+
+		enterString("-----  3  ----X");
+		enterString("\033[@-");  // ICH
+
+		enterString("-----  4  ----X");
+		enterString("\033[P-");  // DCH
+
+		enterString("-----  5  ----X");
+		enterString("\033[X-");  // ECH
+
+		// DL will delete the entire line but clear the wrap bit, so we
+		// expect a hyphen at the end and nothing else.
+		enterString("XXXXXXXXXXXXXXX");
+		enterString("\033[M-");  // DL
+
+		assertLinesAre(
+				"-----  1  -----",
+				"-----  2  -----",
+				"-----  3  -----",
+				"-----  4  -----",
+				"-----  5  -----",
+				"              -");
+	}
+
 }

app/src/test/java/com/termux/terminal/DecSetTest.java

@@ -28,6 +28,11 @@ public class DecSetTest extends TerminalTestCase {
 		assertFalse(mTerminal.isShowingCursor());
 		mTerminal.reset();
 		assertTrue("Resetting the terminal should show the cursor", mTerminal.isShowingCursor());
+
+		enterString("\033[?25l");
+		assertFalse(mTerminal.isShowingCursor());
+		enterString("\033c"); // RIS resetting should reveal cursor.
+		assertTrue(mTerminal.isShowingCursor());
 	}
 
 	/** DECSET 2004, controls bracketed paste mode. */

app/src/test/java/com/termux/terminal/TerminalTest.java

@@ -92,6 +92,7 @@ public class TerminalTest extends TerminalTestCase {
 		assertEnteringStringGivesResponse("\033[6n", "\033[2;1R");
 	}
 
+	/** Test the cursor shape changes using DECSCUSR. */
 	public void testSetCursorStyle() throws Exception {
 		withTerminalSized(5, 5);
 		assertEquals(TerminalEmulator.CURSOR_STYLE_BLOCK, mTerminal.getCursorStyle());

app/src/test/java/com/termux/terminal/UnicodeInputTest.java

@@ -12,6 +12,47 @@ public class UnicodeInputTest extends TerminalTestCase {
 		withTerminalSized(5, 5);
 		mTerminal.append(new byte[]{(byte) 0b11101111, (byte) 'a'}, 2);
 		assertLineIs(0, ((char) TerminalEmulator.UNICODE_REPLACEMENT_CHAR) + "a   ");
+
+		// https://code.google.com/p/chromium/issues/detail?id=212704
+		byte[] input = new byte[]{
+				(byte) 0x61, (byte) 0xF1,
+				(byte) 0x80, (byte) 0x80,
+				(byte) 0xe1, (byte) 0x80,
+				(byte) 0xc2, (byte) 0x62,
+				(byte) 0x80, (byte) 0x63,
+				(byte) 0x80, (byte) 0xbf,
+				(byte) 0x64
+		};
+		withTerminalSized(10, 2);
+		mTerminal.append(input, input.length);
+		assertLinesAre("a\uFFFD\uFFFD\uFFFDb\uFFFDc\uFFFD\uFFFDd", "          ");
+
+		// Surrogate pairs.
+		withTerminalSized(5, 2);
+		input = new byte[]{
+				(byte) 0xed, (byte) 0xa0,
+				(byte) 0x80, (byte) 0xed,
+				(byte) 0xad, (byte) 0xbf,
+				(byte) 0xed, (byte) 0xae,
+				(byte) 0x80, (byte) 0xed,
+				(byte) 0xbf, (byte) 0xbf
+		};
+		mTerminal.append(input, input.length);
+		assertLinesAre("\uFFFD\uFFFD\uFFFD\uFFFD ", "     ");
+
+		// https://bugzilla.mozilla.org/show_bug.cgi?id=746900: "with this patch 0xe0 0x80 is decoded as two U+FFFDs,
+		// but 0xe0 0xa0 is decoded as a single U+FFFD, and this is correct according to the "Best Practices", but IE
+		// and Chrome (Version 22.0.1229.94) decode both of them as two U+FFFDs. Opera 12.11 decodes both of them as
+		// one U+FFFD".
+		withTerminalSized(5, 2);
+		input = new byte[]{(byte) 0xe0, (byte) 0xa0, ' '};
+		mTerminal.append(input, input.length);
+		assertLinesAre("\uFFFD    ", "     ");
+
+		// withTerminalSized(5, 2);
+		// input = new byte[]{(byte) 0xe0, (byte) 0x80, 'a'};
+		// mTerminal.append(input, input.length);
+		// assertLinesAre("\uFFFD\uFFFDa  ", "     ");
 	}
 
 	public void testUnassignedCodePoint() throws UnsupportedEncodingException {

app/src/test/java/com/termux/terminal/WcWidthTest.java

@@ -39,6 +39,7 @@ public class WcWidthTest extends TestCase {
 	public void testCombining() {
 		assertWidthIs(0, 0x0302);
 		assertWidthIs(0, 0x0308);
+		assertWidthIs(0, 0x2060);
 	}
 
 	public void testWatch() {