Source

pygame / src / joystick.c

  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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
/*
    pygame - Python Game Library
    Copyright (C) 2000  Pete Shinners

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

    Pete Shinners
    pete@shinners.org
*/

#define PYGAMEAPI_JOYSTICK_INTERNAL
#include "pygame.h"


#define JOYSTICK_MAXSTICKS 32
static SDL_Joystick* joystick_stickdata[JOYSTICK_MAXSTICKS] = {NULL};


staticforward PyTypeObject Joystick_Type;
static PyObject* PyJoystick_New(int);
#define PyJoystick_Check(x) ((x)->ob_type == &PyJoystick_Type)



static void joy_autoquit()
{
	int loop;
	for(loop = 0; loop < JOYSTICK_MAXSTICKS; ++loop)
	{
		if(joystick_stickdata[loop])
		{
			SDL_JoystickClose(joystick_stickdata[loop]);
			joystick_stickdata[loop] = NULL;
		}
	}

	if(SDL_WasInit(SDL_INIT_JOYSTICK))
	{
		SDL_JoystickEventState(SDL_ENABLE);
		SDL_QuitSubSystem(SDL_INIT_JOYSTICK);
	}
}

static PyObject* joy_autoinit(PyObject* self, PyObject* arg)
{
	if(!PyArg_ParseTuple(arg, ""))
		return NULL;

	if(!SDL_WasInit(SDL_INIT_JOYSTICK))
	{
		if(SDL_InitSubSystem(SDL_INIT_JOYSTICK))
			return PyInt_FromLong(0);
		SDL_JoystickEventState(SDL_ENABLE);
		PyGame_RegisterQuit(joy_autoquit);
	}
	return PyInt_FromLong(1);
}


    /*DOC*/ static char doc_quit[] =
    /*DOC*/    "pygame.joystick.quit() -> None\n"
    /*DOC*/    "uninitialize joystick module\n"
    /*DOC*/    "\n"
    /*DOC*/    "Uninitialize the joystick module manually\n"
    /*DOC*/ ;

static PyObject* quit(PyObject* self, PyObject* arg)
{
	if(!PyArg_ParseTuple(arg, ""))
		return NULL;

	joy_autoquit();

	RETURN_NONE
}

    /*DOC*/ static char doc_init[] =
    /*DOC*/    "pygame.joystick.init() -> None\n"
    /*DOC*/    "initialize joystick module\n"
    /*DOC*/    "\n"
    /*DOC*/    "Initialize the joystick module manually\n"
    /*DOC*/ ;

static PyObject* init(PyObject* self, PyObject* arg)
{
	PyObject* result;
	int istrue;

	if(!PyArg_ParseTuple(arg, ""))
		return NULL;

	result = joy_autoinit(self, arg);
	istrue = PyObject_IsTrue(result);
	Py_DECREF(result);
	if(!istrue)
		return RAISE(PyExc_SDLError, SDL_GetError());

	RETURN_NONE
}



    /*DOC*/ static char doc_get_init[] =
    /*DOC*/    "pygame.joystick.get_init() -> bool\n"
    /*DOC*/    "query initialization of joystick module\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns true when the joystick module is initialized.\n"
    /*DOC*/ ;

static PyObject* get_init(PyObject* self, PyObject* arg)
{
	if(!PyArg_ParseTuple(arg, ""))
		return NULL;

	return PyInt_FromLong(SDL_WasInit(SDL_INIT_JOYSTICK)!=0);
}



/*joystick object funcs*/


static void joy_dealloc(PyObject* self)
{
	PyMem_DEL(self);
}


    /*DOC*/ static char doc_Joystick[] =
    /*DOC*/    "pygame.joystick.Joystick(id) -> Joystick\n"
    /*DOC*/    "create new joystick object\n"
    /*DOC*/    "\n"
    /*DOC*/    "Creates a new joystick object for the given device id. The given id\n"
    /*DOC*/    "must be less than the value from pygame.joystick.get_count().\n"
    /*DOC*/ ;

static PyObject* Joystick(PyObject* self, PyObject* args)
{
	int id;	
	if(!PyArg_ParseTuple(args, "i", &id))
		return NULL;

	JOYSTICK_INIT_CHECK();

	return PyJoystick_New(id);
}



    /*DOC*/ static char doc_get_count[] =
    /*DOC*/    "pygame.joystick.get_count() -> int\n"
    /*DOC*/    "query number of joysticks on system\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the number of joysticks devices available on\n"
    /*DOC*/    "the system.\n"
    /*DOC*/ ;

static PyObject* get_count(PyObject* self, PyObject* args)
{
	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	JOYSTICK_INIT_CHECK();

	return PyInt_FromLong(SDL_NumJoysticks());
}




    /*DOC*/ static char doc_joy_init[] =
    /*DOC*/    "Joystick.init() -> None\n"
    /*DOC*/    "initialize a joystick device for use\n"
    /*DOC*/    "\n"
    /*DOC*/    "In order to call most members in the Joystick object, the\n"
    /*DOC*/    "Joystick must be initialized. You can initialzie the Joystick object\n"
    /*DOC*/    "at anytime, and it is ok to initialize more than once.\n"
    /*DOC*/ ;

static PyObject* joy_init(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);

	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	JOYSTICK_INIT_CHECK();

	if(!joystick_stickdata[joy_id])
	{
		joystick_stickdata[joy_id] = SDL_JoystickOpen(joy_id);
		if(!joystick_stickdata[joy_id])
			return RAISE(PyExc_SDLError, SDL_GetError());
	}
	RETURN_NONE
}


    /*DOC*/ static char doc_joy_quit[] =
    /*DOC*/    "Joystick.quit() -> None\n"
    /*DOC*/    "uninitialize a joystick device for use\n"
    /*DOC*/    "\n"
    /*DOC*/    "After you are completely finished with a joystick device, you\n"
    /*DOC*/    "can use this quit() function to free access to the drive.\n"
    /*DOC*/    "This will be cleaned up automatically when the joystick module is.\n"
    /*DOC*/    "uninitialized. It is safe to call this function on an uninitialized Joystick.\n"
    /*DOC*/ ;

static PyObject* joy_quit(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);

	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	JOYSTICK_INIT_CHECK();

	if(joystick_stickdata[joy_id])
	{
		SDL_JoystickClose(joystick_stickdata[joy_id]);
		joystick_stickdata[joy_id] = NULL;
	}
	RETURN_NONE
}



    /*DOC*/ static char doc_joy_get_init[] =
    /*DOC*/    "Joystick.get_init() -> bool\n"
    /*DOC*/    "check if joystick is initialized\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns a true value if the Joystick is initialized.\n"
    /*DOC*/ ;

static PyObject* joy_get_init(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);

	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	return PyInt_FromLong(joystick_stickdata[joy_id] != NULL);
}



    /*DOC*/ static char doc_joy_get_id[] =
    /*DOC*/    "Joystick.get_id() -> idnum\n"
    /*DOC*/    "get device id number for joystick\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the device id number for this Joystick. This is the\n"
    /*DOC*/    "same number used in the call to pygame.joystick.Joystick() to create\n"
    /*DOC*/    "the object. The Joystick does not need to be initialized for this\n"
    /*DOC*/    "function to work.\n"
    /*DOC*/ ;

static PyObject* joy_get_id(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);

	if(!PyArg_ParseTuple(args, ""))
		return NULL;
	return PyInt_FromLong(joy_id);
}


    /*DOC*/ static char doc_joy_get_name[] =
    /*DOC*/    "Joystick.get_name(id) -> string\n"
    /*DOC*/    "query name of joystick drive\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the name of the Joystick device, given by the\n"
    /*DOC*/    "system. This function can be called before the Joystick\n"
    /*DOC*/    "is initialized.\n"
    /*DOC*/ ;

static PyObject* joy_get_name(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	
	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	JOYSTICK_INIT_CHECK();

	return PyString_FromString(SDL_JoystickName(joy_id));
}



    /*DOC*/ static char doc_joy_get_numaxes[] =
    /*DOC*/    "Joystick.get_numaxes() -> int\n"
    /*DOC*/    "get number of axes on a joystick\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the number of available axes on the Joystick.\n"
    /*DOC*/ ;

static PyObject* joy_get_numaxes(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	SDL_Joystick* joy = joystick_stickdata[joy_id];

	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	JOYSTICK_INIT_CHECK();
	if(!joy)
		return RAISE(PyExc_SDLError, "Joystick not initialized");

	return PyInt_FromLong(SDL_JoystickNumAxes(joy));
}



    /*DOC*/ static char doc_joy_get_axis[] =
    /*DOC*/    "Joystick.get_axis(axis) -> float\n"
    /*DOC*/    "get the position of a joystick axis\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the current position of a joystick axis. The value\n"
    /*DOC*/    "will range from -1 to 1 with a value of 0 being centered. You\n"
    /*DOC*/    "may want to take into account some tolerance to handle jitter,\n"
    /*DOC*/    "and joystick drift may keep the joystick from centering at 0 or\n"
    /*DOC*/    "using the full range of position values.\n"
    /*DOC*/ ;

static PyObject* joy_get_axis(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	SDL_Joystick* joy = joystick_stickdata[joy_id];
	int axis, value;
	
	if(!PyArg_ParseTuple(args, "i", &axis))
		return NULL;

	JOYSTICK_INIT_CHECK();
	if(!joy)
		return RAISE(PyExc_SDLError, "Joystick not initialized");
	if(axis < 0 || axis >= SDL_JoystickNumAxes(joy))
		return RAISE(PyExc_SDLError, "Invalid joystick axis");

	value = SDL_JoystickGetAxis(joy, axis);
	return PyFloat_FromDouble(value / 32768.0);
}


    /*DOC*/ static char doc_joy_get_numbuttons[] =
    /*DOC*/    "Joystick.get_numbuttons() -> int\n"
    /*DOC*/    "get number of buttons on a joystick\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the number of available buttons on the Joystick.\n"
    /*DOC*/ ;

static PyObject* joy_get_numbuttons(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	SDL_Joystick* joy = joystick_stickdata[joy_id];

	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	JOYSTICK_INIT_CHECK();
	if(!joy)
		return RAISE(PyExc_SDLError, "Joystick not initialized");

	return PyInt_FromLong(SDL_JoystickNumButtons(joy));
}



    /*DOC*/ static char doc_joy_get_button[] =
    /*DOC*/    "Joystick.get_button(button) -> bool\n"
    /*DOC*/    "get the position of a joystick button\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the current state of a joystick button.\n"
    /*DOC*/ ;

static PyObject* joy_get_button(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	SDL_Joystick* joy = joystick_stickdata[joy_id];
	int index, value;
	
	if(!PyArg_ParseTuple(args, "i", &index))
		return NULL;

	JOYSTICK_INIT_CHECK();
	if(!joy)
		return RAISE(PyExc_SDLError, "Joystick not initialized");
	if(index < 0 || index >= SDL_JoystickNumButtons(joy))
		return RAISE(PyExc_SDLError, "Invalid joystick button");

	value = SDL_JoystickGetButton(joy, index);
	return PyInt_FromLong(value);
}


    /*DOC*/ static char doc_joy_get_numballs[] =
    /*DOC*/    "Joystick.get_numballs() -> int\n"
    /*DOC*/    "get number of trackballs on a joystick\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the number of available trackballs on the Joystick.\n"
    /*DOC*/ ;

static PyObject* joy_get_numballs(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	SDL_Joystick* joy = joystick_stickdata[joy_id];

	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	JOYSTICK_INIT_CHECK();
	if(!joy)
		return RAISE(PyExc_SDLError, "Joystick not initialized");

	return PyInt_FromLong(SDL_JoystickNumBalls(joy));
}



    /*DOC*/ static char doc_joy_get_ball[] =
    /*DOC*/    "Joystick.get_ball(button) -> x, y\n"
    /*DOC*/    "get the movement of a joystick trackball\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the relative movement of a joystick button. The\n"
    /*DOC*/    "value is a x, y pair holding the relative movement since the\n"
    /*DOC*/    "last call to get_ball()\n"
    /*DOC*/ ;

static PyObject* joy_get_ball(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	SDL_Joystick* joy = joystick_stickdata[joy_id];
	int index, dx, dy;
	
	if(!PyArg_ParseTuple(args, "i", &index))
		return NULL;

	JOYSTICK_INIT_CHECK();
	if(!joy)
		return RAISE(PyExc_SDLError, "Joystick not initialized");
	if(index < 0 || index >= SDL_JoystickNumBalls(joy))
		return RAISE(PyExc_SDLError, "Invalid joystick trackball");

	SDL_JoystickGetBall(joy, index, &dx, &dy);
	return Py_BuildValue("(ii)", dx, dy);
}


    /*DOC*/ static char doc_joy_get_numhats[] =
    /*DOC*/    "Joystick.get_numballs() -> int\n"
    /*DOC*/    "get number of hats on a joystick\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the number of available directional hats on the Joystick.\n"
    /*DOC*/ ;

static PyObject* joy_get_numhats(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	SDL_Joystick* joy = joystick_stickdata[joy_id];

	if(!PyArg_ParseTuple(args, ""))
		return NULL;

	JOYSTICK_INIT_CHECK();
	if(!joy)
		return RAISE(PyExc_SDLError, "Joystick not initialized");

	return PyInt_FromLong(SDL_JoystickNumHats(joy));
}



    /*DOC*/ static char doc_joy_get_hat[] =
    /*DOC*/    "Joystick.get_hat(button) -> x, y\n"
    /*DOC*/    "get the position of a joystick hat\n"
    /*DOC*/    "\n"
    /*DOC*/    "Returns the current position of a position hat. The position\n"
    /*DOC*/    "is given as two values representing the X and Y position for the\n"
    /*DOC*/    "hat. (0, 0) means centered. A value of -1 means left/down a value\n"
    /*DOC*/    "of one means right/up\n"
    /*DOC*/ ;

static PyObject* joy_get_hat(PyObject* self, PyObject* args)
{
	int joy_id = PyJoystick_AsID(self);
	SDL_Joystick* joy = joystick_stickdata[joy_id];
	int index, px, py;
	Uint8 value;

	if(!PyArg_ParseTuple(args, "i", &index))
		return NULL;

	JOYSTICK_INIT_CHECK();
	if(!joy)
		return RAISE(PyExc_SDLError, "Joystick not initialized");
	if(index < 0 || index >= SDL_JoystickNumHats(joy))
		return RAISE(PyExc_SDLError, "Invalid joystick hat");

	px = py = 0;
	value = SDL_JoystickGetHat(joy, index);
	if(value&SDL_HAT_UP) py = 1;
	else if(value&SDL_HAT_DOWN) py = -1;
	if(value&SDL_HAT_RIGHT) px = 1;
	else if(value&SDL_HAT_LEFT) px = -1;
	
	return Py_BuildValue("(ii)", px, py);
}



static PyMethodDef joy_builtins[] =
{
	{ "init", joy_init, 1, doc_joy_init },
	{ "quit", joy_quit, 1, doc_joy_quit },
	{ "get_init", joy_get_init, 1, doc_joy_get_init },

	{ "get_id", joy_get_id, 1, doc_joy_get_id },
	{ "get_name", joy_get_name, 1, doc_joy_get_name },

	{ "get_numaxes", joy_get_numaxes, 1, doc_joy_get_numaxes },
	{ "get_axis", joy_get_axis, 1, doc_joy_get_axis },
	{ "get_numbuttons", joy_get_numbuttons, 1, doc_joy_get_numbuttons },
	{ "get_button", joy_get_button, 1, doc_joy_get_button },
	{ "get_numballs", joy_get_numballs, 1, doc_joy_get_numballs },
	{ "get_ball", joy_get_ball, 1, doc_joy_get_ball },
	{ "get_numhats", joy_get_numhats, 1, doc_joy_get_numhats },
	{ "get_hat", joy_get_hat, 1, doc_joy_get_hat },

	{ NULL, NULL }
};

static PyObject* joy_getattr(PyObject* self, char* attrname)
{
	return Py_FindMethod(joy_builtins, self, attrname);
}


    /*DOC*/ static char doc_Joystick_MODULE[] =
    /*DOC*/    "The Joystick object represents a joystick device and allows you to\n"
    /*DOC*/    "access the controls on that joystick. All functions (except get_name()\n"
    /*DOC*/    "and get_id()) require the Joystick object to be initialized. This is done\n"
    /*DOC*/    "with the Joystick.init() function.\n"
    /*DOC*/    "\n"
    /*DOC*/    "Joystick control values are only updated during the calls to the event\n"
    /*DOC*/    "queue. Call pygame.event.pump() if you are not using the event queue for\n"
    /*DOC*/    "any input handling. Once a joystick object has been initialized, it will\n"
    /*DOC*/    "start to send joystick events to the input queue.\n"
    /*DOC*/    "\n"
    /*DOC*/    "Be sure to understand there is a difference between the joystick module\n"
    /*DOC*/    "and the Joystick objects.\n"
    /*DOC*/ ;


static PyTypeObject PyJoystick_Type =
{
	PyObject_HEAD_INIT(NULL)
	0,
	"Joystick",
	sizeof(PyJoystickObject),
	0,
	joy_dealloc,
	0,
	joy_getattr,
	0,
	0,
	0,
	0,
	NULL,
	0
};



static PyObject* PyJoystick_New(int id)
{
	PyJoystickObject* joy;

	if(id < 0 || id >= JOYSTICK_MAXSTICKS || id >= SDL_NumJoysticks())
		return RAISE(PyExc_SDLError, "Invalid joystick device number");
	
	joy = PyObject_NEW(PyJoystickObject, &PyJoystick_Type);
	if(!joy) return NULL;

	joy->id = id;

	return (PyObject*)joy;
}





static PyMethodDef joystick_builtins[] =
{
	{ "__PYGAMEinit__", joy_autoinit, 1, doc_joy_init },
	{ "init", init, 1, doc_init },
	{ "quit", quit, 1, doc_quit },
	{ "get_init", get_init, 1, doc_get_init },
	{ "get_count", get_count, 1, doc_get_count },
	{ "Joystick", Joystick, 1, doc_Joystick },
	{ NULL, NULL }
};




    /*DOC*/ static char doc_pygame_joystick_MODULE[] =
    /*DOC*/    "The joystick module provides a few functions to initialize\n"
    /*DOC*/    "the joystick subsystem and to manage the Joystick objects. These\n"
    /*DOC*/    "objects are created with the pygame.joystick.Joystick() function.\n"
    /*DOC*/    "This function needs a joystick device number to work on. All\n"
    /*DOC*/    "joystick devices on the system are enumerated for use as a Joystick\n"
    /*DOC*/    "object. To access most of the Joystick functions, you'll need to\n"
    /*DOC*/    "Init() the Joystick. (note that the joystick module will already\n"
    /*DOC*/    "be initialized). When multiple Joysticks objects are created for the\n"
    /*DOC*/    "same joystick device, the state and values for those Joystick objects\n"
    /*DOC*/    "will be shared.\n"
    /*DOC*/    "\n"
    /*DOC*/    "You can call the Joystick.get_name() and Joystick.get_id() functions\n"
    /*DOC*/    "without initializing the Joystick object.\n"
    /*DOC*/    "\n"
    /*DOC*/    "Joystick control values are only updated during the calls to the event\n"
    /*DOC*/    "queue. Call pygame.event.pump() if you are not using the event queue for\n"
    /*DOC*/    "any input handling. Once a joystick object has been initialized, it will\n"
    /*DOC*/    "start to send joystick events to the input queue.\n"
    /*DOC*/    "\n"
    /*DOC*/    "Be sure to understand there is a difference between the joystick module\n"
    /*DOC*/    "and the Joystick objects.\n"
    /*DOC*/ ;

void initjoystick()
{
	PyObject *module, *dict, *apiobj;
	static void* c_api[PYGAMEAPI_JOYSTICK_NUMSLOTS];

	PyType_Init(PyJoystick_Type);


    /* create the module */
	module = Py_InitModule3("joystick", joystick_builtins, doc_pygame_joystick_MODULE);
	dict = PyModule_GetDict(module);

	/* export the c api */
	c_api[0] = &PyJoystick_Type;
	c_api[1] = PyJoystick_New;
	apiobj = PyCObject_FromVoidPtr(c_api, NULL);
	PyDict_SetItemString(dict, PYGAMEAPI_LOCAL_ENTRY, apiobj);

	/*imported needed apis*/
	import_pygame_base();
}