Replace raw number by its name

PR #4373 <https://github.com/Genymobile/scrcpy/pull/4373>

Signed-off-by: Romain Vimont <rom@rom1v.com>

app/data/bash-completion/scrcpy

@@ -44,6 +44,8 @@ _scrcpy() {
         --no-video-playback
         --otg
         -p --port=
+        --pause-on-exit
+        --pause-on-exit=
         --power-off-on-close
         --prefer-text
         --print-fps
@@ -97,6 +99,10 @@ _scrcpy() {
             COMPREPLY=($(compgen -W 'unlocked initial 0 1 2 3' -- "$cur"))
             return
             ;;
+        --pause-on-exit)
+            COMPREPLY=($(compgen -W 'true false if-error' -- "$cur"))
+            return
+            ;;
         -r|--record)
             COMPREPLY=($(compgen -f -- "$cur"))
             return

app/data/scrcpy-console.bat

@@ -1,4 +1,2 @@
 @echo off
-scrcpy.exe %*
-:: if the exit code is >= 1, then pause
-if errorlevel 1 pause
+scrcpy.exe --pause-on-exit=if-error %*

app/data/scrcpy-console.desktop

@@ -5,7 +5,7 @@ Comment=Display and control your Android device
 # For some users, the PATH or ADB environment variables are set from the shell
 # startup file, like .bashrc or .zshrc… Run an interactive shell to get
 # environment correctly initialized.
-Exec=/bin/bash --norc --noprofile -i -c "\"\\$SHELL\" -i -c scrcpy || read -p 'Press Enter to quit...'"
+Exec=/bin/sh -c "\"\\$SHELL\" -i -c scrcpy --pause-on-exit=if-error"
 Icon=scrcpy
 Terminal=true
 Type=Application

app/data/zsh-completion/_scrcpy

@@ -50,6 +50,7 @@ arguments=(
     '--no-video-playback[Disable video playback]'
     '--otg[Run in OTG mode \(simulating physical keyboard and mouse\)]'
     {-p,--port=}'[\[port\[\:port\]\] Set the TCP port \(range\) used by the client to listen]'
+    '--pause-on-exit=[Make scrcpy pause before exiting]:mode:(true false if-error)'
     '--power-off-on-close[Turn the device screen off when closing scrcpy]'
     '--prefer-text[Inject alpha characters and space as text events instead of key events]'
     '--print-fps[Start FPS counter, to print frame logs to the console]'

app/scrcpy.1

@@ -267,6 +267,16 @@ Set the TCP port (range) used by the client to listen.
 
 Default is 27183:27199.
 
+.TP
+\fB\-\-pause\-on\-exit\fR[=\fImode\fR]
+Configure pause on exit. Possible values are "true" (always pause on exit), "false" (never pause on exit) and "if-error" (pause only if an error occured).
+
+This is useful to prevent the terminal window from automatically closing, so that error messages can be read.
+
+Default is "false".
+
+Passing the option without argument is equivalent to passing "true".
+
 .TP
 .B \-\-power\-off\-on\-close
 Turn the device screen off when closing scrcpy.

app/src/adb/adb.c

@@ -70,7 +70,7 @@ argv_to_string(const char *const *argv, char *buf, size_t bufsize) {
 }
 
 static void
-show_adb_installation_msg() {
+show_adb_installation_msg(void) {
 #ifndef __WINDOWS__
     static const struct {
         const char *binary;
@@ -218,8 +218,16 @@ sc_adb_forward(struct sc_intr *intr, const char *serial, uint16_t local_port,
                const char *device_socket_name, unsigned flags) {
     char local[4 + 5 + 1]; // tcp:PORT
     char remote[108 + 14 + 1]; // localabstract:NAME
-    sprintf(local, "tcp:%" PRIu16, local_port);
-    snprintf(remote, sizeof(remote), "localabstract:%s", device_socket_name);
+
+    int r = snprintf(local, sizeof(local), "tcp:%" PRIu16, local_port);
+    assert(r >= 0 && (size_t) r < sizeof(local));
+
+    r = snprintf(remote, sizeof(remote), "localabstract:%s",
+                 device_socket_name);
+    if (r < 0 || (size_t) r >= sizeof(remote)) {
+        LOGE("Could not write socket name");
+        return false;
+    }
 
     assert(serial);
     const char *const argv[] =
@@ -233,7 +241,9 @@ bool
 sc_adb_forward_remove(struct sc_intr *intr, const char *serial,
                       uint16_t local_port, unsigned flags) {
     char local[4 + 5 + 1]; // tcp:PORT
-    sprintf(local, "tcp:%" PRIu16, local_port);
+    int r = snprintf(local, sizeof(local), "tcp:%" PRIu16, local_port);
+    assert(r >= 0 && (size_t) r < sizeof(local));
+    (void) r;
 
     assert(serial);
     const char *const argv[] =
@@ -249,8 +259,16 @@ sc_adb_reverse(struct sc_intr *intr, const char *serial,
                unsigned flags) {
     char local[4 + 5 + 1]; // tcp:PORT
     char remote[108 + 14 + 1]; // localabstract:NAME
-    sprintf(local, "tcp:%" PRIu16, local_port);
-    snprintf(remote, sizeof(remote), "localabstract:%s", device_socket_name);
+    int r = snprintf(local, sizeof(local), "tcp:%" PRIu16, local_port);
+    assert(r >= 0 && (size_t) r < sizeof(local));
+
+    r = snprintf(remote, sizeof(remote), "localabstract:%s",
+                 device_socket_name);
+    if (r < 0 || (size_t) r >= sizeof(remote)) {
+        LOGE("Could not write socket name");
+        return false;
+    }
+
     assert(serial);
     const char *const argv[] =
         SC_ADB_COMMAND("-s", serial, "reverse", remote, local);
@@ -263,7 +281,12 @@ bool
 sc_adb_reverse_remove(struct sc_intr *intr, const char *serial,
                       const char *device_socket_name, unsigned flags) {
     char remote[108 + 14 + 1]; // localabstract:NAME
-    snprintf(remote, sizeof(remote), "localabstract:%s", device_socket_name);
+    int r = snprintf(remote, sizeof(remote), "localabstract:%s",
+                     device_socket_name);
+    if (r < 0 || (size_t) r >= sizeof(remote)) {
+        LOGE("Device socket name too long");
+        return false;
+    }
 
     assert(serial);
     const char *const argv[] =
@@ -333,7 +356,9 @@ bool
 sc_adb_tcpip(struct sc_intr *intr, const char *serial, uint16_t port,
              unsigned flags) {
     char port_string[5 + 1];
-    sprintf(port_string, "%" PRIu16, port);
+    int r = snprintf(port_string, sizeof(port_string), "%" PRIu16, port);
+    assert(r >= 0 && (size_t) r < sizeof(port_string));
+    (void) r;
 
     assert(serial);
     const char *const argv[] =

app/src/adb/adb_parser.c

@@ -7,7 +7,7 @@
 #include "util/log.h"
 #include "util/str.h"
 
-bool
+static bool
 sc_adb_parse_device(char *line, struct sc_adb_device *device) {
     // One device line looks like:
     // "0123456789abcdef	device usb:2-1 product:MyProduct model:MyModel "

app/src/cli.c

@@ -79,6 +79,7 @@ enum {
     OPT_AUDIO_SOURCE,
     OPT_KILL_ADB_ON_CLOSE,
     OPT_TIME_LIMIT,
+    OPT_PAUSE_ON_EXIT,
 };
 
 struct sc_option {
@@ -463,6 +464,20 @@ static const struct sc_option options[] = {
                 "Default is " STR(DEFAULT_LOCAL_PORT_RANGE_FIRST) ":"
                               STR(DEFAULT_LOCAL_PORT_RANGE_LAST) ".",
     },
+    {
+        .longopt_id = OPT_PAUSE_ON_EXIT,
+        .longopt = "pause-on-exit",
+        .argdesc = "mode",
+        .optional_arg = true,
+        .text = "Configure pause on exit. Possible values are \"true\" (always "
+                "pause on exit), \"false\" (never pause on exit) and "
+                "\"if-error\" (pause only if an error occured).\n"
+                "This is useful to prevent the terminal window from "
+                "automatically closing, so that error messages can be read.\n"
+                "Default is \"false\".\n"
+                "Passing the option without argument is equivalent to passing "
+                "\"true\".",
+    },
     {
         .longopt_id = OPT_POWER_OFF_ON_CLOSE,
         .longopt = "power-off-on-close",
@@ -1070,7 +1085,7 @@ print_shortcut(const struct sc_shortcut *shortcut, unsigned cols) {
     while (shortcut->shortcuts[i]) {
         printf("    %s\n", shortcut->shortcuts[i]);
         ++i;
-    };
+    }
 
     char *text = sc_str_wrap_lines(shortcut->text, cols, 8);
     if (!text) {
@@ -1637,6 +1652,29 @@ parse_time_limit(const char *s, sc_tick *tick) {
     return true;
 }
 
+static bool
+parse_pause_on_exit(const char *s, enum sc_pause_on_exit *pause_on_exit) {
+    if (!s || !strcmp(s, "true")) {
+        *pause_on_exit = SC_PAUSE_ON_EXIT_TRUE;
+        return true;
+    }
+
+    if (!strcmp(s, "false")) {
+        *pause_on_exit = SC_PAUSE_ON_EXIT_FALSE;
+        return true;
+    }
+
+    if (!strcmp(s, "if-error")) {
+        *pause_on_exit = SC_PAUSE_ON_EXIT_IF_ERROR;
+        return true;
+    }
+
+    LOGE("Unsupported pause on exit mode: %s "
+         "(expected true, false or if-error)", optarg);
+    return false;
+
+}
+
 static bool
 parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
                        const char *optstring, const struct option *longopts) {
@@ -1977,6 +2015,11 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
                     return false;
                 }
                 break;
+            case OPT_PAUSE_ON_EXIT:
+                if (!parse_pause_on_exit(optarg, &args->pause_on_exit)) {
+                    return false;
+                }
+                break;
             default:
                 // getopt prints the error message on stderr
                 return false;
@@ -2190,6 +2233,37 @@ parse_args_with_getopt(struct scrcpy_cli_args *args, int argc, char *argv[],
     return true;
 }
 
+static enum sc_pause_on_exit
+sc_get_pause_on_exit(int argc, char *argv[]) {
+    // Read arguments backwards so that the last --pause-on-exit is considered
+    // (same behavior as getopt())
+    for (int i = argc - 1; i >= 1; --i) {
+        const char *arg = argv[i];
+        // Starts with "--pause-on-exit"
+        if (!strncmp("--pause-on-exit", arg, 15)) {
+            if (arg[15] == '\0') {
+                // No argument
+                return SC_PAUSE_ON_EXIT_TRUE;
+            }
+            if (arg[15] != '=') {
+                // Invalid parameter, ignore
+                return SC_PAUSE_ON_EXIT_FALSE;
+            }
+            const char *value = &arg[16];
+            if (!strcmp(value, "true")) {
+                return SC_PAUSE_ON_EXIT_TRUE;
+            }
+            if (!strcmp(value, "if-error")) {
+                return SC_PAUSE_ON_EXIT_IF_ERROR;
+            }
+            // Set to false, inclusing when the value is invalid
+            return SC_PAUSE_ON_EXIT_FALSE;
+        }
+    }
+
+    return SC_PAUSE_ON_EXIT_FALSE;
+}
+
 bool
 scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
     struct sc_getopt_adapter adapter;
@@ -2203,5 +2277,11 @@ scrcpy_parse_args(struct scrcpy_cli_args *args, int argc, char *argv[]) {
 
     sc_getopt_adapter_destroy(&adapter);
 
+    if (!ret && args->pause_on_exit == SC_PAUSE_ON_EXIT_FALSE) {
+        // Check if "--pause-on-exit" is present in the arguments list, because
+        // it must be taken into account even if command line parsing failed
+        args->pause_on_exit = sc_get_pause_on_exit(argc, argv);
+    }
+
     return ret;
 }

app/src/cli.h

@@ -7,10 +7,17 @@
 
 #include "options.h"
 
+enum sc_pause_on_exit {
+    SC_PAUSE_ON_EXIT_TRUE,
+    SC_PAUSE_ON_EXIT_FALSE,
+    SC_PAUSE_ON_EXIT_IF_ERROR,
+};
+
 struct scrcpy_cli_args {
     struct scrcpy_options opts;
     bool help;
     bool version;
+    enum sc_pause_on_exit pause_on_exit;
 };
 
 void

app/src/icon.c

@@ -271,7 +271,7 @@ error:
 }
 
 SDL_Surface *
-scrcpy_icon_load() {
+scrcpy_icon_load(void) {
     char *icon_path = get_icon_path();
     if (!icon_path) {
         return NULL;

app/src/main.c

@@ -23,7 +23,7 @@
 #include "util/str.h"
 #endif
 
-int
+static int
 main_scrcpy(int argc, char *argv[]) {
 #ifdef _WIN32
     // disable buffering, we want logs immediately
@@ -39,26 +39,32 @@ main_scrcpy(int argc, char *argv[]) {
         .opts = scrcpy_options_default,
         .help = false,
         .version = false,
+        .pause_on_exit = SC_PAUSE_ON_EXIT_FALSE,
     };
 
 #ifndef NDEBUG
     args.opts.log_level = SC_LOG_LEVEL_DEBUG;
 #endif
 
+    enum scrcpy_exit_code ret;
+
     if (!scrcpy_parse_args(&args, argc, argv)) {
-        return SCRCPY_EXIT_FAILURE;
+        ret = SCRCPY_EXIT_FAILURE;
+        goto end;
     }
 
     sc_set_log_level(args.opts.log_level);
 
     if (args.help) {
         scrcpy_print_usage(argv[0]);
-        return SCRCPY_EXIT_SUCCESS;
+        ret = SCRCPY_EXIT_SUCCESS;
+        goto end;
     }
 
     if (args.version) {
         scrcpy_print_version();
-        return SCRCPY_EXIT_SUCCESS;
+        ret = SCRCPY_EXIT_SUCCESS;
+        goto end;
     }
 
 #ifdef SCRCPY_LAVF_REQUIRES_REGISTER_ALL
@@ -72,18 +78,26 @@ main_scrcpy(int argc, char *argv[]) {
 #endif
 
     if (!net_init()) {
-        return SCRCPY_EXIT_FAILURE;
+        ret = SCRCPY_EXIT_FAILURE;
+        goto end;
     }
 
     sc_log_configure();
 
 #ifdef HAVE_USB
-    enum scrcpy_exit_code ret = args.opts.otg ? scrcpy_otg(&args.opts)
-                                              : scrcpy(&args.opts);
+    ret = args.opts.otg ? scrcpy_otg(&args.opts) : scrcpy(&args.opts);
 #else
-    enum scrcpy_exit_code ret = scrcpy(&args.opts);
+    ret = scrcpy(&args.opts);
 #endif
 
+end:
+    if (args.pause_on_exit == SC_PAUSE_ON_EXIT_TRUE ||
+            (args.pause_on_exit == SC_PAUSE_ON_EXIT_IF_ERROR &&
+                ret != SCRCPY_EXIT_SUCCESS)) {
+        printf("Press Enter to continue...\n");
+        getchar();
+    }
+
     return ret;
 }
 

app/src/scrcpy.c

@@ -90,7 +90,7 @@ push_event(uint32_t type, const char *name) {
 #define PUSH_EVENT(TYPE) push_event(TYPE, # TYPE)
 
 #ifdef _WIN32
-BOOL WINAPI windows_ctrl_handler(DWORD ctrl_type) {
+static BOOL WINAPI windows_ctrl_handler(DWORD ctrl_type) {
     if (ctrl_type == CTRL_C_EVENT) {
         PUSH_EVENT(SDL_QUIT);
         return TRUE;
@@ -297,7 +297,7 @@ sc_timeout_on_timeout(struct sc_timeout *timeout, void *userdata) {
 
 // Generate a scrcpy id to differentiate multiple running scrcpy instances
 static uint32_t
-scrcpy_generate_scid() {
+scrcpy_generate_scid(void) {
     struct sc_rand rand;
     sc_rand_init(&rand);
     // Only use 31 bits to avoid issues with signed values on the Java-side

app/src/server.c

@@ -86,14 +86,15 @@ sc_server_params_copy(struct sc_server_params *dst,
     // The params reference user-allocated memory, so we must copy them to
     // handle them from another thread
 
-#define COPY(FIELD) \
+#define COPY(FIELD) do { \
     dst->FIELD = NULL; \
     if (src->FIELD) { \
         dst->FIELD = strdup(src->FIELD); \
         if (!dst->FIELD) { \
             goto error; \
         } \
-    }
+    } \
+} while(0)
 
     COPY(req_serial);
     COPY(crop);
@@ -215,13 +216,13 @@ execute_server(struct sc_server *server,
     cmd[count++] = SCRCPY_VERSION;
 
     unsigned dyn_idx = count; // from there, the strings are allocated
-#define ADD_PARAM(fmt, ...) { \
+#define ADD_PARAM(fmt, ...) do { \
         char *p; \
         if (asprintf(&p, fmt, ## __VA_ARGS__) == -1) { \
             goto end; \
         } \
         cmd[count++] = p; \
-    }
+    } while(0)
 
     ADD_PARAM("scid=%08x", params->scid);
     ADD_PARAM("log_level=%s", log_level_to_server_string(params->log_level));

app/src/usb/hid_keyboard.c

@@ -27,7 +27,8 @@
 // keyboard support, though OS could support more keys via modifying the report
 // desc. 6 should be enough for scrcpy.
 #define HID_KEYBOARD_MAX_KEYS 6
-#define HID_KEYBOARD_EVENT_SIZE (2 + HID_KEYBOARD_MAX_KEYS)
+#define HID_KEYBOARD_EVENT_SIZE \
+    (HID_KEYBOARD_INDEX_KEYS + HID_KEYBOARD_MAX_KEYS)
 
 #define HID_RESERVED 0x00
 #define HID_ERROR_ROLL_OVER 0x01

app/src/usb/usb.c

@@ -93,7 +93,7 @@ sc_usb_device_move(struct sc_usb_device *dst, struct sc_usb_device *src) {
     src->product = NULL;
 }
 
-void
+static void
 sc_usb_devices_destroy(struct sc_vec_usb_devices *usb_devices) {
     for (size_t i = 0; i < usb_devices->size; ++i) {
         sc_usb_device_destroy(&usb_devices->data[i]);

app/src/util/log.c

@@ -147,7 +147,7 @@ sc_sdl_log_print(void *userdata, int category, SDL_LogPriority priority,
 }
 
 void
-sc_log_configure() {
+sc_log_configure(void) {
     SDL_LogSetOutputFunction(sc_sdl_log_print, NULL);
     // Redirect FFmpeg logs to SDL logs
     av_log_set_callback(sc_av_log_callback);

app/src/util/log.h

@@ -36,6 +36,6 @@ sc_log_windows_error(const char *prefix, int error);
 #endif
 
 void
-sc_log_configure();
+sc_log_configure(void);
 
 #endif

app/src/util/vecdeque.h

@@ -190,10 +190,10 @@ sc_vecdeque_reallocdata_(void *ptr, size_t newcap, size_t item_size,
 
     size_t right_len = MIN(size, oldcap - oldorigin);
     assert(right_len);
-    memcpy(newptr, ptr + (oldorigin * item_size), right_len * item_size);
+    memcpy(newptr, (char *) ptr + (oldorigin * item_size), right_len * item_size);
 
     if (size > right_len) {
-        memcpy(newptr + (right_len * item_size), ptr,
+        memcpy((char *) newptr + (right_len * item_size), ptr,
                (size - right_len) * item_size);
     }
 

app/tests/test_bytebuf.c

@@ -5,7 +5,7 @@
 
 #include "util/bytebuf.h"
 
-void test_bytebuf_simple(void) {
+static void test_bytebuf_simple(void) {
     struct sc_bytebuf buf;
     uint8_t data[20];
 
@@ -34,7 +34,7 @@ void test_bytebuf_simple(void) {
     sc_bytebuf_destroy(&buf);
 }
 
-void test_bytebuf_boundaries(void) {
+static void test_bytebuf_boundaries(void) {
     struct sc_bytebuf buf;
     uint8_t data[20];
 
@@ -71,7 +71,7 @@ void test_bytebuf_boundaries(void) {
     sc_bytebuf_destroy(&buf);
 }
 
-void test_bytebuf_two_steps_write(void) {
+static void test_bytebuf_two_steps_write(void) {
     struct sc_bytebuf buf;
     uint8_t data[20];
 

app/tests/test_str.c

@@ -358,7 +358,7 @@ static void test_index_of_column(void) {
     assert(sc_str_index_of_column("  a bc  d", 1, " ") == 2);
 }
 
-static void test_remove_trailing_cr() {
+static void test_remove_trailing_cr(void) {
     char s[] = "abc\r";
     sc_str_remove_trailing_cr(s, sizeof(s) - 1);
     assert(!strcmp(s, "abc"));

app/tests/test_vecdeque.c

@@ -102,7 +102,7 @@ static void test_vecdeque_reserve(void) {
     sc_vecdeque_destroy(&vdq);
 }
 
-static void test_vecdeque_grow() {
+static void test_vecdeque_grow(void) {
     struct SC_VECDEQUE(int) vdq = SC_VECDEQUE_INITIALIZER;
 
     bool ok = sc_vecdeque_reserve(&vdq, 20);
@@ -142,7 +142,7 @@ static void test_vecdeque_grow() {
     sc_vecdeque_destroy(&vdq);
 }
 
-static void test_vecdeque_push_hole() {
+static void test_vecdeque_push_hole(void) {
     struct SC_VECDEQUE(int) vdq = SC_VECDEQUE_INITIALIZER;
 
     bool ok = sc_vecdeque_reserve(&vdq, 20);

app/tests/test_vector.c

@@ -187,7 +187,7 @@ static void test_vector_index_of(void) {
     sc_vector_destroy(&vec);
 }
 
-static void test_vector_grow() {
+static void test_vector_grow(void) {
     struct SC_VECTOR(int) vec = SC_VECTOR_INITIALIZER;
 
     bool ok;

meson.build

@@ -7,6 +7,8 @@ project('scrcpy', 'c',
             'b_ndebug=if-release',
         ])
 
+add_project_arguments('-Wmissing-prototypes', language: 'c')
+
 if get_option('compile_app')
     subdir('app')
 endif