HaxeFoundation.haxe/std/lua/Ffi.hx

/*
 * Copyright (C)2005-2019 Haxe Foundation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */

package lua;

import haxe.Constraints.Function;
import lua.Table;

#if lua_jit
@:luaRequire("ffi")
extern class Ffi {
	function new(type:String, arg:Dynamic);

	// Declaring and accessing external symbols
	static function cdef(def:String):Void;
	static var C:Dynamic;
	static function gc(cdata:Dynamic, finalizer:Function):Void;
	static function load(name:String, ?global:Bool):Dynamic;
	static function metatype<T>(ct:Ctype<T>, metatable:Table<Dynamic, Dynamic>):Ctype<T>;
	static function typeof(str:String):Ctype<Dynamic>;

	// C Type functionality
	static function alignof<T>(ct:Ctype<T>):Int;
	static function istype<T>(ct:Ctype<T>, obj:Dynamic):Bool;
	static function offsetof<T>(ct:Ctype<T>, field:String):Int;
	static function sizeof<T>(ct:Ctype<T>, ?nelem:Int):Int;

	// Utility functionality
	static function errno(?newerr:Int):Int;
	static function fill(dst:Dynamic, len:Int, c:Int):Void;
	static function string(ptr:Dynamic, ?len:Int):String;

	@:overload(function(dst:Dynamic, str:String):Dynamic {})
	static function copy(dst:Dynamic, src:Dynamic, len:Int):String;

	// Target specific functionality
	static var os:String;
	static var arch:String;
	static function abi(param:String):Bool;
}

extern class Ctype<T> {}

// TODO FFI callback type (gc methods)
#end