1/**************************************************************************/
2/* gradle_export_util.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef ANDROID_GRADLE_EXPORT_UTIL_H
32#define ANDROID_GRADLE_EXPORT_UTIL_H
33
34#include "core/io/dir_access.h"
35#include "core/io/file_access.h"
36#include "core/io/zip_io.h"
37#include "core/os/os.h"
38#include "editor/export/editor_export.h"
39
40const String godot_project_name_xml_string = R"(<?xml version="1.0" encoding="utf-8"?>
41<!--WARNING: THIS FILE WILL BE OVERWRITTEN AT BUILD TIME-->
42<resources>
43 <string name="godot_project_name_string">%s</string>
44</resources>
45)";
46
47// Application category.
48// See https://developer.android.com/guide/topics/manifest/application-element#appCategory for standards
49static const int APP_CATEGORY_ACCESSIBILITY = 0;
50static const int APP_CATEGORY_AUDIO = 1;
51static const int APP_CATEGORY_GAME = 2;
52static const int APP_CATEGORY_IMAGE = 3;
53static const int APP_CATEGORY_MAPS = 4;
54static const int APP_CATEGORY_NEWS = 5;
55static const int APP_CATEGORY_PRODUCTIVITY = 6;
56static const int APP_CATEGORY_SOCIAL = 7;
57static const int APP_CATEGORY_VIDEO = 8;
58
59// Supported XR modes.
60// This should match the entries in 'platform/android/java/lib/src/org/godotengine/godot/xr/XRMode.java'
61static const int XR_MODE_REGULAR = 0;
62static const int XR_MODE_OPENXR = 1;
63
64struct CustomExportData {
65 String assets_directory;
66 bool debug;
67 Vector<String> libs;
68};
69
70int _get_android_orientation_value(DisplayServer::ScreenOrientation screen_orientation);
71
72String _get_android_orientation_label(DisplayServer::ScreenOrientation screen_orientation);
73
74int _get_app_category_value(int category_index);
75
76String _get_app_category_label(int category_index);
77
78// Utility method used to create a directory.
79Error create_directory(const String &p_dir);
80
81// Writes p_data into a file at p_path, creating directories if necessary.
82// Note: this will overwrite the file at p_path if it already exists.
83Error store_file_at_path(const String &p_path, const Vector<uint8_t> &p_data);
84
85// Writes string p_data into a file at p_path, creating directories if necessary.
86// Note: this will overwrite the file at p_path if it already exists.
87Error store_string_at_path(const String &p_path, const String &p_data);
88
89// Implementation of EditorExportSaveFunction.
90// This method will only be called as an input to export_project_files.
91// It is used by the export_project_files method to save all the asset files into the gradle project.
92// It's functionality mirrors that of the method save_apk_file.
93// This method will be called ONLY when gradle build is enabled.
94Error rename_and_store_file_in_gradle_project(void *p_userdata, const String &p_path, const Vector<uint8_t> &p_data, int p_file, int p_total, const Vector<String> &p_enc_in_filters, const Vector<String> &p_enc_ex_filters, const Vector<uint8_t> &p_key);
95
96// Creates strings.xml files inside the gradle project for different locales.
97Error _create_project_name_strings_files(const Ref<EditorExportPreset> &p_preset, const String &project_name);
98
99String bool_to_string(bool v);
100
101String _get_gles_tag();
102
103String _get_screen_sizes_tag(const Ref<EditorExportPreset> &p_preset);
104
105String _get_activity_tag(const Ref<EditorExportPlatform> &p_export_platform, const Ref<EditorExportPreset> &p_preset, bool p_debug);
106
107String _get_application_tag(const Ref<EditorExportPlatform> &p_export_platform, const Ref<EditorExportPreset> &p_preset, bool p_has_read_write_storage_permission, bool p_debug);
108
109#endif // ANDROID_GRADLE_EXPORT_UTIL_H
110