text/plain
•
11.30 KB
•
387 lines
/*
| nujel.h
|
| This file contains the public interface to the Nujel runtime.
| While it is still not stable, it shouldn't change as often anymore.
*/
#ifndef NUJEL_LIB_NUJEL_PUBLIC
#define NUJEL_LIB_NUJEL_PUBLIC
#include <math.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#if defined(_MSC_VER)
#define likely(x) x
#define unlikely(x) x
#else
#define likely(x) __builtin_expect(!!(x), 1)
#define unlikely(x) __builtin_expect(!!(x), 0)
#endif
#define MAX(x, y) (((x) > (y)) ? (x) : (y))
#define MIN(x, y) (((x) < (y)) ? (x) : (y))
#define countof(x) (sizeof(x)/sizeof(*x))
/*
| Now for some type/struct definitions
*/
typedef unsigned int uint;
typedef uint64_t u64;
typedef uint32_t u32;
typedef uint16_t u16;
typedef uint8_t u8;
typedef int64_t i64;
typedef int32_t i32;
typedef int16_t i16;
typedef int8_t i8;
/*
| And some Windows workarounds
*/
#ifdef _MSC_VER
typedef int64_t ssize_t;
#endif
typedef enum {
ltNil = 0,
ltSymbol,
ltKeyword,
ltBool,
ltInt,
ltFloat,
ltPair,
ltArray,
ltTree,
ltMap,
ltLambda,
ltMacro,
ltNativeFunc,
ltEnvironment,
ltString,
ltBuffer,
ltBufferView,
ltBytecodeArr,
ltFileHandle,
ltType,
// These should never be visible from inside the Nujel VM
ltComment,
ltException,
ltAny
} lType;
typedef struct lBuffer lBuffer;
typedef struct lBufferView lBufferView;
typedef struct lArray lArray;
typedef struct lClosure lClosure;
typedef struct lThread lThread;
typedef struct lNFunc lNFunc;
typedef struct lSymbol lSymbol;
typedef struct lClass lClass;
typedef struct lTree lTree;
typedef struct lTreeRoot lTreeRoot;
typedef struct lMap lMap;
typedef struct lMapEntry lMapEntry;
typedef struct lVec lVec;
typedef struct lVal lVal;
typedef struct lPair lPair;
typedef struct lBytecodeArray lBytecodeArray;
typedef uint8_t lBytecodeOp;
typedef lBuffer lString;
struct lTreeRoot {
union {
lTree *root;
lTreeRoot *nextFree;
};
};
struct lVal {
u16 type;
union {
bool vBool;
i64 vInt;
double vFloat;
lPair* vList;
const lSymbol * vSymbol;
FILE * vFileHandle;
lBytecodeArray *vBytecodeArr;
lArray * vArray;
lTreeRoot * vTree;
lMap * vMap;
lString * vString;
lClosure * vClosure;
lNFunc * vNFunc;
void * vPointer;
lBuffer * vBuffer;
lBufferView * vBufferView;
lClass * vType;
};
};
extern lVal NIL;
static inline lVal lValAlloc(lType T, void *v){
return (lVal){T, .vPointer = v};
}
struct lPair {
lVal car;
union {
lPair *nextFree;
lVal cdr;
};
};
/*
| Some pretty core Nujel procedures
*/
void lInit ();
lClosure *lNewRoot ();
lClosure *lInitRootClosure();
lClosure *lRedefineNativeFuncs(lClosure *c);
lVal lApply (lVal fun, lVal args);
lVal readImage(const void *ptr, size_t imgSize, bool staticImage);
lClosure *findRoot (lVal v);
const void * lBufferData (lBuffer *v);
void * lBufferDataMutable (lBuffer *v);
size_t lBufferLength (const lBuffer *v);
const void * lBufferViewData (lBufferView *v);
void * lBufferViewDataMutable (lBufferView *v);
size_t lBufferViewLength (const lBufferView *v);
lPair *lPairAllocRaw();
lMap *lMapAllocRaw();
static inline lVal lCons(lVal car, lVal cdr){
lPair *cons = lPairAllocRaw();
cons->car = car;
cons->cdr = cdr;
return lValAlloc(ltPair, cons);
}
static inline lVal lCar(lVal v) {
return likely(v.type == ltPair) ? v.vList->car : NIL;
}
static inline lVal lCdr(lVal v) {
return likely(v.type == ltPair) ? v.vList->cdr : NIL;
}
static inline lVal lCaar (lVal v){return lCar(lCar(v));}
static inline lVal lCadr (lVal v){return lCar(lCdr(v));}
static inline lVal lCdar (lVal v){return lCdr(lCar(v));}
static inline lVal lCddr (lVal v){return lCdr(lCdr(v));}
static inline lVal lCaddr (lVal v){return lCar(lCdr(lCdr(v)));}
static inline lVal lCadddr(lVal v){return lCar(lCdr(lCdr(lCdr(v))));}
/*
| Type related procedores
*/
i64 castToInt (const lVal v, i64 fallback);
bool castToBool (const lVal v);
lVal lValException (const lSymbol *symbol, const char *error, lVal v);
lVal lValExceptionType (lVal v, lType T);
lVal lValExceptionArity (lVal v, int arity);
lVal lValExceptionNonNumeric (lVal v);
lVal requireFloat (lVal v);
lVal optionalSymbolic (lVal v, const lSymbol *fallback);
/* Type requirement macros - return exception if type check fails */
#define reqType(val, typeEnum, msg) do { \
if(unlikely((val).type != (typeEnum))){ \
return lValException(lSymTypeError, msg, (val)); \
} \
} while(0)
#define reqInt(v) reqType(v, ltInt, "Need an Int")
#define reqString(v) reqType(v, ltString, "Need a String")
#define reqBuffer(v) reqType(v, ltBuffer, "Need a Buffer")
#define reqArray(v) reqType(v, ltArray, "Need an Array")
#define reqSymbol(v) reqType(v, ltSymbol, "Need a Symbol")
#define reqFileHandle(v) reqType(v, ltFileHandle, "Need a FileHandle")
#define reqBytecodeArray(v) reqType(v, ltBytecodeArr, "Need a BytecodeArr")
#define reqNaturalInt(v) do { \
reqInt(v); \
if(unlikely((v).vInt < 0)){ \
return lValException(lSymTypeError, "Expected a Natural int", (v)); \
} \
} while(0)
#define reqClosure(v) do { \
if(unlikely(((v).type != ltLambda) && ((v).type != ltEnvironment) && ((v).type != ltMacro))){ \
return lValException(lSymTypeError, "Need a Closure", (v)); \
} \
} while(0)
#define reqSymbolic(v) do { \
if(unlikely(((v).type != ltSymbol) && ((v).type != ltKeyword))){ \
return lValException(lSymTypeError, "Need a Symbol or Keyword", (v)); \
} \
} while(0)
#define reqMutableBuffer(v) do { \
reqBuffer(v); \
if(unlikely((v).vBuffer->flags & BUFFER_IMMUTABLE)){ \
return lValException(lSymTypeError, "Buffer is immutable", (v)); \
} \
} while(0)
/*
| Closure related procedores
*/
lVal lDefineAliased (lClosure *c, lVal lNF, const char *sym);
lVal lGetClosureSym (lClosure *c, const lSymbol *s);
void lDefineClosureSym (lClosure *c, const lSymbol *s, lVal v);
bool lSetClosureSym (lClosure *c, const lSymbol *s, lVal v);
void lDefineVal (lClosure *c, const char *str, lVal v);
lVal lAddNativeFunc (const char *sym, const char *args, const char *doc, lVal (*func)(), uint flags);
lVal lAddNativeFuncC (const char *sym, const char *args, const char *doc, lVal (*func)(lClosure *), uint flags);
lVal lAddNativeFuncV (const char *sym, const char *args, const char *doc, lVal (*func)(lVal), uint flags);
lVal lAddNativeFuncCV (const char *sym, const char *args, const char *doc, lVal (*func)(lClosure *, lVal), uint flags);
lVal lAddNativeFuncVV (const char *sym, const char *args, const char *doc, lVal (*func)(lVal, lVal), uint flags);
lVal lAddNativeFuncCVV (const char *sym, const char *args, const char *doc, lVal (*func)(lClosure *, lVal, lVal), uint flags);
lVal lAddNativeFuncVVV (const char *sym, const char *args, const char *doc, lVal (*func)(lVal, lVal, lVal), uint flags);
lVal lAddNativeFuncCVVV (const char *sym, const char *args, const char *doc, lVal (*func)(lClosure *, lVal, lVal, lVal), uint flags);
lVal lAddNativeFuncVVVV (const char *sym, const char *args, const char *doc, lVal (*func)(lVal, lVal, lVal, lVal), uint flags);
lVal lAddNativeFuncCVVVV(const char *sym, const char *args, const char *doc, lVal (*func)(lClosure *, lVal, lVal, lVal, lVal), uint flags);
lVal lAddNativeFuncR (const char *sym, const char *args, const char *doc, lVal (*func)(lVal), uint flags);
lVal lAddNativeFuncCR (const char *sym, const char *args, const char *doc, lVal (*func)(lClosure *, lVal), uint flags);
lVal lAddNativeMethodV(lClass *T, const lSymbol *name, const char *args, lVal (*fun)(lVal), uint flags);
lVal lAddNativeMethodVV(lClass *T, const lSymbol *name, const char *args, lVal (*fun)(lVal, lVal), uint flags);
lVal lAddNativeMethodVVV(lClass *T, const lSymbol *name, const char *args, lVal (*fun)(lVal, lVal, lVal), uint flags);
lVal lAddNativeStaticMethodV(lClass *T, const lSymbol *name, const char *args, lVal (*fun)(lVal), uint flags);
lVal lAddNativeStaticMethodVV(lClass *T, const lSymbol *name, const char *args, lVal (*fun)(lVal, lVal), uint flags);
lVal lAddNativeStaticMethodVVV(lClass *T, const lSymbol *name, const char *args, lVal (*fun)(lVal, lVal, lVal), uint flags);
/*
| Map related procedures
*/
lVal lMapSet (lMap *map, lVal key, lVal val);
lVal lMapRef (lMap *map, lVal key);
lVal lMapRefString (lMap *map, const char *key);
/*
| Symbolic routines
*/
lSymbol *lSymS (const char *s);
lSymbol *lSymSM (const char *s);
lSymbol *lSymSL (const char *s, uint len);
extern lSymbol *lSymPrototype;
extern lSymbol *lSymFloatNaN;
extern lSymbol *lSymFloatInf;
extern lSymbol *lSymTypeError;
extern lSymbol *lSymOutOfBounds;
extern lSymbol *lSymIOError;
extern lSymbol *lSymArityError;
extern lSymbol *lSymDivisionByZero;
extern lSymbol *lSymReadError;
extern lSymbol *lSymOOM;
extern lSymbol *lSymUnmatchedOpeningBracket;
extern lSymbol *lSymUnboundVariable;
extern lSymbol *lSymNotSupportedOnPlatform;
/*
| lVal related procedures
*/
static inline lVal lValFloat(double v){
if(unlikely(isnan(v))){
return lValException(lSymFloatNaN,"NaN is disallowed in Nujel", NIL);
}
if(unlikely(isinf(v))){
return lValException(lSymFloatInf,"INF is disallowed in Nujel", NIL);
}
return (lVal){ltFloat, .vFloat = v};
}
static inline lVal lValExceptionSimple(){
return (lVal){ltException, .vList = NULL};
}
static inline lVal lValInt(i64 v){
return (lVal){ltInt, .vInt = v};
}
static inline lVal lValBool(bool v){
return (lVal){ltBool, .vBool = v};
}
static inline lVal lValType(lClass *T){
return (lVal){ltType, .vType = T};
}
lTreeRoot *lTreeRootAllocRaw();
static inline lVal lValTree(lTree *v){
lTreeRoot *root = lTreeRootAllocRaw();
root->root = v;
return (lVal){ltTree, .vTree = root};
}
static inline lVal lValMap(lMap *v){
return (lVal){ltMap, .vMap = v};
}
static inline lVal lValEnvironment(lClosure *v){
return (lVal){ltEnvironment, .vClosure = v};
}
static inline lVal lValLambda(lClosure *v){
return (lVal){ltLambda, .vClosure = v};
}
/* Return a newly allocated nujel symbol of value S */
static inline lVal lValSymS(const lSymbol *s){
if(unlikely(s == NULL)){return NIL;}
return (lVal){ltSymbol, .vSymbol = s};
}
/* Return a nujel value for the symbol within S */
static inline lVal lValSym(const char *s){
return lValSymS(lSymS(s));
}
/* Return a newly allocated nujel keyword of value S */
static inline lVal lValKeywordS(const lSymbol *s){
if(unlikely(s == NULL)){return NIL;}
return (lVal){ltKeyword, .vSymbol = s};
}
/* Return a nujel value for the keyword within S */
static inline lVal lValKeyword(const char *s){
return lValKeywordS(lSymS(s));
}
static inline lVal lValFileHandle(FILE *fh){
return (lVal){ltFileHandle, .vFileHandle = fh};
}
lVal lValString (const char *s);
lVal lValStringLen (const char *s, int len);
lVal lValStringNoCopy (const char *s, int len);
/*
| Allocator related procedures
*/
lArray *lArrayAlloc (size_t len);
lBuffer *lBufferAlloc (size_t length, bool immutable);
lString *lStringNew (const char *str, uint len);
#endif
