rt-thread/components/rtgui/common/rtgui_app.c

/*
 * File      : rtgui_app.c
 * This file is part of RTGUI in RT-Thread RTOS
 * COPYRIGHT (C) 2012, RT-Thread Development Team
 *
 * The license and distribution terms for this file may be
 * found in the file LICENSE in this distribution or at
 * http://www.rt-thread.org/license/LICENSE
 *
 * Change Logs:
 * Date           Author       Notes
 * 2012-01-13     Grissiom     first version(just a prototype of application API)
 * 2012-07-07     Bernard      move the send/recv message to the rtgui_system.c
 */

#include <rtgui/rtgui_system.h>
#include <rtgui/rtgui_app.h>
#include <rtgui/widgets/window.h>

static void _rtgui_app_constructor(struct rtgui_app *app)
{
	/* set event handler */
	rtgui_object_set_event_handler(RTGUI_OBJECT(app),
			                       rtgui_app_event_handler);

	app->name           = RT_NULL;
	app->icon 			= RT_NULL;
	/* set EXITED so we can destroy an application that just created */
	app->state_flag     = RTGUI_APP_FLAG_EXITED;
	app->ref_count      = 0;
	app->exit_code      = 0;
	app->tid            = RT_NULL;
	app->server         = RT_NULL;
	app->mq             = RT_NULL;
	app->modal_object   = RT_NULL;
	app->main_object    = RT_NULL;
	app->on_idle        = RT_NULL;
}

static void _rtgui_app_destructor(struct rtgui_app *app)
{
	RT_ASSERT(app != RT_NULL);

	rt_free(app->name);
	app->name = RT_NULL;
}

DEFINE_CLASS_TYPE(application, "application",
	RTGUI_OBJECT_TYPE,
	_rtgui_app_constructor,
	_rtgui_app_destructor,
	sizeof(struct rtgui_app));

struct rtgui_app* rtgui_app_create(
        rt_thread_t tid,
        const char *title)
{
	rt_thread_t srv_tid;
	struct rtgui_app *app;
	struct rtgui_event_application event;

	RT_ASSERT(tid != RT_NULL);
	RT_ASSERT(title != RT_NULL);

	/* create application */
	app = RTGUI_APP(rtgui_object_create(RTGUI_APP_TYPE));
	if (app == RT_NULL)
		return RT_NULL;

	/* one thread only can create one rtgui application */
	RT_ASSERT(tid->user_data == 0);
	app->tid = tid;
	/* set user thread */
	tid->user_data = (rt_uint32_t)app;

	app->mq = rt_mq_create("rtgui", sizeof(union rtgui_event_generic), 32, RT_IPC_FLAG_FIFO);
	if (app->mq == RT_NULL)
	{
		rt_kprintf("create msgq failed.\n");
		goto __mq_err;
	}

	/* set application title */
	app->name = (unsigned char*)rt_strdup((char*)title);
	if (app->name == RT_NULL)
		goto __err;

	/* send a message to notify rtgui server */
	srv_tid = rtgui_get_server();
	if (srv_tid == RT_NULL)
	{
		rt_kprintf("gui server is not running.\n");
		goto __err;
	}

	/* create the rtgui server application */
	if (srv_tid == rt_thread_self())
		return app;

	RTGUI_EVENT_APP_CREATE_INIT(&event);
	event.app = app;

	/* notify rtgui server to one application has been created */
	if (rtgui_send_sync(srv_tid, RTGUI_EVENT(&event), sizeof(event)) == RT_EOK)
	{
		return app;
	}

__err:
__mq_err:
	rtgui_object_destroy(RTGUI_OBJECT(app));
	tid->user_data = 0;
	return RT_NULL;
}
RTM_EXPORT(rtgui_app_create);

#define _rtgui_application_check(app)			\
	do {										\
		RT_ASSERT(app != RT_NULL);				\
		RT_ASSERT(app->tid != RT_NULL);			\
		RT_ASSERT(app->tid->user_data != 0);	\
		RT_ASSERT(app->mq != RT_NULL);			\
	} while (0)

void rtgui_app_destroy(struct rtgui_app *app)
{
	rt_thread_t srv_tid;
    _rtgui_application_check(app);

	if (!(app->state_flag & RTGUI_APP_FLAG_EXITED))
	{
		rt_kprintf("cannot destroy a running application: %s.\n",
				   app->name);
		return;
	}

	/* send a message to notify rtgui server */
	srv_tid = rtgui_get_server();
	if (srv_tid != rt_thread_self()) /* must not the server thread */
	{
		struct rtgui_event_application event;
		RTGUI_EVENT_APP_DESTROY_INIT(&event);
		event.app = app;

		if (rtgui_send_sync(srv_tid, RTGUI_EVENT(&event), sizeof(event)) != RT_EOK)
		{
			rt_kprintf("destroy an application in server failed\n");
			return ;
		}
	}

	app->tid->user_data = 0;
	rt_mq_delete(app->mq);
	rtgui_object_destroy(RTGUI_OBJECT(app));
}
RTM_EXPORT(rtgui_app_destroy);

struct rtgui_app* rtgui_app_self(void)
{
	struct rtgui_app *app;
	rt_thread_t self;

	/* get current thread */
	self = rt_thread_self();
	app = (struct rtgui_app*)(self->user_data);

	return app;
}
RTM_EXPORT(rtgui_app_self);

void rtgui_app_set_onidle(rtgui_idle_func_t onidle)
{
	struct rtgui_app *app;

	app = rtgui_app_self();
	if (app != RT_NULL)
		app->on_idle = onidle;
}
RTM_EXPORT(rtgui_app_set_onidle);

rtgui_idle_func_t rtgui_app_get_onidle(void)
{
	struct rtgui_app *app;

	app = rtgui_app_self();
	if (app != RT_NULL)
		return app->on_idle;
	else
		return RT_NULL;
}
RTM_EXPORT(rtgui_app_get_onidle);

rt_inline rt_bool_t _rtgui_application_dest_handle(
		struct rtgui_app *app,
		struct rtgui_event *event)
{
	struct rtgui_event_win* wevent = (struct rtgui_event_win*)event;

	struct rtgui_object* dest_object = RTGUI_OBJECT(wevent->wid);

	if (dest_object != RT_NULL)
	{
		if (dest_object->event_handler != RT_NULL)
			return dest_object->event_handler(RTGUI_OBJECT(dest_object), event);
		else
			return RT_FALSE;
	}
	else
	{
		rt_kprintf("RTGUI ERROR:server sent a event(%d) without wid\n", event->type);
		return RT_FALSE;
	}
}

rt_bool_t rtgui_app_event_handler(struct rtgui_object* object, rtgui_event_t* event)
{
	struct rtgui_app* app;

	RT_ASSERT(object != RT_NULL);
	RT_ASSERT(event != RT_NULL);

	app = RTGUI_APP(object);

	switch (event->type)
	{
	case RTGUI_EVENT_PAINT:
	case RTGUI_EVENT_CLIP_INFO:
	case RTGUI_EVENT_WIN_ACTIVATE:
	case RTGUI_EVENT_WIN_DEACTIVATE:
	case RTGUI_EVENT_WIN_CLOSE:
	case RTGUI_EVENT_WIN_MOVE:
	case RTGUI_EVENT_KBD:
		_rtgui_application_dest_handle(app, event);
		break;

	case RTGUI_EVENT_APP_ACTIVATE:
		if (app->main_object != RT_NULL)
		{
			rtgui_win_activate(RTGUI_WIN(app->main_object));
			if (app->modal_object != RT_NULL)
				rtgui_win_activate(RTGUI_WIN(app->modal_object));
		}
		else if (app->modal_object != RT_NULL)
		{
			rtgui_win_activate(RTGUI_WIN(app->modal_object));
		}
		break;

	case RTGUI_EVENT_APP_DESTROY:
		rtgui_app_exit(app, 0);
		break;

	case RTGUI_EVENT_MOUSE_BUTTON:
	case RTGUI_EVENT_MOUSE_MOTION:
		{
			struct rtgui_event_win* wevent = (struct rtgui_event_win*)event;
			struct rtgui_object* dest_object = RTGUI_OBJECT(wevent->wid);

			// FIXME: let application determine the dest_wiget but not in sever
			// so we can combine this handler with above one
			if (app->modal_object != RT_NULL &&
				dest_object != app->modal_object)
			{
//				rt_kprintf("discard event %s that is not sent to modal object\n",
//						   event_string[event->type]);
			}
			else
			{
				_rtgui_application_dest_handle(app, event);
			}
		}
		break;

	case RTGUI_EVENT_TIMER:
		{
			struct rtgui_timer* timer;
			struct rtgui_event_timer* etimer = (struct rtgui_event_timer*) event;

			timer = etimer->timer;
			if (timer->timeout != RT_NULL)
			{
				/* call timeout function */
				timer->timeout(timer, timer->user_data);
			}
		}
		break;

        case RTGUI_EVENT_COMMAND:
        {
            struct rtgui_event_command *ecmd = (struct rtgui_event_command*)event;

            if (ecmd->wid != RT_NULL)
                    return _rtgui_application_dest_handle(app, event);
        }
	}

	return rtgui_object_event_handler(object, event);
}

rt_inline void _rtgui_application_event_loop(struct rtgui_app *app)
{
	rt_err_t result;
	rt_uint16_t current_ref;
	struct rtgui_event *event;

	_rtgui_application_check(app);

	/* point to event buffer */
	event = (struct rtgui_event*)app->event_buffer;

	current_ref = ++app->ref_count;

	while (current_ref <= app->ref_count)
	{
		RT_ASSERT(current_ref == app->ref_count);

		if (app->on_idle != RT_NULL)
		{
			result = rtgui_recv_nosuspend(event, sizeof(union rtgui_event_generic));
			if (result == RT_EOK)
				RTGUI_OBJECT(app)->event_handler(RTGUI_OBJECT(app), event);
			else if (result == -RT_ETIMEOUT)
				app->on_idle(RTGUI_OBJECT(app), RT_NULL);
		}
		else
		{
			result = rtgui_recv(event, sizeof(union rtgui_event_generic));
			if (result == RT_EOK)
				RTGUI_OBJECT(app)->event_handler(RTGUI_OBJECT(app), event);
		}
	}
}

rt_base_t rtgui_app_run(struct rtgui_app *app)
{
	_rtgui_application_check(app);

	app->state_flag &= ~RTGUI_APP_FLAG_EXITED;

	_rtgui_application_event_loop(app);

	if (app->ref_count == 0)
		app->state_flag |= RTGUI_APP_FLAG_EXITED;

	return app->exit_code;
}
RTM_EXPORT(rtgui_app_run);

void rtgui_app_exit(struct rtgui_app* app, rt_uint16_t code)
{
	--app->ref_count;
	app->exit_code = code;
}
RTM_EXPORT(rtgui_app_exit);

void rtgui_app_activate(struct rtgui_app *app)
{
	struct rtgui_event_application event;

	RTGUI_EVENT_APP_ACTIVATE_INIT(&event);
	event.app = app;

	rtgui_send(app->tid, RTGUI_EVENT(&event), sizeof(struct rtgui_event_application));
}
RTM_EXPORT(rtgui_app_activate);

void rtgui_app_close(struct rtgui_app *app)
{
	struct rtgui_event_application event;

	RTGUI_EVENT_APP_DESTROY_INIT(&event);
	event.app = app;

	rtgui_send(app->tid, RTGUI_EVENT(&event), sizeof(struct rtgui_event_application));
}
RTM_EXPORT(rtgui_app_close);

/**
 * set this application as window manager
 */
rt_err_t rtgui_app_set_as_wm(void)
{
	rt_thread_t srv_tid;
	struct rtgui_event_set_wm event;
	struct rtgui_app* app;

	srv_tid = rtgui_get_server();
	app = rtgui_app_self();
	if (app != RT_NULL && srv_tid != RT_NULL)
	{
		/* notify rtgui server, this is a window manager */
		RTGUI_EVENT_SET_WM_INIT(&event);
		event.app = app;

		rtgui_send_sync(srv_tid, RTGUI_EVENT(&event), sizeof(event));
		return RT_EOK;
	}

	return RT_ERROR;
}
RTM_EXPORT(rtgui_app_set_as_wm);

void rtgui_app_set_main_win(struct rtgui_win* win)
{
	struct rtgui_app *app;

	app = rtgui_app_self();
	if (app != RT_NULL)
	{
		app->main_object = RTGUI_OBJECT(win);
	}
}
RTM_EXPORT(rtgui_app_set_main_win);