NeoMutt  2021-02-05-666-ge300cd
Teaching an old dog new tricks
DOXYGEN
mutt_curses.h File Reference

Define wrapper functions around Curses/Slang. More...

#include "config.h"
#include "color.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 CI_is_return(ch)   (((ch) == '\r') || ((ch) == '\n'))
 

Enumerations

enum  MuttCursorState { MUTT_CURSOR_RESTORE_LAST = -1, 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_attr (int attr)
 Set the attributes for text. More...
 
void mutt_curses_set_color (enum ColorId color)
 Set the current colour for text. More...
 
void mutt_curses_set_cursor (enum MuttCursorState state)
 Set the cursor state. More...
 
void mutt_resize_screen (void)
 Update NeoMutt's opinion about the window size (CURSES) More...
 

Detailed Description

Define wrapper functions around Curses/Slang.

Authors
  • Michael R. Elkins
  • g10 Code GmbH

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 66 of file mutt_curses.h.

◆ CI_is_return

#define CI_is_return (   ch)    (((ch) == '\r') || ((ch) == '\n'))

Definition at line 71 of file mutt_curses.h.

Enumeration Type Documentation

◆ MuttCursorState

Cursor states for mutt_curses_set_cursor()

Enumerator
MUTT_CURSOR_RESTORE_LAST 

Restore the previous cursor state.

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 77 of file mutt_curses.h.

78 {
83 };
Display a very visible cursor.
Definition: mutt_curses.h:82
Display a normal cursor.
Definition: mutt_curses.h:81
Restore the previous cursor state.
Definition: mutt_curses.h:79
Hide the cursor.
Definition: mutt_curses.h:80

Function Documentation

◆ mutt_curses_set_attr()

void mutt_curses_set_attr ( int  attr)

Set the attributes for text.

Parameters
attrAttributes to set, e.g. A_UNDERLINE

Definition at line 39 of file mutt_curses.c.

40 {
41 #ifdef HAVE_BKGDSET
42  bkgdset(attr | ' ');
43 #else
44  attrset(attr);
45 #endif
46 }
+ Here is the caller graph for this function:

◆ mutt_curses_set_color()

void mutt_curses_set_color ( enum ColorId  color)

Set the current colour for text.

Parameters
colorColour to set, e.g. MT_COLOR_HEADER

If the system has bkgdset() use it rather than attrset() so that the clr*() functions will properly set the background attributes all the way to the right column.

Definition at line 56 of file mutt_curses.c.

57 {
58  const int chosen = mutt_color(color);
59  const int normal = mutt_color(MT_COLOR_NORMAL);
60 #ifdef HAVE_BKGDSET
61  bkgdset((chosen ? chosen : normal) | ' ');
62 #else
63  attrset(chosen ? chosen : normal);
64 #endif
65 }
enum ColorId color
Colour for the text, e.g. MT_COLOR_MESSAGE.
Definition: msgwin.c:97
Plain text.
Definition: color.h:58
int mutt_color(enum ColorId id)
Return the color of an object.
Definition: color.c:1427
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_curses_set_cursor()

void mutt_curses_set_cursor ( enum MuttCursorState  state)

Set the cursor state.

Parameters
stateState to set, e.g. MUTT_CURSOR_INVISIBLE

Definition at line 71 of file mutt_curses.c.

72 {
73 #if (defined(USE_SLANG_CURSES) || defined(HAVE_CURS_SET))
74  static int SavedCursor = MUTT_CURSOR_VISIBLE;
75 
76  if (state == MUTT_CURSOR_RESTORE_LAST)
77  state = SavedCursor;
78  else
79  SavedCursor = state;
80 
81  if (curs_set(state) == ERR)
82  {
83  if (state == MUTT_CURSOR_VISIBLE)
84  curs_set(MUTT_CURSOR_VERY_VISIBLE);
85  }
86 #endif
87 }
Display a very visible cursor.
Definition: mutt_curses.h:82
Display a normal cursor.
Definition: mutt_curses.h:81
Restore the previous cursor state.
Definition: mutt_curses.h:79
+ Here is the caller graph for this function:

◆ mutt_resize_screen()

void mutt_resize_screen ( void  )

Update NeoMutt's opinion about the window size (CURSES)

Definition at line 101 of file resize.c.

102 {
103  struct winsize w = mutt_get_winsize();
104 
105  int screenrows = w.ws_row;
106  int screencols = w.ws_col;
107 
108  if (screenrows <= 0)
109  {
110  const char *cp = mutt_str_getenv("LINES");
111  if (cp && (mutt_str_atoi(cp, &screenrows) < 0))
112  screenrows = 24;
113  }
114 
115  if (screencols <= 0)
116  {
117  const char *cp = mutt_str_getenv("COLUMNS");
118  if (cp && (mutt_str_atoi(cp, &screencols) < 0))
119  screencols = 80;
120  }
121 
122  resizeterm(screenrows, screencols);
123  rootwin_set_size(screencols, screenrows);
124  window_notify_all(NULL);
125 }
int mutt_str_atoi(const char *str, int *dst)
Convert ASCII string to an integer.
Definition: string.c:252
const char * mutt_str_getenv(const char *name)
Get an environment variable.
Definition: string.c:1024
static struct winsize mutt_get_winsize(void)
Use an ioctl to get the window size.
Definition: resize.c:51
void window_notify_all(struct MuttWindow *win)
Notify observers of changes to a Window and its children.
Definition: mutt_window.c:143
void rootwin_set_size(int cols, int rows)
Set the dimensions of the Root Window.
Definition: rootwin.c:222
+ Here is the call graph for this function:
+ Here is the caller graph for this function: