xref: /freebsd/contrib/ncurses/form/fld_current.c (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
1 /****************************************************************************
2  * Copyright (c) 1998,2000 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 <juergen.pfeifer@gmx.net> 1995,1997            *
31  ****************************************************************************/
32 #include "form.priv.h"
33 
34 MODULE_ID("$Id: fld_current.c,v 1.5 2000/12/10 02:09:38 tom Exp $")
35 
36 /*---------------------------------------------------------------------------
37 |   Facility      :  libnform
38 |   Function      :  int set_current_field(FORM  * form,FIELD * field)
39 |
40 |   Description   :  Set the current field of the form to the specified one.
41 |
42 |   Return Values :  E_OK              - success
43 |                    E_BAD_ARGUMENT    - invalid form or field pointer
44 |                    E_REQUEST_DENIED  - field not selectable
45 |                    E_BAD_STATE       - called from a hook routine
46 |                    E_INVALID_FIELD   - current field can't be left
47 |                    E_SYSTEM_ERROR    - system error
48 +--------------------------------------------------------------------------*/
49 NCURSES_EXPORT(int)
50 set_current_field (FORM  * form, FIELD * field)
51 {
52   int err = E_OK;
53 
54   if ( !form || !field )
55     RETURN(E_BAD_ARGUMENT);
56 
57   if ( (form != field->form) || Field_Is_Not_Selectable(field) )
58     RETURN(E_REQUEST_DENIED);
59 
60   if (!(form->status & _POSTED))
61     {
62       form->current = field;
63       form->curpage = field->page;
64   }
65   else
66     {
67       if (form->status & _IN_DRIVER)
68 	err = E_BAD_STATE;
69       else
70 	{
71 	  if (form->current != field)
72 	    {
73 	      if (!_nc_Internal_Validation(form))
74 	       err = E_INVALID_FIELD;
75 	      else
76 		{
77 		  Call_Hook(form,fieldterm);
78 		  if (field->page != form->curpage)
79 		    {
80 		      Call_Hook(form,formterm);
81 		      err = _nc_Set_Form_Page(form,field->page,field);
82 		      Call_Hook(form,forminit);
83 		    }
84 		  else
85 		    {
86 		      err = _nc_Set_Current_Field(form,field);
87 		    }
88 		  Call_Hook(form,fieldinit);
89 		  _nc_Refresh_Current_Field(form);
90 		}
91 	    }
92 	}
93     }
94   RETURN(err);
95 }
96 
97 /*---------------------------------------------------------------------------
98 |   Facility      :  libnform
99 |   Function      :  FIELD *current_field(const FORM * form)
100 |
101 |   Description   :  Return the current field.
102 |
103 |   Return Values :  Pointer to the current field.
104 +--------------------------------------------------------------------------*/
105 NCURSES_EXPORT(FIELD *)
106 current_field (const FORM * form)
107 {
108   return Normalize_Form(form)->current;
109 }
110 
111 /*---------------------------------------------------------------------------
112 |   Facility      :  libnform
113 |   Function      :  int field_index(const FIELD * field)
114 |
115 |   Description   :  Return the index of the field in the field-array of
116 |                    the form.
117 |
118 |   Return Values :  >= 0   : field index
119 |                    -1     : fieldpointer invalid or field not connected
120 +--------------------------------------------------------------------------*/
121 NCURSES_EXPORT(int)
122 field_index (const FIELD * field)
123 {
124   return ( (field && field->form) ? field->index : -1 );
125 }
126 
127 /* fld_current.c ends here */
128