A text-based widget toolkit
Go to file
Markus Gans 09d6c2879d Fix unsigned integer underflow in FString::_insert() 2017-04-15 19:32:43 +02:00
debian Debian files dependencies update 2017-02-06 22:47:48 +01:00
doc compiles now under FreeBSD 2017-03-26 20:40:04 +02:00
icon Add finalcut icon 2015-08-16 19:46:18 +02:00
logo Accelerates text line drawing by clear with CSI sequences 2016-12-11 16:42:50 +01:00
m4 Enable xterm "metaSendsEscape" switch 2017-04-11 00:30:27 +02:00
scripts small shell script improvements 2016-04-02 18:35:34 +02:00
src Fix unsigned integer underflow in FString::_insert() 2017-04-15 19:32:43 +02:00
test Rename preprocessor macro names with leading underscore 2017-04-09 20:08:53 +02:00
.codedocs Add Debian files to create packages 2017-02-05 23:55:54 +01:00
.gitignore compiles now under FreeBSD 2017-03-26 20:40:04 +02:00
.travis.yml .travis.yml 2015-11-22 22:26:28 +01:00
AUTHORS upload 2015-05-23 13:35:12 +02:00
COPYING upload 2015-05-23 13:35:12 +02:00
ChangeLog Fix unsigned integer underflow in FString::_insert() 2017-04-15 19:32:43 +02:00
LICENSE upload 2015-05-23 13:35:12 +02:00
Makefile.am Makefile update 2015-07-09 02:15:12 +02:00
Makefile.in compiles now under FreeBSD 2017-03-26 20:40:04 +02:00
README.md Improve input cursor positioning in FScrollView 2017-03-08 23:48:30 +01:00
aclocal.m4 Add the opti-move test program 2016-11-26 15:18:44 +01:00
autogen.sh Makefile update 2015-07-09 02:15:12 +02:00
build.sh Remap meta key to left alt on FreeBSD console 2017-04-02 13:30:23 +02:00
compile Optimized the terminal clear screen 2016-11-26 18:15:31 +01:00
config.guess Add the opti-move test program 2016-11-26 15:18:44 +01:00
config.h.in config.h.in 2015-09-15 23:07:24 +02:00
config.sub Add the opti-move test program 2016-11-26 15:18:44 +01:00
configure Enable xterm "metaSendsEscape" switch 2017-04-11 00:30:27 +02:00
configure.ac Correct gpm detection in configure script 2016-12-22 12:27:11 +01:00
depcomp upload 2015-05-23 13:35:12 +02:00
finalcut.spec FScrollView provides a scrollable viewport to change area 2017-01-02 08:07:46 +01:00
install-sh Add the opti-move test program 2016-11-26 15:18:44 +01:00
ltmain.sh Add the opti-move test program 2016-11-26 15:18:44 +01:00
missing Add the opti-move test program 2016-11-26 15:18:44 +01:00
stamp-h1 readme update 2015-08-30 13:11:49 +02:00

README.md

The Final Cut

Building and code analysis

Travis CI:
     Build Status
Coverity Scan:
     Coverity Scan Status
Class Reference:
     documented

Installation

> git clone git://github.com/gansm/finalcut.git
> cd finalcut
> ./configure --prefix=/usr
> make
> su -c "make install"

The Final Cut

The Final Cut is a class library and widget toolkit with full mouse support for creating a text-based user interface. The library supports the programmer to develop an application for the text console. It allows the simultaneous handling of multiple windows on the screen.
The C++ class design was inspired by the Qt framework. It provides common controls like dialog windows, push buttons, check boxes, radio buttons, input lines, list boxes, status bars and so on.

newfont

A new text font for X11 and the Linux console.

Virtual terminal

It uses a virtual terminal to print the character via an update method on the screen.
The virtual windows are an overlying layer to realizing window movements.
The update method transmits only the changes to the virtual terminal or the screen.

 print(...)
printf(...)
  │
  │           ╔═════════════════════════[ vterm ]═════════════════════════╗
  │           ║createVTerm()                                              ║
  │           ║                                 ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ║
  │           ║                                                           ║
  │           ║                                 │ restoreVTerm(x,y,w,h) │ ║
  │           ║                                                           ║
  │           ║                                 └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ ║
  │           ║                                                           ║
  │   ┌───────╨─────[ vwin ]─────────────┐                                ║
  │   │createArea(area)                  │                                ║
  │   │                                  │                                ║
  │   │                                  │                                ║
  └───┼─────────────►     ──────► updateVTerm(area) ────►                 ║
      │                                  │                                ║
      │                           putArea(x,y,area)                       ║
      │                         ────────────────────►                     ║
      │                           getArea(x,y,area)                       ║
      │                        ◄────────────────────                      ║
      │                                  │                                ║
      │                                  │                                ║
      │                  resizeArea(area)│                                ║
      └───────╥──────────────────────────┘                                ║
              ║                                                           ║
              ║                                                           ║
              ║                                                           ║
              ║   │                                          resizeVTerm()║
              ╚═══▼═══════════════════════════════════════════════════════╝
                  │
                  │    putVTerm()
                  └──────────────────► updateTerminalLine(y)
                    updateTerminal()             │
                                                 ▼
                                         ┌───────────────┐
                                         │ output_buffer │
                                         └───────────────┘
                                                 │
                                                 │ flush_out() 
                                                 │     +
                                                 │ Fputchar(char)
                                                 │
                                                 ▼
                                         ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
                                         ▌               ▐
                                         ▌    screen     ▐
                                         ▌ ───────────── ▐
                                         ▌ real terminal ▐
                                         ▌               ▐
                                         ▀▀▀▀▀▀▀███▀▀▀▀▀▀▀
                                                ███
                                             ▀▀▀▀▀▀▀▀▀

Class digramm

                                                ┌───────────┐
                                           ┌────┤ FKeyEvent │
                                           │    └───────────┘
                                           │    ┌─────────────┐
                                           ├────┤ FMouseEvent │
                                           │    └─────────────┘
                                           │    ┌─────────────┐
                                           ├────┤ FWheelEvent │
                                           │    └─────────────┘
                                           │    ┌─────────────┐
                                           ├────┤ FFocusEvent │
                                           │    └─────────────┘
                                           │    ┌─────────────┐
                               ┌────────┐  ├────┤ FAccelEvent │
                               │ FEvent │◄─┤    └─────────────┘
                               └────┬───┘  │    ┌──────────────┐
                                    :1     ├────┤ FResizeEvent │
                                    :      │    └──────────────┘
                                    :      │    ┌────────────┐
                                    :      ├────┤ FShowEvent │
                                    :      │    └────────────┘
                                    :      │    ┌────────────┐
                                    :      ├────┤ FHideEvent │
                                    :      │    └────────────┘
                                    :      │    ┌─────────────┐
                                    :      ├────┤ FCloseEvent │
                                    :      │    └─────────────┘
                                    :      │    ┌─────────────┐
                                    :      └────┤ FTimerEvent │
                                    :           └─────────────┘
                                    :
                                    :           ┌──────────────┐
                                    :      ┌────┤ FApplication │
                                    :      │    └──────────────┘
                                    :      │    ┌─────────┐1
                                    :      ├────┤ FButton ├-----------------------------┐
                                    :      │    └─────────┘                             :
                                    :      │    ┌────────┐1                             :
                                    :      ├────┤ FLabel ├------------------------------┐
                                    :      │    └────────┘                              :
                                    :      │    ┌───────────┐1                          :
                                    :      ├────┤ FLineEdit ├---------------------------┐
                                    :      │    └───────────┘                           :
                                    :      │    ┌──────────────┐      ┌──────────────┐1 :
                                    :1     ├────┤ FButtonGroup │   ┌──┤ FRadioButton ├--┐
 ┌─────────┐    ┌────────┐    ┌─────┴───┐  │    └──────────────┘   │  └──────────────┘  :
 │ FObject │◄─┬─┤ FVTerm │◄───┤ FWidget │◄─┤    ┌───────────────┐  │  ┌───────────┐1    :
 └─────────┘  │ └────┬───┘    └───┬─┬───┘  ├────┤ FToggleButton │◄─┼──┤ FCheckBox ├-----┐
              │      :1           :1:1     │    └───────────────┘  │  └───────────┘     :
   ┌───────┐  │      :            : :      │    ┌──────────────┐   │  ┌─────────┐1      :
   │ FTerm │◄─┘      └------------┐ :      ├────┤ FProgressbar │   └──┤ FSwitch ├-------┐
   └─┬───┬─┘                      : :      │    └──────────────┘      └─────────┘       :
     :1  :1                       : :      │    ┌────────────┐                          :  *┌─────────┐
     :   └------------------------┐ :      ├────┤ FScrollbar │                          ├---┤ FString │
     :                            : :      │    └────────────┘                          :   └─────────┘
     :  1┌───────────┐            : :      │    ┌───────────┐1                          :
     └---┤ FOptiAttr │            : :      ├────┤ FTextView ├---------------------------┘
     :   └───────────┘            : :      │    └───────────┘                           :
     :  1┌───────────┐            : :      │    ┌──────────┐1     *┌──────────────┐1    :
     └---┤ FOptiMove │            : :      ├────┤ FListBox ├-------┤ FListBoxItem ├-----┘
         └───────────┘            : :      │    └──────────┘       └──────────────┘     :
                                  : :      │    ┌─────────────┐                         :
                                  : :      ├────┤ FScrollView │                         :
                                  : :      │    └─────────────┘                         :
                                  : :      │    ┌────────────┐1   *┌────────────┐1      :
                                  : :      │ ┌──┤ FStatusBar ├-----┤ FStatusKey ├-------┘
                                  : :      │ │  └────┬───────┘     └────────────┘       :
                                  : :      │ │      1└----------------------------------┘
                                  : :      │ ▼                       ┌─────────────┐1   :
                                  : :  ┌───┴─┴───┐  ┌─────────┐   ┌──┤ FFileDialog ├----┘
                                  : :  │ FWindow │◄─┤ FDialog │◄──┤  └─────────────┘    :
                                  : :  └──┬──┬───┘  └────┬────┘   │  ┌─────────────┐1   :
                                  : :     ▲  ▲          1:        └──┤ FMessageBox ├----┘
                                  : :     │  │           :           └─────────────┘    :
                                  : :     │  │           └------------------------------┘
                                  : :     │  │      ┌──────────┐                        :
                                  : :     │  └──────┤ FToolTip ├------------------------┘
                                  : :     │         └──────────┘                        :
                                  : :     └───────────────┐          ┌──────────┐       :
                                  : :                     │      ┌───┤ FMenuBar │       :
                                  : :    ┌───────────┐    └──────┤   └──────────┘       :
                                  : :    │ FMenuList │◄──────────┤   ┌───────┐          :
                                  : :    └────┬──────┘           └───┤ FMenu │◄──┐      :
                                  : :        1:                      └───────┘   │      :
                                  : :         :            ┌─────────────────┐   │      :
                                  : :         :            │ FDialogListMenu ├───┘      :
                                  : :         :            └─────────────────┘          :
                                  : :         :                    ┌────────────────┐*  :
                                  : :         : *┌───────────┐  ┌──┤ FCheckMenuItem ├-┐ :
                                  : :         ├--┤ FMenuItem │◄─┤  └────────────────┘ : :
                                  : :         :  └───────────┘  │  ┌────────────────┐*: :
                                  : :         :                 └──┤ FRadioMenuItem ├-┤ :
                                  : :         :                    └────────────────┘ : :
                                  : :         └---------------------------------------┘ :
                                  : └---------------------------------------------------┘
                                  :  *┌────────┐
                                  └---┤ FPoint │
                                  :   └────────┘
                                  :  *┌───────┐
                                  └---┤ FRect │
                                      └───────┘