NeoMutt  2020-09-25
Teaching an old dog new tricks
DOXYGEN
mutt_globals.h
Go to the documentation of this file.
1 
23 #ifndef MUTT_GLOBALS_H
24 #define MUTT_GLOBALS_H
25 
26 #include "config.h"
27 #include <signal.h> // IWYU pragma: keep
28 #include <stdbool.h>
29 #include "mutt/lib.h"
30 #include "keymap.h"
31 #include "where.h"
32 
33 #ifdef MAIN_C
34 /* so that global vars get included */
35 #include "mx.h"
36 #include "sort.h"
37 #include "ncrypt/lib.h"
38 #endif /* MAIN_C */
39 
40 WHERE struct Colors *Colors;
41 
42 WHERE struct Context *Context;
43 
45 WHERE char ErrorBuf[256];
48 
49 WHERE char *HomeDir;
51 
52 WHERE char *Username;
53 
56 
57 extern const char *GitVer;
58 
60 
61 /* Lists of strings */
62 WHERE struct ListHead AlternativeOrderList INITVAL(STAILQ_HEAD_INITIALIZER(AlternativeOrderList));
63 WHERE struct ListHead AutoViewList INITVAL(STAILQ_HEAD_INITIALIZER(AutoViewList));
64 WHERE struct ListHead HeaderOrderList INITVAL(STAILQ_HEAD_INITIALIZER(HeaderOrderList));
65 WHERE struct ListHead MimeLookupList INITVAL(STAILQ_HEAD_INITIALIZER(MimeLookupList));
66 WHERE struct ListHead Muttrc INITVAL(STAILQ_HEAD_INITIALIZER(Muttrc));
67 WHERE struct ListHead TempAttachmentsList INITVAL(STAILQ_HEAD_INITIALIZER(TempAttachmentsList));
68 WHERE struct ListHead UserHeader INITVAL(STAILQ_HEAD_INITIALIZER(UserHeader));
69 
70 WHERE struct RegexList Alternates INITVAL(STAILQ_HEAD_INITIALIZER(Alternates));
71 WHERE struct RegexList UnAlternates INITVAL(STAILQ_HEAD_INITIALIZER(UnAlternates));
72 
73 /* flags for received signals */
74 WHERE SIG_ATOMIC_VOLATILE_T SigInt;
75 WHERE SIG_ATOMIC_VOLATILE_T SigWinch;
76 
78 
79 /* All the variables below are backing for config items */
80 
81 WHERE struct Address *C_From;
82 
90 WHERE char *C_Editor;
93 
94 WHERE char *C_Mbox;
96 WHERE char *C_Folder;
97 
98 WHERE char *C_Record;
99 WHERE char *C_Pager;
106 WHERE char *C_Shell;
113 
116 WHERE short C_Wrap;
117 
118 /* These variables are backing for config items */
119 WHERE struct Regex *C_Mask;
122 
123 /* Quad-options */
124 WHERE unsigned char C_Bounce;
125 WHERE unsigned char C_Delete;
127 WHERE unsigned char C_MimeForward;
128 WHERE unsigned char C_Print;
129 WHERE unsigned char C_Quit;
130 
138 WHERE bool C_Beep;
171 
172 #endif /* MUTT_GLOBALS_H */
WHERE bool C_SizeUnitsOnLeft
Config: Show the units as a prefix to the size.
Definition: mutt_globals.h:162
WHERE bool C_WriteBcc
Config: Write out the &#39;Bcc&#39; field when preparing to send a mail.
Definition: mutt_globals.h:170
WHERE char * C_Attribution
Config: Message to start a reply, "On DATE, PERSON wrote:".
Definition: mutt_globals.h:85
WHERE char * HomeDir
User&#39;s home directory.
Definition: mutt_globals.h:49
WHERE unsigned char C_MimeForward
Config: Forward a message as a &#39;message/RFC822&#39; MIME part.
Definition: mutt_globals.h:127
Manage keymappings.
A Hash Table.
Definition: hash.h:84
WHERE bool C_DeleteUntag
Config: Untag messages when they are marked for deletion.
Definition: mutt_globals.h:144
WHERE bool C_SaveEmpty
Config: (mbox,mmdf) Preserve empty mailboxes.
Definition: mutt_globals.h:157
WHERE short C_Timeout
Config: Time to wait for user input in menus.
Definition: mutt_globals.h:115
MenuType
Types of GUI selections.
Definition: keymap.h:72
WHERE bool C_Askcc
Config: Ask the user for the carbon-copy recipients.
Definition: mutt_globals.h:135
WHERE SIG_ATOMIC_VOLATILE_T SigInt
true after SIGINT is received
Definition: mutt_globals.h:74
WHERE char * C_TsIconFormat
Config: printf-like format string for the terminal&#39;s icon title.
Definition: mutt_globals.h:111
WHERE bool C_Header
Config: Include the message headers in the reply email (Weed applies)
Definition: mutt_globals.h:148
WHERE bool C_Score
Config: Use message scoring.
Definition: mutt_globals.h:158
WHERE short C_SleepTime
Config: Time to pause after certain info messages.
Definition: mutt_globals.h:114
WHERE char * C_Realname
Config: Real name of the user.
Definition: mutt_globals.h:105
WHERE bool C_BeepNew
Config: Make a noise when new mail arrives.
Definition: mutt_globals.h:139
WHERE char * C_AbortKey
Config: String representation of key to abort prompts.
Definition: mutt_globals.h:84
An email address.
Definition: address.h:34
WHERE char * C_Hostname
Config: Fully-qualified domain name of this machine.
Definition: mutt_globals.h:91
WHERE bool C_BrailleFriendly
Config: Move the cursor to the beginning of the line.
Definition: mutt_globals.h:140
WHERE struct Context * Context
Definition: mutt_globals.h:42
#define WHERE
Definition: where.h:30
WHERE char ErrorBuf[256]
Copy of the last error message.
Definition: mutt_globals.h:45
WHERE struct Slist * C_MailcapPath
Config: Colon-separated list of mailcap files.
Definition: mutt_globals.h:95
WHERE bool C_UseDomain
Config: Qualify local addresses using this domain.
Definition: mutt_globals.h:167
String list.
Definition: slist.h:45
WHERE bool C_AutoTag
Config: Automatically apply actions to all tagged messages.
Definition: mutt_globals.h:137
WHERE struct ListHead AlternativeOrderList INITVAL(STAILQ_HEAD_INITIALIZER(AlternativeOrderList))
List of preferred mime types to display.
WHERE char * C_Visual
Config: Editor to use when &#39;~v&#39; is given in the built-in editor.
Definition: mutt_globals.h:112
WHERE char * C_Shell
Config: External command to run subshells in.
Definition: mutt_globals.h:106
Assorted sorting methods.
WHERE char ProtectedHeaderMarker[256]
Unique ANSI string to mark protected headers in an email.
Definition: mutt_globals.h:47
WHERE char * Username
User&#39;s login name.
Definition: mutt_globals.h:52
WHERE enum MenuType CurrentMenu
Current Menu, e.g. MENU_PAGER.
Definition: mutt_globals.h:77
WHERE unsigned char C_ForwardAttachments
Config: Forward attachments when forwarding a message.
Definition: mutt_globals.h:126
API for mailboxes.
WHERE char * C_IndexFormat
Config: printf-like format string for the index menu (emails)
Definition: mutt_globals.h:92
WHERE bool C_ForwardQuote
Config: Automatically quote a forwarded message using C_IndentString.
Definition: mutt_globals.h:147
WHERE char * C_StatusFormat
Config: printf-like format string for the index&#39;s status line.
Definition: mutt_globals.h:109
WHERE bool C_ReadOnly
Config: Open folders in read-only mode.
Definition: mutt_globals.h:153
WHERE bool C_Beep
Config: Make a noise when an error occurs.
Definition: mutt_globals.h:138
WHERE char * C_PrintCommand
Config: External command to print a message.
Definition: mutt_globals.h:103
WHERE bool C_PrintDecodeWeed
Config: Control whether to weed headers when printing an email.
Definition: mutt_globals.h:152
WHERE int C_ToggleQuotedShowLevels
Config: Number of quote levels to show with toggle-quoted.
Definition: mutt_globals.h:121
WHERE bool C_ForwardDecode
Config: Decode the message when forwarding it.
Definition: mutt_globals.h:146
WHERE bool C_SizeShowBytes
Config: Show smaller sizes in bytes.
Definition: mutt_globals.h:159
WHERE short C_Wrap
Config: Width to wrap text in the pager.
Definition: mutt_globals.h:116
WHERE struct Regex * C_QuoteRegex
Config: Regex to match quoted text in a reply.
Definition: mutt_globals.h:120
WHERE bool C_Suspend
Config: Allow the user to suspend NeoMutt using &#39;^Z&#39;.
Definition: mutt_globals.h:164
WHERE char * C_Editor
Config: External command to use as an email editor.
Definition: mutt_globals.h:90
WHERE unsigned char C_Bounce
Config: Confirm before bouncing a message.
Definition: mutt_globals.h:124
WHERE bool C_SaveAddress
Config: Use sender&#39;s full address as a default save folder.
Definition: mutt_globals.h:156
WHERE bool C_TsEnabled
Config: Allow NeoMutt to set the terminal status line and icon.
Definition: mutt_globals.h:166
WHERE char AttachmentMarker[256]
Unique ANSI string to mark PGP messages in an email.
Definition: mutt_globals.h:46
WHERE char * C_ConfigCharset
Config: Character set that the config files are in.
Definition: mutt_globals.h:88
WHERE char * ShortHostname
Short version of the hostname.
Definition: mutt_globals.h:50
WHERE char * C_Folder
Config: Base folder for a set of mailboxes.
Definition: mutt_globals.h:96
WHERE bool C_Askbcc
Config: Ask the user for the blind-carbon-copy recipients.
Definition: mutt_globals.h:134
API for encryption/signing of emails.
WHERE bool C_Autoedit
Config: Skip the initial compose menu and edit the email.
Definition: mutt_globals.h:136
WHERE bool C_SizeShowFractions
Config: Show size fractions with a single decimal place.
Definition: mutt_globals.h:160
WHERE bool C_FlagSafe
Config: Protect flagged messages from deletion.
Definition: mutt_globals.h:145
WHERE bool C_Markers
Config: Display a &#39;+&#39; at the beginning of wrapped lines in the pager.
Definition: mutt_globals.h:150
WHERE bool C_Confirmcreate
Config: Confirm before creating a new mailbox.
Definition: mutt_globals.h:142
WHERE char * C_NewMailCommand
Config: External command to run when new mail arrives.
Definition: mutt_globals.h:104
WHERE bool C_MailCheckRecent
Config: Notify the user about new mail since the last time the mailbox was opened.
Definition: mutt_globals.h:149
WHERE bool C_AbortBackspace
Config: Hitting backspace against an empty prompt aborts the prompt.
Definition: mutt_globals.h:83
An evil macro.
WHERE bool C_SizeShowMb
Config: Show sizes in megabytes for sizes greater than 1 megabyte.
Definition: mutt_globals.h:161
WHERE struct Address * C_From
Config: Default &#39;From&#39; address to use, if isn&#39;t otherwise set.
Definition: mutt_globals.h:81
WHERE char * LastFolder
Previously selected mailbox.
Definition: mutt_globals.h:55
WHERE char * C_TsStatusFormat
Config: printf-like format string for the terminal&#39;s status (window title)
Definition: mutt_globals.h:110
WHERE bool C_WrapSearch
Config: Wrap around when the search hits the end.
Definition: mutt_globals.h:169
WHERE bool C_ArrowCursor
Config: Use an arrow &#39;->&#39; instead of highlighting in the index.
Definition: mutt_globals.h:131
WHERE char * C_SimpleSearch
Config: Pattern to search for when search doesn&#39;t contain ~&#39;s.
Definition: mutt_globals.h:107
WHERE bool C_AsciiChars
Config: Use plain ASCII characters, when drawing email threads.
Definition: mutt_globals.h:133
WHERE char * C_Record
Config: Folder to save &#39;sent&#39; messages.
Definition: mutt_globals.h:98
WHERE bool C_CopyDecodeWeed
Config: Controls whether to weed headers when copying or saving emails.
Definition: mutt_globals.h:143
WHERE unsigned char C_Delete
Config: Really delete messages, when the mailbox is closed.
Definition: mutt_globals.h:125
WHERE char * C_DateFormat
Config: strftime format string for the d expando.
Definition: mutt_globals.h:89
WHERE char * C_Spoolfile
Config: Inbox.
Definition: mutt_globals.h:108
WHERE char * C_Pager
Config: External command for viewing messages, or &#39;builtin&#39; to use NeoMutt&#39;s.
Definition: mutt_globals.h:99
WHERE bool C_ResumeDraftFiles
Config: Process draft files like postponed messages.
Definition: mutt_globals.h:155
Cached regular expression.
Definition: regex3.h:88
WHERE bool C_StatusOnTop
Config: Display the status bar at the top.
Definition: mutt_globals.h:163
WHERE unsigned char C_Quit
Config: Prompt before exiting NeoMutt.
Definition: mutt_globals.h:129
WHERE char * CurrentFolder
Currently selected mailbox.
Definition: mutt_globals.h:54
WHERE bool C_PipeDecodeWeed
Config: Control whether to weed headers when piping an email.
Definition: mutt_globals.h:151
WHERE char * C_AttachFormat
Config: printf-like format string for the attachment menu.
Definition: mutt_globals.h:87
#define STAILQ_HEAD_INITIALIZER(head)
Definition: queue.h:321
WHERE struct Colors * Colors
Wrapper around the user&#39;s colour settings.
Definition: mutt_globals.h:40
WHERE bool ErrorBufMessage
true if the last message was an error
Definition: mutt_globals.h:44
WHERE unsigned char C_Print
Config: Confirm before printing a message.
Definition: mutt_globals.h:128
const char * GitVer
Convenience wrapper for the library headers.
WHERE char * C_AttributionLocale
Config: Locale for dates in the attribution message.
Definition: mutt_globals.h:86
WHERE struct HashTable * TagFormats
Hash Table of tag-formats (tag -> format string)
Definition: mutt_globals.h:59
WHERE char * C_PagerFormat
Config: printf-like format string for the pager&#39;s status bar.
Definition: mutt_globals.h:100
WHERE SIG_ATOMIC_VOLATILE_T SigWinch
true after SIGWINCH is received
Definition: mutt_globals.h:75
WHERE char * C_Mbox
Config: Folder that receives read emails (see Move)
Definition: mutt_globals.h:94
WHERE struct Regex * C_Mask
Config: Only display files/dirs matching this regex in the browser.
Definition: mutt_globals.h:119
WHERE char * C_Postponed
Config: Folder to store postponed messages.
Definition: mutt_globals.h:101
WHERE char * C_ArrowString
Config: Use an custom string for arrow_cursor.
Definition: mutt_globals.h:132
WHERE bool C_Resolve
Config: Move to the next email whenever a command modifies an email.
Definition: mutt_globals.h:154
WHERE char * C_IndentString
Config: String used to indent &#39;reply&#39; text.
Definition: mutt_globals.h:102
WHERE bool C_WaitKey
Config: Prompt to press a key after running external commands.
Definition: mutt_globals.h:168
WHERE bool C_Confirmappend
Config: Confirm before appending emails to a mailbox.
Definition: mutt_globals.h:141
WHERE bool C_TextFlowed
Config: Generate &#39;format=flowed&#39; messages.
Definition: mutt_globals.h:165