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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
/* vim: set sw=8: -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* fn-logical.c: Built in logical functions and functions registration
*
* Authors:
* Miguel de Icaza (miguel@gnu.org)
* Jukka-Pekka Iivonen (iivonen@iki.fi)
* Morten Welinder (terra@gnome.org)
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* 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, write to the Free Software
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gnumeric-config.h>
#include <gnumeric.h>
#include <func.h>
#include <parse-util.h>
#include <cell.h>
#include <expr.h>
#include <expr-impl.h>
#include <value.h>
#include <gnm-i18n.h>
#include <goffice/goffice.h>
#include <gnm-plugin.h>
GNM_PLUGIN_MODULE_HEADER;
/***************************************************************************/
static GnmFuncHelp const help_and[] = {
{ GNM_FUNC_HELP_NAME, F_("AND:logical conjunction")},
{ GNM_FUNC_HELP_ARG, F_("b0:logical value")},
{ GNM_FUNC_HELP_ARG, F_("b1:logical value")},
{ GNM_FUNC_HELP_DESCRIPTION, F_("AND calculates the logical conjunction of its arguments @{b0},@{b1},...") },
{ GNM_FUNC_HELP_NOTE, F_("If an argument is numerical, zero is considered FALSE and anything else TRUE.")},
{ GNM_FUNC_HELP_NOTE, F_("Strings and empty values are ignored.")},
{ GNM_FUNC_HELP_NOTE, F_("If no logical values are provided, then the error #VALUE! is returned.")},
{ GNM_FUNC_HELP_NOTE, F_("This function is strict: if any argument is an error, the result will be the first such error.")},
{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
{ GNM_FUNC_HELP_EXAMPLES, "=AND(TRUE,FALSE)" },
{ GNM_FUNC_HELP_EXAMPLES, "=AND(0,1)" },
{ GNM_FUNC_HELP_EXAMPLES, "=AND(FALSE,NA())" },
{ GNM_FUNC_HELP_SEEALSO, "OR,NOT,IF"},
{ GNM_FUNC_HELP_EXTREF, F_("wiki:en:Logical_conjunction") },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
callback_function_and (GnmEvalPos const *ep, GnmValue const *value, void *closure)
{
int *result = closure;
if (!VALUE_IS_STRING (value)) {
gboolean err;
*result = value_get_as_bool (value, &err) && *result;
if (err)
return value_new_error_VALUE (ep);
}
return NULL;
}
static GnmValue *
gnumeric_and (GnmFuncEvalInfo *ei, int argc, GnmExprConstPtr const *argv)
{
int result = -1;
/* Yes, AND is actually strict. */
GnmValue *v = function_iterate_argument_values
(ei->pos, callback_function_and, &result,
argc, argv, TRUE, CELL_ITER_IGNORE_BLANK);
if (v != NULL)
return v;
/* See if there was any value worth using */
if (result == -1)
return value_new_error_VALUE (ei->pos);
return value_new_bool (result);
}
/***************************************************************************/
static GnmFuncHelp const help_not[] = {
{ GNM_FUNC_HELP_NAME, F_("NOT:logical negation")},
{ GNM_FUNC_HELP_ARG, F_("b:logical value")},
{ GNM_FUNC_HELP_DESCRIPTION, F_("NOT calculates the logical negation of its argument.") },
{ GNM_FUNC_HELP_NOTE, F_("If the argument is numerical, zero is considered FALSE and anything else TRUE.")},
{ GNM_FUNC_HELP_NOTE, F_("Strings and empty values are ignored.")},
{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
{ GNM_FUNC_HELP_EXAMPLES, "=NOT(FALSE)" },
{ GNM_FUNC_HELP_EXAMPLES, "=NOT(1)" },
{ GNM_FUNC_HELP_SEEALSO, "AND,OR,IF"},
{ GNM_FUNC_HELP_EXTREF, F_("wiki:en:Negation") },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
gnumeric_not (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
{
gboolean err, val = value_get_as_bool (argv [0], &err);
if (err)
return value_new_error (ei->pos, _("Type Mismatch"));
return value_new_bool (!val);
}
/***************************************************************************/
static GnmFuncHelp const help_or[] = {
{ GNM_FUNC_HELP_NAME, F_("OR:logical disjunction")},
{ GNM_FUNC_HELP_ARG, F_("b0:logical value")},
{ GNM_FUNC_HELP_ARG, F_("b1:logical value")},
{ GNM_FUNC_HELP_DESCRIPTION, F_("OR calculates the logical disjunction of its arguments @{b0},@{b1},...") },
{ GNM_FUNC_HELP_NOTE, F_("If an argument is numerical, zero is considered FALSE and anything else TRUE.")},
{ GNM_FUNC_HELP_NOTE, F_("Strings and empty values are ignored.")},
{ GNM_FUNC_HELP_NOTE, F_("If no logical values are provided, then the error #VALUE! is returned.")},
{ GNM_FUNC_HELP_NOTE, F_("This function is strict: if any argument is an error, the result will be the first such error.")},
{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
{ GNM_FUNC_HELP_EXAMPLES, "=OR(TRUE,FALSE)" },
{ GNM_FUNC_HELP_EXAMPLES, "=OR(0,1)" },
{ GNM_FUNC_HELP_EXAMPLES, "=OR(TRUE,NA())" },
{ GNM_FUNC_HELP_SEEALSO, "AND,XOR,NOT,IF"},
{ GNM_FUNC_HELP_EXTREF, F_("wiki:en:Logical_disjunction") },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
callback_function_or (GnmEvalPos const *ep, GnmValue const *value, void *closure)
{
int *result = closure;
if (!VALUE_IS_STRING (value)) {
gboolean err;
*result = value_get_as_bool (value, &err) || *result == 1;
if (err)
return value_new_error_VALUE (ep);
}
return NULL;
}
static GnmValue *
gnumeric_or (GnmFuncEvalInfo *ei, int argc, GnmExprConstPtr const *argv)
{
int result = -1;
/* Yes, OR is actually strict. */
GnmValue *v = function_iterate_argument_values
(ei->pos, callback_function_or, &result,
argc, argv, TRUE, CELL_ITER_IGNORE_BLANK);
if (v != NULL)
return v;
/* See if there was any value worth using */
if (result == -1)
return value_new_error_VALUE (ei->pos);
return value_new_bool (result);
}
/***************************************************************************/
static GnmFuncHelp const help_xor[] = {
{ GNM_FUNC_HELP_NAME, F_("XOR:logical exclusive disjunction")},
{ GNM_FUNC_HELP_ARG, F_("b0:logical value")},
{ GNM_FUNC_HELP_ARG, F_("b1:logical value")},
{ GNM_FUNC_HELP_DESCRIPTION, F_("XOR calculates the logical exclusive disjunction of its arguments @{b0},@{b1},...") },
{ GNM_FUNC_HELP_NOTE, F_("If an argument is numerical, zero is considered FALSE and anything else TRUE.")},
{ GNM_FUNC_HELP_NOTE, F_("Strings and empty values are ignored.")},
{ GNM_FUNC_HELP_NOTE, F_("If no logical values are provided, then the error #VALUE! is returned.")},
{ GNM_FUNC_HELP_NOTE, F_("This function is strict: if any argument is an error, the result will be the first such error.")},
{ GNM_FUNC_HELP_EXAMPLES, "=XOR(TRUE,FALSE)" },
{ GNM_FUNC_HELP_EXAMPLES, "=XOR(0,1)" },
{ GNM_FUNC_HELP_EXAMPLES, "=XOR(TRUE,NA())" },
{ GNM_FUNC_HELP_SEEALSO, "OR,AND,NOT,IF"},
{ GNM_FUNC_HELP_EXTREF, F_("wiki:en:Exclusive_disjunction") },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
callback_function_xor (GnmEvalPos const *ep, GnmValue const *value, void *closure)
{
int *result = closure;
if (!VALUE_IS_STRING (value)) {
gboolean err;
*result = value_get_as_bool (value, &err) ^ (*result == 1);
if (err)
return value_new_error_VALUE (ep);
}
return NULL;
}
static GnmValue *
gnumeric_xor (GnmFuncEvalInfo *ei, int argc, GnmExprConstPtr const *argv)
{
int result = -1;
/* Yes, XOR is actually strict. */
GnmValue *v = function_iterate_argument_values
(ei->pos, callback_function_xor, &result,
argc, argv, TRUE, CELL_ITER_IGNORE_BLANK);
if (v != NULL)
return v;
/* See if there was any value worth using */
if (result == -1)
return value_new_error_VALUE (ei->pos);
return value_new_bool (result);
}
/***************************************************************************/
static GnmFuncHelp const help_iferror[] = {
{ GNM_FUNC_HELP_NAME, F_("IFERROR:test for error") },
{ GNM_FUNC_HELP_ARG, F_("x:value to test for error") },
{ GNM_FUNC_HELP_ARG, F_("y:alternate value") },
{ GNM_FUNC_HELP_DESCRIPTION, F_("This function returns the first value, unless that is an error, in which case it returns the second.") },
{ GNM_FUNC_HELP_EXAMPLES, "=IFERROR(1/0,14)" },
{ GNM_FUNC_HELP_SEEALSO, "IF,ISERROR" },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
gnumeric_iferror (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
{
return value_dup (VALUE_IS_ERROR (argv[0]) ? argv[1] : argv[0]);
}
/***************************************************************************/
static GnmFuncHelp const help_ifna[] = {
{ GNM_FUNC_HELP_NAME, F_("IFNA:test for #NA! error") },
{ GNM_FUNC_HELP_ARG, F_("x:value to test for #NA! error") },
{ GNM_FUNC_HELP_ARG, F_("y:alternate value") },
{ GNM_FUNC_HELP_DESCRIPTION, F_("This function returns the first value, unless that is #NA!, in which case it returns the second.") },
{ GNM_FUNC_HELP_EXAMPLES, "=IFNA(12,14)" },
{ GNM_FUNC_HELP_EXAMPLES, "=IFNA(1/0,14)" },
{ GNM_FUNC_HELP_EXAMPLES, "=IFNA(NA(),14)" },
{ GNM_FUNC_HELP_SEEALSO, "IF,ISERROR" },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
gnumeric_ifna (GnmFuncEvalInfo *ei, GnmValue const * const *argv)
{
return value_dup ((value_error_classify (argv[0]) == GNM_ERROR_NA) ? argv[1] : argv[0]);
}
/***************************************************************************/
static GnmFuncHelp const help_true[] = {
{ GNM_FUNC_HELP_NAME, F_("TRUE:the value TRUE") },
{ GNM_FUNC_HELP_DESCRIPTION, F_("TRUE returns the value TRUE.") },
{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
{ GNM_FUNC_HELP_EXAMPLES, "=TRUE()" },
{ GNM_FUNC_HELP_SEEALSO, "FALSE,IF" },
{ GNM_FUNC_HELP_EXTREF, F_("wiki:en:Logical_value") },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
gnumeric_true (GnmFuncEvalInfo *ei, GnmValue const * const *args)
{
return value_new_bool (TRUE);
}
/***************************************************************************/
static GnmFuncHelp const help_false[] = {
{ GNM_FUNC_HELP_NAME, F_("FALSE:the value FALSE") },
{ GNM_FUNC_HELP_DESCRIPTION, F_("FALSE returns the value FALSE.") },
{ GNM_FUNC_HELP_EXCEL, F_("This function is Excel compatible.") },
{ GNM_FUNC_HELP_EXAMPLES, "=FALSE()" },
{ GNM_FUNC_HELP_SEEALSO, "TRUE,IF" },
{ GNM_FUNC_HELP_EXTREF, F_("wiki:en:Logical_value") },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
gnumeric_false (GnmFuncEvalInfo *ei, GnmValue const * const *args)
{
return value_new_bool (FALSE);
}
/***************************************************************************/
GnmFuncDescriptor const logical_functions[] = {
{ "and", NULL, help_and, NULL,
gnumeric_and, NULL, NULL, NULL,
GNM_FUNC_SIMPLE + GNM_FUNC_AUTO_UNITLESS,
GNM_FUNC_IMPL_STATUS_COMPLETE, GNM_FUNC_TEST_STATUS_BASIC },
{ "or", NULL, help_or, NULL,
gnumeric_or, NULL, NULL, NULL,
GNM_FUNC_SIMPLE + GNM_FUNC_AUTO_UNITLESS,
GNM_FUNC_IMPL_STATUS_COMPLETE, GNM_FUNC_TEST_STATUS_BASIC },
{ "not", "b", help_not, gnumeric_not,
NULL, NULL, NULL, NULL,
GNM_FUNC_SIMPLE + GNM_FUNC_AUTO_UNITLESS,
GNM_FUNC_IMPL_STATUS_COMPLETE, GNM_FUNC_TEST_STATUS_BASIC },
{ "iferror", "EE", help_iferror,
gnumeric_iferror, NULL, NULL, NULL, NULL,
GNM_FUNC_SIMPLE, GNM_FUNC_IMPL_STATUS_COMPLETE, GNM_FUNC_TEST_STATUS_NO_TESTSUITE },
{ "ifna", "EE", help_ifna,
gnumeric_ifna, NULL, NULL, NULL, NULL,
GNM_FUNC_SIMPLE, GNM_FUNC_IMPL_STATUS_UNIQUE_TO_GNUMERIC,
GNM_FUNC_TEST_STATUS_NO_TESTSUITE},
{ "true", "", help_true, gnumeric_true,
NULL, NULL, NULL, NULL,
GNM_FUNC_SIMPLE + GNM_FUNC_AUTO_UNITLESS,
GNM_FUNC_IMPL_STATUS_COMPLETE, GNM_FUNC_TEST_STATUS_EXHAUSTIVE },
{ "false", "", help_false, gnumeric_false,
NULL, NULL, NULL, NULL,
GNM_FUNC_SIMPLE + GNM_FUNC_AUTO_UNITLESS,
GNM_FUNC_IMPL_STATUS_COMPLETE, GNM_FUNC_TEST_STATUS_EXHAUSTIVE },
{ "xor", NULL, help_xor, NULL,
gnumeric_xor, NULL, NULL, NULL,
GNM_FUNC_SIMPLE + GNM_FUNC_AUTO_UNITLESS,
GNM_FUNC_IMPL_STATUS_UNIQUE_TO_GNUMERIC, GNM_FUNC_TEST_STATUS_BASIC },
{NULL}
};
|
