ncurses 6.1 - patch 20190309
[ncurses.git] / form / form.h
index a4691a86e8e726196927a475d924ba9fe5e38352..c34be75dc2701eabbd289a2050c53dccb151a63b 100644 (file)
@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
+ * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc.              *
  *                                                                          *
  * Permission is hereby granted, free of charge, to any person obtaining a  *
  * copy of this software and associated documentation files (the            *
  *   Author:  Juergen Pfeifer, 1995,1997                                    *
  ****************************************************************************/
 
-/* $Id: form.h,v 0.20 2004/12/04 22:22:10 tom Exp $ */
+/* $Id: form.h,v 0.29 2019/01/19 21:26:13 Leon.Winter Exp $ */
 
 #ifndef FORM_H
 #define FORM_H
+/* *INDENT-OFF*/
 
 #include <curses.h>
 #include <eti.h>
@@ -57,18 +58,24 @@ typedef int Field_Options;
        *  _PAGE  *
        **********/
 
-typedef struct {
+typedef struct pagenode
+#if !NCURSES_OPAQUE_FORM
+{
   short pmin;          /* index of first field on page                 */
   short pmax;          /* index of last field on page                  */
   short smin;          /* index of top leftmost field on page          */
   short smax;          /* index of bottom rightmost field on page      */
-} _PAGE;
+}
+#endif /* !NCURSES_OPAQUE_FORM */
+_PAGE;
 
        /**********
        *  FIELD  *
        **********/
 
-typedef struct fieldnode {
+typedef struct fieldnode
+#if 1                  /* not yet: !NCURSES_OPAQUE_FORM */
+{
   unsigned short       status;         /* flags                        */
   short                        rows;           /* size in rows                 */
   short                        cols;           /* size in cols                 */
@@ -97,42 +104,25 @@ typedef struct fieldnode {
   /*
    * The wide-character configuration requires extra information.  Because
    * there are existing applications that manipulate the members of FIELD
-   * directly, we cannot make the struct opaque.  Offsets of members up to
-   * this point are the same in the narrow- and wide-character configuration.
-   * But note that the type of buf depends on the configuration, and is made
-   * opaque for that reason.
+   * directly, we cannot make the struct opaque, except by changing the ABI. 
+   * Offsets of members up to this point are the same in the narrow- and
+   * wide-character configuration.  But note that the type of buf depends on
+   * the configuration, and is made opaque for that reason.
    */
   NCURSES_FIELD_INTERNALS
-} FIELD;
+}
+#endif /* NCURSES_OPAQUE_FORM */
+FIELD;
 
-       /**************
-       *  FIELDTYPE  *
-       **************/
-
-typedef struct typenode {
-  unsigned short       status;                 /* flags                */
-  long                 ref;                    /* reference count      */
-  struct typenode *    left;                   /* ptr to operand for | */
-  struct typenode *    right;                  /* ptr to operand for | */
-
-  void* (*makearg)(va_list *);                 /* make fieldtype arg   */
-  void* (*copyarg)(const void *);              /* copy fieldtype arg   */
-  void (*freearg)(void *);                     /* free fieldtype arg   */
-
-  bool (*fcheck)(FIELD *,const void *);        /* field validation     */
-  bool (*ccheck)(int,const void *);            /* character validation */
-
-  bool (*next)(FIELD *,const void *);          /* enumerate next value */
-  bool (*prev)(FIELD *,const void *);          /* enumerate prev value */
-
-} FIELDTYPE;
 
        /*********
        *  FORM  *
        *********/
 
-typedef struct formnode {
-  unsigned short       status;         /* flags                        */
+typedef struct formnode
+#if 1                  /* not yet: !NCURSES_OPAQUE_FORM */
+{
+  unsigned short       status;         /* flags                        */
   short                        rows;           /* size in rows                 */
   short                        cols;           /* size in cols                 */
   int                  currow;         /* current row in field window  */
@@ -156,7 +146,56 @@ typedef struct formnode {
   void                 (*fieldinit)(struct formnode *);
   void                 (*fieldterm)(struct formnode *);
 
-} FORM;
+}
+#endif /* !NCURSES_OPAQUE_FORM */
+FORM;
+
+
+       /**************
+       *  FIELDTYPE  *
+       **************/
+
+typedef struct typenode
+#if !NCURSES_OPAQUE_FORM
+{
+  unsigned short       status;                 /* flags                    */
+  long                 ref;                    /* reference count          */
+  struct typenode *    left;                   /* ptr to operand for |     */
+  struct typenode *    right;                  /* ptr to operand for |     */
+
+  void* (*makearg)(va_list *);                 /* make fieldtype arg       */
+  void* (*copyarg)(const void *);              /* copy fieldtype arg       */
+  void (*freearg)(void *);                     /* free fieldtype arg       */
+
+#if NCURSES_INTEROP_FUNCS
+  union {
+    bool (*ofcheck)(FIELD *,const void *);     /* field validation         */
+    bool (*gfcheck)(FORM*,FIELD *,const void*);        /* generic field validation */
+  } fieldcheck;
+  union {
+    bool (*occheck)(int,const void *);         /* character validation     */
+    bool (*gccheck)(int,FORM*,
+                   FIELD*,const void*);        /* generic char validation  */
+  } charcheck;
+  union {
+    bool (*onext)(FIELD *,const void *);        /* enumerate next value     */
+    bool (*gnext)(FORM*,FIELD*,const void*);    /* generic enumerate next   */
+  } enum_next;
+  union {
+    bool (*oprev)(FIELD *,const void *);       /* enumerate prev value     */
+    bool (*gprev)(FORM*,FIELD*,const void*);    /* generic enumerate prev   */
+  } enum_prev;
+  void* (*genericarg)(void*);                   /* Alternate Arg method     */
+#else
+  bool (*fcheck)(FIELD *,const void *);        /* field validation     */
+  bool (*ccheck)(int,const void *);            /* character validation */
+
+  bool (*next)(FIELD *,const void *);          /* enumerate next value */
+  bool (*prev)(FIELD *,const void *);          /* enumerate prev value */
+#endif
+}
+#endif /* !NCURSES_OPAQUE_FORM */
+FIELDTYPE;
 
 typedef void (*Form_Hook)(FORM *);
 
@@ -181,6 +220,10 @@ typedef void (*Form_Hook)(FORM *);
 #define O_NULLOK               (0x0080U)
 #define O_PASSOK               (0x0100U)
 #define O_STATIC               (0x0200U)
+#define O_DYNAMIC_JUSTIFY      (0x0400U)       /* ncurses extension    */
+#define O_NO_LEFT_STRIP                (0x0800U)       /* ncurses extension    */
+#define O_EDGE_INSERT_STAY      (0x1000U)      /* ncurses extension    */
+#define O_INPUT_LIMIT           (0x2000U)      /* ncurses extension    */
 
 /* form options */
 #define O_NL_OVERLOAD          (0x0001U)
@@ -278,13 +321,6 @@ extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_REGEXP;
        ************************************/
 extern NCURSES_EXPORT_VAR(FIELDTYPE *) TYPE_IPV4;      /* Internet IP Version 4 address */
 
-       /***********************
-       *   Default objects    *
-       ***********************/
-extern NCURSES_EXPORT_VAR(FORM *)      _nc_Default_Form;
-extern NCURSES_EXPORT_VAR(FIELD *)     _nc_Default_Field;
-
-
        /***********************
        *  FIELDTYPE routines  *
        ***********************/
@@ -369,6 +405,7 @@ extern NCURSES_EXPORT(int)  field_count (const FORM *);
 extern NCURSES_EXPORT(int)     set_form_win (FORM *,WINDOW *);
 extern NCURSES_EXPORT(int)     set_form_sub (FORM *,WINDOW *);
 extern NCURSES_EXPORT(int)     set_current_field (FORM *,FIELD *);
+extern NCURSES_EXPORT(int)     unfocus_current_field (FORM *);
 extern NCURSES_EXPORT(int)     field_index (const FIELD *);
 extern NCURSES_EXPORT(int)     set_form_page (FORM *,int);
 extern NCURSES_EXPORT(int)     form_page (const FORM *);
@@ -381,6 +418,9 @@ extern NCURSES_EXPORT(int)  post_form (FORM *);
 extern NCURSES_EXPORT(int)     unpost_form (FORM *);
 extern NCURSES_EXPORT(int)     pos_form_cursor (FORM *);
 extern NCURSES_EXPORT(int)     form_driver (FORM *,int);
+# if NCURSES_WIDECHAR
+extern NCURSES_EXPORT(int)     form_driver_w (FORM *,int,wchar_t);
+# endif
 extern NCURSES_EXPORT(int)     set_form_userptr (FORM *,void *);
 extern NCURSES_EXPORT(int)     set_form_opts (FORM *,Form_Options);
 extern NCURSES_EXPORT(int)     form_opts_on (FORM *,Form_Options);
@@ -396,8 +436,13 @@ extern NCURSES_EXPORT(Form_Options)        form_opts (const FORM *);
 extern NCURSES_EXPORT(bool)    data_ahead (const FORM *);
 extern NCURSES_EXPORT(bool)    data_behind (const FORM *);
 
+#if NCURSES_SP_FUNCS
+extern NCURSES_EXPORT(FORM *)  NCURSES_SP_NAME(new_form) (SCREEN*, FIELD **);
+#endif
+
 #ifdef __cplusplus
   }
 #endif
+/* *INDENT-ON*/
 
-#endif /* FORM_H */
+#endif /* FORM_H */