2007-07-13 Marcus Brinkmann <marcus@g10code.de>
[gpgme.git] / gpgme / priv-io.h
1 /* priv-io.h - Interface to the private I/O functions.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004, 2005 g10 Code GmbH
4
5    This file is part of GPGME.
6  
7    GPGME is free software; you can redistribute it and/or modify it
8    under the terms of the GNU Lesser General Public License as
9    published by the Free Software Foundation; either version 2.1 of
10    the License, or (at your option) any later version.
11    
12    GPGME is distributed in the hope that it will be useful, but
13    WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Lesser General Public License for more details.
16    
17    You should have received a copy of the GNU Lesser General Public
18    License along with this program; if not, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
21
22 #ifndef IO_H
23 #define IO_H
24
25
26 /* A single file descriptor passed to spawn.  For child fds, dup_to
27    specifies the fd it should become in the child.  */
28 struct spawn_fd_item_s
29 {
30   int fd;
31   int dup_to;
32 };
33
34 struct io_select_fd_s
35 {
36   int fd;
37   int for_read;
38   int for_write;
39   int signaled;
40   int frozen;
41   void *opaque;
42 };
43
44 /* These function are either defined in posix-io.c or w32-io.c.  */
45 void _gpgme_io_subsystem_init (void);
46 int _gpgme_io_read (int fd, void *buffer, size_t count);
47 int _gpgme_io_write (int fd, const void *buffer, size_t count);
48 int _gpgme_io_pipe (int filedes[2], int inherit_idx);
49 int _gpgme_io_close (int fd);
50 typedef void (*_gpgme_close_notify_handler_t) (int,void*);
51 int _gpgme_io_set_close_notify (int fd, _gpgme_close_notify_handler_t handler,
52                                 void *value);
53 int _gpgme_io_set_nonblocking (int fd);
54
55 /* Spawn the executable PATH with ARGV as arguments, after forking
56    close all fds in FD_PARENT_LIST in the parent and close or dup all
57    fds in FD_CHILD_LIST in the child.  */
58 int _gpgme_io_spawn (const char *path, char **argv,
59                      struct spawn_fd_item_s *fd_child_list,
60                      struct spawn_fd_item_s *fd_parent_list);
61 int _gpgme_io_select (struct io_select_fd_s *fds, size_t nfds, int nonblock);
62
63 /* Write the printable version of FD to the buffer BUF of length
64    BUFLEN.  The printable version is the representation on the command
65    line that the child process expects.  */
66 int _gpgme_io_fd2str (char *buf, int buflen, int fd);
67
68 #endif /* IO_H */