ncurses 6.1 - patch 20190831
[ncurses.git] / form / fty_enum.c
index 4ad69fb50a7db5606e14ec05e9e442cc6a41fd24..d3351644ef1849f2aa9de6dfd7ab31674cc08e8c 100644 (file)
+/****************************************************************************
+ * Copyright (c) 1998-2009,2010 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            *
+ * "Software"), to deal in the Software without restriction, including      *
+ * without limitation the rights to use, copy, modify, merge, publish,      *
+ * distribute, distribute with modifications, sublicense, and/or sell       *
+ * copies of the Software, and to permit persons to whom the Software is    *
+ * furnished to do so, subject to the following conditions:                 *
+ *                                                                          *
+ * The above copyright notice and this permission notice shall be included  *
+ * in all copies or substantial portions of the Software.                   *
+ *                                                                          *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+ *                                                                          *
+ * Except as contained in this notice, the name(s) of the above copyright   *
+ * holders shall not be used in advertising or otherwise to promote the     *
+ * sale, use or other dealings in this Software without prior written       *
+ * authorization.                                                           *
+ ****************************************************************************/
 
-/*
- * THIS CODE IS SPECIFICALLY EXEMPTED FROM THE NCURSES PACKAGE COPYRIGHT.
- * You may freely copy it for use as a template for your own field types.
- * If you develop a field type that might be of general use, please send
- * it back to the ncurses maintainers for inclusion in the next version.
- */
 /***************************************************************************
 *                                                                          *
-*  Author : Juergen Pfeifer, juergen.pfeifer@gmx.net                       *
+*  Author : Juergen Pfeifer                                                *
 *                                                                          *
 ***************************************************************************/
 
 #include "form.priv.h"
 
-MODULE_ID("$Id: fty_enum.c,v 1.14 2000/10/18 09:28:19 juergen Exp $")
+MODULE_ID("$Id: fty_enum.c,v 1.26 2010/05/01 21:11:07 tom Exp $")
 
-typedef struct {
-  char **kwds;
-  int  count;
-  bool checkcase;
-  bool checkunique;
-} enumARG;
+typedef struct
+  {
+    char **kwds;
+    int count;
+    bool checkcase;
+    bool checkunique;
+  }
+enumARG;
+
+typedef struct
+  {
+    char **kwds;
+    int ccase;
+    int cunique;
+  }
+enumParams;
 
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
-|   Function      :  static void *Make_Enum_Type( va_list * ap )
+|   Function      :  static void *Generic_Enum_Type(void * arg)
 |   
 |   Description   :  Allocate structure for enumeration type argument.
 |
 |   Return Values :  Pointer to argument structure or NULL on error
 +--------------------------------------------------------------------------*/
-static void *Make_Enum_Type(va_list * ap)
+static void *
+Generic_Enum_Type(void *arg)
 {
-  enumARG *argp = (enumARG *)malloc(sizeof(enumARG));
+  enumARG *argp = (enumARG *)0;
+  enumParams *params = (enumParams *) arg;
 
-  if (argp)
+  if (params)
     {
-      int cnt = 0;
-      char **kp = (char **)0;
-      int ccase, cunique;
-
-      argp->kwds        = va_arg(*ap,char **);
-      ccase             = va_arg(*ap,int);
-      cunique           = va_arg(*ap,int);
-      argp->checkcase   = ccase   ? TRUE : FALSE;
-      argp->checkunique = cunique ? TRUE : FALSE;
-
-      kp = argp->kwds;
-      while( kp && (*kp++) ) cnt++;
-      argp->count = cnt;
+      argp = typeMalloc(enumARG, 1);
+
+      if (argp)
+       {
+         int cnt = 0;
+         char **kp = (char **)0;
+         char **kwds = (char **)0;
+         char **kptarget;
+         int ccase, cunique;
+
+         T((T_CREATE("enumARG %p"), (void *)argp));
+         kwds = params->kwds;
+         ccase = params->ccase;
+         cunique = params->cunique;
+
+         argp->checkcase = ccase ? TRUE : FALSE;
+         argp->checkunique = cunique ? TRUE : FALSE;
+         argp->kwds = (char **)0;
+
+         kp = kwds;
+         while (kp && (*kp++))
+           cnt++;
+         argp->count = cnt;
+
+         if (cnt > 0)
+           {
+             /* We copy the keywords, because we can't rely on the fact
+                that the caller doesn't relocate or free the memory used
+                for the keywords (maybe he has GC)
+              */
+             argp->kwds = typeMalloc(char *, cnt + 1);
+
+             kp = kwds;
+             if ((kptarget = argp->kwds) != 0)
+               {
+                 while (kp && (*kp))
+                   {
+                     (*kptarget++) = strdup(*kp++);
+                   }
+                 *kptarget = (char *)0;
+               }
+           }
+       }
     }
   return (void *)argp;
 }
 
+/*---------------------------------------------------------------------------
+|   Facility      :  libnform  
+|   Function      :  static void *Make_Enum_Type( va_list * ap )
+|   
+|   Description   :  Allocate structure for enumeration type argument.
+|
+|   Return Values :  Pointer to argument structure or NULL on error
++--------------------------------------------------------------------------*/
+static void *
+Make_Enum_Type(va_list *ap)
+{
+  enumParams params;
+
+  params.kwds = va_arg(*ap, char **);
+  params.ccase = va_arg(*ap, int);
+  params.cunique = va_arg(*ap, int);
+
+  return Generic_Enum_Type((void *)&params);
+}
+
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
 |   Function      :  static void *Copy_Enum_Type( const void * argp )
@@ -61,7 +144,8 @@ static void *Make_Enum_Type(va_list * ap)
 |
 |   Return Values :  Pointer to argument structure or NULL on error.
 +--------------------------------------------------------------------------*/
-static void *Copy_Enum_Type(const void * argp)
+static void *
+Copy_Enum_Type(const void *argp)
 {
   enumARG *result = (enumARG *)0;
 
@@ -69,9 +153,29 @@ static void *Copy_Enum_Type(const void * argp)
     {
       const enumARG *ap = (const enumARG *)argp;
 
-      result = (enumARG *)malloc(sizeof(enumARG));
+      result = typeMalloc(enumARG, 1);
+
       if (result)
-       *result = *ap;
+       {
+         T((T_CREATE("enumARG %p"), (void *)result));
+         *result = *ap;
+
+         if (ap->count > 0)
+           {
+             char **kptarget;
+             char **kp = ap->kwds;
+             result->kwds = typeMalloc(char *, 1 + ap->count);
+
+             if ((kptarget = result->kwds) != 0)
+               {
+                 while (kp && (*kp))
+                   {
+                     (*kptarget++) = strdup(*kp++);
+                   }
+                 *kptarget = (char *)0;
+               }
+           }
+       }
     }
   return (void *)result;
 }
@@ -84,10 +188,28 @@ static void *Copy_Enum_Type(const void * argp)
 |
 |   Return Values :  -
 +--------------------------------------------------------------------------*/
-static void Free_Enum_Type(void * argp)
+static void
+Free_Enum_Type(void *argp)
 {
-  if (argp) 
-    free(argp);
+  if (argp)
+    {
+      const enumARG *ap = (const enumARG *)argp;
+
+      if (ap->kwds && ap->count > 0)
+       {
+         char **kp = ap->kwds;
+         int cnt = 0;
+
+         while (kp && (*kp))
+           {
+             free(*kp++);
+             cnt++;
+           }
+         assert(cnt == ap->count);
+         free(ap->kwds);
+       }
+      free(argp);
+    }
 }
 
 #define SKIP_SPACE(x) while(((*(x))!='\0') && (is_blank(*(x)))) (x)++
@@ -101,37 +223,40 @@ static void Free_Enum_Type(void * argp)
 |                                       const unsigned char * buf,
 |                                       bool  ccase )
 |   
-|   Description   :  Check wether or not the text in 'buf' matches the
+|   Description   :  Check whether or not the text in 'buf' matches the
 |                    text in 's', at least partial.
 |
 |   Return Values :  NOMATCH   - buffer doesn't match
 |                    PARTIAL   - buffer matches partially
 |                    EXACT     - buffer matches exactly
 +--------------------------------------------------------------------------*/
-static int Compare(const unsigned char *s, const unsigned char *buf, 
-                  bool ccase)
+static int
+Compare(const unsigned char *s, const unsigned char *buf,
+       bool ccase)
 {
-  SKIP_SPACE(buf); /* Skip leading spaces in both texts */
+  SKIP_SPACE(buf);             /* Skip leading spaces in both texts */
   SKIP_SPACE(s);
 
-  if (*buf=='\0')
+  if (*buf == '\0')
     {
-      return (((*s)!='\0') ? NOMATCH : EXACT);
-    } 
-  else 
+      return (((*s) != '\0') ? NOMATCH : EXACT);
+    }
+  else
     {
       if (ccase)
        {
-         while(*s++ == *buf)
+         while (*s++ == *buf)
            {
-             if (*buf++=='\0') return EXACT;
-           } 
-       } 
-      else 
+             if (*buf++ == '\0')
+               return EXACT;
+           }
+       }
+      else
        {
-         while(toupper(*s++)==toupper(*buf))
+         while (toupper(*s++) == toupper(*buf))
            {
-             if (*buf++=='\0') return EXACT;
+             if (*buf++ == '\0')
+               return EXACT;
            }
        }
     }
@@ -139,12 +264,12 @@ static int Compare(const unsigned char *s, const unsigned char *buf,
      matches with s. So if only blanks are following, we have a partial
      match otherwise there is no match */
   SKIP_SPACE(buf);
-  if (*buf) 
+  if (*buf)
     return NOMATCH;
 
   /* If it happens that the reference buffer is at its end, the partial
      match is actually an exact match. */
-  return ((s[-1]!='\0') ? PARTIAL : EXACT);
+  return ((s[-1] != '\0') ? PARTIAL : EXACT);
 }
 
 /*---------------------------------------------------------------------------
@@ -158,27 +283,28 @@ static int Compare(const unsigned char *s, const unsigned char *buf,
 |   Return Values :  TRUE  - field is valid
 |                    FALSE - field is invalid
 +--------------------------------------------------------------------------*/
-static bool Check_Enum_Field(FIELD * field, const void  * argp)
+static bool
+Check_Enum_Field(FIELD *field, const void *argp)
 {
-  char **kwds       = ((const enumARG *)argp)->kwds;
-  bool ccase        = ((const enumARG *)argp)->checkcase;
-  bool unique       = ((const enumARG *)argp)->checkunique;
-  unsigned char *bp = (unsigned char *)field_buffer(field,0);
+  char **kwds = ((const enumARG *)argp)->kwds;
+  bool ccase = ((const enumARG *)argp)->checkcase;
+  bool unique = ((const enumARG *)argp)->checkunique;
+  unsigned char *bp = (unsigned char *)field_buffer(field, 0);
   char *s, *t, *p;
   int res;
-  
-  while( kwds && (s=(*kwds++)) )
+
+  while (kwds && (s = (*kwds++)))
     {
-      if ((res=Compare((unsigned char *)s,bp,ccase))!=NOMATCH)
+      if ((res = Compare((unsigned char *)s, bp, ccase)) != NOMATCH)
        {
-         p=t=s; /* t is at least a partial match */
-         if ((unique && res!=EXACT)) 
+         p = t = s;            /* t is at least a partial match */
+         if ((unique && res != EXACT))
            {
-             while( kwds && (p = *kwds++) )
+             while (kwds && (p = *kwds++))
                {
-                 if ((res=Compare((unsigned char *)p,bp,ccase))!=NOMATCH)
+                 if ((res = Compare((unsigned char *)p, bp, ccase)) != NOMATCH)
                    {
-                     if (res==EXACT)
+                     if (res == EXACT)
                        {
                          t = p;
                          break;
@@ -187,10 +313,10 @@ static bool Check_Enum_Field(FIELD * field, const void  * argp)
                        t = (char *)0;
                    }
                }
-           }     
+           }
          if (t)
            {
-             set_field_buffer(field,0,t);
+             set_field_buffer(field, 0, t);
              return TRUE;
            }
          if (!p)
@@ -200,7 +326,8 @@ static bool Check_Enum_Field(FIELD * field, const void  * argp)
   return FALSE;
 }
 
-static const char *dummy[] = { (char *)0 };
+static const char *dummy[] =
+{(char *)0};
 
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
@@ -212,28 +339,30 @@ static const char *dummy[] = { (char *)0 };
 |   Return Values :  TRUE  - next value found and loaded
 |                    FALSE - no next value loaded
 +--------------------------------------------------------------------------*/
-static bool Next_Enum(FIELD * field, const void * argp)
+static bool
+Next_Enum(FIELD *field, const void *argp)
 {
   const enumARG *args = (const enumARG *)argp;
-  char **kwds       = args->kwds;
-  bool ccase        = args->checkcase;
-  int cnt           = args->count;
-  unsigned char *bp = (unsigned char *)field_buffer(field,0);
-
-  if (kwds) {
-    while(cnt--)
-      {
-       if (Compare((unsigned char *)(*kwds++),bp,ccase)==EXACT) 
-         break;
-      }
-    if (cnt<=0)
-      kwds = args->kwds;
-    if ((cnt>=0) || (Compare((const unsigned char *)dummy,bp,ccase)==EXACT))
-      {
-       set_field_buffer(field,0,*kwds);
-       return TRUE;
-      }
-  }
+  char **kwds = args->kwds;
+  bool ccase = args->checkcase;
+  int cnt = args->count;
+  unsigned char *bp = (unsigned char *)field_buffer(field, 0);
+
+  if (kwds)
+    {
+      while (cnt--)
+       {
+         if (Compare((unsigned char *)(*kwds++), bp, ccase) == EXACT)
+           break;
+       }
+      if (cnt <= 0)
+       kwds = args->kwds;
+      if ((cnt >= 0) || (Compare((const unsigned char *)dummy, bp, ccase) == EXACT))
+       {
+         set_field_buffer(field, 0, *kwds);
+         return TRUE;
+       }
+    }
   return FALSE;
 }
 
@@ -248,48 +377,66 @@ static bool Next_Enum(FIELD * field, const void * argp)
 |   Return Values :  TRUE  - previous value found and loaded
 |                    FALSE - no previous value loaded
 +--------------------------------------------------------------------------*/
-static bool Previous_Enum(FIELD * field, const void * argp)
+static bool
+Previous_Enum(FIELD *field, const void *argp)
 {
   const enumARG *args = (const enumARG *)argp;
-  int cnt       = args->count;
-  char **kwds   = &args->kwds[cnt-1];
-  bool ccase    = args->checkcase;
-  unsigned char *bp = (unsigned char *)field_buffer(field,0);
-
-  if (kwds) {
-    while(cnt--)
-      {
-       if (Compare((unsigned char *)(*kwds--),bp,ccase)==EXACT) 
-         break;
-      }
-    
-    if (cnt<=0)
-      kwds  = &args->kwds[args->count-1];
-    
-    if ((cnt>=0) || (Compare((const unsigned char *)dummy,bp,ccase)==EXACT))
-      {
-       set_field_buffer(field,0,*kwds);
-       return TRUE;
-      }
-  }
+  int cnt = args->count;
+  char **kwds = &args->kwds[cnt - 1];
+  bool ccase = args->checkcase;
+  unsigned char *bp = (unsigned char *)field_buffer(field, 0);
+
+  if (kwds)
+    {
+      while (cnt--)
+       {
+         if (Compare((unsigned char *)(*kwds--), bp, ccase) == EXACT)
+           break;
+       }
+
+      if (cnt <= 0)
+       kwds = &args->kwds[args->count - 1];
+
+      if ((cnt >= 0) || (Compare((const unsigned char *)dummy, bp, ccase) == EXACT))
+       {
+         set_field_buffer(field, 0, *kwds);
+         return TRUE;
+       }
+    }
   return FALSE;
 }
 
-
-static FIELDTYPE typeENUM = {
+static FIELDTYPE typeENUM =
+{
   _HAS_ARGS | _HAS_CHOICE | _RESIDENT,
-  1,                           /* this is mutable, so we can't be const */
+  1,                           /* this is mutable, so we can't be const */
   (FIELDTYPE *)0,
   (FIELDTYPE *)0,
   Make_Enum_Type,
   Copy_Enum_Type,
   Free_Enum_Type,
-  Check_Enum_Field,
-  NULL,
-  Next_Enum,
-  Previous_Enum
+  INIT_FT_FUNC(Check_Enum_Field),
+  INIT_FT_FUNC(NULL),
+  INIT_FT_FUNC(Next_Enum),
+  INIT_FT_FUNC(Previous_Enum),
+#if NCURSES_INTEROP_FUNCS
+  Generic_Enum_Type
+#endif
 };
 
-FIELDTYPE* TYPE_ENUM = &typeENUM;
+NCURSES_EXPORT_VAR(FIELDTYPE *)
+TYPE_ENUM = &typeENUM;
+
+#if NCURSES_INTEROP_FUNCS
+/* The next routines are to simplify the use of ncurses from
+   programming languages with restictions on interop with C level
+   constructs (e.g. variable access or va_list + ellipsis constructs)
+*/
+NCURSES_EXPORT(FIELDTYPE *)
+_nc_TYPE_ENUM(void)
+{
+  return TYPE_ENUM;
+}
+#endif
 
 /* fty_enum.c ends here */