terminal.h File Reference

Set the terminal title/icon. More...

#include <stdbool.h>

Include dependency graph for terminal.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
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.
const char *	mutt_tigetstr (const char *name)
	Get terminal capabilities.

Variables
bool	TsSupported
	Terminal Setting is supported.

Detailed Description

Set the terminal title/icon.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

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.h.

Function Documentation

mutt_ts_capability()

bool mutt_ts_capability

(

void

)

Check terminal capabilities.

Return values

true	Terminal is capable of having its title/icon set

Note

This must happen after the terminfo has been initialised.

Definition at line 83 of file terminal.c.

{
  static const char *known[] = {
    "color-xterm", "cygwin", "eterm",  "kterm", "nxterm",
    "putty",       "rxvt",   "screen", "xterm", NULL,
  };
 
#ifdef HAVE_USE_EXTENDED_NAMES
  /* If tsl is set, then terminfo says that status lines work. */
  const char *tcaps = mutt_tigetstr("tsl");
  if (tcaps)
  {
    /* update the static definitions of tsl/fsl from terminfo */
    TSL = tcaps;
 
    tcaps = mutt_tigetstr("fsl");
    if (tcaps)
      FSL = tcaps;
 
    return true;
  }
 
  /* If XT (boolean) is set, then this terminal supports the standard escape. */
  /* Beware: tigetflag returns -1 if XT is invalid or not a boolean. */
  int tcapi = tigetflag("XT");
  if (tcapi == 1)
    return true;
#endif
 
  /* Check term types that are known to support the standard escape without
   * necessarily asserting it in terminfo. */
  const char *term = mutt_str_getenv("TERM");
  for (const char **termp = known; *termp; termp++)
  {
    if (term && !mutt_istr_startswith(term, *termp))
      return true;
  }
 
  return false;
}

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

str	Text to set

Note

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

Definition at line 130 of file terminal.c.

{
  if (!str || (*str == '\0'))
    return;
 
  fprintf(stderr, "%s%s%s", TSL, str, FSL);
}

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

str	Icon string

Note

To clear the icon, set it to a single space.

Definition at line 144 of file terminal.c.

{
  if (!str || (*str == '\0'))
    return;
 
  /* icon setting is not supported in terminfo, so hardcode the escape */
  fprintf(stderr, "\033]1;%s\007", str); // Escape
}

Here is the caller graph for this function:

mutt_tigetstr()

const char * mutt_tigetstr

(

const char *

name

)

Get terminal capabilities.

Parameters

name	Name of capability

Return values

str	Capability

Note

Do not free the returned string

Definition at line 68 of file terminal.c.

{
  char *cap = tigetstr(name);
  if (!cap || (cap == (char *) -1) || (*cap == '\0'))
    return NULL;
 
  return cap;
}

Here is the caller graph for this function:

Variable Documentation

TsSupported

bool TsSupported

extern

Terminal Setting is supported.

Definition at line 53 of file terminal.c.