1/**************************************************************************/
2/* export_plugin.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 WINDOWS_EXPORT_PLUGIN_H
32#define WINDOWS_EXPORT_PLUGIN_H
33
34#include "core/io/file_access.h"
35#include "core/os/os.h"
36#include "editor/editor_settings.h"
37#include "editor/export/editor_export_platform_pc.h"
38
39// Optional environment variables for defining confidential information. If any
40// of these is set, they will override the values set in the credentials file.
41const String ENV_WIN_CODESIGN_ID_TYPE = "GODOT_WINDOWS_CODESIGN_IDENTITY_TYPE";
42const String ENV_WIN_CODESIGN_ID = "GODOT_WINDOWS_CODESIGN_IDENTITY";
43const String ENV_WIN_CODESIGN_PASS = "GODOT_WINDOWS_CODESIGN_PASSWORD";
44
45class EditorExportPlatformWindows : public EditorExportPlatformPC {
46 GDCLASS(EditorExportPlatformWindows, EditorExportPlatformPC);
47
48 struct SSHCleanupCommand {
49 String host;
50 String port;
51 Vector<String> ssh_args;
52 String cmd_args;
53 bool wait = false;
54
55 SSHCleanupCommand(){};
56 SSHCleanupCommand(const String &p_host, const String &p_port, const Vector<String> &p_ssh_arg, const String &p_cmd_args, bool p_wait = false) {
57 host = p_host;
58 port = p_port;
59 ssh_args = p_ssh_arg;
60 cmd_args = p_cmd_args;
61 wait = p_wait;
62 };
63 };
64
65 Ref<ImageTexture> run_icon;
66 Ref<ImageTexture> stop_icon;
67
68 Vector<SSHCleanupCommand> cleanup_commands;
69 OS::ProcessID ssh_pid = 0;
70 int menu_options = 0;
71
72 Error _process_icon(const Ref<EditorExportPreset> &p_preset, const String &p_src_path, const String &p_dst_path);
73 Error _rcedit_add_data(const Ref<EditorExportPreset> &p_preset, const String &p_path, bool p_console_icon);
74 Error _code_sign(const Ref<EditorExportPreset> &p_preset, const String &p_path);
75
76public:
77 virtual Error export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags = 0) override;
78 virtual Error modify_template(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) override;
79 virtual Error sign_shared_object(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path) override;
80 virtual List<String> get_binary_extensions(const Ref<EditorExportPreset> &p_preset) const override;
81 virtual void get_export_options(List<ExportOption> *r_options) const override;
82 virtual bool has_valid_export_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates, bool p_debug = false) const override;
83 virtual bool has_valid_project_configuration(const Ref<EditorExportPreset> &p_preset, String &r_error) const override;
84 virtual bool get_export_option_visibility(const EditorExportPreset *p_preset, const String &p_option) const override;
85 virtual String get_export_option_warning(const EditorExportPreset *p_preset, const StringName &p_name) const override;
86
87 virtual String get_template_file_name(const String &p_target, const String &p_arch) const override;
88 virtual Error fixup_embedded_pck(const String &p_path, int64_t p_embedded_start, int64_t p_embedded_size) override;
89
90 virtual Ref<Texture2D> get_run_icon() const override;
91 virtual bool poll_export() override;
92 virtual Ref<ImageTexture> get_option_icon(int p_index) const override;
93 virtual int get_options_count() const override;
94 virtual String get_option_label(int p_index) const override;
95 virtual String get_option_tooltip(int p_index) const override;
96 virtual Error run(const Ref<EditorExportPreset> &p_preset, int p_device, int p_debug_flags) override;
97 virtual void cleanup() override;
98
99 EditorExportPlatformWindows();
100};
101
102#endif // WINDOWS_EXPORT_PLUGIN_H
103