rom/workbench/addappmenuitema.c

   1 /*
   2     Copyright © 1995-2007, 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
  87     const struct TagItem     *tagState = taglist;
  88     const struct TagItem     *tag;
  89
  90     struct AppMenuItem *appMenuItem;
  91
  92     appMenuItem = AllocVec(sizeof(struct AppMenuItem), MEMF_CLEAR);
  93
  94     if (appMenuItem == NULL)
  95     {
  96         return NULL;
  97     }
  98
  99     appMenuItem->ami_ID       = id;
 100     appMenuItem->ami_UserData = userdata;
 101     appMenuItem->ami_Text     = text;
 102     appMenuItem->ami_MsgPort  = msgport;
 103
 104     while ((tag = NextTagItem(&tagState)))
 105     {
 106         switch (tag->ti_Tag)
 107         {
 108         case WBAPPMENUA_CommandKeyString:
 109             {
 110                 STRPTR key = (STRPTR)tag->ti_Data;
 111
 112                 if (keyUsed(key, WorkbenchBase))
 113                 {
 114                     appMenuItem->ami_CommandKey = "";
 115                 }
 116                 else
 117                 {
 118                     appMenuItem->ami_CommandKey = key;
 119                 }
 120
 121                 break;
 122             }
 123         }
 124     }
 125
 126     LockWorkbench();
 127     AddTail(&(WorkbenchBase->wb_AppMenuItems), (struct Node *)appMenuItem);
 128     UnlockWorkbench();
 129
 130     /* NotifyWorkbench(WBNOTIFY_Create, WBNOTIFY_AppMenuItem, WorkbenchBase);
 131      */
 132
 133     return appMenuItem;
 134
 135     AROS_LIBFUNC_EXIT
 136 } /* AddAppMenuItemA */
 137
 138
 139 BOOL keyUsed(STRPTR key, struct WorkbenchBase *WorkbenchBase)
 140 {
 141     struct AppMenuItem *ami;
 142     BOOL                found = FALSE;
 143
 144     if (strlen(key) == 0)
 145     {
 146         return FALSE;
 147     }
 148
 149     LockWorkbench();
 150
 151     ForeachNode(&WorkbenchBase->wb_AppMenuItems, ami)
 152     {
 153         if (strlen(ami->ami_CommandKey) != 0 &&
 154             ami->ami_CommandKey[0] == key[0])
 155         {
 156             found = TRUE;
 157             break;
 158         }
 159     }
 160
 161     UnlockWorkbench();
 162
 163     return found;
 164 }