%%%
%%% @doc Callback functions that need to be implemented
%%% for a language-specific behaviour
%%%
-module(xprof_core_language).

%% Function for start monitoring

%% Parse a query string that represents either an xprof-flavoured
%% match-spec fun or an extended xprof query.
-callback parse_query(Query :: string()) ->
    Result :: {ok, xprof_core:cmd(), [{mfa, string()} |
                                      {atom(), erl_parse:abstract_expr()}]}
            | {error, Reason :: any()}.

%% Parse a query string that represents an xprof-flavoured match-spec fun
-callback parse_match_spec(Query :: string()) ->
    Result :: {mfa, xprof_core:mfa_id()}
            | {clauses, module(), atom(), [erl_parse:abstract_clause()]}.

%% Functions for autocomplete

%% Return whether a function should be excluded from the autocomplete list
-callback hidden_function(Fun :: atom()) ->
    boolean().

%% Formatter functions according to the specific language

-callback fmt_mfa(Mod :: module(), Fun :: atom(), Arity :: integer()) ->
    Formatted :: binary().

-callback fmt_mod_and_delim(Mod :: module()) ->
    Formatted :: binary().

-callback fmt_mod(Mod :: module()) ->
    Formatted :: binary().

-callback fmt_fun_and_arity(Fun :: atom(), Arity :: integer()) ->
    Formatted :: binary().

-callback fmt_fun(Fun :: atom()) ->
    Formatted :: binary().

-callback fmt_cmd(xprof_core:cmd()) ->
    Formatted :: binary().

-callback fmt_param(xprof_core:param_name()) ->
    Formatted :: binary().

-callback fmt_param_and_delim(xprof_core:param()) ->
    Formatted :: binary().

-callback fmt_exception(Class :: throw | error | exit, Reason :: term()) ->
    Formatted :: binary().

-callback fmt_term(Term :: term()) ->
    Formatted :: binary().