io.h

   1 /* Copyright (c) 2006-2012 Jonas Fonseca <fonseca@diku.dk>
   2  *
   3  * This program is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU General Public License as
   5  * published by the Free Software Foundation; either version 2 of
   6  * the License, or (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13
  14 #ifndef TIG_IO_H
  15 #define TIG_IO_H
  16
  17 /*
  18  * Argument array helpers.
  19  */
  20
  21 bool argv_from_string_no_quotes(const char *argv[SIZEOF_ARG], int *argc, char *cmd);
  22 bool argv_from_string(const char *argv[SIZEOF_ARG], int *argc, char *cmd);
  23 bool argv_from_env(const char **argv, const char *name);
  24 void argv_free(const char *argv[]);
  25 size_t argv_size(const char **argv);
  26 bool argv_append(const char ***argv, const char *arg);
  27 bool argv_append_array(const char ***dst_argv, const char *src_argv[]);
  28 bool argv_copy(const char ***dst, const char *src[]);
  29
  30 /*
  31  * Encoding conversion.
  32  */
  33
  34 struct encoding;
  35
  36 struct encoding *encoding_open(const char *fromcode);
  37 char *encoding_convert(struct encoding *encoding, char *line);
  38
  39 /*
  40  * Executing external commands.
  41  */
  42
  43 enum io_type {
  44         IO_FD,                  /* File descriptor based IO. */
  45         IO_BG,                  /* Execute command in the background. */
  46         IO_FG,                  /* Execute command with same std{in,out,err}. */
  47         IO_RD,                  /* Read only fork+exec IO. */
  48         IO_WR,                  /* Write only fork+exec IO. */
  49         IO_AP,                  /* Append fork+exec output to file. */
  50 };
  51
  52 struct io {
  53         int pipe;               /* Pipe end for reading or writing. */
  54         pid_t pid;              /* PID of spawned process. */
  55         int error;              /* Error status. */
  56         char *buf;              /* Read buffer. */
  57         size_t bufalloc;        /* Allocated buffer size. */
  58         size_t bufsize;         /* Buffer content size. */
  59         char *bufpos;           /* Current buffer position. */
  60         unsigned int eof:1;     /* Has end of file been reached. */
  61         int status:8;           /* Status exit code. */
  62 };
  63
  64 typedef int (*io_read_fn)(char *, size_t, char *, size_t, void *data);
  65
  66 bool io_open(struct io *io, const char *fmt, ...);
  67 bool io_kill(struct io *io);
  68 bool io_done(struct io *io);
  69 bool io_run(struct io *io, enum io_type type, const char *dir, const char *argv[], ...);
  70 bool io_run_bg(const char **argv);
  71 bool io_run_fg(const char **argv, const char *dir);
  72 bool io_run_append(const char **argv, int fd);
  73 bool io_eof(struct io *io);
  74 int io_error(struct io *io);
  75 char * io_strerror(struct io *io);
  76 bool io_can_read(struct io *io, bool can_block);
  77 ssize_t io_read(struct io *io, void *buf, size_t bufsize);
  78 char * io_get(struct io *io, int c, bool can_read);
  79 bool io_write(struct io *io, const void *buf, size_t bufsize);
  80 bool io_printf(struct io *io, const char *fmt, ...);
  81 bool io_read_buf(struct io *io, char buf[], size_t bufsize);
  82 bool io_run_buf(const char **argv, char buf[], size_t bufsize);
  83 int io_load(struct io *io, const char *separators,
  84             io_read_fn read_property, void *data);
  85 int io_run_load(const char **argv, const char *separators,
  86                 io_read_fn read_property, void *data);
  87
  88 #endif