rom/hyperlayers/isfrontmostlayer.c

   1 /*
   2     Copyright © 1995-2007, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: english
   7 */
   8 #include <proto/exec.h>
   9 #include <exec/types.h>
  10 #include <exec/memory.h>
  11 #include "layers_intern.h"
  12 #include <aros/libcall.h>
  13 #include <proto/graphics.h>
  14 #include "basicfuncs.h"
  15
  16 /*****************************************************************************
  17
  18     NAME */
  19 #include <proto/layers.h>
  20         AROS_LH2(BOOL, IsFrontmostLayer,
  21
  22 /*  SYNOPSIS */
  23         AROS_LHA(struct Layer *, l              , A0),
  24         AROS_LHA(BOOL          , check_invisible, D0),
  25
  26 /*  LOCATION */
  27         struct LayersBase *, LayersBase, 43, Layers)
  28
  29 /*  FUNCTION
  30        Checks whether this layer is the frontmost layer within
  31        its priority. If this layer has children then all of
  32        its children will be disregarded. Comparisons are only
  33        done with layers that have the same 'depth' of relation-
  34        ship (=nesting counter) to the root layer.
  35        It can be specified whether invisible siblings are to be
  36        considered in the comparison.
  37
  38     INPUTS
  39        L               - pointer to layer
  40        check_invisible - whether invisible siblings are to be considered
  41
  42
  43     RESULT
  44        TRUE  - layer is frontmost layer within its priority
  45        FALSE - layer is not frontmost layer within its priority
  46
  47     NOTES
  48
  49     EXAMPLE
  50
  51     BUGS
  52
  53     SEE ALSO
  54
  55     INTERNALS
  56
  57     HISTORY
  58
  59 *****************************************************************************/
  60 {
  61         AROS_LIBFUNC_INIT
  62
  63         struct Layer * _l;
  64         BOOL result = TRUE;
  65
  66         if (NULL == l)
  67                 return FALSE;
  68
  69         LockLayers(l->LayerInfo);
  70
  71         _l = l->front;
  72
  73         while (NULL != _l) {
  74                 /*
  75                  * If they differ in priority then return TRUE.
  76                  * I did not meet another (elegible) sibling so
  77                  * far.
  78                  */
  79                 if (_l->priority != l->priority)
  80                         break;
  81                 /*
  82                  * If the nesting counter of one layer in front
  83                  * of the layer l is equal (or less) then return FALSE.
  84                  */
  85                 if (_l->nesting  <= l->nesting &&
  86                     ( IS_VISIBLE(_l) || TRUE == check_invisible)) {
  87                         result = FALSE;
  88                         break;
  89                 }
  90                 _l = _l->front;
  91         }
  92
  93         UnlockLayers(l->LayerInfo);
  94
  95         return result;
  96
  97         AROS_LIBFUNC_EXIT
  98 } /* IsFrontmostLayer */