From 32cabecca93261edd11a9357254cfb0119598b91 Mon Sep 17 00:00:00 2001
From: orbitcowboy <orbitcowboy@web.de>
Date: Fri, 5 Jan 2024 23:34:08 +0100
Subject: [PATCH] Add support for InvalidFunctionArg lgamma() (#5845)

Reference: https://en.cppreference.com/w/cpp/numeric/math/lgamma
---
 cfg/std.cfg      |  9 +++++++++
 test/cfg/std.cpp | 24 ++++++++++++++++++++++++
 2 files changed, 33 insertions(+)

diff --git a/cfg/std.cfg b/cfg/std.cfg
index 490480a56..70c05e57b 100644
--- a/cfg/std.cfg
+++ b/cfg/std.cfg
@@ -3035,6 +3035,7 @@ The obsolete function 'gets' is called. With 'gets' you'll get a buffer overrun
       <not-uninit/>
     </arg>
   </function>
+  <!-- https://cplusplus.com/reference/cmath/lgamma/ -->
   <!-- double lgamma(double x); -->
   <function name="lgamma,std::lgamma">
     <use-retval/>
@@ -3044,8 +3045,11 @@ The obsolete function 'gets' is called. With 'gets' you'll get a buffer overrun
     <leak-ignore/>
     <arg nr="1" direction="in">
       <not-uninit/>
+      <!-- If x is zero or a negative integer for which the function is asymptotic, it may cause a pole error (depending on implementation).-->
+      <valid>!0.0:</valid>
     </arg>
   </function>
+  <!-- https://cplusplus.com/reference/cmath/lgamma/ -->
   <!-- float lgammaf(float x); -->
   <function name="lgammaf,std::lgammaf">
     <use-retval/>
@@ -3055,8 +3059,11 @@ The obsolete function 'gets' is called. With 'gets' you'll get a buffer overrun
     <leak-ignore/>
     <arg nr="1" direction="in">
       <not-uninit/>
+      <!-- If x is zero or a negative integer for which the function is asymptotic, it may cause a pole error (depending on implementation).-->
+      <valid>!0.0:</valid>
     </arg>
   </function>
+  <!-- https://cplusplus.com/reference/cmath/lgamma/ -->
   <!-- long double lgammal(long double x); -->
   <function name="lgammal,std::lgammal">
     <use-retval/>
@@ -3066,6 +3073,8 @@ The obsolete function 'gets' is called. With 'gets' you'll get a buffer overrun
     <leak-ignore/>
     <arg nr="1" direction="in">
       <not-uninit/>
+      <!-- If x is zero or a negative integer for which the function is asymptotic, it may cause a pole error (depending on implementation).-->
+      <valid>!0.0:</valid>
     </arg>
   </function>
   <!-- double rint(double x); -->
diff --git a/test/cfg/std.cpp b/test/cfg/std.cpp
index 1762118c7..8bb7c29f4 100644
--- a/test/cfg/std.cpp
+++ b/test/cfg/std.cpp
@@ -2382,6 +2382,30 @@ void uninitvar_ldexp(void)
     (void)std::ldexp(ldc,e3);
 }
 
+void invalidFunctionArg_lgamma(float f, double d, long double ld)
+{
+    (void)lgamma(d);
+    // cppcheck-suppress invalidFunctionArg
+    (void)lgamma(-0.1);
+    // cppcheck-suppress invalidFunctionArg
+    (void)lgamma(0.0);
+    (void)lgamma(0.1);
+
+    (void)lgammaf(f);
+    // cppcheck-suppress invalidFunctionArg
+    (void)lgammaf(-0.1f);
+    // cppcheck-suppress invalidFunctionArg
+    (void)lgammaf(0.0f);
+    (void)lgammaf(0.1f);
+
+    (void)lgammal(ld);
+    // cppcheck-suppress invalidFunctionArg
+    (void)lgammal(-0.1L);
+    // cppcheck-suppress invalidFunctionArg
+    (void)lgammal(0.0L);
+    (void)lgammal(0.1L);
+}
+
 void uninitvar_lgamma(void)
 {
     float f;