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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
|
/**
* Value.cpp
*
* Implementation for the Value class, which wraps a PHP userspace
* value (a 'zval' in Zend's terminology) into a C++ object
*
* Reminder for the implementer:
*
* A 'zval' is an object that represents a _value_ in the PHP user space,
* and thus not a variable. A 'value' or 'zval' can be used by many
* different variables at the same time. The 'refcount' property of the
* zval holds the number of variables ($a, $b, $c, et cetera) that are
* all linked to the same value. With this system, PHP can implement copy
* on write behavior.
*
* Next to the refcount, the zval also holds a is_ref property, which is
* set to true if all variables linked to the value are references of each
* other. Thus is $a, $b and $c all point to the same variable, and is_ref
* is set to true, changing the value means that the $a, $b and $c value
* are all updated. If is_res was false, a change to $a would not mean a
* change to $b, and the zval should have been copied first.
*
*
* @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
* @copyright 2013 Copernica BV
*/
#include "includes.h"
/**
* Set up namespace
*/
namespace Php {
/**
* Constructor (value = NULL)
*/
Value::Value()
{
// create a null zval
MAKE_STD_ZVAL(_val);
ZVAL_NULL(_val);
}
/**
* Constructor for null ptr
*/
Value::Value(std::nullptr_t value)
{
// create a null zval
MAKE_STD_ZVAL(_val);
ZVAL_NULL(_val);
}
/**
* Constructor based on integer value
* @param value
*/
Value::Value(int16_t value)
{
// create an integer zval
MAKE_STD_ZVAL(_val);
ZVAL_LONG(_val, value);
}
/**
* Constructor based on integer value
* @param value
*/
Value::Value(int32_t value)
{
// create an integer zval
MAKE_STD_ZVAL(_val);
ZVAL_LONG(_val, value);
}
/**
* Constructor based on long value
* @param value
*/
Value::Value(int64_t value)
{
// create an integer zval
MAKE_STD_ZVAL(_val);
ZVAL_LONG(_val, value);
}
/**
* Constructor based on boolean value
* @param value
*/
Value::Value(bool value)
{
// create a boolean zval
MAKE_STD_ZVAL(_val);
ZVAL_BOOL(_val, value);
}
/**
* Constructor based on single character
* @param value
*/
Value::Value(char value)
{
// create a string zval
MAKE_STD_ZVAL(_val);
ZVAL_STRINGL(_val, &value, 1, 1);
}
/**
* Constructor based on string value
* @param value
*/
Value::Value(const std::string &value)
{
// create a string zval
MAKE_STD_ZVAL(_val);
ZVAL_STRINGL(_val, value.c_str(), value.size(), 1);
}
/**
* Constructor based on a byte array
* @param value
* @param size
*/
Value::Value(const char *value, int size)
{
// create a string zval
MAKE_STD_ZVAL(_val);
ZVAL_STRINGL(_val, value, size < 0 ? strlen(value) : size, 1);
}
/**
* Constructor based on decimal value
* @param value
*/
Value::Value(double value)
{
// create a double zval
MAKE_STD_ZVAL(_val);
ZVAL_DOUBLE(_val, value);
}
/**
* Wrap object around zval
* @param zval Value to wrap
* @param ref Force this to be a reference
*/
Value::Value(struct _zval_struct *val, bool ref)
{
// just copy the zval into this object
_val = val;
// if the variable is not already a reference, and it has more than one
// variable pointing to it, we should seperate it so that any changes
// we're going to make will not change the other variable
if (ref && Z_REFCOUNT_P(_val) > 1)
{
// separate the zval
SEPARATE_ZVAL_IF_NOT_REF(&_val);
}
// we see ourselves as reference too
Z_ADDREF_P(_val);
// we're ready if we do not have to force it as a reference
if (!ref || Z_ISREF_P(_val)) return;
// make this a reference
Z_SET_ISREF_P(_val);
}
/**
* Copy constructor
* @param value
*/
Value::Value(const Value &that)
{
// how many references does the other object has?
if (Z_REFCOUNT_P(that._val) > 1 && !Z_ISREF_P(that._val))
{
// there are already multiple variables linked to this value, and it
// is not a reference. this implies that we can not turn this variable
// into a reference, otherwise strange things could happen, we're going
// to create a new zval
ALLOC_ZVAL(_val);
INIT_PZVAL_COPY(_val, that._val);
zval_copy_ctor(_val);
}
else
{
// simply use the same zval
_val = that._val;
}
// the other object only has one variable using it, or it is already
// a variable by reference, we can safely add one more reference to it
// and make it a variable by reference if it was not already a ref
Z_ADDREF_P(_val);
// make reference
Z_SET_ISREF_P(_val);
}
/**
* Move constructor
* @param value
*/
Value::Value(Value &&that)
{
// just copy the zval
_val = that._val;
// clear the other object
that._val = nullptr;
}
/**
* Destructor
*/
Value::~Value()
{
// ignore if moved
if (!_val) return;
// if there were two references or less, we're going to remove a reference
// and only one reference will remain, the object will then impossible be
// a reference
if (Z_REFCOUNT_P(_val) <= 2) Z_UNSET_ISREF_P(_val);
// destruct the zval (this function will decrement the reference counter,
// and only destruct if there are no other references left)
zval_ptr_dtor(&_val);
}
/**
* Move operator
* @param value
* @return Value
*/
Value &Value::operator=(Value &&value)
{
// skip self assignment
if (this == &value) return *this;
// is the object a reference?
if (Z_ISREF_P(_val))
{
// @todo difference if the other object is a reference or not?
// the current object is a reference, this means that we should
// keep the zval object, and copy the other value into it, get
// the current refcount
int refcount = Z_REFCOUNT_P(_val);
// clean up the current zval (but keep the zval structure)
zval_dtor(_val);
// make the copy
*_val = *value._val;
// restore reference and refcount setting
Z_SET_ISREF_TO_P(_val, true);
Z_SET_REFCOUNT_P(_val, refcount);
// how many references did the old variable have?
if (Z_REFCOUNT_P(value._val) > 1)
{
// the other object already had multiple references, this
// implies that many other PHP variables are also referring
// to it, and we still need to store its contents, with one
// reference less
Z_DELREF_P(value._val);
// and we need to run the copy constructor on the current
// value, because we're making a deep copy
zval_copy_ctor(_val);
}
else
{
// the last and only reference to the other object was
// removed, we no longer need it
FREE_ZVAL(value._val);
// the other object is no longer valid
value._val = nullptr;
}
}
else
{
// destruct the zval (this function will decrement the reference counter,
// and only destruct if there are no other references left)
zval_ptr_dtor(&_val);
// just copy the zval completely
_val = value._val;
// the other object is no longer valid
value._val = nullptr;
}
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(const Value &value)
{
// skip self assignment
if (this == &value) return *this;
// is the object a reference?
if (Z_ISREF_P(_val))
{
// the current object is a reference, this means that we should
// keep the zval object, and copy the other value into it, get
// the current refcount
int refcount = Z_REFCOUNT_P(_val);
// clean up the current zval (but keep the zval structure)
zval_dtor(_val);
// make the copy
*_val = *value._val;
zval_copy_ctor(_val);
// restore refcount and reference setting
Z_SET_ISREF_TO_P(_val, true);
Z_SET_REFCOUNT_P(_val, refcount);
}
else
{
// destruct the zval (this function will decrement the reference counter,
// and only destruct if there are no other references left)
zval_ptr_dtor(&_val);
// just copy the zval, and the refcounter
_val = value._val;
// and we have one more reference
Z_ADDREF_P(_val);
}
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(int16_t value)
{
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// deallocate current zval (without cleaning the zval structure)
zval_dtor(_val);
// set new value
ZVAL_LONG(_val, value);
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(int32_t value)
{
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// deallocate current zval (without cleaning the zval structure)
zval_dtor(_val);
// set new value
ZVAL_LONG(_val, value);
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(int64_t value)
{
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// deallocate current zval (without cleaning the zval structure)
zval_dtor(_val);
// set new value
ZVAL_LONG(_val, value);
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(bool value)
{
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// deallocate current zval (without cleaning the zval structure)
zval_dtor(_val);
// set new value
ZVAL_BOOL(_val, value);
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(char value)
{
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// deallocate current zval (without cleaning the zval structure)
zval_dtor(_val);
// set new value
ZVAL_STRINGL(_val, &value, 1, 1);
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(const std::string &value)
{
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// deallocate current zval (without cleaning the zval structure)
zval_dtor(_val);
// set new value
ZVAL_STRINGL(_val, value.c_str(), value.size(), 1);
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(const char *value)
{
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// deallocate current zval (without cleaning the zval structure)
zval_dtor(_val);
// set new value
ZVAL_STRING(_val, value, 1);
// update the object
return validate();
}
/**
* Assignment operator
* @param value
* @return Value
*/
Value &Value::operator=(double value)
{
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// deallocate current zval (without cleaning the zval structure)
zval_dtor(_val);
// set new value
ZVAL_DOUBLE(_val, value);
// update the object
return validate();
}
/**
* Add a value to the object
* @param value
* @return Value
*/
Value &Value::operator+=(const Value &value) { return Arithmetic<std::plus>(this).assign(value); }
Value &Value::operator+=(int16_t value) { return Arithmetic<std::plus>(this).assign(value); }
Value &Value::operator+=(int32_t value) { return Arithmetic<std::plus>(this).assign(value); }
Value &Value::operator+=(int64_t value) { return Arithmetic<std::plus>(this).assign(value); }
Value &Value::operator+=(bool value) { return Arithmetic<std::plus>(this).assign(value); }
Value &Value::operator+=(char value) { return Arithmetic<std::plus>(this).assign(value); }
Value &Value::operator+=(const std::string &value) { return Arithmetic<std::plus>(this).assign(value); }
Value &Value::operator+=(const char *value) { return Arithmetic<std::plus>(this).assign(value); }
Value &Value::operator+=(double value) { return Arithmetic<std::plus>(this).assign(value); }
/**
* Subtract a value from the object
* @param value
* @return Value
*/
Value &Value::operator-=(const Value &value) { return Arithmetic<std::minus>(this).assign(value); }
Value &Value::operator-=(int16_t value) { return Arithmetic<std::minus>(this).assign(value); }
Value &Value::operator-=(int32_t value) { return Arithmetic<std::minus>(this).assign(value); }
Value &Value::operator-=(int64_t value) { return Arithmetic<std::minus>(this).assign(value); }
Value &Value::operator-=(bool value) { return Arithmetic<std::minus>(this).assign(value); }
Value &Value::operator-=(char value) { return Arithmetic<std::minus>(this).assign(value); }
Value &Value::operator-=(const std::string &value) { return Arithmetic<std::minus>(this).assign(value); }
Value &Value::operator-=(const char *value) { return Arithmetic<std::minus>(this).assign(value); }
Value &Value::operator-=(double value) { return Arithmetic<std::minus>(this).assign(value); }
/**
* Multiply the object with a certain value
* @param value
* @return Value
*/
Value &Value::operator*=(const Value &value) { return Arithmetic<std::multiplies>(this).assign(value); }
Value &Value::operator*=(int16_t value) { return Arithmetic<std::multiplies>(this).assign(value); }
Value &Value::operator*=(int32_t value) { return Arithmetic<std::multiplies>(this).assign(value); }
Value &Value::operator*=(int64_t value) { return Arithmetic<std::multiplies>(this).assign(value); }
Value &Value::operator*=(bool value) { return Arithmetic<std::multiplies>(this).assign(value); }
Value &Value::operator*=(char value) { return Arithmetic<std::multiplies>(this).assign(value); }
Value &Value::operator*=(const std::string &value) { return Arithmetic<std::multiplies>(this).assign(value); }
Value &Value::operator*=(const char *value) { return Arithmetic<std::multiplies>(this).assign(value); }
Value &Value::operator*=(double value) { return Arithmetic<std::multiplies>(this).assign(value); }
/**
* Divide the object with a certain value
* @param value
* @return Value
*/
Value &Value::operator/=(const Value &value) { return Arithmetic<std::divides>(this).assign(value); }
Value &Value::operator/=(int16_t value) { return Arithmetic<std::divides>(this).assign(value); }
Value &Value::operator/=(int32_t value) { return Arithmetic<std::divides>(this).assign(value); }
Value &Value::operator/=(int64_t value) { return Arithmetic<std::divides>(this).assign(value); }
Value &Value::operator/=(bool value) { return Arithmetic<std::divides>(this).assign(value); }
Value &Value::operator/=(char value) { return Arithmetic<std::divides>(this).assign(value); }
Value &Value::operator/=(const std::string &value) { return Arithmetic<std::divides>(this).assign(value); }
Value &Value::operator/=(const char *value) { return Arithmetic<std::divides>(this).assign(value); }
Value &Value::operator/=(double value) { return Arithmetic<std::divides>(this).assign(value); }
/**
* Divide the object with a certain value and get the rest
* Note that this does not use the Arithmetic object, because no conversion between floats is necessary
* @param value
* @return Value
*/
Value &Value::operator%=(const Value &value) { return operator=(numericValue() % value.numericValue()); }
Value &Value::operator%=(int16_t value) { return operator=(numericValue() % value); }
Value &Value::operator%=(int32_t value) { return operator=(numericValue() % value); }
Value &Value::operator%=(int64_t value) { return operator=(numericValue() % value); }
Value &Value::operator%=(bool value) { return operator=(numericValue() % value); }
Value &Value::operator%=(char value) { return operator=(numericValue() % value); }
Value &Value::operator%=(const std::string &value) { return operator=(numericValue() % atoi(value.c_str())); }
Value &Value::operator%=(const char *value) { return operator=(numericValue() % atoi(value)); }
Value &Value::operator%=(double value) { return operator=(numericValue() % (int)value); }
/**
* Assignment operator
* @param value
* @return Value
*/
Value Value::operator+(const Value &value) { return Arithmetic<std::plus>(this).apply(value); }
Value Value::operator+(int16_t value) { return Arithmetic<std::plus>(this).apply(value); }
Value Value::operator+(int32_t value) { return Arithmetic<std::plus>(this).apply(value); }
Value Value::operator+(int64_t value) { return Arithmetic<std::plus>(this).apply(value); }
Value Value::operator+(bool value) { return Arithmetic<std::plus>(this).apply(value); }
Value Value::operator+(char value) { return Arithmetic<std::plus>(this).apply(value); }
Value Value::operator+(const std::string &value) { return Arithmetic<std::plus>(this).apply(value); }
Value Value::operator+(const char *value) { return Arithmetic<std::plus>(this).apply(value); }
Value Value::operator+(double value) { return Arithmetic<std::plus>(this).apply(value); }
/**
* Subtraction operator
* @param value
* @return Value
*/
Value Value::operator-(const Value &value) { return Arithmetic<std::minus>(this).apply(value); }
Value Value::operator-(int16_t value) { return Arithmetic<std::minus>(this).apply(value); }
Value Value::operator-(int32_t value) { return Arithmetic<std::minus>(this).apply(value); }
Value Value::operator-(int64_t value) { return Arithmetic<std::minus>(this).apply(value); }
Value Value::operator-(bool value) { return Arithmetic<std::minus>(this).apply(value); }
Value Value::operator-(char value) { return Arithmetic<std::minus>(this).apply(value); }
Value Value::operator-(const std::string &value) { return Arithmetic<std::minus>(this).apply(value); }
Value Value::operator-(const char *value) { return Arithmetic<std::minus>(this).apply(value); }
Value Value::operator-(double value) { return Arithmetic<std::minus>(this).apply(value); }
/**
* Multiplication operator
* @param value
* @return Value
*/
Value Value::operator*(const Value &value) { return Arithmetic<std::multiplies>(this).apply(value); }
Value Value::operator*(int16_t value) { return Arithmetic<std::multiplies>(this).apply(value); }
Value Value::operator*(int32_t value) { return Arithmetic<std::multiplies>(this).apply(value); }
Value Value::operator*(int64_t value) { return Arithmetic<std::multiplies>(this).apply(value); }
Value Value::operator*(bool value) { return Arithmetic<std::multiplies>(this).apply(value); }
Value Value::operator*(char value) { return Arithmetic<std::multiplies>(this).apply(value); }
Value Value::operator*(const std::string &value) { return Arithmetic<std::multiplies>(this).apply(value); }
Value Value::operator*(const char *value) { return Arithmetic<std::multiplies>(this).apply(value); }
Value Value::operator*(double value) { return Arithmetic<std::multiplies>(this).apply(value); }
/**
* Division operator
* @param value
* @return Value
*/
Value Value::operator/(const Value &value) { return Arithmetic<std::divides>(this).apply(value); }
Value Value::operator/(int16_t value) { return Arithmetic<std::divides>(this).apply(value); }
Value Value::operator/(int32_t value) { return Arithmetic<std::divides>(this).apply(value); }
Value Value::operator/(int64_t value) { return Arithmetic<std::divides>(this).apply(value); }
Value Value::operator/(bool value) { return Arithmetic<std::divides>(this).apply(value); }
Value Value::operator/(char value) { return Arithmetic<std::divides>(this).apply(value); }
Value Value::operator/(const std::string &value) { return Arithmetic<std::divides>(this).apply(value); }
Value Value::operator/(const char *value) { return Arithmetic<std::divides>(this).apply(value); }
Value Value::operator/(double value) { return Arithmetic<std::divides>(this).apply(value); }
/**
* Modulus operator
* @param value
* @return Value
*/
Value Value::operator%(const Value &value) { return Value(numericValue() % value.numericValue()); }
Value Value::operator%(int16_t value) { return Value(numericValue() % value); }
Value Value::operator%(int32_t value) { return Value(numericValue() % value); }
Value Value::operator%(int64_t value) { return Value(numericValue() % value); }
Value Value::operator%(bool value) { return Value(numericValue() % value); }
Value Value::operator%(char value) { return Value(numericValue() % value); }
Value Value::operator%(const std::string &value) { return Value(numericValue() % atoi(value.c_str())); }
Value Value::operator%(const char *value) { return Value(numericValue() % atoi(value)); }
Value Value::operator%(double value) { return Value(numericValue() % (int)value); }
/**
* Call the function in PHP
* We have ten variants of this function, depending on the number of parameters
* This call operator is only useful when the variable represents a callable
* @param p0-p10 Parameters of the function to be called.
* @return Value
*/
Value Value::operator()()
{
// call with zero parameters
return exec(0, NULL);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @return Value
*/
Value Value::operator()(Value p0)
{
// array of parameters
zval **params[1] = { &p0._val };
// call the function
return exec(1, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1)
{
// array of parameters
zval **params[2] = { &p0._val, &p1._val };
// call the function
return exec(2, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @param p2 The third parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1, Value p2)
{
// array of parameters
zval **params[3] = { &p0._val, &p1._val, &p2._val };
// call the function
return exec(3, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @param p2 The third parameter
* @param p3 The fourth parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1, Value p2, Value p3)
{
// array of parameters
zval **params[4] = { &p0._val, &p1._val, &p2._val, &p3._val };
// call the function
return exec(4, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @param p2 The third parameter
* @param p3 The fourth parameter
* @param p4 The fifth parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1, Value p2, Value p3, Value p4)
{
// array of parameters
zval **params[5] = { &p0._val, &p1._val, &p2._val, &p3._val, &p4._val };
// call the function
return exec(5, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @param p2 The third parameter
* @param p3 The fourth parameter
* @param p4 The fifth parameter
* @param p5 The sixth parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1, Value p2, Value p3, Value p4, Value p5)
{
// array of parameters
zval **params[6] = { &p0._val, &p1._val, &p2._val, &p3._val, &p4._val, &p5._val };
// call the function
return exec(6, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @param p2 The third parameter
* @param p3 The fourth parameter
* @param p4 The fifth parameter
* @param p5 The sixth parameter
* @param p6 The seventh parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1, Value p2, Value p3, Value p4, Value p5, Value p6)
{
// array of parameters
zval **params[7] = { &p0._val, &p1._val, &p2._val, &p3._val, &p4._val, &p5._val, &p6._val };
// call the function
return exec(7, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @param p2 The third parameter
* @param p3 The fourth parameter
* @param p4 The fifth parameter
* @param p5 The sixth parameter
* @param p6 The seventh parameter
* @param p7 The eighth parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1, Value p2, Value p3, Value p4, Value p5, Value p6, Value p7)
{
// array of parameters
zval **params[8] = { &p0._val, &p1._val, &p2._val, &p3._val, &p4._val, &p5._val, &p6._val, &p7._val };
// call the function
return exec(8, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @param p2 The third parameter
* @param p3 The fourth parameter
* @param p4 The fifth parameter
* @param p5 The sixth parameter
* @param p6 The seventh parameter
* @param p7 The eighth parameter
* @param p8 The ninth parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1, Value p2, Value p3, Value p4, Value p5, Value p6, Value p7, Value p8)
{
// array of parameters
zval **params[9] = { &p0._val, &p1._val, &p2._val, &p3._val, &p4._val, &p5._val, &p6._val, &p7._val, &p8._val };
// call the function
return exec(9, params);
}
/**
* Call the function - if the variable holds a callable thing
* @param p0 The first parameter
* @param p1 The second parameter
* @param p2 The third parameter
* @param p3 The fourth parameter
* @param p4 The fifth parameter
* @param p5 The sixth parameter
* @param p6 The seventh parameter
* @param p7 The eighth parameter
* @param p8 The ninth parameter
* @param p9 The tenth parameter
* @return Value
*/
Value Value::operator()(Value p0, Value p1, Value p2, Value p3, Value p4, Value p5, Value p6, Value p7, Value p8, Value p9)
{
// array of parameters
zval **params[10] = { &p0._val, &p1._val, &p2._val, &p3._val, &p4._val, &p5._val, &p6._val, &p7._val, &p8._val, &p9._val};
// call the function
return exec(10, params);
}
/**
* Call function with a number of parameters
* @param argc Number of parameters
* @param argv The parameters
* @return Value
*/
Value Value::exec(int argc, zval ***params)
{
// the return zval
zval *retval = nullptr;
// call the function
if (call_user_function_ex(CG(function_table), NULL, _val, &retval, argc, params, 1, NULL) != SUCCESS) return nullptr;
// was a value returned?
if (retval) return Value(retval);
// no value was returned, return NULL
return nullptr;
}
/**
* The type of object
* @return Type
*/
Type Value::type() const
{
// return regular type
return (Type)Z_TYPE_P(_val);
}
/**
* Change the internal type
* @param type
* @return Value
*/
Value &Value::setType(Type type)
{
// skip if nothing changes
if (this->type() == type) return *this;
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// run the conversion
switch (type) {
case nullType: convert_to_null(_val); break;
case numericType: convert_to_long(_val); break;
case floatType: convert_to_double(_val); break;
case boolType: convert_to_boolean(_val); break;
case arrayType: convert_to_array(_val); break;
case objectType: convert_to_object(_val); break;
case stringType: convert_to_string(_val); break;
}
// done
return *this;
}
/**
* Check if the variable holds something that is callable
* @return bool
*/
bool Value::isCallable() const
{
// we can not rely on the type, because strings can be callable as well
return zend_is_callable(_val, 0, NULL);
}
/**
* Make a clone of the type
* @return Value
*/
Value Value::clone() const
{
// the zval that will hold the copy
zval *copy;
// allocate memory
ALLOC_ZVAL(copy);
// copy the data
INIT_PZVAL_COPY(copy, _val);
// run the copy constructor to ensure that everything gets copied
zval_copy_ctor(copy);
// done
return Value(copy);
}
/**
* Clone the zval to a different type
* @param type
* @return Value
*/
Value Value::clone(Type type) const
{
// regular clone if nothing changes
if (this->type() == type) return clone();
// make a clone
return clone().setType(type);
}
/**
* Retrieve the value as integer
* @return long
*/
long Value::numericValue() const
{
// already a long?
if (isNumeric()) return Z_LVAL_P(_val);
// make a clone
return clone(numericType).numericValue();
}
/**
* Retrieve the value as boolean
* @return bool
*/
bool Value::boolValue() const
{
// already a bool?
if (isBool()) return Z_BVAL_P(_val);
// make a clone
return clone(boolType).boolValue();
}
/**
* Retrieve the value as string
* @return string
*/
std::string Value::stringValue() const
{
// already a string?
if (isString()) return std::string(Z_STRVAL_P(_val), Z_STRLEN_P(_val));
// make a clone
return clone(stringType).stringValue();
}
/**
* Retrieve raw string value
* @return const char *
*/
const char *Value::rawValue() const
{
// already a string?
if (isString()) return Z_STRVAL_P(_val);
// make a clone
return clone(stringType).rawValue();
}
/**
* Retrieve the value as decimal
* @return double
*/
double Value::floatValue() const
{
// already a double
if (isFloat()) return Z_DVAL_P(_val);
// make a clone
return clone(floatType).floatValue();
}
/**
* The number of members in case of an array or object
* @return int
*/
int Value::size() const
{
// is it an array?
if (isArray())
{
// get the number of elements
return zend_hash_num_elements(Z_ARRVAL_P(_val));
}
// or an object?
else if (isObject())
{
// the count_elements member function should be defined
if (!Z_OBJ_HT_P(_val)->count_elements) return 0;
// create a variable to hold the result
long result;
// call the function
return Z_OBJ_HT_P(_val)->count_elements(_val, &result) == SUCCESS ? result : 0;
}
// not an array, return string size if this is a string
else if (isString())
{
// get string size
return Z_STRLEN_P(_val);
}
// in all other situations, we convert the variable to a string
else
{
// make a copy
Value copy(*this);
// convert the copy to a string
copy.setType(stringType);
// return the string size
return copy.size();
}
}
/**
* Does the array contain a certain index?
* @param index
* @return bool
*/
bool Value::contains(int index) const
{
// must be an array
if (!isArray()) return false;
// unused variable
zval **result;
// check if this index is already in the array
return zend_hash_index_find(Z_ARRVAL_P(_val), index, (void**)&result) != FAILURE;
}
/**
* Does the array contain a certain key
* @param key
* @param size
* @return boolean
*/
bool Value::contains(const char *key, int size) const
{
// calculate size
if (size < 0) size = strlen(key);
// deal with arrays
if (isArray())
{
// unused variable
zval **result;
// check if index is already in the array
return zend_hash_find(Z_ARRVAL_P(_val), key, size+1, (void **)&result) != FAILURE;
}
else if (isObject())
{
// @todo implementation
return false;
}
else
{
// scalar variable
return false;
}
}
/**
* Get access to a certain array member
* @param index
* @return Value
*/
Value Value::get(int index) const
{
// must be an array
if (!isArray()) return Value();
// zval to retrieve
zval **result;
// check if index is in the array
if (zend_hash_index_find(Z_ARRVAL_P(_val), index, (void **)&result) == FAILURE) return Value();
// wrap the value
return Value(*result);
}
/**
* Get access to a certain assoc member
* @param key
* @param size
* @return Value
*/
Value Value::get(const char *key, int size) const
{
// must be an array
if (!isArray() && !isObject()) return Value();
// calculate size
if (size < 0) size = strlen(key);
// are we in an object or an array?
if (isArray())
{
// the result value
zval **result;
// check if this index is already in the array, otherwise we return NULL
if (zend_hash_find(Z_ARRVAL_P(_val), key, size + 1, (void **)&result) == FAILURE) return Value();
// wrap the value
return Value(*result);
}
else
{
// @todo implementation for objects
return Value();
}
}
/**
* Set a certain property
* @param index
* @param value
* @return Value
*/
const Value &Value::set(int index, const Value &value)
{
// the current value
zval **current;
// check if this index is already in the array, otherwise we return NULL
if (isArray() && zend_hash_index_find(Z_ARRVAL_P(_val), index, (void **)¤t) != FAILURE)
{
// skip if nothing is going to change
if (value._val == *current) return value;
}
// must be an array
setType(arrayType);
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// add the value (this will decrement refcount on any current variable)
add_index_zval(_val, index, value._val);
// the variable has one more reference (the array entry)
Z_ADDREF_P(value._val);
// object should stay valid
validate();
// done
return value;
}
/**
* Set a certain property
* @param key
* @param size
* @param value
* @return Value
*/
const Value &Value::set(const char *key, int size, const Value &value)
{
// the current value
zval **current;
// check if this index is already in the array, otherwise we return NULL
if (isArray() && zend_hash_find(Z_ARRVAL_P(_val), key, size + 1, (void **)¤t) != FAILURE)
{
// skip if nothing is going to change
if (value._val == *current) return value;
}
// must be an array
setType(arrayType);
// if this is not a reference variable, we should detach it to implement copy on write
SEPARATE_ZVAL_IF_NOT_REF(&_val);
// add the value (this will reduce the refcount of the current value)
add_assoc_zval_ex(_val, key, size+1, value._val);
// the variable has one more reference (the array entry)
Z_ADDREF_P(value._val);
// object should stay valid
validate();
// done
return value;
}
/**
* Array access operator
* This can be used for accessing arrays
* @param index
* @return HashMember
*/
HashMember<int> Value::operator[](int index)
{
return HashMember<int>(this, index);
}
/**
* Array access operato
* This can be used for accessing associative arrays
* @param key
* @return HashMember
*/
HashMember<std::string> Value::operator[](const std::string &key)
{
return HashMember<std::string>(this, key);
}
/**
* Array access operator
* This can be used for accessing associative arrays
* @param key
* @return HashMember
*/
HashMember<std::string> Value::operator[](const char *key)
{
return HashMember<std::string>(this, key);
}
/**
* Custom output stream operator
* @param stream
* @param value
* @return ostream
*/
std::ostream &operator<<(std::ostream &stream, const Value &value)
{
return stream << value.stringValue();
}
/**
* End of namespace
*/
}
|