new command line options; fast screenshot; doc update

cmd line options --resetSettings, --verbose:
Reset persistent settings, start with default values
Verbose tracing of the program startup steps (debugging support)
make screenshot/hardcopy with default name (date_time.png) without asking

Signed-off-by: Martin <Ho-Ro@users.noreply.github.com>

Author: Ho-Ro

README.md

@@ -5,7 +5,6 @@
 [![GitHub commits since latest release](https://img.shields.io/github/commits-since/OpenHantek/OpenHantek6022/latest?color=blue)](https://github.com/OpenHantek/OpenHantek6022/commits/master)
 
 [![GitHub CI](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml/badge.svg)](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml)
-[![CodeFactor](https://www.codefactor.io/repository/github/openhantek/openhantek6022/badge)](https://www.codefactor.io/repository/github/openhantek/openhantek6022)
 
 OpenHantek6022 is a free software for **Hantek DSO6022** USB digital signal oscilloscopes that is actively developed on
 [github.com/OpenHantek/OpenHantek6022](https://github.com/OpenHantek/OpenHantek6022) - but only for Hantek 6022BE/BL and compatible scopes (Voltcraft, Darkwire, Protek, Acetech, etc.).
@@ -90,7 +89,7 @@ that builds and packages OpenHantek6022 for:
 * Windows (MSVS-2019)
 
 [![GitHub CI](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml/badge.svg)](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml)
-This status badge here (and on top of this page) show the build status.
+This status badge here (and on top) show the build status.
 
 ## Building OpenHantek6022 from source
 The preferred way to run OpenHantek is to build it from source on your system,
@@ -108,20 +107,20 @@ To make building for Linux even easier, I provide two shell scripts:
 If you make small changes to the local source code, it is sufficient to call `make -j4` or `fakeroot make -j4 package` in the `build` directory.
 
 ## Install prebuilt binary packages
-* Download Linux (built on Ubuntu 1804 LTS), Raspberry Pi (Debian stable), FreeBSD (12.1), macOS (Catalina) and Windows (Visual Studio 2019) packages for your convenience from the [Releases](https://github.com/OpenHantek/OpenHantek6022/releases) page.
-* If you want to follow ongoing development, packages built from the last commit are available in the [unstable release](https://github.com/OpenHantek/OpenHantek6022/releases/tag/unstable).
+* Download Linux (built on Ubuntu 1804 LTS), Raspberry Pi (Debian stable), FreeBSD (12.1), macOS (Catalina 10.15) and Windows (Visual Studio 2019) packages for your convenience from the [Releases](https://github.com/OpenHantek/OpenHantek6022/releases) page.
+* If you want to follow ongoing development, packages built from a fairly recent commit are available in the [unstable release](https://github.com/OpenHantek/OpenHantek6022/releases/tag/unstable).
 * For RPi4 see also [issue #28](https://github.com/OpenHantek/OpenHantek6022/issues/28).
 * These binary packages are built on stable operating system versions and require an up-to-date system.
 * As I develop on a *Debian stable* system my preferred (native) package format is `*.deb`.
-The program itself and the `*.deb` package is tested on my local system for completeness and correctness.
-The prebuilt packages are not tested, neither is the installation of the `*.rpm` packages.
+The program itself and the `*.deb` package built on my local system is tested for completeness and correctness.
+The precompiled packages are only randomly tested - if at all - and the installation of the `*.rpm` packages is untested.
 * To install the downloaded `*.deb` package, open a terminal window, go to the package directory and enter the command (as root) `apt install ./openhantek_..._amd64.deb`.
 This command will automatically install all dependencies of the program as well.
 * For installation of `*.rpm` packages follow similar rules, e.g. `dnf install ./openhantek-...-1.x86_64.rpm`.
 * The `*.tar.gz` achives contain the same files as the `*.deb` and `*.rpm` packages for quick testing - do not use for a permanent intallation. Do not report any issues about the `*.tar.gz`!
 * Get macOS packages from [macports](https://www.macports.org/ports.php?by=name&substr=openhantek) - thx [ra1nb0w](https://github.com/ra1nb0w).
 * Get [Fedora rpm packages](https://pkgs.org/download/openhantek) - thx [Vascom](https://github.com/Vascom).
-* Download [(untested) builds from last commit](https://ci.appveyor.com/project/Ho-Ro/openhantek6022). Select the preferred `Image` and go to `Artifacts`.
+* Download [(untested) builds from last commit(s)](https://github.com/OpenHantek/OpenHantek6022/actions/workflows/build_check.yml). Select the preferred `workflow run` and go to `Artifacts`.
 
 ## Run OpenHantek6022
 On a Linux system start the program via the menu entry *OpenHantek (Digital Storage Oscilloscope)* or from a terminal window as `OpenHantek`.

openhantek/src/OH_BUILD.h

@@ -1,2 +1,2 @@
 // Do not edit, will be re-created at each commit!
-#define OH_BUILD "20210418 - commit 891"
+#define OH_BUILD "20210423 - commit 892"

openhantek/src/OH_VERSION.h

@@ -7,7 +7,7 @@
 
 // next line shall define either OH_VERSION or LAST_OH_VERSION
 //
-#define OH_VERSION "3.2.2"
+#define LAST_OH_VERSION "3.2.2"
 
 
 // do not edit below

openhantek/src/dsosettings.cpp

@@ -9,9 +9,9 @@
 
 /// \brief Set the number of channels.
 /// \param channels The new channel count, that will be applied to lists.
-DsoSettings::DsoSettings( const ScopeDevice *scopeDevice )
+DsoSettings::DsoSettings( const ScopeDevice *scopeDevice, bool resetSettings )
     : deviceName( scopeDevice->getModel()->name ), deviceID( scopeDevice->getSerialNumber() ),
-      deviceSpecification( scopeDevice->getModel()->spec() ) {
+      deviceSpecification( scopeDevice->getModel()->spec() ), resetSettings( resetSettings ) {
 
     // Add new channels to the list
     int voltage_hue[] = {60, 210, 0, 120};   // yellow, lightblue, red, green
@@ -51,6 +51,11 @@ DsoSettings::DsoSettings( const ScopeDevice *scopeDevice )
     view.print.spectrum.push_back( QColor::fromHsv( 320, 0xff, 0xff ) );
 
     // create an unique storage for this device based on device name and serial number
+    // individual device settings location:
+    // Linux, Unix: $HOME/.config/OpenHantek/<deviceName>_<deviceID>.conf
+    // macOS:       $HOME/Library/Preferences/org.openhantek.<deviceName>_<deviceID>.plist
+    // Windows:     HKEY_CURRENT_USER\Software\OpenHantek\<deviceName>_<deviceID>
+    // more info:   https://doc.qt.io/qt-5/qsettings.html#platform-specific-notes
     storeSettings =
         std::unique_ptr< QSettings >( new QSettings( QCoreApplication::organizationName(), deviceName + "_" + deviceID ) );
     // and get the persistent settings
@@ -73,7 +78,7 @@ bool DsoSettings::setFilename( const QString &filename ) {
 // called by "DsoSettings::DsoSettings" and explicitely by "ui->actionOpen"
 void DsoSettings::load() {
     // Start with default configuration?
-    if ( storeSettings->value( "configuration/version", 0 ).toUInt() < CONFIG_VERSION ) {
+    if ( resetSettings || storeSettings->value( "configuration/version", 0 ).toUInt() < CONFIG_VERSION ) {
         // incompatible change or config reset by user
         storeSettings->clear(); // start with a clean config storage
         QSettings().clear();    // and a clean global storage

openhantek/src/dsosettings.h

@@ -22,7 +22,7 @@ class DsoSettings {
     Q_DECLARE_TR_FUNCTIONS( DsoSettings )
 
   public:
-    explicit DsoSettings( const ScopeDevice *scopeDevice );
+    explicit DsoSettings( const ScopeDevice *scopeDevice, bool resetSettings = false );
     bool setFilename( const QString &filename );
 
     DsoSettingsScope scope;                  ///< All oscilloscope related settings
@@ -47,4 +47,5 @@ class DsoSettings {
     std::unique_ptr< QSettings > storeSettings;
     const Dso::ControlSpecification *deviceSpecification;
     void setDefaultConfig();
+    bool resetSettings = false;
 };

openhantek/src/main.cpp

@@ -4,6 +4,7 @@
 #include <QCommandLineParser>
 #include <QDebug>
 #include <QDesktopWidget>
+#include <QElapsedTimer>
 #include <QLibraryInfo>
 #include <QLocale>
 #include <QStyleFactory>
@@ -48,11 +49,6 @@
 #include "exporting/exporterprocessor.h"
 #include "exporting/exporterregistry.h"
 #include "exporting/exportjson.h"
-// legacy img and pdf export is replaced by MainWindow::screenshot()
-#ifdef LEGACYEXPORT
-#include "exporting/exportimage.h"
-#include "exporting/exportprint.h"
-#endif
 
 // GUI
 #include "iconfont/QtAwesome.h"
@@ -75,9 +71,21 @@ using namespace Hantek;
 
 /// \brief Initialize resources and translations and show the main window.
 int main( int argc, char *argv[] ) {
-#ifndef Q_OS_WIN
-    unsetenv( "LANGUAGE" ); // this ENV variable hides the LANG=xx setting, not available under Windows
+
+#ifdef Q_OS_WIN
+    // Win: close "extra" console window but if started from cmd.exe use this console
+    if ( FreeConsole() && AttachConsole( ATTACH_PARENT_PROCESS ) ) {
+        freopen( "CONOUT$", "w", stdout );
+        freopen( "CONOUT$", "w", stderr );
+    }
+#else
+    // this ENV variable hides the LANG=xx setting, fkt. not available under Windows
+    unsetenv( "LANGUAGE" );
 #endif
+
+    QElapsedTimer startupTime;
+    startupTime.start(); // time tracking for verbose startup
+
     //////// Set application information ////////
     QCoreApplication::setOrganizationName( "OpenHantek" );
     QCoreApplication::setOrganizationDomain( "openhantek.org" );
@@ -88,24 +96,23 @@ int main( int argc, char *argv[] ) {
     QCoreApplication::setAttribute( Qt::AA_EnableHighDpiScaling, true );
 #endif
 
-#ifdef Q_OS_WIN
-    // close "extra" console window but if started from cmd.exe use this console
-    if ( FreeConsole() && AttachConsole( ATTACH_PARENT_PROCESS ) ) {
-        freopen( "CONOUT$", "w", stdout );
-        freopen( "CONOUT$", "w", stderr );
-    }
-#endif
-
     bool demoMode = false;
     bool useGLES = false;
     bool useGLSL120 = false;
     bool useGLSL150 = false;
     bool useLocale = true;
+    bool verboseStartup = false;
+    bool resetSettings = false;
     QString font = defaultFont;       // defined in viewsettings.h
     int fontSize = defaultFontSize;   // defined in viewsettings.h
     int condensed = defaultCondensed; // defined in viewsettings.h
 
-    { // do this once at program start ...
+    { // do this early at program start ...
+        // get font size settings:
+        // Linux, Unix: $HOME/.config/OpenHantek/OpenHantek6022.conf
+        // macOS:       $HOME/Library/Preferences/org.openhantek.OpenHantek6022.plist
+        // Windows:     HKEY_CURRENT_USER\Software\OpenHantek\OpenHantek6022"
+        // more info:   https://doc.qt.io/qt-5/qsettings.html#platform-specific-notes
         QSettings storeSettings;
         storeSettings.beginGroup( "view" );
         if ( storeSettings.contains( "fontSize" ) )
@@ -135,6 +142,10 @@ int main( int argc, char *argv[] ) {
         QCommandLineOption condensedOption(
             {"c", "condensed"}, QString( "Set the font condensed value (default = %1)" ).arg( condensed ), "Condensed" );
         p.addOption( condensedOption );
+        QCommandLineOption resetSettingsOption( "resetSettings", "Reset persistent settings, start with default" );
+        p.addOption( resetSettingsOption );
+        QCommandLineOption verboseOption( "verbose", "Verbose tracing of the program startup steps" );
+        p.addOption( verboseOption );
         p.process( parserApp );
         demoMode = p.isSet( demoModeOption );
         useGLES = p.isSet( useGlesOption );
@@ -147,22 +158,28 @@ int main( int argc, char *argv[] ) {
         useGLSL120 = p.isSet( useGLSL120Option );
         useGLSL150 = p.isSet( useGLSL150Option );
         useLocale = !p.isSet( intOption );
+        verboseStartup = p.isSet( verboseOption );
+        resetSettings = p.isSet( resetSettingsOption );
     } // ... and forget the no more needed variables
 
 #ifdef Q_PROCESSOR_ARM
     // HACK: Raspberry Pi crashes with OpenGL, use always OpenGLES
     useGLES = true;
 #endif
 
-    GlScope::useQSurfaceFormat( useGLES ? QSurfaceFormat::OpenGLES : QSurfaceFormat::OpenGL );
-    if ( useGLSL120 )
-        GlScope::useOpenGLSLversion( 120 );
-    else if ( useGLSL150 )
-        GlScope::useOpenGLSLversion( 150 );
+    if ( verboseStartup ) {
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "OpenHantek6022 - version" << VERSION;
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "create openHantekApplication";
+    }
     QApplication openHantekApplication( argc, argv );
 
 // Qt5 linux default ("Breeze", "Windows" or "Fusion")
 #ifndef Q_OS_MACOS
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "set \"Fusion\" style";
     openHantekApplication.setStyle( QStyleFactory::create( "Fusion" ) ); // smaller widgets allow stacking of all docks
 #endif
 
@@ -175,13 +192,19 @@ int main( int argc, char *argv[] ) {
     //    usermod -a -G audio <your_user_name>
     // or set the limits only for your user in /etc/security/limits.d:
     //    <your_user_name> - rtprio 99
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "set RT FIFO scheduler";
     struct sched_param schedParam;
     schedParam.sched_priority = 9;                    // set RT priority level 10
     sched_setscheduler( 0, SCHED_FIFO, &schedParam ); // and RT FIFO scheduler
-// but ignore any error if user has no realtime rights
+    // but ignore any error if user has no realtime rights
 #endif
 
     //////// Load translations ////////
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "load translations for locale" << QLocale().name();
     QTranslator qtTranslator;
     QTranslator openHantekTranslator;
     if ( useLocale && QLocale().name() != "en_US" ) { // somehow Qt on MacOS uses the german translation for en_US?!
@@ -200,6 +223,9 @@ int main( int argc, char *argv[] ) {
     std::unique_ptr< ScopeDevice > scopeDevice = nullptr;
 
     if ( !demoMode ) {
+        if ( verboseStartup )
+            qDebug() << startupTime.elapsed() << "ms:"
+                     << "init libusb";
         int error = libusb_init( &context );
         if ( error ) {
             SelectSupportedDevice().showLibUSBFailedDialogModel( error );
@@ -209,6 +235,9 @@ int main( int argc, char *argv[] ) {
             libusb_setlocale( QLocale().name().toLocal8Bit().constData() );
 
         // SelectSupportedDevive returns a real device unless demoMode is true
+        if ( verboseStartup )
+            qDebug() << startupTime.elapsed() << "ms:"
+                     << "show splash screen";
         scopeDevice = SelectSupportedDevice().showSelectDeviceModal( context );
         if ( scopeDevice && scopeDevice->isDemoDevice() ) {
             demoMode = true;
@@ -229,8 +258,14 @@ int main( int argc, char *argv[] ) {
 
     // Here we have either a connected scope device or a demo device w/o hardware
     const DSOModel *model = scopeDevice->getModel();
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "use device" << scopeDevice->getModel()->name << "serial number" << scopeDevice->getSerialNumber();
 
     //////// Create DSO control object and move it to a separate thread ////////
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "create DSO control thread";
     QThread dsoControlThread;
     dsoControlThread.setObjectName( "dsoControlThread" );
     HantekDsoControl dsoControl( scopeDevice.get(), model );
@@ -245,9 +280,15 @@ int main( int argc, char *argv[] ) {
     const Dso::ControlSpecification *spec = model->spec();
 
     //////// Create settings object specific to this scope, use unique serial number ////////
-    DsoSettings settings( scopeDevice.get() );
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "create settings object";
+    DsoSettings settings( scopeDevice.get(), resetSettings );
 
     //////// Create exporters ////////
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "create exporters";
     ExporterRegistry exportRegistry( spec, &settings );
     ExporterCSV exporterCSV;
     ExporterJSON exporterJSON;
@@ -256,6 +297,9 @@ int main( int argc, char *argv[] ) {
     exportRegistry.registerExporter( &exporterJSON );
 
     //////// Create post processing objects ////////
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "create post processing objects";
     QThread postProcessingThread;
     postProcessingThread.setObjectName( "postProcessingThread" );
     PostProcessing postProcessing( settings.scope.countChannels() );
@@ -274,9 +318,17 @@ int main( int argc, char *argv[] ) {
     QObject::connect( &postProcessing, &PostProcessing::processingFinished, &exportRegistry, &ExporterRegistry::input,
                       Qt::DirectConnection );
 
-    //////// Create main window ////////
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "setup OpenGL";
+    GlScope::useQSurfaceFormat( useGLES ? QSurfaceFormat::OpenGLES : QSurfaceFormat::OpenGL );
+    if ( useGLSL120 )
+        GlScope::useOpenGLSLversion( 120 );
+    else if ( useGLSL150 )
+        GlScope::useOpenGLSLversion( 150 );
 
-    // Apply the font size and style settings for the scope application
+    //////// Prepare visual appearance ////////
+    // prepare the font size and style settings for the scope application
     QFont appFont = openHantekApplication.font();
     if ( 0 == fontSize ) {                               // option -s0 -> use system font size
         fontSize = qBound( 6, appFont.pointSize(), 24 ); // values < 6 do not scale correctly
@@ -287,10 +339,18 @@ int main( int argc, char *argv[] ) {
     appFont.setStretch( condensed );
     appFont.setPointSize( fontSize ); // scales the widgets accordingly
     // apply new font settings for the scope application
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "set" << appFont;
     openHantekApplication.setFont( appFont );
     openHantekApplication.setFont( appFont, "QWidget" ); // on some systems the 2nd argument is required
 
     iconFont->initFontAwesome();
+
+    //////// Create main window ////////
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "create main window";
     MainWindow openHantekMainWindow( &dsoControl, &settings, &exportRegistry );
     QObject::connect( &postProcessing, &PostProcessing::processingFinished, &openHantekMainWindow, &MainWindow::showNewData );
     QObject::connect( &exportRegistry, &ExporterRegistry::exporterProgressChanged, &openHantekMainWindow,
@@ -300,15 +360,24 @@ int main( int argc, char *argv[] ) {
     openHantekMainWindow.show();
 
     //////// Start DSO thread and go into GUI main loop
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "start DSO control thread";
     dsoControl.enableSampling( true );
     postProcessingThread.start();
     dsoControlThread.start();
     Capturing capturing( &dsoControl );
     capturing.start();
 
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "execute GUI main loop";
     int appStatus = openHantekApplication.exec();
 
     //////// Application closed, clean up step by step ////////
+    if ( verboseStartup )
+        qDebug() << startupTime.elapsed() << "ms:"
+                 << "application closed, clean up";
 
     std::cout << std::unitbuf; // enable automatic flushing
     std::cout << "OpenHantek6022 ";