incubator-nuttx/libs/libnx/nxmu/nx_cursor.c

229 lines
7.4 KiB
C

/****************************************************************************
* libs/libnx/nxmu/nx_cursor.c
*
* Copyright (C) 2019 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <assert.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/nx/nx.h>
#include <nuttx/nx/nxmu.h>
#include <nuttx/nx/nxcursor.h>
#if defined(CONFIG_NX_SWCURSOR) || defined(CONFIG_NX_HWCURSOR)
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: nxcursor_enable
*
* Description:
* Enable/disable presentation of the cursor
*
* Input Parameters:
* hnd - The server handle returned by nx_connect()
* enable - True: show the cursor, false: hide the cursor.
*
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
int nxcursor_enable(NXHANDLE hnd, bool enable)
{
FAR struct nxmu_conn_s *conn = (FAR struct nxmu_conn_s *)hnd;
struct nxsvrmsg_curenable_s outmsg;
int ret;
/* Send the cursor enable/disable message */
outmsg.msgid = NX_SVRMSG_CURSOR_ENABLE;
outmsg.enable = enable;
ret = nxmu_sendserver(conn, &outmsg, sizeof(struct nxsvrmsg_curenable_s));
if (ret < 0)
{
gerr("ERROR: nxmu_sendserver() returned %d\n", ret);
set_errno(-ret);
return ERROR;
}
return OK;
}
/****************************************************************************
* Name: nxcursor_setimage
*
* Description:
* Set the cursor image.
*
* The image is provided a a 2-bits-per-pixel image. The two bit encoding
* is as follows:
*
* 00 - The transparent background
* 01 - Color1: The main color of the cursor
* 10 - Color2: The color of any border
* 11 - Color3: A blend color for better imaging (fake anti-aliasing).
*
* NOTE: The NX logic will reference the user image buffer repeatedly.
* That image buffer must persist for as long as the NX server connection
* persists.
*
* Input Parameters:
* hnd - The server handle returned by nx_connect()
* image - Describes the cursor image in the expected format.
*
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
#if defined(CONFIG_NX_HWCURSORIMAGE) || defined(CONFIG_NX_SWCURSOR)
int nxcursor_setimage(NXHANDLE hnd, FAR const struct nx_cursorimage_s *image)
{
FAR struct nxmu_conn_s *conn = (FAR struct nxmu_conn_s *)hnd;
struct nxsvrmsg_curimage_s outmsg;
int ret;
DEBUGASSERT(hnd != NULL && image != NULL);
/* Send the new cursor image to the server */
outmsg.msgid = NX_SVRMSG_CURSOR_IMAGE;
outmsg.image.size.w = image->size.w;
outmsg.image.size.h = image->size.h;
outmsg.image.image = image->image; /* The user pointer is sent, no data */
nxgl_colorcopy(outmsg.image.color1, image->color1);
nxgl_colorcopy(outmsg.image.color1, image->color1);
nxgl_colorcopy(outmsg.image.color1, image->color1);
/* We will finish the teardown upon receipt of the DISCONNECTED message */
ret = nxmu_sendserver(conn, &outmsg, sizeof(struct nxsvrmsg_curimage_s));
if (ret < 0)
{
gerr("ERROR: nxmu_sendserver() returned %d\n", ret);
set_errno(-ret);
return ERROR;
}
return OK;
}
#endif
/****************************************************************************
* Name: nxcursor_setposition
*
* Description:
* Move the cursor to the specified position
*
* Input Parameters:
* hnd - The server handle returned by nx_connect()
* pos - The new cursor position
*
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
int nxcursor_setposition(NXHANDLE hnd, FAR const struct nxgl_point_s *pos)
{
FAR struct nxmu_conn_s *conn = (FAR struct nxmu_conn_s *)hnd;
struct nxsvrmsg_curpos_s outmsg;
int ret;
DEBUGASSERT(hnd != NULL && pos != NULL);
/* Send the new cursor position to the server */
outmsg.msgid = NX_SVRMSG_CURSOR_SETPOS;
outmsg.pos.x = pos->x;
outmsg.pos.y = pos->y;
/* We will finish the teardown upon receipt of the DISCONNECTED message */
ret = nxmu_sendserver(conn, &outmsg, sizeof(struct nxsvrmsg_curpos_s));
if (ret < 0)
{
gerr("ERROR: nxmu_sendserver() returned %d\n", ret);
set_errno(-ret);
return ERROR;
}
return OK;
}
/****************************************************************************
* Name: nxcursor_get_position
*
* Description:
* Return the current cursor position.
*
* CAUTION: The current cursor position is not updated until the display
* is actually changed. Due to asynchronies caused by queue, the new
* current cursor position may not match the cursor position set until
* the client and server are syncrhonized.
*
* Input Parameters:
* hnd - The server handle returned by nx_connect()
* pos - The location to return the cursor position
*
* Returned Value:
* OK on success; ERROR on failure with errno set appropriately
*
****************************************************************************/
int nxcursor_get_position(NXHANDLE hnd, FAR struct nxgl_point_s *pos)
{
/* REVISIT: The cursor position is not accessible from here. It is in hnd,
* be we don't have the definitions exposed to get it.
*/
#warning Missing logic
set_errno(ENOSYS);
return ERROR;
}
#endif /* __INCLUDE_NUTTX_NX_NXCURSOR_H */