1/**************************************************************************/
2/* main.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 MAIN_H
32#define MAIN_H
33
34#include "core/error/error_list.h"
35#include "core/os/thread.h"
36#include "core/typedefs.h"
37
38template <class T>
39class Vector;
40
41class Main {
42 static void print_help(const char *p_binary);
43 static uint64_t last_ticks;
44 static uint32_t hide_print_fps_attempts;
45 static uint32_t frames;
46 static uint32_t frame;
47 static bool force_redraw_requested;
48 static int iterating;
49 static bool agile_input_event_flushing;
50
51public:
52 static bool is_cmdline_tool();
53#ifdef TOOLS_ENABLED
54 enum CLIScope {
55 CLI_SCOPE_TOOL, // Editor and project manager.
56 CLI_SCOPE_PROJECT,
57 };
58 static const Vector<String> &get_forwardable_cli_arguments(CLIScope p_scope);
59#endif
60
61 static int test_entrypoint(int argc, char *argv[], bool &tests_need_run);
62 static Error setup(const char *execpath, int argc, char *argv[], bool p_second_phase = true);
63 static Error setup2(); // The thread calling setup2() will effectively become the main thread.
64 static String get_rendering_driver_name();
65#ifdef TESTS_ENABLED
66 static Error test_setup();
67 static void test_cleanup();
68#endif
69 static bool start();
70
71 static bool iteration();
72 static void force_redraw();
73
74 static bool is_iterating();
75
76 static void cleanup(bool p_force = false);
77};
78
79// Test main override is for the testing behavior.
80#define TEST_MAIN_OVERRIDE \
81 bool run_test = false; \
82 int return_code = Main::test_entrypoint(argc, argv, run_test); \
83 if (run_test) { \
84 return return_code; \
85 }
86
87#define TEST_MAIN_PARAM_OVERRIDE(argc, argv) \
88 bool run_test = false; \
89 int return_code = Main::test_entrypoint(argc, argv, run_test); \
90 if (run_test) { \
91 return return_code; \
92 }
93
94#endif // MAIN_H
95