gwenhywfar  5.4.1
gui.h
Go to the documentation of this file.
1 /***************************************************************************
2  begin : Tue Oct 02 2002
3  copyright : (C) 2002-2010 by Martin Preuss
4  email : martin@libchipcard.de
5 
6  ***************************************************************************
7  * *
8  * This library is free software; you can redistribute it and/or *
9  * modify it under the terms of the GNU Lesser General Public *
10  * License as published by the Free Software Foundation; either *
11  * version 2.1 of the License, or (at your option) any later version. *
12  * *
13  * This library is distributed in the hope that it will be useful, *
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
16  * Lesser General Public License for more details. *
17  * *
18  * You should have received a copy of the GNU Lesser General Public *
19  * License along with this library; if not, write to the Free Software *
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, *
21  * MA 02111-1307 USA *
22  * *
23  ***************************************************************************/
24 
25 #ifndef GWENHYWFAR_GUI_GUI_H
26 #define GWENHYWFAR_GUI_GUI_H
27 
28 
29 
30 #include <gwenhywfar/inherit.h>
31 #include <gwenhywfar/logger.h>
32 #include <gwenhywfar/inetsocket.h>
34 #include <gwenhywfar/syncio.h>
35 #include <gwenhywfar/dialog.h>
36 #include <gwenhywfar/passwdstore.h>
37 
38 #include <inttypes.h>
39 
40 
41 
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45 
46 
47 
48 
115 
116 
117 
132 
163 typedef enum {
169 
170 
176 typedef struct GWEN_GUI GWEN_GUI;
178 
179 
180 #define GWEN_GUI_CPU_TIMEOUT 200
181 
182 #define GWEN_GUI_CHECK_PERIOD 750
183 #define GWEN_GUI_DELAY_SECS 2
184 
185 
192 #define GWEN_GUI_PROGRESS_DELAY 0x00000001
193 #define GWEN_GUI_PROGRESS_SHOW_LOG 0x00000002
194 #define GWEN_GUI_PROGRESS_SHOW_ABORT 0x00000004
195 #define GWEN_GUI_PROGRESS_ALLOW_SUBLEVELS 0x00000008
196 #define GWEN_GUI_PROGRESS_ALLOW_EMBED 0x00000010
197 #define GWEN_GUI_PROGRESS_SHOW_PROGRESS 0x00000020
198 #define GWEN_GUI_PROGRESS_KEEP_OPEN 0x00000040
199 #define GWEN_GUI_PROGRESS_ALWAYS_SHOW_LOG 0x00000080
200 
211 #define GWEN_GUI_INPUT_FLAGS_CONFIRM 0x00000001
212 
213 #define GWEN_GUI_INPUT_FLAGS_SHOW 0x00000002
214 
215 #define GWEN_GUI_INPUT_FLAGS_NUMERIC 0x00000004
216 
217 #define GWEN_GUI_INPUT_FLAGS_RETRY 0x00000008
218 
220 #define GWEN_GUI_INPUT_FLAGS_ALLOW_DEFAULT 0x00000010
221 
222 #define GWEN_GUI_INPUT_FLAGS_TAN 0x00000020
223 
224 #define GWEN_GUI_INPUT_FLAGS_OPTICAL 0x00000040
225 
226 #define GWEN_GUI_INPUT_FLAGS_DIRECT 0x00000080
227 
279 #define GWEN_GUI_MSG_FLAGS_TYPE_MASK 0x07
280 
281 #define GWEN_GUI_MSG_FLAGS_TYPE_INFO 0
282 
283 #define GWEN_GUI_MSG_FLAGS_TYPE_IS_INFO(fl) \
284  ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_INFO)
285 
287 #define GWEN_GUI_MSG_FLAGS_TYPE_WARN 1
288 
289 #define GWEN_GUI_MSG_FLAGS_TYPE_IS_WARN(fl) \
290  ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_WARN)
291 
293 #define GWEN_GUI_MSG_FLAGS_TYPE_ERROR 2
294 
295 #define GWEN_GUI_MSG_FLAGS_TYPE_IS_ERROR \
296  ((fl & GWEN_GUI_MSG_FLAGS_TYPE_MASK)==GWEN_GUI_MSG_FLAGS_TYPE_ERROR)
297 
299 #define GWEN_GUI_MSG_FLAGS_CONFIRM_B1 (1<<3)
300 
301 #define GWEN_GUI_MSG_FLAGS_CONFIRM_B2 (2<<3)
302 
303 #define GWEN_GUI_MSG_FLAGS_CONFIRM_B3 (3<<3)
304 
305 #define GWEN_GUI_MSG_FLAGS_CONFIRM_BUTTON(fl) (((fl)>>3) & 0x3)
306 
307 
329 #define GWEN_GUI_MSG_FLAGS_SEVERITY_MASK (0x7<<5)
330 
331 #define GWEN_GUI_MSG_FLAGS_SEVERITY_NORMAL (0x0<<5)
332 #define GWEN_GUI_MSG_FLAGS_SEVERITY_IS_NORMAL(fl) \
333  ((fl & GWEN_GUI_MSG_FLAGS_SEVERITY_MASK)==\
334  GWEN_GUI_MSG_FLAGS_SEVERITY_NORMAL)
335 
337 #define GWEN_GUI_MSG_FLAGS_SEVERITY_DANGEROUS (0x1<<5)
338 #define GWEN_GUI_MSG_FLAGS_SEVERITY_IS_DANGEROUS(fl) \
339  ((fl & GWEN_GUI_MSG_FLAGS_SEVERITY_MASK)==\
340  GWEN_GUI_MSG_FLAGS_SEVERITY_DANGEROUS)
341 
353 #define GWEN_GUI_SHOWBOX_FLAGS_BEEP 0x00000001
354 
368 #define GWEN_GUI_PROGRESS_NONE (0xffffffffUL)
369 
376 #define GWEN_GUI_PROGRESS_ONE (0xfffffffeUL)
377 
386 typedef enum {
394 
395 
396 
402 GWEN_GUI *GWEN_Gui_new(void);
403 
405 void GWEN_Gui_free(GWEN_GUI *gui);
406 
408 void GWEN_Gui_Attach(GWEN_GUI *gui);
409 
411 void GWEN_Gui_SetGui(GWEN_GUI *gui);
412 
415 
429 const char *GWEN_Gui_GetCharSet(const GWEN_GUI *gui);
430 
432 void GWEN_Gui_SetCharSet(GWEN_GUI *gui, const char *s);
433 
435 int GWEN_Gui_ConvertString(const char *text, size_t len, GWEN_BUFFER *tbuf,
436  const char *fromCs, const char *toCs);
437 
438 
481 
515 int GWEN_Gui_MessageBox(uint32_t flags,
516  const char *title,
517  const char *text,
518  const char *b1,
519  const char *b2,
520  const char *b3,
521  uint32_t guiid);
522 
529 void GWEN_Gui_ShowError(const char *title, const char *text, ...);
530 
531 
560 int GWEN_Gui_InputBox(uint32_t flags,
561  const char *title,
562  const char *text,
563  char *buffer,
564  int minLen,
565  int maxLen,
566  uint32_t guiid);
567 
591 uint32_t GWEN_Gui_ShowBox(uint32_t flags,
592  const char *title,
593  const char *text,
594  uint32_t guiid);
595 
605 void GWEN_Gui_HideBox(uint32_t id);
606 
607 
640 uint32_t GWEN_Gui_ProgressStart(uint32_t progressFlags,
641  const char *title,
642  const char *text,
643  uint64_t total,
644  uint32_t guiid);
645 
667 int GWEN_Gui_ProgressAdvance(uint32_t id, uint32_t progress);
668 
670 int GWEN_Gui_ProgressSetTotal(uint32_t id, uint64_t total);
671 
683 int GWEN_Gui_ProgressLog(uint32_t id,
684  GWEN_LOGGER_LEVEL level,
685  const char *text);
686 
700 int GWEN_Gui_ProgressLog2(uint32_t id,
701  GWEN_LOGGER_LEVEL level,
702  const char *text, ...);
703 
729 int GWEN_Gui_ProgressEnd(uint32_t id);
730 
731 
746 int GWEN_Gui_Print(const char *docTitle,
747  const char *docType,
748  const char *descr,
749  const char *text,
750  uint32_t guiid);
751 
782 int GWEN_Gui_GetPassword(uint32_t flags,
783  const char *token,
784  const char *title,
785  const char *text,
786  char *buffer,
787  int minLen,
788  int maxLen,
789  GWEN_GUI_PASSWORD_METHOD methodId,
790  GWEN_DB_NODE *methodParams,
791  uint32_t guiid);
792 
798 int GWEN_Gui_SetPasswordStatus(const char *token,
799  const char *pin,
800  GWEN_GUI_PASSWORD_STATUS status,
801  uint32_t guiid);
802 
814 int GWEN_Gui_LogHook(const char *logDomain,
815  GWEN_LOGGER_LEVEL priority,
816  const char *s);
817 
818 
829  GWEN_SOCKET_LIST2 *writeSockets,
830  uint32_t guiid,
831  int msecs);
832 
843 int GWEN_Gui_GetSyncIo(const char *url,
844  const char *defaultProto,
845  int defaultPort,
846  GWEN_SYNCIO **pSio);
847 
848 
858 int GWEN_Gui_CheckCert(const GWEN_SSLCERTDESCR *cert,
859  GWEN_SYNCIO *sio,
860  uint32_t guiid);
861 
862 
874 int GWEN_Gui_KeyDataFromText_OpenSSL(const char *text,
875  unsigned char *buffer,
876  unsigned int bufLength);
877 
878 
891 
902 int GWEN_Gui_ExecDialog(GWEN_DIALOG *dlg, uint32_t guiid);
903 
904 
915 int GWEN_Gui_OpenDialog(GWEN_DIALOG *dlg, uint32_t guiid);
916 
917 
929 
930 
940 int GWEN_Gui_RunDialog(GWEN_DIALOG *dlg, int untilEnd);
941 
942 
943 typedef enum {
947 
949 
964 int GWEN_Gui_GetFileName(const char *caption,
965  GWEN_GUI_FILENAME_TYPE fnt,
966  uint32_t flags,
967  const char *patterns,
968  GWEN_BUFFER *pathBuffer,
969  uint32_t guiid);
970 
984 
986 #define GWEN_GUI_FLAGS_NONINTERACTIVE 0x00000001
987 
988 #define GWEN_GUI_FLAGS_ACCEPTVALIDCERTS 0x00000002
989 
990 #define GWEN_GUI_FLAGS_REJECTINVALIDCERTS 0x00000004
991 
992 #define GWEN_GUI_FLAGS_PERMPASSWORDS 0x00000008
993 
995 #define GWEN_GUI_FLAGS_DIALOGSUPPORTED 0x80000000
996 
997 GWENHYWFAR_API uint32_t GWEN_Gui_GetFlags(const GWEN_GUI *gui);
998 GWENHYWFAR_API void GWEN_Gui_SetFlags(GWEN_GUI *gui, uint32_t fl);
999 GWENHYWFAR_API void GWEN_Gui_AddFlags(GWEN_GUI *gui, uint32_t fl);
1000 GWENHYWFAR_API void GWEN_Gui_SubFlags(GWEN_GUI *gui, uint32_t fl);
1004 GWENHYWFAR_API const char *GWEN_Gui_GetName(void);
1005 
1006 
1007 
1027  GWEN_DB_NODE *dbPasswords,
1028  int persistent);
1029 
1057 
1058 
1059 
1078 GWEN_SYNCIO *GWEN_Gui_ExtendSyncIo(const char *url,
1079  const char *defaultProto,
1080  int defaultPort,
1081  GWEN_SYNCIO *baseSio);
1082 
1083 
1084 #ifdef __cplusplus
1085 }
1086 #endif
1087 
1091 #endif
1092 
1093 
1094 
1095 
GWENHYWFAR_API int GWEN_Gui_ProgressLog(uint32_t id, GWEN_LOGGER_LEVEL level, const char *text)
GWENHYWFAR_API void GWEN_Gui_SubFlags(GWEN_GUI *gui, uint32_t fl)
struct GWEN_SSLCERTDESCR GWEN_SSLCERTDESCR
GWENHYWFAR_API int GWEN_Gui_OpenDialog(GWEN_DIALOG *dlg, uint32_t guiid)
GWENHYWFAR_API void GWEN_Gui_SetFlags(GWEN_GUI *gui, uint32_t fl)
GWENHYWFAR_API int GWEN_Gui_ProgressAdvance(uint32_t id, uint32_t progress)
struct GWEN_DB_NODE GWEN_DB_NODE
Definition: db.h:228
GWENHYWFAR_API int GWEN_Gui_WaitForSockets(GWEN_SOCKET_LIST2 *readSockets, GWEN_SOCKET_LIST2 *writeSockets, uint32_t guiid, int msecs)
struct GWEN_SOCKET_LIST2 GWEN_SOCKET_LIST2
Definition: listdoc.h:3880
GWENHYWFAR_API int GWEN_Gui_LogHook(const char *logDomain, GWEN_LOGGER_LEVEL priority, const char *s)
GWENHYWFAR_API int GWEN_Gui_ProgressSetTotal(uint32_t id, uint64_t total)
GWEN_LOGGER_LEVEL
Definition: logger.h:64
GWENHYWFAR_API void GWEN_Gui_SetCharSet(GWEN_GUI *gui, const char *s)
GWENHYWFAR_API void GWEN_Gui_SetMinProgressLogLevel(GWEN_GUI *gui, GWEN_LOGGER_LEVEL ll)
GWENHYWFAR_API void GWEN_Gui_AddFlags(GWEN_GUI *gui, uint32_t fl)
This file contains sockets and socket sets.
GWENHYWFAR_API int GWEN_Gui_MessageBox(uint32_t flags, const char *title, const char *text, const char *b1, const char *b2, const char *b3, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_ExecDialog(GWEN_DIALOG *dlg, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_Print(const char *docTitle, const char *docType, const char *descr, const char *text, uint32_t guiid)
GWENHYWFAR_API GWEN_LOGGER_LEVEL GWEN_Gui_GetMinProgressLogLevel(const GWEN_GUI *gui)
struct GWEN_DIALOG GWEN_DIALOG
Definition: dialog.h:54
GWENHYWFAR_API int GWEN_Gui_GetSyncIo(const char *url, const char *defaultProto, int defaultPort, GWEN_SYNCIO **pSio)
GWENHYWFAR_API const char * GWEN_Gui_GetName(void)
GWEN_GUI_FILENAME_TYPE
Definition: gui.h:943
GWEN_GUI_PASSWORD_STATUS
Definition: gui.h:386
struct GWEN_SYNCIO GWEN_SYNCIO
Definition: syncio.h:40
#define GWEN_INHERIT_FUNCTION_LIB_DEFS(t, decl)
Definition: inherit.h:125
GWENHYWFAR_API int GWEN_Gui_InputBox(uint32_t flags, const char *title, const char *text, char *buffer, int minLen, int maxLen, uint32_t guiid)
GWENHYWFAR_API uint32_t GWEN_Gui_ShowBox(uint32_t flags, const char *title, const char *text, uint32_t guiid)
GWEN_SYNCIO * GWEN_Gui_ExtendSyncIo(const char *url, const char *defaultProto, int defaultPort, GWEN_SYNCIO *baseSio)
GWENHYWFAR_API int GWEN_Gui_ProgressLog2(uint32_t id, GWEN_LOGGER_LEVEL level, const char *text,...)
GWENHYWFAR_API void GWEN_Gui_HideBox(uint32_t id)
GWENHYWFAR_API GWEN_GUI * GWEN_Gui_GetGui(void)
GWENHYWFAR_API int GWEN_Gui_ConvertString(const char *text, size_t len, GWEN_BUFFER *tbuf, const char *fromCs, const char *toCs)
GWENHYWFAR_API GWEN_PASSWD_STORE * GWEN_Gui_GetPasswdStore(const GWEN_GUI *gui)
struct GWEN_BUFFER GWEN_BUFFER
A dynamically resizeable text buffer.
Definition: buffer.h:38
GWEN_GUI_PASSWORD_METHOD
Definition: gui.h:163
#define GWENHYWFAR_API
Definition: gwenhywfarapi.h:67
GWENHYWFAR_API uint32_t GWEN_Gui_ProgressStart(uint32_t progressFlags, const char *title, const char *text, uint64_t total, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_KeyDataFromText_OpenSSL(const char *text, unsigned char *buffer, unsigned int bufLength)
GWENHYWFAR_API int GWEN_Gui_ProgressEnd(uint32_t id)
GWENHYWFAR_API int GWEN_Gui_CloseDialog(GWEN_DIALOG *dlg)
struct GWEN_PASSWD_STORE GWEN_PASSWD_STORE
Definition: passwdstore.h:37
GWENHYWFAR_API void GWEN_Gui_SetPasswordDb(GWEN_GUI *gui, GWEN_DB_NODE *dbPasswords, int persistent)
GWENHYWFAR_API GWEN_GUI * GWEN_Gui_new(void)
GWENHYWFAR_API void GWEN_Gui_SetPasswdStore(GWEN_GUI *gui, GWEN_PASSWD_STORE *sto)
GWENHYWFAR_API int GWEN_Gui_GetPassword(uint32_t flags, const char *token, const char *title, const char *text, char *buffer, int minLen, int maxLen, GWEN_GUI_PASSWORD_METHOD methodId, GWEN_DB_NODE *methodParams, uint32_t guiid)
GWENHYWFAR_API GWEN_DB_NODE * GWEN_Gui_GetPasswordDb(const GWEN_GUI *gui)
GWENHYWFAR_API void GWEN_Gui_Attach(GWEN_GUI *gui)
struct GWEN_GUI GWEN_GUI
Definition: gui.h:176
GWENHYWFAR_API int GWEN_Gui_SetPasswordStatus(const char *token, const char *pin, GWEN_GUI_PASSWORD_STATUS status, uint32_t guiid)
GWENHYWFAR_API void GWEN_Gui_free(GWEN_GUI *gui)
GWENHYWFAR_API void GWEN_Gui_SetGui(GWEN_GUI *gui)
GWENHYWFAR_API int GWEN_Gui_GetFileName(const char *caption, GWEN_GUI_FILENAME_TYPE fnt, uint32_t flags, const char *patterns, GWEN_BUFFER *pathBuffer, uint32_t guiid)
GWENHYWFAR_API void GWEN_Gui_ShowError(const char *title, const char *text,...)
GWENHYWFAR_API int GWEN_Gui_CheckCert(const GWEN_SSLCERTDESCR *cert, GWEN_SYNCIO *sio, uint32_t guiid)
GWENHYWFAR_API int GWEN_Gui_RunDialog(GWEN_DIALOG *dlg, int untilEnd)
GWENHYWFAR_API uint32_t GWEN_Gui_GetFlags(const GWEN_GUI *gui)
GWENHYWFAR_API const char * GWEN_Gui_GetCharSet(const GWEN_GUI *gui)