/* Various useful definitions.
 *
 * J.Cupitt, 8/4/93
 * 15/7/96 JC
 *	- C++ stuff added
 */

/*

	This file is part of VIPS.

	VIPS is free software; you can redistribute it and/or modify
	it under the terms of the GNU Lesser General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	This program 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 Lesser General Public License for more details.

	You should have received a copy of the GNU Lesser General Public License
	along with this program; if not, write to the Free Software
	Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
	02110-1301  USA

 */

/*

	These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk

 */

#ifndef VIPS_UTIL_H
#define VIPS_UTIL_H

#ifdef __cplusplus
extern "C" {
#endif /*__cplusplus*/

#include <stdio.h>
#include <math.h>

/* Some platforms don't have M_PI :-(
 */
#define VIPS_PI (3.14159265358979323846)

/* Convert degrees->rads and vice-versa.
 */
#define VIPS_RAD(R) (((R) / 360.0) * 2.0 * VIPS_PI)
#define VIPS_DEG(A) (((A) / (2.0 * VIPS_PI)) * 360.0)

#define VIPS_MAX(A, B) ((A) > (B) ? (A) : (B))
#define VIPS_MIN(A, B) ((A) < (B) ? (A) : (B))

#define VIPS_CLIP(A, V, B) VIPS_MAX((A), VIPS_MIN((B), (V)))
#define VIPS_FCLIP(A, V, B) VIPS_FMAX((A), VIPS_FMIN((B), (V)))

#define VIPS_NUMBER(R) ((int) (sizeof(R) / sizeof(R[0])))

#define VIPS_ABS(X) (((X) >= 0) ? (X) : -(X))

// is something (eg. a pointer) N aligned
#define VIPS_ALIGNED(P, N) ((((guint64) (P)) & ((N) - 1)) == 0)

/* The built-in isnan and isinf functions provided by gcc 4+ and clang are
 * up to 7x faster than their libc equivalent included from <math.h>.
 */
#if defined(__clang__) || (__GNUC__ >= 4)
#define VIPS_ISNAN(V) __builtin_isnan(V)
#define VIPS_FLOOR(V) __builtin_floor(V)
#define VIPS_CEIL(V) __builtin_ceil(V)
#define VIPS_RINT(V) __builtin_rint(V)
#define VIPS_ROUND(V) __builtin_round(V)
#define VIPS_FABS(V) __builtin_fabs(V)
#define VIPS_FMAX(A, B) __builtin_fmax(A, B)
#define VIPS_FMIN(A, B) __builtin_fmin(A, B)
#else
#define VIPS_ISNAN(V) isnan(V)
#define VIPS_FLOOR(V) floor(V)
#define VIPS_CEIL(V) ceil(V)
#define VIPS_RINT(V) rint(V)
#define VIPS_ROUND(V) round(V)
#define VIPS_FABS(V) VIPS_ABS(V)
#define VIPS_FMAX(A, B) VIPS_MAX(A, B)
#define VIPS_FMIN(A, B) VIPS_MIN(A, B)
#endif

/* Testing status before the function call saves a lot of time.
 */
#define VIPS_ONCE(ONCE, FUNC, CLIENT) \
	G_STMT_START \
	{ \
		if (G_UNLIKELY((ONCE)->status != G_ONCE_STATUS_READY)) \
			(void) g_once(ONCE, FUNC, CLIENT); \
	} \
	G_STMT_END

/* VIPS_RINT() does "bankers rounding", it rounds to the nearest even integer.
 * For things like image geometry, we want strict nearest int.
 *
 * If you know it's unsigned, _UINT is a little faster.
 */
#define VIPS_ROUND_INT(R) ((int) ((R) > 0 ? ((R) + 0.5) : ((R) -0.5)))
#define VIPS_ROUND_UINT(R) ((int) ((R) + 0.5))

/* Round N down and up to the nearest multiple of P.
 */
#define VIPS_ROUND_DOWN(N, P) ((N) - ((N) % (P)))
#define VIPS_ROUND_UP(N, P) (VIPS_ROUND_DOWN((N) + (P) -1, (P)))

#define VIPS_SWAP(TYPE, A, B) \
	G_STMT_START \
	{ \
		TYPE t = (A); \
		(A) = (B); \
		(B) = t; \
	} \
	G_STMT_END

/* Duff's device. Do OPERation N times in a 16-way unrolled loop.
 */
#define VIPS_UNROLL(N, OPER) \
	G_STMT_START \
	{ \
		if ((N)) { \
			int duff_count = ((N) + 15) / 16; \
			\
			switch ((N) % 16) { \
			case 0: \
				do { \
					OPER; \
				case 15: \
					OPER; \
				case 14: \
					OPER; \
				case 13: \
					OPER; \
				case 12: \
					OPER; \
				case 11: \
					OPER; \
				case 10: \
					OPER; \
				case 9: \
					OPER; \
				case 8: \
					OPER; \
				case 7: \
					OPER; \
				case 6: \
					OPER; \
				case 5: \
					OPER; \
				case 4: \
					OPER; \
				case 3: \
					OPER; \
				case 2: \
					OPER; \
				case 1: \
					OPER; \
				} while (--duff_count > 0); \
			} \
		} \
	} \
	G_STMT_END

/* Various integer range clips. Record over/under flows.
 */
#define VIPS_CLIP_UCHAR(V, SEQ) \
	G_STMT_START \
	{ \
		if ((V) < 0) { \
			(SEQ)->underflow++; \
			(V) = 0; \
		} \
		else if ((V) > UCHAR_MAX) { \
			(SEQ)->overflow++; \
			(V) = UCHAR_MAX; \
		} \
	} \
	G_STMT_END

#define VIPS_CLIP_CHAR(V, SEQ) \
	G_STMT_START \
	{ \
		if ((V) < SCHAR_MIN) { \
			(SEQ)->underflow++; \
			(V) = SCHAR_MIN; \
		} \
		else if ((V) > SCHAR_MAX) { \
			(SEQ)->overflow++; \
			(V) = SCHAR_MAX; \
		} \
	} \
	G_STMT_END

#define VIPS_CLIP_USHORT(V, SEQ) \
	G_STMT_START \
	{ \
		if ((V) < 0) { \
			(SEQ)->underflow++; \
			(V) = 0; \
		} \
		else if ((V) > USHRT_MAX) { \
			(SEQ)->overflow++; \
			(V) = USHRT_MAX; \
		} \
	} \
	G_STMT_END

#define VIPS_CLIP_SHORT(V, SEQ) \
	G_STMT_START \
	{ \
		if ((V) < SHRT_MIN) { \
			(SEQ)->underflow++; \
			(V) = SHRT_MIN; \
		} \
		else if ((V) > SHRT_MAX) { \
			(SEQ)->overflow++; \
			(V) = SHRT_MAX; \
		} \
	} \
	G_STMT_END

#define VIPS_CLIP_UINT(V, SEQ) \
	G_STMT_START \
	{ \
		if ((V) < 0) { \
			(SEQ)->underflow++; \
			(V) = 0; \
		} \
	} \
	G_STMT_END

#define VIPS_CLIP_NONE(V, SEQ) \
	{ \
	}

/* Not all platforms have PATH_MAX (eg. Hurd) and we don't need a platform one
 * anyway, just a static buffer big enough for almost any path.
 */
#define VIPS_PATH_MAX (4096)

/* Create multiple copies of a function targeted at groups of SIMD intrinsics,
 * with the most suitable selected at runtime via dynamic dispatch.
 */
#ifdef HAVE_TARGET_CLONES
#define VIPS_TARGET_CLONES(TARGETS) \
	__attribute__((target_clones(TARGETS)))
#else
#define VIPS_TARGET_CLONES(TARGETS)
#endif

VIPS_API
const char *vips_enum_string(GType enm, int value);
VIPS_API
const char *vips_enum_nick(GType enm, int value);
VIPS_API
int vips_enum_from_nick(const char *domain, GType type, const char *str);
VIPS_API
int vips_flags_from_nick(const char *domain, GType type, const char *nick);

VIPS_API
gboolean vips_slist_equal(GSList *l1, GSList *l2);
VIPS_API
void *vips_slist_map2(GSList *list, VipsSListMap2Fn fn, void *a, void *b);
VIPS_API
void *vips_slist_map2_rev(GSList *list, VipsSListMap2Fn fn, void *a, void *b);
VIPS_API
void *vips_slist_map4(GSList *list,
	VipsSListMap4Fn fn, void *a, void *b, void *c, void *d);
VIPS_API
void *vips_slist_fold2(GSList *list, void *start,
	VipsSListFold2Fn fn, void *a, void *b);
VIPS_API
GSList *vips_slist_filter(GSList *list, VipsSListMap2Fn fn, void *a, void *b);
VIPS_API
void vips_slist_free_all(GSList *list);
VIPS_API
void *vips_map_equal(void *a, void *b);

VIPS_API
void *vips_hash_table_map(GHashTable *hash,
	VipsSListMap2Fn fn, void *a, void *b);

VIPS_API
gboolean vips_iscasepostfix(const char *a, const char *b);
VIPS_API
gboolean vips_isprefix(const char *a, const char *b);
VIPS_API
char *vips_break_token(char *str, const char *brk);

VIPS_API
int vips_filename_suffix_match(const char *path, const char *suffixes[]);

VIPS_API
gint64 vips_file_length(int fd);
/* TODO(kleisauke): VIPS_API is required by vipsedit.
 */
VIPS_API
int vips__write(int fd, const void *buf, size_t count);

/* TODO(kleisauke): VIPS_API is required by test_connections.
 */
VIPS_API
int vips__open(const char *filename, int flags, int mode);
int vips__open_read(const char *filename);
FILE *vips__fopen(const char *filename, const char *mode);

FILE *vips__file_open_read(const char *filename,
	const char *fallback_dir, gboolean text_mode);
FILE *vips__file_open_write(const char *filename,
	gboolean text_mode);
/* TODO(kleisauke): VIPS_API is required by vipsedit.
 */
VIPS_API
char *vips__file_read(FILE *fp, const char *name, size_t *length_out);
char *vips__file_read_name(const char *name, const char *fallback_dir,
	size_t *length_out);
int vips__file_write(void *data, size_t size, size_t nmemb, FILE *stream);
/* TODO(kleisauke): VIPS_API is required by the magick module.
 */
VIPS_API
gint64 vips__get_bytes(const char *filename, unsigned char buf[], gint64 len);
int vips__fgetc(FILE *fp);

GValue *vips__gvalue_ref_string_new(const char *text);
void vips__gslist_gvalue_free(GSList *list);
GSList *vips__gslist_gvalue_copy(const GSList *list);
GSList *vips__gslist_gvalue_merge(GSList *a, const GSList *b);
char *vips__gslist_gvalue_get(const GSList *list);

gint64 vips__seek_no_error(int fd, gint64 pos, int whence);
/* TODO(kleisauke): VIPS_API is required by vipsedit.
 */
VIPS_API
gint64 vips__seek(int fd, gint64 pos, int whence);
int vips__ftruncate(int fd, gint64 pos);
VIPS_API
int vips_existsf(const char *name, ...)
	G_GNUC_PRINTF(1, 2);
VIPS_API
int vips_isdirf(const char *name, ...)
	G_GNUC_PRINTF(1, 2);
VIPS_API
int vips_mkdirf(const char *name, ...)
	G_GNUC_PRINTF(1, 2);
VIPS_API
int vips_rmdirf(const char *name, ...)
	G_GNUC_PRINTF(1, 2);
VIPS_API
int vips_rename(const char *old_name, const char *new_name);

/**
 * VipsToken:
 * @VIPS_TOKEN_LEFT: left bracket
 * @VIPS_TOKEN_RIGHT: right bracket
 * @VIPS_TOKEN_STRING: string constant
 * @VIPS_TOKEN_EQUALS: equals sign
 * @VIPS_TOKEN_COMMA: comma
 *
 * Tokens returned by the vips lexical analyzer, see vips__token_get(). This
 * is used to parse option strings for arguments.
 *
 * Left and right brackets can be any of (, {, [, <.
 *
 * Strings may be in double quotes, and may contain escaped quote characters,
 * for example string, "string" and "str\"ing".
 *
 */
typedef enum {
	VIPS_TOKEN_LEFT = 1,
	VIPS_TOKEN_RIGHT,
	VIPS_TOKEN_STRING,
	VIPS_TOKEN_EQUALS,
	VIPS_TOKEN_COMMA
} VipsToken;

// we expose this one in the API for testing
VIPS_API
const char *vips__token_get(const char *buffer,
	VipsToken *token, char *string, int size);
const char *vips__token_must(const char *buffer, VipsToken *token,
	char *string, int size);
const char *vips__token_need(const char *buffer, VipsToken need_token,
	char *string, int size);
const char *vips__token_segment(const char *p, VipsToken *token,
	char *string, int size);
const char *vips__token_segment_need(const char *p, VipsToken need_token,
	char *string, int size);
const char *vips__find_rightmost_brackets(const char *p);
/* TODO(kleisauke): VIPS_API is required by libvips-cpp and vipsheader.
 */
VIPS_API
void vips__filename_split8(const char *name,
	char *filename, char *option_string);

VIPS_API
int vips_ispoweroftwo(int p);
VIPS_API
int vips_amiMSBfirst(void);

/* TODO(kleisauke): VIPS_API is required by jpegsave_file_fuzzer.
 */
VIPS_API
char *vips__temp_name(const char *format);

void vips__change_suffix(const char *name, char *out, int mx,
	const char *new_suff, const char **olds, int nolds);

VIPS_API
char *vips_realpath(const char *path);

guint32 vips__random(guint32 seed);
guint32 vips__random_add(guint32 seed, int value);

const char *vips__icc_dir(void);
const char *vips__windows_prefix(void);

char *vips__get_iso8601(void);

VIPS_API
int vips_strtod(const char *str, double *out);

#ifdef __cplusplus
}
#endif /*__cplusplus*/

#endif /*VIPS_UTIL_H*/
