dns_erlang

-module(dns_names).
-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.
?MODULEDOC("""
Helpers to convert between DNS codes and their names.
""").

-include_lib("dns_erlang/include/dns.hrl").

-export([
    class_name/1,
    type_name/1,
    rcode_name/1,
    opcode_name/1,
    tsigerr_name/1,
    ercode_name/1,
    eoptcode_name/1,
    llqopcode_name/1,
    llqerrcode_name/1,
    alg_name/1
]).

%%%===================================================================
%%% DNS terms
%%%===================================================================

?DOC("Returns the name of the class as a binary string.").
-spec class_name(dns:class()) -> binary() | undefined.
class_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_CLASS_IN_NUMBER -> ?DNS_CLASS_IN_BSTR;
        ?DNS_CLASS_CS_NUMBER -> ?DNS_CLASS_CS_BSTR;
        ?DNS_CLASS_CH_NUMBER -> ?DNS_CLASS_CH_BSTR;
        ?DNS_CLASS_HS_NUMBER -> ?DNS_CLASS_HS_BSTR;
        ?DNS_CLASS_NONE_NUMBER -> ?DNS_CLASS_NONE_BSTR;
        ?DNS_CLASS_ANY_NUMBER -> ?DNS_CLASS_ANY_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of the type as a binary string.").
-spec type_name(dns:type()) -> binary() | undefined.
type_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_TYPE_A_NUMBER -> ?DNS_TYPE_A_BSTR;
        ?DNS_TYPE_NS_NUMBER -> ?DNS_TYPE_NS_BSTR;
        ?DNS_TYPE_MD_NUMBER -> ?DNS_TYPE_MD_BSTR;
        ?DNS_TYPE_MF_NUMBER -> ?DNS_TYPE_MF_BSTR;
        ?DNS_TYPE_CNAME_NUMBER -> ?DNS_TYPE_CNAME_BSTR;
        ?DNS_TYPE_SOA_NUMBER -> ?DNS_TYPE_SOA_BSTR;
        ?DNS_TYPE_MB_NUMBER -> ?DNS_TYPE_MB_BSTR;
        ?DNS_TYPE_MG_NUMBER -> ?DNS_TYPE_MG_BSTR;
        ?DNS_TYPE_MR_NUMBER -> ?DNS_TYPE_MR_BSTR;
        ?DNS_TYPE_NULL_NUMBER -> ?DNS_TYPE_NULL_BSTR;
        ?DNS_TYPE_WKS_NUMBER -> ?DNS_TYPE_WKS_BSTR;
        ?DNS_TYPE_PTR_NUMBER -> ?DNS_TYPE_PTR_BSTR;
        ?DNS_TYPE_HINFO_NUMBER -> ?DNS_TYPE_HINFO_BSTR;
        ?DNS_TYPE_MINFO_NUMBER -> ?DNS_TYPE_MINFO_BSTR;
        ?DNS_TYPE_MX_NUMBER -> ?DNS_TYPE_MX_BSTR;
        ?DNS_TYPE_TXT_NUMBER -> ?DNS_TYPE_TXT_BSTR;
        ?DNS_TYPE_RP_NUMBER -> ?DNS_TYPE_RP_BSTR;
        ?DNS_TYPE_AFSDB_NUMBER -> ?DNS_TYPE_AFSDB_BSTR;
        ?DNS_TYPE_X25_NUMBER -> ?DNS_TYPE_X25_BSTR;
        ?DNS_TYPE_ISDN_NUMBER -> ?DNS_TYPE_ISDN_BSTR;
        ?DNS_TYPE_RT_NUMBER -> ?DNS_TYPE_RT_BSTR;
        ?DNS_TYPE_NSAP_NUMBER -> ?DNS_TYPE_NSAP_BSTR;
        ?DNS_TYPE_SIG_NUMBER -> ?DNS_TYPE_SIG_BSTR;
        ?DNS_TYPE_KEY_NUMBER -> ?DNS_TYPE_KEY_BSTR;
        ?DNS_TYPE_PX_NUMBER -> ?DNS_TYPE_PX_BSTR;
        ?DNS_TYPE_GPOS_NUMBER -> ?DNS_TYPE_GPOS_BSTR;
        ?DNS_TYPE_AAAA_NUMBER -> ?DNS_TYPE_AAAA_BSTR;
        ?DNS_TYPE_LOC_NUMBER -> ?DNS_TYPE_LOC_BSTR;
        ?DNS_TYPE_NXT_NUMBER -> ?DNS_TYPE_NXT_BSTR;
        ?DNS_TYPE_EID_NUMBER -> ?DNS_TYPE_EID_BSTR;
        ?DNS_TYPE_NIMLOC_NUMBER -> ?DNS_TYPE_NIMLOC_BSTR;
        ?DNS_TYPE_SRV_NUMBER -> ?DNS_TYPE_SRV_BSTR;
        ?DNS_TYPE_ATMA_NUMBER -> ?DNS_TYPE_ATMA_BSTR;
        ?DNS_TYPE_NAPTR_NUMBER -> ?DNS_TYPE_NAPTR_BSTR;
        ?DNS_TYPE_KX_NUMBER -> ?DNS_TYPE_KX_BSTR;
        ?DNS_TYPE_CERT_NUMBER -> ?DNS_TYPE_CERT_BSTR;
        ?DNS_TYPE_DNAME_NUMBER -> ?DNS_TYPE_DNAME_BSTR;
        ?DNS_TYPE_SINK_NUMBER -> ?DNS_TYPE_SINK_BSTR;
        ?DNS_TYPE_OPT_NUMBER -> ?DNS_TYPE_OPT_BSTR;
        ?DNS_TYPE_APL_NUMBER -> ?DNS_TYPE_APL_BSTR;
        ?DNS_TYPE_DS_NUMBER -> ?DNS_TYPE_DS_BSTR;
        ?DNS_TYPE_CDS_NUMBER -> ?DNS_TYPE_CDS_BSTR;
        ?DNS_TYPE_SSHFP_NUMBER -> ?DNS_TYPE_SSHFP_BSTR;
        ?DNS_TYPE_CAA_NUMBER -> ?DNS_TYPE_CAA_BSTR;
        ?DNS_TYPE_IPSECKEY_NUMBER -> ?DNS_TYPE_IPSECKEY_BSTR;
        ?DNS_TYPE_RRSIG_NUMBER -> ?DNS_TYPE_RRSIG_BSTR;
        ?DNS_TYPE_NSEC_NUMBER -> ?DNS_TYPE_NSEC_BSTR;
        ?DNS_TYPE_DNSKEY_NUMBER -> ?DNS_TYPE_DNSKEY_BSTR;
        ?DNS_TYPE_CDNSKEY_NUMBER -> ?DNS_TYPE_CDNSKEY_BSTR;
        ?DNS_TYPE_NSEC3_NUMBER -> ?DNS_TYPE_NSEC3_BSTR;
        ?DNS_TYPE_NSEC3PARAM_NUMBER -> ?DNS_TYPE_NSEC3PARAM_BSTR;
        ?DNS_TYPE_DHCID_NUMBER -> ?DNS_TYPE_DHCID_BSTR;
        ?DNS_TYPE_HIP_NUMBER -> ?DNS_TYPE_HIP_BSTR;
        ?DNS_TYPE_NINFO_NUMBER -> ?DNS_TYPE_NINFO_BSTR;
        ?DNS_TYPE_RKEY_NUMBER -> ?DNS_TYPE_RKEY_BSTR;
        ?DNS_TYPE_TALINK_NUMBER -> ?DNS_TYPE_TALINK_BSTR;
        ?DNS_TYPE_SPF_NUMBER -> ?DNS_TYPE_SPF_BSTR;
        ?DNS_TYPE_UINFO_NUMBER -> ?DNS_TYPE_UINFO_BSTR;
        ?DNS_TYPE_UID_NUMBER -> ?DNS_TYPE_UID_BSTR;
        ?DNS_TYPE_GID_NUMBER -> ?DNS_TYPE_GID_BSTR;
        ?DNS_TYPE_UNSPEC_NUMBER -> ?DNS_TYPE_UNSPEC_BSTR;
        ?DNS_TYPE_NXNAME_NUMBER -> ?DNS_TYPE_NXNAME_BSTR;
        ?DNS_TYPE_TKEY_NUMBER -> ?DNS_TYPE_TKEY_BSTR;
        ?DNS_TYPE_TSIG_NUMBER -> ?DNS_TYPE_TSIG_BSTR;
        ?DNS_TYPE_IXFR_NUMBER -> ?DNS_TYPE_IXFR_BSTR;
        ?DNS_TYPE_AXFR_NUMBER -> ?DNS_TYPE_AXFR_BSTR;
        ?DNS_TYPE_MAILB_NUMBER -> ?DNS_TYPE_MAILB_BSTR;
        ?DNS_TYPE_MAILA_NUMBER -> ?DNS_TYPE_MAILA_BSTR;
        ?DNS_TYPE_ANY_NUMBER -> ?DNS_TYPE_ANY_BSTR;
        ?DNS_TYPE_DLV_NUMBER -> ?DNS_TYPE_DLV_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of an rcode as a binary string.").
-spec rcode_name(dns:rcode()) -> binary() | undefined.
rcode_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_RCODE_NOERROR_NUMBER -> ?DNS_RCODE_NOERROR_BSTR;
        ?DNS_RCODE_FORMERR_NUMBER -> ?DNS_RCODE_FORMERR_BSTR;
        ?DNS_RCODE_SERVFAIL_NUMBER -> ?DNS_RCODE_SERVFAIL_BSTR;
        ?DNS_RCODE_NXDOMAIN_NUMBER -> ?DNS_RCODE_NXDOMAIN_BSTR;
        ?DNS_RCODE_NOTIMP_NUMBER -> ?DNS_RCODE_NOTIMP_BSTR;
        ?DNS_RCODE_REFUSED_NUMBER -> ?DNS_RCODE_REFUSED_BSTR;
        ?DNS_RCODE_YXDOMAIN_NUMBER -> ?DNS_RCODE_YXDOMAIN_BSTR;
        ?DNS_RCODE_YXRRSET_NUMBER -> ?DNS_RCODE_YXRRSET_BSTR;
        ?DNS_RCODE_NXRRSET_NUMBER -> ?DNS_RCODE_NXRRSET_BSTR;
        ?DNS_RCODE_NOTAUTH_NUMBER -> ?DNS_RCODE_NOTAUTH_BSTR;
        ?DNS_RCODE_NOTZONE_NUMBER -> ?DNS_RCODE_NOTZONE_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of an opcode as a binary string.").
-spec opcode_name(dns:opcode()) -> binary() | undefined.
opcode_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_OPCODE_QUERY_NUMBER -> ?DNS_OPCODE_QUERY_BSTR;
        ?DNS_OPCODE_IQUERY_NUMBER -> ?DNS_OPCODE_IQUERY_BSTR;
        ?DNS_OPCODE_STATUS_NUMBER -> ?DNS_OPCODE_STATUS_BSTR;
        ?DNS_OPCODE_UPDATE_NUMBER -> ?DNS_OPCODE_UPDATE_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of a DNS algorithm as a binary string.").
-spec alg_name(dns:alg()) -> binary() | undefined.
alg_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_ALG_DSA_NUMBER -> ?DNS_ALG_DSA_BSTR;
        ?DNS_ALG_NSEC3DSA_NUMBER -> ?DNS_ALG_NSEC3DSA_BSTR;
        ?DNS_ALG_RSASHA1_NUMBER -> ?DNS_ALG_RSASHA1_BSTR;
        ?DNS_ALG_NSEC3RSASHA1_NUMBER -> ?DNS_ALG_NSEC3RSASHA1_BSTR;
        ?DNS_ALG_RSASHA256_NUMBER -> ?DNS_ALG_RSASHA256_BSTR;
        ?DNS_ALG_RSASHA512_NUMBER -> ?DNS_ALG_RSASHA512_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of a TSIG error as a binary string.").
-spec tsigerr_name(dns:tsig_error()) -> binary() | undefined.
tsigerr_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_TSIGERR_NOERROR_NUMBER -> ?DNS_TSIGERR_NOERROR_BSTR;
        ?DNS_TSIGERR_BADSIG_NUMBER -> ?DNS_TSIGERR_BADSIG_BSTR;
        ?DNS_TSIGERR_BADKEY_NUMBER -> ?DNS_TSIGERR_BADKEY_BSTR;
        ?DNS_TSIGERR_BADTIME_NUMBER -> ?DNS_TSIGERR_BADTIME_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of an extended rcode as a binary string.").
-spec ercode_name(dns:ercode()) -> binary() | undefined.
ercode_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_ERCODE_NOERROR_NUMBER -> ?DNS_ERCODE_NOERROR_BSTR;
        ?DNS_ERCODE_BADVERS_NUMBER -> ?DNS_ERCODE_BADVERS_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of an extended option as a binary string.").
-spec eoptcode_name(dns:eoptcode()) -> binary() | undefined.
eoptcode_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_EOPTCODE_LLQ_NUMBER -> ?DNS_EOPTCODE_LLQ_BSTR;
        ?DNS_EOPTCODE_UL_NUMBER -> ?DNS_EOPTCODE_UL_BSTR;
        ?DNS_EOPTCODE_NSID_NUMBER -> ?DNS_EOPTCODE_NSID_BSTR;
        ?DNS_EOPTCODE_OWNER_NUMBER -> ?DNS_EOPTCODE_OWNER_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of an LLQ opcode as a binary string.").
-spec llqopcode_name(dns:llqopcode()) -> binary() | undefined.
llqopcode_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_LLQOPCODE_SETUP_NUMBER -> ?DNS_LLQOPCODE_SETUP_BSTR;
        ?DNS_LLQOPCODE_REFRESH_NUMBER -> ?DNS_LLQOPCODE_REFRESH_BSTR;
        ?DNS_LLQOPCODE_EVENT_NUMBER -> ?DNS_LLQOPCODE_EVENT_BSTR;
        _ -> undefined
    end.

?DOC("Returns the name of an LLQ error code as a binary string.").
-spec llqerrcode_name(dns:llqerrcode()) -> binary() | undefined.
llqerrcode_name(Int) when is_integer(Int) ->
    case Int of
        ?DNS_LLQERRCODE_NOERROR_NUMBER -> ?DNS_LLQERRCODE_NOERROR_BSTR;
        ?DNS_LLQERRCODE_SERVFULL_NUMBER -> ?DNS_LLQERRCODE_SERVFULL_BSTR;
        ?DNS_LLQERRCODE_STATIC_NUMBER -> ?DNS_LLQERRCODE_STATIC_BSTR;
        ?DNS_LLQERRCODE_FORMATERR_NUMBER -> ?DNS_LLQERRCODE_FORMATERR_BSTR;
        ?DNS_LLQERRCODE_NOSUCHLLQ_NUMBER -> ?DNS_LLQERRCODE_NOSUCHLLQ_BSTR;
        ?DNS_LLQERRCODE_BADVERS_NUMBER -> ?DNS_LLQERRCODE_BADVERS_BSTR;
        ?DNS_LLQERRCODE_UNKNOWNERR_NUMBER -> ?DNS_LLQERRCODE_UNKNOWNERR_BSTR;
        _ -> undefined
    end.