sdl-ios-xcode: include/SDL

annotate include/SDL_rwops.h @ 4170:092c0bc69155 SDL-1.2

Fixed bug #618 Description From Tim Angus 2008-08-30 12:23:56 (-) [reply] As we all know SDL 1.2 doesn't handle dead keys well since one key press potentially equals two (or more) characters. For example, on many layouts, keying <backquote>,<space> results in <no character>,<backquote><space>. Since the unicode member of the SDL_keysym struct only has room for one character, only one can be returned. On Linux, the first character is returned. On Windows however, unless the exact number of characters generated by the keypress is 1, nothing is returned. The following patch addresses this inconsistency. Updated patch which includes a further fix to the handling of the numpad when numlock is on. This further fix is courtesy Amanieu d'Antras.

author	Sam Lantinga <slouken@libsdl.org>
date	Mon, 13 Apr 2009 08:42:09 +0000
parents	bd91db0b0b5d
children	4c4113c2162c

rev	line source
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	1 /*
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	2 SDL - Simple DirectMedia Layer
4159 a1b03ba2fcd0 Updated copyright date Sam Lantinga <slouken@libsdl.org> parents: 4026 diff changeset	3 Copyright (C) 1997-2009 Sam Lantinga
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	4
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	5 This library is free software; you can redistribute it and/or
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 930 diff changeset	6 modify it under the terms of the GNU Lesser General Public
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	7 License as published by the Free Software Foundation; either
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 930 diff changeset	8 version 2.1 of the License, or (at your option) any later version.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	9
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	10 This library is distributed in the hope that it will be useful,
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	11 but WITHOUT ANY WARRANTY; without even the implied warranty of
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 930 diff changeset	13 Lesser General Public License for more details.
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	14
1312 c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 930 diff changeset	15 You should have received a copy of the GNU Lesser General Public
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 930 diff changeset	16 License along with this library; if not, write to the Free Software
c9b51268668f Updated copyright information and removed rcs id lines (problematic in branch merges) Sam Lantinga <slouken@libsdl.org> parents: 930 diff changeset	17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	18
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	19 Sam Lantinga
251 b8688cfdc232 Updated the headers with the correct e-mail address Sam Lantinga <slouken@libsdl.org> parents: 0 diff changeset	20 slouken@libsdl.org
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	21 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	22
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	23 /* This file provides a general interface for SDL to read and write
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	24 data sources. It can easily be extended to files, memory, etc.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	25 */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	26
1402 d910939febfa Use consistent identifiers for the various platforms we support. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	27 #ifndef _SDL_rwops_h
d910939febfa Use consistent identifiers for the various platforms we support. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	28 #define _SDL_rwops_h
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	29
1354 22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	30 #include "SDL_stdinc.h"
1358 c71e05b4dc2e More header massaging... works great on Windows. ;-) Sam Lantinga <slouken@libsdl.org> parents: 1356 diff changeset	31 #include "SDL_error.h"
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	32
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	33 #include "begin_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	34 /* Set up for C function definitions, even when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	35 #ifdef __cplusplus
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	36 extern "C" {
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	37 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	38
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	39 /* This is the read/write operation structure -- very basic */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	40
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	41 typedef struct SDL_RWops {
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	42 /* Seek to 'offset' relative to whence, one of stdio's whence values:
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	43 SEEK_SET, SEEK_CUR, SEEK_END
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	44 Returns the final offset in the data source.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	45 */
930 02759105b989 Date: Fri, 20 Aug 2004 08:31:20 +0200 Sam Lantinga <slouken@libsdl.org> parents: 769 diff changeset	46 int (SDLCALL seek)(struct SDL_RWops context, int offset, int whence);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	47
4161 bd91db0b0b5d Corrected documentation for SDL_rwops::read() Ryan C. Gordon <icculus@icculus.org> parents: 4159 diff changeset	48 /* Read up to 'maxnum' objects each of size 'size' from the data
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	49 source to the area pointed at by 'ptr'.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	50 Returns the number of objects read, or -1 if the read failed.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	51 */
930 02759105b989 Date: Fri, 20 Aug 2004 08:31:20 +0200 Sam Lantinga <slouken@libsdl.org> parents: 769 diff changeset	52 int (SDLCALL read)(struct SDL_RWops context, void *ptr, int size, int maxnum);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	53
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	54 /* Write exactly 'num' objects each of size 'objsize' from the area
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	55 pointed at by 'ptr' to data source.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	56 Returns 'num', or -1 if the write failed.
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	57 */
930 02759105b989 Date: Fri, 20 Aug 2004 08:31:20 +0200 Sam Lantinga <slouken@libsdl.org> parents: 769 diff changeset	58 int (SDLCALL write)(struct SDL_RWops context, const void *ptr, int size, int num);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	59
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	60 /* Close and free an allocated SDL_FSops structure */
930 02759105b989 Date: Fri, 20 Aug 2004 08:31:20 +0200 Sam Lantinga <slouken@libsdl.org> parents: 769 diff changeset	61 int (SDLCALL close)(struct SDL_RWops context);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	62
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	63 Uint32 type;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	64 union {
4026 255b0469ca83 Added read-ahead support for Win32 file IO Sam Lantinga <slouken@libsdl.org> parents: 1453 diff changeset	65 #if defined(__WIN32__) && !defined(__SYMBIAN32__)
1449 d7d96c87b6a6 Did I mention I'm anal? :) Fixed spacing in SDL_rwops.h Sam Lantinga <slouken@libsdl.org> parents: 1447 diff changeset	66 struct {
4026 255b0469ca83 Added read-ahead support for Win32 file IO Sam Lantinga <slouken@libsdl.org> parents: 1453 diff changeset	67 int append;
255b0469ca83 Added read-ahead support for Win32 file IO Sam Lantinga <slouken@libsdl.org> parents: 1453 diff changeset	68 void *h;
255b0469ca83 Added read-ahead support for Win32 file IO Sam Lantinga <slouken@libsdl.org> parents: 1453 diff changeset	69 struct {
255b0469ca83 Added read-ahead support for Win32 file IO Sam Lantinga <slouken@libsdl.org> parents: 1453 diff changeset	70 void *data;
255b0469ca83 Added read-ahead support for Win32 file IO Sam Lantinga <slouken@libsdl.org> parents: 1453 diff changeset	71 int size;
255b0469ca83 Added read-ahead support for Win32 file IO Sam Lantinga <slouken@libsdl.org> parents: 1453 diff changeset	72 int left;
255b0469ca83 Added read-ahead support for Win32 file IO Sam Lantinga <slouken@libsdl.org> parents: 1453 diff changeset	73 } buffer;
1449 d7d96c87b6a6 Did I mention I'm anal? :) Fixed spacing in SDL_rwops.h Sam Lantinga <slouken@libsdl.org> parents: 1447 diff changeset	74 } win32io;
1447 515df0086eb7 Prefer the raw Win32 API over stdio for file RWops Sam Lantinga <slouken@libsdl.org> parents: 1446 diff changeset	75 #endif
1446 47bf1767c4ca Date: Mon, 27 Feb 2006 02:17:29 +0100 Sam Lantinga <slouken@libsdl.org> parents: 1402 diff changeset	76 #ifdef HAVE_STDIO_H
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	77 struct {
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	78 int autoclose;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	79 FILE *fp;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	80 } stdio;
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	81 #endif
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	82 struct {
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	83 Uint8 *base;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	84 Uint8 *here;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	85 Uint8 *stop;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	86 } mem;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	87 struct {
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	88 void *data1;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	89 } unknown;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	90 } hidden;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	91
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	92 } SDL_RWops;
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	93
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	94
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	95 /* Functions to create SDL_RWops structures from various data sources */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	96
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	97 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFile(const char file, const char mode);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	98
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	99 #ifdef HAVE_STDIO_H
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	100 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFP(FILE *fp, int autoclose);
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	101 #endif
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	102
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	103 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromMem(void *mem, int size);
764 974c0fb74bf8 Added function to create RWops from const memory: SDL_RWFromConstMem() Sam Lantinga <slouken@libsdl.org> parents: 337 diff changeset	104 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromConstMem(const void *mem, int size);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	105
337 9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	106 extern DECLSPEC SDL_RWops * SDLCALL SDL_AllocRW(void);
9154ec9ca3d2 Explicitly specify the SDL API calling convention (C by default) Sam Lantinga <slouken@libsdl.org> parents: 297 diff changeset	107 extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops *area);
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	108
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	109 #define RW_SEEK_SET 0 /* Seek from the beginning of data */
450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	110 #define RW_SEEK_CUR 1 /* Seek relative to current read point */
450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	111 #define RW_SEEK_END 2 /* Seek relative to the end of data */
450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	112
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	113 /* Macros to easily read and write from an SDL_RWops structure */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	114 #define SDL_RWseek(ctx, offset, whence) (ctx)->seek(ctx, offset, whence)
1330 450721ad5436 It's now possible to build SDL without any C runtime at all on Windows, Sam Lantinga <slouken@libsdl.org> parents: 1312 diff changeset	115 #define SDL_RWtell(ctx) (ctx)->seek(ctx, 0, RW_SEEK_CUR)
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	116 #define SDL_RWread(ctx, ptr, size, n) (ctx)->read(ctx, ptr, size, n)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	117 #define SDL_RWwrite(ctx, ptr, size, n) (ctx)->write(ctx, ptr, size, n)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	118 #define SDL_RWclose(ctx) (ctx)->close(ctx)
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	119
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	120
1354 22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	121 /* Read an item of the specified endianness and return in native format */
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	122 extern DECLSPEC Uint16 SDLCALL SDL_ReadLE16(SDL_RWops *src);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	123 extern DECLSPEC Uint16 SDLCALL SDL_ReadBE16(SDL_RWops *src);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	124 extern DECLSPEC Uint32 SDLCALL SDL_ReadLE32(SDL_RWops *src);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	125 extern DECLSPEC Uint32 SDLCALL SDL_ReadBE32(SDL_RWops *src);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	126 extern DECLSPEC Uint64 SDLCALL SDL_ReadLE64(SDL_RWops *src);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	127 extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops *src);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	128
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	129 /* Write an item of native format to the specified endianness */
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	130 extern DECLSPEC int SDLCALL SDL_WriteLE16(SDL_RWops *dst, Uint16 value);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	131 extern DECLSPEC int SDLCALL SDL_WriteBE16(SDL_RWops *dst, Uint16 value);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	132 extern DECLSPEC int SDLCALL SDL_WriteLE32(SDL_RWops *dst, Uint32 value);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	133 extern DECLSPEC int SDLCALL SDL_WriteBE32(SDL_RWops *dst, Uint32 value);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	134 extern DECLSPEC int SDLCALL SDL_WriteLE64(SDL_RWops *dst, Uint64 value);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	135 extern DECLSPEC int SDLCALL SDL_WriteBE64(SDL_RWops *dst, Uint64 value);
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	136
22f39393668a Fixed build problem with SDL_string.c Sam Lantinga <slouken@libsdl.org> parents: 1330 diff changeset	137
0 74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	138 /* Ends C function definitions when using C++ */
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	139 #ifdef __cplusplus
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	140 }
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	141 #endif
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	142 #include "close_code.h"
74212992fb08 Initial revision Sam Lantinga <slouken@lokigames.com> parents: diff changeset	143
1402 d910939febfa Use consistent identifiers for the various platforms we support. Sam Lantinga <slouken@libsdl.org> parents: 1358 diff changeset	144 #endif /* _SDL_rwops_h */

Mercurial > sdl-ios-xcode

annotate include/SDL_rwops.h @ 4170:092c0bc69155 SDL-1.2