mutt_window.c File Reference

Window management. More...

#include "config.h"
#include <stdarg.h>
#include <string.h>
#include "mutt/mutt.h"
#include "mutt_window.h"
#include "globals.h"
#include "menu.h"
#include "options.h"

Include dependency graph for mutt_window.c:

Go to the source code of this file.

Functions
void	mutt_window_clearline (struct MuttWindow *win, int row)
	Clear a row of a Window. More...
void	mutt_window_clrtoeol (struct MuttWindow *win)
	Clear to the end of the line. More...
void	mutt_window_free (void)
	Free the default Windows. More...
void	mutt_window_getxy (struct MuttWindow *win, int *x, int *y)
	Get the cursor position in the Window. More...
void	mutt_window_init (void)
	Create the default Windows. More...
int	mutt_window_move (struct MuttWindow *win, int row, int col)
	Move the cursor in a Window. More...
int	mutt_window_mvaddch (struct MuttWindow *win, int row, int col, const chtype ch)
	Move the cursor and write a character to a Window. More...
int	mutt_window_mvaddstr (struct MuttWindow *win, int row, int col, const char *str)
	Move the cursor and write a fixed string to a Window. More...
int	mutt_window_mvprintw (struct MuttWindow *win, int row, int col, const char *fmt,...)
	Move the cursor and write a formatted string to a Window. More...
void	mutt_window_reflow (void)
	Resize the Windows to fit the screen. More...
void	mutt_window_reflow_message_rows (int mw_rows)
	Resize the Message Window. More...
int	mutt_window_wrap_cols (struct MuttWindow *win, short wrap)
	Calculate the wrap column for a Window. More...

Variables
struct MuttWindow *	MuttHelpWindow = NULL
	Help Window. More...
struct MuttWindow *	MuttIndexWindow = NULL
	Index Window. More...
struct MuttWindow *	MuttStatusWindow = NULL
	Status Window. More...
struct MuttWindow *	MuttMessageWindow = NULL
	Message Window. More...
struct MuttWindow *	MuttSidebarWindow = NULL
	Sidebar Window. More...

Detailed Description

Window management.

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 mutt_window.c.

Function Documentation

void mutt_window_clearline	(	struct MuttWindow *	win,
		int	row
	)

Clear a row of a Window.

Parameters

win	Window
row	Row to clear

Definition at line 69 of file mutt_window.c.

{
  mutt_window_move(win, row, 0);
  mutt_window_clrtoeol(win);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void mutt_window_clrtoeol

(

struct MuttWindow *

win

)

Clear to the end of the line.

Parameters

win

Window

Note

Assumes the cursor has already been positioned within the window.

Definition at line 81 of file mutt_window.c.

{
  if (!win || !stdscr)
    return;

  if (win->col_offset + win->cols == COLS)
    clrtoeol();
  else
  {
    int row = 0;
    int col = 0;
    getyx(stdscr, row, col);
    int curcol = col;
    while (curcol < (win->col_offset + win->cols))
    {
      addch(' ');
      curcol++;
    }
    move(row, col);
  }
}

Here is the caller graph for this function:

void mutt_window_free

(

void

)

Free the default Windows.

Definition at line 106 of file mutt_window.c.

{
  FREE(&MuttHelpWindow);
  FREE(&MuttIndexWindow);
  FREE(&MuttStatusWindow);
  FREE(&MuttMessageWindow);
#ifdef USE_SIDEBAR
  FREE(&MuttSidebarWindow);
#endif
}

Here is the caller graph for this function:

void mutt_window_getxy	(	struct MuttWindow *	win,
		int *	x,
		int *	y
	)

Get the cursor position in the Window.

Parameters

[in]	win	Window
[out]	x	X-Coordinate
[out]	y	Y-Coordinate

Assumes the current position is inside the window. Otherwise it will happily return negative or values outside the window boundaries

Definition at line 126 of file mutt_window.c.

{
  int row = 0;
  int col = 0;

  getyx(stdscr, row, col);
  if (x)
    *x = col - win->col_offset;
  if (y)
    *y = row - win->row_offset;
}

Here is the caller graph for this function:

void mutt_window_init

(

void

)

Create the default Windows.

Create the Help, Index, Status, Message and Sidebar Windows.

Definition at line 143 of file mutt_window.c.

{
  MuttHelpWindow = mutt_mem_calloc(1, sizeof(struct MuttWindow));
  MuttIndexWindow = mutt_mem_calloc(1, sizeof(struct MuttWindow));
  MuttStatusWindow = mutt_mem_calloc(1, sizeof(struct MuttWindow));
  MuttMessageWindow = mutt_mem_calloc(1, sizeof(struct MuttWindow));
#ifdef USE_SIDEBAR
  MuttSidebarWindow = mutt_mem_calloc(1, sizeof(struct MuttWindow));
#endif
}

Here is the call graph for this function:

Here is the caller graph for this function:

int mutt_window_move	(	struct MuttWindow *	win,
		int	row,
		int	col
	)

Move the cursor in a Window.

Parameters

win	Window
row	Row to move to
col	Column to move to

Return values

OK	Success
ERR	Error

Definition at line 162 of file mutt_window.c.

{
  return move(win->row_offset + row, win->col_offset + col);
}

Here is the caller graph for this function:

int mutt_window_mvaddch	(	struct MuttWindow *	win,
		int	row,
		int	col,
		const chtype	ch
	)

Move the cursor and write a character to a Window.

Parameters

win	Window to write to
row	Row to move to
col	Column to move to
ch	Character to write

Return values

OK	Success
ERR	Error

Definition at line 176 of file mutt_window.c.

{
  return mvaddch(win->row_offset + row, win->col_offset + col, ch);
}

int mutt_window_mvaddstr	(	struct MuttWindow *	win,
		int	row,
		int	col,
		const char *	str
	)

Move the cursor and write a fixed string to a Window.

Parameters

win	Window to write to
row	Row to move to
col	Column to move to
str	String to write

Return values

OK	Success
ERR	Error

Definition at line 190 of file mutt_window.c.

{
  return mvaddstr(win->row_offset + row, win->col_offset + col, str);
}

Here is the caller graph for this function:

int mutt_window_mvprintw	(	struct MuttWindow *	win,
		int	row,
		int	col,
		const char *	fmt,
			...
	)

Move the cursor and write a formatted string to a Window.

Parameters

win	Window to write to
row	Row to move to
col	Column to move to
fmt	printf format string
...	printf arguments

Return values

num	Success, characters written
ERR	Error, move failed

Definition at line 205 of file mutt_window.c.

{
  int rc = mutt_window_move(win, row, col);
  if (rc == ERR)
    return rc;

  va_list ap;
  va_start(ap, fmt);
  rc = vw_printw(stdscr, fmt, ap);
  va_end(ap);

  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void mutt_window_reflow

(

void

)

Resize the Windows to fit the screen.

Definition at line 222 of file mutt_window.c.

{
  if (OptNoCurses)
    return;

  mutt_debug(2, "entering\n");

  MuttStatusWindow->rows = 1;
  MuttStatusWindow->cols = COLS;
  MuttStatusWindow->row_offset = StatusOnTop ? 0 : LINES - 2;
  MuttStatusWindow->col_offset = 0;

  memcpy(MuttHelpWindow, MuttStatusWindow, sizeof(struct MuttWindow));
  if (!Help)
    MuttHelpWindow->rows = 0;
  else
    MuttHelpWindow->row_offset = StatusOnTop ? LINES - 2 : 0;

  memcpy(MuttMessageWindow, MuttStatusWindow, sizeof(struct MuttWindow));
  MuttMessageWindow->row_offset = LINES - 1;

  memcpy(MuttIndexWindow, MuttStatusWindow, sizeof(struct MuttWindow));
  MuttIndexWindow->rows = MAX(
      LINES - MuttStatusWindow->rows - MuttHelpWindow->rows - MuttMessageWindow->rows, 0);
  MuttIndexWindow->row_offset =
      StatusOnTop ? MuttStatusWindow->rows : MuttHelpWindow->rows;

#ifdef USE_SIDEBAR
  if (SidebarVisible)
  {
    memcpy(MuttSidebarWindow, MuttIndexWindow, sizeof(struct MuttWindow));
    MuttSidebarWindow->cols = SidebarWidth;
    MuttIndexWindow->cols -= SidebarWidth;

    if (SidebarOnRight)
    {
      MuttSidebarWindow->col_offset = COLS - SidebarWidth;
    }
    else
    {
      MuttIndexWindow->col_offset += SidebarWidth;
    }
  }
#endif

  mutt_menu_set_current_redraw_full();
  /* the pager menu needs this flag set to recalc line_info */
  mutt_menu_set_current_redraw(REDRAW_FLOW);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void mutt_window_reflow_message_rows

(

int

mw_rows

)

Resize the Message Window.

Parameters

mw_rows

Number of rows required

Resize the other Windows to allow a multi-line message to be displayed.

Definition at line 278 of file mutt_window.c.

{
  MuttMessageWindow->rows = mw_rows;
  MuttMessageWindow->row_offset = LINES - mw_rows;

  MuttStatusWindow->row_offset = StatusOnTop ? 0 : LINES - mw_rows - 1;

  if (Help)
    MuttHelpWindow->row_offset = StatusOnTop ? LINES - mw_rows - 1 : 0;

  MuttIndexWindow->rows = MAX(
      LINES - MuttStatusWindow->rows - MuttHelpWindow->rows - MuttMessageWindow->rows, 0);

#ifdef USE_SIDEBAR
  if (SidebarVisible)
    MuttSidebarWindow->rows = MuttIndexWindow->rows;
#endif

  /* We don't also set REDRAW_FLOW because this function only
   * changes rows and is a temporary adjustment. */
  mutt_menu_set_current_redraw_full();
}

Here is the call graph for this function:

Here is the caller graph for this function:

int mutt_window_wrap_cols	(	struct MuttWindow *	win,
		short	wrap
	)

Calculate the wrap column for a Window.

Parameters

win	Window
wrap	Wrap config

Return values

num	Column that text should be wrapped at

The wrap variable can be negative, meaning there should be a right margin.

Definition at line 309 of file mutt_window.c.

{
  if (wrap < 0)
    return (win->cols > -wrap) ? (win->cols + wrap) : win->cols;
  else if (wrap)
    return (wrap < win->cols) ? wrap : win->cols;
  else
    return win->cols;
}

Here is the caller graph for this function:

Variable Documentation

struct MuttWindow* MuttHelpWindow = NULL

Help Window.

Definition at line 38 of file mutt_window.c.

struct MuttWindow* MuttIndexWindow = NULL

Index Window.

Definition at line 39 of file mutt_window.c.

struct MuttWindow* MuttStatusWindow = NULL

Status Window.

Definition at line 40 of file mutt_window.c.

struct MuttWindow* MuttMessageWindow = NULL

Message Window.

Definition at line 41 of file mutt_window.c.

struct MuttWindow* MuttSidebarWindow = NULL

Sidebar Window.

Definition at line 43 of file mutt_window.c.