annotate src/video/directfb/SDL_DirectFB_dyn.c @ 5067:61d53410eb41

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.
author Sam Lantinga <slouken@libsdl.org>
date Fri, 21 Jan 2011 12:57:01 -0800
parents b196d2758026
children 164f20ba08eb
rev   line source
3000
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
1 /*
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
2 SDL - Simple DirectMedia Layer
3697
f7b03b6838cb Fixed bug #926
Sam Lantinga <slouken@libsdl.org>
parents: 3023
diff changeset
3 Copyright (C) 1997-2010 Sam Lantinga
3000
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
4
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
5 This library is free software; you can redistribute it and/or
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
6 modify it under the terms of the GNU Lesser General Public
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
7 License as published by the Free Software Foundation; either
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
8 version 2.1 of the License, or (at your option) any later version.
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
9
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
10 This library is distributed in the hope that it will be useful,
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
13 Lesser General Public License for more details.
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
14
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
15 You should have received a copy of the GNU Lesser General Public
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
16 License along with this library; if not, write to the Free Software
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
18
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
19 Sam Lantinga
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
20 slouken@libsdl.org
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
21 */
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
22 #include "SDL_config.h"
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
23
3023
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 3000
diff changeset
24 #include "SDL_DirectFB_video.h"
3000
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
25 #include "SDL_DirectFB_dyn.h"
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
26
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
27 #ifdef SDL_VIDEO_DRIVER_DIRECTFB_DYNAMIC
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
28 #include "SDL_name.h"
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
29 #include "SDL_loadso.h"
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
30
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
31 #define DFB_SYM(ret, name, args, al, func) ret (*name) args;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
32 static struct _SDL_DirectFB_Symbols
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
33 {
4636
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3697
diff changeset
34 DFB_SYMS
b196d2758026 Couriersud to Sam
Sam Lantinga <slouken@libsdl.org>
parents: 3697
diff changeset
35 const unsigned int *directfb_major_version;
3000
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
36 const unsigned int *directfb_minor_version;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
37 const unsigned int *directfb_micro_version;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
38 } SDL_DirectFB_Symbols;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
39 #undef DFB_SYM
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
40
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
41 #define DFB_SYM(ret, name, args, al, func) ret name args { func SDL_DirectFB_Symbols.name al ; }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
42 DFB_SYMS
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
43 #undef DFB_SYM
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
44 static void *handle = NULL;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
45
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
46 int
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
47 SDL_DirectFB_LoadLibrary(void)
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
48 {
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
49 int retval = 0;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
50
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
51 if (handle == NULL) {
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
52 handle = SDL_LoadObject(SDL_VIDEO_DRIVER_DIRECTFB_DYNAMIC);
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
53 if (handle != NULL) {
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
54 retval = 1;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
55 #define DFB_SYM(ret, name, args, al, func) if (!(SDL_DirectFB_Symbols.name = SDL_LoadFunction(handle, # name))) retval = 0;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
56 DFB_SYMS
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
57 #undef DFB_SYM
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
58 if (!
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
59 (SDL_DirectFB_Symbols.directfb_major_version =
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
60 SDL_LoadFunction(handle, "directfb_major_version")))
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
61 retval = 0;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
62 if (!
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
63 (SDL_DirectFB_Symbols.directfb_minor_version =
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
64 SDL_LoadFunction(handle, "directfb_minor_version")))
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
65 retval = 0;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
66 if (!
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
67 (SDL_DirectFB_Symbols.directfb_micro_version =
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
68 SDL_LoadFunction(handle, "directfb_micro_version")))
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
69 retval = 0;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
70 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
71 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
72 if (retval) {
3023
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 3000
diff changeset
73 const char *stemp = DirectFBCheckVersion(DIRECTFB_MAJOR_VERSION,
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 3000
diff changeset
74 DIRECTFB_MINOR_VERSION,
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 3000
diff changeset
75 DIRECTFB_MICRO_VERSION);
3000
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
76 /* Version Check */
3023
d72a0dd80e8b DirectFB cleanups & simple window manager
Couriersud <couriersud@arcor.de>
parents: 3000
diff changeset
77 if (stemp != NULL) {
3000
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
78 fprintf(stderr,
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
79 "DirectFB Lib: Version mismatch. Compiled: %d.%d.%d Library %d.%d.%d\n",
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
80 DIRECTFB_MAJOR_VERSION, DIRECTFB_MINOR_VERSION,
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
81 DIRECTFB_MICRO_VERSION,
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
82 *SDL_DirectFB_Symbols.directfb_major_version,
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
83 *SDL_DirectFB_Symbols.directfb_minor_version,
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
84 *SDL_DirectFB_Symbols.directfb_micro_version);
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
85 retval = 0;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
86 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
87 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
88 if (!retval)
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
89 SDL_DirectFB_UnLoadLibrary();
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
90 return retval;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
91 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
92
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
93 void
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
94 SDL_DirectFB_UnLoadLibrary(void)
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
95 {
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
96 if (handle != NULL) {
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
97 SDL_UnloadObject(handle);
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
98 handle = NULL;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
99 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
100 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
101
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
102 #else
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
103 int
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
104 SDL_DirectFB_LoadLibrary(void)
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
105 {
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
106 return 1;
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
107 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
108
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
109 void
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
110 SDL_DirectFB_UnLoadLibrary(void)
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
111 {
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
112 }
61081db2385a Whoops, missing files from Couriersud's update
Sam Lantinga <slouken@libsdl.org>
parents:
diff changeset
113 #endif