ncurses 6.2 - patch 20200212
[ncurses.git] / form / fld_pad.c
1 /****************************************************************************
2  * Copyright 2020 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: fld_pad.c,v 1.11 2020/02/02 23:34:34 tom Exp $")
37
38 /*---------------------------------------------------------------------------
39 |   Facility      :  libnform  
40 |   Function      :  int set_field_pad(FIELD *field, int ch)
41 |   
42 |   Description   :  Set the pad character used to fill the field. This must
43 |                    be a printable character.
44 |
45 |   Return Values :  E_OK           - success
46 |                    E_BAD_ARGUMENT - invalid field pointer or pad character
47 |                    E_SYSTEM_ERROR - system error
48 +--------------------------------------------------------------------------*/
49 NCURSES_EXPORT(int)
50 set_field_pad(FIELD *field, int ch)
51 {
52   int res = E_BAD_ARGUMENT;
53
54   T((T_CALLED("set_field_pad(%p,%d)"), (void *)field, ch));
55
56   Normalize_Field(field);
57   if (isprint(UChar(ch)))
58     {
59       if (field->pad != ch)
60         {
61           field->pad = ch;
62           res = _nc_Synchronize_Attributes(field);
63         }
64       else
65         res = E_OK;
66     }
67   RETURN(res);
68 }
69
70 /*---------------------------------------------------------------------------
71 |   Facility      :  libnform  
72 |   Function      :  int field_pad(const FIELD *field)
73 |   
74 |   Description   :  Retrieve the fields pad character.
75 |
76 |   Return Values :  The pad character.
77 +--------------------------------------------------------------------------*/
78 NCURSES_EXPORT(int)
79 field_pad(const FIELD *field)
80 {
81   T((T_CALLED("field_pad(%p)"), (const void *)field));
82
83   returnCode(Normalize_Field(field)->pad);
84 }
85
86 /* fld_pad.c ends here */