xref: /netbsd-src/lib/libcurses/underscore.c (revision 6348e3f32a4431b45d07e1da16fd7b12725a45e7)
1 /*	$NetBSD: underscore.c,v 1.14 2024/12/23 02:58:04 blymn Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Julian Coleman.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 #ifndef lint
34 __RCSID("$NetBSD: underscore.c,v 1.14 2024/12/23 02:58:04 blymn Exp $");
35 #endif				/* not lint */
36 
37 #include "curses.h"
38 #include "curses_private.h"
39 
40 #ifndef _CURSES_USE_MACROS
41 
42 /*
43  * underscore --
44  *	Enter underscore mode on stdscr.
45  */
46 int
47 underscore(void)
48 {
49 
50 	return wunderscore(stdscr);
51 }
52 
53 
54 /*
55  * underend --
56  *	Exit underscore mode on stdscr.
57  */
58 int
59 underend(void)
60 {
61 
62 	return wunderend(stdscr);
63 }
64 
65 #endif
66 
67 /*
68  * wunderscore --
69  *	Enter underscore mode.
70  */
71 int
72 wunderscore(WINDOW *win)
73 {
74 	if (__predict_false(win == NULL))
75 		return ERR;
76 
77 	/* If can underscore, set the screen underscore bit. */
78 	if ((enter_underline_mode != NULL && exit_underline_mode != NULL) ||
79 	    underline_char != NULL)
80 	{
81 		__CTRACE(__CTRACE_ATTR, "wunderscore\n");
82 		win->wattr |= __UNDERSCORE;
83 	}
84 	return 1;
85 }
86 
87 /*
88  * wunderend --
89  *	Exit underscore mode.
90  */
91 int
92 wunderend(WINDOW *win)
93 {
94 
95 	if (__predict_false(win == NULL))
96 		return ERR;
97 
98 	if (exit_underline_mode != NULL) {
99 		__CTRACE(__CTRACE_ATTR, "wunderend\n");
100 		win->wattr &= ~__UNDERSCORE;
101 	}
102         return 1;
103 }
104