Merge pull request #326 from Bill-Gray/portable-panel_hidden

make panel_hidden portable, prepare release 4.5.0

Author: GitMensch

curses.h

@@ -38,11 +38,11 @@ Defined by this header:
          /* NOTE : For version changes that are not backward compatible, */
          /* the 'endwin_*' #defines below should be updated.             */
 #define PDC_VER_MAJOR    4
-#define PDC_VER_MINOR    4
+#define PDC_VER_MINOR    5
 #define PDC_VER_CHANGE   0
 #define PDC_VER_YEAR   2024
 #define PDC_VER_MONTH    12
-#define PDC_VER_DAY      11
+#define PDC_VER_DAY      31
 
 #define PDC_STRINGIZE( x) #x
 #define PDC_stringize( x) PDC_STRINGIZE( x)

demos/test_pan.c

@@ -279,10 +279,10 @@ int main( const int argc, const char **argv)
          case 9:
             if( curr_top)
                {
-#ifdef __PDCURSES__
-               if( panel_hidden( curr_top) == OK)
-#else
-               if( panel_hidden( curr_top) == TRUE)
+#if (defined( PDCURSES) && (!defined( __PDCURSESMOD__) || PDC_BUILD < 4500))
+               if( panel_hidden( curr_top) == OK)    /* old,  non-standard behavior */
+#else            
+               if( panel_hidden( curr_top) == TRUE)   /* correct behavior according to SVR4 */
 #endif
                   show_panel( curr_top);
                else

docs/HISTORY.md

@@ -1,7 +1,7 @@
 Generally speaking,  this history mentions only the more significant
 changes.  See the git log for full details.
 
-Current PDCursesMod - 2024 Oct 28
+PDCursesMod 4.5.0 - 2024 Dec 31
 =================================
 
 Major new features
@@ -54,6 +54,8 @@ Minor new features
   arbitrarily long strings via recursion.  Added some code to test this
   in 'show_col.c'.  3f8dfa9e06   18ef78de69
 
+- PDC_wcwidth( ) updated from Unicode 14.0.0 to 16.0.0   93e32ef a5f13c2
+
 Bug fixes
 ---------
 
@@ -119,6 +121,10 @@ Bug fixes
 - Fixes for Borland Turbo C compilation. a59f452e78  26128c29aa
   d6b7e998eb
 
+- panel_hidden() is now portable, returning TRUE (1) and FALSE (0) instead
+  of OK (0) and ERR (-1) This may break existing applications, so you possibly
+  want to check for the PDCursesMod build (PDC_BUILD < 4500).
+
 PDCursesMod 4.4.0 - 2023 November 30
 ===================================
 

pdcurses/panel.c

@@ -1,8 +1,5 @@
 /* PDCurses */
 
-#include <curspriv.h>
-#include <assert.h>
-
 /*man-start**************************************************************
 
 panel
@@ -71,7 +68,8 @@ panel
 
    ceiling_panel() returns a pointer to the top panel in the deck.
 
-   panel_hidden() returns OK if pan is hidden and ERR if it is not.
+   panel_hidden() returns TRUE if pan is hidden, FALSE if not and
+   ERR if pan is NULL.
 
    panel_userptr() - Each panel has a user pointer available for
    maintaining relevant information. This function returns a pointer to
@@ -100,7 +98,8 @@ panel
 
    Each routine that returns a pointer to an object returns NULL if an
    error occurs. Each panel routine that returns an integer, returns OK
-   if it executes successfully and ERR if it does not.
+   if it executes successfully and ERR if it does not, with the exception
+   of panel_hidden returning TRUE/FALSE/ERR.
 
 ### Portability
                              X/Open  ncurses  NetBSD
@@ -122,14 +121,21 @@ panel
     top_panel                   -       Y       Y
     update_panels               -       Y       Y
 
+  Note: Before PDC_BUILD 4500 panel_hidden did not return the expected
+        values TRUE (1) and FALSE (0), but OK (0) and ERR (-1).
+
   Credits:
     Original Author - Warren Tucker <[email protected]>
 
 **man-end****************************************************************/
 
-#include <panel.h>
 #include <stdlib.h>
 
+#include <assert.h>
+
+#include "curspriv.h"
+#include <panel.h>
+
 struct panel
 {
     WINDOW *win;
@@ -430,11 +436,10 @@ PANEL *ground_panel( SCREEN *sp)
 
 int panel_hidden(const PANEL *pan)
 {
-    assert( pan);
     if (!pan)
         return ERR;
 
-    return _panel_is_linked(pan) ? ERR : OK;
+    return _panel_is_linked(pan) ? FALSE : TRUE;
 }
 
 const void *panel_userptr(const PANEL *pan)