Thanks to visit codestin.com
Credit goes to code.neomutt.org

NeoMutt  2025-12-11-219-g274730
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 "config.h"
44#include <stdbool.h>
45#include <stdint.h>
46#include <sys/types.h>
47#include "mutt/lib.h"
48
49struct Mailbox;
50struct Menu;
51struct MuttWindow;
52struct stat;
53struct SubMenu;
54
55extern struct Buffer LastDir;
56extern struct Buffer LastDirBackup;
57
58typedef uint8_t SelectFileFlags;
59#define MUTT_SEL_NO_FLAGS 0
60#define MUTT_SEL_MAILBOX (1 << 0)
61#define MUTT_SEL_MULTI (1 << 1)
62#define MUTT_SEL_FOLDER (1 << 2)
63
64extern const struct CompleteOps CompleteFileOps;
65extern const struct CompleteOps CompleteMailboxOps;
66
70struct Folder
71{
72 struct FolderFile *ff;
73 int num;
74};
75
80{
81 mode_t mode;
82 off_t size;
83 time_t mtime;
84 uid_t uid;
85 gid_t gid;
86 nlink_t nlink;
87
88 char *name;
89 char *desc;
90
94
95 char delim;
96
97 bool imap : 1;
98 bool selectable : 1;
99 bool inferiors : 1;
100 bool has_mailbox : 1;
101 bool local : 1;
102 bool notify_user : 1;
103 bool poll_new_mail : 1;
104 bool tagged : 1;
105 struct NntpMboxData *nd;
106
107 int gen;
108};
109
110ARRAY_HEAD(BrowserEntryArray, struct FolderFile);
111
141
146{
147 struct BrowserEntryArray entry;
149 char *folder;
151};
152
153
154void browser_init_keys(struct SubMenu *sm_generic);
155
156void dlg_browser(struct Buffer *file, SelectFileFlags flags, struct Mailbox *m, char ***files, int *numfiles);
157void mutt_browser_select_dir(const char *f);
158void mutt_browser_cleanup(void);
159
160void browser_sort(struct BrowserState *state);
161void 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);
162void browser_highlight_default(struct BrowserState *state, struct Menu *menu);
163int examine_directory(struct Mailbox *m, struct Menu *menu, struct BrowserState *state, const char *d, const char *prefix);
164int examine_mailboxes(struct Mailbox *m, struct Menu *menu, struct BrowserState *state);
165void init_menu(struct BrowserState *state, struct Menu *menu, struct Mailbox *m, struct MuttWindow *sbar);
166void init_state(struct BrowserState *state);
167bool link_is_dir(const char *folder, const char *path);
168void destroy_state(struct BrowserState *state);
169void dump_state(struct BrowserState *state);
170
171#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:118
@ ED_FOL_POLL
FolderFile.poll_new_mail.
Definition lib.h:137
@ ED_FOL_NOTIFY
FolderFile.notify_user.
Definition lib.h:135
@ ED_FOL_NEW_COUNT
FolderFile.nd (NntpMboxData)
Definition lib.h:133
@ ED_FOL_FILE_OWNER
FolderFile.uid.
Definition lib.h:126
@ ED_FOL_FILE_GROUP
FolderFile.gid.
Definition lib.h:124
@ ED_FOL_FILENAME
FolderFile.name.
Definition lib.h:123
@ ED_FOL_DATE_FORMAT
FolderFile.mtime.
Definition lib.h:120
@ ED_FOL_DATE_STRF
FolderFile.mtime.
Definition lib.h:121
@ ED_FOL_UNREAD_COUNT
FolderFile.msg_unread.
Definition lib.h:139
@ ED_FOL_FLAGS2
FolderFile.nd (NntpMboxData)
Definition lib.h:129
@ ED_FOL_FILE_MODE
FolderFile.move.
Definition lib.h:125
@ ED_FOL_NEW_MAIL
FolderFile.has_new_mail.
Definition lib.h:134
@ ED_FOL_FILE_SIZE
FolderFile.size.
Definition lib.h:127
@ ED_FOL_HARD_LINKS
FolderFile.nlink.
Definition lib.h:130
@ ED_FOL_DATE
FolderFile.mtime.
Definition lib.h:119
@ ED_FOL_TAGGED
FolderFile.tagged.
Definition lib.h:138
@ ED_FOL_NUMBER
Folder.num.
Definition lib.h:136
@ ED_FOL_DESCRIPTION
FolderFile.desc, FolderFile.name.
Definition lib.h:122
@ ED_FOL_MESSAGE_COUNT
FolderFile.msg_count.
Definition lib.h:131
@ ED_FOL_NEWSGROUP
FolderFile.name.
Definition lib.h:132
@ ED_FOL_FLAGS
FolderFile.nd (NntpMboxData)
Definition lib.h:128
void browser_init_keys(struct SubMenu *sm_generic)
Initialise the Browser Keybindings - Implements ::init_keys_api.
Definition functions.c:131
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:149
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:58
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:146
char * folder
Folder name.
Definition lib.h:149
bool is_mailbox_list
Viewing mailboxes.
Definition lib.h:150
struct BrowserEntryArray entry
Array of files / dirs / mailboxes.
Definition lib.h:147
bool imap_browse
IMAP folder.
Definition lib.h:148
String manipulation buffer.
Definition buffer.h:36
Browser entry representing a folder/dir.
Definition lib.h:80
bool selectable
Folder can be selected.
Definition lib.h:98
char delim
Path delimiter.
Definition lib.h:95
bool imap
This is an IMAP folder.
Definition lib.h:97
bool has_mailbox
This is a mailbox.
Definition lib.h:100
char * name
Name of file/dir/mailbox.
Definition lib.h:88
uid_t uid
File's User ID.
Definition lib.h:84
bool tagged
Folder is tagged.
Definition lib.h:104
gid_t gid
File's Group ID.
Definition lib.h:85
bool has_new_mail
true if mailbox has "new mail"
Definition lib.h:91
bool poll_new_mail
Check mailbox for new mail.
Definition lib.h:103
bool notify_user
User will be notified of new mail.
Definition lib.h:102
nlink_t nlink
Number of hard links.
Definition lib.h:86
char * desc
Description of mailbox.
Definition lib.h:89
struct NntpMboxData * nd
Extra NNTP data.
Definition lib.h:105
off_t size
File size.
Definition lib.h:82
int gen
Unique id, used for (un)sorting.
Definition lib.h:107
bool local
Folder is on local filesystem.
Definition lib.h:101
time_t mtime
Modification time.
Definition lib.h:83
int msg_count
total number of messages
Definition lib.h:92
mode_t mode
File permissions.
Definition lib.h:81
bool inferiors
Folder has children.
Definition lib.h:99
int msg_unread
number of unread messages
Definition lib.h:93
A folder/dir in the browser.
Definition lib.h:71
int num
Number in the index.
Definition lib.h:73
struct FolderFile * ff
File / Dir / Mailbox.
Definition lib.h:72
A mailbox.
Definition mailbox.h:79
Definition lib.h:80
NNTP-specific Mailbox data -.
Definition mdata.h:34
Collection of related functions.
Definition menu.h:69