contrib/ncurses-5.4/form/fld_current.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
   3  *                                                                          *
   4  * Permission is hereby granted, free of charge, to any person obtaining a  *
   5  * copy of this software and associated documentation files (the            *
   6  * "Software"), to deal in the Software without restriction, including      *
   7  * without limitation the rights to use, copy, modify, merge, publish,      *
   8  * distribute, distribute with modifications, sublicense, and/or sell       *
   9  * copies of the Software, and to permit persons to whom the Software is    *
  10  * furnished to do so, subject to the following conditions:                 *
  11  *                                                                          *
  12  * The above copyright notice and this permission notice shall be included  *
  13  * in all copies or substantial portions of the Software.                   *
  14  *                                                                          *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22  *                                                                          *
  23  * Except as contained in this notice, the name(s) of the above copyright   *
  24  * holders shall not be used in advertising or otherwise to promote the     *
  25  * sale, use or other dealings in this Software without prior written       *
  26  * authorization.                                                           *
  27  ****************************************************************************/
  28
  29 /****************************************************************************
  30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
  31  ****************************************************************************/
  32
  33 #include "form.priv.h"
  34
  35 MODULE_ID("$Id: fld_current.c,v 1.7 2003/10/25 15:17:08 tom Exp $")
  36
  37 /*---------------------------------------------------------------------------
  38 |   Facility      :  libnform
  39 |   Function      :  int set_current_field(FORM  * form,FIELD * field)
  40 |
  41 |   Description   :  Set the current field of the form to the specified one.
  42 |
  43 |   Return Values :  E_OK              - success
  44 |                    E_BAD_ARGUMENT    - invalid form or field pointer
  45 |                    E_REQUEST_DENIED  - field not selectable
  46 |                    E_BAD_STATE       - called from a hook routine
  47 |                    E_INVALID_FIELD   - current field can't be left
  48 |                    E_SYSTEM_ERROR    - system error
  49 +--------------------------------------------------------------------------*/
  50 NCURSES_EXPORT(int)
  51 set_current_field (FORM  * form, FIELD * field)
  52 {
  53   int err = E_OK;
  54
  55   if ( !form || !field )
  56     RETURN(E_BAD_ARGUMENT);
  57
  58   if ( (form != field->form) || Field_Is_Not_Selectable(field) )
  59     RETURN(E_REQUEST_DENIED);
  60
  61   if (!(form->status & _POSTED))
  62     {
  63       form->current = field;
  64       form->curpage = field->page;
  65   }
  66   else
  67     {
  68       if (form->status & _IN_DRIVER)
  69         err = E_BAD_STATE;
  70       else
  71         {
  72           if (form->current != field)
  73             {
  74               if (!_nc_Internal_Validation(form))
  75                err = E_INVALID_FIELD;
  76               else
  77                 {
  78                   Call_Hook(form,fieldterm);
  79                   if (field->page != form->curpage)
  80                     {
  81                       Call_Hook(form,formterm);
  82                       err = _nc_Set_Form_Page(form,field->page,field);
  83                       Call_Hook(form,forminit);
  84                     }
  85                   else
  86                     {
  87                       err = _nc_Set_Current_Field(form,field);
  88                     }
  89                   Call_Hook(form,fieldinit);
  90                   _nc_Refresh_Current_Field(form);
  91                 }
  92             }
  93         }
  94     }
  95   RETURN(err);
  96 }
  97
  98 /*---------------------------------------------------------------------------
  99 |   Facility      :  libnform
 100 |   Function      :  FIELD *current_field(const FORM * form)
 101 |
 102 |   Description   :  Return the current field.
 103 |
 104 |   Return Values :  Pointer to the current field.
 105 +--------------------------------------------------------------------------*/
 106 NCURSES_EXPORT(FIELD *)
 107 current_field (const FORM * form)
 108 {
 109   return Normalize_Form(form)->current;
 110 }
 111
 112 /*---------------------------------------------------------------------------
 113 |   Facility      :  libnform
 114 |   Function      :  int field_index(const FIELD * field)
 115 |
 116 |   Description   :  Return the index of the field in the field-array of
 117 |                    the form.
 118 |
 119 |   Return Values :  >= 0   : field index
 120 |                    -1     : fieldpointer invalid or field not connected
 121 +--------------------------------------------------------------------------*/
 122 NCURSES_EXPORT(int)
 123 field_index (const FIELD * field)
 124 {
 125   return ( (field && field->form) ? field->index : -1 );
 126 }
 127
 128 /* fld_current.c ends here */