libcomcom 0.1.1 support and wrapper for initializer/destructor

vporton · vporton · commit f5710a411fee · 2019-01-26T17:06:35.000+02:00
diff --git a/C/libcomcom.h b/C/libcomcom.h
@@ -31,6 +31,8 @@ extern "C" {
  * Initialize the library. Call it before libcomcom_run_command().
  * Note that this erases the old SIGCHLD handler (if any).
  * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * You should usually also initialize SIGTERM/SIGINT signal handlers.
  */
 int libcomcom_init(void);
 
@@ -41,6 +43,8 @@ int libcomcom_init(void);
  * The old signal handler (the one obtained from `old` variable) is also
  * called from our SIGCHLD handler.
  * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * You should usually also initialize SIGTERM/SIGINT signal handlers.
  */
 int libcomcom_init2(struct sigaction *old);
 
@@ -53,6 +57,8 @@ int libcomcom_init2(struct sigaction *old);
  * (not by sigaction()), then this function may not work (leads to undefined
  * behavior) on some non-Unix systems.
  * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * You should usually also initialize SIGTERM/SIGINT signal handlers.
  */
 int libcomcom_init_stratum(void);
 
@@ -64,7 +70,7 @@ int libcomcom_init_stratum(void);
  * @param output_len at this location is stored the length of command's stdout
  * @param file the command to run (PATH used)
  * @param argv arguments for the command to run
- * @param envp environment for the command to run (pass `environ` to duplicate our environment)
+ * @param envp environment for the command to run (pass `NULL` to duplicate our environment)
  * @param timeout timeout in milliseconds, -1 means infinite timeout
  * @return 0 on success and -1 on error (also sets `errno`).
  */
@@ -76,6 +82,7 @@ int libcomcom_run_command(const char *input, size_t input_len,
 
 /**
  * Should be run for normal termination (not in SIGTERM/SIGINT handler)
+ * of our program.
  * @return 0 on success and -1 on error (also sets `errno`).
  */
 int libcomcom_destroy(void);
@@ -88,20 +95,41 @@ int libcomcom_terminate(void);
 
 /**
  * Install SIGTERM and SIGINT handler which calls libcomcom_terminate().
- * If your program needs to handle SIGTERM or SIGINT in another way,
- * use libcomcom_terminate() instead.
  * @return 0 on success and -1 on error (also sets `errno`).
+ * 
+ * You are recommended to use libcomcom_set_default_terminate2()
+ * instead.
  */
 int libcomcom_set_default_terminate(void);
 
 /**
  * Uninstall SIGTERM and SIGINT handler which calls libcomcom_terminate().
- * If your program needs to handle SIGTERM or SIGINT in another way,
- * use libcomcom_terminate() instead.
  * @return 0 on success and -1 on error (also sets `errno`).
+ * 
+ * You are recommended to use libcomcom_reset_default_terminate2()
+ * instead.
  */
 int libcomcom_reset_default_terminate(void);
 
+/**
+ * Install SIGTERM and SIGINT handler which calls libcomcom_terminate().
+ * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * The installed signal handler also calls old signal handler automatically.
+ *
+ * WARNING: If before calling these handlers were set by signal()
+ * (not by sigaction()), then this function may not work (leads to undefined
+ * behavior) on some non-Unix systems.
+ */
+int libcomcom_set_default_terminate2(void);
+
+/**
+ * Resets to signal handlers which were before calling
+ * libcomcom_set_default_terminate2().
+ * @return 0 on success and -1 on error (also sets `errno`).
+ */
+int libcomcom_reset_default_terminate2(void);
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/deimos/libcomcom.d b/deimos/libcomcom.d
@@ -26,6 +26,8 @@ extern extern(C):
  * Initialize the library. Call it before libcomcom_run_command().
  * Note that this erases the old SIGCHLD handler (if any).
  * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * You should usually also initialize SIGTERM/SIGINT signal handlers.
  */
 int libcomcom_init();
 
@@ -36,6 +38,8 @@ int libcomcom_init();
  * The old signal handler (the one obtained from `old` variable) is also
  * called from our SIGCHLD handler.
  * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * You should usually also initialize SIGTERM/SIGINT signal handlers.
  */
 int libcomcom_init2(sigaction_t *old);
 
@@ -48,6 +52,8 @@ int libcomcom_init2(sigaction_t *old);
  * (not by sigaction()), then this function may not work (leads to undefined
  * behavior) on some non-Unix systems.
  * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * You should usually also initialize SIGTERM/SIGINT signal handlers.
  */
 int libcomcom_init_stratum();
 
@@ -59,7 +65,7 @@ int libcomcom_init_stratum();
  * @param output_len at this location is stored the length of command's stdout
  * @param file the command to run (PATH used)
  * @param argv arguments for the command to run
- * @param envp environment for the command to run (pass `environ` to duplicate our environment)
+ * @param envp environment for the command to run (pass `NULL` to duplicate our environment)
  * @param timeout timeout in milliseconds, -1 means infinite timeout
  * @return 0 on success and -1 on error (also sets `errno`).
  */
@@ -71,6 +77,7 @@ int libcomcom_run_command(const char *input, size_t input_len,
 
 /**
  * Should be run for normal termination (not in SIGTERM/SIGINT handler)
+ * of our program.
  * @return 0 on success and -1 on error (also sets `errno`).
  */
 int libcomcom_destroy();
@@ -83,17 +90,37 @@ int libcomcom_terminate();
 
 /**
  * Install SIGTERM and SIGINT handler which calls libcomcom_terminate().
- * If your program needs to handle SIGTERM or SIGINT in another way,
- * use libcomcom_terminate() instead.
  * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * You are recommended to use libcomcom_set_default_terminate2()
+ * instead.
  */
 int libcomcom_set_default_terminate();
 
 /**
  * Uninstall SIGTERM and SIGINT handler which calls libcomcom_terminate().
- * If your program needs to handle SIGTERM or SIGINT in another way,
- * use libcomcom_terminate() instead.
  * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * You are recommended to use libcomcom_reset_default_terminate2()
+ * instead.
  */
 int libcomcom_reset_default_terminate();
 
+/**
+ * Install SIGTERM and SIGINT handler which calls libcomcom_terminate().
+ * @return 0 on success and -1 on error (also sets `errno`).
+ *
+ * The installed signal handler also calls old signal handler automatically.
+ *
+ * WARNING: If before calling these handlers were set by signal()
+ * (not by sigaction()), then this function may not work (leads to undefined
+ * behavior) on some non-Unix systems.
+ */
+int libcomcom_set_default_terminate2();
+
+/**
+ * Resets to signal handlers which were before calling
+ * libcomcom_set_default_terminate2().
+ * @return 0 on success and -1 on error (also sets `errno`).
+ */
+int libcomcom_reset_default_terminate2();
diff --git a/deimos/libcomcom_wrapper.d b/deimos/libcomcom_wrapper.d
@@ -24,6 +24,25 @@ import std.array : array;
 import std.exception : ErrnoException;
 import libcomcom;
 
+void libComComInitializer()
+{
+    int res;
+    res = libcomcom_init_stratum();
+    if (res != 0) {
+        throw new ErrnoException("libcomcom_init_stratum()"); // TODO: Localization
+    }
+    libcomcom_set_default_terminate();
+    if (res != 0) {
+        throw new ErrnoException("libcomcom_set_default_terminate()"); // TODO: Localization
+    }
+}
+
+void libComComDestructor()
+{
+    cast(void) libcomcom_reset_default_terminate();
+    cast(void) libcomcom_destroy();
+}
+
 string _runCommand(string file,
                    string[] argv,
                    const char** childEnvp,
diff --git a/dub.json b/dub.json
@@ -30,6 +30,5 @@
       "name": "static-library",
       "targetType": "staticLibrary"
     }
-]
-
+  ]
 }

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,5 @@`
`30`	`30`	`"name": "static-library",`
`31`	`31`	`"targetType": "staticLibrary"`
`32`	`32`	`}`
`33`		`-]`
`34`		`-`
	`33`	`+ ]`
`35`	`34`	`}`