chiark / gitweb /
Use the new `mLib' annotations on varargs functions.
[tripe] / common / util.h
index b76e12595f13ebb2cdfa6c7386b032bdc777e526..b4c45056ace6b2a8001d7ac142f9f4038a6c41d5 100644 (file)
 #ifndef UTIL_H
 #define UTIL_H
 
+#ifndef CONFIG_H
+#  include "config.h"
+#endif
+
+#include <sys/types.h>
+
+#include <mLib/macros.h>
+
 #ifdef __cplusplus
   extern "C" {
 #endif
 
 extern void u_quotify(dstr */*d*/, const char */*p*/);
 
-/* --- @u_detach@ --- *
+/* --- @u_getuser@ --- *
  *
- * Arguments:  ---
+ * Arguments:  @const char *name@ = user name or id requested
+ *             @gid_t *gg@ = where to store corresponding gid
  *
- * Returns:    ---
+ * Returns:    Corresponding uid.
+ *
+ * Use:                Resolves a user name into a uid.  Dies on failure; suitable
+ *             for use in argument parsing.
+ */
+
+extern uid_t u_getuser(const char */*name*/, gid_t */*gg*/);
+
+/* --- @u_getgroup@ --- *
  *
- * Use:                Detaches from the current terminal and ensures it can never
- *             acquire a new one.  Calls @fork@.
+ * Arguments:  @const char *name@ = user name or id requested
+ *
+ * Returns:    Corresponding gid.
+ *
+ * Use:                Resolves a group name into a gid.  Dies on failure; suitable
+ *             for use in argument parsing.
  */
 
-extern void u_detach(void);
+extern gid_t u_getgroup(const char */*name*/);
 
-/* --- @u_daemon@ --- *
+/* --- @u_setugid@ --- *
  *
- * Arguments:  ---
+ * Arguments:  @uid_t u@ = user to set
+ *             @gid_t g@ = group to set
  *
- * Returns:    Zero if OK, nonzero on failure.
+ * Returns:    ---
  *
- * Use:                Becomes a daemon.
+ * Use:                Sets user and group to the given values; aborts on failure.
  */
 
-extern int u_daemon(void);
+extern void u_setugid(uid_t /*u*/, gid_t /*g*/);
 
 /*----- That's all, folks -------------------------------------------------*/