workbench/libs/commodities/createcxobj.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 <libraries/commodities.h>
  15 #include <proto/exec.h>
  16 #include <proto/commodities.h>
  17 #include <string.h>
  18
  19 #include <aros/debug.h>
  20
  21 #define DEBUG_CREATECXOBJ(x)    ;
  22
  23
  24 VOID BrokerFunc(CxObj *, struct NewBroker *, struct Library *CxBase);
  25
  26
  27     AROS_LH3(CxObj *, CreateCxObj,
  28
  29 /*  SYNOPSIS */
  30
  31         AROS_LHA(ULONG, type, D0),
  32         AROS_LHA(IPTR,  arg1, A0),
  33         AROS_LHA(IPTR,  arg2, A1),
  34
  35 /*  LOCATION */
  36
  37         struct Library *, CxBase, 5, Commodities)
  38
  39 /*  FUNCTION
  40
  41     Creates a commodity object of type 'type'. This function should never
  42     be called directly; instead, use the macros defined in <libraries/
  43     commodties.h>. Brokers, however, should be created with the CxBroker()
  44     function.
  45
  46     INPUTS
  47
  48     type  -  the type of the commodity object to be created. Possible
  49              types are defined in <libraries/commodities.h>.
  50     arg1  -  depends on the value of 'type' above.
  51     arg2  -  depends on the value of 'type' above.
  52
  53     RESULT
  54
  55     The commodity object or NULL if it couldn't be created. Not so severe
  56     problems in the creation process are recorded in an internal field
  57     retrievable with CxObjError(). These errors are defined in <libraries/
  58     commodities.h>
  59
  60     NOTES
  61
  62     This 'CxObj *' that is returned from this function (and from CxBroker())
  63     is the reference to your commodity object. It shall be used whenever
  64     dealing with your commodity objects (functions operating on commodity
  65     objects and so on).
  66
  67     EXAMPLE
  68
  69     BUGS
  70
  71     SEE ALSO
  72
  73     CxObjError(), CxBroker(), cx_lib/CxSender(), cx_lib/CxSignal(),
  74     cx_lib/CxFilter(), cx_lib/CxTranslate() cx_lib/CxCustom(),
  75     cx_lib/CxDebug()
  76
  77     INTERNALS
  78
  79     HISTORY
  80
  81 ******************************************************************************/
  82
  83 {
  84     AROS_LIBFUNC_INIT
  85
  86     CxObj *co;
  87
  88     DEBUG_CREATECXOBJ(dprintf("CreateCxObj: type %lu Arg1 0x%lx Arg2 0x%lx\n",
  89                               type, arg1, arg2));
  90
  91     if ((co = (CxObj *)AllocCxStructure(CX_OBJECT, type, CxBase)) == NULL)
  92     {
  93         return NULL;      /* No memory for object */
  94     }
  95
  96     D(bug("CreateCxObject: Memory for object allocated.\n"));
  97
  98     co->co_Node.ln_Type = type;
  99     co->co_Flags = COF_ACTIVE;
 100     co->co_Error = 0;
 101
 102     NEWLIST(&co->co_ObjList);
 103
 104     switch (type)
 105     {
 106     case CX_FILTER:
 107         SetFilter(co, (STRPTR)arg1);
 108         break;
 109
 110     case CX_TYPEFILTER:
 111         /* Obsolete and undocumented */
 112         break;
 113
 114     case CX_SEND:
 115         co->co_Ext.co_SendExt->sext_MsgPort = (struct MsgPort *)arg1;
 116         co->co_Ext.co_SendExt->sext_ID = (ULONG)arg2;
 117         break;
 118
 119     case CX_SIGNAL:
 120         co->co_Ext.co_SignalExt->sixt_Task = (struct Task *)arg1;
 121         co->co_Ext.co_SignalExt->sixt_SigBit = (UBYTE)arg2;
 122         break;
 123
 124     case CX_TRANSLATE:
 125         co->co_Ext.co_IE = (struct InputEvent *)arg1;
 126         break;
 127
 128     case CX_BROKER:
 129         BrokerFunc(co, (struct NewBroker *)arg1, CxBase);
 130         break;
 131
 132     case CX_DEBUG:
 133         co->co_Ext.co_DebugID = arg1;
 134         break;
 135
 136     case CX_CUSTOM:
 137         co->co_Ext.co_CustomExt->cext_Action = (APTR)arg1;
 138         co->co_Ext.co_CustomExt->cext_ID = arg2;
 139         break;
 140
 141     default:
 142         break;
 143     }
 144
 145     DEBUG_CREATECXOBJ(dprintf("CreateCxObject: Leaving...\n"));
 146
 147     return co;
 148
 149     AROS_LIBFUNC_EXIT
 150 } /* CxBroker */
 151
 152
 153 VOID BrokerFunc(CxObj *co, struct NewBroker *nbrok, struct Library *CxBase)
 154 {
 155     strncpy(co->co_Ext.co_BExt->bext_Name,  nbrok->nb_Name,  CBD_NAMELEN - 1);
 156     strncpy(co->co_Ext.co_BExt->bext_Title, nbrok->nb_Title, CBD_TITLELEN - 1);
 157     strncpy(co->co_Ext.co_BExt->bext_Descr, nbrok->nb_Descr, CBD_DESCRLEN - 1);
 158
 159     co->co_Ext.co_BExt->bext_Task = FindTask(NULL);
 160
 161     /* Brokers are created inactive */
 162     co->co_Flags &= ~COF_ACTIVE;
 163     co->co_Node.ln_Pri = nbrok->nb_Pri;
 164
 165     co->co_Ext.co_BExt->bext_MsgPort = nbrok->nb_Port;
 166
 167     co->co_Flags |= (UBYTE)nbrok->nb_Flags;
 168 }