[nikiroo-utils.git] / README.md

Jexer - Java Text User Interface library
========================================

WARNING: THIS IS ALPHA CODE!  PLEASE CONSIDER FILING BUGS AS YOU
ENCOUNTER THEM.

This library is intended to implement a text-based windowing system
loosely reminiscient of Borland's [Turbo
Vision](http://en.wikipedia.org/wiki/Turbo_Vision) library.  For those
wishing to use the actual C++ Turbo Vision library, see [Sergio
Sigala's updated version](http://tvision.sourceforge.net/) that runs
on many more platforms.

Three backends are available:

* System.in/out to a command-line ECMA-48 / ANSI X3.64 type terminal
  (tested on Linux + xterm).  I/O is handled through terminal escape
  sequences generated by the library itself: ncurses is not required
  or linked to.  xterm mouse tracking using UTF8 and SGR coordinates
  are supported.  For the demo application, this is the default
  backend on non-Windows platforms.

* The same command-line ECMA-48 / ANSI X3.64 type terminal as above,
  but to any general InputStream/OutputStream.  See the file
  jexer.demos.Demo2 for an example of running the demo over a TCP
  socket.

* Java Swing UI.  This backend can be selected by setting
  jexer.Swing=true.  The default window size for Swing is 132x40,
  which is set in jexer.session.SwingSession.  For the demo
  application, this is the default backend on Windows platforms.

The demo application showing the existing UI controls is available via
'java -jar jexer.jar', 'java -Djexer.Swing=true -jar jexer.jar', or
'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a number to
run the TCP daemon on).

Additional backends can be created by subclassing
jexer.backend.Backend and passing it into the TApplication
constructor.


License
-------

This project is licensed LGPL ("GNU Lesser General Public License",
sometimes called the "Library GPL") version 3 or greater.  You may
freely use Jexer in both closed source (proprietary) and open source
applications, however any changes you make to the Jexer code must be
made available to your users.

See the file LICENSE for the full license text, which includes both
the GPL v3 and the LGPL supplemental terms.


Acknowledgements
----------------

Jexer makes use of the Terminus TrueType font [made available
here](http://files.ax86.net/terminus-ttf/) .


Usage
-----

Usage patterns are still being worked on, but in general the goal will
be to build applications as follows:

```Java
import jexer.*;

public class MyApplication extends TApplication {

    public MyApplication() {
        super(BackendType.SWING); // Could also use BackendType.XTERM

        // Create standard menus for File and Window
        addFileMenu();
        addWindowMenu();
    }

    public static void main(String [] args) {
        MyApplication app = new MyApplication();
        (new Thread(app)).start();
    }
}
```

See the files in jexer.demos for more detailed examples.


Known Issues / Arbitrary Decisions
----------------------------------

Some arbitrary design decisions had to be made when either the
obviously expected behavior did not happen or when a specification was
ambiguous.  This section describes such issues.

  - TTerminalWindow will hang on input from the remote if the
    TApplication is exited before the TTerminalWindow's process has
    closed on its own.  This is due to a Java limitation/interaction
    between blocking reads (which is necessary to get UTF8 translation
    correct) and file streams.

  - See jexer.tterminal.ECMA48 for more specifics of terminal
    emulation limitations.

  - TTerminalWindow uses cmd.exe on Windows.  Output will not be seen
    until enter is pressed, due to cmd.exe's use of line-oriented
    input (see the ENABLE_LINE_INPUT flag for GetConsoleMode() and
    SetConsoleMode()).

  - TTerminalWindow launches 'script -fqe /dev/null' on non-Windows
    platforms.  This is a workaround for the C library behavior of
    checking for a tty: script launches $SHELL in a pseudo-tty.  This
    works on Linux but might not on other Posix-y platforms.

  - Java's InputStreamReader as used by the ECMA48 backend requires a
    valid UTF-8 stream.  The default X10 encoding for mouse
    coordinates outside (160,94) can corrupt that stream, at best
    putting garbage keyboard events in the input queue but at worst
    causing the backend reader thread to throw an Exception and exit
    and make the entire UI unusable.  Mouse support therefore requires
    a terminal that can deliver either UTF-8 coordinates (1005 mode)
    or SGR coordinates (1006 mode).  Most modern terminals can do
    this.

  - jexer.session.TTYSession calls 'stty size' once every second to
    check the current window size, performing the same function as
    ioctl(TIOCGWINSZ) but without requiring a native library.

  - jexer.io.ECMA48Terminal calls 'stty' to perform the equivalent of
    cfmakeraw() when using System.in/out.  System.out is also
    (blindly!)  put in 'stty sane cooked' mode when exiting.


System Properties
-----------------

The following properties control features of Jexer:

  jexer.Swing
  -----------

  Used only by jexer.demos.Demo1.  If true, use the Swing interface
  for the demo application.  Default: true on Windows platforms
  (os.name starts with "Windows"), false on non-Windows platforms.

  jexer.Swing.cursorStyle
  -----------------------

  Used by jexer.io.SwingScreen.  Selects the cursor style to draw.
  Valid values are: underline, block, outline.  Default: underline.


Roadmap
-------

Many tasks remain before calling this version 1.0:

0.0.3: FINISH PORTING

- TTreeView
  - Also add keyboard navigation
- TDirectoryList
  - Also add keyboard navigation
- TFileOpen

0.0.4: NEW STUFF

- Making TMenu keyboard accelerators active/inactive
- TStatusBar
- TEditor
- TWindow
  - "Smart placement" for new windows

0.0.5: BUG HUNT

- TSubMenu keyboard mnemonic not working
- Swing performance.  Even with double buffering it isn't great.

0.1.0: BETA RELEASE

- TSpinner
- TComboBox
- TListBox
- TCalendar
- TColorPicker

Wishlist features (2.0):

- TTerminal
  - Handle resize events (pass to child process)
- Screen
  - Allow complex characters in putCharXY() and detect them in putStrXY().
- Drag and drop
  - TEditor
  - TField
  - TText
  - TTerminal
  - TComboBox


Screenshots
-----------

![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal")

![Yo Dawg...](/screenshots/yodawg.png?raw=true "Yo Dawg, I heard you like text windowing systems, so I ran a text windowing system inside your text windowing system so you can have a terminal in your terminal.")
Commit	Line	Data
	1	Jexer - Java Text User Interface library
	2	========================================
	3
	4	WARNING: THIS IS ALPHA CODE! PLEASE CONSIDER FILING BUGS AS YOU
	5	ENCOUNTER THEM.
	6
	7	This library is intended to implement a text-based windowing system
	8	loosely reminiscient of Borland's [Turbo
	9	Vision](http://en.wikipedia.org/wiki/Turbo_Vision) library. For those
	10	wishing to use the actual C++ Turbo Vision library, see [Sergio
	11	Sigala's updated version](http://tvision.sourceforge.net/) that runs
	12	on many more platforms.
	13
	14	Three backends are available:
	15
	16	* System.in/out to a command-line ECMA-48 / ANSI X3.64 type terminal
	17	(tested on Linux + xterm). I/O is handled through terminal escape
	18	sequences generated by the library itself: ncurses is not required
	19	or linked to. xterm mouse tracking using UTF8 and SGR coordinates
	20	are supported. For the demo application, this is the default
	21	backend on non-Windows platforms.
	22
	23	* The same command-line ECMA-48 / ANSI X3.64 type terminal as above,
	24	but to any general InputStream/OutputStream. See the file
	25	jexer.demos.Demo2 for an example of running the demo over a TCP
	26	socket.
	27
	28	* Java Swing UI. This backend can be selected by setting
	29	jexer.Swing=true. The default window size for Swing is 132x40,
	30	which is set in jexer.session.SwingSession. For the demo
	31	application, this is the default backend on Windows platforms.
	32
	33	The demo application showing the existing UI controls is available via
	34	'java -jar jexer.jar', 'java -Djexer.Swing=true -jar jexer.jar', or
	35	'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a number to
	36	run the TCP daemon on).
	37
	38	Additional backends can be created by subclassing
	39	jexer.backend.Backend and passing it into the TApplication
	40	constructor.
	41
	42
	43
	44	License
	45	-------
	46
	47	This project is licensed LGPL ("GNU Lesser General Public License",
	48	sometimes called the "Library GPL") version 3 or greater. You may
	49	freely use Jexer in both closed source (proprietary) and open source
	50	applications, however any changes you make to the Jexer code must be
	51	made available to your users.
	52
	53	See the file LICENSE for the full license text, which includes both
	54	the GPL v3 and the LGPL supplemental terms.
	55
	56
	57
	58	Acknowledgements
	59	----------------
	60
	61	Jexer makes use of the Terminus TrueType font [made available
	62	here](http://files.ax86.net/terminus-ttf/) .
	63
	64
	65
	66	Usage
	67	-----
	68
	69	Usage patterns are still being worked on, but in general the goal will
	70	be to build applications as follows:
	71
	72	```Java
	73	import jexer.*;
	74
	75	public class MyApplication extends TApplication {
	76
	77	public MyApplication() {
	78	super(BackendType.SWING); // Could also use BackendType.XTERM
	79
	80	// Create standard menus for File and Window
	81	addFileMenu();
	82	addWindowMenu();
	83	}
	84
	85	public static void main(String [] args) {
	86	MyApplication app = new MyApplication();
	87	(new Thread(app)).start();
	88	}
	89	}
	90	```
	91
	92	See the files in jexer.demos for more detailed examples.
	93
	94
	95
	96	Known Issues / Arbitrary Decisions
	97	----------------------------------
	98
	99	Some arbitrary design decisions had to be made when either the
	100	obviously expected behavior did not happen or when a specification was
	101	ambiguous. This section describes such issues.
	102
	103	- TTerminalWindow will hang on input from the remote if the
	104	TApplication is exited before the TTerminalWindow's process has
	105	closed on its own. This is due to a Java limitation/interaction
	106	between blocking reads (which is necessary to get UTF8 translation
	107	correct) and file streams.
	108
	109	- See jexer.tterminal.ECMA48 for more specifics of terminal
	110	emulation limitations.
	111
	112	- TTerminalWindow uses cmd.exe on Windows. Output will not be seen
	113	until enter is pressed, due to cmd.exe's use of line-oriented
	114	input (see the ENABLE_LINE_INPUT flag for GetConsoleMode() and
	115	SetConsoleMode()).
	116
	117	- TTerminalWindow launches 'script -fqe /dev/null' on non-Windows
	118	platforms. This is a workaround for the C library behavior of
	119	checking for a tty: script launches $SHELL in a pseudo-tty. This
	120	works on Linux but might not on other Posix-y platforms.
	121
	122	- Java's InputStreamReader as used by the ECMA48 backend requires a
	123	valid UTF-8 stream. The default X10 encoding for mouse
	124	coordinates outside (160,94) can corrupt that stream, at best
	125	putting garbage keyboard events in the input queue but at worst
	126	causing the backend reader thread to throw an Exception and exit
	127	and make the entire UI unusable. Mouse support therefore requires
	128	a terminal that can deliver either UTF-8 coordinates (1005 mode)
	129	or SGR coordinates (1006 mode). Most modern terminals can do
	130	this.
	131
	132	- jexer.session.TTYSession calls 'stty size' once every second to
	133	check the current window size, performing the same function as
	134	ioctl(TIOCGWINSZ) but without requiring a native library.
	135
	136	- jexer.io.ECMA48Terminal calls 'stty' to perform the equivalent of
	137	cfmakeraw() when using System.in/out. System.out is also
	138	(blindly!) put in 'stty sane cooked' mode when exiting.
	139
	140
	141
	142	System Properties
	143	-----------------
	144
	145	The following properties control features of Jexer:
	146
	147	jexer.Swing
	148	-----------
	149
	150	Used only by jexer.demos.Demo1. If true, use the Swing interface
	151	for the demo application. Default: true on Windows platforms
	152	(os.name starts with "Windows"), false on non-Windows platforms.
	153
	154	jexer.Swing.cursorStyle
	155	-----------------------
	156
	157	Used by jexer.io.SwingScreen. Selects the cursor style to draw.
	158	Valid values are: underline, block, outline. Default: underline.
	159
	160
	161
	162	Roadmap
	163	-------
	164
	165	Many tasks remain before calling this version 1.0:
	166
	167	0.0.3: FINISH PORTING
	168
	169	- TTreeView
	170	- Also add keyboard navigation
	171	- TDirectoryList
	172	- Also add keyboard navigation
	173	- TFileOpen
	174
	175	0.0.4: NEW STUFF
	176
	177	- Making TMenu keyboard accelerators active/inactive
	178	- TStatusBar
	179	- TEditor
	180	- TWindow
	181	- "Smart placement" for new windows
	182
	183	0.0.5: BUG HUNT
	184
	185	- TSubMenu keyboard mnemonic not working
	186	- Swing performance. Even with double buffering it isn't great.
	187
	188	0.1.0: BETA RELEASE
	189
	190	- TSpinner
	191	- TComboBox
	192	- TListBox
	193	- TCalendar
	194	- TColorPicker
	195
	196	Wishlist features (2.0):
	197
	198	- TTerminal
	199	- Handle resize events (pass to child process)
	200	- Screen
	201	- Allow complex characters in putCharXY() and detect them in putStrXY().
	202	- Drag and drop
	203	- TEditor
	204	- TField
	205	- TText
	206	- TTerminal
	207	- TComboBox
	208
	209
	210	Screenshots
	211	-----------
	212
	213	![Several Windows Open Including A Terminal](/screenshots/screenshot1.png?raw=true "Several Windows Open Including A Terminal")
	214
	215	![Yo Dawg...](/screenshots/yodawg.png?raw=true "Yo Dawg, I heard you like text windowing systems, so I ran a text windowing system inside your text windowing system so you can have a terminal in your terminal.")