Fixed bug #859 CREATE_SUBDIRS helps a lot if browsing HTML documentation in a file browser. ALWAYS_DETAILED_SEC makes sure everything has at least the automatic documentation like function prototype and source references. STRIP_FROM_PATH allows you to include only the relevant portions of the files' paths, cleaning up both the file list and directory tree, though you need to change the path listed here to match wherever you put SDL. ALIASES avoids some warnings generated by C:\source\svn.libsdl.org\trunk\SDL\src\joystick\darwin\10.3.9-FIX\IOHIDLib.h. It seems Apple uses a few commands which are not normally supported by Doxygen. BUILTIN_STL_SUPPORT adds support for parsing code which makes use of the standard template library. There isn't a lot of C++ in SDL (some in bwindow at least), but this still seems like a good idea. TYPEDEF_HIDES_STRUCT means that for code like this: typedef struct A {int B;} C; C is documented as a structure containing B instead of a typedef mapped to A. EXTRACT_ALL, EXTRACT_PRIVATE, EXTRACT_STATIC, EXTRACT_LOCAL_METHODS, EXTRACT_ANON_NSPACES and INTERNAL_DOCS make sure that _everything_ is documented. CASE_SENSE_NAMES = NO avoids potential conflicts when building documentation on case insensitive file systems like NTFS and FAT32. WARN_NO_PARAMDOC lets you know when you have documented some, but not all, of the parameters of a function. This is useful when you're working on adding such documentation since it makes partially documented functions easier to spot. WARN_LOGFILE writes warnings to a seperate file instead of mixing them in with stdout. When not running in quiet mode, these warnings can be hard to spot without this flag. I added *.h.in and *.h.default to FILE_PATTERNS to generate documentation for config.h.in and config.h.default. RECURSIVE tells doxygen to look not only in the input directory, but also in subfolders. EXCLUDE avoids documenting things like test programs, examples and templates which need to be documented separately. I've used EXCLUDE_PATTERNS to exclude non-source subdirectories that often find their way into source folders (such as obj or .svn). EXAMPLE_PATH lists directories doxygen will search to find included example code. So far, SDL doesn't really use this feature, but I've listed some likely locations. SOURCE_BROWSER adds syntax highlighted source code to the HTML output. USE_HTAGS is nice, but not available on Windows. INLINE_SOURCES adds the body of a function to it's documentation so you can quickly see exactly what it does. ALPHABETICAL_INDEX generates an alphabetical list of all structures, functions, etc., which makes it much easier to find what you're looking for. IGNORE_PREFIX skips the SDL_ prefix when deciding which index page to place an item on so you don't have everything show up under "S". HTML_DYNAMIC_SECTIONS hides the includes/included by diagrams by default and adds JavaScript to allow the user to show and hide them by clicking a link. ENUM_VALUES_PER_LINE = 1 makes enums easier to read by placing each value on it's own line. GENERATE_TREEVIEW produces a two frame index page with a navigation tree on the left. I have LaTeX and man pages turned off to speed up doxygen, you may want to turn them back on yourself. I added _WIN32=1 to PREDEFINED to cause SDL to output documentation related to Win32 builds of SDL. Normally, doxygen gets confused since there are multiple definitions for various structures and formats that vary by platform. Without this doxygen can produce broken documentation or, if you're lucky, output documentation only for the dummy drivers, which isn't very useful. You need to pick a platform. GENERATE_TAGFILE produces a file which can be used to link other doxygen documentation to the SDL documentation. CLASS_DIAGRAMS turns on class diagrams even when dot is not available. HAVE_DOT tells doxygen to try to use dot to generate diagrams. TEMPLATE_RELATIONS and INCLUDE_GRAPH add additional diagrams to the documentation. DOT_MULTI_TARGETS speeds up dot. OUTPUT_DIRECTORY, INPUT and other paths reflect the fact that this Doxyfile is intended to process src as well as include and is being run from a separate subdirectory. Doxygen produces several temporary files while it's running and if interrupted, can leave those files behind. It's easier to clean up if there aren't a hundred or so files in the same folder. I typically run doxygen in SDL/doxy and set the output directory to '.'. Since doxygen puts it's output in subfolders by type, this keeps things pretty well organised. You could use '../doc' instead and get the same results.

/*
    SDL - Simple DirectMedia Layer
    Copyright (C) 1997-2010 Sam Lantinga

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    Sam Lantinga
    slouken@libsdl.org

    QNX Graphics Framework SDL driver
    Copyright (C) 2009 Mike Gorchak
    (mike@malva.ua, lestat@i.com.ua)
*/

#ifndef __SDL_GF_INPUT_H__
#define __SDL_GF_INPUT_H__

#include "SDL_config.h"
#include "SDL_video.h"
#include "../SDL_sysvideo.h"

#include <errno.h>

#include <gf/gf.h>

#include <sys/hiddi.h>
#include <sys/hidut.h>

#include "SDL_qnxgf.h"

typedef struct SDL_MouseData
{
    SDL_DisplayData *didata;
} SDL_MouseData;

int32_t gf_addinputdevices(_THIS);
int32_t gf_delinputdevices(_THIS);

#define SDL_GF_MOUSE_COLOR_BLACK 0xFF000000
#define SDL_GF_MOUSE_COLOR_WHITE 0xFFFFFFFF
#define SDL_GF_MOUSE_COLOR_TRANS 0x00000000

/*****************************************************************************/
/* This is HIDDI closed interface declarations                               */
/*****************************************************************************/
#define HID_TYPE_MAIN      0x0
#define HID_TYPE_GLOBAL    0x1
#define HID_TYPE_LOCAL     0x2
#define HID_TYPE_RESERVED  0x3

#define HID_GLOBAL_USAGE_PAGE 0x0
#define HID_LOCAL_USAGE       0x0

typedef struct _hid_byte
{
    uint8_t HIDB_Length;
    uint8_t HIDB_Type;
    uint8_t HIDB_Tag;
    uint8_t reserved[1];
} hid_byte_t;

typedef struct _hidd_global_item
{
    uint16_t usage_page;
    uint16_t logical_min;
    uint16_t logical_max;
    uint16_t physical_min;
    uint16_t physical_max;
    uint16_t unit_expo;
    uint16_t unit;
    uint16_t report_size;
    uint16_t report_id;
    uint16_t report_count;
} hidd_global_item_t;

typedef struct _hidd_local_item
{
    uint16_t type;
    uint8_t reserved[2];
    uint32_t value;
    struct _hidd_local_item *next_local;
    struct _hidd_local_item *alt_local;
} hidd_local_item_t;

typedef struct _hidd_local_table
{
    hidd_local_item_t *usage_info;
    hidd_local_item_t *designator_info;
    hidd_local_item_t *string_info;
    uint8_t delimiter;
    uint8_t reserved[3];
} hidd_local_table_t;

typedef struct _hidd_field
{
    struct hidd_report_instance *report;
    struct hidd_collection *collection;
    uint16_t report_offset;
    uint16_t flags;
    hidd_global_item_t gitem;
    hidd_local_table_t *ltable;
    struct _hidd_field *next_field;
    void *user;
} hidd_field_t;

typedef struct hidd_report_instance
{
    uint8_t report_id;
    uint8_t reserved[1];
    uint16_t report_type;
    hidd_field_t *field;
    uint16_t num_field;
    uint16_t byte_len;
    uint16_t bit_len;
    uint8_t reserved2[2];
    struct hidd_collection *collection;
    struct hidd_report_instance *next_col_report;
    struct hidd_report_instance *next_report;
} hidd_report_instance_t;

typedef struct hidd_report
{
    TAILQ_ENTRY(hidd_report) link;
    hidd_report_instance_t *rinst;
    hidd_device_instance_t *dev_inst;
    uint32_t flags;
    struct hidd_connection *connection;
    void *user;
} hidd_report_t;

typedef struct hidview_device
{
    struct hidd_report_instance *instance;
    struct hidd_report *report;
} hidview_device_t;

/*****************************************************************************/
/* Closed HIDDI interface declarations end                                   */
/*****************************************************************************/

/* Maximum devices and subdevices amount per host */
#define SDL_HIDDI_MAX_DEVICES 64

/* Detected device/subdevice type for SDL */
#define SDL_GF_HIDDI_NONE     0x00000000
#define SDL_GF_HIDDI_MOUSE    0x00000001
#define SDL_GF_HIDDI_KEYBOARD 0x00000002
#define SDL_GF_HIDDI_JOYSTICK 0x00000003

extern void hiddi_enable_mouse();
extern void hiddi_disable_mouse();

#endif /* __SDL_GF_INPUT_H__ */