xref: /src/lib/libcurses/underscore.c

/*	$NetBSD: underscore.c,v 1.14 2024/12/23 02:58:04 blymn Exp $	*/

/*-
 * Copyright (c) 1999 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Julian Coleman.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/cdefs.h>
#ifndef lint
__RCSID("$NetBSD: underscore.c,v 1.14 2024/12/23 02:58:04 blymn Exp $");
#endif				/* not lint */

#include "curses.h"
#include "curses_private.h"

#ifndef _CURSES_USE_MACROS

/*
 * underscore --
 *	Enter underscore mode on stdscr.
 */
int
underscore(void)
{

	return wunderscore(stdscr);
}


/*
 * underend --
 *	Exit underscore mode on stdscr.
 */
int
underend(void)
{

	return wunderend(stdscr);
}

#endif

/*
 * wunderscore --
 *	Enter underscore mode.
 */
int
wunderscore(WINDOW *win)
{
	if (__predict_false(win == NULL))
		return ERR;

	/* If can underscore, set the screen underscore bit. */
	if ((enter_underline_mode != NULL && exit_underline_mode != NULL) ||
	    underline_char != NULL)
	{
		__CTRACE(__CTRACE_ATTR, "wunderscore\n");
		win->wattr |= __UNDERSCORE;
	}
	return 1;
}

/*
 * wunderend --
 *	Exit underscore mode.
 */
int
wunderend(WINDOW *win)
{

	if (__predict_false(win == NULL))
		return ERR;

	if (exit_underline_mode != NULL) {
		__CTRACE(__CTRACE_ATTR, "wunderend\n");
		win->wattr &= ~__UNDERSCORE;
	}
        return 1;
}