refactor(main): move remaining entry related code #2127

ReenigneArcher · 2024-02-10T15:49:48Z

Description

This PR moves remaining entry point related code out of main. I wasn't sure of a better way to separate this.

Screenshot

Issues Fixed or Closed

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Dependency update (updates to dependencies)
Documentation update (changes to documentation)
Repository update (changes to repository files, e.g. .github/...)

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added or updated the in code docstring/documentation-blocks for new or existing methods/components

Branch Updates

LizardByte requires that branches be up-to-date before merging. This means that after any PR is merged, this branch
must be updated before it can be merged. You must also
Allow edits from maintainers.

I want maintainers to keep my branch updated

src/config.cpp

ReenigneArcher · 2024-02-10T15:52:46Z

src/entry_handler.cpp

+  char **argv;
+  std::atomic_int desired_exit_code;


static was removed from these, as it wouldn't compile.

src/main.cpp

src/entry_handler.h

ReenigneArcher · 2024-02-10T16:18:46Z

src/main.cpp

+  { "creds"sv, args::creds },
+  { "help"sv, args::help },
+  { "version"sv, args::version },
 #ifdef _WIN32
-  { "restore-nvprefs-undo"sv, restore_nvprefs_undo::entry },
+  { "restore-nvprefs-undo"sv, args::restore_nvprefs_undo },


Refactored CLI args into one namepsace.

cgutman · 2024-02-10T21:55:55Z

src/stream.cpp

@@ -18,14 +18,16 @@ extern "C" {
 }

 #include "config.h"
+#include "entry_handler.h"


What entry handler functions are these (stream.cpp, rtsp.cpp, etc) using?

Let me double check... it might have been from before I created the globals.

Here's a table of the files I added entry_handler to. I'll remove it from the ones without a check.

source file mail nv_prefs_instance lifetime service_ctlr launch_ui launch_ui_with_path

src/audio.cpp ✅

src/config.cpp ✅ ✅

src/confighttp.cpp ✅

src/input.cpp

src/nvhttp.cpp ✅

src/platform/linux/audio.cpp

src/platform/linux/misc.cpp ✅

src/platform/linux/x11grab.cpp

src/platform/macos/misc.mm ✅

src/platform/windows/input.cpp

src/platform/windows/misc.cpp ✅ ✅

src/rtsp.cpp ✅

src/stream.cpp

src/system_tray.cpp ✅ ✅ ✅

src/upnp.cpp ✅

src/video.cpp

src/platform/linux/audio.cpp gives the following errors without entry_handler.h:

No type named 'thread' in namespace 'std'; did you mean 'boost::thread'?: 201

No member named 'thread' in namespace 'std': 238

Expected ';' after expression: 238

Expected ';' after expression: 239

Probably a better fix than inclduing entry_handler.h exists.

Solved audio.cpp by including <thread>

I think moving the whole mail namespace into globals.cpp/h would clean things up nicely. It's a process-wide communication mechanism, so I think it makes sense for it to live with other global state.

Sounds good. I'll work on that.

Done in a71d3b6

There was no mail in entry_handler.cpp, only in the header.

I made a few more tweaks, but I think this is ready now.

moved nvprefs_instance to globals

added/updated some documentation blocks in globals.cpp and entry_handler.cpp

changed the input validation of the creds arg to the just use the help function within the args namespace

ReenigneArcher commented Feb 10, 2024

View reviewed changes

ReenigneArcher force-pushed the refactor(main)-move-remaining-entry-related-code branch 2 times, most recently from a82200a to eb78805 Compare February 10, 2024 16:05

ReenigneArcher added this to the Implement Unit Testing milestone Feb 10, 2024

ReenigneArcher force-pushed the refactor(main)-move-remaining-entry-related-code branch from eb78805 to ba2906b Compare February 10, 2024 16:17

ReenigneArcher commented Feb 10, 2024

View reviewed changes

ReenigneArcher requested a review from cgutman February 10, 2024 16:34

ReenigneArcher marked this pull request as ready for review February 10, 2024 16:39

This comment was marked as resolved.

Sign in to view

ReenigneArcher force-pushed the refactor(main)-move-remaining-entry-related-code branch 2 times, most recently from c00d53c to 5310c7d Compare February 10, 2024 19:56

cgutman reviewed Feb 10, 2024

View reviewed changes

ReenigneArcher force-pushed the refactor(main)-move-remaining-entry-related-code branch 3 times, most recently from e7faeb5 to a71d3b6 Compare February 11, 2024 02:28

ReenigneArcher added 7 commits February 11, 2024 09:14

refactor(main): move remaining entry related code

16a1db4

refactor(main): move globals out of main

2673bb9

include thread and remove dangling entry_handler includes

19769a5

docs(src): add globals documentation

5be6cfb

remove unused imports from main.cpp

6d595c5

refactor(mail): move mail to globals

7b18b7a

revert removal of #include <libavutil/log.h>

dc2d416

ReenigneArcher force-pushed the refactor(main)-move-remaining-entry-related-code branch from 5a95c69 to dc2d416 Compare February 11, 2024 14:17

ReenigneArcher added 3 commits February 11, 2024 09:36

docs(src): add documentation blocks to globals.cpp

2e8d51e

refactor(globals): move nvprefs_instance to globals

b18b6ce

docs(src): add/update documentation blocks for entry_handler.cpp

e0a66d0

cgutman approved these changes Feb 11, 2024

View reviewed changes

ReenigneArcher merged commit 8689469 into nightly Feb 11, 2024
44 checks passed

ReenigneArcher deleted the refactor(main)-move-remaining-entry-related-code branch February 11, 2024 19:15

KuleRucket pushed a commit to KuleRucket/Sunshine that referenced this pull request Jun 6, 2024

refactor(main): move remaining entry related code (LizardByte#2127)

2577925

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(main): move remaining entry related code #2127

refactor(main): move remaining entry related code #2127

ReenigneArcher commented Feb 10, 2024

ReenigneArcher Feb 10, 2024

ReenigneArcher Feb 10, 2024

This comment was marked as resolved.

cgutman Feb 10, 2024

ReenigneArcher Feb 10, 2024

ReenigneArcher Feb 10, 2024

ReenigneArcher Feb 10, 2024

cgutman Feb 11, 2024

ReenigneArcher Feb 11, 2024

ReenigneArcher Feb 11, 2024 •

edited

Loading

ReenigneArcher Feb 11, 2024

source file	mail	nv_prefs_instance	lifetime	service_ctlr	launch_ui	launch_ui_with_path
src/audio.cpp	✅
src/config.cpp				✅	✅
src/confighttp.cpp	✅
src/input.cpp
src/nvhttp.cpp	✅
src/platform/linux/audio.cpp
src/platform/linux/misc.cpp			✅
src/platform/linux/x11grab.cpp
src/platform/macos/misc.mm			✅
src/platform/windows/input.cpp
src/platform/windows/misc.cpp		✅	✅
src/rtsp.cpp	✅
src/stream.cpp
src/system_tray.cpp			✅		✅	✅
src/upnp.cpp	✅
src/video.cpp

refactor(main): move remaining entry related code #2127

refactor(main): move remaining entry related code #2127

Conversation

ReenigneArcher commented Feb 10, 2024

Description

Screenshot

Issues Fixed or Closed

Type of Change

Checklist

Branch Updates

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ReenigneArcher Feb 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ReenigneArcher Feb 11, 2024 •

edited

Loading