src/common.h

   1 /* common.h - Common functions
   2
   3    Copyright (C) 1993 Werner Almesberger <werner.almesberger@lrc.di.epfl.ch>
   4    Copyright (C) 2008-2014 Daniel Baumann <mail@daniel-baumann.ch>
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program. If not, see <http://www.gnu.org/licenses/>.
  18
  19    The complete text of the GNU General Public License
  20    can be found in /usr/share/common-licenses/GPL-3 file.
  21 */
  22
  23 #ifndef _COMMON_H
  24 #define _COMMON_H
  25
  26 void die(const char *msg, ...)
  27     __attribute((noreturn, format(printf, 1, 2)));
  28
  29 /* Displays a prinf-style message and terminates the program. */
  30
  31 void pdie(const char *msg, ...)
  32     __attribute((noreturn, format(printf, 1, 2)));
  33
  34 /* Like die, but appends an error message according to the state of errno. */
  35
  36 void *alloc(int size);
  37
  38 /* mallocs SIZE bytes and returns a pointer to the data. Terminates the program
  39    if malloc fails. */
  40
  41 void *qalloc(void **root, int size);
  42
  43 /* Like alloc, but registers the data area in a list described by ROOT. */
  44
  45 void qfree(void **root);
  46
  47 /* Deallocates all qalloc'ed data areas described by ROOT. */
  48
  49 int min(int a, int b);
  50
  51 /* Returns the smaller integer value of a and b. */
  52
  53 char get_key(const char *valid, const char *prompt);
  54
  55 /* Displays PROMPT and waits for user input. Only characters in VALID are
  56    accepted. Terminates the program on EOF. Returns the character. */
  57
  58 #endif