workbench/libs/commodities/divertcxmsg.c

   1 /*
   2     Copyright © 1995-2001, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc:
   6     Lang: English
   7 */
   8
   9 /*****************************************************************************
  10
  11     NAME */
  12
  13 #include "cxintern.h"
  14 #include <proto/commodities.h>
  15
  16     AROS_LH3I(VOID, DivertCxMsg,
  17
  18 /*  SYNOPSIS */
  19
  20         AROS_LHA(CxMsg *, cxm      , A0),
  21         AROS_LHA(CxObj *, headObj  , A1),
  22         AROS_LHA(CxObj *, returnObj, A2),
  23
  24 /*  LOCATION */
  25
  26         struct Library *, CxBase, 26, Commodities)
  27
  28 /*  FUNCTION
  29
  30     Send the commodity message 'cxm' down the list of objects connected to
  31     'headObj' and set the destination to 'returnObj'. This means that when
  32     the message has travelled through the objects within the 'headObj' tree,
  33     the _successor_ of returnObj will receive the message.
  34
  35     INPUTS
  36
  37     cxm       -- the message to be diverted.
  38     headObj   -- the start object
  39     returnObj -- the successor of this object will get the message after
  40                  travelling through 'headObj' and friends.
  41
  42     RESULT
  43
  44     NOTES
  45
  46     EXAMPLE
  47
  48     When a filter gets a message that matches with its description, it
  49     sends the message down its list using:
  50
  51         DivertCxMsg(msg, filter, filter);
  52
  53     BUGS
  54
  55     SEE ALSO
  56
  57     RouteCxMsg()
  58
  59     INTERNALS
  60
  61     HISTORY
  62
  63 ******************************************************************************/
  64
  65 {
  66     AROS_LIBFUNC_INIT
  67
  68     ROUTECxMsg(cxm, (CxObj *)GetHead(&headObj->co_ObjList));
  69
  70     if (cxm->cxm_Level >= cxm_MaxLevel)
  71     {
  72         return;
  73     }
  74
  75     cxm->cxm_retObj[cxm->cxm_Level] = returnObj;
  76     cxm->cxm_Level++;
  77
  78     AROS_LIBFUNC_EXIT
  79 } /* DivertCxMsg */