nuttx-apps/include/graphics/nxwidgets/cnxserver.hxx

/****************************************************************************
 * apps/include/graphics/nxwidgets/cnxserver.hxx
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.  The
 * ASF licenses this file to you 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 __APPS_INCLUDE_GRAPHICS_NXWIDGETS_CNXSERVER_HXX
#define __APPS_INCLUDE_GRAPHICS_NXWIDGETS_CNXSERVER_HXX

/****************************************************************************
 * Included Files
 ****************************************************************************/

#include <nuttx/config.h>

#include <stdint.h>
#include <stdbool.h>
#include <semaphore.h>

#include <nuttx/nx/nx.h>
#include <nuttx/nx/nxcursor.h>

#include "graphics/nxwidgets/cnxwindow.hxx"
#include "graphics/nxwidgets/cnxtkwindow.hxx"
#include "graphics/nxwidgets/cbgwindow.hxx"

/****************************************************************************
 * Pre-Processor Definitions
 ****************************************************************************/

/****************************************************************************
 * Implementation Classes
 ****************************************************************************/

#if defined(__cplusplus)

namespace NXWidgets
{
  /**
   * Forward references
   */

  class CBgWindow;

  /**
   * This class represents the NX server.  It includes methods to connect to
   * and disconnect form the NX server, methods to manage the background, and
   * "factory" methods to create window objects on the NX server.  NXWidget
   * objects them may be created on the window objects.
   */

  class CNxServer
  {
  private:
    FAR NX_DRIVERTYPE *m_hDevice;    /**< LCD/Framebuffer device handle */
    NXHANDLE           m_hNxServer;  /**< NX server handle */
    volatile bool      m_running;    /**< True: The listener thread is running */
    volatile bool      m_connected;  /**< True: Connected to the server */
    volatile bool      m_stop;       /**< True: Waiting for the listener thread to stop */
    sem_t              m_connsem;    /**< Wait for server connection */
    static uint8_t     m_nServers;   /**< The number of NX server instances */

    /**
     * NX listener thread.  This is the entry point of a thread that listeners for and
     * dispatches events from the NX server.
     */

    static FAR void *listener(FAR void *arg);

  public:

    /**
     * CNXServer constructor.  The CNxServer is a normally singleton.  However, that
     * not enforced:  This constructor could run more than one in the situation where
     * there are multiple physical displays.  However, that configuration has never
     * been texted.
     */

    CNxServer(void);

    /**
     * CNXServer destructor
     */

    ~CNxServer(void);

    /**
     * Connect to the NX Server
     */

    virtual bool connect(void);

    /**
     * Disconnect from the NX Server
     */

    virtual void disconnect(void);

    /**
     * Get the NX server handle
     *
     * @return The NX server handler (NULL is not connected)
     */

    inline NXHANDLE getServer(void)
    {
      return m_hNxServer;
    }

    /**
     * Test if we are connected to the NX server.
     *
     * @return True is connected; false is not connected.
     */

    inline bool connected(void)
    {
      return m_connected;
    }

    /**
     * Set the background color
     */

     inline bool setBackgroundColor(nxgl_mxpixel_t color)
     {
       return nx_setbgcolor(m_hNxServer, &color) == OK;
     }

    /**
     * Get an instance of a raw NX window.
     */

    inline CNxWindow *createRawWindow(CWidgetControl *widgetControl, uint8_t flags = 0)
    {
      return new CNxWindow(m_hNxServer, widgetControl, flags);
    }

    /**
     * Get an instance of the framed NX window.
     */

    inline CNxTkWindow *createFramedWindow(CWidgetControl *widgetControl, uint8_t flags = 0)
    {
      return new CNxTkWindow(m_hNxServer, widgetControl, flags);
    }

    /**
     * Get an instance of the background window.
     */

    inline CBgWindow *getBgWindow(CWidgetControl *widgetControl)
    {
      return new CBgWindow(m_hNxServer, widgetControl);
    }

#if defined(CONFIG_NX_SWCURSOR) || defined(CONFIG_NX_HWCURSOR)
    /**
     * Enable/disable the cursor.
     *
     * @param enable.  True: show the cursor, false: hide the cursor.
     */

    inline void enableCursor(bool enable)
    {
      nxcursor_enable(m_hNxServer, enable);
    }
#endif

#if defined(CONFIG_NX_SWCURSOR) || defined(CONFIG_NX_HWCURSORIMAGE)
    /**
     * Enable/disable the cursor.
     *
     *   The image is provided a a 2-bits-per-pixel image.  The two bit encoding
     *   is as follows:
     *
     *   0b00 - The transparent background.
     *   0b01 - Color1:  The main color of the cursor.
     *   0b10 - Color2:  The color of any border.
     *   0b11 - 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.
     *
     * @param image.  Describes the cursor image in the expected format..
     */

    inline void setCursorImage(FAR const struct nx_cursorimage_s *image)
    {
      nxcursor_setimage(m_hNxServer, image);
    }
#endif

#if defined(CONFIG_NX_SWCURSOR) || defined(CONFIG_NX_HWCURSOR)
    /**
     * Set the cursor position.
     *
     * @param pos.  The new cursor position.
     */

    inline void setCursorPosition(FAR struct nxgl_point_s *pos)
    {
      nxcursor_setposition(m_hNxServer, pos);
    }
#endif
  };
}

#endif // __cplusplus

#endif // __APPS_INCLUDE_GRAPHICS_NXWIDGETS_CNXSERVER_HXX