vsf_tgui.h

Go to the documentation of this file.

/****************************************************************************
*  Copyright 2020 by Gorgon Meducer (Email:embedded_zhuoran@hotmail.com)    *
*                                                                           *
*  Licensed under the Apache License, Version 2.0 (the "License");          *
*  you may not use this file except in compliance with the License.         *
*  You may obtain a copy of the License at                                  *
*                                                                           *
*     http://www.apache.org/licenses/LICENSE-2.0                            *
*                                                                           *
*  Unless required by applicable law or agreed to in writing, software      *
*  distributed under the License is distributed on an "AS IS" BASIS,        *
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
*  See the License for the specific language governing permissions and      *
*  limitations under the License.                                           *
*                                                                           *
****************************************************************************/
 
/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_TINY_GUI_H__
#define __VSF_TINY_GUI_H__
 
/*============================ INCLUDES ======================================*/
#include "./vsf_tgui_cfg.h"
 
#if VSF_USE_TINY_GUI == ENABLED
 
#ifndef VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE
#if VSF_TGUI_CFG_RENDERING_TEMPLATE_SEL == VSF_TGUI_V_TEMPLATE_SIMPLE_VIEW
#   define VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE "./view/simple_view/vsf_tgui_v_type.h"
#elif VSF_TGUI_CFG_RENDERING_TEMPLATE_SEL == VSF_TGUI_V_TEMPLATE_SCGUI_VIEW
#   define VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE "./view/scgui_view/vsf_tgui_v_type.h"
#else
#   undef VSF_TGUI_CFG_RENDERING_TEMPLATE_SEL
#   define VSF_TGUI_CFG_RENDERING_TEMPLATE_SEL  VSF_TGUI_V_TEMPLATE_EXAMPLE
#   define VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE "./view/template/vsf_tgui_v_type.h"
#endif
#include VSF_TGUI_V_TEMPLATE_TYPE_HEADER_FILE
#endif
 
#include "utilities/vsf_tgui_text.h"
 
#if     defined(__VSF_TGUI_CLASS_IMPLEMENT)
#   define __PLOOC_CLASS_IMPLEMENT__
 
#elif   defined(__VSF_TGUI_CLASS_INHERIT)
#   define __PLOOC_CLASS_INHERIT__
 
#endif   
 
#include "utilities/ooc_class.h"
 
/*============================ MACROS ========================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
declare_vsf_rng_buf(__vsf_tgui_evt_queue_t)
 
def_vsf_rng_buf(__vsf_tgui_evt_queue_t, vsf_tgui_evt_t)
 
declare_structure(__vk_tgui_focus_t)
 
def_structure(__vk_tgui_focus_t)
    const vsf_tgui_control_t* current_ptr;
    const vsf_tgui_control_t* previous_ptr;
end_def_structure(__vk_tgui_focus_t)
 
declare_vsf_pt(__vsf_tgui_evt_shooter_t)
 
def_vsf_pt(__vsf_tgui_evt_shooter_t,
    def_params(
        __vsf_tgui_evt_queue_t* queue_ptr;
        vsf_msgt_t* msg_tree_ptr;
        const vsf_tgui_root_container_t * root_node_ptr;
        const vsf_msgt_node_t*          node_ptr;
        vsf_tgui_evt_t                  event;
        const vsf_tgui_region_t*        region_ptr;
        vsf_tgui_region_t               temp_region;
 
        __vk_tgui_focus_t Activated;
 
#if VSF_TGUI_CFG_SUPPORT_MOUSE_LIKE_EVENTS == ENABLED
        __vk_tgui_focus_t pointer_above;
#endif
 
        struct {
            //uint8_t bIsActivatedControlChanged  : 1;
            uint8_t is_queue_drain               : 1;
#if     VSF_TGUI_CFG_SUPPORT_DIRTY_REGION == ENABLED                            \
    &&  VSF_TGUI_CFG_SUPPORT_TRANSPARENT_CONTROL == ENABLED
            uint8_t is_dirty_region_include_transparent_area : 1;
#endif
        } Attribute;
        
    ))
end_def_vsf_pt(__vsf_tgui_evt_shooter_t)
 
 
declare_class(vsf_tgui_t)
 
def_class(vsf_tgui_t,
    private_member(
        implement(vsf_msgt_t)
        implement_ex(__vsf_tgui_evt_shooter_t, consumer)
        __vsf_tgui_evt_queue_t msg_queue;
 
        struct {
            int8_t finger_idx_pre;
            union {
                struct {
                    uint8_t is_finger0_down     : 1;
                    uint8_t is_finger1_down     : 1;
                    uint8_t                     : 6;
                    vsf_tgui_location_t         location_pre[2];
                };
                uint8_t status;
            }finger;
            vsf_tgui_location_t current[2];
        }input;
    )
    protected_member(
        implement(vsf_tgui_v_port_t)
    )
)
end_def_class(vsf_tgui_t)
 
typedef struct vsf_tgui_cfg_t {
    vsf_mem_t evt_queue;
 
#if VSF_TGUI_CFG_REFRESH_SCHEME == VSF_TGUI_REFRESH_SCHEME_BREADTH_FIRST_TRAVERSAL
    vsf_mem_t bfs_queue;
#endif
 
    const vsf_tgui_root_container_t* root_node_ptr;
    vsf_prio_t                      priority;
    bool                            is_ignore_first_refresh;
 
}vsf_tgui_cfg_t;
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ PROTOTYPES ====================================*/
 
 
extern 
vsf_err_t vk_tgui_init(vsf_tgui_t* gui_ptr, const vsf_tgui_cfg_t *cfg_ptr);
 
extern 
vsf_err_t vk_tgui_set_root_container(vsf_tgui_t* gui_ptr, 
                                    vsf_tgui_root_container_t *root_node_ptr,
                                    bool req_first_refresh);
 
extern
vsf_err_t vk_tgui_close_root_container(vsf_tgui_t* gui_ptr);
 
extern 
bool vk_tgui_send_message(vsf_tgui_t *gui_ptr, vsf_tgui_evt_t event);
 
extern 
bool vk_tgui_update(vsf_tgui_t *gui_ptr, 
                    const vsf_tgui_control_t *target_ptr);
 
extern
bool vk_tgui_update_tree(vsf_tgui_t* gui_ptr,
                        const vsf_tgui_control_t* target_ptr);
 
extern
bool vk_tgui_send_timer_event(  vsf_tgui_t* gui_ptr,
                                const vsf_tgui_control_t* target_ptr);
 
extern
const vsf_tgui_control_t *vsf_tgui_actived_control_get(vsf_tgui_t *gui_ptr);
 
#if VSF_TGUI_CFG_SUPPORT_MOUSE_LIKE_EVENTS == ENABLED
extern
const vsf_tgui_control_t *vsf_tgui_pointed_control_get(vsf_tgui_t *gui_ptr);
#endif
 
#if VSF_TGUI_CFG_REFRESH_SCHEME != VSF_TGUI_REFRESH_SCHEME_NONE
extern
bool vk_tgui_refresh(vsf_tgui_t *gui_ptr);
 
// region_ptr is relative region to target_ptr
extern
bool vk_tgui_refresh_ex(    vsf_tgui_t *gui_ptr, 
                            const vsf_tgui_control_t *target_ptr, 
                            const vsf_tgui_region_t *region_ptr);
 
extern
bool vk_tgui_refresh_dirty( vsf_tgui_t* gui_ptr,
                            vsf_tgui_control_t* target_ptr);
 
 
extern
vsf_tgui_region_t* vsf_tgui_v_refresh_loop_begin(
                            vsf_tgui_t* gui_ptr,
                            const vsf_tgui_region_t* ptPlannedRefreshRegion);
 
extern
bool vsf_tgui_v_refresh_loop_end(vsf_tgui_t* gui_ptr);
 
extern
void vsf_tgui_low_level_refresh_ready(vsf_tgui_t *gui_ptr);
 
/*----------------------------------------------------------------------------*
 * Input related APIs                                                         *
 *----------------------------------------------------------------------------*/
extern
vsf_err_t vsf_tgui_send_touch_evt(  vsf_tgui_t *tgui_ptr,
                                    uint_fast8_t finger_idx,
                                    vsf_tgui_location_t position, 
                                    bool is_down,
                                    int32_t duration);
extern
const vsf_tgui_location_t *vsf_tgui_get_pointer_location(vsf_tgui_t *gui_ptr, 
                                                        int_fast8_t idx);
 
extern
bool vsf_tgui_set_pointer_location(  vsf_tgui_t *gui_ptr, 
                                        int_fast8_t idx, 
                                        vsf_tgui_location_t *location_ptr);
 
#ifdef __VSF_TGUI_CLASS_IMPLEMENT
extern 
bool __vk_tgui_send_touch_evt(  vsf_tgui_t *tgui_ptr,
                                uint_fast8_t finger_idx,
                                vsf_evt_t   msg,
                                vsf_tgui_location_t position );
 
extern 
bool __vk_tgui_send_gesture_evt(vsf_tgui_t *tgui_ptr,
                                uint_fast8_t finger_idx,
                                vsf_evt_t   msg,
                                vsf_tgui_location_t delta,
                                int32_t duration );
#endif
 
/*============================ INCLUDES ======================================*/
 
#include "./controls/vsf_tgui_controls.h"
#include "./view/vsf_tgui_v.h"
 
#include "./ext/dynamic/vsf_tgui_dynamic.h"
 
#include "./port/vsf_tgui_port.h"
 
#endif
#endif
 
#undef __VSF_TGUI_CLASS_IMPLEMENT
#undef __VSF_TGUI_CLASS_INHERIT
#endif
/* EOF */