rom/intuition/lockpubscreen.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5 */
   6
   7 #include <string.h>
   8 #include "intuition_intern.h"
   9
  10 static struct PubScreenNode *findcasename(struct List *list, const UBYTE *name);
  11
  12 /*****************************************************************************
  13
  14     NAME */
  15 #include <proto/intuition.h>
  16
  17         AROS_LH1(struct Screen *, LockPubScreen,
  18
  19 /*  SYNOPSIS */
  20         AROS_LHA(CONST_STRPTR, name, A0),
  21
  22 /*  LOCATION */
  23         struct IntuitionBase *, IntuitionBase, 85, Intuition)
  24
  25 /*  FUNCTION
  26         Locks a public screen, thus preventing it from closing. This is
  27         useful if you want to put up a visitor window on a public screen
  28         and need to check some of the public screen's fields first -- not
  29         locking the screen may lead to the public screen not existing when
  30         your visitor window is ready.
  31
  32         If you try to lock the Workbench screen or the default public screen
  33         and there isn't any, the Workbench screen will be automatically opened
  34         and locked.
  35
  36     INPUTS
  37         name - Name of the public screen or NULL for the default public
  38                screen. The name "Workbench" refers to the Workbench screen.
  39                The name is case insensitive.
  40
  41     RESULT
  42         A pointer to the screen or NULL if something went wrong. Failure can
  43         happen for instance when the public screen is in private state or
  44         doesn't exist.
  45
  46     NOTES
  47         You don't need to hold the lock when your visitor window is opened as
  48         the pubscreen cannot be closed as long as there are visitor windows
  49         on it.
  50
  51     EXAMPLE
  52         To open a visitor window which needs information from the screen
  53         structure of the public screen to open on, do this:
  54
  55         if((pubscreen = LockPubScreen("PubScreentoOpenon")) != NULL)
  56         {
  57             ...check pubscreen's internal data...
  58             OpenWindow(VisitorWindow, pubscreen);
  59             UnlockPubScreen(NULL, pubscreen);
  60             ...use your visitor window...
  61             CloseWindow(VisitorWindow);
  62         }
  63
  64     BUGS
  65
  66     SEE ALSO
  67         OpenWindow(), UnlockPubScreen(), GetScreenData()
  68
  69     INTERNALS
  70
  71 *****************************************************************************/
  72 {
  73     AROS_LIBFUNC_INIT
  74
  75     struct Screen *screen = NULL;
  76     struct List   *list;
  77
  78     DEBUG_LOCKPUBSCREEN(dprintf("LockPubScreen: name <%s>\n",
  79                                 name ? name : (CONST_STRPTR)"NULL"));
  80     DEBUG_LOCKPUBSCREEN({struct Task *t = FindTask(NULL);
  81                         dprintf("LockPubScreen: task %p <%s>\n",
  82                         t,
  83                         t->tc_Node.ln_Name ? t->tc_Node.ln_Name : "NULL");});
  84
  85     list = LockPubScreenList();
  86
  87     if( !name )
  88     {
  89
  90         screen = GetPrivIBase(IntuitionBase)->DefaultPubScreen;
  91
  92         /* If IntuitionBase->DefaultPubScreen is NULL, then Workbench screen
  93            is default public screen. But note that, Workbench screen might
  94            here not be open either. */
  95
  96         if (!screen) screen = GetPrivIBase(IntuitionBase)->WorkBench;
  97
  98         if (screen)
  99         {
 100             ASSERT_VALID_PTR(screen);
 101             GetPrivScreen(screen)->pubScrNode->psn_VisitorCount++;
 102             DEBUG_VISITOR(dprintf("LockPubScreen: 1 screen %p count %ld Task <%s>\n",
 103                                   screen, GetPrivScreen(screen)->pubScrNode->psn_VisitorCount,
 104                                   FindTask(NULL)->tc_Node.ln_Name));
 105             DEBUG_LOCKPUBSCREEN(dprintf("LockPubScreen: screen %p count %d\n",
 106                                         screen, GetPrivScreen(screen)->pubScrNode->psn_VisitorCount));
 107         }
 108
 109     }
 110     else
 111     {
 112         struct PubScreenNode *psn;
 113
 114         ASSERT_VALID_PTR(name);
 115
 116         /* Browse the public screen list */
 117         if( (psn = findcasename(list, (UBYTE *)name )) )
 118         {
 119             ASSERT_VALID_PTR(psn);
 120
 121             /* Don't lock screens in private state */
 122             if( (psn != NULL) && !(psn->psn_Flags & PSNF_PRIVATE) )
 123             {
 124                 /* Increment screen lock count */
 125                 psn->psn_VisitorCount++;
 126                 screen = psn->psn_Screen;
 127                 DEBUG_VISITOR(dprintf("LockPubScreen: 2 node %p screen %p count %ld <%s>\n",
 128                                       psn, screen, psn->psn_VisitorCount,
 129                                       FindTask(NULL)->tc_Node.ln_Name));
 130                 DEBUG_LOCKPUBSCREEN(dprintf("LockPubScreen: node %p screen %p count %d\n",
 131                                             psn, screen, psn->psn_VisitorCount));
 132                 ASSERT_VALID_PTR(screen);
 133             }
 134         }
 135
 136     }
 137
 138     UnlockPubScreenList();
 139
 140     /* If no screen was found and the requested one was the Workbench screen or
 141      * the default public screen, open the Workbench screen and lock it. */
 142     if( (screen == NULL) && ((name == NULL) || (strcasecmp( name, "Workbench" ) == 0)) )
 143     {
 144         OpenWorkBench();
 145         DEBUG_LOCKPUBSCREEN(dprintf("LockPubScreen: opened workbench\n"));
 146
 147         LockPubScreenList();
 148
 149         screen = GetPrivIBase(IntuitionBase)->WorkBench;
 150         if (!screen)
 151         {
 152             struct PubScreenNode *psn;
 153
 154             /* Maybe something patched OpenWorkbench, and there is a 'Workbench'
 155              * screen in the list. Our private pointer is just not set. */
 156             if( (psn = findcasename(list, "Workbench" )) )
 157             {
 158                 /* Don't lock screens in private state */
 159                 if( (psn != NULL) && !(psn->psn_Flags & PSNF_PRIVATE) )
 160                     screen = psn->psn_Screen;
 161             }
 162         }
 163
 164         if( screen )
 165         {
 166             ASSERT_VALID_PTR(screen);
 167             GetPrivScreen(screen)->pubScrNode->psn_VisitorCount++;
 168             DEBUG_VISITOR(dprintf("LockPubScreen: 3 screen %p count %d <%s>\n",
 169                                   screen, GetPrivScreen(screen)->pubScrNode->psn_VisitorCount,
 170                                   FindTask(NULL)->tc_Node.ln_Name));
 171
 172             DEBUG_LOCKPUBSCREEN(dprintf("LockPubScreen: screen %p count %d\n",
 173                                         screen, GetPrivScreen(screen)->pubScrNode->psn_VisitorCount));
 174         }
 175
 176         UnlockPubScreenList();
 177     }
 178
 179     FireScreenNotifyMessage((IPTR) screen, SNOTIFY_LOCKPUBSCREEN, IntuitionBase);
 180
 181     DEBUG_LOCKPUBSCREEN(dprintf("LockPubScreen: return %p\n", screen));
 182
 183     return screen;
 184
 185     AROS_LIBFUNC_EXIT
 186 } /* LockPubScreen */
 187
 188
 189 /* case insensitive FindName() */
 190 static struct PubScreenNode *findcasename(struct List *list, const UBYTE *name)
 191 {
 192     struct Node *node;
 193
 194     for (node = GetHead(list); node; node = GetSucc(node))
 195     {
 196         if(node->ln_Name)
 197         {
 198             if (!strcasecmp (node->ln_Name, name))
 199                 break;
 200         }
 201     }
 202     return (struct PubScreenNode *)node;
 203 }