rom/workbench/addappmenuitema.c

   1 /*
   2     Copyright © 1995-2003, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Add a menuitem to Workbench's list of AppMenuItems.
   6 */
   7
   8
   9 #include <string.h>
  10
  11 #include <exec/types.h>
  12 #include <exec/ports.h>
  13 #include <utility/tagitem.h>
  14
  15 #include "workbench_intern.h"
  16 #include <workbench/workbench.h>
  17 #include <proto/utility.h>
  18
  19 BOOL keyUsed(STRPTR key, struct WorkbenchBase *WorkbenchBase);
  20
  21 /*****************************************************************************
  22
  23     NAME */
  24         #include <proto/workbench.h>
  25
  26         AROS_LH5(struct AppMenuItem *, AddAppMenuItemA,
  27 /*  SYNOPSIS */
  28         AROS_LHA(ULONG           , id      , D0),
  29         AROS_LHA(ULONG           , userdata, D1),
  30         AROS_LHA(APTR            , text    , A0),
  31         AROS_LHA(struct MsgPort *, msgport , A1),
  32         AROS_LHA(struct TagItem *, taglist , A3),
  33
  34 /*  LOCATION */
  35         struct WorkbenchBase *, WorkbenchBase, 12, Workbench)
  36
  37 /*  FUNCTION
  38
  39     Try to add a menu item to workbench.library's list of AppMenuItems (this
  40     will be shown in the 'Tools' menu strip in Workbench).
  41
  42     INPUTS
  43
  44     id        --  menu item identifier; for your convenience (ignored by
  45                   workbench.library)
  46     userdata  --  user specific data (ignored by workbench.library)
  47     text      --  menu item text; any text consisting merely of '-','_' and
  48                   '~' characters corresponds to a separator bar instead of
  49                   a textual item
  50     msgport   --  port to which notification messages regarding the menu
  51                   item will be sent
  52     taglist   --  tags (see below)
  53
  54     TAGS
  55
  56     WBAPPMENUA_CommandKeyString (STRPTR)
  57     Command key assigned to this menu item. If the string is empty, it will
  58     be ignored as will it if the command key is already in use by another
  59     menu item. Only the first character of the string will be used.
  60     [default = NULL]
  61
  62     RESULT
  63
  64     A pointer to an AppMenuItem which you pass to RemoveAppMenuItem() when
  65     you want to remove the menu item. If it was not possible to add the menu
  66     item, NULL will be returned.
  67
  68     NOTES
  69
  70     Contrary to AmigaOS, this function will report success even when there
  71     is no running workbench application.
  72
  73     EXAMPLE
  74
  75     BUGS
  76
  77     SEE ALSO
  78
  79     RemoveAppMenuItem()
  80
  81     INTERNALS
  82
  83 ******************************************************************************/
  84 {
  85     AROS_LIBFUNC_INIT
  86     AROS_LIBBASE_EXT_DECL(struct WorkbenchBase *, WorkbenchBase)
  87
  88     struct TagItem     *tagState = taglist;
  89     struct TagItem     *tag;
  90
  91     struct AppMenuItem *appMenuItem;
  92
  93     appMenuItem = AllocVec(sizeof(struct AppMenuItem), MEMF_ANY | MEMF_CLEAR);
  94
  95     if (appMenuItem == NULL)
  96     {
  97         return NULL;
  98     }
  99
 100     appMenuItem->ami_ID       = id;
 101     appMenuItem->ami_UserData = userdata;
 102     appMenuItem->ami_Text     = text;
 103     appMenuItem->ami_MsgPort  = msgport;
 104
 105     while ((tag = NextTagItem(&tagState)))
 106     {
 107         switch (tag->ti_Tag)
 108         {
 109         case WBAPPMENUA_CommandKeyString:
 110             {
 111                 STRPTR key = (STRPTR)tag->ti_Data;
 112
 113                 if (keyUsed(key, WorkbenchBase))
 114                 {
 115                     appMenuItem->ami_CommandKey = "";
 116                 }
 117                 else
 118                 {
 119                     appMenuItem->ami_CommandKey = key;
 120                 }
 121
 122                 break;
 123             }
 124         }
 125     }
 126
 127     LockWorkbench();
 128     AddTail(&(WorkbenchBase->wb_AppMenuItems), (struct Node *)appMenuItem);
 129     UnlockWorkbench();
 130
 131     /* NotifyWorkbench(WBNOTIFY_Create, WBNOTIFY_AppMenuItem, WorkbenchBase);
 132      */
 133
 134     return appMenuItem;
 135
 136     AROS_LIBFUNC_EXIT
 137 } /* AddAppMenuItemA */
 138
 139
 140 BOOL keyUsed(STRPTR key, struct WorkbenchBase *WorkbenchBase)
 141 {
 142     struct AppMenuItem *ami;
 143     BOOL                found = FALSE;
 144
 145     if (strlen(key) == 0)
 146     {
 147         return FALSE;
 148     }
 149
 150     LockWorkbench();
 151
 152     ForeachNode(&WorkbenchBase->wb_AppMenuItems, ami)
 153     {
 154         if (strlen(ami->ami_CommandKey) != 0 &&
 155             ami->ami_CommandKey[0] == key[0])
 156         {
 157             found = TRUE;
 158             break;
 159         }
 160     }
 161
 162     UnlockWorkbench();
 163
 164     return found;
 165 }