summaryrefslogtreecommitdiff
path: root/tools/editor/editor_export.h
blob: 8a9dc965e5b18fdf996a342321ee95cc2b629f57 (plain)
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
/*************************************************************************/
/*  editor_import_export.h                                               */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                    http://www.godotengine.org                         */
/*************************************************************************/
/* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur.                 */
/*                                                                       */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the       */
/* "Software"), to deal in the Software without restriction, including   */
/* without limitation the rights to use, copy, modify, merge, publish,   */
/* distribute, sublicense, and/or sell copies of the Software, and to    */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions:                                             */
/*                                                                       */
/* The above copyright notice and this permission notice shall be        */
/* included in all copies or substantial portions of the Software.       */
/*                                                                       */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,       */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF    */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY  */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,  */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE     */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                */
/*************************************************************************/
#ifndef EDITOR_EXPORT_H
#define EDITOR_EXPORT_H



#include "resource.h"
#include "scene/main/node.h"
#include "scene/resources/texture.h"
#include "scene/main/timer.h"

class EditorProgress;
class FileAccess;
class EditorExportPlatform;
class EditorFileSystemDirectory;

class EditorExportPreset : public Reference {

	GDCLASS( EditorExportPreset,Reference )
public:
	enum ExportFilter {
		EXPORT_ALL_RESOURCES,
		EXPORT_SELECTED_SCENES,
		EXPORT_SELECTED_RESOURCES,
	};

private:

	Ref<EditorExportPlatform> platform;
	ExportFilter export_filter;
	String include_filter;
	String exclude_filter;

	String exporter;
	Set<String> selected_files;
	bool runnable;

	Vector<String> patches;


friend class EditorExport;
friend class EditorExportPlatform;

	List<PropertyInfo> properties;
	Map<StringName,Variant> values;

	String name;
protected:
	bool _set(const StringName& p_name, const Variant& p_value);
	bool _get(const StringName& p_name,Variant &r_ret) const;
	void _get_property_list( List<PropertyInfo> *p_list) const;

public:

	Ref<EditorExportPlatform> get_platform() const;
	bool has(const StringName& p_property) const { return values.has(p_property); }

	Vector<String> get_files_to_export() const;

	void add_export_file(const String& p_path);
	void remove_export_file(const String& p_path);
	bool has_export_file(const String& p_path);

	void set_name(const String& p_name);
	String get_name() const;

	void set_runnable(bool p_enable);
	bool is_runnable() const;

	void set_export_filter(ExportFilter p_filter);
	ExportFilter get_export_filter() const;

	void set_include_filter(const String& p_include);
	String get_include_filter() const;

	void set_exclude_filter(const String& p_exclude);
	String get_exclude_filter() const;

	void add_patch(const String& p_path,int p_at_pos=-1);
	void set_patch(int p_index,const String& p_path);
	String get_patch(int p_index);
	void remove_patch(int p_idx);
	Vector<String> get_patches() const;

	const List<PropertyInfo>& get_properties() const { return properties; }

	EditorExportPreset();
};


class EditorExportPlatform : public Reference {

	GDCLASS( EditorExportPlatform,Reference )

public:

	typedef Error (*EditorExportSaveFunction)(void *p_userdata,const String& p_path, const Vector<uint8_t>& p_data,int p_file,int p_total);

private:

	struct SavedData {

		uint64_t ofs;
		uint64_t size;
		Vector<uint8_t> md5;
		CharString path_utf8;

		bool operator<(const SavedData& p_data) const {
			return path_utf8 < p_data.path_utf8;
		}
	};

	struct PackData {

		FileAccess *f;
		Vector<SavedData> file_ofs;
		EditorProgress *ep;
	};

	struct ZipData {

		void* zip;
		EditorProgress *ep;

	};

	void _export_find_resources(EditorFileSystemDirectory *p_dir,Set<String>& p_paths);
	void _export_find_dependencies(const String& p_path,Set<String>& p_paths);

	void gen_debug_flags(Vector<String> &r_flags, int p_flags);
	static Error _save_pack_file(void *p_userdata,const String& p_path, const Vector<uint8_t>& p_data,int p_file,int p_total);
	static Error _save_zip_file(void *p_userdata,const String& p_path, const Vector<uint8_t>& p_data,int p_file,int p_total);


protected:

	virtual void get_preset_features(const Ref<EditorExportPreset>& p_preset,List<String> *r_features)=0;
	String find_export_template(String template_file_name, String *err=NULL) const;

public:


	struct ExportOption {
		PropertyInfo option;
		Variant default_value;

		ExportOption(const PropertyInfo& p_info,const Variant& p_default) { option=p_info; default_value=p_default; }
		ExportOption() {}
	};

	virtual Ref<EditorExportPreset> create_preset();

	virtual void get_export_options(List<ExportOption> *r_options)=0;
	virtual String get_name() const =0;
	virtual Ref<Texture> get_logo() const =0;


	Error export_project_files(const Ref<EditorExportPreset>& p_preset,EditorExportSaveFunction p_func, void* p_udata);

	Error save_pack(const Ref<EditorExportPreset>& p_preset,const String& p_path);
	Error save_zip(const Ref<EditorExportPreset>& p_preset,const String& p_path);


	virtual bool poll_devices() { return false; }
	virtual int get_device_count() const { return 0; }
	virtual String get_device_name(int p_device) const { return ""; }
	virtual String get_device_info(int p_device) const { return ""; }

	enum DebugFlags {
		DEBUG_FLAG_DUMB_CLIENT=1,
		DEBUG_FLAG_REMOTE_DEBUG=2,
		DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST=4,
		DEBUG_FLAG_VIEW_COLLISONS=8,
		DEBUG_FLAG_VIEW_NAVIGATION=16,
	};

	virtual Error run(int p_device,int p_debug_flags) { return OK; }

	virtual bool can_export(const Ref<EditorExportPreset>& p_preset,String &r_error,bool &r_missing_templates) const=0;

	virtual String get_binary_extension() const=0;
	virtual Error export_project(const Ref<EditorExportPreset>& p_preset,bool p_debug,const String& p_path,int p_flags=0)=0;

	EditorExportPlatform();
};


class EditorExport : public Node {
	GDCLASS(EditorExport,Node);

	Vector<Ref<EditorExportPlatform> > export_platforms;
	Vector<Ref<EditorExportPreset> > export_presets;

	Timer *save_timer;
	bool block_save;

	static EditorExport *singleton;

	void _save();
protected:

friend class EditorExportPreset;
	void save_presets();

	void _notification(int p_what);
	static void _bind_methods();
public:

	static EditorExport * get_singleton() { return singleton; }

	void add_export_platform(const Ref<EditorExportPlatform>& p_platform);
	int get_export_platform_count();
	Ref<EditorExportPlatform> get_export_platform(int p_idx);


	void add_export_preset(const Ref<EditorExportPreset>& p_preset,int p_at_pos=-1);
	int get_export_preset_count() const;
	Ref<EditorExportPreset> get_export_preset(int p_idx);
	void remove_export_preset(int p_idx);

	void load_config();

	EditorExport();
	~EditorExport();
};




class EditorExportPlatformPC : public EditorExportPlatform {

	GDCLASS( EditorExportPlatformPC,EditorExportPlatform )

	Ref<ImageTexture> logo;
	String name;
	String extension;

	String release_file_32;
	String release_file_64;
	String debug_file_32;
	String debug_file_64;

public:

	virtual void get_preset_features(const Ref<EditorExportPreset>& p_preset,List<String>* r_features);

	virtual void get_export_options(List<ExportOption> *r_options);

	virtual String get_name() const;
	virtual Ref<Texture> get_logo() const;

	virtual bool can_export(const Ref<EditorExportPreset>& p_preset,String &r_error,bool &r_missing_templates) const;
	virtual String get_binary_extension() const;
	virtual Error export_project(const Ref<EditorExportPreset>& p_preset,bool p_debug,const String& p_path,int p_flags=0);

	void set_extension(const String& p_extension);
	void set_name(const String& p_name);

	void set_logo(const Ref<Texture>& p_loco);

	void set_release_64(const String& p_file);
	void set_release_32(const String& p_file);
	void set_debug_64(const String& p_file);
	void set_debug_32(const String& p_file);

	EditorExportPlatformPC();
};


#endif // EDITOR_IMPORT_EXPORT_H