NeoMutt  2024-03-23-142-g2b2e76
Teaching an old dog new tricks
DOXYGEN
Loading...
Searching...
No Matches
lib.h File Reference

Compressed mbox local mailbox type. More...

#include <stdbool.h>
#include <stdio.h>
#include "core/lib.h"
+ Include dependency graph for lib.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  CompressInfo
 Private data for compress. More...
 

Enumerations

enum  ExpandoDataCompress { ED_CMP_FROM = 1 , ED_CMP_TO }
 Expando UIDs for Compression. More...
 

Functions

void mutt_comp_init (void)
 Setup feature commands.
 
bool mutt_comp_can_append (struct Mailbox *m)
 Can we append to this path?
 
bool mutt_comp_can_read (const char *path)
 Can we read from this file?
 
int mutt_comp_valid_command (const char *cmd)
 Is this command string allowed?
 

Variables

const struct MxOps MxCompOps
 Compressed Mailbox - Implements MxOps -.
 

Detailed Description

Compressed mbox local mailbox type.

Authors
  • Richard Russon
  • Tóth János

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 lib.h.

Enumeration Type Documentation

◆ ExpandoDataCompress

Expando UIDs for Compression.

See also
ED_COMPRESS, ExpandoDomain
Enumerator
ED_CMP_FROM 

'from' path

ED_CMP_TO 

'to' path

Definition at line 46 of file lib.h.

47{
48 ED_CMP_FROM = 1,
49 ED_CMP_TO,
50};
@ ED_CMP_FROM
'from' path
Definition: lib.h:48
@ ED_CMP_TO
'to' path
Definition: lib.h:49

Function Documentation

◆ mutt_comp_init()

void mutt_comp_init ( void  )

Setup feature commands.

Definition at line 91 of file compress.c.

92{
94}
static const struct Command CompCommands[]
Compression Commands.
Definition: compress.c:64
void commands_register(const struct Command *cmds, const size_t num_cmds)
Add commands to Commands array.
Definition: command.c:53
#define mutt_array_size(x)
Definition: memory.h:38
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_comp_can_append()

bool mutt_comp_can_append ( struct Mailbox m)

Can we append to this path?

Parameters
mMailbox
Return values
trueYes, we can append to the file
falseNo, appending isn't possible

To append to a file we can either use an 'append-hook' or a combination of 'open-hook' and 'close-hook'.

A match means it's our responsibility to append to the file.

Definition at line 365 of file compress.c.

366{
367 if (!m)
368 return false;
369
370 /* If this succeeds, we know there's an open-hook */
371 struct CompressInfo *ci = set_compress_info(m);
372 if (!ci)
373 return false;
374
375 /* We have an open-hook, so to append we need an append-hook,
376 * or a close-hook. */
377 if (ci->cmd_append || ci->cmd_close)
378 return true;
379
380 mutt_error(_("Can't append without an append-hook or close-hook : %s"), mailbox_path(m));
381 return false;
382}
static struct CompressInfo * set_compress_info(struct Mailbox *m)
Find the compress hooks for a mailbox.
Definition: compress.c:239
static const char * mailbox_path(const struct Mailbox *m)
Get the Mailbox's path string.
Definition: mailbox.h:223
#define mutt_error(...)
Definition: logging2.h:92
#define _(a)
Definition: message.h:28
Private data for compress.
Definition: lib.h:58
struct Expando * cmd_append
append-hook command
Definition: lib.h:59
struct Expando * cmd_close
close-hook command
Definition: lib.h:60
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_comp_can_read()

bool mutt_comp_can_read ( const char *  path)

Can we read from this file?

Parameters
pathPathname of file to be tested
Return values
trueYes, we can read the file
falseNo, we can't read the file

Search for an 'open-hook' with a regex that matches the path.

A match means it's our responsibility to open the file.

Definition at line 394 of file compress.c.

395{
396 if (!path)
397 return false;
398
400 return true;
401
402 return false;
403}
char * mutt_find_hook(HookFlags type, const char *pat)
Find a matching hook.
Definition: hook.c:671
#define MUTT_OPEN_HOOK
open-hook: to read a compressed mailbox
Definition: hook.h:49
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ mutt_comp_valid_command()

int mutt_comp_valid_command ( const char *  cmd)

Is this command string allowed?

Parameters
cmdCommand string
Return values
1Valid command
0"%f" and/or "%t" is missing

A valid command string must have both "%f" (from file) and "%t" (to file). We don't check if we can actually run the command.

Definition at line 414 of file compress.c.

415{
416 if (!cmd)
417 return 0;
418
419 return strstr(cmd, "%f") && strstr(cmd, "%t");
420}
+ Here is the caller graph for this function: