altosui: Don't export product defs from libaltos
[fw/altos] / altosui / libaltos / libaltos.h
1 /*
2  * Copyright © 2010 Keith Packard <keithp@keithp.com>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 #ifndef _LIBALTOS_H_
19 #define _LIBALTOS_H_
20
21 #include <stdlib.h>
22
23 #if defined(_WIN32) || defined(__WIN32__) || defined(__CYGWIN__)
24 # ifndef BUILD_STATIC
25 #  ifdef BUILD_DLL
26 #   define PUBLIC __declspec(dllexport)
27 #  else
28 #   define PUBLIC __declspec(dllimport)
29 #  endif
30 # endif /* BUILD_STATIC */
31 #endif
32
33 #ifndef PUBLIC
34 # define PUBLIC
35 #endif
36
37 struct altos_device {
38         //%immutable;
39         int                             vendor;
40         int                             product;
41         int                             serial;
42         char                            name[256];
43         char                            path[256];
44         //%mutable;
45 };
46
47 struct altos_bt_device {
48         //%immutable;
49         char                            name[256];
50         char                            addr[20];
51         //%mutable;
52 };
53
54 #define LIBALTOS_SUCCESS        0
55 #define LIBALTOS_ERROR          -1
56 #define LIBALTOS_TIMEOUT        -2
57
58 /* Returns 0 for success, < 0 on error */
59 PUBLIC int
60 altos_init(void);
61
62 PUBLIC void
63 altos_fini(void);
64
65 PUBLIC struct altos_list *
66 altos_list_start(void);
67
68 /* Returns 1 for success, zero on end of list */
69 PUBLIC int
70 altos_list_next(struct altos_list *list, struct altos_device *device);
71
72 PUBLIC void
73 altos_list_finish(struct altos_list *list);
74
75 PUBLIC struct altos_file *
76 altos_open(struct altos_device *device);
77
78 PUBLIC void
79 altos_close(struct altos_file *file);
80
81 PUBLIC void
82 altos_free(struct altos_file *file);
83
84 /* Returns < 0 for error */
85 PUBLIC int
86 altos_putchar(struct altos_file *file, char c);
87
88 /* Returns < 0 for error */
89 PUBLIC int
90 altos_flush(struct altos_file *file);
91
92 /* Returns < 0 for error or timeout. timeout of 0 == wait forever */
93 PUBLIC int
94 altos_getchar(struct altos_file *file, int timeout);
95
96 // #define HAS_BLUETOOTH 1
97 #if HAS_BLUETOOTH
98
99 PUBLIC struct altos_bt_list *
100 altos_bt_list_start(int inquiry_time);
101
102 PUBLIC int
103 altos_bt_list_next(struct altos_bt_list *list, struct altos_bt_device *device);
104
105 PUBLIC void
106 altos_bt_list_finish(struct altos_bt_list *list);
107
108 PUBLIC void
109 altos_bt_fill_in(char *name, char *addr, struct altos_bt_device *device);
110
111 PUBLIC struct altos_file *
112 altos_bt_open(struct altos_bt_device *device);
113
114 #endif
115
116 #endif /* _LIBALTOS_H_ */