rom/intuition/closescreen.c

   1 /*
   2     Copyright © 1995-2013, The AROS Development Team. All rights reserved.
   3     Copyright © 2001-2013, The MorphOS Development Team. All Rights Reserved.
   4     $Id$
   5
   6     Close a screen.
   7 */
   8
   9 /*
  10  * Things added by AROS, which needs to be kept when merging with newer MorphOS releases:
  11  *
  12  * 1. Explicit library bases
  13  * 2. FireScreenNotifyMessage() calls
  14  * 3. RemoveResourceFromList() call
  15  * 4. int_ExitDecorator() call
  16  * 5. Other placed marked by 'AROS:' in comments.
  17  * 6. Check #ifdef's. Some of them were rearranged or completely deleted.
  18  *    We reuse MorphOS skin code where appropriate.
  19  */
  20
  21 #include <graphics/videocontrol.h>
  22 #include <proto/exec.h>
  23 #include <proto/graphics.h>
  24 #include <proto/layers.h>
  25 #include "intuition_intern.h"
  26 #include "intuition_customize.h"
  27 #include "inputhandler_actions.h"
  28
  29 #ifndef DEBUG_CloseScreen
  30 #define DEBUG_CloseScreen 0
  31 #endif
  32 #undef DEBUG
  33 #if DEBUG_CloseScreen
  34 #define DEBUG 1
  35 #endif
  36 #include <aros/debug.h>
  37
  38 struct CloseScreenActionMsg
  39 {
  40     struct IntuiActionMsg msg;
  41     struct Screen *Screen;
  42 };
  43
  44 static VOID int_closescreen(struct CloseScreenActionMsg *msg,
  45                             struct IntuitionBase *IntuitionBase);
  46
  47 /*****************************************************************************
  48
  49     NAME */
  50 #include <intuition/screens.h>
  51 #include <proto/intuition.h>
  52
  53     AROS_LH1(BOOL, CloseScreen,
  54
  55 /*  SYNOPSIS */
  56          AROS_LHA(struct Screen *, screen, A0),
  57
  58 /*  LOCATION */
  59          struct IntuitionBase *, IntuitionBase, 11, Intuition)
  60
  61 /*  FUNCTION
  62
  63     Release all resources held by a screen and close it down visually.
  64
  65     INPUTS
  66
  67     screen  --  pointer to the screen to be closed
  68
  69     RESULT
  70
  71     TRUE if the screen is successfully closed, FALSE if there were still
  72     windows left on the screen (which means the screen is not closed).
  73
  74     NOTES
  75
  76     EXAMPLE
  77
  78     BUGS
  79
  80     SEE ALSO
  81
  82     INTERNALS
  83
  84     HISTORY
  85     29-10-95    digulla automatically created from
  86                 intuition_lib.fd and clib/intuition_protos.h
  87
  88 *****************************************************************************/
  89 {
  90     AROS_LIBFUNC_INIT
  91
  92     struct GfxBase *GfxBase = GetPrivIBase(IntuitionBase)->GfxBase;
  93     struct LayersBase *LayersBase = GetPrivIBase(IntuitionBase)->LayersBase;
  94     struct CloseScreenActionMsg msg;
  95 //      ULONG lock;
  96
  97     DEBUG_CLOSESCREEN(dprintf("CloseScreen: Screen 0x%lx\n", (ULONG)screen));
  98
  99     D(bug("CloseScreen (%p)\n", screen));
 100
 101     if ( screen == NULL )
 102     {
 103         ReturnBool("CloseScreen",TRUE);
 104     }
 105
 106 #ifdef INTUITION_NOTIFY_SUPPORT
 107     /* Notify that the screen is going to close */
 108     sn_DoNotify(SCREENNOTIFY_TYPE_CLOSESCREEN, screen, IBase->ScreenNotifyBase);
 109 #endif
 110     if (screen != GetPrivIBase(IntuitionBase)->WorkBench)
 111         FireScreenNotifyMessage((IPTR) screen, SNOTIFY_BEFORE_CLOSESCREEN, IntuitionBase);
 112
 113     /* there's a second check below for public screens */
 114     if (screen->FirstWindow)
 115     {
 116         D(bug("CloseScreen: fail, window still opened\n"));
 117         ReturnBool("CloseScreen",FALSE);
 118     }
 119
 120 #ifdef USEWINDOWLOCK
 121     /* let's wait for user to finish window drag/size actions to avoid
 122     deadlocks and not break user's input */
 123     if (IS(screen)->WindowLock)
 124     {
 125         struct Screen *ccs;
 126         BOOL found = FALSE;
 127
 128         LOCKWINDOW;
 129
 130         /* !moron check here! */
 131         for (ccs = IntuitionBase->FirstScreen; ccs; ccs = ccs->NextScreen)
 132         {
 133             if (ccs == screen) found = TRUE;
 134         }
 135
 136         if (!found)
 137         {
 138             struct Task *caller = FindTask(NULL);
 139             UNLOCKWINDOW;
 140
 141             dprintf("CloseScreen: task %p (%s) attempted a bogus CloseScreen(%p) !\n",
 142                     caller,(char*) (caller->tc_Node.ln_Name ? caller->tc_Node.ln_Name : ""),screen);
 143
 144             ReturnBool("closescreen",FALSE);
 145         }
 146     }
 147 #endif
 148
 149     DEBUG_CLOSESCREEN(dprintf("CloseScreen: LockPubScreenList\n"));
 150     LockPubScreenList();
 151     DEBUG_CLOSESCREEN(dprintf("CloseScreen: LockPubScreenList done\n"));
 152
 153     msg.Screen = screen;
 154     DoSyncAction((APTR)int_closescreen,&msg.msg,IntuitionBase);
 155
 156     DEBUG_CLOSESCREEN(dprintf("CloseScreen: UnLockPubScreenList\n"));
 157     UnlockPubScreenList();
 158     DEBUG_CLOSESCREEN(dprintf("CloseScreen: UnLockPubScreenList done\n"));
 159
 160     if (IS(screen)->pubScrNode != NULL)
 161     {
 162 #ifdef USEWINDOWLOCK
 163         if (IS(screen)->WindowLock) UNLOCKWINDOW;
 164 #endif
 165         DEBUG_CLOSESCREEN(dprintf("CloseScreen: failed\n"));
 166         //something went wrong! int_closescreen is supposed to clear pubScrNode ptr!
 167         return FALSE;
 168     }
 169
 170     /* AROS: Notify decorator */
 171     int_ExitDecorator(screen);
 172
 173     /* kill screen bar */
 174     KillScreenBar(screen, IntuitionBase);
 175
 176     /* kill depth gadget */
 177     if (((struct IntScreen *)screen)->depthgadget)
 178     {
 179         Object *im = (Object*)((struct Gadget *)(((struct IntScreen *)screen)->depthgadget))->GadgetRender;
 180
 181         DisposeObject(im);
 182         DisposeObject(((struct IntScreen *)screen)->depthgadget);
 183     }
 184
 185     if (IS(screen)->RestoreDBufInfo != NULL)
 186     {
 187         FreeDBufInfo(IS(screen)->RestoreDBufInfo);
 188     }
 189
 190     RethinkDisplay();
 191     DEBUG_CLOSESCREEN(dprintf("CloseScreen: Rethink done\n"));
 192
 193     FreeVPortCopLists(&screen->ViewPort);
 194
 195 #ifdef __MORPHOS__
 196     /*
 197      * AROS: According to documentation, VTAG_ATTACH_CM_GET should return a pointer
 198      * to our ViewPort. ViewPort is part of struct Screen, so there's nothing to
 199      * GfxFree(). Also, ViewPortExtra is GfxFree()d in FreeColorMap(), attempt to
 200      * free it twice doesn't do good things. Looks like some MorphOS quirk. Note
 201      * that the same thing is surrounded by #ifdef __MORPHOS__ in original MorphOS code.
 202      * TODO: Check if our behavior is correct and adjust it to correspond AmigaOS v3.
 203      */
 204     {
 205         struct TagItem tags[3];
 206
 207         tags[0].ti_Tag = VTAG_ATTACH_CM_GET;
 208         tags[0].ti_Data = 0;
 209         tags[1].ti_Tag = VTAG_VIEWPORTEXTRA_GET;
 210         tags[1].ti_Data = 0;
 211         tags[2].ti_Tag = VTAG_END_CM;
 212
 213         if (VideoControl(screen->ViewPort.ColorMap, tags) == NULL)
 214         {
 215             DEBUG_CLOSESCREEN(dprintf("CloseScreen: CM %lx EX %lx\n",tags[0].ti_Data,tags[1].ti_Data));
 216             if (tags[0].ti_Data) GfxFree((APTR)tags[0].ti_Data);
 217             if (tags[1].ti_Data) GfxFree((APTR)tags[1].ti_Data);
 218         }
 219     }
 220 #endif
 221
 222 #ifdef USEWINDOWLOCK
 223     if (IS(screen)->WindowLock) UNLOCKWINDOW;
 224 #endif
 225
 226     /* Free the RasInfo of the viewport */
 227     FreeMem(screen->ViewPort.RasInfo, sizeof (struct RasInfo));
 228
 229 #if 0
 230     /* Root layer now automatically freed in ThinLayerInfo() */
 231
 232 #ifdef CreateLayerTagList
 233     /* Free the root layer */
 234     DeleteLayer(0UL, ((struct IntScreen *)screen)->rootLayer);
 235 #endif
 236 #endif
 237     /* Uninit the layerinfo */
 238
 239     ThinLayerInfo(&screen->LayerInfo);
 240     DEBUG_CLOSESCREEN(dprintf("CloseScreen: ThinLayer done\n"));
 241
 242     ReadPixel(&screen->RastPort,0,0);
 243
 244     /* Free the screen's bitmap */
 245     if (IS(screen)->AllocatedBitMap)
 246     {
 247         FreeBitMap(IS(screen)->AllocatedBitMap);
 248     }
 249
 250     screen->RastPort.BitMap = NULL;
 251
 252     DEBUG_CLOSESCREEN(dprintf("CloseScreen: Freebitmap done\n"));
 253
 254     /* Free the RastPort's contents */
 255     DeinitRastPort(&screen->RastPort);
 256
 257     if (((struct IntScreen *)screen)->DInfo.dri_Customize)
 258     {
 259         /* Free the skin */
 260                 /* AROS: submenu image moved out of #ifdef */
 261         DisposeObject(((struct IntScreen *)screen)->DInfo.dri_Customize->submenu);
 262 #ifdef SKINS
 263         DisposeObject(((struct IntScreen *)screen)->DInfo.dri_Customize->menutoggle);
 264         int_SkinAction(SKA_FreeSkin,(ULONG*)&((struct IntScreen *)(screen))->DInfo,(struct Screen *)screen,IntuitionBase);
 265         int_FreeTitlebarBuffer(screen,IntuitionBase);
 266 #endif
 267         FreeMem(((struct IntScreen *)screen)->DInfo.dri_Customize,sizeof (struct IntuitionCustomize));
 268     }
 269
 270 #ifdef SKINS
 271     if (((struct IntScreen *)screen)->DInfo.dri_Colors)
 272     {
 273         FreeMem(((struct IntScreen *)screen)->DInfo.dri_Colors,4 * DRIPEN_NUMDRIPENS);
 274     }
 275     DEBUG_CLOSESCREEN(dprintf("CloseScreen: skins done\n"));
 276 #endif
 277
 278     DisposeObject(((struct IntScreen *)screen)->DInfo.dri_CheckMark);
 279     DisposeObject(((struct IntScreen *)screen)->DInfo.dri_AmigaKey);
 280
 281     /* Close the font */
 282     CloseFont(((struct IntScreen *)screen)->DInfo.dri_Font);
 283
 284     /* Free the ColorMap */
 285     FreeColorMap(screen->ViewPort.ColorMap);
 286
 287     DEBUG_CLOSESCREEN(dprintf("CloseScreen: Freecolormap done\n"));
 288
 289     /* Free the sprite */
 290     ReleaseSharedPointer(((struct IntScreen *)screen)->Pointer, IntuitionBase);
 291
 292     /* Free the memory */
 293     DisposeObject(screen);
 294
 295     /* AROS: Send notification */
 296     if (screen != GetPrivIBase(IntuitionBase)->WorkBench)
 297         FireScreenNotifyMessage((IPTR) screen, SNOTIFY_AFTER_CLOSESCREEN, IntuitionBase);
 298
 299     DEBUG_CLOSESCREEN(dprintf("CloseScreen: ok\n"));
 300
 301     ReturnBool("CloseScreen",TRUE);
 302
 303     AROS_LIBFUNC_EXIT
 304 } /* CloseScreen */
 305
 306 static VOID int_closescreen(struct CloseScreenActionMsg *msg,
 307                             struct IntuitionBase *IntuitionBase)
 308 {
 309     struct Screen *parent,*screen = msg->Screen;
 310     ULONG lock = 0;
 311
 312     DEBUG_CLOSESCREEN(dprintf("CloseScreen: welcome in inputhandler!\n"));
 313
 314 #ifdef SKINS
 315     if (IntuitionBase->FirstScreen == screen) ScreenDepth(screen,SDEPTH_TOBACK,NULL);
 316     DEBUG_CLOSESCREEN(dprintf("CloseScreen: put the screen to back\n"));
 317 #endif
 318
 319 #if USE_NEWDISPLAYBEEP
 320     /* we could be beeping this screen... */
 321     /* NOTE: we're running under the windowlock here! */
 322     if (IBase->BeepingScreens && (screen->Flags & BEEPING))
 323     {
 324         IBase->BeepingScreens --;
 325     }
 326 #endif
 327
 328     if (IBase->MenuVerifyScreen == IS(screen))
 329             IBase->MenuVerifyScreen = NULL;
 330
 331     /* If this is a public screen, free related information if there are
 332        no windows left on the screen */
 333     if (IS(screen)->pubScrNode != NULL)
 334     {
 335         DEBUG_CLOSESCREEN(dprintf("CloseScreen: killing a pubscreen entry\n"));
 336
 337         if(IS(screen)->pubScrNode->psn_VisitorCount || screen->FirstWindow)
 338         {
 339             DEBUG_CLOSESCREEN(dprintf("CloseScreen: failed\n"));
 340             return;
 341         }
 342
 343         Remove((struct Node *)IS(screen)->pubScrNode);
 344
 345         if(IS(screen)->pubScrNode->psn_Node.ln_Name != NULL)
 346             FreeVec(IS(screen)->pubScrNode->psn_Node.ln_Name);
 347
 348         FreeMem(IS(screen)->pubScrNode,
 349                 sizeof(struct PubScreenNode));
 350
 351         IS(screen)->pubScrNode = 0;
 352     }
 353
 354     RemoveResourceFromList(screen, RESOURCE_SCREEN, IntuitionBase);
 355
 356     DEBUG_CLOSESCREEN(dprintf("CloseScreen: LockIBase\n"));
 357
 358     if (!ILOCKCHECK(((struct IntuiActionMsg *)msg))) lock = LockIBase(0);
 359
 360     DEBUG_CLOSESCREEN(dprintf("CloseScreen: LockIBase done\n"));
 361
 362     /* Trick: Since NextScreen is the first field of the structure,
 363     we can use the pointer in the IntuitionBase as a screen with
 364     the structure-size of one pointer */
 365     parent = (struct Screen *)&(IntuitionBase->FirstScreen);
 366
 367     /* For all screens... */
 368     while (parent->NextScreen)
 369     {
 370         /* If the screen to close is the next screen... */
 371         if (parent->NextScreen == screen)
 372         {
 373
 374             /* Unlink it */
 375             parent->NextScreen = screen->NextScreen;
 376
 377             /* Check ActiveScreen */
 378             if (IntuitionBase->ActiveScreen == screen)
 379             {
 380                 if (screen->NextScreen)
 381                     IntuitionBase->ActiveScreen = screen->NextScreen;
 382                 else if (IntuitionBase->FirstScreen)
 383                     IntuitionBase->ActiveScreen = parent;
 384                 else
 385                     IntuitionBase->ActiveScreen = NULL;
 386             }
 387
 388             /* now let's set the default pub screen */
 389             if (IBase->DefaultPubScreen == screen)
 390             {
 391                 struct Screen *scr;
 392
 393                 IBase->DefaultPubScreen = NULL;
 394                 scr = IntuitionBase->FirstScreen;
 395
 396                 if (scr && IBase->IControlPrefs.ic_Flags & ICF_DEFPUBSCREEN && IS(scr)->pubScrNode && (scr->Flags & (PUBLICSCREEN | WBENCHSCREEN)))
 397                 {
 398                     IBase->DefaultPubScreen = scr;
 399                 }
 400             }
 401
 402             DEBUG_CLOSESCREEN(dprintf("CloseScreen: UnLockIBase\n"));
 403             if (!ILOCKCHECK(((struct IntuiActionMsg *)msg))) UnlockIBase(lock);
 404             DEBUG_CLOSESCREEN(dprintf("CloseScreen: UnLockIBase done\n"));
 405
 406 #ifdef TIMEVALWINDOWACTIVATION
 407             if (IntuitionBase->FirstScreen && ((IBase->IControlPrefs.ic_Flags & ICF_SCREENACTIVATION) || !IntuitionBase->ActiveWindow))
 408             {
 409                 DeactivateWindow(NULL,msg->msg.task,IntuitionBase);
 410             }
 411 #endif
 412             return;
 413         }
 414         parent = parent->NextScreen;
 415     }
 416
 417     DEBUG_CLOSESCREEN(dprintf("CloseScreen: UnLockIBase\n"));
 418     if (!ILOCKCHECK(((struct IntuiActionMsg *)msg))) UnlockIBase(lock);
 419     DEBUG_CLOSESCREEN(dprintf("CloseScreen: UnLockIBase done\n"));
 420
 421     return;
 422 }