mutt_curses.h File Reference

Define wrapper functions around Curses. More...

#include "config.h"
#include "color/lib.h"
#include <curses.h>

Include dependency graph for mutt_curses.h:

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

Go to the source code of this file.

Macros
#define	ctrl(ch)   ((ch) - '@')
#define	key_is_return(ch)   (((ch) == '\r') || ((ch) == '\n'))

Enumerations
enum	MuttCursorState { MUTT_CURSOR_INVISIBLE = 0 , MUTT_CURSOR_VISIBLE = 1 , MUTT_CURSOR_VERY_VISIBLE = 2 }
	Cursor states for mutt_curses_set_cursor() More...

Functions
void	mutt_curses_set_color (const struct AttrColor *ac)
	Set the colour and attributes for text.
const struct AttrColor *	mutt_curses_set_color_by_id (enum ColorId cid)
	Set the colour and attributes by the colour id.
enum MuttCursorState	mutt_curses_set_cursor (enum MuttCursorState state)
	Set the cursor state.
const struct AttrColor *	mutt_curses_set_normal_backed_color_by_id (enum ColorId cid)
	Set the colour and attributes by the colour id.
void	mutt_resize_screen (void)
	Update NeoMutt's opinion about the window size.

Detailed Description

Define wrapper functions around Curses.

Authors

• Michael R. Elkins
• g10 Code GmbH

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

Macro Definition Documentation

ctrl

#define ctrl

(

ch

)

((ch) - '@')

Definition at line 46 of file mutt_curses.h.

key_is_return

#define key_is_return

(

ch

)

(((ch) == '\r') || ((ch) == '\n'))

Definition at line 51 of file mutt_curses.h.

Enumeration Type Documentation

MuttCursorState

enum MuttCursorState

Cursor states for mutt_curses_set_cursor()

Enumerator
MUTT_CURSOR_INVISIBLE	Hide the cursor.
MUTT_CURSOR_VISIBLE	Display a normal cursor.
MUTT_CURSOR_VERY_VISIBLE	Display a very visible cursor.

Definition at line 57 of file mutt_curses.h.

{
  MUTT_CURSOR_INVISIBLE    =  0, 
  MUTT_CURSOR_VISIBLE      =  1, 
  MUTT_CURSOR_VERY_VISIBLE =  2, 
};

Function Documentation

mutt_curses_set_color()

void mutt_curses_set_color

(

const struct AttrColor *

ac

)

Set the colour and attributes for text.

Parameters

ac	Colour and Attributes to set

Definition at line 40 of file mutt_curses.c.

{
  if (!ac)
    return;
 
  int index = ac->curses_color ? ac->curses_color->index : 0;
 
#if defined(HAVE_SETCCHAR) && defined(HAVE_BKGRNDSET)
  cchar_t cch = { 0 };
  setcchar(&cch, L" ", ac->attrs, index, NULL);
  bkgrndset(&cch);
#elif defined(HAVE_BKGDSET)
  bkgdset(COLOR_PAIR(index) | ac->attrs | ' ');
#else
  attrset(COLOR_PAIR(index) | ac->attrs);
#endif
}

Here is the caller graph for this function:

mutt_curses_set_color_by_id()

const struct AttrColor * mutt_curses_set_color_by_id

(

enum ColorId

cid

)

Set the colour and attributes by the colour id.

Parameters

cid	Colour Id, e.g. MT_COLOR_TREE

Return values

ptr	Colour set

Definition at line 81 of file mutt_curses.c.

{
  struct AttrColor *ac = simple_color_get(cid);
  if (!attr_color_is_set(ac))
    ac = simple_color_get(MT_COLOR_NORMAL);
 
  mutt_curses_set_color(ac);
  return ac;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_curses_set_cursor()

enum MuttCursorState mutt_curses_set_cursor

(

enum MuttCursorState

state

)

Set the cursor state.

Parameters

state

State to set, e.g. MUTT_CURSOR_INVISIBLE

Return values

enum	Old state, e.g. MUTT_CURSOR_VISIBLE

Definition at line 96 of file mutt_curses.c.

{
  static enum MuttCursorState SavedCursor = MUTT_CURSOR_VISIBLE;
 
  enum MuttCursorState OldCursor = SavedCursor;
  SavedCursor = state;
 
  if (curs_set(state) == ERR)
  {
    if (state == MUTT_CURSOR_VISIBLE)
      curs_set(MUTT_CURSOR_VERY_VISIBLE);
  }
 
  return OldCursor;
}

Here is the caller graph for this function:

mutt_curses_set_normal_backed_color_by_id()

const struct AttrColor * mutt_curses_set_normal_backed_color_by_id

(

enum ColorId

cid

)

Set the colour and attributes by the colour id.

Parameters

cid	Colour Id, e.g. MT_COLOR_WARNING

Return values

ptr	Colour set

Note

Colour will be merged over MT_COLOR_NORMAL

Definition at line 65 of file mutt_curses.c.

{
  const struct AttrColor *ac_normal = simple_color_get(MT_COLOR_NORMAL);
  const struct AttrColor *ac_color = simple_color_get(cid);
 
  const struct AttrColor *ac_merge = merged_color_overlay(ac_normal, ac_color);
 
  mutt_curses_set_color(ac_merge);
  return ac_merge;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_resize_screen()

void mutt_resize_screen

(

void

)

Update NeoMutt's opinion about the window size.

Definition at line 74 of file resize.c.

{
  struct winsize w = mutt_get_winsize();
 
  int screenrows = w.ws_row;
  int screencols = w.ws_col;
 
  if (screenrows <= 0)
  {
    const char *cp = mutt_str_getenv("LINES");
    if (cp && !mutt_str_atoi_full(cp, &screenrows))
      screenrows = 24;
  }
 
  if (screencols <= 0)
  {
    const char *cp = mutt_str_getenv("COLUMNS");
    if (cp && !mutt_str_atoi_full(cp, &screencols))
      screencols = 80;
  }
 
  resizeterm(screenrows, screencols);
  rootwin_set_size(screencols, screenrows);
  window_notify_all(NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function: