NetBSD/usr.bin/mail/thread.h

111 lines
3.3 KiB
C
Raw Normal View History

/* $NetBSD: thread.h,v 1.2 2008/04/28 20:24:14 martin Exp $ */
From Anon Ymous: 1) Statification of modules. 2) Implement the 'detach' and 'Detach' commands for extracting mime parts from messages. 3) Teach mail to output "In-Reply-To" and "References" header fields when replying so others can thread us. 4) Implement threading, sorting, and tagging, supported by the following commands: 'flatten', 'reverse', 'sort', 'thread', 'unthread', 'down', 'tset', 'up', 'expose', 'hide', 'tag', 'untag', 'invtags', 'tagbelow', 'hidetags', 'showtags'. See the manpage for details (when available - soon). 5) Implement a 'deldups' command to delete duplicate messages based on their "Message-Id" field, e.g., in replies to a mailing list that are also CCed to a subscriber. (This can also be accomplished with the threading and tagging commands.) 6) Implement 'ifdef' and 'ifndef' commands, and make the conditionals nestable (i.e., implement a conditional stack). The if/else/endif commands existed before, but they were primitive and undocumented. The 'if' command currently recognizes the "receiving", "sending", and "headersonly" mode keywords. 7) Teach the message selecting routine to understand regular expressions if "regex-search" is defined. Otherwise only case insensitive substring matches are done (as in the past). 8) Teach the message selection routine to understand boolean expressions. Improved "colon-modifier" support. See the manpage for details (when available - soon). 9) Extend paging to all commands (where relevant). 10) Add shell like piping and redirection of (standard) output (if "enable-piping" is defined). Extend completion to these contexts. 11) The manpage should follow soon!!!!
2006-11-28 21:45:32 +03:00
/*-
* Copyright (c) 2006 The NetBSD Foundation, Inc.
* All rights reserved.
*
* This code is derived from software contributed to The NetBSD Foundation
* by Anon Ymous.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifdef THREAD_SUPPORT
#ifndef __THREAD_H__
#define __THREAD_H__
#if 0
#define NDEBUG /* disable the asserts */
#endif
/*
* The core message control routines. Without thread support, they
* live in fio.c.
*/
struct message *next_message(struct message *);
struct message *prev_message(struct message *);
struct message *get_message(int);
int get_msgnum(struct message *);
int get_msgCount(void);
/* These give special access to the message array needed in lex.c */
struct message *get_abs_message(int);
struct message *next_abs_message(struct message *);
int get_abs_msgCount(void);
/*
* Support hooks used by other modules.
*/
void thread_fix_old_links(struct message *, struct message *, int);
void thread_fix_new_links(struct message *, int, int);
int thread_hidden(void);
int thread_depth(void);
int do_recursion(void);
int thread_recursion(struct message *, int (*)(struct message *, void *), void *);
const char *thread_next_key_name(const void **);
/*
* Commands.
*/
/* thread setup */
int flattencmd(void *);
int reversecmd(void *v);
int sortcmd(void *);
int threadcmd(void *);
int unthreadcmd(void *);
/* thread navigation */
int downcmd(void *);
int tsetcmd(void *);
int upcmd(void *);
/* thread display */
int exposecmd(void *);
int hidecmd(void *);
/* tag commands */
int invtagscmd(void *);
int tagbelowcmd(void *);
int tagcmd(void *);
int untagcmd(void *);
/* tag display */
int hidetagscmd(void *);
int showtagscmd(void *);
/* something special */
int deldupscmd(void *);
#define ENAME_RECURSIVE_CMDS "recursive-commands"
/*
* Debugging stuff that should go away.
*/
#define THREAD_DEBUG
#ifdef THREAD_DEBUG
int thread_showcmd(void *);
#endif /* THREAD_DEBUG */
#endif /* __THREAD_H__ */
#endif /* THREAD_SUPPORT */