chiark - git - mdw - tripe/blob - common/util.h

   1 /* -*-c-*-
   2  *
   3  * Utilities for the client and the server
   4  *
   5  * (c) 2001 Straylight/Edgeware
   6  */
   7
   8 /*----- Licensing notice --------------------------------------------------*
   9  *
  10  * This file is part of Trivial IP Encryption (TrIPE).
  11  *
  12  * TrIPE is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * TrIPE is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with TrIPE; if not, write to the Free Software Foundation,
  24  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25  */
  26
  27 #ifndef UTIL_H
  28 #define UTIL_H
  29
  30 #ifdef __cplusplus
  31   extern "C" {
  32 #endif
  33
  34 /*----- Functions provided ------------------------------------------------*/
  35
  36 /* --- @u_quotify@ --- *
  37  *
  38  * Arguments:   @dstr *d@ = where to write the answer
  39  *              @const char *p@ = string to quotify
  40  *
  41  * Returns:     ---
  42  *
  43  * Use:         Quotes the given string if necessary, according to our
  44  *              quoting rules.
  45  */
  46
  47 extern void u_quotify(dstr */*d*/, const char */*p*/);
  48
  49 /* --- @u_detach@ --- *
  50  *
  51  * Arguments:   ---
  52  *
  53  * Returns:     ---
  54  *
  55  * Use:         Detaches from the current terminal and ensures it can never
  56  *              acquire a new one.  Calls @fork@.
  57  */
  58
  59 extern void u_detach(void);
  60
  61 /* --- @u_daemon@ --- *
  62  *
  63  * Arguments:   ---
  64  *
  65  * Returns:     Zero if OK, nonzero on failure.
  66  *
  67  * Use:         Becomes a daemon.
  68  */
  69
  70 extern int u_daemon(void);
  71
  72 /*----- That's all, folks -------------------------------------------------*/
  73
  74 #ifdef __cplusplus
  75   }
  76 #endif
  77
  78 #endif