mkxp-freebird/src/util.h
Jonas Kulla e858bbdcf5 Lift 'Disposable' concept from core into bindings
Instead of replicating the RGSS Disposable interface in C++
and merely binding it, redefine the 'disposed' state as the
entire core object being deleted (and the binding object's
private pointer being null).

This makes the behavior more accurate in regard to RMXP.
It is now for example possible to subclass disposable classes
and access their 'dispose'/'disposed?' methods without
initializing the base class first (because the internal pointer
is simply null before initialization). Accessing any other
base methods will still raise an exception.

There are some quirks and irregular behavior in RMXP; eg.
most nullable bitmap attributes of disposable classes
(Sprite, Plane etc.) can still be queried afterwards, but
some cannot (Tilemap#tileset), and disposing certain
attributes crashes RMXP entirely (Tilemap#autotiles[n]).
mkxp tries to behave as close possible, but will be more
lenient some circumstances.

To the core, disposed bitmap attributes will look
identically to null, which slightly diverges from RMXP
(where they're treated as still existing, but aren't drawn).
The Disposable interface has been retained containing a
single signal, for the binding to inform core when
objects are disposed (so active attributes can be set to null).
2014-08-09 21:21:38 +02:00

140 lines
3.4 KiB
C++

/*
** util.h
**
** This file is part of mkxp.
**
** Copyright (C) 2013 Jonas Kulla <Nyocurio@gmail.com>
**
** mkxp is free software: you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation, either version 2 of the License, or
** (at your option) any later version.
**
** mkxp 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 General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with mkxp. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef UTIL_H
#define UTIL_H
#include <stdio.h>
#include <string>
#include <algorithm>
static inline int
wrapRange(int value, int min, int max)
{
if (value >= min && value <= max)
return value;
while (value < min)
value += (max - min);
return value % (max - min);
}
template<typename T>
static inline T clamp(T value, T min, T max)
{
if (value < min)
return min;
if (value > max)
return max;
return value;
}
static inline int
findNextPow2(int start)
{
int i = 1;
while (i < start)
i <<= 1;
return i;
}
/* Reads the contents of the file at 'path' and
* appends them to 'out'. Returns false on failure */
inline bool readFile(const char *path,
std::string &out)
{
FILE *f = fopen(path, "r");
if (!f)
return false;
fseek(f, 0, SEEK_END);
long size = ftell(f);
fseek(f, 0, SEEK_SET);
size_t back = out.size();
out.resize(back+size);
size_t read = fread(&out[back], 1, size, f);
fclose(f);
if (read != (size_t) size)
out.resize(back+read);
return true;
}
inline void strReplace(std::string &str,
char before, char after)
{
for (size_t i = 0; i < str.size(); ++i)
if (str[i] == before)
str[i] = after;
}
/* Check if [C]ontainer contains [V]alue */
template<typename C, typename V>
inline bool contains(const C &c, const V &v)
{
return std::find(c.begin(), c.end(), v) != c.end();
}
#define ARRAY_SIZE(obj) (sizeof(obj) / sizeof((obj)[0]))
#define elementsN(obj) const size_t obj##N = ARRAY_SIZE(obj)
#define DECL_ATTR_DETAILED(name, type, keyword1, keyword2) \
keyword1 type get##name() keyword2; \
keyword1 void set##name(type value);
#define DECL_ATTR(name, type) DECL_ATTR_DETAILED(name, type, , const)
#define DECL_ATTR_VIRT(name, type) DECL_ATTR_DETAILED(name, type, virtual, const)
#define DECL_ATTR_STATIC(name, type) DECL_ATTR_DETAILED(name, type, static, )
#define DECL_ATTR_INLINE(name, type, loc) \
type get##name() const { return loc; } \
void set##name(type value) { loc = value; }
#define DEF_ATTR_RD_SIMPLE_DETAILED(klass, name, type, location, keyword1) \
type klass :: get##name() keyword1 \
{ \
return location; \
}
#define DEF_ATTR_SIMPLE_DETAILED(klass, name, type, location, keyword1) \
DEF_ATTR_RD_SIMPLE_DETAILED(klass, name, type, location, keyword1) \
void klass :: set##name(type value) \
{ \
location = value; \
}
#define DEF_ATTR_RD_SIMPLE(klass, name, type, location) \
DEF_ATTR_RD_SIMPLE_DETAILED(klass, name, type, location, const)
#define DEF_ATTR_SIMPLE(klass, name, type, location) \
DEF_ATTR_SIMPLE_DETAILED(klass, name, type, location, const)
#define DEF_ATTR_SIMPLE_STATIC(klass, name, type, location) \
DEF_ATTR_SIMPLE_DETAILED(klass, name, type, location, )
#endif // UTIL_H