NeoMutt  2025-12-11-694-ga89709
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h
Go to the documentation of this file.
1
22
39
40#ifndef MUTT_BROWSER_LIB_H
41#define MUTT_BROWSER_LIB_H
42
43#include <stdbool.h>
44#include <stdint.h>
45#include <sys/types.h>
46#include "mutt/lib.h"
47
48struct Mailbox;
49struct Menu;
50struct MuttWindow;
51struct stat;
52struct SubMenu;
53
54extern struct Buffer LastDir;
55extern struct Buffer LastDirBackup;
56
57typedef uint8_t SelectFileFlags;
58#define MUTT_SEL_NO_FLAGS 0
59#define MUTT_SEL_MAILBOX (1 << 0)
60#define MUTT_SEL_MULTI (1 << 1)
61#define MUTT_SEL_FOLDER (1 << 2)
62
63extern const struct CompleteOps CompleteFileOps;
64extern const struct CompleteOps CompleteMailboxOps;
65
69struct Folder
70{
71 struct FolderFile *ff;
72 int num;
73};
74
79{
80 mode_t mode;
81 off_t size;
82 time_t mtime;
83 uid_t uid;
84 gid_t gid;
85 nlink_t nlink;
86
87 char *name;
88 char *desc;
89
93
94 char delim;
95
96 bool imap : 1;
97 bool selectable : 1;
98 bool inferiors : 1;
99 bool has_mailbox : 1;
100 bool local : 1;
101 bool notify_user : 1;
102 bool poll_new_mail : 1;
103 bool tagged : 1;
104 struct NntpMboxData *nd;
105
106 int gen;
107};
108
109ARRAY_HEAD(BrowserEntryArray, struct FolderFile);
110
140
145{
146 struct BrowserEntryArray entry;
148 char *folder;
150};
151
152
153void browser_init_keys(struct SubMenu *sm_generic);
154
155void dlg_browser(struct Buffer *file, SelectFileFlags flags, struct Mailbox *m, char ***files, int *numfiles);
156void mutt_browser_select_dir(const char *f);
157void mutt_browser_cleanup(void);
158
159void browser_sort(struct BrowserState *state);
160void browser_add_folder(const struct Menu *menu, struct BrowserState *state, const char *name, const char *desc, const struct stat *st, struct Mailbox *m, void *data);
161void browser_highlight_default(struct BrowserState *state, struct Menu *menu);
162int examine_directory(struct Mailbox *m, struct Menu *menu, struct BrowserState *state, const char *d, const char *prefix);
163int examine_mailboxes(struct Mailbox *m, struct Menu *menu, struct BrowserState *state);
164void init_menu(struct BrowserState *state, struct Menu *menu, struct Mailbox *m, struct MuttWindow *sbar);
165void init_state(struct BrowserState *state);
166bool link_is_dir(const char *folder, const char *path);
167void destroy_state(struct BrowserState *state);
168void dump_state(struct BrowserState *state);
169
170#endif /* MUTT_BROWSER_LIB_H */
#define ARRAY_HEAD(name, T)
Define a named struct for arrays of elements of a certain type.
Definition array.h:47
const struct CompleteOps CompleteFileOps
Auto-Completion of Files.
Definition complete.c:152
const struct CompleteOps CompleteMailboxOps
Auto-Completion of Files / Mailboxes.
Definition complete.c:159
void init_menu(struct BrowserState *state, struct Menu *menu, struct Mailbox *m, struct MuttWindow *sbar)
Set up a new menu.
void browser_sort(struct BrowserState *state)
Sort the entries in the browser.
Definition sort.c:186
ExpandoDataFolder
Expando UIDs for the File Browser.
Definition lib.h:117
@ ED_FOL_POLL
FolderFile.poll_new_mail.
Definition lib.h:136
@ ED_FOL_NOTIFY
FolderFile.notify_user.
Definition lib.h:134
@ ED_FOL_NEW_COUNT
FolderFile.nd (NntpMboxData)
Definition lib.h:132
@ ED_FOL_FILE_OWNER
FolderFile.uid.
Definition lib.h:125
@ ED_FOL_FILE_GROUP
FolderFile.gid.
Definition lib.h:123
@ ED_FOL_FILENAME
FolderFile.name.
Definition lib.h:122
@ ED_FOL_DATE_FORMAT
FolderFile.mtime.
Definition lib.h:119
@ ED_FOL_DATE_STRF
FolderFile.mtime.
Definition lib.h:120
@ ED_FOL_UNREAD_COUNT
FolderFile.msg_unread.
Definition lib.h:138
@ ED_FOL_FLAGS2
FolderFile.nd (NntpMboxData)
Definition lib.h:128
@ ED_FOL_FILE_MODE
FolderFile.move.
Definition lib.h:124
@ ED_FOL_NEW_MAIL
FolderFile.has_new_mail.
Definition lib.h:133
@ ED_FOL_FILE_SIZE
FolderFile.size.
Definition lib.h:126
@ ED_FOL_HARD_LINKS
FolderFile.nlink.
Definition lib.h:129
@ ED_FOL_DATE
FolderFile.mtime.
Definition lib.h:118
@ ED_FOL_TAGGED
FolderFile.tagged.
Definition lib.h:137
@ ED_FOL_NUMBER
Folder.num.
Definition lib.h:135
@ ED_FOL_DESCRIPTION
FolderFile.desc, FolderFile.name.
Definition lib.h:121
@ ED_FOL_MESSAGE_COUNT
FolderFile.msg_count.
Definition lib.h:130
@ ED_FOL_NEWSGROUP
FolderFile.name.
Definition lib.h:131
@ ED_FOL_FLAGS
FolderFile.nd (NntpMboxData)
Definition lib.h:127
void browser_init_keys(struct SubMenu *sm_generic)
Initialise the Browser Keybindings - Implements ::init_keys_api.
Definition functions.c:130
void mutt_browser_select_dir(const char *f)
Remember the last directory selected.
void init_state(struct BrowserState *state)
Initialise a browser state.
void destroy_state(struct BrowserState *state)
Free the BrowserState.
Definition functions.c:150
int examine_directory(struct Mailbox *m, struct Menu *menu, struct BrowserState *state, const char *d, const char *prefix)
Get list of all files/newsgroups with mask.
void browser_add_folder(const struct Menu *menu, struct BrowserState *state, const char *name, const char *desc, const struct stat *st, struct Mailbox *m, void *data)
Add a folder to the browser list.
void mutt_browser_cleanup(void)
Clean up working Buffers.
void browser_highlight_default(struct BrowserState *state, struct Menu *menu)
Decide which browser item should be highlighted.
void dump_state(struct BrowserState *state)
int examine_mailboxes(struct Mailbox *m, struct Menu *menu, struct BrowserState *state)
Get list of mailboxes/subscribed newsgroups.
uint8_t SelectFileFlags
Flags for mutt_select_file(), e.g. MUTT_SEL_MAILBOX.
Definition lib.h:57
bool link_is_dir(const char *folder, const char *path)
Does this symlink point to a directory?
struct Buffer LastDir
Browser: previous selected directory.
struct Buffer LastDirBackup
Browser: backup copy of the current directory.
void dlg_browser(struct Buffer *file, SelectFileFlags flags, struct Mailbox *m, char ***files, int *numfiles)
Let the user select a file -.
Convenience wrapper for the library headers.
State of the file/mailbox browser.
Definition lib.h:145
char * folder
Folder name.
Definition lib.h:148
bool is_mailbox_list
Viewing mailboxes.
Definition lib.h:149
struct BrowserEntryArray entry
Array of files / dirs / mailboxes.
Definition lib.h:146
bool imap_browse
IMAP folder.
Definition lib.h:147
String manipulation buffer.
Definition buffer.h:36
Browser entry representing a folder/dir.
Definition lib.h:79
bool selectable
Folder can be selected.
Definition lib.h:97
char delim
Path delimiter.
Definition lib.h:94
bool imap
This is an IMAP folder.
Definition lib.h:96
bool has_mailbox
This is a mailbox.
Definition lib.h:99
char * name
Name of file/dir/mailbox.
Definition lib.h:87
uid_t uid
File's User ID.
Definition lib.h:83
bool tagged
Folder is tagged.
Definition lib.h:103
gid_t gid
File's Group ID.
Definition lib.h:84
bool has_new_mail
true if mailbox has "new mail"
Definition lib.h:90
bool poll_new_mail
Check mailbox for new mail.
Definition lib.h:102
bool notify_user
User will be notified of new mail.
Definition lib.h:101
nlink_t nlink
Number of hard links.
Definition lib.h:85
char * desc
Description of mailbox.
Definition lib.h:88
struct NntpMboxData * nd
Extra NNTP data.
Definition lib.h:104
off_t size
File size.
Definition lib.h:81
int gen
Unique id, used for (un)sorting.
Definition lib.h:106
bool local
Folder is on local filesystem.
Definition lib.h:100
time_t mtime
Modification time.
Definition lib.h:82
int msg_count
total number of messages
Definition lib.h:91
mode_t mode
File permissions.
Definition lib.h:80
bool inferiors
Folder has children.
Definition lib.h:98
int msg_unread
number of unread messages
Definition lib.h:92
A folder/dir in the browser.
Definition lib.h:70
int num
Number in the index.
Definition lib.h:72
struct FolderFile * ff
File / Dir / Mailbox.
Definition lib.h:71
A mailbox.
Definition mailbox.h:78
Definition lib.h:80
NNTP-specific Mailbox data -.
Definition mdata.h:34
Collection of related functions.
Definition menu.h:68