Add GNU LGPL headers to all .c .C and .h files
[oweals/cde.git] / cde / lib / tt / lib / api / c / api_mp.h
1 /*
2  * CDE - Common Desktop Environment
3  *
4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
5  *
6  * These libraries and programs are free software; you can
7  * redistribute them and/or modify them under the terms of the GNU
8  * Lesser General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * These libraries and programs are distributed in the hope that
13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15  * PURPOSE. See the GNU Lesser General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with these librararies and programs; if not, write
20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21  * Floor, Boston, MA 02110-1301 USA
22  */
23 /*%%  (c) Copyright 1993, 1994 Hewlett-Packard Company                   */
24 /*%%  (c) Copyright 1993, 1994 International Business Machines Corp.     */
25 /*%%  (c) Copyright 1993, 1994 Sun Microsystems, Inc.                    */
26 /*%%  (c) Copyright 1993, 1994 Novell, Inc.                              */
27 /*%%  $XConsortium: api_mp.h /main/4 1995/11/28 19:22:43 cde-sun $                                                       */
28 /* @(#)api_mp.h 1.14 93/07/30 SMI
29  * api_mp.h
30  * 
31  * Copyright (c) 1993 by Sun Microsystems, Inc.
32  */
33 #ifndef _TT_API_MP_H
34 #define _TT_API_MP_H
35 #include <api/c/tt_c.h>
36 #include <util/tt_string.h>
37
38
39 char           *_tt_default_ptype(void);
40 Tt_status       _tt_default_ptype_set(const char *ptid);
41 char           *_tt_default_file(void);
42 Tt_status       _tt_default_file_set(const char *docid);
43
44 Tt_status       _tt_file_join(const char *filepath);
45
46 Tt_status       _tt_file_objects_query(const char *filepath, Tt_filter_function filter,
47                                      void *context, void *accumulator);
48 char           *_tt_file_procid(const char *filepath, int n);
49 Tt_status       _tt_file_quit(const char *filepath);
50
51 Tt_status       _tt_file_destroy(const char *filepath);
52 Tt_status       _tt_file_move(const char *oldfilepath,
53                               const char *newfilepath);
54 Tt_status       _tt_file_copy(const char *oldfilepath,
55                               const char *newfilepath);
56
57 Tt_status       _tt_filelist_objects_query(const char **filepathlist,
58                                          Tt_filter_function filter,
59                                          void *context, void *accumulator);
60 Tt_status       _tt_message_accept(Tt_message m);
61 Tt_status       _tt_message_arg_add(Tt_message m, Tt_mode n,
62                                     const char *vtype, const char *value);
63 char           *_tt_message_arg_val(Tt_message m, int n);
64 Tt_status       _tt_message_arg_val_set(Tt_message m, int n,
65                                         const char *value);
66 Tt_status       _tt_message_barg_add(Tt_message m, Tt_mode n,
67                                      const char *vtype, 
68                                      const unsigned char *value, int len);
69 Tt_status       _tt_message_arg_bval(Tt_message m, int n,
70                                      unsigned char **value, int *len);
71 Tt_status       _tt_message_arg_bval_set(Tt_message m, int n,
72                                          const unsigned char *value, int len);
73 Tt_status       _tt_message_iarg_add(Tt_message m, Tt_mode n,
74                                      const char *vtype, int value);
75 Tt_status       _tt_message_arg_ival(Tt_message m, int n, int *value);
76 Tt_status       _tt_message_arg_ival_set(Tt_message m, int n, int value);
77 int             _tt_message_args_count(Tt_message m);
78 Tt_mode         _tt_message_arg_mode(Tt_message m, int n);
79 char *          _tt_message_arg_type(Tt_message m, int n);
80 Tt_status       _tt_message_callback_add(Tt_message m,
81                                             Tt_message_callback f);    
82 Tt_class        _tt_message_class(Tt_message m);
83 Tt_status       _tt_message_class_set(Tt_message m, Tt_class c);
84 Tt_message      _tt_message_create(void);
85 Tt_message      _tt_message_create_super(Tt_message m);
86 Tt_status       _tt_message_destroy(Tt_message m);
87 Tt_status       _tt_message_fail(Tt_message m);
88 char           *_tt_message_file(Tt_message m);
89 Tt_status       _tt_message_file_set(Tt_message m, const char *filepath);
90 char           *_tt_message_object(Tt_message m);
91 Tt_status       _tt_message_object_set(Tt_message m, const char *objid);
92 char           *_tt_message_observer(Tt_message m);
93 char           *_tt_message_op(Tt_message m);
94 Tt_status       _tt_message_op_set(Tt_message m, const char *opname);
95 int             _tt_message_opnum(Tt_message m);
96 char           *_tt_message_otype(Tt_message m);
97 Tt_status       _tt_message_otype_set(Tt_message m, const char *otype);
98 Tt_address     _tt_message_address(Tt_message m);
99 Tt_status       _tt_message_address_set(Tt_message m, Tt_address p);
100 Tt_pattern      _tt_message_pattern(Tt_message m);
101 Tt_message      _tt_message_receive(void);
102 char           *_tt_message_handler(Tt_message m);
103 Tt_status       _tt_message_handler_set(Tt_message m, const char *procid);
104 char           *_tt_message_handler_ptype(Tt_message m);
105 Tt_status       _tt_message_handler_ptype_set(Tt_message m, const char *ptid);
106 Tt_status       _tt_message_reject(Tt_message m);
107 Tt_disposition  _tt_message_disposition(Tt_message m);
108 Tt_status       _tt_message_disposition_set(Tt_message m, Tt_disposition r);
109 Tt_status       _tt_message_reply(Tt_message m);
110 Tt_scope        _tt_message_scope(Tt_message m);
111 Tt_status       _tt_message_scope_set(Tt_message m, Tt_scope s);
112 Tt_status       _tt_message_send(Tt_message m);
113 Tt_status       _tt_message_send_on_exit(Tt_message m);
114 char           *_tt_message_sender(Tt_message m);
115 char           *_tt_message_sender_ptype(Tt_message m);
116 Tt_status       _tt_message_sender_ptype_set(Tt_message m, const char *ptid);
117 char           *_tt_message_session(Tt_message m);
118 Tt_status       _tt_message_session_set(Tt_message m, const char *sessid);
119 Tt_state        _tt_message_state(Tt_message m);
120 int             _tt_message_status(Tt_message m);
121 Tt_status       _tt_message_status_set(Tt_message m, int status);
122 char            *_tt_message_status_string(Tt_message m);
123 Tt_status       _tt_message_status_string_set(Tt_message m, const char *status_str);
124 uid_t           _tt_message_uid(Tt_message m);
125 gid_t           _tt_message_gid(Tt_message m);
126 void           *_tt_message_user(Tt_message m, int key);
127 Tt_status       _tt_message_user_set(Tt_message m, int key, void *v);
128
129 int             _tt_otype_deriveds_count(const char *otype);
130 char *          _tt_otype_derived(const char *otype, int i);
131 char *          _tt_otype_base(const char *otype);
132 int             _tt_otype_is_derived(const char *derivedotype,
133                                      const char *baseotype);
134 int             _tt_otype_osig_count(const char * otype);
135 int             _tt_otype_hsig_count(const char * otype);
136 char *          _tt_otype_osig_op(const char * otype, int sig);
137 char *          _tt_otype_hsig_op(const char * otype, int sig);
138 int             _tt_otype_osig_args_count(const char * otype, int sig);
139 int             _tt_otype_hsig_args_count(const char * otype, int sig);
140 Tt_mode         _tt_otype_osig_arg_mode(const char * otype,
141                                         int sig, int arg);
142 Tt_mode         _tt_otype_hsig_arg_mode(const char * otype,
143                                         int sig, int arg);
144 char *          _tt_otype_osig_arg_type(const char * otype,
145                                         int sig, int arg);
146 char *          _tt_otype_hsig_arg_type(const char * otype,
147                                         int sig, int arg);
148 Tt_status       _tt_valid_otype(const char *otype);
149
150 Tt_status       _tt_spec_bprop(const char *nodeid, const char *propname, int i,
151                                unsigned char **value, int *length);
152 Tt_status       _tt_spec_bprop_add(const char *nodeid, const char *propname,
153                                    unsigned const char *value, int length);
154 Tt_status       _tt_spec_bprop_set(const char *nodeid, const char *propname,
155                                    unsigned const char *value, int length);
156 char           *_tt_spec_create(const char *filepath);
157 Tt_status       _tt_spec_destroy(const char *nodeid);
158 char           *_tt_spec_file(const char *nodeid);
159 char           *_tt_spec_move(const char *nodeid, const char *newfilepath);
160 Tt_status       _tt_spec_type_set(const char * nodeid, const char * otid);
161 char           *_tt_spec_type(const char * nodeid);
162 char           *_tt_spec_prop(const char *nodeid, const char *propname, int i);
163 Tt_status       _tt_spec_prop_add(const char *nodeid, const char *propname, const char *value);
164 int             _tt_spec_prop_count(const char *nodeid, const char *propname);
165 Tt_status       _tt_spec_prop_set(const char *nodeid, const char *propname, const char *value);
166 char           *_tt_spec_propname(const char *nodeid, int n);
167 int             _tt_spec_propnames_count(const char *nodeid);
168 Tt_status       _tt_spec_write(const char *nodeid);
169
170 int             _tt_objid_equal(const char *nodeid1, const char *nodeid2);
171 char           *_tt_objid_objkey(const char *nodeid);
172 Tt_status       _tt_pattern_arg_add(Tt_pattern p, Tt_mode n,
173                                     const char *vtype, const char *value);
174 Tt_status       _tt_pattern_barg_add(Tt_pattern p, Tt_mode n,
175                                      const char *vtype, 
176                                      const unsigned char *value, int len);
177 Tt_status       _tt_pattern_iarg_add(Tt_pattern p, Tt_mode n,
178                                      const char *vtype, int value);
179
180 Tt_status       _tt_pattern_callback_add(Tt_pattern m,
181                                            Tt_message_callback f);    
182 Tt_category     _tt_pattern_category(Tt_pattern p);
183 Tt_status       _tt_pattern_category_set(Tt_pattern p, Tt_category c);
184 Tt_status       _tt_pattern_class_add(Tt_pattern p, Tt_class c);
185 Tt_pattern      _tt_pattern_create(void);
186 Tt_status       _tt_pattern_destroy(Tt_pattern p);
187 Tt_status       _tt_pattern_file_add(Tt_pattern p, const char *filepath);
188 Tt_status       _tt_pattern_object_add(Tt_pattern p, const char *objid);
189 Tt_status       _tt_pattern_op_add(Tt_pattern p, const char *opname);
190 Tt_status       _tt_pattern_otype_add(Tt_pattern p, const char *otype);
191 Tt_status       _tt_pattern_address_add(Tt_pattern p, Tt_address d);
192 Tt_status       _tt_pattern_register(Tt_pattern p);
193 Tt_status       _tt_pattern_unregister(Tt_pattern p);
194 Tt_status       _tt_pattern_disposition_add(Tt_pattern p, Tt_disposition r);
195 Tt_status       _tt_pattern_scope_add(Tt_pattern p, Tt_scope s);
196 Tt_status       _tt_pattern_sender_add(Tt_pattern p, const char *procid);
197 Tt_status       _tt_pattern_sender_ptype_add(Tt_pattern p, const char *ptid);
198 Tt_status       _tt_pattern_session_add(Tt_pattern p, const char *sessid);
199 Tt_status       _tt_pattern_state_add(Tt_pattern p, Tt_state s);
200 void           *_tt_pattern_user(Tt_pattern p, int key);
201 Tt_status       _tt_pattern_user_set(Tt_pattern p, int key, void *v);
202
203 Tt_status       _tt_ptype_declare(const char *ptid);
204 Tt_status       _tt_ptype_undeclare(const char *ptid);
205 Tt_status       _tt_ptype_exists(const char *ptid);
206
207
208 char            *_tt_session_prop(const char *sessid, const char *propname,
209                                   int i);
210 Tt_status       _tt_session_prop_add(const char *sessid, const char *propname,
211                                      const char *value);
212 int             _tt_session_prop_count(const char *sessid,
213                                        const char *propname);
214 Tt_status       _tt_session_prop_set(const char *sessid, const char *propname,
215                                      const char *value);
216 Tt_status       _tt_session_bprop(const char *sessid, const char *propname,
217                                   int i,
218                                   unsigned char **value, int *length);
219 Tt_status       _tt_session_bprop_add(const char *sessid, const char *propname,
220                                       unsigned const char *value, int length);
221 Tt_status       _tt_session_bprop_set(const char *sessid, const char *propname,
222                                       unsigned const char *value, int length);
223 char           *_tt_session_propname(const char *sessid, int n);
224 int             _tt_session_propnames_count(const char *sessid);
225
226 char           *_tt_default_session(void);
227 Tt_status       _tt_default_session_set(const char *sessid);
228
229 char           *_tt_default_procid(void);
230 Tt_status       _tt_default_procid_set(const char *procid);
231
232 char           *_tt_thread_session(void);
233 Tt_status       _tt_thread_session_set(const char *sessid);
234
235 char           *_tt_thread_procid(void);
236 Tt_status       _tt_thread_procid_set(const char *procid);
237
238 char           *_tt_procid_session(const char *);
239 Tt_status       _tt_feature_enabled(Tt_feature f);
240 Tt_status       _tt_feature_required(Tt_feature f);
241
242 void            _tt_internal_init();
243 #endif