MTK

开发平台：
C/C++

wgui_dynamic_menuitems.c：源码内容
							/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
/*******************************************************************************
* Filename:
* ---------
*  wgui_dynamic_menuitems.c
*
* Project:
* --------
*   PlutoMMI
*
* Description:
* ------------
*   In order to use limited memory (size decided in compile-time) to load unlimited items (size decide in run-time) 
*   to a category screen, a modification in MMI for dynamic item loading is required as the following.
*
* Author:
* -------
*  Tim Chen
*
*******************************************************************************/
#include "MMI_features.h"
#include "gui_setting.h"
#include "wgui.h"
#include "wgui_fixed_menuitems.h"
#include "wgui_dynamic_menuitems.h"
#include "DebugInitDef.h"
/* global variables */
dynamic_item_circular_buffer_t dynamic_item_buffer;
BOOL dynamic_item_text_align_left = FALSE;  /* 032905 Calvin added */
/*****************************************************************************
 * FUNCTION
 *  init_dynamic_item_buffer
 * DESCRIPTION
 *  initialize the global dynamic item buffer
 * PARAMETERS
 *  n_items             [IN]        total number of items
 *  get_item_func       [IN]        a callback function for filling in item text & image at run time
 *  get_hint_func       [IN]        a callback function to get hint data
 *  flush_data_func     [IN]        a callback function when cached data is flushed )flush_dynamic_item_buffer_before_load_chunk())
 * RETURNS
 *  void
 *****************************************************************************/
void init_dynamic_item_buffer(
        S32 n_items,
        GetItemFuncPtr get_item_func,
        GetHintFuncPtr get_hint_func,
        FlushDataFuncPtr flush_data_func)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    dynamic_item_buffer.load_func = get_item_func;
    dynamic_item_buffer.hint_func = get_hint_func;
    dynamic_item_buffer.flush_func = flush_data_func;
    /* PMT VIKAS START 20051202 */
#ifdef __MMI_UI_LIST_HIGHLIGHT_EFFECTS__
    gui_add_cleanup_hook(gui_stop_list_highlight_effect);
#endif 
    /* PMT VIKAS END 20051202 */
    if (MMI_fixed_list_menu.flags & UI_LIST_MENU_DISABLE_CACHE_DYNAMIC_DATA)
    {
        /* Special case for JAM (Java application manager) */
        if (flush_data_func)
        {
            flush_data_func();
        }
        load_dynamic_item_buffer((MMI_MAX_MENUITEMS_IN_CONTENT < n_items) ? MMI_MAX_MENUITEMS_IN_CONTENT : n_items);
    }
    else
    {
        load_dynamic_item_buffer(n_items);
    }
    dynamic_item_buffer.n_total_items = n_items;
}
/*****************************************************************************
 * FUNCTION
 *  load_dynamic_item_buffer
 * DESCRIPTION
 *  Used internally by init_dynamic_item_buffer()
 * PARAMETERS
 *  n_items     [IN]        total number of items
 * RETURNS
 *  void
 *****************************************************************************/
void load_dynamic_item_buffer(S32 n_items)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    S32 i;
    PU8 image;
    U32 flags = 0;  /* 032905 Calvin added */
    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    dynamic_item_buffer.head_item_index = 0;
    dynamic_item_buffer.head = 0;
    dynamic_item_buffer.tail = 0;
    dynamic_item_buffer.count = 0;
    dynamic_item_buffer.n_total_items = n_items;
    if (n_items > MAX_DYNAMIC_ITEMS_BUFF)
    {
        n_items = MAX_DYNAMIC_ITEMS_BUFF;
    }
    /* 032905 Calvin added */
    if (dynamic_item_text_align_left)
    {
        flags = UI_MENUITEM_DISABLE_ICON;
    }
    for (i = 0; i < n_items; i++)
    {
        if (dynamic_item_buffer.load_func(i, (UI_string_type) subMenuData[i], &image, 3))
        {
            MMI_fixed_icontext_menuitems[i].item_icon = image;
            MMI_fixed_icontext_menuitems[i].item_text = (UI_string_type) subMenuData[i];
            MMI_fixed_icontext_menuitems[i].flags = flags;  /* 032905 Calvin modified */
            dynamic_item_buffer.count++;
        }
        else
        {
            break;
        }
    }
    dynamic_item_buffer.tail = dynamic_item_buffer.count & MASK_DYNAMIC_ITEMS_BUFF;
}
/*****************************************************************************
 * FUNCTION
 *  get_dynamic_item_from_buffer
 * DESCRIPTION
 *  a convenient function to get the pointer of a item in the buffer
 * PARAMETERS
 *  index       [IN]        index of the item to be retrieved
 * RETURNS
 *  fixed_icontext_menuitem_type*
 *****************************************************************************/
fixed_icontext_menuitem_type *get_dynamic_item_from_buffer(S32 index)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    /* pre-condition: in_dynamic_item_buffer( index ) return TRUE */
    return &MMI_fixed_icontext_menuitems[(index - dynamic_item_buffer.head_item_index +
                                          dynamic_item_buffer.head) & MASK_DYNAMIC_ITEMS_BUFF];
}
/*****************************************************************************
 * FUNCTION
 *  in_dynamic_item_buffer
 * DESCRIPTION
 *  a convenient function to check whether a item is loaded in buffer
 * PARAMETERS
 *  index       [IN]        index of the item to be checked
 * RETURNS
 *  pBOOL : TRUE / FALSE
 *****************************************************************************/
pBOOL in_dynamic_item_buffer(S32 index)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    S32 count;
    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    if (dynamic_item_buffer.count == 0)
    {
        return FALSE;
    }
    count = index - dynamic_item_buffer.head_item_index;
    if (count < 0 || count >= dynamic_item_buffer.count)
    {
        return FALSE;
    }
    return TRUE;
}
/*****************************************************************************
 * FUNCTION
 *  flush_dynamic_item_buffer_before_load_chunk
 * DESCRIPTION
 *  Used before load_chunk_dynamic_item_buffer to flush all cached data.
 * PARAMETERS
 *  void
 * RETURNS
 *  void
 *****************************************************************************/
void flush_dynamic_item_buffer_before_load_chunk(void)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    dynamic_item_buffer.head_item_index = 0;
    dynamic_item_buffer.head = 0;
    dynamic_item_buffer.tail = 0;
    dynamic_item_buffer.count = 0;
    if (dynamic_item_buffer.flush_func)
    {
        dynamic_item_buffer.flush_func();
    }
    /* Keep n_total_items, load_func, flush_func, and hint_func unchanged */
}
/*****************************************************************************
 * FUNCTION
 *  load_chunk_dynamic_item_buffer
 * DESCRIPTION
 *  load a chunk of items, starting from [start_index] to [start_index+n_items-1], to buffer
 *  the loading machnism will try to maintain the contiguous buffer as big as possible
 * IMPACT
 *  this function may unload some other items in the buffer
 * PARAMETERS
 *  start_index     [IN]        the starting index of requested items
 *  n_items         [IN]        the number of items to be loaded
 * RETURNS
 *  S32 : the number of items that are loaded successfully
 *****************************************************************************/
S32 load_chunk_dynamic_item_buffer(S32 start_index, S32 n_items)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    S32 size;
    S32 i, count, start, offset, index;
    PU8 image;
    U32 flags = 0;  /* 032905 Calvin added */
    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    /*
     * If UI_LIST_MENU_DISABLE_CACHE_DYNAMIC_DATA is set, flush_dynamic_item_buffer_before_load_chunk()
     * * should be invoked before load_chunk_dynamic_item_buffer().
     */
    MMI_ASSERT(!(MMI_fixed_list_menu.flags & UI_LIST_MENU_DISABLE_CACHE_DYNAMIC_DATA) ||
               (n_items <= MMI_MAX_MENUITEMS_IN_CONTENT && dynamic_item_buffer.count == 0));
    if (dynamic_item_buffer.count == 0)
    {
        offset = 0;
    }
    else
    {
        offset = start_index - dynamic_item_buffer.head_item_index;
    }
    /* protect when n_items > MAX_DYNAMIC_ITEMS_BUFF */
    if (n_items > MAX_DYNAMIC_ITEMS_BUFF)
    {
        n_items = MAX_DYNAMIC_ITEMS_BUFF;
    }
    else if (start_index + n_items > dynamic_item_buffer.n_total_items)
    {
        n_items = dynamic_item_buffer.n_total_items - start_index;
    }
    if (n_items <= 0)
    {
        return 0;
    }
    /* protect when index out of bound */
    if (offset + n_items > dynamic_item_buffer.n_total_items)
    {
        n_items = dynamic_item_buffer.n_total_items - offset;
    }
    start = (offset + dynamic_item_buffer.head) & MASK_DYNAMIC_ITEMS_BUFF;
    /* 032905 Calvin added */
    if (dynamic_item_text_align_left)
    {
        flags = UI_MENUITEM_DISABLE_ICON;
    }
    for (count = 0, index = start_index, i = start; count < n_items;
         count++, index++, i = (i + 1) & MASK_DYNAMIC_ITEMS_BUFF)
    {
        if (!in_dynamic_item_buffer(index))
        {
            if (dynamic_item_buffer.load_func(index, (UI_string_type) subMenuData[i], &image, 3))
            {
                MMI_fixed_icontext_menuitems[i].item_icon = image;
                MMI_fixed_icontext_menuitems[i].item_text = (UI_string_type) subMenuData[i];
                MMI_fixed_icontext_menuitems[i].flags = flags;  /* 032905 Calvin modified */
            }
            else
            {
                break;
            }
        }
    }
    if (count == 0)
    {
        return 0;
    }
    if (dynamic_item_buffer.count == 0 || (offset < 0 && offset + count < 0) || (offset > dynamic_item_buffer.count))
    {
        dynamic_item_buffer.head_item_index = start_index;
        dynamic_item_buffer.head = start;
        dynamic_item_buffer.tail = i;
        dynamic_item_buffer.count = count;
    }
    else if (offset < 0)
    {
        dynamic_item_buffer.head_item_index = start_index;
        dynamic_item_buffer.head = start;
        size = dynamic_item_buffer.count - offset;
        if (size > MAX_DYNAMIC_ITEMS_BUFF)
        {
            size = MAX_DYNAMIC_ITEMS_BUFF;
        }
        else if (size < count)
        {
            size = count;
        }
        dynamic_item_buffer.tail = (start + size) & MASK_DYNAMIC_ITEMS_BUFF;
        dynamic_item_buffer.count = size;
    }
    else
    {
        size = count + offset;
        if (size > MAX_DYNAMIC_ITEMS_BUFF)
        {
            dynamic_item_buffer.head = dynamic_item_buffer.tail = i;
            dynamic_item_buffer.head_item_index = index - MAX_DYNAMIC_ITEMS_BUFF;
            dynamic_item_buffer.count = MAX_DYNAMIC_ITEMS_BUFF;
        }
        else if (size > dynamic_item_buffer.count)
        {
            dynamic_item_buffer.tail = (dynamic_item_buffer.head + size) & MASK_DYNAMIC_ITEMS_BUFF;
            dynamic_item_buffer.count = size;
        }
    }
    return count;
}
/*****************************************************************************
 * FUNCTION
 *  resize_dynamic_icontext_menuitems_to_list_width
 * DESCRIPTION
 *  adjust the menu width if needed
 * PARAMETERS
 *  void
 * RETURNS
 *  void
 *****************************************************************************/
void resize_dynamic_icontext_menuitems_to_list_width(void)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    if (MMI_fixed_list_menu.flags & UI_LIST_MENU_AUTO_DISABLE_SCROLLBAR)
    {
        MMI_fixed_list_menu.flags |= UI_LIST_MENU_DISABLE_DRAW;
        gui_show_dynamic_list_menu(&MMI_fixed_list_menu);
        MMI_fixed_list_menu.flags &= ~UI_LIST_MENU_DISABLE_DRAW;
        if (MMI_fixed_list_menu.vbar.scale >= MMI_fixed_list_menu.vbar.range)
        {
            resize_fixed_icontext_menuitems(
                MMI_fixed_list_menu.width - 4,
                get_menu_item_height() /* MMI_fixed_icontext_menuitem.height */ );
        }
    }
    else if (MMI_fixed_list_menu.flags & UI_LIST_MENU_DISABLE_SCROLLBAR)
    {
        resize_fixed_icontext_menuitems(MMI_fixed_list_menu.width - 4, get_menu_item_height());
    }
}

						