fc-tourmaline: src/ui/bmi/mmiBookUtils.h annotate

annotate src/ui/bmi/mmiBookUtils.h @ 51:04aaa5622fa7

disable deep sleep when Iota LEDB is on TI's Iota chip docs say that CLK13M must be running in order for LEDB to work, and practical experience on Mot C139 which uses Iota LEDB for its keypad backlight concurs: if Calypso enters deep sleep while the keypad backlight is turned on, the light flickers visibly as the chipset goes into and out of deep sleep. TI's original L1 sleep manager code had logic to disable deep sleep when LT_Status() returns nonzero, but that function only works for B-Sample and C-Sample LT, always returns 0 on BOARD 41 - no check of Iota LEDB status anywhere. Change this code for our current hardware: disable deep sleep when Iota LEDB has been turned on through LLS.

author	Mychaela Falconia <falcon@freecalypso.org>
date	Mon, 19 Oct 2020 05:11:29 +0000
parents	67bfe9f274f6
children	c0052fe355d3

rev	line source
3 67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	1 #ifndef _MMIBOOKUTILS_H_
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	2 #define _MMIBO0KUTILS_H_ 1
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	3
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	4 /*******************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	5
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	6 CONDAT (UK)
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	7
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	8 ********************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	9
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	10 This software product is the property of Condat (UK) Ltd and may not be
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	11 disclosed to any third party without the express permission of the owner.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	12
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	13 ********************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	14
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	15 $Project name: Basic MMI
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	16 $Project code: BMI (6349)
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	17 $Module: PhoneBook
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	18 $File: MmiBookUtils.h
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	19 $Revision: 1.0
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	20
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	21 $Author: Condat(UK)
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	22 $Date: 25/10/00
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	23
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	24 ********************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	25
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	26 Description:
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	27
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	28 This module provides utility functions for the phone book.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	29
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	30
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	31 ********************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	32
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	33 $History: MmiBookUtils.h
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	34
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	35 25/10/00 Original Condat(UK) BMI version.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	36
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	37 $End
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	38
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	39 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	40
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	41
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	42 /* Include the phonebook types package, it will probably be
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	43 required to get the basic types which are shared by the
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	44 phonebook modules.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	45 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	46 #include "MmiBookShared.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	47 #include "mfw_phb.h"
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	48 /* SPR#1428 - SH - New Editor changes */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	49 #ifndef NEW_EDITOR
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	50 #include "MmiEditor.h" //for editor size definitions
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	51 #endif
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	52 /* bookCurrentWindow
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	53
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	54 This returns the window handle associated with the current
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	55 MFW element
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	56 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	57 tBookMfwHnd bookCurrentWindow( void );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	58
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	59
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	60 /* bookDefaultCallBack
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	61
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	62 This is a simple call back function which is invoked when
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	63 a not implemented dialog is displayed. We don't want anyone
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	64 outside of this module using it so define it as static,
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	65 this will still be callable from the info dialogs as it
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	66 will use the reference we set up.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	67 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	68 static tBookStatus bookDefaultCallBack( tBookMfwHnd win, UBYTE identifier, UBYTE reason );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	69
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	70
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	71 /* bookWindowData
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	72
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	73 This routine is designed to be invoked from within a menu
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	74 handler or call back function and will return a pointer to
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	75 the user data associated with the current MFW element.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	76
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	77 The return value is a pointer to void, therefore the caller
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	78 is responsible for casting this to the correct type prior
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	79 to use.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	80 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	81 void *bookWindowData( void );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	82
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	83
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	84 /* bookMenuSelectedNumber
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	85
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	86 This will return the currently selected entry in the phone
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	87 book, when the routine is being called from a menu handler
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	88 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	89 char *bookMenuSelectedNumber( void );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	90
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	91
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	92 /* bookNotImplemented
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	93
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	94 This will present an information dialog indicating the current
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	95 feature is still under development. This routine will use the
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	96 current MFW element to detect the handle of the parent window
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	97 if the incoming window handle is NULL.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	98 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	99 tBookStatus bookNotImplemented( tBookMfwHnd ParentWindowHandle );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	100 tBookStatus bookMenuNotImplemented( tBookMfwMenu Menu, tBookMfwMenuItem Item );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	101
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	102
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	103
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	104
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	105 /* Utility function to determine if the phone book is
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	106 still in the loading state
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	107 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	108 int bookPhoneBookLoading( void );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	109
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	110
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	111
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	112 /* Utility functions just to throw a string onto the screen
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	113 primarily for debug purposes, the modal version will wait
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	114 for a user input before removing the message, the non-modal
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	115 will clear after three seconds
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	116 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	117 tBookStatus bookInfoDialog( char String1, char String2 );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	118 tBookStatus bookInfoDialogModal( char String, char String2 );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	119
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	120
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	121 /* SPR#1428 - SH - New Editor: No longer required */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	122 #ifndef NEW_EDITOR
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	123 /* Set editing attributes
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	124 This constructs a edit attribute block from the provided
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	125 parameters
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	126 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	127 // GW - Changed colour from 8 bits (foreground) to 2x32bits fgd and bgd
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	128 void bookSetEditAttributes(
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	129 int editZone,
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	130 U32 colindex,
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	131 U8 font, U8 mode, U8 *controls,
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	132 char *text, U16 size,
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	133 MfwEdtAttr* attr);
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	134 #endif
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	135
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	136 /* Memory allocation and freeing functions
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	137
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	138 These routines provided guarded access to the malloc and free
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	139 routines used in the MMI application. The wrapper functions
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	140 provided here allow debugging and tracking information to be
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	141 easily derived, it also allows the memory allocation and
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	142 deallocation to be changed if required.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	143
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	144 Note that the free routine takes a pointer to the pointer
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	145 to the memory being freed. This allows the actual pointer
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	146 value to be set to NULL as part of the free operation, this
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	147 helps protect against reusing the pointer after the memory
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	148 has been deallocated.
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	149
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	150 Sample usage:
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	151
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	152 tStructure *ptr;
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	153
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	154 if ( ( ptr = (tStructure *) bookMemAlloc( sizeof(tStructure) ) ) != NULL )
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	155 {
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	156 // use the allocated memory
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	157 //
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	158 ...
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	159
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	160 // free the memory
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	161 //
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	162 bookMemFree( &ptr );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	163 }
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	164 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	165 void *bookMemAlloc( long int NumBytes );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	166 void bookMemFree( void **Pointer );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	167
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	168
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	169
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	170 /* Name handling utility functions
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	171 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	172 UBYTE bookFindName( UBYTE number, tMmiPhbData *current );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	173 //UBYTE changeName( UBYTE book, T_MFW_PHB_ENTRY entry, T_MFW_PHB_STATUS currentStatus );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	174 //UBYTE deleteName( UBYTE book, UBYTE index, T_MFW_PHB_STATUS *currentStatus );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	175 //UBYTE addName( UBYTE book, T_MFW_PHB_ENTRY entry, T_MFW_PHB_STATUS currentStatus );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	176
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	177 /* File handling functions
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	178 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	179 void changeInFile( T_phbk *phbk );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	180 void deleteFromFile( T_phbk *phbk, UBYTE book );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	181 void storeInFile( T_phbk *phbk );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	182
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	183 /* SPR#1112 - SH - Internal phonebook use */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	184 #ifdef INT_PHONEBOOK
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	185 void bookChangePB(T_MFW_HND win, UBYTE identifier, UBYTE reason);
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	186 UBYTE bookCopy( T_MFW_PHB_ENTRY entry, T_MFW_PHB_STATUS destStatus, T_MFW_PHB_STATUS *srcStatus, UBYTE move);
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	187 void bookCopySingle(T_MFW_HND win, UBYTE identifier, UBYTE reason);
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	188 void bookCopyMultiple(T_MFW_HND win, UBYTE move, UBYTE reason);
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	189 #endif
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	190
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	191 UBYTE bookGetCurrentStatus( T_MFW_PHB_STATUS *currentStatus );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	192 int bookEvent( MfwEvt e, void *para );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	193
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	194 /* Copy name in phonebook structure
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	195 */
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	196 void bookCopyPhbName( T_MFW_PHB_ENTRY* destEntry, T_MFW_PHB_ENTRY* srcEntry, int maxLen );
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	197
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	198
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	199 /*******************************************************************************
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	200
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	201 End of File
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	202
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	203 *******************************************************************************/
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	204
67bfe9f274f6 src/ui: import of src/ui3 from Magnetite Mychaela Falconia <falcon@freecalypso.org> parents: diff changeset	205 #endif

FreeCalypso > hg > fc-tourmaline

annotate src/ui/bmi/mmiBookUtils.h @ 51:04aaa5622fa7