File: gen_java.py

package info (click to toggle)
visp 3.6.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 119,296 kB
  • sloc: cpp: 500,914; ansic: 52,904; xml: 22,642; python: 7,365; java: 4,247; sh: 482; makefile: 237; objc: 145
file content (1446 lines) | stat: -rwxr-xr-x 63,656 bytes parent folder | download
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
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
#!/usr/bin/env python

import sys, re, os.path, errno, fnmatch
import json
import logging
from shutil import copyfile
from pprint import pformat
from string import Template

if sys.version_info[0] >= 3:
    from io import StringIO
else:
    from cStringIO import StringIO

SCRIPT_DIR = os.path.dirname(os.path.abspath(__file__))

# list of modules + files remap
config = None
ROOT_DIR = None
FILES_REMAP = {}
def checkFileRemap(path):
    path = os.path.realpath(path)
    if path in FILES_REMAP:
        return FILES_REMAP[path]
    assert path[-3:] != '.in', path
    return path


total_files = 0
updated_files = 0

module_imports = []
module_j_code = None
module_jn_code = None

# list of class names, which should be skipped by wrapper generator
# the list is loaded from misc/java/gen_dict.json defined for the module and its dependencies
class_ignore_list = []

# list of constant names, which should be skipped by wrapper generator
# ignored constants can be defined using regular expressions
const_ignore_list = []

# list of private constants
const_private_list = []

# { Module : { public : [[name, val],...], private : [[]...] } }
missing_consts = {}

# c_type    : { java/jni correspondence }
# Complex data types are configured for each module using misc/java/gen_dict.json

type_dict = {
    # "simple"  : { j_type : "?", jn_type : "?", jni_type : "?", suffix : "?" },
    "": {"j_type": "", "jn_type": "long", "jni_type": "jlong"},  # c-tor ret_type
    "void": {"j_type": "void", "jn_type": "void", "jni_type": "void"},
    "env": {"j_type": "", "jn_type": "", "jni_type": "JNIEnv*"},
    "cls": {"j_type": "", "jn_type": "", "jni_type": "jclass"},
    "bool": {"j_type": "boolean", "jn_type": "boolean", "jni_type": "jboolean", "suffix": "Z"},
    "char": {"j_type": "char", "jn_type": "char", "jni_type": "jchar", "suffix": "C"},
    "int": {"j_type": "int", "jn_type": "int", "jni_type": "jint", "suffix": "I"},
    "long": {"j_type": "int", "jn_type": "int", "jni_type": "jint", "suffix": "I"},
    "float": {"j_type": "float", "jn_type": "float", "jni_type": "jfloat", "suffix": "F"},
    "double": {"j_type": "double", "jn_type": "double", "jni_type": "jdouble", "suffix": "D"},
    "size_t": {"j_type": "long", "jn_type": "long", "jni_type": "jlong", "suffix": "J"},
    "__int64": {"j_type": "long", "jn_type": "long", "jni_type": "jlong", "suffix": "J"},
    "int64": {"j_type": "long", "jn_type": "long", "jni_type": "jlong", "suffix": "J"},
    "double[]": {"j_type": "double[]", "jn_type": "double[]", "jni_type": "jdoubleArray", "suffix": "_3D"}
}

# { class : { func : {j_code, jn_code, cpp_code} } }
ManualFuncs = {}
ToStringSupport = []

# { class : { func : { arg_name : {"ctype" : ctype, "attrib" : [attrib]} } } }
func_arg_fix = {}

'''
    # INFO: Needs no comments :D
'''


def read_contents(fname):
    with open(fname, 'r') as f:
        data = f.read()
    return data


'''
    # INFO: Create dir or a file if not created already
'''


def mkdir_p(path):
    ''' mkdir -p '''
    try:
        os.makedirs(path)
    except OSError as exc:
        if exc.errno == errno.EEXIST and os.path.isdir(path):
            pass
        else:
            raise


def camelCase(s):
    '''
        turns vpHomoMatrix to VpHomoMatrix
    '''
    if len(s) > 0:
        return s[0].upper() + s[1:]
    else:
        return s


def reverseCamelCase(s):
    '''
        turns VpHomoMatrix to vpHomoMatrix
    '''
    if len(s) > 0:
        return s[0].lower() + s[1:]
    else:
        return s


T_JAVA_START_INHERITED = read_contents(os.path.join(SCRIPT_DIR, 'templates/java_class_inherited.prolog'))
T_JAVA_START_ORPHAN = read_contents(os.path.join(SCRIPT_DIR, 'templates/java_class.prolog'))
T_JAVA_START_MODULE = read_contents(os.path.join(SCRIPT_DIR, 'templates/java_module.prolog'))
T_CPP_MODULE = Template(read_contents(os.path.join(SCRIPT_DIR, 'templates/cpp_module.template')))


class GeneralInfo():
    def __init__(self, type, decl, namespaces):
        self.namespace, self.classpath, self.classname, self.name = self.parseName(decl[0], namespaces)

        # parse doxygen comments
        self.params = {}
        self.annotation = []
        if type == "class":
            docstring = "// C++: class " + self.name + "\n//javadoc: " + self.name
        else:
            docstring = ""
        if len(decl) > 5 and decl[5]:
            # logging.info('docstring: %s', decl[5])
            if re.search("(@|\\\\)deprecated", decl[5]):
                self.annotation.append("@Deprecated")

        self.docstring = docstring

    def parseName(self, name, namespaces):
        '''
        input: full name and available namespaces
        returns: (namespace, classpath, classname, name)
        '''
        name = name[name.find(" ") + 1:].strip()  # remove struct/class/const prefix
        spaceName = ""
        localName = name  # <classes>.<name>

        if name.count('.') == 1 and len(namespaces) == 1:
            namespaces = list(namespaces)
            pieces = name.split(".")
            return namespaces[0], ".".join(namespaces[:-1]), camelCase(pieces[0]), pieces[1]

        for namespace in sorted(namespaces, key=len, reverse=True):
            if name.startswith(namespace + "."):
                spaceName = namespace
                localName = name.replace(namespace + ".", "")
                break
        pieces = localName.split(".")
        if len(pieces) > 2:  # <class>.<class>.<class>.<name>
            return spaceName, ".".join(pieces[:-1]), pieces[-2], pieces[-1]
        elif len(pieces) == 2:  # <class>.<name>
            return spaceName, pieces[0], pieces[0], pieces[1]
        elif len(pieces) == 1:  # <name>
            return spaceName, "", "", pieces[0]
        else:
            return spaceName, "", ""  # error?!

    def fullName(self, isCPP=False):
        result = ".".join([self.fullClass(), reverseCamelCase(self.name)])
        return result if not isCPP else result.replace(".", "::")

    def fullClass(self, isCPP=False):
        result = ".".join([f for f in [self.namespace] + self.classpath.split(".") if len(f) > 0])
        return result if not isCPP else result.replace(".", "::")


class ConstInfo(GeneralInfo):
    def __init__(self, decl, addedManually=False, namespaces=[]):
        GeneralInfo.__init__(self, "const", decl, namespaces)
        self.cname = self.name.replace(".", "::")
        self.value = decl[1]
        self.addedManually = addedManually

    def __repr__(self):
        return Template("CONST $name=$value$manual").substitute(name=self.name,
                                                                value=self.value,
                                                                manual="(manual)" if self.addedManually else "")

    def isIgnored(self):
        for c in const_ignore_list:
            if re.match(c, self.name):
                return True
        return False


class ClassPropInfo():
    def __init__(self, decl):  # [f_ctype, f_name, '', '/RW']
        self.ctype = decl[0]
        self.name = decl[1]
        self.rw = "/RW" in decl[3]

    def __repr__(self):
        return Template("PROP $ctype $name").substitute(ctype=self.ctype, name=self.name)


class ClassInfo(GeneralInfo):
    def __init__(self, decl, namespaces=[]):  # [ 'class/struct cname', ': base', [modlist] ]
        GeneralInfo.__init__(self, "class", decl, namespaces)
        self.cname = self.name.replace(".", "::")
        self.methods = []
        self.methods_suffixes = {}
        self.consts = []  # using a list to save the occurrence order
        self.private_consts = []  # TODO: ViSP wont need these
        self.imports = set()
        self.props = []
        self.jname = self.name
        self.smart = None  # True if class stores Ptr<T>* instead of T* in nativeObj field
        self.j_code = None  # java code stream
        self.jn_code = None  # jni code stream
        self.cpp_code = None  # cpp code stream
        for m in decl[2]:
            if m.startswith("="):
                self.jname = m[1:]
        self.base = ''
        if decl[1]:
            # self.base = re.sub(r"\b"+self.jname+r"\b", "", decl[1].replace(":", "")).strip()
            self.base = re.sub(r"^.*:", "", decl[1].split(",")[0]).strip().replace(self.jname, "")

    def __repr__(self):
        return Template("CLASS $namespace::$classpath.$name : $base").substitute(**self.__dict__)

    def getAllImports(self, module):
        return ["import %s;" % c for c in sorted(self.imports) if not c.startswith('org.visp.' + module)]

    def addImports(self, ctype):
        if ctype in type_dict:
            if "j_import" in type_dict[ctype]:
                self.imports.add(type_dict[ctype]["j_import"])
            if "v_type" in type_dict[ctype]:
                self.imports.add("java.util.List")
                self.imports.add("java.util.ArrayList")
                self.imports.add("org.visp.utils.Converters")
                if type_dict[ctype]["v_type"] in ("VpMatrix", "vector_Mat"):
                    self.imports.add("org.visp.core.VpMatrix")

    def getAllMethods(self):
        result = []
        result.extend([fi for fi in sorted(self.methods) if fi.isconstructor])
        result.extend([fi for fi in sorted(self.methods) if not fi.isconstructor])
        return result

    def addMethod(self, fi):
        if fi not in self.methods: # Dont add duplicates
            self.methods.append(fi)

    def getConst(self, name):
        for cand in self.consts + self.private_consts:
            if cand.name == name:
                return cand
        return None

    def addConst(self, constinfo):
        # choose right list (public or private)
        consts = self.consts
        for c in const_private_list:
            if re.match(c, constinfo.name):
                consts = self.private_consts
                break
        consts.append(constinfo)

    def initCodeStreams(self, Module):
        self.j_code = StringIO()
        self.jn_code = StringIO()
        self.cpp_code = StringIO();

        # INFO: All of these T_JAVA are templates for starting portion of Java classes
        if self.base:
            self.j_code.write(T_JAVA_START_INHERITED)
        else:
            if self.name != Module:
                self.j_code.write(T_JAVA_START_ORPHAN)
            else:
                self.j_code.write(T_JAVA_START_MODULE)

        # INFO: Misc folder handling for modules like Core, Imgproc
        if self.name == Module:

            # INFO: module_imports - read from gen_dict.json. Contains 'java.lang.String', 'java.lang.Character' etc
            for i in module_imports or []:
                self.imports.add(i)
            if module_j_code:
                self.j_code.write(module_j_code)
            if module_jn_code:
                self.jn_code.write(module_jn_code)

    def cleanupCodeStreams(self):
        self.j_code.close()
        self.jn_code.close()
        self.cpp_code.close()

    def generateJavaCode(self, m, M):
        return Template(self.j_code.getvalue() + "\n\n" + \
                        self.jn_code.getvalue() + "\n}\n").substitute( \
            module=m,
            name=self.name,
            jname=self.jname,
            imports="\n".join(self.getAllImports(M)),
            docs=self.docstring,
            annotation="\n".join(self.annotation),
            base=self.base)

    def generateCppCode(self):
        return self.cpp_code.getvalue()


class ArgInfo():
    def __init__(self, arg_tuple):  # [ ctype, name, def val, [mod], argno ]
        self.pointer = False
        ctype = arg_tuple[0]
        if ctype.endswith("*"):
            ctype = ctype[:-1]
            self.pointer = True
        self.ctype = ctype
        self.name = arg_tuple[1]
        self.defval = arg_tuple[2]
        self.out = ""
        if "/O" in arg_tuple[3]:
            self.out = "O"
        if "/IO" in arg_tuple[3]:
            self.out = "IO"

    def __repr__(self):
        return Template("ARG $ctype$p $name=$defval").substitute(ctype=self.ctype,
                                                                 p=" *" if self.pointer else "",
                                                                 name=self.name,
                                                                 defval=self.defval)
    def __eq__(self, other):
        return self.ctype == other.ctype


class FuncInfo(GeneralInfo):
    def __init__(self, decl, namespaces=[]):  # [ funcname, return_ctype, [modifiers], [args] ]
        GeneralInfo.__init__(self, "func", decl, namespaces)
        self.cname = self.name.replace(".", "::")
        self.jname = self.name
        self.isconstructor = self.name == self.classname

        # TODO open-cv didn't add camel case support
        # I'm adding
        self.classname = camelCase(self.classname)
        self.classpath = camelCase(self.classpath)
        if self.isconstructor:
            self.name = camelCase(self.name)
            self.jname = camelCase(self.jname)

        if "[" in self.name:
            self.jname = "getelem"
        for m in decl[2]:
            if m.startswith("="):
                self.jname = m[1:]
        self.static = ["", "static"]["/S" in decl[2]]
        self.ctype = re.sub(r"^VpTermCriteria", "TermCriteria", decl[1] or "")
        self.args = []
        func_fix_map = func_arg_fix.get(self.jname, {})
        for a in decl[3]:
            arg = a[:]
            arg_fix_map = func_fix_map.get(arg[1], {})
            arg[0] = arg_fix_map.get('ctype', arg[0])  # fixing arg type
            arg[3] = arg_fix_map.get('attrib', arg[3])  # fixing arg attrib
            self.args.append(ArgInfo(arg))

    def __repr__(self):
        return Template("FUNC <$ctype $namespace.$classpath.$name $args>").substitute(**self.__dict__)

    def __lt__(self, other):
        return self.__repr__() < other.__repr__()

    def __eq__(self, other):
        return self.cname == other.cname and len(self.args) == len(other.args) and self.args == other.args


class JavaWrapperGenerator(object):
    def __init__(self):
        self.cpp_files = []
        self.clear()

    def clear(self):
        self.namespaces = set(["vp"])
        self.classes = {}
        self.module = ""
        self.Module = ""
        self.ported_func_list = []
        self.skipped_func_list = []
        self.def_args_hist = {}  # { def_args_cnt : funcs_cnt }

    def add_class(self, decl):
        classinfo = ClassInfo(decl, namespaces=self.namespaces)
        if classinfo.name in class_ignore_list:
            logging.info('ignored: %s', classinfo)
            return
        name = classinfo.name
        if self.isWrapped(name) and not classinfo.base:
            logging.warning('duplicated: %s', classinfo)
            return
        self.classes[name] = classinfo
        if name in type_dict and not classinfo.base:
            logging.warning('duplicated: %s', classinfo)
            return
        type_dict.setdefault(name, {}).update(
            {"j_type": classinfo.jname,
             "jn_type": "long", "jn_args": (("__int64", ".nativeObj"),),
             "jni_name": "(*(" + classinfo.fullName(isCPP=True) + "*)%(n)s_nativeObj)", "jni_type": "jlong",
             "suffix": "J",
             "j_import": "org.visp.%s.%s" % (self.module, classinfo.jname)
             }
        )
        type_dict.setdefault(name + '*', {}).update(
            {"j_type": classinfo.jname,
             "jn_type": "long", "jn_args": (("__int64", ".nativeObj"),),
             "jni_name": "(" + classinfo.fullName(isCPP=True) + "*)%(n)s_nativeObj", "jni_type": "jlong",
             "suffix": "J",
             "j_import": "org.visp.%s.%s" % (self.module, classinfo.jname)
             }
        )

        # missing_consts { Module : { public : [[name, val],...], private : [[]...] } }
        if name in missing_consts:
            if 'private' in missing_consts[name]:
                for (n, val) in missing_consts[name]['private']:
                    classinfo.private_consts.append(ConstInfo([n, val], addedManually=True))
            if 'public' in missing_consts[name]:
                for (n, val) in missing_consts[name]['public']:
                    classinfo.consts.append(ConstInfo([n, val], addedManually=True))

        # class props
        for p in decl[3]:
            if True:  # "vector" not in p[0]:
                classinfo.props.append(ClassPropInfo(p))
            else:
                logging.warning("Skipped property: [%s]" % name, p)

        if classinfo.base:
            classinfo.addImports(classinfo.base)
        type_dict.setdefault("Ptr_" + name, {}).update(
            {"j_type": classinfo.jname,
             "jn_type": "long", "jn_args": (("__int64", ".getNativeObjAddr()"),),
             "jni_name": "*((Ptr<" + classinfo.fullName(isCPP=True) + ">*)%(n)s_nativeObj)", "jni_type": "jlong",
             "suffix": "J",
             "j_import": "org.visp.%s.%s" % (self.module, classinfo.jname)
             }
        )
        logging.info('ok: class %s, name: %s, base: %s', classinfo, name, classinfo.base)

    def add_const(self, decl):  # [ "const cname", val, [], [] ]
        constinfo = ConstInfo(decl, namespaces=self.namespaces)
        if constinfo.isIgnored():
            logging.info('ignored: %s', constinfo)
        elif not self.isWrapped(constinfo.classname):
            logging.info('class not found: %s', constinfo)
        else:
            ci = self.getClass(constinfo.classname)
            duplicate = ci.getConst(constinfo.name)
            if duplicate:
                if duplicate.addedManually:
                    logging.info('manual: %s', constinfo)
                else:
                    logging.warning('duplicated: %s', constinfo)
            else:
                ci.addConst(constinfo)
                logging.info('ok: %s', constinfo)

    # INFO: Some functions are to be ignored - either they can't exist in java or have to be implemtd manully
    def add_func(self, decl):
        fi = FuncInfo(decl, namespaces=self.namespaces)
        classname = fi.classname or self.Module

        # Workaround for imgrpoc module
        if classname == 'Vp' and self.Module == 'Imgproc':
            classname = 'VpImgproc'

        if classname in class_ignore_list:
            logging.info('ignored: %s', fi)
        elif classname in ManualFuncs and fi.jname in ManualFuncs[classname]:
            logging.info('manual: %s', fi)
        elif not self.isWrapped(classname):
            logging.warning('not found: %s', fi)
        else:
            self.getClass(classname).addMethod(fi)
            logging.info('ok: %s', fi)
            # calc args with def val
            cnt = len([a for a in fi.args if a.defval])
            self.def_args_hist[cnt] = self.def_args_hist.get(cnt, 0) + 1

    def save(self, path, buf):
        global total_files, updated_files
        total_files += 1
        if os.path.exists(path):
            with open(path, "rt") as f:
                content = f.read()
                if content == buf:
                    return
        with open(path, "wt") as f:
            f.write(buf)
        updated_files += 1

    def gen(self, srcfiles, module, output_path, output_jni_path, output_java_path, common_headers):
        self.clear()
        self.module = module
        self.Module = module.capitalize()

        # INFO: In open-cv 4, hdr_parser is imported to gen2.py which is imported to gen_java
        parser = hdr_parser.CppHeaderParser()

        # INFO: Donno why open-cv was adding module in list of classes
        # self.add_class( ['class ' + self.Module, '', [], []] ) # [ 'class/struct cname', ':bases', [modlist] [props] ]

        # scan the headers and build more descriptive maps of classes, consts, functions
        includes = [];

        # INFO: Don't know yet what it does
        for hdr in common_headers:
            logging.info("\n===== Common header : %s =====", hdr)
            includes.append('#include "' + hdr + '"')

        # INFO: These are .hpp files containing enums, template classes and some VP_EXPORT functions
        for hdr in srcfiles:

            '''
                # INFO: decls contains enum and const declared in .hpp files. It also contains function declarations,
                but only those which have a VISP_EXPORT macro with them. Read a snippet from `hdr_parser.py` for more

                Each declaration is [funcname, return_value_type /* in C, not in Python */, <list_of_modifiers>, <list_of_arguments>, original_return_type, docstring],
                where each element of <list_of_arguments> is 4-element list itself:
                [argtype, argname, default_value /* or "" if none */, <list_of_modifiers>]
                where the list of modifiers is yet another nested list of strings
                   (currently recognized are "/O" for output argument, "/S" for static (i.e. class) methods
                   and "/A value" for the plain C arrays with counters)
                original_return_type is None if the original_return_type is the same as return_value_type

                Ex:
                ['const cv.Error.StsOk', '0', [], [], None, '']   , where cv and Error are namespaces
                ['cv.cubeRoot', 'float', [], [['float', 'val', '', []]], 'float', '@brief Computes the cube root of an ...']

            '''
            decls = parser.parse(hdr)

            # TODO: Above parse function detects functions but not classes.
            # SO I'm adding classes assuming that the file name is a class name
            # Find the last occurence of / in path/to/class/myClass.h
            # -2 for removing `.h`
            self.add_class(["class " + camelCase(hdr[hdr.rfind('/') + 1:-2]), '', [], []])

            # INFO: List of all namespaces mentioned in the .hpp file. Like cv,ogl,cuda etc
            self.namespaces = parser.namespaces
            logging.info("\n\n===== Header: %s =====", hdr)
            logging.info("Namespaces: %s", parser.namespaces)

            if decls:
                includes.append('#include "' + hdr + '"')
            else:
                logging.info("Ignore header: %s", hdr)

            # INFO: Now split each declaration in categories - class, const or function
            # INFO: Some functions .are to be ignored - either they can't exist in java or have to be implemtd manully
            for decl in decls:
                logging.info("\n--- Incoming ---\n%s", pformat(decl[:5], 4))  # without docstring
                name = decl[0]

                # ToDO ignore operator member functions
                if decl[1] == 'operator':
                    print("Skipped operator function: %s" % name)
                elif name.startswith("struct") or name.startswith("class"):
                    self.add_class(decl)
                elif name.startswith("const"):
                    self.add_const(decl)
                else:  # function
                    self.add_func(decl)

                logging.info("\n\n===== Generating... =====")
        moduleCppCode = StringIO()
        package_path = os.path.join(output_java_path, module)
        mkdir_p(package_path)
        for ci in self.classes.values():
            # INFO: Ignore classes that are manually. For open-cv it was Mat, for Visp it'll be vpMat and vpImage
            if ci.name in ["vpMatrix", "vpImageUChar", "vpImageRGBa", "vpArray2D"]:
                continue
            ci.initCodeStreams(self.Module)
            self.gen_class(ci)
            classJavaCode = ci.generateJavaCode(self.module, self.Module)
            self.save("%s/%s/%s.java" % (output_java_path, module, ci.jname), classJavaCode)
            moduleCppCode.write(ci.generateCppCode())
            ci.cleanupCodeStreams()
        cpp_file = os.path.abspath(os.path.join(output_jni_path, module + ".inl.hpp"))
        self.cpp_files.append(cpp_file)
        self.save(cpp_file, T_CPP_MODULE.substitute(m=module, M=module.upper(), code=moduleCppCode.getvalue(),
                                                    includes="\n".join(includes)))
        self.save(os.path.join(output_path, module + ".txt"), self.makeReport())

    def makeReport(self):
        '''
        Returns string with generator report
        '''
        report = StringIO()
        total_count = len(self.ported_func_list) + len(self.skipped_func_list)
        report.write("PORTED FUNCs LIST (%i of %i):\n\n" % (len(self.ported_func_list), total_count))
        report.write("\n".join(self.ported_func_list))
        report.write("\n\nSKIPPED FUNCs LIST (%i of %i):\n\n" % (len(self.skipped_func_list), total_count))
        report.write("".join(self.skipped_func_list))
        for i in self.def_args_hist.keys():
            report.write("\n%i def args - %i funcs" % (i, self.def_args_hist[i]))
        return report.getvalue()

    def fullTypeName(self, t):
        if self.isWrapped(t):
            return self.getClass(t).fullName(isCPP=True)
        else:
            return t

    def gen_func(self, ci, fi, prop_name=''):
        logging.info("%s", fi)
        j_code = ci.j_code
        jn_code = ci.jn_code
        cpp_code = ci.cpp_code

        # c_decl
        # e.g: void add(Mat src1, Mat src2, Mat dst, Mat mask = Mat(), int dtype = -1)
        if prop_name:
            c_decl = "%s %s::%s" % (fi.ctype, fi.classname, prop_name)
        else:
            decl_args = []
            for a in fi.args:  # INFO: Even arguments have their own class: [type, defval, name, isPointer(bool), out(ret type)]
                s = a.ctype or ' _hidden_ '
                if a.pointer:
                    s += "*"
                elif a.out:
                    s += "&"
                s += " " + a.name
                if a.defval:
                    s += " = " + a.defval
                decl_args.append(s)
            c_decl = "%s %s %s(%s)" % (fi.static, fi.ctype, fi.cname, ", ".join(decl_args))

        # INFO: This is the java comment above every function
        j_code.write("\n    //\n    // C++: %s\n    //\n\n" % c_decl)

        # check if we 'know' all the types
        if fi.ctype not in type_dict:  # unsupported ret type
            msg = "// Return type '%s' is not supported, skipping the function\n\n" % fi.ctype
            self.skipped_func_list.append(c_decl + "\n" + msg)
            j_code.write(" " * 4 + msg)
            logging.warning("SKIP:" + c_decl.strip() + "\t due to RET type" + fi.ctype)
            return

        for a in fi.args:
            if a.ctype not in type_dict:
                if not a.defval and a.ctype.endswith("*"):
                    a.defval = 0
                if a.defval:
                    a.ctype = ''
                    continue
                msg = "// Unknown type '%s' (%s), skipping the function\n\n" % (a.ctype, a.out or "I")
                self.skipped_func_list.append(c_decl + "\n" + msg)
                j_code.write(" " * 4 + msg)
                logging.warning("SKIP:" + c_decl.strip() + "\t due to ARG type" + a.ctype + "/" + (a.out or "I"))
                return

        self.ported_func_list.append(c_decl)

        # jn & cpp comment
        jn_code.write("\n    // C++: %s\n" % c_decl)
        cpp_code.write("\n//\n// %s\n//\n" % c_decl)

        # INFO: Generating the JNI method signatures
        args = fi.args[:]  # copy
        j_signatures = []
        suffix_counter = int(ci.methods_suffixes.get(fi.jname, -1))
        while True:
            suffix_counter += 1
            ci.methods_suffixes[fi.jname] = suffix_counter
            # java native method args
            jn_args = []
            # jni (cpp) function args
            jni_args = [ArgInfo(["env", "env", "", [], ""]), ArgInfo(["cls", "", "", [], ""])]
            j_prologue = []
            j_epilogue = []
            c_prologue = []
            c_epilogue = []

            # Add 3rd party specific tags
            # If Lapack, Eigen3 or OpenCV are missing, don't include them to prevent compilation error
            if fi.name in ['detByLULapack', 'svdLapack', 'inverseByLULapack', 'pseudoInverseLapack', 'inverseByLapack', 'inverseByCholeskyLapack', 'inverseByQRLapack']:
                c_prologue.append('#if defined(VISP_HAVE_LAPACK)')

            if fi.name in ['detByLUEigen3', 'svdEigen3', 'inverseByLUEigen3', 'pseudoInverseEigen3', 'inverseByEigen3']:
                c_prologue.append('#if defined(VISP_HAVE_EIGEN3)')

            if fi.name in ['detByLUOpenCV', 'svdOpenCV', 'inverseByLUOpenCV', 'pseudoInverseOpenCV', 'inverseByOpenCV', 'inverseByCholeskyOpenCV']:
                c_prologue.append('#if (VISP_HAVE_OPENCV_VERSION >= 0x020101)')

            if fi.name in ['detByLUGsl', 'svdGsl', 'inverseByLUGsl', 'pseudoInverseGsl', 'inverseByGsl', 'inverseByCholeskyGsl', 'inverseByQRGsl']:
                c_prologue.append('#if defined(VISP_BUILD_DEPRECATED_FUNCTIONS) && defined(VISP_HAVE_LAPACK)')
            if fi.name in ['from_json', 'to_json', 'loadConfigFileJSON', 'saveConfigFile']:
                c_prologue.append('#if defined(VISP_HAVE_NLOHMANN_JSON)')


            if type_dict[fi.ctype]["jni_type"] == "jdoubleArray" and type_dict[fi.ctype]["suffix"] != "[D":
                fields = type_dict[fi.ctype]["jn_args"]
                c_epilogue.append( \
                    ("jdoubleArray _da_retval_ = env->NewDoubleArray(%(cnt)i);  " +
                     "jdouble _tmp_retval_[%(cnt)i] = {%(args)s}; " +
                     "env->SetDoubleArrayRegion(_da_retval_, 0, %(cnt)i, _tmp_retval_);") %
                    {"cnt": len(fields), "args": ", ".join(["(jdouble)_retval_" + f[1] for f in fields])})
            if fi.classname and fi.ctype and not fi.static:  # non-static class method except c-tor
                # adding 'self'
                jn_args.append(ArgInfo(["__int64", "nativeObj", "", [], ""]))
                jni_args.append(ArgInfo(["__int64", "self", "", [], ""]))
            ci.addImports(fi.ctype)
            for a in args:
                if not a.ctype:  # hidden
                    continue
                ci.addImports(a.ctype)
                if "v_type" in type_dict[a.ctype]:  # pass as vector
                    if type_dict[a.ctype]["v_type"] in ("Mat", "vector_Mat"):  # pass as Mat or vector_Mat
                        jn_args.append(ArgInfo(["__int64", "%s_mat.nativeObj" % a.name, "", [], ""]))
                        jni_args.append(ArgInfo(["__int64", "%s_mat_nativeObj" % a.name, "", [], ""]))
                        c_prologue.append(type_dict[a.ctype]["jni_var"] % {"n": a.name} + ";")
                        c_prologue.append("Mat& %(n)s_mat = *((Mat*)%(n)s_mat_nativeObj)" % {"n": a.name} + ";")
                        if "I" in a.out or not a.out:
                            if type_dict[a.ctype]["v_type"] == "vector_Mat":
                                j_prologue.append(
                                    "List<VpMatrix> %(n)s_tmplm = new ArrayList<VpMatrix>((%(n)s != null) ? %(n)s.size() : 0);" % {
                                        "n": a.name})
                                j_prologue.append(
                                    "Mat %(n)s_mat = Converters.%(t)s_to_Mat(%(n)s, %(n)s_tmplm);" % {"n": a.name,
                                                                                                      "t": a.ctype})
                            else:
                                j_prologue.append("Mat %(n)s_mat = Converters.%(t)s_to_Mat(%(n)s);" % {"n": a.name, "t": a.ctype})
                            c_prologue.append("Mat_to_%(t)s( %(n)s_mat, %(n)s );" % {"n": a.name, "t": a.ctype})
                        else:
                            j_prologue.append("Mat %s_mat = new Mat();" % a.name)
                        if "O" in a.out:
                            j_epilogue.append("Converters.Mat_to_%(t)s(%(n)s_mat, %(n)s);" % {"t": a.ctype, "n": a.name})
                            j_epilogue.append("%s_mat.release();" % a.name)
                            c_epilogue.append("%(t)s_to_Mat( %(n)s, %(n)s_mat );" % {"n": a.name, "t": a.ctype})
                    elif type_dict[a.ctype]["v_type"] in ("std::vector<double>"):
                        c_prologue.append("std::vector<double> v_ = List_to_vector_double(env, v);")
                    else:  # pass as list
                        jn_args.append(ArgInfo([a.ctype, a.name, "", [], ""]))
                        jni_args.append(ArgInfo([a.ctype, "%s_list" % a.name, "", [], ""]))
                        ci.addImports(a.ctype)
                        j_prologue.append("long[] "+a.name+" = Converters."+a.ctype+"_to_Array("+a.name+"_list_arr);")
                        a.name += '_list'
                        c_prologue.append(type_dict[a.ctype]["jni_var"] % {"n": a.name} + "_arr;")
                        if "I" in a.out or not a.out:
                            c_prologue.append("%(n)s_arr = List_to_%(t)s(env, %(n)s);" % {"n": a.name, "t": a.ctype})
                        if "O" in a.out:
                            c_epilogue.append("Copy_%s_to_List(env,%s,%s_list);" % (a.ctype, a.name, a.name))
                        a.name += '_arr'
                else:
                    fields = type_dict[a.ctype].get("jn_args", ((a.ctype, ""),))
                    if "I" in a.out or not a.out or self.isWrapped(a.ctype):  # input arg, pass by primitive fields
                        for f in fields:
                            jn_args.append(ArgInfo([f[0], a.name + f[1], "", [], ""]))
                            jni_args.append(ArgInfo([f[0], a.name + f[1].replace(".", "_").replace("[", "").replace("]",
                                                                                                                    "").replace(
                                "_getNativeObjAddr()", "_nativeObj"), "", [], ""]))
                    if "O" in a.out and not self.isWrapped(a.ctype):  # out arg, pass as double[]
                        jn_args.append(ArgInfo(["double[]", "%s_out" % a.name, "", [], ""]))
                        jni_args.append(ArgInfo(["double[]", "%s_out" % a.name, "", [], ""]))
                        j_prologue.append("double[] %s_out = new double[%i];" % (a.name, len(fields)))
                        c_epilogue.append( \
                            "jdouble tmp_%(n)s[%(cnt)i] = {%(args)s}; env->SetDoubleArrayRegion(%(n)s_out, 0, %(cnt)i, tmp_%(n)s);" %
                            {"n": a.name, "cnt": len(fields),
                             "args": ", ".join(["(jdouble)" + a.name + f[1] for f in fields])})
                        if type_dict[a.ctype]["j_type"] in ('bool', 'int', 'long', 'float', 'double'):
                            j_epilogue.append('if(%(n)s!=null) %(n)s[0] = (%(t)s)%(n)s_out[0];' % {'n': a.name, 't':
                                type_dict[a.ctype]["j_type"]})
                        else:
                            set_vals = []
                            i = 0
                            for f in fields:
                                set_vals.append("%(n)s%(f)s = %(t)s%(n)s_out[%(i)i]" %
                                                {"n": a.name,
                                                 "t": ("(" + type_dict[f[0]]["j_type"] + ")", "")[f[0] == "double"],
                                                 "f": f[1], "i": i}
                                                )
                                i += 1
                            j_epilogue.append("if(" + a.name + "!=null){ " + "; ".join(set_vals) + "; } ")

            # calculate java method signature to check for uniqueness
            j_args = []
            for a in args:
                if not a.ctype:  # hidden
                    continue
                jt = type_dict[a.ctype]["j_type"]
                if a.out and jt in ('bool', 'int', 'long', 'float', 'double'):
                    jt += '[]'
                j_args.append(jt + ' ' + a.name)
            j_signature = type_dict[fi.ctype]["j_type"] + " " + \
                          fi.jname + "(" + ", ".join(j_args) + ")"
            logging.info("java: " + j_signature)

            if (j_signature in j_signatures):
                if args:
                    args.pop()
                    continue
                else:
                    break

            # java part:
            # private java NATIVE method decl
            # e.g.
            # private static native void add_0(long src1, long src2, long dst, long mask, int dtype);
            jn_code.write(Template( \
                "    private static native $type $name($args);\n").substitute( \
                type=type_dict[fi.ctype].get("jn_type", "double[]"), \
                name=fi.jname + '_' + str(suffix_counter), \
                args=", ".join(["%s %s" % (type_dict[a.ctype]["jn_type"],
                                           a.name.replace(".", "_").replace("[", "").replace("]", "").replace(
                                               "_getNativeObjAddr()", "_nativeObj")) for a in jn_args])
            ));

            # java part:

            # java doc comment
            f_name = fi.name
            if fi.classname:
                f_name = fi.classname + "::" + fi.name
            java_doc = "//javadoc: " + f_name + "(%s)" % ", ".join([a.name for a in args if a.ctype])
            j_code.write(" " * 4 + java_doc + "\n")

            if fi.docstring:
                lines = StringIO(fi.docstring)
                for line in lines:
                    j_code.write(" " * 4 + line + "\n")
            if fi.annotation:
                j_code.write(" " * 4 + "\n".join(fi.annotation) + "\n")

            # public java wrapper method impl (calling native one above)
            # e.g.
            # public static void add( Mat src1, Mat src2, Mat dst, Mat mask, int dtype )
            # { add_0( src1.nativeObj, src2.nativeObj, dst.nativeObj, mask.nativeObj, dtype );  }
            ret_type = fi.ctype
            if fi.ctype.endswith('*'):
                ret_type = ret_type[:-1]
            ret_val = type_dict[ret_type]["j_type"] + " retVal = "
            tail = ""
            ret = "return retVal;"
            if "v_type" in type_dict[ret_type]:
                j_type = type_dict[ret_type]["j_type"]
                ret_val = "long[] addressList = "
                j_epilogue.append(j_type + ' retVal = Converters.Array_to_' + ret_type + '(addressList);')
            elif ret_type.startswith("Ptr_"):
                ret_val = type_dict[fi.ctype]["j_type"] + " retVal = " + type_dict[ret_type]["j_type"] + ".__fromPtr__("
                tail = ")"
            elif ret_type == "void":
                ret_val = ""
                ret = "return;"
            elif ret_type == "":  # c-tor
                if fi.classname and ci.base:
                    ret_val = "super( "
                    tail = " )"
                else:
                    ret_val = "nativeObj = "
                ret = "return;"
            elif self.isWrapped(camelCase(ret_type)):  # wrapped class
                ret_val = type_dict[ret_type]["j_type"] + " retVal = new " + camelCase(
                    self.getClass(camelCase(ret_type)).jname) + "("
                tail = ")"
            elif "jn_type" not in type_dict[ret_type]:
                ret_val = type_dict[fi.ctype]["j_type"] + " retVal = new " + camelCase(
                    type_dict[ret_type]["j_type"]) + "("
                tail = ")"

            static = "static"
            if fi.classname:
                static = fi.static

            j_code.write(Template( \
                """
    public $static $j_type $j_name($j_args)
    {
        $prologue
        $ret_val$jn_name($jn_args_call)$tail;
        $epilogue
        $ret
    }
                """
            ).substitute( \
                ret=ret, \
                ret_val=ret_val, \
                tail=tail, \
                prologue="\n        ".join(j_prologue), \
                epilogue="\n        ".join(j_epilogue), \
                static=static, \
                j_type=type_dict[fi.ctype]["j_type"], \
                j_name=fi.jname, \
                j_args=", ".join(j_args), \
                jn_name=fi.jname + '_' + str(suffix_counter), \
                jn_args_call=", ".join([a.name for a in jn_args]), \
                )
            )

            # cpp part:
            # jni_func(..) { _retval_ = vp_func(..); return _retval_; }
            ret = "return _retval_;"
            default = "return 0;"
            if fi.ctype == "void":
                ret = "return;"
                default = "return;"
            elif not fi.ctype:  # c-tor
                ret = "return (jlong) _retval_;"
            elif "v_type" in type_dict[fi.ctype]:  # c-tor
                if type_dict[fi.ctype]["v_type"] in ("vpMatrix", "vector_vpMatrix"):
                    ret = "return (jlong) _retval_;"
                else:  # returned as jobject
                    ret = "return _retval_;"
            elif fi.ctype == "String":
                ret = "return env->NewStringUTF(_retval_.c_str());"
                default = 'return env->NewStringUTF("");'
            elif self.isWrapped(camelCase(fi.ctype)):  # wrapped class:
                ret = "return (jlong) new %s(_retval_);" % self.smartWrap(ci, self.fullTypeName(camelCase(fi.ctype)))
            elif fi.ctype.startswith('Ptr_'):
                c_prologue.append("typedef Ptr<%s> %s;" % (self.fullTypeName(fi.ctype[4:]), fi.ctype))
                ret = "return (jlong)(new %(ctype)s(_retval_));" % {'ctype': fi.ctype}
            elif self.isWrapped(camelCase(ret_type)):  # pointer to wrapped class:
                ret = "return (jlong) _retval_;"
            elif type_dict[fi.ctype]["jni_type"] == "jdoubleArray":
                ret = "return _da_retval_;"

            # hack: replacing func call with property set/get
            name = fi.name
            if prop_name:
                if args:
                    name = prop_name + " = "
                else:
                    name = prop_name + ";//"

            cvname = fi.fullName(isCPP=True)
            retval = self.fullTypeName(fi.ctype) + " _retval_ = "
            if fi.ctype == "void":
                retval = ""
            elif fi.ctype == "String":
                retval = "vp::" + retval
            elif "v_type" in type_dict[fi.ctype]:  # vector is returned
                retval = type_dict[fi.ctype]['jni_var'] % {"n": '_ret_val_vector_'} + " = "
                c_epilogue.append("jlongArray _retval_ = " + fi.ctype + "_to_List(env, _ret_val_vector_);")
            if len(fi.classname) > 0:
                if not fi.ctype:  # c-tor
                    retval = reverseCamelCase(fi.fullClass(isCPP=True)) + "* _retval_ = "
                    cvname = "new " + reverseCamelCase(fi.fullClass(isCPP=True))
                elif fi.static:
                    cvname = reverseCamelCase(fi.fullName(isCPP=True))
                else:
                    cvname = ("me->" if not self.isSmartClass(ci) else "(*me)->") + name
                    c_prologue.append( \
                        "%(cls)s* me = (%(cls)s*) self; //TODO: check for NULL" \
                        % {"cls": reverseCamelCase(self.smartWrap(ci, fi.fullClass(isCPP=True)))} \
                        )
            cvargs = []
            for a in args:
                if a.pointer:
                    jni_name = "&%(n)s"
                else:
                    jni_name = "%(n)s"
                    if not a.out and not "jni_var" in type_dict[a.ctype]:
                        # explicit cast to C type to avoid ambiguous call error on platforms (mingw)
                        # where jni types are different from native types (e.g. jint is not the same as int)
                        jni_name = "(%s)%s" % (a.ctype, jni_name)
                if not a.ctype:  # hidden
                    jni_name = a.defval
                cvargs.append(type_dict[a.ctype].get("jni_name", jni_name) % {"n": a.name})
                if "v_type" not in type_dict[a.ctype]:
                    if ("I" in a.out or not a.out or self.isWrapped(a.ctype)) and "jni_var" in type_dict[a.ctype]:  # complex type
                        if a.ctype in [ 'vector_double', 'vector_float' ]:
                            c_prologue.append(type_dict[a.ctype]["jni_var"] % {"n": a.name} + "_ = List_to_" + a.ctype + "(env, " + a.name + ");")
                            # add "_" suffix to the last argument
                            cvargs[len(cvargs) - 1] = cvargs[len(cvargs) - 1] + "_"
                        else:
                            c_prologue.append(type_dict[a.ctype]["jni_var"] % {"n": a.name} + ";")
                    if a.out and "I" not in a.out and not self.isWrapped(a.ctype) and a.ctype:
                        c_prologue.append("%s %s;" % (a.ctype, a.name))

            # Add 3rd party specific tags
            # If Lapack, Eigen3 or OpenCV are missing, don't include them to prevent compilation error
            if fi.name in ['detByLULapack', 'svdLapack', 'inverseByLULapack', 'pseudoInverseLapack', 'inverseByLapack', 'inverseByCholeskyLapack', 'inverseByQRLapack']:
                ret += '\n    #endif'

            if fi.name in ['detByLUEigen3', 'svdEigen3', 'inverseByLUEigen3', 'pseudoInverseEigen3', 'inverseByEigen3']:
                ret += '\n    #endif'

            if fi.name in ['detByLUOpenCV', 'svdOpenCV', 'inverseByLUOpenCV', 'pseudoInverseOpenCV', 'inverseByOpenCV', 'inverseByCholeskyOpenCV']:
                ret += '\n    #endif'

            if fi.name in ['detByLUGsl', 'svdGsl', 'inverseByLUGsl', 'pseudoInverseGsl', 'inverseByGsl', 'inverseByCholeskyGsl', 'inverseByQRGsl']:
                ret += '\n    #endif'
            if fi.name in ['from_json', 'to_json', 'loadConfigFileJSON', 'saveConfigFile']:
                ret += '\n    #endif'

            rtype = type_dict[fi.ctype].get("jni_type", "jdoubleArray")
            clazz = ci.jname
            cpp_code.write(Template( \
                """
${namespace}
JNIEXPORT $rtype JNICALL Java_org_visp_${module}_${clazz}_$fname ($argst);

JNIEXPORT $rtype JNICALL Java_org_visp_${module}_${clazz}_$fname
  ($args)
{
  static const char method_name[] = "$module::$fname()";
  try {
    LOGD("%s", method_name);
    $prologue
    $retval$cvname( ${cvargs} );
    $epilogue$ret
  } catch(const std::exception &e) {
    throwJavaException(env, &e, method_name);
  } catch (...) {
    throwJavaException(env, 0, method_name);
  }
  $default
}
                """).substitute( \
                rtype=rtype, \
                module=self.module.replace('_', '_1'), \
                clazz=clazz.replace('_', '_1'), \
                fname=(fi.jname + '_' + str(suffix_counter)).replace('_', '_1'), \
                args=", ".join(["%s %s" % (type_dict[a.ctype].get("jni_type"), a.name) for a in jni_args]), \
                argst=", ".join([type_dict[a.ctype].get("jni_type") for a in jni_args]), \
                prologue="\n        ".join(c_prologue), \
                epilogue="  ".join(c_epilogue) + ("\n        " if c_epilogue else ""), \
                ret=ret, \
                cvname=cvname, \
                cvargs=", ".join(cvargs), \
                default=default, \
                retval=retval, \
                namespace=('using namespace ' + ci.namespace.replace('.', '::') + ';') if ci.namespace else ''
            ))

            # adding method signature to dictionarry
            j_signatures.append(j_signature)

            # processing args with default values
            if not args or not args[-1].defval:
                break
            while args and args[-1].defval:
                # 'smart' overloads filtering
                a = args.pop()
                if a.name in ('mask', 'dtype', 'ddepth', 'lineType', 'borderType', 'borderMode', 'criteria'):
                    break

    # INFO: Regex starts here
    def gen_class(self, ci):
        logging.info("%s", ci)
        # constants
        if ci.private_consts:
            logging.info("%s", ci.private_consts)
            ci.j_code.write("""
    private static final int
            %s;\n\n""" % (",\n" + " " * 12).join(["%s = %s" % (c.name, c.value) for c in ci.private_consts])
                            )
        if ci.consts:
            logging.info("%s", ci.consts)
            ci.j_code.write("""
    public static final int
            %s;\n\n""" % (",\n" + " " * 12).join(["%s = %s" % (c.name, c.value) for c in ci.consts])
                            )
        # methods
        for fi in ci.getAllMethods():
            self.gen_func(ci, fi)
        # props
        for pi in ci.props:
            # getter
            getter_name = ci.fullName() + ".get_" + pi.name
            fi = FuncInfo([getter_name, pi.ctype, [], []],
                          self.namespaces)  # [ funcname, return_ctype, [modifiers], [args] ]
            self.gen_func(ci, fi, pi.name)
            if pi.rw:
                # setter
                setter_name = ci.fullName() + ".set_" + pi.name
                fi = FuncInfo([setter_name, "void", [], [[pi.ctype, pi.name, "", [], ""]]], self.namespaces)
                self.gen_func(ci, fi, pi.name)

        # manual ports
        if ci.name in ManualFuncs:
            for func in ManualFuncs[ci.name].keys():
                ci.j_code.write("\n\t")
                ci.jn_code.write("\n\t")
                ci.cpp_code.write("\n")
                ci.j_code.write("\n\t".join(ManualFuncs[ci.name][func]["j_code"]))
                ci.jn_code.write("\n\t".join(ManualFuncs[ci.name][func]["jn_code"]))
                ci.cpp_code.write("\n".join(ManualFuncs[ci.name][func]["cpp_code"]))
                ci.j_code.write("\n\t")
                ci.jn_code.write("\n\t")
                ci.cpp_code.write("\n")

        # Add only classes that support << operator
        if ci.name in ToStringSupport:
            # toString
            ci.j_code.write(
                """
    @Override
    public String toString(){
        return toString(nativeObj);
    }
                """)

            ci.jn_code.write(
                """
    // native support for java toString()
    private static native String toString(long nativeObj);
                """)

            # native support for java toString()
            ci.cpp_code.write("""
//
//  native support for java toString()
//  static String %(cls)s::toString()
//

JNIEXPORT jstring JNICALL Java_org_visp_%(module)s_%(j_cls)s_toString(JNIEnv*, jclass, jlong);

JNIEXPORT jstring JNICALL Java_org_visp_%(module)s_%(j_cls)s_toString
  (JNIEnv* env, jclass, jlong self)
{
  %(cls)s* me = (%(cls)s*) self; //TODO: check for NULL
  std::stringstream ss;
  ss << *me;
  return env->NewStringUTF(ss.str().c_str());
}

                """ % {"module": module.replace('_', '_1'), "cls": self.smartWrap(ci, ci.fullName(isCPP=True)),
                       "j_cls": ci.jname.replace('_', '_1')}
            )

        if ci.name != 'VpImgproc' and ci.name != self.Module or ci.base:
            # finalize()
            ci.j_code.write(
                """
    @Override
    protected void finalize() throws Throwable {
        delete(nativeObj);
    }
                """)

            ci.jn_code.write(
                """
    // native support for java finalize()
    private static native void delete(long nativeObj);
                """)

            # native support for java finalize()
            ci.cpp_code.write( \
                """
//
//  native support for java finalize()
//  static void %(cls)s::delete( __int64 self )
//

JNIEXPORT void JNICALL Java_org_visp_%(module)s_%(j_cls)s_delete(JNIEnv*, jclass, jlong);

JNIEXPORT void JNICALL Java_org_visp_%(module)s_%(j_cls)s_delete
  (JNIEnv*, jclass, jlong self)
{
  delete (%(cls)s*) self;
}

                """ % {"module": module.replace('_', '_1'), "cls": self.smartWrap(ci, ci.fullName(isCPP=True)),
       "j_cls": ci.jname.replace('_', '_1')}
            )

    def getClass(self, classname):
        return self.classes[classname or self.Module]

    def isWrapped(self, classname):
        name = classname or self.Module
        return name in self.classes

    def isSmartClass(self, ci):
        '''
        Check if class stores Ptr<T>* instead of T* in nativeObj field
        '''
        if ci.smart != None:
            return ci.smart

        # if parents are smart (we hope) then children are!
        # if not we believe the class is smart if it has "create" method
        ci.smart = False
        if ci.base or ci.name == 'Algorithm':
            ci.smart = True
        else:
            for fi in ci.methods:
                if fi.name == "create":
                    ci.smart = True
                    break

        return ci.smart

    def smartWrap(self, ci, fullname):
        '''
        Wraps fullname with Ptr<> if needed
        '''
        if self.isSmartClass(ci):
            return "Ptr<" + fullname + ">"
        if fullname[0] == ':':   # some classes miss namespace. so they are named ::<class>. That :: should be removed
            fullname = fullname[2:]
        return fullname

    '''
        # INFO: Generate a visp_jni.hpp file. Contains #include tags for all
        modules that very to be built and specified at compile time
    '''

    def finalize(self, output_jni_path):
        list_file = os.path.join(output_jni_path, "visp_jni.hpp")
        self.save(list_file, '\n'.join(['#include "%s"' % f for f in self.cpp_files]))


'''
    # INFO: As name suggests, copies some files specified at the desired location.
    Are the files edited as they are copied? No
'''


def copy_java_files(java_files_dir, java_base_path, default_package_path='org/visp/'):
    global total_files, updated_files
    java_files = []
    re_filter = re.compile(r'^.+\.(java|aidl)(.in)?$')
    for root, dirnames, filenames in os.walk(java_files_dir):
        java_files += [os.path.join(root, filename) for filename in filenames if re_filter.match(filename)]
    java_files = [f.replace('\\', '/') for f in java_files]

    re_package = re.compile(r'^package +(.+);')
    re_prefix = re.compile(r'^.+[\+/]([^\+]+).(java|aidl)(.in)?$')
    for java_file in java_files:

        '''
            # INFO: Not all files are copied directly. There's a set of files
            read in the `config.json`. Instead of copyong them, the code copies
            a diffrent set of files(also mentioned in gen_config.json, stored as
            a dict).
        '''

        src = checkFileRemap(java_file)
        with open(src, 'r') as f:
            package_line = f.readline()
        m = re_prefix.match(java_file)

        # INFO: using absolute path, get the filename.extension <- @a
        target_fname = (m.group(1) + '.' + m.group(2)) if m else os.path.basename(java_file)

        # INFO: Using the package name mentioned at the top of java file
        # INFO: generate a path. Ex package org.visp.core to ./org/visp/core <- @b
        m = re_package.match(package_line)
        if m:
            package = m.group(1)
            package_path = package.replace('.', '/')
        else:
            package_path = default_package_path

        # print(java_file, package_path, target_fname)

        # INFO: dest path = ./gen/java/@b/@a
        # INFO: ./gen/java is given as function argument
        dest = os.path.join(java_base_path, os.path.join(package_path, target_fname))
        assert dest[-3:] != '.in', dest + ' | ' + target_fname

        mkdir_p(os.path.dirname(dest))
        total_files += 1

        if (not os.path.exists(dest)) or (os.stat(src).st_mtime - os.stat(dest).st_mtime > 1):
            copyfile(src, dest)
            updated_files += 1


if __name__ == "__main__":
    # initialize logger
    logging.basicConfig(filename='gen_java.log', format=None, filemode='w', level=logging.INFO)
    handler = logging.StreamHandler()
    handler.setLevel(logging.WARNING)
    logging.getLogger().addHandler(handler)

    # parse command line parameters
    import argparse

    arg_parser = argparse.ArgumentParser(description='ViSP Java Wrapper Generator')
    arg_parser.add_argument('-p', '--parser', required=True, help='ViSP header parser')
    arg_parser.add_argument('-c', '--config', required=True, help='ViSP modules config')

    args = arg_parser.parse_args()

    # INFO: There's a file called gen2.py. It contains some functions Arginfo
    # , GeneralINfo, FuncIfno and some template strings. I guess its called
    # header parsers. I guess thats used for extracting Class name, function name
    # and module name from a .cpp file. These values must be fed in the
    # template given above to create JNI code.

    # import header parser
    hdr_parser_path = os.path.abspath(args.parser)
    if hdr_parser_path.endswith(".py"):
        hdr_parser_path = os.path.dirname(hdr_parser_path)
    sys.path.append(hdr_parser_path)
    import hdr_parser

    with open(args.config) as f:
        config = json.load(f)

    ROOT_DIR = config['rootdir'];
    assert os.path.exists(ROOT_DIR)
    FILES_REMAP = {os.path.realpath(os.path.join(ROOT_DIR, f['src'])): f['target'] for f in config['files_remap']}
    logging.info("\nRemapped configured files (%d):\n%s", len(FILES_REMAP), pformat(FILES_REMAP))

    # INFO: Now we create some folders inside the <build> folder viz. gen/cpp, gen/java

    dstdir = "./gen"
    jni_path = os.path.join(dstdir, 'cpp');
    mkdir_p(jni_path)
    java_base_path = os.path.join(dstdir, 'java');
    mkdir_p(java_base_path)
    java_test_base_path = os.path.join(dstdir, 'test');
    mkdir_p(java_test_base_path)

    for (subdir, target_subdir) in [('src/java', 'java'), ('android/java', None), ('android-21/java', None)]:
        if target_subdir is None:
            target_subdir = subdir
        java_files_dir = os.path.join(SCRIPT_DIR, subdir)
        if os.path.exists(java_files_dir):
            target_path = os.path.join(dstdir, target_subdir);
            mkdir_p(target_path)
            copy_java_files(java_files_dir, target_path)

    # launch Java Wrapper generator
    generator = JavaWrapperGenerator()

    gen_dict_files = []

    # INFO: I'm not adding modules manually. That info is read from <buildPath>/modules/java_bindings_generator/gen_java.json
    # To add Java Wrapper for a module, find and change the line given below in <module>/CMakeLists.txt:
    # vp_add_module(<mod-name> ....)   -->   vp_add_module(<mod-name> .... WRAP java)
    # Also you need to add support for functions that have to implemented manually in misc/java/<mod-name> folder
    print("JAVA: Processing ViSP modules: %d" % len(config['modules']))
    for e in config['modules']:

        # INFO: Get absolute location of the module
        (module, module_location) = (e['name'], os.path.join(ROOT_DIR, e['location']))
        logging.info("\n=== MODULE: %s (%s) ===\n" % (module, module_location))

        java_path = os.path.join(java_base_path, 'org/visp')
        mkdir_p(java_path)

        module_imports = []
        module_j_code = None
        module_jn_code = None
        srcfiles = []
        common_headers = []

        misc_location = os.path.join(hdr_parser_path, '../misc/' + module)

        # INFO: Get some specific .hpp files for the module. Not all modules contain the set of files
        srcfiles_fname = os.path.join(misc_location, 'filelist')
        if os.path.exists(srcfiles_fname):
            with open(srcfiles_fname) as f:
                srcfiles = [os.path.join(module_location, str(l).strip()) for l in f.readlines() if str(l).strip()]
        else:
            re_bad = re.compile(r'(private|.inl.hpp$|_inl.hpp$|.details.hpp$|_winrt.hpp$|/cuda/)')
            # .h files before .hpp
            h_files = []
            hpp_files = []
            for root, dirnames, filenames in os.walk(os.path.join(module_location, 'include')):
                h_files += [os.path.join(root, filename) for filename in fnmatch.filter(filenames, '*.h')]
                hpp_files += [os.path.join(root, filename) for filename in fnmatch.filter(filenames, '*.hpp')]
            srcfiles = h_files + hpp_files
            srcfiles = [f for f in srcfiles if not re_bad.search(f.replace('\\', '/'))]
        logging.info("\nFiles (%d):\n%s", len(srcfiles), pformat(srcfiles))

        # INFO: Again, get some more .hpp files. Not for all modules
        common_headers_fname = os.path.join(misc_location, 'filelist_common')
        if os.path.exists(common_headers_fname):
            with open(common_headers_fname) as f:
                common_headers = [os.path.join(module_location, str(l).strip()) for l in f.readlines() if
                                  str(l).strip()]
        logging.info("\nCommon headers (%d):\n%s", len(common_headers), pformat(common_headers))

        '''
            # INFO: Not all C++ files can be directly turned to Java/JNI files. Get all
            such files and classes here. Include classes/functions that are to be ignored,
            new classes to be added manually. Sometimes arguments are to be changed while the
            function can be used

            Such files exist for a few root/core modules only like core, imgproc, calib
        '''
        gendict_fname = os.path.join(misc_location, 'gen_dict.json')
        if os.path.exists(gendict_fname):
            with open(gendict_fname) as f:
                gen_type_dict = json.load(f)
            class_ignore_list += gen_type_dict.get("class_ignore_list", [])
            const_ignore_list += gen_type_dict.get("const_ignore_list", [])
            const_private_list += gen_type_dict.get("const_private_list", [])
            missing_consts.update(gen_type_dict.get("missing_consts", {}))
            type_dict.update(gen_type_dict.get("type_dict", {}))
            ManualFuncs.update(gen_type_dict.get("ManualFuncs", {}))
            ToStringSupport += gen_type_dict.get("ToStringSupport", [])
            func_arg_fix.update(gen_type_dict.get("func_arg_fix", {}))
            if 'module_j_code' in gen_type_dict:
                module_j_code = read_contents(
                    checkFileRemap(os.path.join(misc_location, gen_type_dict['module_j_code'])))
            if 'module_jn_code' in gen_type_dict:
                module_jn_code = read_contents(
                    checkFileRemap(os.path.join(misc_location, gen_type_dict['module_jn_code'])))
            module_imports += gen_type_dict.get("module_imports", [])

        '''
            # INFO: In light of above, copy the .java files that were manually created to dst folder
            Later machine will generate all other files
        '''
        java_files_dir = os.path.join(misc_location, 'src/java')
        if os.path.exists(java_files_dir):
            copy_java_files(java_files_dir, java_base_path, 'org/visp/' + module)

        java_test_files_dir = os.path.join(misc_location, 'test')
        if os.path.exists(java_test_files_dir):
            copy_java_files(java_test_files_dir, java_test_base_path, 'org/visp/test/' + module)

        # INFO: Here's the meat. Most important function of the whole file
        if len(srcfiles) > 0:
            generator.gen(srcfiles, module, dstdir, jni_path, java_path, common_headers)
        else:
            logging.info("No generated code for module: %s", module)

    '''
        # INFO: Generate a visp_jni.hpp file. Contains #include tags for all
        modules that very to be built and specified at compile time
    '''
    generator.finalize(jni_path)

    print('Generated files: %d (updated %d)' % (total_files, updated_files))