420 lines
14 KiB
C
420 lines
14 KiB
C
/**********************************************************************************************
|
|
*
|
|
* raylib.utils - Some common utility functions
|
|
*
|
|
* CONFIGURATION:
|
|
*
|
|
* #define SUPPORT_TRACELOG
|
|
* Show TraceLog() output messages
|
|
* NOTE: By default LOG_DEBUG traces not shown
|
|
*
|
|
*
|
|
* LICENSE: zlib/libpng
|
|
*
|
|
* Copyright (c) 2014-2020 Ramon Santamaria (@raysan5)
|
|
*
|
|
* This software is provided "as-is", without any express or implied warranty. In no event
|
|
* will the authors be held liable for any damages arising from the use of this software.
|
|
*
|
|
* Permission is granted to anyone to use this software for any purpose, including commercial
|
|
* applications, and to alter it and redistribute it freely, subject to the following restrictions:
|
|
*
|
|
* 1. The origin of this software must not be misrepresented; you must not claim that you
|
|
* wrote the original software. If you use this software in a product, an acknowledgment
|
|
* in the product documentation would be appreciated but is not required.
|
|
*
|
|
* 2. Altered source versions must be plainly marked as such, and must not be misrepresented
|
|
* as being the original software.
|
|
*
|
|
* 3. This notice may not be removed or altered from any source distribution.
|
|
*
|
|
**********************************************************************************************/
|
|
|
|
#include "raylib.h" // WARNING: Required for: LogType enum
|
|
|
|
// Check if config flags have been externally provided on compilation line
|
|
#if !defined(EXTERNAL_CONFIG_FLAGS)
|
|
#include "config.h" // Defines module configuration flags
|
|
#endif
|
|
|
|
#include "utils.h"
|
|
|
|
#if defined(PLATFORM_ANDROID)
|
|
#include <errno.h> // Required for: Android error types
|
|
#include <android/log.h> // Required for: Android log system: __android_log_vprint()
|
|
#include <android/asset_manager.h> // Required for: Android assets manager: AAsset, AAssetManager_open(), ...
|
|
#endif
|
|
|
|
#include <stdlib.h> // Required for: exit()
|
|
#include <stdio.h> // Required for: vprintf()
|
|
#include <stdarg.h> // Required for: va_list, va_start(), va_end()
|
|
#include <string.h> // Required for: strcpy(), strcat()
|
|
|
|
#define MAX_TRACELOG_BUFFER_SIZE 128 // Max length of one trace-log message
|
|
|
|
#define MAX_UWP_MESSAGES 512 // Max UWP messages to process
|
|
|
|
//----------------------------------------------------------------------------------
|
|
// Global Variables Definition
|
|
//----------------------------------------------------------------------------------
|
|
|
|
// Log types messages
|
|
static int logTypeLevel = LOG_INFO; // Minimum log type level
|
|
static int logTypeExit = LOG_ERROR; // Log type that exits
|
|
static TraceLogCallback logCallback = NULL; // Log callback function pointer
|
|
|
|
#if defined(PLATFORM_ANDROID)
|
|
static AAssetManager *assetManager = NULL; // Android assets manager pointer
|
|
static const char *internalDataPath = NULL; // Android internal data path
|
|
#endif
|
|
|
|
#if defined(PLATFORM_UWP)
|
|
static int UWPOutMessageId = -1; // Last index of output message
|
|
static UWPMessage *UWPOutMessages[MAX_UWP_MESSAGES]; // Messages out to UWP
|
|
static int UWPInMessageId = -1; // Last index of input message
|
|
static UWPMessage *UWPInMessages[MAX_UWP_MESSAGES]; // Messages in from UWP
|
|
#endif
|
|
|
|
//----------------------------------------------------------------------------------
|
|
// Module specific Functions Declaration
|
|
//----------------------------------------------------------------------------------
|
|
#if defined(PLATFORM_ANDROID)
|
|
FILE *funopen(const void *cookie, int (*readfn)(void *, char *, int), int (*writefn)(void *, const char *, int),
|
|
fpos_t (*seekfn)(void *, fpos_t, int), int (*closefn)(void *));
|
|
|
|
static int android_read(void *cookie, char *buf, int size);
|
|
static int android_write(void *cookie, const char *buf, int size);
|
|
static fpos_t android_seek(void *cookie, fpos_t offset, int whence);
|
|
static int android_close(void *cookie);
|
|
#endif
|
|
|
|
//----------------------------------------------------------------------------------
|
|
// Module Functions Definition - Utilities
|
|
//----------------------------------------------------------------------------------
|
|
|
|
// Set the current threshold (minimum) log level
|
|
void SetTraceLogLevel(int logType)
|
|
{
|
|
logTypeLevel = logType;
|
|
}
|
|
|
|
// Set the exit threshold (minimum) log level
|
|
void SetTraceLogExit(int logType)
|
|
{
|
|
logTypeExit = logType;
|
|
}
|
|
|
|
// Set a trace log callback to enable custom logging
|
|
void SetTraceLogCallback(TraceLogCallback callback)
|
|
{
|
|
logCallback = callback;
|
|
}
|
|
|
|
// Show trace log messages (LOG_INFO, LOG_WARNING, LOG_ERROR, LOG_DEBUG)
|
|
void TraceLog(int logType, const char *text, ...)
|
|
{
|
|
#if defined(SUPPORT_TRACELOG)
|
|
// Message has level below current threshold, don't emit
|
|
if (logType < logTypeLevel) return;
|
|
|
|
va_list args;
|
|
va_start(args, text);
|
|
|
|
if (logCallback)
|
|
{
|
|
logCallback(logType, text, args);
|
|
va_end(args);
|
|
return;
|
|
}
|
|
|
|
#if defined(PLATFORM_ANDROID)
|
|
switch(logType)
|
|
{
|
|
case LOG_TRACE: __android_log_vprint(ANDROID_LOG_VERBOSE, "raylib", text, args); break;
|
|
case LOG_DEBUG: __android_log_vprint(ANDROID_LOG_DEBUG, "raylib", text, args); break;
|
|
case LOG_INFO: __android_log_vprint(ANDROID_LOG_INFO, "raylib", text, args); break;
|
|
case LOG_WARNING: __android_log_vprint(ANDROID_LOG_WARN, "raylib", text, args); break;
|
|
case LOG_ERROR: __android_log_vprint(ANDROID_LOG_ERROR, "raylib", text, args); break;
|
|
case LOG_FATAL: __android_log_vprint(ANDROID_LOG_FATAL, "raylib", text, args); break;
|
|
default: break;
|
|
}
|
|
#else
|
|
char buffer[MAX_TRACELOG_BUFFER_SIZE] = { 0 };
|
|
|
|
switch (logType)
|
|
{
|
|
case LOG_TRACE: strcpy(buffer, "TRACE: "); break;
|
|
case LOG_DEBUG: strcpy(buffer, "DEBUG: "); break;
|
|
case LOG_INFO: strcpy(buffer, "INFO: "); break;
|
|
case LOG_WARNING: strcpy(buffer, "WARNING: "); break;
|
|
case LOG_ERROR: strcpy(buffer, "ERROR: "); break;
|
|
case LOG_FATAL: strcpy(buffer, "FATAL: "); break;
|
|
default: break;
|
|
}
|
|
|
|
strcat(buffer, text);
|
|
strcat(buffer, "\n");
|
|
vprintf(buffer, args);
|
|
#endif
|
|
|
|
va_end(args);
|
|
|
|
if (logType >= logTypeExit) exit(1); // If exit message, exit program
|
|
|
|
#endif // SUPPORT_TRACELOG
|
|
}
|
|
|
|
// Load data from file into a buffer
|
|
unsigned char *LoadFileData(const char *fileName, int *bytesRead)
|
|
{
|
|
unsigned char *data = NULL;
|
|
*bytesRead = 0;
|
|
|
|
if (fileName != NULL)
|
|
{
|
|
FILE *file = fopen(fileName, "rb");
|
|
|
|
if (file != NULL)
|
|
{
|
|
// WARNING: On binary streams SEEK_END could not be found,
|
|
// using fseek() and ftell() could not work in some (rare) cases
|
|
fseek(file, 0, SEEK_END);
|
|
int size = ftell(file);
|
|
fseek(file, 0, SEEK_SET);
|
|
|
|
if (size > 0)
|
|
{
|
|
data = (unsigned char *)RL_MALLOC(sizeof(unsigned char)*size);
|
|
|
|
// NOTE: fread() returns number of read elements instead of bytes, so we read [1 byte, size elements]
|
|
int count = fread(data, sizeof(unsigned char), size, file);
|
|
*bytesRead = count;
|
|
|
|
if (count != size) TRACELOG(LOG_WARNING, "[%s] File partially loaded", fileName);
|
|
else TRACELOG(LOG_INFO, "[%s] File loaded successfully", fileName);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "[%s] File could not be read", fileName);
|
|
|
|
fclose(file);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "[%s] File could not be opened", fileName);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "File name provided is not valid");
|
|
|
|
return data;
|
|
}
|
|
|
|
// Save data to file from buffer
|
|
void SaveFileData(const char *fileName, void *data, int bytesToWrite)
|
|
{
|
|
if (fileName != NULL)
|
|
{
|
|
FILE *file = fopen(fileName, "wb");
|
|
|
|
if (file != NULL)
|
|
{
|
|
int count = fwrite(data, sizeof(unsigned char), bytesToWrite, file);
|
|
|
|
if (count == 0) TRACELOG(LOG_WARNING, "[%s] File could not be written", fileName);
|
|
else if (count != bytesToWrite) TRACELOG(LOG_WARNING, "[%s] File partially written", fileName);
|
|
else TRACELOG(LOG_INFO, "[%s] File successfully saved", fileName);
|
|
|
|
fclose(file);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "[%s] File could not be opened", fileName);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "File name provided is not valid");
|
|
}
|
|
|
|
// Load text data from file, returns a '\0' terminated string
|
|
// NOTE: text chars array should be freed manually
|
|
char *LoadFileText(const char *fileName)
|
|
{
|
|
char *text = NULL;
|
|
|
|
if (fileName != NULL)
|
|
{
|
|
FILE *textFile = fopen(fileName, "rt");
|
|
|
|
if (textFile != NULL)
|
|
{
|
|
// WARNING: When reading a file as 'text' file,
|
|
// text mode causes carriage return-linefeed translation...
|
|
// ...but using fseek() should return correct byte-offset
|
|
fseek(textFile, 0, SEEK_END);
|
|
int size = ftell(textFile);
|
|
fseek(textFile, 0, SEEK_SET);
|
|
|
|
if (size > 0)
|
|
{
|
|
text = (char *)RL_MALLOC(sizeof(char)*(size + 1));
|
|
int count = fread(text, sizeof(char), size, textFile);
|
|
|
|
// WARNING: \r\n is converted to \n on reading, so,
|
|
// read bytes count gets reduced by the number of lines
|
|
if (count < size) text = RL_REALLOC(text, count + 1);
|
|
|
|
// Zero-terminate the string
|
|
text[count] = '\0';
|
|
|
|
TRACELOG(LOG_INFO, "[%s] Text file loaded successfully", fileName);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "[%s] Text file could not be read", fileName);
|
|
|
|
fclose(textFile);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "[%s] Text file could not be opened", fileName);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "File name provided is not valid");
|
|
|
|
return text;
|
|
}
|
|
|
|
// Save text data to file (write), string must be '\0' terminated
|
|
void SaveFileText(const char *fileName, char *text)
|
|
{
|
|
if (fileName != NULL)
|
|
{
|
|
FILE *file = fopen(fileName, "wt");
|
|
|
|
if (file != NULL)
|
|
{
|
|
int count = fprintf(file, "%s", text);
|
|
|
|
if (count == 0) TRACELOG(LOG_WARNING, "[%s] Text file could not be written", fileName);
|
|
else TRACELOG(LOG_INFO, "[%s] Text file successfully saved", fileName);
|
|
|
|
fclose(file);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "[%s] Text file could not be opened", fileName);
|
|
}
|
|
else TRACELOG(LOG_WARNING, "File name provided is not valid");
|
|
}
|
|
|
|
#if defined(PLATFORM_ANDROID)
|
|
// Initialize asset manager from android app
|
|
void InitAssetManager(AAssetManager *manager, const char *dataPath)
|
|
{
|
|
assetManager = manager;
|
|
internalDataPath = dataPath;
|
|
}
|
|
|
|
// Replacement for fopen
|
|
// Ref: https://developer.android.com/ndk/reference/group/asset
|
|
FILE *android_fopen(const char *fileName, const char *mode)
|
|
{
|
|
if (mode[0] == 'w') // TODO: Test!
|
|
{
|
|
// TODO: fopen() is mapped to android_fopen() that only grants read access
|
|
// to assets directory through AAssetManager but we want to also be able to
|
|
// write data when required using the standard stdio FILE access functions
|
|
// Ref: https://stackoverflow.com/questions/11294487/android-writing-saving-files-from-native-code-only
|
|
#undef fopen
|
|
return fopen(TextFormat("%s/%s", internalDataPath, fileName), mode);
|
|
#define fopen(name, mode) android_fopen(name, mode)
|
|
}
|
|
else
|
|
{
|
|
// NOTE: AAsset provides access to read-only asset
|
|
AAsset *asset = AAssetManager_open(assetManager, fileName, AASSET_MODE_UNKNOWN);
|
|
|
|
if (asset != NULL) return funopen(asset, android_read, android_write, android_seek, android_close);
|
|
else return NULL;
|
|
}
|
|
}
|
|
#endif // PLATFORM_ANDROID
|
|
|
|
//----------------------------------------------------------------------------------
|
|
// Module specific Functions Definition
|
|
//----------------------------------------------------------------------------------
|
|
#if defined(PLATFORM_ANDROID)
|
|
static int android_read(void *cookie, char *buf, int size)
|
|
{
|
|
return AAsset_read((AAsset *)cookie, buf, size);
|
|
}
|
|
|
|
static int android_write(void *cookie, const char *buf, int size)
|
|
{
|
|
TRACELOG(LOG_ERROR, "Can't provide write access to the APK");
|
|
|
|
return EACCES;
|
|
}
|
|
|
|
static fpos_t android_seek(void *cookie, fpos_t offset, int whence)
|
|
{
|
|
return AAsset_seek((AAsset *)cookie, offset, whence);
|
|
}
|
|
|
|
static int android_close(void *cookie)
|
|
{
|
|
AAsset_close((AAsset *)cookie);
|
|
return 0;
|
|
}
|
|
#endif // PLATFORM_ANDROID
|
|
|
|
#if defined(PLATFORM_UWP)
|
|
UWPMessage *CreateUWPMessage(void)
|
|
{
|
|
UWPMessage *msg = (UWPMessage *)RL_MALLOC(sizeof(UWPMessage));
|
|
msg->type = UWP_MSG_NONE;
|
|
Vector2 v0 = { 0, 0 };
|
|
msg->paramVector0 = v0;
|
|
msg->paramInt0 = 0;
|
|
msg->paramInt1 = 0;
|
|
msg->paramChar0 = 0;
|
|
msg->paramFloat0 = 0;
|
|
msg->paramDouble0 = 0;
|
|
msg->paramBool0 = false;
|
|
return msg;
|
|
}
|
|
|
|
void DeleteUWPMessage(UWPMessage *msg)
|
|
{
|
|
RL_FREE(msg);
|
|
}
|
|
|
|
bool UWPHasMessages(void)
|
|
{
|
|
return (UWPOutMessageId > -1);
|
|
}
|
|
|
|
UWPMessage *UWPGetMessage(void)
|
|
{
|
|
if (UWPHasMessages()) return UWPOutMessages[UWPOutMessageId--];
|
|
|
|
return NULL;
|
|
}
|
|
|
|
void UWPSendMessage(UWPMessage *msg)
|
|
{
|
|
if ((UWPInMessageId + 1) < MAX_UWP_MESSAGES)
|
|
{
|
|
UWPInMessageId++;
|
|
UWPInMessages[UWPInMessageId] = msg;
|
|
}
|
|
else TRACELOG(LOG_WARNING, "[UWP Messaging] Not enough array space to register new UWP inbound Message.");
|
|
}
|
|
|
|
void SendMessageToUWP(UWPMessage *msg)
|
|
{
|
|
if ((UWPOutMessageId + 1) < MAX_UWP_MESSAGES)
|
|
{
|
|
UWPOutMessageId++;
|
|
UWPOutMessages[UWPOutMessageId] = msg;
|
|
}
|
|
else TRACELOG(LOG_WARNING, "[UWP Messaging] Not enough array space to register new UWP outward Message.");
|
|
}
|
|
|
|
bool HasMessageFromUWP(void)
|
|
{
|
|
return UWPInMessageId > -1;
|
|
}
|
|
|
|
UWPMessage *GetMessageFromUWP(void)
|
|
{
|
|
if (HasMessageFromUWP()) return UWPInMessages[UWPInMessageId--];
|
|
|
|
return NULL;
|
|
}
|
|
#endif // PLATFORM_UWP
|