Changeset 14 for trunk/src

Timestamp:

Dec 9, 2000, 8:19:42 PM (25 years ago)

Author:

umoeller

Message:

Major updates; timers, LVM, miscellaneous.

Location:

trunk/src/helpers

Files:

• animate.c (modified) (3 diffs)
• cctl_chart.c (modified) (2 diffs)
• cctl_checkcnr.c (modified) (3 diffs)
• cctl_progbar.c (modified) (2 diffs)
• cctl_splitwin.c (modified) (2 diffs)
• cctl_tooltip.c (modified) (4 diffs)
• cnrh.c (modified) (9 diffs)
• comctl.c (modified) (9 diffs)
• datetime.c (modified) (9 diffs)
• debug.c (modified) (7 diffs)
• dosh.c (modified) (13 diffs)
• dosh2.c (modified) (12 diffs)
• eah.c (modified) (31 diffs)
• except.c (modified) (30 diffs)
• gpih.c (modified) (10 diffs)
• helpers_post.in (modified) (1 diff)
• helpers_pre.in (modified) (1 diff)
• level.c (modified) (4 diffs)
• linklist.c (modified) (5 diffs)
• memdebug.c (modified) (3 diffs)
• prfh.c (modified) (5 diffs)
• prfh2.c (modified) (2 diffs)
• procstat.c (modified) (5 diffs)
• resh.c (modified) (1 diff)
• shapewin.c (modified) (7 diffs)
• stringh.c (modified) (6 diffs)
• textv_html.c (modified) (5 diffs)
• textview.c (modified) (5 diffs)
• threads.c (modified) (2 diffs)
• timer.c (added)
• tmsgfile.c (modified) (4 diffs)
• tree.c (modified) (1 diff)
• winh.c (modified) (27 diffs)
• wphandle.c (modified) (6 diffs)
• xml.c (modified) (1 diff)
• xprf.c (modified) (6 diffs)
• xprf2.c (modified) (3 diffs)
• xstring.c (modified) (1 diff)

trunk/src/helpers/animate.c

@@ -22 +22 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -38 +38 @@
     // as unsigned char
 
-#define INCL_DOS
-#define INCL_DOSERRORS
+#define INCL_DOSPROCESS
 #define INCL_DOSDEVICES
 #define INCL_DOSDEVIOCTL
-
-#define INCL_WIN
+#define INCL_DOSERRORS
+
+#define INCL_WINPOINTERS
 #define INCL_WINSYS
 
@@ -164 +164 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Other animations                                               *
- *                                                                  *
+ *
+ *   Other animations
+ *
  ********************************************************************/
 

trunk/src/helpers/cctl_chart.c

@@ -16 +16 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -84 +84 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Chart Control                                                  *
- *                                                                  *
+ *
+ *   Chart Control
+ *
  ********************************************************************/
 

trunk/src/helpers/cctl_checkcnr.c

@@ -16 +16 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -84 +84 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Global variables                                               *
- *                                                                  *
+ *
+ *   Global variables
+ *
  ********************************************************************/
 
@@ -94 +94 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Checkbox container record cores                                *
- *                                                                  *
+ *
+ *   Checkbox container record cores
+ *
  ********************************************************************/
 

trunk/src/helpers/cctl_progbar.c

@@ -16 +16 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -84 +84 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Progress bars                                                  *
- *                                                                  *
+ *
+ *   Progress bars
+ *
  ********************************************************************/
 

trunk/src/helpers/cctl_splitwin.c

@@ -16 +16 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -84 +84 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Split windows                                                  *
- *                                                                  *
+ *
+ *   Split windows
+ *
  ********************************************************************/
 

trunk/src/helpers/cctl_tooltip.c

@@ -16 +16 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -84 +84 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Global variables                                               *
- *                                                                  *
+ *
+ *   Global variables
+ *
  ********************************************************************/
 
@@ -98 +98 @@
 
 /* ******************************************************************
- *                                                                  *
- *   "Tooltip" control                                              *
- *                                                                  *
+ *
+ *   "Tooltip" control
+ *
  ********************************************************************/
 
@@ -724 +724 @@
     PTOOLTIPDATA pttd = (PTOOLTIPDATA)WinQueryWindowPtr(hwndTooltip, 1);
 
-    TRY_LOUD(excpt1, NULL)
+    TRY_LOUD(excpt1)
     {
         switch (msg)

trunk/src/helpers/cnrh.c

@@ -22 +22 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -38 +38 @@
     // as unsigned char
 
-#define INCL_WIN
+#define INCL_WINWINDOWMGR
+#define INCL_WINRECTANGLES
+#define INCL_WININPUT
+#define INCL_WINPOINTERS
+#define INCL_WINMENUS
+#define INCL_WINSYS
+#define INCL_WINSTDDRAG
+#define INCL_WINSTDCNR
+
 #define INCL_GPILOGCOLORTABLE
 #define INCL_GPIPRIMITIVES
@@ -59 +67 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Details view field infos                                       *
- *                                                                  *
+ *
+ *   Details view field infos
+ *
  ********************************************************************/
 
@@ -338 +346 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Record core management                                         *
- *                                                                  *
+ *
+ *   Record core management
+ *
  ********************************************************************/
 
@@ -353 +361 @@
  *      by following the RECORDCORE.preccNextRecord pointers
  *      (i.e. we have a linked list here).
+ *
+ *      Returns NULL on errors (what CM_ALLOCRECORD returns).
  *
  *      The record cores returned by the container are
@@ -735 +745 @@
 
 /* ******************************************************************
- *                                                                  *
- *   View management                                                *
- *                                                                  *
+ *
+ *   View management
+ *
  ********************************************************************/
 
@@ -1119 +1129 @@
                 // convert this to screen coordinates
                 WinMapWindowPoints(hwndCnr,
-                           HWND_DESKTOP,
-                           &ptl,
-                           1);
+                                   HWND_DESKTOP,
+                                   &ptl,
+                                   1);
                 fQueried = TRUE;
             }
@@ -1303 +1313 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Record relations/iteration                                     *
- *                                                                  *
+ *
+ *   Record relations/iteration
+ *
  ********************************************************************/
 
@@ -1580 +1590 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Miscellaneous                                                  *
- *                                                                  *
+ *
+ *   Miscellaneous
+ *
  ********************************************************************/
 

trunk/src/helpers/comctl.c

@@ -53 +53 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -117 +117 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Global variables                                               *
- *                                                                  *
+ *
+ *   Global variables
+ *
  ********************************************************************/
 
@@ -127 +127 @@
 
 /* ******************************************************************
- *                                                                  *
- *   "Menu button" control                                          *
- *                                                                  *
+ *
+ *   "Menu button" control
+ *
  ********************************************************************/
 
@@ -149 +149 @@
     HWND        hwndMenu;
 } MENUBUTTONDATA, *PMENUBUTTONDATA;
+
+/*
+ *@@ ctlDisplayButtonMenu:
+ *      displays the specified menu above the button.
+ *
+ *@@added V0.9.7 (2000-11-29) [umoeller]
+ */
+
+VOID ctlDisplayButtonMenu(HWND hwndButton,
+                          HWND hwndMenu)
+{
+    SWP     swpButton;
+    POINTL  ptlMenu;
+    WinQueryWindowPos(hwndButton, &swpButton);
+    ptlMenu.x = swpButton.x;
+    ptlMenu.y = swpButton.y;
+
+    // ptlMenu now has button coordinates
+    // relative to the button's parent;
+    // convert this to screen coordinates:
+    WinMapWindowPoints(WinQueryWindow(hwndButton, QW_PARENT),
+                       HWND_DESKTOP,
+                       &ptlMenu,
+                       1);
+
+    // now show the menu on top of the button
+    WinPopupMenu(HWND_DESKTOP,               // menu parent
+                 hwndButton,                 // owner
+                 hwndMenu,
+                 (SHORT)(ptlMenu.x),
+                 (SHORT)(ptlMenu.y + swpButton.cy - 1),
+                 0,                          // ID
+                 PU_NONE
+                     | PU_MOUSEBUTTON1
+                     | PU_KEYBOARD
+                     | PU_HCONSTRAIN
+                     | PU_VCONSTRAIN);
+}
 
 /*
@@ -288 +326 @@
                         // menu successfully loaded:
                         // find out where to put it
-                        SWP     swpButton;
-                        POINTL  ptlMenu;
-                        WinQueryWindowPos(hwndButton, &swpButton);
-                        ptlMenu.x = swpButton.x;
-                        ptlMenu.y = swpButton.y;
-
-                        // ptlMenu now has button coordinates
-                        // relative to the button's parent;
-                        // convert this to screen coordinates:
-                        WinMapWindowPoints(WinQueryWindow(hwndButton, QW_PARENT),
-                                           HWND_DESKTOP,
-                                           &ptlMenu,
-                                           1);
-
-                        // now show the menu on top of the button
-                        WinPopupMenu(HWND_DESKTOP,               // menu parent
-                                     hwndButton,                 // owner
-                                     pmbd->hwndMenu,
-                                     (SHORT)(ptlMenu.x),
-                                     (SHORT)(ptlMenu.y + swpButton.cy - 1),
-                                     0,                          // ID
-                                      PU_NONE
-                                         | PU_MOUSEBUTTON1
-                                         | PU_KEYBOARD
-                                         | PU_HCONSTRAIN
-                                         | PU_VCONSTRAIN);
+                        ctlDisplayButtonMenu(hwndButton,
+                                             pmbd->hwndMenu);
                     } // end if (pmbd->hwndMenu)
                     else
@@ -484 +498 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Subclassed Static Bitmap Control                               *
- *                                                                  *
+ *
+ *   Subclassed Static Bitmap Control
+ *
  ********************************************************************/
 
@@ -788 +802 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Icon animation                                                 *
- *                                                                  *
+ *
+ *   Icon animation
+ *
  ********************************************************************/
 
@@ -967 +981 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Bitmap functions                                               *
- *                                                                  *
+ *
+ *   Bitmap functions
+ *
  ********************************************************************/
 
@@ -1050 +1064 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Hotkey entry field                                             *
- *                                                                  *
+ *
+ *   Hotkey entry field
+ *
  ********************************************************************/
 

trunk/src/helpers/datetime.c

@@ -25 +25 @@
 /*
  *      This file Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -63 +63 @@
 const char  *pcszFormatTimestamp = "%4u%02u%02u%02u%02u%02u%";
 
+ULONG G_ulDateScalarFirstCalled = 0;
+
 /*
  *@@ dtGetULongTime:
@@ -71 +73 @@
  *      time in milliseconds.
  *
- *      Warning: this does not handle day information. When called twice
- *      in between day changes, this returns incorrect information.
+ *      Even though this does handle date information (i.e.
+ *      will still return an increasing number when the
+ *      clock switches from 23:59:59:9999 to 0:00:00:0000),
+ *      this will not work forver after the first call.
+ *      Here's the calculation:
+ *
+ +          1000 ms per second
+ +            * 60 secs per minute
+ +                * 60 minutes per hour
+ +                    * 24 hours per day
+ +                      = 86'400'000       after 23:59:59:9999
+ *
+ *      A ULONG can hold a max value of 4'294'967'295.
+ *      So this overflows after 49.71... days.
+ *
+ *@@changed V0.9.7 (2000-12-05) [umoeller]: now handling date also
  */
 
@@ -78 +94 @@
 {
     DATETIME    dt;
+    ULONG       ulTime,
+                ulDateScalarPassed = 1;
     DosGetDateTime(&dt);
-    return (10*(dt.hundredths + 100*(dt.seconds + 60*(dt.minutes + 60*(dt.hours)))));
+    ulTime = (10*(dt.hundredths + 100*(dt.seconds + 60*(dt.minutes + 60*(dt.hours)))));
+
+    if (G_ulDateScalarFirstCalled == 0)
+    {
+        // first call:
+        G_ulDateScalarFirstCalled = dtDate2Scalar(dt.year,
+                                                  dt.month,
+                                                  dt.day);
+    }
+    else
+    {
+        // not first call:
+        ULONG ulDateScalarNow = dtDate2Scalar(dt.year,
+                                              dt.month,
+                                              dt.day);
+        // calculate days passed since first call;
+        // this should be 1 if the date hasn't changed
+        ulDateScalarPassed = (G_ulDateScalarFirstCalled - ulDateScalarNow) + 1;
+    }
+
+    return (ulTime * ulDateScalarPassed);
 }
 
@@ -147 +185 @@
 
 /*
+**
+**
+**   day:    day of month
+**   mon:    month (1-12)
+**   yr:     year
+**
+**
+*/
+
+/*
+ *@@ dtDayOfWeek:
+ *      returns an integer that represents the day of
+ *      the week for the date passed as parameters.
+ *
+ *      Returns 0-6 where 0 is sunday.
+ *
+ *@@added V0.9.7 (2000-12-05) [umoeller]
+ */
+
+ULONG dtDayOfWeek(ULONG day,
+                  ULONG mon,    // 1-12
+                  ULONG yr)
+{
+    int dow;
+
+    if (mon <= 2)
+    {
+          mon += 12;
+          yr -= 1;
+    }
+    dow = (   day
+            + mon * 2
+            + ((mon + 1) * 6) / 10
+            + yr
+            + yr / 4
+            - yr / 100
+            + yr / 400
+            + 2);
+    dow = dow % 7;
+    return ((dow ? dow : 7) - 1);
+}
+
+/*
  *@@ dtIsLeapYear:
  *      returns TRUE if yr is a leap year.
@@ -164 +245 @@
 /*
  *@@ dtMonths2Days:
- *      returns the no. of days for month.
+ *      returns the no. of days for the beginning
+ *      of "month" (starting from 1).
+ *
+ *      For example, if you pass 1 (for january),
+ *      you get 0 because there's no days at jan 1st
+ *      yet.
+ *
+ *      If you pass 2 (for february), you get 31.
+ *
+ *      If you pass 3 (for march), you get 61.
+ *
+ *      This is useful for computing a day index
+ *      for a given month/day pair. Pass the month
+ *      in here and add (day-1); for march 3rd,
+ *      you then get 63.
  *
  *      (c) Ray Gardner.
@@ -171 +266 @@
 unsigned dtMonths2Days(unsigned month)
 {
-   return (month * 3057 - 3007) / 100;
+    return (month * 3057 - 3007) / 100;
 }
 
@@ -228 +323 @@
    *pyr = n;
    n = (unsigned)(scalar - dtYears2Days(n-1));
-   if ( n > 59 ) {                       /* adjust if past February */
+   if ( n > 59 )    /* adjust if past February */
+   {
       n += 2;
       if ( dtIsLeapYear(*pyr) )
@@ -237 +333 @@
 }
 
-
+/*
+ *@@ dtIsValidDate:
+ *      returns TRUE if the given date is valid.
+ *
+ *@@added V0.9.7 (2000-12-05) [umoeller]
+ */
+
+BOOL dtIsValidDate(LONG day,      // in: day (1-31)
+                   LONG month,    // in: month (1-12)
+                   ULONG year)    // in: year (e.g. 1999)
+{
+    BOOL brc = FALSE;
+    if (day > 0)
+    {
+        switch( month )
+        {
+            case 1  :
+            case 3  :
+            case 5  :
+            case 7  :
+            case 8  :
+            case 10 :
+            case 12 :
+                if (day <= 31)
+                    brc = TRUE;
+            break;
+
+            case 4  :
+            case 6  :
+            case 9  :
+            case 11 :
+                if (day <= 30)
+                    brc = TRUE;
+            break;
+
+            case 2 :
+                if (day < 29)
+                    brc = TRUE;
+                else
+                    if (day == 29)
+                        if (dtIsLeapYear(year))
+                            return 1 ;
+        }
+    }
+    return (brc);
+}
+

trunk/src/helpers/debug.c

@@ -34 +34 @@
  *                                      John Currier,
  *                                      Anthony Cruise.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -50 +50 @@
     // as unsigned char
 
-#define INCL_BASE
+#define INCL_DOSPROCESS
+#define INCL_DOSMODULEMGR
+#define INCL_DOSMISC
+#define INCL_DOSERRORS
 #include <os2.h>
 
@@ -88 +91 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Global variables                                               *
- *                                                                  *
+ *
+ *   Global variables
+ *
  ********************************************************************/
 
@@ -353 +356 @@
 
 /* ******************************************************************
- *                                                                  *
- *   PART 1: ANALYZE DEBUG CODE                                     *
- *                                                                  *
+ *
+ *   PART 1: ANALYZE DEBUG CODE
+ *
  ********************************************************************/
 
@@ -1129 +1132 @@
 
 /* ******************************************************************
- *                                                                  *
- *   PART 2: ANALYZE VARIABLES                                      *
- *                                                                  *
+ *
+ *   PART 2: ANALYZE VARIABLES
+ *
  ********************************************************************/
 
@@ -1421 +1424 @@
 
 /* ******************************************************************
- *                                                                  *
- *   PART 3: ANALYZE SYMBOL (.SYM) FILE                             *
- *                                                                  *
+ *
+ *   PART 3: ANALYZE SYMBOL (.SYM) FILE
+ *
  ********************************************************************/
 
@@ -1566 +1569 @@
 
 /* ******************************************************************
- *                                                                  *
- *   PART 4: dbgPrintStack                                          *
- *                                                                  *
+ *
+ *   PART 4: dbgPrintStack
+ *
  ********************************************************************/
 

trunk/src/helpers/dosh.c

@@ -31 +31 @@
 /*
  *      This file Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -47 +47 @@
     // as unsigned char
 
-#define INCL_DOS
+#define INCL_DOSMODULEMGR
+#define INCL_DOSPROCESS
+#define INCL_DOSSESMGR
+#define INCL_DOSQUEUES
+#define INCL_DOSMISC
+#define INCL_DOSDEVICES
 #define INCL_DOSDEVIOCTL
 #define INCL_DOSERRORS
+
 #define INCL_KBD
 #include <os2.h>
+
 #include <stdlib.h>
 #include <string.h>
 #include <stdio.h>
-// #include <ctype.h>
 
 #include "setup.h"                      // code generation and debugging options
@@ -70 +76 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Miscellaneous                                                  *
- *                                                                  *
+ *
+ *   Miscellaneous
+ *
  ********************************************************************/
 
@@ -172 +178 @@
 
     return (s_brc);
+}
+
+/*
+ *@@ doshQueryAvailPhysMem:
+ *      returns the amount of physical memory which
+ *      is presently available (before the swapper
+ *      would have to be expanded).
+ *
+ *      This number is calculated by getting the
+ *      total available memory (QSV_TOTRESMEM)
+ *      and subtracting the free space on the
+ *      drive with the swap file from it.
+ *
+ *      As a result, you also need to specify
+ *      the logical drive on which the swapper
+ *      resides (3 = C, 4 = D, and so on).
+ *
+ *@@added V0.9.7 (2000-12-01) [umoeller]
+ */
+
+APIRET doshQueryAvailPhysMem(PULONG pulMem,
+                             ULONG ulLogicalSwapDrive)
+{
+    APIRET arc = DosQuerySysInfo(QSV_TOTAVAILMEM,
+                                 QSV_TOTAVAILMEM,
+                                 pulMem,
+                                 sizeof(*pulMem));
+    if (arc == NO_ERROR)
+    {
+        double dFree = 0;
+        arc = doshQueryDiskFree(ulLogicalSwapDrive,
+                                &dFree);
+        *pulMem -= (ULONG)dFree;
+    }
+
+    return (arc);
 }
 
@@ -213 +255 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Memory helpers                                                 *
- *                                                                  *
+ *
+ *   Memory helpers
+ *
  ********************************************************************/
 
@@ -283 +325 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Drive helpers                                                  *
- *                                                                  *
+ *
+ *   Drive helpers
+ *
  ********************************************************************/
 
@@ -417 +459 @@
 {
     ULONG ulBootDrive;
-    DosQuerySysInfo(5, 5, &ulBootDrive, sizeof(ulBootDrive));
+    DosQuerySysInfo(QSV_BOOT_DRIVE, QSV_BOOT_DRIVE,
+                    &ulBootDrive,
+                    sizeof(ulBootDrive));
     return (G_acDriveLetters[ulBootDrive]);
 }
@@ -461 +505 @@
                   OPEN_FLAGS_DASD
                          | OPEN_FLAGS_FAIL_ON_ERROR
+                         | OPEN_FLAGS_NOINHERIT     // V0.9.6 (2000-11-25) [pr]
                          | OPEN_ACCESS_READONLY
                          | OPEN_SHARE_DENYNONE,
@@ -523 +568 @@
 
 /*
+ *@@ doshSetLogicalMap:
+ *       sets the mapping of logical floppy drives onto a single
+ *       physical floppy drive.
+ *       This means selecting either drive A: or drive B: to refer
+ *       to the physical drive.
+ *
+ *@@added V0.9.6 (2000-11-24) [pr]
+ */
+
+APIRET doshSetLogicalMap(ULONG ulLogicalDrive)
+{
+    CHAR    name[3] = "?:";
+    ULONG   fd = 0,
+            action = 0,
+            paramsize = 0,
+            datasize = 0;
+    APIRET    rc = NO_ERROR;
+    USHORT    data,
+              param;
+
+    name[0] = doshQueryBootDrive();
+    rc = DosOpen(name,
+                 &fd,
+                 &action,
+                 0,
+                 0,
+                 OPEN_ACTION_FAIL_IF_NEW
+                          | OPEN_ACTION_OPEN_IF_EXISTS,
+                 OPEN_FLAGS_DASD
+                       | OPEN_FLAGS_FAIL_ON_ERROR
+                       | OPEN_FLAGS_NOINHERIT
+                       | OPEN_ACCESS_READONLY
+                       | OPEN_SHARE_DENYNONE,
+                 0);
+    if (rc == NO_ERROR)
+    {
+        param = 0;
+        data = (USHORT)ulLogicalDrive;
+        paramsize = sizeof(param);
+        datasize = sizeof(data);
+        rc = DosDevIOCtl(fd,
+                         IOCTL_DISK, DSK_SETLOGICALMAP,
+                         &param, paramsize, &paramsize,
+                         &data, datasize, &datasize);
+        DosClose(fd);
+    }
+
+    return(rc);
+}
+
+/*
  *@@ doshQueryDiskFree:
  *       returns the number of bytes remaining on the disk
- *       specified by the given logical drive, or -1 upon errors.
+ *       specified by the given logical drive.
  *
  *       Note: This returns a "double" value, because a ULONG
@@ -532 +628 @@
  *
  *@@changed V0.9.0 [umoeller]: fixed another > 4 GB bug (thanks to Rdiger Ihle)
- */
-
-double doshQueryDiskFree(ULONG ulLogicalDrive) // in: 1 for A:, 2 for B:, 3 for C:, ...
-{
+ *@@changed V0.9.7 (2000-12-01) [umoeller]: changed prototype
+ */
+
+APIRET doshQueryDiskFree(ULONG ulLogicalDrive, // in: 1 for A:, 2 for B:, 3 for C:, ...
+                         double *pdFree)
+{
+    APIRET      arc = NO_ERROR;
     FSALLOCATE  fsa;
     double      dbl = -1;
 
-    if (ulLogicalDrive)
-        if (DosQueryFSInfo(ulLogicalDrive, FSIL_ALLOC, &fsa, sizeof(fsa))
-                == NO_ERROR)
-            dbl = ((double)fsa.cSectorUnit * fsa.cbSector * fsa.cUnitAvail);
+    arc = DosQueryFSInfo(ulLogicalDrive, FSIL_ALLOC, &fsa, sizeof(fsa));
+    if (arc == NO_ERROR)
+        *pdFree = ((double)fsa.cSectorUnit * fsa.cbSector * fsa.cUnitAvail);
                    // ^ fixed V0.9.0
 
-    return (dbl);
+    return (arc);
 }
 
@@ -779 +877 @@
 
 /* ******************************************************************
- *                                                                  *
- *   File helpers                                                   *
- *                                                                  *
+ *
+ *   File helpers
+ *
  ********************************************************************/
 
@@ -1226 +1324 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Directory helpers                                              *
- *                                                                  *
+ *
+ *   Directory helpers
+ *
  ********************************************************************/
 
@@ -1459 +1557 @@
 
 /*
+ *@@category: Helpers\Control program helpers\Performance (CPU load) helpers
+ */
+
+/* ******************************************************************
+ *
+ *   Performance Counters (CPU Load)
+ *
+ ********************************************************************/
+
+/*
+ *@@ doshPerfOpen:
+ *      initializes the OS/2 DosPerfSysCall API for
+ *      the calling thread.
+ *
+ *      Note: This API is not supported on all OS/2
+ *      versions. I believe it came up with some Warp 4
+ *      fixpak. The API is resolved dynamically by
+ *      this function (using DosQueryProcAddr). Only
+ *      if NO_ERROR is returned, you may call doshPerfGet
+ *      afterwards.
+ *
+ *      This properly initializes the internal counters
+ *      which the OS/2 kernel uses for this API. Apparently,
+ *      with newer kernels (FP13/14), IBM has chosen to no
+ *      longer do this automatically, which is the reason
+ *      why many "pulse" utilities display garbage with these
+ *      fixpaks.
+ *
+ *      After NO_ERROR is returned, DOSHPERFSYS.cProcessors
+ *      contains the no. of processors found on the system.
+ *      All pointers in DOSHPERFSYS then point to arrays
+ *      which have exactly cProcessors array items.
+ *
+ *      Call doshPerfClose to clean up resources allocated
+ *      by this function.
+ *
+ *      Example code:
+ *
+ +      PDOSHPERFSYS pPerf = NULL;
+ +      APIRET arc = doshPerfOpen(&pPerf);
+ +      if (arc == NO_ERROR)
+ +      {
+ +          // this should really be in a timer
+ +          ULONG   ulCPU;
+ +          arc = doshPerfGet(&pPerf);
+ +          // go thru all CPUs
+ +          for (ulCPU = 0; ulCPU < pPerf->cProcessors; ulCPU++)
+ +          {
+ +              LONG lLoadThis = pPerf->palLoads[ulCPU];
+ +              ...
+ +          }
+ +
+ +          ...
+ +
+ +          // clean up
+ +          doshPerfClose(&pPerf);
+ +      }
+ +
+ *
+ *@@added V0.9.7 (2000-12-02) [umoeller]
+ */
+
+APIRET doshPerfOpen(PDOSHPERFSYS *ppPerfSys)  // out: new DOSHPERFSYS structure
+{
+    APIRET  arc = NO_ERROR;
+
+    // allocate DOSHPERFSYS structure
+    *ppPerfSys = (PDOSHPERFSYS)malloc(sizeof(DOSHPERFSYS));
+    if (!*ppPerfSys)
+        arc = ERROR_NOT_ENOUGH_MEMORY;
+    else
+    {
+        // initialize structure
+        PDOSHPERFSYS pPerfSys = *ppPerfSys;
+        memset(pPerfSys, 0, sizeof(*pPerfSys));
+
+        // resolve DosPerfSysCall API entry
+        arc = DosLoadModule(NULL, 0, "DOSCALLS", &pPerfSys->hmod);
+        if (arc == NO_ERROR)
+        {
+            arc = DosQueryProcAddr(pPerfSys->hmod,
+                                   976,
+                                   "DosPerfSysCall",
+                                   (PFN*)(&pPerfSys->pDosPerfSysCall));
+            if (arc == NO_ERROR)
+            {
+                // OK, we got the API: initialize!
+                arc = pPerfSys->pDosPerfSysCall(CMD_KI_ENABLE, 0, 0, 0);
+                if (arc == NO_ERROR)
+                {
+                    pPerfSys->fInitialized = TRUE;
+                            // call CMD_KI_DISABLE later
+
+                    arc = pPerfSys->pDosPerfSysCall(CMD_PERF_INFO,
+                                                    0,
+                                                    (ULONG)(&pPerfSys->cProcessors),
+                                                    0);
+                    if (arc == NO_ERROR)
+                    {
+                        ULONG   ul = 0;
+
+                        // allocate arrays
+                        pPerfSys->paCPUUtils = (PCPUUTIL)calloc(pPerfSys->cProcessors,
+                                                                sizeof(CPUUTIL));
+                        if (!pPerfSys->paCPUUtils)
+                            arc = ERROR_NOT_ENOUGH_MEMORY;
+                        else
+                        {
+                            pPerfSys->padBusyPrev = (double*)malloc(pPerfSys->cProcessors * sizeof(double));
+                            if (!pPerfSys->padBusyPrev)
+                                arc = ERROR_NOT_ENOUGH_MEMORY;
+                            else
+                            {
+                                pPerfSys->padTimePrev
+                                    = (double*)malloc(pPerfSys->cProcessors * sizeof(double));
+                                if (!pPerfSys->padTimePrev)
+                                    arc = ERROR_NOT_ENOUGH_MEMORY;
+                                else
+                                {
+                                    pPerfSys->palLoads = (PLONG)malloc(pPerfSys->cProcessors * sizeof(LONG));
+                                    if (!pPerfSys->palLoads)
+                                        arc = ERROR_NOT_ENOUGH_MEMORY;
+                                    else
+                                    {
+                                        for (ul = 0; ul < pPerfSys->cProcessors; ul++)
+                                        {
+                                            pPerfSys->padBusyPrev[ul] = 0.0;
+                                            pPerfSys->padTimePrev[ul] = 0.0;
+                                            pPerfSys->palLoads[ul] = 0;
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            } // end if (arc == NO_ERROR)
+        } // end if (arc == NO_ERROR)
+
+        if (arc != NO_ERROR)
+        {
+            doshPerfClose(ppPerfSys);
+        }
+    } // end else if (!*ppPerfSys)
+
+    return (arc);
+}
+
+/*
+ *@@ doshPerfGet:
+ *      calculates a current snapshot of the system load,
+ *      compared with the load which was calculated on
+ *      the previous call.
+ *
+ *      If you want to continually measure the system CPU
+ *      load, this is the function you will want to call
+ *      regularly -- e.g. with a timer once per second.
+ *
+ *      Call this ONLY if doshPerfOpen returned NO_ERROR,
+ *      or you'll get crashes.
+ *
+ *      If this call returns NO_ERROR, you get a LONG
+ *      CPU load for each CPU in the system in the
+ *      DOSHPERFSYS.palLoads array (in per-mille, 0-1000).
+ *
+ *      For example, if there are two CPUs, after this call,
+ *
+ *      -- DOSHPERFSYS.palLoads[0] contains the load of
+ *         the first CPU,
+ *
+ *      -- DOSHPERFSYS.palLoads[1] contains the load of
+ *         the second CPU.
+ *
+ *      See doshPerfOpen for example code.
+ *
+ *@@added V0.9.7 (2000-12-02) [umoeller]
+ */
+
+APIRET doshPerfGet(PDOSHPERFSYS pPerfSys)
+{
+    APIRET arc = NO_ERROR;
+    if (!pPerfSys->pDosPerfSysCall)
+        arc = ERROR_INVALID_PARAMETER;
+    else
+    {
+        arc = pPerfSys->pDosPerfSysCall(CMD_KI_RDCNT,
+                                        (ULONG)pPerfSys->paCPUUtils,
+                                        0, 0);
+        if (arc == NO_ERROR)
+        {
+            // go thru all processors
+            ULONG ul = 0;
+            for (; ul < pPerfSys->cProcessors; ul++)
+            {
+                PCPUUTIL    pCPUUtilThis = &pPerfSys->paCPUUtils[ul];
+
+                double      dTime = LL2F(pCPUUtilThis->ulTimeHigh,
+                                         pCPUUtilThis->ulTimeLow);
+                double      dBusy = LL2F(pCPUUtilThis->ulBusyHigh,
+                                         pCPUUtilThis->ulBusyLow);
+
+                double      *pdBusyPrevThis = &pPerfSys->padBusyPrev[ul];
+                double      *pdTimePrevThis = &pPerfSys->padTimePrev[ul];
+
+                // avoid division by zero
+                double      dTimeDelta = (dTime - *pdTimePrevThis);
+                if (dTimeDelta)
+                    pPerfSys->palLoads[ul]
+                        = (LONG)( (double)(   (dBusy - *pdBusyPrevThis)
+                                            / dTimeDelta
+                                            * 1000.0
+                                          )
+                                );
+                else
+                    pPerfSys->palLoads[ul] = 0;
+
+                *pdTimePrevThis = dTime;
+                *pdBusyPrevThis = dBusy;
+            }
+        }
+    }
+
+    return (arc);
+}
+
+/*
+ *@@ doshPerfClose:
+ *      frees all resources allocated by doshPerfOpen.
+ *
+ *@@added V0.9.7 (2000-12-02) [umoeller]
+ */
+
+APIRET doshPerfClose(PDOSHPERFSYS *ppPerfSys)
+{
+    APIRET arc = NO_ERROR;
+    PDOSHPERFSYS pPerfSys = *ppPerfSys;
+    if (!pPerfSys)
+        arc = ERROR_INVALID_PARAMETER;
+    else
+    {
+        if (pPerfSys->fInitialized)
+            pPerfSys->pDosPerfSysCall(CMD_KI_DISABLE,
+                                      0, 0, 0);
+
+        if (pPerfSys->paCPUUtils)
+            free(pPerfSys->paCPUUtils);
+        if (pPerfSys->padBusyPrev)
+            free(pPerfSys->padBusyPrev);
+        if (pPerfSys->padTimePrev)
+            free(pPerfSys->padTimePrev);
+
+        if (pPerfSys->hmod)
+            DosFreeModule(pPerfSys->hmod);
+        free(pPerfSys);
+        *ppPerfSys = NULL;
+    }
+
+    return (arc);
+}
+
+/*
  *@@category: Helpers\Control program helpers\Process management
  */
 
 /* ******************************************************************
- *                                                                  *
- *   Process helpers                                                *
- *                                                                  *
+ *
+ *   Process helpers
+ *
  ********************************************************************/
 

trunk/src/helpers/dosh2.c

@@ -30 +30 @@
  *      This file Copyright (C) 1997-2000 Ulrich M”ller,
  *                                        Dmitry A. Steklenev.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -46 +46 @@
     // as unsigned char
 
+#define INCL_DOSMODULEMGR
+#define INCL_DOSPROCESS
+#define INCL_DOSSESMGR
+#define INCL_DOSQUEUES
+#define INCL_DOSMISC
+#define INCL_DOSDEVICES
 #define INCL_DOSDEVIOCTL
-#define INCL_DOS
 #define INCL_DOSERRORS
-// #define INCL_GPI
 #include <os2.h>
+
 #include <stdlib.h>
 #include <string.h>
@@ -68 +73 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Miscellaneous                                                  *
- *                                                                  *
+ *
+ *   Miscellaneous
+ *
  ********************************************************************/
 
@@ -109 +114 @@
                            BOOL fFullyQualified)    // in: if TRUE, pcszFile must be fully q'fied
 {
+    APIRET  arc = NO_ERROR;
     CHAR    szPath[CCHMAXPATH+4] = " :";
     CHAR    szComponent[CCHMAXPATH];
@@ -120 +126 @@
              || (*(pcszFile + 2) != '\\')
            )
-            return (ERROR_CURRENT_DIRECTORY);
+            arc = ERROR_CURRENT_DIRECTORY;
     }
 
@@ -127 +133 @@
     {
         CHAR cDrive = toupper(*pcszFile);
+        double d;
         // drive specified:
         strcpy(szPath, pcszFile);
         szPath[0] = toupper(*pcszFile);
-        if (doshQueryDiskFree(cDrive - 'A' + 1) == -1)
-            return (ERROR_INVALID_DRIVE);
+        arc = doshQueryDiskFree(cDrive - 'A' + 1, &d);
     }
     else
@@ -138 +144 @@
         ULONG   ulDriveNum = 0,
                 ulDriveMap = 0;
-        DosQueryCurrentDisk(&ulDriveNum, &ulDriveMap);
+        arc = DosQueryCurrentDisk(&ulDriveNum, &ulDriveMap);
         szPath[0] = ((UCHAR)ulDriveNum) + 'A' - 1;
         szPath[1] = ':';
@@ -144 +150 @@
     }
 
-    fIsFAT = doshIsFileOnFAT(szPath);
-
-    pszInvalid = (fIsFAT)
-                    ? "<>|+=:;,\"/[] "  // invalid characters in FAT
-                    : "<>|:\"/";        // invalid characters in IFS's
-
-    // now separate path components
-    p1 = &szPath[2];       // advance past ':'
-
-    do {
-
-        if (*p1 == '\\')
-            p1++;
-
-        p2 = strchr(p1, '\\');
-        if (p2 == NULL)
-            p2 = p1 + strlen(p1);
-
-        if (p1 != p2)
-        {
-            LONG    lDotOfs = -1,
-                    lAfterDot = -1;
-            ULONG   cbFile,
-                    ul;
-            PSZ     pSource = szComponent;
-
-            strncpy(szComponent, p1, p2-p1);
-            szComponent[p2-p1] = 0;
-            cbFile = strlen(szComponent);
-
-            // now check each path component
-            for (ul = 0; ul < cbFile; ul++)
+    if (arc == NO_ERROR)
+    {
+        fIsFAT = doshIsFileOnFAT(szPath);
+
+        pszInvalid = (fIsFAT)
+                        ? "<>|+=:;,\"/[] "  // invalid characters in FAT
+                        : "<>|:\"/";        // invalid characters in IFS's
+
+        // now separate path components
+        p1 = &szPath[2];       // advance past ':'
+
+        do {
+
+            if (*p1 == '\\')
+                p1++;
+
+            p2 = strchr(p1, '\\');
+            if (p2 == NULL)
+                p2 = p1 + strlen(p1);
+
+            if (p1 != p2)
             {
+                LONG    lDotOfs = -1,
+                        lAfterDot = -1;
+                ULONG   cbFile,
+                        ul;
+                PSZ     pSource = szComponent;
+
+                strncpy(szComponent, p1, p2-p1);
+                szComponent[p2-p1] = 0;
+                cbFile = strlen(szComponent);
+
+                // now check each path component
+                for (ul = 0; ul < cbFile; ul++)
+                {
+                    if (fIsFAT)
+                    {
+                        // on FAT: only 8 characters allowed before dot
+                        if (*pSource == '.')
+                        {
+                            lDotOfs = ul;
+                            lAfterDot = 0;
+                            if (ul > 7)
+                                return (ERROR_FILENAME_EXCED_RANGE);
+                        }
+                    }
+                    // and check for invalid characters
+                    if (strchr(pszInvalid, *pSource) != NULL)
+                        return (ERROR_INVALID_NAME);
+
+                    pSource++;
+
+                    // on FAT, allow only three chars after dot
+                    if (fIsFAT)
+                        if (lAfterDot != -1)
+                        {
+                            lAfterDot++;
+                            if (lAfterDot > 3)
+                                return (ERROR_FILENAME_EXCED_RANGE);
+                        }
+                }
+
+                // we are still missing the case of a FAT file
+                // name without extension; if so, check whether
+                // the file stem is <= 8 chars
                 if (fIsFAT)
-                {
-                    // on FAT: only 8 characters allowed before dot
-                    if (*pSource == '.')
-                    {
-                        lDotOfs = ul;
-                        lAfterDot = 0;
-                        if (ul > 7)
+                    if (lDotOfs == -1)  // dot not found:
+                        if (cbFile > 8)
                             return (ERROR_FILENAME_EXCED_RANGE);
-                    }
-                }
-                // and check for invalid characters
-                if (strchr(pszInvalid, *pSource) != NULL)
-                    return (ERROR_INVALID_NAME);
-
-                pSource++;
-
-                // on FAT, allow only three chars after dot
-                if (fIsFAT)
-                    if (lAfterDot != -1)
-                    {
-                        lAfterDot++;
-                        if (lAfterDot > 3)
-                            return(ERROR_FILENAME_EXCED_RANGE);
-                    }
             }
 
-            // we are still missing the case of a FAT file
-            // name without extension; if so, check whether
-            // the file stem is <= 8 chars
-            if (fIsFAT)
-                if (lDotOfs == -1)  // dot not found:
-                    if (cbFile > 8)
-                        return (ERROR_FILENAME_EXCED_RANGE);
-        }
-
-        // go for next component
-        p1 = p2+1;
-    } while (*p2);
-
-    return (NO_ERROR);
+            // go for next component
+            p1 = p2+1;
+        } while (*p2);
+    }
+
+    return (arc);
 }
 
@@ -340 +349 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Environment helpers                                            *
- *                                                                  *
+ *
+ *   Environment helpers
+ *
  ********************************************************************/
 
@@ -716 +725 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Module handling helpers                                        *
- *                                                                  *
+ *
+ *   Module handling helpers
+ *
  ********************************************************************/
 
@@ -773 +782 @@
 
 /********************************************************************
- *                                                                  *
- *   Executable functions                                           *
- *                                                                  *
+ *
+ *   Executable functions
+ *
  ********************************************************************/
 
@@ -1219 +1228 @@
 
 /********************************************************************
- *                                                                  *
- *   Partition functions                                            *
- *                                                                  *
+ *
+ *   Partition functions
+ *
  ********************************************************************/
 

trunk/src/helpers/eah.c

@@ -67 +67 @@
  *      Copyright (C) 1995 Massachusetts Institute of Technology.
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -83 +83 @@
     // as unsigned char
 
-#define INCL_DOS
+#define INCL_DOSFILEMGR
 #define INCL_DOSERRORS
 #include <os2.h>
@@ -101 +101 @@
 
 /********************************************************************
- *                                                                  *
- *   Extended Attribute handling                                    *
- *                                                                  *
+ *
+ *   Extended Attribute handling
+ *
  ********************************************************************/
 
@@ -173 +173 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Read-EA functions                                              *
- *                                                                  *
+ *
+ *   Read-EA functions
+ *
  ********************************************************************/
 
@@ -196 +196 @@
  */
 
-ULONG eaPathQueryTotalSize(PSZ pszPath)
+ULONG eaPathQueryTotalSize(const char *pcszPath)
 {
     APIRET  arc;
@@ -202 +202 @@
     FILEFINDBUF4   ffb4;
 
-    _Pmpf(("eaPathQueryTotalSize %s", pszPath));
-
-    arc = DosQueryPathInfo(pszPath,
+    arc = DosQueryPathInfo((PSZ)pcszPath,
                            FIL_QUERYEASIZE,
                            &ffb4,
@@ -220 +218 @@
 
         arc = DosEnumAttribute(ENUMEA_REFTYPE_PATH,
-                               pszPath,
+                               (PSZ)pcszPath,
                                1,
                                abBuf,
@@ -230 +228 @@
         pdena2 = (PDENA2)abBuf;
 
-        _Pmpf(("  %s: arc = %d, count = %d", pszPath, arc, lCount));
-
         if (lCount > 0)
         {
@@ -247 +243 @@
     }
 
-    _Pmpf(("    %s: total %d", pszPath, ulTotalEASize));
-
     return (ulTotalEASize);
 }
@@ -259 +253 @@
  */
 
-PEALIST eaPathReadAll(PSZ path)
-{
-    return (ReadEAList(ENUMEA_REFTYPE_PATH, path));
+PEALIST eaPathReadAll(const char *pcszPath)
+{
+    return (ReadEAList(ENUMEA_REFTYPE_PATH, (PSZ)pcszPath));
 }
 
@@ -283 +277 @@
  */
 
-PEABINDING eaPathReadOneByIndex(PSZ path, ULONG index)
-{
-    return (ReadEAByIndex(ENUMEA_REFTYPE_PATH, path, index));
+PEABINDING eaPathReadOneByIndex(const char *pcszPath, ULONG index)
+{
+    return (ReadEAByIndex(ENUMEA_REFTYPE_PATH, (PSZ)pcszPath, index));
 }
 
@@ -305 +299 @@
  */
 
-PEABINDING eaPathReadOneByName(PSZ path, PSZ name)
-{
-    return (ReadEAByName(ENUMEA_REFTYPE_PATH, path, name));
+PEABINDING eaPathReadOneByName(const char *pcszPath, const char *pcszEAName)
+{
+    return (ReadEAByName(ENUMEA_REFTYPE_PATH, (PSZ)pcszPath, (PSZ)pcszEAName));
 }
 
@@ -315 +309 @@
  */
 
-PEABINDING eaHFileReadOneByName(HFILE hfile, PSZ name)
-{
-    return (ReadEAByName(ENUMEA_REFTYPE_FHANDLE, (&hfile), name));
+PEABINDING eaHFileReadOneByName(HFILE hfile, const char *pcszEAName)
+{
+    return (ReadEAByName(ENUMEA_REFTYPE_FHANDLE, (&hfile), (PSZ)pcszEAName));
 }
 
 /* ******************************************************************
- *                                                                  *
- *   Write-EA functions                                             *
- *                                                                  *
+ *
+ *   Write-EA functions
+ *
  ********************************************************************/
 
@@ -335 +329 @@
  *      field is 0; only in that case, the EABINDING.value
  *      field may also be NULL.
- */
-
-void eaPathWriteAll(PSZ path, PEALIST list)
-{
-    WriteEAList(ENUMEA_REFTYPE_PATH, path, list);
+ *
+ *@@changed V0.9.7 (2000-11-30) [umoeller]: now returning APIRET
+ */
+
+APIRET eaPathWriteAll(const char *pcszPath, PEALIST list)
+{
+    return (WriteEAList(ENUMEA_REFTYPE_PATH, (PSZ)pcszPath, list));
 }
 
@@ -345 +341 @@
  *@@ eaHFileWriteAll:
  *      like eaPathWriteAll, but for an open file handle.
- */
-
-void eaHFileWriteAll(HFILE hfile, PEALIST list)
-{
-    WriteEAList(ENUMEA_REFTYPE_FHANDLE, (&hfile), list);
+ *
+ *@@changed V0.9.7 (2000-11-30) [umoeller]: now returning APIRET
+ */
+
+APIRET eaHFileWriteAll(HFILE hfile, PEALIST list)
+{
+    return (WriteEAList(ENUMEA_REFTYPE_FHANDLE, (&hfile), list));
 }
 
@@ -362 +360 @@
  *
  *      To delete an EA, you may also use eaPathDeleteOne.
- */
-
-void eaPathWriteOne(PSZ path, PEABINDING peab)
-{
-    WriteEA(ENUMEA_REFTYPE_PATH, path, peab);
+ *
+ *@@changed V0.9.7 (2000-11-30) [umoeller]: now returning APIRET
+ */
+
+APIRET eaPathWriteOne(const char *pcszPath, PEABINDING peab)
+{
+    return (WriteEA(ENUMEA_REFTYPE_PATH, (PSZ)pcszPath, peab));
 }
 
@@ -372 +372 @@
  *@@ eaHFileWriteOne:
  *      like eaPathWriteOne, but for an open file handle.
- */
-
-void eaHFileWriteOne(HFILE hfile, PEABINDING peab)
-{
-    WriteEA(ENUMEA_REFTYPE_FHANDLE, (&hfile), peab);
+ *
+ *@@changed V0.9.7 (2000-11-30) [umoeller]: now returning APIRET
+ */
+
+APIRET eaHFileWriteOne(HFILE hfile, PEABINDING peab)
+{
+    return (WriteEA(ENUMEA_REFTYPE_FHANDLE, (&hfile), peab));
 }
 
@@ -386 +388 @@
  *
  *@@added V0.9.0 [umoeller]
- */
-
-void eaPathDeleteOne(PSZ path, PSZ pszEAName)
+ *@@changed V0.9.7 (2000-11-30) [umoeller]: now returning APIRET
+ */
+
+APIRET eaPathDeleteOne(const char *pcszPath, const char *pcszEAName)
 {
     EABINDING eab;
     eab.bFlags = 0;
-    eab.bNameLength = strlen(pszEAName);
-    eab.pszName = pszEAName;
+    eab.bNameLength = strlen(pcszEAName);
+    eab.pszName = (PSZ)pcszEAName;
     eab.usValueLength = 0;
     eab.pszValue = 0;
-    eaPathWriteOne(path, &eab);
+    return (eaPathWriteOne(pcszPath, &eab));
 }
 
@@ -404 +407 @@
 
 /********************************************************************
- *                                                                  *
- *   Translation funcs                                              *
- *                                                                  *
+ *
+ *   Translation funcs
+ *
  ********************************************************************/
 
@@ -484 +487 @@
  */
 
-PEABINDING eaCreateBindingFromPSZ(PSZ pszEAName,     // in: EA name (e.g. ".LONGNAME")
-                                  PSZ pszString)     // in: string for EAT_ASCII EA
+PEABINDING eaCreateBindingFromPSZ(const char *pcszEAName, // in: EA name (e.g. ".LONGNAME")
+                                  const char *pcszInput)  // in: string for EAT_ASCII EA
 {
     PEABINDING peab = (PEABINDING)malloc(sizeof(EABINDING));
@@ -491 +494 @@
     {
         SHORT cbString = 0;
-        if (pszString)
-            cbString = strlen(pszString);
+        if (pcszInput)
+            cbString = strlen(pcszInput);
 
         peab->bFlags = 0;
-        peab->bNameLength = strlen(pszEAName);
-        peab->pszName = strdup(pszEAName);
+        peab->bNameLength = strlen(pcszEAName);
+        peab->pszName = strdup(pcszEAName);
 
         if (cbString)
@@ -510 +513 @@
                 *((PUSHORT)(peab->pszValue + 2)) = cbString;
                 // copy string to byte 4 (no null-terminator)
-                memcpy(peab->pszValue + 4, pszString, cbString);
+                memcpy(peab->pszValue + 4, pcszInput, cbString);
             }
             else
@@ -743 +746 @@
 
 PSZ eaCreatePSZFromMVBinding(PEABINDING peab,       // in: EAT_MVMT binding
-                             PSZ     pszSeparator,  // in: null-terminated string used as separator
+                             const char *pcszSeparator,  // in: null-terminated string used as separator
                              PUSHORT pusCodepage)   // out: codepage found in binding (ptr can be NULL)
 {
@@ -765 +768 @@
             USHORT  us = 0;
             USHORT  cbComment = 0;
-            USHORT  cbSeparator = strlen(pszSeparator);
+            USHORT  cbSeparator = strlen(pcszSeparator);
             while (us < usMVCount)
             {
@@ -794 +797 @@
                             // append separator
                             memcpy(pszTotal + cbCommentOld,
-                                   pszSeparator,
+                                   pcszSeparator,
                                    cbSeparator);
                             // copy the rest after the separator (below)
@@ -846 +849 @@
  */
 
-PEABINDING eaCreateMVBindingFromPSZ(PSZ pszEAName,      // in: EA name (e.g. ".KEYPHRASES")
-                                    PSZ pszInput,       // in: string to parse
-                                    PSZ pszSeparator,   // in: separator used in pszInput
+PEABINDING eaCreateMVBindingFromPSZ(const char *pcszEAName,      // in: EA name (e.g. ".KEYPHRASES")
+                                    const char *pcszInput,       // in: string to parse
+                                    const char *pcszSeparator,   // in: separator used in pszInput
                                     USHORT usCodepage)  // in: codepage to set in EAT_MVMT
 {
     PEABINDING peab;
-    if (pszInput)
+    if (pcszInput)
     {
         peab = (PEABINDING)malloc(sizeof(EABINDING));
         if (peab)
         {
-            PSZ     p = pszInput,
-                    pSource,
-                    pTarget;
-            USHORT  cbInput = strlen(pszInput),
-                    cbSep = strlen(pszSeparator),
+            const char *p = pcszInput,
+                    *pSource;
+            PSZ     pTarget;
+            USHORT  cbInput = strlen(pcszInput),
+                    cbSep = strlen(pcszSeparator),
                     usSepCount = 0,
                     cbToAlloc = 0,
@@ -868 +871 @@
 
             peab->bFlags = 0;
-            peab->bNameLength = strlen(pszEAName);
-            peab->pszName = strdup(pszEAName);
+            peab->bNameLength = strlen(pcszEAName);
+            peab->pszName = strdup(pcszEAName);
 
             // now count the number of pszSeparators in pszInput
-            while ((p = strstr(p, pszSeparator)))
+            while ((p = strstr(p, pcszSeparator)))
             {
                 usSepCount++;
@@ -898 +901 @@
 
             // set pointer to first field
-            pSource = pszInput;
+            pSource = pcszInput;
             pTarget = peab->pszValue + 6;
 
@@ -907 +910 @@
             {
                 // find the next separator
-                PSZ     pNextSep = strstr(pSource, pszSeparator);
+                PSZ     pNextSep = strstr(pSource, pcszSeparator);
                 // calculate the length of the substring
                 cbThis = pNextSep - pSource;
@@ -934 +937 @@
 
 /********************************************************************
- *                                                                  *
- *   EA helper funcs                                                *
- *                                                                  *
+ *
+ *   EA helper funcs
+ *
  ********************************************************************/
 
@@ -1217 +1220 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Direct plain-string EA handling                                *
- *                                                                  *
+ *
+ *   Direct plain-string EA handling
+ *
  ********************************************************************/
 

trunk/src/helpers/except.c

@@ -3 +3 @@
  *@@sourcefile except.c:
  *      this file contains powerful exception handlers.
+ *      except.h also defines easy-to-use macros for them.
  *
  *      Usage: All OS/2 programs, PM or text mode.
  *
- *      <B>except.h macros</B>
- *
- *      except.h declares a few handy macros to easily install
- *      exception handling for a section of code.
- *
- *      These macros automatically insert code for properly
- *      registering and deregistering the handlers. You should
- *      ALWAYS use these macros instead of directly registering
+ *      <B>Introduction</B>
+ *
+ *      OS/2 exception handlers are a mess to program and,
+ *      if installed wrongly, almost impossible to debug.
+ *      The problem is that for any program that does a bit
+ *      more than showing a message box, using exception
+ *      handlers is a must to avoid system hangs. This
+ *      especially applies to multi-thread programs using
+ *      mutex semaphores (more on that below). The functions
+ *      and macros in here are designed to make that more simple.
+ *
+ *      The macros in except.h automatically insert code for properly
+ *      registering and deregistering the handlers in except.c. You
+ *      should ALWAYS use these macros instead of directly registering
  *      the handlers to avoid accidentally forgetting to deregister
  *      them. If you forget to deregister an exception handler, this
@@ -20 +27 @@
  *      might get completely messed up.
  *
- *      The general idea of these macros is to define
- *      TRY / CATCH blocks similar to C++. If an exception
- *      occurs in the TRY block, execution is transferred
- *      to the CATCH block. (This works in both C and C++,
- *      by the way.)
- *
- *      In addition, with the TRY statement, you may specify
- *      an optional "OnKill" function which gets called if
- *      the thread gets killed while code in the TRY block is
- *      executed (new with V0.9.0). If you need no such
- *      function, specify NULL. Details follow.
+ *      The general idea of these macros is to define TRY / CATCH
+ *      blocks similar to C++. If an exception occurs in the TRY block,
+ *      execution is transferred to the CATCH block. (This works in both
+ *      C and C++, by the way.)
+ *
+ *      The "OnKill" function that was added with V0.9.0 has been
+ *      removed again with V0.9.7. Use DosEnterMustComplete instead.
+ *      Details follow.
  *
  *      The general usage is like this:
@@ -36 +40 @@
  +          int your_protected_func(int ...)
  +          {
- +              TRY_LOUD(excptid, OnKillFunc)
- +              // or: TRY_QUIET(excptid, OnKillFunc)
- +              // OnKillFunc can be NULL
+ +              TRY_LOUD(excptid)         // or: TRY_QUIET(excptid)
  +              {
  +                  ....        // the stuff in here is protected by
@@ -50 +52 @@
  +          } // end of your_func
  *
- *      TRY_LOUD  is for excHandlerLoud (see below).
- *      TRY_QUIET is for excHandlerQuiet (see below).
+ *      TRY_LOUD  is for installing excHandlerLoud.
+ *      TRY_QUIET is for installing excHandlerQuiet.
  *      CATCH / END_CATCH are the same for the two. This
  *      is where the exception handler jumps to if an
@@ -58 +60 @@
  *      in there.
  *
- *      "excptid" can be any identifier which is not used in
+ *      "excptid" can be any C identifier which is not used in
  *      your current variable scope, e.g. "excpt1". This
  *      is used for creating an EXCEPTSTRUCT variable of
@@ -65 +67 @@
  *      store the exception handler data.
  *
- *      It is possible to nest these handlers though. You
- *      must use different "excptid"'s only if more than one
- *      TRY_* block exists in the same variable scope. Avoid
- *      using gotos to jump between the different CATCH blocks,
- *      because this might not properly deregister the handlers.
+ *      These macros may be nested if you use different
+ *      "excptid"'s for sub-macros.
+ *
+ *      Inside the TRY and CATCH blocks, you must not use
+ *      "goto" (to a location outside the block) or "return",
+ *      because this will not deregister the handler.
  *
  *      Keep in mind that all the code in the TRY_* block is
@@ -76 +79 @@
  *      TRY_* block, your entire application is protected.
  *
- *      Your "OnKillFunc" must be declared as
- +          VOID APIENTRY YourOnKillFunc(VOID) {...}.
- *      This gets called when the thread gets terminated
- *      while being executed in the TRY block (that is,
- *      if either the thread gets killed explicitly or
- *      the entire process ends for some reason). After
- *      that function got executed, the thread will _always_
- *      be terminated; the CATCH block will not be executed
- *      then. You can specify NULL for the "OnKillFunc", if
- *      you don't need one.
- *
- *      To summarize: If an exception occurs in the TRY
- *      block,
- *
- *      a) "OnKillFunc" gets called if the thread got
- *         killed, and the thread then terminates;
- *
- *      b) the CATCH block is executed for other exceptions
- *         and execution continues.
+ *      <B>Asynchronous exceptions</B>
+ *
+ *      The exception handlers in this file (which are installed
+ *      with the TRY/CATCH mechanism) only intercept synchronous
+ *      exceptions (see excHandlerLoud for a list). They do not
+ *      protect your code against asynchronous exceptions.
+ *
+ *      OS/2 defines asynchronous exceptions to be those that
+ *      can be delayed. With OS/2, there are only three of these:
+ *
+ *      -- XCPT_PROCESS_TERMINATE
+ *      -- XCPT_ASYNC_PROCESS_TERMINATE
+ *      -- XCPT_SIGNAL (thread 1 only)
+ *
+ *      To protect yourself against these also, put the section
+ *      in question in a DosEnterMustComplete/DosExitMustComplete
+ *      block as well.
  *
  *      <B>Mutex semaphores</B>
  *
- *      Here's how to deal with mutex semaphores: WHENEVER
- *      you request a mutex semaphore, enclose the block
- *      with TRY/CATCH in case an error occurs, like this:
+ *      The problem with OS/2 mutex semaphores is that they are
+ *      not automatically released when a thread terminates.
+ *      If the thread owning the mutex died without releasing
+ *      the mutex, other threads which are blocked on that mutex
+ *      will wait forever and become zombie threads. Even worse,
+ *      if this happens to a PM thread, this will hang the system.
+ *
+ *      Here's the typical scenario with two threads:
+ *
+ *      1)  Thread 2 requests a mutex and does lots of processing.
+ *
+ *      2)  Thread 1 requests the mutex. Since it's still owned
+ *          by thread 2, thread 1 blocks.
+ *
+ *      3)  Thread 2 crashes in its processing. Without an
+ *          exception handler, OS/2 will terminate the process.
+ *          It will first kill thread 2 and then attempt to
+ *          kill thread 1. This fails because it is still
+ *          blocking on the semaphore that thread 2 never
+ *          released. Boom.
+ *
+ *      The same scenario happens when a process gets killed.
+ *      Since OS/2 will kill secondary threads before thread 1,
+ *      the same situation can arise.
+ *
+ *      As a result, you must protect any section of code which
+ *      requests a semaphore _both_ against crashes _and_
+ *      termination.
+ *
+ *      So _whenever_ you request a mutex semaphore, enclose
+ *      the block with TRY/CATCH in case the code crashes.
+ *      Besides, enclose the TRY/CATCH block in a must-complete
+ *      section, like this:
  *
  +          HMTX hmtx = ...
- +
- +          VOID APIENTRY OnKillYourFunc(VOID)
- +          {
- +              DosReleaseMutexSem(hmtx);
- +          }
  +
  +          int your_func(int)
  +          {
- +              BOOL fSemOwned = FALSE;
+ +              BOOL    fSemOwned = FALSE;
+ +              ULONG   ulNesting = 0;
+ +
+ +              DosEnterMustComplete(&ulNesting);
  +              TRY_QUIET(excpt1, OnKillYourFunc) // or TRY_LOUD
  +              {
@@ -126 +155 @@
  +                  fSemOwned = FALSE;
  +              }
+ +              DosExitMustComplete(&ulNesting);
  +          } // end of your_func
  *
- *      This way your mutex semaphore gets released even if
- *      exceptions occur in your code. If you don't do this,
- *      threads waiting for that semaphore will be blocked
- *      forever when exceptions occur. As a result, depending
- *      on the thread, PM will hang, or the application will
- *      never terminate.
+ *      This way your mutex semaphore gets released in every
+ *      possible condition.
  *
  *      <B>Customizing</B>
  *
- *      Note: As opposed to versions < 0.9.0, this is now
+ *      As opposed to versions before 0.9.0, this code is now
  *      completely independent of XWorkplace. This file now
  *      contains "pure" exception handlers only.
@@ -146 +172 @@
  *      If excRegisterHooks is not called, the following safe
  *      defaults are used:
+ *
  *          --  the trap log file is TRAP.LOG in the root
  *              directory of your boot drive.
@@ -182 +209 @@
  *                                      John Currier,
  *                                      Anthony Cruise.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -223 +250 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Global variables                                               *
- *                                                                  *
+ *
+ *   Global variables
+ *
  ********************************************************************/
 
@@ -240 +267 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Exception helper routines                                      *
- *                                                                  *
+ *
+ *   Exception helper routines
+ *
  ********************************************************************/
 
@@ -490 +517 @@
         case XCPT_ACCESS_VIOLATION:
         {
-            fprintf(file, "\nAccess violation: ");
+            fprintf(file, "\nXCPT_ACCESS_VIOLATION: ");
             if (pReportRec->ExceptionInfo[0] & XCPT_READ_ACCESS)
                 fprintf(file, "Invalid read access from 0x%04lX:%08lX.\n",
@@ -516 +543 @@
         case XCPT_INTEGER_DIVIDE_BY_ZERO:
         {
-            fprintf(file, "\nInteger division by zero.\n");
+            fprintf(file, "\nXCPT_INTEGER_DIVIDE_BY_ZERO.\n");
             fprintf(file,
                     "Explanation: An attempt was made to divide an integer value by zero,\n"
@@ -525 +552 @@
         case XCPT_ILLEGAL_INSTRUCTION:
         {
-            fprintf(file, "\nIllegal instruction found.\n");
+            fprintf(file, "\nXCPT_ILLEGAL_INSTRUCTION.\n");
             fprintf(file,
                     "Explanation: An attempt was made to execute an instruction that\n"
@@ -534 +561 @@
         case XCPT_PRIVILEGED_INSTRUCTION:
         {
-            fprintf(file, "\nPrivileged instruction found.\n");
+            fprintf(file, "\nXCPT_PRIVILEGED_INSTRUCTION.\n");
             fprintf(file,
                     "Explanation: An attempt was made to execute an instruction that\n"
@@ -543 +570 @@
 
         case XCPT_INTEGER_OVERFLOW:
-            fprintf(file, "\nInteger overflow.\n");
+            fprintf(file, "\nXCPT_INTEGER_OVERFLOW.\n");
             fprintf(file,
                     "Explanation: An integer operation generated a carry-out of the most\n"
                     "             significant bit. This is a sign of an attempt to store\n"
                     "             a value which does not fit into an integer variable.\n");
+
+        default:
+            fprintf(file, "\nUnknown OS/2 exception number %d.\n", pReportRec->ExceptionNum);
+            fprintf(file, "Look this up in the OS/2 header files.\n");
     }
 
@@ -700 +731 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Exported routines                                              *
- *                                                                  *
+ *
+ *   Exported routines
+ *
  ********************************************************************/
 
@@ -722 +753 @@
  *      The hooks are as follows:
  *
- *      pfnExcOpenFileNew gets called to open
+ *      --  pfnExcOpenFileNew gets called to open
  *          the trap log file. This must return a FILE*
  *          pointer from fopen(). If this is not defined,
@@ -729 +760 @@
  *          into it before the actual exception info.
  *
- *      pfnExcHookNew gets called while the trap log
+ *      --  pfnExcHookNew gets called while the trap log
  *          is being written. At this point,
  *          the following info has been written into
@@ -743 +774 @@
  *          Use this hook to write additional application
  *          info into the trap log, such as the state
- *          of your threads.
- *
- *      pfnExcHookError gets called when the TRY_* macros
+ *          of your own threads and mutexes.
+ *
+ *      --  pfnExcHookError gets called when the TRY_* macros
  *          fail to install an exception handler (when
- *          DosSetExceptionHandler fails).
+ *          DosSetExceptionHandler fails). I've never seen
+ *          this happen.
  *
  *@@added V0.9.0 [umoeller]
@@ -772 +804 @@
  *      to the thread to continue execution, i.e. the
  *      default OS/2 exception handler will never get
- *      called. This requires a setjmp() call on
+ *      called.
+ *
+ *      This requires a setjmp() call on
  *      EXCEPTIONREGISTRATIONRECORD2.jmpThread before
- *      being installed.
- *
- *      This is best registered thru the TRY_LOUD macro
- *      (new with V0.84, described in except.c), which
- *      does the necessary setup.
- *
- *      Depending on the type of exception, the following
- *      happens:
- *
- *      <B>a) "real" exceptions</B>
+ *      being installed. The TRY_LOUD macro will take
+ *      care of this for you (see except.c).
+ *
+ *      This intercepts the following exceptions (see
+ *      the OS/2 Control Program Reference for details):
  *
  *      --  XCPT_ACCESS_VIOLATION         (traps 0x0d, 0x0e)
@@ -795 +824 @@
  *      what source code corresponds to the error.
  *
+ *      See excRegisterHooks for the default setup of this.
+ *
  *      Note that to get meaningful debugging information
  *      in this handler's traplog, you need the following:
+ *
  *      a)  have a MAP file created at link time (/MAP)
+ *
  *      b)  convert the MAP to a SYM file using MAPSYM
+ *
  *      c)  put the SYM file in the same directory of
- *          the executable. This must have the same
- *          filestem as the executable.
- *
- *      See the "Control Programming Guide and Reference"
- *      for details.
+ *          the module (EXE or DLL). This must have the
+ *          same filestem as the module.
+ *
  *      All other exceptions are passed to the next handler
  *      in the exception handler chain. This might be the
  *      C/C++ compiler handler or the default OS/2 handler,
  *      which will probably terminate the process.
- *
- *      <B>b) thread kills</B>
- *
- *      -- XCPT_PROCESS_TERMINATE
- *      -- XCPT_ASYNC_PROCESS_TERMINATE:
- *
- *      If EXCEPTIONREGISTRATIONRECORD2.pfnOnKill is != NULL,
- *      that function gets called to allow for thread cleanup
- *      before the thread really terminates. This should be
- *      used for releasing mutex semaphores.
  *
  *@@changed V0.9.0 [umoeller]: added support for thread termination
@@ -852 +874 @@
     switch (pReportRec->ExceptionNum)
     {
-        case XCPT_PROCESS_TERMINATE:
+        /* case XCPT_PROCESS_TERMINATE:
         case XCPT_ASYNC_PROCESS_TERMINATE:
             // thread terminated:
@@ -859 +881 @@
             if (pRegRec2->pfnOnKill)
                 // call the "OnKill" function
-                pRegRec2->pfnOnKill();
+                pRegRec2->pfnOnKill(pRegRec2);
             // get outta here, which will kill the thread
-        break;
+        break; */
 
         case XCPT_ACCESS_VIOLATION:
@@ -867 +889 @@
         case XCPT_ILLEGAL_INSTRUCTION:
         case XCPT_PRIVILEGED_INSTRUCTION:
+        case XCPT_INVALID_LOCK_SEQUENCE:
         case XCPT_INTEGER_OVERFLOW:
         {
@@ -924 +947 @@
  *      this is useful for certain error-prone functions, where
  *      exceptions are likely to appear, for example used by
- *      cmnCheckObject to implement a fail-safe SOM object check.
+ *      wpshCheckObject to implement a fail-safe SOM object check.
  *
  *      This does _not_ write an error log and makes _no_ sound.
@@ -953 +976 @@
     switch (pReportRec->ExceptionNum)
     {
-        case XCPT_PROCESS_TERMINATE:
+        /* case XCPT_PROCESS_TERMINATE:
         case XCPT_ASYNC_PROCESS_TERMINATE:
             // thread terminated:
@@ -960 +983 @@
             if (pRegRec2->pfnOnKill)
                 // call the "OnKill" function
-                pRegRec2->pfnOnKill();
+                pRegRec2->pfnOnKill(pRegRec2);
             // get outta here, which will kill the thread
-        break;
+        break; */
 
         case XCPT_ACCESS_VIOLATION:
@@ -968 +991 @@
         case XCPT_ILLEGAL_INSTRUCTION:
         case XCPT_PRIVILEGED_INSTRUCTION:
+        case XCPT_INVALID_LOCK_SEQUENCE:
         case XCPT_INTEGER_OVERFLOW:
             // write excpt explanation only if the
-            // resp. debugging #define is set (common.h)
+            // resp. debugging #define is set (setup.h)
             #ifdef DEBUG_WRITEQUIETEXCPT
             {

trunk/src/helpers/gpih.c

@@ -6 +6 @@
  *      Usage: All PM programs.
  *
- *      A word about GPI rectangles: In general, graphics operations involving
- *      device coordinates (such as regions, bit maps and bit blts, and window
- *      management) use inclusive-exclusive rectangles.  All other graphics
- *      operations, such as GPI functions that define paths, use inclusive-inclusive
- *      rectangles.
+ *      A word about GPI rectangles: In general, graphics operations
+ *      involving device coordinates (such as regions, bit maps and
+ *      bit blts, and window management) use inclusive-exclusive
+ *      rectangles.  All other graphics operations, such as GPI
+ *      functions that define paths, use inclusive-inclusive rectangles.
+ *
+ *      This can be a problem with mixing Win and Gpi functions. For
+ *      example, WinQueryWindowRect returns an inclusive-exclusive
+ *      rectangle (so that the xRight value is the same as the window
+ *      width). However, GpiBox expects an inclusive-inclusive rectangle.
  *
  *      Function prefixes (new with V0.81):
@@ -23 +28 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -39 +44 @@
     // as unsigned char
 
-#define INCL_DOSDEVIOCTL
-#define INCL_DOS
 #define INCL_DOSERRORS
-#define INCL_WIN
-#define INCL_GPI
+
+#define INCL_WINWINDOWMGR
+#define INCL_WINPOINTERS
+#define INCL_WINSYS
+
+#define INCL_GPIPRIMITIVES
+#define INCL_GPIBITMAPS
+#define INCL_GPILOGCOLORTABLE
+#define INCL_GPILCIDS
 #include <os2.h>
 
@@ -68 +78 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Device helpers                                                 *
- *                                                                  *
+ *
+ *   Device helpers
+ *
  ********************************************************************/
 
@@ -100 +110 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Color helpers                                                  *
- *                                                                  *
+ *
+ *   Color helpers
+ *
  ********************************************************************/
 
@@ -139 +149 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Drawing primitives helpers                                     *
- *                                                                  *
+ *
+ *   Drawing primitives helpers
+ *
  ********************************************************************/
 
@@ -187 +197 @@
  *      the top right point lies _outside_ the rectangle
  *      which is actually drawn. This is the same as with
- *      WinFillRect.
+ *      WinFillRect. ### I don't think so any more... GpiBox
+ *      uses inclusive-inclusive rectangles...
  *
  *      Changes to the HPS:
@@ -252 +263 @@
     GpiMove(hps, &ptlSave);
     GpiSetColor(hps, lColorSave);
+}
+
+/*
+ *@@ gpihThickBox:
+ *      draws a box from the specified rectangle with the
+ *      specified width.
+ *
+ *      The specified rectangle is inclusive, that is, the top
+ *      right corner specifies the top right pixel to be drawn.
+ *
+ *      If usWidth > 1, the additional pixels will be drawn towards
+ *      the _center_ of the rectangle. prcl thus always specifies
+ *      the bottom left and top right pixels to be drawn.
+ *
+ *      This is different from using GpiSetLineWidth, with which
+ *      I was unable to find out in which direction lines are
+ *      extended.
+ *
+ *      This is similar to gpihDraw3DFrame, except that everything
+ *      is painted in the current color.
+ *
+ *@@added V0.9.7 (2000-12-06) [umoeller]
+ */
+
+VOID gpihDrawThickFrame(HPS hps,              // in: presentation space for output
+                        PRECTL prcl,          // in: rectangle to draw (exclusive)
+                        ULONG ulWidth)       // in: line width (>= 1)
+{
+    ULONG ul = 0;
+    for (;
+         ul < ulWidth;
+         ul++)
+    {
+        GpiMove(hps, (PPOINTL)prcl);
+        GpiBox(hps,
+               DRO_OUTLINE,
+               (PPOINTL)&(prcl->xRight),
+               0,
+               0);
+
+        // and one more to the outside
+        prcl->xLeft++;
+        prcl->yBottom++;
+        prcl->xRight--;
+        prcl->yTop--;
+    }
 }
 
@@ -355 +412 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Font helpers                                                   *
- *                                                                  *
+ *
+ *   Font helpers
+ *
  ********************************************************************/
 
@@ -1030 +1087 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Bitmap helpers                                                 *
- *                                                                  *
+ *
+ *   Bitmap helpers
+ *
  ********************************************************************/
 

trunk/src/helpers/helpers_post.in

@@ -153 +153 @@
                $(PROJECTINC)\setup.h
 
+$(OUTPUTDIR)\timer.obj:   $(@B).c $(HLPINC)\$(@B).h \
+               $(HLPINC)\datetime.h $(HLPINC)\except.h $(HLPINC)\linklist.h $(HLPINC)\threads.h \
+               $(PROJECTINC)\setup.h
+
 $(OUTPUTDIR)\tmsgfile.obj:  $(@B).c $(HLPINC)\$(@B).h \
                $(PROJECTINC)\setup.h \

trunk/src/helpers/helpers_pre.in

@@ -80 +80 @@
 $(OUTPUTDIR)\textview.obj \
 $(OUTPUTDIR)\textv_html.obj \
+$(OUTPUTDIR)\timer.obj \
 $(OUTPUTDIR)\winh.obj
 

trunk/src/helpers/level.c

@@ -16 +16 @@
  *      Copyright (C) 1994 Martin Lafaix (EDM/2 2-05).
  *      Copyright (C) 2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -33 +33 @@
 
 #define INCL_DOSFILEMGR
-#define INCL_NOPMAPI
 #include <os2.h>
 
@@ -54 +53 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Interface                                                      *
- *                                                                  *
+ *
+ *   Interface
+ *
  ********************************************************************/
 
@@ -473 +472 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Local helper functions                                         *
- *                                                                  *
+ *
+ *   Local helper functions
+ *
  ********************************************************************/
 

trunk/src/helpers/linklist.c

@@ -57 +57 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -82 +82 @@
 
 /* ******************************************************************
- *                                                                  *
- *   List base functions                                            *
- *                                                                  *
+ *
+ *   List base functions
+ *
  ********************************************************************/
+
+/*
+ *@@ lstMalloc:
+ *      wrapper around malloc() to make sure memory is
+ *      allocated from the C runtime the helpers were
+ *      compiled with. This is useful for auto-free
+ *      lists.
+ *
+ *@@added V0.9.7 (2000-12-07) [umoeller]
+ */
+
+void* lstMalloc(size_t size)
+{
+    return (malloc(size));
+}
+
+/*
+ *@@ lstStrDup:
+ *      wrapper around strdup() to make sure memory is
+ *      allocated from the C runtime the helpers were
+ *      compiled with. This is useful for auto-free
+ *      lists.
+ *
+ *@@added V0.9.7 (2000-12-07) [umoeller]
+ */
+
+void* lstStrDup(const char *pcsz)
+{
+    return (strdup(pcsz));
+}
 
 /*
@@ -111 +141 @@
  *      you're storing other objects, such as numbers
  *      or other static items.
+ *
+ *      This of course will be a "flat" free(). If
+ *      you store structures in the list using other
+ *      heap pointers, auto-free would cause memory leaks.
+ *
+ *      Also, auto-free only works if the malloc() that
+ *      has been used on the list item is in the same C
+ *      runtime as with the linklist functions. If the
+ *      caller uses a different runtime (e.g. from a DLL),
+ *      it can use lstMalloc() for allocating the list
+ *      item and still use auto-free.
  *
  *      Note: You better call lstInit only once per list,
@@ -758 +799 @@
 
 /* ******************************************************************
- *                                                                  *
- *   List sorting                                                   *
- *                                                                  *
+ *
+ *   List sorting
+ *
  ********************************************************************/
 
@@ -933 +974 @@
 
 /* ******************************************************************
- *                                                                  *
- *   List pseudo-stacks                                             *
- *                                                                  *
+ *
+ *   List pseudo-stacks
+ *
  ********************************************************************/
 

trunk/src/helpers/memdebug.c

@@ -134 +134 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Global variables                                               *
- *                                                                  *
+ *
+ *   Global variables
+ *
  ********************************************************************/
 
@@ -156 +156 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Debug heap management                                          *
- *                                                                  *
+ *
+ *   Debug heap management
+ *
  ********************************************************************/
 
@@ -660 +660 @@
 
 /* ******************************************************************
- *                                                                  *
- *   XFolder debugging helpers                                      *
- *                                                                  *
+ *
+ *   XFolder debugging helpers
+ *
  ********************************************************************/
 

trunk/src/helpers/prfh.c

@@ -19 +19 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -35 +35 @@
     // as unsigned char
 
-#define INCL_DOS
 #define INCL_DOSERRORS
-#define INCL_WIN
+#define INCL_WINSHELLDATA
 #include <os2.h>
 
@@ -170 +169 @@
 
 PSZ prfhQueryProfileData(HINI hIni,      // in: INI handle (can be HINI_USER or HINI_SYSTEM)
-                        PSZ pszApp,      // in: application to query
-                        PSZ pszKey,      // in: key to query
-                        PULONG pcbBuf)   // out: size of the returned buffer
+                         PSZ pszApp,     // in: application to query
+                         PSZ pszKey,     // in: key to query
+                         PULONG pcbBuf)  // out: size of the returned buffer; ptr can be NULL
 {
     PSZ     pData = NULL;
@@ -238 +237 @@
  *      --  cDateSep = '/' (date separator);
  *      --  cTimeSep = ':' (time separator);
+ *      --  cDecimal = '.' (decimal separator).
  *      --  cThousands = ',' (thousands separator).
  *
  *@@added V0.9.0 [umoeller]
+ *@@changed V0.9.7 (2000-12-02) [umoeller]: added cDecimal
  */
 
@@ -247 +248 @@
     if (pcs)
     {
-        pcs->ulDateFormat = PrfQueryProfileInt(HINI_USER, "PM_National", "iDate", 0);
-        pcs->ulTimeFormat = PrfQueryProfileInt(HINI_USER, "PM_National", "iTime", 0);
-        pcs->cDateSep = prfhQueryProfileChar(HINI_USER, "PM_National", "sDate", '/');
-        pcs->cTimeSep = prfhQueryProfileChar(HINI_USER, "PM_National", "sTime", ':');
-        pcs->cThousands = prfhQueryProfileChar(HINI_USER, "PM_National", "sThousand", ',');
+        const char *pcszApp = "PM_National";
+        pcs->ulDateFormat = PrfQueryProfileInt(HINI_USER, (PSZ)pcszApp, "iDate", 0);
+        pcs->ulTimeFormat = PrfQueryProfileInt(HINI_USER, (PSZ)pcszApp, "iTime", 0);
+        pcs->cDateSep = prfhQueryProfileChar(HINI_USER, (PSZ)pcszApp, "sDate", '/');
+        pcs->cTimeSep = prfhQueryProfileChar(HINI_USER, (PSZ)pcszApp, "sTime", ':');
+        pcs->cDecimal = prfhQueryProfileChar(HINI_USER, (PSZ)pcszApp, "sDecimal", '.');
+        pcs->cThousands = prfhQueryProfileChar(HINI_USER, (PSZ)pcszApp, "sThousand", ',');
     }
 }

trunk/src/helpers/prfh2.c

@@ -24 +24 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -40 +40 @@
     // as unsigned char
 
-#define INCL_DOS
 #define INCL_DOSERRORS
-#define INCL_WIN
+#define INCL_WINSHELLDATA
 #include <os2.h>
 

trunk/src/helpers/procstat.c

@@ -34 +34 @@
  *      Copyright (C) 1992-1994 Kai Uwe Rommel.
  *      Copyright (C) 1998-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -50 +50 @@
     // as unsigned char
 
-#define INCL_DOS
+#define INCL_DOSMODULEMGR
 #define INCL_DOSERRORS
-#define INCL_DOSMODULEMGR
 #include <os2.h>
 
@@ -70 +69 @@
 
 /********************************************************************
- *                                                                  *
- *   DosQProcStat (16-bit) interface                                *
- *                                                                  *
+ *
+ *   DosQProcStat (16-bit) interface
+ *
  ********************************************************************/
 
@@ -196 +195 @@
 
 /********************************************************************
- *                                                                  *
- *   DosQProcStat (16-bit) helpers                                  *
- *                                                                  *
+ *
+ *   DosQProcStat (16-bit) helpers
+ *
  ********************************************************************/
 
@@ -439 +438 @@
 
 /********************************************************************
- *                                                                  *
- *   DosQuerySysState (32-bit) interface                            *
- *                                                                  *
+ *
+ *   DosQuerySysState (32-bit) interface
+ *
  ********************************************************************/
 

trunk/src/helpers/resh.c

@@ -34 +34 @@
     // as unsigned char
 
+#define INCL_DOSMODULEMGR
+#define INCL_DOSRESOURCES
 #define INCL_DOSERRORS
-#define INCL_DOS
-#define INCL_DOS
 #include <os2.h>
 

trunk/src/helpers/shapewin.c

@@ -167 +167 @@
  *                  Akira Hatakeyama,
  *                  Takayuki Suwa.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -184 +184 @@
     // as unsigned char
 
-#define INCL_DOS
 #define INCL_DOSERRORS
-#define INCL_WIN
+
+#define INCL_WINWINDOWMGR
+#define INCL_WINFRAMEMGR
+#define INCL_WINDIALOGS
+#define INCL_WININPUT
+#define INCL_WINPOINTERS
 #define INCL_WINSYS
+#define INCL_WINRECTANGLES
+#define INCL_WINTRACKRECT
+
 #define INCL_GPILOGCOLORTABLE
 #define INCL_GPIPRIMITIVES
@@ -209 +216 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Global variables                                               *
- *                                                                  *
+ *
+ *   Global variables
+ *
  ********************************************************************/
 
@@ -217 +224 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Part 1: Shape window functions                                 *
- *                                                                  *
+ *
+ *   Part 1: Shape window functions
+ *
  ********************************************************************/
 
@@ -515 +522 @@
     HPS         hps ;
 
-    pRgn = (PSHPREGION) WinQueryWindowPtr(hwnd, 0);
+    pRgn = (PSHPREGION)WinQueryWindowPtr(hwnd, 0);
 
     switch (msg)
@@ -1216 +1223 @@
         case WM_QUERYDLGCODE:
             // TRACE("WM_QUERYDLGCODE\n");
-            return (MRESULT) DLGC_STATIC;
+            return (MRESULT)DLGC_STATIC;
 
         /*
@@ -1295 +1302 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Part 2: Shape frame functions                                  *
- *                                                                  *
+ *
+ *   Part 2: Shape frame functions
+ *
  ********************************************************************/
 

trunk/src/helpers/stringh.c

@@ -25 +25 @@
  *      Copyright (C) 1997-2000 Ulrich M”ller.
  *      Parts Copyright (C) 1991-1999 iMatix Corporation.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -1709 +1709 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Miscellaneous                                                  *
- *                                                                  *
+ *
+ *   Miscellaneous
+ *
  ********************************************************************/
 
@@ -1742 +1742 @@
 
 VOID strhArrayAppend(PSZ *ppszRoot,         // in: root of array
-                     PSZ pszNew,            // in: string to append
+                     const char *pcszNew,   // in: string to append
                      PULONG pcbRoot)        // in/out: size of array
 {
-    ULONG cbNew = strlen(pszNew);
+    ULONG cbNew = strlen(pcszNew);
     PSZ pszTemp = (PSZ)malloc(*pcbRoot
                               + cbNew
@@ -1759 +1759 @@
     // append new string
     strcpy(pszTemp + *pcbRoot,
-           pszNew);
+           pcszNew);
     // update root
     *ppszRoot = pszTemp;
@@ -1859 +1859 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Wildcard matching                                              *
- *                                                                  *
+ *
+ *   Wildcard matching
+ *
  ********************************************************************/
 
@@ -2457 +2457 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Fast string searches                                           *
- *                                                                  *
+ *
+ *   Fast string searches
+ *
  ********************************************************************/
 

trunk/src/helpers/textv_html.c

@@ -59 +59 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Declarations                                                   *
- *                                                                  *
+ *
+ *   Declarations
+ *
  ********************************************************************/
 
@@ -150 +150 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Global variables                                               *
- *                                                                  *
+ *
+ *   Global variables
+ *
  ********************************************************************/
 
 /* ******************************************************************
- *                                                                  *
- *   Append-char helpers                                            *
- *                                                                  *
+ *
+ *   Append-char helpers
+ *
  ********************************************************************/
 
@@ -299 +299 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Tag converter functions                                        *
- *                                                                  *
+ *
+ *   Tag converter functions
+ *
  ********************************************************************/
 
@@ -885 +885 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Tag helpers                                                    *
- *                                                                  *
+ *
+ *   Tag helpers
+ *
  ********************************************************************/
 
@@ -1972 +1972 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Entry points                                                   *
- *                                                                  *
+ *
+ *   Entry points
+ *
  ********************************************************************/
 

trunk/src/helpers/textview.c

@@ -252 +252 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Device-independent functions                                   *
- *                                                                  *
+ *
+ *   Device-independent functions
+ *
  ********************************************************************/
 
@@ -466 +466 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Device-independent text formatting                             *
- *                                                                  *
+ *
+ *   Device-independent text formatting
+ *
  ********************************************************************/
 
@@ -1400 +1400 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Device-independent text painting                               *
- *                                                                  *
+ *
+ *   Device-independent text painting
+ *
  ********************************************************************/
 
@@ -1806 +1806 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Window-dependent functions                                     *
- *                                                                  *
+ *
+ *   Window-dependent functions
+ *
  ********************************************************************/
 
@@ -3180 +3180 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Printer-dependent functions                                    *
- *                                                                  *
+ *
+ *   Printer-dependent functions
+ *
  ********************************************************************/
 

trunk/src/helpers/threads.c

@@ -24 +24 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -102 +102 @@
             ((PTHREADFUNC)pti->pThreadFunc)(pti);
 
+        if (pti->flFlags & THRF_WAIT)
+            // "Wait" flag set: delete semaphore
+            DosCloseEventSem(pti->hevRunning);
+
         // thread func returns:
         pti->fExitComplete = TRUE;
         pti->tid = NULLHANDLE;
-
-        if (pti->flFlags & THRF_WAIT)
-            // "Wait" flag set: delete semaphore
-            DosCloseEventSem(pti->hevRunning);
 
         if (pti->pfRunning)

trunk/src/helpers/tmsgfile.c

@@ -50 +50 @@
  *      Copyright (C) 1999 Christian Langanke.
  *      Copyright (C) 1999-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -66 +66 @@
     // as unsigned char
 
-#define INCL_DOS
-#define INCL_ERRORS
+#define INCL_DOSFILEMGR
+#define INCL_DOSMISC
+#define INCL_DOSNLS
+#define INCL_DOSERRORS
 #include <os2.h>
 
@@ -85 +87 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Declarations                                                   *
- *                                                                  *
+ *
+ *   Declarations
+ *
  ********************************************************************/
 
@@ -111 +113 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Text Message File Code                                         *
- *                                                                  *
+ *
+ *   Text Message File Code
+ *
  ********************************************************************/
 

trunk/src/helpers/tree.c

@@ -89 +89 @@
  *      Copyright (C) 1991-99 iMatix Corporation.
  *      Copyright (C) 2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the

trunk/src/helpers/winh.c

@@ -20 +20 @@
 /*
  *      Copyright (C) 1997-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -36 +36 @@
     // as unsigned char
 
+#define INCL_DOSPROCESS
+#define INCL_DOSMODULEMGR
+#define INCL_DOSSEMAPHORES
+#define INCL_DOSDEVICES
 #define INCL_DOSDEVIOCTL
-#define INCL_DOS
 #define INCL_DOSERRORS
-#define INCL_WIN
-#define INCL_GPI
-
-// spooler #include's
-#define INCL_BASE
+
+#define INCL_WINWINDOWMGR
+#define INCL_WINMESSAGEMGR
+#define INCL_WINFRAMEMGR
+#define INCL_WININPUT
+#define INCL_WINDIALOGS
+#define INCL_WINPOINTERS
+#define INCL_WINRECTANGLES
+#define INCL_WINSHELLDATA
+#define INCL_WINSYS
+#define INCL_WINHELP
+#define INCL_WINPROGRAMLIST
+#define INCL_WINSWITCHLIST
+#define INCL_WINMENUS
+#define INCL_WINSCROLLBARS
+#define INCL_WINLISTBOXES
+#define INCL_WINSTDSPIN
+#define INCL_WINSTDSLIDER
+#define INCL_WINCIRCULARSLIDER
+#define INCL_WINSTDFILE
+
 #define INCL_SPL
 #define INCL_SPLDOSPRINT
 #define INCL_SPLERRORS
 
+#define INCL_GPIBITMAPS
+#define INCL_GPIPRIMITIVES
 #include <os2.h>
 
@@ -69 +90 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Menu helpers                                                   *
- *                                                                  *
+ *
+ *   Menu helpers
+ *
  ********************************************************************/
 
@@ -255 +276 @@
  *      not found.
  *
- *      If something != NULL is returned, you
- *      should free() the buffer afterwards.
+ *      Returns NULL on error. Use winhFree()
+ *      to free the return value.
  *
  *      Use the WinSetMenuItemText macro to
@@ -387 +408 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Slider helpers                                                 *
- *                                                                  *
+ *
+ *   Slider helpers
+ *
  ********************************************************************/
 
@@ -791 +812 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Spin button helpers                                            *
- *                                                                  *
+ *
+ *   Spin button helpers
+ *
  ********************************************************************/
 
@@ -896 +917 @@
 
 /* ******************************************************************
- *                                                                  *
- *   List box helpers                                               *
- *                                                                  *
+ *
+ *   List box helpers
+ *
  ********************************************************************/
 
@@ -905 +926 @@
  *      returns the text of the specified
  *      list box item in a newly allocated
- *      buffer, which you should free() afterwards,
- *      or NULL upon errors.
+ *      buffer.
+ *
+ *      Returns NULL on error. Use winhFree()
+ *      to free the return value.
  *
  *@@added V0.9.1 (99-12-14) [umoeller]
@@ -1025 +1048 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Scroll bar helpers                                             *
- *                                                                  *
+ *
+ *   Scroll bar helpers
+ *
  ********************************************************************/
 
@@ -1503 +1526 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Window positioning helpers                                     *
- *                                                                  *
+ *
+ *   Window positioning helpers
+ *
  ********************************************************************/
 
@@ -1916 +1939 @@
 
 /*
+ *@@ winhFindWindowBelow:
+ *      finds the window with the same parent
+ *      which sits right below hwndFind in the
+ *      window Z-order.
+ *
+ *@@added V0.9.7 (2000-12-04) [umoeller]
+ */
+
+HWND winhFindWindowBelow(HWND hwndFind)
+{
+    HWND hwnd = NULLHANDLE,
+         hwndParent = WinQueryWindow(hwndFind, QW_PARENT);
+
+    if (hwndParent)
+    {
+        HENUM   henum = WinBeginEnumWindows(hwndParent);
+        HWND    hwndThis;
+        while (hwndThis = WinGetNextWindow(henum))
+        {
+            SWP swp;
+            WinQueryWindowPos(hwndThis, &swp);
+            if (swp.hwndInsertBehind == hwndFind)
+            {
+                hwnd = hwndThis;
+                break;
+            }
+        }
+        WinEndEnumWindows(henum);
+    }
+
+    return (hwnd);
+}
+
+/*
  *@@category: Helpers\PM helpers\Presentation parameters
  */
 
 /* ******************************************************************
- *                                                                  *
- *   Presparams helpers                                             *
- *                                                                  *
+ *
+ *   Presparams helpers
+ *
  ********************************************************************/
 
@@ -1928 +1985 @@
  *@@ winhQueryWindowFont:
  *      returns the window font presentation parameter
- *      in a newly allocated buffer, which you must
- *      free() afterwards. Returns NULL if not found.
+ *      in a newly allocated buffer.
+ *
+ *      Returns NULL on error. Use winhFree()
+ *      to free the return value.
  *
  *@@added V0.9.1 (2000-02-14) [umoeller]
@@ -1966 +2025 @@
 
 BOOL winhSetWindowFont(HWND hwnd,
-                       PSZ pszFont)
+                       const char *pcszFont)
 {
     CHAR    szFont[256];
 
-    if (pszFont == NULL)
+    if (pcszFont == NULL)
     {
         if (doshIsWarp4())
@@ -1978 +2037 @@
     }
     else
-        strhncpy0(szFont, pszFont, sizeof(szFont));
+        strhncpy0(szFont, pcszFont, sizeof(szFont));
 
     return (WinSetPresParam(hwnd,
@@ -2060 +2119 @@
  *      Use free() on your PPRESPARAMS pointer (whose
  *      address was passed) after WinCreateWindow.
+ *
+ *      See winhQueryPresColor for typical presparams
+ *      used in OS/2.
  *
  *      Example:
@@ -2139 +2201 @@
  *      3)  if this fails or (fInherit == FALSE), WinQuerySysColor
  *          is called to get lSysColor (which should be a SYSCLR_*
- *          index).
+ *          index), if lSysColor != -1;
+ *      4)  if (lSysColor == -1), -1 is returned.
  *
  *      The return value is always an RGB LONG, _not_ a color index.
@@ -2205 +2268 @@
  *@@changed V0.9.0 [umoeller]: removed INI key query, using SYSCLR_* instead; function prototype changed
  *@@changed V0.9.0 [umoeller]: added fInherit parameter
+ *@@changed V0.9.7 (2000-12-02) [umoeller]: added lSysColor == -1 support
  */
 
@@ -2229 +2293 @@
 
     // not found: get system color
-    return (WinQuerySysColor(HWND_DESKTOP, lSysColor, 0));
+    if (lSysColor != -1)
+        return (WinQuerySysColor(HWND_DESKTOP, lSysColor, 0));
+
+    return -1;
 }
 
@@ -2237 +2304 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Help instance helpers                                          *
- *                                                                  *
+ *
+ *   Help instance helpers
+ *
  ********************************************************************/
 
@@ -2760 +2827 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Miscellaneous                                                  *
- *                                                                  *
+ *
+ *   Miscellaneous
+ *
  ********************************************************************/
+
+/*
+ *@@ winhFree:
+ *      frees a block of memory allocated by the
+ *      winh* functions.
+ *
+ *      Since the winh* functions use malloc(),
+ *      you can also use free() directly on such
+ *      blocks. However, you must use winhFree
+ *      if the winh* functions are in a module
+ *      with a different C runtime.
+ *
+ *@@added V0.9.7 (2000-12-06) [umoeller]
+ */
+
+VOID winhFree(PVOID p)
+{
+    if (p)
+        free(p);
+}
 
 /*
@@ -2930 +3017 @@
  *@@ winhQueryWindowText:
  *      this returns the window text of the specified
- *      HWND in a newly allocated buffer, which has
- *      the exact size of the window text.
- *
- *      This buffer must be free()'d later.
+ *      HWND in a newly allocated buffer.
+ *
+ *      Returns NULL on error. Use winhFree()
+ *      to free the return value.
  */
 
@@ -3058 +3145 @@
  *@@added V0.9.0 [umoeller]
  *@@changed V0.9.5 (2000-08-13) [umoeller]: flStyleClient never worked, fixed
+ *@@changed V0.9.7 (2000-12-08) [umoeller]: fixed client calc for invisible window
  */
 
@@ -3119 +3207 @@
 
             // position client
-            WinQueryWindowRect(hwndFrame, &rclClient);
-            WinCalcFrameRect(hwndFrame, &rclClient,
+            // WinQueryWindowRect(hwndFrame, &rclClient);
+            // doesn't work because it might be invisible V0.9.7 (2000-12-08) [umoeller]
+            rclClient.xLeft = 0;
+            rclClient.yBottom = 0;
+            rclClient.xRight = pswpFrame->cx;
+            rclClient.yTop = pswpFrame->cy;
+            WinCalcFrameRect(hwndFrame,
+                             &rclClient,
                              TRUE);     // calc client from frame
             WinSetWindowPos(*phwndClient,
@@ -3515 +3609 @@
 
 /*
+ *@@ winhQuerySwitchList:
+ *      returns the switch list in a newly
+ *      allocated buffer. This does the
+ *      regular double WinQuerySwitchList
+ *      call to first get the no. of items
+ *      and then get the items.
+ *
+ *      The no. of items can be found in
+ *      the returned SWBLOCK.cwsentry.
+ *
+ *      Returns NULL on errors. Use
+ *      winhFree to free the return value.
+ *
+ *@@added V0.9.7 (2000-12-06) [umoeller]
+ */
+
+PSWBLOCK winhQuerySwitchList(HAB hab)
+{
+    ULONG   cItems = WinQuerySwitchList(hab, NULL, 0);
+    ULONG   ulBufSize = (cItems * sizeof(SWENTRY)) + sizeof(HSWITCH);
+    PSWBLOCK pSwBlock = (PSWBLOCK)malloc(ulBufSize);
+    if (pSwBlock)
+    {
+        cItems = WinQuerySwitchList(hab, pSwBlock, ulBufSize);
+        if (!cItems)
+        {
+            free(pSwBlock);
+            pSwBlock = NULL;
+        }
+    }
+
+    return (pSwBlock);
+}
+
+/*
+ *@@ winhQueryTasklistWindow:
+ *      returns the window handle of the PM task list.
+ *
+ *@@added V0.9.7 (2000-12-07) [umoeller]
+ */
+
+HWND winhQueryTasklistWindow(VOID)
+{
+    SWBLOCK  swblock;
+    HWND     hwndTasklist = winhQueryTasklistWindow();
+    // the tasklist has entry #0 in the SWBLOCK
+    WinQuerySwitchList(NULLHANDLE, &swblock, sizeof(SWBLOCK));
+    return (swblock.aswentry[0].swctl.hwnd);
+}
+
+/*
  *@@ winhKillTasklist:
  *      this will destroy the Tasklist (window list) window.
@@ -3525 +3670 @@
 VOID winhKillTasklist(VOID)
 {
-    SWBLOCK  swblock;
-    HWND     hwndTasklist;
-    // the tasklist has entry #0 in the SWBLOCK
-    WinQuerySwitchList(NULLHANDLE, &swblock, sizeof(SWBLOCK));
-    hwndTasklist = swblock.aswentry[0].swctl.hwnd;
+    HWND     hwndTasklist = winhQueryTasklistWindow();
     WinPostMsg(hwndTasklist,
                0x0454,     // undocumented msg for killing tasklist
@@ -3695 +3836 @@
 
 /* ******************************************************************
- *                                                                  *
- *   WPS Class List helpers                                         *
- *                                                                  *
+ *
+ *   WPS Class List helpers
+ *
  ********************************************************************/
 
@@ -3712 +3853 @@
  *      See WinEnumObjectClasses() for details.
  *
- *      The buffer is allocated using malloc(), so
- *      you should free() it when it is no longer
- *      needed.
- *
- *      This returns NULL if an error occured.
+ *      Returns NULL on error. Use winhFree()
+ *      to free the return value.
  *
  *@@added V0.9.0 [umoeller]

trunk/src/helpers/wphandle.c

@@ -24 +24 @@
  *      This file Copyright (C) 1997-2000 Ulrich M”ller,
  *                                        Henk Kelder.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -40 +40 @@
     // as unsigned char
 
-#define INCL_DOS
 #define INCL_WINSHELLDATA
 #include <os2.h>
@@ -73 +72 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Helper functions                                               *
- *                                                                  *
+ *
+ *   Helper functions
+ *
  ********************************************************************/
 
@@ -281 +280 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Get HOBJECT from filename                                      *
- *                                                                  *
+ *
+ *   Get HOBJECT from filename
+ *
  ********************************************************************/
 
@@ -521 +520 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Get filename from HOBJECT                                      *
- *                                                                  *
+ *
+ *   Get filename from HOBJECT
+ *
  ********************************************************************/
 
@@ -640 +639 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Manipulation functions                                         *
- *                                                                  *
+ *
+ *   Manipulation functions
+ *
  ********************************************************************/
 

trunk/src/helpers/xml.c

@@ -46 +46 @@
 /*
  *      Copyright (C) 2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the

trunk/src/helpers/xprf.c

@@ -75 +75 @@
 /*
  *      Copyright (C) 2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -91 +91 @@
     // as unsigned char
 
-#define INCL_DOS
 #define INCL_DOSERRORS
 #define INCL_WINSHELLDATA
@@ -113 +112 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Declarations                                                   *
- *                                                                  *
+ *
+ *   Declarations
+ *
  ********************************************************************/
 
@@ -143 +142 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Helpers                                                        *
- *                                                                  *
+ *
+ *   Helpers
+ *
  ********************************************************************/
 
@@ -352 +351 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Read/write data                                                *
- *                                                                  *
+ *
+ *   Read/write data
+ *
  ********************************************************************/
 
@@ -670 +669 @@
 
 /* ******************************************************************
- *                                                                  *
- *   API Functions                                                  *
- *                                                                  *
+ *
+ *   API Functions
+ *
  ********************************************************************/
 

trunk/src/helpers/xprf2.c

@@ -22 +22 @@
 /*
  *      Copyright (C) 2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the
@@ -38 +38 @@
     // as unsigned char
 
-#define INCL_DOS
 #define INCL_DOSERRORS
 #define INCL_WINSHELLDATA
@@ -61 +60 @@
 
 /* ******************************************************************
- *                                                                  *
- *   Copy API Functions                                             *
- *                                                                  *
+ *
+ *   Copy API Functions
+ *
  ********************************************************************/
 

trunk/src/helpers/xstring.c

@@ -85 +85 @@
 /*
  *      Copyright (C) 1999-2000 Ulrich M”ller.
- *      This file is part of the XWorkplace source package.
- *      XWorkplace is free software; you can redistribute it and/or modify
+ *      This file is part of the "XWorkplace helpers" source package.
+ *      This is free software; you can redistribute it and/or modify
  *      it under the terms of the GNU General Public License as published
  *      by the Free Software Foundation, in version 2 as it comes in the