bug fix uv_spawn usage, add example and test

Author: TheTechsTech

CMakeLists.txt

@@ -26,7 +26,7 @@ find_package(raii QUIET)
 if(NOT raii_FOUND)
     FetchContent_Declare(raii
         URL https://github.com/zelang-dev/c-raii/archive/refs/heads/main.zip
-        URL_MD5 5381f3b2c240e778a3d5d1d75a3a42e9
+        URL_MD5 3dc8b8eaf534a3569d3f76805a4cfc15
     )
     FetchContent_MakeAvailable(raii)
 endif()

README.md

@@ -71,6 +71,7 @@ int main() {
 
 * [Reading/Writing files](https://docs.libuv.org/en/v1.x/guide/filesystem.html#reading-writing-files) as in [uvcat/main.c](https://github.com/libuv/libuv/blob/master/docs/code/uvcat/main.c) - 62 line *script*.
 * [Buffers and Streams](https://docs.libuv.org/en/v1.x/guide/filesystem.html#buffers-and-streams) as in [uvtee/main.c](https://github.com/libuv/libuv/blob/master/docs/code/uvtee/main.c) - 79 line *script*.
+* [Spawning child processes](https://docs.libuv.org/en/v1.x/guide/processes.html#spawning-child-processes) as in [spawn/main.c](https://github.com/libuv/libuv/blob/master/docs/code/spawn/main.c) - 36 line *script*.
 * [Networking/TCP](https://docs.libuv.org/en/v1.x/guide/networking.html#tcp) as in [tcp-echo-server/main.c](https://github.com/libuv/libuv/blob/master/docs/code/tcp-echo-server/main.c) - 87 line *script*.
 
 *Reduced to:*
@@ -128,6 +129,33 @@ int uv_main(int argc, char **argv) {
 </tr>
 </table>
 
+<table>
+<tr>
+<th>spawn.c - 13 lines</th>
+</tr>
+<tr>
+<td>
+
+```c
+#include "uv_coro.h"
+
+void _on_exit(int64_t exit_status, int term_signal) {
+    fprintf(stderr, "\nProcess exited with status %" PRId64 ", signal %d\n", exit_status, term_signal);
+}
+
+int uv_main(int argc, char **argv) {
+    spawn_t child = spawn("mkdir", "test-dir", nullptr);
+    if (!spawn_atexit(child, _on_exit))
+        fprintf(stderr, "\nLaunched process with ID %d\n", spawn_pid(child));
+
+    return coro_err_code();
+}
+```
+
+</td>
+</tr>
+</table>
+
 <table>
 <tr>
 <th>tcp-echo-server.c - 27 lines</th>

docs/index.md

@@ -71,6 +71,7 @@ int main() {
 
 * [Reading/Writing files](https://docs.libuv.org/en/v1.x/guide/filesystem.html#reading-writing-files) as in [uvcat/main.c](https://github.com/libuv/libuv/blob/master/docs/code/uvcat/main.c) - 62 line *script*.
 * [Buffers and Streams](https://docs.libuv.org/en/v1.x/guide/filesystem.html#buffers-and-streams) as in [uvtee/main.c](https://github.com/libuv/libuv/blob/master/docs/code/uvtee/main.c) - 79 line *script*.
+* [Spawning child processes](https://docs.libuv.org/en/v1.x/guide/processes.html#spawning-child-processes) as in [spawn/main.c](https://github.com/libuv/libuv/blob/master/docs/code/spawn/main.c) - 36 line *script*.
 * [Networking/TCP](https://docs.libuv.org/en/v1.x/guide/networking.html#tcp) as in [tcp-echo-server/main.c](https://github.com/libuv/libuv/blob/master/docs/code/tcp-echo-server/main.c) - 87 line *script*.
 
 *Reduced to:*
@@ -128,6 +129,33 @@ int uv_main(int argc, char **argv) {
 </tr>
 </table>
 
+<table>
+<tr>
+<th>spawn.c - 13 lines</th>
+</tr>
+<tr>
+<td>
+
+```c
+#include "uv_coro.h"
+
+void _on_exit(int64_t exit_status, int term_signal) {
+    fprintf(stderr, "\nProcess exited with status %" PRId64 ", signal %d\n", exit_status, term_signal);
+}
+
+int uv_main(int argc, char **argv) {
+    spawn_t child = spawn("mkdir", "test-dir", nullptr);
+    if (!spawn_atexit(child, _on_exit))
+        fprintf(stderr, "\nLaunched process with ID %d\n", spawn_pid(child));
+
+    return coro_err_code();
+}
+```
+
+</td>
+</tr>
+</table>
+
 <table>
 <tr>
 <th>tcp-echo-server.c - 27 lines</th>

examples/CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 2.8...3.14)
 
 add_subdirectory(echo-server)
 
-set(TARGET_LIST child helloworld tcp-echo-server uvcat uvtee uv_coro_spawn)
+set(TARGET_LIST helloworld spawn tcp-echo-server uvcat uvtee)
 foreach (TARGET ${TARGET_LIST})
     add_executable(${TARGET} ${TARGET}.c)
     target_link_libraries(${TARGET} uv_coro)

examples/child.c

@@ -0,0 +1,13 @@
+#include "uv_coro.h"
+
+void _on_exit(int64_t exit_status, int term_signal) {
+    fprintf(stderr, "\nProcess exited with status %" PRId64 ", signal %d\n", exit_status, term_signal);
+}
+
+int uv_main(int argc, char **argv) {
+    spawn_t child = spawn("mkdir", "test-dir", nullptr);
+    if (!spawn_atexit(child, _on_exit))
+        fprintf(stderr, "\nLaunched process with ID %d\n", spawn_pid(child));
+
+    return coro_err_code();
+}

examples/spawn.c

@@ -59,6 +59,7 @@ typedef enum {
     UV_CORO_PIPE,
     UV_CORO_TCP,
     UV_CORO_UDP,
+    UV_CORO_SPAWN,
     UV_CORO_SOCKET,
     UV_CORO_PIPE_0,
     UV_CORO_PIPE_1,
@@ -168,13 +169,8 @@ typedef struct {
     uv_process_options_t options[1];
 } spawn_options_t;
 
-typedef struct {
-    uv_coro_types type;
-    bool is_detach;
-    spawn_options_t *handle;
-    uv_process_t process[1];
-} spawn_t;
-
+typedef struct spawn_s _spawn_t;
+typedef _spawn_t *spawn_t;
 typedef struct nameinfo_s {
     uv_coro_types type;
     string_t host;
@@ -262,11 +258,25 @@ C_API uv_stdio_container_t *stdio_fd(int fd, int flags);
 * -`UV_NONBLOCK_PIPE`
 * -`UV_OVERLAPPED_PIPE`
 */
-C_API uv_stdio_container_t *stdio_stream(void *handle, int flags);
+C_API uv_stdio_container_t *stdio_stream(void_t handle, int flags);
+
+/*
+Stdio container `pipe` ~pointer~ with `uv_stdio_flags` transmitted to the child process.
+* -`UV_CREATE_PIPE`
+* -`UV_READABLE_PIPE`
+*/
+C_API uv_stdio_container_t *stdio_piperead(void);
+
+/*
+Stdio container `pipe` ~pointer~ with `uv_stdio_flags` transmitted to the child process.
+* -`UV_CREATE_PIPE`
+* -`UV_WRITABLE_PIPE`
+*/
+C_API uv_stdio_container_t *stdio_pipewrite(void);
 
 /**
  * @param env Environment for the new process. Key=value, separated with semicolon like:
- * `"Key1=Value1;Key=Value2;Key3=Value3"`. If NULL the parents environment is used.
+ * `"Key1=Value1;Key2=Value2;Key3=Value3"`. If `NULL` the parents environment is used.
  *
  * @param cwd Current working directory for the subprocess.
  * @param flags  Various process flags that control how `uv_spawn()` behaves:
@@ -304,17 +314,18 @@ C_API spawn_options_t *spawn_opts(string env, string_t cwd, int flags, uv_uid_t
  * @param options Use `spawn_opts()` function to produce `uv_stdio_container_t` and `uv_process_options_t` options.
  * If `NULL` defaults `stderr` of subprocess to parent.
  */
-C_API spawn_t *spawn(string_t command, string_t args, spawn_options_t *options);
-C_API int spawn_exit(spawn_t *, spawn_cb exit_func);
-C_API int spawn_in(spawn_t *, stdin_cb std_func);
-C_API int spawn_out(spawn_t *, stdout_cb std_func);
-C_API int spawn_err(spawn_t *, stderr_cb std_func);
-C_API int spawn_pid(spawn_t *child);
-C_API int spawn_signal(spawn_t *, int sig);
-C_API int spawn_detach(spawn_t *);
-C_API uv_stream_t *ipc_in(spawn_t *);
-C_API uv_stream_t *ipc_out(spawn_t *);
-C_API uv_stream_t *ipc_err(spawn_t *);
+C_API spawn_t spawn(string_t command, string_t args, spawn_options_t *options);
+C_API int spawn_atexit(spawn_t, spawn_cb exit_func);
+C_API bool is_spawning(spawn_t);
+C_API int spawn_in(spawn_t, stdin_cb std_func);
+C_API int spawn_out(spawn_t, stdout_cb std_func);
+C_API int spawn_err(spawn_t, stderr_cb std_func);
+C_API int spawn_pid(spawn_t);
+C_API int spawn_signal(spawn_t, int sig);
+C_API int spawn_detach(spawn_t);
+C_API uv_stream_t *ipc_in(spawn_t);
+C_API uv_stream_t *ipc_out(spawn_t);
+C_API uv_stream_t *ipc_err(spawn_t);
 
 C_API string fs_readfile(string_t path);
 C_API int fs_writefile(string_t path, string_t text);
@@ -361,6 +372,7 @@ C_API dnsinfo_t *get_addrinfo(string_t address, string_t service, u32 numhints_p
 C_API addrinfo_t *addrinfo_next(dnsinfo_t *);
 C_API nameinfo_t *get_nameinfo(string_t addr, int port, int flags);
 
+C_API uv_pipe_t *pipe_create_ex(bool is_ipc, bool autofree);
 C_API uv_pipe_t *pipe_create(bool is_ipc);
 C_API uv_tcp_t *tcp_create(void);
 
@@ -420,6 +432,7 @@ C_API bool is_pipe(void_t);
 C_API bool is_tty(void_t);
 C_API bool is_udp(void_t);
 C_API bool is_tcp(void_t);
+C_API bool is_process(void_t);
 C_API bool is_udp_packet(void_t);
 C_API bool is_socketpair(void_t);
 C_API bool is_pipepair(void_t);