NeoMutt  2022-04-29-249-gaae397
Teaching an old dog new tricks
DOXYGEN
private.h File Reference

Shared constants/structs that are private to libpattern. More...

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

Go to the source code of this file.

Data Structures

struct  PatternEntry
 A line in the Pattern Completion menu. More...
 
struct  PatternFlags
 Mapping between user character and internal constant. More...
 
struct  RangeRegex
 Regular expression representing a range. More...
 

Macros

#define RANGE_NUM_RX   "([[:digit:]]+|0x[[:xdigit:]]+)[MmKk]?"
 
#define RANGE_REL_SLOT_RX   "[[:blank:]]*([.^$]|-?" RANGE_NUM_RX ")?[[:blank:]]*"
 
#define RANGE_REL_RX   "^" RANGE_REL_SLOT_RX "," RANGE_REL_SLOT_RX
 
#define RANGE_ABS_SLOT_RX   "[[:blank:]]*([.^$]|" RANGE_NUM_RX ")?[[:blank:]]*"
 
#define RANGE_ABS_RX   "^" RANGE_ABS_SLOT_RX "-" RANGE_ABS_SLOT_RX
 
#define RANGE_LT_RX   "^()[[:blank:]]*(<[[:blank:]]*" RANGE_NUM_RX ")[[:blank:]]*"
 
#define RANGE_GT_RX   "^()[[:blank:]]*(>[[:blank:]]*" RANGE_NUM_RX ")[[:blank:]]*"
 
#define RANGE_BARE_RX   "^[[:blank:]]*([.^$]|" RANGE_NUM_RX ")[[:blank:]]*"
 
#define RANGE_RX_GROUPS   5
 
#define RANGE_DOT   '.'
 
#define RANGE_CIRCUM   '^'
 
#define RANGE_DOLLAR   '$'
 
#define RANGE_LT   '<'
 
#define RANGE_GT   '>'
 
#define EMSG(e)   (((e)->msgno) + 1)
 
#define MUTT_MAXRANGE   -1
 

Enumerations

enum  PatternEat {
  EAT_NONE , EAT_REGEX , EAT_DATE , EAT_RANGE ,
  EAT_MESSAGE_RANGE , EAT_QUERY
}
 Function to process pattern arguments. More...
 
enum  RangeType {
  RANGE_K_REL , RANGE_K_ABS , RANGE_K_LT , RANGE_K_GT ,
  RANGE_K_BARE , RANGE_K_INVALID
}
 Type of range. More...
 
enum  RangeSide { RANGE_S_LEFT , RANGE_S_RIGHT }
 Which side of the range. More...
 

Functions

const struct PatternFlagslookup_op (int op)
 Lookup the Pattern Flags for an op. More...
 
const struct PatternFlagslookup_tag (char tag)
 Lookup a pattern modifier. More...
 
bool eval_date_minmax (struct Pattern *pat, const char *s, struct Buffer *err)
 Evaluate a date-range pattern against 'now'. More...
 

Variables

struct RangeRegex RangeRegexes []
 Set of Regexes for various range types. More...
 
const struct PatternFlags Flags []
 Lookup table for all patterns. More...
 

Detailed Description

Shared constants/structs that are private to libpattern.

Authors
  • Richard Russon

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

Macro Definition Documentation

◆ RANGE_NUM_RX

#define RANGE_NUM_RX   "([[:digit:]]+|0x[[:xdigit:]]+)[MmKk]?"

Definition at line 96 of file private.h.

◆ RANGE_REL_SLOT_RX

#define RANGE_REL_SLOT_RX   "[[:blank:]]*([.^$]|-?" RANGE_NUM_RX ")?[[:blank:]]*"

Definition at line 97 of file private.h.

◆ RANGE_REL_RX

#define RANGE_REL_RX   "^" RANGE_REL_SLOT_RX "," RANGE_REL_SLOT_RX

Definition at line 98 of file private.h.

◆ RANGE_ABS_SLOT_RX

#define RANGE_ABS_SLOT_RX   "[[:blank:]]*([.^$]|" RANGE_NUM_RX ")?[[:blank:]]*"

Definition at line 101 of file private.h.

◆ RANGE_ABS_RX

#define RANGE_ABS_RX   "^" RANGE_ABS_SLOT_RX "-" RANGE_ABS_SLOT_RX

Definition at line 102 of file private.h.

◆ RANGE_LT_RX

#define RANGE_LT_RX   "^()[[:blank:]]*(<[[:blank:]]*" RANGE_NUM_RX ")[[:blank:]]*"

Definition at line 105 of file private.h.

◆ RANGE_GT_RX

#define RANGE_GT_RX   "^()[[:blank:]]*(>[[:blank:]]*" RANGE_NUM_RX ")[[:blank:]]*"

Definition at line 106 of file private.h.

◆ RANGE_BARE_RX

#define RANGE_BARE_RX   "^[[:blank:]]*([.^$]|" RANGE_NUM_RX ")[[:blank:]]*"

Definition at line 109 of file private.h.

◆ RANGE_RX_GROUPS

#define RANGE_RX_GROUPS   5

Definition at line 110 of file private.h.

◆ RANGE_DOT

#define RANGE_DOT   '.'

Definition at line 112 of file private.h.

◆ RANGE_CIRCUM

#define RANGE_CIRCUM   '^'

Definition at line 113 of file private.h.

◆ RANGE_DOLLAR

#define RANGE_DOLLAR   '$'

Definition at line 114 of file private.h.

◆ RANGE_LT

#define RANGE_LT   '<'

Definition at line 115 of file private.h.

◆ RANGE_GT

#define RANGE_GT   '>'

Definition at line 116 of file private.h.

◆ EMSG

#define EMSG (   e)    (((e)->msgno) + 1)

Definition at line 127 of file private.h.

◆ MUTT_MAXRANGE

#define MUTT_MAXRANGE   -1

Definition at line 129 of file private.h.

Enumeration Type Documentation

◆ PatternEat

enum PatternEat

Function to process pattern arguments.

Values for PatternFlags.eat_arg

Enumerator
EAT_NONE 

No arguments required.

EAT_REGEX 

Process a regex.

EAT_DATE 

Process a date (range)

EAT_RANGE 

Process a number (range)

EAT_MESSAGE_RANGE 

Process a message number (range)

EAT_QUERY 

Process a query string.

Definition at line 46 of file private.h.

47{
48 EAT_NONE,
49 EAT_REGEX,
50 EAT_DATE,
51 EAT_RANGE,
53 EAT_QUERY,
54};
@ EAT_NONE
No arguments required.
Definition: private.h:48
@ EAT_RANGE
Process a number (range)
Definition: private.h:51
@ EAT_MESSAGE_RANGE
Process a message number (range)
Definition: private.h:52
@ EAT_DATE
Process a date (range)
Definition: private.h:50
@ EAT_QUERY
Process a query string.
Definition: private.h:53
@ EAT_REGEX
Process a regex.
Definition: private.h:49

◆ RangeType

enum RangeType

Type of range.

Enumerator
RANGE_K_REL 

Relative range.

RANGE_K_ABS 

Absolute range.

RANGE_K_LT 

Less-than range.

RANGE_K_GT 

Greater-than range.

RANGE_K_BARE 

Single symbol.

RANGE_K_INVALID 

Range is invalid.

Definition at line 84 of file private.h.

85{
91 /* add new ones HERE */
93};
@ RANGE_K_REL
Relative range.
Definition: private.h:86
@ RANGE_K_ABS
Absolute range.
Definition: private.h:87
@ RANGE_K_LT
Less-than range.
Definition: private.h:88
@ RANGE_K_INVALID
Range is invalid.
Definition: private.h:92
@ RANGE_K_BARE
Single symbol.
Definition: private.h:90
@ RANGE_K_GT
Greater-than range.
Definition: private.h:89

◆ RangeSide

enum RangeSide

Which side of the range.

Enumerator
RANGE_S_LEFT 

Left side of range.

RANGE_S_RIGHT 

Right side of range.

Definition at line 121 of file private.h.

122{
125};
@ RANGE_S_LEFT
Left side of range.
Definition: private.h:123
@ RANGE_S_RIGHT
Right side of range.
Definition: private.h:124

Function Documentation

◆ lookup_op()

const struct PatternFlags * lookup_op ( int  op)

Lookup the Pattern Flags for an op.

Parameters
opOperation, e.g. MUTT_PAT_SENDER
Return values
ptrPatternFlags

Definition at line 210 of file flags.c.

211{
212 for (int i = 0; Flags[i].tag; i++)
213 if (Flags[i].op == op)
214 return (&Flags[i]);
215 return NULL;
216}
const struct PatternFlags Flags[]
Lookup table for all patterns.
Definition: flags.c:40
int tag
Character used to represent this operation, e.g. 'A' for '~A'.
Definition: private.h:61
+ Here is the caller graph for this function:

◆ lookup_tag()

const struct PatternFlags * lookup_tag ( char  tag)

Lookup a pattern modifier.

Parameters
tagLetter, e.g. 'b' for pattern '~b'
Return values
ptrPattern data

Definition at line 197 of file flags.c.

198{
199 for (int i = 0; Flags[i].tag; i++)
200 if (Flags[i].tag == tag)
201 return &Flags[i];
202 return NULL;
203}
+ Here is the caller graph for this function:

◆ eval_date_minmax()

bool eval_date_minmax ( struct Pattern pat,
const char *  s,
struct Buffer err 
)

Evaluate a date-range pattern against 'now'.

Parameters
patPattern to modify
sPattern string to use
errBuffer for error messages
Return values
truePattern valid and updated
falsePattern invalid

Definition at line 500 of file compile.c.

501{
502 /* the '0' time is Jan 1, 1970 UTC, so in order to prevent a negative time
503 * when doing timezone conversion, we use Jan 2, 1970 UTC as the base here */
504 struct tm min = { 0 };
505 min.tm_mday = 2;
506 min.tm_year = 70;
507
508 /* Arbitrary year in the future. Don't set this too high or
509 * mutt_date_make_time() returns something larger than will fit in a time_t
510 * on some systems */
511 struct tm max = { 0 };
512 max.tm_year = 130;
513 max.tm_mon = 11;
514 max.tm_mday = 31;
515 max.tm_hour = 23;
516 max.tm_min = 59;
517 max.tm_sec = 59;
518
519 if (strchr("<>=", s[0]))
520 {
521 /* offset from current time
522 * <3d less than three days ago
523 * >3d more than three days ago
524 * =3d exactly three days ago */
525 struct tm *tm = NULL;
526 bool exact = false;
527
528 if (s[0] == '<')
529 {
531 tm = &min;
532 }
533 else
534 {
536 tm = &max;
537
538 if (s[0] == '=')
539 exact = true;
540 }
541
542 /* Reset the HMS unless we are relative matching using one of those
543 * offsets. */
544 char *offset_type = NULL;
545 strtol(s + 1, &offset_type, 0);
546 if (!(*offset_type && strchr("HMS", *offset_type)))
547 {
548 tm->tm_hour = 23;
549 tm->tm_min = 59;
550 tm->tm_sec = 59;
551 }
552
553 /* force negative offset */
554 get_offset(tm, s + 1, -1);
555
556 if (exact)
557 {
558 /* start at the beginning of the day in question */
559 memcpy(&min, &max, sizeof(max));
560 min.tm_hour = 0;
561 min.tm_sec = 0;
562 min.tm_min = 0;
563 }
564 }
565 else
566 {
567 const char *pc = s;
568
569 bool have_min = false;
570 bool until_now = false;
571 if (isdigit((unsigned char) *pc))
572 {
573 /* minimum date specified */
574 pc = get_date(pc, &min, err);
575 if (!pc)
576 {
577 return false;
578 }
579 have_min = true;
580 SKIPWS(pc);
581 if (*pc == '-')
582 {
583 const char *pt = pc + 1;
584 SKIPWS(pt);
585 until_now = (*pt == '\0');
586 }
587 }
588
589 if (!until_now)
590 { /* max date or relative range/window */
591
592 struct tm base_min;
593
594 if (!have_min)
595 { /* save base minimum and set current date, e.g. for "-3d+1d" */
596 memcpy(&base_min, &min, sizeof(base_min));
598 min.tm_hour = 0;
599 min.tm_sec = 0;
600 min.tm_min = 0;
601 }
602
603 /* preset max date for relative offsets,
604 * if nothing follows we search for messages on a specific day */
605 max.tm_year = min.tm_year;
606 max.tm_mon = min.tm_mon;
607 max.tm_mday = min.tm_mday;
608
609 if (!parse_date_range(pc, &min, &max, have_min, &base_min, err))
610 { /* bail out on any parsing error */
611 return false;
612 }
613 }
614 }
615
616 /* Since we allow two dates to be specified we'll have to adjust that. */
617 adjust_date_range(&min, &max);
618
619 pat->min = mutt_date_make_time(&min, true);
620 pat->max = mutt_date_make_time(&max, true);
621
622 return true;
623}
static const char * parse_date_range(const char *pc, struct tm *min, struct tm *max, bool have_min, struct tm *base_min, struct Buffer *err)
Parse a date range.
Definition: compile.c:376
static void adjust_date_range(struct tm *min, struct tm *max)
Put a date range in the correct order.
Definition: compile.c:462
static const char * get_offset(struct tm *tm, const char *s, int sign)
Calculate a symbolic offset.
Definition: compile.c:236
static const char * get_date(const char *s, struct tm *t, struct Buffer *err)
Parse a (partial) date in dd/mm/yyyy format.
Definition: compile.c:290
struct tm mutt_date_localtime(time_t t)
Converts calendar time to a broken-down time structure expressed in user timezone.
Definition: date.c:655
time_t mutt_date_make_time(struct tm *t, bool local)
Convert struct tm to time_t
Definition: date.c:229
#define MUTT_DATE_NOW
Constant representing the 'current time', see: mutt_date_gmtime(), mutt_date_localtime()
Definition: date.h:39
#define SKIPWS(ch)
Definition: string2.h:46
long min
Minimum for range checks.
Definition: lib.h:81
long max
Maximum for range checks.
Definition: lib.h:82
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ RangeRegexes

struct RangeRegex RangeRegexes[]
extern

Set of Regexes for various range types.

This array, will also contain the compiled regexes.

Definition at line 65 of file pattern.c.

◆ Flags

const struct PatternFlags Flags[]
extern

Lookup table for all patterns.

Definition at line 40 of file flags.c.