summaryrefslogtreecommitdiff
path: root/libxklavier/xklavier_private.h
blob: a0af474a4469634c2b9b110fde0b517e43f8a09a (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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
#ifndef __XKLAVIER_PRIVATE_H__
#define __XKLAVIER_PRIVATE_H__

#include <stdio.h>

#include <libxklavier/xklavier_config.h>

typedef Bool ( *XklConfigActivateHandler )( const XklConfigRecPtr data );

typedef void ( *XklConfigInitHandler )( void );

typedef Bool ( *XklConfigLoadRegistryHandler )( void );

typedef Bool ( *XklConfigMultipleLayoutsSupportedHandler )( void );

typedef Bool ( *XklConfigWriteFileHandler )( const char *fileName,
                                             const XklConfigRecPtr data,
                                             const Bool binary );

typedef int ( *XklEventHandler )( XEvent *xev );

typedef void ( *XklFreeAllInfoHandler )( void );

typedef const char **( *XklGetGroupNamesHandler )( void );

typedef unsigned ( *XklGetNumGroupsHandler )( void );

typedef Bool ( *XklLoadAllInfoHandler )( void );

typedef void ( *XklLockGroupHandler )( int group );

typedef int ( *XklPauseResumeListenHandler )( void );

typedef void ( *XklSetIndicatorsHandler )( const XklState *windowState );

typedef struct
{
  /**
   * Activates the configuration.
   * xkb: create proper the XkbDescRec and send it to the server
   * TODO: xmodmap
   */
  XklConfigActivateHandler xklConfigActivateHandler;
  /**
   * Background-specific initialization.
   * xkb: XkbInitAtoms - init internal xkb atoms table
   * TODO: xmodmap
   */
  XklConfigInitHandler xklConfigInitHandler; /* private */
  /**
   * Loads the registry tree into DOM (using whatever path(s))
   * The XklConfigFreeRegistry is static - no virtualization necessary.
   * xkb: loads xml from XKB_BASE+"/rules/"+ruleset+".xml"
   * TODO: xmodmap
   */
  XklConfigLoadRegistryHandler xklConfigLoadRegistryHandler;
  /**
   * Can the system combine layouts in one configuration - or not?
   * xkb: checks the simple rule with 2 layouts
   * xmodmap: return true
   */
  XklConfigMultipleLayoutsSupportedHandler xklConfigMultipleLayoutsSupportedHandler;
  /**
   * Write the configuration into the file (binary/textual)
   * xkb: write xkb or xkm file
   * TODO: xmodmap
   */
  XklConfigWriteFileHandler xklConfigWriteFileHandler;
  /**
   * Handles X events.
   * xkb: XkbEvent handling
   * TODO: xmodmap: .... (scariest thing)
   */
  XklEventHandler xklEventHandler;
  /**
   * Flushes the cached server config info.
   * xkb: frees XkbDesc
   * TODO: xmodmap
   */
  XklFreeAllInfoHandler xklFreeAllInfoHandler; /* private */
  /**
   * Get the list of the group names
   * xkb: return cached list of the group names
   * TODO: xmodmap
   */
  XklGetGroupNamesHandler xklGetGroupNamesHandler;
  /**
   * Get the number of loaded groups
   * xkb: return from the cached XkbDesc
   * TODO: xmodmap
   */
  XklGetNumGroupsHandler xklGetNumGroupsHandler;
  /**
   * Loads the configuration info from the server
   * xkb: loads XkbDesc, names, indicators
   * TODO: xmodmap
   */
  XklLoadAllInfoHandler xklLoadAllInfoHandler; /* private */
  /**
   * Switches the keyboard to the group N
   * xkb: simple one-liner to call the XKB function
   * TODO: xmodmap
   */
  XklLockGroupHandler xklLockGroupHandler;
  /**
   * Stop tracking the keyboard-related events
   * xkb: XkbSelectEvents(..., 0)
   * TODO: xmodmap
   */
  XklPauseResumeListenHandler xklPauseListenHandler;
  /**
   * Start tracking the keyboard-related events
   * xkb: XkbSelectEvents + XkbSelectEventDetails + GetRealState
   * TODO: xmodmap
   */
  XklPauseResumeListenHandler xklResumeListenHandler;
  /**
   * Set the indicators state from the XklState
   * xkb: _XklSetIndicator for all indicators
   * TODO: xmodmap
   */
  XklSetIndicatorsHandler xklSetIndicatorsHandler; /* private */
} XklVTable;

extern void _XklEnsureVTableInited( void );

extern void _XklGetRealState( XklState * curState_return );
extern void _XklAddAppWindow( Window win, Window parent, Bool force,
                              XklState * initState );
extern Bool _XklGetAppWindowBottomToTop( Window win, Window * appWin_return );
extern Bool _XklGetAppWindow( Window win, Window * appWin_return );

extern void _XklFocusInEvHandler( XFocusChangeEvent * fev );
extern void _XklFocusOutEvHandler( XFocusChangeEvent * fev );
extern void _XklPropertyEvHandler( XPropertyEvent * rev );
extern void _XklCreateEvHandler( XCreateWindowEvent * cev );

extern void _XklErrHandler( Display * dpy, XErrorEvent * evt );

extern Window _XklGetRegisteredParent( Window win );
extern Bool _XklLoadAllInfo( void );
extern void _XklFreeAllInfo( void );
extern Bool _XklLoadWindowTree( void );
extern Bool _XklLoadSubtree( Window window, int level, XklState * initState );

extern Bool _XklHasWmState( Window win );

extern Bool _XklGetAppState( Window appWin, XklState * state_return );
extern void _XklDelAppState( Window appWin );
extern void _XklSaveAppState( Window appWin, XklState * state );

extern void _XklSelectInputMerging( Window win, long mask );

extern char *_XklGetDebugWindowTitle( Window win );

extern Status _XklStatusQueryTree( Display * display,
                                   Window w,
                                   Window * root_return,
                                   Window * parent_return,
                                   Window ** children_return,
                                   signed int *nchildren_return );

extern Bool _XklSetIndicator( int indicatorNum, Bool set );

extern void _XklTryCallStateCallback( XklStateChange changeType,
                                      XklState * oldState );

extern void _XklI18NInit(  );

extern char *_XklLocaleFromUtf8( const char *utf8string );

extern int _XklGetLanguagePriority( const char *language );

extern char *_XklConfigRecMergeByComma( const char **array,
                                        const int arrayLength );

extern char *_XklConfigRecMergeLayouts( const XklConfigRecPtr data );

extern char *_XklConfigRecMergeVariants( const XklConfigRecPtr data );

extern char *_XklConfigRecMergeOptions( const XklConfigRecPtr data );

extern void _XklConfigRecSplitByComma( char ***array,
                                       int *arraySize, const char *merged );

extern void _XklConfigRecSplitLayouts( XklConfigRecPtr data,
                                       const char *merged );

extern void _XklConfigRecSplitVariants( XklConfigRecPtr data,
                                        const char *merged );

extern void _XklConfigRecSplitOptions( XklConfigRecPtr data,
                                       const char *merged );

extern const char *_XklGetEventName( int type );

extern Bool _XklIsTransparentAppWindow( Window appWin );

extern void _XklUpdateCurState( int group, unsigned indicators, const char reason[] );

extern int _XklXkbInit( void );

extern int _XklXmmInit( void );

extern Display *_xklDpy;

extern Window _xklRootWindow;

extern XklState _xklCurState;

extern Window _xklCurClient;

extern Status _xklLastErrorCode;

extern const char *_xklLastErrorMsg;

extern XErrorHandler _xklDefaultErrHandler;

extern char *_xklIndicatorNames[];

#define WM_NAME 0
#define WM_STATE 1
#define XKLAVIER_STATE 2
#define XKLAVIER_TRANSPARENT 3

// XKB ones
#define XKB_RF_NAMES_PROP_ATOM 4
#define XKB_RF_NAMES_PROP_ATOM_BACKUP 5
#define TOTAL_ATOMS 6

#define XKLAVIER_STATE_PROP_LENGTH 2

// taken from XFree86 maprules.c
#define _XKB_RF_NAMES_PROP_MAXLEN 1024

extern Atom _xklAtoms[];

extern Bool _xklAllowSecondaryGroupOnce;

extern int _xklDefaultGroup;

extern Bool _xklSkipOneRestore;

extern int _xklSecondaryGroupsMask;

extern int _xklDebugLevel;

extern Window _xklPrevAppWindow;

#define WINID_FORMAT "%lx"

extern XklConfigCallback _xklConfigCallback;

extern void *_xklConfigCallbackData;

extern XklVTable *xklVTable;

#endif