minigui.h

Go to the documentation of this file.

/*
 * $Id: minigui.h 13368 2010-08-30 09:25:11Z wanzheng $
 * 
 *             MiniGUI for Linux/uClinux, eCos, uC/OS-II, VxWorks, 
 *                     pSOS, ThreadX, NuCleus, OSE, and Win32.
 *
 *             Copyright (C) 2002-2009 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 */

extern MG_EXPORT RECT g_rcScr;

#define g_rcDesktop     g_rcScr

#ifdef _MGRM_PROCESSES

#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;

    BOOL    has_dirty;
    DWORD   last_live_time;
    DWORD   dwAddData;

    struct  _MG_Client* next;
    struct  _MG_Client* prev;

    struct  _MG_Layer* layer;

    struct GlobalRes* global_res;
} MG_Client;

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

    DWORD   dwAddData;

    MG_Client* cli_head;
    MG_Client* cli_active;

    struct _MG_Layer* next;
    struct _MG_Layer* prev;

    void* zorder_info;
    int   zorder_shmid;
} MG_Layer;

/*screen attr type*/
#define SCREEN_ATTR_ALPHA_CHANNEL    0x01      //alpha channel     
#define SCREEN_ATTR_COLORKEY         0x02      //colorkey
#define SCREEN_ATTR_COLORSPACE       0x03      //colorspace
#define SCREEN_ATTR_ALPHA            0x04
#define SCREEN_NO_EXIST              -99       //screen don't exist

extern MG_EXPORT int mgClientSize;

extern MG_EXPORT MG_Client* mgClients;

extern MG_EXPORT MG_Layer* mgTopmostLayer;

extern MG_EXPORT MG_Layer* mgLayers;

#endif /* _MGRM_PROCESSES */

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

MG_EXPORT void GUIAPI TerminateGUI (int not_used);

MG_EXPORT void GUIAPI MiniGUIPanic (int exitcode);

#ifndef _MGRM_THREADS

#define MAX_NR_LISTEN_FD   5

#ifdef WIN32
#ifndef POLLIN
#define POLLIN  0x001
#endif

#ifndef POLLOUT
#define POLLOUT 0x004
#endif

#ifndef POLLERR
#define POLLERR 0x008
#endif

#endif

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

MG_EXPORT BOOL GUIAPI UnregisterListenFD (int fd);

#ifdef _MGRM_PROCESSES

#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 max_nr_topmosts, int max_nr_normals);

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

MG_EXPORT BOOL GUIAPI SetTopmostLayer (BOOL handle_name,
                GHANDLE handle, const char* name);

MG_EXPORT BOOL GUIAPI DeleteLayer (BOOL handle_name,
                        GHANDLE handle, const char* layer_name);

typedef int (* ON_LOCK_CLIENT_REQ) (void);


typedef int (* ON_TRYLOCK_CLIENT_REQ) (void);

typedef void (* ON_UNLOCK_CLIENT_REQ) (void);

extern MG_EXPORT ON_LOCK_CLIENT_REQ  OnLockClientReq;

extern MG_EXPORT ON_TRYLOCK_CLIENT_REQ  OnTrylockClientReq;
extern MG_EXPORT ON_UNLOCK_CLIENT_REQ  OnUnlockClientReq;

#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);

#define ZNOP_ALLOCATE   1
#define ZNOP_FREE       2
#define ZNOP_MOVE2TOP   3
#define ZNOP_SHOW       4
#define ZNOP_HIDE       5
#define ZNOP_MOVEWIN    6
#define ZNOP_SETACTIVE  7

#define ZNOP_ENABLEWINDOW        11
#define ZNOP_DISABLEWINDOW       12
#define ZNOP_STARTDRAG           13
#define ZNOP_CANCELDRAG          14
#define ZNOP_CHANGECAPTION       15

typedef void (* ON_ZNODE_OPERATION) (int op, int cli, int idx_znode);

extern MG_EXPORT ON_NEW_DEL_CLIENT OnNewDelClient;

extern MG_EXPORT ON_CHANGE_LAYER OnChangeLayer;

extern MG_EXPORT ON_ZNODE_OPERATION OnZNodeOperation;

MG_EXPORT BOOL GUIAPI ServerStartup (int nr_globals,
                int def_nr_topmosts, int def_nr_normals);

MG_EXPORT MG_Layer* GUIAPI ServerCreateLayer (const char* layer_name, 
                int max_nr_topmosts, int max_nr_normals);

MG_EXPORT BOOL GUIAPI ServerSetTopmostLayer (MG_Layer* layer);

MG_EXPORT BOOL GUIAPI ServerDeleteLayer (MG_Layer* layer);

MG_EXPORT int GUIAPI ServerGetNextZNode (MG_Layer* layer, int idx_znode, 
                int* cli);

#define ZNIT_DESKTOP         0x50000000

#define ZNIT_GLOBAL_MAINWIN  0x31000000
#define ZNIT_GLOBAL_TOOLWIN  0x32000000
#define ZNIT_GLOBAL_CONTROL  0x30000000

#define ZNIT_TOPMOST_MAINWIN 0x21000000
#define ZNIT_TOPMOST_TOOLWIN 0x22000000
#define ZNIT_TOPMOST_CONTROL 0x20000000

#define ZNIT_NORMAL_MAINWIN  0x11000000
#define ZNIT_NORMAL_TOOLWIN  0x12000000
#define ZNIT_NORMAL_CONTROL  0x10000000

#define ZNIT_NULL            0x00000000

#define ZNIF_VISIBLE         0x00000002
#define ZNIF_DISABLED        0x00000004

typedef struct _ZNODEINFO
{
    DWORD           type;

    DWORD           flags;

    const char*     caption;
    RECT            rc;

    int             cli;
    HWND            hwnd;
    HWND            main_win;
} ZNODEINFO;

MG_EXPORT BOOL GUIAPI ServerGetZNodeInfo (MG_Layer* layer, int idx_znode, 
                ZNODEINFO* znode_info);

MG_EXPORT BOOL GUIAPI ServerDoZNodeOperation (MG_Layer* layer, int idx_znode, 
                int op_code, void* op_data, BOOL notify);

MG_EXPORT int GUIAPI GetClientByPID (int pid);

MG_EXPORT BOOL GUIAPI SetTopmostClient (int cli);

MG_EXPORT void GUIAPI DisableClientsOutput (void);

MG_EXPORT void GUIAPI UpdateTopmostLayer (const RECT* dirty_rc);

#define MAX_SYS_REQID           0x0020

#define MAX_REQID               0x0030

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

MG_EXPORT int GUIAPI ClientRequestEx (const REQUEST* request, const void* ex_data, 
                int ex_data_len, void* result, int len_rslt);

static inline int ClientRequest (const REQUEST* request, 
                void* result, int len_rslt)
{
    return ClientRequestEx (request, NULL, 0, result, len_rslt);
}

MG_EXPORT int GUIAPI GetSockFD2Server (void);

MG_EXPORT 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);

MG_EXPORT int serv_listen (const char* name);

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

MG_EXPORT 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

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

MG_EXPORT 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 /* _MGRM_PROCESSES */

#endif /* LITE_VERSION */

MG_EXPORT BOOL GUIAPI ReinitDesktopEx (BOOL init_sys_text);

#define ReinitDesktop()    ReinitDesktopEx (TRUE)

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)

typedef struct _DESKTOPOPS {
        
        void* (*init) (void);
        
        void (*deinit) (void* context);
        
        void (*paint_desktop) (void* context, 
                                HDC dc_desktop, const RECT* inv_rc);
        
        void (*keyboard_handler) (void* context, 
                                int message, WPARAM wParam, LPARAM lParam);
        
        void (*mouse_handler) (void* context, 
                                int message, WPARAM wParam, LPARAM lParam);
        
        void (*customize_desktop_menu) (void* context, 
                                                 HMENU hmenu, int start_pos);
        
        void (*desktop_menucmd_handler) (void* context, int id);
} DESKTOPOPS;

MG_EXPORT DESKTOPOPS* GUIAPI SetCustomDesktopOperationSet 
                                       (DESKTOPOPS* usr_dsk_ops);

MG_EXPORT void GUIAPI DesktopUpdateAllWindow (void);

#ifdef _MGHAVE_MOUSECALIBRATE

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

MG_EXPORT void GUIAPI GetOriginalMousePosition (int* x, int* y);

#endif /* _MGHAVE_MOUSECALIBRATE */

#ifdef _MGMISC_ABOUTDLG
#ifdef _MGRM_THREADS

MG_EXPORT  void GUIAPI OpenAboutDialog (void);
#else

MG_EXPORT HWND GUIAPI OpenAboutDialog (HWND hHosting);
#endif /* _MGRM_THREADS */
#endif /* _MGMISC_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 _MGINCORE_RES

extern MG_EXPORT char ETCFILEPATH [];

#endif /* _MGINCORE_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 RemoveSectionInEtcFile (const char* pEtcFile, 
                const char* pSection);

MG_EXPORT int GUIAPI SaveSectionToEtcFile (const char* pEtcFile, 
                                                                                   PETCSECTION psect);
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 _MGINCORE_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 _MGINCORE_RES
    if (!hMgEtc)
        return GetIntValueFromEtcFile (ETCFILEPATH, pSection, pKey, value);
#endif

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

#ifdef _MGHAVE_CLIPBOARD

#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 /* _MGHAVE_CLIPBOARD */

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 _MGHAVE_CURSOR
static inline void do_nothing (void) { return; }
#endif

#ifdef _MGHAVE_CURSOR

MG_EXPORT HCURSOR GUIAPI LoadCursorFromFile (const char* filename);

MG_EXPORT HCURSOR GUIAPI LoadCursorFromMem (const void* area);

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

MG_EXPORT 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 /* _MGHAVE_CURSOR */

#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 _MGHAVE_CURSOR

 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 /* _MGHAVE_CURSOR */

#ifdef _MGHAVE_CURSOR

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

MG_EXPORT BOOL GUIAPI GetKeyStatus (UINT uKey);

MG_EXPORT DWORD GUIAPI GetShiftKeyStatus (void);

#define IDS_MGST_WINDOW          0

#define IDS_MGST_START           1

#define IDS_MGST_REFRESH         2

#define IDS_MGST_CLOSEALLWIN     3

#define IDS_MGST_ENDSESSION      4

#define IDS_MGST_OPERATIONS      5

#define IDS_MGST_MINIMIZE        6

#define IDS_MGST_MAXIMIZE        7

#define IDS_MGST_RESTORE         8

#define IDS_MGST_CLOSE           9

#define IDS_MGST_OK              10

#define IDS_MGST_NEXT            11

#define IDS_MGST_CANCEL          12

#define IDS_MGST_PREV            13

#define IDS_MGST_YES             14

#define IDS_MGST_NO              15

#define IDS_MGST_ABORT           16

#define IDS_MGST_RETRY           17

#define IDS_MGST_IGNORE          18

#define IDS_MGST_ABOUTMG         19

#define IDS_MGST_OPENFILE        20

#define IDS_MGST_SAVEFILE        21

#define IDS_MGST_COLORSEL        22

#define IDS_MGST_SWITCHLAYER     23

#define IDS_MGST_DELLAYER        24

#define IDS_MGST_ERROR           25

#define IDS_MGST_LOGO            26

#define IDS_MGST_CURRPATH        27

#define IDS_MGST_FILE            28

#define IDS_MGST_LOCATION        29

#define IDS_MGST_UP              30

#define IDS_MGST_NAME            31

#define IDS_MGST_SIZE            32

#define IDS_MGST_ACCESSMODE      33

#define IDS_MGST_LASTMODTIME     34

#define IDS_MGST_OPEN            35

#define IDS_MGST_FILENAME        36

#define IDS_MGST_FILETYPE        37

#define IDS_MGST_SHOWHIDEFILE    38

#define IDS_MGST_NOTFOUND        39

#define IDS_MGST_NR              40

#define IDS_MGST_NW              41

#define IDS_MGST_INFO            42

#define IDS_MGST_R               43

#define IDS_MGST_W               44

#define IDS_MGST_WR              45

#define IDS_MGST_SAVE            46

#define IDS_MGST_FILEEXIST       47

#define IDS_MGST_MAXNUM          47

MG_EXPORT const char* GUIAPI GetSysText (unsigned int id);

extern MG_EXPORT const char* SysText [];

extern MG_EXPORT const char** local_SysText;

#ifdef _MGCHARSET_UNICODE

extern MG_EXPORT const char** GUIAPI GetSysTextInUTF8 (const char* language);

#endif /* _MGCHARSET_UNICODE */

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

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

MG_EXPORT char * strtrimall (char* src);

#ifdef __cplusplus
}
#endif  /* __cplusplus */

#endif /* _MGUI_MINIGUI_H */