minigui.h

Go to the documentation of this file.

/*
 * $Id: minigui.h,v 1.115.2.9 2006/06/05 09:22:36 xwyan Exp $
 * 
 *             MiniGUI for Linux/uClinux, eCos, uC/OS-II, VxWorks, 
 *                     pSOS, ThreadX, NuCleus, OSE, and Win32 version 1.6.x
 *
 *             Copyright (C) 2002-2006 Feynman Software.
 *             Copyright (C) 1998-2002 Wei Yongming.
 */

#ifndef _MGUI_MINIGUI_H
  #define _MGUI_MINIGUI_H

#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif  /* __cplusplus */

#ifdef WIN32
extern MG_EXPORT HWND __mg_ime_wnd;
#endif

extern MG_EXPORT RECT g_rcScr;         /* The RECT of screen. */

#if defined(_LITE_VERSION) && !defined(_STAND_ALONE)

extern MG_EXPORT RECT g_rcDesktop;     /* The RECT of desktop. */

#else
#define g_rcDesktop     g_rcScr
#endif

#if defined(_LITE_VERSION) && !defined(_STAND_ALONE)

#include <sys/types.h>

extern MG_EXPORT BOOL mgIsServer;

extern MG_EXPORT void* mgSharedRes;

extern MG_EXPORT size_t mgSizeRes;

#define LEN_LAYER_NAME      14

#define LEN_CLIENT_NAME     14

#define INV_LAYER_HANDLE    0

struct _MG_Layer;

typedef struct _MG_Client
{
    char    name [LEN_CLIENT_NAME + 1];

    pid_t   pid;
    uid_t   uid;
    int     fd;

    RECT    rc;
    DWORD   last_live_time;
    DWORD   dwAddData;

    struct  _MG_Client* next;
    struct  _MG_Client* prev;

    struct  _MG_Layer* layer;

    struct GlobalRes* global_res;
} MG_Client;

struct _CLIPRGN;

typedef struct _MG_Layer
{
    char    name [LEN_LAYER_NAME + 1];

    MG_Client* cli_head;
    MG_Client* cli_active;
    DWORD   dwAddData;

    struct _MG_Layer* next;
    struct _MG_Layer* prev;

    struct _CLIPRGN* spare_rects;
} MG_Layer;

extern MG_EXPORT int mgClientSize;

extern MG_EXPORT MG_Client* mgClients;

extern MG_EXPORT MG_Layer* mgTopmostLayer;

extern MG_EXPORT MG_Layer* mgLayers;

#endif /* _LITE_VERSION && !_STAND_ALONE */

MG_EXPORT int GUIAPI InitGUI (int, const char **);

MG_EXPORT void GUIAPI TerminateGUI (int rcByGUI);

MG_EXPORT void GUIAPI MiniGUIPanic (int exitcode);

#ifdef _LITE_VERSION

#define MAX_NR_LISTEN_FD   5

MG_EXPORT BOOL GUIAPI RegisterListenFD (int fd, int type,
                HWND hwnd, void* context);

MG_EXPORT BOOL GUIAPI UnregisterListenFD (int fd);

#ifdef _STAND_ALONE

#define SetDesktopRect(lx, ty, rx, by) {}

#else

#define NAME_SELF_LAYER         ""

#define NAME_TOPMOST_LAYER      ""

#define NAME_DEF_LAYER          "mginit"

MG_EXPORT GHANDLE GUIAPI JoinLayer (const char* layer_name, 
                const char* client_name, int lx, int ty, int rx, int by);

#define SetDesktopRect(lx, ty, rx, by) \
        JoinLayer ("", "", lx, ty, rx, by)

MG_EXPORT void GUIAPI GetDesktopRect (int* lx, int* ty, int* rx, int* by);

#define NAME_SELF_LAYER     ""

MG_EXPORT GHANDLE GUIAPI GetLayerInfo (const char* layer_name, RECT* max_rect, 
                int* nr_clients, BOOL* is_topmost, int* cli_active);

MG_EXPORT BOOL GUIAPI BringLayer2Topmost (GHANDLE handle);

MG_EXPORT BOOL GUIAPI SetActiveClient (int active);

#define LCO_NEW_CLIENT      1

#define LCO_DEL_CLIENT      2

typedef void (* ON_NEW_DEL_CLIENT) (int op, int cli);

#define LCO_NEW_LAYER       1

#define LCO_DEL_LAYER       2

#define LCO_JOIN_CLIENT     3

#define LCO_REMOVE_CLIENT   4

#define LCO_TOPMOST_CHANGED 5

#define LCO_ACTIVE_CHANGED  6

typedef void (* ON_CHANGE_LAYER) (int op, MG_Layer* layer, 
                MG_Client* client);

extern MG_EXPORT ON_NEW_DEL_CLIENT OnNewDelClient;

extern MG_EXPORT ON_CHANGE_LAYER OnChangeLayer;

static inline BOOL SetClientScreen (int lx, int ty, int rx, int by)
{
    return TRUE;
}

MG_EXPORT BOOL GUIAPI OnlyMeCanDraw (void);

MG_EXPORT BOOL GUIAPI ClientCanDrawNowEx (BOOL bRepaint, const RECT* invrc);

#define ClientCanDrawNow()    ClientCanDrawNowEx (TRUE, NULL)

MG_EXPORT void GUIAPI UpdateTopmostLayer (const RECT* dirty_rc);

MG_EXPORT BOOL GUIAPI SetTopMostClient (int cli);

MG_EXPORT BOOL GUIAPI SetTopMostLayer (MG_Layer* layer);

MG_EXPORT int GUIAPI GetClientByPID (int pid);

#define MAX_SYS_REQID           0x0011

#define MAX_REQID               0x0018

typedef struct _REQUEST {
    int id;
    const void* data;
    size_t len_data;
} REQUEST;
typedef REQUEST* PREQUEST;

int ClientRequest (PREQUEST request, void* result, int len_rslt);

int get_sock_fd2srv (void);

int GUIAPI ServerSendReply (int clifd, const void* reply, int len);

typedef int (* REQ_HANDLER)(int cli, int clifd, void* buff, size_t len);

MG_EXPORT BOOL GUIAPI RegisterRequestHandler (int req_id, 
                REQ_HANDLER your_handler);

MG_EXPORT REQ_HANDLER GUIAPI GetRequestHandler (int req_id);

int serv_listen (const char* name);

int serv_accept (int listenfd, pid_t *pidptr, uid_t *uidptr);

int cli_conn (const char* name, char project);

#define SOCKERR_IO          -1
#define SOCKERR_CLOSED      -2
#define SOCKERR_INVARG      -3
#define SOCKERR_TIMEOUT     -4
#define SOCKERR_OK          0

int sock_write_t (int fd, const void* buff, 
                int count, unsigned int timeout);

int sock_read_t (int fd, void* buff, int count, unsigned int timeout);

#define sock_write(fd, buff, count) sock_write_t(fd, buff, count, 0)

#define sock_read(fd, buff, count) sock_read_t(fd, buff, count, 0)

#endif /* !_STAND_ALONE */
#endif /* LITE_VERSION */

MG_EXPORT BOOL GUIAPI ReinitDesktopEx (BOOL init_sys_text);

#define ReinitDesktop()    ReinitDesktopEx (TRUE)

/*
 * We remove the SuspendGUI and ResumeGUI functions. 
 * Don't use these two functios any more.
 * void GUIAPI SuspendGUI (void);
 * BOOL GUIAPI ResumeGUI (void); 
 */

MG_EXPORT void GUIAPI ExitGUISafely (int exitcode);

#ifdef _USE_MINIGUIENTRY
  #define main_entry minigui_entry
  int minigui_entry (int args, const char* arg[]);
#else
  #define main_entry main
#endif

#define MiniGUIMain \
MiniGUIAppMain (int args, const char* argv[]); \
int main_entry (int args, const char* argv[]) \
{ \
    int iRet = 0; \
    if (InitGUI (args, argv) != 0) { \
        return 1; \
    } \
    iRet = MiniGUIAppMain (args, argv); \
    TerminateGUI (iRet); \
    return iRet; \
} \
int MiniGUIAppMain

#define IDM_DTI_FIRST   (300)

#ifndef _LITE_VERSION
/*
 * NOTE: The following two functions is only valid for MiniGUI-Threads
 * since version 1.0.01.
 */
MG_EXPORT typedef void GUIAPI (*CustomizeDesktopMenuFunc)(HMENU hDesktopMenu, 
                int iPos);

MG_EXPORT typedef int GUIAPI (*CustomDesktopCommandFunc)(int id);

extern MG_EXPORT CustomizeDesktopMenuFunc CustomizeDesktopMenu;

extern MG_EXPORT CustomDesktopCommandFunc CustomDesktopCommand;
#endif

#ifdef _MISC_MOUSECALIBRATE

MG_EXPORT BOOL GUIAPI SetMouseCalibrationParameters (const POINT* src_pts, 
                const POINT* dst_pts);

#endif /* _MISC_MOUSECALIBRATE */

#ifdef _MISC_ABOUTDLG
#ifndef _LITE_VERSION
MG_EXPORT  void GUIAPI OpenAboutDialog (void);
#else

MG_EXPORT  HWND GUIAPI OpenAboutDialog (HWND hHosting);
#endif /* _LITE_VERSION */
#endif /* _MISC_ABOUTDLG */

#define ETC_MAXLINE             1024

#define ETC_FILENOTFOUND        -1

#define ETC_SECTIONNOTFOUND     -2

#define ETC_KEYNOTFOUND         -3

#define ETC_TMPFILEFAILED       -4

#define ETC_FILEIOFAILED        -5

#define ETC_INTCONV             -6

#define ETC_INVALIDOBJ          -7

#define ETC_READONLYOBJ         -8

#define ETC_OK                  0

typedef struct _ETCSECTION
{
    int key_nr_alloc;           
    int key_nr;                 
    char *name;                 
    char** keys;                
    char** values;              
} ETCSECTION;
typedef ETCSECTION* PETCSECTION;

typedef struct _ETC_S
{
    int sect_nr_alloc;          
    int section_nr;             
    PETCSECTION sections;       
} ETC_S;

#ifndef _INCORE_RES

extern MG_EXPORT char ETCFILEPATH [];

#endif /* _INCORE_RES */

MG_EXPORT int GUIAPI GetValueFromEtcFile (const char* pEtcFile, 
                const char* pSection, const char* pKey, char* pValue, int iLen);

MG_EXPORT int GUIAPI GetIntValueFromEtcFile (const char* pEtcFile, 
                const char* pSection, const char* pKey, int* value);

MG_EXPORT int GUIAPI SetValueToEtcFile (const char* pEtcFile, 
                const char* pSection, const char* pKey, char* pValue);

MG_EXPORT int GUIAPI SaveSectionToEtcFile (const char* pEtcFile,
                PETCSECTION psect);

MG_EXPORT int GUIAPI RemoveSectionInEtcFile (const char* pEtcFile, 
                const char* pSection);

MG_EXPORT GHANDLE GUIAPI LoadEtcFile (const char * pEtcFile);

MG_EXPORT int GUIAPI SaveEtcToFile (GHANDLE hEtc, const char* file_name);

MG_EXPORT int GUIAPI UnloadEtcFile (GHANDLE hEtc);

MG_EXPORT int GUIAPI GetValueFromEtc (GHANDLE hEtc, const char* pSection, 
                const char* pKey, char* pValue, int iLen);

MG_EXPORT int GUIAPI GetIntValueFromEtc (GHANDLE hEtc, const char* pSection,
                const char* pKey, int* pValue);

#define SetValueToEtc(hEtc, pSection, pKey, pValue) \
        GetValueFromEtc(hEtc, pSection, pKey, pValue, -1)

MG_EXPORT GHANDLE GUIAPI FindSectionInEtc (GHANDLE hEtc, 
                const char* pSection, BOOL bCreateNew);

MG_EXPORT int GUIAPI GetValueFromEtcSec (GHANDLE hSect, 
                const char* pKey, char* pValue, int iLen);

MG_EXPORT int GUIAPI GetIntValueFromEtcSec (GHANDLE hSect, 
                const char* pKey, int* pValue);

MG_EXPORT int GUIAPI SetValueToEtcSec (GHANDLE hSect, 
                const char* pKey, char* pValue);

MG_EXPORT int GUIAPI RemoveSectionInEtc (GHANDLE hEtc, const char* pSection);

/* global MiniGUI etc file object */
extern MG_EXPORT GHANDLE hMgEtc;

static inline int GetMgEtcValue(const char* pSection, 
                const char *pKey, char *pValue, int iLen) 
{
#ifndef _INCORE_RES
    if (!hMgEtc)
        return GetValueFromEtcFile (ETCFILEPATH, pSection, pKey, pValue, iLen);
#endif

    return GetValueFromEtc (hMgEtc, pSection, pKey, pValue, iLen);
}

static inline int GetMgEtcIntValue (const char *pSection, 
                const char* pKey, int *value)
{
#ifndef _INCORE_RES
    if (!hMgEtc)
        return GetIntValueFromEtcFile (ETCFILEPATH, pSection, pKey, value);
#endif

    return GetIntValueFromEtc (hMgEtc, pSection, pKey, value);
}

#ifdef _CLIPBOARD_SUPPORT

#define LEN_CLIPBOARD_NAME      15

#define NR_CLIPBOARDS           4

#define CBNAME_TEXT             ("text")

#define CBERR_OK        0

#define CBERR_BADNAME   1

#define CBERR_NOMEM     2

#define CBOP_NORMAL     0

#define CBOP_APPEND     1

MG_EXPORT int GUIAPI CreateClipBoard (const char* cb_name, size_t size);

MG_EXPORT int GUIAPI DestroyClipBoard (const char* cb_name);

MG_EXPORT int GUIAPI SetClipBoardData (const char* cb_name, 
                void* data, size_t n, int cbop);

MG_EXPORT size_t GUIAPI GetClipBoardDataLen (const char* cb_name);

MG_EXPORT size_t GUIAPI GetClipBoardData (const char* cb_name, 
                void* data, size_t n);

MG_EXPORT int GUIAPI GetClipBoardByte (const char* cb_name, 
                int index, unsigned char* byte);

#endif /* _CLIPBOARD_SUPPORT */

MG_EXPORT void GUIAPI Ping (void);

#define Beep Ping

MG_EXPORT void GUIAPI Tone (int frequency_hz, int duration_ms);

MG_EXPORT void* GUIAPI GetOriginalTermIO (void);

MG_EXPORT char* GUIAPI FixStrAlloc (int len);

MG_EXPORT char* GUIAPI FixStrDup (const char* str);

MG_EXPORT void GUIAPI FreeFixStr (char* str);

#ifndef _CURSOR_SUPPORT
static inline void do_nothing (void) { return; }
#endif

#ifdef _CURSOR_SUPPORT

  HCURSOR GUIAPI LoadCursorFromFile (const char* filename);

  HCURSOR GUIAPI LoadCursorFromMem (const void* area);

  HCURSOR GUIAPI CreateCursor (int xhotspot, int yhotspot, int w, int h,
               const BYTE* pANDBits, const BYTE* pXORBits, int colornum);

  BOOL GUIAPI DestroyCursor (HCURSOR hcsr);

MG_EXPORT HCURSOR GUIAPI GetSystemCursor (int csrid);

MG_EXPORT HCURSOR GUIAPI GetCurrentCursor (void);
#else
  #define LoadCursorFromFile(filename)    (do_nothing(), 0)
  #define CreateCursor(x, y, w, h, ANDbs, XORbs, cr) (do_nothing(), 0)
  #define DestroyCursor(hcsr)             (do_nothing(), 0)
  #define GetSystemCursor(csrid)          (do_nothing(), 0)
  #define GetCurrentCursor()              (do_nothing(), 0)
#endif /* _CURSOR_SUPPORT */

#define MAX_SYSCURSORINDEX    22

/* System cursor index. */
#define IDC_ARROW       0

#define IDC_IBEAM       1

#define IDC_PENCIL      2

#define IDC_CROSS       3

#define IDC_MOVE        4

#define IDC_SIZENWSE    5

#define IDC_SIZENESW    6

#define IDC_SIZEWE      7

#define IDC_SIZENS      8

#define IDC_UPARROW     9

#define IDC_NONE        10

#define IDC_HELP        11

#define IDC_BUSY        12

#define IDC_WAIT        13

#define IDC_RARROW      14

#define IDC_COLOMN      15

#define IDC_ROW         16

#define IDC_DRAG        17

#define IDC_NODROP      18

#define IDC_HAND_POINT  19

#define IDC_HAND_SELECT 20

#define IDC_SPLIT_HORZ  21

#define IDC_SPLIT_VERT  22

MG_EXPORT void GUIAPI ClipCursor (const RECT* prc);

MG_EXPORT void GUIAPI GetClipCursor (RECT* prc);

MG_EXPORT void GUIAPI GetCursorPos (POINT* ppt);

MG_EXPORT void GUIAPI SetCursorPos (int x, int y);

#ifdef _CURSOR_SUPPORT

 MG_EXPORT HCURSOR GUIAPI SetCursorEx (HCURSOR hcsr, BOOL set_def);

  #define SetCursor(hcsr) SetCursorEx (hcsr, FALSE)

  #define SetDefaultCursor(hcsr) SetCursorEx (hcsr, TRUE)

MG_EXPORT  HCURSOR GUIAPI GetDefaultCursor (void);

#else
  #define SetCursorEx(hcsr, set_def)    (do_nothing(), 0)
  #define SetCursor(hcsr)               (do_nothing(), 0)
  #define SetDefaultCursor(hcsr)        (do_nothing(), 0)
  #define GetDefaultCursor()            (do_nothing(), 0)
#endif /* _CURSOR_SUPPORT */

#ifdef _CURSOR_SUPPORT

MG_EXPORT int GUIAPI ShowCursor (BOOL fShow);
#else
  #define ShowCursor(fShow)             (do_nothing(), 0)
#endif /* _CURSOR_SUPPORT */

MG_EXPORT BOOL GUIAPI GetKeyStatus (UINT uKey);

MG_EXPORT DWORD GUIAPI GetShiftKeyStatus (void);

MG_EXPORT const char* GetSysText (const char* text);

extern MG_EXPORT const char* SysText [];

extern MG_EXPORT const char** local_SysText;


MG_EXPORT char* strnchr (const char* s, size_t n, int c);

MG_EXPORT int substrlen (const char* text, int len, char delimiter,
                int* nr_delim);

MG_EXPORT char * strtrimall (char* src);


#ifdef __cplusplus
}
#endif  /* __cplusplus */

#endif /* _MGUI_MINIGUI_H */

---