~ubuntu-branches/ubuntu/trusty/libgii/trusty

/* $Id: gii.h,v 1.3 2001/06/30 09:56:14 soyt Exp $

******************************************************************************

 

   LibGII API header file

 

   Copyright (C) 1998      Andreas Beck         [becka@ggi-project.org]

   Copyright (C) 1999-2000 Marcus Sundberg      [marcus@ggi-project.org]

 

   Permission is hereby granted, free of charge, to any person obtaining a

   copy of this software and associated documentation files (the "Software"),

   to deal in the Software without restriction, including without limitation

   the rights to use, copy, modify, merge, publish, distribute, sublicense,

   and/or sell copies of the Software, and to permit persons to whom the

   Software is furnished to do so, subject to the following conditions:

 

   The above copyright notice and this permission notice shall be included in

   all copies or substantial portions of the Software.

 

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL

   THE AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

   IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

   CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 

******************************************************************************

*/

              

#ifndef _GGI_GII_H

#define _GGI_GII_H

 

#include <ggi/events.h>

 

#ifndef _INTERNAL_LIBGII

/* Opaque pointer types.

   This little magic gains us some type checking. */

struct gii_h_dummy1 { char dummy1; };

typedef struct gii_h_dummy1 *gii_input_t;

#endif

 

 

/*

******************************************************************************

 libGII function definitions

******************************************************************************

*/

__BEGIN_DECLS

 

/* Get the master config dir

 */

const char *giiGetConfDir(void);

 

/* Enter and leave the library.

 */

int  giiInit(void);

int  giiExit(void);

void giiPanic(const char *format, ...);

 

/* Turn on thread safe operation

 */

int giiMTInit(void);

 

/* Open a new Input - use input `NULL' for autoselect.

 */

gii_input_t     giiOpen(const char *input,...);

int             giiClose(gii_input_t inp);

 

/* Input management

 */

gii_input_t giiJoinInputs(gii_input_t inp, gii_input_t inp2);

int giiSplitInputs(gii_input_t inp, gii_input_t *newhand,

                   uint32 origin, uint32 flags);

 

/* Event Handling

 */

gii_event_mask  giiEventPoll(gii_input_t inp, gii_event_mask mask,

                             struct timeval *t);

int             giiEventRead(gii_input_t inp, gii_event *ev,

                             gii_event_mask mask);

int             giiEventsQueued(gii_input_t inp, gii_event_mask mask);

int             giiEventSend(gii_input_t inp, gii_event *ev);

int             giiSetEventMask(gii_input_t inp, gii_event_mask evm);

gii_event_mask  giiGetEventMask(gii_input_t inp);

 

#define giiAddEventMask(inp,mask)  \

                giiSetEventMask((inp), giiGetEventMask((inp)) | (mask))

#define giiRemoveEventMask(inp,mask)  \

                giiSetEventMask((inp), giiGetEventMask((inp)) & ~(mask))

 

/* Deviceinfo stuff

 */

int          giiQueryDeviceInfo        (gii_input_t inp, uint32 origin, gii_cmddata_getdevinfo *info);

int          giiQueryDeviceInfoByNumber(gii_input_t inp, uint32 number, uint32 *origin, gii_cmddata_getdevinfo *info);

int          giiQueryValInfo   (gii_input_t inp, uint32 origin, uint32 valnumber, gii_cmddata_getvalinfo *info);

 

__END_DECLS

 

#endif /* _GGI_GII_H */