lib/libutil/libutil.h

   1 /*
   2  * Copyright (c) 1996  Peter Wemm <peter@FreeBSD.org>.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, is permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  * $FreeBSD: src/lib/libutil/libutil.h,v 1.26.2.3 2000/11/22 03:49:49 murray Exp $
  27  * $DragonFly: src/lib/libutil/libutil.h,v 1.6 2005/03/04 05:47:03 cpressey Exp $
  28  */
  29
  30 #ifndef _LIBUTIL_H_
  31 #define _LIBUTIL_H_
  32
  33 #include <sys/cdefs.h>
  34
  35 #define PROPERTY_MAX_NAME       64
  36 #define PROPERTY_MAX_VALUE      512
  37
  38 /* for properties.c */
  39 typedef struct _property {
  40         struct _property *next;
  41         char *name;
  42         char *value;
  43 } *properties;
  44
  45 /* Avoid pulling in all the include files for no need */
  46 struct termios;
  47 struct winsize;
  48 struct utmp;
  49 struct in_addr;
  50 struct sockaddr;
  51
  52 __BEGIN_DECLS
  53 void    login(struct utmp *);
  54 int     login_tty(int);
  55 int     logout(const char *);
  56 void    logwtmp(const char *, const char *, const char *);
  57 void    trimdomain(char *, int);
  58 int     openpty(int *, int *, char *, struct termios *, struct winsize *);
  59 int     forkpty(int *, char *, struct termios *, struct winsize *);
  60 int     humanize_number(char *, size_t, int64_t, const char *, int, int);
  61 const char *uu_lockerr(int);
  62 int     uu_lock(const char *);
  63 int     uu_unlock(const char *);
  64 int     uu_lock_txfr(const char *, pid_t);
  65 int     _secure_path(const char *, uid_t, gid_t);
  66 int     pidfile(const char *);
  67 properties properties_read(int fd);
  68 void    properties_free(properties);
  69 char    *property_find(properties, const char *);
  70 char    *auth_getval(const char *);
  71 int     realhostname(char *, size_t, const struct in_addr *);
  72 int     realhostname_sa(char *, size_t, struct sockaddr *, int);
  73 #ifdef _STDIO_H_        /* avoid adding new includes */
  74 char   *fparseln(FILE *, size_t *, size_t *, const char[3], int);
  75 #endif
  76 __END_DECLS
  77
  78 #define UU_LOCK_INUSE (1)
  79 #define UU_LOCK_OK (0)
  80 #define UU_LOCK_OPEN_ERR (-1)
  81 #define UU_LOCK_READ_ERR (-2)
  82 #define UU_LOCK_CREAT_ERR (-3)
  83 #define UU_LOCK_WRITE_ERR (-4)
  84 #define UU_LOCK_LINK_ERR (-5)
  85 #define UU_LOCK_TRY_ERR (-6)
  86 #define UU_LOCK_OWNER_ERR (-7)
  87
  88 /* return values from realhostname() */
  89 #define HOSTNAME_FOUND          (0)
  90 #define HOSTNAME_INCORRECTNAME  (1)
  91 #define HOSTNAME_INVALIDADDR    (2)
  92 #define HOSTNAME_INVALIDNAME    (3)
  93
  94 /* fparseln(3) */
  95 #define FPARSELN_UNESCESC       0x01
  96 #define FPARSELN_UNESCCONT      0x02
  97 #define FPARSELN_UNESCCOMM      0x04
  98 #define FPARSELN_UNESCREST      0x08
  99 #define FPARSELN_UNESCALL       0x0f
 100
 101 /* humanize_number(3) */
 102 #define HN_DECIMAL              0x01
 103 #define HN_NOSPACE              0x02
 104 #define HN_B                    0x04
 105 #define HN_DIVISOR_1000         0x08
 106 #define HN_GETSCALE             0x10
 107 #define HN_AUTOSCALE            0x20
 108
 109 #endif /* !_LIBUTIL_H_ */