update doxygen docs to specify authors
[asterisk/asterisk.git] / funcs / func_math.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2004 - 2005, Andy Powell 
5  *
6  * Updated by Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Maths relatad dialplan functions
22  *
23  * \author Andy Powell
24  * \author Mark Spencer <markster@digium.com>
25  */
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <string.h>
30 #include <sys/types.h>
31
32 #include "asterisk.h"
33
34 /* ASTERISK_FILE_VERSION(__FILE__, "$Revision$") */
35
36 #include "asterisk/channel.h"
37 #include "asterisk/pbx.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/utils.h"
40 #include "asterisk/app.h"
41 #include "asterisk/config.h"
42
43 enum TypeOfFunctions
44 {
45     ADDFUNCTION,
46     DIVIDEFUNCTION,
47     MULTIPLYFUNCTION,
48     SUBTRACTFUNCTION,
49     MODULUSFUNCTION,
50
51     GTFUNCTION,
52     LTFUNCTION,
53     GTEFUNCTION,
54     LTEFUNCTION,
55     EQFUNCTION
56 };
57
58 enum TypeOfResult
59 {
60     FLOAT_RESULT,
61     INT_RESULT,
62     HEX_RESULT,
63     CHAR_RESULT
64 };
65
66
67 static char *builtin_function_math(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len) 
68 {
69         int argc;
70         char *argv[2];
71         char *args;
72         float fnum1;
73         float fnum2;
74         float ftmp = 0;
75         char *op;
76         int iaction=-1;
77         int type_of_result=FLOAT_RESULT;
78
79         /* dunno, big calulations :D */
80         char user_result[30];
81
82         char *mvalue1, *mvalue2=NULL, *mtype_of_result;
83                 
84         if (ast_strlen_zero(data)) {
85                 ast_log(LOG_WARNING, "Syntax: Math(<number1><op><number 2>[,<type_of_result>]) - missing argument!\n");
86                 return NULL;
87         }
88
89         args = ast_strdupa(data);       
90         argc = ast_app_separate_args(args, '|', argv, sizeof(argv) / sizeof(argv[0]));
91
92         if (argc < 1) {
93                 ast_log(LOG_WARNING, "Syntax: Math(<number1><op><number 2>[,<type_of_result>]) - missing argument!\n");
94                 return NULL;
95         }
96
97         mvalue1 = argv[0];
98         
99         if ((op = strchr(mvalue1, '+'))) {
100                 iaction = ADDFUNCTION;
101                 *op = '\0';
102         } else if ((op = strchr(mvalue1, '-'))) {
103                 iaction = SUBTRACTFUNCTION;
104                 *op = '\0';
105         } else if ((op = strchr(mvalue1, '*'))) {
106                 iaction = MULTIPLYFUNCTION;
107                 *op = '\0';
108         } else if ((op = strchr(mvalue1, '/'))) {
109                 iaction = DIVIDEFUNCTION;
110                 *op = '\0';
111         } else if ((op = strchr(mvalue1, '%'))) {
112                 iaction = MODULUSFUNCTION;
113                 *op = '\0';
114         } else if ((op = strchr(mvalue1, '>'))) {
115                 iaction = GTFUNCTION;
116                 *op = '\0';
117                 if (*(op+1) == '=') {
118                         *++op = '\0';
119                         iaction = GTEFUNCTION;
120                 }
121         } else if ((op = strchr(mvalue1, '<'))) {
122                 iaction = LTFUNCTION;
123                 *op = '\0';
124                 if (*(op+1) == '=') {
125                         *++op = '\0';
126                         iaction = LTEFUNCTION;
127                 }
128         } else if ((op = strchr(mvalue1, '='))) {
129                 iaction = GTFUNCTION;
130                 *op = '\0';
131                 if (*(op+1) == '=') {
132                         *++op = '\0';
133                         iaction = EQFUNCTION;
134                 } else
135                         op = NULL;
136         } 
137         
138         if (op) 
139                 mvalue2 = op + 1;
140
141         /* detect wanted type of result */
142         mtype_of_result = argv[1];
143         if (mtype_of_result)
144         {
145                 if (!strcasecmp(mtype_of_result,"float") || !strcasecmp(mtype_of_result,"f"))
146                         type_of_result=FLOAT_RESULT;
147                 else if (!strcasecmp(mtype_of_result,"int") || !strcasecmp(mtype_of_result,"i"))
148                         type_of_result=INT_RESULT;
149                 else if (!strcasecmp(mtype_of_result,"hex") || !strcasecmp(mtype_of_result,"h"))
150                         type_of_result=HEX_RESULT;
151                 else if (!strcasecmp(mtype_of_result,"char") || !strcasecmp(mtype_of_result,"c"))
152                         type_of_result=CHAR_RESULT;
153                 else
154                 {
155                         ast_log(LOG_WARNING, "Unknown type of result requested '%s'.\n", mtype_of_result);
156                         return NULL;
157                 }
158         }
159         
160         if (!mvalue1 || !mvalue2) {
161                 ast_log(LOG_WARNING, "Supply all the parameters - just this once, please\n");
162                 return NULL;
163         }
164
165         if (sscanf(mvalue1, "%f", &fnum1) != 1) {
166                 ast_log(LOG_WARNING, "'%s' is not a valid number\n", mvalue1);
167                 return NULL;
168         }
169
170         if (sscanf(mvalue2, "%f", &fnum2) != 1) {
171                 ast_log(LOG_WARNING, "'%s' is not a valid number\n", mvalue2);
172                 return NULL;
173         }
174
175         switch (iaction) {
176         case ADDFUNCTION :
177                 ftmp = fnum1 + fnum2;
178                 break;
179         case DIVIDEFUNCTION :
180                 if (fnum2 <= 0)
181                         ftmp = 0; /* can't do a divide by 0 */
182                 else
183                         ftmp = (fnum1 / fnum2);
184                 break;
185         case MULTIPLYFUNCTION :
186                 ftmp = (fnum1 * fnum2);
187                 break;
188         case SUBTRACTFUNCTION :
189                 ftmp = (fnum1 - fnum2);
190                 break;
191         case MODULUSFUNCTION :
192         {
193                 int inum1 = fnum1;
194                 int inum2 = fnum2;
195                         
196                 ftmp = (inum1 % inum2);
197                 
198                 break;
199         }
200         case GTFUNCTION :
201                 ast_copy_string (user_result, (fnum1 > fnum2)?"TRUE":"FALSE", sizeof (user_result));
202                 break;
203         case LTFUNCTION :
204                 ast_copy_string (user_result, (fnum1 < fnum2)?"TRUE":"FALSE", sizeof (user_result));
205                 break;
206         case GTEFUNCTION :
207                 ast_copy_string (user_result, (fnum1 >= fnum2)?"TRUE":"FALSE", sizeof (user_result));
208                 break;
209         case LTEFUNCTION :
210                 ast_copy_string (user_result, (fnum1 <= fnum2)?"TRUE":"FALSE", sizeof (user_result));
211                 break;                                  
212         case EQFUNCTION :
213                 ast_copy_string (user_result, (fnum1 == fnum2)?"TRUE":"FALSE", sizeof (user_result));
214                 break;
215         default :
216                 ast_log(LOG_WARNING, "Something happened that neither of us should be proud of %d\n", iaction);
217                 return NULL;
218         }
219
220         if (iaction < GTFUNCTION || iaction > EQFUNCTION) {
221             if (type_of_result == FLOAT_RESULT)
222                     snprintf(user_result, sizeof(user_result), "%f", ftmp);
223             else if (type_of_result == INT_RESULT)
224                     snprintf(user_result, sizeof(user_result), "%i", (int) ftmp);
225             else if (type_of_result == HEX_RESULT)
226                 snprintf(user_result, sizeof(user_result), "%x", (unsigned int) ftmp);
227             else if (type_of_result == CHAR_RESULT)
228                 snprintf(user_result, sizeof(user_result), "%c", (unsigned char) ftmp);
229         }
230                 
231         ast_copy_string(buf, user_result, len);
232         
233         return buf;
234 }
235
236 #ifndef BUILTIN_FUNC
237 static
238 #endif /* BUILTIN_FUNC */
239 struct ast_custom_function math_function = {
240         .name = "MATH",
241         .synopsis = "Performs Mathematical Functions",
242         .syntax = "MATH(<number1><op><number 2>[,<type_of_result>])",
243         .desc = "Perform calculation on number 1 to number 2. Valid ops are: \n"
244             "    +,-,/,*,%,<,>,>=,<=,==\n"
245                 "and behave as their C equivalents.\n"
246                 "<type_of_result> - wanted type of result:\n"
247                 "       f, float - float(default)\n"
248                 "       i, int - integer,\n"
249                 "       h, hex - hex,\n"
250                 "       c, char - char\n"
251                 "Example: Set(i=${MATH(123%16,int)}) - sets var i=11",
252         .read = builtin_function_math
253 };