-
Notifications
You must be signed in to change notification settings - Fork 2
/
Sdk.zig
1175 lines (1009 loc) · 41.1 KB
/
Sdk.zig
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
//! External dependencies:
//! - `keytool`, `jarsigner` from OpenJDK
//! - `adb` from the Android tools package
const std = @import("std");
const builtin = @import("builtin");
const auto_detect = @import("build/auto-detect.zig");
fn sdkRoot() []const u8 {
return std.fs.path.dirname(@src().file) orelse ".";
}
/// This file encodes a instance of an Android SDK interface.
const Sdk = @This();
/// The builder instance associated with this object.
b: *Builder,
/// A set of tools that run on the build host that are required to complete the
/// project build. Must be created with the `hostTools()` function that passes in
/// the correct relpath to the package.
host_tools: HostTools,
/// The configuration for all non-shipped system tools.
/// Contains the normal default config for each tool.
system_tools: SystemTools = .{},
/// Contains paths to each required input folder.
folders: UserConfig,
versions: ToolchainVersions,
/// Initializes the android SDK.
/// It requires some input on which versions of the tool chains should be used
pub fn init(b: *Builder, user_config: ?UserConfig, versions: ToolchainVersions) *Sdk {
// Make sure the oculus SDK is here
{
var quest_sdk = std.fs.cwd().openDir("quest_sdk", .{}) catch |err| {
std.debug.print(
\\Couldn't find the Oculus Mobile SDK.
\\Please unzip it into ./quest_sdk
\\Refer to README.md for more information.
\\Error: {}
\\
, .{err});
std.os.exit(1);
};
defer quest_sdk.close();
var vrapi = quest_sdk.openDir("VrApi", .{}) catch |err| {
std.debug.print(
\\Found the Quest SDK at ./quest_sdk, but it is configured incorrectly.
\\Please rearrange the files so that the "VrApi" folder in the SDK
\\is at ./quest_sdk/VrApi .
\\Refer to README.md for more information.
\\Error: {}
\\
, .{err});
std.os.exit(1);
};
defer vrapi.close();
var audio_sdk = quest_sdk.openDir("AudioSDK", .{}) catch |err| {
std.debug.print(
\\Found the Quest SDK at ./quest_sdk, but it is missing the Audio SDK.
\\The Oculus Spatial Audio SDK should be unzipped to quest_sdk/AudioSDK.
\\Refer to README.md for more information.
\\Error: {}
\\
, .{err});
std.os.exit(1);
};
defer audio_sdk.close();
var audio_sdk_lib = audio_sdk.openDir("Lib", .{}) catch |err| {
std.debug.print(
\\Found the Audio SDK at ./quest_sdk/AudioSDK, but it is configured incorrectly.
\\Please rearrange the files so that the "Lib" folder in the Audio SDK
\\is at ./quest_sdk/AudioSDK/Lib.
\\Refer to README.md for more information.
\\Error: {}
\\
, .{err});
std.os.exit(1);
};
defer audio_sdk_lib.close();
}
const actual_user_config = user_config orelse auto_detect.findUserConfig(b, versions) catch |err| @panic(@errorName(err));
const system_tools = blk: {
const exe = if (builtin.os.tag == .windows) ".exe" else "";
const zipalign = std.fs.path.join(b.allocator, &[_][]const u8{ actual_user_config.android_sdk_root, "build-tools", versions.build_tools_version, "zipalign" ++ exe }) catch unreachable;
const aapt = std.fs.path.join(b.allocator, &[_][]const u8{ actual_user_config.android_sdk_root, "build-tools", versions.build_tools_version, "aapt" ++ exe }) catch unreachable;
const adb = std.fs.path.join(b.allocator, &[_][]const u8{ actual_user_config.android_sdk_root, "platform-tools", "adb" ++ exe }) catch unreachable;
const jarsigner = std.fs.path.join(b.allocator, &[_][]const u8{ actual_user_config.java_home, "bin", "jarsigner" ++ exe }) catch unreachable;
const keytool = std.fs.path.join(b.allocator, &[_][]const u8{ actual_user_config.java_home, "bin", "keytool" ++ exe }) catch unreachable;
break :blk SystemTools{
.zipalign = zipalign,
.aapt = aapt,
.adb = adb,
.jarsigner = jarsigner,
.keytool = keytool,
};
};
// Compiles all required additional tools for toolchain.
const host_tools = blk: {
const zip_add = b.addExecutable("zip_add", sdkRoot() ++ "/tools/zip_add.zig");
zip_add.addCSourceFile(sdkRoot() ++ "/vendor/kuba-zip/zip.c", &[_][]const u8{
"-std=c99",
"-fno-sanitize=undefined",
});
zip_add.addIncludeDir(sdkRoot() ++ "/vendor/kuba-zip");
zip_add.linkLibC();
break :blk HostTools{
.zip_add = zip_add,
};
};
const sdk = b.allocator.create(Sdk) catch @panic("out of memory");
sdk.* = Sdk{
.b = b,
.host_tools = host_tools,
.system_tools = system_tools,
.folders = actual_user_config,
.versions = versions,
};
return sdk;
}
pub const ToolchainVersions = struct {
android_sdk_version: u16 = 28,
build_tools_version: []const u8 = "28.0.3",
ndk_version: []const u8 = "21.1.6352462",
pub fn androidSdkString(self: ToolchainVersions, buf: *[5]u8) []u8 {
return std.fmt.bufPrint(buf, "{d}", .{self.android_sdk_version}) catch unreachable;
}
};
pub const UserConfig = struct {
android_sdk_root: []const u8 = "",
android_ndk_root: []const u8 = "",
java_home: []const u8 = "",
};
/// Configuration of the Android toolchain.
pub const Config = struct {
/// Path to the SDK root folder.
/// Example: `/home/ziggy/android-sdk`.
sdk_root: []const u8,
/// Path to the NDK root folder.
/// Example: `/home/ziggy/android-sdk/ndk/21.1.6352462`.
ndk_root: []const u8,
/// Path to the build tools folder.
/// Example: `/home/ziggy/android-sdk/build-tools/28.0.3`.
build_tools: []const u8,
/// A key store. This is required when an APK is created and signed.
/// If you don't care for production code, just use the default here
/// and it will work. This needs to be changed to a *proper* key store
/// when you want to publish the app.
key_store: KeyStore = KeyStore{
.file = "zig-cache/",
.alias = "default",
.password = "ziguana",
},
};
/// A resource that will be packed into the appliation.
pub const Resource = struct {
/// This is the relative path to the resource root
path: []const u8,
/// This is the content of the file.
content: std.build.FileSource,
};
/// Configuration of an application.
pub const AppConfig = struct {
/// The display name of the application. This is shown to the users.
display_name: []const u8,
/// Application name, only lower case letters and underscores are allowed.
app_name: []const u8,
/// Java package name, usually the reverse top level domain + app name.
/// Only lower case letters, dots and underscores are allowed.
package_name: []const u8,
/// The android version which is embedded in the manifset.
/// This is usually the same version as of the SDK that was used, but might also be
/// overridden for a specific app.
target_sdk_version: ?u16 = null,
/// The resource directory that will contain the manifest and other app resources.
/// This should be a distinct directory per app.
resources: []const Resource = &[_]Resource{},
/// If true, the app will be started in "fullscreen" mode, this means that
/// navigation buttons as well as the top bar are not shown.
/// This is usually relevant for games.
fullscreen: bool = true,
/// If true, the app will allow hand tracking instead of using remotes
enable_hand_tracking: bool = false,
/// One or more asset directories. Each directory will be added into the app assets.
asset_directories: []const []const u8 = &[_][]const u8{},
permissions: []const []const u8 = &[_][]const u8{
//"android.permission.SET_RELEASE_APP",
//"android.permission.RECORD_AUDIO",
},
};
/// One of the legal targets android can be built for.
pub const Target = enum {
aarch64,
arm,
x86,
x86_64,
};
pub const KeyStore = struct {
file: []const u8,
alias: []const u8,
password: []const u8,
};
pub const HostTools = struct {
zip_add: *std.build.LibExeObjStep,
};
/// Configuration of the binary paths to all tools that are not included in the android SDK.
pub const SystemTools = struct {
//keytool: []const u8 = "keytool",
//adb: []const u8 = "adb",
//jarsigner: []const u8 = "/usr/lib/jvm/java-11-openjdk/bin/jarsigner",
mkdir: []const u8 = "mkdir",
rm: []const u8 = "rm",
zipalign: []const u8 = "zipalign",
aapt: []const u8 = "aapt",
adb: []const u8 = "adb",
jarsigner: []const u8 = "jarsigner",
keytool: []const u8 = "keytool",
};
/// The configuration which targets a app should be built for.
pub const AppTargetConfig = struct {
aarch64: bool = true,
arm: bool = false, // re-enable when https://github.com/ziglang/zig/issues/8885 is resolved
x86_64: bool = false,
x86: bool = false,
};
pub const CreateAppStep = struct {
sdk: *Sdk,
first_step: *std.build.Step,
final_step: *std.build.Step,
libraries: []const *std.build.LibExeObjStep,
build_options: *BuildOptionStep,
apk_file: std.build.FileSource,
package_name: []const u8,
pub fn getAndroidPackage(self: @This(), name: []const u8) std.build.Pkg {
return self.sdk.b.dupePkg(std.build.Pkg{
.name = name,
.path = .{ .path = sdkRoot() ++ "/src/android-support.zig" },
.dependencies = &[_]std.build.Pkg{
self.build_options.getPackage("build_options"),
},
});
}
pub fn install(self: @This()) *Step {
return self.sdk.installApp(self.apk_file);
}
pub fn run(self: @This()) *Step {
return self.sdk.startApp(self.package_name);
}
};
/// Instantiates the full build pipeline to create an APK file.
///
pub fn createApp(
sdk: *Sdk,
apk_file: []const u8,
src_file: []const u8,
app_config: AppConfig,
mode: std.builtin.Mode,
targets: AppTargetConfig,
key_store: KeyStore,
) CreateAppStep {
const write_xml_step = sdk.b.addWriteFile("strings.xml", blk: {
var buf = std.ArrayList(u8).init(sdk.b.allocator);
errdefer buf.deinit();
var writer = buf.writer();
writer.writeAll(
\\<?xml version="1.0" encoding="utf-8"?>
\\<resources>
\\
) catch unreachable;
writer.print(
\\ <string name="app_name">{s}</string>
\\ <string name="lib_name">{s}</string>
\\ <string name="package_name">{s}</string>
\\
, .{
app_config.display_name,
app_config.app_name,
app_config.package_name,
}) catch unreachable;
writer.writeAll(
\\</resources>
\\
) catch unreachable;
break :blk buf.toOwnedSlice();
});
const manifest_step = sdk.b.addWriteFile("AndroidManifest.xml", blk: {
var buf = std.ArrayList(u8).init(sdk.b.allocator);
errdefer buf.deinit();
var writer = buf.writer();
@setEvalBranchQuota(1_000_000);
writer.print(
\\<?xml version="1.0" encoding="utf-8" standalone="no"?><manifest xmlns:tools="http://schemas.android.com/tools" xmlns:android="http://schemas.android.com/apk/res/android" package="{s}">
\\ <uses-feature android:glEsVersion="0x00030001" android:required="true"/>
\\ <uses-feature android:name="android.hardware.vr.headtracking" android:required="true" />
\\
, .{app_config.package_name}) catch unreachable;
if (app_config.enable_hand_tracking) {
writer.writeAll(
\\ <uses-feature android:name="oculus.software.handtracking" android:required="true" />
\\ <uses-permission android:name="com.oculus.permission.HAND_TRACKING" />
\\
) catch unreachable;
}
for (app_config.permissions) |perm| {
writer.print(
\\ <uses-permission android:name="{s}"/>
\\
, .{perm}) catch unreachable;
}
if (app_config.fullscreen) {
writer.writeAll(
\\ <application android:debuggable="true" android:hasCode="false" android:label="@string/app_name" android:theme="@android:style/Theme.NoTitleBar.Fullscreen" tools:replace="android:icon,android:theme,android:allowBackup,label" android:icon="@mipmap/icon" >
\\ <meta-data android:name="com.samsung.android.vr.application.mode" android:value="vr_only"/>
\\ <meta-data android:name="com.oculus.supportedDevices" android:value="all" />
\\ <activity
\\ android:name="android.app.NativeActivity"
\\ android:theme="@android:style/Theme.Black.NoTitleBar.Fullscreen"
\\ android:launchMode="singleTask"
\\ android:screenOrientation="landscape"
\\ android:excludeFromRecents="false"
\\ android:configChanges="screenSize|screenLayout|orientation|keyboardHidden|keyboard|navigation|uiMode">
\\ <meta-data android:name="android.app.lib_name" android:value="@string/lib_name"/>
\\ <intent-filter>
\\ <action android:name="android.intent.action.MAIN"/>
\\ <category android:name="android.intent.category.LAUNCHER"/>
\\ </intent-filter>
\\ </activity>
\\ </application>
\\</manifest>
\\
) catch unreachable;
} else {
writer.writeAll(
\\ <application android:debuggable="true" android:hasCode="false" android:label="@string/app_name" tools:replace="android:icon,android:theme,android:allowBackup,label" android:icon="@mipmap/icon">
\\ <activity android:configChanges="keyboardHidden|orientation" android:name="android.app.NativeActivity">
\\ <meta-data android:name="android.app.lib_name" android:value="@string/lib_name"/>
\\ <intent-filter>
\\ <action android:name="android.intent.action.MAIN"/>
\\ <category android:name="android.intent.category.LAUNCHER"/>
\\ </intent-filter>
\\ </activity>
\\ </application>
\\</manifest>
\\
) catch unreachable;
}
break :blk buf.toOwnedSlice();
});
const resource_dir_step = CreateResourceDirectory.create(sdk.b);
for (app_config.resources) |res| {
resource_dir_step.add(res);
}
resource_dir_step.add(Resource{
.path = "values/strings.xml",
.content = write_xml_step.getFileSource("strings.xml").?,
});
const sdk_version = sdk.versions.android_sdk_version;
const target_sdk_version = app_config.target_sdk_version orelse sdk.versions.android_sdk_version;
const root_jar = std.fs.path.resolve(sdk.b.allocator, &[_][]const u8{
sdk.folders.android_sdk_root,
"platforms",
sdk.b.fmt("android-{d}", .{sdk_version}),
"android.jar",
}) catch unreachable;
const make_unsigned_apk = sdk.b.addSystemCommand(&[_][]const u8{
sdk.system_tools.aapt,
"package",
"-f", // force overwrite of existing files
"-F", // specify the apk file to output
sdk.b.pathFromRoot(apk_file),
"-I", // add an existing package to base include set
root_jar,
});
make_unsigned_apk.addArg("-M"); // specify full path to AndroidManifest.xml to include in zip
make_unsigned_apk.addFileSourceArg(manifest_step.getFileSource("AndroidManifest.xml").?);
make_unsigned_apk.addArg("-S"); // directory in which to find resources. Multiple directories will be scanned and the first match found (left to right) will take precedence
make_unsigned_apk.addFileSourceArg(resource_dir_step.getOutputDirectory());
make_unsigned_apk.addArgs(&[_][]const u8{
"-v",
"--target-sdk-version",
sdk.b.fmt("{d}", .{target_sdk_version}),
});
for (app_config.asset_directories) |dir| {
make_unsigned_apk.addArg("-A"); // additional directory in which to find raw asset files
make_unsigned_apk.addArg(sdk.b.pathFromRoot(dir));
}
var libs = std.ArrayList(*std.build.LibExeObjStep).init(sdk.b.allocator);
defer libs.deinit();
const build_options = BuildOptionStep.create(sdk.b);
build_options.add([]const u8, "app_name", app_config.app_name);
build_options.add(u16, "android_sdk_version", app_config.target_sdk_version orelse sdk.versions.android_sdk_version);
build_options.add(bool, "fullscreen", app_config.fullscreen);
const sign_step = sdk.signApk(apk_file, key_store);
inline for (std.meta.fields(AppTargetConfig)) |fld| {
const target_name = @field(Target, fld.name);
if (@field(targets, fld.name)) {
const library = sdk.compileAppLibrary(
src_file,
app_config,
mode,
target_name,
// build_options.getPackage("build_options"),
);
libs.append(library.app_step) catch unreachable;
const so_dir = switch (target_name) {
.aarch64 => "lib/arm64-v8a/",
.arm => "lib/armeabi/",
.x86_64 => "lib/x86_64/",
.x86 => "lib/x86/",
};
{
const copy_to_zip = CopyToZipStep.create(sdk, apk_file, so_dir, library.app_step.getOutputSource());
copy_to_zip.step.dependOn(&make_unsigned_apk.step); // enforces creation of APK before the execution
sign_step.dependOn(©_to_zip.step);
}
for (library.libraries) |lib| {
const copy_to_zip = CopyToZipStep.create(sdk, apk_file, so_dir, .{ .path = lib });
copy_to_zip.step.dependOn(&make_unsigned_apk.step); // enforces creation of APK before the execution
sign_step.dependOn(©_to_zip.step);
}
}
}
// const compress_step = compressApk(b, android_config, apk_file, "zig-out/demo.packed.apk");
// compress_step.dependOn(sign_step);
return CreateAppStep{
.sdk = sdk,
.first_step = &make_unsigned_apk.step,
.final_step = sign_step,
.libraries = libs.toOwnedSlice(),
.build_options = build_options,
.package_name = sdk.b.dupe(app_config.package_name),
.apk_file = (std.build.FileSource{ .path = apk_file }).dupe(sdk.b),
};
}
const CreateResourceDirectory = struct {
const Self = @This();
builder: *std.build.Builder,
step: std.build.Step,
resources: std.ArrayList(Resource),
directory: std.build.GeneratedFile,
pub fn create(b: *std.build.Builder) *Self {
const self = b.allocator.create(Self) catch @panic("out of memory");
self.* = Self{
.builder = b,
.step = Step.init(.custom, "populate resource directory", b.allocator, CreateResourceDirectory.make),
.directory = .{ .step = &self.step },
.resources = std.ArrayList(Resource).init(b.allocator),
};
return self;
}
pub fn add(self: *Self, resource: Resource) void {
self.resources.append(Resource{
.path = self.builder.dupe(resource.path),
.content = resource.content.dupe(self.builder),
}) catch @panic("out of memory");
resource.content.addStepDependencies(&self.step);
}
pub fn getOutputDirectory(self: *Self) std.build.FileSource {
return .{ .generated = &self.directory };
}
fn make(step: *Step) !void {
const self = @fieldParentPtr(Self, "step", step);
// if (std.fs.path.dirname(strings_xml)) |dir| {
// std.fs.cwd().makePath(dir) catch unreachable;
// }
var cacher = createCacheBuilder(self.builder);
for (self.resources.items) |res| {
cacher.addBytes(res.path);
try cacher.addFile(res.content);
}
const root = try cacher.createAndGetDir();
for (self.resources.items) |res| {
if (std.fs.path.dirname(res.path)) |folder| {
try root.dir.makePath(folder);
}
const src_path = res.content.getPath(self.builder);
try std.fs.Dir.copyFile(
std.fs.cwd(),
src_path,
root.dir,
res.path,
.{},
);
}
self.directory.path = root.path;
}
};
const CopyToZipStep = struct {
step: Step,
sdk: *Sdk,
target_dir: []const u8,
input_file: std.build.FileSource,
apk_file: []const u8,
fn create(sdk: *Sdk, apk_file: []const u8, target_dir: []const u8, input_file: std.build.FileSource) *CopyToZipStep {
std.debug.assert(target_dir[target_dir.len - 1] == '/');
const self = sdk.b.allocator.create(CopyToZipStep) catch unreachable;
self.* = CopyToZipStep{
.step = Step.init(.custom, "copy to zip", sdk.b.allocator, make),
.target_dir = target_dir,
.input_file = input_file,
.sdk = sdk,
.apk_file = sdk.b.pathFromRoot(apk_file),
};
self.step.dependOn(&sdk.host_tools.zip_add.step);
input_file.addStepDependencies(&self.step);
return self;
}
// id: Id, name: []const u8, allocator: *Allocator, makeFn: fn (*Step) anyerror!void
fn make(step: *Step) !void {
const self = @fieldParentPtr(CopyToZipStep, "step", step);
const output_path = self.input_file.getPath(self.sdk.b);
var zip_name = std.mem.concat(self.sdk.b.allocator, u8, &[_][]const u8{
self.target_dir,
std.fs.path.basename(output_path),
}) catch unreachable;
const args = [_][]const u8{
self.sdk.host_tools.zip_add.getOutputSource().getPath(self.sdk.b),
self.apk_file,
output_path,
zip_name,
};
_ = try self.sdk.b.execFromStep(&args, &self.step);
}
};
/// Compiles a single .so file for the given platform.
/// Note that this function assumes your build script only uses a single `android_config`!
const AppLibrary = struct {
app_step: *std.build.LibExeObjStep,
libraries: []const []const u8,
};
pub fn compileAppLibrary(
sdk: Sdk,
src_file: []const u8,
app_config: AppConfig,
mode: std.builtin.Mode,
target: Target,
// build_options: std.build.Pkg,
) AppLibrary {
switch (target) {
.arm => @panic("compiling android apps to arm not supported right now. see: https://github.com/ziglang/zig/issues/8885"),
.x86 => @panic("compiling android apps to x86 not supported right now. see https://github.com/ziglang/zig/issues/7935"),
else => {},
}
const ndk_root = sdk.b.pathFromRoot(sdk.folders.android_ndk_root);
const exe = sdk.b.addSharedLibrary(app_config.app_name, src_file, .unversioned);
exe.force_pic = true;
exe.link_function_sections = true;
exe.bundle_compiler_rt = true;
exe.strip = (mode == .ReleaseSmall);
exe.defineCMacro("ANDROID", null);
exe.setBuildMode(mode);
const TargetConfig = struct {
lib_dir: []const u8,
target_dir: []const u8,
cpp_dir: []const u8,
out_dir: []const u8,
vrapi_dir: []const u8,
audio_lib: []const u8,
target: std.zig.CrossTarget,
};
const config: TargetConfig = switch (target) {
.aarch64 => TargetConfig{
.lib_dir = "arch-arm64/usr/lib",
.target_dir = "aarch64-linux-android",
.cpp_dir = "arm64-v8a",
.out_dir = "arm64-v8a",
.vrapi_dir = "quest_sdk/VrApi/Libs/Android/arm64-v8a",
.audio_lib = "quest_sdk/AudioSDK/Lib/Android/arm64-v8a/libovraudiostatic64.a",
.target = zig_targets.aarch64,
},
.arm => TargetConfig{
.lib_dir = "arch-arm/usr/lib",
.target_dir = "arm-linux-androideabi",
.cpp_dir = "armeabi-v7a",
.out_dir = "armeabi",
.vrapi_dir = "quest_sdk/VrApi/Libs/Android/armeabi-v7a",
.audio_lib = "quest_sdk/AudioSDK/Lib/Android/armeabi-v7a/libovraudiostatic64.a",
.target = zig_targets.arm,
},
.x86 => TargetConfig{
.lib_dir = "arch-x86/usr/lib",
.target_dir = "i686-linux-android",
.cpp_dir = "x86",
.out_dir = "x86",
.vrapi_dir = @panic("VrApi not built for x86, cannot link this platform"),
.audio_lib = @panic("AudioSDK not built for Android x86, cannot link this platform"),
.target = zig_targets.x86,
},
.x86_64 => TargetConfig{
.lib_dir = "arch-x86_64/usr/lib64",
.target_dir = "x86_64-linux-android",
.cpp_dir = "x86_64",
.out_dir = "x86_64",
.vrapi_dir = @panic("VrApi not built for x86_64, cannot link this platform"),
.audio_lib = @panic("AudioSDK not built for Android x86_64, cannot link this platform"),
.target = zig_targets.x86_64,
},
};
const lib_dir_root = sdk.b.fmt("{s}/platforms/android-{d}", .{
ndk_root,
sdk.versions.android_sdk_version,
});
const lib_dir = std.fs.path.resolve(sdk.b.allocator, &[_][]const u8{ lib_dir_root, config.lib_dir }) catch unreachable;
exe.setTarget(config.target);
exe.addLibPath(lib_dir);
const include_dir = std.fs.path.resolve(sdk.b.allocator, &[_][]const u8{ ndk_root, "sysroot/usr/include" }) catch unreachable;
exe.addIncludeDir(include_dir);
for (app_libs) |lib| {
exe.linkSystemLibraryName(lib);
}
// Link with the platform libc++
const libcpp_dir = std.fs.path.resolve(sdk.b.allocator, &[_][]const u8{ ndk_root, "sources/cxx-stl/llvm-libc++/libs", config.cpp_dir }) catch unreachable;
const libcpp_shared = std.fs.path.resolve(sdk.b.allocator, &[_][]const u8{ libcpp_dir, "libc++_static.a" }) catch unreachable;
const libcpp_abi = std.fs.path.resolve(sdk.b.allocator, &[_][]const u8{ libcpp_dir, "libc++abi.a" }) catch unreachable;
exe.addObjectFile(libcpp_shared);
exe.addObjectFile(libcpp_abi);
exe.linkSystemLibraryName("unwind");
const sys_include_dir = std.fs.path.resolve(sdk.b.allocator, &[_][]const u8{ include_dir, config.target_dir }) catch unreachable;
exe.addIncludeDir(sys_include_dir);
// write libc file:
const libc_path = std.fs.path.resolve(sdk.b.allocator, &[_][]const u8{
sdk.b.cache_root,
"android-libc",
sdk.b.fmt("android-{d}-{s}.conf", .{ sdk.versions.android_sdk_version, config.out_dir }),
}) catch unreachable;
const libc_file_step = CreateLibCFileStep.create(sdk.b, libc_path, include_dir, sys_include_dir, lib_dir);
exe.libc_file = std.build.FileSource{ .generated = &libc_file_step.path };
exe.step.dependOn(&libc_file_step.step);
exe.linkLibC();
const vrapi_version = if (mode == .Debug) "Debug" else "Release";
const vrapi_lib_path = std.fs.path.join(sdk.b.allocator, &[_][]const u8{ config.vrapi_dir, vrapi_version }) catch unreachable;
exe.addLibPath(vrapi_lib_path);
exe.linkSystemLibraryName("vrapi");
exe.addObjectFile(config.audio_lib);
const libraries = sdk.b.allocator.alloc([]const u8, 1) catch unreachable;
const vrapi_lib = std.fs.path.join(sdk.b.allocator, &[_][]const u8{ vrapi_lib_path, "libvrapi.so" }) catch unreachable;
libraries[0] = vrapi_lib;
return .{
.app_step = exe,
.libraries = libraries,
};
}
pub fn compressApk(sdk: Sdk, input_apk_file: []const u8, output_apk_file: []const u8) *Step {
const temp_folder = sdk.b.pathFromRoot("zig-cache/apk-compress-folder");
const mkdir_cmd = sdk.b.addSystemCommand(&[_][]const u8{
sdk.system_tools.mkdir,
temp_folder,
});
const unpack_apk = sdk.b.addSystemCommand(&[_][]const u8{
"unzip",
"-o",
sdk.builder.pathFromRoot(input_apk_file),
"-d",
temp_folder,
});
unpack_apk.step.dependOn(&mkdir_cmd.step);
const repack_apk = sdk.b.addSystemCommand(&[_][]const u8{
"zip",
"-D9r",
sdk.builder.pathFromRoot(output_apk_file),
".",
});
repack_apk.cwd = temp_folder;
repack_apk.step.dependOn(&unpack_apk.step);
const rmdir_cmd = sdk.b.addSystemCommand(&[_][]const u8{
sdk.system_tools.rm,
"-rf",
temp_folder,
});
rmdir_cmd.step.dependOn(&repack_apk.step);
return &rmdir_cmd.step;
}
pub fn signApk(sdk: Sdk, apk_file: []const u8, key_store: KeyStore) *Step {
const sign_apk = sdk.b.addSystemCommand(&[_][]const u8{
sdk.system_tools.jarsigner,
"-sigalg",
"SHA1withRSA",
"-digestalg",
"SHA1",
"-verbose",
"-keystore",
key_store.file,
"-storepass",
key_store.password,
sdk.b.pathFromRoot(apk_file),
key_store.alias,
});
return &sign_apk.step;
}
pub fn alignApk(sdk: Sdk, input_apk_file: []const u8, output_apk_file: []const u8) *Step {
const step = sdk.b.addSystemCommand(&[_][]const u8{
sdk.system_tools.zipalign,
"-v",
"4",
sdk.builder.pathFromRoot(input_apk_file),
sdk.builder.pathFromRoot(output_apk_file),
});
return &step.step;
}
pub fn installApp(sdk: Sdk, apk_file: std.build.FileSource) *Step {
const step = sdk.b.addSystemCommand(&[_][]const u8{ sdk.system_tools.adb, "install" });
step.addFileSourceArg(apk_file);
return &step.step;
}
pub fn startApp(sdk: Sdk, package_name: []const u8) *Step {
const step = sdk.b.addSystemCommand(&[_][]const u8{
sdk.system_tools.adb,
"shell",
"am",
"start",
"-n",
sdk.b.fmt("{s}/android.app.NativeActivity", .{package_name}),
});
return &step.step;
}
/// Configuration for a signing key.
pub const KeyConfig = struct {
pub const Algorithm = enum { RSA };
key_algorithm: Algorithm = .RSA,
key_size: u32 = 2048, // bits
validity: u32 = 10_000, // days
distinguished_name: []const u8 = "CN=example.com, OU=ID, O=Example, L=Doe, S=John, C=GB",
};
/// A build step that initializes a new key store from the given configuration.
/// `android_config.key_store` must be non-`null` as it is used to initialize the key store.
pub fn initKeystore(sdk: Sdk, key_store: KeyStore, key_config: KeyConfig) *Step {
const step = sdk.b.addSystemCommand(&[_][]const u8{
sdk.system_tools.keytool,
"-genkey",
"-v",
"-keystore",
key_store.file,
"-alias",
key_store.alias,
"-keyalg",
@tagName(key_config.key_algorithm),
"-keysize",
sdk.b.fmt("{d}", .{key_config.key_size}),
"-validity",
sdk.b.fmt("{d}", .{key_config.validity}),
"-storepass",
key_store.password,
"-keypass",
key_store.password,
"-dname",
key_config.distinguished_name,
});
return &step.step;
}
const Builder = std.build.Builder;
const Step = std.build.Step;
const android_os = .linux;
const android_abi = .android;
const zig_targets = struct {
const aarch64 = std.zig.CrossTarget{
.cpu_arch = .aarch64,
.os_tag = android_os,
.abi = android_abi,
.cpu_model = .baseline,
.cpu_features_add = std.Target.aarch64.featureSet(&.{.v8a}),
};
const arm = std.zig.CrossTarget{
.cpu_arch = .arm,
.os_tag = android_os,
.abi = android_abi,
.cpu_model = .baseline,
.cpu_features_add = std.Target.arm.featureSet(&.{.v7a}),
};
const x86 = std.zig.CrossTarget{
.cpu_arch = .i386,
.os_tag = android_os,
.abi = android_abi,
.cpu_model = .baseline,
};
const x86_64 = std.zig.CrossTarget{
.cpu_arch = .x86_64,
.os_tag = android_os,
.abi = android_abi,
.cpu_model = .baseline,
};
};
const app_libs = [_][]const u8{
"GLESv2", "EGL", "android", "log",
};
const BuildOptionStep = struct {
const Self = @This();
step: Step,
builder: *std.build.Builder,
file_content: std.ArrayList(u8),
package_file: std.build.GeneratedFile,
pub fn create(b: *Builder) *Self {
const options = b.allocator.create(Self) catch @panic("out of memory");
options.* = Self{
.builder = b,
.step = Step.init(.custom, "render build options", b.allocator, make),
.file_content = std.ArrayList(u8).init(b.allocator),
.package_file = std.build.GeneratedFile{ .step = &options.step },
};
return options;
}
pub fn getPackage(self: *Self, name: []const u8) std.build.Pkg {
return self.builder.dupePkg(std.build.Pkg{
.name = name,
.path = .{ .generated = &self.package_file },
});
}
pub fn add(self: *Self, comptime T: type, name: []const u8, value: T) void {
const out = self.file_content.writer();
switch (T) {
[]const []const u8 => {
out.print("pub const {}: []const []const u8 = &[_][]const u8{{\n", .{std.zig.fmtId(name)}) catch unreachable;
for (value) |slice| {
out.print(" \"{}\",\n", .{std.zig.fmtEscapes(slice)}) catch unreachable;
}
out.writeAll("};\n") catch unreachable;
return;
},
[:0]const u8 => {
out.print("pub const {}: [:0]const u8 = \"{}\";\n", .{ std.zig.fmtId(name), std.zig.fmtEscapes(value) }) catch unreachable;
return;
},
[]const u8 => {
out.print("pub const {}: []const u8 = \"{}\";\n", .{ std.zig.fmtId(name), std.zig.fmtEscapes(value) }) catch unreachable;
return;
},
?[:0]const u8 => {
out.print("pub const {}: ?[:0]const u8 = ", .{std.zig.fmtId(name)}) catch unreachable;
if (value) |payload| {
out.print("\"{}\";\n", .{std.zig.fmtEscapes(payload)}) catch unreachable;
} else {
out.writeAll("null;\n") catch unreachable;
}
return;
},
?[]const u8 => {
out.print("pub const {}: ?[]const u8 = ", .{std.zig.fmtId(name)}) catch unreachable;
if (value) |payload| {
out.print("\"{}\";\n", .{std.zig.fmtEscapes(payload)}) catch unreachable;
} else {
out.writeAll("null;\n") catch unreachable;
}
return;
},
std.builtin.Version => {
out.print(
\\pub const {}: @import("std").builtin.Version = .{{
\\ .major = {d},
\\ .minor = {d},
\\ .patch = {d},
\\}};
\\
, .{
std.zig.fmtId(name),
value.major,
value.minor,
value.patch,
}) catch unreachable;
},
std.SemanticVersion => {
out.print(
\\pub const {}: @import("std").SemanticVersion = .{{
\\ .major = {d},
\\ .minor = {d},
\\ .patch = {d},
\\
, .{