Make startup verbosity configurable #477

kcgen · 2020-07-02T04:27:14Z

This is a rework of the prior instant launch PR, which was somewhat narrow in its focus.

This PR transforms that into the general concept of Startup Verbosity.

Level	Show Splash Window	Show Welcome Banner	Show pre-executable stdout	Program Display
High	yes	yes	yes	yes
Medium	no	yes	yes	yes
Low	no	no	yes	yes
Silent	no	no	no	yes

Graphically, this corresponds to:

Level	Show Splash Window	Show Welcome Banner	Show pre-executable stdout
High
Medium	no
Low	no	no
Silent	no	no	no

'high' startup verbosity is default

This guarantees the existing verbose behavior is retained for new users, while allowing experienced users to dial back the verbosity.

'auto' startup verbosity is available

auto is equivalent to "high" if dosbox was not passed an executable, and "low" if it was.

What is pre-executable stdout?

This is non-executable stdout constructed by dosbox prior to launching an executable or batch-file.

For example, when you give dosbox an executable to launch, ie: dosbox duke1/dn1.exe, it still generates the following stdout, which requires setting a graphical text mode window:

If verbosity is set to quiet, then this output is suppressed prior to the first executable.

How are batch files handled with 'silent' startup verbosity?

Any output generated in a batch file will be shown.

As described above, dosbox's stdout is suppressed prior to the first executable statement, after which stdout is re-enabled. Batch files are executable, so it's up to the batch file if it generates output (or not).

To make batch execution really quiet, ensure the first line in the batch file is: @echo off, which instructs DOS not to print each line in the file.

Inside the batch file, you can similarly hide a program's text output by redirecting its output, for example: noisy\game.exe > NUL.

dosbox.conf

kcgen · 2020-07-02T14:55:31Z

@dreamer , #478 has come just in time for this too. Will rebase this and see how this works under Windows 10 64-bit :-)

dreamer

I like the change, and it has a very high "user-visible improvement to lines of code" ratio ;)

I left some design-oriented comments to various parts of the implementation.

During testing I found two small problems:

"Silent" does not work so well - in smaller games it causes super fast flash of black screen (e.g. in "PAKU PAKU 1.6", in others the delay is uncomfortably longer (Wolfenstein 3D when games starts with default 3000 cycles). Also, despite suppression of output, some text still slips in: empty lines injected by who-knows-what part of dosbox implementation, text printed by DOS4/GW, DOS32/A, or the game itself…
Running dosbox path/to/dir (which triggers mounting directory as C) should trigger instant launch as well.

About (1) - I think we could leave this option in as it is, without redesing and improve it in future iterations / PRs.

About (2) - this should be a rather easy fix, I think?

src/misc/setup.cpp

src/misc/support.cpp

src/shell/shell.cpp

src/shell/shell_misc.cpp

src/dosbox.cpp

include/control.h

kcgen · 2020-07-02T22:22:48Z

Changes are in.

About (1) - I think we could leave this option in as it is, without redesigning and improve it in future iterations / PRs.

I like this step-wise approach; looking forward to more refinement!

About (2) - this should be a rather easy fix, I think?

It was just a couple lines, and working very nicely. Great suggestion @dreamer!

With this directory addition, auto lets me launch dosbox . or dosbox /some/dir very quickly and naturally, like spawning another Xterm (that just happens to be a DOS-interpreter)!

With this mental "startup weight" lifted, staging feels like a general tool for Linux and CLI users, and I now see myself using DOS CLI tools or MOD / MP3 players naturally into my daily workflow. This dovetails very nicely with LFN support!

dreamer

Nice :) And I'm glad you mentioned a new feature in README.

I left some additional comments, but at this point it's only polishing the code.

I performed some tests and in all cases I tried, the feature behaved according to user expectations :)

src/misc/setup.cpp

src/misc/support.cpp

src/misc/programs.cpp

[dosbox] startup_verbosity = high # medium, low, quiet, auto Also adds a GetStartupVerbosity() getter to the control class, so we can query this from various places. This commit is dormant though - no code uses it.

Verbosity::Quiet suppresses stdout prior launching an executable.

dreamer

Great feature; I will merge it in momentarily :)

dreamer · 2020-07-05T11:18:12Z

src/dosbox.cpp

@@ -444,6 +445,18 @@ void DOSBOX_Init(void) {
 	secprop->AddInitFunction(&TIMER_Init);//done
 	secprop->AddInitFunction(&CMOS_Init);//done

+	const char *verbosity_choices[] = {"high",   "medium", "low",
+	                                   "quiet", "auto",   0};
+	Pstring = secprop->Add_string("startup_verbosity", only_at_start, "high");


Nitpick: Pstring -> pstring (but it's minor I will merge it in anyway).

dreamer · 2020-07-05T11:22:29Z

And it's in; thanks @kcgen :)

gumispl · 2021-02-23T10:26:47Z

I have proposition for one extra mode.
We are using dosbox-staging for repackaging our old games to run on new computers.
Dosbox/Dosbox-staging are a great piece of software and we want to give proper credentials to it and always show DosBox splash window.
At the same time we would want to hide next screens - welcome banner and pre-executable stdout to not confuse users with irrelevant launching details.
Would this be easy change?

dreamer · 2021-02-23T11:05:29Z

@gumispl startup_verbosity = quiet does this exactly :)

gumispl · 2021-02-23T11:11:07Z

@dreamer It skips DosBox Splash entirely - I want to show it and then hide following screens.

kcgen · 2021-02-23T12:25:07Z

Maybe we call it:

startup_verbosity = splash
Or
startup_verbosity = splash_only

dreamer · 2021-02-23T16:39:16Z

@gumispl Ah, you're right - sorry :)

@kcgen splash_only seems like a good name.

kcgen · 2021-02-23T19:14:02Z

@gumispl ,

PR inbound for this: #912

Linux binaries: https://github.com/dosbox-staging/dosbox-staging/actions/runs/593614180
Windows binaries: https://github.com/dosbox-staging/dosbox-staging/actions/runs/593614178
macOS binaries: https://github.com/dosbox-staging/dosbox-staging/actions/runs/593614177

Feel free to give it a go (or build using the kc/splash-only-1 branch).

Much thanks!

kcgen mentioned this pull request Jul 2, 2020

Implement instant launch! #415

Closed

kcgen changed the title ~~Controls dosbox's verbosity prior to displaying the program~~ Control the startup verbosity, prior to displaying the program Jul 2, 2020

kcgen changed the title ~~Control the startup verbosity, prior to displaying the program~~ Make startup verbosity configurable Jul 2, 2020

kcgen requested a review from dreamer July 2, 2020 14:36

kcgen self-assigned this Jul 2, 2020

kcgen added the enhancement New feature or enhancement of existing features label Jul 2, 2020

kcgen linked an issue Jul 2, 2020 that may be closed by this pull request

Implement instant-launch #139

Closed

dreamer requested changes Jul 2, 2020

View reviewed changes

kcgen force-pushed the kc/startup-verbosity-1 branch from b8ea24b to 6d1fd36 Compare July 2, 2020 22:14

kcgen requested a review from dreamer July 2, 2020 22:23

kcgen force-pushed the kc/startup-verbosity-1 branch from 6d1fd36 to ac0b3e4 Compare July 3, 2020 01:49

dreamer requested changes Jul 5, 2020

View reviewed changes

src/misc/setup.cpp Outdated Show resolved Hide resolved

src/misc/setup.cpp Outdated Show resolved Hide resolved

src/misc/support.cpp Outdated Show resolved Hide resolved

src/misc/programs.cpp Outdated Show resolved Hide resolved

src/misc/programs.cpp Outdated Show resolved Hide resolved

dreamer added this to In progress in 0.76.0 release Jul 5, 2020

kcgen added 8 commits July 5, 2020 04:02

Add and use an is_executable_filename() support function

f44677f

Let CommandLine inidicate if it was passed an executable filename

68792d6

Let CommandLine inidicate if it was passed a directory

14b8545

Add a configurable "Startup Verbosity" setting

425f562

[dosbox] startup_verbosity = high # medium, low, quiet, auto Also adds a GetStartupVerbosity() getter to the control class, so we can query this from various places. This commit is dormant though - no code uses it.

Add startup Verbosity::High as pre-req for the Splash

cc66ab8

Add startup Verbosity::Medium as pre-req for the Welcome banner

305afb1

Add startup Verbosity::Low as pre-req for stdout prior to executable

6479ac7

Verbosity::Quiet suppresses stdout prior launching an executable.

List Startup Verbosity in README's table of differences

35b66dc

kcgen force-pushed the kc/startup-verbosity-1 branch from ac0b3e4 to 35b66dc Compare July 5, 2020 11:04

dreamer approved these changes Jul 5, 2020

View reviewed changes

dreamer merged commit 7530307 into master Jul 5, 2020

kcgen deleted the kc/startup-verbosity-1 branch July 5, 2020 11:31

kcgen moved this from In progress to Done in 0.76.0 release Aug 3, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make startup verbosity configurable #477

Make startup verbosity configurable #477

kcgen commented Jul 2, 2020 •

edited

kcgen commented Jul 2, 2020

dreamer left a comment

kcgen commented Jul 2, 2020 •

edited

dreamer left a comment •

edited

dreamer left a comment

dreamer Jul 5, 2020

dreamer commented Jul 5, 2020

gumispl commented Feb 23, 2021

dreamer commented Feb 23, 2021

gumispl commented Feb 23, 2021

kcgen commented Feb 23, 2021 •

edited

dreamer commented Feb 23, 2021

kcgen commented Feb 23, 2021 •

edited

Make startup verbosity configurable #477

Make startup verbosity configurable #477

Conversation

kcgen commented Jul 2, 2020 • edited

'high' startup verbosity is default

'auto' startup verbosity is available

What is pre-executable stdout?

How are batch files handled with 'silent' startup verbosity?

kcgen commented Jul 2, 2020

dreamer left a comment

Choose a reason for hiding this comment

kcgen commented Jul 2, 2020 • edited

dreamer left a comment • edited

Choose a reason for hiding this comment

dreamer left a comment

Choose a reason for hiding this comment

dreamer Jul 5, 2020

Choose a reason for hiding this comment

dreamer commented Jul 5, 2020

gumispl commented Feb 23, 2021

dreamer commented Feb 23, 2021

gumispl commented Feb 23, 2021

kcgen commented Feb 23, 2021 • edited

dreamer commented Feb 23, 2021

kcgen commented Feb 23, 2021 • edited

kcgen commented Jul 2, 2020 •

edited

kcgen commented Jul 2, 2020 •

edited

dreamer left a comment •

edited

kcgen commented Feb 23, 2021 •

edited

kcgen commented Feb 23, 2021 •

edited