ncurses 5.7 - patch 20100123
[ncurses.git] / form / fld_current.c
1 /****************************************************************************
2  * Copyright (c) 1998-2004,2010 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.12 2010/01/23 21:14:35 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   T((T_CALLED("set_current_field(%p,%p)"), (void *)form, (void *)field));
56   if (form == 0 || field == 0)
57     {
58       RETURN(E_BAD_ARGUMENT);
59     }
60   else if ((form != field->form) || Field_Is_Not_Selectable(field))
61     {
62       RETURN(E_REQUEST_DENIED);
63     }
64   else if ((form->status & _POSTED) == 0)
65     {
66       form->current = field;
67       form->curpage = field->page;
68     }
69   else
70     {
71       if ((form->status & _IN_DRIVER) != 0)
72         {
73           err = E_BAD_STATE;
74         }
75       else
76         {
77           if (form->current != field)
78             {
79               if (!_nc_Internal_Validation(form))
80                 {
81                   err = E_INVALID_FIELD;
82                 }
83               else
84                 {
85                   Call_Hook(form, fieldterm);
86                   if (field->page != form->curpage)
87                     {
88                       Call_Hook(form, formterm);
89                       err = _nc_Set_Form_Page(form, (int)field->page, field);
90                       Call_Hook(form, forminit);
91                     }
92                   else
93                     {
94                       err = _nc_Set_Current_Field(form, field);
95                     }
96                   Call_Hook(form, fieldinit);
97                   (void)_nc_Refresh_Current_Field(form);
98                 }
99             }
100         }
101     }
102   RETURN(err);
103 }
104
105 /*---------------------------------------------------------------------------
106 |   Facility      :  libnform
107 |   Function      :  FIELD *current_field(const FORM * form)
108 |
109 |   Description   :  Return the current field.
110 |
111 |   Return Values :  Pointer to the current field.
112 +--------------------------------------------------------------------------*/
113 NCURSES_EXPORT(FIELD *)
114 current_field(const FORM *form)
115 {
116   T((T_CALLED("current_field(%p)"), (const void *)form));
117   returnField(Normalize_Form(form)->current);
118 }
119
120 /*---------------------------------------------------------------------------
121 |   Facility      :  libnform
122 |   Function      :  int field_index(const FIELD * field)
123 |
124 |   Description   :  Return the index of the field in the field-array of
125 |                    the form.
126 |
127 |   Return Values :  >= 0   : field index
128 |                    -1     : fieldpointer invalid or field not connected
129 +--------------------------------------------------------------------------*/
130 NCURSES_EXPORT(int)
131 field_index(const FIELD *field)
132 {
133   T((T_CALLED("field_index(%p)"), (const void *)field));
134   returnCode((field != 0 && field->form != 0) ? (int)field->index : -1);
135 }
136
137 /* fld_current.c ends here */