Minor fixes to comments.
[AROS.git] / rom / intuition / itemaddress.c
blobb040f493a7b406b76cfdd02493092d017ae8b50f
1 /*
2 Copyright © 1995-2007, The AROS Development Team. All rights reserved.
3 Copyright © 2001-2003, The MorphOS Development Team. All Rights Reserved.
4 $Id$
5 */
7 #include "intuition_intern.h"
9 #define DEBUG_ITEMADDRESS(x) ;
10 #define DEBUG_ITEMADDRESS2(x) ;
12 /*****************************************************************************
14 NAME */
15 #include <proto/intuition.h>
17 AROS_LH2(struct MenuItem *, ItemAddress,
19 /* SYNOPSIS */
20 AROS_LHA(struct Menu *, menustrip, A0),
21 AROS_LHA(UWORD , menunumber, D0),
23 /* LOCATION */
24 struct IntuitionBase *, IntuitionBase, 24, Intuition)
26 /* FUNCTION
27 Returns the address of the menuitem 'menunumber' of 'menustrip'.
28 The number is the one you get from intuition after the user has
29 selected a menu.
30 The menunumber must be well-defined.
31 Valid numbers are MENUNULL, which makes the routine return NULL,
32 or valid item number of your menustrip, which contains
33 - a valid menu number
34 - a valid item number
35 - if the menu-item has a sub-item, a valid sub-item number
36 Menu number and item number must be specified. Sub-item, if
37 available, is optional, therefore this function returns either
38 the item or sub-item.
40 INPUTS
41 menustrip - Pointer to the first menu of the menustrip.
42 menunumber - Packed value describing the menu, item and if
43 appropriate sub-item.
45 RESULT
46 Returns NULL for menunumber == MENUNULL or the address of the
47 menuitem described by menunumber.
49 NOTES
51 EXAMPLE
53 BUGS
55 SEE ALSO
57 INTERNALS
59 HISTORY
61 *****************************************************************************/
63 AROS_LIBFUNC_INIT
65 struct Menu *thismenu;
66 struct MenuItem *thisitem = NULL;
67 int i;
69 DEBUG_ITEMADDRESS(dprintf("ItemAddress: Strip %p Number 0x%lx (%d/%d/%d)\n",
70 menustrip, menunumber, MENUNUM(menunumber),
71 ITEMNUM(menunumber), SUBNUM(menunumber)));
73 IntuitionBase = IntuitionBase; /* shut up the compiler */
75 SANITY_CHECKR(menustrip,NULL)
77 if ( menunumber != MENUNULL )
79 thismenu = menustrip;
80 DEBUG_ITEMADDRESS2(dprintf("ItemAddress: Menu %p\n", thismenu));
82 for ( i = 0 ; thismenu && i < MENUNUM ( menunumber ) ; i++ )
84 thismenu = thismenu->NextMenu;
85 DEBUG_ITEMADDRESS2(dprintf("ItemAddress: Menu %p\n", thismenu));
88 if (thismenu)
90 thisitem = thismenu->FirstItem;
91 DEBUG_ITEMADDRESS2(dprintf("ItemAddress: Item %p\n", thisitem));
93 for ( i = 0 ; thisitem && i < ITEMNUM ( menunumber ) ; i++ )
95 thisitem = thisitem->NextItem;
96 DEBUG_ITEMADDRESS2(dprintf("ItemAddress: Item %p\n", thisitem));
99 if (thisitem && ( SUBNUM ( menunumber ) != NOSUB ) && thisitem->SubItem )
101 thisitem = thisitem->SubItem;
102 DEBUG_ITEMADDRESS2(dprintf("ItemAddress: SubItem %p\n", thisitem));
104 for ( i = 0 ; thisitem && i < SUBNUM ( menunumber ) ; i++ )
106 DEBUG_ITEMADDRESS2(dprintf("ItemAddress: SubItem %p\n", thisitem));
107 thisitem = thisitem->NextItem;
113 DEBUG_ITEMADDRESS(dprintf("ItemAddress: return %p\n", thisitem));
115 return thisitem;
117 AROS_LIBFUNC_EXIT
118 } /* ItemAddress */