lib.h

Go to the documentation of this file.

 
#ifndef MUTT_PAGER_LIB_H
#define MUTT_PAGER_LIB_H
 
#include "config.h"
#include <stdbool.h>
#include <stdint.h>
#include <stdio.h>
#include "mutt/lib.h"
 
struct Email;
struct IndexSharedData;
struct ConfigSubset;
struct MailboxView;
struct MuttWindow;
struct PagerPrivateData;
 
typedef uint16_t PagerFlags;              
#define MUTT_PAGER_NO_FLAGS         0     
#define MUTT_SHOWFLAT         (1 << 0)    
#define MUTT_SHOWCOLOR        (1 << 1)    
#define MUTT_HIDE             (1 << 2)    
#define MUTT_SEARCH           (1 << 3)    
#define MUTT_TYPES            (1 << 4)    
#define MUTT_SHOW             (MUTT_SHOWCOLOR | MUTT_SHOWFLAT)
 
/* exported flags for mutt_(do_)?pager */
#define MUTT_PAGER_NSKIP      (1 << 5)    
#define MUTT_PAGER_MARKER     (1 << 6)    
#define MUTT_PAGER_RETWINCH   (1 << 7)    
#define MUTT_PAGER_ATTACHMENT (1 << 8)    
#define MUTT_PAGER_NOWRAP     (1 << 9)    
#define MUTT_PAGER_LOGS       (1 << 10)   
#define MUTT_PAGER_BOTTOM     (1 << 11)   
#define MUTT_PAGER_STRIPES    (1 << 12)   
#define MUTT_PAGER_MESSAGE    (MUTT_SHOWCOLOR | MUTT_PAGER_MARKER)
 
#define MUTT_DISPLAYFLAGS (MUTT_SHOW | MUTT_PAGER_NSKIP | MUTT_PAGER_MARKER | MUTT_PAGER_LOGS)
 
// Pager mode.
// There are 10 code paths that lead to dlg_pager() invocation:
//
// 1. dlg_index -> mutt_display_message -> dlg_pager
//
//    This path always results in mailbox and email set,
//    the rest is unset - Body, fp.
//    This invocation can be identified by IsEmail macro.
//    The intent is to display an email message
//
// 2. mutt_view_attachment -> mutt_do_pager -> dlg_pager
//
//    this path always results in email, body, mailbox_view set
//    this invocation can be identified by one of the two macros
//    - IsAttach (viewing a regular attachment)
//    - IsMsgAttach (viewing nested email)
//
//    IsMsgAttach has extra->body->email set
//    extra->email != extra->body->email
//    the former is the message that contains the latter message as attachment
//
//    NB. extra->email->body->email seems to be always NULL
//
// 3. The following 8 invocations are similar, because they all call
//    mutt_do_page with info = NULL
//
//    And so it results in mailbox, body, fp set to NULL.
//    The intent is to show user some text that is not
//    directly related to viewing emails,
//    e.g. help, log messages,gpg key selection etc.
//
//    No macro identifies these invocations
//
//    dlg_index             -> mutt_do_pager -> dlg_pager
//    mutt_help             -> mutt_do_pager -> dlg_pager
//    icmd_bind             -> mutt_do_pager -> dlg_pager
//    icmd_set              -> mutt_do_pager -> dlg_pager
//    icmd_version          -> mutt_do_pager -> dlg_pager
//    dlg_pgp               -> mutt_do_pager -> dlg_pager
//    verify_key            -> mutt_do_pager -> dlg_pager
//    mutt_invoke_sendmail  -> mutt_do_pager -> dlg_pager
//
//
// - IsAttach(pager) (pager && (pager)->body)
// - IsMsgAttach(pager)
//   (pager && (pager)->fp && (pager)->body && (pager)->body->email)
// - IsEmail(pager) (pager && (pager)->email && !(pager)->body)
// See nice infographic here:
// https://gist.github.com/flatcap/044ecbd2498c65ea9a85099ef317509a
 
enum PagerMode
{
  PAGER_MODE_UNKNOWN = 0, 
 
  PAGER_MODE_EMAIL,       
  PAGER_MODE_ATTACH,      
  PAGER_MODE_ATTACH_E,    
  PAGER_MODE_HELP,        
  PAGER_MODE_OTHER,       
 
  PAGER_MODE_MAX,         
};
 
enum PagerLoopMode
{
  PAGER_LOOP_CONTINUE = -7,  
  PAGER_LOOP_QUIT     = -6,  
  PAGER_LOOP_RELOAD   = -5,  
};
 
struct PagerData
{
  struct Body      *body;   
  FILE             *fp;     
  struct AttachCtx *actx;   
  const char       *fname;  
};
 
struct PagerView
{
  struct PagerData *pdata; 
  enum PagerMode mode;     
  PagerFlags flags;        
  const char *banner;      
 
  struct MuttWindow *win_index; 
  struct MuttWindow *win_pbar;  
  struct MuttWindow *win_pager; 
};
 
// Observers of #NT_PAGER will be passed a #PagerPrivateData.
typedef uint8_t NotifyPager;         
#define NT_PAGER_NO_FLAGS        0   
#define NT_PAGER_DELETE    (1 << 0)  
#define NT_PAGER_VIEW      (1 << 1)  
 
typedef uint8_t PagerRedrawFlags;       
#define PAGER_REDRAW_NO_FLAGS        0  
#define PAGER_REDRAW_PAGER     (1 << 1) 
#define PAGER_REDRAW_FLOW      (1 << 2) 
 
extern int BrailleRow;
extern int BrailleCol;
 
int dlg_pager(struct PagerView *pview);
int mutt_do_pager(struct PagerView *pview, struct Email *e);
void buf_strip_formatting(struct Buffer *dest, const char *src, bool strip_markers);
struct MuttWindow *ppanel_new(bool status_on_top, struct IndexSharedData *shared);
struct MuttWindow *pager_window_new(struct IndexSharedData *shared, struct PagerPrivateData *priv);
int mutt_display_message(struct MuttWindow *win_index, struct IndexSharedData *shared);
int external_pager(struct MailboxView *mv, struct Email *e, const char *command);
void pager_queue_redraw(struct PagerPrivateData *priv, PagerRedrawFlags redraw);
bool mutt_is_quote_line(char *buf, regmatch_t *pmatch);
const char *pager_get_pager(struct ConfigSubset *sub);
 
void mutt_clear_pager_position(void);
 
struct TextSyntax;
struct Line;
void dump_text_syntax(struct TextSyntax *ts, int num);
void dump_line(int i, struct Line *line);
 
#ifdef USE_DEBUG_COLOR
void dump_pager(struct PagerPrivateData *priv);
#else
static inline void dump_pager(struct PagerPrivateData *priv) {}
#endif
 
#endif /* MUTT_PAGER_LIB_H */