form/fld_info.c

   1 /****************************************************************************
   2  * Copyright 2020,2021 Thomas E. Dickey                                     *
   3  * Copyright 1998-2004,2010 Free Software Foundation, Inc.                  *
   4  *                                                                          *
   5  * Permission is hereby granted, free of charge, to any person obtaining a  *
   6  * copy of this software and associated documentation files (the            *
   7  * "Software"), to deal in the Software without restriction, including      *
   8  * without limitation the rights to use, copy, modify, merge, publish,      *
   9  * distribute, distribute with modifications, sublicense, and/or sell       *
  10  * copies of the Software, and to permit persons to whom the Software is    *
  11  * furnished to do so, subject to the following conditions:                 *
  12  *                                                                          *
  13  * The above copyright notice and this permission notice shall be included  *
  14  * in all copies or substantial portions of the Software.                   *
  15  *                                                                          *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23  *                                                                          *
  24  * Except as contained in this notice, the name(s) of the above copyright   *
  25  * holders shall not be used in advertising or otherwise to promote the     *
  26  * sale, use or other dealings in this Software without prior written       *
  27  * authorization.                                                           *
  28  ****************************************************************************/
  29
  30 /****************************************************************************
  31  *   Author:  Juergen Pfeifer, 1995,1997                                    *
  32  ****************************************************************************/
  33
  34 #include "form.priv.h"
  35
  36 MODULE_ID("$Id: fld_info.c,v 1.16 2021/06/17 21:20:30 tom Exp $")
  37
  38 /*---------------------------------------------------------------------------
  39 |   Facility      :  libnform
  40 |   Function      :  int field_info(const FIELD *field,
  41 |                                   int *rows, int *cols,
  42 |                                   int *frow, int *fcol,
  43 |                                   int *nrow, int *nbuf)
  44 |
  45 |   Description   :  Retrieve information about the field's creation parameters.
  46 |
  47 |   Return Values :  E_OK           - success
  48 |                    E_BAD_ARGUMENT - invalid field pointer
  49 +--------------------------------------------------------------------------*/
  50 FORM_EXPORT(int)
  51 field_info(const FIELD *field,
  52            int *rows, int *cols,
  53            int *frow, int *fcol,
  54            int *nrow, int *nbuf)
  55 {
  56   T((T_CALLED("field_info(%p,%p,%p,%p,%p,%p,%p)"),
  57      (const void *)field,
  58      (void *)rows, (void *)cols,
  59      (void *)frow, (void *)fcol,
  60      (void *)nrow, (void *)nbuf));
  61
  62   if (!field)
  63     RETURN(E_BAD_ARGUMENT);
  64
  65   if (rows)
  66     *rows = field->rows;
  67   if (cols)
  68     *cols = field->cols;
  69   if (frow)
  70     *frow = field->frow;
  71   if (fcol)
  72     *fcol = field->fcol;
  73   if (nrow)
  74     *nrow = field->nrow;
  75   if (nbuf)
  76     *nbuf = field->nbuf;
  77   RETURN(E_OK);
  78 }
  79
  80 /*---------------------------------------------------------------------------
  81 |   Facility      :  libnform
  82 |   Function      :  int dynamic_field_info(const FIELD *field,
  83 |                                           int *drows, int *dcols,
  84 |                                           int *maxgrow)
  85 |
  86 |   Description   :  Retrieve information about a dynamic field's current
  87 |                    dynamic parameters.
  88 |
  89 |   Return Values :  E_OK           - success
  90 |                    E_BAD_ARGUMENT - invalid argument
  91 +--------------------------------------------------------------------------*/
  92 FORM_EXPORT(int)
  93 dynamic_field_info(const FIELD *field, int *drows, int *dcols, int *maxgrow)
  94 {
  95   T((T_CALLED("dynamic_field_info(%p,%p,%p,%p)"),
  96      (const void *)field,
  97      (void *)drows,
  98      (void *)dcols,
  99      (void *)maxgrow));
 100
 101   if (!field)
 102     RETURN(E_BAD_ARGUMENT);
 103
 104   if (drows)
 105     *drows = field->drows;
 106   if (dcols)
 107     *dcols = field->dcols;
 108   if (maxgrow)
 109     *maxgrow = field->maxgrow;
 110
 111   RETURN(E_OK);
 112 }
 113
 114 /* fld_info.c ends here */