finalcut/README.md

270 lines
20 KiB
Markdown
Raw Normal View History

2018-09-30 20:07:22 +02:00
![FINAL CUT](logo/svg/finalcut-logo.svg)
2016-04-25 21:13:12 +02:00
# Library for creating terminal applications with text-based widgets
2020-11-08 12:17:05 +01:00
FINAL CUT is a C++ class library and widget toolkit with full [mouse](doc/mouse-control.md#title-bar-actions-on-mouse-clicks) support for creating a [text-based user interface](https://en.wikipedia.org/wiki/Text-based_user_interface). The library supports the programmer to develop an application for the text console. It allows the simultaneous handling of multiple text windows on the screen.
The structure of the Qt framework was originally the inspiration for the C++ class design of FINAL CUT. It provides common controls like dialog boxes, push buttons, check boxes, radio buttons, input lines, list boxes, status bars and so on.
## Building and code analysis
2019-10-05 23:20:07 +02:00
| | Badge |
|-------------------:|:------|
| *Latest release* | [![Latest Release](https://img.shields.io/github/release/gansm/finalcut.svg)](https://github.com/gansm/finalcut/releases) |
| *License* | [![license](https://img.shields.io/github/license/gansm/finalcut.svg?colorA=#333)](COPYING) |
| *Class Reference* | [![documented](https://codedocs.xyz/gansm/finalcut.svg)](https://codedocs.xyz/gansm/finalcut/hierarchy.html) |
2021-06-16 22:11:57 +02:00
| *Travis CI* | [![Build Status](https://travis-ci.com/gansm/finalcut.svg?branch=main)](https://travis-ci.com/gansm/finalcut)
| *Coverity Scan* | [![Coverity Scan Status](https://img.shields.io/coverity/scan/6508.svg)](https://scan.coverity.com/projects/6508 )|
| *LGTM* | [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/gansm/finalcut.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/gansm/finalcut/context:cpp) |
| *SonarCloud* | [![Quality gate](https://sonarcloud.io/api/project_badges/measure?project=gansm_finalcut&metric=alert_status)](https://sonarcloud.io/dashboard?id=gansm_finalcut) |
| *CodeFactor* | [![CodeFactor](https://www.codefactor.io/repository/github/gansm/finalcut/badge)](https://www.codefactor.io/repository/github/gansm/finalcut) |
2015-09-30 22:39:02 +02:00
## Installation
2017-11-02 16:05:34 +01:00
```bash
> git clone git://github.com/gansm/finalcut.git
> cd finalcut
2018-09-22 01:11:05 +02:00
> autoreconf --install --force
2016-04-02 18:35:34 +02:00
> ./configure --prefix=/usr
> make
> su -c "make install"
```
## Supported platforms
* Linux
* FreeBSD
* NetBSD
* OpenBSD
* macOS
* Cygwin
* Solaris
## First steps
2019-10-05 23:20:07 +02:00
See the [first steps](doc/first-steps.md#first-steps-with-the-final-cut-widget-toolkit) documentation for information on how to use the library.
2018-09-30 20:07:22 +02:00
## Some screenshots
2018-09-30 20:07:22 +02:00
The FFileDialog widget with incremental file name search:
2018-09-30 20:07:22 +02:00
![FFileDialog](doc/fileopen-dialog.png)
The FINAL CUT FProgressbar widget:
2015-05-23 13:35:12 +02:00
2018-09-30 20:07:22 +02:00
![FProgressbar](doc/progress-bar.png)
2015-05-23 13:35:12 +02:00
2018-09-30 20:07:22 +02:00
Scrollable text in the FTextView widget:
2019-09-29 22:28:58 +02:00
![FTextView](doc/textview.png)
2018-09-30 20:07:22 +02:00
The Mandelbrot set example:
2019-09-29 22:28:58 +02:00
![Mandelbrot set](doc/Mandelbrot.png)
2015-06-14 13:48:35 +02:00
## newfont
2015-05-23 13:35:12 +02:00
2017-11-03 05:04:27 +01:00
A [graphical text font](fonts/) for X11 and the Linux console.
2018-09-30 20:07:22 +02:00
![ui example in newfont mode](doc/newfont1.png)
Newfont drive symbols:
2015-05-23 13:35:12 +02:00
2018-09-30 20:07:22 +02:00
![drive symbols](doc/newfont2.png)
The calculator example in newfont mode:
![calculator](doc/calculator.png)
2015-06-20 16:56:03 +02:00
## Benchmark
2015-05-23 13:35:12 +02:00
2020-04-10 22:13:13 +02:00
Here you can find a test for [measuring the character speed](doc/benchmark.md#benchmark) in the terminal.
## Virtual terminal
FINAL CUT uses a virtual terminal to print character via an update method on the screen. It provides (as an overlying layer) virtual windows for the realization of window movements. The update methods only transfer differences to the virtual terminal or physical screen.
2015-05-23 13:35:12 +02:00
<pre style="line-height: 1 !important;">
print(...)
printf(...)
2019-10-08 04:37:19 +02:00
│ ╔════════════════════════[ vterm ]════════════════════════╗
│ ║createVTerm() ║
│ ║ ┌ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐ ║
│ ║ ║
│ ║ │ restoreVTerm(x,y,w,h) │ ║
│ ┌───────╨────[ vwin ]────────────┐ ║
│ │createArea(area) │ └ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘ ║
│ │ │ ║
│ │ │ ║
└──┼────────► putArea(area) ────► ║
│ │ ║
│ putArea(x,y,area) ────► ║
│ │ ║
│ ◄──── getArea(x,y,area) ║
│ │ ║
│ │ ║
│ │ ║
│ resizeArea(area)│ ║
└───────╥────────────────────────┘ ║
║ ║
║ │ resizeVTerm()║
╚═══════▼═════════════════════════════════════════════════╝
│ putVTerm()
└──────────────────► updateTerminalLine(y)
updateTerminal() │
┌───────────────┐
│ output_buffer │
└───────────────┘
│ flushOutputBuffer()
│ and putchar(char)
▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
▌ ▐
▌ screen ▐
▌ ───────────── ▐
▌ real terminal ▐
▌ ▐
▀▀▀▀▀▀▀███▀▀▀▀▀▀▀
███
▀▀▀▀▀▀▀▀▀
2015-05-23 13:35:12 +02:00
</pre>
## Class digramm
2018-11-01 00:49:13 +01:00
2015-05-23 13:35:12 +02:00
<pre style="line-height: 1 !important;">
2020-09-20 14:11:35 +02:00
1┌────────────┐
┌-----------┤ FTermLinux │
: └────────────┘
: 1┌──────────────┐
2018-07-22 23:07:49 +02:00
┌-----------┤ FTermFreeBSD │
: └──────────────┘
2019-07-04 15:26:26 +02:00
: 1┌──────────────┐
┌-----------┤ FTermOpenBSD │
: └──────────────┘
: 1┌────────────────┐ ┌───────────┐
┌-----------┤ FTermDetection │ ┌────┤ FKeyEvent │
: └────────────────┘ │ └───────────┘
2018-10-29 00:45:45 +01:00
: 1┌────────────────┐ │ ┌─────────────┐
2019-07-04 15:26:26 +02:00
┌-----------┤ FTermcapQuirks │ ├────┤ FMouseEvent │
2018-10-29 00:45:45 +01:00
: └────────────────┘ │ └─────────────┘
: 1┌────────────────┐ │ ┌─────────────┐
2019-07-04 15:26:26 +02:00
┌-----------┤ FTermXTerminal │ ├────┤ FWheelEvent │
2018-10-29 00:45:45 +01:00
: └────────────────┘ │ └─────────────┘
: 1┌──────────┐ │ ┌─────────────┐
2019-07-04 15:26:26 +02:00
┌-----------┤ FTermcap │ ├────┤ FFocusEvent │
: └──────────┘ │ └─────────────┘
: 1┌──────────┐ │ ┌─────────────┐
┌-----------┤ FTermios │ ├────┤ FAccelEvent │
2018-10-29 00:45:45 +01:00
: └──────────┘ │ └─────────────┘
2019-07-04 15:26:26 +02:00
: 1┌───────────────┐ │ ┌──────────────┐
┌-----------┤ FColorPalette │ ├────┤ FResizeEvent │
: └───────────────┘ │ └──────────────┘
2018-10-29 00:45:45 +01:00
: 1┌───────────┐ │ ┌────────────┐
2019-07-04 15:26:26 +02:00
┌-----------┤ FOptiMove │ ├────┤ FShowEvent │
: └───────────┘ │ └────────────┘
: 1┌───────────┐ │ ┌────────────┐
┌-----------┤ FOptiAttr │ ├────┤ FHideEvent │
2018-10-29 00:45:45 +01:00
: └───────────┘ │ └────────────┘
: 1┌───────────┐ │ ┌─────────────┐
2019-07-04 15:26:26 +02:00
┌-----------┤ FKeyboard │ ├────┤ FCloseEvent │
2018-10-29 00:45:45 +01:00
: └───────────┘ │ └─────────────┘
2019-07-04 15:26:26 +02:00
: 1┌───────────────┐ │ ┌─────────────┐
┌-----------┤ FMouseControl │ ├────┤ FTimerEvent │
: └───────────────┘ │ └─────────────┘
2020-09-20 14:11:35 +02:00
: 1┌─────────┐ │ ┌────────────┐1 1┌───────┐
┌-----------┤ FSystem │ ├────┤ FUserEvent ├------┤ FData │
: └─────────┘ │ └────────────┘ └───────┘
: *┌─────────┐ │ ┌──────┐ ┌─────────┐
: ┌--------┤ FString │ │ │ FLog │◄──┤ FLogger │
: : └─────────┘ │ └──┬───┘ └─────────┘
: : *┌───────────────┐ │ :1
: ┌--------┤ FStringStream │ │ ┌──┴───────────┐
: : └───────────────┘ │ ┌────┤ FApplication │
2019-07-04 15:26:26 +02:00
: : *┌────────┐ │ │ └──────────────┘
: ┌--------┤ FPoint │ │ │ ┌────────┐
: : └────────┘ │ ├────┤ FLabel │
2018-10-29 00:45:45 +01:00
: : *┌───────┐ │ │ └────────┘
: ┌--------┤ FRect │ │ │ ┌───────────┐
2018-10-29 00:45:45 +01:00
: : └───────┘ │ ├────┤ FLineEdit │
: : *┌───────┐ │ │ └───────────┘
: ┌--------┤ FSize │ │ │ ┌──────────┐
: : └───────┘ │ ├────┤ FSpinBox │
:1 :1 │ │ └──────────┘
┌─┴──┴──┐ │ │ ┌─────────┐
│ FTerm │ │ ├────┤ FButton │
└───┬───┘ ┌────────┐ │ │ └─────────┘
:1 │ FEvent │◄─────┘ │ ┌──────────────┐ ┌──────────────┐
┌───┴────┐ └────┬───┘ ├────┤ FButtonGroup │ ┌──┤ FRadioButton │
│ FVTerm │◄──┐ :1 │ └──────────────┘ │ └──────────────┘
└────────┘ │ ┌────┴────┐ │ ┌───────────────┐ │ ┌───────────┐
├────┤ FWidget │◄───────┼────┤ FToggleButton │◄─┼──┤ FCheckBox │
2020-06-11 21:38:33 +02:00
┌─────────┐ │ └────┬────┘ │ └───────────────┘ │ └───────────┘
│ FObject │◄──┘ :1 │ ┌──────────────┐ │ ┌─────────┐
└─────────┘ ┌──────┴────────┐ ├────┤ FProgressbar │ └──┤ FSwitch │
│ FWidgetColors │ │ └──────────────┘ └─────────┘
└───────────────┘ │ ┌────────────┐
├────┤ FScrollbar │
2018-10-29 00:45:45 +01:00
│ └────────────┘
│ ┌───────────┐
├────┤ FTextView │
│ └───────────┘
│ ┌───────────┐1 1┌──────────────────┐
├────┤ FComboBox ├------┤ FDropDownListBox │
│ └───────────┘ └──────────────────┘
2020-09-20 14:11:35 +02:00
┌─────────────┐1 │ ┌──────────┐1 *┌──────────────┐1
│ FTermBuffer ├----------------------├────┤ FListBox ├-------┤ FListBoxItem ├--┐
└─────────────┘ │ └──────────┘ └──────────────┘ :
│ 1┌───────────┐1 *┌───────────────┐ :
├────┤ FListView ├------┤ FListViewItem │ :
│ └───────────┘ └────────┬──────┘ :
│ ┌─────────────┐ :1 :
├────┤ FScrollView │ ┌───┴───┐1 :
│ └─────────────┘ │ FData ├----┘
│ └───────┘
2018-10-29 00:45:45 +01:00
│ ┌────────────┐1 *┌────────────┐
│ ┌──┤ FStatusBar ├-----┤ FStatusKey │
│ │ └────────────┘ └────────────┘
│ │
│ ▼ ┌─────────────┐
┌───┴─┴───┐ ┌─────────┐ ┌──┤ FFileDialog │
│ FWindow │◄─┤ FDialog │◄──┤ └─────────────┘
└──┬──┬───┘ └─────────┘ │ ┌─────────────┐
▲ ▲ └──┤ FMessageBox │
│ │ └─────────────┘
2020-06-11 21:38:33 +02:00
│ │ ┌──────────┐ ┌────────────────┐
│ └──────┤ FToolTip │◄─┤ FBusyIndicator │
│ └──────────┘ └────────────────┘
2018-10-29 00:45:45 +01:00
└───────────────┐ ┌──────────┐
│ ┌───┤ FMenuBar │
┌───────────┐ └──────┤ └──────────┘
│ FMenuList │◄──────────┤ ┌───────┐
└────┬──────┘ └───┤ FMenu │◄──┐
:1 └───────┘ │
: ┌─────────────────┐ │
: │ FDialogListMenu ├───┘
: └─────────────────┘
└--------------------------------┐
:* ┌────────────────┐* :
┌────┴─────┐ ┌──┤ FCheckMenuItem ├---┘
│FMenuItem │◄─┤ └────────────────┘ :
└──────────┘ │ ┌────────────────┐* :
└──┤ FRadioMenuItem ├---┘
└────────────────┘
2015-05-23 13:35:12 +02:00
</pre>
2017-11-03 05:04:27 +01:00
## Frequently Asked Questions
For general questions about FINAL CUT, likely the answer is already included in the [FAQ](doc/faq.md#frequently-asked-questions).
## Please send bug reports to
https://github.com/gansm/finalcut/issues
2020-02-08 21:31:21 +01:00
## License
2017-11-03 05:04:27 +01:00
GNU Lesser General Public License Version 3 <a href="https://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img width="200" align="right" src="https://camo.githubusercontent.com/726b87cc2ebaf8c40716842ff509c5f874381c8e/68747470733a2f2f75706c6f61642e77696b696d656469612e6f72672f77696b6970656469612f636f6d6d6f6e732f332f33622f4c47504c76335f4c6f676f2e737667" alt="LGPLv3" data-canonical-src="https://upload.wikimedia.org/wikipedia/commons/3/3b/LGPLv3_Logo.svg"></a>