Add prefix macro for dotlock functions.
[gnupg.git] / common / dotlock.h
1 /* dotlock.h - dotfile locking declarations
2  * Copyright (C) 2000, 2001, 2006, 2011 Free Software Foundation, Inc.
3  *
4  * This file is part of JNLIB, which is a subsystem of GnuPG.
5  *
6  * JNLIB is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as
8  * published by the Free Software Foundation; either version 3 of
9  * the License, or (at your option) any later version.
10  *
11  * JNLIB is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef LIBJNLIB_DOTLOCK_H
21 #define LIBJNLIB_DOTLOCK_H
22
23 /* See dotlock.c for a description.  */
24
25 #ifdef DOTLOCK_EXT_SYM_PREFIX
26 # ifndef _DOTLOCK_PREFIX
27 #  define _DOTLOCK_PREFIX1(x,y)  x ## y
28 #  define _DOTLOCK_PREFIX2(x,y) _DOTLOCK_PREFIX1(x,y)
29 #  define _DOTLOCK_PREFIX(x)    _DOTLOCK_PREFIX2(DOTLOCK_EXT_SYM_PREFIX,x)
30 # endif /*_DOTLOCK_PREFIX*/
31 # define dotlock_disable          _DOTLOCK_PREFIX(dotlock_disable)
32 # define dotlock_create           _DOTLOCK_PREFIX(dotlock_create)
33 # define dotlock_set_fd           _DOTLOCK_PREFIX(dotlock_set_fd)
34 # define dotlock_get_fd           _DOTLOCK_PREFIX(dotlock_get_fd)
35 # define dotlock_destroy          _DOTLOCK_PREFIX(dotlock_destroy)
36 # define dotlock_take             _DOTLOCK_PREFIX(dotlock_take)
37 # define dotlock_release          _DOTLOCK_PREFIX(dotlock_release)
38 # define dotlock_remove_lockfiles _DOTLOCK_PREFIX(dotlock_remove_lockfiles)
39 #endif /*DOTLOCK_EXT_SYM_PREFIX*/
40
41 #ifdef __cplusplus
42 extern "C"
43 {
44 #if 0
45 }
46 #endif
47 #endif
48
49
50 struct dotlock_handle;
51 typedef struct dotlock_handle *dotlock_t;
52
53 void dotlock_disable (void);
54 dotlock_t dotlock_create (const char *file_to_lock, unsigned int flags);
55 void dotlock_set_fd (dotlock_t h, int fd);
56 int  dotlock_get_fd (dotlock_t h);
57 void dotlock_destroy (dotlock_t h);
58 int dotlock_take (dotlock_t h, long timeout);
59 int dotlock_release (dotlock_t h);
60 void dotlock_remove_lockfiles (void);
61
62 #ifdef __cplusplus
63 }
64 #endif
65 #endif /*LIBJNLIB_DOTLOCK_H*/