summaryrefslogtreecommitdiff
path: root/include/compiz.h
blob: 32be090b9e44cd63195d73992edbeab1793f6b62 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/*
 * Copyright © 2007 Novell, Inc.
 *
 * Permission to use, copy, modify, distribute, and sell this software
 * and its documentation for any purpose is hereby granted without
 * fee, provided that the above copyright notice appear in all copies
 * and that both that copyright notice and this permission notice
 * appear in supporting documentation, and that the name of
 * Novell, Inc. not be used in advertising or publicity pertaining to
 * distribution of the software without specific, written prior permission.
 * Novell, Inc. makes no representations about the suitability of this
 * software for any purpose. It is provided "as is" without express or
 * implied warranty.
 *
 * NOVELL, INC. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
 * NO EVENT SHALL NOVELL, INC. BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
 * OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 * Author: David Reveman <davidr@novell.com>
 */

#ifndef _COMPIZ_H
#define _COMPIZ_H

#include <libxml/parser.h>

#include <compiz-common.h>

COMPIZ_BEGIN_DECLS

typedef int CompBool;
typedef int CompTimeoutHandle;
typedef int CompWatchFdHandle;

typedef union _CompOptionValue CompOptionValue;

typedef struct _CompObject   CompObject;
typedef struct _CompDisplay  CompDisplay;
typedef struct _CompMetadata CompMetadata;
typedef struct _CompOption   CompOption;
typedef struct _CompPlugin   CompPlugin;
typedef struct _CompScreen   CompScreen;
typedef struct _CompWindow   CompWindow;

typedef CompBool (*CallBackProc) (void *closure);

typedef enum {
    CompOptionTypeBool,
    CompOptionTypeInt,
    CompOptionTypeFloat,
    CompOptionTypeString,
    CompOptionTypeColor,
    CompOptionTypeAction,
    CompOptionTypeKey,
    CompOptionTypeButton,
    CompOptionTypeEdge,
    CompOptionTypeBell,
    CompOptionTypeMatch,
    CompOptionTypeList
} CompOptionType;

void
compInitOptionValue (CompOptionValue *v);

void
compFiniOptionValue (CompOptionValue *v,
		     CompOptionType  type);

void
compInitOption (CompOption *option);

void
compFiniOption (CompOption *option);

CompOption *
compFindOption (CompOption *option,
		int	    nOption,
		const char  *name,
		int	    *index);

CompBool
compSetBoolOption (CompOption      *option,
		   CompOptionValue *value);

CompBool
compSetIntOption (CompOption	  *option,
		  CompOptionValue *value);

CompBool
compSetFloatOption (CompOption	    *option,
		    CompOptionValue *value);

CompBool
compSetStringOption (CompOption	     *option,
		     CompOptionValue *value);

CompBool
compSetColorOption (CompOption	    *option,
		    CompOptionValue *value);

CompBool
compSetActionOption (CompOption      *option,
		     CompOptionValue *value);

CompBool
compSetMatchOption (CompOption      *option,
		    CompOptionValue *value);

CompBool
compSetOptionList (CompOption      *option,
		   CompOptionValue *value);

CompBool
compSetOption (CompOption      *option,
	       CompOptionValue *value);

CompTimeoutHandle
compAddTimeout (int	     time,
		CallBackProc callBack,
		void	     *closure);

void *
compRemoveTimeout (CompTimeoutHandle handle);

CompWatchFdHandle
compAddWatchFd (int	     fd,
		short int    events,
		CallBackProc callBack,
		void	     *closure);

void
compRemoveWatchFd (CompWatchFdHandle handle);

short int
compWatchFdEvents (CompWatchFdHandle handle);

CompBool
compInitMetadata (CompMetadata *metadata);

CompBool
compInitPluginMetadata (CompMetadata *metadata,
			const char   *plugin);

void
compFiniMetadata (CompMetadata *metadata);

CompBool
compAddMetadataFromFile (CompMetadata *metadata,
			 const char   *file);

CompBool
compAddMetadataFromString (CompMetadata *metadata,
			   const char	*string);

CompBool
compAddMetadataFromIO (CompMetadata	     *metadata,
		       xmlInputReadCallback  ioread,
		       xmlInputCloseCallback ioclose,
		       void		     *ioctx);

char *
compGetStringFromMetadataPath (CompMetadata *metadata,
			       const char   *path);

int
compReadXmlChunk (const char *src,
		  int	     *offset,
		  char	     *buffer,
		  int	     length);


COMPIZ_END_DECLS

#endif