Version 0.3.0 from FTP
[asterisk/asterisk.git] / README.variables
1 GENERAL ENCHANCEMENTS TO EXTENSION LOGIC : 
2
3 QUOTING: 
4
5 exten => s,5,BackGround,blabla
6
7 The parameter (blabla) can be quoted ("blabla"). In this case, a 
8 comma does not terminate the field. 
9
10 Also, characters special to variable substitution, expression evaluation, etc
11 (see below), can be quoted. For example, to literally use a $ on the 
12 string "$1231", quote it with a preceeding \. Special characters that must
13 be quoted to be used, are [ ] $ " \. (to write \ itself, use \\). 
14
15 VARIABLES: 
16
17 Parameter strings can include variables. Variable names are arbitrary strings. 
18 They are stored in the respective channel structure. 
19
20 To set a variable to a particular value, do : 
21
22 ;exten => 1,2,SetVar,varname=value
23
24 You can substitute the value of a variable everywhere using ${variablename}.
25 For example, to stringwise append $lala to $blabla and store result in $koko, 
26 do: 
27
28 ;exten => 1,2,SetVar,koko=${blabla}${lala}
29
30 There are also the following special variables: 
31
32 ${CALLERID}     Caller ID
33 ${CALLERIDNAME} Caller ID Name only
34 ${CALLERIDNUM}  Caller ID Number only
35 ${EXTEN}        Current extension
36 ${CONTEXT}      Current context
37 ${PRIORITY}     Current priority
38
39 There are two reference modes - reference by value and reference by name. 
40 To refer to a variable with its name (as an argument to a function that 
41 requires a variable), just write the name. To refer to the variable's value, 
42 enclose it inside ${}. For example, SetVar takes as the first argument 
43 (before the =) a variable name, so: 
44
45 ;exten => 1,2,SetVar,koko=lala
46 ;exten => 1,3,SetVar,${koko}=blabla
47
48 stores to the variable "koko" the value "lala" and to variable "lala" the 
49 value "blabla". 
50
51 In fact, everything contained ${here} is just replaced with the value of 
52 the variable "here". 
53
54 EXPRESSIONS: 
55
56 Everything contained inside a bracket pair prefixed by a $ (like $[this]) is 
57 considered as an expression and it is evaluated. Evaluation works similar to 
58 (but is done on a later stage than) variable substitution: the expression 
59 (including the square brackets) is replaced by the result of the expression 
60 evaluation. The arguments and operands of the expression MUST BE separated 
61 with spaces (take care NOT to leave ANY spaces between opening and closing 
62 square brackets and the first and last arguments). 
63
64 For example, after the sequence: 
65
66 exten => 1,1,SetVar,"lala=$[1 + 2]";
67 exten => 1,2,SetVar,"koko=$[2 * ${lala}]";
68
69 the value of variable koko is "6".
70
71 Operators are listed below in order of increasing precedence.  Operators
72 with equal precedence are grouped within { } symbols.
73
74      expr1 | expr2
75              Return the evaluation of expr1 if it is neither an empty string
76              nor zero; otherwise, returns the evaluation of expr2.
77
78      expr1 & expr2
79              Return the evaluation of expr1 if neither expression evaluates to
80              an empty string or zero; otherwise, returns zero.
81
82      expr1 {=, >, >=, <, <=, !=} expr2
83              Return the results of integer comparison if both arguments are
84              integers; otherwise, returns the results of string comparison
85              using the locale-specific collation sequence.  The result of each
86              comparison is 1 if the specified relation is true, or 0 if the
87              relation is false.
88
89      expr1 {+, -} expr2
90              Return the results of addition or subtraction of integer-valued
91              arguments.
92
93      expr1 {*, /, %} expr2
94              Return the results of multiplication, integer division, or
95              remainder of integer-valued arguments.
96
97      expr1 : expr2
98              The `:' operator matches expr1 against expr2, which must be a
99              regular expression.  The regular expression is anchored to the
100              beginning of  the string with an implicit `^'.
101
102              If the match succeeds and the pattern contains at least one regu-
103              lar expression subexpression `\(...\)', the string correspond-
104              ing to `\1' is returned; otherwise the matching operator
105              returns the number of characters matched.  If the match fails and
106              the pattern contains a regular expression subexpression the null
107              string is returned; otherwise 0.
108
109 Parentheses are used for grouping in the usual manner.
110
111 The parser must be parsed with bison (bison is REQUIRED - yacc cannot 
112 produce pure parsers, which are reentrant) 
113
114 CONDITIONALS
115
116 There is one conditional operator - the conditional goto : 
117
118 ;exten => 1,2,gotoif,condition?label1:label2
119
120 If condition is true go to label1, else go to label2. Labels are interpreted
121 exactly as in the normal goto command.
122
123 "condition" is just a string. If the string is empty or "0", the condition
124 is considered to be false, if it's anything else, the condition is true. 
125 This is designed to be used together with the expression syntax described 
126 above, eg : 
127
128 exten => 1,2,gotoif,$[${CALLERID} = 123456]?2|1:3|1
129
130
131 Example of use : 
132
133 exten => s,2,SetVar,"vara=1"
134 exten => s,3,SetVar,"varb=$[${vara} + 2]"
135 exten => s,4,SetVar,"varc=$[${varb} * 2]"
136 exten => s,5,GotoIf,"$[${varc} = 6]?99|1:s|6";
137