ncurses 5.0
[ncurses.git] / form / fld_def.c
index 9b88ee3f35832b0ffbfd23add3f391c7aa3e46df..dd3de804688b49b3dd11da79635ed506a653e84a 100644 (file)
@@ -1,28 +1,38 @@
-/*-----------------------------------------------------------------------------+
-|           The ncurses form library is  Copyright (C) 1995-1997               |
-|             by Juergen Pfeifer <Juergen.Pfeifer@T-Online.de>                 |
-|                          All Rights Reserved.                                |
-|                                                                              |
-| Permission to use, copy, modify, and distribute this software and its        |
-| documentation for any purpose and without fee is hereby granted, provided    |
-| that the above copyright notice appear in all copies and that both that      |
-| copyright notice and this permission notice appear in supporting             |
-| documentation, and that the name of the above listed copyright holder(s) not |
-| be used in advertising or publicity pertaining to distribution of the        |
-| software without specific, written prior permission.                         | 
-|                                                                              |
-| THE ABOVE LISTED COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD TO  |
-| THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FIT-  |
-| NESS, IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR   |
-| ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RE- |
-| SULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, |
-| NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH    |
-| THE USE OR PERFORMANCE OF THIS SOFTWARE.                                     |
-+-----------------------------------------------------------------------------*/
+/****************************************************************************
+ * Copyright (c) 1998 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.                                                           *
+ ****************************************************************************/
+
+/****************************************************************************
+ *   Author: Juergen Pfeifer <juergen.pfeifer@gmx.net> 1995,1997            *
+ ****************************************************************************/
 
 #include "form.priv.h"
 
-MODULE_ID("$Id: fld_def.c,v 1.6 1997/05/01 16:47:54 juergen Exp $")
+MODULE_ID("$Id: fld_def.c,v 1.12 1999/05/16 17:37:48 juergen Exp $")
 
 /* this can't be readonly */
 static FIELD default_field = {
@@ -57,7 +67,7 @@ FIELD *_nc_Default_Field = &default_field;
 \f
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
-|   Function      :  static TypeArgument *Make_Argument(
+|   Function      :  TypeArgument *_nc_Make_Argument(
 |                              const FIELDTYPE *typ,
 |                              va_list *ap,
 |                              int *err )
@@ -69,7 +79,8 @@ FIELD *_nc_Default_Field = &default_field;
 |   Return Values :  Pointer to argument structure. Maybe NULL.
 |                    In case of an error in *err an errorcounter is increased. 
 +--------------------------------------------------------------------------*/
-static TypeArgument* Make_Argument(const FIELDTYPE *typ, va_list *ap, int *err)
+TypeArgument*
+_nc_Make_Argument(const FIELDTYPE *typ, va_list *ap, int *err)
 {
   TypeArgument *res = (TypeArgument *)0; 
   TypeArgument *p;
@@ -82,14 +93,15 @@ static TypeArgument* Make_Argument(const FIELDTYPE *typ, va_list *ap, int *err)
          p = (TypeArgument *)malloc(sizeof(TypeArgument));
          if (p) 
            {
-             p->left  = Make_Argument(typ->left ,ap,err);
-             p->right = Make_Argument(typ->right,ap,err);
+             p->left  = _nc_Make_Argument(typ->left ,ap,err);
+             p->right = _nc_Make_Argument(typ->right,ap,err);
              return p;
            }
          else
            *err += 1;
       } else 
        {
+         assert(typ->makearg);
          if ( !(res=(TypeArgument *)typ->makearg(ap)) ) 
            *err += 1;
        }
@@ -99,10 +111,9 @@ static TypeArgument* Make_Argument(const FIELDTYPE *typ, va_list *ap, int *err)
 
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
-|   Function      :  static TypeArgument *Copy_Argument(
-|                              const FIELDTYPE *typ,
-|                              const TypeArgument *argp,
-|                              int *err )
+|   Function      :  TypeArgument *_nc_Copy_Argument(const FIELDTYPE *typ,
+|                                                    const TypeArgument *argp,
+|                                                    int *err )
 |   
 |   Description   :  Create a copy of an argument structure for the specified 
 |                    type.
@@ -110,8 +121,9 @@ static TypeArgument* Make_Argument(const FIELDTYPE *typ, va_list *ap, int *err)
 |   Return Values :  Pointer to argument structure. Maybe NULL.
 |                    In case of an error in *err an errorcounter is increased. 
 +--------------------------------------------------------------------------*/
-static TypeArgument *Copy_Argument(const FIELDTYPE *typ,
-                                  const TypeArgument *argp, int *err)
+TypeArgument*
+_nc_Copy_Argument(const FIELDTYPE *typ,
+                 const TypeArgument *argp, int *err)
 {
   TypeArgument *res = (TypeArgument *)0;
   TypeArgument *p;
@@ -124,16 +136,21 @@ static TypeArgument *Copy_Argument(const FIELDTYPE *typ,
          p = (TypeArgument *)malloc(sizeof(TypeArgument));
          if (p)
            {
-             p->left  = Copy_Argument(typ,argp->left ,err);
-             p->right = Copy_Argument(typ,argp->right,err);
+             p->left  = _nc_Copy_Argument(typ,argp->left ,err);
+             p->right = _nc_Copy_Argument(typ,argp->right,err);
              return p;
            }
          *err += 1;
       } 
       else 
        {
-         if (!(res = (TypeArgument *)(typ->copyarg((const void *)argp)))) 
-           *err += 1;
+         if (typ->copyarg)
+           {
+             if (!(res = (TypeArgument *)(typ->copyarg((const void *)argp)))) 
+               *err += 1;
+           }
+         else
+           res = (TypeArgument *)argp;
        }
     }
   return res;
@@ -141,16 +158,16 @@ static TypeArgument *Copy_Argument(const FIELDTYPE *typ,
 
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
-|   Function      :  static void Free_Argument(
-|                                  const FIELDTYPE *typ,
-|                                  TypeArgument * argp )
+|   Function      :  void _nc_Free_Argument(const FIELDTYPE *typ,
+|                                           TypeArgument * argp )
 |   
 |   Description   :  Release memory associated with the argument structure
 |                    for the given fieldtype.
 |
 |   Return Values :  -
 +--------------------------------------------------------------------------*/
-static void Free_Argument(const FIELDTYPE * typ, TypeArgument * argp)
+void
+_nc_Free_Argument(const FIELDTYPE * typ, TypeArgument * argp)
 {
   if (!typ || !(typ->status & _HAS_ARGS)) 
     return;
@@ -158,63 +175,66 @@ static void Free_Argument(const FIELDTYPE * typ, TypeArgument * argp)
   if (typ->status & _LINKED_TYPE)
     {
       assert(argp);
-      Free_Argument(typ->left ,argp->left );
-      Free_Argument(typ->right,argp->right);
+      _nc_Free_Argument(typ->left ,argp->left );
+      _nc_Free_Argument(typ->right,argp->right);
       free(argp);
     } 
   else 
     {
-      typ->freearg((void *)argp);
+      if (typ->freearg)
+       typ->freearg((void *)argp);
     }
 }
 
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
-|   Function      :  static bool Copy_Type( FIELD *new, FIELD const *old )
+|   Function      :  bool _nc_Copy_Type( FIELD *dst, FIELD const *src )
 |   
-|   Description   :  Copy argument structure of field old to field new
+|   Description   :  Copy argument structure of field src to field dst
 |
 |   Return Values :  TRUE       - copy worked
 |                    FALSE      - error occured
 +--------------------------------------------------------------------------*/
-static bool Copy_Type(FIELD *new, FIELD const *old)
+bool
+_nc_Copy_Type(FIELD *dst, FIELD const *src)
 {
   int err = 0;
 
-  assert(new && old);
+  assert(dst && src);
 
-  new->type = old->type;
-  new->arg  = (void *)Copy_Argument(old->type,(TypeArgument *)(old->arg),&err);
+  dst->type = src->type;
+  dst->arg  = (void *)_nc_Copy_Argument(src->type,(TypeArgument *)(src->arg),&err);
 
   if (err)
     {
-      Free_Argument(new->type,(TypeArgument *)(new->arg));
-      new->type = (FIELDTYPE *)0;
-      new->arg  = (void *)0;
+      _nc_Free_Argument(dst->type,(TypeArgument *)(dst->arg));
+      dst->type = (FIELDTYPE *)0;
+      dst->arg  = (void *)0;
       return FALSE;
     }
   else
     {
-      if (new->type) 
-       new->type->ref++;
+      if (dst->type) 
+       dst->type->ref++;
       return TRUE;
     }
 }
 
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
-|   Function      :  static void Free_Type( FIELD *field )
+|   Function      :  void _nc_Free_Type( FIELD *field )
 |   
 |   Description   :  Release Argument structure for this field
 |
 |   Return Values :  -
 +--------------------------------------------------------------------------*/
-INLINE static void Free_Type(FIELD *field)
+void
+_nc_Free_Type(FIELD *field)
 {
   assert(field);
   if (field->type) 
     field->type->ref--;
-  Free_Argument(field->type,(TypeArgument *)(field->arg));
+  _nc_Free_Argument(field->type,(TypeArgument *)(field->arg));
 }
 
 /*---------------------------------------------------------------------------
@@ -258,7 +278,7 @@ FIELD *new_field(int rows, int cols, int frow, int fcol, int nrow, int nbuf)
       New_Field->nbuf  = nbuf;
       New_Field->link  = New_Field;
 
-      if (Copy_Type(New_Field,&default_field))
+      if (_nc_Copy_Type(New_Field,&default_field))
        {
          size_t len;
 
@@ -287,119 +307,6 @@ FIELD *new_field(int rows, int cols, int frow, int fcol, int nrow, int nbuf)
   return (FIELD *)0;
 }
 
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  FIELD *dup_field(FIELD *field, int frow, int fcol)
-|   
-|   Description   :  Duplicates the field at the specified position. All
-|                    field attributes and the buffers are copied.
-|                    If an error occurs, errno is set to
-|                    
-|                    E_BAD_ARGUMENT - invalid argument
-|                    E_SYSTEM_ERROR - system error
-|
-|   Return Values :  Pointer to the new field or NULL if failure
-+--------------------------------------------------------------------------*/
-FIELD *dup_field(FIELD * field, int frow, int fcol)
-{
-  FIELD *New_Field = (FIELD *)0;
-  int err = E_BAD_ARGUMENT;
-
-  if (field && (frow>=0) && (fcol>=0) && 
-      ((err=E_SYSTEM_ERROR) != 0) && /* trick : this resets the default error */
-      (New_Field=(FIELD *)malloc(sizeof(FIELD))) )
-    {
-      *New_Field         = default_field;
-      New_Field->frow    = frow;
-      New_Field->fcol    = fcol;
-      New_Field->link    = New_Field;
-      New_Field->rows    = field->rows;
-      New_Field->cols    = field->cols;
-      New_Field->nrow    = field->nrow;
-      New_Field->drows   = field->drows;
-      New_Field->dcols   = field->dcols;
-      New_Field->maxgrow = field->maxgrow;
-      New_Field->nbuf    = field->nbuf;
-      New_Field->just    = field->just;
-      New_Field->fore    = field->fore;
-      New_Field->back    = field->back;
-      New_Field->pad     = field->pad;
-      New_Field->opts    = field->opts;
-      New_Field->usrptr  = field->usrptr;
-
-      if (Copy_Type(New_Field,field))
-       {
-         size_t len;
-
-         len = Total_Buffer_Size(New_Field);
-         if ( (New_Field->buf=(char *)malloc(len)) )
-           {
-             memcpy(New_Field->buf,field->buf,len);
-             return New_Field;
-           }
-       }
-    }
-
-  if (New_Field) 
-    free_field(New_Field);
-
-  SET_ERROR(err);
-  return (FIELD *)0;
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  FIELD *link_field(FIELD *field, int frow, int fcol)  
-|   
-|   Description   :  Duplicates the field at the specified position. The
-|                    new field shares its buffers with the original one,
-|                    the attributes are independent.
-|                    If an error occurs, errno is set to
-|                    
-|                    E_BAD_ARGUMENT - invalid argument
-|                    E_SYSTEM_ERROR - system error
-|
-|   Return Values :  Pointer to the new field or NULL if failure
-+--------------------------------------------------------------------------*/
-FIELD *link_field(FIELD * field, int frow, int fcol)
-{
-  FIELD *New_Field = (FIELD *)0;
-  int err = E_BAD_ARGUMENT;
-
-  if (field && (frow>=0) && (fcol>=0) &&
-      ((err=E_SYSTEM_ERROR) != 0) && /* trick: this resets the default error */
-      (New_Field = (FIELD *)malloc(sizeof(FIELD))) )
-    {
-      *New_Field        = default_field;
-      New_Field->frow   = frow;
-      New_Field->fcol   = fcol;
-      New_Field->link   = field->link;
-      field->link       = New_Field;
-      New_Field->buf    = field->buf;
-      New_Field->rows   = field->rows;
-      New_Field->cols   = field->cols;
-      New_Field->nrow   = field->nrow;
-      New_Field->nbuf   = field->nbuf;
-      New_Field->drows  = field->drows;
-      New_Field->dcols  = field->dcols;
-      New_Field->maxgrow= field->maxgrow;
-      New_Field->just   = field->just;
-      New_Field->fore   = field->fore;
-      New_Field->back   = field->back;
-      New_Field->pad    = field->pad;
-      New_Field->opts   = field->opts;
-      New_Field->usrptr = field->usrptr;
-      if (Copy_Type(New_Field,field)) 
-       return New_Field;
-    }
-
-  if (New_Field) 
-    free_field(New_Field);
-
-  SET_ERROR( err );
-  return (FIELD *)0;
-}
-
 /*---------------------------------------------------------------------------
 |   Facility      :  libnform  
 |   Function      :  int free_field( FIELD *field )
@@ -431,231 +338,9 @@ int free_field(FIELD * field)
        {}
       f->link = field->link;
     }
-  Free_Type(field);
+  _nc_Free_Type(field);
   free(field);
   RETURN(E_OK);
 }
 
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  int field_info(const FIELD *field,
-|                                   int *rows, int *cols,
-|                                   int *frow, int *fcol,
-|                                   int *nrow, int *nbuf)
-|   
-|   Description   :  Retrieve infos about the fields creation parameters.
-|
-|   Return Values :  E_OK           - success
-|                    E_BAD_ARGUMENT - invalid field pointer
-+--------------------------------------------------------------------------*/
-int field_info(const FIELD *field,
-              int *rows, int *cols, 
-              int *frow, int *fcol, 
-              int *nrow, int *nbuf)
-{
-  if (!field) 
-    RETURN(E_BAD_ARGUMENT);
-
-  if (rows) *rows = field->rows;
-  if (cols) *cols = field->cols;
-  if (frow) *frow = field->frow;
-  if (fcol) *fcol = field->fcol;
-  if (nrow) *nrow = field->nrow;
-  if (nbuf) *nbuf = field->nbuf;
-  RETURN(E_OK);
-}
-       
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  int move_field(FIELD *field,int frow, int fcol)
-|   
-|   Description   :  Moves the disconnected field to the new location in
-|                    the forms subwindow.
-|
-|   Return Values :  E_OK            - success
-|                    E_BAD_ARGUMENT  - invalid argument passed
-|                    E_CONNECTED     - field is connected
-+--------------------------------------------------------------------------*/
-int move_field(FIELD *field, int frow, int fcol)
-{
-  if ( !field || (frow<0) || (fcol<0) ) 
-    RETURN(E_BAD_ARGUMENT);
-
-  if (field->form) 
-    RETURN(E_CONNECTED);
-
-  field->frow = frow;
-  field->fcol = fcol;
-  RETURN(E_OK);
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  int set_field_type(FIELD *field, FIELDTYPE *type,...)
-|   
-|   Description   :  Associate the specified fieldtype with the field.
-|                    Certain field types take additional arguments. Look
-|                    at the spec of the field types !
-|
-|   Return Values :  E_OK           - success
-|                    E_SYSTEM_ERROR - system error
-+--------------------------------------------------------------------------*/
-int set_field_type(FIELD *field,FIELDTYPE *type, ...)
-{
-  va_list ap;
-  int res = E_SYSTEM_ERROR;
-  int err = 0;
-
-  va_start(ap,type);
-
-  Normalize_Field(field);
-  Free_Type(field);
-
-  field->type = type;
-  field->arg  = (void *)Make_Argument(field->type,&ap,&err);
-
-  if (err)
-    {
-      Free_Argument(field->type,(TypeArgument *)(field->arg));
-      field->type = (FIELDTYPE *)0;
-      field->arg  = (void *)0;
-    }
-  else
-    {
-      res = E_OK;
-      if (field->type) 
-       field->type->ref++;
-    }
-
-  va_end(ap);
-  RETURN(res);
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  FIELDTYPE *field_type(const FIELD *field)
-|   
-|   Description   :  Retrieve the associated fieldtype for this field.
-|
-|   Return Values :  Pointer to fieldtype of NULL if none is defined.
-+--------------------------------------------------------------------------*/
-FIELDTYPE *field_type(const FIELD * field)
-{
-  return Normalize_Field(field)->type;
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  void *field_arg(const FIELD *field)
-|   
-|   Description   :  Retrieve pointer to the fields argument structure.
-|
-|   Return Values :  Pointer to structure or NULL if none is defined.
-+--------------------------------------------------------------------------*/
-void *field_arg(const FIELD * field)
-{
-  return Normalize_Field(field)->arg;
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  int set_max_field(FIELD *field, int maxgrow)
-|   
-|   Description   :  Set the maximum growth for a dynamic field. If maxgrow=0
-|                    the field may grow to any possible size.
-|
-|   Return Values :  E_OK           - success
-|                    E_BAD_ARGUMENT - invalid argument
-+--------------------------------------------------------------------------*/
-int set_max_field(FIELD *field, int maxgrow)
-{
-  if (!field || (maxgrow<0))
-    RETURN(E_BAD_ARGUMENT);
-  else
-    {
-      bool single_line_field = Single_Line_Field(field);
-
-      if (maxgrow>0)
-       {
-         if (( single_line_field && (maxgrow < field->dcols)) ||
-             (!single_line_field && (maxgrow < field->drows)))
-           RETURN(E_BAD_ARGUMENT);
-       }
-      field->maxgrow = maxgrow;
-      field->status &= ~_MAY_GROW;
-      if (!(field->opts & O_STATIC))
-       {
-         if ((maxgrow==0) ||
-             ( single_line_field && (field->dcols < maxgrow)) ||
-             (!single_line_field && (field->drows < maxgrow)))
-           field->status |= _MAY_GROW;
-       }
-    }
-  RETURN(E_OK);
-}
-                 
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  int dynamic_field_info(const FIELD *field,
-|                                           int *drows, int *dcols,
-|                                           int *maxgrow)
-|   
-|   Description   :  Retrieve informations about a dynamic fields current
-|                    dynamic parameters.
-|
-|   Return Values :  E_OK           - success
-|                    E_BAD_ARGUMENT - invalid argument
-+--------------------------------------------------------------------------*/
-int dynamic_field_info(const FIELD *field,
-                      int *drows, int *dcols, int *maxgrow)
-{
-  if (!field)
-    RETURN(E_BAD_ARGUMENT);
-
-  if (drows)   *drows   = field->drows;
-  if (dcols)   *dcols   = field->dcols;
-  if (maxgrow) *maxgrow = field->maxgrow;
-
-  RETURN(E_OK);
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  int set_new_page(FIELD *field, bool new_page_flag)
-|   
-|   Description   :  Marks the field as the beginning of a new page of 
-|                    the form.
-|
-|   Return Values :  E_OK         - success
-|                    E_CONNECTED  - field is connected
-+--------------------------------------------------------------------------*/
-int set_new_page(FIELD * field, bool new_page_flag)
-{
-  Normalize_Field(field);
-  if (field->form) 
-    RETURN(E_CONNECTED);
-
-  if (new_page_flag) 
-    field->status |= _NEWPAGE;
-  else
-    field->status &= ~_NEWPAGE;
-
-  RETURN(E_OK);
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnform  
-|   Function      :  bool new_page(const FIELD *field)
-|   
-|   Description   :  Retrieve the info whether or not the field starts a
-|                    new page on the form.
-|
-|   Return Values :  TRUE  - field starts a new page
-|                    FALSE - field doesn't start a new page
-+--------------------------------------------------------------------------*/
-bool new_page(const FIELD * field)
-{
-  return (Normalize_Field(field)->status & _NEWPAGE)  ? TRUE : FALSE;
-}
-
 /* fld_def.c ends here */