summaryrefslogtreecommitdiffstats
path: root/comm/mailnews/addrbook/public/nsIAbBooleanExpression.idl
blob: 37ab350bbc093a13bcde7227ba4ee7f33d56a70a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

typedef long nsAbBooleanConditionType;

/**
 * Condition types
 *
 * Constants defining the types of condition
 * to obtain a boolean result of TRUE or FALSE
 *
 */
[scriptable, uuid(F51387B1-5AEF-4A1C-830E-7CD3B02366CE)]
interface nsIAbBooleanConditionTypes : nsISupports
{
    const long Exists        = 0;
    const long DoesNotExist        = 1;
    const long Contains        = 2;
    const long DoesNotContain    = 3;
    const long Is            = 4;
    const long IsNot        = 5;
    const long BeginsWith        = 6;
    const long EndsWith        = 7;
    const long LessThan        = 8;
    const long GreaterThan        = 9;
    const long SoundsLike        = 10;
    const long RegExp        = 11;
};


typedef long nsAbBooleanOperationType;

/*
 * Operation types
 *
 * Constants defining the boolean operation that
 * should be performed between two boolean expressions
 *
 */
[scriptable, uuid(9bdd2e51-2be4-49a4-a558-36d1a812231a)]
interface nsIAbBooleanOperationTypes : nsISupports
{
    const long AND        = 0;
    const long OR        = 1;
    const long NOT        = 2;
};


/**
 * String condition
 *
 * A string condition represents a leaf node in a
 * boolean expression tree and represents
 * test which will return TRUE or FALSE
 *
 * Condition is an expression which is a
 * leaf node in a boolean expression tree
 *
 */
[scriptable, uuid(C3869D72-CFD0-45F0-A0EC-3F67D83C7110)]
interface nsIAbBooleanConditionString : nsISupports
{
    /**
     * The condition for how the a value
     * should be compared
     *
     */
    attribute nsAbBooleanConditionType condition;

    /**
     * The lhs of the condition
     *
     * Represents a property name which
     * should be evaluated to obtain the
     * lhs.
     *
     */
    attribute string name;

    /**
     * The rhs of the condition
     *
     * <name> [condition] value
     *
     */
    attribute wstring value;
};

/**
 * N Boolean expression type
 *
 * Supports Unary Binary and N boolean expressions
 *
 * An operation represents a node in a boolean
 * expression tree which may contain one or more
 * child conditions or expressions
 *
 */
[scriptable, uuid(223a9462-1aeb-4c1f-b069-5fc6278989b2)]
interface nsIAbBooleanExpression: nsISupports
{
    /**
     * The boolean operation to be applied to
     * results of all evaluated expressions
     *
     */
    attribute nsAbBooleanOperationType operation;

    /**
     * List of peer expressions
     *
     * e1 [op] e2 [op] .... en
     *
     */
    attribute Array<nsISupports> expressions;
};