eden-emu/SDL
20
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

wikiheaders: Bind #defines below a function to it, like typedefs.

Browse source 
This effectively adds the property symbols for various functions to the
function's wiki page.
This commit is contained in:
Ryan C. Gordon 2024-05-02 12:49:30 -04:00
parent 0178b19489
commit 9f842e9b5a
No known key found for this signature in database
GPG key ID: FA148B892AB48044
4 changed files with 62 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

54
build-scripts/wikiheaders.pl
View file

@ -780,6 +780,53 @@ while (my $d = readdir(DH)) {
$decl .= "\n";
}
}
# !!! FIXME: code duplication with typedef processing, below.
# We assume any `#define`s directly after the function are related to it: probably bitflags for an integer typedef.
# We'll also allow some other basic preprocessor lines.
# Blank lines are allowed, anything else, even comments, are not.
my $blank_lines = 0;
my $lastpos = tell(FH);
my $lastlineno = $lineno;
my $additional_decl = '';
my $saw_define = 0;
while (<FH>) {
chomp;
$lineno++;
if (/\A\s*\Z/) {
$blank_lines++;
} elsif (/\A\s*\#\s*(define|if|else|elif|endif)(\s+|\Z)/) {
if (/\A\s*\#\s*define\s+([a-zA-Z0-9_]*)/) {
$referenceonly{$1} = $sym;
$saw_define = 1;
} elsif (!$saw_define) {
# if the first non-blank thing isn't a #define, assume we're done.
seek(FH, $lastpos, 0); # re-read eaten lines again next time.
$lineno = $lastlineno;
last;
}
# update strings now that we know everything pending is to be applied to this declaration. Add pending blank lines and the new text.
if ($blank_lines > 0) {
while ($blank_lines > 0) {
$additional_decl .= "\n";
push @decllines, '';
$blank_lines--;
}
}
$additional_decl .= "\n$_";
push @decllines, $_;
$lastpos = tell(FH);
} else {
seek(FH, $lastpos, 0); # re-read eaten lines again next time.
$lineno = $lastlineno;
last;
}
}
$decl .= $additional_decl;
} elsif ($symtype == 2) { # a macro
if ($decl =~ /\A\s*\#\s*define\s+(.*?)(\(.*?\)|)\s+/) {
$sym = $1;
@ -900,6 +947,7 @@ while (my $d = readdir(DH)) {
my $lastpos = tell(FH);
my $lastlineno = $lineno;
my $additional_decl = '';
my $saw_define = 0;
while (<FH>) {
chomp;
@ -910,6 +958,12 @@ while (my $d = readdir(DH)) {
} elsif (/\A\s*\#\s*(define|if|else|elif|endif)(\s+|\Z)/) {
if (/\A\s*\#\s*define\s+([a-zA-Z0-9_]*)/) {
$referenceonly{$1} = $sym;
$saw_define = 1;
} elsif (!$saw_define) {
# if the first non-blank thing isn't a #define, assume we're done.
seek(FH, $lastpos, 0); # re-read eaten lines again next time.
$lineno = $lastlineno;
last;
}
# update strings now that we know everything pending is to be applied to this declaration. Add pending blank lines and the new text.
if ($blank_lines > 0) {

7
include/SDL3/SDL_audio.h
View file

@ -1540,8 +1540,11 @@ extern DECLSPEC int SDLCALL SDL_LoadWAV_IO(SDL_IOStream * src, SDL_bool closeio,
extern DECLSPEC int SDLCALL SDL_LoadWAV(const char *path, SDL_AudioSpec * spec,
Uint8 ** audio_buf, Uint32 * audio_len);
/**
* Maximum volume allowed in calls to SDL_MixAudioFormat.
*
* \since This macro is available since SDL 3.0.0.
*/
#define SDL_MIX_MAXVOLUME 128
/**

1
include/SDL3/SDL_iostream.h
View file

@ -375,6 +375,7 @@ extern DECLSPEC int SDLCALL SDL_CloseIO(SDL_IOStream *context);
*/
extern DECLSPEC SDL_PropertiesID SDLCALL SDL_GetIOProperties(SDL_IOStream *context);
/* Possible `whence` values for SDL_IOStream seeking... */
#define SDL_IO_SEEK_SET 0 /**< Seek from the beginning of data */
#define SDL_IO_SEEK_CUR 1 /**< Seek relative to current read point */
#define SDL_IO_SEEK_END 2 /**< Seek relative to the end of data */

2
include/SDL3/SDL_stdinc.h
View file

@ -2389,6 +2389,8 @@ extern DECLSPEC char *SDLCALL SDL_iconv_string(const char *tocode,
const char *fromcode,
const char *inbuf,
size_t inbytesleft);
/* Some helper macros for common cases... */
#define SDL_iconv_utf8_locale(S) SDL_iconv_string("", "UTF-8", S, SDL_strlen(S)+1)
#define SDL_iconv_utf8_ucs2(S) (Uint16 *)SDL_iconv_string("UCS-2", "UTF-8", S, SDL_strlen(S)+1)
#define SDL_iconv_utf8_ucs4(S) (Uint32 *)SDL_iconv_string("UCS-4", "UTF-8", S, SDL_strlen(S)+1)