/* DE1: $Id: m_misc.h 2885 2006-02-26 18:15:52Z danij $
 * Copyright (C) 2003, 2004 Jaakko Keränen <jaakko.keranen@iki.fi>
 *
 * This program 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.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not: http://www.opensource.org/
 */

/*
 * m_misc.h: Miscellanous Routines
 */

#ifndef __DOOMSDAY_MISCELLAN_H__
#define __DOOMSDAY_MISCELLAN_H__

#include "sys_file.h"

#define MAX_READ    8192
#define ISSPACE(c)  ((c) == 0 || (c) == ' ' || (c) == '\t' || (c) == '\n' ||\
                     (c) == '\r')

typedef struct trigger_s {
    timespan_t      duration;
    timespan_t      accum;
} trigger_t;

extern int      read_count;
extern int      rndindex;

// Memory.
void           *M_Malloc(size_t size);
void           *M_Calloc(size_t size);
void           *M_Realloc(void *ptr, size_t size);
void            M_Free(void *ptr);

// File system routines.
boolean         M_CheckFileID(const char *path);
int             M_ReadFile(char const *name, byte **buffer);
int             M_ReadFileCLib(char const *name, byte **buffer);
boolean         M_WriteFile(char const *name, void *source, int length);
void            M_ExtractFileBase(const char *path, char *dest);
void            M_ExtractFileBase2(const char *path, char *dest,
                                   int max, int ignore);
void            M_GetFileExt(const char *path, char *ext);
void            M_ReplaceFileExt(char *path, char *newext);
boolean         M_CheckPath(char *path);
int             M_FileExists(const char *file);
void            M_TranslatePath(const char *path, char *translated);
void            M_PrependBasePath(const char *path, char *newpath);
void            M_RemoveBasePath(const char *absPath, char *newPath);
const char     *M_Pretty(const char *path);
void            M_ReadLine(char *buffer, int len, DFILE * file);

// Bounding boxes.
void            M_ClearBox(fixed_t *box);
void            M_AddToBox(fixed_t *box, fixed_t x, fixed_t y);
float           M_BoundingBoxDiff(float in[4], float out[4]);
void            M_JoinBoxes(float box[4], const float other[4]);

// Text utilities.
char           *M_SkipWhite(char *str);
char           *M_FindWhite(char *str);
char           *M_SkipLine(char *str);
void            M_WriteCommented(FILE * file, const char *text);
void            M_WriteTextEsc(FILE * file, char *text);
boolean         M_IsComment(char *text);
char           *M_LimitedStrCat(const char *str, unsigned int maxWidth,
                                char separator, char *buf,
                                unsigned int bufLength);
char           *M_StrCatQuoted(char *dest, char *src);

// Random numbers.
byte            M_Random(void);
float           M_FRandom(void);
void            M_ClearRandom(void);

// Math routines.
float           M_ApproxDistancef(float dx, float dy);
float           M_ApproxDistance3(float delta[3]);
float           M_ApproxDistance3f(float dx, float dy, float dz);
float           M_PointLineDistance(float *a, float *b, float *c);
float           M_PointUnitLineDistance(float *a, float *b, float *c);
float           M_Normalize(float *a);
float           M_Distance(float *a, float *b);
void            M_Scale(float *dest, const float *a, float scale);
float           M_DotProduct(float *a, float *b);
void            M_CrossProduct(float *a, float *b, float *out);
void            M_PointCrossProduct(float *v1, float *v2, float *v3,
                                    float *out);
void            M_RotateVector(float vec[3], float degYaw, float degPitch);
void            M_ProjectPointOnLinef(fixed_t *point, fixed_t *linepoint,
                                      fixed_t *delta, float gap,
                                      float *result);
float           M_CycleIntoRange(float value, float length);
uint            M_CRC32(byte *data, uint length);

// Time utilities.
boolean         M_CheckTrigger(trigger_t * trigger, timespan_t advanceTime);

// Other utilities.
int             M_ScreenShot(char *filename, int bits);

#endif