NeoMutt  2024-04-25-97-g7d2481
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
terminal.c File Reference

Set the terminal title/icon. More...

#include "config.h"
#include <stdbool.h>
#include <stdio.h>
#include "mutt/lib.h"
#include "terminal.h"
#include "mutt_curses.h"
+ Include dependency graph for terminal.c:

Go to the source code of this file.

Functions

const char * mutt_tigetstr (const char *name)
 Get terminal capabilities.
 
bool mutt_ts_capability (void)
 Check terminal capabilities.
 
void mutt_ts_status (char *str)
 Set the text of the terminal title bar.
 
void mutt_ts_icon (char *str)
 Set the icon in the terminal title bar.
 

Variables

bool TsSupported
 Terminal Setting is supported.
 
static const char * TSL = "\033]0;"
 TSL: to_status_line - Sent before the terminal title.
 
static const char * FSL = "\007"
 FSL: from_status_line - Sent after the terminal title.
 

Detailed Description

Set the terminal title/icon.

Authors
  • Richard Russon
  • Pietro Cerutti

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file terminal.c.

Function Documentation

◆ mutt_tigetstr()

const char * mutt_tigetstr ( const char *  name)

Get terminal capabilities.

Parameters
nameName of capability
Return values
strCapability
Note
Do not free the returned string

Definition at line 57 of file terminal.c.

58{
59 char *cap = tigetstr(name);
60 if (!cap || (cap == (char *) -1) || (*cap == '\0'))
61 return NULL;
62
63 return cap;
64}
+ Here is the caller graph for this function:

◆ mutt_ts_capability()

bool mutt_ts_capability ( void  )

Check terminal capabilities.

Return values
trueTerminal is capable of having its title/icon set
Note
This must happen after the terminfo has been initialised.

Definition at line 72 of file terminal.c.

73{
74 static const char *known[] = {
75 "color-xterm", "cygwin", "eterm", "kterm", "nxterm",
76 "putty", "rxvt", "screen", "xterm", NULL,
77 };
78
79#ifdef HAVE_USE_EXTENDED_NAMES
80 /* If tsl is set, then terminfo says that status lines work. */
81 const char *tcaps = mutt_tigetstr("tsl");
82 if (tcaps)
83 {
84 /* update the static definitions of tsl/fsl from terminfo */
85 TSL = tcaps;
86
87 tcaps = mutt_tigetstr("fsl");
88 if (tcaps)
89 FSL = tcaps;
90
91 return true;
92 }
93
94 /* If XT (boolean) is set, then this terminal supports the standard escape. */
95 /* Beware: tigetflag returns -1 if XT is invalid or not a boolean. */
96 int tcapi = tigetflag("XT");
97 if (tcapi == 1)
98 return true;
99#endif
100
101 /* Check term types that are known to support the standard escape without
102 * necessarily asserting it in terminfo. */
103 const char *term = mutt_str_getenv("TERM");
104 for (const char **termp = known; *termp; termp++)
105 {
106 if (term && !mutt_istr_startswith(term, *termp))
107 return true;
108 }
109
110 return false;
111}
const char * mutt_str_getenv(const char *name)
Get an environment variable.
Definition: string.c:726
size_t mutt_istr_startswith(const char *str, const char *prefix)
Check whether a string starts with a prefix, ignoring case.
Definition: string.c:242
static const char * FSL
FSL: from_status_line - Sent after the terminal title.
Definition: terminal.c:48
static const char * TSL
TSL: to_status_line - Sent before the terminal title.
Definition: terminal.c:46
const char * mutt_tigetstr(const char *name)
Get terminal capabilities.
Definition: terminal.c:57
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_ts_status()

void mutt_ts_status ( char *  str)

Set the text of the terminal title bar.

Parameters
strText to set
Note
To clear the text, set the title to a single space.

Definition at line 119 of file terminal.c.

120{
121 if (!str || (*str == '\0'))
122 return;
123
124 fprintf(stderr, "%s%s%s", TSL, str, FSL);
125}
+ Here is the caller graph for this function:

◆ mutt_ts_icon()

void mutt_ts_icon ( char *  str)

Set the icon in the terminal title bar.

Parameters
strIcon string
Note
To clear the icon, set it to a single space.

Definition at line 133 of file terminal.c.

134{
135 if (!str || (*str == '\0'))
136 return;
137
138 /* icon setting is not supported in terminfo, so hardcode the escape */
139 fprintf(stderr, "\033]1;%s\007", str); // Escape
140}
+ Here is the caller graph for this function:

Variable Documentation

◆ TsSupported

bool TsSupported

Terminal Setting is supported.

Definition at line 42 of file terminal.c.

◆ TSL

const char* TSL = "\033]0;"
static

TSL: to_status_line - Sent before the terminal title.

Definition at line 46 of file terminal.c.

◆ FSL

const char* FSL = "\007"
static

FSL: from_status_line - Sent after the terminal title.

Definition at line 48 of file terminal.c.