rom/intuition/closeworkbench.c

   1 /*
   2     Copyright  1995-2007, The AROS Development Team. All rights reserved.
   3     Copyright  2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5 */
   6
   7 #include "intuition_intern.h"
   8
   9 #include <intuition/intuition.h>
  10 #include <proto/intuition.h>
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15
  16 AROS_LH0(LONG, CloseWorkBench,
  17
  18          /*  SYNOPSIS */
  19
  20          /*  LOCATION */
  21          struct IntuitionBase *, IntuitionBase, 13, Intuition)
  22
  23 /*  FUNCTION
  24     Attempt to close the Workbench screen:
  25     - Check for open application windows. return FALSE if there are any
  26     - Clean up all special buffers
  27     - Close the Workbench screen
  28     - Make the Workbench program mostly inactive
  29       (disk activity will still be monitored)
  30     - Return TRUE
  31
  32     INPUTS
  33
  34     RESULT
  35
  36     NOTES
  37
  38     EXAMPLE
  39
  40     BUGS
  41
  42     SEE ALSO
  43     OpenWorkBench()
  44
  45     INTERNALS
  46
  47     HISTORY
  48
  49 *****************************************************************************/
  50 {
  51     AROS_LIBFUNC_INIT
  52
  53     struct Screen *wbscreen;
  54     BOOL           retval = TRUE;
  55
  56     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: <%s>\n",
  57                                  FindTask(NULL)->tc_Node.ln_Name));
  58
  59     if (wbscreen) FireScreenNotifyMessage((IPTR) wbscreen, SNOTIFY_BEFORE_CLOSEWB, IntuitionBase);
  60
  61     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: LockPubScreenList\n"));
  62     LockPubScreenList();
  63     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: LockPubScreenList done\n"));
  64
  65     wbscreen = GetPrivIBase(IntuitionBase)->WorkBench;
  66
  67     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: Workbench Screen 0x%lx\n",
  68                                  (ULONG) wbscreen));
  69
  70     if (!wbscreen)
  71     {
  72         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: no wbscreen, do nothing\n"));
  73         UnlockPubScreenList();
  74
  75         FireScreenNotifyMessage((IPTR) wbscreen, SNOTIFY_AFTER_OPENWB, IntuitionBase);
  76
  77         return(FALSE);
  78     }
  79     else
  80     {
  81         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: Workbench Screen's pubnode 0x%lx\n",
  82                                      (ULONG) GetPrivScreen(wbscreen)->pubScrNode));
  83         if (GetPrivScreen(wbscreen)->pubScrNode->psn_VisitorCount != 0)
  84         {
  85             DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: visitor count %ld, do nothing\n",
  86                                          (ULONG) GetPrivScreen(wbscreen)->pubScrNode->psn_VisitorCount));
  87             retval = FALSE;
  88         }
  89     }
  90
  91     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: UnlockPubScreenList\n"));
  92     UnlockPubScreenList();
  93     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: UnlockPubScreenList done\n"));
  94
  95
  96     /* If there is a Workbench process running, tell it to close it's windows. */
  97
  98     /* Don't call this function while pub screen list is locked! */
  99
 100     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: Tell WB to close windows\n"));
 101     TellWBTaskToCloseWindows(IntuitionBase);
 102
 103     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: LockPubScreenList\n"));
 104     LockPubScreenList();
 105     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: LockPubScreenList done\n"));
 106
 107     wbscreen = GetPrivIBase(IntuitionBase)->WorkBench;
 108
 109     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: current wbscreen 0x%lx\n",
 110                                  (ULONG) wbscreen));
 111
 112     /* Try to close the Workbench screen, if there is any. */
 113     if( wbscreen != NULL )
 114     {
 115         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: CloseScreen\n"));
 116         if (CloseScreen(wbscreen))
 117         {
 118             DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: CloseScreen worked\n"));
 119             GetPrivIBase(IntuitionBase)->WorkBench = NULL;
 120             wbscreen = NULL;
 121             retval = TRUE;
 122         }
 123         else
 124         {
 125             /* Grrr ... closing screen failed. I inc psn_VisitorCount by hand here,
 126              * to avoid that someone else can kill it, because I must tell Workbench
 127              * task that it shall open its windows again
 128              */
 129
 130             DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: CloseScreen failed\n"));
 131             GetPrivScreen(wbscreen)->pubScrNode->psn_VisitorCount++;
 132             retval = FALSE;
 133         }
 134     }
 135     else
 136     {
 137         retval = FALSE;
 138     }
 139
 140     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: UnLockPubScreenList\n"));
 141     UnlockPubScreenList();
 142     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: UnLockPubScreenList done\n"));
 143
 144     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: wbscreen 0x%lx retval %ld\n",
 145                                  (ULONG) wbscreen,
 146                                  (ULONG) retval));
 147     if (wbscreen && !retval)
 148     {
 149         /* Don't call this function while pub screen list is locked! */
 150         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: Tell WB to reopen windows\n"));
 151         TellWBTaskToOpenWindows(IntuitionBase);
 152
 153         /* Fix psn_VisitorCount which was increased above */
 154         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: LockPubScreenList\n"));
 155         LockPubScreenList();
 156         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: LockPubScreenList done\n"));
 157         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: WBScreen's pubnode 0x%lx\n",
 158                                      (ULONG) GetPrivScreen(wbscreen)->pubScrNode));
 159         GetPrivScreen(wbscreen)->pubScrNode->psn_VisitorCount--;
 160         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: UnLockPubScreenList\n"));
 161         UnlockPubScreenList();
 162         DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: UnLockPubScreenList done\n"));
 163     }
 164
 165     DEBUG_CLOSEWORKBENCH(dprintf("CloseWorkBench: Return %d\n", retval));
 166
 167     if (!retval)
 168     {
 169         /* Workbench screen failed to close, notify that the screen is open again */
 170         FireScreenNotifyMessage((IPTR) wbscreen, SNOTIFY_AFTER_OPENWB, IntuitionBase);
 171     }
 172     else
 173     {
 174         FireScreenNotifyMessage((IPTR) wbscreen, SNOTIFY_AFTER_CLOSEWB, IntuitionBase);
 175     }
 176
 177     return retval;
 178
 179     AROS_LIBFUNC_EXIT
 180
 181 } /* CloseWorkBench */