forked from YaaZ/VulkanMemoryAllocator-Hpp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Generate.java
979 lines (864 loc) · 48.2 KB
/
Generate.java
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
import java.io.IOException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.*;
import java.util.function.IntFunction;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* <b>Java 16+</b>
* <pre>{@code java Generate.java <path/to/vk_mem_alloc.h>}</pre>
*/
public class Generate {
static Set<String> BLACKLISTED_UNIQUE_HANDLES = Set.of("DefragmentationContext"); // These handles will not have unique variants
/**
* Represents single sequence of #if - [#elif]... - [#else] - #endif statements.
* It forms a tree structure which is used to check all active conditions at any point in source code.
* E.g. structure field is declared only if some condition is met, and we want to reflect it in our generated code.
*/
static class Ifdef {
final Range parent;
final int start;
final List<Range> ranges = new ArrayList<>();
int end;
boolean skip = false;
Ifdef(Range parent, int start) {
this.parent = parent;
this.start = start;
if (parent != null) parent.ifdef.add(this);
}
Range goTo(StringBuilder content, int index, int fromRange) {
for (int i = fromRange; i < ranges.size(); i++) {
Range r = ranges.get(i);
if (!skip) content.append("\n#").append(r.text);
if (index >= r.start && index < r.end) return r.goTo(content, index);
}
if (parent != null) {
if (!skip) content.append("\n#endif");
return parent.goTo(content, index);
} else return null;
}
void skipLevels(int levels) {
if (levels == 0) return;
skip = true;
if (levels == 1) return;
for (Range r : ranges) {
for (Ifdef d : r.ifdef) d.skipLevels(levels - 1);
}
}
/**
* Represents a single condition range, like #if - #endif, or #elif - #else.
*/
static class Range {
final Ifdef parent;
final int index, start;
final List<Ifdef> ifdef = new ArrayList<>();
final String text;
int end;
Range(Ifdef parent, int start, String text) {
this.parent = parent;
this.start = start;
this.text = text;
index = parent.ranges.size();
parent.ranges.add(this);
}
/**
* Go to given position in source code, inserting encountered statements into given StringBuilder
* @param content where statements are appended
* @param index target position in source code (in characters)
* @return new range which contains given position
*/
Range goTo(StringBuilder content, int index) {
if (index >= start && index < end) {
for (Ifdef d : ifdef) {
if (index >= d.start && index < d.end) return d.goTo(content, index, 0);
}
return this;
} else {
return parent.goTo(content, index, this.index + 1);
}
}
}
/**
* Parse source code and build a tree from extracted conditions
* @param orig original source code
* @param skipLevels how many top-level ranges to skip (this is usually 1 or more, as we want to at least skip include guards)
* @return root range of the generated tree structure
*/
static Range buildTree(String orig, int skipLevels) {
Range root = new Range(new Ifdef(null, 0), 0, null), head = root;
root.parent.end = root.end = orig.length();
Pattern pattern = Pattern.compile("# *(.+)");
Matcher matcher = pattern.matcher(orig);
while (matcher.find()) {
String t = matcher.group(1);
if (t.startsWith("if")) {
Ifdef d = new Ifdef(head, matcher.start());
head = new Range(d, matcher.start(), t);
} else if (t.startsWith("elif") || t.startsWith("else")) {
head.parent.ranges.get(head.parent.ranges.size() - 1).end = matcher.start();
head = new Range(head.parent, matcher.start(), t);
} else if (t.startsWith("endif")) {
head.parent.ranges.get(head.parent.ranges.size() - 1).end = matcher.start();
head.parent.end = matcher.start();
head = head.parent.parent;
}
}
root.parent.skipLevels(skipLevels + 1);
return root;
}
}
record TemplateEntry<T>(T data, int position) {
static final Pattern loopPattern = Pattern.compile("\\{\\{\\{([\\w\\W]+?)}}}\n");
static final Pattern entryPattern = Pattern.compile("\\$\\{(.*?\\^)?(.*?)(\\$.*?)?}");
}
/**
* Expressions $0 ... $N are replaced with corresponding strings from {@code replacementStrings}
*/
static String processTemplate(String template, String... replacementStrings) {
for (int i = 0; i < replacementStrings.length; i++) {
String pattern = "$" + i;
String[] replacementLines = replacementStrings[i].split("\n");
for (int ix, last = template.length(); (ix = template.lastIndexOf(pattern, last)) != -1; last = ix) {
int nl = template.lastIndexOf('\n', ix) + 1;
String indent = "\n" + " ".repeat(ix - nl);
StringBuilder s = new StringBuilder();
s.append(template, 0, ix).append(replacementLines[0]);
for (int j = 1; j < replacementLines.length; j++) s.append(indent).append(replacementLines[j]);
s.append(template, ix + pattern.length(), template.length());
template = s.toString();
}
}
return template.replaceAll("(?m)^[ \\t]+(?=$|#)", ""); // Strip blank lines & trailing whitespaces for preprocessor defs
}
/**
* Expressions inside triple curly braces {{{}}} are replaced for each entry in {@code entries} list,
* where you can use ${someGetter} expressions to access getter methods of the entry
* and {@code ${firstIteration^anything$lastIteration}} syntax to add text only for specific iterations
* (e.g. when generating comma separated lists).
* Then expressions $0 ... $N are replaced with corresponding strings from {@code replacementStrings}
*/
static <T> String processTemplate(Ifdef.Range ifdef, int sourcePosition,
String template, List<TemplateEntry<T>> entries, String... replacementStrings) {
int lastIndex = 0;
StringBuilder content = new StringBuilder();
if (ifdef != null) ifdef = ifdef.goTo(content, sourcePosition);
Matcher loopMatcher = TemplateEntry.loopPattern.matcher(template);
while (loopMatcher.find()) {
content.append(template, lastIndex, loopMatcher.start());
lastIndex = loopMatcher.end();
int nl = template.lastIndexOf('\n', loopMatcher.start()) + 1;
String indent = "\n" + " ".repeat(loopMatcher.start() - nl);
String entryTemplate = loopMatcher.group(1);
Matcher entryMatcher = TemplateEntry.entryPattern.matcher(entryTemplate);
List<IntFunction<String>> entryTextParts = new ArrayList<>();
int li = 0;
while (entryMatcher.find()) {
String textPart = entryTemplate.substring(li, entryMatcher.start());
entryTextParts.add(i -> textPart);
li = entryMatcher.end();
String firstIteration = entryMatcher.group(1), entry = entryMatcher.group(2), lastIteration = entryMatcher.group(3);
if (firstIteration == null && lastIteration == null) {
try {
Method getter = entries.get(0).data.getClass().getMethod(entry);
entryTextParts.add(i -> {
try {
return getter.invoke(entries.get(i).data).toString();
} catch (IllegalAccessException | InvocationTargetException e) {
throw new Error(e);
}
});
} catch (NoSuchMethodException e) {
throw new Error(e);
}
} else {
entryTextParts.add(i -> {
if (firstIteration != null && i == 0) return firstIteration.substring(0, firstIteration.length() - 1);
if (lastIteration != null && i == entries.size() - 1) return lastIteration.substring(1);
return entry;
});
}
}
String lastPart = entryTemplate.substring(li);
entryTextParts.add(i -> lastPart);
for (int i = 0; i < entries.size(); i++) {
if (ifdef != null) ifdef = ifdef.goTo(content, entries.get(i).position);
if (i != 0) content.append(indent);
for (var e : entryTextParts) content.append(e.apply(i));
}
if (ifdef != null) ifdef = ifdef.goTo(content, sourcePosition);
content.append("\n");
}
content.append(template.substring(lastIndex));
if (ifdef != null) ifdef.goTo(content, -1);
return processTemplate(content.toString(), replacementStrings);
}
/**
* Simplified version of {@link #processTemplate(Ifdef.Range, int, String, List, String...)}.
*/
static <T> String processTemplate(String template, Stream<T> entries, String... replacementStrings) {
return processTemplate(null, 0, template, entries.map(e -> new TemplateEntry<>(e, 0)).toList(), replacementStrings);
}
static List<String> generateEnums(String orig, Ifdef.Range ifdef) throws IOException {
List<String> enums = new ArrayList<>();
record Entry(String name, String originalName) {}
StringBuilder content = new StringBuilder();
Pattern typedefPattern = Pattern.compile("typedef\\s+enum\\s+Vma(\\w+)");
Pattern entryPattern = Pattern.compile("(VMA_\\w+)[^,}]*");
Matcher typedefMatcher = typedefPattern.matcher(orig);
while (typedefMatcher.find()) {
String name = typedefMatcher.group(1);
boolean flagBits = name.endsWith("FlagBits");
String flags = flagBits ? name.substring(0, name.length() - 4) + "s" : null;
enums.add(name);
if (flagBits) enums.add(flags);
String body = orig.substring(typedefMatcher.end(), orig.indexOf("}", typedefMatcher.end()));
Matcher entryMatcher = entryPattern.matcher(body);
List<TemplateEntry<Entry>> entries = new ArrayList<>();
while (entryMatcher.find()) {
String value = entryMatcher.group(1);
if (value.endsWith("_MAX_ENUM")) break;
if (flagBits && !value.endsWith("_BIT")) continue;
String entry = Stream.of(value.split("_"))
.map(t -> t.substring(0, 1).toUpperCase() + t.substring(1).toLowerCase())
.collect(Collectors.joining());
if (flagBits) entry = entry.substring(name.length() - 5, entry.length() - 3);
else entry = entry.substring(name.length() + 3);
entries.add(new TemplateEntry<>(new Entry(entry, value), typedefMatcher.end() + entryMatcher.start()));
}
content.append(processTemplate(ifdef, typedefMatcher.start(), """
VMA_EXPORT namespace VMA_HPP_NAMESPACE {
enum class $0$1 {
{{{e${name} = ${originalName}${,$}}}}
};
# if !defined( VULKAN_HPP_NO_TO_STRING )
VULKAN_HPP_INLINE std::string to_string($0 value) {
{{{if (value == $0::e${name}) return "${name}";}}}
return "invalid ( " + VULKAN_HPP_NAMESPACE::toHexString(static_cast<uint32_t>(value)) + " )";
}
# endif
}
""", entries, name, flagBits ? (" : Vma" + flags) : ""));
if (flagBits) {
content.append(processTemplate(ifdef, typedefMatcher.start(), """
VMA_EXPORT namespace VULKAN_HPP_NAMESPACE {
template<> struct FlagTraits<VMA_HPP_NAMESPACE::$0> {
static VULKAN_HPP_CONST_OR_CONSTEXPR bool isBitmask = true;
static VULKAN_HPP_CONST_OR_CONSTEXPR Flags<VMA_HPP_NAMESPACE::$0> allFlags =
{{{${ ^|} VMA_HPP_NAMESPACE::$0::e${name}${$;}}}}
};
}
VMA_EXPORT namespace VMA_HPP_NAMESPACE {
using $1 = VULKAN_HPP_NAMESPACE::Flags<$0>;
VULKAN_HPP_INLINE VULKAN_HPP_CONSTEXPR $1 operator|($0 bit0, $0 bit1) VULKAN_HPP_NOEXCEPT {
return $1(bit0) | bit1;
}
VULKAN_HPP_INLINE VULKAN_HPP_CONSTEXPR $1 operator&($0 bit0, $0 bit1) VULKAN_HPP_NOEXCEPT {
return $1(bit0) & bit1;
}
VULKAN_HPP_INLINE VULKAN_HPP_CONSTEXPR $1 operator^($0 bit0, $0 bit1) VULKAN_HPP_NOEXCEPT {
return $1(bit0) ^ bit1;
}
VULKAN_HPP_INLINE VULKAN_HPP_CONSTEXPR $1 operator~($0 bits) VULKAN_HPP_NOEXCEPT {
return ~($1(bits));
}
# if !defined( VULKAN_HPP_NO_TO_STRING )
VULKAN_HPP_INLINE std::string to_string($1 value) {
if (!value) return "{}";
std::string result;
{{{if (value & $0::e${name}) result += "${name} | ";}}}
return "{ " + result.substr( 0, result.size() - 3 ) + " }";
}
# endif
}
""", entries, name, flags));
}
}
Files.writeString(Path.of("include/vk_mem_alloc_enums.hpp"), processTemplate("""
#ifndef VULKAN_MEMORY_ALLOCATOR_ENUMS_HPP
#define VULKAN_MEMORY_ALLOCATOR_ENUMS_HPP
$0
#endif
""", content.toString()));
return enums;
}
enum VarTag {
NONE,
NULLABLE,
NOT_NULL
}
/**
* Parsed variable declaration (field or function parameter)
* @param type (probably) converted type, e.g. VkResult -> vk::Result or VmaAllocator -> vma::Allocator
* @param name variable name
* @param constant whether it's constant
* @param pointer whether it's a pointer
* @param originalType original type
* @param underlyingType underlying type (`type` without const and pointers applied)
*/
record Var(String originalType, boolean constant, String type, boolean pointer, VarTag tag,
String lenIfNotNull, boolean primitive, String underlyingType, String name) {
static final Pattern pattern = Pattern.compile(
"(const\\s+)?(\\w+)" +
"(\\s*\\*)?(?:\\s+VMA_(NULLABLE|NOT_NULL)(?:_NON_DISPATCHABLE)?)?" +
"(\\s*\\*)?(?:\\s+VMA_(NULLABLE|NOT_NULL)(?:_NON_DISPATCHABLE)?)?" +
"(?:\\s+(VMA_LEN_IF_NOT_NULL|VMA_EXTENDS_VK_STRUCT)\\(\\s*([^)]+)\\s*\\))?" +
"\\s+(\\w+)" +
"((?:\\s*\\[\\w+])+)?" +
"\\s*[;,)]");
private static String applyConstAndPointers(String type, boolean constant, boolean pointer1, boolean pointer2) {
if (constant && (pointer1 || pointer2)) type = "const " + type;
if (pointer1) type += "*";
if (pointer2) type += "*";
return type;
}
static Var parse(Matcher matcher) {
String originalType = matcher.group(2), type = originalType;
if (type.startsWith("Vk")) type = "VULKAN_HPP_NAMESPACE::" + type.substring(2);
else if (type.startsWith("Vma")) type = type.substring(3);
String underlyingType = type;
boolean primitive = switch (type) {
case "void", "char", "uint32_t", "size_t" -> true;
default -> false;
};
boolean c = matcher.group(1) != null, p1 = matcher.group(3) != null, p2 = matcher.group(5) != null;
type = applyConstAndPointers(type, c, p1, p2);
originalType = applyConstAndPointers(originalType, c, p1, p2);
String tag1 = matcher.group(4), tag2 = matcher.group(6);
VarTag tag = VarTag.NONE;
if (p2) {
if (tag2 != null) tag = VarTag.valueOf(tag2);
} else if (tag1 != null) tag = VarTag.valueOf(tag1);
String arr = matcher.group(10);
if (arr != null) {
arr = arr.strip();
while (!arr.isEmpty()) {
int i = arr.lastIndexOf('[');
String dim = arr.substring(i + 1, arr.length() - 1).strip();
arr = arr.substring(0, i).strip();
type = "std::array<" + type + ", " + dim + ">";
}
}
if (p1 && p2) c = false; // double pointer, then first-level pointer is not const
String lenIfNotNull = null;
if ((matcher.group(7) != null) && (matcher.group(7).equals("VMA_LEN_IF_NOT_NULL"))) {
lenIfNotNull = matcher.group(8);
}
return new Var(originalType, c, type, p1 || p2, tag, lenIfNotNull, primitive, underlyingType, matcher.group(9));
}
public String capitalName() {
return name.substring(0, 1).toUpperCase() + name.substring(1);
}
private static final Pattern pointerVariableNamePattern = Pattern.compile("p+([A-Z])(\\w+)");
public String prettyName() {
Matcher m = pointerVariableNamePattern.matcher(name);
return m.matches() ? m.group(1).toLowerCase() + m.group(2) : name;
}
public String stripPtr() {
return type.substring(0, type.length() - 1);
}
}
static List<String> generateStructs(String orig, Ifdef.Range ifdef) throws IOException {
List<String> structs = new ArrayList<>();
StringBuilder content = new StringBuilder();
Pattern typedefPattern = Pattern.compile("typedef\\s+struct\\s+Vma(\\w+)");
Matcher typedefMatcher = typedefPattern.matcher(orig);
while (typedefMatcher.find()) {
String name = typedefMatcher.group(1);
structs.add(name);
String body = orig.substring(typedefMatcher.end(), orig.indexOf("}", typedefMatcher.end()));
List<TemplateEntry<Var>> fields = new ArrayList<>();
Matcher memberMatcher = Var.pattern.matcher(body);
while (memberMatcher.find()) {
fields.add(new TemplateEntry<>(Var.parse(memberMatcher), typedefMatcher.end() + memberMatcher.start()));
}
content.append(processTemplate(ifdef, typedefMatcher.start(), """
struct $0 {
using NativeType = Vma$0;
#if !defined( VULKAN_HPP_NO_STRUCT_CONSTRUCTORS )
VULKAN_HPP_CONSTEXPR $0(
{{{${ ^,} ${type} ${name}_ = {}}}}
) VULKAN_HPP_NOEXCEPT
{{{${:^,} ${name}(${name}_)}}}
{}
VULKAN_HPP_CONSTEXPR $0($0 const &) VULKAN_HPP_NOEXCEPT = default;
$0(Vma$0 const & rhs) VULKAN_HPP_NOEXCEPT : $0(*reinterpret_cast<$0 const *>(&rhs)) {}
#endif
$0& operator=($0 const &) VULKAN_HPP_NOEXCEPT = default;
$0& operator=(Vma$0 const & rhs) VULKAN_HPP_NOEXCEPT {
*this = *reinterpret_cast<VMA_HPP_NAMESPACE::$0 const *>(&rhs);
return *this;
}
explicit operator Vma$0 const &() const VULKAN_HPP_NOEXCEPT {
return *reinterpret_cast<const Vma$0 *>(this);
}
explicit operator Vma$0&() VULKAN_HPP_NOEXCEPT {
return *reinterpret_cast<Vma$0 *>(this);
}
#if defined( VULKAN_HPP_HAS_SPACESHIP_OPERATOR )
bool operator==($0 const &) const = default;
#else
bool operator==($0 const & rhs) const VULKAN_HPP_NOEXCEPT {
{{{${return^ &&} ${name} == rhs.${name}}}}
;
}
#endif
#if !defined( VULKAN_HPP_NO_STRUCT_SETTERS )
{{{
VULKAN_HPP_CONSTEXPR_14 $0& set${capitalName}(${type} ${name}_) VULKAN_HPP_NOEXCEPT {
${name} = ${name}_;
return *this;
}}}}
#endif
public:
{{{${type} ${name} = {};}}}
};
VULKAN_HPP_STATIC_ASSERT(sizeof($0) == sizeof(Vma$0),
"struct and wrapper have different size!");
VULKAN_HPP_STATIC_ASSERT(std::is_standard_layout<$0>::value,
"struct wrapper is not a standard layout!");
VULKAN_HPP_STATIC_ASSERT(std::is_nothrow_move_constructible<$0>::value,
"$0 is not nothrow_move_constructible!");
""", fields, name));
}
Files.writeString(Path.of("include/vk_mem_alloc_structs.hpp"), processTemplate("""
#ifndef VULKAN_MEMORY_ALLOCATOR_STRUCTS_HPP
#define VULKAN_MEMORY_ALLOCATOR_STRUCTS_HPP
VMA_EXPORT namespace VMA_HPP_NAMESPACE {
$0
}
#endif
""", content.toString()));
return structs;
}
/**
* Handle class, from which ..._handles.hpp and ..._funcs.hpp files are generated
*/
static class Handle {
final String name;
final boolean dispatchable;
final StringBuilder declarations = new StringBuilder(), definitions = new StringBuilder();
Ifdef.Range ifdef;
final Set<Handle> dependencies = new LinkedHashSet<>();
final Set<String> methods = new LinkedHashSet<>();
Handle owner = null;
boolean appended = false;
Handle(String name, boolean dispatchable, Ifdef.Range ifdef) {
this.name = name;
this.dispatchable = dispatchable;
this.ifdef = ifdef;
}
public String name() { return name; }
boolean hasUniqueVariant() { return !BLACKLISTED_UNIQUE_HANDLES.contains(name); }
String getLowerName() {
return name.substring(0, 1).toLowerCase() + name.substring(1);
}
String generateClass() {
return processTemplate("""
VMA_EXPORT namespace VMA_HPP_NAMESPACE {
class $0 {
public:
using CType = Vma$0;
using NativeType = Vma$0;
public:
VULKAN_HPP_CONSTEXPR $0() = default;
VULKAN_HPP_CONSTEXPR $0(std::nullptr_t) VULKAN_HPP_NOEXCEPT {}
VULKAN_HPP_TYPESAFE_EXPLICIT $0(Vma$0 $1) VULKAN_HPP_NOEXCEPT : m_$1($1) {}
#if defined(VULKAN_HPP_TYPESAFE_CONVERSION)
$0& operator=(Vma$0 $1) VULKAN_HPP_NOEXCEPT {
m_$1 = $1;
return *this;
}
#endif
$0& operator=(std::nullptr_t) VULKAN_HPP_NOEXCEPT {
m_$1 = {};
return *this;
}
#if defined( VULKAN_HPP_HAS_SPACESHIP_OPERATOR )
auto operator<=>($0 const &) const = default;
#else
bool operator==($0 const & rhs) const VULKAN_HPP_NOEXCEPT {
return m_$1 == rhs.m_$1;
}
#endif
VULKAN_HPP_TYPESAFE_EXPLICIT operator Vma$0() const VULKAN_HPP_NOEXCEPT {
return m_$1;
}
explicit operator bool() const VULKAN_HPP_NOEXCEPT {
return m_$1 != VK_NULL_HANDLE;
}
bool operator!() const VULKAN_HPP_NOEXCEPT {
return m_$1 == VK_NULL_HANDLE;
}
$2
private:
Vma$0 m_$1 = {};
};
VULKAN_HPP_STATIC_ASSERT(sizeof($0) == sizeof(Vma$0),
"handle and wrapper have different size!");
}
""" + (hasUniqueVariant() ? """
#ifndef VULKAN_HPP_NO_SMART_HANDLE
VMA_EXPORT namespace VULKAN_HPP_NAMESPACE {
template<> class UniqueHandleTraits<VMA_HPP_NAMESPACE::$0, VMA_HPP_NAMESPACE::Dispatcher> {
public:
using deleter = VMA_HPP_NAMESPACE::Deleter<VMA_HPP_NAMESPACE::$0, $3>;
};
}
VMA_EXPORT namespace VMA_HPP_NAMESPACE { using Unique$0 = VULKAN_HPP_NAMESPACE::UniqueHandle<$0, Dispatcher>; }
#endif
""" : ""),
name, getLowerName(), declarations.toString().indent(4),
owner == null ? "void" : "VMA_HPP_NAMESPACE::" + owner.name);
}
String generateNamespace() {
return processTemplate("""
VMA_EXPORT namespace VMA_HPP_NAMESPACE {
$0
}
""", declarations.toString().indent(2));
}
void append(StringBuilder declarations, StringBuilder definitions) {
if (appended) return;
for (Handle h : dependencies) h.append(declarations, definitions);
ifdef.goTo(this.declarations, -1);
ifdef.goTo(this.definitions, -1);
declarations.append("\n").append(name == null ? generateNamespace() : generateClass());
definitions.append(this.definitions);
appended = true;
}
}
static String deduceVectorSize(String funcName, String lenIfNotNull) {
// These are exceptional cases, which needs some custom code to achieve smart behavior
if (funcName.equals("vmaGetHeapBudgets") && lenIfNotNull.equals("\"VkPhysicalDeviceMemoryProperties::memoryHeapCount\"")) {
return "getMemoryProperties()->memoryHeapCount";
} else {
throw new Error("Don't know how to deduce vector size: " + lenIfNotNull + " in " + funcName);
}
}
static List<Handle> generateHandles(String orig, Ifdef.Range ifdef, List<String> structs) throws IOException {
// Forward declarations for structs
StringBuilder forwardDeclarations = new StringBuilder(), declarations = new StringBuilder(), definitions = new StringBuilder();
for (String s : structs) forwardDeclarations.append("\nstruct ").append(s).append(";");
// Find all handles
Handle namespaceHandle = new Handle(null, false, ifdef);
Map<String, Handle> handles = new LinkedHashMap<>();
Pattern handlePattern = Pattern.compile("VK_DEFINE_(NON_DISPATCHABLE_)?HANDLE\\s*\\(\\s*Vma(\\w+)\\s*\\)");
Matcher handleMatcher = handlePattern.matcher(orig);
while (handleMatcher.find()) {
String name = handleMatcher.group(2);
Handle h = new Handle(name, handleMatcher.group(1) == null, ifdef);
handles.put("Vma" + name, h);
namespaceHandle.dependencies.add(h);
}
// Forward declarations for handles
forwardDeclarations.append("\n\n");
for (Handle h : handles.values()) forwardDeclarations.append("class ").append(h.name).append(";\n");
// Iterate VMA functions
Pattern funcPattern = Pattern.compile("VMA_CALL_PRE\\s+(\\w+)\\s+VMA_CALL_POST\\s+vma(\\w+)\\s*(\\([\\s\\S]+?\\)\\s*;)");
Matcher funcMatcher = funcPattern.matcher(orig);
while (funcMatcher.find()) {
Matcher paramMatcher = Var.pattern.matcher(funcMatcher.group(3));
List<Var> params = new ArrayList<>();
while (paramMatcher.find()) params.add(Var.parse(paramMatcher));
// Find dispatchable handle if any
Handle handle = handles.getOrDefault(params.get(0).originalType, namespaceHandle);
if (handle != namespaceHandle) params.remove(0);
// Find handle dependencies
if (handle != namespaceHandle) {
for (Var p : params) {
Handle h = handles.get(p.originalType);
if (h != null && h != handle) handle.dependencies.add(h);
}
}
Map<String, Integer> paramIndexByName = new HashMap<>();
for (int i = 0; i < params.size(); i++) paramIndexByName.put(params.get(i).name, i);
String name = funcMatcher.group(2);
String funcName = "vma" + name; // Original function name
if (handle != namespaceHandle && name.equals("Destroy" + handle.name)) name = "destroy"; // E.g. Allocator::destroyAllocator -> Allocator::destroy
String methodName = name.substring(0, 1).toLowerCase() + name.substring(1); // Generated method name
handle.methods.add(methodName);
// Find dependencies of array sizes
Integer[] arrayByLengthIndex = new Integer[params.size()];
for (int i = 0; i < params.size(); i++) {
Var v = params.get(i);
if (v.lenIfNotNull == null) continue;
if (v.constant && !v.underlyingType.equals("void")) { // Input array, respective size parameter can be deduced
Integer l = paramIndexByName.get(v.lenIfNotNull);
if (l != null && arrayByLengthIndex[l] == null) arrayByLengthIndex[l] = i;
}
}
// Find output params
List<Integer> outputs = new ArrayList<>(), defaultedOutputs = new ArrayList<>();
for (int i = 0; i < params.size(); i++) {
Var v = params.get(i);
if (v.pointer && !v.constant && !v.originalType.equals("void*")) {
if (v.tag == VarTag.NOT_NULL) outputs.add(i);
else if (!v.primitive) {
defaultedOutputs.add(i);
continue;
}
}
defaultedOutputs.clear();
}
String returnType = switch (funcMatcher.group(1)) {
case "void" -> "void";
case "VkResult" -> "VULKAN_HPP_NAMESPACE::Result";
case "VkBool32" -> "VULKAN_HPP_NAMESPACE::Bool32";
default -> throw new Error("Unknown return type: " + funcMatcher.group(1));
};
class Method {
final boolean enhanced;
final List<String> paramTypes = new ArrayList<>(), paramsPass = new ArrayList<>();
final List<Integer> paramIndices = new ArrayList<>();
boolean returnsHandles = false;
Method(boolean enhanced) {
this.enhanced = enhanced;
if (handle != namespaceHandle) paramsPass.add("m_" + handle.getLowerName());
for (int i = 0; i < params.size(); i++) {
Var p = params.get(i);
String v = p.prettyName();
if (p.type.equals(p.originalType)) {
if (enhanced && outputs.contains(i)) v = "&" + v;
} else if (p.pointer) {
if (enhanced) {
if (p.lenIfNotNull != null) v += ".data()";
else if (p.tag == VarTag.NOT_NULL) v = "&" + v;
else if (!p.constant && !p.primitive) v = "static_cast<" + p.type + ">(" + v + ")";
}
v = "reinterpret_cast<" + p.originalType + ">(" + v + ")";
} else v = "static_cast<" + p.originalType + ">(" + v + ")";
paramsPass.add(v);
if (enhanced) {
if (outputs.contains(i)) {
String n = params.get(i).stripPtr();
Handle h = handles.get("Vma" + n);
if (h != null && !BLACKLISTED_UNIQUE_HANDLES.contains(n)) {
if (handle != namespaceHandle) h.owner = handle;
returnsHandles = true;
}
continue; // Skip output parameters
}
if (arrayByLengthIndex[i] != null) continue; // Skip length parameters which can be deduced
}
String t = p.type;
if (enhanced && p.pointer && !p.underlyingType.equals("void")) {
if (p.lenIfNotNull != null) t = "VULKAN_HPP_NAMESPACE::" + (p.constant ? "ArrayProxy<" : "ArrayProxyNoTemporaries<") + p.stripPtr() + ">";
else if (p.tag == VarTag.NOT_NULL) t = p.stripPtr() + "&";
else if (!p.constant && !p.primitive) t = "VULKAN_HPP_NAMESPACE::Optional<" + p.stripPtr() + ">";
}
paramTypes.add(t);
paramIndices.add(i);
}
}
String returnType(int i, boolean uniqueHandle) {
String t = params.get(outputs.get(i)).stripPtr();
if (uniqueHandle) {
if (t.startsWith("VULKAN_HPP_NAMESPACE::")) t = t.substring(22); // We use our own unique handles for Vulkan types
t = "Unique" + t;
}
return t;
}
String returnType(boolean uniqueHandle, boolean noVectorAllocator) {
return enhanced ? switch (outputs.size()) {
case 2 -> "std::pair<" + returnType(0, uniqueHandle) + ", " + returnType(1, uniqueHandle) + ">";
case 1 -> params.get(outputs.get(0)).lenIfNotNull != null ? "std::vector<" + returnType(0, uniqueHandle) + (noVectorAllocator ? "" : ", VectorAllocator") + ">" : returnType(0, uniqueHandle);
default -> returnType.equals("VULKAN_HPP_NAMESPACE::Result") ? "void" : returnType;
} : returnType;
}
String returnType(boolean uniqueHandle) { return returnType(uniqueHandle, false); }
String generate(boolean definition, boolean uniqueHandle, boolean customVectorAllocator) {
if (outputs.size() >= 3) throw new Error("3+ mandatory outputs");
if (outputs.size() != 0 && !returnType.equals("void") && !returnType.equals("VULKAN_HPP_NAMESPACE::Result")) throw new Error("Both return value and output parameters");
if (outputs.size() >= 2 && params.get(outputs.get(0)).lenIfNotNull != null) throw new Error("2+ mandatory outputs with at least one array");
String ret = returnType(false);
String decl = "";
// Generate template for vector allocator
if (enhanced && outputs.size() == 1 && params.get(outputs.get(0)).lenIfNotNull != null) {
if (!customVectorAllocator) decl = generate(definition, uniqueHandle, true) + "\n";
decl += "template<typename VectorAllocator";
if (!definition) decl += " = std::allocator<" + returnType(0, uniqueHandle) + ">";
if (customVectorAllocator) {
decl += ",\n typename B";
if (!definition) decl += " = VectorAllocator";
decl += ",\n typename std::enable_if<std::is_same<typename B::value_type, " +
returnType(0, uniqueHandle) + ">::value, int>::type";
if (!definition) decl += " = 0";
}
decl += ">\n";
}
if (definition) decl += "VULKAN_HPP_INLINE ";
else if (!ret.equals("void")) decl += enhanced ? "VULKAN_HPP_NODISCARD_WHEN_NO_EXCEPTIONS " : "VULKAN_HPP_NODISCARD ";
decl += (enhanced && returnType.equals("VULKAN_HPP_NAMESPACE::Result") ? "typename VULKAN_HPP_NAMESPACE::ResultValueType<" + returnType(uniqueHandle) + ">::type" : returnType(uniqueHandle)) + " ";
if (definition && handle != namespaceHandle) decl += handle.name + "::";
StringBuilder s = new StringBuilder();
for (int i = 0; i < paramTypes.size(); i++) {
if (i != 0) s.append(",\n");
s.append(paramTypes.get(i)).append(" ").append(params.get(paramIndices.get(i)).prettyName());
if (enhanced && !definition && defaultedOutputs.contains(paramIndices.get(i)) && !customVectorAllocator) s.append(" = nullptr");
}
if (customVectorAllocator) {
if (!paramTypes.isEmpty()) s.append(",\n");
s.append("VectorAllocator& vectorAllocator");
}
decl = processTemplate("$0$1($2)$3", decl, methodName + (uniqueHandle ? "Unique" : ""), s.toString(), handle != namespaceHandle ? " const" : "");
if (!definition) return decl + ";\n";
s.setLength(0);
if (enhanced) {
// Generate deduction statements
for (int i = 0; i < params.size(); i++) {
Var p = params.get(i);
if (arrayByLengthIndex[i] != null) s.append(p.type).append(" ").append(p.prettyName())
.append(" = ").append(params.get(arrayByLengthIndex[i]).prettyName()).append(".size();\n");
}
// Generate output variable declarations
if (outputs.size() == 2) {
Var p1 = params.get(outputs.get(0)), p2 = params.get(outputs.get(1));
s.append(ret).append(" pair;\n")
.append(p1.stripPtr()).append("& ").append(p1.prettyName()).append(" = pair.first;\n")
.append(p2.stripPtr()).append("& ").append(p2.prettyName()).append(" = pair.second;\n");
} else if (outputs.size() == 1) {
Var p = params.get(outputs.get(0));
s.append(returnType(false, uniqueHandle)).append(" ").append(p.prettyName());
if (p.lenIfNotNull != null) {
s.append("(").append(paramIndexByName.get(p.lenIfNotNull) != null ?
p.lenIfNotNull : deduceVectorSize(funcName, p.lenIfNotNull)).append(customVectorAllocator && !uniqueHandle ? ", vectorAllocator)" : ")");
}
s.append(";\n");
}
}
// Generate call
if (!returnType.equals("void")) s.append(returnType).append(" result = static_cast<").append(returnType).append(">( ");
s.append(funcName).append("(").append(String.join(", ", paramsPass)).append(")");
if (!returnType.equals("void")) s.append(" )");
s.append(";");
// Generate return statement
String returnValue = enhanced ? switch (outputs.size()) {
case 2 -> "pair";
case 1 -> params.get(outputs.get(0)).prettyName();
default -> "result";
} : "result";
if (enhanced && returnType.equals("VULKAN_HPP_NAMESPACE::Result")) {
// Check result
if (uniqueHandle) {
if (params.get(outputs.get(0)).lenIfNotNull != null) {
returnValue = "createUniqueHandleVector(" + returnValue +
(handle != namespaceHandle ? ", *this" : "") +
(customVectorAllocator ? ", vectorAllocator)" : ", VectorAllocator())");
} else {
returnValue = "createUniqueHandle(" + returnValue +
(handle != namespaceHandle ? ", *this)" : ")");
}
}
if (ret.equals("void")) returnValue = "result";
else returnValue = "result, " + returnValue;
s.append("\nVMA_HPP_NAMESPACE::detail::resultCheck(result, VMA_HPP_NAMESPACE_STRING \"::");
if (handle != namespaceHandle) s.append(handle.name).append("::");
s.append(methodName).append("\");\nreturn VMA_HPP_NAMESPACE::detail::createResultValueType(").append(returnValue).append(");");
} else if (!ret.equals("void")) s.append("\nreturn ").append(returnValue).append(";");
return processTemplate("""
$0 {
$1
}
""", decl, s.toString());
}
}
Method simple = new Method(false), enhanced = new Method(true);
boolean sameSignatures = simple.paramTypes.equals(enhanced.paramTypes);
handle.ifdef.goTo(handle.declarations, funcMatcher.start());
handle.ifdef = handle.ifdef.goTo(handle.definitions, funcMatcher.start());
handle.declarations.append("\n#ifndef VULKAN_HPP_DISABLE_ENHANCED_MODE\n").append(enhanced.generate(false, false, false));
handle.definitions.append("\n#ifndef VULKAN_HPP_DISABLE_ENHANCED_MODE\n").append(enhanced.generate(true, false, false));
if (enhanced.returnsHandles) {
handle.declarations.append("#ifndef VULKAN_HPP_NO_SMART_HANDLE\n").append(enhanced.generate(false, true, false)).append("#endif\n");
handle.definitions.append("#ifndef VULKAN_HPP_NO_SMART_HANDLE\n").append(enhanced.generate(true, true, false)).append("#endif\n");
}
handle.declarations.append(sameSignatures ? "#else\n" : "#endif\n").append(simple.generate(false, false, false));
handle.definitions.append(sameSignatures ? "#else\n" : "#endif\n").append(simple.generate(true, false, false));
if (sameSignatures) {
handle.declarations.append("#endif\n");
handle.definitions.append("#endif\n");
}
}
namespaceHandle.append(declarations, definitions);
Files.writeString(Path.of("include/vk_mem_alloc_handles.hpp"), processTemplate("""
#ifndef VULKAN_MEMORY_ALLOCATOR_HANDLES_HPP
#define VULKAN_MEMORY_ALLOCATOR_HANDLES_HPP
VMA_EXPORT namespace VMA_HPP_NAMESPACE {
$0
}
$1
#endif
""", forwardDeclarations.toString(), declarations.toString()));
Files.writeString(Path.of("include/vk_mem_alloc_funcs.hpp"), processTemplate("""
#ifndef VULKAN_MEMORY_ALLOCATOR_FUNCS_HPP
#define VULKAN_MEMORY_ALLOCATOR_FUNCS_HPP
VMA_EXPORT namespace VMA_HPP_NAMESPACE {
$0
}
#endif
""", definitions.toString()));
return Stream.concat(Stream.of(namespaceHandle), handles.values().stream()).toList();
}
static void generateModule(List<String> enums, List<String> structs, List<Handle> handles) throws IOException {
Files.writeString(Path.of("src/vk_mem_alloc.cppm"), """
module;
#define VMA_BUILD_MODULE
#ifndef VMA_USE_VULKAN_HPP_MODULE
#define VMA_USE_VULKAN_HPP_MODULE 0
#endif
#ifndef VMA_USE_STD_MODULE
#define VMA_USE_STD_MODULE 0
#endif
#define VMA_IMPLEMENTATION
#include <vk_mem_alloc.h>
#include <vulkan/vulkan_hpp_macros.hpp>
#if !VMA_USE_VULKAN_HPP_MODULE
#include <vulkan/vulkan.hpp>
#endif
#if !VMA_USE_STD_MODULE
#include <string>
#include <vector>
#endif
export module vk_mem_alloc_hpp;
#if VMA_USE_VULKAN_HPP_MODULE
import vulkan_hpp;
#endif
#if VMA_USE_STD_MODULE
import std.compat;
#endif
#include "vk_mem_alloc.hpp"
""" +
processTemplate("""
module : private;
#ifndef VULKAN_HPP_NO_SMART_HANDLE
// Instantiate unique handle templates.
// This is a workaround for MSVC bugs, but wouldn't harm on other compilers anyway.
namespace VULKAN_HPP_NAMESPACE {
template class UniqueHandle<Buffer, VMA_HPP_NAMESPACE::Dispatcher>;
template class UniqueHandle<Image, VMA_HPP_NAMESPACE::Dispatcher>;
{{{template class UniqueHandle<VMA_HPP_NAMESPACE::${name}, VMA_HPP_NAMESPACE::Dispatcher>;}}}
}
#endif
""", handles.stream().skip(1).filter(Handle::hasUniqueVariant)));
}
public static void main(String[] args) throws Exception {
if (args.length != 1) {
System.err.println("Usage: java Generate.java <path/to/vk_mem_alloc.h>");
return;
}
String orig = Files.readString(Path.of(args[0]))
.replaceAll("/\\*[\\s\\S]*?\\*/", "") // Delete multi-line comments
.replaceAll("//.*", ""); // Delete single-line comments
orig = orig.substring(0, orig.indexOf("#ifdef VMA_IMPLEMENTATION")); // Strip implementation part
Ifdef.Range ifdef = Ifdef.buildTree(orig, 2);
List<String> enums = generateEnums(orig, ifdef);
List<String> structs = generateStructs(orig, ifdef);
List<Handle> handles = generateHandles(orig, ifdef, structs);
generateModule(enums, structs, handles);
}
}