view erlang/erldc/src/dyncall.erl @ 37:8c8f848131c6

- version bump - better doc - made calling convention mode reset by default, as only way to specify convention used is via signature string
author Tassilo Philipp
date Mon, 13 Apr 2020 20:08:54 +0200
parents 0cfcc391201f
children
line wrap: on
line source

%%  Copyright (c) 2014 Erik Mackdanz <erikmack@gmail.com>

%%  Permission to use, copy, modify, and distribute this software for any
%%  purpose with or without fee is hereby granted, provided that the above
%%  copyright notice and this permission notice appear in all copies.

%%  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
%%  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
%%  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
%%  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
%%  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
%%  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
%%  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.          

-module(dyncall).

-export([ 
          mode/2,
          get_error/1,
          reset/1,
          load_library/1,
	  find_symbol/2,
	  new_call_vm/1,
	  arg_double/2,
	  call_double/2,
	  arg_float/2,
	  call_float/2,
	  arg_int/2,
	  call_int/2,
	  arg_char/2,
	  call_char/2,
	  arg_bool/2,
	  call_bool/2,
	  arg_short/2,
	  call_short/2,
	  arg_long/2,
	  call_long/2,
	  arg_longlong/2,
	  call_longlong/2,
	  arg_ptr/2,
	  call_ptr/2,
	  call_void/2,
	  arg_string/2,
	  call_string/2,
          argf/3,
          callf/4
	]).

-on_load(load_nif/0).

load_nif() ->
    Dir = case code:priv_dir(dyncall) of
	      {error, bad_name} ->
		  filename:dirname(code:which(?MODULE)) ++ "/../priv";
	              OtherDir -> OtherDir
    end,
    erlang:load_nif(Dir ++ "/erldc", 0).

-spec load_library(LibPath :: string()) -> {ok,Lib :: binary()} | {error,_Reason}.
load_library(_LibPath) ->
    {error,"NIF library not loaded"}.

-spec find_symbol(Lib :: binary(), SymName :: string()) -> {ok,Sym :: binary()} | {error,_Reason}.
find_symbol(_Lib, _SymName) ->
    {error,"NIF library not loaded"}.

-spec new_call_vm(Size :: pos_integer()) -> {ok,Vm :: binary()} | {error,_Reason}.
new_call_vm(_Size) ->
    {error,"NIF library not loaded"}.

-spec arg_double(Vm :: binary(), Double :: float()) -> ok | {error, _Reason}.
arg_double(_Vm, _Double) ->
    {error,"NIF library not loaded"}.

-spec call_double(Vm :: binary(), Sym :: binary()) -> {ok, Result :: float()} | {error, _Reason}.
call_double(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec arg_float(Vm :: binary(), Float :: float()) -> ok | {error, _Reason}.
arg_float(_Vm, _Float) ->
    {error,"NIF library not loaded"}.

-spec call_float(Vm :: binary(), Sym :: binary()) -> {ok, Result :: float()} | {error, _Reason}.
call_float(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec arg_int(Vm :: binary(), Int :: integer()) -> ok | {error, _Reason}.
arg_int(_Vm, _Int) ->
    {error,"NIF library not loaded"}.

-spec call_int(Vm :: binary(), Sym :: binary()) -> {ok, Result :: integer()} | {error, _Reason}.
call_int(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec arg_char(Vm :: binary(), Char :: char()) -> ok | {error, _Reason}.
arg_char(_Vm, _Char) ->
    {error,"NIF library not loaded"}.

-spec call_char(Vm :: binary(), Sym :: binary()) -> {ok, Result :: char()} | {error, _Reason}.
call_char(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec arg_bool(Vm :: binary(), Bool :: boolean()) -> ok | {error, _Reason}.
arg_bool(_Vm, _Bool) ->
    {error,"NIF library not loaded"}.

-spec call_bool(Vm :: binary(), Sym :: binary()) -> {ok, Result :: boolean()} | {error, _Reason}.
call_bool(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec arg_short(Vm :: binary(), Short :: integer()) -> ok | {error, _Reason}.
arg_short(_Vm, _Short) ->
    {error,"NIF library not loaded"}.

-spec call_short(Vm :: binary(), Sym :: binary()) -> {ok, Result :: integer()} | {error, _Reason}.
call_short(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec arg_long(Vm :: binary(), Long :: integer()) -> ok | {error, _Reason}.
arg_long(_Vm, _Long) ->
    {error,"NIF library not loaded"}.

-spec call_long(Vm :: binary(), Sym :: binary()) -> {ok, Result :: integer()} | {error, _Reason}.
call_long(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec arg_longlong(Vm :: binary(), Longlong :: integer()) -> ok | {error, _Reason}.
arg_longlong(_Vm, _Longlong) ->
    {error,"NIF library not loaded"}.

-spec call_longlong(Vm :: binary(), Sym :: binary()) -> {ok, Result :: integer()} | {error, _Reason}.
call_longlong(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.


-spec arg_ptr(Vm :: binary(), Ptr :: binary()) -> ok | {error, _Reason}.
arg_ptr(_Vm, _Ptr) ->
    {error,"NIF library not loaded"}.

-spec call_ptr(Vm :: binary(), Sym :: binary()) -> {ok, Result :: binary()} | {error, _Reason}.
call_ptr(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec call_void(Vm :: binary(), Sym :: binary()) -> ok | {error, _Reason}.
call_void(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec arg_string(Vm :: binary(), String :: string()) -> ok | {error, _Reason}.
arg_string(_Vm, _String) ->
    {error,"NIF library not loaded"}.

-spec call_string(Vm :: binary(), Sym :: binary()) -> {ok, Result :: string()} | {error, _Reason}.
call_string(_Vm, _Sym) ->
    {error,"NIF library not loaded"}.

-spec mode(Vm :: binary(), Mode :: pos_integer()) -> ok | {error, _Reason}.
mode(_Vm, _Mode) ->
    {error,"NIF library not loaded"}.

-spec get_error(Vm :: binary()) -> {ok, ErrorCode :: pos_integer()} | {error, _Reason}.
get_error(_Vm) ->
    {error,"NIF library not loaded"}.

-spec reset(Vm :: binary()) -> ok | {error, _Reason}.
reset(_Vm) ->
    {error,"NIF library not loaded"}.

-spec argf(Vm :: binary(), Format :: string(), Args :: [term()]) -> ok | {error, _Reason}.
argf(_Vm,_Format,_Args) ->
    {error,"NIF library not loaded"}.

-spec callf(Vm :: binary(), Sym :: binary(), Format :: string(), Args :: [term()]) -> ok | {error, _Reason}.
callf(_Vm,_Sym,_Format,_Args) ->
    {error,"NIF library not loaded"}.