ncurses 6.2 - patch 20211018
[ncurses.git] / form / frm_cursor.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: frm_cursor.c,v 1.13 2021/06/17 21:20:30 tom Exp $")
37
38 /*---------------------------------------------------------------------------
39 |   Facility      :  libnform
40 |   Function      :  int pos_form_cursor(FORM * form)
41 |
42 |   Description   :  Moves the form window cursor to the location required
43 |                    by the form driver to resume form processing. This may
44 |                    be needed after the application calls a curses library
45 |                    I/O routine that modifies the cursor position.
46 |
47 |   Return Values :  E_OK                      - Success
48 |                    E_SYSTEM_ERROR            - System error.
49 |                    E_BAD_ARGUMENT            - Invalid form pointer
50 |                    E_NOT_POSTED              - Form is not posted
51 +--------------------------------------------------------------------------*/
52 FORM_EXPORT(int)
53 pos_form_cursor(FORM *form)
54 {
55   int res;
56
57   T((T_CALLED("pos_form_cursor(%p)"), (void *)form));
58
59   if (!form)
60     res = E_BAD_ARGUMENT;
61   else
62     {
63       if (!(form->status & _POSTED))
64         res = E_NOT_POSTED;
65       else
66         res = _nc_Position_Form_Cursor(form);
67     }
68   RETURN(res);
69 }
70
71 /* frm_cursor.c ends here */