add sv_numne() to the API

some refactoring next, since sv_numeq_flags and sv_numne_flags are
similar.

Used a separate test file since putting every sv_num*() variant in the
one file would be ugly

Addresses GH #23918 but isn't a direct fix

Author: tonycoz

MANIFEST

@@ -5192,6 +5192,7 @@ ext/XS-APItest/t/stuff_svcur_bug.t		test for a bug in lex_stuff_pvn
 ext/XS-APItest/t/subcall.t			Test XSUB calls
 ext/XS-APItest/t/subsignature.t			Test parse_subsignature()
 ext/XS-APItest/t/sv_numeq.t			Test sv_numeq
+ext/XS-APItest/t/sv_numne.t			Test sv_numne
 ext/XS-APItest/t/sv_streq.t			Test sv_streq
 ext/XS-APItest/t/svcat.t			Test sv_catpvn
 ext/XS-APItest/t/svcatpvf.t			Test sv_catpvf argument reordering

embed.fnc

@@ -3419,6 +3419,11 @@ Admp	|bool	|sv_numeq	|NULLOK SV *sv1 			\
 Adp	|bool	|sv_numeq_flags |NULLOK SV *sv1 			\
 				|NULLOK SV *sv2 			\
 				|const U32 flags
+Admp	|bool	|sv_numne	|NULLOK SV *sv1 			\
+				|NULLOK SV *sv2
+Adp	|bool	|sv_numne_flags |NULLOK SV *sv1 			\
+				|NULLOK SV *sv2 			\
+				|const U32 flags
 Adip	|NV	|SvNV		|NN SV *sv
 Adp	|NV	|sv_2nv_flags	|NN SV * const sv			\
 				|const I32 flags

embed.h

@@ -727,6 +727,7 @@
 # define sv_newref(a)                           Perl_sv_newref(aTHX_ a)
 # define sv_nosharing(a)                        Perl_sv_nosharing(aTHX_ a)
 # define sv_numeq_flags(a,b,c)                  Perl_sv_numeq_flags(aTHX_ a,b,c)
+# define sv_numne_flags(a,b,c)                  Perl_sv_numne_flags(aTHX_ a,b,c)
 # define sv_peek(a)                             Perl_sv_peek(aTHX_ a)
 # define sv_pos_b2u(a,b)                        Perl_sv_pos_b2u(aTHX_ a,b)
 # define sv_pos_b2u_flags(a,b,c)                Perl_sv_pos_b2u_flags(aTHX_ a,b,c)
@@ -2345,6 +2346,7 @@
 #   define Perl_sv_insert(mTHX,a,b,c,d,e)       sv_insert(a,b,c,d,e)
 #   define Perl_sv_mortalcopy(mTHX,a)           sv_mortalcopy(a)
 #   define Perl_sv_numeq(mTHX,a,b)              sv_numeq(a,b)
+#   define Perl_sv_numne(mTHX,a,b)              sv_numne(a,b)
 #   define Perl_sv_pv(mTHX,a)                   sv_pv(a)
 #   define Perl_sv_pvbyte(mTHX,a)               sv_pvbyte(a)
 #   define Perl_sv_pvn_force(mTHX,a,b)          sv_pvn_force(a,b)
@@ -2446,6 +2448,7 @@
 #   define Perl_sv_insert                       sv_insert
 #   define Perl_sv_mortalcopy                   sv_mortalcopy
 #   define Perl_sv_numeq                        sv_numeq
+#   define Perl_sv_numne                        sv_numne
 #   define Perl_sv_pv                           sv_pv
 #   define Perl_sv_pvbyte                       sv_pvbyte
 #   define Perl_sv_pvn_force                    sv_pvn_force

ext/XS-APItest/APItest.pm

@@ -4,7 +4,7 @@ use strict;
 use warnings;
 use Carp;
 
-our $VERSION = '1.47';
+our $VERSION = '1.48';
 
 require XSLoader;
 

ext/XS-APItest/APItest.xs

@@ -5020,6 +5020,12 @@ sv_numeq_flags(SV *sv1, SV *sv2, U32 flags)
     OUTPUT:
         RETVAL
 
+bool
+sv_numne(SV *sv1, SV *sv2)
+
+bool
+sv_numne_flags(SV *sv1, SV *sv2, U32 flags)
+
 bool
 sv_streq(SV *sv1, SV *sv2)
     CODE:

ext/XS-APItest/t/sv_numeq.t

@@ -1,6 +1,6 @@
 #!perl
 
-use Test::More tests => 9;
+use Test::More tests => 11;
 use XS::APItest;
 
 my $four = 4;
@@ -9,7 +9,7 @@ ok !sv_numeq($four, 5), '$four != 5';
 
 my $six_point_five = 6.5; # an exact float, so == is fine
 ok  sv_numeq($six_point_five, 6.5), '$six_point_five == 6.5';
-ok !sv_numeq($six_point_five, 6.6), '$six_point_five == 6.6';
+ok !sv_numeq($six_point_five, 6.6), '$six_point_five != 6.6';
 
 # GMAGIC
 "10" =~ m/(\d+)/;
@@ -27,6 +27,10 @@ ok  sv_numeq_flags($1, 10, SV_GMAGIC), 'sv_numeq_flags with SV_GMAGIC does';
 
     ok  sv_numeq($obj, 10), 'AlwaysTen is 10';
     ok !sv_numeq($obj, 11), 'AlwaysTen is not 11';
+    ok  sv_numeq(10, $obj), 'AlwaysTen is 10 on the right';
+    ok !sv_numeq(11, $obj), 'AlwaysTen is not 11 on the right';
 
     ok !sv_numeq_flags($obj, 10, SV_SKIP_OVERLOAD), 'AlwaysTen is not 10 with SV_SKIP_OVERLOAD'
 }
+
+

ext/XS-APItest/t/sv_numne.t

@@ -0,0 +1,35 @@
+#!perl
+
+use Test::More tests => 11;
+use XS::APItest;
+
+my $four = 4;
+ok !sv_numne($four, 4), '$four != 4';
+ok  sv_numne($four, 5), '$four == 5';
+
+my $six_point_five = 6.5; # an exact float, so == is fine
+ok !sv_numne($six_point_five, 6.5), '$six_point_five == 6.5';
+ok  sv_numne($six_point_five, 6.6), '$six_point_five != 6.6';
+
+# GMAGIC
+"11" =~ m/(\d+)/;
+ok  sv_numne_flags($1, 11, 0), 'sv_numne_flags with no flags does not GETMAGIC';
+ok !sv_numne_flags($1, 11, SV_GMAGIC), 'sv_numne_flags with SV_GMAGIC does';
+
+{
+    package AlwaysTwelve {
+        use overload
+            '!=' => sub { return $_[1] != 12 },
+            '0+' => sub { 11 };
+    }
+    my $obj = bless([], "AlwaysTwelve");
+
+    ok !sv_numne($obj, 12), 'AlwaysTwelve is 12';
+    ok  sv_numne($obj, 11), 'AlwaysTwelve is not 11';
+    ok !sv_numne(12, $obj), 'AlwaysTwelve is 12 on right';
+    ok  sv_numne(11, $obj), 'AlwayeTwelve is not 11 on the right';
+
+    ok !sv_numne_flags($obj, 11, SV_SKIP_OVERLOAD), 'AlwaysTwelve is 12 with SV_SKIP_OVERLOAD'
+}
+
+done_testing();

proto.h

@@ -8759,6 +8759,60 @@ Perl_sv_numeq_flags(pTHX_ SV *sv1, SV *sv2, const U32 flags)
     return do_ncmp(sv1, sv2) == 0;
 }
 
+/*
+
+=for apidoc      sv_numne
+=for apidoc_item sv_numne_flags
+
+These each return a boolean indicating if the numbers in the two SV arguments
+are different, coercing them to numbers if necessary, basically behaving like
+the Perl code S<C<$sv1 != $sv2>>.
+
+A NULL SV is treated as C<undef>.
+
+C<sv_numne> always performs 'get' magic.  C<sv_numne_flags> performs 'get'
+magic only if C<flags> has the C<SV_GMAGIC> bit set.
+
+C<sv_numne> always checks for, and if present, handles C<!=> overloading.  If
+not present, regular numerical comparison will be used instead.
+C<sv_numne_flags> normally does the same, but setting the C<SV_SKIP_OVERLOAD>
+bit set in C<flags> causes it to use regular numerical comparison.
+
+Otherwise, the functions behave identically.
+
+=for apidoc Amnh||SV_SKIP_OVERLOAD
+
+=cut
+*/
+
+bool
+Perl_sv_numne_flags(pTHX_ SV *sv1, SV *sv2, const U32 flags)
+{
+    PERL_ARGS_ASSERT_SV_NUMNE_FLAGS;
+
+    if(flags & SV_GMAGIC) {
+        if(sv1)
+            SvGETMAGIC(sv1);
+        if(sv2)
+            SvGETMAGIC(sv2);
+    }
+
+    /* Treat NULL as undef */
+    if(!sv1)
+        sv1 = &PL_sv_undef;
+    if(!sv2)
+        sv2 = &PL_sv_undef;
+
+    if(!(flags & SV_SKIP_OVERLOAD) &&
+            (SvAMAGIC(sv1) || SvAMAGIC(sv2))) {
+        SV *ret = amagic_call(sv1, sv2, ne_amg, 0);
+        if(ret)
+            return SvTRUE(ret);
+    }
+
+    return do_ncmp(sv1, sv2) != 0;
+}
+
 /*
 =for apidoc      sv_cmp
 =for apidoc_item sv_cmp_flags

sv.c

@@ -2322,6 +2322,7 @@ Usually accessed via the C<SvPVutf8_nolen> macro.
 #define sv_cmp(sv1, sv2) sv_cmp_flags(sv1, sv2, SV_GMAGIC)
 #define sv_cmp_locale(sv1, sv2) sv_cmp_locale_flags(sv1, sv2, SV_GMAGIC)
 #define sv_numeq(sv1, sv2) sv_numeq_flags(sv1, sv2, SV_GMAGIC)
+#define sv_numne(sv1, sv2) sv_numne_flags(sv1, sv2, SV_GMAGIC)
 #define sv_streq(sv1, sv2) sv_streq_flags(sv1, sv2, SV_GMAGIC)
 #define sv_collxfrm(sv, nxp) sv_collxfrm_flags(sv, nxp, SV_GMAGIC)
 #define sv_2bool(sv) sv_2bool_flags(sv, SV_GMAGIC)