X-Git-Url: http://git.nikiroo.be/?p=nikiroo-utils.git;a=blobdiff_plain;f=README.md;h=9ffed93744fd9fb9127e5991e32e0f397583a809;hp=89e852a1213fcf9a44d9ec617a6926293e8106bd;hb=9b1afdde02c30f0d4a80ba330a4bc72384093253;hpb=3633816889a62bb395ff68f9219dcd26d600c870 diff --git a/README.md b/README.md index 89e852a..9ffed93 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ Jexer - Java Text User Interface library ======================================== -WARNING: THIS IS ALPHA CODE! +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 @@ -10,31 +11,56 @@ 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. -Two backends are available: +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 coordinates is - supported. This is the default backend on non-Windows platforms. + 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. -* Java AWT UI. This backend can be selected by setting - jexer.AWT=true. This is the default backend on Windows platforms. - AWT is experimental, please consider filing bugs when you encounter - them. The default window size for AWT is 132x40, which is set in - jexer.session.AWTSession. +* 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. -A demo application showing the existing UI controls is available via -'java -jar jexer.jar' or 'java -Djexer.AWT=true -jar jexer.jar' . +* 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 can be seen in +three ways: + + * 'java -jar jexer.jar' . This will use System.in/out on + non-Windows, or Swing on Windows. + + * 'java -Djexer.Swing=true -jar jexer.jar' . This will always use + Swing. + + * 'java -cp jexer.jar jexer.demos.Demo2 PORT' (where PORT is a + number to run the TCP daemon on). This will use the telnet + protocol to establish an 8-bit clean channel and be aware of + screen size changes. + +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") -version 3 or greater. See the file LICENSE for the full license text, -which includes both the GPL v3 and the LGPL supplemental terms. +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. @@ -50,7 +76,7 @@ Usage ----- Usage patterns are still being worked on, but in general the goal will -be to build applications somewhat as follows: +be to build applications as follows: ```Java import jexer.*; @@ -58,7 +84,7 @@ import jexer.*; public class MyApplication extends TApplication { public MyApplication() { - super(); + super(BackendType.SWING); // Could also use BackendType.XTERM // Create standard menus for File and Window addFileMenu(); @@ -67,12 +93,12 @@ public class MyApplication extends TApplication { public static void main(String [] args) { MyApplication app = new MyApplication(); - app.run(); + (new Thread(app)).start(); } } ``` -See the file demos/Demo1.java for detailed examples. +See the files in jexer.demos for more detailed examples. @@ -83,9 +109,6 @@ 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 - --------------- - - 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 @@ -95,6 +118,53 @@ ambiguous. This section describes such issues. - 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. @@ -103,41 +173,34 @@ Roadmap Many tasks remain before calling this version 1.0: -0.0.2: +0.0.3: FINISH PORTING -- Making TMenu keyboard accelerators active/inactive -- AWT: - - Blinking cursor - - Handle kbTab (disable focus traversal BS) - - Block cursor -- ECMA48Backend running on socket - TTreeView + - Also add keyboard navigation - TDirectoryList + - Also add keyboard navigation - TFileOpen -- Decide on naming convention: getText, getValue, getLabel: one or all - of them? -- Refactor: - - TKeypress: - - getCh() --> getChar() - - getAlt/getCtrl/getShift --> isAltDown / isCtrlDown / isShiftDown - - Other boolean getters --> isSomething -0.0.3: +0.0.4: NEW STUFF +- Making TMenu keyboard accelerators active/inactive +- TStatusBar - TEditor +- TWindow + - "Smart placement" for new windows -0.0.4: +0.0.5: BUG HUNT -- Bugs - - TSubMenu keyboard mnemonic not working - - TDirectoryList cannot be navigated only with keyboard - - TTreeView cannot be navigated only with keyboard - - RangeViolation after dragging scrollbar up/down +- TSubMenu keyboard mnemonic not working +- Swing performance. Even with double buffering it isn't great. -0.1.0: +0.1.0: BETA RELEASE -- TWindow - - "Smart placement" for new windows +- TSpinner +- TComboBox +- TListBox +- TCalendar +- TColorPicker Wishlist features (2.0): @@ -145,11 +208,6 @@ Wishlist features (2.0): - Handle resize events (pass to child process) - Screen - Allow complex characters in putCharXY() and detect them in putStrXY(). -- TComboBox -- TListBox -- TSpinner -- TCalendar widget -- TColorPicker widget - Drag and drop - TEditor - TField @@ -163,6 +221,4 @@ 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.") +![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.")