os.h
1 /*************************************************************************/
2 /* os.h */
3 /*************************************************************************/
4 /* This file is part of: */
5 /* GODOT ENGINE */
6 /* http://www.godotengine.org */
7 /*************************************************************************/
8 /* Copyright (c) 2007-2016 Juan Linietsky, Ariel Manzur. */
9 /* */
10 /* Permission is hereby granted, free of charge, to any person obtaining */
11 /* a copy of this software and associated documentation files (the */
12 /* "Software"), to deal in the Software without restriction, including */
13 /* without limitation the rights to use, copy, modify, merge, publish, */
14 /* distribute, sublicense, and/or sell copies of the Software, and to */
15 /* permit persons to whom the Software is furnished to do so, subject to */
16 /* the following conditions: */
17 /* */
18 /* The above copyright notice and this permission notice shall be */
19 /* included in all copies or substantial portions of the Software. */
20 /* */
21 /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
22 /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
23 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
24 /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
25 /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
26 /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
27 /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
28 /*************************************************************************/
29 #ifndef OS_H
30 #define OS_H
31 
32 #include "ustring.h"
33 #include "list.h"
34 #include "vector.h"
35 #include "os/main_loop.h"
36 #include <stdarg.h>
37 
42 class OS {
43 
44  static OS* singleton;
45  String _execpath;
46  String _custom_level;
47  List<String> _cmdline;
48  int ips;
49  bool _keep_screen_on;
50  bool low_processor_usage_mode;
51  bool _verbose_stdout;
52  String _local_clipboard;
53  uint64_t frames_drawn;
54  uint32_t _frame_delay;
55  uint64_t _msec_splash;
56  bool _no_window;
57  int _exit_code;
58  int _orientation;
59  float _fps;
60  int _target_fps;
61  float _time_scale;
62  bool _pixel_snap;
63 
64  char *last_error;
65 
66 public:
67  enum RenderThreadMode {
68 
69  RENDER_THREAD_UNSAFE,
70  RENDER_THREAD_SAFE,
71  RENDER_SEPARATE_THREAD
72  };
73  struct VideoMode {
74 
75  int width,height;
76  bool fullscreen;
77  bool resizable;
78  float get_aspect() const { return (float)width/(float)height; }
79  VideoMode(int p_width=1024,int p_height=600,bool p_fullscreen=false, bool p_resizable = true) {width=p_width; height=p_height; fullscreen=p_fullscreen; resizable = p_resizable; }
80  };
81 protected:
82 friend class Main;
83 
84  RenderThreadMode _render_thread_mode;
85 
86  // functions used by main to initialize/deintialize the OS
87  virtual int get_video_driver_count() const=0;
88  virtual const char * get_video_driver_name(int p_driver) const=0;
89 
90  virtual VideoMode get_default_video_mode() const=0;
91 
92  virtual int get_audio_driver_count() const=0;
93  virtual const char * get_audio_driver_name(int p_driver) const=0;
94 
95  virtual void initialize_core()=0;
96  virtual void initialize(const VideoMode& p_desired,int p_video_driver,int p_audio_driver)=0;
97 
98  virtual void set_main_loop( MainLoop * p_main_loop )=0;
99  virtual void delete_main_loop()=0;
100 
101  virtual void finalize()=0;
102  virtual void finalize_core()=0;
103 
104  virtual void set_cmdline(const char* p_execpath, const List<String>& p_args);
105 
106  void _ensure_data_dir();
107 
108 public:
109 
110  typedef int64_t ProcessID;
111 
112  static OS* get_singleton();
113 
114  enum ErrorType {
115  ERR_ERROR,
116  ERR_WARNING,
117  ERR_SCRIPT
118  };
119 
120  virtual void print_error(const char* p_function,const char* p_file,int p_line,const char *p_code,const char*p_rationale,ErrorType p_type=ERR_ERROR);
121 
122  virtual void print(const char *p_format, ... );
123  virtual void printerr(const char *p_format, ... );
124  virtual void vprint(const char* p_format, va_list p_list, bool p_stderr=false)=0;
125  virtual void alert(const String& p_alert,const String& p_title="ALERT!")=0;
126  virtual String get_stdin_string(bool p_block = true)=0;
127 
128  virtual void set_last_error(const char* p_error);
129  virtual const char *get_last_error() const;
130  virtual void clear_last_error();
131 
132 
133 
134  enum MouseMode {
135  MOUSE_MODE_VISIBLE,
136  MOUSE_MODE_HIDDEN,
137  MOUSE_MODE_CAPTURED
138  };
139 
140  virtual void set_mouse_mode(MouseMode p_mode);
141  virtual MouseMode get_mouse_mode() const;
142 
143 
144  virtual void warp_mouse_pos(const Point2& p_to) {}
145  virtual Point2 get_mouse_pos() const=0;
146  virtual int get_mouse_button_state() const=0;
147  virtual void set_window_title(const String& p_title)=0;
148 
149  virtual void set_clipboard(const String& p_text);
150  virtual String get_clipboard() const;
151 
152  virtual void set_video_mode(const VideoMode& p_video_mode,int p_screen=0)=0;
153  virtual VideoMode get_video_mode(int p_screen=0) const=0;
154  virtual void get_fullscreen_mode_list(List<VideoMode> *p_list,int p_screen=0) const=0;
155 
156 
157  virtual int get_screen_count() const{ return 1; }
158  virtual int get_current_screen() const { return 0; }
159  virtual void set_current_screen(int p_screen) { }
160  virtual Point2 get_screen_position(int p_screen=0) const { return Point2(); }
161  virtual Size2 get_screen_size(int p_screen=0) const { return get_window_size(); }
162  virtual Point2 get_window_position() const { return Vector2(); }
163  virtual void set_window_position(const Point2& p_position) {}
164  virtual Size2 get_window_size() const=0;
165  virtual void set_window_size(const Size2 p_size){}
166  virtual void set_window_fullscreen(bool p_enabled) {}
167  virtual bool is_window_fullscreen() const { return true; }
168  virtual void set_window_resizable(bool p_enabled) {}
169  virtual bool is_window_resizable() const { return false; }
170  virtual void set_window_minimized(bool p_enabled) {}
171  virtual bool is_window_minimized() const { return false; }
172  virtual void set_window_maximized(bool p_enabled) {}
173  virtual bool is_window_maximized() const { return true; }
174 
175 
176 
177 
178  virtual void set_iterations_per_second(int p_ips);
179  virtual int get_iterations_per_second() const;
180 
181  virtual void set_target_fps(int p_fps);
182  virtual float get_target_fps() const;
183 
184  virtual float get_frames_per_second() const { return _fps; };
185 
186  virtual void set_keep_screen_on(bool p_enabled);
187  virtual bool is_keep_screen_on() const;
188  virtual void set_low_processor_usage_mode(bool p_enabled);
189  virtual bool is_in_low_processor_usage_mode() const;
190 
191  virtual String get_installed_templates_path() const { return ""; };
192  virtual String get_executable_path() const;
193  virtual Error execute(const String& p_path, const List<String>& p_arguments,bool p_blocking,ProcessID *r_child_id=NULL,String* r_pipe=NULL,int *r_exitcode=NULL)=0;
194  virtual Error kill(const ProcessID& p_pid)=0;
195  virtual int get_process_ID() const;
196 
197  virtual Error shell_open(String p_uri);
198  virtual Error set_cwd(const String& p_cwd);
199 
200  virtual bool has_environment(const String& p_var) const=0;
201  virtual String get_environment(const String& p_var) const=0;
202 
203  virtual String get_name()=0;
204  virtual List<String> get_cmdline_args() const { return _cmdline; }
205  virtual String get_model_name() const;
206 
207  virtual MainLoop *get_main_loop() const=0;
208 
209  String get_custom_level() const { return _custom_level; }
210 
211  virtual void yield();
212 
213  enum Weekday {
214  DAY_SUNDAY,
215  DAY_MONDAY,
216  DAY_TUESDAY,
217  DAY_WEDNESDAY,
218  DAY_THURSDAY,
219  DAY_FRIDAY,
220  DAY_SATURDAY
221  };
222 
223  enum Month {
224  MONTH_JANUARY,
225  MONTH_FEBRUARY,
226  MONTH_MARCH,
227  MONTH_APRIL,
228  MONTH_MAY,
229  MONTH_JUNE,
230  MONTH_JULY,
231  MONTH_AUGUST,
232  MONTH_SEPTEMBER,
233  MONTH_OCTOBER,
234  MONTH_NOVEMBER,
235  MONTH_DECEMBER
236  };
237 
238  struct Date {
239 
240  int year;
241  Month month;
242  int day;
243  Weekday weekday;
244  bool dst;
245  };
246 
247  struct Time {
248 
249  int hour;
250  int min;
251  int sec;
252  };
253 
254  struct TimeZoneInfo {
255  int bias;
256  String name;
257  };
258 
259  virtual Date get_date(bool local=false) const=0;
260  virtual Time get_time(bool local=false) const=0;
261  virtual TimeZoneInfo get_time_zone_info() const=0;
262  virtual uint64_t get_unix_time() const;
263  virtual uint64_t get_system_time_secs() const;
264 
265  virtual void delay_usec(uint32_t p_usec) const=0;
266  virtual uint64_t get_ticks_usec() const=0;
267  uint32_t get_ticks_msec() const;
268  uint64_t get_splash_tick_msec() const;
269 
270  void set_frame_delay(uint32_t p_msec);
271  uint32_t get_frame_delay() const;
272 
273  virtual bool can_draw() const = 0;
274 
275  uint64_t get_frames_drawn();
276 
277  bool is_stdout_verbose() const;
278 
279  enum CursorShape {
280  CURSOR_ARROW,
281  CURSOR_IBEAM,
282  CURSOR_POINTING_HAND,
283  CURSOR_CROSS,
284  CURSOR_WAIT,
285  CURSOR_BUSY,
286  CURSOR_DRAG,
287  CURSOR_CAN_DROP,
288  CURSOR_FORBIDDEN,
289  CURSOR_VSIZE,
290  CURSOR_HSIZE,
291  CURSOR_BDIAGSIZE,
292  CURSOR_FDIAGSIZE,
293  CURSOR_MOVE,
294  CURSOR_VSPLIT,
295  CURSOR_HSPLIT,
296  CURSOR_HELP,
297  CURSOR_MAX
298  };
299 
300 
301  virtual bool has_virtual_keyboard() const;
302  virtual void show_virtual_keyboard(const String& p_existing_text,const Rect2& p_screen_rect=Rect2());
303  virtual void hide_virtual_keyboard();
304 
305  virtual void set_cursor_shape(CursorShape p_shape)=0;
306 
307  virtual bool get_swap_ok_cancel() { return false; }
308  virtual void dump_memory_to_file(const char* p_file);
309  virtual void dump_resources_to_file(const char* p_file);
310  virtual void print_resources_in_use(bool p_short=false);
311  virtual void print_all_resources(String p_to_file="");
312 
313  virtual int get_static_memory_usage() const;
314  virtual int get_static_memory_peak_usage() const;
315  virtual int get_dynamic_memory_usage() const;
316  virtual int get_free_static_memory() const;
317 
318  RenderThreadMode get_render_thread_mode() const { return _render_thread_mode; }
319 
320  virtual String get_locale() const;
321 
322  String get_safe_application_name() const;
323  virtual String get_data_dir() const;
324  virtual String get_resource_dir() const;
325 
326  enum SystemDir {
327  SYSTEM_DIR_DESKTOP,
328  SYSTEM_DIR_DCIM,
329  SYSTEM_DIR_DOCUMENTS,
330  SYSTEM_DIR_DOWNLOADS,
331  SYSTEM_DIR_MOVIES,
332  SYSTEM_DIR_MUSIC,
333  SYSTEM_DIR_PICTURES,
334  SYSTEM_DIR_RINGTONES,
335  };
336 
337  virtual String get_system_dir(SystemDir p_dir) const;
338 
339 
340  virtual void set_no_window_mode(bool p_enable);
341  virtual bool is_no_window_mode_enabled() const;
342 
343  virtual bool has_touchscreen_ui_hint() const;
344 
345  enum ScreenOrientation {
346 
347  SCREEN_LANDSCAPE,
348  SCREEN_PORTRAIT,
349  SCREEN_REVERSE_LANDSCAPE,
350  SCREEN_REVERSE_PORTRAIT,
351  SCREEN_SENSOR_LANDSCAPE,
352  SCREEN_SENSOR_PORTRAIT,
353  SCREEN_SENSOR,
354  };
355 
356  virtual void set_screen_orientation(ScreenOrientation p_orientation);
357  ScreenOrientation get_screen_orientation() const;
358 
359  virtual void move_window_to_foreground() {};
360 
361  virtual void debug_break();
362 
363  virtual void release_rendering_thread();
364  virtual void make_rendering_thread();
365  virtual void swap_buffers();
366 
367 
368  virtual void set_icon(const Image& p_icon);
369 
370  virtual int get_exit_code() const;
371  virtual void set_exit_code(int p_code);
372 
373  virtual int get_processor_count() const;
374 
375  virtual String get_unique_ID() const;
376 
377  virtual Error native_video_play(String p_path, float p_volume, String p_audio_track, String p_subtitle_track);
378  virtual bool native_video_is_playing() const;
379  virtual void native_video_pause();
380  virtual void native_video_unpause();
381  virtual void native_video_stop();
382 
383  virtual bool can_use_threads() const;
384 
385  virtual Error dialog_show(String p_title, String p_description, Vector<String> p_buttons, Object* p_obj, String p_callback);
386  virtual Error dialog_input_text(String p_title, String p_description, String p_partial, Object* p_obj, String p_callback);
387 
388 
389  enum LatinKeyboardVariant {
390  LATIN_KEYBOARD_QWERTY,
391  LATIN_KEYBOARD_QWERTZ,
392  LATIN_KEYBOARD_AZERTY,
393  LATIN_KEYBOARD_QZERTY,
394  LATIN_KEYBOARD_DVORAK,
395  LATIN_KEYBOARD_NEO,
396  };
397 
398 
399  virtual LatinKeyboardVariant get_latin_keyboard_variant() const;
400 
401  void set_time_scale(float p_scale);
402  float get_time_scale() const;
403 
404  _FORCE_INLINE_ bool get_use_pixel_snap() const { return _pixel_snap; }
405 
406  virtual bool is_joy_known(int p_device);
407  virtual String get_joy_guid(int p_device)const;
408 
409  enum EngineContext {
410  CONTEXT_EDITOR,
411  CONTEXT_PROJECTMAN,
412  };
413 
414  virtual void set_context(int p_context);
415 
416  OS();
417  virtual ~OS();
418 
419 };
420 
421 #endif
422 
MainLoop
Definition: main_loop.h:38
OS
Definition: os.h:42
OS::Date
Definition: os.h:238
Rect2
Definition: math_2d.h:204
Image
Definition: image.h:47
Main
Definition: main.h:40
OS::TimeZoneInfo
Definition: os.h:254
OS::VideoMode
Definition: os.h:73
Vector2
Definition: math_2d.h:65
OS::Time
Definition: os.h:247
String
Definition: ustring.h:64
Object
Definition: object.h:317
Generated on Wed Jul 13 2016 13:20:59 by   doxygen 1.8.11