72534a9e36a3196cd02df6d5398a8624f54d8f4e
[ncurses.git] / form / fld_current.c
1 /****************************************************************************
2  * Copyright (c) 1998 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@T-Online.de> 1995,1997        *
31  ****************************************************************************/
32 #include "form.priv.h"
33
34 MODULE_ID("$Id: fld_current.c,v 1.2 1998/02/11 12:13:44 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 int set_current_field(FORM  * form, FIELD * field)
50 {
51   int err = E_OK;
52
53   if ( !form || !field )
54     RETURN(E_BAD_ARGUMENT);
55
56   if ( (form != field->form) || Field_Is_Not_Selectable(field) )
57     RETURN(E_REQUEST_DENIED);
58
59   if (!(form->status & _POSTED))
60     {
61       form->current = field;
62       form->curpage = field->page;
63   }
64   else
65     {
66       if (form->status & _IN_DRIVER) 
67         err = E_BAD_STATE;
68       else
69         {
70           if (form->current != field)
71             {
72               if (!_nc_Internal_Validation(form)) 
73                err = E_INVALID_FIELD;
74               else
75                 {
76                   Call_Hook(form,fieldterm);
77                   if (field->page != form->curpage)
78                     {
79                       Call_Hook(form,formterm);
80                       err = _nc_Set_Form_Page(form,field->page,field);
81                       Call_Hook(form,forminit);
82                     } 
83                   else 
84                     {
85                       err = _nc_Set_Current_Field(form,field);
86                     }
87                   Call_Hook(form,fieldinit);
88                   _nc_Refresh_Current_Field(form);
89                 }
90             }
91         }
92     }
93   RETURN(err);
94 }
95
96 /*---------------------------------------------------------------------------
97 |   Facility      :  libnform  
98 |   Function      :  FIELD *current_field(const FORM * form)
99 |   
100 |   Description   :  Return the current field.
101 |
102 |   Return Values :  Pointer to the current field.
103 +--------------------------------------------------------------------------*/
104 FIELD *current_field(const FORM * form)
105 {
106   return Normalize_Form(form)->current;
107 }
108
109 /*---------------------------------------------------------------------------
110 |   Facility      :  libnform  
111 |   Function      :  int field_index(const FIELD * field)
112 |   
113 |   Description   :  Return the index of the field in the field-array of
114 |                    the form.
115 |
116 |   Return Values :  >= 0   : field index
117 |                    -1     : fieldpointer invalid or field not connected
118 +--------------------------------------------------------------------------*/
119 int field_index(const FIELD * field)
120 {
121   return ( (field && field->form) ? field->index : -1 );
122 }
123
124 /* fld_current.c ends here */