text,length,is_long_context,metric_val,label_metric
"/*************************************************************************/
/*  main.cpp                                                             */
/*************************************************************************/
/*                       This file is part of:                           */
/*                           GODOT ENGINE                                */
/*                      https://godotengine.org                          */
/*************************************************************************/
/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur.                 */
/* Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md)    */
/*                                                                       */
/* 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.                */
/*************************************************************************/

#include ""main.h""

#include ""app_icon.gen.h""
#include ""core/register_core_types.h""
#include ""drivers/register_driver_types.h""
#include ""message_queue.h""
#include ""modules/register_module_types.h""
#include ""os/os.h""
#include ""platform/register_platform_apis.h""
#include ""project_settings.h""
#include ""scene/register_scene_types.h""
#include ""script_debugger_local.h""
#include ""script_debugger_remote.h""
#include ""servers/register_server_types.h""
#include ""splash.gen.h""
#include ""splash_editor.gen.h""

#include ""input_map.h""
#include ""io/resource_loader.h""
#include ""scene/main/scene_tree.h""
#include ""servers/arvr_server.h""
#include ""servers/audio_server.h""
#include ""servers/physics_2d_server.h""
#include ""servers/physics_server.h""

#include ""io/resource_loader.h""
#include ""script_language.h""

#include ""core/io/ip.h""
#include ""main/tests/test_main.h""
#include ""os/dir_access.h""
#include ""scene/main/viewport.h""
#include ""scene/resources/packed_scene.h""

#ifdef TOOLS_ENABLED
#include ""editor/doc/doc_data.h""
#include ""editor/doc/doc_data_class_path.gen.h""
#include ""editor/editor_node.h""
#include ""editor/project_manager.h""
#endif

#include ""io/file_access_network.h""
#include ""servers/physics_2d_server.h""

#include ""core/io/file_access_pack.h""
#include ""core/io/file_access_zip.h""
#include ""core/io/stream_peer_ssl.h""
#include ""core/io/stream_peer_tcp.h""
#include ""main/input_default.h""
#include ""performance.h""
#include ""translation.h""
#include ""version.h""
#include ""version_hash.gen.h""

static ProjectSettings *globals = NULL;
static Engine *engine = NULL;
static InputMap *input_map = NULL;
static bool _start_success = false;
static ScriptDebugger *script_debugger = NULL;
AudioServer *audio_server = NULL;
ARVRServer *arvr_server = NULL;
PhysicsServer *physics_server = NULL;
Physics2DServer *physics_2d_server = NULL;

static MessageQueue *message_queue = NULL;
static Performance *performance = NULL;

static PackedData *packed_data = NULL;
#ifdef MINIZIP_ENABLED
static ZipArchive *zip_packed_data = NULL;
#endif
static FileAccessNetworkClient *file_access_network_client = NULL;
static TranslationServer *translation_server = NULL;

static OS::VideoMode video_mode;
static bool init_maximized = false;
static bool init_windowed = false;
static bool init_fullscreen = false;
static bool init_always_on_top = false;
static bool init_use_custom_pos = false;
#ifdef DEBUG_ENABLED
static bool debug_collisions = false;
static bool debug_navigation = false;
#endif
static int frame_delay = 0;
static Vector2 init_custom_pos;
static int video_driver_idx = -1;
static int audio_driver_idx = -1;
static String locale;
static bool use_debug_profiler = false;
static bool force_lowdpi = false;
static int init_screen = -1;
static bool use_vsync = true;
static bool editor = false;
static bool show_help = false;
static bool disable_render_loop = false;
static int fixed_fps = -1;

static OS::ProcessID allow_focus_steal_pid = 0;

static bool project_manager = false;

bool Main::is_project_manager() {
	return project_manager;
}

void initialize_physics() {

	/// 3D Physics Server
	physics_server = PhysicsServerManager::new_server(ProjectSettings::get_singleton()->get(PhysicsServerManager::setting_property_name));
	if (!physics_server) {
		// Physics server not found, Use the default physics
		physics_server = PhysicsServerManager::new_default_server();
	}
	ERR_FAIL_COND(!physics_server);
	physics_server->init();

	/// 2D Physics server
	physics_2d_server = Physics2DServerManager::new_server(ProjectSettings::get_singleton()->get(Physics2DServerManager::setting_property_name));
	if (!physics_2d_server) {
		// Physics server not found, Use the default physics
		physics_2d_server = Physics2DServerManager::new_default_server();
	}
	ERR_FAIL_COND(!physics_2d_server);
	physics_2d_server->init();
}

void finalize_physics() {
	physics_server->finish();
	memdelete(physics_server);

	physics_2d_server->finish();
	memdelete(physics_2d_server);
}

static String unescape_cmdline(const String &p_str) {

	return p_str.replace(""%20"", "" "");
}

static String get_full_version_string() {

	String hash = String(VERSION_HASH);
	if (hash.length() != 0)
		hash = ""."" + hash.left(7);
	return String(VERSION_MKSTRING) + hash;
}

//#define DEBUG_INIT
#ifdef DEBUG_INIT
#define MAIN_PRINT(m_txt) print_line(m_txt)
#else
#define MAIN_PRINT(m_txt)
#endif

void Main::print_help(const char *p_binary) {

	print_line(String(VERSION_NAME) + "" v"" + get_full_version_string() + "" - https://godotengine.org"");
	OS::get_singleton()->print(""(c) 2007-2018 Juan Linietsky, Ariel Manzur.\\n"");
	OS::get_singleton()->print(""(c) 2014-2018 Godot Engine contributors.\\n"");
	OS::get_singleton()->print(""\\n"");
	OS::get_singleton()->print(""Usage: %s [options] [path to scene or 'project.godot' file]\\n"", p_binary);
	OS::get_singleton()->print(""\\n"");

	OS::get_singleton()->print(""General options:\\n"");
	OS::get_singleton()->print(""  -h, --help                       Display this help message.\\n"");
	OS::get_singleton()->print(""  --version                        Display the version string.\\n"");
	OS::get_singleton()->print(""  -v, --verbose                    Use verbose stdout mode.\\n"");
	OS::get_singleton()->print(""  --quiet                          Quiet mode, silences stdout messages. Errors are still displayed.\\n"");
	OS::get_singleton()->print(""\\n"");

	OS::get_singleton()->print(""Run options:\\n"");
#ifdef TOOLS_ENABLED
	OS::get_singleton()->print(""  -e, --editor                     Start the editor instead of running the scene.\\n"");
	OS::get_singleton()->print(""  -p, --project-manager            Start the project manager, even if a project is auto-detected.\\n"");
#endif
	OS::get_singleton()->print(""  -l, --language <locale>          Use a specific locale (<locale> being a two-letter code).\\n"");
	OS::get_singleton()->print(""  --path <directory>               Path to a project (<directory> must contain a 'project.godot' file).\\n"");
	OS::get_singleton()->print(""  -u, --upwards                    Scan folders upwards for project.godot file.\\n"");
	OS::get_singleton()->print(""  --main-pack <file>               Path to a pack (.pck) file to load.\\n"");
	OS::get_singleton()->print(""  --render-thread <mode>           Render thread mode ('unsafe', 'safe', 'separate').\\n"");
	OS::get_singleton()->print(""  --remote-fs <address>            Remote filesystem (<host/IP>[:<port>] address).\\n"");
	OS::get_singleton()->print(""  --remote-fs-password <password>  Password for remote filesystem.\\n"");
	OS::get_singleton()->print(""  --audio-driver <driver>          Audio driver ("");
	for (int i = 0; i < OS::get_singleton()->get_audio_driver_count(); i++) {
		if (i != 0)
			OS::get_singleton()->print("", "");
		OS::get_singleton()->print(""'%s'"", OS::get_singleton()->get_audio_driver_name(i));
	}
	OS::get_singleton()->print("").\\n"");
	OS::get_singleton()->print(""  --video-driver <driver>          Video driver ("");
	for (int i = 0; i < OS::get_singleton()->get_video_driver_count(); i++) {
		if (i != 0)
			OS::get_singleton()->print("", "");
		OS::get_singleton()->print(""'%s'"", OS::get_singleton()->get_video_driver_name(i));
	}
	OS::get_singleton()->print("").\\n"");
	OS::get_singleton()->print(""\\n"");

	OS::get_singleton()->print(""Display options:\\n"");
	OS::get_singleton()->print(""  -f, --fullscreen                 Request fullscreen mode.\\n"");
	OS::get_singleton()->print(""  -m, --maximized                  Request a maximized window.\\n"");
	OS::get_singleton()->print(""  -w, --windowed                   Request windowed mode.\\n"");
	OS::get_singleton()->print(""  -t, --always-on-top              Request an always-on-top window.\\n"");
	OS::get_singleton()->print(""  --resolution <W>x<H>             Request window resolution.\\n"");
	OS::get_singleton()->print(""  --position <X>,<Y>               Request window position.\\n"");
	OS::get_singleton()->print(""  --low-dpi                        Force low-DPI mode (macOS and Windows only).\\n"");
	OS::get_singleton()->print(""  --no-window                      Disable window creation (Windows only). Useful together with --script.\\n"");
	OS::get_singleton()->print(""\\n"");

	OS::get_singleton()->print(""Debug options:\\n"");
	OS::get_singleton()->print(""  -d, --debug                      Debug (local stdout debugger).\\n"");
	OS::get_singleton()->print(""  -b, --breakpoints                Breakpoint list as source::line comma-separated pairs, no spaces (use %%20 instead).\\n"");
	OS::get_singleton()->print(""  --profiling                      Enable profiling in the script debugger.\\n"");
	OS::get_singleton()->print(""  --remote-debug <address>         Remote debug (<host/IP>:<port> address).\\n"");
#ifdef DEBUG_ENABLED
	OS::get_singleton()->print(""  --debug-collisions               Show collisions shapes when running the scene.\\n"");
	OS::get_singleton()->print(""  --debug-navigation               Show navigation polygons when running the scene.\\n"");
#endif
	OS::get_singleton()->print(""  --frame-delay <ms>               Simulate high CPU load (delay each frame by <ms> milliseconds).\\n"");
	OS::get_singleton()->print(""  --time-scale <scale>             Force time scale (higher values are faster, 1.0 is normal speed).\\n"");
	OS::get_singleton()->print(""  --disable-render-loop            Disable render loop so rendering only occurs when called explicitly from script.\\n"");
	OS::get_singleton()->print(""  --disable-crash-handler          Disable crash handler when supported by the platform code.\\n"");
	OS::get_singleton()->print(""  --fixed-fps <fps>                Force a fixed number of frames per second. This setting disables real-time synchronization.\\n"");
	OS::get_singleton()->print(""\\n"");

	OS::get_singleton()->print(""Standalone tools:\\n"");
	OS::get_singleton()->print(""  -s, --script <script>            Run a script.\\n"");
#ifdef TOOLS_ENABLED
	OS::get_singleton()->print(""  --export <target>                Export the project using the given export target.\\n"");
	OS::get_singleton()->print(""  --export-debug                   Use together with --export, enables debug mode for the template.\\n"");
	OS::get_singleton()->print(""  --doctool <path>                 Dump the engine API reference to the given <path> in XML format, merging if existing files are found.\\n"");
	OS::get_singleton()->print(""  --no-docbase                     Disallow dumping the base types (used with --doctool).\\n"");
#ifdef DEBUG_METHODS_ENABLED
	OS::get_singleton()->print(""  --gdnative-generate-json-api     Generate JSON dump of the Godot API for GDNative bindings.\\n"");
#endif
	OS::get_singleton()->print(""  --test <test>                    Run a unit test ("");
	const char **test_names = tests_get_names();
	const char *comma = """";
	while (*test_names) {
		OS::get_singleton()->print(""%s'%s'"", comma, *test_names);
		test_names++;
		comma = "", "";
	}
	OS::get_singleton()->print("").\\n"");
#endif
}

Error Main::setup(const char *execpath, int argc, char *argv[], bool p_second_phase) {
	RID_OwnerBase::init_rid();

	OS::get_singleton()->initialize_core();

	engine = memnew(Engine);

	ClassDB::init();

	MAIN_PRINT(""Main: Initialize CORE"");

	register_core_types();
	register_core_driver_types();

	MAIN_PRINT(""Main: Initialize Globals"");

	Thread::_main_thread_id = Thread::get_caller_id();

	globals = memnew(ProjectSettings);
	input_map = memnew(InputMap);

	register_core_settings(); //here globals is present

	translation_server = memnew(TranslationServer);
	performance = memnew(Performance);
	ClassDB::register_class<Performance>();
	engine->add_singleton(Engine::Singleton(""Performance"", performance));

	GLOBAL_DEF(""debug/settings/crash_handler/message"", String(""Please include this when reporting the bug on https://github.com/godotengine/godot/issues""));

	MAIN_PRINT(""Main: Parse CMDLine"");

	/* argument parsing and main creation */
	List<String> args;
	List<String> main_args;

	for (int i = 0; i < argc; i++) {

		args.push_back(String::utf8(argv[i]));
	}

	List<String>::Element *I = args.front();

	I = args.front();

	while (I) {

		I->get() = unescape_cmdline(I->get().strip_escapes());
		I = I->next();
	}

	I = args.front();

	String video_driver = """";
	String audio_driver = """";
	String game_path = ""."";
	bool upwards = false;
	String debug_mode;
	String debug_host;
	String main_pack;
	bool quiet_stdout = false;
	int rtm = -1;

	String remotefs;
	String remotefs_pass;

	Vector<String> breakpoints;
	bool use_custom_res = true;
	bool force_res = false;

	packed_data = PackedData::get_singleton();
	if (!packed_data)
		packed_data = memnew(PackedData);

#ifdef MINIZIP_ENABLED

	//XXX: always get_singleton() == 0x0
	zip_packed_data = ZipArchive::get_singleton();
	//TODO: remove this temporary fix
	if (!zip_packed_data) {
		zip_packed_data = memnew(ZipArchive);
	}

	packed_data->add_pack_source(zip_packed_data);
#endif

	I = args.front();
	while (I) {

		List<String>::Element *N = I->next();

		if (I->get() == ""-h"" || I->get() == ""--help"" || I->get() == ""/?"") { // display help

			show_help = true;
			goto error;

		} else if (I->get() == ""--version"") {

			print_line(get_full_version_string());
			goto error;

		} else if (I->get() == ""--resolution"") { // force resolution

			if (I->next()) {

				String vm = I->next()->get();

				if (vm.find(""x"") == -1) { // invalid parameter format

					OS::get_singleton()->print(""Invalid resolution '%s', it should be e.g. '1280x720'.\\n"", vm.utf8().get_data());
					goto error;
				}

				int w = vm.get_slice(""x"", 0).to_int();
				int h = vm.get_slice(""x"", 1).to_int();

				if (w <= 0 || h <= 0) {

					OS::get_singleton()->print(""Invalid resolution '%s', width and height must be above 0.\\n"", vm.utf8().get_data());
					goto error;
				}

				video_mode.width = w;
				video_mode.height = h;
				force_res = true;

				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing resolution argument, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""--position"") { // set window position

			if (I->next()) {

				String vm = I->next()->get();

				if (vm.find("","") == -1) { // invalid parameter format

					OS::get_singleton()->print(""Invalid position '%s', it should be e.g. '80,128'.\\n"", vm.utf8().get_data());
					goto error;
				}

				int x = vm.get_slice("","", 0).to_int();
				int y = vm.get_slice("","", 1).to_int();

				init_custom_pos = Point2(x, y);
				init_use_custom_pos = true;

				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing position argument, aborting.\\n"");
				goto error;
			}

		} else if (I->get() == ""-m"" || I->get() == ""--maximized"") { // force maximized window

			init_maximized = true;
			video_mode.maximized = true;
		} else if (I->get() == ""-w"" || I->get() == ""--windowed"") { // force windowed window

			init_windowed = true;
		} else if (I->get() == ""-t"" || I->get() == ""--always-on-top"") { // force always-on-top window

			init_always_on_top = true;
		} else if (I->get() == ""--profiling"") { // enable profiling

			use_debug_profiler = true;
		} else if (I->get() == ""--video-driver"") { // force video driver

			if (I->next()) {

				video_driver = I->next()->get();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing video driver argument, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""-l"" || I->get() == ""--language"") { // language

			if (I->next()) {

				locale = I->next()->get();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing language argument, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""--low-dpi"") { // force low DPI (macOS only)

			force_lowdpi = true;
		} else if (I->get() == ""--remote-fs"") { // remote filesystem

			if (I->next()) {

				remotefs = I->next()->get();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing remote filesystem address, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""--remote-fs-password"") { // remote filesystem password

			if (I->next()) {

				remotefs_pass = I->next()->get();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing remote filesystem password, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""--render-thread"") { // render thread mode

			if (I->next()) {

				if (I->next()->get() == ""safe"")
					rtm = OS::RENDER_THREAD_SAFE;
				else if (I->next()->get() == ""unsafe"")
					rtm = OS::RENDER_THREAD_UNSAFE;
				else if (I->next()->get() == ""separate"")
					rtm = OS::RENDER_SEPARATE_THREAD;

				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing render thread mode argument, aborting.\\n"");
				goto error;
			}

		} else if (I->get() == ""--audio-driver"") { // audio driver

			if (I->next()) {

				audio_driver = I->next()->get();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing audio driver argument, aborting.\\n"");
				goto error;
			}

		} else if (I->get() == ""-f"" || I->get() == ""--fullscreen"") { // force fullscreen

			//video_mode.fullscreen=false;
			init_fullscreen = true;
#ifdef TOOLS_ENABLED
		} else if (I->get() == ""-e"" || I->get() == ""--editor"") { // starts editor

			editor = true;
		} else if (I->get() == ""-p"" || I->get() == ""--project-manager"") { // starts project manager

			project_manager = true;
#endif
		} else if (I->get() == ""--no-window"") { // disable window creation, Windows only

			OS::get_singleton()->set_no_window_mode(true);
		} else if (I->get() == ""--quiet"") { // quieter output

			quiet_stdout = true;
		} else if (I->get() == ""-v"" || I->get() == ""--verbose"") { // verbose output
			OS::get_singleton()->_verbose_stdout = true;
		} else if (I->get() == ""--path"") { // set path of project to start or edit

			if (I->next()) {

				String p = I->next()->get();
				if (OS::get_singleton()->set_cwd(p) == OK) {
					//nothing
				} else {
					game_path = I->next()->get(); //use game_path instead
				}
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing relative or absolute path, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""-u"" || I->get() == ""--upwards"") { // scan folders upwards
			upwards = true;
		} else if (I->get().ends_with(""project.godot"")) {
			String path;
			String file = I->get();
			int sep = MAX(file.find_last(""/""), file.find_last(""\\\\""));
			if (sep == -1)
				path = ""."";
			else {
				path = file.substr(0, sep);
			}
			if (OS::get_singleton()->set_cwd(path) == OK) {
				// path already specified, don't override
			} else {
				game_path = path;
			}
#ifdef TOOLS_ENABLED
			editor = true;
#endif
		} else if (I->get() == ""-b"" || I->get() == ""--breakpoints"") { // add breakpoints

			if (I->next()) {

				String bplist = I->next()->get();
				breakpoints = bplist.split("","");
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing list of breakpoints, aborting.\\n"");
				goto error;
			}

		} else if (I->get() == ""--frame-delay"") { // force frame delay

			if (I->next()) {

				frame_delay = I->next()->get().to_int();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing frame delay argument, aborting.\\n"");
				goto error;
			}

		} else if (I->get() == ""--time-scale"") { // force time scale

			if (I->next()) {

				Engine::get_singleton()->set_time_scale(I->next()->get().to_double());
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing time scale argument, aborting.\\n"");
				goto error;
			}

		} else if (I->get() == ""--main-pack"") {

			if (I->next()) {

				main_pack = I->next()->get();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing path to main pack file, aborting.\\n"");
				goto error;
			};

		} else if (I->get() == ""-d"" || I->get() == ""--debug"") {
			debug_mode = ""local"";
#ifdef DEBUG_ENABLED
		} else if (I->get() == ""--debug-collisions"") {
			debug_collisions = true;
		} else if (I->get() == ""--debug-navigation"") {
			debug_navigation = true;
#endif
		} else if (I->get() == ""--remote-debug"") {
			if (I->next()) {

				debug_mode = ""remote"";
				debug_host = I->next()->get();
				if (debug_host.find("":"") == -1) { // wrong address
					OS::get_singleton()->print(""Invalid debug host address, it should be of the form <host/IP>:<port>.\\n"");
					goto error;
				}
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing remote debug host address, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""--allow_focus_steal_pid"") { // not exposed to user
			if (I->next()) {

				allow_focus_steal_pid = I->next()->get().to_int64();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing editor PID argument, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""--disable-render-loop"") {
			disable_render_loop = true;
		} else if (I->get() == ""--fixed-fps"") {
			if (I->next()) {
				fixed_fps = I->next()->get().to_int();
				N = I->next()->next();
			} else {
				OS::get_singleton()->print(""Missing fixed-fps argument, aborting.\\n"");
				goto error;
			}
		} else if (I->get() == ""--disable-crash-handler"") {
			OS::get_singleton()->disable_crash_handler();
		} else {

			//test for game path
			bool gpfound = false;

			if (!I->get().begins_with(""-"") && game_path == """") {
				DirAccess *da = DirAccess::open(I->get());
				if (da != NULL) {
					game_path = I->get();
					gpfound = true;
					memdelete(da);
				}
			}

			if (!gpfound) {
				main_args.push_back(I->get());
			}
		}

		I = N;
	}

	GLOBAL_DEF(""memory/limits/multithreaded_server/rid_pool_prealloc"", 60);
	GLOBAL_DEF(""network/limits/debugger_stdout/max_chars_per_second"", 2048);
	GLOBAL_DEF(""network/limits/debugger_stdout/max_messages_per_frame"", 10);
	GLOBAL_DEF(""network/limits/debugger_stdout/max_errors_per_frame"", 10);

	if (debug_mode == ""remote"") {

		ScriptDebuggerRemote *sdr = memnew(ScriptDebuggerRemote);
		uint16_t debug_port = 6007;
		if (debug_host.find("":"") != -1) {
			int sep_pos = debug_host.find_last("":"");
			debug_port = debug_host.substr(sep_pos + 1, debug_host.length()).to_int();
			debug_host = debug_host.substr(0, sep_pos);
		}
		Error derr = sdr->connect_to_host(debug_host, debug_port);

		if (derr != OK) {
			memdelete(sdr);
		} else {
			script_debugger = sdr;
		}
	} else if (debug_mode == ""local"") {

		script_debugger = memnew(ScriptDebuggerLocal);
	}

	FileAccessNetwork::configure();

	if (remotefs != """") {

		file_access_network_client = memnew(FileAccessNetworkClient);
		int port;
		if (remotefs.find("":"") != -1) {
			port = remotefs.get_slicec(':', 1).to_int();
			remotefs = remotefs.get_slicec(':', 0);
		} else {
			port = 6010;
		}

		Error err = file_access_network_client->connect(remotefs, port, remotefs_pass);
		if (err) {
			OS::get_singleton()->printerr(""Could not connect to remotefs: %s:%i.\\n"", remotefs.utf8().get_data(), port);
			goto error;
		}

		FileAccess::make_default<FileAccessNetwork>(FileAccess::ACCESS_RESOURCES);
	}
	if (script_debugger) {
		//there is a debugger, parse breakpoints

		for (int i = 0; i < breakpoints.size(); i++) {

			String bp = breakpoints[i];
			int sp = bp.find_last("":"");
			if (sp == -1) {
				ERR_EXPLAIN(""Invalid breakpoint: '"" + bp + ""', expected file:line format."");
				ERR_CONTINUE(sp == -1);
			}

			script_debugger->insert_breakpoint(bp.substr(sp + 1, bp.length()).to_int(), bp.substr(0, sp));
		}
	}

#ifdef TOOLS_ENABLED
	if (editor) {
		packed_data->set_disabled(true);
		globals->set_disable_feature_overrides(true);
		StreamPeerSSL::initialize_certs = false; //will be initialized by editor
	}

#endif

	if (globals->setup(game_path, main_pack, upwards) != OK) {

#ifdef TOOLS_ENABLED
		editor = false;
#else
		OS::get_singleton()->print(""Error: Could not load game path '%s'.\\n"", game_path.ascii().get_data());

		goto error;
#endif
	} else if (String(GLOBAL_DEF(""application/run/main_scene"", """")) == """") {
#ifdef TOOLS_ENABLED
		if (!editor) {
#endif
			OS::get_singleton()->print(""Error: Can't run project: no main scene defined.\\n"");
			goto error;
#ifdef TOOLS_ENABLED
		}
#endif
	}

	GLOBAL_DEF(""logging/file_logging/enable_file_logging"", false);
	GLOBAL_DEF(""logging/file_logging/log_path"", ""user://logs/log.txt"");
	GLOBAL_DEF(""logging/file_logging/max_log_files"", 10);
	if (FileAccess::get_create_func(FileAccess::ACCESS_USERDATA) && GLOBAL_GET(""logging/file_logging/enable_file_logging"")) {
		String base_path = GLOBAL_GET(""logging/file_logging/log_path"");
		int max_files = GLOBAL_GET(""logging/file_logging/max_log_files"");
		OS::get_singleton()->add_logger(memnew(RotatedFileLogger(base_path, max_files)));
	}

	if (editor) {
		Engine::get_singleton()->set_editor_hint(true);
		main_args.push_back(""--editor"");
		if (!init_windowed) {
			init_maximized = true;
			video_mode.maximized = true;
		}
		use_custom_res = false;
	}

	if (bool(ProjectSettings::get_singleton()->get(""application/run/disable_stdout""))) {
		quiet_stdout = true;
	}
	if (bool(ProjectSettings::get_singleton()->get(""application/run/disable_stderr""))) {
		_print_error_enabled = false;
	};

	if (quiet_stdout)
		_print_line_enabled = false;

	OS::get_singleton()->set_cmdline(execpath, main_args);

#ifdef TOOLS_ENABLED

	if (!project_manager) {
		// Determine if the project manager should be requested
		project_manager =
				main_args.size() == 0 &&
				!ProjectSettings::get_singleton()->has_setting(""application/run/main_loop_type"") &&
				(!ProjectSettings::get_singleton()->has_setting(""application/run/main_scene"") ||
						String(ProjectSettings::get_singleton()->get(""application/run/main_scene"")) == """");
	}

	if (project_manager) {
		use_custom_res = false; //project manager (run without arguments)
	}

#endif

	if (editor)
		input_map->load_default(); //keys for editor
	else
		input_map->load_from_globals(); //keys for game

	//if (video_driver == """") // useless for now, so removing
	//	video_driver = GLOBAL_DEF(""display/driver/name"", Variant((const char *)OS::get_singleton()->get_video_driver_name(0)));

	GLOBAL_DEF(""display/window/size/width"", 1024);
	GLOBAL_DEF(""display/window/size/height"", 600);
	GLOBAL_DEF(""display/window/size/resizable"", true);
	GLOBAL_DEF(""display/window/size/borderless"", false);
	GLOBAL_DEF(""display/window/size/fullscreen"", false);
	GLOBAL_DEF(""display/window/size/always_on_top"", false);
	GLOBAL_DEF(""display/window/size/test_width"", 0);
	GLOBAL_DEF(""display/window/size/test_height"", 0);

	if (use_custom_res) {

		if (!force_res) {
			video_mode.width = GLOBAL_GET(""display/window/size/width"");
			video_mode.height = GLOBAL_GET(""display/window/size/height"");

			if (globals->has_setting(""display/window/size/test_width"") && globals->has_setting(""display/window/size/test_height"")) {
				int tw = globals->get(""display/window/size/test_width"");
				int th = globals->get(""display/window/size/test_height"");
				if (tw > 0 && th > 0) {
					video_mode.width = tw;
					video_mode.height = th;
				}
			}
		}

		video_mode.resizable = GLOBAL_GET(""display/window/size/resizable"");
		video_mode.borderless_window = GLOBAL_GET(""display/window/size/borderless"");
		video_mode.fullscreen = GLOBAL_GET(""display/window/size/fullscreen"");
		video_mode.always_on_top = GLOBAL_GET(""display/window/size/always_on_top"");
	}

	if (!force_lowdpi) {
		OS::get_singleton()->_allow_hidpi = GLOBAL_DEF(""display/window/dpi/allow_hidpi"", false);
	}

	video_mode.use_vsync = GLOBAL_DEF(""display/window/vsync/use_vsync"", true);

	GLOBAL_DEF(""rendering/quality/intended_usage/framebuffer_allocation"", 2);
	GLOBAL_DEF(""rendering/quality/intended_usage/framebuffer_allocation.mobile"", 3);

	if (editor || project_manager) {
		// The editor and project manager always detect and use hiDPI if needed
		OS::get_singleton()->_allow_hidpi = true;
	}

	Engine::get_singleton()->_pixel_snap = GLOBAL_DEF(""rendering/quality/2d/use_pixel_snap"", false);
	OS::get_singleton()->_keep_screen_on = GLOBAL_DEF(""display/window/energy_saving/keep_screen_on"", true);
	if (rtm == -1) {
		rtm = GLOBAL_DEF(""rendering/threads/thread_model"", OS::RENDER_THREAD_SAFE);
	}

	if (rtm >= 0 && rtm < 3) {
		if (editor) {
			rtm = OS::RENDER_THREAD_SAFE;
		}
		OS::get_singleton()->_render_thread_mode = OS::RenderThreadMode(rtm);
	}

	/* Determine audio and video drivers */

	for (int i = 0; i < OS::get_singleton()->get_video_driver_count(); i++) {

		if (video_driver == OS::get_singleton()->get_video_driver_name(i)) {

			video_driver_idx = i;
			break;
		}
	}

	if (video_driver_idx < 0) {

		//OS::get_singleton()->alert(""Invalid Video Driver: "" + video_driver);
		video_driver_idx = 0;
		//goto error;
	}

	if (audio_driver == """") { // specified in project.godot
		audio_driver = GLOBAL_DEF(""audio/driver"", OS::get_singleton()->get_audio_driver_name(0));
	}

	for (int i = 0; i < OS::get_singleton()->get_audio_driver_count(); i++) {

		if (audio_driver == OS::get_singleton()->get_audio_driver_name(i)) {

			audio_driver_idx = i;
			break;
		}
	}

	if (audio_driver_idx < 0) {

		OS::get_singleton()->alert(""Invalid Audio Driver: "" + audio_driver);
		audio_driver_idx = 0;
		//goto error;
	}

	{
		String orientation = GLOBAL_DEF(""display/window/handheld/orientation"", ""landscape"");

		if (orientation == ""portrait"")
			OS::get_singleton()->set_screen_orientation(OS::SCREEN_PORTRAIT);
		else if (orientation == ""reverse_landscape"")
			OS::get_singleton()->set_screen_orientation(OS::SCREEN_REVERSE_LANDSCAPE);
		else if (orientation == ""reverse_portrait"")
			OS::get_singleton()->set_screen_orientation(OS::SCREEN_REVERSE_PORTRAIT);
		else if (orientation == ""sensor_landscape"")
			OS::get_singleton()->set_screen_orientation(OS::SCREEN_SENSOR_LANDSCAPE);
		else if (orientation == ""sensor_portrait"")
			OS::get_singleton()->set_screen_orientation(OS::SCREEN_SENSOR_PORTRAIT);
		else if (orientation == ""sensor"")
			OS::get_singleton()->set_screen_orientation(OS::SCREEN_SENSOR);
		else
			OS::get_singleton()->set_screen_orientation(OS::SCREEN_LANDSCAPE);
	}

	Engine::get_singleton()->set_iterations_per_second(GLOBAL_DEF(""physics/common/physics_fps"", 60));
	Engine::get_singleton()->set_target_fps(GLOBAL_DEF(""debug/settings/fps/force_fps"", 0));

	GLOBAL_DEF(""debug/settings/stdout/print_fps"", OS::get_singleton()->is_stdout_verbose());

	if (!OS::get_singleton()->_verbose_stdout) //overridden
		OS::get_singleton()->_verbose_stdout = GLOBAL_DEF(""debug/settings/stdout/verbose_stdout"", false);

	if (frame_delay == 0) {
		frame_delay = GLOBAL_DEF(""application/run/frame_delay_msec"", 0);
	}

	OS::get_singleton()->set_low_processor_usage_mode(GLOBAL_DEF(""application/run/low_processor_mode"", false));
	OS::get_singleton()->set_low_processor_usage_mode_sleep_usec(GLOBAL_DEF(""application/run/low_processor_mode_sleep_usec"", 8000));

	Engine::get_singleton()->set_frame_delay(frame_delay);

	message_queue = memnew(MessageQueue);

	ProjectSettings::get_singleton()->register_global_defaults();

	if (p_second_phase)
		return setup2();

	return OK;

error:

	video_driver = """";
	audio_driver = """";
	game_path = """";

	args.clear();
	main_args.clear();

	if (show_help)
		print_help(execpath);

	if (performance)
		memdelete(performance);
	if (input_map)
		memdelete(input_map);
	if (translation_server)
		memdelete(translation_server);
	if (globals)
		memdelete(globals);
	if (engine)
		memdelete(engine);
	if (script_debugger)
		memdelete(script_debugger);
	if (packed_data)
		memdelete(packed_data);
	if (file_access_network_client)
		memdelete(file_access_network_client);

	// Note 1: *zip_packed_data live into *packed_data
	// Note 2: PackedData::~PackedData destroy this.
	/*
#ifdef MINIZIP_ENABLED
	if (zip_packed_data)
		memdelete( zip_packed_data );
#endif
*/

	unregister_core_driver_types();
	unregister_core_types();

	OS::get_singleton()->_cmdline.clear();

	if (message_queue)
		memdelete(message_queue);
	OS::get_singleton()->finalize_core();
	locale = String();

	return ERR_INVALID_PARAMETER;
}

Error Main::setup2(Thread::ID p_main_tid_override) {

	if (p_main_tid_override) {
		Thread::_main_thread_id = p_main_tid_override;
	}

	Error err = OS::get_singleton()->initialize(video_mode, video_driver_idx, audio_driver_idx);
	if (err != OK) {
		return err;
	}
	if (init_use_custom_pos) {
		OS::get_singleton()->set_window_position(init_custom_pos);
	}

	// right moment to create and initialize the audio server

	audio_server = memnew(AudioServer);
	audio_server->init();

	// also init our arvr_server from here
	arvr_server = memnew(ARVRServer);

	register_core_singletons();

	MAIN_PRINT(""Main: Setup Logo"");

#ifdef JAVASCRIPT_ENABLED
	bool show_logo = false;
#else
	bool show_logo = true;
#endif

	if (init_screen != -1) {
		OS::get_singleton()->set_current_screen(init_screen);
	}
	if (init_windowed) {
		//do none..
	} else if (init_maximized) {
		OS::get_singleton()->set_window_maximized(true);
	} else if (init_fullscreen) {
		OS::get_singleton()->set_window_fullscreen(true);
	}
	if (init_always_on_top) {
		OS::get_singleton()->set_window_always_on_top(true);
	}

	register_server_types();

	MAIN_PRINT(""Main: Load Remaps"");

	Color clear = GLOBAL_DEF(""rendering/environment/default_clear_color"", Color(0.3, 0.3, 0.3));
	VisualServer::get_singleton()->set_default_clear_color(clear);

	if (show_logo) { //boot logo!
		String boot_logo_path = GLOBAL_DEF(""application/boot_splash/image"", String());
		bool boot_logo_scale = GLOBAL_DEF(""application/boot_splash/fullsize"", true);
		ProjectSettings::get_singleton()->set_custom_property_info(""application/boot_splash/image"", PropertyInfo(Variant::STRING, ""application/boot_splash/image"", PROPERTY_HINT_FILE, ""*.png""));

		Ref<Image> boot_logo;

		boot_logo_path = boot_logo_path.strip_edges();

		if (boot_logo_path != String() /*&& FileAccess::exists(boot_logo_path)*/) {
			print_line(""Boot splash path: "" + boot_logo_path);
			boot_logo.instance();
			Error err = boot_logo->load(boot_logo_path);
			if (err)
				ERR_PRINTS(""Non-existing or invalid boot splash at: "" + boot_logo_path + "". Loading default splash."");
		}

		if (boot_logo.is_valid()) {
			OS::get_singleton()->_msec_splash = OS::get_singleton()->get_ticks_msec();
			Color boot_bg = GLOBAL_DEF(""application/boot_splash/bg_color"", clear);
			VisualServer::get_singleton()->set_boot_image(boot_logo, boot_bg, boot_logo_scale);
#ifndef TOOLS_ENABLED
//no tools, so free the boot logo (no longer needed)
//ProjectSettings::get_singleton()->set(""application/boot_logo"",Image());
#endif

		} else {
#ifndef NO_DEFAULT_BOOT_LOGO

			MAIN_PRINT(""Main: Create bootsplash"");
#if defined(TOOLS_ENABLED) && !defined(NO_EDITOR_SPLASH)

			Ref<Image> splash = editor ? memnew(Image(boot_splash_editor_png)) : memnew(Image(boot_splash_png));
#else
			Ref<Image> splash = memnew(Image(boot_splash_png));
#endif

			MAIN_PRINT(""Main: ClearColor"");
			VisualServer::get_singleton()->set_default_clear_color(boot_splash_bg_color);
			MAIN_PRINT(""Main: Image"");
			VisualServer::get_singleton()->set_boot_image(splash, boot_splash_bg_color, false);
#endif
		}

#ifdef TOOLS_ENABLED
		Ref<Image> icon = memnew(Image(app_icon_png));
		OS::get_singleton()->set_icon(icon);
#endif
	}

	MAIN_PRINT(""Main: DCC"");
	VisualServer::get_singleton()->set_default_clear_color(GLOBAL_DEF(""rendering/environment/default_clear_color"", Color(0.3, 0.3, 0.3)));
	MAIN_PRINT(""Main: END"");

	GLOBAL_DEF(""application/config/icon"", String());
	ProjectSettings::get_singleton()->set_custom_property_info(""application/config/icon"", PropertyInfo(Variant::STRING, ""application/config/icon"", PROPERTY_HINT_FILE, ""*.png,*.webp""));

	if (bool(GLOBAL_DEF(""display/window/handheld/emulate_touchscreen"", false))) {
		if (!OS::get_singleton()->has_touchscreen_ui_hint() && Input::get_singleton() && !editor) {
			//only if no touchscreen ui hint, set emulation
			InputDefault *id = Object::cast_to<InputDefault>(Input::get_singleton());
			if (id)
				id->set_emulate_touch(true);
		}
	}

	MAIN_PRINT(""Main: Load Remaps"");

	MAIN_PRINT(""Main: Load Scene Types"");

	register_scene_types();

	GLOBAL_DEF(""display/mouse_cursor/custom_image"", String());
	GLOBAL_DEF(""display/mouse_cursor/custom_image_hotspot"", Vector2());
	ProjectSettings::get_singleton()->set_custom_property_info(""display/mouse_cursor/custom_image"", PropertyInfo(Variant::STRING, ""display/mouse_cursor/custom_image"", PROPERTY_HINT_FILE, ""*.png,*.webp""));

	if (String(ProjectSettings::get_singleton()->get(""display/mouse_cursor/custom_image"")) != String()) {

		//print_line(""use custom cursor"");
		Ref<Texture> cursor = ResourceLoader::load(ProjectSettings::get_singleton()->get(""display/mouse_cursor/custom_image""));
		if (cursor.is_valid()) {
			//print_line(""loaded ok"");
			Vector2 hotspot = ProjectSettings::get_singleton()->get(""display/mouse_cursor/custom_image_hotspot"");
			Input::get_singleton()->set_custom_mouse_cursor(cursor, Input::CURSOR_ARROW, hotspot);
		}
	}
#ifdef TOOLS_ENABLED
	ClassDB::set_current_api(ClassDB::API_EDITOR);
	EditorNode::register_editor_types();

	ClassDB::set_current_api(ClassDB::API_CORE);

#endif

	if (allow_focus_steal_pid) {
		OS::get_singleton()->enable_for_stealing_focus(allow_focus_steal_pid);
	}

	MAIN_PRINT(""Main: Load Modules, Physics, Drivers, Scripts"");

	register_platform_apis();
	register_module_types();

	initialize_physics();
	register_server_singletons();

	register_driver_types();

	ScriptServer::init_languages();

	MAIN_PRINT(""Main: Load Translations"");

	translation_server->setup(); //register translations, load them, etc.
	if (locale != """") {

		translation_server->set_locale(locale);
	}
	translation_server->load_translations();
	ResourceLoader::load_translation_remaps(); //load remaps for resources

	ResourceLoader::load_path_remaps();

	audio_server->load_default_bus_layout();

	if (use_debug_profiler && script_debugger) {
		script_debugger->profiling_start();
	}
	_start_success = true;
	locale = String();

	ClassDB::set_current_api(ClassDB::API_NONE); //no more api is registered at this point

	if (OS::get_singleton()->is_stdout_verbose()) {
		print_line(""CORE API HASH: "" + itos(ClassDB::get_api_hash(ClassDB::API_CORE)));
		print_line(""EDITOR API HASH: "" + itos(ClassDB::get_api_hash(ClassDB::API_EDITOR)));
	}
	MAIN_PRINT(""Main: Done"");

	return OK;
}

bool Main::start() {

	ERR_FAIL_COND_V(!_start_success, false);

	bool hasicon = false;
	bool editor = false;
	String doc_tool;
	List<String> removal_docs;
	bool doc_base = true;
	String game_path;
	String script;
	String test;
	String _export_preset;
	bool export_debug = false;

	List<String> args = OS::get_singleton()->get_cmdline_args();
	for (int i = 0; i < args.size(); i++) {
		//parameters that do not have an argument to the right
		if (args[i] == ""--no-docbase"") {
			doc_base = false;
#ifdef TOOLS_ENABLED
		} else if (args[i] == ""-e"" || args[i] == ""--editor"") {
			editor = true;
		} else if (args[i] == ""-p"" || args[i] == ""--project-manager"") {
			project_manager = true;
#endif
		} else if (args[i].length() && args[i][0] != '-' && game_path == """") {
			game_path = args[i];
		}
		//parameters that have an argument to the right
		else if (i < (args.size() - 1)) {
			bool parsed_pair = true;
			if (args[i] == ""-s"" || args[i] == ""--script"") {
				script = args[i + 1];
			} else if (args[i] == ""--test"") {
				test = args[i + 1];
#ifdef TOOLS_ENABLED
			} else if (args[i] == ""--doctool"") {
				doc_tool = args[i + 1];
				for (int j = i + 2; j < args.size(); j++)
					removal_docs.push_back(args[j]);
			} else if (args[i] == ""--export"") {
				editor = true; //needs editor
				if (i + 1 < args.size()) {
					_export_preset = args[i + 1];
				} else {
					ERR_PRINT(""Export preset name not specified"");
					return false;
				}
			} else if (args[i] == ""--export-debug"") {
				editor = true; //needs editor
				if (i + 1 < args.size()) {
					_export_preset = args[i + 1];
				} else {
					ERR_PRINT(""Export preset name not specified"");
					return false;
				}
				export_debug = true;
#endif
			} else {
				// The parameter does not match anything known, don't skip the next argument
				parsed_pair = false;
			}
			if (parsed_pair) {
				i++;
			}
		}
	}

	GLOBAL_DEF(""editor/active"", editor);

	String main_loop_type;
#ifdef TOOLS_ENABLED
	if (doc_tool != """") {

		{
			DirAccessRef da = DirAccess::open(doc_tool);
			if (!da) {
				ERR_EXPLAIN(""Argument supplied to --doctool must be a base godot build directory"");
				ERR_FAIL_V(false);
			}
		}
		DocData doc;
		doc.generate(doc_base);

		DocData docsrc;
		Map<String, String> doc_data_classes;
		Set<String> checked_paths;
		print_line(""Loading docs.."");

		for (int i = 0; i < _doc_data_class_path_count; i++) {
			String path = doc_tool.plus_file(_doc_data_class_paths[i].path);
			String name = _doc_data_class_paths[i].name;
			doc_data_classes[name] = path;
			if (!checked_paths.has(path)) {
				checked_paths.insert(path);
				docsrc.load_classes(path);
				print_line(""Loading docs from: "" + path);
			}
		}

		String index_path = doc_tool.plus_file(""doc/classes"");
		docsrc.load_classes(index_path);
		checked_paths.insert(index_path);
		print_line(""Loading docs from: "" + index_path);

		print_line(""Merging docs.."");
		doc.merge_from(docsrc);
		for (Set<String>::Element *E = checked_paths.front(); E; E = E->next()) {
			print_line(""Erasing old docs at: "" + E->get());
			DocData::erase_classes(E->get());
		}

		print_line(""Generating new docs.."");
		doc.save_classes(index_path, doc_data_classes);

		return false;
	}

#endif

	if (_export_preset != """") {
		if (game_path == """") {
			String err = ""Command line param "";
			err += export_debug ? ""--export-debug"" : ""--export"";
			err += "" passed but no destination path given.\\n"";
			err += ""Please specify the binary's file path to export to. Aborting export."";
			ERR_PRINT(err.utf8().get_data());
			return false;
		}
	}

	if (script == """" && game_path == """" && String(GLOBAL_DEF(""application/run/main_scene"", """")) != """") {
		game_path = GLOBAL_DEF(""application/run/main_scene"", """");
	}

	MainLoop *main_loop = NULL;
	if (editor) {
		main_loop = memnew(SceneTree);
	};

	if (test != """") {
#ifdef DEBUG_ENABLED
		main_loop = test_main(test, args);

		if (!main_loop)
			return false;

#endif

	} else if (script != """") {

		Ref<Script> script_res = ResourceLoader::load(script);
		ERR_EXPLAIN(""Can't load script: "" + script);
		ERR_FAIL_COND_V(script_res.is_null(), false);

		if (script_res->can_instance() /*&& script_res->inherits_from(""SceneTreeScripted"")*/) {

			StringName instance_type = script_res->get_instance_base_type();
			Object *obj = ClassDB::instance(instance_type);
			MainLoop *script_loop = Object::cast_to<MainLoop>(obj);
			if (!script_loop) {
				if (obj)
					memdelete(obj);
				ERR_EXPLAIN(""Can't load script '"" + script + ""', it does not inherit from a MainLoop type"");
				ERR_FAIL_COND_V(!script_loop, false);
			}

			script_loop->set_init_script(script_res);
			main_loop = script_loop;
		} else {

			return false;
		}

	} else {
		main_loop_type = GLOBAL_DEF(""application/run/main_loop_type"", """");
	}

	if (!main_loop && main_loop_type == """")
		main_loop_type = ""SceneTree"";

	if (!main_loop) {
		if (!ClassDB::class_exists(main_loop_type)) {
			OS::get_singleton()->alert(""Error: MainLoop type doesn't exist: "" + main_loop_type);
			return false;
		} else {

			Object *ml = ClassDB::instance(main_loop_type);
			if (!ml) {
				ERR_EXPLAIN(""Can't instance MainLoop type"");
				ERR_FAIL_V(false);
			}

			main_loop = Object::cast_to<MainLoop>(ml);
			if (!main_loop) {

				memdelete(ml);
				ERR_EXPLAIN(""Invalid MainLoop type"");
				ERR_FAIL_V(false);
			}
		}
	}

	if (main_loop->is_class(""SceneTree"")) {

		SceneTree *sml = Object::cast_to<SceneTree>(main_loop);

#ifdef DEBUG_ENABLED
		if (debug_collisions) {
			sml->set_debug_collisions_hint(true);
		}
		if (debug_navigation) {
			sml->set_debug_navigation_hint(true);
		}
#endif

#ifdef TOOLS_ENABLED

		EditorNode *editor_node = NULL;
		if (editor) {

			editor_node = memnew(EditorNode);
			sml->get_root()->add_child(editor_node);

			//root_node->set_editor(editor);
			//startup editor

			if (_export_preset != """") {

				editor_node->export_preset(_export_preset, game_path, export_debug, """", true);
				game_path = """"; //no load anything
			}
		}
#endif

		{
		}

		if (!editor) {
			//standard helpers that can be changed from main config

			String stretch_mode = GLOBAL_DEF(""display/window/stretch/mode"", ""disabled"");
			String stretch_aspect = GLOBAL_DEF(""display/window/stretch/aspect"", ""ignore"");
			Size2i stretch_size = Size2(GLOBAL_DEF(""display/window/size/width"", 0), GLOBAL_DEF(""display/window/size/height"", 0));
			real_t stretch_shrink = GLOBAL_DEF(""display/window/stretch/shrink"", 1.0f);

			SceneTree::StretchMode sml_sm = SceneTree::STRETCH_MODE_DISABLED;
			if (stretch_mode == ""2d"")
				sml_sm = SceneTree::STRETCH_MODE_2D;
			else if (stretch_mode == ""viewport"")
				sml_sm = SceneTree::STRETCH_MODE_VIEWPORT;

			SceneTree::StretchAspect sml_aspect = SceneTree::STRETCH_ASPECT_IGNORE;
			if (stretch_aspect == ""keep"")
				sml_aspect = SceneTree::STRETCH_ASPECT_KEEP;
			else if (stretch_aspect == ""keep_width"")
				sml_aspect = SceneTree::STRETCH_ASPECT_KEEP_WIDTH;
			else if (stretch_aspect == ""keep_height"")
				sml_aspect = SceneTree::STRETCH_ASPECT_KEEP_HEIGHT;
			else if (stretch_aspect == ""expand"")
				sml_aspect = SceneTree::STRETCH_ASPECT_EXPAND;

			sml->set_screen_stretch(sml_sm, sml_aspect, stretch_size, stretch_shrink);

			sml->set_auto_accept_quit(GLOBAL_DEF(""application/config/auto_accept_quit"", true));
			sml->set_quit_on_go_back(GLOBAL_DEF(""application/config/quit_on_go_back"", true));
			String appname = ProjectSettings::get_singleton()->get(""application/config/name"");
			appname = TranslationServer::get_singleton()->translate(appname);
			OS::get_singleton()->set_window_title(appname);

			int shadow_atlas_size = GLOBAL_GET(""rendering/quality/shadow_atlas/size"");
			int shadow_atlas_q0_subdiv = GLOBAL_GET(""rendering/quality/shadow_atlas/quadrant_0_subdiv"");
			int shadow_atlas_q1_subdiv = GLOBAL_GET(""rendering/quality/shadow_atlas/quadrant_1_subdiv"");
			int shadow_atlas_q2_subdiv = GLOBAL_GET(""rendering/quality/shadow_atlas/quadrant_2_subdiv"");
			int shadow_atlas_q3_subdiv = GLOBAL_GET(""rendering/quality/shadow_atlas/quadrant_3_subdiv"");

			sml->get_root()->set_shadow_atlas_size(shadow_atlas_size);
			sml->get_root()->set_shadow_atlas_quadrant_subdiv(0, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q0_subdiv));
			sml->get_root()->set_shadow_atlas_quadrant_subdiv(1, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q1_subdiv));
			sml->get_root()->set_shadow_atlas_quadrant_subdiv(2, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q2_subdiv));
			sml->get_root()->set_shadow_atlas_quadrant_subdiv(3, Viewport::ShadowAtlasQuadrantSubdiv(shadow_atlas_q3_subdiv));
			Viewport::Usage usage = Viewport::Usage(int(GLOBAL_GET(""rendering/quality/intended_usage/framebuffer_allocation"")));
			sml->get_root()->set_usage(usage);

			bool snap_controls = GLOBAL_DEF(""gui/common/snap_controls_to_pixels"", true);
			sml->get_root()->set_snap_controls_to_pixels(snap_controls);

			bool font_oversampling = GLOBAL_DEF(""rendering/quality/dynamic_fonts/use_oversampling"", false);
			sml->set_use_font_oversampling(font_oversampling);

		} else {
			GLOBAL_DEF(""display/window/stretch/mode"", ""disabled"");
			ProjectSettings::get_singleton()->set_custom_property_info(""display/window/stretch/mode"", PropertyInfo(Variant::STRING, ""display/window/stretch/mode"", PROPERTY_HINT_ENUM, ""disabled,2d,viewport""));
			GLOBAL_DEF(""display/window/stretch/aspect"", ""ignore"");
			ProjectSettings::get_singleton()->set_custom_property_info(""display/window/stretch/aspect"", PropertyInfo(Variant::STRING, ""display/window/stretch/aspect"", PROPERTY_HINT_ENUM, ""ignore,keep,keep_width,keep_height,expand""));
			GLOBAL_DEF(""display/window/stretch/shrink"", 1);
			ProjectSettings::get_singleton()->set_custom_property_info(""display/window/stretch/shrink"", PropertyInfo(Variant::STRING, ""display/window/stretch/shrink"", PROPERTY_HINT_RANGE, ""1,8,1""));
			sml->set_auto_accept_quit(GLOBAL_DEF(""application/config/auto_accept_quit"", true));
			sml->set_quit_on_go_back(GLOBAL_DEF(""application/config/quit_on_go_back"", true));
			GLOBAL_DEF(""gui/common/snap_controls_to_pixels"", true);
			GLOBAL_DEF(""rendering/quality/dynamic_fonts/use_oversampling"", false);
		}

		String local_game_path;
		if (game_path != """" && !project_manager) {

			local_game_path = game_path.replace(""\\\\"", ""/"");

			if (!local_game_path.begins_with(""res://"")) {
				bool absolute = (local_game_path.size() > 1) && (local_game_path[0] == '/' || local_game_path[1] == ':');

				if (!absolute) {

					if (ProjectSettings::get_singleton()->is_using_datapack()) {

						local_game_path = ""res://"" + local_game_path;

					} else {
						int sep = local_game_path.find_last(""/"");

						if (sep == -1) {
							DirAccess *da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
							local_game_path = da->get_current_dir() + ""/"" + local_game_path;
							memdelete(da);
						} else {

							DirAccess *da = DirAccess::open(local_game_path.substr(0, sep));
							if (da) {
								local_game_path = da->get_current_dir() + ""/"" + local_game_path.substr(sep + 1, local_game_path.length());
								memdelete(da);
							}
						}
					}
				}
			}

			local_game_path = ProjectSettings::get_singleton()->localize_path(local_game_path);

#ifdef TOOLS_ENABLED
			if (editor) {

				Error serr = editor_node->load_scene(local_game_path);
				if (serr != OK)
					ERR_PRINT(""Failed to load scene"");
				OS::get_singleton()->set_context(OS::CONTEXT_EDITOR);
			}
#endif
		}

		if (!project_manager && !editor) {
			if (game_path != """" || script != """") {
				//autoload
				List<PropertyInfo> props;
				ProjectSettings::get_singleton()->get_property_list(&props);

				//first pass, add the constants so they exist before any script is loaded
				for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {

					String s = E->get().name;
					if (!s.begins_with(""autoload/""))
						continue;
					String name = s.get_slicec('/', 1);
					String path = ProjectSettings::get_singleton()->get(s);
					bool global_var = false;
					if (path.begins_with(""*"")) {
						global_var = true;
					}

					if (global_var) {
						for (int i = 0; i < ScriptServer::get_language_count(); i++) {
							ScriptServer::get_language(i)->add_global_constant(name, Variant());
						}
					}
				}

				//second pass, load into global constants
				List<Node *> to_add;
				for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {

					String s = E->get().name;
					if (!s.begins_with(""autoload/""))
						continue;
					String name = s.get_slicec('/', 1);
					String path = ProjectSettings::get_singleton()->get(s);
					bool global_var = false;
					if (path.begins_with(""*"")) {
						global_var = true;
						path = path.substr(1, path.length() - 1);
					}

					RES res = ResourceLoader::load(path);
					ERR_EXPLAIN(""Can't autoload: "" + path);
					ERR_CONTINUE(res.is_null());
					Node *n = NULL;
					if (res->is_class(""PackedScene"")) {
						Ref<PackedScene> ps = res;
						n = ps->instance();
					} else if (res->is_class(""Script"")) {
						Ref<Script> s = res;
						StringName ibt = s->get_instance_base_type();
						bool valid_type = ClassDB::is_parent_class(ibt, ""Node"");
						ERR_EXPLAIN(""Script does not inherit a Node: "" + path);
						ERR_CONTINUE(!valid_type);

						Object *obj = ClassDB::instance(ibt);

						ERR_EXPLAIN(""Cannot instance script for autoload, expected 'Node' inheritance, got: "" + String(ibt));
						ERR_CONTINUE(obj == NULL);

						n = Object::cast_to<Node>(obj);
						n->set_script(s.get_ref_ptr());
					}

					ERR_EXPLAIN(""Path in autoload not a node or script: "" + path);
					ERR_CONTINUE(!n);
					n->set_name(name);

					//defer so references are all valid on _ready()
					to_add.push_back(n);

					if (global_var) {
						for (int i = 0; i < ScriptServer::get_language_count(); i++) {
							ScriptServer::get_language(i)->add_global_constant(name, n);
						}
					}
				}

				for (List<Node *>::Element *E = to_add.front(); E; E = E->next()) {

					sml->get_root()->add_child(E->get());
				}
				//singletons
			}

			if (game_path != """") {
				Node *scene = NULL;
				Ref<PackedScene> scenedata = ResourceLoader::load(local_game_path);
				if (scenedata.is_valid())
					scene = scenedata->instance();

				ERR_EXPLAIN(""Failed loading scene: "" + local_game_path);
				ERR_FAIL_COND_V(!scene, false)
				sml->add_current_scene(scene);

				String iconpath = GLOBAL_DEF(""application/config/icon"", ""Variant()"");
				if (iconpath != """") {
					Ref<Image> icon;
					icon.instance();
					if (icon->load(iconpath) == OK) {
						OS::get_singleton()->set_icon(icon);
						hasicon = true;
					}
				}
			}
		}

#ifdef TOOLS_ENABLED
		if (project_manager || (script == """" && test == """" && game_path == """" && !editor)) {

			ProjectManager *pmanager = memnew(ProjectManager);
			ProgressDialog *progress_dialog = memnew(ProgressDialog);
			pmanager->add_child(progress_dialog);
			sml->get_root()->add_child(pmanager);
			OS::get_singleton()->set_context(OS::CONTEXT_PROJECTMAN);
		}
#endif
	}

	if (!hasicon) {
		Ref<Image> icon = memnew(Image(app_icon_png));
		OS::get_singleton()->set_icon(icon);
	}

	OS::get_singleton()->set_main_loop(main_loop);

	return true;
}

uint64_t Main::last_ticks = 0;
uint64_t Main::target_ticks = 0;
float Main::time_accum = 0;
uint32_t Main::frames = 0;
uint32_t Main::frame = 0;
bool Main::force_redraw_requested = false;

//for performance metrics
static uint64_t physics_process_max = 0;
static uint64_t idle_process_max = 0;

bool Main::iteration() {

	uint64_t ticks = OS::get_singleton()->get_ticks_usec();
	Engine::get_singleton()->_frame_ticks = ticks;

	uint64_t ticks_elapsed = ticks - last_ticks;

	double step = (double)ticks_elapsed / 1000000.0;
	if (fixed_fps != -1)
		step = 1.0 / fixed_fps;

	float frame_slice = 1.0 / Engine::get_singleton()->get_iterations_per_second();

	Engine::get_singleton()->_frame_step = step;

	/*
	if (time_accum+step < frame_slice)
		return false;
	*/

	uint64_t physics_process_ticks = 0;
	uint64_t idle_process_ticks = 0;

	frame += ticks_elapsed;

	last_ticks = ticks;

	if (fixed_fps == -1 && step > frame_slice * 8)
		step = frame_slice * 8;

	time_accum += step;

	float time_scale = Engine::get_singleton()->get_time_scale();

	bool exit = false;

	int iters = 0;

	Engine::get_singleton()->_in_physics = true;

	while (time_accum > frame_slice) {

		uint64_t physics_begin = OS::get_singleton()->get_ticks_usec();

		PhysicsServer::get_singleton()->sync();
		PhysicsServer::get_singleton()->flush_queries();

		Physics2DServer::get_singleton()->sync();
		Physics2DServer::get_singleton()->flush_queries();

		if (OS::get_singleton()->get_main_loop()->iteration(frame_slice * time_scale)) {
			exit = true;
			break;
		}

		message_queue->flush();

		PhysicsServer::get_singleton()->step(frame_slice * time_scale);

		Physics2DServer::get_singleton()->end_sync();
		Physics2DServer::get_singleton()->step(frame_slice * time_scale);

		time_accum -= frame_slice;
		message_queue->flush();

		physics_process_ticks = MAX(physics_process_ticks, OS::get_singleton()->get_ticks_usec() - physics_begin); // keep the largest one for reference
		physics_process_max = MAX(OS::get_singleton()->get_ticks_usec() - physics_begin, physics_process_max);
		iters++;
		Engine::get_singleton()->_physics_frames++;
	}

	Engine::get_singleton()->_in_physics = false;

	uint64_t idle_begin = OS::get_singleton()->get_ticks_usec();

	OS::get_singleton()->get_main_loop()->idle(step * time_scale);
	message_queue->flush();

	VisualServer::get_singleton()->sync(); //sync if still drawing from previous frames.

	if (OS::get_singleton()->can_draw() && !disable_render_loop) {

		if ((!force_redraw_requested) && OS::get_singleton()->is_in_low_processor_usage_mode()) {
			if (VisualServer::get_singleton()->has_changed()) {
				VisualServer::get_singleton()->draw(); // flush visual commands
				Engine::get_singleton()->frames_drawn++;
			}
		} else {
			VisualServer::get_singleton()->draw(); // flush visual commands
			Engine::get_singleton()->frames_drawn++;
			force_redraw_requested = false;
		}
	}

	if (AudioServer::get_singleton())
		AudioServer::get_singleton()->update();

	idle_process_ticks = OS::get_singleton()->get_ticks_usec() - idle_begin;
	idle_process_max = MAX(idle_process_ticks, idle_process_max);
	uint64_t frame_time = OS::get_singleton()->get_ticks_usec() - ticks;

	for (int i = 0; i < ScriptServer::get_language_count(); i++) {
		ScriptServer::get_language(i)->frame();
	}

	if (script_debugger) {
		if (script_debugger->is_profiling()) {
			script_debugger->profiling_set_frame_times(USEC_TO_SEC(frame_time), USEC_TO_SEC(idle_process_ticks), USEC_TO_SEC(physics_process_ticks), frame_slice);
		}
		script_debugger->idle_poll();
	}

	frames++;
	Engine::get_singleton()->_idle_frames++;

	if (frame > 1000000) {

		if (GLOBAL_DEF(""debug/settings/stdout/print_fps"", OS::get_singleton()->is_stdout_verbose()) && !editor) {
			print_line(""FPS: "" + itos(frames));
		};

		Engine::get_singleton()->_fps = frames;
		performance->set_process_time(USEC_TO_SEC(idle_process_max));
		performance->set_physics_process_time(USEC_TO_SEC(physics_process_max));
		idle_process_max = 0;
		physics_process_max = 0;

		frame %= 1000000;
		frames = 0;
	}

	if (fixed_fps != -1)
		return exit;

	if (OS::get_singleton()->is_in_low_processor_usage_mode() || !OS::get_singleton()->can_draw())
		OS::get_singleton()->delay_usec(OS::get_singleton()->get_low_processor_usage_mode_sleep_usec()); //apply some delay to force idle time (results in about 60 FPS max)
	else {
		uint32_t frame_delay = Engine::get_singleton()->get_frame_delay();
		if (frame_delay)
			OS::get_singleton()->delay_usec(Engine::get_singleton()->get_frame_delay() * 1000);
	}

	int target_fps = Engine::get_singleton()->get_target_fps();
	if (target_fps > 0) {
		uint64_t time_step = 1000000L / target_fps;
		target_ticks += time_step;
		uint64_t current_ticks = OS::get_singleton()->get_ticks_usec();
		if (current_ticks < target_ticks) OS::get_singleton()->delay_usec(target_ticks - current_ticks);
		current_ticks = OS::get_singleton()->get_ticks_usec();
		target_ticks = MIN(MAX(target_ticks, current_ticks - time_step), current_ticks + time_step);
	}

	return exit;
}

void Main::force_redraw() {

	force_redraw_requested = true;
};

void Main::cleanup() {

	ERR_FAIL_COND(!_start_success);

	message_queue->flush();
	memdelete(message_queue);

	if (script_debugger) {
		if (use_debug_profiler) {
			script_debugger->profiling_end();
		}

		memdelete(script_debugger);
	}

	OS::get_singleton()->delete_main_loop();

	OS::get_singleton()->_cmdline.clear();
	OS::get_singleton()->_execpath = """";
	OS::get_singleton()->_local_clipboard = """";

	ResourceLoader::clear_translation_remaps();
	ResourceLoader::clear_path_remaps();

	ScriptServer::finish_languages();

#ifdef TOOLS_ENABLED
	EditorNode::unregister_editor_types();
#endif

	if (arvr_server) {
		// cleanup now before we pull the rug from underneath...
		memdelete(arvr_server);
	}

	unregister_driver_types();
	unregister_module_types();
	unregister_platform_apis();
	unregister_scene_types();
	unregister_server_types();

	if (audio_server) {
		audio_server->finish();
		memdelete(audio_server);
	}

	OS::get_singleton()->finalize();
	finalize_physics();

	if (packed_data)
		memdelete(packed_data);
	if (file_access_network_client)
		memdelete(file_access_network_client);
	if (performance)
		memdelete(performance);
	if (input_map)
		memdelete(input_map);
	if (translation_server)
		memdelete(translation_server);
	if (globals)
		memdelete(globals);
	if (engine)
		memdelete(engine);

	unregister_core_driver_types();
	unregister_core_types();

	OS::get_singleton()->clear_last_error();
	OS::get_singleton()->finalize_core();
}
",16355,True,2976.8271207482485,median
"/*
 * Licensed under the Apache License, Version 2.0 (the ""License"");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an ""AS IS"" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * This file is an adaptation of Presto's presto-parser/src/main/antlr4/com/facebook/presto/sql/parser/SqlBase.g4 grammar.
 */

grammar SqlBase;

@members {
  /**
   * Verify whether current token is a valid decimal token (which contains dot).
   * Returns true if the character that follows the token is not a digit or letter or underscore.
   *
   * For example:
   * For char stream ""2.3"", ""2."" is not a valid decimal token, because it is followed by digit '3'.
   * For char stream ""2.3_"", ""2.3"" is not a valid decimal token, because it is followed by '_'.
   * For char stream ""2.3W"", ""2.3"" is not a valid decimal token, because it is followed by 'W'.
   * For char stream ""12.0D 34.E2+0.12 ""  12.0D is a valid decimal token because it is followed
   * by a space. 34.E2 is a valid decimal token because it is followed by symbol '+'
   * which is not a digit or letter or underscore.
   */
  public boolean isValidDecimal() {
    int nextChar = _input.LA(1);
    if (nextChar >= 'A' && nextChar <= 'Z' || nextChar >= '0' && nextChar <= '9' ||
      nextChar == '_') {
      return false;
    } else {
      return true;
    }
  }
}

singleStatement
    : statement EOF
    ;

singleExpression
    : namedExpression EOF
    ;

singleTableIdentifier
    : tableIdentifier EOF
    ;

singleFunctionIdentifier
    : functionIdentifier EOF
    ;

singleDataType
    : dataType EOF
    ;

singleTableSchema
    : colTypeList EOF
    ;

statement
    : query                                                            #statementDefault
    | USE db=identifier                                                #use
    | CREATE DATABASE (IF NOT EXISTS)? identifier
        (COMMENT comment=STRING)? locationSpec?
        (WITH DBPROPERTIES tablePropertyList)?                         #createDatabase
    | ALTER DATABASE identifier SET DBPROPERTIES tablePropertyList     #setDatabaseProperties
    | DROP DATABASE (IF EXISTS)? identifier (RESTRICT | CASCADE)?      #dropDatabase
    | createTableHeader ('(' colTypeList ')')? tableProvider
        ((OPTIONS options=tablePropertyList) |
        (PARTITIONED BY partitionColumnNames=identifierList) |
        bucketSpec |
        locationSpec |
        (COMMENT comment=STRING) |
        (TBLPROPERTIES tableProps=tablePropertyList))*
        (AS? query)?                                                   #createTable
    | createTableHeader ('(' columns=colTypeList ')')?
        ((COMMENT comment=STRING) |
        (PARTITIONED BY '(' partitionColumns=colTypeList ')') |
        bucketSpec |
        skewSpec |
        rowFormat |
        createFileFormat |
        locationSpec |
        (TBLPROPERTIES tableProps=tablePropertyList))*
        (AS? query)?                                                   #createHiveTable
    | CREATE TABLE (IF NOT EXISTS)? target=tableIdentifier
        LIKE source=tableIdentifier locationSpec?                      #createTableLike
    | ANALYZE TABLE tableIdentifier partitionSpec? COMPUTE STATISTICS
        (identifier | FOR COLUMNS identifierSeq)?                      #analyze
    | ALTER TABLE tableIdentifier
        ADD COLUMNS '(' columns=colTypeList ')'                        #addTableColumns
    | ALTER (TABLE | VIEW) from=tableIdentifier
        RENAME TO to=tableIdentifier                                   #renameTable
    | ALTER (TABLE | VIEW) tableIdentifier
        SET TBLPROPERTIES tablePropertyList                            #setTableProperties
    | ALTER (TABLE | VIEW) tableIdentifier
        UNSET TBLPROPERTIES (IF EXISTS)? tablePropertyList             #unsetTableProperties
    | ALTER TABLE tableIdentifier partitionSpec?
        CHANGE COLUMN? identifier colType colPosition?                 #changeColumn
    | ALTER TABLE tableIdentifier (partitionSpec)?
        SET SERDE STRING (WITH SERDEPROPERTIES tablePropertyList)?     #setTableSerDe
    | ALTER TABLE tableIdentifier (partitionSpec)?
        SET SERDEPROPERTIES tablePropertyList                          #setTableSerDe
    | ALTER TABLE tableIdentifier ADD (IF NOT EXISTS)?
        partitionSpecLocation+                                         #addTablePartition
    | ALTER VIEW tableIdentifier ADD (IF NOT EXISTS)?
        partitionSpec+                                                 #addTablePartition
    | ALTER TABLE tableIdentifier
        from=partitionSpec RENAME TO to=partitionSpec                  #renameTablePartition
    | ALTER TABLE tableIdentifier
        DROP (IF EXISTS)? partitionSpec (',' partitionSpec)* PURGE?    #dropTablePartitions
    | ALTER VIEW tableIdentifier
        DROP (IF EXISTS)? partitionSpec (',' partitionSpec)*           #dropTablePartitions
    | ALTER TABLE tableIdentifier partitionSpec? SET locationSpec      #setTableLocation
    | ALTER TABLE tableIdentifier RECOVER PARTITIONS                   #recoverPartitions
    | DROP TABLE (IF EXISTS)? tableIdentifier PURGE?                   #dropTable
    | DROP VIEW (IF EXISTS)? tableIdentifier                           #dropTable
    | CREATE (OR REPLACE)? (GLOBAL? TEMPORARY)?
        VIEW (IF NOT EXISTS)? tableIdentifier
        identifierCommentList? (COMMENT STRING)?
        (PARTITIONED ON identifierList)?
        (TBLPROPERTIES tablePropertyList)? AS query                    #createView
    | CREATE (OR REPLACE)? GLOBAL? TEMPORARY VIEW
        tableIdentifier ('(' colTypeList ')')? tableProvider
        (OPTIONS tablePropertyList)?                                   #createTempViewUsing
    | ALTER VIEW tableIdentifier AS? query                             #alterViewQuery
    | CREATE (OR REPLACE)? TEMPORARY? FUNCTION (IF NOT EXISTS)?
        qualifiedName AS className=STRING
        (USING resource (',' resource)*)?                              #createFunction
    | DROP TEMPORARY? FUNCTION (IF EXISTS)? qualifiedName              #dropFunction
    | EXPLAIN (LOGICAL | FORMATTED | EXTENDED | CODEGEN | COST)?
        statement                                                      #explain
    | SHOW TABLES ((FROM | IN) db=identifier)?
        (LIKE? pattern=STRING)?                                        #showTables
    | SHOW TABLE EXTENDED ((FROM | IN) db=identifier)?
        LIKE pattern=STRING partitionSpec?                             #showTable
    | SHOW DATABASES (LIKE? pattern=STRING)?                           #showDatabases
    | SHOW TBLPROPERTIES table=tableIdentifier
        ('(' key=tablePropertyKey ')')?                                #showTblProperties
    | SHOW COLUMNS (FROM | IN) tableIdentifier
        ((FROM | IN) db=identifier)?                                   #showColumns
    | SHOW PARTITIONS tableIdentifier partitionSpec?                   #showPartitions
    | SHOW identifier? FUNCTIONS
        (LIKE? (qualifiedName | pattern=STRING))?                      #showFunctions
    | SHOW CREATE TABLE tableIdentifier                                #showCreateTable
    | (DESC | DESCRIBE) FUNCTION EXTENDED? describeFuncName            #describeFunction
    | (DESC | DESCRIBE) DATABASE EXTENDED? identifier                  #describeDatabase
    | (DESC | DESCRIBE) TABLE? option=(EXTENDED | FORMATTED)?
        tableIdentifier partitionSpec? describeColName?                #describeTable
    | REFRESH TABLE tableIdentifier                                    #refreshTable
    | REFRESH (STRING | .*?)                                           #refreshResource
    | CACHE LAZY? TABLE tableIdentifier (AS? query)?                   #cacheTable
    | UNCACHE TABLE (IF EXISTS)? tableIdentifier                       #uncacheTable
    | CLEAR CACHE                                                      #clearCache
    | LOAD DATA LOCAL? INPATH path=STRING OVERWRITE? INTO TABLE
        tableIdentifier partitionSpec?                                 #loadData
    | TRUNCATE TABLE tableIdentifier partitionSpec?                    #truncateTable
    | MSCK REPAIR TABLE tableIdentifier                                #repairTable
    | op=(ADD | LIST) identifier .*?                                   #manageResource
    | SET ROLE .*?                                                     #failNativeCommand
    | SET .*?                                                          #setConfiguration
    | RESET                                                            #resetConfiguration
    | unsupportedHiveNativeCommands .*?                                #failNativeCommand
    ;

unsupportedHiveNativeCommands
    : kw1=CREATE kw2=ROLE
    | kw1=DROP kw2=ROLE
    | kw1=GRANT kw2=ROLE?
    | kw1=REVOKE kw2=ROLE?
    | kw1=SHOW kw2=GRANT
    | kw1=SHOW kw2=ROLE kw3=GRANT?
    | kw1=SHOW kw2=PRINCIPALS
    | kw1=SHOW kw2=ROLES
    | kw1=SHOW kw2=CURRENT kw3=ROLES
    | kw1=EXPORT kw2=TABLE
    | kw1=IMPORT kw2=TABLE
    | kw1=SHOW kw2=COMPACTIONS
    | kw1=SHOW kw2=CREATE kw3=TABLE
    | kw1=SHOW kw2=TRANSACTIONS
    | kw1=SHOW kw2=INDEXES
    | kw1=SHOW kw2=LOCKS
    | kw1=CREATE kw2=INDEX
    | kw1=DROP kw2=INDEX
    | kw1=ALTER kw2=INDEX
    | kw1=LOCK kw2=TABLE
    | kw1=LOCK kw2=DATABASE
    | kw1=UNLOCK kw2=TABLE
    | kw1=UNLOCK kw2=DATABASE
    | kw1=CREATE kw2=TEMPORARY kw3=MACRO
    | kw1=DROP kw2=TEMPORARY kw3=MACRO
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=NOT kw4=CLUSTERED
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=CLUSTERED kw4=BY
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=NOT kw4=SORTED
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=SKEWED kw4=BY
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=NOT kw4=SKEWED
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=NOT kw4=STORED kw5=AS kw6=DIRECTORIES
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=SET kw4=SKEWED kw5=LOCATION
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=EXCHANGE kw4=PARTITION
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=ARCHIVE kw4=PARTITION
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=UNARCHIVE kw4=PARTITION
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=TOUCH
    | kw1=ALTER kw2=TABLE tableIdentifier partitionSpec? kw3=COMPACT
    | kw1=ALTER kw2=TABLE tableIdentifier partitionSpec? kw3=CONCATENATE
    | kw1=ALTER kw2=TABLE tableIdentifier partitionSpec? kw3=SET kw4=FILEFORMAT
    | kw1=ALTER kw2=TABLE tableIdentifier partitionSpec? kw3=REPLACE kw4=COLUMNS
    | kw1=START kw2=TRANSACTION
    | kw1=COMMIT
    | kw1=ROLLBACK
    | kw1=DFS
    | kw1=DELETE kw2=FROM
    ;

createTableHeader
    : CREATE TEMPORARY? EXTERNAL? TABLE (IF NOT EXISTS)? tableIdentifier
    ;

bucketSpec
    : CLUSTERED BY identifierList
      (SORTED BY orderedIdentifierList)?
      INTO INTEGER_VALUE BUCKETS
    ;

skewSpec
    : SKEWED BY identifierList
      ON (constantList | nestedConstantList)
      (STORED AS DIRECTORIES)?
    ;

locationSpec
    : LOCATION STRING
    ;

query
    : ctes? queryNoWith
    ;

insertInto
    : INSERT OVERWRITE TABLE tableIdentifier (partitionSpec (IF NOT EXISTS)?)?                              #insertOverwriteTable
    | INSERT INTO TABLE? tableIdentifier partitionSpec?                                                     #insertIntoTable
    | INSERT OVERWRITE LOCAL? DIRECTORY path=STRING rowFormat? createFileFormat?                            #insertOverwriteHiveDir
    | INSERT OVERWRITE LOCAL? DIRECTORY (path=STRING)? tableProvider (OPTIONS options=tablePropertyList)?   #insertOverwriteDir
    ;

partitionSpecLocation
    : partitionSpec locationSpec?
    ;

partitionSpec
    : PARTITION '(' partitionVal (',' partitionVal)* ')'
    ;

partitionVal
    : identifier (EQ constant)?
    ;

describeFuncName
    : qualifiedName
    | STRING
    | comparisonOperator
    | arithmeticOperator
    | predicateOperator
    ;

describeColName
    : nameParts+=identifier ('.' nameParts+=identifier)*
    ;

ctes
    : WITH namedQuery (',' namedQuery)*
    ;

namedQuery
    : name=identifier AS? '(' query ')'
    ;

tableProvider
    : USING qualifiedName
    ;

tablePropertyList
    : '(' tableProperty (',' tableProperty)* ')'
    ;

tableProperty
    : key=tablePropertyKey (EQ? value=tablePropertyValue)?
    ;

tablePropertyKey
    : identifier ('.' identifier)*
    | STRING
    ;

tablePropertyValue
    : INTEGER_VALUE
    | DECIMAL_VALUE
    | booleanValue
    | STRING
    ;

constantList
    : '(' constant (',' constant)* ')'
    ;

nestedConstantList
    : '(' constantList (',' constantList)* ')'
    ;

createFileFormat
    : STORED AS fileFormat
    | STORED BY storageHandler
    ;

fileFormat
    : INPUTFORMAT inFmt=STRING OUTPUTFORMAT outFmt=STRING    #tableFileFormat
    | identifier                                             #genericFileFormat
    ;

storageHandler
    : STRING (WITH SERDEPROPERTIES tablePropertyList)?
    ;

resource
    : identifier STRING
    ;

queryNoWith
    : insertInto? queryTerm queryOrganization                                              #singleInsertQuery
    | fromClause multiInsertQueryBody+                                                     #multiInsertQuery
    ;

queryOrganization
    : (ORDER BY order+=sortItem (',' order+=sortItem)*)?
      (CLUSTER BY clusterBy+=expression (',' clusterBy+=expression)*)?
      (DISTRIBUTE BY distributeBy+=expression (',' distributeBy+=expression)*)?
      (SORT BY sort+=sortItem (',' sort+=sortItem)*)?
      windows?
      (LIMIT (ALL | limit=expression))?
    ;

multiInsertQueryBody
    : insertInto?
      querySpecification
      queryOrganization
    ;

queryTerm
    : queryPrimary                                                                         #queryTermDefault
    | left=queryTerm operator=(INTERSECT | UNION | EXCEPT | SETMINUS) setQuantifier? right=queryTerm  #setOperation
    ;

queryPrimary
    : querySpecification                                                    #queryPrimaryDefault
    | TABLE tableIdentifier                                                 #table
    | inlineTable                                                           #inlineTableDefault1
    | '(' queryNoWith  ')'                                                  #subquery
    ;

sortItem
    : expression ordering=(ASC | DESC)? (NULLS nullOrder=(LAST | FIRST))?
    ;

querySpecification
    : (((SELECT kind=TRANSFORM '(' namedExpressionSeq ')'
        | kind=MAP namedExpressionSeq
        | kind=REDUCE namedExpressionSeq))
       inRowFormat=rowFormat?
       (RECORDWRITER recordWriter=STRING)?
       USING script=STRING
       (AS (identifierSeq | colTypeList | ('(' (identifierSeq | colTypeList) ')')))?
       outRowFormat=rowFormat?
       (RECORDREADER recordReader=STRING)?
       fromClause?
       (WHERE where=booleanExpression)?)
    | ((kind=SELECT (hints+=hint)* setQuantifier? namedExpressionSeq fromClause?
       | fromClause (kind=SELECT setQuantifier? namedExpressionSeq)?)
       lateralView*
       (WHERE where=booleanExpression)?
       aggregation?
       (HAVING having=booleanExpression)?
       windows?)
    ;

hint
    : '/*+' hintStatements+=hintStatement (','? hintStatements+=hintStatement)* '*/'
    ;

hintStatement
    : hintName=identifier
    | hintName=identifier '(' parameters+=primaryExpression (',' parameters+=primaryExpression)* ')'
    ;

fromClause
    : FROM relation (',' relation)* (pivotClause | lateralView*)?
    ;

aggregation
    : GROUP BY groupingExpressions+=expression (',' groupingExpressions+=expression)* (
      WITH kind=ROLLUP
    | WITH kind=CUBE
    | kind=GROUPING SETS '(' groupingSet (',' groupingSet)* ')')?
    ;

groupingSet
    : '(' (expression (',' expression)*)? ')'
    | expression
    ;

pivotClause
    : PIVOT '(' aggregates=namedExpressionSeq FOR pivotColumn=identifier IN '(' pivotValues+=constant (',' pivotValues+=constant)* ')' ')'
    ;

lateralView
    : LATERAL VIEW (OUTER)? qualifiedName '(' (expression (',' expression)*)? ')' tblName=identifier (AS? colName+=identifier (',' colName+=identifier)*)?
    ;

setQuantifier
    : DISTINCT
    | ALL
    ;

relation
    : relationPrimary joinRelation*
    ;

joinRelation
    : (joinType) JOIN right=relationPrimary joinCriteria?
    | NATURAL joinType JOIN right=relationPrimary
    ;

joinType
    : INNER?
    | CROSS
    | LEFT OUTER?
    | LEFT SEMI
    | RIGHT OUTER?
    | FULL OUTER?
    | LEFT? ANTI
    ;

joinCriteria
    : ON booleanExpression
    | USING '(' identifier (',' identifier)* ')'
    ;

sample
    : TABLESAMPLE '(' sampleMethod? ')'
    ;

sampleMethod
    : negativeSign=MINUS? percentage=(INTEGER_VALUE | DECIMAL_VALUE) PERCENTLIT   #sampleByPercentile
    | expression ROWS                                                             #sampleByRows
    | sampleType=BUCKET numerator=INTEGER_VALUE OUT OF denominator=INTEGER_VALUE
        (ON (identifier | qualifiedName '(' ')'))?                                #sampleByBucket
    | bytes=expression                                                            #sampleByBytes
    ;

identifierList
    : '(' identifierSeq ')'
    ;

identifierSeq
    : identifier (',' identifier)*
    ;

orderedIdentifierList
    : '(' orderedIdentifier (',' orderedIdentifier)* ')'
    ;

orderedIdentifier
    : identifier ordering=(ASC | DESC)?
    ;

identifierCommentList
    : '(' identifierComment (',' identifierComment)* ')'
    ;

identifierComment
    : identifier (COMMENT STRING)?
    ;

relationPrimary
    : tableIdentifier sample? tableAlias      #tableName
    | '(' queryNoWith ')' sample? tableAlias  #aliasedQuery
    | '(' relation ')' sample? tableAlias     #aliasedRelation
    | inlineTable                             #inlineTableDefault2
    | functionTable                           #tableValuedFunction
    ;

inlineTable
    : VALUES expression (',' expression)* tableAlias
    ;

functionTable
    : identifier '(' (expression (',' expression)*)? ')' tableAlias
    ;

tableAlias
    : (AS? strictIdentifier identifierList?)?
    ;

rowFormat
    : ROW FORMAT SERDE name=STRING (WITH SERDEPROPERTIES props=tablePropertyList)?  #rowFormatSerde
    | ROW FORMAT DELIMITED
      (FIELDS TERMINATED BY fieldsTerminatedBy=STRING (ESCAPED BY escapedBy=STRING)?)?
      (COLLECTION ITEMS TERMINATED BY collectionItemsTerminatedBy=STRING)?
      (MAP KEYS TERMINATED BY keysTerminatedBy=STRING)?
      (LINES TERMINATED BY linesSeparatedBy=STRING)?
      (NULL DEFINED AS nullDefinedAs=STRING)?                                       #rowFormatDelimited
    ;

tableIdentifier
    : (db=identifier '.')? table=identifier
    ;

functionIdentifier
    : (db=identifier '.')? function=identifier
    ;

namedExpression
    : expression (AS? (identifier | identifierList))?
    ;

namedExpressionSeq
    : namedExpression (',' namedExpression)*
    ;

expression
    : booleanExpression
    ;

booleanExpression
    : NOT booleanExpression                                        #logicalNot
    | EXISTS '(' query ')'                                         #exists
    | predicated                                                   #booleanDefault
    | left=booleanExpression operator=AND right=booleanExpression  #logicalBinary
    | left=booleanExpression operator=OR right=booleanExpression   #logicalBinary
    ;

// workaround for:
//  https://github.com/antlr/antlr4/issues/780
//  https://github.com/antlr/antlr4/issues/781
predicated
    : valueExpression predicate?
    ;

predicate
    : NOT? kind=BETWEEN lower=valueExpression AND upper=valueExpression
    | NOT? kind=IN '(' expression (',' expression)* ')'
    | NOT? kind=IN '(' query ')'
    | NOT? kind=(RLIKE | LIKE) pattern=valueExpression
    | IS NOT? kind=NULL
    | IS NOT? kind=DISTINCT FROM right=valueExpression
    ;

valueExpression
    : primaryExpression                                                                      #valueExpressionDefault
    | operator=(MINUS | PLUS | TILDE) valueExpression                                        #arithmeticUnary
    | left=valueExpression operator=(ASTERISK | SLASH | PERCENT | DIV) right=valueExpression #arithmeticBinary
    | left=valueExpression operator=(PLUS | MINUS | CONCAT_PIPE) right=valueExpression       #arithmeticBinary
    | left=valueExpression operator=AMPERSAND right=valueExpression                          #arithmeticBinary
    | left=valueExpression operator=HAT right=valueExpression                                #arithmeticBinary
    | left=valueExpression operator=PIPE right=valueExpression                               #arithmeticBinary
    | left=valueExpression comparisonOperator right=valueExpression                          #comparison
    ;

primaryExpression
    : CASE whenClause+ (ELSE elseExpression=expression)? END                                   #searchedCase
    | CASE value=expression whenClause+ (ELSE elseExpression=expression)? END                  #simpleCase
    | CAST '(' expression AS dataType ')'                                                      #cast
    | STRUCT '(' (argument+=namedExpression (',' argument+=namedExpression)*)? ')'             #struct
    | FIRST '(' expression (IGNORE NULLS)? ')'                                                 #first
    | LAST '(' expression (IGNORE NULLS)? ')'                                                  #last
    | POSITION '(' substr=valueExpression IN str=valueExpression ')'                           #position
    | constant                                                                                 #constantDefault
    | ASTERISK                                                                                 #star
    | qualifiedName '.' ASTERISK                                                               #star
    | '(' namedExpression (',' namedExpression)+ ')'                                           #rowConstructor
    | '(' query ')'                                                                            #subqueryExpression
    | qualifiedName '(' (setQuantifier? argument+=expression (',' argument+=expression)*)? ')'
       (OVER windowSpec)?                                                                      #functionCall
    | qualifiedName '(' trimOption=(BOTH | LEADING | TRAILING) argument+=expression
      FROM argument+=expression ')'                                                            #functionCall
    | value=primaryExpression '[' index=valueExpression ']'                                    #subscript
    | identifier                                                                               #columnReference
    | base=primaryExpression '.' fieldName=identifier                                          #dereference
    | '(' expression ')'                                                                       #parenthesizedExpression
    ;

constant
    : NULL                                                                                     #nullLiteral
    | interval                                                                                 #intervalLiteral
    | identifier STRING                                                                        #typeConstructor
    | number                                                                                   #numericLiteral
    | booleanValue                                                                             #booleanLiteral
    | STRING+                                                                                  #stringLiteral
    ;

comparisonOperator
    : EQ | NEQ | NEQJ | LT | LTE | GT | GTE | NSEQ
    ;

arithmeticOperator
    : PLUS | MINUS | ASTERISK | SLASH | PERCENT | DIV | TILDE | AMPERSAND | PIPE | CONCAT_PIPE | HAT
    ;

predicateOperator
    : OR | AND | IN | NOT
    ;

booleanValue
    : TRUE | FALSE
    ;

interval
    : INTERVAL intervalField*
    ;

intervalField
    : value=intervalValue unit=identifier (TO to=identifier)?
    ;

intervalValue
    : (PLUS | MINUS)? (INTEGER_VALUE | DECIMAL_VALUE)
    | STRING
    ;

colPosition
    : FIRST | AFTER identifier
    ;

dataType
    : complex=ARRAY '<' dataType '>'                            #complexDataType
    | complex=MAP '<' dataType ',' dataType '>'                 #complexDataType
    | complex=STRUCT ('<' complexColTypeList? '>' | NEQ)        #complexDataType
    | identifier ('(' INTEGER_VALUE (',' INTEGER_VALUE)* ')')?  #primitiveDataType
    ;

colTypeList
    : colType (',' colType)*
    ;

colType
    : identifier dataType (COMMENT STRING)?
    ;

complexColTypeList
    : complexColType (',' complexColType)*
    ;

complexColType
    : identifier ':' dataType (COMMENT STRING)?
    ;

whenClause
    : WHEN condition=expression THEN result=expression
    ;

windows
    : WINDOW namedWindow (',' namedWindow)*
    ;

namedWindow
    : identifier AS windowSpec
    ;

windowSpec
    : name=identifier  #windowRef
    | '('
      ( CLUSTER BY partition+=expression (',' partition+=expression)*
      | ((PARTITION | DISTRIBUTE) BY partition+=expression (',' partition+=expression)*)?
        ((ORDER | SORT) BY sortItem (',' sortItem)*)?)
      windowFrame?
      ')'              #windowDef
    ;

windowFrame
    : frameType=RANGE start=frameBound
    | frameType=ROWS start=frameBound
    | frameType=RANGE BETWEEN start=frameBound AND end=frameBound
    | frameType=ROWS BETWEEN start=frameBound AND end=frameBound
    ;

frameBound
    : UNBOUNDED boundType=(PRECEDING | FOLLOWING)
    | boundType=CURRENT ROW
    | expression boundType=(PRECEDING | FOLLOWING)
    ;

qualifiedName
    : identifier ('.' identifier)*
    ;

identifier
    : strictIdentifier
    | ANTI | FULL | INNER | LEFT | SEMI | RIGHT | NATURAL | JOIN | CROSS | ON
    | UNION | INTERSECT | EXCEPT | SETMINUS
    ;

strictIdentifier
    : IDENTIFIER             #unquotedIdentifier
    | quotedIdentifier       #quotedIdentifierAlternative
    | nonReserved            #unquotedIdentifier
    ;

quotedIdentifier
    : BACKQUOTED_IDENTIFIER
    ;

number
    : MINUS? DECIMAL_VALUE            #decimalLiteral
    | MINUS? INTEGER_VALUE            #integerLiteral
    | MINUS? BIGINT_LITERAL           #bigIntLiteral
    | MINUS? SMALLINT_LITERAL         #smallIntLiteral
    | MINUS? TINYINT_LITERAL          #tinyIntLiteral
    | MINUS? DOUBLE_LITERAL           #doubleLiteral
    | MINUS? BIGDECIMAL_LITERAL       #bigDecimalLiteral
    ;

nonReserved
    : SHOW | TABLES | COLUMNS | COLUMN | PARTITIONS | FUNCTIONS | DATABASES
    | ADD
    | OVER | PARTITION | RANGE | ROWS | PRECEDING | FOLLOWING | CURRENT | ROW | LAST | FIRST | AFTER
    | MAP | ARRAY | STRUCT
    | PIVOT | LATERAL | WINDOW | REDUCE | TRANSFORM | SERDE | SERDEPROPERTIES | RECORDREADER
    | DELIMITED | FIELDS | TERMINATED | COLLECTION | ITEMS | KEYS | ESCAPED | LINES | SEPARATED
    | EXTENDED | REFRESH | CLEAR | CACHE | UNCACHE | LAZY | GLOBAL | TEMPORARY | OPTIONS
    | GROUPING | CUBE | ROLLUP
    | EXPLAIN | FORMAT | LOGICAL | FORMATTED | CODEGEN | COST
    | TABLESAMPLE | USE | TO | BUCKET | PERCENTLIT | OUT | OF
    | SET | RESET
    | VIEW | REPLACE
    | IF
    | POSITION
    | NO | DATA
    | START | TRANSACTION | COMMIT | ROLLBACK | IGNORE
    | SORT | CLUSTER | DISTRIBUTE | UNSET | TBLPROPERTIES | SKEWED | STORED | DIRECTORIES | LOCATION
    | EXCHANGE | ARCHIVE | UNARCHIVE | FILEFORMAT | TOUCH | COMPACT | CONCATENATE | CHANGE
    | CASCADE | RESTRICT | BUCKETS | CLUSTERED | SORTED | PURGE | INPUTFORMAT | OUTPUTFORMAT
    | DBPROPERTIES | DFS | TRUNCATE | COMPUTE | LIST
    | STATISTICS | ANALYZE | PARTITIONED | EXTERNAL | DEFINED | RECORDWRITER
    | REVOKE | GRANT | LOCK | UNLOCK | MSCK | REPAIR | RECOVER | EXPORT | IMPORT | LOAD | VALUES | COMMENT | ROLE
    | ROLES | COMPACTIONS | PRINCIPALS | TRANSACTIONS | INDEX | INDEXES | LOCKS | OPTION | LOCAL | INPATH
    | ASC | DESC | LIMIT | RENAME | SETS
    | AT | NULLS | OVERWRITE | ALL | ANY | ALTER | AS | BETWEEN | BY | CREATE | DELETE
    | DESCRIBE | DROP | EXISTS | FALSE | FOR | GROUP | IN | INSERT | INTO | IS |LIKE
    | NULL | ORDER | OUTER | TABLE | TRUE | WITH | RLIKE
    | AND | CASE | CAST | DISTINCT | DIV | ELSE | END | FUNCTION | INTERVAL | MACRO | OR | STRATIFY | THEN
    | UNBOUNDED | WHEN
    | DATABASE | SELECT | FROM | WHERE | HAVING | TO | TABLE | WITH | NOT
    | DIRECTORY
    | BOTH | LEADING | TRAILING
    ;

SELECT: 'SELECT';
FROM: 'FROM';
ADD: 'ADD';
AS: 'AS';
ALL: 'ALL';
ANY: 'ANY';
DISTINCT: 'DISTINCT';
WHERE: 'WHERE';
GROUP: 'GROUP';
BY: 'BY';
GROUPING: 'GROUPING';
SETS: 'SETS';
CUBE: 'CUBE';
ROLLUP: 'ROLLUP';
ORDER: 'ORDER';
HAVING: 'HAVING';
LIMIT: 'LIMIT';
AT: 'AT';
OR: 'OR';
AND: 'AND';
IN: 'IN';
NOT: 'NOT' | '!';
NO: 'NO';
EXISTS: 'EXISTS';
BETWEEN: 'BETWEEN';
LIKE: 'LIKE';
RLIKE: 'RLIKE' | 'REGEXP';
IS: 'IS';
NULL: 'NULL';
TRUE: 'TRUE';
FALSE: 'FALSE';
NULLS: 'NULLS';
ASC: 'ASC';
DESC: 'DESC';
FOR: 'FOR';
INTERVAL: 'INTERVAL';
CASE: 'CASE';
WHEN: 'WHEN';
THEN: 'THEN';
ELSE: 'ELSE';
END: 'END';
JOIN: 'JOIN';
CROSS: 'CROSS';
OUTER: 'OUTER';
INNER: 'INNER';
LEFT: 'LEFT';
SEMI: 'SEMI';
RIGHT: 'RIGHT';
FULL: 'FULL';
NATURAL: 'NATURAL';
ON: 'ON';
PIVOT: 'PIVOT';
LATERAL: 'LATERAL';
WINDOW: 'WINDOW';
OVER: 'OVER';
PARTITION: 'PARTITION';
RANGE: 'RANGE';
ROWS: 'ROWS';
UNBOUNDED: 'UNBOUNDED';
PRECEDING: 'PRECEDING';
FOLLOWING: 'FOLLOWING';
CURRENT: 'CURRENT';
FIRST: 'FIRST';
AFTER: 'AFTER';
LAST: 'LAST';
ROW: 'ROW';
WITH: 'WITH';
VALUES: 'VALUES';
CREATE: 'CREATE';
TABLE: 'TABLE';
DIRECTORY: 'DIRECTORY';
VIEW: 'VIEW';
REPLACE: 'REPLACE';
INSERT: 'INSERT';
DELETE: 'DELETE';
INTO: 'INTO';
DESCRIBE: 'DESCRIBE';
EXPLAIN: 'EXPLAIN';
FORMAT: 'FORMAT';
LOGICAL: 'LOGICAL';
CODEGEN: 'CODEGEN';
COST: 'COST';
CAST: 'CAST';
SHOW: 'SHOW';
TABLES: 'TABLES';
COLUMNS: 'COLUMNS';
COLUMN: 'COLUMN';
USE: 'USE';
PARTITIONS: 'PARTITIONS';
FUNCTIONS: 'FUNCTIONS';
DROP: 'DROP';
UNION: 'UNION';
EXCEPT: 'EXCEPT';
SETMINUS: 'MINUS';
INTERSECT: 'INTERSECT';
TO: 'TO';
TABLESAMPLE: 'TABLESAMPLE';
STRATIFY: 'STRATIFY';
ALTER: 'ALTER';
RENAME: 'RENAME';
ARRAY: 'ARRAY';
MAP: 'MAP';
STRUCT: 'STRUCT';
COMMENT: 'COMMENT';
SET: 'SET';
RESET: 'RESET';
DATA: 'DATA';
START: 'START';
TRANSACTION: 'TRANSACTION';
COMMIT: 'COMMIT';
ROLLBACK: 'ROLLBACK';
MACRO: 'MACRO';
IGNORE: 'IGNORE';
BOTH: 'BOTH';
LEADING: 'LEADING';
TRAILING: 'TRAILING';

IF: 'IF';
POSITION: 'POSITION';

EQ  : '=' | '==';
NSEQ: '<=>';
NEQ : '<>';
NEQJ: '!=';
LT  : '<';
LTE : '<=' | '!>';
GT  : '>';
GTE : '>=' | '!<';

PLUS: '+';
MINUS: '-';
ASTERISK: '*';
SLASH: '/';
PERCENT: '%';
DIV: 'DIV';
TILDE: '~';
AMPERSAND: '&';
PIPE: '|';
CONCAT_PIPE: '||';
HAT: '^';

PERCENTLIT: 'PERCENT';
BUCKET: 'BUCKET';
OUT: 'OUT';
OF: 'OF';

SORT: 'SORT';
CLUSTER: 'CLUSTER';
DISTRIBUTE: 'DISTRIBUTE';
OVERWRITE: 'OVERWRITE';
TRANSFORM: 'TRANSFORM';
REDUCE: 'REDUCE';
USING: 'USING';
SERDE: 'SERDE';
SERDEPROPERTIES: 'SERDEPROPERTIES';
RECORDREADER: 'RECORDREADER';
RECORDWRITER: 'RECORDWRITER';
DELIMITED: 'DELIMITED';
FIELDS: 'FIELDS';
TERMINATED: 'TERMINATED';
COLLECTION: 'COLLECTION';
ITEMS: 'ITEMS';
KEYS: 'KEYS';
ESCAPED: 'ESCAPED';
LINES: 'LINES';
SEPARATED: 'SEPARATED';
FUNCTION: 'FUNCTION';
EXTENDED: 'EXTENDED';
REFRESH: 'REFRESH';
CLEAR: 'CLEAR';
CACHE: 'CACHE';
UNCACHE: 'UNCACHE';
LAZY: 'LAZY';
FORMATTED: 'FORMATTED';
GLOBAL: 'GLOBAL';
TEMPORARY: 'TEMPORARY' | 'TEMP';
OPTIONS: 'OPTIONS';
UNSET: 'UNSET';
TBLPROPERTIES: 'TBLPROPERTIES';
DBPROPERTIES: 'DBPROPERTIES';
BUCKETS: 'BUCKETS';
SKEWED: 'SKEWED';
STORED: 'STORED';
DIRECTORIES: 'DIRECTORIES';
LOCATION: 'LOCATION';
EXCHANGE: 'EXCHANGE';
ARCHIVE: 'ARCHIVE';
UNARCHIVE: 'UNARCHIVE';
FILEFORMAT: 'FILEFORMAT';
TOUCH: 'TOUCH';
COMPACT: 'COMPACT';
CONCATENATE: 'CONCATENATE';
CHANGE: 'CHANGE';
CASCADE: 'CASCADE';
RESTRICT: 'RESTRICT';
CLUSTERED: 'CLUSTERED';
SORTED: 'SORTED';
PURGE: 'PURGE';
INPUTFORMAT: 'INPUTFORMAT';
OUTPUTFORMAT: 'OUTPUTFORMAT';
DATABASE: 'DATABASE' | 'SCHEMA';
DATABASES: 'DATABASES' | 'SCHEMAS';
DFS: 'DFS';
TRUNCATE: 'TRUNCATE';
ANALYZE: 'ANALYZE';
COMPUTE: 'COMPUTE';
LIST: 'LIST';
STATISTICS: 'STATISTICS';
PARTITIONED: 'PARTITIONED';
EXTERNAL: 'EXTERNAL';
DEFINED: 'DEFINED';
REVOKE: 'REVOKE';
GRANT: 'GRANT';
LOCK: 'LOCK';
UNLOCK: 'UNLOCK';
MSCK: 'MSCK';
REPAIR: 'REPAIR';
RECOVER: 'RECOVER';
EXPORT: 'EXPORT';
IMPORT: 'IMPORT';
LOAD: 'LOAD';
ROLE: 'ROLE';
ROLES: 'ROLES';
COMPACTIONS: 'COMPACTIONS';
PRINCIPALS: 'PRINCIPALS';
TRANSACTIONS: 'TRANSACTIONS';
INDEX: 'INDEX';
INDEXES: 'INDEXES';
LOCKS: 'LOCKS';
OPTION: 'OPTION';
ANTI: 'ANTI';
LOCAL: 'LOCAL';
INPATH: 'INPATH';

STRING
    : '\\'' ( ~('\\''|'\\\\') | ('\\\\' .) )* '\\''
    | '""' ( ~('""'|'\\\\') | ('\\\\' .) )* '""'
    ;

BIGINT_LITERAL
    : DIGIT+ 'L'
    ;

SMALLINT_LITERAL
    : DIGIT+ 'S'
    ;

TINYINT_LITERAL
    : DIGIT+ 'Y'
    ;

INTEGER_VALUE
    : DIGIT+
    ;

DECIMAL_VALUE
    : DIGIT+ EXPONENT
    | DECIMAL_DIGITS EXPONENT? {isValidDecimal()}?
    ;

DOUBLE_LITERAL
    : DIGIT+ EXPONENT? 'D'
    | DECIMAL_DIGITS EXPONENT? 'D' {isValidDecimal()}?
    ;

BIGDECIMAL_LITERAL
    : DIGIT+ EXPONENT? 'BD'
    | DECIMAL_DIGITS EXPONENT? 'BD' {isValidDecimal()}?
    ;

IDENTIFIER
    : (LETTER | DIGIT | '_')+
    ;

BACKQUOTED_IDENTIFIER
    : '`' ( ~'`' | '``' )* '`'
    ;

fragment DECIMAL_DIGITS
    : DIGIT+ '.' DIGIT*
    | '.' DIGIT+
    ;

fragment EXPONENT
    : 'E' [+-]? DIGIT+
    ;

fragment DIGIT
    : [0-9]
    ;

fragment LETTER
    : [A-Z]
    ;

SIMPLE_COMMENT
    : '--' ~[\\r\\n]* '\\r'? '\\n'? -> channel(HIDDEN)
    ;

BRACKETED_EMPTY_COMMENT
    : '/**/' -> channel(HIDDEN)
    ;

BRACKETED_COMMENT
    : '/*' ~[+] .*? '*/' -> channel(HIDDEN)
    ;

WS
    : [ \\r\\n\\t]+ -> channel(HIDDEN)
    ;

// Catch-all for anything we can't recognize.
// We use this to be able to ignore and recover all the text
// when splitting statements with DelimiterLexer
UNRECOGNIZED
    : .
    ;
",8434,False,1578.8535597905143,median
"/*
 Copyright 2019 Alain Dargelas

 Licensed under the Apache License, Version 2.0 (the ""License"");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

 http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an ""AS IS"" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
#include ""SourceCompile/SV3_1aPpTreeShapeListener.h""

#include <cstdlib>
#include <iostream>
#include <regex>

#include ""CommandLine/CommandLineParser.h""
#include ""ErrorReporting/ErrorContainer.h""
#include ""SourceCompile/CompilationUnit.h""
#include ""SourceCompile/CompileSourceFile.h""
#include ""SourceCompile/Compiler.h""
#include ""SourceCompile/PreprocessFile.h""
#include ""SourceCompile/SymbolTable.h""
#include ""Utils/FileUtils.h""
#include ""Utils/ParseUtils.h""
#include ""Utils/StringUtils.h""
#include ""parser/SV3_1aPpLexer.h""
#include ""parser/SV3_1aPpParser.h""
#include ""parser/SV3_1aPpParserBaseListener.h""

namespace SURELOG {
SV3_1aPpTreeShapeListener::SV3_1aPpTreeShapeListener(
    PreprocessFile *pp, antlr4::CommonTokenStream *tokens,
    PreprocessFile::SpecialInstructions &instructions)
    : SV3_1aPpTreeListenerHelper::SV3_1aPpTreeListenerHelper(pp, instructions) {
  m_tokens = tokens;
}

void SV3_1aPpTreeShapeListener::enterTop_level_rule(
    SV3_1aPpParser::Top_level_ruleContext * /*ctx*/) {
  if (m_pp->getFileContent() == NULL) {
    m_fileContent = new FileContent(
        m_pp->getFileId(0), m_pp->getLibrary(),
        m_pp->getCompileSourceFile()->getSymbolTable(),
        m_pp->getCompileSourceFile()->getErrorContainer(), NULL, 0);
    m_pp->setFileContent(m_fileContent);
    m_pp->getCompileSourceFile()->getCompiler()->getDesign()->addPPFileContent(
        m_pp->getFileId(0), m_fileContent);
  } else {
    m_fileContent = m_pp->getFileContent();
  }
}

void SV3_1aPpTreeShapeListener::enterComments(
    SV3_1aPpParser::CommentsContext *ctx) {
  // if (m_pp->getIncluder ())
  //  return;
  if (!m_pp->getCompileSourceFile()->getCommandLineParser()->filterComments()) {
    if (m_inActiveBranch &&
        (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
        (!m_inMacroDefinitionParsing)) {
      if (ctx->Block_comment()) {
        m_pp->append(ctx->Block_comment()->getText());
      } else if (ctx->One_line_comment()) {
        m_pp->append(ctx->One_line_comment()->getText());
      }
    }
  }
}

void SV3_1aPpTreeShapeListener::enterNumber(
    SV3_1aPpParser::NumberContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion))) {
    if (!m_inMacroDefinitionParsing) {
      std::string text = ctx->Number()->getText();
      std::string text2;
      bool firstNonSpace = false;
      unsigned int size = text.size();
      for (unsigned int i = 0; i < size; i++) {
        if (text[i] != ' ') {
          firstNonSpace = true;
        }
        if (firstNonSpace) {
          if ((i < size - 1) && (text[i] == ' ')) {
            continue;
          }
          text2 += text[i];
        }
      }
      m_pp->append(text2);
    }
  }
}

void SV3_1aPpTreeShapeListener::exitDescription(
    SV3_1aPpParser::DescriptionContext *ctx) {
  if (ctx->text_blob()) {
    if (ctx->text_blob()->CR())
      addVObject(ctx, VObjectType::slText_blob);
    else if (ctx->text_blob()->Spaces())
      addVObject(ctx, VObjectType::slText_blob);
    else
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
  } else {
    addVObject(ctx, ctx->getText(), VObjectType::slDescription);
  }
}

void SV3_1aPpTreeShapeListener::exitComments(
    SV3_1aPpParser::CommentsContext *ctx) {
  if (!m_pp->getCompileSourceFile()->getCommandLineParser()->filterComments()) {
    if (m_inActiveBranch &&
        (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
        (!m_inMacroDefinitionParsing)) {
      if (ctx->Block_comment()) {
        addVObject(ctx, ctx->Block_comment()->getText(),
                   VObjectType::slComments);
      } else if (ctx->One_line_comment()) {
        addVObject(ctx, ctx->One_line_comment()->getText(),
                   VObjectType::slComments);
      }
    } else {
      addLineFiller(ctx);
    }
  }
}

void SV3_1aPpTreeShapeListener::exitNumber(SV3_1aPpParser::NumberContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion))) {
    if (!m_inMacroDefinitionParsing) {
      std::string text = ctx->Number()->getText();
      addVObject(ctx, text, VObjectType::slNumber);
    }
  }
}

void SV3_1aPpTreeShapeListener::exitEscaped_macro_definition_body(
    SV3_1aPpParser::Escaped_macro_definition_bodyContext *ctx) {
  addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
}

void SV3_1aPpTreeShapeListener::exitSimple_macro_definition_body(
    SV3_1aPpParser::Simple_macro_definition_bodyContext *ctx) {
  addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
}

void SV3_1aPpTreeShapeListener::exitPragma_expression(
    SV3_1aPpParser::Pragma_expressionContext *ctx) {
  addVObject(ctx, ctx->getText(), VObjectType::slPragma_expression);
}

void SV3_1aPpTreeShapeListener::exitMacro_arg(
    SV3_1aPpParser::Macro_argContext *ctx) {
  addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
}

void SV3_1aPpTreeShapeListener::exitString_blob(
    SV3_1aPpParser::String_blobContext *ctx) {
  addVObject(ctx, ctx->getText(), VObjectType::slString);
}

void SV3_1aPpTreeShapeListener::exitDefault_value(
    SV3_1aPpParser::Default_valueContext *ctx) {
  addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
}

void SV3_1aPpTreeShapeListener::enterUnterminated_string(
    SV3_1aPpParser::Unterminated_stringContext *ctx) {
  std::string st = ctx->getText();
  if (m_pp->getMacroInfo() == nullptr)
    logError(ErrorDefinition::PP_UNTERMINATED_STRING, ctx, st, true);
  m_pp->append(st);
}

void SV3_1aPpTreeShapeListener::enterInclude_directive(
    SV3_1aPpParser::Include_directiveContext *ctx) {
  if (m_inActiveBranch && (!m_inMacroDefinitionParsing)) {
    std::pair<int, int> lineCol =
        ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
    std::string fileName;
    int openingIndex = -1;
    if (ctx->String()) {
      fileName = ctx->String()->getText();
    } else if (ctx->macro_instance()) {
      fileName = m_pp->evaluateMacroInstance(
          ctx->macro_instance()->getText(), m_pp, lineCol.first,
          PreprocessFile::SpecialInstructions::CheckLoop,
          PreprocessFile::SpecialInstructions::ComplainUndefinedMacro);
    } else {
      Location loc(m_pp->getFileId(lineCol.first),
                   m_pp->getLineNb(lineCol.first), 0, 0);
      logError(ErrorDefinition::PP_INVALID_INCLUDE_FILENAME, loc);
      return;
    }

    if (m_pp->m_debugPP)
      std::cout << ""PP INCLUDE DIRECTIVE "" << fileName << std::endl;
    if (fileName.size() && fileName[0] == '\\""')
      fileName = fileName.substr(1, fileName.size() - 2);

    SymbolId fileId = getSymbolTable()->registerSymbol(fileName);
    SymbolId locfileId = FileUtils::locateFile(fileId, getSymbolTable(),
                                               m_pp->getCompileSourceFile()
                                                   ->getCommandLineParser()
                                                   ->getIncludePaths());
    if (locfileId != getSymbolTable()->getBadId()) {
      fileName = getSymbolTable()->getSymbol(locfileId);
      fileId = locfileId;
    }

    if (m_pp->getCompileSourceFile()->getCommandLineParser()->verbose()) {
      Location loc(fileId);
      logError(ErrorDefinition::PP_PROCESSING_INCLUDE_FILE, loc, true);
    }

    // Detect include loop
    PreprocessFile *tmp = m_pp;
    while (tmp) {
      if (tmp->getFileId(0) == fileId) {
        Location loc(m_pp->getFileId(lineCol.first), lineCol.first, 0, fileId);
        logError(ErrorDefinition::PP_RECURSIVE_INCLUDE_DIRECTIVE, loc, true);
        return;
      }
      tmp = tmp->getIncluder();
    }

    // unsigned int sectionStartLine, SymbolId sectionFile, unsigned int
    // originalLine, unsigned int type
    IncludeFileInfo info(1, fileId, m_pp->getSumLineCount() + 1, 1);
    m_pp->getSourceFile()->getIncludeFileInfo().push_back(info);
    openingIndex = m_pp->getSourceFile()->getIncludeFileInfo().size() - 1;

    PreprocessFile *pp = new PreprocessFile(
        fileId, m_pp, lineCol.first, m_pp->getCompileSourceFile(),
        m_instructions, m_pp->getCompilationUnit(), m_pp->getLibrary());
    m_pp->getCompileSourceFile()->registerPP(pp);
    if (!pp->preprocess()) {
      return;
    }

    std::string pre;
    std::string post;

    if (!m_pp->m_instructions.m_filterFileLine) {
      pre = ""`line 1 \\"""" + fileName + ""\\"" 1\\n"";
      if (m_pp->getCompileSourceFile()
              ->getCommandLineParser()
              ->lineOffsetsAsComments()) {
        pre = ""/* "" + pre + "" */"";
      }

      if (m_pp->isMacroBody() && m_pp->getMacroInfo()) {
        MacroInfo *info = m_pp->getMacroInfo();
        if (m_pp->getCompileSourceFile()
                ->getCommandLineParser()
                ->lineOffsetsAsComments()) {
          post = ""\\n/* SLline "" + std::to_string(info->m_line + lineCol.first) +
                 "" \\"""" + getSymbolTable()->getSymbol(info->m_file) +
                 ""\\"" 0 */\\n"";
        } else {
          post = ""\\n`line "" + std::to_string(info->m_line + lineCol.first) +
                 "" \\"""" + getSymbolTable()->getSymbol(info->m_file) + ""\\"" 0\\n"";
        }
      } else {
        if (m_pp->getCompileSourceFile()
                ->getCommandLineParser()
                ->lineOffsetsAsComments()) {
          post = ""\\n/* SLline "" + std::to_string(lineCol.first + 1) + "" \\"""" +
                 m_pp->getFileName(lineCol.first) + ""\\"" 2 */\\n"";
        } else {
          post = ""\\n`line "" + std::to_string(lineCol.first + 1) + "" \\"""" +
                 m_pp->getFileName(lineCol.first) + ""\\"" 2\\n"";
        }
      }
    }
    std::string pp_result = pp->getPreProcessedFileContent();
    if (!pp_result.empty()) m_pp->append(pre + pp_result + post);
    if (ctx->macro_instance()) {
      m_append_paused_context = ctx;
      m_pp->pauseAppend();
    }

    IncludeFileInfo infop(lineCol.first, m_pp->getFileId(lineCol.first),
                          m_pp->getSumLineCount() + 1, 2);
    infop.m_indexOpening = openingIndex;
    m_pp->getSourceFile()->getIncludeFileInfo().push_back(infop);
    if (openingIndex >= 0)
      m_pp->getSourceFile()->getIncludeFileInfo(openingIndex).m_indexClosing =
          m_pp->getSourceFile()->getIncludeFileInfo().size() - 1;
  }
}

void SV3_1aPpTreeShapeListener::exitInclude_directive(
    SV3_1aPpParser::Include_directiveContext *ctx) {
  if (m_append_paused_context == ctx) {
    m_append_paused_context = NULL;
    m_pp->resumeAppend();
  }
  std::string text;
  if (ctx->Escaped_identifier()) {
    text = ctx->Escaped_identifier()->getText();
    addVObject((antlr4::ParserRuleContext *)ctx->Escaped_identifier(), text,
               VObjectType::slEscaped_identifier);
  } else if (ctx->Simple_identifier()) {
    text = ctx->Simple_identifier()->getText();
    addVObject((antlr4::ParserRuleContext *)ctx->Simple_identifier(), text,
               VObjectType::slPs_identifier);
  } else if (ctx->String()) {
    text = ctx->String()->getText();
    addVObject((antlr4::ParserRuleContext *)ctx->String(), text,
               VObjectType::slString);
  }
  addVObject(ctx, VObjectType::slInclude_statement);
}

void SV3_1aPpTreeShapeListener::enterSimple_no_args_macro_definition(
    SV3_1aPpParser::Simple_no_args_macro_definitionContext *ctx) {
  if (m_inActiveBranch) {
    std::string macroName;
    if (ctx->Simple_identifier())
      macroName = ctx->Simple_identifier()->getText();
    else if (ctx->Escaped_identifier()) {
      macroName = ctx->Escaped_identifier()->getText();
      macroName.erase(0, 1);
      StringUtils::rtrim(macroName);
    }
    m_inMacroDefinitionParsing = true;
    SV3_1aPpParser::Simple_macro_definition_bodyContext *cBody =
        ctx->simple_macro_definition_body();

    std::pair<int, int> lineCol = ParseUtils::getLineColumn(
        ctx->Simple_identifier() ? ctx->Simple_identifier()
                                 : ctx->Escaped_identifier());
    std::vector<antlr4::Token *> tokens = ParseUtils::getFlatTokenList(cBody);
    std::vector<std::string> body_tokens;
    for (auto token : tokens) {
      body_tokens.push_back(token->getText());
    }

    checkMultiplyDefinedMacro(macroName, ctx);
    m_pp->recordMacro(macroName, m_pp->getLineNb(lineCol.first), lineCol.second,
                      """", body_tokens);
    addLineFiller(ctx);
  } else {
    addLineFiller(ctx);
  }
}

void SV3_1aPpTreeShapeListener::exitSimple_no_args_macro_definition(
    SV3_1aPpParser::Simple_no_args_macro_definitionContext *ctx) {
  m_inMacroDefinitionParsing = false;
  addVObject(ctx, VObjectType::slMacro_definition);
}

void SV3_1aPpTreeShapeListener::enterMacroInstanceWithArgs(
    SV3_1aPpParser::MacroInstanceWithArgsContext *ctx) {
  if (m_inActiveBranch && (!m_inMacroDefinitionParsing)) {
    std::string macroName;
    if (ctx->Macro_identifier())
      macroName = ctx->Macro_identifier()->getText();
    else if (ctx->Macro_Escaped_identifier()) {
      macroName = ctx->Macro_Escaped_identifier()->getText();
      macroName.erase(0, 1);
      StringUtils::rtrim(macroName);
    }
    std::string macroArgs = ctx->macro_actual_args()->getText();
    int nbCRinArgs = std::count(macroArgs.begin(), macroArgs.end(), '\\n');
    std::vector<antlr4::tree::ParseTree *> tokens =
        ParseUtils::getTopTokenList(ctx->macro_actual_args());
    std::vector<std::string> actualArgs;
    ParseUtils::tokenizeAtComma(actualArgs, tokens);
    macroName.erase(macroName.begin());
    std::string macroBody;
    int openingIndex = -1;
    std::pair<int, int> lineCol =
        ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
    if (!m_pp->isMacroBody()) {
      m_pp->getSourceFile()->m_loopChecker.clear();
    }

    MacroInfo *macroInf = m_pp->getMacro(macroName);
    if (macroInf) {
      IncludeFileInfo info(macroInf->m_line, macroInf->m_file,
                           m_pp->getSumLineCount() + 1, 1);
      m_pp->getSourceFile()->getIncludeFileInfo().push_back(info);
      openingIndex = m_pp->getSourceFile()->getIncludeFileInfo().size() - 1;
      macroBody = m_pp->getMacro(macroName, actualArgs, m_pp, lineCol.first,
                                 m_pp->getSourceFile()->m_loopChecker,
                                 m_pp->m_instructions, macroInf->m_line,
                                 macroInf->m_file);
    } else {
      macroBody = m_pp->getMacro(macroName, actualArgs, m_pp, lineCol.first,
                                 m_pp->getSourceFile()->m_loopChecker,
                                 m_pp->m_instructions);
    }
    if (m_pp->m_debugMacro)
      std::cout << ""FIND MACRO: "" << macroName << "" ARGS: "" << macroArgs
                << "" BODY: |"" << macroBody << ""|"" << std::endl;
    if (macroBody == PreprocessFile::MacroNotDefined) {
      macroBody += "":"" + macroName + ""!!! "";
      logError(ErrorDefinition::PP_UNKOWN_MACRO, ctx, macroName, true);
    }
    std::string pre;
    std::string post;

    if (macroInf) {
      if (!m_pp->m_instructions.m_filterFileLine) {
        if (lineCol.second == 0) {
          pre = ""`line "" + std::to_string(macroInf->m_line) + "" \\"""" +
                getSymbolTable()->getSymbol(macroInf->m_file) + ""\\"" 0"";
          post = ""`line "" + std::to_string(lineCol.first + 1) + "" \\"""" +
                 m_pp->getFileName(lineCol.first) + ""\\"" 0"";
          if (m_pp->getCompileSourceFile()
                  ->getCommandLineParser()
                  ->lineOffsetsAsComments()) {
            pre = ""/* "" + pre + ""*/"";
            post = ""/* "" + post + ""*/"";
          } else {
            // Don't insert as parser does not know how to process this
            // directive in this lexical context
            pre = """";
            post = """";
          }
        }
      }
    }
    bool emptyMacroBody = false;
    if (macroBody.empty()) {
      emptyMacroBody = true;
      for (int i = 0; i < nbCRinArgs; i++) macroBody += ""\\n"";
    }

    m_pp->append(pre + macroBody + post);

    if (m_append_paused_context == NULL) {
      m_append_paused_context = ctx;
      m_pp->pauseAppend();
    }

    if (openingIndex >= 0) {
      SymbolId fileId = 0;
      unsigned int line = 0;
      if (m_pp->getEmbeddedMacroCallFile()) {
        fileId = m_pp->getEmbeddedMacroCallFile();
        line = m_pp->getEmbeddedMacroCallLine() + lineCol.first;
      } else {
        fileId = m_pp->getFileId(lineCol.first);
        line = lineCol.first;
      }
      int totalLineCount = m_pp->getSumLineCount() + 1;
      int origLine = line;
      if (emptyMacroBody) {
        if (nbCRinArgs) totalLineCount -= nbCRinArgs;

        IncludeFileInfo infop(origLine, fileId, totalLineCount, 2);
        infop.m_indexOpening = openingIndex;
        m_pp->getSourceFile()->getIncludeFileInfo().push_back(infop);
      } else {
        IncludeFileInfo infop(origLine + nbCRinArgs, fileId, totalLineCount, 2);
        infop.m_indexOpening = openingIndex;
        m_pp->getSourceFile()->getIncludeFileInfo().push_back(infop);
      }
      if (openingIndex >= 0)
        m_pp->getSourceFile()->getIncludeFileInfo(openingIndex).m_indexClosing =
            m_pp->getSourceFile()->getIncludeFileInfo().size() - 1;
    }
  } else if ((!m_inActiveBranch) && (!m_inMacroDefinitionParsing)) {
    std::string macroArgs = ctx->macro_actual_args()->getText();
    int nbCRinArgs = std::count(macroArgs.begin(), macroArgs.end(), '\\n');
    for (int i = 0; i < nbCRinArgs; i++) {
      m_pp->append(""\\n"");
    }
  }
}

void SV3_1aPpTreeShapeListener::exitMacroInstanceWithArgs(
    SV3_1aPpParser::MacroInstanceWithArgsContext *ctx) {
  if (m_append_paused_context == ctx) {
    m_append_paused_context = NULL;
    m_pp->resumeAppend();
    addVObject(ctx, VObjectType::slMacroInstanceWithArgs);
  }
}

void SV3_1aPpTreeShapeListener::enterMacroInstanceNoArgs(
    SV3_1aPpParser::MacroInstanceNoArgsContext *ctx) {
  if (m_inActiveBranch && (!m_inMacroDefinitionParsing)) {
    std::string macroName;
    if (ctx->Macro_identifier())
      macroName = ctx->Macro_identifier()->getText();
    else if (ctx->Macro_Escaped_identifier()) {
      macroName = ctx->Macro_Escaped_identifier()->getText();
      macroName.erase(0, 1);
      StringUtils::rtrim(macroName);
    }
    macroName.erase(macroName.begin());
    std::pair<int, int> lineCol =
        ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
    std::vector<std::string> args;
    if (!m_pp->isMacroBody()) {
      m_pp->getSourceFile()->m_loopChecker.clear();
    }

    std::string macroBody;
    int openingIndex = -1;
    MacroInfo *macroInf = m_pp->getMacro(macroName);
    if (macroInf) {
      if (macroInf->m_type == MacroInfo::WITH_ARGS) {
        Location loc(m_pp->getFileId(lineCol.first),
                     m_pp->getLineNb(lineCol.first), 0,
                     getSymbolTable()->getId(macroName));
        Location extraLoc(macroInf->m_file, macroInf->m_line, 0);
        logError(ErrorDefinition::PP_MACRO_PARENTHESIS_NEEDED, loc, extraLoc);
      }

      IncludeFileInfo info(macroInf->m_line, macroInf->m_file,
                           m_pp->getSumLineCount() + 1, 1);
      m_pp->getSourceFile()->getIncludeFileInfo().push_back(info);
      openingIndex = m_pp->getSourceFile()->getIncludeFileInfo().size() - 1;

      macroBody = m_pp->getMacro(macroName, args, m_pp, lineCol.first,
                                 m_pp->getSourceFile()->m_loopChecker,
                                 m_pp->m_instructions, macroInf->m_line,
                                 macroInf->m_file);
    } else {
      macroBody = m_pp->getMacro(macroName, args, m_pp, lineCol.first,
                                 m_pp->getSourceFile()->m_loopChecker,
                                 m_pp->m_instructions);
    }
    if (m_pp->m_debugMacro)
      std::cout << ""FIND MACRO: "" << macroName << "", BODY: |"" << macroBody
                << ""|"" << std::endl;
    if (macroBody.empty() && m_instructions.m_mark_empty_macro) {
      macroBody = SymbolTable::getEmptyMacroMarker();
    }
    if (macroBody == PreprocessFile::MacroNotDefined) {
      macroBody += "":"" + macroName + ""!!! "";
      logError(ErrorDefinition::PP_UNKOWN_MACRO, ctx, macroName, true);
    }

    std::string pre;
    std::string post;

    if (macroInf) {
      if (!m_pp->m_instructions.m_filterFileLine) {
        if (lineCol.second == 0) {
          if (macroInf->m_file)
            pre = ""`line "" + std::to_string(macroInf->m_line) + "" \\"""" +
                  getSymbolTable()->getSymbol(macroInf->m_file) + ""\\"" 0"";
          post = ""`line "" + std::to_string(lineCol.first + 1) + "" \\"""" +
                 m_pp->getFileName(lineCol.first) + ""\\"" 0"";
          if (m_pp->getCompileSourceFile()
                  ->getCommandLineParser()
                  ->lineOffsetsAsComments()) {
            pre = ""/* "" + pre + ""*/"";
            post = ""/* "" + post + ""*/"";
          } else {
            // Don't insert as parser does not know how to process this
            // directive in this lexical context
            pre = """";
            post = """";
          }
        }
      }
    }
    m_pp->append(pre + macroBody + post);

    if (openingIndex >= 0) {
      SymbolId fileId = 0;
      unsigned int line = 0;
      if (m_pp->getEmbeddedMacroCallFile()) {
        fileId = m_pp->getEmbeddedMacroCallFile();
        line = m_pp->getEmbeddedMacroCallLine() + lineCol.first;
      } else {
        fileId = m_pp->getFileId(lineCol.first);
        line = lineCol.first;
      }
      int nbCRinMacroBody =
          std::count(macroBody.begin(), macroBody.end(), '\\n');
      if (nbCRinMacroBody) {
        IncludeFileInfo infop(line, fileId, m_pp->getSumLineCount() + 1, 2);
        infop.m_indexOpening = openingIndex;
        m_pp->getSourceFile()->getIncludeFileInfo().push_back(infop);
        if (openingIndex >= 0)
          m_pp->getSourceFile()
              ->getIncludeFileInfo(openingIndex)
              .m_indexClosing =
              m_pp->getSourceFile()->getIncludeFileInfo().size() - 1;
      }
    }
  }
}

void SV3_1aPpTreeShapeListener::enterPragma_directive(
    SV3_1aPpParser::Pragma_directiveContext *ctx) {
  std::string type;
  if (ctx->Simple_identifier()) type = ctx->Simple_identifier()->getText();
  bool endOfSection = false;
  if (type == ""protect"") {
    if (m_pp->getCompileSourceFile()
            ->getCommandLineParser()
            ->filterProtectedRegions()) {
      m_filterProtectedRegions = true;

      const std::vector<SV3_1aPpParser::Pragma_expressionContext *> &exprs =
          ctx->pragma_expression();
      for (auto expr : exprs) {
        if (expr->Simple_identifier()) {
          const std::string key = expr->Simple_identifier()->getText();
          if (key == ""begin_protected"") {
            m_inProtectedRegion = true;
            break;
          }
          if (key == ""end_protected"") {
            m_inProtectedRegion = false;
            endOfSection = true;
            break;
          }
        }
      }
    }
  }
  if ((!(m_filterProtectedRegions && m_inProtectedRegion)) && (!endOfSection)) {
    forwardToParser(ctx);
    m_pp->pauseAppend();
  }
}

void SV3_1aPpTreeShapeListener::exitPragma_directive(
    SV3_1aPpParser::Pragma_directiveContext *ctx) {
  if ((!(m_filterProtectedRegions && m_inProtectedRegion))) {
    m_pp->resumeAppend();
  }
}

void SV3_1aPpTreeShapeListener::enterSv_file_directive(
    SV3_1aPpParser::Sv_file_directiveContext *ctx) {
  if (m_inActiveBranch && (!m_inMacroDefinitionParsing)) {
    if (m_pp->getMacroInfo()) {
      m_pp->append(PreprocessFile::PP__File__Marking);
    } else {
      std::pair<int, int> lineCol =
          ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
      m_pp->append(""\\"""" + m_pp->getFileName(lineCol.first) + ""\\"""");
    }
  }
  m_pp->pauseAppend();
}
// void
// SV3_1aPpTreeShapeListener::exitSv_file_directive(SV3_1aPpParser::Sv_file_directiveContext
// *
// /*ctx*/)  { }

void SV3_1aPpTreeShapeListener::enterSv_line_directive(
    SV3_1aPpParser::Sv_line_directiveContext *ctx) {
  if (m_inActiveBranch && (!m_inMacroDefinitionParsing)) {
    std::pair<int, int> lineCol =
        ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);

    if (m_pp->getMacroInfo()) {
      // Macro 1rst line + offset of directive within the macro -1
      // m_pp->append (std::to_string (m_pp->getLineNb(lineCol.first) +
      // m_pp->getMacroInfo()->m_line - 1));
      m_pp->append(PreprocessFile::PP__Line__Marking);
    } else {
      m_pp->append(std::to_string(m_pp->getLineNb(lineCol.first)));
    }
  }
  m_pp->pauseAppend();
}

void SV3_1aPpTreeShapeListener::enterLine_directive(
    SV3_1aPpParser::Line_directiveContext *ctx) {
  std::pair<int, int> lineCol =
      ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
  std::string fileName;
  if (ctx->String()) fileName = ctx->String()->getText();
  if (fileName.size()) fileName = fileName.substr(1, fileName.size() - 2);
  std::string number;
  if (ctx->number().size()) number = ctx->number()[0]->getText();
  SymbolId newFileId = getSymbolTable()->registerSymbol(fileName);
  int currentLine = lineCol.first;
  int newLine = atoi(number.c_str());
  PreprocessFile::LineTranslationInfo info(newFileId, currentLine, newLine);
  m_pp->addLineTranslationInfo(info);
  m_pp->pauseAppend();
}

void SV3_1aPpTreeShapeListener::enterDefine_directive(
    SV3_1aPpParser::Define_directiveContext *ctx) {
  if (m_inActiveBranch) {
    std::string macroName;
    if (ctx->Simple_identifier())
      macroName = ctx->Simple_identifier()->getText();
    else if (ctx->Escaped_identifier()) {
      macroName = ctx->Escaped_identifier()->getText();
      macroName.erase(0, 1);
      StringUtils::rtrim(macroName);
    }
    if (m_reservedMacroNamesSet.find(macroName) !=
        m_reservedMacroNamesSet.end()) {
      logError(ErrorDefinition::PP_MACRO_NAME_RESERVED, ctx, macroName, 0);
    }
  }
}

void SV3_1aPpTreeShapeListener::exitDefine_directive(
    SV3_1aPpParser::Define_directiveContext *ctx) {
  if (m_inActiveBranch) {
    std::string macroName;
    if (ctx->Simple_identifier())
      macroName = ctx->Simple_identifier()->getText();
    else if (ctx->Escaped_identifier()) {
      macroName = ctx->Escaped_identifier()->getText();
      macroName.erase(0, 1);
      StringUtils::rtrim(macroName);
    }
    MacroInfo *macroInf = m_pp->getMacro(macroName);
    if (macroInf == NULL) {
      std::pair<int, int> lineCol = ParseUtils::getLineColumn(
          ctx->Simple_identifier() ? ctx->Simple_identifier()
                                   : ctx->Escaped_identifier());
      checkMultiplyDefinedMacro(macroName, ctx);
      std::vector<std::string> body_tokens;
      m_pp->recordMacro(macroName, m_pp->getLineNb(lineCol.first),
                        lineCol.second, """", body_tokens);
      addLineFiller(ctx);
    }
  } else {
    addLineFiller(ctx);
  }
}

void SV3_1aPpTreeShapeListener::enterString(
    SV3_1aPpParser::StringContext *ctx) {
  std::string stringContent = ctx->getText();
  std::pair<int, int> lineCol =
      ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
  bool escaped = false;
  for (unsigned int i = 1; i < stringContent.size() - 1; i++) {
    if (stringContent[i] == '""') {
      if (escaped == false) {
        std::string character;
        character += stringContent[i];
        Location loc(m_pp->getFileId(lineCol.first),
                     m_pp->getLineNb(lineCol.first), lineCol.second + i + 1,
                     getSymbolTable()->registerSymbol(character));
        logError(ErrorDefinition::PP_UNESCAPED_CHARACTER_IN_STRING, loc);
      }
    }
    if (stringContent[i] == '\\\\') {
      escaped = true;
      if (i == stringContent.size() - 2) {
        std::string character;
        character += stringContent[i];
        Location loc(m_pp->getFileId(lineCol.first),
                     m_pp->getLineNb(lineCol.first), lineCol.second + i + 1,
                     getSymbolTable()->registerSymbol(character));
        logError(ErrorDefinition::PP_UNRECOGNIZED_ESCAPED_SEQUENCE, loc);
      } else {
        if (stringContent[i + 1] == '\\\\') {
          i++;
          escaped = false;
          continue;
        }
        char sc = stringContent[i + 1];
        if ((sc != 'n') && (sc != '""') && (sc != '\\\\') && (sc != 't') &&
            (sc != 'v') && (sc != 'f') && (sc != 'a') && (sc != 'd') &&
            (sc != '%') && (sc != 'x') && (sc != '\\n') && (sc != '0') &&
            (sc != 'r')) {
          std::string character = ""\\\\"";
          character += stringContent[i + 1];
          Location loc(m_pp->getFileId(lineCol.first),
                       m_pp->getLineNb(lineCol.first), lineCol.second + i + 1,
                       getSymbolTable()->registerSymbol(character));
          logError(ErrorDefinition::PP_UNRECOGNIZED_ESCAPED_SEQUENCE, loc);
        }
      }
    } else {
      escaped = false;
    }
  }
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    if (stringContent.find(""`"") != std::string::npos) {
      std::string stringData = stringContent;
      /* No macro substitution in strings (LRM)
      stringData.erase(0,1);
      stringData.erase(stringData.end() -1, stringData.end());
      stringContent = ""\\"""" + m_pp->evaluateMacroInstance(stringData,m_pp,
      lineCol.first, PreprocessFile::SpecialInstructions::DontCheckLoop,
                                                         PreprocessFile::SpecialInstructions::AsIsUndefinedMacro
                                                         ) + ""\\"""" ;
       */
      stringContent =
          std::regex_replace(stringContent, std::regex(""``.``""), ""."");
      stringContent =
          std::regex_replace(stringContent, std::regex(""``-``""), ""-"");
    }
    m_pp->append(stringContent);
  }
}

void SV3_1aPpTreeShapeListener::enterEscaped_identifier(
    SV3_1aPpParser::Escaped_identifierContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion))) {
    if (!m_inMacroDefinitionParsing) {
      std::string text = ctx->getText();
      std::string trunc;
      for (unsigned int i = 1; i < text.size() - 1; i++) trunc += text[i];
      m_pp->append(EscapeSequence + trunc + EscapeSequence);
    }
  }
}

void SV3_1aPpTreeShapeListener::enterSource_text(
    SV3_1aPpParser::Source_textContext * /*ctx*/) {
  m_pp->getCompilationUnit()->setCurrentTimeInfo(m_pp->getFileId(0));
}

void SV3_1aPpTreeShapeListener::exitLine_directive(
    SV3_1aPpParser::Line_directiveContext * /*ctx*/) {
  m_pp->resumeAppend();
}

void SV3_1aPpTreeShapeListener::enterDefault_nettype_directive(
    SV3_1aPpParser::Default_nettype_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::exitSv_file_directive(
    SV3_1aPpParser::Sv_file_directiveContext * /*ctx*/) {
  m_pp->resumeAppend();
}

void SV3_1aPpTreeShapeListener::exitSv_line_directive(
    SV3_1aPpParser::Sv_line_directiveContext * /*ctx*/) {
  m_pp->resumeAppend();
}

void SV3_1aPpTreeShapeListener::enterTimescale_directive(
    SV3_1aPpParser::Timescale_directiveContext *ctx) {
  if (m_pp->getCompilationUnit()->isInDesignElement()) {
    std::string directive = ""`timescale"";
    getSymbolTable()->registerSymbol(directive);
    logError(ErrorDefinition::PP_ILLEGAL_DIRECTIVE_IN_DESIGN_ELEMENT, ctx,
             directive);
  }
  forwardToParser(ctx);

  TimeInfo compUnitTimeInfo;
  compUnitTimeInfo.m_type = TimeInfo::Type::Timescale;
  compUnitTimeInfo.m_fileId = m_pp->getFileId(0);
  std::pair<int, int> lineCol = ParseUtils::getLineColumn(ctx->TIMESCALE());
  compUnitTimeInfo.m_line = lineCol.first;
  std::regex base_regex(
      ""[ ]*([0-9]+)([mnsupf]+)[ ]*/[ ]*([0-9]+)([mnsupf]+)[ ]*"");
  std::smatch base_match;
  std::string value = ctx->TIMESCALE()->getText().c_str();
  if (std::regex_match(value, base_match, base_regex)) {
    std::ssub_match base1_sub_match = base_match[1];
    std::string base1 = base1_sub_match.str();
    compUnitTimeInfo.m_timeUnitValue = atoi(base1.c_str());
    compUnitTimeInfo.m_timeUnit = TimeInfo::unitFromString(base_match[2].str());
    std::ssub_match base2_sub_match = base_match[3];
    std::string base2 = base2_sub_match.str();
    compUnitTimeInfo.m_timePrecisionValue = atoi(base2.c_str());
    compUnitTimeInfo.m_timePrecision =
        TimeInfo::unitFromString(base_match[4].str());
  }
  m_pp->getCompilationUnit()->recordTimeInfo(compUnitTimeInfo);
}

void SV3_1aPpTreeShapeListener::enterUndef_directive(
    SV3_1aPpParser::Undef_directiveContext *ctx) {
  std::string macroName;
  std::pair<int, int> lineCol =
      ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
  if (ctx->Simple_identifier())
    macroName = ctx->Simple_identifier()->getText();
  else if (ctx->Escaped_identifier()) {
    macroName = ctx->Escaped_identifier()->getText();
    macroName.erase(0, 1);
    StringUtils::rtrim(macroName);
  } else if (ctx->macro_instance()) {
    macroName = m_pp->evaluateMacroInstance(
        ctx->macro_instance()->getText(), m_pp, lineCol.first,
        PreprocessFile::SpecialInstructions::CheckLoop,
        PreprocessFile::SpecialInstructions::ComplainUndefinedMacro);
  }
  if (m_pp->m_debugMacro)
    std::cout << ""Undefining macro: "" << macroName << std::endl;
  std::set<PreprocessFile *> visited;
  if (m_inActiveBranch && (!m_inMacroDefinitionParsing)) {
    bool found = m_pp->deleteMacro(macroName, visited);
    if (!found) {
      logError(ErrorDefinition::PP_UNDEF_UNKOWN_MACRO, ctx, macroName);
    }
  }
}

void SV3_1aPpTreeShapeListener::enterIfdef_directive(
    SV3_1aPpParser::Ifdef_directiveContext *ctx) {
  PreprocessFile::IfElseItem item;
  std::string macroName;
  std::pair<int, int> lineCol =
      ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
  if (ctx->Simple_identifier())
    macroName = ctx->Simple_identifier()->getText();
  else if (ctx->Escaped_identifier()) {
    macroName = ctx->Escaped_identifier()->getText();
    macroName.erase(0, 1);
    StringUtils::rtrim(macroName);
  } else if (ctx->macro_instance()) {
    macroName = m_pp->evaluateMacroInstance(
        ctx->macro_instance()->getText(), m_pp, lineCol.first,
        PreprocessFile::SpecialInstructions::CheckLoop,
        PreprocessFile::SpecialInstructions::ComplainUndefinedMacro);
  }
  item.m_macroName = macroName;
  std::vector<std::string> args;
  if (!m_pp->isMacroBody()) {
    m_pp->getSourceFile()->m_loopChecker.clear();
  }
  PreprocessFile::SpecialInstructions instr = m_pp->m_instructions;
  instr.m_evaluate = PreprocessFile::SpecialInstructions::DontEvaluate;
  std::string macroBody =
      m_pp->getMacro(item.m_macroName, args, m_pp, 0,
                     m_pp->getSourceFile()->m_loopChecker, instr);
  item.m_defined = (macroBody != PreprocessFile::MacroNotDefined);
  item.m_type = PreprocessFile::IfElseItem::IFDEF;
  item.m_previousActiveState = m_inActiveBranch;
  m_pp->getStack().push_back(item);
  setCurrentBranchActivity(lineCol.first);
}

void SV3_1aPpTreeShapeListener::enterIfndef_directive(
    SV3_1aPpParser::Ifndef_directiveContext *ctx) {
  PreprocessFile::IfElseItem item;
  std::string macroName;
  std::pair<int, int> lineCol =
      ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
  if (ctx->Simple_identifier())
    macroName = ctx->Simple_identifier()->getText();
  else if (ctx->Escaped_identifier()) {
    macroName = ctx->Escaped_identifier()->getText();
    macroName.erase(0, 1);
    StringUtils::rtrim(macroName);
  } else if (ctx->macro_instance()) {
    macroName = m_pp->evaluateMacroInstance(
        ctx->macro_instance()->getText(), m_pp, lineCol.first,
        PreprocessFile::SpecialInstructions::CheckLoop,
        PreprocessFile::SpecialInstructions::ComplainUndefinedMacro);
  }
  item.m_macroName = macroName;
  std::vector<std::string> args;
  if (!m_pp->isMacroBody()) {
    m_pp->getSourceFile()->m_loopChecker.clear();
  }
  PreprocessFile::SpecialInstructions instr = m_pp->m_instructions;
  instr.m_evaluate = PreprocessFile::SpecialInstructions::DontEvaluate;
  std::string macroBody =
      m_pp->getMacro(item.m_macroName, args, m_pp, 0,
                     m_pp->getSourceFile()->m_loopChecker, instr);
  item.m_defined = (macroBody != PreprocessFile::MacroNotDefined);
  item.m_type = PreprocessFile::IfElseItem::IFNDEF;
  item.m_previousActiveState = m_inActiveBranch;
  m_pp->getStack().push_back(item);
  setCurrentBranchActivity(lineCol.first);
}

void SV3_1aPpTreeShapeListener::enterElsif_directive(
    SV3_1aPpParser::Elsif_directiveContext *ctx) {
  PreprocessFile::IfElseItem item;
  std::string macroName;
  std::pair<int, int> lineCol =
      ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
  if (ctx->Simple_identifier())
    macroName = ctx->Simple_identifier()->getText();
  else if (ctx->Escaped_identifier()) {
    macroName = ctx->Escaped_identifier()->getText();
    macroName.erase(0, 1);
    StringUtils::rtrim(macroName);
  } else if (ctx->macro_instance()) {
    macroName = m_pp->evaluateMacroInstance(
        ctx->macro_instance()->getText(), m_pp, lineCol.first,
        PreprocessFile::SpecialInstructions::CheckLoop,
        PreprocessFile::SpecialInstructions::ComplainUndefinedMacro);
  }
  item.m_macroName = macroName;
  bool previousBranchActive = isPreviousBranchActive();
  std::vector<std::string> args;
  if (!m_pp->isMacroBody()) {
    m_pp->getSourceFile()->m_loopChecker.clear();
  }
  PreprocessFile::SpecialInstructions instr = m_pp->m_instructions;
  instr.m_evaluate = PreprocessFile::SpecialInstructions::DontEvaluate;
  std::string macroBody =
      m_pp->getMacro(item.m_macroName, args, m_pp, 0,
                     m_pp->getSourceFile()->m_loopChecker, instr);
  item.m_defined =
      (macroBody != PreprocessFile::MacroNotDefined) && (!previousBranchActive);
  item.m_type = PreprocessFile::IfElseItem::ELSIF;
  m_pp->getStack().push_back(item);
  setCurrentBranchActivity(lineCol.first);
}

void SV3_1aPpTreeShapeListener::enterElse_directive(
    SV3_1aPpParser::Else_directiveContext *ctx) {
  PreprocessFile::IfElseItem item;
  std::pair<int, int> lineCol =
      ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
  bool previousBranchActive = isPreviousBranchActive();
  item.m_defined = !previousBranchActive;
  item.m_type = PreprocessFile::IfElseItem::ELSE;
  m_pp->getStack().push_back(item);
  setCurrentBranchActivity(lineCol.first);
}

void SV3_1aPpTreeShapeListener::enterEndif_directive(
    SV3_1aPpParser::Endif_directiveContext *ctx) {
  PreprocessFile::IfElseStack &stack = m_pp->getStack();
  std::pair<int, int> lineCol =
      ParseUtils::getLineColumn(m_pp->getTokenStream(), ctx);
  if (stack.size()) {
    bool unroll = true;
    if (ctx->One_line_comment()) {
      addLineFiller(ctx);
    }
    while (unroll) {
      PreprocessFile::IfElseItem &item = stack.back();
      switch (item.m_type) {
        case PreprocessFile::IfElseItem::IFDEF:
        case PreprocessFile::IfElseItem::IFNDEF:
          // std::cout << ""STACK SIZE: "" << m_pp->getStack ().size () <<
          // std::endl;
          m_inActiveBranch = item.m_previousActiveState;
          stack.pop_back();
          unroll = false;
          break;
        case PreprocessFile::IfElseItem::ELSIF:
        case PreprocessFile::IfElseItem::ELSE:
          stack.pop_back();
          break;
        default:
          break;
      }
    }
  }
  setCurrentBranchActivity(lineCol.first);
}

void SV3_1aPpTreeShapeListener::enterResetall_directive(
    SV3_1aPpParser::Resetall_directiveContext *ctx) {
  if (m_pp->getCompilationUnit()->isInDesignElement()) {
    std::string directive = ""`resetall"";
    getSymbolTable()->registerSymbol(directive);
    logError(ErrorDefinition::PP_ILLEGAL_DIRECTIVE_IN_DESIGN_ELEMENT, ctx,
             directive);
  }
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterBegin_keywords_directive(
    SV3_1aPpParser::Begin_keywords_directiveContext *ctx) {
  std::string version = ctx->String()->getText();
  if (version == ""\\""1364-1995\\"""") {
    m_pp->setVerilogVersion(Verilog1995);
  } else if (version == ""\\""1364-2001\\"""") {
    m_pp->setVerilogVersion(Verilog2001);
  } else if (version == ""\\""1364-2005\\"""") {
    m_pp->setVerilogVersion(Verilog2005);
  } else if (version == ""\\""1800-2005\\"""") {
    m_pp->setVerilogVersion(Verilog2005);
  } else if (version == ""\\""1800-2009\\"""") {
    m_pp->setVerilogVersion(Verilog2009);
  } else if (version == ""\\""1800-2012\\"""") {
    m_pp->setVerilogVersion(SystemVerilog);
  } else if (version == ""\\""1800-2017\\"""") {
    m_pp->setVerilogVersion(SystemVerilog);
  } else {
    logError(ErrorDefinition::PA_UNSUPPORTED_KEYWORD_LIST, ctx, version);
  }
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterEnd_keywords_directive(
    SV3_1aPpParser::End_keywords_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterCelldefine_directive(
    SV3_1aPpParser::Celldefine_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterEndcelldefine_directive(
    SV3_1aPpParser::Endcelldefine_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterProtect_directive(
    SV3_1aPpParser::Protect_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterEndprotect_directive(
    SV3_1aPpParser::Endprotect_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterProtected_directive(
    SV3_1aPpParser::Protected_directiveContext *ctx) {
  m_inProtectedRegion = true;
  if (m_pp->getCompileSourceFile()
          ->getCommandLineParser()
          ->filterProtectedRegions()) {
    m_filterProtectedRegions = true;
  } else {
    forwardToParser(ctx);
  }
}

void SV3_1aPpTreeShapeListener::enterEndprotected_directive(
    SV3_1aPpParser::Endprotected_directiveContext *ctx) {
  m_inProtectedRegion = false;
  if (!m_pp->getCompileSourceFile()
           ->getCommandLineParser()
           ->filterProtectedRegions())
    forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterExpand_vectornets_directive(
    SV3_1aPpParser::Expand_vectornets_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterNoexpand_vectornets_directive(
    SV3_1aPpParser::Noexpand_vectornets_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterAutoexpand_vectornets_directive(
    SV3_1aPpParser::Autoexpand_vectornets_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterUselib_directive(
    SV3_1aPpParser::Uselib_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterDisable_portfaults_directive(
    SV3_1aPpParser::Disable_portfaults_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterEnable_portfaults_directive(
    SV3_1aPpParser::Enable_portfaults_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterNosuppress_faults_directive(
    SV3_1aPpParser::Nosuppress_faults_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterSuppress_faults_directive(
    SV3_1aPpParser::Suppress_faults_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterSigned_directive(
    SV3_1aPpParser::Signed_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterUnsigned_directive(
    SV3_1aPpParser::Unsigned_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterRemove_gatename_directive(
    SV3_1aPpParser::Remove_gatename_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterNoremove_gatenames_directive(
    SV3_1aPpParser::Noremove_gatenames_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterRemove_netname_directive(
    SV3_1aPpParser::Remove_netname_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterNoremove_netnames_directive(
    SV3_1aPpParser::Noremove_netnames_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterAccelerate_directive(
    SV3_1aPpParser::Accelerate_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterNoaccelerate_directive(
    SV3_1aPpParser::Noaccelerate_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterDefault_trireg_strenght_directive(
    SV3_1aPpParser::Default_trireg_strenght_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterDefault_decay_time_directive(
    SV3_1aPpParser::Default_decay_time_directiveContext *ctx) {
  forwardToParser(ctx);
  m_pp->pauseAppend();
}

void SV3_1aPpTreeShapeListener::exitDefault_decay_time_directive(
    SV3_1aPpParser::Default_decay_time_directiveContext * /*ctx*/) {
  m_pp->resumeAppend();
}

void SV3_1aPpTreeShapeListener::enterUnconnected_drive_directive(
    SV3_1aPpParser::Unconnected_drive_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterNounconnected_drive_directive(
    SV3_1aPpParser::Nounconnected_drive_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterDelay_mode_distributed_directive(
    SV3_1aPpParser::Delay_mode_distributed_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterDelay_mode_path_directive(
    SV3_1aPpParser::Delay_mode_path_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterDelay_mode_unit_directive(
    SV3_1aPpParser::Delay_mode_unit_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterDelay_mode_zero_directive(
    SV3_1aPpParser::Delay_mode_zero_directiveContext *ctx) {
  forwardToParser(ctx);
}

void SV3_1aPpTreeShapeListener::enterUndefineall_directive(
    SV3_1aPpParser::Undefineall_directiveContext * /*ctx*/) {
  std::set<PreprocessFile *> visited;
  if (m_pp->m_debugMacro) std::cout << ""Undefining all macros"" << std::endl;
  m_pp->undefineAllMacros(visited);
}

void SV3_1aPpTreeShapeListener::enterMultiline_no_args_macro_definition(
    SV3_1aPpParser::Multiline_no_args_macro_definitionContext *ctx) {
  if (m_inActiveBranch) {
    std::string macroName;
    if (ctx->Simple_identifier())
      macroName = ctx->Simple_identifier()->getText();
    else if (ctx->Escaped_identifier()) {
      macroName = ctx->Escaped_identifier()->getText();
      macroName.erase(0, 1);
      StringUtils::rtrim(macroName);
    }
    std::pair<int, int> lineCol = ParseUtils::getLineColumn(
        ctx->Simple_identifier() ? ctx->Simple_identifier()
                                 : ctx->Escaped_identifier());

    if (m_pp->m_debugMacro)
      std::cout << ""Defining macro:"" << macroName << std::endl;
    m_inMacroDefinitionParsing = true;
    SV3_1aPpParser::Escaped_macro_definition_bodyContext *cBody =
        ctx->escaped_macro_definition_body();
    std::vector<antlr4::Token *> tokens = ParseUtils::getFlatTokenList(cBody);
    std::vector<std::string> body_tokens;
    for (auto token : tokens) {
      body_tokens.push_back(token->getText());
    }

    checkMultiplyDefinedMacro(macroName, ctx);

    m_pp->recordMacro(macroName, m_pp->getLineNb(lineCol.first), lineCol.second,
                      """", body_tokens);
    addLineFiller(ctx);
  } else {
    addLineFiller(ctx);
  }
}

void SV3_1aPpTreeShapeListener::exitMultiline_no_args_macro_definition(
    SV3_1aPpParser::Multiline_no_args_macro_definitionContext *ctx) {
  m_inMacroDefinitionParsing = false;
  addVObject(ctx, VObjectType::slMacro_definition);
}

void SV3_1aPpTreeShapeListener::enterMultiline_args_macro_definition(
    SV3_1aPpParser::Multiline_args_macro_definitionContext *ctx) {
  if (m_inActiveBranch) {
    std::string macroName;
    if (ctx->Simple_identifier())
      macroName = ctx->Simple_identifier()->getText();
    else if (ctx->Escaped_identifier()) {
      macroName = ctx->Escaped_identifier()->getText();
      macroName.erase(0, 1);
      StringUtils::rtrim(macroName);
    }
    if (m_pp->m_debugMacro)
      std::cout << ""Defining macro:"" << macroName << std::endl;
    m_inMacroDefinitionParsing = true;
    SV3_1aPpParser::Escaped_macro_definition_bodyContext *cBody =
        ctx->escaped_macro_definition_body();
    std::string arguments = ctx->macro_arguments()->getText();
    std::vector<antlr4::Token *> tokens = ParseUtils::getFlatTokenList(cBody);
    std::vector<std::string> body_tokens;
    for (auto token : tokens) {
      body_tokens.push_back(token->getText());
    }
    std::pair<int, int> lineCol = ParseUtils::getLineColumn(
        ctx->Simple_identifier() ? ctx->Simple_identifier()
                                 : ctx->Escaped_identifier());

    checkMultiplyDefinedMacro(macroName, ctx);
    m_pp->recordMacro(macroName, m_pp->getLineNb(lineCol.first), lineCol.second,
                      arguments, body_tokens);
    addLineFiller(ctx);
  } else {
    addLineFiller(ctx);
  }
}

void SV3_1aPpTreeShapeListener::exitMultiline_args_macro_definition(
    SV3_1aPpParser::Multiline_args_macro_definitionContext *ctx) {
  m_inMacroDefinitionParsing = false;
  addVObject(ctx, VObjectType::slMacro_definition);
}

void SV3_1aPpTreeShapeListener::enterSimple_args_macro_definition(
    SV3_1aPpParser::Simple_args_macro_definitionContext *ctx) {
  if (m_inActiveBranch) {
    std::string macroName;
    if (ctx->Simple_identifier())
      macroName = ctx->Simple_identifier()->getText();
    else if (ctx->Escaped_identifier()) {
      macroName = ctx->Escaped_identifier()->getText();
      macroName.erase(0, 1);
      StringUtils::rtrim(macroName);
    }
    if (m_pp->m_debugMacro)
      std::cout << ""Defining macro:"" << macroName << std::endl;
    m_inMacroDefinitionParsing = true;
    // std::string wholeMacro = ctx->getText();
    SV3_1aPpParser::Simple_macro_definition_bodyContext *cBody =
        ctx->simple_macro_definition_body();
    std::string arguments = ctx->macro_arguments()->getText();
    std::vector<antlr4::Token *> tokens = ParseUtils::getFlatTokenList(cBody);
    std::vector<std::string> body_tokens;
    for (auto token : tokens) {
      body_tokens.push_back(token->getText());
    }
    std::pair<int, int> lineCol = ParseUtils::getLineColumn(
        ctx->Simple_identifier() ? ctx->Simple_identifier()
                                 : ctx->Escaped_identifier());
    checkMultiplyDefinedMacro(macroName, ctx);
    m_pp->recordMacro(macroName, m_pp->getLineNb(lineCol.first), lineCol.second,
                      arguments, body_tokens);
    addLineFiller(ctx);
  } else {
    addLineFiller(ctx);
  }
}

void SV3_1aPpTreeShapeListener::exitSimple_args_macro_definition(
    SV3_1aPpParser::Simple_args_macro_definitionContext *ctx) {
  m_inMacroDefinitionParsing = false;
  addVObject(ctx, VObjectType::slMacro_definition);
}

void SV3_1aPpTreeShapeListener::enterText_blob(
    SV3_1aPpParser::Text_blobContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion))) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
  } else {
    addLineFiller(ctx);
  }
}

void SV3_1aPpTreeShapeListener::exitText_blob(
    SV3_1aPpParser::Text_blobContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion))) {
    if (ctx->Simple_identifier()) {
      addVObject(ctx, ctx->Simple_identifier()->getText(),
                 VObjectType::slPs_identifier);
    } else if (ctx->number()) {
      addVObject(ctx, ctx->number()->getText(), VObjectType::slNumber);
    } else if (ctx->CR()) {
      addVObject(ctx, VObjectType::slCR);
    } else if (ctx->Spaces()) {
      addVObject(ctx, VObjectType::slSpaces);
    } else if (ctx->Fixed_point_number()) {
      addVObject(ctx, ctx->Fixed_point_number()->getText(),
                 VObjectType::slNumber);
    } else if (ctx->ESCAPED_CR()) {
      addVObject(ctx, VObjectType::slEscapedCR);
    } else if (ctx->String()) {
      addVObject(ctx, ctx->ESCAPED_CR()->getText(), VObjectType::slString);
    } else if (ctx->PARENS_OPEN()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->PARENS_CLOSE()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->COMMA()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->EQUAL_OP()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->DOUBLE_QUOTE()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->Special()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->CURLY_OPEN()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->CURLY_CLOSE()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->SQUARE_OPEN()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->SQUARE_CLOSE()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->TICK_TICK()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->TICK_VARIABLE()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->TIMESCALE()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->ANY()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->pound_delay()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->pound_pound_delay()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->TICK_QUOTE()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->TICK_BACKSLASH_TICK_QUOTE()) {
      addVObject(ctx, ctx->getText(), VObjectType::slText_blob);
    } else if (ctx->TEXT_CR()) {
      addVObject(ctx, VObjectType::slCR);
    }
  }
}

void SV3_1aPpTreeShapeListener::enterModule(
    SV3_1aPpParser::ModuleContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->setInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterEndmodule(
    SV3_1aPpParser::EndmoduleContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->unsetInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterSv_interface(
    SV3_1aPpParser::Sv_interfaceContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->setInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterEndinterface(
    SV3_1aPpParser::EndinterfaceContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->unsetInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterProgram(
    SV3_1aPpParser::ProgramContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->setInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterEndprogram(
    SV3_1aPpParser::EndprogramContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->unsetInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterPrimitive(
    SV3_1aPpParser::PrimitiveContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->setInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterEndprimitive(
    SV3_1aPpParser::EndprimitiveContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->unsetInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterSv_package(
    SV3_1aPpParser::Sv_packageContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->setInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterEndpackage(
    SV3_1aPpParser::EndpackageContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->unsetInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterChecker(
    SV3_1aPpParser::CheckerContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->setInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterEndchecker(
    SV3_1aPpParser::EndcheckerContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->unsetInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterConfig(
    SV3_1aPpParser::ConfigContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->setInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterEndconfig(
    SV3_1aPpParser::EndconfigContext *ctx) {
  if (m_inActiveBranch &&
      (!(m_filterProtectedRegions && m_inProtectedRegion)) &&
      (!m_inMacroDefinitionParsing)) {
    std::string text_blob = ctx->getText();
    m_pp->append(text_blob);
    m_pp->getCompilationUnit()->unsetInDesignElement();
  }
}

void SV3_1aPpTreeShapeListener::enterElseif_directive(
    SV3_1aPpParser::Elseif_directiveContext *ctx) {
  logError(ErrorDefinition::PP_ILLEGAL_DIRECTIVE_ELSEIF, ctx, """");
}

void SV3_1aPpTreeShapeListener::enterEveryRule(antlr4::ParserRuleContext *ctx) {
}
void SV3_1aPpTreeShapeListener::exitEveryRule(antlr4::ParserRuleContext *ctx) {}
void SV3_1aPpTreeShapeListener::visitTerminal(
    antlr4::tree::TerminalNode *node) {}
void SV3_1aPpTreeShapeListener::visitErrorNode(antlr4::tree::ErrorNode *node) {}
}  // namespace SURELOG
",16301,True,3936.1054487048427,median
"CLASS zcl_excel_drawing DEFINITION
  PUBLIC
  FINAL
  CREATE PUBLIC .

  PUBLIC SECTION.
*""* public components of class ZCL_EXCEL_DRAWING
*""* do not include other source files here!!!
*""* protected components of class ZCL_EXCEL_DRAWING
*""* do not include other source files here!!!
*""* protected components of class ZCL_EXCEL_DRAWING
*""* do not include other source files here!!!
*""* protected components of class ZCL_EXCEL_DRAWING
*""* do not include other source files here!!!
    TYPE-POOLS abap .

    CONSTANTS c_graph_pie TYPE zexcel_graph_type VALUE 1.   ""#EC NOTEXT
    CONSTANTS c_graph_line TYPE zexcel_graph_type VALUE 2.  ""#EC NOTEXT
    CONSTANTS c_graph_bars TYPE zexcel_graph_type VALUE 0.  ""#EC NOTEXT
    DATA graph_type TYPE zexcel_graph_type .
    DATA title TYPE string VALUE 'image1.jpg'.              ""#EC NOTEXT
    CONSTANTS type_image TYPE zexcel_drawing_type VALUE 'image'. ""#EC NOTEXT
    CONSTANTS type_chart TYPE zexcel_drawing_type VALUE 'chart'. ""#EC NOTEXT
    CONSTANTS anchor_absolute TYPE zexcel_drawing_anchor VALUE 'ABS'. ""#EC NOTEXT
    CONSTANTS anchor_one_cell TYPE zexcel_drawing_anchor VALUE 'ONE'. ""#EC NOTEXT
    CONSTANTS anchor_two_cell TYPE zexcel_drawing_anchor VALUE 'TWO'. ""#EC NOTEXT
    DATA graph TYPE REF TO zcl_excel_graph .
    CONSTANTS c_media_type_bmp TYPE string VALUE 'bmp'.     ""#EC NOTEXT
    CONSTANTS c_media_type_xml TYPE string VALUE 'xml'.     ""#EC NOTEXT
    CONSTANTS c_media_type_jpg TYPE string VALUE 'jpg'.     ""#EC NOTEXT
    CONSTANTS type_image_header_footer TYPE zexcel_drawing_type VALUE 'hd_ft'. ""#EC NOTEXT

    METHODS constructor
      IMPORTING
        !ip_type  TYPE zexcel_drawing_type DEFAULT zcl_excel_drawing=>type_image
        !ip_title TYPE clike OPTIONAL .
    METHODS create_media_name
      IMPORTING
        !ip_index TYPE i .
    METHODS get_from_col
      RETURNING
        VALUE(r_from_col) TYPE zexcel_cell_column .
    METHODS get_from_row
      RETURNING
        VALUE(r_from_row) TYPE zexcel_cell_row .
    METHODS get_guid
      RETURNING
        VALUE(ep_guid) TYPE guid_16 .
    METHODS get_height_emu_str
      RETURNING
        VALUE(r_height) TYPE string .
    METHODS get_media
      RETURNING
        VALUE(r_media) TYPE xstring .
    METHODS get_media_name
      RETURNING
        VALUE(r_name) TYPE string .
    METHODS get_media_type
      RETURNING
        VALUE(r_type) TYPE string .
    METHODS get_name
      RETURNING
        VALUE(r_name) TYPE string .
    METHODS get_to_col
      RETURNING
        VALUE(r_to_col) TYPE zexcel_cell_column .
    METHODS get_to_row
      RETURNING
        VALUE(r_to_row) TYPE zexcel_cell_row .
    METHODS get_width_emu_str
      RETURNING
        VALUE(r_width) TYPE string .
    CLASS-METHODS pixel2emu
      IMPORTING
        !ip_pixel    TYPE int4
        !ip_dpi      TYPE int2 OPTIONAL
      RETURNING
        VALUE(r_emu) TYPE string .
    CLASS-METHODS emu2pixel
      IMPORTING
        !ip_emu        TYPE int4
        !ip_dpi        TYPE int2 OPTIONAL
      RETURNING
        VALUE(r_pixel) TYPE int4 .
    METHODS set_media
      IMPORTING
        !ip_media      TYPE xstring OPTIONAL
        !ip_media_type TYPE string
        !ip_width      TYPE int4 DEFAULT 0
        !ip_height     TYPE int4 DEFAULT 0 .
    METHODS set_media_mime
      IMPORTING
        !ip_io     TYPE skwf_io
        !ip_width  TYPE int4
        !ip_height TYPE int4 .
    METHODS set_media_www
      IMPORTING
        !ip_key    TYPE wwwdatatab
        !ip_width  TYPE int4
        !ip_height TYPE int4 .
    METHODS set_position
      IMPORTING
        !ip_from_row TYPE zexcel_cell_row
        !ip_from_col TYPE zexcel_cell_column_alpha
        !ip_rowoff   TYPE int4 OPTIONAL
        !ip_coloff   TYPE int4 OPTIONAL
      RAISING
        zcx_excel .
    METHODS set_position2
      IMPORTING
        !ip_from   TYPE zexcel_drawing_location
        !ip_to     TYPE zexcel_drawing_location
        !ip_anchor TYPE zexcel_drawing_anchor OPTIONAL .
    METHODS get_position
      RETURNING
        VALUE(rp_position) TYPE zexcel_drawing_position .
    METHODS get_type
      RETURNING
        VALUE(rp_type) TYPE zexcel_drawing_type .
    METHODS get_index
      RETURNING
        VALUE(rp_index) TYPE string .
    METHODS load_chart_attributes
      IMPORTING
        VALUE(ip_chart) TYPE REF TO if_ixml_document .
  PROTECTED SECTION.
  PRIVATE SECTION.

*""* private components of class ZCL_EXCEL_DRAWING
*""* do not include other source files here!!!
    DATA type TYPE zexcel_drawing_type VALUE type_image. ""#EC NOTEXT .  .  .  .  .  .  .  .  .  .  . "" .
    DATA index TYPE string .
    DATA anchor TYPE zexcel_drawing_anchor VALUE anchor_one_cell. ""#EC NOTEXT .  .  .  .  .  .  .  .  .  .  . "" .
    CONSTANTS c_media_source_www TYPE c VALUE 1.            ""#EC NOTEXT
    CONSTANTS c_media_source_xstring TYPE c VALUE 0.        ""#EC NOTEXT
    CONSTANTS c_media_source_mime TYPE c VALUE 2.           ""#EC NOTEXT
    DATA guid TYPE guid_16 .
    DATA media TYPE xstring .
    DATA media_key_www TYPE wwwdatatab .
    DATA media_name TYPE string .
    DATA media_source TYPE c .
    DATA media_type TYPE string .
    DATA io TYPE skwf_io .
    DATA from_loc TYPE zexcel_drawing_location .
    DATA to_loc TYPE zexcel_drawing_location .
    DATA size TYPE zexcel_drawing_size .
ENDCLASS.



CLASS zcl_excel_drawing IMPLEMENTATION.


  METHOD constructor.

*  CALL FUNCTION 'GUID_CREATE'                                  "" del issue #379 - function is outdated in newer releases
*    IMPORTING
*      ev_guid_16 = me->guid.
    me->guid = zcl_excel_obsolete_func_wrap=>guid_create( ).      "" ins issue #379 - replacement for outdated function call

    IF ip_title IS NOT INITIAL.
      title = ip_title.
    ELSE.
      title = me->guid.
    ENDIF.

    me->type = ip_type.

* inizialize dimension range
    anchor = anchor_one_cell.
    from_loc-col = 1.
    from_loc-row = 1.
  ENDMETHOD.


  METHOD create_media_name.

* if media name is initial, create unique name
    CHECK media_name IS INITIAL.

    index = ip_index.
    CONCATENATE me->type index INTO media_name.
    CONDENSE media_name NO-GAPS.
  ENDMETHOD.


  METHOD emu2pixel.
* suppose 96 DPI
    IF ip_dpi IS SUPPLIED.
*    r_emu = ip_pixel  * 914400 / ip_dpi.
      r_pixel = ip_emu * ip_dpi / 914400.
    ELSE.
* suppose 96 DPI
*    r_emu = ip_pixel  * 914400 / 96.
      r_pixel = ip_emu * 96 / 914400.
    ENDIF.
  ENDMETHOD.


  METHOD get_from_col.
    r_from_col = me->from_loc-col.
  ENDMETHOD.


  METHOD get_from_row.
    r_from_row = me->from_loc-row.
  ENDMETHOD.


  METHOD get_guid.

    ep_guid = me->guid.

  ENDMETHOD.


  METHOD get_height_emu_str.
    r_height = pixel2emu( size-height ).
    CONDENSE r_height NO-GAPS.
  ENDMETHOD.


  METHOD get_index.
    rp_index = me->index.
  ENDMETHOD.


  METHOD get_media.

    DATA: lv_language TYPE sylangu.
    DATA: lt_bin_mime TYPE sdokcntbins.
    DATA: lt_mime          TYPE tsfmime,
          lv_filesize      TYPE i,
          lv_filesizec(10).

    CASE media_source.
      WHEN c_media_source_xstring.
        r_media = media.
      WHEN c_media_source_www.
        CALL FUNCTION 'WWWDATA_IMPORT'
          EXPORTING
            key    = media_key_www
          TABLES
            mime   = lt_mime
          EXCEPTIONS
            OTHERS = 1.

        CALL FUNCTION 'WWWPARAMS_READ'
          EXPORTING
            relid = media_key_www-relid
            objid = media_key_www-objid
            name  = 'filesize'
          IMPORTING
            value = lv_filesizec.

        lv_filesize = lv_filesizec.
        CALL FUNCTION 'SCMS_BINARY_TO_XSTRING'
          EXPORTING
            input_length = lv_filesize
          IMPORTING
            buffer       = r_media
          TABLES
            binary_tab   = lt_mime
          EXCEPTIONS
            failed       = 1
            OTHERS       = 2.
      WHEN c_media_source_mime.
        lv_language = sy-langu.
        cl_wb_mime_repository=>load_mime( EXPORTING
                                            io        = me->io
                                          IMPORTING
                                            filesize  = lv_filesize
                                            bin_data  = lt_bin_mime
                                          CHANGING
                                            language  = lv_language ).

        CALL FUNCTION 'SCMS_BINARY_TO_XSTRING'
          EXPORTING
            input_length = lv_filesize
          IMPORTING
            buffer       = r_media
          TABLES
            binary_tab   = lt_bin_mime
          EXCEPTIONS
            failed       = 1
            OTHERS       = 2.
    ENDCASE.
  ENDMETHOD.


  METHOD get_media_name.
    CONCATENATE media_name  `.` media_type INTO r_name.
  ENDMETHOD.


  METHOD get_media_type.
    r_type = media_type.
  ENDMETHOD.


  METHOD get_name.
    r_name = title.
  ENDMETHOD.


  METHOD get_position.
    rp_position-anchor = anchor.
    rp_position-from = from_loc.
    rp_position-to = to_loc.
    rp_position-size = size.
  ENDMETHOD.


  METHOD get_to_col.
    r_to_col = me->to_loc-col.
  ENDMETHOD.


  METHOD get_to_row.
    r_to_row = me->to_loc-row.
  ENDMETHOD.


  METHOD get_type.
    rp_type = me->type.
  ENDMETHOD.


  METHOD get_width_emu_str.
    r_width = pixel2emu( size-width ).
    CONDENSE r_width NO-GAPS.
  ENDMETHOD.


  METHOD load_chart_attributes.
    DATA: node                TYPE REF TO if_ixml_element.
    DATA: node2               TYPE REF TO if_ixml_element.
    DATA: node3               TYPE REF TO if_ixml_element.
    DATA: node4               TYPE REF TO if_ixml_element.

    DATA lo_barchart TYPE REF TO zcl_excel_graph_bars.
    DATA lo_piechart TYPE REF TO zcl_excel_graph_pie.
    DATA lo_linechart TYPE REF TO zcl_excel_graph_line.

    TYPES: BEGIN OF t_prop,
             val          TYPE string,
             rtl          TYPE string,
             lang         TYPE string,
             formatcode   TYPE string,
             sourcelinked TYPE string,
           END OF t_prop.

    TYPES: BEGIN OF t_pagemargins,
             b      TYPE string,
             l      TYPE string,
             r      TYPE string,
             t      TYPE string,
             header TYPE string,
             footer TYPE string,
           END OF t_pagemargins.

    DATA ls_prop TYPE t_prop.
    DATA ls_pagemargins TYPE t_pagemargins.

    DATA lo_collection TYPE REF TO if_ixml_node_collection.
    DATA lo_node       TYPE REF TO if_ixml_node.
    DATA lo_iterator   TYPE REF TO if_ixml_node_iterator.
    DATA lv_idx        TYPE i.
    DATA lv_order      TYPE i.
    DATA lv_invertifnegative      TYPE string.
    DATA lv_symbol      TYPE string.
    DATA lv_smooth      TYPE c.
    DATA lv_sername    TYPE string.
    DATA lv_label      TYPE string.
    DATA lv_value      TYPE string.
    DATA lv_axid       TYPE string.
    DATA lv_orientation TYPE string.
    DATA lv_delete TYPE string.
    DATA lv_axpos TYPE string.
    DATA lv_formatcode TYPE string.
    DATA lv_sourcelinked TYPE string.
    DATA lv_majortickmark TYPE string.
    DATA lv_minortickmark TYPE string.
    DATA lv_ticklblpos TYPE string.
    DATA lv_crossax TYPE string.
    DATA lv_crosses TYPE string.
    DATA lv_auto TYPE string.
    DATA lv_lblalgn TYPE string.
    DATA lv_lbloffset TYPE string.
    DATA lv_nomultilvllbl TYPE string.
    DATA lv_crossbetween TYPE string.

    node ?= ip_chart->if_ixml_node~get_first_child( ).
    CHECK node IS NOT INITIAL.

    CASE me->graph_type.
      WHEN c_graph_bars.
        CREATE OBJECT lo_barchart.
        me->graph = lo_barchart.
      WHEN c_graph_pie.
        CREATE OBJECT lo_piechart.
        me->graph = lo_piechart.
      WHEN c_graph_line.
        CREATE OBJECT lo_linechart.
        me->graph = lo_linechart.
      WHEN OTHERS.
    ENDCASE.

    ""Fill properties
    node2 ?= node->find_from_name( name = 'date1904' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_1904val = ls_prop-val.
    node2 ?= node->find_from_name( name = 'lang' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_langval = ls_prop-val.
    node2 ?= node->find_from_name( name = 'roundedCorners' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_roundedcornersval = ls_prop-val.

    ""style
    node2 ?= node->find_from_name( name = 'style' namespace = 'c14' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_c14styleval = ls_prop-val.
    node2 ?= node->find_from_name( name = 'style' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_styleval = ls_prop-val.
    ""---------------------------Read graph properties
    ""ADDED
    CLEAR node2.
    node2 ?= node->find_from_name( name = 'title' namespace = 'c' ).
    IF node2 IS BOUND AND node2 IS NOT INITIAL.
      node3 ?= node2->find_from_name( name = 't' namespace = 'a' ).
      me->graph->title = node3->get_value( ).
    ENDIF.
    ""END

    node2 ?= node->find_from_name( name = 'autoTitleDeleted' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_autotitledeletedval = ls_prop-val.

    ""plotArea
    CASE me->graph_type.
      WHEN c_graph_bars.
        node2 ?= node->find_from_name( name = 'barDir' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_bardirval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'grouping' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_groupingval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'varyColors' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_varycolorsval = ls_prop-val.

        ""Load series
        CALL METHOD node->get_elements_by_tag_name
          EXPORTING
*           depth     = 0
            name = 'ser'
*           namespace = ''
          RECEIVING
            rval = lo_collection.
        CALL METHOD lo_collection->create_iterator
          RECEIVING
            rval = lo_iterator.
        lo_node = lo_iterator->get_next( ).
        IF lo_node IS BOUND.
          node2 ?= lo_node->query_interface( ixml_iid_element ).
        ENDIF.
        WHILE lo_node IS BOUND.
          node3 ?= node2->find_from_name( name = 'idx' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_idx = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'order' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_order = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'invertIfNegative' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_invertifnegative = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'v' namespace = 'c' ).
          IF node3 IS BOUND.
            lv_sername = node3->get_value( ).
          ENDIF.
          node3 ?= node2->find_from_name( name = 'strRef' namespace = 'c' ).
          IF node3 IS BOUND.
            node4 ?= node3->find_from_name( name = 'f' namespace = 'c' ).
            lv_label = node4->get_value( ).
          ENDIF.
          node3 ?= node2->find_from_name( name = 'numRef' namespace = 'c' ).
          IF node3 IS BOUND.
            node4 ?= node3->find_from_name( name = 'f' namespace = 'c' ).
            lv_value = node4->get_value( ).
          ENDIF.
          CALL METHOD lo_barchart->create_serie
            EXPORTING
              ip_idx              = lv_idx
              ip_order            = lv_order
              ip_invertifnegative = lv_invertifnegative
              ip_lbl              = lv_label
              ip_ref              = lv_value
              ip_sername          = lv_sername.
          lo_node = lo_iterator->get_next( ).
          IF lo_node IS BOUND.
            node2 ?= lo_node->query_interface( ixml_iid_element ).
          ENDIF.
        ENDWHILE.
        ""note: numCache avoided
        node2 ?= node->find_from_name( name = 'showLegendKey' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_showlegendkeyval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showVal' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_showvalval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showCatName' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_showcatnameval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showSerName' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_showsernameval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showPercent' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_showpercentval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showBubbleSize' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_showbubblesizeval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'gapWidth' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_barchart->ns_gapwidthval = ls_prop-val.

        ""Load axes
        node2 ?= node->find_from_name( name = 'barChart' namespace = 'c' ).
        CALL METHOD node2->get_elements_by_tag_name
          EXPORTING
*           depth     = 0
            name = 'axId'
*           namespace = ''
          RECEIVING
            rval = lo_collection.
        CALL METHOD lo_collection->create_iterator
          RECEIVING
            rval = lo_iterator.
        lo_node = lo_iterator->get_next( ).
        IF lo_node IS BOUND.
          node2 ?= lo_node->query_interface( ixml_iid_element ).
        ENDIF.
        WHILE lo_node IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lv_axid = ls_prop-val.
          IF sy-index EQ 1. ""catAx
            node2 ?= node->find_from_name( name = 'catAx' namespace = 'c' ).
            node3 ?= node2->find_from_name( name = 'orientation' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_orientation = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'delete' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_delete = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'axPos' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_axpos = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'numFmt' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_formatcode = ls_prop-formatcode.
            lv_sourcelinked = ls_prop-sourcelinked.
            node3 ?= node2->find_from_name( name = 'majorTickMark' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_majortickmark = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'majorTickMark' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_minortickmark = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'tickLblPos' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_ticklblpos = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crossAx' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crossax = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crosses' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crosses = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'auto' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_auto = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'lblAlgn' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_lblalgn = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'lblOffset' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_lbloffset = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'noMultiLvlLbl' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_nomultilvllbl = ls_prop-val.
            CALL METHOD lo_barchart->create_ax
              EXPORTING
                ip_axid          = lv_axid
                ip_type          = zcl_excel_graph_bars=>c_catax
                ip_orientation   = lv_orientation
                ip_delete        = lv_delete
                ip_axpos         = lv_axpos
                ip_formatcode    = lv_formatcode
                ip_sourcelinked  = lv_sourcelinked
                ip_majortickmark = lv_majortickmark
                ip_minortickmark = lv_minortickmark
                ip_ticklblpos    = lv_ticklblpos
                ip_crossax       = lv_crossax
                ip_crosses       = lv_crosses
                ip_auto          = lv_auto
                ip_lblalgn       = lv_lblalgn
                ip_lbloffset     = lv_lbloffset
                ip_nomultilvllbl = lv_nomultilvllbl.
          ELSEIF sy-index EQ 2. ""valAx
            node2 ?= node->find_from_name( name = 'valAx' namespace = 'c' ).
            node3 ?= node2->find_from_name( name = 'orientation' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_orientation = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'delete' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_delete = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'axPos' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_axpos = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'numFmt' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_formatcode = ls_prop-formatcode.
            lv_sourcelinked = ls_prop-sourcelinked.
            node3 ?= node2->find_from_name( name = 'majorTickMark' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_majortickmark = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'majorTickMark' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_minortickmark = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'tickLblPos' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_ticklblpos = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crossAx' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crossax = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crosses' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crosses = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crossBetween' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crossbetween = ls_prop-val.
            CALL METHOD lo_barchart->create_ax
              EXPORTING
                ip_axid          = lv_axid
                ip_type          = zcl_excel_graph_bars=>c_valax
                ip_orientation   = lv_orientation
                ip_delete        = lv_delete
                ip_axpos         = lv_axpos
                ip_formatcode    = lv_formatcode
                ip_sourcelinked  = lv_sourcelinked
                ip_majortickmark = lv_majortickmark
                ip_minortickmark = lv_minortickmark
                ip_ticklblpos    = lv_ticklblpos
                ip_crossax       = lv_crossax
                ip_crosses       = lv_crosses
                ip_crossbetween  = lv_crossbetween.
          ENDIF.
          lo_node = lo_iterator->get_next( ).
          IF lo_node IS BOUND.
            node2 ?= lo_node->query_interface( ixml_iid_element ).
          ENDIF.
        ENDWHILE.

      WHEN c_graph_pie.
        node2 ?= node->find_from_name( name = 'varyColors' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_varycolorsval = ls_prop-val.

        ""Load series
        CALL METHOD node->get_elements_by_tag_name
          EXPORTING
*           depth     = 0
            name = 'ser'
*           namespace = ''
          RECEIVING
            rval = lo_collection.
        CALL METHOD lo_collection->create_iterator
          RECEIVING
            rval = lo_iterator.
        lo_node = lo_iterator->get_next( ).
        IF lo_node IS BOUND.
          node2 ?= lo_node->query_interface( ixml_iid_element ).
        ENDIF.
        WHILE lo_node IS BOUND.
          node3 ?= node2->find_from_name( name = 'idx' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_idx = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'order' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_order = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'v' namespace = 'c' ).
          IF node3 IS BOUND.
            lv_sername = node3->get_value( ).
          ENDIF.
          node3 ?= node2->find_from_name( name = 'strRef' namespace = 'c' ).
          IF node3 IS BOUND.
            node4 ?= node3->find_from_name( name = 'f' namespace = 'c' ).
            lv_label = node4->get_value( ).
          ENDIF.
          node3 ?= node2->find_from_name( name = 'numRef' namespace = 'c' ).
          IF node3 IS BOUND.
            node4 ?= node3->find_from_name( name = 'f' namespace = 'c' ).
            lv_value = node4->get_value( ).
          ENDIF.
          CALL METHOD lo_piechart->create_serie
            EXPORTING
              ip_idx     = lv_idx
              ip_order   = lv_order
              ip_lbl     = lv_label
              ip_ref     = lv_value
              ip_sername = lv_sername.
          lo_node = lo_iterator->get_next( ).
          IF lo_node IS BOUND.
            node2 ?= lo_node->query_interface( ixml_iid_element ).
          ENDIF.
        ENDWHILE.

        ""note: numCache avoided
        node2 ?= node->find_from_name( name = 'showLegendKey' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_showlegendkeyval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showVal' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_showvalval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showCatName' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_showcatnameval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showSerName' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_showsernameval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showPercent' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_showpercentval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showBubbleSize' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_showbubblesizeval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showLeaderLines' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_showleaderlinesval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'firstSliceAng' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_firstsliceangval = ls_prop-val.
      WHEN c_graph_line.
        node2 ?= node->find_from_name( name = 'grouping' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_groupingval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'varyColors' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_varycolorsval = ls_prop-val.

        ""Load series
        CALL METHOD node->get_elements_by_tag_name
          EXPORTING
*           depth     = 0
            name = 'ser'
*           namespace = ''
          RECEIVING
            rval = lo_collection.
        CALL METHOD lo_collection->create_iterator
          RECEIVING
            rval = lo_iterator.
        lo_node = lo_iterator->get_next( ).
        IF lo_node IS BOUND.
          node2 ?= lo_node->query_interface( ixml_iid_element ).
        ENDIF.
        WHILE lo_node IS BOUND.
          node3 ?= node2->find_from_name( name = 'idx' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_idx = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'order' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_order = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'symbol' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_symbol = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'smooth' namespace = 'c' ).
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
          lv_smooth = ls_prop-val.
          node3 ?= node2->find_from_name( name = 'v' namespace = 'c' ).
          IF node3 IS BOUND.
            lv_sername = node3->get_value( ).
          ENDIF.
          node3 ?= node2->find_from_name( name = 'strRef' namespace = 'c' ).
          IF node3 IS BOUND.
            node4 ?= node3->find_from_name( name = 'f' namespace = 'c' ).
            lv_label = node4->get_value( ).
          ENDIF.
          node3 ?= node2->find_from_name( name = 'numRef' namespace = 'c' ).
          IF node3 IS BOUND.
            node4 ?= node3->find_from_name( name = 'f' namespace = 'c' ).
            lv_value = node4->get_value( ).
          ENDIF.
          CALL METHOD lo_linechart->create_serie
            EXPORTING
              ip_idx     = lv_idx
              ip_order   = lv_order
              ip_symbol  = lv_symbol
              ip_smooth  = lv_smooth
              ip_lbl     = lv_label
              ip_ref     = lv_value
              ip_sername = lv_sername.
          lo_node = lo_iterator->get_next( ).
          IF lo_node IS BOUND.
            node2 ?= lo_node->query_interface( ixml_iid_element ).
          ENDIF.
        ENDWHILE.
        ""note: numCache avoided
        node2 ?= node->find_from_name( name = 'showLegendKey' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_showlegendkeyval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showVal' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_showvalval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showCatName' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_showcatnameval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showSerName' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_showsernameval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showPercent' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_showpercentval = ls_prop-val.
        node2 ?= node->find_from_name( name = 'showBubbleSize' namespace = 'c' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_showbubblesizeval = ls_prop-val.

        node ?= node->find_from_name( name = 'lineChart' namespace = 'c' ).
        node2 ?= node->find_from_name( name = 'marker' namespace = 'c' depth = '1' ).
        IF node2 IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lo_linechart->ns_markerval = ls_prop-val.
        ENDIF.
        node2 ?= node->find_from_name( name = 'smooth' namespace = 'c' depth = '1' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_linechart->ns_smoothval = ls_prop-val.
        node ?= ip_chart->if_ixml_node~get_first_child( ).
        CHECK node IS NOT INITIAL.

        ""Load axes
        node2 ?= node->find_from_name( name = 'lineChart' namespace = 'c' ).
        CALL METHOD node2->get_elements_by_tag_name
          EXPORTING
*           depth     = 0
            name = 'axId'
*           namespace = ''
          RECEIVING
            rval = lo_collection.
        CALL METHOD lo_collection->create_iterator
          RECEIVING
            rval = lo_iterator.
        lo_node = lo_iterator->get_next( ).
        IF lo_node IS BOUND.
          node2 ?= lo_node->query_interface( ixml_iid_element ).
        ENDIF.
        WHILE lo_node IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lv_axid = ls_prop-val.
          IF sy-index EQ 1. ""catAx
            node2 ?= node->find_from_name( name = 'catAx' namespace = 'c' ).
            node3 ?= node2->find_from_name( name = 'orientation' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_orientation = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'delete' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_delete = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'axPos' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_axpos = ls_prop-val.
*          node3 ?= node2->find_from_name( name = 'numFmt' namespace = 'c' ).
*          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
*          lv_formatcode = ls_prop-formatcode.
*          lv_sourcelinked = ls_prop-sourcelinked.
            node3 ?= node2->find_from_name( name = 'majorTickMark' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_majortickmark = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'majorTickMark' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_minortickmark = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'tickLblPos' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_ticklblpos = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crossAx' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crossax = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crosses' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crosses = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'auto' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_auto = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'lblAlgn' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_lblalgn = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'lblOffset' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_lbloffset = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'noMultiLvlLbl' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_nomultilvllbl = ls_prop-val.
            CALL METHOD lo_linechart->create_ax
              EXPORTING
                ip_axid          = lv_axid
                ip_type          = zcl_excel_graph_line=>c_catax
                ip_orientation   = lv_orientation
                ip_delete        = lv_delete
                ip_axpos         = lv_axpos
                ip_formatcode    = lv_formatcode
                ip_sourcelinked  = lv_sourcelinked
                ip_majortickmark = lv_majortickmark
                ip_minortickmark = lv_minortickmark
                ip_ticklblpos    = lv_ticklblpos
                ip_crossax       = lv_crossax
                ip_crosses       = lv_crosses
                ip_auto          = lv_auto
                ip_lblalgn       = lv_lblalgn
                ip_lbloffset     = lv_lbloffset
                ip_nomultilvllbl = lv_nomultilvllbl.
          ELSEIF sy-index EQ 2. ""valAx
            node2 ?= node->find_from_name( name = 'valAx' namespace = 'c' ).
            node3 ?= node2->find_from_name( name = 'orientation' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_orientation = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'delete' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_delete = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'axPos' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_axpos = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'numFmt' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_formatcode = ls_prop-formatcode.
            lv_sourcelinked = ls_prop-sourcelinked.
            node3 ?= node2->find_from_name( name = 'majorTickMark' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_majortickmark = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'majorTickMark' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_minortickmark = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'tickLblPos' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_ticklblpos = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crossAx' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crossax = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crosses' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crosses = ls_prop-val.
            node3 ?= node2->find_from_name( name = 'crossBetween' namespace = 'c' ).
            zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node3 CHANGING cp_structure = ls_prop ).
            lv_crossbetween = ls_prop-val.
            CALL METHOD lo_linechart->create_ax
              EXPORTING
                ip_axid          = lv_axid
                ip_type          = zcl_excel_graph_line=>c_valax
                ip_orientation   = lv_orientation
                ip_delete        = lv_delete
                ip_axpos         = lv_axpos
                ip_formatcode    = lv_formatcode
                ip_sourcelinked  = lv_sourcelinked
                ip_majortickmark = lv_majortickmark
                ip_minortickmark = lv_minortickmark
                ip_ticklblpos    = lv_ticklblpos
                ip_crossax       = lv_crossax
                ip_crosses       = lv_crosses
                ip_crossbetween  = lv_crossbetween.
          ENDIF.
          lo_node = lo_iterator->get_next( ).
          IF lo_node IS BOUND.
            node2 ?= lo_node->query_interface( ixml_iid_element ).
          ENDIF.
        ENDWHILE.
      WHEN OTHERS.
    ENDCASE.

    ""legend
    CASE me->graph_type.
      WHEN c_graph_bars.
        node2 ?= node->find_from_name( name = 'legendPos' namespace = 'c' ).
        IF node2 IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lo_barchart->ns_legendposval = ls_prop-val.
        ENDIF.
        node2 ?= node->find_from_name( name = 'overlay' namespace = 'c' ).
        IF node2 IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lo_barchart->ns_overlayval = ls_prop-val.
        ENDIF.
      WHEN c_graph_line.
        node2 ?= node->find_from_name( name = 'legendPos' namespace = 'c' ).
        IF node2 IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lo_linechart->ns_legendposval = ls_prop-val.
        ENDIF.
        node2 ?= node->find_from_name( name = 'overlay' namespace = 'c' ).
        IF node2 IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lo_linechart->ns_overlayval = ls_prop-val.
        ENDIF.
      WHEN c_graph_pie.
        node2 ?= node->find_from_name( name = 'legendPos' namespace = 'c' ).
        IF node2 IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lo_piechart->ns_legendposval = ls_prop-val.
        ENDIF.
        node2 ?= node->find_from_name( name = 'overlay' namespace = 'c' ).
        IF node2 IS BOUND.
          zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
          lo_piechart->ns_overlayval = ls_prop-val.
        ENDIF.
        node2 ?= node->find_from_name( name = 'pPr' namespace = 'a' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_pprrtl = ls_prop-rtl.
        node2 ?= node->find_from_name( name = 'endParaRPr' namespace = 'a' ).
        zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
        lo_piechart->ns_endpararprlang = ls_prop-lang.

      WHEN OTHERS.
    ENDCASE.

    node2 ?= node->find_from_name( name = 'plotVisOnly' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_plotvisonlyval = ls_prop-val.
    node2 ?= node->find_from_name( name = 'dispBlanksAs' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_dispblanksasval = ls_prop-val.
    node2 ?= node->find_from_name( name = 'showDLblsOverMax' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_prop ).
    me->graph->ns_showdlblsovermaxval = ls_prop-val.
    ""---------------------

    node2 ?= node->find_from_name( name = 'pageMargins' namespace = 'c' ).
    zcl_excel_reader_2007=>fill_struct_from_attributes( EXPORTING ip_element = node2 CHANGING cp_structure = ls_pagemargins ).
    me->graph->pagemargins = ls_pagemargins.


  ENDMETHOD.


  METHOD pixel2emu.
* suppose 96 DPI
    IF ip_dpi IS SUPPLIED.
      r_emu = ip_pixel  * 914400 / ip_dpi.
    ELSE.
* suppose 96 DPI
      r_emu = ip_pixel  * 914400 / 96.
    ENDIF.
  ENDMETHOD.


  METHOD set_media.
    IF ip_media IS SUPPLIED.
      media = ip_media.
    ENDIF.
    media_type = ip_media_type.
    media_source = c_media_source_xstring.
    IF ip_width IS SUPPLIED.
      size-width  = ip_width.
    ENDIF.
    IF ip_height IS SUPPLIED.
      size-height = ip_height.
    ENDIF.
  ENDMETHOD.


  METHOD set_media_mime.

    DATA: lv_language TYPE sylangu.

    io = ip_io.
    media_source = c_media_source_mime.
    size-width  = ip_width.
    size-height = ip_height.

    lv_language = sy-langu.
    cl_wb_mime_repository=>load_mime( EXPORTING
                                        io        = ip_io
                                      IMPORTING
                                        filename  = media_name
                                        ""mimetype = media_type
                                      CHANGING
                                        language  = lv_language  ).

    SPLIT media_name AT '.' INTO media_name media_type.

  ENDMETHOD.


  METHOD set_media_www.
    DATA: lv_value(20).

    media_key_www = ip_key.
    media_source = c_media_source_www.

    CALL FUNCTION 'WWWPARAMS_READ'
      EXPORTING
        relid = media_key_www-relid
        objid = media_key_www-objid
        name  = 'fileextension'
      IMPORTING
        value = lv_value.
    media_type = lv_value.
    SHIFT media_type LEFT DELETING LEADING '.'.

    size-width  = ip_width.
    size-height = ip_height.
  ENDMETHOD.


  METHOD set_position.
    from_loc-col = zcl_excel_common=>convert_column2int( ip_from_col ) - 1.
    IF ip_coloff IS SUPPLIED.
      from_loc-col_offset = ip_coloff.
    ENDIF.
    from_loc-row = ip_from_row - 1.
    IF ip_rowoff IS SUPPLIED.
      from_loc-row_offset = ip_rowoff.
    ENDIF.
    anchor = anchor_one_cell.
  ENDMETHOD.


  METHOD set_position2.

    DATA: lv_anchor                     TYPE zexcel_drawing_anchor.
    lv_anchor = ip_anchor.

    IF lv_anchor IS INITIAL.
      IF ip_to IS NOT INITIAL.
        lv_anchor = anchor_two_cell.
      ELSE.
        lv_anchor = anchor_one_cell.
      ENDIF.
    ENDIF.

    CASE lv_anchor.
      WHEN anchor_absolute OR anchor_one_cell.
        CLEAR: me->to_loc.
      WHEN anchor_two_cell.
        CLEAR: me->size.
    ENDCASE.

    me->from_loc = ip_from.
    me->to_loc = ip_to.
    me->anchor = lv_anchor.

  ENDMETHOD.
ENDCLASS.
",13561,True,3731.588594734834,median
"*----------------------------------------------------------------------*
***INCLUDE Z_CA02701_F01 .
*----------------------------------------------------------------------*
*&---------------------------------------------------------------------*
*&      Form  EVT_INITIALIZATION
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM evt_initialization .
  DATA ls_allowed_object LIKE LINE OF mt_allowed_object.

* Se instancia la clase que gestionara todo la herramientra de traduccion.
  CREATE OBJECT mo_proces.

* Se recupera los objetos permitidos en base a las clases de componentes
* parametrizadas.
  mt_allowed_object = mo_proces->get_allowed_objects( ).

* Idioma fuente por defecto
  CALL FUNCTION 'LXE_T002_CHECK_LANGUAGE'
    EXPORTING
      r3_lang    = sy-langu
    IMPORTING
      o_language = p_olang.

* Indico que los refrescos de los ALV no se moverán de filas y columna
  ms_stable-row = abap_true.
  ms_stable-col = abap_true.

* Nombre del programa para variantes.
  ms_variant-report = sy-cprog.
ENDFORM.                    "" EVT_INITIALIZATION
*&---------------------------------------------------------------------*
*&      Form  F4_OBJECT
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM f4_object .
  CALL FUNCTION 'F4IF_INT_TABLE_VALUE_REQUEST'
    EXPORTING
      retfield        = 'OBJECT'
      window_title    = 'Allowed Plugins'
      dynpprog        = sy-repid
      dynpnr          = '1000'
      dynprofield     = 'P_OBJECT'
      value_org       = 'S'
    TABLES
      value_tab       = mt_allowed_object
    EXCEPTIONS
      parameter_error = 1
      no_values_found = 2
      OTHERS          = 3.
ENDFORM.                    "" F4_OBJECT
*&---------------------------------------------------------------------*
*&      Form  CHECK_BL1
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM check_bl1 .
  IF p_object IS INITIAL.
    MESSAGE e001.
  ELSE.
* Compruebo si el objeto es valido
    READ TABLE mt_allowed_object TRANSPORTING NO FIELDS
                                 WITH KEY object = p_object.
    IF sy-subrc = 0.
* Compruebo si el objeto existe
      IF mo_proces->check_obj_2_trans( iv_object = p_object iv_obj_name = p_oname ) = abap_false.
        MESSAGE e004 WITH p_object p_oname.
      ENDIF.
    ELSE.
      MESSAGE e012 WITH p_object.
    ENDIF.

  ENDIF.
ENDFORM.                    "" CHECK_BL1
*&---------------------------------------------------------------------*
*&      Form  LOAD_OBJECT_TEXTS
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM load_object_texts .

* Se leen los textos del objeto y sus componentes.
  mo_proces->load_object_texts( ).

* Se recuperan el texto del objeto con sus componentes.
  mo_it_data = mo_proces->get_data( ).
  ASSIGN mo_it_data->* TO <it_datos>.

ENDFORM.                    "" LOAD_OBJECT_TEXTS
*&---------------------------------------------------------------------*
*&      Form  F4_OLANG
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
*  -->  p1        text
*  <--  p2        text
*----------------------------------------------------------------------*
FORM f4_olang .
  CALL FUNCTION 'LXE_T002_SELECT_LANGUAGE'
    EXPORTING
      dynpprog        = 'Z_CA02701'
      dynpnr          = '1000'
      dynpfield       = 'P_OLANG'
    IMPORTING
      language        = p_olang
    EXCEPTIONS
      parameter_error = 1
      no_values_found = 2
      no_selection    = 3
      OTHERS          = 4.

ENDFORM.                    "" F4_OLANG
*&---------------------------------------------------------------------*
*&      Form  PBO_PS
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM pbo_ps .
* Texto informativo para el campo de niveles de profundidad.
  text1 = text-i01.

  LOOP AT SCREEN.
    CASE screen-name.
* El idioma de origen, objeto a traducir y la orden se desactiva la entrada de datos.
* Se usará el matchcode para hacerlo.
* Se hace para que usen la ayuda para búsqueda y no se introduzcan cosas que no deben.
      WHEN 'P_OLANG' OR 'P_TRKORR'.
        screen-input = 0.
    ENDCASE.
    MODIFY SCREEN.
  ENDLOOP.
ENDFORM.                    "" PBO_PS
*&---------------------------------------------------------------------*
*&      Form  F4_SPRAS
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM f4_spras .

  CALL FUNCTION 'LXE_T002_SELECT_LANGUAGE'
    EXPORTING
      dynpprog        = 'Z_CA02701'
      dynpnr          = '1000'
      dynpfield       = 'S_TLANG-LOW'
    IMPORTING
      language        = s_tlang-low
    EXCEPTIONS
      parameter_error = 1
      no_values_found = 2
      no_selection    = 3
      OTHERS          = 4.

ENDFORM.                    "" F4_SPRAS
*&---------------------------------------------------------------------*
*&      Form  check_tlang
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM check_tlang.

* Se borra el idioma de origen en el ranges de idiomas de destino.
* no tiene sentido poner los mismos.
  DELETE s_tlang WHERE low = p_olang.

* La búsqueda por patrones no esta permitida, y no se puede marcar la opción
* de exclusion.
  LOOP AT s_tlang TRANSPORTING NO FIELDS WHERE option = 'CP'
                                               OR sign = 'E'.
    EXIT.
  ENDLOOP.
  IF sy-subrc = 0.
    MESSAGE e002.
  ELSE.

    IF s_tlang-low IS NOT INITIAL.
      CALL FUNCTION 'LXE_T002_CHECK_LANGUAGE'
        EXPORTING
          language           = s_tlang-low
        EXCEPTIONS
          language_not_in_cp = 1
          unknown            = 2
          OTHERS             = 3.
      IF sy-subrc > 1.
        MESSAGE e003(lxe_trans) WITH s_tlang-low. "" Idioma no existe.
      ENDIF.
    ENDIF.
  ENDIF.

ENDFORM.                    ""check_tlang
*&---------------------------------------------------------------------*
*&      Form  SET_PARAMS_SELSCREEN
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM set_params_selscreen .
  DATA lt_tlang TYPE lxe_tt_lxeisolang.

* El ranges de los idiomas se pasa a una tabla normal
  LOOP AT s_tlang.
    APPEND s_tlang-low TO lt_tlang.
  ENDLOOP.

* Se eliminan posibles duplicados
  SORT lt_tlang.
  DELETE ADJACENT DUPLICATES FROM lt_tlang.

  CALL METHOD mo_proces->set_params_selscreen
    EXPORTING
      iv_olang      = p_olang
      it_tlang    = lt_tlang
      iv_trkorr     = p_trkorr
      iv_depth_refs = p_drefs.

ENDFORM.                    "" SET_PARAMS_SELSCREEN
*&---------------------------------------------------------------------*
*&      Form  SHOW_DATA
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM show_data .
  CALL SCREEN 9000.
ENDFORM.                    "" SHOW_DATA
*&---------------------------------------------------------------------*
*&      Form  DATA_CHANGED
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM data_changed  CHANGING ps_data_changed TYPE REF TO cl_alv_changed_data_protocol.
  FIELD-SYMBOLS <ls_modif> TYPE lvc_s_modi.
  FIELD-SYMBOLS <wa> TYPE ANY.
  FIELD-SYMBOLS <field> TYPE ANY.
  FIELD-SYMBOLS <lt_field_style> TYPE lvc_t_styl.
  FIELD-SYMBOLS <ls_field_style> TYPE LINE OF lvc_t_styl.
  DATA ld_fieldname TYPE fieldname.
  DATA ls_field_style TYPE LINE OF lvc_t_styl.


  LOOP AT ps_data_changed->mt_mod_cells ASSIGNING <ls_modif>.
* En el primer registro se marca que los datos han sido modificados
    AT FIRST.
      mv_datos_modif = abap_true.
    ENDAT.
* Registro cada vez que se modifica una fila.
    AT NEW row_id.
* Leo el registro modificado.
      READ TABLE <it_datos> ASSIGNING <wa> INDEX <ls_modif>-row_id.
    ENDAT.

* Paso el texto modificado al campo que toca.
    ASSIGN COMPONENT <ls_modif>-fieldname OF STRUCTURE <wa> TO <field>.
    IF sy-subrc = 0.
      <field> = <ls_modif>-value.
    ENDIF.

* Pongo el nombre del campo en una variable para despues cambiarlo para actualizar
* el campo de control.
    ld_fieldname = <ls_modif>-fieldname.

* Para actualizar el campo de control tengo que reemplazar el texto del nombre del campo
* por el de control.
    REPLACE mo_proces->mc_field_txt_lang IN ld_fieldname
            WITH mo_proces->mc_field_ctrl_lang.

* Actualizo el campo de control
    ASSIGN COMPONENT ld_fieldname OF STRUCTURE <wa> TO <field>.
    IF sy-subrc = 0.
      <field> = abap_true.
    ENDIF.

* Cambio el color del campo de texto. No se puede actualizar directamente el estilo
* en la tabla porque ira bien para el primer ENTER. Pero si luego se modifica y se vuelve
* a pulsar ENTER se pierde el estilo de la primera modificacion. Vamos, que solo
* hay color para los últimos cambios.
    CALL METHOD ps_data_changed->modify_style
      EXPORTING
        i_row_id    = <ls_modif>-row_id
        i_fieldname = <ls_modif>-fieldname
        i_style     = mo_proces->mc_style_text_changed.

  ENDLOOP.

ENDFORM.                    "" DATA_CHANGED
*&---------------------------------------------------------------------*
*&      Form  BUTTONS_EXCLUDE_ALV
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM buttons_exclude_alv .
*mt_excluding
  APPEND cl_gui_alv_grid=>mc_fc_loc_append_row TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_copy TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_copy_row TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_cut TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_delete_row TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_insert_row TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_move_row TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_paste TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_paste_new_row TO mt_excluding.
  APPEND cl_gui_alv_grid=>mc_fc_loc_undo  TO mt_excluding.
ENDFORM.                    "" BUTTONS_EXCLUDE_ALV
*&---------------------------------------------------------------------*
*&      Form  save_data
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM save_data.
  DATA ls_return TYPE bapiret2.

  IF mv_datos_modif = abap_true.

* Se pasa los datos a la clase de control
    mo_proces->set_data( mo_it_data ).

* Se graban los datos
    ls_return = mo_proces->save_data( ).

    CASE ls_return-type.
* Los mensajes de error se muestran como informativos pero de tipo error.
      WHEN 'E' OR 'X' OR 'A'.
        MESSAGE ID ls_return-id TYPE 'S'
                       NUMBER ls_return-number
                       WITH ls_return-message_v1 ls_return-message_v2 ls_return-message_v3 ls_return-message_v4
                       DISPLAY LIKE 'E'.
      WHEN OTHERS.
* Una vez grabado sin error se marca que los datos no están modificados.
        mv_datos_modif = abap_false.

        MESSAGE ID ls_return-id TYPE ls_return-type
                       NUMBER ls_return-number
                       WITH ls_return-message_v1 ls_return-message_v2 ls_return-message_v3 ls_return-message_v4.
    ENDCASE.

* Refresco los datos para que se van los cambios en la tabla interna de datos.
* No es necesario recuperar los datos porque ya se han hecho con anterioridad a través
* de punteros. Por lo que todo se haga en la clase o programa se ve reflejando en ambos sitios
* sin necesidad de traspasar de nuevo los datos. Viva los punteros :-)
    CALL METHOD mo_alv->refresh_table_display( EXPORTING is_stable = ms_stable ).

  ELSE.
    MESSAGE s010.
  ENDIF.

ENDFORM.                    ""save_data
*&---------------------------------------------------------------------*
*&      Form  F4_TRKORR
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
*  -->  p1        text
*  <--  p2        text
*----------------------------------------------------------------------*
FORM f4_trkorr .
  DATA ld_order TYPE trkorr.
  DATA ld_task TYPE trkorr.
  DATA ld_trkorr TYPE trkorr.
  DATA lt_dyntab TYPE STANDARD TABLE OF dynpread.
  DATA ls_dyntab TYPE dynpread.

  CALL FUNCTION 'TR_ORDER_CHOICE_CORRECTION'
    EXPORTING
      iv_category = 'SYST'
    IMPORTING
      ev_order    = ld_order
      ev_task     = ld_task
    EXCEPTIONS
      OTHERS      = 3.
  IF sy-subrc = 0.

* La tarea si, se devuelve, tiene más prioridad. Esto se hace para
* operacion en la orden que se harán al transportar (como clasificar y comprimir).
    IF ld_task IS NOT INITIAL.
      ld_trkorr = ld_task.
    ELSEIF ld_order IS NOT INITIAL.
      ld_trkorr = ld_order.
    ENDIF.

* Si hay orden actualizo el campo de la pantalla.
    IF ld_trkorr IS NOT INITIAL.
      ls_dyntab-fieldname = 'P_TRKORR'.
      ls_dyntab-fieldvalue = ld_trkorr.
      APPEND ls_dyntab TO lt_dyntab.

      CALL FUNCTION 'DYNP_VALUES_UPDATE'
        EXPORTING
          dyname               = 'Z_CA02701'
          dynumb               = '1000'
        TABLES
          dynpfields           = lt_dyntab
        EXCEPTIONS
          invalid_abapworkarea = 1
          invalid_dynprofield  = 2
          invalid_dynproname   = 3
          invalid_dynpronummer = 4
          invalid_request      = 5
          no_fielddescription  = 6
          undefind_error       = 7
          OTHERS               = 8.
    ENDIF.

  ENDIF.
ENDFORM.                    "" F4_TRKORR
*&---------------------------------------------------------------------*
*&      Form  CHECK_TRKORR
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM check_trkorr .
  FIELD-SYMBOLS <ls_req_head> TYPE trwbo_request_header.
  DATA ld_trfunction TYPE e070-trfunction.
  DATA lt_req_head TYPE trwbo_request_headers.
  DATA lt_req TYPE trwbo_requests.
  DATA ld_order TYPE e070-trkorr.

  IF p_trkorr IS NOT INITIAL.
* Se las tareas de las ordenes para ver si hay alguna valida.
    CALL FUNCTION 'TR_READ_REQUEST_WITH_TASKS'
      EXPORTING
        iv_trkorr          = p_trkorr
      IMPORTING
        et_request_headers = lt_req_head
        et_requests        = lt_req
      EXCEPTIONS
        invalid_input      = 1
        OTHERS             = 2.
    IF sy-subrc <> 0.
      MESSAGE ID sy-msgid TYPE 'E' NUMBER sy-msgno WITH sy-msgv1 sy-msgv2 sy-msgv3 sy-msgv4.
    ENDIF.

* Se mira si hay alguna tarea valida para el usuario.
    LOOP AT lt_req_head ASSIGNING <ls_req_head> WHERE trfunction = 'S'
                                                      AND trstatus = 'D'
                                                      AND as4user = sy-uname.
      EXIT.
    ENDLOOP.
    IF sy-subrc = 0.
      p_trkorr = <ls_req_head>-trkorr.
    ELSE.
* En caso de no haberla se lee la primera posicion se indique la orden padre para leer
* algunos datos y crear la tarea.
      LOOP AT lt_req_head ASSIGNING <ls_req_head> WHERE strkorr IS NOT INITIAL.
        EXIT.
      ENDLOOP.
      IF sy-subrc = 0.

        CALL FUNCTION 'TRINT_INSERT_NEW_COMM'
          EXPORTING
            wi_kurztext       = <ls_req_head>-as4text
            wi_trfunction     = 'S'
            iv_username       = sy-uname
            wi_strkorr        = <ls_req_head>-strkorr
            wi_client         = sy-mandt
          IMPORTING
            we_trkorr         = p_trkorr
          EXCEPTIONS
            no_systemname     = 1
            no_systemtype     = 2
            no_authorization  = 3
            db_access_error   = 4
            file_access_error = 5
            enqueue_error     = 6
            number_range_full = 7
            invalid_input     = 8
            OTHERS            = 9.
        IF sy-subrc <> 0.
          MESSAGE ID sy-msgid TYPE 'E' NUMBER sy-msgno WITH sy-msgv1 sy-msgv2 sy-msgv3 sy-msgv4.
        ENDIF.
      ENDIF.
    ENDIF.
  ENDIF.

ENDFORM.                    "" CHECK_TRKORR
*&---------------------------------------------------------------------*
*&      Form  TOOLBAR_ALV
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM toolbar_alv CHANGING ps_object TYPE REF TO cl_alv_event_toolbar_set
                          ps_interactive TYPE char01.
  DATA ls_toolbar  TYPE stb_button.

* Se añade un separador para separar los botones estándar de los propios.
  CLEAR ls_toolbar.
  MOVE 3 TO ls_toolbar-butn_type.
  APPEND ls_toolbar TO ps_object->mt_toolbar.

* Boton de transporte
  CLEAR ls_toolbar.
  MOVE mc_transport TO ls_toolbar-function.
  MOVE icon_transport TO ls_toolbar-icon.
  MOVE text-q01 TO ls_toolbar-quickinfo.
  MOVE 1 TO ls_toolbar-butn_type. "" Menu + opcion por defecto
  IF p_trkorr IS NOT INITIAL.
    MOVE space TO ls_toolbar-disabled.
  ELSE.
    MOVE abap_true TO ls_toolbar-disabled .
  ENDIF.
  APPEND ls_toolbar TO ps_object->mt_toolbar.

* Botón de confirmar traducciones
  CLEAR ls_toolbar.
  MOVE mc_pprosal TO ls_toolbar-function.
*  MOVE icon_transport TO ls_toolbar-icon.
*  MOVE text-q02 TO ls_toolbar-quickinfo.
  MOVE text-q02 TO ls_toolbar-text.
  MOVE 1 TO ls_toolbar-butn_type. "" Menu + opcion por defecto
  APPEND ls_toolbar TO ps_object->mt_toolbar.

ENDFORM.                    "" TOOLBAR_ALV
*&---------------------------------------------------------------------*
*&      Form  MENU_TOOLBAR
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*

FORM menu_toolbar  CHANGING ps_object TYPE REF TO cl_ctmenu
                            ps_ucomm TYPE sy-ucomm.

* Se desplega el menú en base a la opción escogida.
  CASE ps_ucomm.
    WHEN mc_transport.
      ps_object->add_function( fcode = mc_transport
                               text = text-t01 "" Transport changes
                               icon =  icon_import_transport_request ).

      ps_object->add_function( fcode = mc_trans_obj
                               text = text-t02 "" Selective transport
                               icon  = icon_transport_proposal
                               disabled = abap_true ).
    WHEN mc_pprosal.
      ps_object->add_function( fcode = mc_pprosal
                             text = text-t03 "" Confirm all
                             icon =  icon_import_transport_request ).

      ps_object->add_function( fcode = mc_ok_pprosal
                               text = text-f01 "" Confirm proposal field
                               icon  = icon_transport_proposal ).
  ENDCASE.
ENDFORM.                    "" MENU_TOOLBAR
*&---------------------------------------------------------------------*
*&      Form  USER_COMMAND_TOOLBAR
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM user_command_toolbar  CHANGING ps_ucomm TYPE sy-ucomm.

  CASE ps_ucomm.
    WHEN mc_transport. "" Transport all objects
      PERFORM transport_mod_obj.
    WHEN mc_trans_obj. "" Selective transport
    WHEN mc_ok_pprosal. "" Confirm proposal
      PERFORM button_confirm_pprosal.
    WHEN mc_pprosal. "" Confirm all proposal
      PERFORM confirm_all_pprosal.
  ENDCASE.

ENDFORM.                    "" USER_COMMAND_TOOLBAR
*&---------------------------------------------------------------------*
*&      Form  TRANSPORT
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM transport_mod_obj .
  DATA ls_return TYPE bapiret2.

  CALL METHOD mo_proces->transport_mod_obj
    IMPORTING
      es_return = ls_return.

  CASE ls_return-type.
* Los errores se muestran como informativo pero de tipo error, de esta
* manera no se sale del programa.
    WHEN 'E' OR 'X' OR 'A'.
      MESSAGE ID ls_return-id TYPE 'S' NUMBER ls_return-number
             WITH ls_return-message_v1 ls_return-message_v2 ls_return-message_v3 ls_return-message_v4
             DISPLAY LIKE 'E'.
    WHEN OTHERS.
      MESSAGE ID ls_return-id TYPE ls_return-type NUMBER ls_return-number
           WITH ls_return-message_v1 ls_return-message_v2 ls_return-message_v3 ls_return-message_v4.
  ENDCASE.

ENDFORM.                    "" TRANSPORT
*&---------------------------------------------------------------------*
*&      Form  INIT_DATA
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM init_data .
* Los datos no se han modificado.
  mv_datos_modif = abap_false.
ENDFORM.                    "" INIT_DATA
*&---------------------------------------------------------------------*
*&      Form  CONTEXT_MENU
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM context_menu  USING  pe_object TYPE REF TO cl_ctmenu.
  FIELD-SYMBOLS <wa> TYPE ANY.
  FIELD-SYMBOLS <field_style> TYPE lvc_t_styl.
  DATA ls_col TYPE lvc_s_col.
  DATA ls_row TYPE lvc_s_row.
  DATA ld_mostrar_menu TYPE sap_bool.
* Códigos de funcion para menu contextual
  DATA lt_func_menu_context TYPE ui_functions.
* Opciones de menu contextual estándar que no se mostrarán
  DATA lt_func_std_menu_context TYPE ui_functions.

* Carga de las opciones de los menus contextuales.
  PERFORM load_func_menu_context CHANGING lt_func_menu_context
                                          lt_func_std_menu_context.

* Obtengo los datos de la columna donde se ha pulsado el menú contextual.
  CALL METHOD mo_alv->get_current_cell
    IMPORTING
      es_col_id = ls_col
      es_row_id = ls_row.
  CALL METHOD cl_gui_cfw=>flush.

  ld_mostrar_menu = abap_false.

* El menu contextual solo se permite para las columnas dinámicas con los textos
  IF ls_col-fieldname CS ZCL_TRANSLATE_TOOL=>mc_field_txt_lang.

* El menú contextual saldrá
    READ TABLE <it_datos> ASSIGNING <wa> INDEX ls_row-index.
    IF sy-subrc = 0.

      ASSIGN COMPONENT ZCL_TRANSLATE_TOOL=>mc_field_style OF STRUCTURE <wa> TO <field_style>.
      IF sy-subrc = 0.

* Miro el estilo es de propuesta no confirmada. Si es así se muestra el menu.
        READ TABLE <field_style> TRANSPORTING NO FIELDS
                                  WITH KEY fieldname = ls_col-fieldname
                                           style = mo_proces->mc_style_prop_wo_conf.
        IF sy-subrc = 0.
          ld_mostrar_menu = abap_true.
        ENDIF.

      ENDIF.

    ENDIF.
  ENDIF.

  IF ld_mostrar_menu = abap_true.
* Añade las opciones al menu contextual
    PERFORM assign_func_menu_context USING pe_object.

* Enseño los códigos funcion
    CALL METHOD pe_object->show_functions
      EXPORTING
        fcodes = lt_func_menu_context.

* Oculto los estándar
    CALL METHOD pe_object->hide_functions
      EXPORTING
        fcodes = lt_func_std_menu_context.
  ELSE.
* Enseño los códigos funcion
    CALL METHOD pe_object->hide_functions
      EXPORTING
        fcodes = lt_func_std_menu_context.

* Oculto los estándar
    CALL METHOD pe_object->show_functions
      EXPORTING
        fcodes = lt_func_std_menu_context.
  ENDIF.
  CALL METHOD cl_gui_cfw=>flush.
ENDFORM.                    "" CONTEXT_MENU
*&---------------------------------------------------------------------*
*&      Form  LOAD_FUNC_MENU_CONTEXT
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM load_func_menu_context  CHANGING ps_func TYPE ui_functions
                                      ps_func_std TYPE ui_functions.

* Confirmacion propuesta traduccion
  APPEND mc_ok_pprosal TO ps_func.

* Codigo estándar para que no se muestren.
  APPEND cl_gui_alv_grid=>mc_fc_col_optimize TO ps_func_std.
  APPEND cl_gui_alv_grid=>mc_fc_help TO ps_func_std.
  APPEND cl_gui_alv_grid=>mc_fc_col_invisible TO ps_func_std.
  APPEND cl_gui_alv_grid=>mc_fc_delete_filter TO ps_func_std.

ENDFORM.                    "" LOAD_FUNC_MENU_CONTEXT
*&---------------------------------------------------------------------*
*&      Form  ASSIGN_FUNC_MENU_CONTEXT
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM assign_func_menu_context  USING  pe_object TYPE REF TO cl_ctmenu.

  pe_object->add_separator( ).

  CALL METHOD pe_object->add_function
    EXPORTING
      fcode = mc_ok_pprosal
      text  = text-f01.

ENDFORM.                    "" ASSIGN_FUNC_MENU_CONTEXT
*&---------------------------------------------------------------------*
*&      Form  CONFIRM_PPROSAL_FIELD
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM confirm_pprosal_field USING pe_fieldname
                            CHANGING ps_wa TYPE any.
  FIELD-SYMBOLS <wa> TYPE ANY.
  FIELD-SYMBOLS <field> TYPE ANY.
  FIELD-SYMBOLS <field_style> TYPE lvc_t_styl.
  FIELD-SYMBOLS <wa_field_style> TYPE LINE OF lvc_t_styl.
  DATA ld_fieldname TYPE fieldname.

  ASSIGN COMPONENT zcl_translate_tool=>mc_field_style OF STRUCTURE ps_wa TO <field_style>.
  IF sy-subrc = 0.

* Miro el estilo es de propuesta no confirmada. Si es así se cambia a confirmada
    READ TABLE <field_style> ASSIGNING <wa_field_style>
                              WITH KEY fieldname = pe_fieldname
                                       style = mo_proces->mc_style_prop_wo_conf.
    IF sy-subrc = 0.
      <wa_field_style>-style = mo_proces->mc_style_text_changed.

* Se marca que el campo ha sido modificado para que se tenga en cuenta en la grabacion.
      ld_fieldname = pe_fieldname.
* Para actualizar el campo de control tengo que reemplazar el texto del nombre del campo
* por el de control.
      REPLACE mo_proces->mc_field_txt_lang IN ld_fieldname
              WITH mo_proces->mc_field_ctrl_lang.

* Actualizo el campo de control
      ASSIGN COMPONENT ld_fieldname OF STRUCTURE ps_wa TO <field>.
      IF sy-subrc = 0.
        <field> = abap_true.

* A nivel global establezco que los datos han sido modificados.
        mv_datos_modif = abap_true.

      ENDIF.

    ENDIF.

  ENDIF.


ENDFORM.                    "" CONFIRM_PPROSAL_FIELD
*&---------------------------------------------------------------------*
*&      Form  BUTTON_CONFIRM_PPROSAL
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM button_confirm_pprosal .
  FIELD-SYMBOLS <wa> TYPE ANY.
  DATA ls_col TYPE lvc_s_col.
  DATA ls_row TYPE lvc_s_row.

* Obtengo los datos de la columna donde se ha pulsado el menú contextual.
  CALL METHOD mo_alv->get_current_cell
    IMPORTING
      es_col_id = ls_col
      es_row_id = ls_row.
  CALL METHOD cl_gui_cfw=>flush.


* El menú contextual saldrá
  READ TABLE <it_datos> ASSIGNING <wa> INDEX ls_row-index.
  IF sy-subrc = 0.
    PERFORM confirm_pprosal_field USING ls_col-fieldname
                                  CHANGING <wa>.

    CALL METHOD mo_alv->refresh_table_display( EXPORTING is_stable = ms_stable ).

    CALL METHOD cl_gui_cfw=>flush.

  ENDIF.

ENDFORM.                    "" BUTTON_CONFIRM_PPROSAL
*&---------------------------------------------------------------------*
*&      Form  CONFIRM_ALL_PPROSAL
*&---------------------------------------------------------------------*
*       text
*----------------------------------------------------------------------*
FORM confirm_all_pprosal .
  FIELD-SYMBOLS <wa> TYPE ANY.
  FIELD-SYMBOLS <ls_tlang> TYPE LINE OF lxe_tt_lxeisolang.
  DATA lt_tlang TYPE lxe_tt_lxeisolang.
  DATA ld_fieldname TYPE fieldname.

* Recupero los idiomas de destino.
  lt_tlang = mo_proces->get_tlang( ).

* Por cada registro se recorre cada columna de idioma y se llama al
* procedimiento que acepta las propuestas por cada idioma.
  LOOP AT <it_datos> ASSIGNING <wa>.

    LOOP AT lt_tlang ASSIGNING <ls_tlang>.

      ld_fieldname = mo_proces->get_name_field_text( <ls_tlang> ).
      PERFORM confirm_pprosal_field USING ld_fieldname
                                   CHANGING <wa>.

    ENDLOOP.

  ENDLOOP.

  CALL METHOD mo_alv->refresh_table_display( EXPORTING is_stable = ms_stable ).

  CALL METHOD cl_gui_cfw=>flush.

ENDFORM.                    "" CONFIRM_ALL_PPROSAL
",6635,False,1418.0923998120575,median
"parser grammar Cisco_interface;

import Cisco_common;

options {
   tokenVocab = CiscoLexer;
}

if_autostate
:
   NO? AUTOSTATE NEWLINE
;

if_bandwidth
:
   NO? BANDWIDTH dec KBPS? NEWLINE
;

if_bfd
:
  BFD (IPV4 | IPV6)? (
     if_bfd_authentication
     | if_bfd_echo
     | if_bfd_echo_rx_interval
     | if_bfd_interval
     | if_bfd_neighbor
     | if_bfd_optimize
     | if_bfd_template
  )
;

if_bfd_authentication
:
  AUTHENTICATION KEYED_SHA1 KEYID id = dec (
     HEX_KEY hex_key = variable
     | KEY ascii_key = variable
  )NEWLINE
;

if_bfd_echo
:
  ECHO NEWLINE
;

if_bfd_echo_rx_interval
:
  ECHO_RX_INTERVAL ms = dec NEWLINE
;

if_bfd_interval
:
  INTERVAL tx_ms = dec (MIN_RX | MIN_RX_VAR) tx_ms = dec MULTIPLIER mult = dec NEWLINE
;

if_bfd_neighbor
:
  NEIGHBOR SRC_IP (
     src_ip = IP_ADDRESS DEST_IP dst_ip = IP_ADDRESS
     | src_ip = IPV6_ADDRESS DEST_IP dst_ip = IPV6_ADDRESS
  ) NEWLINE
;

if_bfd_optimize
:
  OPTIMIZE SUBINTERFACE NEWLINE
;

if_bfd_template
:
  TEMPLATE name = variable_permissive NEWLINE
;

if_channel_group
:
   CHANNEL_GROUP num = dec
   (
      MODE
      (
         ACTIVE
         | DESIRABLE
         | AUTO
         | ON
         | PASSIVE
      )
      (
        NON_SILENT
        | SILENT
      )?
   )? NEWLINE
;

if_crypto_map
:
   CRYPTO MAP name = variable NEWLINE
;

if_default_gw
:
   DEFAULT_GW IP_ADDRESS NEWLINE
;

if_description
:
   description_line
;

if_delay
:
   NO? DELAY dec NEWLINE
;

if_encapsulation
:
  ENCAPSULATION
  (
    if_encapsulation_dot1q
    | if_encapsulation_null
  )
;

if_encapsulation_dot1q
:
  DOT1Q vlan = vlan_id NEWLINE
;

if_encapsulation_null
:
  (
    DEFAULT
  ) null_rest_of_line
;

if_flow_sampler
:
   NO? FLOW_SAMPLER variable EGRESS? NEWLINE
;

if_hsrp
:
   HSRP group = dec NEWLINE
   (
      if_hsrp_ip_address
      | if_hsrp_null
      | if_hsrp_preempt
      | if_hsrp_priority
      | if_hsrp_track
   )*
;

if_hsrp_ip_address
:
   IP ip = IP_ADDRESS SECONDARY? NEWLINE
;

if_hsrp_null
:
   NO?
   (
      AUTHENTICATION
      | MAC_ADDRESS
      | NAME
      | TIMERS
   ) null_rest_of_line
;

if_hsrp_preempt
:
   NO? PREEMPT null_rest_of_line
;

if_hsrp_priority
:
   NO? PRIORITY value = dec null_rest_of_line
;

if_hsrp_track
:
   NO? TRACK null_rest_of_line
;

if_hsrp6
:
   HSRP group = dec IPV6 NEWLINE
   (
      if_hsrp6_ip_address
      | if_hsrp_null
      | if_hsrp_preempt
      | if_hsrp_priority
      | if_hsrp_track
   )*
;

if_hsrp6_ip_address
:
   IP ip = IPV6_ADDRESS NEWLINE
;

if_ip
:
  IP
  (
    if_ip_address_dhcp
    | if_ip_authentication
    | if_ip_cef
    | if_ip_flow_monitor
    | if_ip_hello_interval
    | if_ip_helper_address
    | if_ip_hold_time
    | if_ip_inband_access_group
    | if_ip_mfib
    | if_ip_nat_inside
    | if_ip_nat_outside
    | if_ip_nbar
    | if_ip_ospf_area
    | if_ip_ospf_dead_interval
    | if_ip_ospf_dead_interval_minimal
    | if_ip_ospf_hello_interval
    | if_ip_ospf_network
    | if_ip_pim_neighbor_filter
    | if_ip_policy
    | if_ip_router_isis
    | if_ip_router_ospf_area
    | if_ip_rtp
    | if_ip_split_horizon
    | if_ip_summary_address
    | if_ip_tcp
    | if_ip_verify
    | if_ip_virtual_router
    | if_ip_vrf_autoclassify
    | if_ip_vrf_receive
    | if_ip_vrf_select
    | if_ip_vrf_sitemap
  )
;

if_ip_access_group
:
   (
      (
         (
            IP
            | IPV4
         ) PORT? ACCESS_GROUP
      )
      |
      (
         ACCESS_LIST NAME
      )
   ) name = variable
   (
      EGRESS
      | IN
      | INGRESS
      | OUT
   )
   (
      HARDWARE_COUNT
      | OPTIMIZED
   )* NEWLINE
;

if_ip_address
:
   (IP | IPV4) ADDRESS
   VIRTUAL?
   (
      ip = IP_ADDRESS subnet = IP_ADDRESS
      | prefix = IP_PREFIX
   )
   (STANDBY standby_address = IP_ADDRESS)?
   (ROUTE_PREFERENCE pref=dec)?
   (TAG tag=dec)?
   NEWLINE
;

if_ip_address_dhcp
:
   ADDRESS DHCP NEWLINE
;

if_ip_address_secondary
:
   (
      IP
      | IPV4
   ) ADDRESS
   (
      (
         ip = IP_ADDRESS subnet = IP_ADDRESS
      )
      | prefix = IP_PREFIX
   ) SECONDARY DHCP_GIADDR? NEWLINE
;

if_ip_authentication
:
   AUTHENTICATION
   (
     if_ip_auth_key_chain
     | if_ip_auth_mode
   )
;

if_ip_auth_key_chain
:
   KEY_CHAIN EIGRP asn = dec name = variable_permissive NEWLINE
;

if_ip_auth_mode
:
   MODE EIGRP asn = dec MD5 NEWLINE
;

if_ip_cef
:
  CEF null_rest_of_line
;

if_ip_dhcp
:
   NO? IP DHCP
   (
      ifdhcp_null
      | ifdhcp_relay
   )
;

if_ip_flow_monitor
:
   FLOW MONITOR name = variable
   (
      INPUT
      | OUTPUT
   ) NEWLINE
;

if_ip_forward
:
   NO? IP FORWARD NEWLINE
;

if_ip_hello_interval
:
   HELLO_INTERVAL EIGRP asn = dec interval = dec NEWLINE
;

if_ip_helper_address
:
   HELPER_ADDRESS address = IP_ADDRESS NEWLINE
;

if_ip_hold_time
:
   HOLD_TIME EIGRP asn = dec interval = dec NEWLINE
;

if_ip_inband_access_group
:
   INBAND ACCESS_GROUP name = variable_permissive NEWLINE
;

if_ip_igmp
:
   NO? IP IGMP
   (
      NEWLINE
      | ifigmp_access_group
      | ifigmp_host_proxy
      | ifigmp_null
      | ifigmp_static_group
   )
;

if_ip_mfib
:
  MFIB null_rest_of_line
;

if_ip_nat_inside
:
   NAT INSIDE NEWLINE
;

if_ip_nat_outside
:
   NAT OUTSIDE NEWLINE
;

if_ip_nbar
:
   NBAR PROTOCOL_DISCOVERY (IPV4 | IPV6)? NEWLINE
;

if_ip_ospf_area
:
   OSPF procname = variable AREA (area_ip = IP_ADDRESS | area_dec = dec) NEWLINE
;

if_ip_ospf_cost
:
   IP? OSPF COST cost = dec NEWLINE
;

if_ip_ospf_dead_interval
:
   OSPF DEAD_INTERVAL seconds = dec NEWLINE
;

if_ip_ospf_dead_interval_minimal
:
   OSPF DEAD_INTERVAL MINIMAL HELLO_MULTIPLIER mult = dec NEWLINE
;

if_ip_ospf_hello_interval
:
   OSPF HELLO_INTERVAL seconds = dec NEWLINE
;

if_ip_ospf_network
:
   OSPF NETWORK
   (
      BROADCAST
      | NON_BROADCAST
      |
      (
         POINT_TO_MULTIPOINT NON_BROADCAST?
      )
      | POINT_TO_POINT
   ) NEWLINE
;

if_ip_ospf_passive_interface
:
   NO? IP OSPF PASSIVE_INTERFACE NEWLINE
;

if_ip_ospf_shutdown
:
   NO? IP OSPF SHUTDOWN NEWLINE
;

if_ip_passive_interface_eigrp
:
   NO? IP PASSIVE_INTERFACE EIGRP tag = dec NEWLINE
;

if_ip_pim_neighbor_filter
:
   PIM NEIGHBOR_FILTER acl = variable NEWLINE
;

if_ip_policy
:
   POLICY ROUTE_MAP name = ~NEWLINE NEWLINE
;

if_ip_proxy_arp
:
   (NO | DEFAULT)? IP PROXY_ARP NEWLINE
;

if_ip_router_isis
:
   ROUTER ISIS null_rest_of_line
;

if_ip_router_ospf_area
:
   ROUTER OSPF procname = variable AREA (area_ip = IP_ADDRESS | area_dec = dec) NEWLINE
;

if_ip_rtp
:
   RTP HEADER_COMPRESSION (PASSIVE | IPHC_FORMAT | IETF_FORMAT) PERIODIC_REFRESH? NEWLINE
;

if_ip_split_horizon
:
  SPLIT_HORIZON NEWLINE
;

if_ip_sticky_arp
:
   (NO? IP STICKY_ARP NEWLINE)
   |
   (IP STICKY_ARP IGNORE NEWLINE)
;

if_ip_summary_address
:
   SUMMARY_ADDRESS EIGRP asn = dec
   (
      addr = IP_ADDRESS netmask = IP_ADDRESS
      | prefix = IP_PREFIX
   )
   (LEAK_MAP mapname = variable)? NEWLINE
;

if_ip_tcp
:
   TCP
   (
      if_ip_tcp_adjust_mss
      | if_ip_tcp_compression_connections
      | if_ip_tcp_header_compression
   )
;

if_ip_tcp_adjust_mss
:
   ADJUST_MSS value = dec NEWLINE
;

if_ip_tcp_compression_connections
:
   COMPRESSION_CONNECTIONS value = dec NEWLINE
;

if_ip_tcp_header_compression
:
   HEADER_COMPRESSION ( PASSIVE | IETF_FORMAT )? NEWLINE
;

if_ip_verify
:
   VERIFY UNICAST
   (
      (
         NOTIFICATION THRESHOLD dec
      )
      |
      (
         REVERSE_PATH ALLOW_SELF_PING? acl = dec?
      )
      |
      (
         SOURCE REACHABLE_VIA
         (
            ANY
            | RX
         )
         (
            ALLOW_DEFAULT
            | ALLOW_SELF_PING
            | L2_SRC
         )* acl = dec?
      )
   ) NEWLINE
;

if_ip_virtual_router
:
   VIRTUAL_ROUTER ADDRESS address = IP_ADDRESS NEWLINE
;

if_ip_vrf_autoclassify
:
   VRF AUTOCLASSIFY SOURCE NEWLINE
;

if_ip_vrf_forwarding
:
   IP? VRF FORWARDING vrf = variable (DOWNSTREAM vrf_down = variable)? NEWLINE
;

if_ip_vrf_receive
:
   VRF RECEIVE vrf = variable NEWLINE
;

if_ip_vrf_select
:
   VRF SELECT SOURCE NEWLINE
;

if_ip_vrf_sitemap
:
   VRF SITEMAP map = variable NEWLINE
;

if_ipv6
:
   IPV6 if_ipv6_inner
;

if_ipv6_inner
:
   if_ipv6_enable
   | if_ipv6_traffic_filter
;

if_ipv6_enable
:
   ENABLE NEWLINE
;

if_ipv6_traffic_filter
:
   TRAFFIC_FILTER acl = variable_aclname (IN | OUT) NEWLINE
;

if_isis_circuit_type
:
   ISIS CIRCUIT_TYPE
   (
      LEVEL_1
      | LEVEL_2_ONLY
      | LEVEL_2
   ) NEWLINE
;

if_isis_enable
:
   ISIS ENABLE num = dec NEWLINE
;

if_isis_hello_interval
:
   ISIS HELLO_INTERVAL dec
   (
      LEVEL_1
      | LEVEL_2
   )? NEWLINE
;

if_isis_metric
:
   ISIS IPV6? METRIC metric = dec
   (
      LEVEL_1
      | LEVEL_2
   )? NEWLINE
;

if_isis_network
:
   ISIS NETWORK POINT_TO_POINT NEWLINE
;

if_isis_passive
:
   ISIS PASSIVE NEWLINE
;

if_isis_tag
:
   ISIS TAG tag = dec NEWLINE
;

if_load_interval
:
   LOAD_INTERVAL li = dec NEWLINE
;

if_member_interface
:
  MEMBER_INTERFACE name = interface_name NEWLINE
;

if_mka
:
  MKA null_rest_of_line
;

if_mtu
:
   MTU mtu_size = dec NEWLINE
;

if_network_clock
:
  NETWORK_CLOCK null_rest_of_line
;

if_no
:
  NO
  (
    if_no_bfd
    | if_no_ip
    | if_no_mka
    | if_no_routing_dynamic
    | if_no_synchronous
  )
;

if_no_bfd
:
   BFD (IPV4 | IPV6)?
   (
       AUTHENTICATION
       | ECHO
       | ECHO_RX_INTERVAL
       | INTERVAL
       | NEIGHBOR SRC_IP src_ip = IP_ADDRESS DEST_IP dst_ip = IP_ADDRESS
       | NEIGHBOR SRC_IP src_ip6 = IPV6_ADDRESS DEST_IP dst_ip6 = IPV6_ADDRESS
       | OPTIMIZE SUBINTERFACE
   ) NEWLINE
;

if_no_ip
:
  IP
  (
    if_no_ip_address
    | if_no_ip_flowspec
  )
;

if_no_ip_address
:
   ADDRESS NEWLINE
;

if_no_ip_flowspec
:
  FLOWSPEC NEWLINE
;

if_no_mka
:
  MKA null_rest_of_line
;

if_no_routing_dynamic
:
   ROUTING DYNAMIC NEWLINE
;

if_no_synchronous
:
  SYNCHRONOUS null_rest_of_line
;

if_null_block
:
   NO?
   (
      ACTIVE
      | AFFINITY
      | ANTENNA
      | ARP
      | ASYNC
      | ATM
      | AUTHENTICATION
      | AUTO
      | AUTOROUTE
      | BANDWIDTH GUARANTEED
      | BANDWIDTH INHERIT
      | BANDWIDTH PERCENT_LITERAL
      | BEACON
      | BGP_POLICY
      | BRIDGE_GROUP
      | BUNDLE
      | CABLE
      | CABLELENGTH
      | CARRIER_DELAY
      | CDP
      | CHANNEL
      | CHANNEL_PROTOCOL
      | CLASS
      | CLNS
      | CLOCK
      | COUNTER
      | CRC
      | CRYPTO
      | DAMPENING
      | DCB
      | DCBX
      | DCB_POLICY
      | DELAY
      | DESTINATION
      | DIALER
      | DIALER_GROUP
      | DFS
      | DOWNSTREAM
      | DSL
      |
      (
         DSU BANDWIDTH
      )
      | DUPLEX
      | ENABLE
      | ENCRYPTION
      | ETHERNET
      | EXIT
      | FAIR_QUEUE
      | FAST_REROUTE
      | FLOW
      | FLOW_CONTROL
      | FLOWCONTROL
      | FORWARDER
      | FRAME_RELAY
      | FRAMING
      | FULL_DUPLEX
      | GIG_DEFAULT
      | GLBP
      | GROUP_RANGE
      | H323_GATEWAY
      | HALF_DUPLEX
      | HARDWARE
      | HISTORY
      | HOLD_QUEUE
      |
      (
         HSRP
         (
            BFD
            | DELAY
            | USE_BIA
            | VERSION
         )
      )
      | IGNORE
      | INGRESS
      |
      (
         IP
         (
            ACCOUNTING
            | ADDRESS
            (
               NEGOTIATED
            )
            | ARP
            | BGP
            | BROADCAST_ADDRESS
            | CGMP
            | CONTROL_APPS_USE_MGMT_PORT
            | DVMRP
            |
            (
               DIRECTED_BROADCAST
            )
            | FLOW
            | IP_ADDRESS
            | IRDP
            | LOAD_SHARING
            | MASK_REPLY
            | MROUTE_CACHE
            | MTU
            | MULTICAST
            | MULTICAST_BOUNDARY
            | NHRP
            |
            (
               OSPF
               (
                  AUTHENTICATION
                  | AUTHENTICATION_KEY
                  | BFD
                  | DEMAND_CIRCUIT
                  | MESSAGE_DIGEST_KEY
                  | MTU_IGNORE
                  | PRIORITY
                  | RETRANSMIT_INTERVAL
                  | TRANSMIT_DELAY
               )
            )
            |
            (
               PIM
               (
                  BORDER
                  | BORDER_ROUTER
                  | BSR_BORDER
                  | DENSE_MODE
                  | DR_PRIORITY
                  | HELLO_INTERVAL
                  | JOIN_PRUNE_INTERVAL
                  | PASSIVE
                  | QUERY_INTERVAL
                  | SNOOPING
                  | SPARSE_DENSE_MODE
                  | SPARSE_MODE
                  | SPARSE_MODE_SSM
               )
            )
            | PIM_SPARSE
            | PORT_UNREACHABLE
            | REDIRECT
            | REDIRECTS
            | RIP
            | ROUTE_CACHE
            | RSVP
            | SAP
            | SDR
            | UNNUMBERED
            | UNREACHABLES
            | VERIFY
            | VIRTUAL_REASSEMBLY
            | WCCP
         )
      )
      |
      (
         IPV4
         (
            ICMP
            | MTU
            | POINT_TO_POINT
            | UNNUMBERED
            | UNREACHABLES
            | VERIFY
         )
      )
      | IPV6
      | ISDN
      |
      (
         ISIS
         (
            AUTHENTICATION
            | CSNP_INTERVAL
            | DS_HELLO_INTERVAL
            | HELLO
            | HELLO_INTERVAL
            | HELLO_MULTIPLIER
            | LSP_INTERVAL
            | POINT_TO_POINT
            | PROTOCOL
            | SMALL_HELLO
            | WIDE_METRIC
         )
      )
      | KEEPALIVE
      | L2_FILTER
      | L2PROTOCOL_TUNNEL
      | L2TRANSPORT
      | LANE
      | LAPB
      | LACP
      | LINK
      | LINK_FAULT_SIGNALING
      | LLDP
      | LOAD_BALANCING
      | LOAD_INTERVAL
      | LOGGING
      | LOOPBACK
      | LRE
      | MAC
      | MAC_ADDRESS
      | MACRO
      | MANAGEMENT
      | MANAGEMENT_ONLY
      | MAP_GROUP
      | MDIX
      | MEDIA_TYPE
      | MEDIUM
      | MEMBER
      | MINIMUM_LINKS
      | MLS
      | MOBILITY
      | MOP
      | MPLS
      | NAME
      | NEGOTIATE
      | NEGOTIATION
      | NMSP
      |
      (
         NO
         (
            DESCRIPTION
         )
      )
      |
      (
         NTP
         (
            BROADCAST
            | DISABLE
            | MULTICAST
         )
      )
      | NV
      | OPENFLOW
      | OPTICAL_MONITOR
      | OSPFV3
      | PACKET
      | PATH_OPTION
      | PEAKDETECT
      | PEER
      | PFC PRIORITY
      | PHYSICAL_LAYER
      | PLATFORM
      | PORT_CHANNEL
      | PORT_CHANNEL_PROTOCOL
      | PORT_NAME
      | PORT_TYPE
      | PORTMODE
      | POS
      | POWER
      | POWER_LEVEL
      | PPP
      | PREEMPT
      | PRIORITY
      | PRIORITY_FLOW_CONTROL
      | PRIORITY_QUEUE
      | QOS
      | QUEUE_MONITOR
      | QUEUE_SET
      | RANDOM_DETECT
      | RATE_LIMIT
      | RATE_MODE
      | RCV_QUEUE
      | REDIRECTS
      | REMOTE
      | ROUTE_CACHE
      | ROUTE_ONLY
      | SCRAMBLE
      | SERIAL
      | SERVICE_MODULE
      | SFLOW
      | SHAPE
      | SIGNALLED_BANDWIDTH
      | SIGNALLED_NAME
      | SONET
      | SOURCE
      | SPEED_DUPLEX
      | SNMP
      | SRR_QUEUE
      | SSID
      | STACK_MIB
      | STATION_ROLE
      | STBC
      | STORM_CONTROL
      |
      (
         SWITCHPORT
         (
            BACKUP
            | BLOCK
            | DOT1Q
            | EMPTY
            |
            (
               MODE PRIVATE_VLAN
            )
            | MONITOR
            | NONEGOTIATE
            | PORT_SECURITY
            | PRIORITY
            | TAP
            | TOOL
            |
            (
               TRUNK PRUNING
            )
            | VOICE
            | VLAN
         )
      )
      | TAG_SWITCHING
      | TAGGED
      | TAP
      | TCAM
      | TRANSCEIVER
      | TRANSPORT_MODE
      | TRUST
      | TUNABLE_OPTIC
      | TX_QUEUE
      | UC_TX_QUEUE
      | UDLD
      | UNTAGGED
      | VLT_PEER_LAG
      | VMTRACER
      | VPC
      | VTP
      | WEIGHTING
      | WRR_QUEUE
      | X25
      | XCONNECT
   ) ~NEWLINE* NEWLINE if_null_inner*
;

if_null_inner
:
   NO?
   (
      ADDRESS
      | BACKUP
      | BRIDGE_DOMAIN
      | DIALER
      | ENCAPSULATION
      | L2PROTOCOL
      | MODE
      | PRIORITY
      | PROPAGATE
      | PROTOCOL
      | RECEIVE
      | REMOTE_PORTS
      | REWRITE
      | SATELLITE_FABRIC_LINK
      | TRANSMIT
      | VIRTUAL_ADDRESS
   ) ~NEWLINE* NEWLINE  // do not change to null_rest_of_line
;

if_null_single
:
  NO?
  (
    BCMC_OPTIMIZATION
    | DOT1X
    | IP TRAFFIC_EXPORT
    | JUMBO
    | LINKDEBOUNCE
    | MAB
    | PHY
    | REDUNDANCY
    |
    (
      SPEED NONEGOTIATE
    )
    | SWITCHPORT CAPTURE
    | SUPPRESS_ARP
    | TRIMODE
    | TRUSTED
  ) ~NEWLINE* NEWLINE // do not change to null_rest_of_line

;

if_port_security
:
   PORT SECURITY NEWLINE
   (
      if_port_security_null
   )*
;

if_private_vlan
:
   PRIVATE_VLAN MAPPING (ADD | REMOVE)? null_rest_of_line
;

if_pvc
:
  PVC null_rest_of_line pvc_null*
;

pvc_null
:
  NO?
  (
    DIALER
    | ENCAPSULATION
    | PROTOCOL
  ) null_rest_of_line
;

if_routing_dynamic
:
   ROUTING DYNAMIC NEWLINE
;

if_service_instance
:
   SERVICE INSTANCE id = dec ETHERNET NEWLINE
   if_si_inner*
;

if_si_inner
:
    if_si_bridge_domain
    | if_si_encapsulation
    | if_si_l2protocol
    | if_si_no_bridge_domain
    | if_si_rewrite
    | if_si_service_policy
;

if_si_bridge_domain
:
    BRIDGE_DOMAIN id = dec SPLIT_HORIZON? NEWLINE
;

if_si_encapsulation
:
    NO? ENCAPSULATION null_rest_of_line
;

if_si_l2protocol
:
    L2PROTOCOL TUNNEL? (DROP | FORWARD | PEER)? (CDP | DOT1X | DTP | LACP | PAGP | STP | VTP)? NEWLINE
;

if_si_no_bridge_domain
:
    NO BRIDGE_DOMAIN id = dec NEWLINE
;

if_si_rewrite
:
    REWRITE null_rest_of_line
;

if_si_service_policy
:
    SERVICE_POLICY (INPUT | OUTPUT) policy_map = variable NEWLINE
;

if_spanning_tree
:
   NO? SPANNING_TREE
   (
      if_st_null
      | if_st_portfast
      | NEWLINE
   )
;

if_speed_auto
:
   SPEED AUTO NEWLINE
;

if_speed_ios
:
   SPEED mbits = dec NEWLINE
;

if_speed_ios_dot11radio
:
// https://www.cisco.com/en/US/docs/routers/access/800/880/software/configuration/guide/880_radio_config.html
   SPEED
   (
      BASIC_1_0
      | BASIC_2_0
      | BASIC_5_5
      | BASIC_6_0
      | BASIC_9_0
      | BASIC_11_0
      | BASIC_12_0
      | BASIC_18_0
      | BASIC_24_0
      | BASIC_36_0
      | BASIC_48_0
      | BASIC_54_0
      | DEFAULT
      | FLOAT
      | M0_7
      | M0_DOT
      | M1_DOT
      | M2_DOT
      | M3_DOT
      | M4_DOT
      | M5_DOT
      | M6_DOT
      | M7_DOT
      | M8_15
      | M8_DOT
      | M9_DOT
      | M10_DOT
      | M11_DOT
      | M12_DOT
      | M13_DOT
      | M14_DOT
      | M15_DOT
      | OFDM
      | OFDM_THROUGHPUT
      | ONLY_OFDM
      | RANGE
      | THROUGHPUT
   )* NEWLINE
;

if_st_null
:
   (
      BPDUFILTER
      | BPDUGUARD
      | COST
      | GUARD
      | LINK_TYPE
      | MST
      | PORT
      | PORT_PRIORITY
      | PRIORITY
      | PROTECT
      | RSTP
      | VLAN
   ) null_rest_of_line
;

if_st_portfast
:
   PORTFAST
   (
      disable = DISABLE
      | edge = EDGE
      | network = NETWORK
      | trunk = TRUNK
   )* NEWLINE
;

if_port_security_null
:
   NO?
   (
      AGE
      | ENABLE
      | MAXIMUM
      | SECURE_MAC_ADDRESS
      | VIOLATION
   ) null_rest_of_line
;

if_service_policy
:
   SERVICE_POLICY
   (
      TYPE (
         CONTROL SUBSCRIBER
         | PBR
         | QOS
         | QUEUING
      )
   )?
   (INPUT | OUTPUT)?
   policy_map = variable NEWLINE
;

if_shutdown
:
   NO?
   (
      DISABLE
      | SHUTDOWN
   ) FORCE? LAN? NEWLINE
;

if_standby
:
  NO? STANDBY
  (
    standby_group
    | standby_version
  ) NEWLINE
;

standby_group
:
  group = dec
  (
    standby_group_authentication
    | standby_group_ip
    | standby_group_preempt
    | standby_group_priority
    | standby_group_timers
    | standby_group_track
  )
;

standby_group_authentication
:
  AUTHENTICATION auth = variable
;

standby_group_ip
:
  IP ip = IP_ADDRESS
;

standby_group_preempt
:
  PREEMPT standby_group_preempt_delay?
;

standby_group_preempt_delay
:
  DELAY
  (
     MINIMUM min_secs = dec
     | RELOAD reload_secs = dec
     | SYNC sync_secs = dec
  )+
;

standby_group_priority
:
  PRIORITY priority = dec
;

standby_group_timers
:
  TIMERS
  (
     MSEC hello_ms = dec
     | hello_sec = dec
  )
  (
     MSEC hold_ms = dec
     | hold_sec = dec
  )
;

standby_group_track
:
  TRACK group = dec track_action
;

track_action
:
  track_action_decrement
;

track_action_decrement
:
  DECREMENT subtrahend = dec
;

standby_version
:
  VERSION version = variable_permissive
;

if_switchport
:
   NO? SWITCHPORT NEWLINE
;

if_switchport_access
:
   SWITCHPORT ACCESS VLAN
   (
      vlan = dec
      | DYNAMIC
   ) NEWLINE
;

if_switchport_mode
:
   SWITCHPORT MODE
   (
      ACCESS
      | DOT1Q_TUNNEL
      |
      (
         DYNAMIC
         (
            AUTO
            | DESIRABLE
         )
      )
      | FEX_FABRIC
      | if_switchport_mode_monitor
      | TAP
      | TOOL
      | TRUNK
   ) NEWLINE
;

if_switchport_mode_monitor
:
   MONITOR BUFFER_LIMIT limit=dec (BYTES | KBYTES | MBYTES | PACKETS)
;

if_switchport_private_vlan_association
:
   SWITCHPORT PRIVATE_VLAN ASSOCIATION TRUNK primary_vlan_id = dec
   secondary_vlan_id = dec NEWLINE
;

if_switchport_private_vlan_host_association
:
   SWITCHPORT PRIVATE_VLAN HOST_ASSOCIATION primary_vlan_id = dec
   secondary_vlan_id = dec NEWLINE
;

if_switchport_private_vlan_mapping
:
   SWITCHPORT PRIVATE_VLAN MAPPING TRUNK? primary_vlan_id = dec
   secondary_vlan_list = range NEWLINE
;

if_switchport_trunk_allowed
:
   SWITCHPORT TRUNK ALLOWED VLAN
   (
      NONE
      |
      (
         ADD? r = range
      )
   ) NEWLINE
;

if_switchport_trunk_encapsulation
:
   SWITCHPORT TRUNK ENCAPSULATION e = switchport_trunk_encapsulation NEWLINE
;

if_switchport_trunk_native
:
   SWITCHPORT TRUNK NATIVE VLAN vlan = dec NEWLINE
;

if_tunnel
:
   TUNNEL
   (
       iftunnel_bandwidth
       | iftunnel_destination
       | iftunnel_key
       | iftunnel_mode
       | iftunnel_path_mtu_discovery
       | iftunnel_protection
       | iftunnel_source
   )
;

if_vlan
:
  VLAN vlan = vlan_id NEWLINE
;

if_vrf
:
   VRF name = variable NEWLINE
;

if_vrf_member
:
   VRF MEMBER name = variable NEWLINE
;

if_vrrp
:
   VRRP groupnum = dec
   (
      ifvrrp_advertisement
      | ifvrrp_authentication
      | ifvrrp_description
      | ifvrrp_ip
      | ifvrrp_ipv4
      | ifvrrp_ipv6
      | ifvrrp_preempt
      | ifvrrp_priority
      | ifvrrp_priority_level
   )
;

if_vrrpno
:
   NO VRRP groupnum = dec
   (
      ifvrrpno_preempt
   )
;

ifvrrpno_preempt
:
   PREEMPT NEWLINE
;

if_zone_member
:
   ZONE_MEMBER SECURITY? name = variable_permissive NEWLINE
;

ifdhcp_null
:
   (
      SMART_RELAY
      | SNOOPING
   ) null_rest_of_line
;

ifdhcp_relay
:
   RELAY
   (
      ifdhcpr_address
      | ifdhcpr_client
      | ifdhcpr_null
   )
;

ifdhcpr_address
:
   ADDRESS address = IP_ADDRESS NEWLINE
;

ifdhcpr_client
:
   CLIENT NEWLINE
;

ifdhcpr_null
:
   (
      INFORMATION
      | SUBNET_BROADCAST
   ) null_rest_of_line
;

ifigmp_access_group
:
   ACCESS_GROUP name = variable NEWLINE
;

ifigmp_host_proxy
:
   HOST_PROXY (
       ifigmphp_access_list
       | ifigmphp_null
   )
;

ifigmphp_access_list
:
   ACCESS_LIST name = variable NEWLINE
;

ifigmphp_null
:
   (
      EXCLUDE
      | INCLUDE
      | IP_ADDRESS
      | REPORT_INTERVAL
      | VERSION
   ) null_rest_of_line

;

ifigmp_null
:
   (
      GROUP_TIMEOUT
      | JOIN_GROUP
      | LAST_MEMBER_QUERY_COUNT
      | LAST_MEMBER_QUERY_INTERVAL
      | LAST_MEMBER_QUERY_RESPONSE_TIME
      | MULTICAST_STATIC_ONLY
      | QUERY_INTERVAL
      | QUERY_MAX_RESPONSE_TIME
      | QUERY_TIMEOUT
      | ROBUSTNESS_VARIABLE
      | ROUTER_ALERT
      | SNOOPING
      | STARTUP_QUERY_COUNT
      | STARTUP_QUERY_INTERVAL
      | TCN
      | V3_QUERY_MAX_RESPONSE_TIME
      | VERSION
   ) null_rest_of_line
;

ifigmp_static_group
:
   STATIC_GROUP
   (
      ifigmpsg_acl
      | ifigmpsg_null
   )
;

ifigmpsg_acl
:
   ACL name = variable NEWLINE
;

ifigmpsg_null
:
   (
      IP_ADDRESS
      | RANGE
   ) null_rest_of_line
;

iftunnel_bandwidth
:
   BANDWIDTH 
   (
      RECEIVE
      | TRANSMIT
   ) dec NEWLINE
;


iftunnel_destination
:
   DESTINATION IP_ADDRESS NEWLINE
;

iftunnel_key
:
   KEY keynum = dec NEWLINE
;

iftunnel_mode
:
   MODE
   (
     gre_multipoint = GRE MULTIPOINT
     | ipsec_ipv4 = IPSEC IPV4
     | ipv6ip = IPV6IP
   )
   NEWLINE
;

iftunnel_path_mtu_discovery
:
   PATH_MTU_DISCOVERY NEWLINE
;

iftunnel_protection
:
   PROTECTION IPSEC PROFILE name = variable NEWLINE
;

iftunnel_source
:
   SOURCE 
   (
     DYNAMIC
     | IP_ADDRESS
     | iname = interface_name_unstructured
   ) NEWLINE
;

ifvrrp_advertisement
:
   ADVERTISEMENT INTERVAL secs = dec NEWLINE
;

ifvrrp_authentication
:
   AUTHENTICATION TEXT text = variable_permissive NEWLINE
;

ifvrrp_description
:
   description_line
;

ifvrrp_ip
:
   IP ip = IP_ADDRESS SECONDARY? NEWLINE
;

ifvrrp_ipv4
:
   IPV4 ip = IP_ADDRESS NEWLINE
;

ifvrrp_ipv6
:
   IPV6 ip = IPV6_ADDRESS NEWLINE
;

ifvrrp_preempt
:
   PREEMPT DELAY
   (
      MINIMUM
      | RELOAD
   ) dec NEWLINE
;

ifvrrp_priority
:
   PRIORITY priority = dec NEWLINE
;

ifvrrp_priority_level
:
   PRIORITY_LEVEL priority = dec NEWLINE
;

s_interface
:
   INTERFACE PRECONFIGURE? iname = interface_name
   (
      L2TRANSPORT
      | MULTIPOINT
      | POINT_TO_POINT
   )?
   NEWLINE
   if_inner*
;

if_inner
:
   if_autostate
   | if_bandwidth
   | if_bfd
   | if_channel_group
   | if_crypto_map
   | if_default_gw
   | if_delay
   | if_description
   | if_encapsulation
   | if_flow_sampler
   | if_hsrp
   | if_hsrp6
   | if_ip
   | if_ip_proxy_arp
   | if_ip_access_group
   | if_ip_address
   | if_ip_address_secondary
   | if_ip_dhcp
   | if_ip_forward
   | if_ip_igmp
   | if_ip_ospf_cost
   | if_ip_ospf_passive_interface
   | if_ip_ospf_shutdown
   | if_ip_passive_interface_eigrp
   | if_ip_sticky_arp
   | if_ip_vrf_forwarding
   | if_ipv6
   | if_isis_circuit_type
   | if_isis_enable
   | if_isis_hello_interval
   | if_isis_metric
   | if_isis_network
   | if_isis_passive
   | if_isis_tag
   | if_load_interval
   | if_member_interface
   | if_mka
   | if_mtu
   | if_network_clock
   | if_no
   | if_port_security
   | if_private_vlan
   | if_pvc
   | if_routing_dynamic
   | if_service_instance
   | if_service_policy
   | if_shutdown
   | if_spanning_tree
   | if_speed_auto
   | if_speed_ios
   | if_speed_ios_dot11radio
   | if_standby
   | if_switchport
   | if_switchport_access
   | if_switchport_mode
   | if_switchport_private_vlan_association
   | if_switchport_private_vlan_host_association
   | if_switchport_private_vlan_mapping
   | if_switchport_trunk_allowed
   | if_switchport_trunk_encapsulation
   | if_switchport_trunk_native
   | if_tunnel
   | if_vlan
   | if_vrf
   | if_vrf_member
   | if_vrrp
   | if_vrrpno
   | if_zone_member
   // do not rearrange items below
 
   | if_null_single
   | if_null_block
;",8139,False,1935.645049383404,median
"= v1beta1.PodSecurityPolicy
{product-author}
{product-version}
:data-uri:
:icons:
:toc: macro
:toc-title:
:toclevels: 2

toc::[]

== Description
[%hardbreaks]
PodSecurityPolicy governs the ability to make requests that affect the Security Context that will be applied to a pod and container. Deprecated: use PodSecurityPolicy from policy API Group instead.

== Object Schema
Expand or mouse-over a field for more information about it.

++++
<pre>
<div style=""margin-left:13px;""><span title=""(string) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"">apiVersion</span>:
</div><div style=""margin-left:13px;""><span title=""(string) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">kind</span>:
</div><details open><summary><span title=""(v1.ObjectMeta) Standard object&#39;s metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"">metadata</span>:
</summary><details><summary>  <span title=""(object) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"">annotations</span>:
</summary><div style=""margin-left:13px;"">    <span title=""(string)"">[string]</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(string) The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."">clusterName</span>:
</div><div style=""margin-left:13px;"">  <span title=""(v1.Time) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"">creationTimestamp</span>:
</div><div style=""margin-left:13px;"">  <span title=""(integer) Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."">deletionGracePeriodSeconds</span>:
</div><div style=""margin-left:13px;"">  <span title=""(v1.Time) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"">deletionTimestamp</span>:
</div><details><summary>  <span title=""(array) Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."">finalizers</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(string) GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency"">generateName</span>:
</div><div style=""margin-left:13px;"">  <span title=""(integer) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."">generation</span>:
</div><details><summary>  <span title=""(v1.Initializers) An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven&#39;t explicitly asked to observe uninitialized objects.

When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user."">initializers</span>:
</summary><details><summary>    <span title=""(array) Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients."">pending</span>:
</summary><div style=""margin-left:13px;"">    - <span title=""(string) name of the process that is responsible for initializing this object."">name</span>:
</div></details><details><summary>    <span title=""(v1.Status) If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion."">result</span>:
</summary><div style=""margin-left:13px;"">      <span title=""(string) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"">apiVersion</span>:
</div><div style=""margin-left:13px;"">      <span title=""(integer) Suggested HTTP return code for this status, 0 if not set."">code</span>:
</div><details><summary>      <span title=""(v1.StatusDetails) Extended data associated with the reason.  Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type."">details</span>:
</summary><details><summary>        <span title=""(array) The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes."">causes</span>:
</summary><div style=""margin-left:13px;"">        - <span title=""(string) The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed.  Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

Examples:
  &#34;name&#34; - the field &#34;name&#34; on the current resource
  &#34;items[0].name&#34; - the field &#34;name&#34; on the first array entry in &#34;items&#34;"">field</span>:
</div><div style=""margin-left:13px;"">          <span title=""(string) A human-readable description of the cause of the error.  This field may be presented as-is to a reader."">message</span>:
</div><div style=""margin-left:13px;"">          <span title=""(string) A machine-readable description of the cause of the error. If this value is empty there is no information available."">reason</span>:
</div></details><div style=""margin-left:13px;"">        <span title=""(string) The group attribute of the resource associated with the status StatusReason."">group</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">kind</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)."">name</span>:
</div><div style=""margin-left:13px;"">        <span title=""(integer) If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action."">retryAfterSeconds</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids"">uid</span>:
</div></details><div style=""margin-left:13px;"">      <span title=""(string) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">kind</span>:
</div><div style=""margin-left:13px;"">      <span title=""(string) A human-readable description of the status of this operation."">message</span>:
</div><details><summary>      <span title=""(v1.ListMeta) Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">metadata</span>:
</summary><div style=""margin-left:13px;"">        <span title=""(string) continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response."">continue</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) String that identifies the server&#39;s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"">resourceVersion</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) selfLink is a URL representing this object. Populated by the system. Read-only."">selfLink</span>:
</div></details><div style=""margin-left:13px;"">      <span title=""(string) A machine-readable description of why this operation is in the &#34;Failure&#34; status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it."">reason</span>:
</div><div style=""margin-left:13px;"">      <span title=""(string) Status of the operation. One of: &#34;Success&#34; or &#34;Failure&#34;. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status"">status</span>:
</div></details></details><details><summary>  <span title=""(object) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"">labels</span>:
</summary><div style=""margin-left:13px;"">    <span title=""(string)"">[string]</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(string) Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"">name</span>:
</div><div style=""margin-left:13px;"">  <span title=""(string) Namespace defines the space within each name must be unique. An empty namespace is equivalent to the &#34;default&#34; namespace, but &#34;default&#34; is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"">namespace</span>:
</div><details><summary>  <span title=""(array) List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."">ownerReferences</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string) API version of the referent."">apiVersion</span>:
</div><div style=""margin-left:13px;"">    <span title=""(boolean) If true, AND if the owner has the &#34;foregroundDeletion&#34; finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs &#34;delete&#34; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned."">blockOwnerDeletion</span>:
</div><div style=""margin-left:13px;"">    <span title=""(boolean) If true, this reference points to the managing controller."">controller</span>:
</div><div style=""margin-left:13px;"">    <span title=""(string) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">kind</span>:
</div><div style=""margin-left:13px;"">    <span title=""(string) Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names"">name</span>:
</div><div style=""margin-left:13px;"">    <span title=""(string) UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"">uid</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(string) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"">resourceVersion</span>:
</div><div style=""margin-left:13px;"">  <span title=""(string) SelfLink is a URL representing this object. Populated by the system. Read-only."">selfLink</span>:
</div><div style=""margin-left:13px;"">  <span title=""(string) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"">uid</span>:
</div></details><details open><summary><span title=""(v1beta1.PodSecurityPolicySpec) spec defines the policy enforced."">spec</span>:
</summary><div style=""margin-left:13px;"">  <span title=""(boolean) allowPrivilegeEscalation determines if a pod can request to allow privilege escalation. If unspecified, defaults to true."">allowPrivilegeEscalation</span>:
</div><details><summary>  <span title=""(array) allowedCapabilities is a list of capabilities that can be requested to add to the container. Capabilities in this field may be added at the pod author&#39;s discretion. You must not list a capability in both allowedCapabilities and requiredDropCapabilities."">allowedCapabilities</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><details><summary>  <span title=""(array) allowedFlexVolumes is a whitelist of allowed Flexvolumes.  Empty or nil indicates that all Flexvolumes may be used.  This parameter is effective only when the usage of the Flexvolumes is allowed in the &#34;volumes&#34; field."">allowedFlexVolumes</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string) driver is the name of the Flexvolume driver."">driver</span>:
</div></details><details><summary>  <span title=""(array) allowedHostPaths is a white list of allowed host paths. Empty indicates that all host paths may be used."">allowedHostPaths</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string) pathPrefix is the path prefix that the host volume must match. It does not support `*`. Trailing slashes are trimmed when validating the path prefix with a host path.

Examples: `/foo` would allow `/foo`, `/foo/` and `/foo/bar` `/foo` would not allow `/food` or `/etc/foo`"">pathPrefix</span>:
</div><div style=""margin-left:13px;"">    <span title=""(boolean) when set to true, will allow host volumes matching the pathPrefix only if all volume mounts are readOnly."">readOnly</span>:
</div></details><details><summary>  <span title=""(array) allowedUnsafeSysctls is a list of explicitly allowed unsafe sysctls, defaults to none. Each entry is either a plain sysctl name or ends in &#34;*&#34; in which case it is considered as a prefix of allowed sysctls. Single * means all unsafe sysctls are allowed. Kubelet has to whitelist all allowed unsafe sysctls explicitly to avoid rejection.

Examples: e.g. &#34;foo/*&#34; allows &#34;foo/bar&#34;, &#34;foo/baz&#34;, etc. e.g. &#34;foo.*&#34; allows &#34;foo.bar&#34;, &#34;foo.baz&#34;, etc."">allowedUnsafeSysctls</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><details><summary>  <span title=""(array) defaultAddCapabilities is the default set of capabilities that will be added to the container unless the pod spec specifically drops the capability.  You may not list a capability in both defaultAddCapabilities and requiredDropCapabilities. Capabilities added here are implicitly allowed, and need not be included in the allowedCapabilities list."">defaultAddCapabilities</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(boolean) defaultAllowPrivilegeEscalation controls the default setting for whether a process can gain more privileges than its parent process."">defaultAllowPrivilegeEscalation</span>:
</div><details><summary>  <span title=""(array) forbiddenSysctls is a list of explicitly forbidden sysctls, defaults to none. Each entry is either a plain sysctl name or ends in &#34;*&#34; in which case it is considered as a prefix of forbidden sysctls. Single * means all sysctls are forbidden.

Examples: e.g. &#34;foo/*&#34; forbids &#34;foo/bar&#34;, &#34;foo/baz&#34;, etc. e.g. &#34;foo.*&#34; forbids &#34;foo.bar&#34;, &#34;foo.baz&#34;, etc."">forbiddenSysctls</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><details><summary>  <span title=""(v1beta1.FSGroupStrategyOptions) fsGroup is the strategy that will dictate what fs group is used by the SecurityContext."">fsGroup</span>:
</summary><details><summary>    <span title=""(array) ranges are the allowed ranges of fs groups.  If you would like to force a single fs group then supply a single range with the same start and end. Required for MustRunAs."">ranges</span>:
</summary><div style=""margin-left:13px;"">    - <span title=""(integer) max is the end of the range, inclusive."">max</span>:
</div><div style=""margin-left:13px;"">      <span title=""(integer) min is the start of the range, inclusive."">min</span>:
</div></details><div style=""margin-left:13px;"">    <span title=""(string) rule is the strategy that will dictate what FSGroup is used in the SecurityContext."">rule</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(boolean) hostIPC determines if the policy allows the use of HostIPC in the pod spec."">hostIPC</span>:
</div><div style=""margin-left:13px;"">  <span title=""(boolean) hostNetwork determines if the policy allows the use of HostNetwork in the pod spec."">hostNetwork</span>:
</div><div style=""margin-left:13px;"">  <span title=""(boolean) hostPID determines if the policy allows the use of HostPID in the pod spec."">hostPID</span>:
</div><details><summary>  <span title=""(array) hostPorts determines which host port ranges are allowed to be exposed."">hostPorts</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(integer) max is the end of the range, inclusive."">max</span>:
</div><div style=""margin-left:13px;"">    <span title=""(integer) min is the start of the range, inclusive."">min</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(boolean) privileged determines if a pod can request to be run as privileged."">privileged</span>:
</div><div style=""margin-left:13px;"">  <span title=""(boolean) readOnlyRootFilesystem when set to true will force containers to run with a read only root file system.  If the container specifically requests to run with a non-read only root file system the PSP should deny the pod. If set to false the container may run with a read only root file system if it wishes but it will not be forced to."">readOnlyRootFilesystem</span>:
</div><details><summary>  <span title=""(array) requiredDropCapabilities are the capabilities that will be dropped from the container.  These are required to be dropped and cannot be added."">requiredDropCapabilities</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><details><summary>  <span title=""(v1beta1.RunAsUserStrategyOptions) runAsUser is the strategy that will dictate the allowable RunAsUser values that may be set."">runAsUser</span>:
</summary><details><summary>    <span title=""(array) ranges are the allowed ranges of uids that may be used. If you would like to force a single uid then supply a single range with the same start and end. Required for MustRunAs."">ranges</span>:
</summary><div style=""margin-left:13px;"">    - <span title=""(integer) max is the end of the range, inclusive."">max</span>:
</div><div style=""margin-left:13px;"">      <span title=""(integer) min is the start of the range, inclusive."">min</span>:
</div></details><div style=""margin-left:13px;"">    <span title=""(string) rule is the strategy that will dictate the allowable RunAsUser values that may be set."">rule</span>:
</div></details><details><summary>  <span title=""(v1beta1.SELinuxStrategyOptions) seLinux is the strategy that will dictate the allowable labels that may be set."">seLinux</span>:
</summary><div style=""margin-left:13px;"">    <span title=""(string) rule is the strategy that will dictate the allowable labels that may be set."">rule</span>:
</div><details><summary>    <span title=""(v1.SELinuxOptions) seLinuxOptions required to run as; required for MustRunAs More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"">seLinuxOptions</span>:
</summary><div style=""margin-left:13px;"">      <span title=""(string) Level is SELinux level label that applies to the container."">level</span>:
</div><div style=""margin-left:13px;"">      <span title=""(string) Role is a SELinux role label that applies to the container."">role</span>:
</div><div style=""margin-left:13px;"">      <span title=""(string) Type is a SELinux type label that applies to the container."">type</span>:
</div><div style=""margin-left:13px;"">      <span title=""(string) User is a SELinux user label that applies to the container."">user</span>:
</div></details></details><details><summary>  <span title=""(v1beta1.SupplementalGroupsStrategyOptions) supplementalGroups is the strategy that will dictate what supplemental groups are used by the SecurityContext."">supplementalGroups</span>:
</summary><details><summary>    <span title=""(array) ranges are the allowed ranges of supplemental groups.  If you would like to force a single supplemental group then supply a single range with the same start and end. Required for MustRunAs."">ranges</span>:
</summary><div style=""margin-left:13px;"">    - <span title=""(integer) max is the end of the range, inclusive."">max</span>:
</div><div style=""margin-left:13px;"">      <span title=""(integer) min is the start of the range, inclusive."">min</span>:
</div></details><div style=""margin-left:13px;"">    <span title=""(string) rule is the strategy that will dictate what supplemental groups is used in the SecurityContext."">rule</span>:
</div></details><details><summary>  <span title=""(array) volumes is a white list of allowed volume plugins. Empty indicates that no volumes may be used. To allow all volumes you may use &#39;*&#39;."">volumes</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details></details>
</pre>
++++

== Operations

[[Post-apis-extensions-v1beta1-podsecuritypolicies]]
=== Create a PodSecurityPolicy
Create a PodSecurityPolicy

==== HTTP request
----
POST /apis/extensions/v1beta1/podsecuritypolicies HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ""kind"": ""PodSecurityPolicy"",
  ""apiVersion"": ""extensions/v1beta1"",
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X POST \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/podsecuritypolicies <<'EOF'
{
  ""kind"": ""PodSecurityPolicy"",
  ""apiVersion"": ""extensions/v1beta1"",
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1beta1.PodSecurityPolicy
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1beta1.PodSecurityPolicy
|201 Created|v1beta1.PodSecurityPolicy
|202 Accepted|v1beta1.PodSecurityPolicy
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Get-apis-extensions-v1beta1-podsecuritypolicies-name]]
=== Get a PodSecurityPolicy
Read the specified PodSecurityPolicy

==== HTTP request
----
GET /apis/extensions/v1beta1/podsecuritypolicies/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/podsecuritypolicies/$NAME
----

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the PodSecurityPolicy
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|exact|Should the export be exact.  Exact export maintains cluster-specific fields like 'Namespace'.
|export|Should this value be exported.  Export strips fields that a user can not specify.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1beta1.PodSecurityPolicy
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Get-apis-extensions-v1beta1-podsecuritypolicies]]
=== Get all PodSecurityPolicies
List or watch objects of kind PodSecurityPolicy

==== HTTP request
----
GET /apis/extensions/v1beta1/podsecuritypolicies HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/podsecuritypolicies
----

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1beta1.PodSecurityPolicyList
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf
* application/json;stream=watch
* application/vnd.kubernetes.protobuf;stream=watch


[[Get-apis-extensions-v1beta1-watch-podsecuritypolicies-name]]
=== Watch a PodSecurityPolicy
Watch changes to an object of kind PodSecurityPolicy

==== HTTP request
----
GET /apis/extensions/v1beta1/watch/podsecuritypolicies/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/watch/podsecuritypolicies/$NAME
----

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the PodSecurityPolicy
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|pretty|If 'true', then the output is pretty printed.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.WatchEvent
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf
* application/json;stream=watch
* application/vnd.kubernetes.protobuf;stream=watch


[[Get-apis-extensions-v1beta1-watch-podsecuritypolicies]]
=== Watch all PodSecurityPolicies
Watch individual changes to a list of PodSecurityPolicy

==== HTTP request
----
GET /apis/extensions/v1beta1/watch/podsecuritypolicies HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/watch/podsecuritypolicies
----

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|pretty|If 'true', then the output is pretty printed.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.WatchEvent
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf
* application/json;stream=watch
* application/vnd.kubernetes.protobuf;stream=watch


[[Put-apis-extensions-v1beta1-podsecuritypolicies-name]]
=== Update a PodSecurityPolicy
Replace the specified PodSecurityPolicy

==== HTTP request
----
PUT /apis/extensions/v1beta1/podsecuritypolicies/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ""kind"": ""PodSecurityPolicy"",
  ""apiVersion"": ""extensions/v1beta1"",
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X PUT \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/podsecuritypolicies/$NAME <<'EOF'
{
  ""kind"": ""PodSecurityPolicy"",
  ""apiVersion"": ""extensions/v1beta1"",
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1beta1.PodSecurityPolicy
|===

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the PodSecurityPolicy
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1beta1.PodSecurityPolicy
|201 Created|v1beta1.PodSecurityPolicy
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Patch-apis-extensions-v1beta1-podsecuritypolicies-name]]
=== Patch a PodSecurityPolicy
Partially update the specified PodSecurityPolicy

==== HTTP request
----
PATCH /apis/extensions/v1beta1/podsecuritypolicies/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X PATCH \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json-patch+json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/podsecuritypolicies/$NAME <<'EOF'
{
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1.Patch
|===

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the PodSecurityPolicy
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1beta1.PodSecurityPolicy
|401 Unauthorized|
|===

==== Consumes

* application/json-patch+json
* application/merge-patch+json
* application/strategic-merge-patch+json

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Delete-apis-extensions-v1beta1-podsecuritypolicies-name]]
=== Delete a PodSecurityPolicy
Delete a PodSecurityPolicy

==== HTTP request
----
DELETE /apis/extensions/v1beta1/podsecuritypolicies/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X DELETE \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/podsecuritypolicies/$NAME <<'EOF'
{
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1.DeleteOptions
|===

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the PodSecurityPolicy
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|gracePeriodSeconds|The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|orphanDependents|Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the ""orphan"" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
|propagationPolicy|Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Status
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Delete-apis-extensions-v1beta1-podsecuritypolicies]]
=== Delete all PodSecurityPolicies
Delete collection of PodSecurityPolicy

==== HTTP request
----
DELETE /apis/extensions/v1beta1/podsecuritypolicies HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -X DELETE \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/extensions/v1beta1/podsecuritypolicies
----

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Status
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf



",12270,False,2057.143579106783,median
"// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2014 The Bitcoin Core developers
// Copyright (c) 2017-2018 The Cuckoocoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#if defined(HAVE_CONFIG_H)
#include ""config/cuckoocoin-config.h""
#endif

#include ""net.h""

#include ""addrman.h""
#include ""chainparams.h""
#include ""clientversion.h""
#include ""primitives/transaction.h""
#include ""scheduler.h""
#include ""ui_interface.h""
#include ""crypto/common.h""

#ifdef WIN32
#include <string.h>
#else
#include <fcntl.h>
#endif

#ifdef USE_UPNP
#include <miniupnpc/miniupnpc.h>
#include <miniupnpc/miniwget.h>
#include <miniupnpc/upnpcommands.h>
#include <miniupnpc/upnperrors.h>
#endif

#include <boost/filesystem.hpp>
#include <boost/thread.hpp>

// Dump addresses to peers.dat every 15 minutes (900s)
#define DUMP_ADDRESSES_INTERVAL 900

#if !defined(HAVE_MSG_NOSIGNAL) && !defined(MSG_NOSIGNAL)
#define MSG_NOSIGNAL 0
#endif

// Fix for ancient MinGW versions, that don't have defined these in ws2tcpip.h.
// Todo: Can be removed when our pull-tester is upgraded to a modern MinGW version.
#ifdef WIN32
#ifndef PROTECTION_LEVEL_UNRESTRICTED
#define PROTECTION_LEVEL_UNRESTRICTED 10
#endif
#ifndef IPV6_PROTECTION_LEVEL
#define IPV6_PROTECTION_LEVEL 23
#endif
#endif

using namespace std;

namespace {
    const int MAX_OUTBOUND_CONNECTIONS = 8;

    struct ListenSocket {
        SOCKET socket;
        bool whitelisted;

        ListenSocket(SOCKET socket, bool whitelisted) : socket(socket), whitelisted(whitelisted) {}
    };
}

//
// Global state variables
//
bool fDiscover = true;
bool fListen = true;
uint64_t nLocalServices = NODE_NETWORK;
CCriticalSection cs_mapLocalHost;
map<CNetAddr, LocalServiceInfo> mapLocalHost;
static bool vfReachable[NET_MAX] = {};
static bool vfLimited[NET_MAX] = {};
static CNode* pnodeLocalHost = NULL;
uint64_t nLocalHostNonce = 0;
static std::vector<ListenSocket> vhListenSocket;
CAddrMan addrman;
int nMaxConnections = 125;
bool fAddressesInitialized = false;

vector<CNode*> vNodes;
CCriticalSection cs_vNodes;
map<CInv, CDataStream> mapRelay;
deque<pair<int64_t, CInv> > vRelayExpiration;
CCriticalSection cs_mapRelay;
limitedmap<CInv, int64_t> mapAlreadyAskedFor(MAX_INV_SZ);

static deque<string> vOneShots;
CCriticalSection cs_vOneShots;

set<CNetAddr> setservAddNodeAddresses;
CCriticalSection cs_setservAddNodeAddresses;

vector<std::string> vAddedNodes;
CCriticalSection cs_vAddedNodes;

NodeId nLastNodeId = 0;
CCriticalSection cs_nLastNodeId;

static CSemaphore *semOutbound = NULL;
boost::condition_variable messageHandlerCondition;

// Signals for message handling
static CNodeSignals g_signals;
CNodeSignals& GetNodeSignals() { return g_signals; }

void AddOneShot(string strDest)
{
    LOCK(cs_vOneShots);
    vOneShots.push_back(strDest);
}

unsigned short GetListenPort()
{
    return (unsigned short)(GetArg(""-port"", Params().GetDefaultPort()));
}

// find 'best' local address for a particular peer
bool GetLocal(CService& addr, const CNetAddr *paddrPeer)
{
    if (!fListen)
        return false;

    int nBestScore = -1;
    int nBestReachability = -1;
    {
        LOCK(cs_mapLocalHost);
        for (map<CNetAddr, LocalServiceInfo>::iterator it = mapLocalHost.begin(); it != mapLocalHost.end(); it++)
        {
            int nScore = (*it).second.nScore;
            int nReachability = (*it).first.GetReachabilityFrom(paddrPeer);
            if (nReachability > nBestReachability || (nReachability == nBestReachability && nScore > nBestScore))
            {
                addr = CService((*it).first, (*it).second.nPort);
                nBestReachability = nReachability;
                nBestScore = nScore;
            }
        }
    }
    return nBestScore >= 0;
}

//! Convert the pnSeeds6 array into usable address objects.
static std::vector<CAddress> convertSeed6(const std::vector<SeedSpec6> &vSeedsIn)
{
    // It'll only connect to one or two seed nodes because once it connects,
    // it'll get a pile of addresses with newer timestamps.
    // Seed nodes are given a random 'last seen time' of between one and two
    // weeks ago.
    const int64_t nOneWeek = 7*24*60*60;
    std::vector<CAddress> vSeedsOut;
    vSeedsOut.reserve(vSeedsIn.size());
    for (std::vector<SeedSpec6>::const_iterator i(vSeedsIn.begin()); i != vSeedsIn.end(); ++i)
    {
        struct in6_addr ip;
        memcpy(&ip, i->addr, sizeof(ip));
        CAddress addr(CService(ip, i->port));
        addr.nTime = GetTime() - GetRand(nOneWeek) - nOneWeek;
        vSeedsOut.push_back(addr);
    }
    return vSeedsOut;
}

// get best local address for a particular peer as a CAddress
// Otherwise, return the unroutable 0.0.0.0 but filled in with
// the normal parameters, since the IP may be changed to a useful
// one by discovery.
CAddress GetLocalAddress(const CNetAddr *paddrPeer)
{
    CAddress ret(CService(""0.0.0.0"",GetListenPort()),0);
    CService addr;
    if (GetLocal(addr, paddrPeer))
    {
        ret = CAddress(addr);
    }
    ret.nServices = nLocalServices;
    ret.nTime = GetAdjustedTime();
    return ret;
}

int GetnScore(const CService& addr)
{
    LOCK(cs_mapLocalHost);
    if (mapLocalHost.count(addr) == LOCAL_NONE)
        return 0;
    return mapLocalHost[addr].nScore;
}

// Is our peer's addrLocal potentially useful as an external IP source?
bool IsPeerAddrLocalGood(CNode *pnode)
{
    return fDiscover && pnode->addr.IsRoutable() && pnode->addrLocal.IsRoutable() &&
           !IsLimited(pnode->addrLocal.GetNetwork());
}

// pushes our own address to a peer
void AdvertizeLocal(CNode *pnode)
{
    if (fListen && pnode->fSuccessfullyConnected)
    {
        CAddress addrLocal = GetLocalAddress(&pnode->addr);
        // If discovery is enabled, sometimes give our peer the address it
        // tells us that it sees us as in case it has a better idea of our
        // address than we do.
        if (IsPeerAddrLocalGood(pnode) && (!addrLocal.IsRoutable() ||
             GetRand((GetnScore(addrLocal) > LOCAL_MANUAL) ? 8:2) == 0))
        {
            addrLocal.SetIP(pnode->addrLocal);
        }
        if (addrLocal.IsRoutable())
        {
            pnode->PushAddress(addrLocal);
        }
    }
}

void SetReachable(enum Network net, bool fFlag)
{
    LOCK(cs_mapLocalHost);
    vfReachable[net] = fFlag;
    if (net == NET_IPV6 && fFlag)
        vfReachable[NET_IPV4] = true;
}

// learn a new local address
bool AddLocal(const CService& addr, int nScore)
{
    if (!addr.IsRoutable())
        return false;

    if (!fDiscover && nScore < LOCAL_MANUAL)
        return false;

    if (IsLimited(addr))
        return false;

    LogPrintf(""AddLocal(%s,%i)\\n"", addr.ToString(), nScore);

    {
        LOCK(cs_mapLocalHost);
        bool fAlready = mapLocalHost.count(addr) > 0;
        LocalServiceInfo &info = mapLocalHost[addr];
        if (!fAlready || nScore >= info.nScore) {
            info.nScore = nScore + (fAlready ? 1 : 0);
            info.nPort = addr.GetPort();
        }
        SetReachable(addr.GetNetwork());
    }

    return true;
}

bool AddLocal(const CNetAddr &addr, int nScore)
{
    return AddLocal(CService(addr, GetListenPort()), nScore);
}

/** Make a particular network entirely off-limits (no automatic connects to it) */
void SetLimited(enum Network net, bool fLimited)
{
    if (net == NET_UNROUTABLE)
        return;
    LOCK(cs_mapLocalHost);
    vfLimited[net] = fLimited;
}

bool IsLimited(enum Network net)
{
    LOCK(cs_mapLocalHost);
    return vfLimited[net];
}

bool IsLimited(const CNetAddr &addr)
{
    return IsLimited(addr.GetNetwork());
}

/** vote for a local address */
bool SeenLocal(const CService& addr)
{
    {
        LOCK(cs_mapLocalHost);
        if (mapLocalHost.count(addr) == 0)
            return false;
        mapLocalHost[addr].nScore++;
    }
    return true;
}


/** check whether a given address is potentially local */
bool IsLocal(const CService& addr)
{
    LOCK(cs_mapLocalHost);
    return mapLocalHost.count(addr) > 0;
}

/** check whether a given network is one we can probably connect to */
bool IsReachable(enum Network net)
{
    LOCK(cs_mapLocalHost);
    return vfReachable[net] && !vfLimited[net];
}

/** check whether a given address is in a network we can probably connect to */
bool IsReachable(const CNetAddr& addr)
{
    enum Network net = addr.GetNetwork();
    return IsReachable(net);
}

void AddressCurrentlyConnected(const CService& addr)
{
    addrman.Connected(addr);
}


uint64_t CNode::nTotalBytesRecv = 0;
uint64_t CNode::nTotalBytesSent = 0;
CCriticalSection CNode::cs_totalBytesRecv;
CCriticalSection CNode::cs_totalBytesSent;

CNode* FindNode(const CNetAddr& ip)
{
    LOCK(cs_vNodes);
    BOOST_FOREACH(CNode* pnode, vNodes)
        if ((CNetAddr)pnode->addr == ip)
            return (pnode);
    return NULL;
}

CNode* FindNode(const std::string& addrName)
{
    LOCK(cs_vNodes);
    BOOST_FOREACH(CNode* pnode, vNodes)
        if (pnode->addrName == addrName)
            return (pnode);
    return NULL;
}

CNode* FindNode(const CService& addr)
{
    LOCK(cs_vNodes);
    BOOST_FOREACH(CNode* pnode, vNodes)
        if ((CService)pnode->addr == addr)
            return (pnode);
    return NULL;
}

CNode* ConnectNode(CAddress addrConnect, const char *pszDest)
{
    if (pszDest == NULL) {
        if (IsLocal(addrConnect))
            return NULL;

        // Look for an existing connection
        CNode* pnode = FindNode((CService)addrConnect);
        if (pnode)
        {
            pnode->AddRef();
            return pnode;
        }
    }

    /// debug print
    LogPrint(""net"", ""trying connection %s lastseen=%.1fhrs\\n"",
        pszDest ? pszDest : addrConnect.ToString(),
        pszDest ? 0.0 : (double)(GetAdjustedTime() - addrConnect.nTime)/3600.0);

    // Connect
    SOCKET hSocket;
    bool proxyConnectionFailed = false;
    if (pszDest ? ConnectSocketByName(addrConnect, hSocket, pszDest, Params().GetDefaultPort(), nConnectTimeout, &proxyConnectionFailed) :
                  ConnectSocket(addrConnect, hSocket, nConnectTimeout, &proxyConnectionFailed))
    {
        if (!IsSelectableSocket(hSocket)) {
            LogPrintf(""Cannot create connection: non-selectable socket created (fd >= FD_SETSIZE ?)\\n"");
            CloseSocket(hSocket);
            return NULL;
        }

        addrman.Attempt(addrConnect);

        // Add node
        CNode* pnode = new CNode(hSocket, addrConnect, pszDest ? pszDest : """", false);
        pnode->AddRef();

        {
            LOCK(cs_vNodes);
            vNodes.push_back(pnode);
        }

        pnode->nTimeConnected = GetTime();

        return pnode;
    } else if (!proxyConnectionFailed) {
        // If connecting to the node failed, and failure is not caused by a problem connecting to
        // the proxy, mark this as an attempt.
        addrman.Attempt(addrConnect);
    }

    return NULL;
}

void CNode::CloseSocketDisconnect()
{
    fDisconnect = true;
    if (hSocket != INVALID_SOCKET)
    {
        LogPrint(""net"", ""disconnecting peer=%d\\n"", id);
        CloseSocket(hSocket);
    }

    // in case this fails, we'll empty the recv buffer when the CNode is deleted
    TRY_LOCK(cs_vRecvMsg, lockRecv);
    if (lockRecv)
        vRecvMsg.clear();
}

void CNode::PushVersion()
{
    int nBestHeight = g_signals.GetHeight().get_value_or(0);

    int64_t nTime = (fInbound ? GetAdjustedTime() : GetTime());
    CAddress addrYou = (addr.IsRoutable() && !IsProxy(addr) ? addr : CAddress(CService(""0.0.0.0"",0)));
    CAddress addrMe = GetLocalAddress(&addr);
    GetRandBytes((unsigned char*)&nLocalHostNonce, sizeof(nLocalHostNonce));
    if (fLogIPs)
        LogPrint(""net"", ""send version message: version %d, blocks=%d, us=%s, them=%s, peer=%d\\n"", PROTOCOL_VERSION, nBestHeight, addrMe.ToString(), addrYou.ToString(), id);
    else
        LogPrint(""net"", ""send version message: version %d, blocks=%d, us=%s, peer=%d\\n"", PROTOCOL_VERSION, nBestHeight, addrMe.ToString(), id);
    PushMessage(""version"", PROTOCOL_VERSION, nLocalServices, nTime, addrYou, addrMe,
                nLocalHostNonce, FormatSubVersion(CLIENT_NAME, CLIENT_VERSION, std::vector<string>()), nBestHeight, true);
}





std::map<CNetAddr, int64_t> CNode::setBanned;
CCriticalSection CNode::cs_setBanned;

void CNode::ClearBanned()
{
    setBanned.clear();
}

bool CNode::IsBanned(CNetAddr ip)
{
    bool fResult = false;
    {
        LOCK(cs_setBanned);
        std::map<CNetAddr, int64_t>::iterator i = setBanned.find(ip);
        if (i != setBanned.end())
        {
            int64_t t = (*i).second;
            if (GetTime() < t)
                fResult = true;
        }
    }
    return fResult;
}

bool CNode::Ban(const CNetAddr &addr) {
    int64_t banTime = GetTime()+GetArg(""-bantime"", 60*60*24);  // Default 24-hour ban
    {
        LOCK(cs_setBanned);
        if (setBanned[addr] < banTime)
            setBanned[addr] = banTime;
    }
    return true;
}


std::vector<CSubNet> CNode::vWhitelistedRange;
CCriticalSection CNode::cs_vWhitelistedRange;

bool CNode::IsWhitelistedRange(const CNetAddr &addr) {
    LOCK(cs_vWhitelistedRange);
    BOOST_FOREACH(const CSubNet& subnet, vWhitelistedRange) {
        if (subnet.Match(addr))
            return true;
    }
    return false;
}

void CNode::AddWhitelistedRange(const CSubNet &subnet) {
    LOCK(cs_vWhitelistedRange);
    vWhitelistedRange.push_back(subnet);
}

#undef X
#define X(name) stats.name = name
void CNode::copyStats(CNodeStats &stats)
{
    stats.nodeid = this->GetId();
    X(nServices);
    X(nLastSend);
    X(nLastRecv);
    X(nTimeConnected);
    X(nTimeOffset);
    X(addrName);
    X(nVersion);
    X(cleanSubVer);
    X(fInbound);
    X(nStartingHeight);
    X(nSendBytes);
    X(nRecvBytes);
    X(fWhitelisted);

    // It is common for nodes with good ping times to suddenly become lagged,
    // due to a new block arriving or other large transfer.
    // Merely reporting pingtime might fool the caller into thinking the node was still responsive,
    // since pingtime does not update until the ping is complete, which might take a while.
    // So, if a ping is taking an unusually long time in flight,
    // the caller can immediately detect that this is happening.
    int64_t nPingUsecWait = 0;
    if ((0 != nPingNonceSent) && (0 != nPingUsecStart)) {
        nPingUsecWait = GetTimeMicros() - nPingUsecStart;
    }

    // Raw ping time is in microseconds, but show it to user as whole seconds (Cuckoocoin users should be well used to small numbers with many decimal places by now :)
    stats.dPingTime = (((double)nPingUsecTime) / 1e6);
    stats.dPingWait = (((double)nPingUsecWait) / 1e6);

    // Leave string empty if addrLocal invalid (not filled in yet)
    stats.addrLocal = addrLocal.IsValid() ? addrLocal.ToString() : """";
}
#undef X

// requires LOCK(cs_vRecvMsg)
bool CNode::ReceiveMsgBytes(const char *pch, unsigned int nBytes)
{
    while (nBytes > 0) {

        // get current incomplete message, or create a new one
        if (vRecvMsg.empty() ||
            vRecvMsg.back().complete())
            vRecvMsg.push_back(CNetMessage(Params().MessageStart(), SER_NETWORK, nRecvVersion));

        CNetMessage& msg = vRecvMsg.back();

        // absorb network data
        int handled;
        if (!msg.in_data)
            handled = msg.readHeader(pch, nBytes);
        else
            handled = msg.readData(pch, nBytes);

        if (handled < 0)
                return false;

        if (msg.in_data && msg.hdr.nMessageSize > MAX_PROTOCOL_MESSAGE_LENGTH) {
            LogPrint(""net"", ""Oversized message from peer=%i, disconnecting\\n"", GetId());
            return false;
        }

        pch += handled;
        nBytes -= handled;

        if (msg.complete()) {
            msg.nTime = GetTimeMicros();
            messageHandlerCondition.notify_one();
        }
    }

    return true;
}

int CNetMessage::readHeader(const char *pch, unsigned int nBytes)
{
    // copy data to temporary parsing buffer
    unsigned int nRemaining = 24 - nHdrPos;
    unsigned int nCopy = std::min(nRemaining, nBytes);

    memcpy(&hdrbuf[nHdrPos], pch, nCopy);
    nHdrPos += nCopy;

    // if header incomplete, exit
    if (nHdrPos < 24)
        return nCopy;

    // deserialize to CMessageHeader
    try {
        hdrbuf >> hdr;
    }
    catch (const std::exception&) {
        return -1;
    }

    // reject messages larger than MAX_SIZE
    if (hdr.nMessageSize > MAX_SIZE)
            return -1;

    // switch state to reading message data
    in_data = true;

    return nCopy;
}

int CNetMessage::readData(const char *pch, unsigned int nBytes)
{
    unsigned int nRemaining = hdr.nMessageSize - nDataPos;
    unsigned int nCopy = std::min(nRemaining, nBytes);

    if (vRecv.size() < nDataPos + nCopy) {
        // Allocate up to 256 KiB ahead, but never more than the total message size.
        vRecv.resize(std::min(hdr.nMessageSize, nDataPos + nCopy + 256 * 1024));
    }

    memcpy(&vRecv[nDataPos], pch, nCopy);
    nDataPos += nCopy;

    return nCopy;
}









// requires LOCK(cs_vSend)
void SocketSendData(CNode *pnode)
{
    std::deque<CSerializeData>::iterator it = pnode->vSendMsg.begin();

    while (it != pnode->vSendMsg.end()) {
        const CSerializeData &data = *it;
        assert(data.size() > pnode->nSendOffset);
        int nBytes = send(pnode->hSocket, &data[pnode->nSendOffset], data.size() - pnode->nSendOffset, MSG_NOSIGNAL | MSG_DONTWAIT);
        if (nBytes > 0) {
            pnode->nLastSend = GetTime();
            pnode->nSendBytes += nBytes;
            pnode->nSendOffset += nBytes;
            pnode->RecordBytesSent(nBytes);
            if (pnode->nSendOffset == data.size()) {
                pnode->nSendOffset = 0;
                pnode->nSendSize -= data.size();
                it++;
            } else {
                // could not send full message; stop sending more
                break;
            }
        } else {
            if (nBytes < 0) {
                // error
                int nErr = WSAGetLastError();
                if (nErr != WSAEWOULDBLOCK && nErr != WSAEMSGSIZE && nErr != WSAEINTR && nErr != WSAEINPROGRESS)
                {
                    LogPrintf(""socket send error %s\\n"", NetworkErrorString(nErr));
                    pnode->CloseSocketDisconnect();
                }
            }
            // couldn't send anything at all
            break;
        }
    }

    if (it == pnode->vSendMsg.end()) {
        assert(pnode->nSendOffset == 0);
        assert(pnode->nSendSize == 0);
    }
    pnode->vSendMsg.erase(pnode->vSendMsg.begin(), it);
}

static list<CNode*> vNodesDisconnected;

void ThreadSocketHandler()
{
    unsigned int nPrevNodeCount = 0;
    while (true)
    {
        //
        // Disconnect nodes
        //
        {
            LOCK(cs_vNodes);
            // Disconnect unused nodes
            vector<CNode*> vNodesCopy = vNodes;
            BOOST_FOREACH(CNode* pnode, vNodesCopy)
            {
                if (pnode->fDisconnect ||
                    (pnode->GetRefCount() <= 0 && pnode->vRecvMsg.empty() && pnode->nSendSize == 0 && pnode->ssSend.empty()))
                {
                    // remove from vNodes
                    vNodes.erase(remove(vNodes.begin(), vNodes.end(), pnode), vNodes.end());

                    // release outbound grant (if any)
                    pnode->grantOutbound.Release();

                    // close socket and cleanup
                    pnode->CloseSocketDisconnect();

                    // hold in disconnected pool until all refs are released
                    if (pnode->fNetworkNode || pnode->fInbound)
                        pnode->Release();
                    vNodesDisconnected.push_back(pnode);
                }
            }
        }
        {
            // Delete disconnected nodes
            list<CNode*> vNodesDisconnectedCopy = vNodesDisconnected;
            BOOST_FOREACH(CNode* pnode, vNodesDisconnectedCopy)
            {
                // wait until threads are done using it
                if (pnode->GetRefCount() <= 0)
                {
                    bool fDelete = false;
                    {
                        TRY_LOCK(pnode->cs_vSend, lockSend);
                        if (lockSend)
                        {
                            TRY_LOCK(pnode->cs_vRecvMsg, lockRecv);
                            if (lockRecv)
                            {
                                TRY_LOCK(pnode->cs_inventory, lockInv);
                                if (lockInv)
                                    fDelete = true;
                            }
                        }
                    }
                    if (fDelete)
                    {
                        vNodesDisconnected.remove(pnode);
                        delete pnode;
                    }
                }
            }
        }
        if(vNodes.size() != nPrevNodeCount) {
            nPrevNodeCount = vNodes.size();
            uiInterface.NotifyNumConnectionsChanged(nPrevNodeCount);
        }

        //
        // Find which sockets have data to receive
        //
        struct timeval timeout;
        timeout.tv_sec  = 0;
        timeout.tv_usec = 50000; // frequency to poll pnode->vSend

        fd_set fdsetRecv;
        fd_set fdsetSend;
        fd_set fdsetError;
        FD_ZERO(&fdsetRecv);
        FD_ZERO(&fdsetSend);
        FD_ZERO(&fdsetError);
        SOCKET hSocketMax = 0;
        bool have_fds = false;

        BOOST_FOREACH(const ListenSocket& hListenSocket, vhListenSocket) {
            FD_SET(hListenSocket.socket, &fdsetRecv);
            hSocketMax = max(hSocketMax, hListenSocket.socket);
            have_fds = true;
        }

        {
            LOCK(cs_vNodes);
            BOOST_FOREACH(CNode* pnode, vNodes)
            {
                if (pnode->hSocket == INVALID_SOCKET)
                    continue;
                FD_SET(pnode->hSocket, &fdsetError);
                hSocketMax = max(hSocketMax, pnode->hSocket);
                have_fds = true;

                // Implement the following logic:
                // * If there is data to send, select() for sending data. As this only
                //   happens when optimistic write failed, we choose to first drain the
                //   write buffer in this case before receiving more. This avoids
                //   needlessly queueing received data, if the remote peer is not themselves
                //   receiving data. This means properly utilizing TCP flow control signalling.
                // * Otherwise, if there is no (complete) message in the receive buffer,
                //   or there is space left in the buffer, select() for receiving data.
                // * (if neither of the above applies, there is certainly one message
                //   in the receiver buffer ready to be processed).
                // Together, that means that at least one of the following is always possible,
                // so we don't deadlock:
                // * We send some data.
                // * We wait for data to be received (and disconnect after timeout).
                // * We process a message in the buffer (message handler thread).
                {
                    TRY_LOCK(pnode->cs_vSend, lockSend);
                    if (lockSend && !pnode->vSendMsg.empty()) {
                        FD_SET(pnode->hSocket, &fdsetSend);
                        continue;
                    }
                }
                {
                    TRY_LOCK(pnode->cs_vRecvMsg, lockRecv);
                    if (lockRecv && (
                        pnode->vRecvMsg.empty() || !pnode->vRecvMsg.front().complete() ||
                        pnode->GetTotalRecvSize() <= ReceiveFloodSize()))
                        FD_SET(pnode->hSocket, &fdsetRecv);
                }
            }
        }

        int nSelect = select(have_fds ? hSocketMax + 1 : 0,
                             &fdsetRecv, &fdsetSend, &fdsetError, &timeout);
        boost::this_thread::interruption_point();

        if (nSelect == SOCKET_ERROR)
        {
            if (have_fds)
            {
                int nErr = WSAGetLastError();
                LogPrintf(""socket select error %s\\n"", NetworkErrorString(nErr));
                for (unsigned int i = 0; i <= hSocketMax; i++)
                    FD_SET(i, &fdsetRecv);
            }
            FD_ZERO(&fdsetSend);
            FD_ZERO(&fdsetError);
            MilliSleep(timeout.tv_usec/1000);
        }

        //
        // Accept new connections
        //
        BOOST_FOREACH(const ListenSocket& hListenSocket, vhListenSocket)
        {
            if (hListenSocket.socket != INVALID_SOCKET && FD_ISSET(hListenSocket.socket, &fdsetRecv))
            {
                struct sockaddr_storage sockaddr;
                socklen_t len = sizeof(sockaddr);
                SOCKET hSocket = accept(hListenSocket.socket, (struct sockaddr*)&sockaddr, &len);
                CAddress addr;
                int nInbound = 0;

                if (hSocket != INVALID_SOCKET)
                    if (!addr.SetSockAddr((const struct sockaddr*)&sockaddr))
                        LogPrintf(""Warning: Unknown socket family\\n"");

                bool whitelisted = hListenSocket.whitelisted || CNode::IsWhitelistedRange(addr);
                {
                    LOCK(cs_vNodes);
                    BOOST_FOREACH(CNode* pnode, vNodes)
                        if (pnode->fInbound)
                            nInbound++;
                }

                if (hSocket == INVALID_SOCKET)
                {
                    int nErr = WSAGetLastError();
                    if (nErr != WSAEWOULDBLOCK)
                        LogPrintf(""socket error accept failed: %s\\n"", NetworkErrorString(nErr));
                }
                else if (!IsSelectableSocket(hSocket))
                {
                    LogPrintf(""connection from %s dropped: non-selectable socket\\n"", addr.ToString());
                    CloseSocket(hSocket);
                }
                else if (nInbound >= nMaxConnections - MAX_OUTBOUND_CONNECTIONS)
                {
                    LogPrint(""net"", ""connection from %s dropped (full)\\n"", addr.ToString());
                    CloseSocket(hSocket);
                }
                else if (CNode::IsBanned(addr) && !whitelisted)
                {
                    LogPrintf(""connection from %s dropped (banned)\\n"", addr.ToString());
                    CloseSocket(hSocket);
                }
                else
                {
                    // According to the internet TCP_NODELAY is not carried into accepted sockets
                    // on all platforms.  Set it again here just to be sure.
                    int set = 1;
#ifdef WIN32
                    setsockopt(hSocket, IPPROTO_TCP, TCP_NODELAY, (const char*)&set, sizeof(int));
#else
                    setsockopt(hSocket, IPPROTO_TCP, TCP_NODELAY, (void*)&set, sizeof(int));
#endif

                    CNode* pnode = new CNode(hSocket, addr, """", true);
                    pnode->AddRef();
                    pnode->fWhitelisted = whitelisted;

                    {
                        LOCK(cs_vNodes);
                        vNodes.push_back(pnode);
                    }
                }
            }
        }

        //
        // Service each socket
        //
        vector<CNode*> vNodesCopy;
        {
            LOCK(cs_vNodes);
            vNodesCopy = vNodes;
            BOOST_FOREACH(CNode* pnode, vNodesCopy)
                pnode->AddRef();
        }
        BOOST_FOREACH(CNode* pnode, vNodesCopy)
        {
            boost::this_thread::interruption_point();

            //
            // Receive
            //
            if (pnode->hSocket == INVALID_SOCKET)
                continue;
            if (FD_ISSET(pnode->hSocket, &fdsetRecv) || FD_ISSET(pnode->hSocket, &fdsetError))
            {
                TRY_LOCK(pnode->cs_vRecvMsg, lockRecv);
                if (lockRecv)
                {
                    {
                        // typical socket buffer is 8K-64K
                        char pchBuf[0x10000];
                        int nBytes = recv(pnode->hSocket, pchBuf, sizeof(pchBuf), MSG_DONTWAIT);
                        if (nBytes > 0)
                        {
                            if (!pnode->ReceiveMsgBytes(pchBuf, nBytes))
                                pnode->CloseSocketDisconnect();
                            pnode->nLastRecv = GetTime();
                            pnode->nRecvBytes += nBytes;
                            pnode->RecordBytesRecv(nBytes);
                        }
                        else if (nBytes == 0)
                        {
                            // socket closed gracefully
                            if (!pnode->fDisconnect)
                                LogPrint(""net"", ""socket closed\\n"");
                            pnode->CloseSocketDisconnect();
                        }
                        else if (nBytes < 0)
                        {
                            // error
                            int nErr = WSAGetLastError();
                            if (nErr != WSAEWOULDBLOCK && nErr != WSAEMSGSIZE && nErr != WSAEINTR && nErr != WSAEINPROGRESS)
                            {
                                if (!pnode->fDisconnect)
                                    LogPrintf(""socket recv error %s\\n"", NetworkErrorString(nErr));
                                pnode->CloseSocketDisconnect();
                            }
                        }
                    }
                }
            }

            //
            // Send
            //
            if (pnode->hSocket == INVALID_SOCKET)
                continue;
            if (FD_ISSET(pnode->hSocket, &fdsetSend))
            {
                TRY_LOCK(pnode->cs_vSend, lockSend);
                if (lockSend)
                    SocketSendData(pnode);
            }

            //
            // Inactivity checking
            //
            int64_t nTime = GetTime();
            if (nTime - pnode->nTimeConnected > 60)
            {
                if (pnode->nLastRecv == 0 || pnode->nLastSend == 0)
                {
                    LogPrint(""net"", ""socket no message in first 60 seconds, %d %d from %d\\n"", pnode->nLastRecv != 0, pnode->nLastSend != 0, pnode->id);
                    pnode->fDisconnect = true;
                }
                else if (nTime - pnode->nLastSend > TIMEOUT_INTERVAL)
                {
                    LogPrintf(""socket sending timeout: %is\\n"", nTime - pnode->nLastSend);
                    pnode->fDisconnect = true;
                }
                else if (nTime - pnode->nLastRecv > (pnode->nVersion > BIP0031_VERSION ? TIMEOUT_INTERVAL : 90*60))
                {
                    LogPrintf(""socket receive timeout: %is\\n"", nTime - pnode->nLastRecv);
                    pnode->fDisconnect = true;
                }
                else if (pnode->nPingNonceSent && pnode->nPingUsecStart + TIMEOUT_INTERVAL * 1000000 < GetTimeMicros())
                {
                    LogPrintf(""ping timeout: %fs\\n"", 0.000001 * (GetTimeMicros() - pnode->nPingUsecStart));
                    pnode->fDisconnect = true;
                }
            }
        }
        {
            LOCK(cs_vNodes);
            BOOST_FOREACH(CNode* pnode, vNodesCopy)
                pnode->Release();
        }
    }
}









#ifdef USE_UPNP
void ThreadMapPort()
{
    std::string port = strprintf(""%u"", GetListenPort());
    const char * multicastif = 0;
    const char * minissdpdpath = 0;
    struct UPNPDev * devlist = 0;
    char lanaddr[64];

#ifndef UPNPDISCOVER_SUCCESS
    /* miniupnpc 1.5 */
    devlist = upnpDiscover(2000, multicastif, minissdpdpath, 0);
#elif MINIUPNPC_API_VERSION < 14
    /* miniupnpc 1.6 */
    int error = 0;
    devlist = upnpDiscover(2000, multicastif, minissdpdpath, 0, 0, &error);
#else
    /* miniupnpc 1.9.20150730 */
    int error = 0;
    devlist = upnpDiscover(2000, multicastif, minissdpdpath, 0, 0, 2, &error);
#endif

    struct UPNPUrls urls;
    struct IGDdatas data;
    int r;

    r = UPNP_GetValidIGD(devlist, &urls, &data, lanaddr, sizeof(lanaddr));
    if (r == 1)
    {
        if (fDiscover) {
            char externalIPAddress[40];
            r = UPNP_GetExternalIPAddress(urls.controlURL, data.first.servicetype, externalIPAddress);
            if(r != UPNPCOMMAND_SUCCESS)
                LogPrintf(""UPnP: GetExternalIPAddress() returned %d\\n"", r);
            else
            {
                if(externalIPAddress[0])
                {
                    LogPrintf(""UPnP: ExternalIPAddress = %s\\n"", externalIPAddress);
                    AddLocal(CNetAddr(externalIPAddress), LOCAL_UPNP);
                }
                else
                    LogPrintf(""UPnP: GetExternalIPAddress failed.\\n"");
            }
        }

        string strDesc = ""Cuckoocoin "" + FormatFullVersion();

        try {
            while (true) {
#ifndef UPNPDISCOVER_SUCCESS
                /* miniupnpc 1.5 */
                r = UPNP_AddPortMapping(urls.controlURL, data.first.servicetype,
                                    port.c_str(), port.c_str(), lanaddr, strDesc.c_str(), ""TCP"", 0);
#else
                /* miniupnpc 1.6 */
                r = UPNP_AddPortMapping(urls.controlURL, data.first.servicetype,
                                    port.c_str(), port.c_str(), lanaddr, strDesc.c_str(), ""TCP"", 0, ""0"");
#endif

                if(r!=UPNPCOMMAND_SUCCESS)
                    LogPrintf(""AddPortMapping(%s, %s, %s) failed with code %d (%s)\\n"",
                        port, port, lanaddr, r, strupnperror(r));
                else
                    LogPrintf(""UPnP Port Mapping successful.\\n"");;

                MilliSleep(20*60*1000); // Refresh every 20 minutes
            }
        }
        catch (const boost::thread_interrupted&)
        {
            r = UPNP_DeletePortMapping(urls.controlURL, data.first.servicetype, port.c_str(), ""TCP"", 0);
            LogPrintf(""UPNP_DeletePortMapping() returned: %d\\n"", r);
            freeUPNPDevlist(devlist); devlist = 0;
            FreeUPNPUrls(&urls);
            throw;
        }
    } else {
        LogPrintf(""No valid UPnP IGDs found\\n"");
        freeUPNPDevlist(devlist); devlist = 0;
        if (r != 0)
            FreeUPNPUrls(&urls);
    }
}

void MapPort(bool fUseUPnP)
{
    static boost::thread* upnp_thread = NULL;

    if (fUseUPnP)
    {
        if (upnp_thread) {
            upnp_thread->interrupt();
            upnp_thread->join();
            delete upnp_thread;
        }
        upnp_thread = new boost::thread(boost::bind(&TraceThread<void (*)()>, ""upnp"", &ThreadMapPort));
    }
    else if (upnp_thread) {
        upnp_thread->interrupt();
        upnp_thread->join();
        delete upnp_thread;
        upnp_thread = NULL;
    }
}

#else
void MapPort(bool)
{
    // Intentionally left blank.
}
#endif






void ThreadDNSAddressSeed()
{
    // goal: only query DNS seeds if address need is acute
    if ((addrman.size() > 0) &&
        (!GetBoolArg(""-forcednsseed"", false))) {
        MilliSleep(11 * 1000);

        LOCK(cs_vNodes);
        if (vNodes.size() >= 2) {
            LogPrintf(""P2P peers available. Skipped DNS seeding.\\n"");
            return;
        }
    }

    const vector<CDNSSeedData> &vSeeds = Params().DNSSeeds();
    int found = 0;

    LogPrintf(""Loading addresses from DNS seeds (could take a while)\\n"");

    BOOST_FOREACH(const CDNSSeedData &seed, vSeeds) {
        if (HaveNameProxy()) {
            AddOneShot(seed.host);
        } else {
            vector<CNetAddr> vIPs;
            vector<CAddress> vAdd;
            if (LookupHost(seed.host.c_str(), vIPs))
            {
                BOOST_FOREACH(CNetAddr& ip, vIPs)
                {
                    int nOneDay = 24*3600;
                    CAddress addr = CAddress(CService(ip, Params().GetDefaultPort()));
                    addr.nTime = GetTime() - 3*nOneDay - GetRand(4*nOneDay); // use a random age between 3 and 7 days old
                    vAdd.push_back(addr);
                    found++;
                }
            }
            addrman.Add(vAdd, CNetAddr(seed.name, true));
        }
    }

    LogPrintf(""%d addresses found from DNS seeds\\n"", found);
}












void DumpAddresses()
{
    int64_t nStart = GetTimeMillis();

    CAddrDB adb;
    adb.Write(addrman);

    LogPrint(""net"", ""Flushed %d addresses to peers.dat  %dms\\n"",
           addrman.size(), GetTimeMillis() - nStart);
}

void static ProcessOneShot()
{
    string strDest;
    {
        LOCK(cs_vOneShots);
        if (vOneShots.empty())
            return;
        strDest = vOneShots.front();
        vOneShots.pop_front();
    }
    CAddress addr;
    CSemaphoreGrant grant(*semOutbound, true);
    if (grant) {
        if (!OpenNetworkConnection(addr, &grant, strDest.c_str(), true))
            AddOneShot(strDest);
    }
}

void ThreadOpenConnections()
{
    // Connect to specific addresses
    if (mapArgs.count(""-connect"") && mapMultiArgs[""-connect""].size() > 0)
    {
        for (int64_t nLoop = 0;; nLoop++)
        {
            ProcessOneShot();
            BOOST_FOREACH(string strAddr, mapMultiArgs[""-connect""])
            {
                CAddress addr;
                OpenNetworkConnection(addr, NULL, strAddr.c_str());
                for (int i = 0; i < 10 && i < nLoop; i++)
                {
                    MilliSleep(500);
                }
            }
            MilliSleep(500);
        }
    }

    // Initiate network connections
    int64_t nStart = GetTime();
    while (true)
    {
        ProcessOneShot();

        MilliSleep(500);

        CSemaphoreGrant grant(*semOutbound);
        boost::this_thread::interruption_point();

        // Add seed nodes if DNS seeds are all down (an infrastructure attack?).
        if (addrman.size() == 0 && (GetTime() - nStart > 60)) {
            static bool done = false;
            if (!done) {
                LogPrintf(""Adding fixed seed nodes as DNS doesn't seem to be available.\\n"");
                addrman.Add(convertSeed6(Params().FixedSeeds()), CNetAddr(""127.0.0.1""));
                done = true;
            }
        }

        //
        // Choose an address to connect to based on most recently seen
        //
        CAddress addrConnect;

        // Only connect out to one peer per network group (/16 for IPv4).
        // Do this here so we don't have to critsect vNodes inside mapAddresses critsect.
        int nOutbound = 0;
        set<vector<unsigned char> > setConnected;
        {
            LOCK(cs_vNodes);
            BOOST_FOREACH(CNode* pnode, vNodes) {
                if (!pnode->fInbound) {
                    setConnected.insert(pnode->addr.GetGroup());
                    nOutbound++;
                }
            }
        }

        int64_t nANow = GetAdjustedTime();

        int nTries = 0;
        while (true)
        {
            CAddrInfo addr = addrman.Select();

            // if we selected an invalid address, restart
            if (!addr.IsValid() || setConnected.count(addr.GetGroup()) || IsLocal(addr))
                break;

            // If we didn't find an appropriate destination after trying 100 addresses fetched from addrman,
            // stop this loop, and let the outer loop run again (which sleeps, adds seed nodes, recalculates
            // already-connected network ranges, ...) before trying new addrman addresses.
            nTries++;
            if (nTries > 100)
                break;

            if (IsLimited(addr))
                continue;

            // only consider very recently tried nodes after 30 failed attempts
            if (nANow - addr.nLastTry < 600 && nTries < 30)
                continue;

            // do not allow non-default ports, unless after 50 invalid addresses selected already
            if (addr.GetPort() != Params().GetDefaultPort() && nTries < 50)
                continue;

            addrConnect = addr;
            break;
        }

        if (addrConnect.IsValid())
            OpenNetworkConnection(addrConnect, &grant);
    }
}

void ThreadOpenAddedConnections()
{
    {
        LOCK(cs_vAddedNodes);
        vAddedNodes = mapMultiArgs[""-addnode""];
    }

    if (HaveNameProxy()) {
        while(true) {
            list<string> lAddresses(0);
            {
                LOCK(cs_vAddedNodes);
                BOOST_FOREACH(string& strAddNode, vAddedNodes)
                    lAddresses.push_back(strAddNode);
            }
            BOOST_FOREACH(string& strAddNode, lAddresses) {
                CAddress addr;
                CSemaphoreGrant grant(*semOutbound);
                OpenNetworkConnection(addr, &grant, strAddNode.c_str());
                MilliSleep(500);
            }
            MilliSleep(120000); // Retry every 2 minutes
        }
    }

    for (unsigned int i = 0; true; i++)
    {
        list<string> lAddresses(0);
        {
            LOCK(cs_vAddedNodes);
            BOOST_FOREACH(string& strAddNode, vAddedNodes)
                lAddresses.push_back(strAddNode);
        }

        list<vector<CService> > lservAddressesToAdd(0);
        BOOST_FOREACH(string& strAddNode, lAddresses)
        {
            vector<CService> vservNode(0);
            if(Lookup(strAddNode.c_str(), vservNode, Params().GetDefaultPort(), fNameLookup, 0))
            {
                lservAddressesToAdd.push_back(vservNode);
                {
                    LOCK(cs_setservAddNodeAddresses);
                    BOOST_FOREACH(CService& serv, vservNode)
                        setservAddNodeAddresses.insert(serv);
                }
            }
        }
        // Attempt to connect to each IP for each addnode entry until at least one is successful per addnode entry
        // (keeping in mind that addnode entries can have many IPs if fNameLookup)
        {
            LOCK(cs_vNodes);
            BOOST_FOREACH(CNode* pnode, vNodes)
                for (list<vector<CService> >::iterator it = lservAddressesToAdd.begin(); it != lservAddressesToAdd.end(); it++)
                    BOOST_FOREACH(CService& addrNode, *(it))
                        if (pnode->addr == addrNode)
                        {
                            it = lservAddressesToAdd.erase(it);
                            it--;
                            break;
                        }
        }
        BOOST_FOREACH(vector<CService>& vserv, lservAddressesToAdd)
        {
            CSemaphoreGrant grant(*semOutbound);
            OpenNetworkConnection(CAddress(vserv[i % vserv.size()]), &grant);
            MilliSleep(500);
        }
        MilliSleep(120000); // Retry every 2 minutes
    }
}

// if successful, this moves the passed grant to the constructed node
bool OpenNetworkConnection(const CAddress& addrConnect, CSemaphoreGrant *grantOutbound, const char *pszDest, bool fOneShot)
{
    //
    // Initiate outbound network connection
    //
    boost::this_thread::interruption_point();
    if (!pszDest) {
        if (IsLocal(addrConnect) ||
            FindNode((CNetAddr)addrConnect) || CNode::IsBanned(addrConnect) ||
            FindNode(addrConnect.ToStringIPPort()))
            return false;
    } else if (FindNode(std::string(pszDest)))
        return false;

    CNode* pnode = ConnectNode(addrConnect, pszDest);
    boost::this_thread::interruption_point();

    if (!pnode)
        return false;
    if (grantOutbound)
        grantOutbound->MoveTo(pnode->grantOutbound);
    pnode->fNetworkNode = true;
    if (fOneShot)
        pnode->fOneShot = true;

    return true;
}


void ThreadMessageHandler()
{
    boost::mutex condition_mutex;
    boost::unique_lock<boost::mutex> lock(condition_mutex);

    SetThreadPriority(THREAD_PRIORITY_BELOW_NORMAL);
    while (true)
    {
        vector<CNode*> vNodesCopy;
        {
            LOCK(cs_vNodes);
            vNodesCopy = vNodes;
            BOOST_FOREACH(CNode* pnode, vNodesCopy) {
                pnode->AddRef();
            }
        }

        // Poll the connected nodes for messages
        CNode* pnodeTrickle = NULL;
        if (!vNodesCopy.empty())
            pnodeTrickle = vNodesCopy[GetRand(vNodesCopy.size())];

        bool fSleep = true;

        BOOST_FOREACH(CNode* pnode, vNodesCopy)
        {
            if (pnode->fDisconnect)
                continue;

            // Receive messages
            {
                TRY_LOCK(pnode->cs_vRecvMsg, lockRecv);
                if (lockRecv)
                {
                    if (!g_signals.ProcessMessages(pnode))
                        pnode->CloseSocketDisconnect();

                    if (pnode->nSendSize < SendBufferSize())
                    {
                        if (!pnode->vRecvGetData.empty() || (!pnode->vRecvMsg.empty() && pnode->vRecvMsg[0].complete()))
                        {
                            fSleep = false;
                        }
                    }
                }
            }
            boost::this_thread::interruption_point();

            // Send messages
            {
                TRY_LOCK(pnode->cs_vSend, lockSend);
                if (lockSend)
                    g_signals.SendMessages(pnode, pnode == pnodeTrickle || pnode->fWhitelisted);
            }
            boost::this_thread::interruption_point();
        }

        {
            LOCK(cs_vNodes);
            BOOST_FOREACH(CNode* pnode, vNodesCopy)
                pnode->Release();
        }

        if (fSleep)
            messageHandlerCondition.timed_wait(lock, boost::posix_time::microsec_clock::universal_time() + boost::posix_time::milliseconds(100));
    }
}






bool BindListenPort(const CService &addrBind, string& strError, bool fWhitelisted)
{
    strError = """";
    int nOne = 1;

    // Create socket for listening for incoming connections
    struct sockaddr_storage sockaddr;
    socklen_t len = sizeof(sockaddr);
    if (!addrBind.GetSockAddr((struct sockaddr*)&sockaddr, &len))
    {
        strError = strprintf(""Error: Bind address family for %s not supported"", addrBind.ToString());
        LogPrintf(""%s\\n"", strError);
        return false;
    }

    SOCKET hListenSocket = socket(((struct sockaddr*)&sockaddr)->sa_family, SOCK_STREAM, IPPROTO_TCP);
    if (hListenSocket == INVALID_SOCKET)
    {
        strError = strprintf(""Error: Couldn't open socket for incoming connections (socket returned error %s)"", NetworkErrorString(WSAGetLastError()));
        LogPrintf(""%s\\n"", strError);
        return false;
    }
    if (!IsSelectableSocket(hListenSocket))
    {
        strError = ""Error: Couldn't create a listenable socket for incoming connections"";
        LogPrintf(""%s\\n"", strError);
        return false;
    }


#ifndef WIN32
#ifdef SO_NOSIGPIPE
    // Different way of disabling SIGPIPE on BSD
    setsockopt(hListenSocket, SOL_SOCKET, SO_NOSIGPIPE, (void*)&nOne, sizeof(int));
#endif
    // Allow binding if the port is still in TIME_WAIT state after
    // the program was closed and restarted.
    setsockopt(hListenSocket, SOL_SOCKET, SO_REUSEADDR, (void*)&nOne, sizeof(int));
    // Disable Nagle's algorithm
    setsockopt(hListenSocket, IPPROTO_TCP, TCP_NODELAY, (void*)&nOne, sizeof(int));
#else
    setsockopt(hListenSocket, SOL_SOCKET, SO_REUSEADDR, (const char*)&nOne, sizeof(int));
    setsockopt(hListenSocket, IPPROTO_TCP, TCP_NODELAY, (const char*)&nOne, sizeof(int));
#endif

    // Set to non-blocking, incoming connections will also inherit this
    if (!SetSocketNonBlocking(hListenSocket, true)) {
        strError = strprintf(""BindListenPort: Setting listening socket to non-blocking failed, error %s\\n"", NetworkErrorString(WSAGetLastError()));
        LogPrintf(""%s\\n"", strError);
        return false;
    }

    // some systems don't have IPV6_V6ONLY but are always v6only; others do have the option
    // and enable it by default or not. Try to enable it, if possible.
    if (addrBind.IsIPv6()) {
#ifdef IPV6_V6ONLY
#ifdef WIN32
        setsockopt(hListenSocket, IPPROTO_IPV6, IPV6_V6ONLY, (const char*)&nOne, sizeof(int));
#else
        setsockopt(hListenSocket, IPPROTO_IPV6, IPV6_V6ONLY, (void*)&nOne, sizeof(int));
#endif
#endif
#ifdef WIN32
        int nProtLevel = PROTECTION_LEVEL_UNRESTRICTED;
        setsockopt(hListenSocket, IPPROTO_IPV6, IPV6_PROTECTION_LEVEL, (const char*)&nProtLevel, sizeof(int));
#endif
    }

    if (::bind(hListenSocket, (struct sockaddr*)&sockaddr, len) == SOCKET_ERROR)
    {
        int nErr = WSAGetLastError();
        if (nErr == WSAEADDRINUSE)
            strError = strprintf(_(""Unable to bind to %s on this computer. Cuckoocoin Core is probably already running.""), addrBind.ToString());
        else
            strError = strprintf(_(""Unable to bind to %s on this computer (bind returned error %s)""), addrBind.ToString(), NetworkErrorString(nErr));
        LogPrintf(""%s\\n"", strError);
        CloseSocket(hListenSocket);
        return false;
    }
    LogPrintf(""Bound to %s\\n"", addrBind.ToString());

    // Listen for incoming connections
    if (listen(hListenSocket, SOMAXCONN) == SOCKET_ERROR)
    {
        strError = strprintf(_(""Error: Listening for incoming connections failed (listen returned error %s)""), NetworkErrorString(WSAGetLastError()));
        LogPrintf(""%s\\n"", strError);
        CloseSocket(hListenSocket);
        return false;
    }

    vhListenSocket.push_back(ListenSocket(hListenSocket, fWhitelisted));

    if (addrBind.IsRoutable() && fDiscover && !fWhitelisted)
        AddLocal(addrBind, LOCAL_BIND);

    return true;
}

void static Discover(boost::thread_group& threadGroup)
{
    if (!fDiscover)
        return;

#ifdef WIN32
    // Get local host IP
    char pszHostName[256] = """";
    if (gethostname(pszHostName, sizeof(pszHostName)) != SOCKET_ERROR)
    {
        vector<CNetAddr> vaddr;
        if (LookupHost(pszHostName, vaddr))
        {
            BOOST_FOREACH (const CNetAddr &addr, vaddr)
            {
                if (AddLocal(addr, LOCAL_IF))
                    LogPrintf(""%s: %s - %s\\n"", __func__, pszHostName, addr.ToString());
            }
        }
    }
#else
    // Get local host ip
    struct ifaddrs* myaddrs;
    if (getifaddrs(&myaddrs) == 0)
    {
        for (struct ifaddrs* ifa = myaddrs; ifa != NULL; ifa = ifa->ifa_next)
        {
            if (ifa->ifa_addr == NULL) continue;
            if ((ifa->ifa_flags & IFF_UP) == 0) continue;
            if (strcmp(ifa->ifa_name, ""lo"") == 0) continue;
            if (strcmp(ifa->ifa_name, ""lo0"") == 0) continue;
            if (ifa->ifa_addr->sa_family == AF_INET)
            {
                struct sockaddr_in* s4 = (struct sockaddr_in*)(ifa->ifa_addr);
                CNetAddr addr(s4->sin_addr);
                if (AddLocal(addr, LOCAL_IF))
                    LogPrintf(""%s: IPv4 %s: %s\\n"", __func__, ifa->ifa_name, addr.ToString());
            }
            else if (ifa->ifa_addr->sa_family == AF_INET6)
            {
                struct sockaddr_in6* s6 = (struct sockaddr_in6*)(ifa->ifa_addr);
                CNetAddr addr(s6->sin6_addr);
                if (AddLocal(addr, LOCAL_IF))
                    LogPrintf(""%s: IPv6 %s: %s\\n"", __func__, ifa->ifa_name, addr.ToString());
            }
        }
        freeifaddrs(myaddrs);
    }
#endif
}

void StartNode(boost::thread_group& threadGroup, CScheduler& scheduler)
{
    uiInterface.InitMessage(_(""Loading addresses...""));
    // Load addresses for peers.dat
    int64_t nStart = GetTimeMillis();
    {
        CAddrDB adb;
        if (!adb.Read(addrman))
            LogPrintf(""Invalid or missing peers.dat; recreating\\n"");
    }
    LogPrintf(""Loaded %i addresses from peers.dat  %dms\\n"",
           addrman.size(), GetTimeMillis() - nStart);
    fAddressesInitialized = true;

    if (semOutbound == NULL) {
        // initialize semaphore
        int nMaxOutbound = min(MAX_OUTBOUND_CONNECTIONS, nMaxConnections);
        semOutbound = new CSemaphore(nMaxOutbound);
    }

    if (pnodeLocalHost == NULL)
        pnodeLocalHost = new CNode(INVALID_SOCKET, CAddress(CService(""127.0.0.1"", 0), nLocalServices));

    Discover(threadGroup);

    //
    // Start threads
    //

    if (!GetBoolArg(""-dnsseed"", true))
        LogPrintf(""DNS seeding disabled\\n"");
    else
        threadGroup.create_thread(boost::bind(&TraceThread<void (*)()>, ""dnsseed"", &ThreadDNSAddressSeed));

    // Map ports with UPnP
    MapPort(GetBoolArg(""-upnp"", DEFAULT_UPNP));

    // Send and receive from sockets, accept connections
    threadGroup.create_thread(boost::bind(&TraceThread<void (*)()>, ""net"", &ThreadSocketHandler));

    // Initiate outbound connections from -addnode
    threadGroup.create_thread(boost::bind(&TraceThread<void (*)()>, ""addcon"", &ThreadOpenAddedConnections));

    // Initiate outbound connections
    threadGroup.create_thread(boost::bind(&TraceThread<void (*)()>, ""opencon"", &ThreadOpenConnections));

    // Process messages
    threadGroup.create_thread(boost::bind(&TraceThread<void (*)()>, ""msghand"", &ThreadMessageHandler));

    // Dump network addresses
    scheduler.scheduleEvery(&DumpAddresses, DUMP_ADDRESSES_INTERVAL);
}

bool StopNode()
{
    LogPrintf(""StopNode()\\n"");
    MapPort(false);
    if (semOutbound)
        for (int i=0; i<MAX_OUTBOUND_CONNECTIONS; i++)
            semOutbound->post();

    if (fAddressesInitialized)
    {
        DumpAddresses();
        fAddressesInitialized = false;
    }

    return true;
}

class CNetCleanup
{
public:
    CNetCleanup() {}

    ~CNetCleanup()
    {
        // Close sockets
        BOOST_FOREACH(CNode* pnode, vNodes)
            if (pnode->hSocket != INVALID_SOCKET)
                CloseSocket(pnode->hSocket);
        BOOST_FOREACH(ListenSocket& hListenSocket, vhListenSocket)
            if (hListenSocket.socket != INVALID_SOCKET)
                if (!CloseSocket(hListenSocket.socket))
                    LogPrintf(""CloseSocket(hListenSocket) failed with error %s\\n"", NetworkErrorString(WSAGetLastError()));

        // clean up some globals (to help leak detection)
        BOOST_FOREACH(CNode *pnode, vNodes)
            delete pnode;
        BOOST_FOREACH(CNode *pnode, vNodesDisconnected)
            delete pnode;
        vNodes.clear();
        vNodesDisconnected.clear();
        vhListenSocket.clear();
        delete semOutbound;
        semOutbound = NULL;
        delete pnodeLocalHost;
        pnodeLocalHost = NULL;

#ifdef WIN32
        // Shutdown Windows Sockets
        WSACleanup();
#endif
    }
}
instance_of_cnetcleanup;







void RelayTransaction(const CTransaction& tx)
{
    CDataStream ss(SER_NETWORK, PROTOCOL_VERSION);
    ss.reserve(10000);
    ss << tx;
    RelayTransaction(tx, ss);
}

void RelayTransaction(const CTransaction& tx, const CDataStream& ss)
{
    CInv inv(MSG_TX, tx.GetHash());
    {
        LOCK(cs_mapRelay);
        // Expire old relay messages
        while (!vRelayExpiration.empty() && vRelayExpiration.front().first < GetTime())
        {
            mapRelay.erase(vRelayExpiration.front().second);
            vRelayExpiration.pop_front();
        }

        // Save original serialized message so newer versions are preserved
        mapRelay.insert(std::make_pair(inv, ss));
        vRelayExpiration.push_back(std::make_pair(GetTime() + 15 * 60, inv));
    }
    LOCK(cs_vNodes);
    BOOST_FOREACH(CNode* pnode, vNodes)
    {
        if(!pnode->fRelayTxes)
            continue;
        LOCK(pnode->cs_filter);
        if (pnode->pfilter)
        {
            if (pnode->pfilter->IsRelevantAndUpdate(tx))
                pnode->PushInventory(inv);
        } else
            pnode->PushInventory(inv);
    }
}

void CNode::RecordBytesRecv(uint64_t bytes)
{
    LOCK(cs_totalBytesRecv);
    nTotalBytesRecv += bytes;
}

void CNode::RecordBytesSent(uint64_t bytes)
{
    LOCK(cs_totalBytesSent);
    nTotalBytesSent += bytes;
}

uint64_t CNode::GetTotalBytesRecv()
{
    LOCK(cs_totalBytesRecv);
    return nTotalBytesRecv;
}

uint64_t CNode::GetTotalBytesSent()
{
    LOCK(cs_totalBytesSent);
    return nTotalBytesSent;
}

void CNode::Fuzz(int nChance)
{
    if (!fSuccessfullyConnected) return; // Don't fuzz initial handshake
    if (GetRand(nChance) != 0) return; // Fuzz 1 of every nChance messages

    switch (GetRand(3))
    {
    case 0:
        // xor a random byte with a random value:
        if (!ssSend.empty()) {
            CDataStream::size_type pos = GetRand(ssSend.size());
            ssSend[pos] ^= (unsigned char)(GetRand(256));
        }
        break;
    case 1:
        // delete a random byte:
        if (!ssSend.empty()) {
            CDataStream::size_type pos = GetRand(ssSend.size());
            ssSend.erase(ssSend.begin()+pos);
        }
        break;
    case 2:
        // insert a random byte at a random position
        {
            CDataStream::size_type pos = GetRand(ssSend.size());
            char ch = (char)GetRand(256);
            ssSend.insert(ssSend.begin()+pos, ch);
        }
        break;
    }
    // Chance of more than one change half the time:
    // (more changes exponentially less likely):
    Fuzz(2);
}

//
// CAddrDB
//

CAddrDB::CAddrDB()
{
    pathAddr = GetDataDir() / ""peers.dat"";
}

bool CAddrDB::Write(const CAddrMan& addr)
{
    // Generate random temporary filename
    unsigned short randv = 0;
    GetRandBytes((unsigned char*)&randv, sizeof(randv));
    std::string tmpfn = strprintf(""peers.dat.%04x"", randv);

    // serialize addresses, checksum data up to that point, then append csum
    CDataStream ssPeers(SER_DISK, CLIENT_VERSION);
    ssPeers << FLATDATA(Params().MessageStart());
    ssPeers << addr;
    uint256 hash = Hash(ssPeers.begin(), ssPeers.end());
    ssPeers << hash;

    // open temp output file, and associate with CAutoFile
    boost::filesystem::path pathTmp = GetDataDir() / tmpfn;
    FILE *file = fopen(pathTmp.string().c_str(), ""wb"");
    CAutoFile fileout(file, SER_DISK, CLIENT_VERSION);
    if (fileout.IsNull())
        return error(""%s: Failed to open file %s"", __func__, pathTmp.string());

    // Write and commit header, data
    try {
        fileout << ssPeers;
    }
    catch (const std::exception& e) {
        return error(""%s: Serialize or I/O error - %s"", __func__, e.what());
    }
    FileCommit(fileout.Get());
    fileout.fclose();

    // replace existing peers.dat, if any, with new peers.dat.XXXX
    if (!RenameOver(pathTmp, pathAddr))
        return error(""%s: Rename-into-place failed"", __func__);

    return true;
}

bool CAddrDB::Read(CAddrMan& addr)
{
    // open input file, and associate with CAutoFile
    FILE *file = fopen(pathAddr.string().c_str(), ""rb"");
    CAutoFile filein(file, SER_DISK, CLIENT_VERSION);
    if (filein.IsNull())
        return error(""%s: Failed to open file %s"", __func__, pathAddr.string());

    // use file size to size memory buffer
    int fileSize = boost::filesystem::file_size(pathAddr);
    int dataSize = fileSize - sizeof(uint256);
    // Don't try to resize to a negative number if file is small
    if (dataSize < 0)
        dataSize = 0;
    vector<unsigned char> vchData;
    vchData.resize(dataSize);
    uint256 hashIn;

    // read data and checksum from file
    try {
        filein.read((char *)&vchData[0], dataSize);
        filein >> hashIn;
    }
    catch (const std::exception& e) {
        return error(""%s: Deserialize or I/O error - %s"", __func__, e.what());
    }
    filein.fclose();

    CDataStream ssPeers(vchData, SER_DISK, CLIENT_VERSION);

    // verify stored checksum matches input data
    uint256 hashTmp = Hash(ssPeers.begin(), ssPeers.end());
    if (hashIn != hashTmp)
        return error(""%s: Checksum mismatch, data corrupted"", __func__);

    unsigned char pchMsgTmp[4];
    try {
        // de-serialize file header (network specific magic number) and ..
        ssPeers >> FLATDATA(pchMsgTmp);

        // ... verify the network matches ours
        if (memcmp(pchMsgTmp, Params().MessageStart(), sizeof(pchMsgTmp)))
            return error(""%s: Invalid network magic number"", __func__);

        // de-serialize address data into one CAddrMan object
        ssPeers >> addr;
    }
    catch (const std::exception& e) {
        return error(""%s: Deserialize or I/O error - %s"", __func__, e.what());
    }

    return true;
}

unsigned int ReceiveFloodSize() { return 1000*GetArg(""-maxreceivebuffer"", 5*1000); }
unsigned int SendBufferSize() { return 1000*GetArg(""-maxsendbuffer"", 1*1000); }

CNode::CNode(SOCKET hSocketIn, CAddress addrIn, std::string addrNameIn, bool fInboundIn) :
    ssSend(SER_NETWORK, INIT_PROTO_VERSION),
    addrKnown(5000, 0.001),
    setInventoryKnown(SendBufferSize() / 1000)
{
    nServices = 0;
    hSocket = hSocketIn;
    nRecvVersion = INIT_PROTO_VERSION;
    nLastSend = 0;
    nLastRecv = 0;
    nSendBytes = 0;
    nRecvBytes = 0;
    nTimeConnected = GetTime();
    nTimeOffset = 0;
    addr = addrIn;
    addrName = addrNameIn == """" ? addr.ToStringIPPort() : addrNameIn;
    nVersion = 0;
    strSubVer = """";
    fWhitelisted = false;
    fOneShot = false;
    fClient = false; // set by version message
    fInbound = fInboundIn;
    fNetworkNode = false;
    fSuccessfullyConnected = false;
    fDisconnect = false;
    nRefCount = 0;
    nSendSize = 0;
    nSendOffset = 0;
    hashContinue = uint256();
    nStartingHeight = -1;
    fGetAddr = false;
    fRelayTxes = false;
    pfilter = new CBloomFilter();
    nPingNonceSent = 0;
    nPingUsecStart = 0;
    nPingUsecTime = 0;
    fPingQueued = false;

    {
        LOCK(cs_nLastNodeId);
        id = nLastNodeId++;
    }

    if (fLogIPs)
        LogPrint(""net"", ""Added connection to %s peer=%d\\n"", addrName, id);
    else
        LogPrint(""net"", ""Added connection peer=%d\\n"", id);

    // Be shy and don't send version until we hear
    if (hSocket != INVALID_SOCKET && !fInbound)
        PushVersion();

    GetNodeSignals().InitializeNode(GetId(), this);
}

CNode::~CNode()
{
    CloseSocket(hSocket);

    if (pfilter)
        delete pfilter;

    GetNodeSignals().FinalizeNode(GetId());
}

void CNode::AskFor(const CInv& inv)
{
    if (mapAskFor.size() > MAPASKFOR_MAX_SZ)
        return;
    // We're using mapAskFor as a priority queue,
    // the key is the earliest time the request can be sent
    int64_t nRequestTime;
    limitedmap<CInv, int64_t>::const_iterator it = mapAlreadyAskedFor.find(inv);
    if (it != mapAlreadyAskedFor.end())
        nRequestTime = it->second;
    else
        nRequestTime = 0;
    LogPrint(""net"", ""askfor %s  %d (%s) peer=%d\\n"", inv.ToString(), nRequestTime, DateTimeStrFormat(""%H:%M:%S"", nRequestTime/1000000), id);

    // Make sure not to reuse time indexes to keep things in the same order
    int64_t nNow = GetTimeMicros() - 1000000;
    static int64_t nLastTime;
    ++nLastTime;
    nNow = std::max(nNow, nLastTime);
    nLastTime = nNow;

    // Each retry is 2 minutes after the last
    nRequestTime = std::max(nRequestTime + 2 * 60 * 1000000, nNow);
    if (it != mapAlreadyAskedFor.end())
        mapAlreadyAskedFor.update(it, nRequestTime);
    else
        mapAlreadyAskedFor.insert(std::make_pair(inv, nRequestTime));
    mapAskFor.insert(std::make_pair(nRequestTime, inv));
}

void CNode::BeginMessage(const char* pszCommand) EXCLUSIVE_LOCK_FUNCTION(cs_vSend)
{
    ENTER_CRITICAL_SECTION(cs_vSend);
    assert(ssSend.size() == 0);
    ssSend << CMessageHeader(Params().MessageStart(), pszCommand, 0);
    LogPrint(""net"", ""sending: %s "", SanitizeString(pszCommand));
}

void CNode::AbortMessage() UNLOCK_FUNCTION(cs_vSend)
{
    ssSend.clear();

    LEAVE_CRITICAL_SECTION(cs_vSend);

    LogPrint(""net"", ""(aborted)\\n"");
}

void CNode::EndMessage() UNLOCK_FUNCTION(cs_vSend)
{
    // The -*messagestest options are intentionally not documented in the help message,
    // since they are only used during development to debug the networking code and are
    // not intended for end-users.
    if (mapArgs.count(""-dropmessagestest"") && GetRand(GetArg(""-dropmessagestest"", 2)) == 0)
    {
        LogPrint(""net"", ""dropmessages DROPPING SEND MESSAGE\\n"");
        AbortMessage();
        return;
    }
    if (mapArgs.count(""-fuzzmessagestest""))
        Fuzz(GetArg(""-fuzzmessagestest"", 10));

    if (ssSend.size() == 0)
    {
        LEAVE_CRITICAL_SECTION(cs_vSend);
        return;
    }
    // Set the size
    unsigned int nSize = ssSend.size() - CMessageHeader::HEADER_SIZE;
    WriteLE32((uint8_t*)&ssSend[CMessageHeader::MESSAGE_SIZE_OFFSET], nSize);

    // Set the checksum
    uint256 hash = Hash(ssSend.begin() + CMessageHeader::HEADER_SIZE, ssSend.end());
    unsigned int nChecksum = 0;
    memcpy(&nChecksum, &hash, sizeof(nChecksum));
    assert(ssSend.size () >= CMessageHeader::CHECKSUM_OFFSET + sizeof(nChecksum));
    memcpy((char*)&ssSend[CMessageHeader::CHECKSUM_OFFSET], &nChecksum, sizeof(nChecksum));

    LogPrint(""net"", ""(%d bytes) peer=%d\\n"", nSize, id);

    std::deque<CSerializeData>::iterator it = vSendMsg.insert(vSendMsg.end(), CSerializeData());
    ssSend.GetAndClear(*it);
    nSendSize += (*it).size();

    // If write queue empty, attempt ""optimistic write""
    if (it == vSendMsg.begin())
        SocketSendData(this);

    LEAVE_CRITICAL_SECTION(cs_vSend);
}
",16173,True,3027.2201369925865,median
"CLASS zcl_abapgit_object_webi DEFINITION PUBLIC INHERITING FROM zcl_abapgit_objects_super FINAL.

  PUBLIC SECTION.
    INTERFACES zif_abapgit_object.

  PROTECTED SECTION.
  PRIVATE SECTION.
    TYPES: BEGIN OF ty_webi,
             veptext         TYPE veptext,
             pvepheader      TYPE STANDARD TABLE OF vepheader WITH DEFAULT KEY,
             pvepfunction    TYPE STANDARD TABLE OF vepfunction WITH DEFAULT KEY,
             pvepfault       TYPE STANDARD TABLE OF vepfault WITH DEFAULT KEY,
             pvepparameter   TYPE STANDARD TABLE OF vepparameter WITH DEFAULT KEY,
             pveptype        TYPE STANDARD TABLE OF veptype WITH DEFAULT KEY,
             pvepelemtype    TYPE STANDARD TABLE OF vepelemtype WITH DEFAULT KEY,
             pveptabletype   TYPE STANDARD TABLE OF veptabletype WITH DEFAULT KEY,
             pvepstrutype    TYPE STANDARD TABLE OF vepstrutype WITH DEFAULT KEY,
             pveptypesoapext TYPE STANDARD TABLE OF veptypesoapext WITH DEFAULT KEY,
             pvepeletypsoap  TYPE STANDARD TABLE OF vepeletypsoap WITH DEFAULT KEY,
             pveptabtypsoap  TYPE STANDARD TABLE OF veptabtypsoap WITH DEFAULT KEY,
             pvepfuncsoapext TYPE STANDARD TABLE OF vepfuncsoapext WITH DEFAULT KEY,
             pvepfieldref    TYPE STANDARD TABLE OF vepfieldref WITH DEFAULT KEY,
             pvependpoint    TYPE STANDARD TABLE OF vependpoint WITH DEFAULT KEY,
             pvepvisoapext   TYPE STANDARD TABLE OF vepvisoapext WITH DEFAULT KEY,
             pvepparasoapext TYPE STANDARD TABLE OF vepparasoapext WITH DEFAULT KEY,
             pwsheader       TYPE STANDARD TABLE OF wsheader WITH DEFAULT KEY,
             pwssoapprop     TYPE STANDARD TABLE OF wssoapprop WITH DEFAULT KEY,
           END OF ty_webi.

    DATA: mi_vi TYPE REF TO if_ws_md_vif.

    METHODS:
      handle_endpoint
        IMPORTING is_webi TYPE ty_webi
        RAISING   zcx_abapgit_exception
                  cx_ws_md_exception,
      handle_types
        IMPORTING is_webi TYPE ty_webi
        RAISING   zcx_abapgit_exception
                  cx_ws_md_exception,
      handle_soap
        IMPORTING is_webi TYPE ty_webi
        RAISING   zcx_abapgit_exception
                  cx_ws_md_exception,
      handle_function
        IMPORTING is_webi TYPE ty_webi
        RAISING   zcx_abapgit_exception
                  cx_ws_md_exception.

ENDCLASS.



CLASS ZCL_ABAPGIT_OBJECT_WEBI IMPLEMENTATION.


  METHOD handle_endpoint.

    DATA: ls_endpoint LIKE LINE OF is_webi-pvependpoint,
          li_endpoint TYPE REF TO if_ws_md_vif_endpoint_ref.

    FIELD-SYMBOLS: <ls_function> LIKE LINE OF is_webi-pvepfunction.


    READ TABLE is_webi-pvependpoint INDEX 1 INTO ls_endpoint.
    ASSERT sy-subrc = 0.

    IF mi_vi->has_endpoint_reference( sews_c_vif_version-all ) = abap_true.
      RETURN.
    ENDIF.

    li_endpoint = mi_vi->create_endpoint_reference(
      endpoint_type          = ls_endpoint-endpointtype
      service_def_startpoint = ls_endpoint-def_start_pt
      auto_generated         = ls_endpoint-auto_generated
      i_is_srvv              = ls_endpoint-is_srvv ).

    IF ls_endpoint-endpointtype = 'BAPI'.
* it looks like some special handling is needed when calling
* set_data, and looking at the cluster data LS_ENDPOINT-CLUSTD
      zcx_abapgit_exception=>raise( 'todo, WEBI BAPI' ).
    ENDIF.

* field ls_endpoint-endpointname does not exist in 702
    READ TABLE is_webi-pvepfunction INDEX 1 ASSIGNING <ls_function>.
    IF sy-subrc <> 0.
      zcx_abapgit_exception=>raise( |WEBI { ms_item-obj_name }: couldn't detect endpoint name| ).
    ENDIF.

    li_endpoint->set_data(
      data_version = '1'
      data         = <ls_function>-function ).

  ENDMETHOD.


  METHOD handle_function.

    CONSTANTS: BEGIN OF lc_parameter_type,
                 import TYPE vepparamtype VALUE 'I',
                 export TYPE vepparamtype VALUE 'O',
               END OF lc_parameter_type.

    DATA: li_parameter TYPE REF TO if_ws_md_vif_param,
          li_soap      TYPE REF TO if_ws_md_soap_ext_func,
          li_fault     TYPE REF TO if_ws_md_vif_fault,
          li_function  TYPE REF TO if_ws_md_vif_func.

    FIELD-SYMBOLS: <ls_function>  LIKE LINE OF is_webi-pvepfunction,
                   <ls_soap>      LIKE LINE OF is_webi-pvepfuncsoapext,
                   <ls_fault>     LIKE LINE OF is_webi-pvepfault,
                   <ls_parameter> LIKE LINE OF is_webi-pvepparameter.


    LOOP AT is_webi-pvepfunction ASSIGNING <ls_function>.

      IF mi_vi->has_function( funcname = <ls_function>-function
                              version  = sews_c_vif_version-active ) = abap_true.
        CONTINUE.
      ENDIF.

      IF mi_vi->has_function( funcname = <ls_function>-function
                              version  = sews_c_vif_version-inactive ) = abap_true.

        li_function = mi_vi->get_function( funcname = <ls_function>-function
                                           version  = sews_c_vif_version-inactive ).

      ELSE.

        li_function = mi_vi->create_function( funcname    = <ls_function>-function
                                              mapped_name = <ls_function>-mappedname ).

      ENDIF.

      li_function->set_is_exposed( <ls_function>-is_exposed ).

      LOOP AT is_webi-pvepparameter ASSIGNING <ls_parameter>
          WHERE function = <ls_function>-function.

        CASE <ls_parameter>-vepparamtype.
          WHEN lc_parameter_type-import.

            li_parameter = li_function->create_incoming_parameter(
              <ls_parameter>-vepparam ).

          WHEN lc_parameter_type-export.

            li_parameter = li_function->create_outgoing_parameter(
              <ls_parameter>-vepparam ).

          WHEN OTHERS.
            ASSERT 0 = 1.
        ENDCASE.

        li_parameter->set_name_mapped_to( <ls_parameter>-mappedname ).
        li_parameter->set_is_exposed( <ls_parameter>-is_exposed ).
        li_parameter->set_is_optional( <ls_parameter>-is_optional ).
        li_parameter->set_default_value( <ls_parameter>-default_value ).
        li_parameter->set_initial( <ls_parameter>-is_initial ).
        li_parameter->set_type( <ls_parameter>-typename ).
      ENDLOOP.

      LOOP AT is_webi-pvepfuncsoapext ASSIGNING <ls_soap>
          WHERE function = <ls_function>-function.
        li_soap = li_function->create_soap_extension_function( ).
        li_soap->set_soap_request_name( <ls_soap>-requestname ).
        li_soap->set_soap_response_name( <ls_soap>-responsename ).
        li_soap->set_namespace( <ls_soap>-namespace ).
      ENDLOOP.

      LOOP AT is_webi-pvepfault ASSIGNING <ls_fault>
          WHERE function = <ls_function>-function.
        li_fault = li_function->create_fault( <ls_fault>-fault ).
        li_fault->set_name_mapped_to( <ls_fault>-mappedname ).
        li_fault->set_detail( <ls_fault>-detail ).
      ENDLOOP.

    ENDLOOP.

  ENDMETHOD.


  METHOD handle_soap.

    DATA: li_soap TYPE REF TO if_ws_md_soap_ext_virtinfc,
          ls_soap LIKE LINE OF is_webi-pvepvisoapext.


    READ TABLE is_webi-pvepvisoapext INDEX 1 INTO ls_soap.
    ASSERT sy-subrc = 0.

    IF mi_vi->has_soap_extension_virtinfc( sews_c_vif_version-active ) = abap_true.
      RETURN.
    ENDIF.

    IF mi_vi->has_soap_extension_virtinfc( sews_c_vif_version-inactive ) = abap_true.
      li_soap = mi_vi->get_soap_extension_virtinfc( sews_c_vif_version-inactive ).
    ELSE.
      li_soap = mi_vi->create_soap_extension_virtinfc( ls_soap-soap_appl_uri ).
    ENDIF.

    li_soap->set_namespace( ls_soap-namespace ).

  ENDMETHOD.


  METHOD handle_types.

    DATA: lv_index TYPE i,
          li_soap  TYPE REF TO if_ws_md_soap_extension_type,
          li_struc TYPE REF TO if_ws_md_vif_struc_type,
          li_field TYPE REF TO if_ws_md_vif_field,
          li_table TYPE REF TO if_ws_md_vif_table_type,
          li_elem  TYPE REF TO if_ws_md_vif_elem_type.

    FIELD-SYMBOLS: <ls_elem>  LIKE LINE OF is_webi-pvepelemtype,
                   <ls_table> LIKE LINE OF is_webi-pveptabletype,
                   <ls_soap>  LIKE LINE OF is_webi-pveptypesoapext,
                   <ls_struc> LIKE LINE OF is_webi-pvepstrutype.


    LOOP AT is_webi-pvepelemtype ASSIGNING <ls_elem>.
      li_elem = mi_vi->create_type_as_elementary( <ls_elem>-typename ).
      li_elem->set_built_in_type( <ls_elem>-build_in_type ).
      li_elem->set_decimals( <ls_elem>-decimals ).
      li_elem->set_kind( <ls_elem>-kind ).
      li_elem->set_length( <ls_elem>-length ).
      li_elem->set_signed( <ls_elem>-signed ).
      li_elem->set_abaptype( <ls_elem>-abaptype ).

      IF li_elem->if_ws_md_vif_type~has_soap_extension_type(
          sews_c_vif_version-all ) = abap_false.
        READ TABLE is_webi-pveptypesoapext ASSIGNING <ls_soap>
          WITH KEY typename = <ls_elem>-typename.
        IF sy-subrc = 0.
          li_soap = li_elem->if_ws_md_vif_type~create_soap_extension_type( ).
          li_soap->set_namespace( <ls_soap>-namespace ).
        ENDIF.
      ENDIF.
    ENDLOOP.

    LOOP AT is_webi-pvepstrutype ASSIGNING <ls_struc>.
      lv_index = sy-tabix.

      li_struc = mi_vi->create_type_as_structure( <ls_struc>-typename ).

      IF li_struc->has_field( field_pos = <ls_struc>-fieldpos
          version = sews_c_vif_version-active ) = abap_true.
        CONTINUE.
      ENDIF.

      li_field = li_struc->create_field(
        field_name = <ls_struc>-fieldname
        fieldpos = <ls_struc>-fieldpos ).
      li_field->set_type( mi_vi->get_type( typename = <ls_struc>-typeref
                                           version  = sews_c_vif_version-inactive ) ).

      IF lv_index = 1
          AND li_struc->if_ws_md_vif_type~has_soap_extension_type(
          sews_c_vif_version-all ) = abap_false.
        READ TABLE is_webi-pveptypesoapext ASSIGNING <ls_soap>
          WITH KEY typename = <ls_struc>-typename.
        IF sy-subrc = 0.
          li_soap = li_struc->if_ws_md_vif_type~create_soap_extension_type( ).
          li_soap->set_namespace( <ls_soap>-namespace ).
        ENDIF.
      ENDIF.
    ENDLOOP.

    LOOP AT is_webi-pveptabletype ASSIGNING <ls_table>.
      li_table = mi_vi->create_type_as_table( <ls_table>-typename ).
      li_table->set_line_type( mi_vi->get_type( typename = <ls_table>-typeref
                                                version  = sews_c_vif_version-inactive ) ).

      IF li_table->if_ws_md_vif_type~has_soap_extension_type(
          sews_c_vif_version-all ) = abap_false.
        READ TABLE is_webi-pveptypesoapext ASSIGNING <ls_soap>
          WITH KEY typename = <ls_table>-typename.
        IF sy-subrc = 0.
          li_soap = li_table->if_ws_md_vif_type~create_soap_extension_type( ).
          li_soap->set_namespace( <ls_soap>-namespace ).
        ENDIF.
      ENDIF.
    ENDLOOP.

  ENDMETHOD.


  METHOD zif_abapgit_object~changed_by.
    rv_user = c_user_unknown. "" todo
  ENDMETHOD.


  METHOD zif_abapgit_object~delete.

    DATA: lv_name TYPE vepname,
          lo_vif  TYPE REF TO cl_ws_md_vif_root.


    lv_name = ms_item-obj_name.

    CREATE OBJECT lo_vif.
    TRY.
        lo_vif->if_ws_md_vif_root~delete_virtual_interface( lv_name ).
      CATCH cx_ws_md_exception.
        zcx_abapgit_exception=>raise( 'error deleting WEBI' ).
    ENDTRY.

  ENDMETHOD.


  METHOD zif_abapgit_object~deserialize.

    DATA: ls_webi     TYPE ty_webi,
          lv_name     TYPE vepname,
          ls_header   LIKE LINE OF ls_webi-pvepheader,
          lx_root     TYPE REF TO cx_root,
          lv_exists   TYPE abap_bool,
          li_root     TYPE REF TO if_ws_md_vif_root,
          ls_endpoint LIKE LINE OF ls_webi-pvependpoint.


    io_xml->read( EXPORTING iv_name = 'WEBI'
                  CHANGING  cg_data = ls_webi ).

    lv_name = ms_item-obj_name.

    READ TABLE ls_webi-pvependpoint INDEX 1 INTO ls_endpoint.
    ASSERT sy-subrc = 0.
    IF ls_endpoint-auto_generated = abap_true.
      "" handled by SPRX.
      RETURN.
    ENDIF.

    READ TABLE ls_webi-pvepheader INDEX 1 INTO ls_header.
    ASSERT sy-subrc = 0.

    lv_exists = cl_ws_md_vif_root=>check_existence_by_vif_name(
      name      = lv_name
      i_version = sews_c_vif_version-all ).

    li_root = cl_ws_md_factory=>get_vif_root( ).
    TRY.
        IF lv_exists = abap_false.
          mi_vi = li_root->create_virtual_interface(
            name    = lv_name
            nameext = ls_header-vepnameext ).
        ELSE.
          mi_vi = li_root->get_virtual_interface( lv_name ).
          mi_vi->if_ws_md_lockable_object~lock( ).
        ENDIF.

        mi_vi->set_short_text( ls_webi-veptext ).

        handle_endpoint( ls_webi ).
        handle_types( ls_webi ).
        handle_function( ls_webi ).
        handle_soap( ls_webi ).

        tadir_insert( iv_package ).

        mi_vi->if_ws_md_lockable_object~save( ).
        mi_vi->if_ws_md_lockable_object~unlock( ).
      CATCH cx_ws_md_exception INTO lx_root.
        TRY.
            mi_vi->if_ws_md_lockable_object~unlock( ).
          CATCH cx_ws_md_exception ##no_handler.
        ENDTRY.
        zcx_abapgit_exception=>raise( lx_root->if_message~get_text( ) ).
    ENDTRY.

    zcl_abapgit_objects_activation=>add_item( ms_item ).

  ENDMETHOD.


  METHOD zif_abapgit_object~exists.

    DATA: lv_name TYPE vepname.


    lv_name = ms_item-obj_name.

    rv_bool = cl_ws_md_vif_root=>check_existence_by_vif_name(
      name      = lv_name
      i_version = sews_c_vif_version-active ).

  ENDMETHOD.


  METHOD zif_abapgit_object~get_comparator.
    RETURN.
  ENDMETHOD.


  METHOD zif_abapgit_object~get_deserialize_steps.
    APPEND zif_abapgit_object=>gc_step_id-abap TO rt_steps.
  ENDMETHOD.


  METHOD zif_abapgit_object~get_metadata.
    rs_metadata = get_metadata( ).
  ENDMETHOD.


  METHOD zif_abapgit_object~is_active.
    rv_active = is_active( ).
  ENDMETHOD.


  METHOD zif_abapgit_object~is_locked.
    rv_is_locked = abap_false.
  ENDMETHOD.


  METHOD zif_abapgit_object~jump.

    CALL FUNCTION 'RS_TOOL_ACCESS'
      EXPORTING
        operation     = 'SHOW'
        object_name   = ms_item-obj_name
        object_type   = ms_item-obj_type
        in_new_window = abap_true.

  ENDMETHOD.


  METHOD zif_abapgit_object~serialize.

    DATA: ls_webi    TYPE ty_webi,
          lt_modilog TYPE STANDARD TABLE OF smodilog WITH DEFAULT KEY,
          li_vi      TYPE REF TO if_ws_md_vif,
          lv_name    TYPE vepname.

    FIELD-SYMBOLS: <ls_vepheader>   LIKE LINE OF ls_webi-pvepheader,
                   <ls_vependpoint> LIKE LINE OF ls_webi-pvependpoint,
                   <ls_wsheader>    TYPE wsheader.

    CALL FUNCTION 'WEBI_GET_OBJECT'
      EXPORTING
        webiname          = ms_item-obj_name
      TABLES
        psmodilog         = lt_modilog
        pvepheader        = ls_webi-pvepheader
        pvepfunction      = ls_webi-pvepfunction
        pvepfault         = ls_webi-pvepfault
        pvepparameter     = ls_webi-pvepparameter
        pveptype          = ls_webi-pveptype
        pvepelemtype      = ls_webi-pvepelemtype
        pveptabletype     = ls_webi-pveptabletype
        pvepstrutype      = ls_webi-pvepstrutype
        pveptypesoapext   = ls_webi-pveptypesoapext
        pvepeletypsoap    = ls_webi-pvepeletypsoap
        pveptabtypsoap    = ls_webi-pveptabtypsoap
        pvepfuncsoapext   = ls_webi-pvepfuncsoapext
        pvepfieldref      = ls_webi-pvepfieldref
        pvependpoint      = ls_webi-pvependpoint
        pvepvisoapext     = ls_webi-pvepvisoapext
        pvepparasoapext   = ls_webi-pvepparasoapext
        pwsheader         = ls_webi-pwsheader
        pwssoapprop       = ls_webi-pwssoapprop
      EXCEPTIONS
        version_not_found = 1
        webi_not_exist    = 2
        OTHERS            = 3.
    IF sy-subrc <> 0.
      zcx_abapgit_exception=>raise( 'error from WEBI_GET_OBJECT' ).
    ENDIF.

    SORT ls_webi-pveptype BY
      vepname ASCENDING
      version ASCENDING
      typename ASCENDING.

    lv_name = ms_item-obj_name.
    TRY.
        li_vi = cl_ws_md_factory=>get_vif_root( )->get_virtual_interface( lv_name ).
        ls_webi-veptext = li_vi->get_short_text( sews_c_vif_version-active ).
      CATCH cx_ws_md_exception.
        zcx_abapgit_exception=>raise( 'error serializing WEBI' ).
    ENDTRY.

    LOOP AT ls_webi-pvepheader ASSIGNING <ls_vepheader>.
      CLEAR <ls_vepheader>-author.
      CLEAR <ls_vepheader>-createdon.
      CLEAR <ls_vepheader>-changedby.
      CLEAR <ls_vepheader>-changedon.
      CLEAR <ls_vepheader>-ctime.
      CLEAR <ls_vepheader>-text_id.
      CLEAR <ls_vepheader>-utime.
      CLEAR <ls_vepheader>-wsint_version.
    ENDLOOP.

    LOOP AT ls_webi-pvependpoint ASSIGNING <ls_vependpoint>.
      CLEAR <ls_vependpoint>-clustd.
    ENDLOOP.

    LOOP AT ls_webi-pwsheader ASSIGNING <ls_wsheader>.

      CLEAR:
        <ls_wsheader>-author,
        <ls_wsheader>-createdon,
        <ls_wsheader>-changedby,
        <ls_wsheader>-changedon,
        <ls_wsheader>-ctime,
        <ls_wsheader>-utime.

    ENDLOOP.

    io_xml->add( iv_name = 'WEBI'
                 ig_data = ls_webi ).

  ENDMETHOD.
ENDCLASS.
",4575,False,988.1427882520072,median
"// Licensed under the Apache License, Version 2.0 (the ""License"");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ""AS IS"" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Modified based on ClickHouse commit 6930605 on Oct 14, 2021
//   https://github.com/ClickHouse/ClickHouse/blob/master/utils/antlr/ClickHouseLexer.g4 and
//   https://github.com/ClickHouse/ClickHouse/blob/master/utils/antlr/ClickHouseParser.g4
////

grammar ClickHouseSQL;

// Top-level statements

queryStmt: query (INTO OUTFILE STRING_LITERAL)? (FORMAT identifierOrNull)? (SEMICOLON)? | insertStmt;
query
    : alterStmt     // DDL
    | attachStmt    // DDL
    | checkStmt
    | createStmt    // DDL
    | describeStmt
    | dropStmt      // DDL
    | existsStmt
    | explainStmt
    | killStmt      // DDL
    | optimizeStmt  // DDL
    | renameStmt    // DDL
    | selectUnionStmt
    | setStmt
    | showStmt
    | systemStmt
    | truncateStmt  // DDL
    | useStmt
    | watchStmt
    ;

// ALTER statement

alterStmt
    : ALTER TABLE tableIdentifier clusterClause? alterTableClause (COMMA alterTableClause)*  # AlterTableStmt
    ;

alterTableClause
    : ADD COLUMN (IF NOT EXISTS)? tableColumnDfnt (AFTER nestedIdentifier)?           # AlterTableClauseAddColumn
    | ADD INDEX (IF NOT EXISTS)? tableIndexDfnt (AFTER nestedIdentifier)?             # AlterTableClauseAddIndex
    | ADD PROJECTION (IF NOT EXISTS)? tableProjectionDfnt (AFTER nestedIdentifier)?   # AlterTableClauseAddProjection
    | ATTACH partitionClause (FROM tableIdentifier)?                                  # AlterTableClauseAttach
    | CLEAR COLUMN (IF EXISTS)? nestedIdentifier (IN partitionClause)?                # AlterTableClauseClearColumn
    | CLEAR INDEX (IF EXISTS)? nestedIdentifier (IN partitionClause)?                 # AlterTableClauseClearIndex
    | CLEAR PROJECTION (IF EXISTS)? nestedIdentifier (IN partitionClause)?            # AlterTableClauseClearProjection
    | COMMENT COLUMN (IF EXISTS)? nestedIdentifier STRING_LITERAL                     # AlterTableClauseComment
    | DELETE WHERE columnExpr                                                         # AlterTableClauseDelete
    | DETACH partitionClause                                                          # AlterTableClauseDetach
    | DROP COLUMN (IF EXISTS)? nestedIdentifier                                       # AlterTableClauseDropColumn
    | DROP INDEX (IF EXISTS)? nestedIdentifier                                        # AlterTableClauseDropIndex
    | DROP PROJECTION (IF EXISTS)? nestedIdentifier                                   # AlterTableClauseDropProjection
    | DROP partitionClause                                                            # AlterTableClauseDropPartition
    | FREEZE partitionClause?                                                         # AlterTableClauseFreezePartition
    | MATERIALIZE INDEX (IF EXISTS)? nestedIdentifier (IN partitionClause)?           # AlterTableClauseMaterializeIndex
    | MATERIALIZE PROJECTION (IF EXISTS)? nestedIdentifier (IN partitionClause)?      # AlterTableClauseMaterializeProjection
    | MODIFY COLUMN (IF EXISTS)? nestedIdentifier codecExpr                           # AlterTableClauseModifyCodec
    | MODIFY COLUMN (IF EXISTS)? nestedIdentifier COMMENT STRING_LITERAL              # AlterTableClauseModifyComment
    | MODIFY COLUMN (IF EXISTS)? nestedIdentifier REMOVE tableColumnPropertyType      # AlterTableClauseModifyRemove
    | MODIFY COLUMN (IF EXISTS)? tableColumnDfnt                                      # AlterTableClauseModify
    | MODIFY ORDER BY columnExpr                                                      # AlterTableClauseModifyOrderBy
    | MODIFY ttlClause                                                                # AlterTableClauseModifyTTL
    | MOVE partitionClause ( TO DISK STRING_LITERAL
                           | TO VOLUME STRING_LITERAL
                           | TO TABLE tableIdentifier
                           )                                                          # AlterTableClauseMovePartition
    | REMOVE TTL                                                                      # AlterTableClauseRemoveTTL
    | RENAME COLUMN (IF EXISTS)? nestedIdentifier TO nestedIdentifier                 # AlterTableClauseRename
    | REPLACE partitionClause FROM tableIdentifier                                    # AlterTableClauseReplace
    | UPDATE assignmentExprList whereClause                                           # AlterTableClauseUpdate
    ;

assignmentExprList: assignmentExpr (COMMA assignmentExpr)*;
assignmentExpr: nestedIdentifier EQ_SINGLE columnExpr;

tableColumnPropertyType: ALIAS | CODEC | COMMENT | DEFAULT | MATERIALIZED | TTL;

partitionClause
    : PARTITION columnExpr         // actually we expect here any form of tuple of literals
    | PARTITION ID STRING_LITERAL
    ;

// ATTACH statement
attachStmt
    : ATTACH DICTIONARY tableIdentifier clusterClause?  # AttachDictionaryStmt
    ;

// CHECK statement

checkStmt: CHECK TABLE tableIdentifier partitionClause?;

// CREATE statement

createStmt
    : (ATTACH | CREATE) DATABASE (IF NOT EXISTS)? databaseIdentifier clusterClause? engineExpr?                                                                                       # CreateDatabaseStmt
    | (ATTACH | CREATE (OR REPLACE)? | REPLACE) DICTIONARY (IF NOT EXISTS)? tableIdentifier uuidClause? clusterClause? dictionarySchemaClause dictionaryEngineClause                                          # CreateDictionaryStmt
    | (ATTACH | CREATE) LIVE VIEW (IF NOT EXISTS)? tableIdentifier uuidClause? clusterClause? (WITH TIMEOUT DECIMAL_LITERAL?)? destinationClause? tableSchemaClause? subqueryClause   # CreateLiveViewStmt
    | (ATTACH | CREATE) MATERIALIZED VIEW (IF NOT EXISTS)? tableIdentifier uuidClause? clusterClause? tableSchemaClause? (destinationClause | engineClause POPULATE?) subqueryClause  # CreateMaterializedViewStmt
    | (ATTACH | CREATE (OR REPLACE)? | REPLACE) TEMPORARY? TABLE (IF NOT EXISTS)? tableIdentifier uuidClause? clusterClause? tableSchemaClause? engineClause? subqueryClause?                                 # CreateTableStmt
    | (ATTACH | CREATE) (OR REPLACE)? VIEW (IF NOT EXISTS)? tableIdentifier uuidClause? clusterClause? tableSchemaClause? subqueryClause                                              # CreateViewStmt
    ;

dictionarySchemaClause: LPAREN dictionaryAttrDfnt (COMMA dictionaryAttrDfnt)* RPAREN;
dictionaryAttrDfnt
    : identifier columnTypeExpr ( DEFAULT literal
                                | EXPRESSION columnExpr
                                | HIERARCHICAL
                                | INJECTIVE
                                | IS_OBJECT_ID
                                )*
                                ;
dictionaryEngineClause
    : dictionaryPrimaryKeyClause? ( sourceClause
                                  | lifetimeClause
                                  | layoutClause
                                  | rangeClause
                                  | dictionarySettingsClause
                                  )*
                                  ;
dictionaryPrimaryKeyClause: PRIMARY KEY columnExprList;
dictionaryArgExpr: identifier (identifier (LPAREN RPAREN)? | literal);
sourceClause: SOURCE LPAREN identifier LPAREN dictionaryArgExpr* RPAREN RPAREN;
lifetimeClause: LIFETIME LPAREN ( DECIMAL_LITERAL
                                | MIN DECIMAL_LITERAL MAX DECIMAL_LITERAL
                                | MAX DECIMAL_LITERAL MIN DECIMAL_LITERAL
                                ) RPAREN;
layoutClause: LAYOUT LPAREN identifier LPAREN dictionaryArgExpr* RPAREN RPAREN;
rangeClause: RANGE LPAREN (MIN identifier MAX identifier | MAX identifier MIN identifier) RPAREN;
dictionarySettingsClause: SETTINGS LPAREN settingExprList RPAREN;

clusterClause: ON CLUSTER (identifier | STRING_LITERAL);
uuidClause: UUID STRING_LITERAL;
destinationClause: TO tableIdentifier;
subqueryClause: AS selectUnionStmt;
tableSchemaClause
    : LPAREN tableElementExpr (COMMA tableElementExpr)* RPAREN  # SchemaDescriptionClause
    | AS tableIdentifier                                        # SchemaAsTableClause
    | AS tableFunctionExpr                                      # SchemaAsFunctionClause
    ;
engineClause
    : engineExpr ( orderByClause
                 | partitionByClause
                 | primaryKeyClause
                 | sampleByClause
                 | ttlClause
                 | settingsClause
                 )*
                 ;
partitionByClause: PARTITION BY columnExpr;
primaryKeyClause: PRIMARY KEY columnExpr;
sampleByClause: SAMPLE BY columnExpr;
ttlClause: TTL ttlExpr (COMMA ttlExpr)*;

// make ENGINE optional for convenient
engineExpr: ENGINE? EQ_SINGLE? identifierOrNull (LPAREN columnExprList? RPAREN)?;
tableElementExpr
    : tableColumnDfnt                                                              # TableElementExprColumn
    | CONSTRAINT identifier CHECK columnExpr                                       # TableElementExprConstraint
    | INDEX tableIndexDfnt                                                         # TableElementExprIndex
    | PROJECTION tableProjectionDfnt                                               # TableElementExprProjection
    ;
tableColumnDfnt
    : nestedIdentifier columnTypeExpr tableColumnPropertyExpr? (COMMENT STRING_LITERAL)? codecExpr? (TTL columnExpr)?
    | nestedIdentifier columnTypeExpr? tableColumnPropertyExpr (COMMENT STRING_LITERAL)? codecExpr? (TTL columnExpr)?
    ;
tableColumnPropertyExpr: (DEFAULT | MATERIALIZED | ALIAS) columnExpr;
tableIndexDfnt: nestedIdentifier columnExpr TYPE columnTypeExpr GRANULARITY DECIMAL_LITERAL;
tableProjectionDfnt: nestedIdentifier projectionSelectStmt;
codecExpr: CODEC LPAREN codecArgExpr (COMMA codecArgExpr)* RPAREN;
codecArgExpr: identifier (LPAREN columnExprList? RPAREN)?;
ttlExpr: columnExpr (DELETE | TO DISK STRING_LITERAL | TO VOLUME STRING_LITERAL)?;

// DESCRIBE statement

describeStmt: (DESCRIBE | DESC) TABLE? tableExpr;

// DROP statement

dropStmt
    : (DETACH | DROP) DATABASE (IF EXISTS)? databaseIdentifier clusterClause?                                  # DropDatabaseStmt
    | (DETACH | DROP) (DICTIONARY | TEMPORARY? TABLE | VIEW) (IF EXISTS)? tableIdentifier clusterClause? (NO DELAY)?  # DropTableStmt
    ;

// EXISTS statement

existsStmt
    : EXISTS DATABASE databaseIdentifier                             # ExistsDatabaseStmt
    | EXISTS (DICTIONARY | TEMPORARY? TABLE | VIEW)? tableIdentifier # ExistsTableStmt
    ;

// EXPLAIN statement

explainStmt
    : EXPLAIN AST query     # ExplainASTStmt
    | EXPLAIN SYNTAX query  # ExplainSyntaxStmt
    ;

// INSERT statement

insertStmt: INSERT INTO TABLE? (tableIdentifier | FUNCTION tableFunctionExpr) columnsClause? dataClause;

columnsClause: LPAREN nestedIdentifier (COMMA nestedIdentifier)* RPAREN;
dataClause
    : FORMAT identifier              # DataClauseFormat
    | VALUES                         # DataClauseValues
    | selectUnionStmt SEMICOLON? EOF # DataClauseSelect
    ;

// KILL statement

killStmt
    : KILL MUTATION clusterClause? whereClause (SYNC | ASYNC | TEST)?  # KillMutationStmt
    ;

// OPTIMIZE statement

optimizeStmt: OPTIMIZE TABLE tableIdentifier clusterClause? partitionClause? FINAL? DEDUPLICATE?;

// RENAME statement

renameStmt: RENAME TABLE tableIdentifier TO tableIdentifier (COMMA tableIdentifier TO tableIdentifier)* clusterClause?;

// PROJECTION SELECT statement

projectionSelectStmt:
    LPAREN
    withClause?
    SELECT columnExprList
    groupByClause?
    projectionOrderByClause?
    RPAREN
    ;

// SELECT statement

selectUnionStmt: selectStmtWithParens (UNION ALL selectStmtWithParens)*;
selectStmtWithParens: selectStmt | LPAREN selectUnionStmt RPAREN;
selectStmt:
    withClause?
    SELECT DISTINCT? topClause? columnExprList
    fromClause?
    arrayJoinClause?
    windowClause?
    prewhereClause?
    whereClause?
    groupByClause? (WITH (CUBE | ROLLUP))? (WITH TOTALS)?
    havingClause?
    orderByClause?
    limitByClause?
    limitClause?
    settingsClause?
    ;

withClause: WITH columnExprList;
topClause: TOP DECIMAL_LITERAL (WITH TIES)?;
fromClause: FROM joinExpr;
arrayJoinClause: (LEFT | INNER)? ARRAY JOIN columnExprList;
windowClause: WINDOW identifier AS LPAREN windowExpr RPAREN;
prewhereClause: PREWHERE columnExpr;
whereClause: WHERE columnExpr;
groupByClause: GROUP BY ((CUBE | ROLLUP) LPAREN columnExprList RPAREN | columnExprList);
havingClause: HAVING columnExpr;
orderByClause: ORDER BY orderExprList;
projectionOrderByClause: ORDER BY columnExprList;
limitByClause: LIMIT limitExpr BY columnExprList;
limitClause: LIMIT limitExpr (WITH TIES)?;
settingsClause: SETTINGS settingExprList;

joinExpr
    : joinExpr (GLOBAL | LOCAL)? joinOp? JOIN joinExpr joinConstraintClause  # JoinExprOp
    | joinExpr joinOpCross joinExpr                                          # JoinExprCrossOp
    | tableExpr FINAL? sampleClause?                                         # JoinExprTable
    | LPAREN joinExpr RPAREN                                                 # JoinExprParens
    ;
joinOp
    : ((ALL | ANY | ASOF)? INNER | INNER (ALL | ANY | ASOF)? | (ALL | ANY | ASOF))  # JoinOpInner
    | ( (SEMI | ALL | ANTI | ANY | ASOF)? (LEFT | RIGHT) OUTER?
      | (LEFT | RIGHT) OUTER? (SEMI | ALL | ANTI | ANY | ASOF)?
      )                                                                             # JoinOpLeftRight
    | ((ALL | ANY)? FULL OUTER? | FULL OUTER? (ALL | ANY)?)                         # JoinOpFull
    ;
joinOpCross
    : (GLOBAL|LOCAL)? CROSS JOIN
    | COMMA
    ;
joinConstraintClause
    : ON columnExprList
    | USING LPAREN columnExprList RPAREN
    | USING columnExprList
    ;

sampleClause: SAMPLE ratioExpr (OFFSET ratioExpr)?;
limitExpr: columnExpr ((COMMA | OFFSET) columnExpr)?;
orderExprList: orderExpr (COMMA orderExpr)*;
orderExpr: columnExpr (ASCENDING | DESCENDING | DESC)? (NULLS (FIRST | LAST))? (COLLATE STRING_LITERAL)?;
ratioExpr: numberLiteral (SLASH numberLiteral)?;
settingExprList: settingExpr (COMMA settingExpr)*;
settingExpr: identifier EQ_SINGLE literal;

windowExpr: winPartitionByClause? winOrderByClause? winFrameClause?;
winPartitionByClause: PARTITION BY columnExprList;
winOrderByClause: ORDER BY orderExprList;
winFrameClause: (ROWS | RANGE) winFrameExtend;
winFrameExtend
    : winFrameBound                             # frameStart
    | BETWEEN winFrameBound AND winFrameBound   # frameBetween
    ;
winFrameBound: (CURRENT ROW | UNBOUNDED PRECEDING | UNBOUNDED FOLLOWING | numberLiteral PRECEDING | numberLiteral FOLLOWING);
//rangeClause: RANGE LPAREN (MIN identifier MAX identifier | MAX identifier MIN identifier) RPAREN;


// SET statement

setStmt: SET settingExprList;

// SHOW statements

showStmt
    : SHOW CREATE DATABASE databaseIdentifier                                                                     # showCreateDatabaseStmt
    | SHOW CREATE DICTIONARY tableIdentifier                                                                      # showCreateDictionaryStmt
    | SHOW CREATE TEMPORARY? TABLE? tableIdentifier                                                               # showCreateTableStmt
    | SHOW DATABASES                                                                                              # showDatabasesStmt
    | SHOW DICTIONARIES (FROM databaseIdentifier)?                                                                # showDictionariesStmt
    | SHOW TEMPORARY? TABLES ((FROM | IN) databaseIdentifier)? (LIKE STRING_LITERAL | whereClause)? limitClause?  # showTablesStmt
    ;

// SYSTEM statements

systemStmt
    : SYSTEM FLUSH DISTRIBUTED tableIdentifier
    | SYSTEM FLUSH LOGS
    | SYSTEM RELOAD DICTIONARIES
    | SYSTEM RELOAD DICTIONARY tableIdentifier
    | SYSTEM (START | STOP) (DISTRIBUTED SENDS | FETCHES | TTL? MERGES) tableIdentifier
    | SYSTEM (START | STOP) REPLICATED SENDS
    | SYSTEM SYNC REPLICA tableIdentifier
    ;

// TRUNCATE statements

truncateStmt: TRUNCATE TEMPORARY? TABLE? (IF EXISTS)? tableIdentifier clusterClause?;

// USE statement

useStmt: USE databaseIdentifier;

// WATCH statement

watchStmt: WATCH tableIdentifier EVENTS? (LIMIT DECIMAL_LITERAL)?;



// Columns

columnTypeExpr
    : identifier                                                                             # ColumnTypeExprSimple   // UInt64
    | identifier LPAREN identifier columnTypeExpr (COMMA identifier columnTypeExpr)* RPAREN  # ColumnTypeExprNested   // Nested
    | identifier LPAREN enumValue (COMMA enumValue)* RPAREN                                  # ColumnTypeExprEnum     // Enum
    | identifier LPAREN columnTypeExpr (COMMA columnTypeExpr)* RPAREN                        # ColumnTypeExprComplex  // Array, Tuple
    | identifier LPAREN columnExprList? RPAREN                                               # ColumnTypeExprParam    // FixedString(N)
    ;
columnExprList: columnsExpr (COMMA columnsExpr)*;
columnsExpr
    : (tableIdentifier DOT)? ASTERISK  # ColumnsExprAsterisk
    | LPAREN selectUnionStmt RPAREN    # ColumnsExprSubquery
    // NOTE: asterisk and subquery goes before |columnExpr| so that we can mark them as multi-column expressions.
    | columnExpr                       # ColumnsExprColumn
    ;
columnExpr
    : CASE columnExpr? (WHEN columnExpr THEN columnExpr)+ (ELSE columnExpr)? END          # ColumnExprCase
    | CAST LPAREN columnExpr AS columnTypeExpr RPAREN                                     # ColumnExprCast
    | DATE STRING_LITERAL                                                                 # ColumnExprDate
    | EXTRACT LPAREN interval FROM columnExpr RPAREN                                      # ColumnExprExtract
    | INTERVAL columnExpr interval                                                        # ColumnExprInterval
    | SUBSTRING LPAREN columnExpr FROM columnExpr (FOR columnExpr)? RPAREN                # ColumnExprSubstring
    | TIMESTAMP STRING_LITERAL                                                            # ColumnExprTimestamp
    | TRIM LPAREN (BOTH | LEADING | TRAILING) STRING_LITERAL FROM columnExpr RPAREN       # ColumnExprTrim
    | identifier (LPAREN columnExprList? RPAREN) OVER LPAREN windowExpr RPAREN            # ColumnExprWinFunction
    | identifier (LPAREN columnExprList? RPAREN) OVER identifier                          # ColumnExprWinFunctionTarget
    | identifier (LPAREN columnExprList? RPAREN)? LPAREN DISTINCT? columnArgList? RPAREN  # ColumnExprFunction
    | literal                                                                             # ColumnExprLiteral

    // FIXME(ilezhankin): this part looks very ugly, maybe there is another way to express it
    | columnExpr LBRACKET columnExpr RBRACKET                                             # ColumnExprArrayAccess
    | columnExpr DOT DECIMAL_LITERAL                                                      # ColumnExprTupleAccess
    | DASH columnExpr                                                                     # ColumnExprNegate
    | columnExpr ( ASTERISK                                                               // multiply
                 | SLASH                                                                  // divide
                 | PERCENT                                                                // modulo
                 ) columnExpr                                                             # ColumnExprPrecedence1
    | columnExpr ( PLUS                                                                   // plus
                 | DASH                                                                   // minus
                 | CONCAT                                                                 // concat
                 ) columnExpr                                                             # ColumnExprPrecedence2
    | columnExpr ( EQ_DOUBLE                                                              // equals
                 | EQ_SINGLE                                                              // equals
                 | NOT_EQ                                                                 // notEquals
                 | LE                                                                     // lessOrEquals
                 | GE                                                                     // greaterOrEquals
                 | LT                                                                     // less
                 | GT                                                                     // greater
                 | GLOBAL? NOT? IN                                                        // in, notIn, globalIn, globalNotIn
                 | NOT? (LIKE | ILIKE)                                                    // like, notLike, ilike, notILike
                 ) columnExpr                                                             # ColumnExprPrecedence3
    | columnExpr IS NOT? NULL_SQL                                                         # ColumnExprIsNull
    | NOT columnExpr                                                                      # ColumnExprNot
    | columnExpr AND columnExpr                                                           # ColumnExprAnd
    | columnExpr OR columnExpr                                                            # ColumnExprOr
    // TODO(ilezhankin): `BETWEEN a AND b AND c` is parsed in a wrong way: `BETWEEN (a AND b) AND c`
    | columnExpr NOT? BETWEEN columnExpr AND columnExpr                                   # ColumnExprBetween
    | <assoc=right> columnExpr QUERY columnExpr COLON columnExpr                          # ColumnExprTernaryOp
    | columnExpr (alias | AS identifier)                                                  # ColumnExprAlias

    | (tableIdentifier DOT)? ASTERISK                                                     # ColumnExprAsterisk  // single-column only
    | LPAREN selectUnionStmt RPAREN                                                       # ColumnExprSubquery  // single-column only
    | LPAREN columnExpr RPAREN                                                            # ColumnExprParens    // single-column only
    | LPAREN columnExprList RPAREN                                                        # ColumnExprTuple
    | LBRACKET columnExprList? RBRACKET                                                   # ColumnExprArray
    | columnIdentifier                                                                    # ColumnExprIdentifier
    ;
columnArgList: columnArgExpr (COMMA columnArgExpr)*;
columnArgExpr: columnLambdaExpr | columnExpr;
columnLambdaExpr:
    ( LPAREN identifier (COMMA identifier)* RPAREN
    |        identifier (COMMA identifier)*
    )
    ARROW columnExpr
    ;
columnIdentifier: (tableIdentifier DOT)? nestedIdentifier;
nestedIdentifier: identifier (DOT identifier)?;

// Tables

tableExpr
    : tableIdentifier                    # TableExprIdentifier
    | tableFunctionExpr                  # TableExprFunction
    | LPAREN selectUnionStmt RPAREN      # TableExprSubquery
    | tableExpr (alias | AS identifier)  # TableExprAlias
    ;
tableFunctionExpr: identifier LPAREN tableArgList? RPAREN;
tableIdentifier: (databaseIdentifier DOT)? identifier;
tableArgList: tableArgExpr (COMMA tableArgExpr)*;
tableArgExpr
    : nestedIdentifier
    | tableFunctionExpr
    | literal
    ;

// Databases

databaseIdentifier: identifier;

// Basics

floatingLiteral
    : FLOATING_LITERAL
    | DOT (DECIMAL_LITERAL | OCTAL_LITERAL)
    | DECIMAL_LITERAL DOT (DECIMAL_LITERAL | OCTAL_LITERAL)?  // can't move this to the lexer or it will break nested tuple access: t.1.2
    ;
numberLiteral: (PLUS | DASH)? (floatingLiteral | OCTAL_LITERAL | DECIMAL_LITERAL | HEXADECIMAL_LITERAL | INF | NAN_SQL);
literal
    : numberLiteral
    | STRING_LITERAL
    | NULL_SQL
    ;
interval: SECOND | MINUTE | HOUR | DAY | WEEK | MONTH | QUARTER | YEAR;
keyword
    // except NULL_SQL, INF, NAN_SQL
    : AFTER | ALIAS | ALL | ALTER | AND | ANTI | ANY | ARRAY | AS | ASCENDING | ASOF | AST | ASYNC | ATTACH | BETWEEN | BOTH | BY | CASE
    | CAST | CHECK | CLEAR | CLUSTER | CODEC | COLLATE | COLUMN | COMMENT | CONSTRAINT | CREATE | CROSS | CUBE | CURRENT | DATABASE
    | DATABASES | DATE | DEDUPLICATE | DEFAULT | DELAY | DELETE | DESCRIBE | DESC | DESCENDING | DETACH | DICTIONARIES | DICTIONARY | DISK
    | DISTINCT | DISTRIBUTED | DROP | ELSE | END | ENGINE | EVENTS | EXISTS | EXPLAIN | EXPRESSION | EXTRACT | FETCHES | FINAL | FIRST
    | FLUSH | FOR | FOLLOWING | FOR | FORMAT | FREEZE | FROM | FULL | FUNCTION | GLOBAL | GRANULARITY | GROUP | HAVING | HIERARCHICAL | ID
    | IF | ILIKE | IN | INDEX | INJECTIVE | INNER | INSERT | INTERVAL | INTO | IS | IS_OBJECT_ID | JOIN | JSON_FALSE | JSON_TRUE | KEY
    | KILL | LAST | LAYOUT | LEADING | LEFT | LIFETIME | LIKE | LIMIT | LIVE | LOCAL | LOGS | MATERIALIZE | MATERIALIZED | MAX | MERGES
    | MIN | MODIFY | MOVE | MUTATION | NO | NOT | NULLS | OFFSET | ON | OPTIMIZE | OR | ORDER | OUTER | OUTFILE | OVER | PARTITION
    | POPULATE | PRECEDING | PREWHERE | PRIMARY | RANGE | RELOAD | REMOVE | RENAME | REPLACE | REPLICA | REPLICATED | RIGHT | ROLLUP | ROW
    | ROWS | SAMPLE | SELECT | SEMI | SENDS | SET | SETTINGS | SHOW | SOURCE | START | STOP | SUBSTRING | SYNC | SYNTAX | SYSTEM | TABLE
    | TABLES | TEMPORARY | TEST | THEN | TIES | TIMEOUT | TIMESTAMP | TOTALS | TRAILING | TRIM | TRUNCATE | TO | TOP | TTL | TYPE
    | UNBOUNDED | UNION | UPDATE | USE | USING | UUID | VALUES | VIEW | VOLUME | WATCH | WHEN | WHERE | WINDOW | WITH
    ;
keywordForAlias
    : DATE | FIRST | ID | KEY
    ;
alias: IDENTIFIER | keywordForAlias;  // |interval| can't be an alias, otherwise 'INTERVAL 1 SOMETHING' becomes ambiguous.
identifier: IDENTIFIER | interval | keyword;
identifierOrNull: identifier | NULL_SQL;  // NULL_SQL can be only 'Null' here.
enumValue: STRING_LITERAL EQ_SINGLE numberLiteral;


// NOTE: don't forget to add new keywords to the parser rule ""keyword""!

// Keywords

ADD: A D D;
AFTER: A F T E R;
ALIAS: A L I A S;
ALL: A L L;
ALTER: A L T E R;
AND: A N D;
ANTI: A N T I;
ANY: A N Y;
ARRAY: A R R A Y;
AS: A S;
ASCENDING: A S C | A S C E N D I N G;
ASOF: A S O F;
AST: A S T;
ASYNC: A S Y N C;
ATTACH: A T T A C H;
BETWEEN: B E T W E E N;
BOTH: B O T H;
BY: B Y;
CASE: C A S E;
CAST: C A S T;
CHECK: C H E C K;
CLEAR: C L E A R;
CLUSTER: C L U S T E R;
CODEC: C O D E C;
COLLATE: C O L L A T E;
COLUMN: C O L U M N;
COMMENT: C O M M E N T;
CONSTRAINT: C O N S T R A I N T;
CREATE: C R E A T E;
CROSS: C R O S S;
CUBE: C U B E;
CURRENT: C U R R E N T;
DATABASE: D A T A B A S E;
DATABASES: D A T A B A S E S;
DATE: D A T E;
DAY: D A Y;
DEDUPLICATE: D E D U P L I C A T E;
DEFAULT: D E F A U L T;
DELAY: D E L A Y;
DELETE: D E L E T E;
DESC: D E S C;
DESCENDING: D E S C E N D I N G;
DESCRIBE: D E S C R I B E;
DETACH: D E T A C H;
DICTIONARIES: D I C T I O N A R I E S;
DICTIONARY: D I C T I O N A R Y;
DISK: D I S K;
DISTINCT: D I S T I N C T;
DISTRIBUTED: D I S T R I B U T E D;
DROP: D R O P;
ELSE: E L S E;
END: E N D;
ENGINE: E N G I N E;
EVENTS: E V E N T S;
EXISTS: E X I S T S;
EXPLAIN: E X P L A I N;
EXPRESSION: E X P R E S S I O N;
EXTRACT: E X T R A C T;
FETCHES: F E T C H E S;
FINAL: F I N A L;
FIRST: F I R S T;
FLUSH: F L U S H;
FOLLOWING: F O L L O W I N G;
FOR: F O R;
FORMAT: F O R M A T;
FREEZE: F R E E Z E;
FROM: F R O M;
FULL: F U L L;
FUNCTION: F U N C T I O N;
GLOBAL: G L O B A L;
GRANULARITY: G R A N U L A R I T Y;
GROUP: G R O U P;
HAVING: H A V I N G;
HIERARCHICAL: H I E R A R C H I C A L;
HOUR: H O U R;
ID: I D;
IF: I F;
ILIKE: I L I K E;
IN: I N;
INDEX: I N D E X;
INF: I N F | I N F I N I T Y;
INJECTIVE: I N J E C T I V E;
INNER: I N N E R;
INSERT: I N S E R T;
INTERVAL: I N T E R V A L;
INTO: I N T O;
IS: I S;
IS_OBJECT_ID: I S UNDERSCORE O B J E C T UNDERSCORE I D;
JOIN: J O I N;
KEY: K E Y;
KILL: K I L L;
LAST: L A S T;
LAYOUT: L A Y O U T;
LEADING: L E A D I N G;
LEFT: L E F T;
LIFETIME: L I F E T I M E;
LIKE: L I K E;
LIMIT: L I M I T;
LIVE: L I V E;
LOCAL: L O C A L;
LOGS: L O G S;
MATERIALIZE: M A T E R I A L I Z E;
MATERIALIZED: M A T E R I A L I Z E D;
MAX: M A X;
MERGES: M E R G E S;
MIN: M I N;
MINUTE: M I N U T E;
MODIFY: M O D I F Y;
MONTH: M O N T H;
MOVE: M O V E;
MUTATION: M U T A T I O N;
NAN_SQL: N A N; // conflicts with macro NAN
NO: N O;
NOT: N O T;
NULL_SQL: N U L L; // conflicts with macro NULL
NULLS: N U L L S;
OFFSET: O F F S E T;
ON: O N;
OPTIMIZE: O P T I M I Z E;
OR: O R;
ORDER: O R D E R;
OUTER: O U T E R;
OUTFILE: O U T F I L E;
OVER: O V E R;
PARTITION: P A R T I T I O N;
POPULATE: P O P U L A T E;
PRECEDING: P R E C E D I N G;
PREWHERE: P R E W H E R E;
PRIMARY: P R I M A R Y;
PROJECTION: P R O J E C T I O N;
QUARTER: Q U A R T E R;
RANGE: R A N G E;
RELOAD: R E L O A D;
REMOVE: R E M O V E;
RENAME: R E N A M E;
REPLACE: R E P L A C E;
REPLICA: R E P L I C A;
REPLICATED: R E P L I C A T E D;
RIGHT: R I G H T;
ROLLUP: R O L L U P;
ROW: R O W;
ROWS: R O W S;
SAMPLE: S A M P L E;
SECOND: S E C O N D;
SELECT: S E L E C T;
SEMI: S E M I;
SENDS: S E N D S;
SET: S E T;
SETTINGS: S E T T I N G S;
SHOW: S H O W;
SOURCE: S O U R C E;
START: S T A R T;
STOP: S T O P;
SUBSTRING: S U B S T R I N G;
SYNC: S Y N C;
SYNTAX: S Y N T A X;
SYSTEM: S Y S T E M;
TABLE: T A B L E;
TABLES: T A B L E S;
TEMPORARY: T E M P O R A R Y;
TEST: T E S T;
THEN: T H E N;
TIES: T I E S;
TIMEOUT: T I M E O U T;
TIMESTAMP: T I M E S T A M P;
TO: T O;
TOP: T O P;
TOTALS: T O T A L S;
TRAILING: T R A I L I N G;
TRIM: T R I M;
TRUNCATE: T R U N C A T E;
TTL: T T L;
TYPE: T Y P E;
UNBOUNDED: U N B O U N D E D;
UNION: U N I O N;
UPDATE: U P D A T E;
USE: U S E;
USING: U S I N G;
UUID: U U I D;
VALUES: V A L U E S;
VIEW: V I E W;
VOLUME: V O L U M E;
WATCH: W A T C H;
WEEK: W E E K;
WHEN: W H E N;
WHERE: W H E R E;
WINDOW: W I N D O W;
WITH: W I T H;
YEAR: Y E A R | Y Y Y Y;

JSON_FALSE: 'false';
JSON_TRUE: 'true';

// Tokens

IDENTIFIER
    : (LETTER | UNDERSCORE) (LETTER | UNDERSCORE | DEC_DIGIT)*
    | BACKQUOTE ( ~([\\\\`]) | (BACKSLASH .) | (BACKQUOTE BACKQUOTE) )* BACKQUOTE
    | QUOTE_DOUBLE ( ~([\\\\""]) | (BACKSLASH .) | (QUOTE_DOUBLE QUOTE_DOUBLE) )* QUOTE_DOUBLE
    ;
FLOATING_LITERAL
    : HEXADECIMAL_LITERAL DOT HEX_DIGIT* (P | E) (PLUS | DASH)? DEC_DIGIT+
    | HEXADECIMAL_LITERAL (P | E) (PLUS | DASH)? DEC_DIGIT+
    | DECIMAL_LITERAL DOT DEC_DIGIT* E (PLUS | DASH)? DEC_DIGIT+
    | DOT DECIMAL_LITERAL E (PLUS | DASH)? DEC_DIGIT+
    | DECIMAL_LITERAL E (PLUS | DASH)? DEC_DIGIT+
    ;
OCTAL_LITERAL: '0' OCT_DIGIT+;
DECIMAL_LITERAL: DEC_DIGIT+;
HEXADECIMAL_LITERAL: '0' X HEX_DIGIT+;

// It's important that quote-symbol is a single character.
STRING_LITERAL: QUOTE_SINGLE ( ~([\\\\']) | (BACKSLASH .) | (QUOTE_SINGLE QUOTE_SINGLE) )* QUOTE_SINGLE;

// Alphabet and allowed symbols

fragment A: [aA];
fragment B: [bB];
fragment C: [cC];
fragment D: [dD];
fragment E: [eE];
fragment F: [fF];
fragment G: [gG];
fragment H: [hH];
fragment I: [iI];
fragment J: [jJ];
fragment K: [kK];
fragment L: [lL];
fragment M: [mM];
fragment N: [nN];
fragment O: [oO];
fragment P: [pP];
fragment Q: [qQ];
fragment R: [rR];
fragment S: [sS];
fragment T: [tT];
fragment U: [uU];
fragment V: [vV];
fragment W: [wW];
fragment X: [xX];
fragment Y: [yY];
fragment Z: [zZ];

fragment LETTER: [a-zA-Z];
fragment OCT_DIGIT: [0-7];
fragment DEC_DIGIT: [0-9];
fragment HEX_DIGIT: [0-9a-fA-F];

ARROW: '->';
ASTERISK: '*';
BACKQUOTE: '`';
BACKSLASH: '\\\\';
COLON: ':';
COMMA: ',';
CONCAT: '||';
DASH: '-';
DOT: '.';
EQ_DOUBLE: '==';
EQ_SINGLE: '=';
GE: '>=';
GT: '>';
LBRACE: '{';
LBRACKET: '[';
LE: '<=';
LPAREN: '(';
LT: '<';
NOT_EQ: '!=' | '<>';
PERCENT: '%';
PLUS: '+';
QUERY: '?';
QUOTE_DOUBLE: '""';
QUOTE_SINGLE: '\\'';
RBRACE: '}';
RBRACKET: ']';
RPAREN: ')';
SEMICOLON: ';';
SLASH: '/';
UNDERSCORE: '_';

// Comments and whitespace

MULTI_LINE_COMMENT: '/*' .*? '*/' -> skip;
SINGLE_LINE_COMMENT: '--' ~('\\n'|'\\r')* ('\\n' | '\\r' | EOF) -> skip;
WHITESPACE: [ \\u000B\\u000C\\t\\r\\n] -> skip;  // '\\n' can be part of multiline single query
",7937,False,1393.2135234039322,median
"/*
 * Licensed under the Apache License, Version 2.0 (the ""License"");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an ""AS IS"" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

grammar SqlBase;

tokens {
    DELIMITER
}

singleStatement
    : statement EOF
    ;

standaloneExpression
    : expression EOF
    ;

standalonePathSpecification
    : pathSpecification EOF
    ;

standaloneType
    : type EOF
    ;

standaloneRowPattern
    : rowPattern EOF
    ;

statement
    : query                                                            #statementDefault
    | USE schema=identifier                                            #use
    | USE catalog=identifier '.' schema=identifier                     #use
    | CREATE SCHEMA (IF NOT EXISTS)? qualifiedName
        (AUTHORIZATION principal)?
        (WITH properties)?                                             #createSchema
    | DROP SCHEMA (IF EXISTS)? qualifiedName (CASCADE | RESTRICT)?     #dropSchema
    | ALTER SCHEMA qualifiedName RENAME TO identifier                  #renameSchema
    | ALTER SCHEMA qualifiedName SET AUTHORIZATION principal           #setSchemaAuthorization
    | CREATE TABLE (IF NOT EXISTS)? qualifiedName columnAliases?
        (COMMENT string)?
        (WITH properties)? AS (query | '('query')')
        (WITH (NO)? DATA)?                                             #createTableAsSelect
    | CREATE TABLE (IF NOT EXISTS)? qualifiedName
        '(' tableElement (',' tableElement)* ')'
         (COMMENT string)?
         (WITH properties)?                                            #createTable
    | DROP TABLE (IF EXISTS)? qualifiedName                            #dropTable
    | INSERT INTO qualifiedName columnAliases? query                   #insertInto
    | DELETE FROM qualifiedName (WHERE booleanExpression)?             #delete
    | TRUNCATE TABLE qualifiedName                                     #truncateTable
    | COMMENT ON TABLE qualifiedName IS (string | NULL)                #commentTable
    | COMMENT ON COLUMN qualifiedName IS (string | NULL)               #commentColumn
    | ALTER TABLE (IF EXISTS)? from=qualifiedName
        RENAME TO to=qualifiedName                                     #renameTable
    | ALTER TABLE (IF EXISTS)? tableName=qualifiedName
        ADD COLUMN (IF NOT EXISTS)? column=columnDefinition            #addColumn
    | ALTER TABLE (IF EXISTS)? tableName=qualifiedName
        RENAME COLUMN (IF EXISTS)? from=identifier TO to=identifier    #renameColumn
    | ALTER TABLE (IF EXISTS)? tableName=qualifiedName
        DROP COLUMN (IF EXISTS)? column=qualifiedName                  #dropColumn
    | ALTER TABLE tableName=qualifiedName SET AUTHORIZATION principal  #setTableAuthorization
    | ALTER TABLE tableName=qualifiedName
        SET PROPERTIES propertyAssignments                             #setTableProperties
    | ALTER TABLE tableName=qualifiedName
        EXECUTE procedureName=identifier
        ('(' (callArgument (',' callArgument)*)? ')')?
        (WHERE where=booleanExpression)?                               #tableExecute
    | ANALYZE qualifiedName (WITH properties)?                         #analyze
    | CREATE (OR REPLACE)? MATERIALIZED VIEW
        (IF NOT EXISTS)? qualifiedName
        (COMMENT string)?
        (WITH properties)? AS query                                    #createMaterializedView
    | CREATE (OR REPLACE)? VIEW qualifiedName
        (COMMENT string)?
        (SECURITY (DEFINER | INVOKER))? AS query                       #createView
    | REFRESH MATERIALIZED VIEW qualifiedName                          #refreshMaterializedView
    | DROP MATERIALIZED VIEW (IF EXISTS)? qualifiedName                #dropMaterializedView
    | ALTER MATERIALIZED VIEW (IF EXISTS)? from=qualifiedName
        RENAME TO to=qualifiedName                                     #renameMaterializedView
    | DROP VIEW (IF EXISTS)? qualifiedName                             #dropView
    | ALTER VIEW from=qualifiedName RENAME TO to=qualifiedName         #renameView
    | ALTER VIEW from=qualifiedName SET AUTHORIZATION principal        #setViewAuthorization
    | CALL qualifiedName '(' (callArgument (',' callArgument)*)? ')'   #call
    | CREATE ROLE name=identifier
        (WITH ADMIN grantor)?
        (IN catalog=identifier)?                                       #createRole
    | DROP ROLE name=identifier (IN catalog=identifier)?            #dropRole
    | GRANT
        roles
        TO principal (',' principal)*
        (WITH ADMIN OPTION)?
        (GRANTED BY grantor)?
        (IN catalog=identifier)?                                       #grantRoles
    | REVOKE
        (ADMIN OPTION FOR)?
        roles
        FROM principal (',' principal)*
        (GRANTED BY grantor)?
        (IN catalog=identifier)?                                       #revokeRoles
    | SET ROLE (ALL | NONE | role=identifier)
        (IN catalog=identifier)?                                       #setRole
    | GRANT
        (privilege (',' privilege)* | ALL PRIVILEGES)
        ON (SCHEMA | TABLE)? qualifiedName
        TO grantee=principal
        (WITH GRANT OPTION)?                                           #grant
    | REVOKE
        (GRANT OPTION FOR)?
        (privilege (',' privilege)* | ALL PRIVILEGES)
        ON (SCHEMA | TABLE)? qualifiedName
        FROM grantee=principal                                         #revoke
    | SHOW GRANTS (ON TABLE? qualifiedName)?                           #showGrants
    | EXPLAIN ('(' explainOption (',' explainOption)* ')')? statement  #explain
    | EXPLAIN ANALYZE VERBOSE? statement                               #explainAnalyze
    | SHOW CREATE TABLE qualifiedName                                  #showCreateTable
    | SHOW CREATE SCHEMA qualifiedName                                 #showCreateSchema
    | SHOW CREATE VIEW qualifiedName                                   #showCreateView
    | SHOW CREATE MATERIALIZED VIEW qualifiedName                      #showCreateMaterializedView
    | SHOW TABLES ((FROM | IN) qualifiedName)?
        (LIKE pattern=string (ESCAPE escape=string)?)?                 #showTables
    | SHOW SCHEMAS ((FROM | IN) identifier)?
        (LIKE pattern=string (ESCAPE escape=string)?)?                 #showSchemas
    | SHOW CATALOGS
        (LIKE pattern=string (ESCAPE escape=string)?)?                 #showCatalogs
    | SHOW COLUMNS (FROM | IN) qualifiedName?
        (LIKE pattern=string (ESCAPE escape=string)?)?                 #showColumns
    | SHOW STATS FOR qualifiedName                                     #showStats
    | SHOW STATS FOR '(' query ')'                                     #showStatsForQuery
    | SHOW CURRENT? ROLES ((FROM | IN) identifier)?                    #showRoles
    | SHOW ROLE GRANTS ((FROM | IN) identifier)?                       #showRoleGrants
    | DESCRIBE qualifiedName                                           #showColumns
    | DESC qualifiedName                                               #showColumns
    | SHOW FUNCTIONS
        (LIKE pattern=string (ESCAPE escape=string)?)?                 #showFunctions
    | SHOW SESSION
        (LIKE pattern=string (ESCAPE escape=string)?)?                 #showSession
    | SET SESSION qualifiedName EQ expression                          #setSession
    | RESET SESSION qualifiedName                                      #resetSession
    | START TRANSACTION (transactionMode (',' transactionMode)*)?      #startTransaction
    | COMMIT WORK?                                                     #commit
    | ROLLBACK WORK?                                                   #rollback
    | PREPARE identifier FROM statement                                #prepare
    | DEALLOCATE PREPARE identifier                                    #deallocate
    | EXECUTE identifier (USING expression (',' expression)*)?         #execute
    | DESCRIBE INPUT identifier                                        #describeInput
    | DESCRIBE OUTPUT identifier                                       #describeOutput
    | SET PATH pathSpecification                                       #setPath
    | SET TIME ZONE (LOCAL | expression)                               #setTimeZone
    | UPDATE qualifiedName
        SET updateAssignment (',' updateAssignment)*
        (WHERE where=booleanExpression)?                               #update
    | MERGE INTO qualifiedName (AS? identifier)?
        USING relation ON expression mergeCase+                        #merge
    ;

query
    :  with? queryNoWith
    ;

with
    : WITH RECURSIVE? namedQuery (',' namedQuery)*
    ;

tableElement
    : columnDefinition
    | likeClause
    ;

columnDefinition
    : identifier type (NOT NULL)? (COMMENT string)? (WITH properties)?
    ;

likeClause
    : LIKE qualifiedName (optionType=(INCLUDING | EXCLUDING) PROPERTIES)?
    ;

properties
    : '(' propertyAssignments ')'
    ;

propertyAssignments
    : property (',' property)*
    ;

property
    : identifier EQ expression
    ;

queryNoWith
    : queryTerm
      (ORDER BY sortItem (',' sortItem)*)?
      (OFFSET offset=rowCount (ROW | ROWS)?)?
      ( (LIMIT limit=limitRowCount)
      | (FETCH (FIRST | NEXT) (fetchFirst=rowCount)? (ROW | ROWS) (ONLY | WITH TIES))
      )?
    ;

limitRowCount
    : ALL
    | rowCount
    ;

rowCount
    : INTEGER_VALUE
    | QUESTION_MARK
    ;

queryTerm
    : queryPrimary                                                             #queryTermDefault
    | left=queryTerm operator=INTERSECT setQuantifier? right=queryTerm         #setOperation
    | left=queryTerm operator=(UNION | EXCEPT) setQuantifier? right=queryTerm  #setOperation
    ;

queryPrimary
    : querySpecification                   #queryPrimaryDefault
    | TABLE qualifiedName                  #table
    | VALUES expression (',' expression)*  #inlineTable
    | '(' queryNoWith ')'                  #subquery
    ;

sortItem
    : expression ordering=(ASC | DESC)? (NULLS nullOrdering=(FIRST | LAST))?
    ;

querySpecification
    : SELECT setQuantifier? selectItem (',' selectItem)*
      (FROM relation (',' relation)*)?
      (WHERE where=booleanExpression)?
      (GROUP BY groupBy)?
      (HAVING having=booleanExpression)?
      (WINDOW windowDefinition (',' windowDefinition)*)?
    ;

groupBy
    : setQuantifier? groupingElement (',' groupingElement)*
    ;

groupingElement
    : groupingSet                                            #singleGroupingSet
    | ROLLUP '(' (expression (',' expression)*)? ')'         #rollup
    | CUBE '(' (expression (',' expression)*)? ')'           #cube
    | GROUPING SETS '(' groupingSet (',' groupingSet)* ')'   #multipleGroupingSets
    ;

groupingSet
    : '(' (expression (',' expression)*)? ')'
    | expression
    ;

windowDefinition
    : name=identifier AS '(' windowSpecification ')'
    ;

windowSpecification
    : (existingWindowName=identifier)?
      (PARTITION BY partition+=expression (',' partition+=expression)*)?
      (ORDER BY sortItem (',' sortItem)*)?
      windowFrame?
    ;

namedQuery
    : name=identifier (columnAliases)? AS '(' query ')'
    ;

setQuantifier
    : DISTINCT
    | ALL
    ;

selectItem
    : expression (AS? identifier)?                          #selectSingle
    | primaryExpression '.' ASTERISK (AS columnAliases)?    #selectAll
    | ASTERISK                                              #selectAll
    ;

relation
    : left=relation
      ( CROSS JOIN right=sampledRelation
      | joinType JOIN rightRelation=relation joinCriteria
      | NATURAL joinType JOIN right=sampledRelation
      )                                                     #joinRelation
    | sampledRelation                                       #relationDefault
    ;

joinType
    : INNER?
    | LEFT OUTER?
    | RIGHT OUTER?
    | FULL OUTER?
    ;

joinCriteria
    : ON booleanExpression
    | USING '(' identifier (',' identifier)* ')'
    ;

sampledRelation
    : patternRecognition (
        TABLESAMPLE sampleType '(' percentage=expression ')'
      )?
    ;

sampleType
    : BERNOULLI
    | SYSTEM
    ;

listAggOverflowBehavior
    : ERROR
    | TRUNCATE string? listaggCountIndication
    ;

listaggCountIndication
    : WITH COUNT
    | WITHOUT COUNT
    ;

patternRecognition
    : aliasedRelation (
        MATCH_RECOGNIZE '('
          (PARTITION BY partition+=expression (',' partition+=expression)*)?
          (ORDER BY sortItem (',' sortItem)*)?
          (MEASURES measureDefinition (',' measureDefinition)*)?
          rowsPerMatch?
          (AFTER MATCH skipTo)?
          (INITIAL | SEEK)?
          PATTERN '(' rowPattern ')'
          (SUBSET subsetDefinition (',' subsetDefinition)*)?
          DEFINE variableDefinition (',' variableDefinition)*
        ')'
        (AS? identifier columnAliases?)?
      )?
    ;

measureDefinition
    : expression AS identifier
    ;

rowsPerMatch
    : ONE ROW PER MATCH
    | ALL ROWS PER MATCH emptyMatchHandling?
    ;

emptyMatchHandling
    : SHOW EMPTY MATCHES
    | OMIT EMPTY MATCHES
    | WITH UNMATCHED ROWS
    ;

skipTo
    : 'SKIP' TO NEXT ROW
    | 'SKIP' PAST LAST ROW
    | 'SKIP' TO FIRST identifier
    | 'SKIP' TO LAST identifier
    | 'SKIP' TO identifier
    ;

subsetDefinition
    : name=identifier EQ '(' union+=identifier (',' union+=identifier)* ')'
    ;

variableDefinition
    : identifier AS expression
    ;

aliasedRelation
    : relationPrimary (AS? identifier columnAliases?)?
    ;

columnAliases
    : '(' identifier (',' identifier)* ')'
    ;

relationPrimary
    : qualifiedName queryPeriod?                                      #tableName
    | '(' query ')'                                                   #subqueryRelation
    | UNNEST '(' expression (',' expression)* ')' (WITH ORDINALITY)?  #unnest
    | LATERAL '(' query ')'                                           #lateral
    | '(' relation ')'                                                #parenthesizedRelation
    ;

expression
    : booleanExpression
    ;

booleanExpression
    : valueExpression predicate[$valueExpression.ctx]?  #predicated
    | NOT booleanExpression                             #logicalNot
    | booleanExpression AND booleanExpression           #and
    | booleanExpression OR booleanExpression            #or
    ;

// workaround for https://github.com/antlr/antlr4/issues/780
predicate[ParserRuleContext value]
    : comparisonOperator right=valueExpression                            #comparison
    | comparisonOperator comparisonQuantifier '(' query ')'               #quantifiedComparison
    | NOT? BETWEEN lower=valueExpression AND upper=valueExpression        #between
    | NOT? IN '(' expression (',' expression)* ')'                        #inList
    | NOT? IN '(' query ')'                                               #inSubquery
    | NOT? LIKE pattern=valueExpression (ESCAPE escape=valueExpression)?  #like
    | IS NOT? NULL                                                        #nullPredicate
    | IS NOT? DISTINCT FROM right=valueExpression                         #distinctFrom
    ;

valueExpression
    : primaryExpression                                                                 #valueExpressionDefault
    | valueExpression AT timeZoneSpecifier                                              #atTimeZone
    | operator=(MINUS | PLUS) valueExpression                                           #arithmeticUnary
    | left=valueExpression operator=(ASTERISK | SLASH | PERCENT) right=valueExpression  #arithmeticBinary
    | left=valueExpression operator=(PLUS | MINUS) right=valueExpression                #arithmeticBinary
    | left=valueExpression CONCAT right=valueExpression                                 #concatenation
    ;

primaryExpression
    : NULL                                                                                #nullLiteral
    | interval                                                                            #intervalLiteral
    | identifier string                                                                   #typeConstructor
    | DOUBLE PRECISION string                                                             #typeConstructor
    | number                                                                              #numericLiteral
    | booleanValue                                                                        #booleanLiteral
    | string                                                                              #stringLiteral
    | BINARY_LITERAL                                                                      #binaryLiteral
    | QUESTION_MARK                                                                       #parameter
    | POSITION '(' valueExpression IN valueExpression ')'                                 #position
    | '(' expression (',' expression)+ ')'                                                #rowConstructor
    | ROW '(' expression (',' expression)* ')'                                            #rowConstructor
    | name=LISTAGG '(' setQuantifier? expression (',' string)?
        (ON OVERFLOW listAggOverflowBehavior)? ')'
        (WITHIN GROUP '(' ORDER BY sortItem (',' sortItem)* ')')                          #listagg
    | processingMode? qualifiedName '(' (label=identifier '.')? ASTERISK ')'
        filter? over?                                                                     #functionCall
    | processingMode? qualifiedName '(' (setQuantifier? expression (',' expression)*)?
        (ORDER BY sortItem (',' sortItem)*)? ')' filter? (nullTreatment? over)?           #functionCall
    | identifier over                                                                     #measure
    | identifier '->' expression                                                          #lambda
    | '(' (identifier (',' identifier)*)? ')' '->' expression                             #lambda
    | '(' query ')'                                                                       #subqueryExpression
    // This is an extension to ANSI SQL, which considers EXISTS to be a <boolean expression>
    | EXISTS '(' query ')'                                                                #exists
    | CASE operand=expression whenClause+ (ELSE elseExpression=expression)? END           #simpleCase
    | CASE whenClause+ (ELSE elseExpression=expression)? END                              #searchedCase
    | CAST '(' expression AS type ')'                                                     #cast
    | TRY_CAST '(' expression AS type ')'                                                 #cast
    | ARRAY '[' (expression (',' expression)*)? ']'                                       #arrayConstructor
    | value=primaryExpression '[' index=valueExpression ']'                               #subscript
    | identifier                                                                          #columnReference
    | base=primaryExpression '.' fieldName=identifier                                     #dereference
    | name=CURRENT_DATE                                                                   #specialDateTimeFunction
    | name=CURRENT_TIME ('(' precision=INTEGER_VALUE ')')?                                #specialDateTimeFunction
    | name=CURRENT_TIMESTAMP ('(' precision=INTEGER_VALUE ')')?                           #specialDateTimeFunction
    | name=LOCALTIME ('(' precision=INTEGER_VALUE ')')?                                   #specialDateTimeFunction
    | name=LOCALTIMESTAMP ('(' precision=INTEGER_VALUE ')')?                              #specialDateTimeFunction
    | name=CURRENT_USER                                                                   #currentUser
    | name=CURRENT_CATALOG                                                                #currentCatalog
    | name=CURRENT_SCHEMA                                                                 #currentSchema
    | name=CURRENT_PATH                                                                   #currentPath
    | SUBSTRING '(' valueExpression FROM valueExpression (FOR valueExpression)? ')'       #substring
    | NORMALIZE '(' valueExpression (',' normalForm)? ')'                                 #normalize
    | EXTRACT '(' identifier FROM valueExpression ')'                                     #extract
    | '(' expression ')'                                                                  #parenthesizedExpression
    | GROUPING '(' (qualifiedName (',' qualifiedName)*)? ')'                              #groupingOperation
    ;

processingMode
    : RUNNING
    | FINAL
    ;

nullTreatment
    : IGNORE NULLS
    | RESPECT NULLS
    ;

string
    : STRING                                #basicStringLiteral
    | UNICODE_STRING (UESCAPE STRING)?      #unicodeStringLiteral
    ;

timeZoneSpecifier
    : TIME ZONE interval  #timeZoneInterval
    | TIME ZONE string    #timeZoneString
    ;

comparisonOperator
    : EQ | NEQ | LT | LTE | GT | GTE
    ;

comparisonQuantifier
    : ALL | SOME | ANY
    ;

booleanValue
    : TRUE | FALSE
    ;

interval
    : INTERVAL sign=(PLUS | MINUS)? string from=intervalField (TO to=intervalField)?
    ;

intervalField
    : YEAR | MONTH | DAY | HOUR | MINUTE | SECOND
    ;

normalForm
    : NFD | NFC | NFKD | NFKC
    ;

type
    : ROW '(' rowField (',' rowField)* ')'                                         #rowType
    | INTERVAL from=intervalField (TO to=intervalField)?                           #intervalType
    | base=TIMESTAMP ('(' precision = typeParameter ')')? (WITHOUT TIME ZONE)?     #dateTimeType
    | base=TIMESTAMP ('(' precision = typeParameter ')')? WITH TIME ZONE           #dateTimeType
    | base=TIME ('(' precision = typeParameter ')')? (WITHOUT TIME ZONE)?          #dateTimeType
    | base=TIME ('(' precision = typeParameter ')')? WITH TIME ZONE                #dateTimeType
    | DOUBLE PRECISION                                                             #doublePrecisionType
    | ARRAY '<' type '>'                                                           #legacyArrayType
    | MAP '<' keyType=type ',' valueType=type '>'                                  #legacyMapType
    | type ARRAY ('[' INTEGER_VALUE ']')?                                          #arrayType
    | identifier ('(' typeParameter (',' typeParameter)* ')')?                     #genericType
    ;

rowField
    : type
    | identifier type;

typeParameter
    : INTEGER_VALUE | type
    ;

whenClause
    : WHEN condition=expression THEN result=expression
    ;

filter
    : FILTER '(' WHERE booleanExpression ')'
    ;

mergeCase
    : WHEN MATCHED (AND condition=expression)? THEN
        UPDATE SET targets+=identifier EQ values+=expression
          (',' targets+=identifier EQ values+=expression)*                  #mergeUpdate
    | WHEN MATCHED (AND condition=expression)? THEN DELETE                  #mergeDelete
    | WHEN NOT MATCHED (AND condition=expression)? THEN
        INSERT ('(' targets+=identifier (',' targets+=identifier)* ')')?
        VALUES '(' values+=expression (',' values+=expression)* ')'         #mergeInsert
    ;

over
    : OVER (windowName=identifier | '(' windowSpecification ')')
    ;

windowFrame
    : (MEASURES measureDefinition (',' measureDefinition)*)?
      frameExtent
      (AFTER MATCH skipTo)?
      (INITIAL | SEEK)?
      (PATTERN '(' rowPattern ')')?
      (SUBSET subsetDefinition (',' subsetDefinition)*)?
      (DEFINE variableDefinition (',' variableDefinition)*)?
    ;

frameExtent
    : frameType=RANGE start=frameBound
    | frameType=ROWS start=frameBound
    | frameType=GROUPS start=frameBound
    | frameType=RANGE BETWEEN start=frameBound AND end=frameBound
    | frameType=ROWS BETWEEN start=frameBound AND end=frameBound
    | frameType=GROUPS BETWEEN start=frameBound AND end=frameBound
    ;

frameBound
    : UNBOUNDED boundType=PRECEDING                 #unboundedFrame
    | UNBOUNDED boundType=FOLLOWING                 #unboundedFrame
    | CURRENT ROW                                   #currentRowBound
    | expression boundType=(PRECEDING | FOLLOWING)  #boundedFrame
    ;

rowPattern
    : patternPrimary patternQuantifier?                 #quantifiedPrimary
    | rowPattern rowPattern                             #patternConcatenation
    | rowPattern '|' rowPattern                         #patternAlternation
    ;

patternPrimary
    : identifier                                        #patternVariable
    | '(' ')'                                           #emptyPattern
    | PERMUTE '(' rowPattern (',' rowPattern)* ')'      #patternPermutation
    | '(' rowPattern ')'                                #groupedPattern
    | '^'                                               #partitionStartAnchor
    | '$'                                               #partitionEndAnchor
    | '{-' rowPattern '-}'                              #excludedPattern
    ;

patternQuantifier
    : ASTERISK (reluctant=QUESTION_MARK)?                                                       #zeroOrMoreQuantifier
    | PLUS (reluctant=QUESTION_MARK)?                                                           #oneOrMoreQuantifier
    | QUESTION_MARK (reluctant=QUESTION_MARK)?                                                  #zeroOrOneQuantifier
    | '{' exactly=INTEGER_VALUE '}' (reluctant=QUESTION_MARK)?                                  #rangeQuantifier
    | '{' (atLeast=INTEGER_VALUE)? ',' (atMost=INTEGER_VALUE)? '}' (reluctant=QUESTION_MARK)?   #rangeQuantifier
    ;

updateAssignment
    : identifier EQ expression
    ;

explainOption
    : FORMAT value=(TEXT | GRAPHVIZ | JSON)                 #explainFormat
    | TYPE value=(LOGICAL | DISTRIBUTED | VALIDATE | IO)    #explainType
    ;

transactionMode
    : ISOLATION LEVEL levelOfIsolation    #isolationLevel
    | READ accessMode=(ONLY | WRITE)      #transactionAccessMode
    ;

levelOfIsolation
    : READ UNCOMMITTED                    #readUncommitted
    | READ COMMITTED                      #readCommitted
    | REPEATABLE READ                     #repeatableRead
    | SERIALIZABLE                        #serializable
    ;

callArgument
    : expression                    #positionalArgument
    | identifier '=>' expression    #namedArgument
    ;

pathElement
    : identifier '.' identifier     #qualifiedArgument
    | identifier                    #unqualifiedArgument
    ;

pathSpecification
    : pathElement (',' pathElement)*
    ;

privilege
    : CREATE | SELECT | DELETE | INSERT | UPDATE
    ;

qualifiedName
    : identifier ('.' identifier)*
    ;

queryPeriod
    : FOR rangeType AS OF end=valueExpression
    ;

rangeType
    : TIMESTAMP
    | VERSION
    ;

grantor
    : principal             #specifiedPrincipal
    | CURRENT_USER          #currentUserGrantor
    | CURRENT_ROLE          #currentRoleGrantor
    ;

principal
    : identifier            #unspecifiedPrincipal
    | USER identifier       #userPrincipal
    | ROLE identifier       #rolePrincipal
    ;

roles
    : identifier (',' identifier)*
    ;

identifier
    : IDENTIFIER             #unquotedIdentifier
    | QUOTED_IDENTIFIER      #quotedIdentifier
    | nonReserved            #unquotedIdentifier
    | BACKQUOTED_IDENTIFIER  #backQuotedIdentifier
    | DIGIT_IDENTIFIER       #digitIdentifier
    ;

number
    : MINUS? DECIMAL_VALUE  #decimalLiteral
    | MINUS? DOUBLE_VALUE   #doubleLiteral
    | MINUS? INTEGER_VALUE  #integerLiteral
    ;

nonReserved
    // IMPORTANT: this rule must only contain tokens. Nested rules are not supported. See SqlParser.exitNonReserved
    : ADD | ADMIN | AFTER | ALL | ANALYZE | ANY | ARRAY | ASC | AT | AUTHORIZATION
    | BERNOULLI
    | CALL | CASCADE | CATALOGS | COLUMN | COLUMNS | COMMENT | COMMIT | COMMITTED | COUNT | CURRENT
    | DATA | DATE | DAY | DEFINE | DEFINER | DESC | DISTRIBUTED | DOUBLE
    | EMPTY | ERROR | EXCLUDING | EXPLAIN
    | FETCH | FILTER | FINAL | FIRST | FOLLOWING | FORMAT | FUNCTIONS
    | GRANT | GRANTED | GRANTS | GRAPHVIZ | GROUPS
    | HOUR
    | IF | IGNORE | INCLUDING | INITIAL | INPUT | INTERVAL | INVOKER | IO | ISOLATION
    | JSON
    | LAST | LATERAL | LEVEL | LIMIT | LOCAL | LOGICAL
    | MAP | MATCH | MATCHED | MATCHES | MATCH_RECOGNIZE | MATERIALIZED | MEASURES | MERGE | MINUTE | MONTH
    | NEXT | NFC | NFD | NFKC | NFKD | NO | NONE | NULLIF | NULLS
    | OF | OFFSET | OMIT | ONE | ONLY | OPTION | ORDINALITY | OUTPUT | OVER | OVERFLOW
    | PARTITION | PARTITIONS | PAST | PATH | PATTERN | PER | PERMUTE | POSITION | PRECEDING | PRECISION | PRIVILEGES | PROPERTIES
    | RANGE | READ | REFRESH | RENAME | REPEATABLE | REPLACE | RESET | RESPECT | RESTRICT | REVOKE | ROLE | ROLES | ROLLBACK | ROW | ROWS | RUNNING
    | SCHEMA | SCHEMAS | SECOND | SECURITY | SEEK | SERIALIZABLE | SESSION | SET | SETS
    | SHOW | SOME | START | STATS | SUBSET | SUBSTRING | SYSTEM
    | TABLES | TABLESAMPLE | TEXT | TIES | TIME | TIMESTAMP | TO | TRANSACTION | TRUNCATE | TRY_CAST | TYPE
    | UNBOUNDED | UNCOMMITTED | UNMATCHED | UPDATE | USE | USER
    | VALIDATE | VERBOSE | VERSION | VIEW
    | WINDOW | WITHIN | WITHOUT | WORK | WRITE
    | YEAR
    | ZONE
    ;

ADD: 'ADD';
ADMIN: 'ADMIN';
AFTER: 'AFTER';
ALL: 'ALL';
ALTER: 'ALTER';
ANALYZE: 'ANALYZE';
AND: 'AND';
ANY: 'ANY';
ARRAY: 'ARRAY';
AS: 'AS';
ASC: 'ASC';
AT: 'AT';
AUTHORIZATION: 'AUTHORIZATION';
BERNOULLI: 'BERNOULLI';
BETWEEN: 'BETWEEN';
BY: 'BY';
CALL: 'CALL';
CASCADE: 'CASCADE';
CASE: 'CASE';
CAST: 'CAST';
CATALOGS: 'CATALOGS';
COLUMN: 'COLUMN';
COLUMNS: 'COLUMNS';
COMMENT: 'COMMENT';
COMMIT: 'COMMIT';
COMMITTED: 'COMMITTED';
CONSTRAINT: 'CONSTRAINT';
COUNT: 'COUNT';
CREATE: 'CREATE';
CROSS: 'CROSS';
CUBE: 'CUBE';
CURRENT: 'CURRENT';
CURRENT_CATALOG: 'CURRENT_CATALOG';
CURRENT_DATE: 'CURRENT_DATE';
CURRENT_PATH: 'CURRENT_PATH';
CURRENT_ROLE: 'CURRENT_ROLE';
CURRENT_SCHEMA: 'CURRENT_SCHEMA';
CURRENT_TIME: 'CURRENT_TIME';
CURRENT_TIMESTAMP: 'CURRENT_TIMESTAMP';
CURRENT_USER: 'CURRENT_USER';
DATA: 'DATA';
DATE: 'DATE';
DAY: 'DAY';
DEALLOCATE: 'DEALLOCATE';
DEFINER: 'DEFINER';
DELETE: 'DELETE';
DESC: 'DESC';
DESCRIBE: 'DESCRIBE';
DEFINE: 'DEFINE';
DISTINCT: 'DISTINCT';
DISTRIBUTED: 'DISTRIBUTED';
DOUBLE: 'DOUBLE';
DROP: 'DROP';
ELSE: 'ELSE';
EMPTY: 'EMPTY';
END: 'END';
ERROR: 'ERROR';
ESCAPE: 'ESCAPE';
EXCEPT: 'EXCEPT';
EXCLUDING: 'EXCLUDING';
EXECUTE: 'EXECUTE';
EXISTS: 'EXISTS';
EXPLAIN: 'EXPLAIN';
EXTRACT: 'EXTRACT';
FALSE: 'FALSE';
FETCH: 'FETCH';
FILTER: 'FILTER';
FINAL: 'FINAL';
FIRST: 'FIRST';
FOLLOWING: 'FOLLOWING';
FOR: 'FOR';
FORMAT: 'FORMAT';
FROM: 'FROM';
FULL: 'FULL';
FUNCTIONS: 'FUNCTIONS';
GRANT: 'GRANT';
GRANTED: 'GRANTED';
GRANTS: 'GRANTS';
GRAPHVIZ: 'GRAPHVIZ';
GROUP: 'GROUP';
GROUPING: 'GROUPING';
GROUPS: 'GROUPS';
HAVING: 'HAVING';
HOUR: 'HOUR';
IF: 'IF';
IGNORE: 'IGNORE';
IN: 'IN';
INCLUDING: 'INCLUDING';
INITIAL: 'INITIAL';
INNER: 'INNER';
INPUT: 'INPUT';
INSERT: 'INSERT';
INTERSECT: 'INTERSECT';
INTERVAL: 'INTERVAL';
INTO: 'INTO';
INVOKER: 'INVOKER';
IO: 'IO';
IS: 'IS';
ISOLATION: 'ISOLATION';
JOIN: 'JOIN';
JSON: 'JSON';
LAST: 'LAST';
LATERAL: 'LATERAL';
LEFT: 'LEFT';
LEVEL: 'LEVEL';
LIKE: 'LIKE';
LIMIT: 'LIMIT';
LISTAGG: 'LISTAGG';
LOCAL: 'LOCAL';
LOCALTIME: 'LOCALTIME';
LOCALTIMESTAMP: 'LOCALTIMESTAMP';
LOGICAL: 'LOGICAL';
MAP: 'MAP';
MATCH: 'MATCH';
MATCHED: 'MATCHED';
MATCHES: 'MATCHES';
MATCH_RECOGNIZE: 'MATCH_RECOGNIZE';
MATERIALIZED: 'MATERIALIZED';
MEASURES: 'MEASURES';
MERGE: 'MERGE';
MINUTE: 'MINUTE';
MONTH: 'MONTH';
NATURAL: 'NATURAL';
NEXT: 'NEXT';
NFC : 'NFC';
NFD : 'NFD';
NFKC : 'NFKC';
NFKD : 'NFKD';
NO: 'NO';
NONE: 'NONE';
NORMALIZE: 'NORMALIZE';
NOT: 'NOT';
NULL: 'NULL';
NULLIF: 'NULLIF';
NULLS: 'NULLS';
OFFSET: 'OFFSET';
OMIT: 'OMIT';
OF: 'OF';
ON: 'ON';
ONE: 'ONE';
ONLY: 'ONLY';
OPTION: 'OPTION';
OR: 'OR';
ORDER: 'ORDER';
ORDINALITY: 'ORDINALITY';
OUTER: 'OUTER';
OUTPUT: 'OUTPUT';
OVER: 'OVER';
OVERFLOW: 'OVERFLOW';
PARTITION: 'PARTITION';
PARTITIONS: 'PARTITIONS';
PAST: 'PAST';
PATH: 'PATH';
PATTERN: 'PATTERN';
PER: 'PER';
PERMUTE: 'PERMUTE';
POSITION: 'POSITION';
PRECEDING: 'PRECEDING';
PRECISION: 'PRECISION';
PREPARE: 'PREPARE';
PRIVILEGES: 'PRIVILEGES';
PROPERTIES: 'PROPERTIES';
RANGE: 'RANGE';
READ: 'READ';
RECURSIVE: 'RECURSIVE';
REFRESH: 'REFRESH';
RENAME: 'RENAME';
REPEATABLE: 'REPEATABLE';
REPLACE: 'REPLACE';
RESET: 'RESET';
RESPECT: 'RESPECT';
RESTRICT: 'RESTRICT';
REVOKE: 'REVOKE';
RIGHT: 'RIGHT';
ROLE: 'ROLE';
ROLES: 'ROLES';
ROLLBACK: 'ROLLBACK';
ROLLUP: 'ROLLUP';
ROW: 'ROW';
ROWS: 'ROWS';
RUNNING: 'RUNNING';
SCHEMA: 'SCHEMA';
SCHEMAS: 'SCHEMAS';
SECOND: 'SECOND';
SECURITY: 'SECURITY';
SEEK: 'SEEK';
SELECT: 'SELECT';
SERIALIZABLE: 'SERIALIZABLE';
SESSION: 'SESSION';
SET: 'SET';
SETS: 'SETS';
SHOW: 'SHOW';
SOME: 'SOME';
START: 'START';
STATS: 'STATS';
SUBSET: 'SUBSET';
SUBSTRING: 'SUBSTRING';
SYSTEM: 'SYSTEM';
TABLE: 'TABLE';
TABLES: 'TABLES';
TABLESAMPLE: 'TABLESAMPLE';
TEXT: 'TEXT';
THEN: 'THEN';
TIES: 'TIES';
TIME: 'TIME';
TIMESTAMP: 'TIMESTAMP';
TO: 'TO';
TRANSACTION: 'TRANSACTION';
TRUE: 'TRUE';
TRUNCATE: 'TRUNCATE';
TRY_CAST: 'TRY_CAST';
TYPE: 'TYPE';
UESCAPE: 'UESCAPE';
UNBOUNDED: 'UNBOUNDED';
UNCOMMITTED: 'UNCOMMITTED';
UNION: 'UNION';
UNMATCHED: 'UNMATCHED';
UNNEST: 'UNNEST';
UPDATE: 'UPDATE';
USE: 'USE';
USER: 'USER';
USING: 'USING';
VALIDATE: 'VALIDATE';
VALUES: 'VALUES';
VERBOSE: 'VERBOSE';
VERSION: 'VERSION';
VIEW: 'VIEW';
WHEN: 'WHEN';
WHERE: 'WHERE';
WINDOW: 'WINDOW';
WITH: 'WITH';
WITHIN: 'WITHIN';
WITHOUT: 'WITHOUT';
WORK: 'WORK';
WRITE: 'WRITE';
YEAR: 'YEAR';
ZONE: 'ZONE';

EQ: '=';
NEQ: '<>' | '!=';
LT: '<';
LTE: '<=';
GT: '>';
GTE: '>=';

PLUS: '+';
MINUS: '-';
ASTERISK: '*';
SLASH: '/';
PERCENT: '%';
CONCAT: '||';
QUESTION_MARK: '?';

STRING
    : '\\'' ( ~'\\'' | '\\'\\'' )* '\\''
    ;

UNICODE_STRING
    : 'U&\\'' ( ~'\\'' | '\\'\\'' )* '\\''
    ;

// Note: we allow any character inside the binary literal and validate
// its a correct literal when the AST is being constructed. This
// allows us to provide more meaningful error messages to the user
BINARY_LITERAL
    : 'X\\'' (~'\\'')* '\\''
    ;

INTEGER_VALUE
    : DIGIT+
    ;

DECIMAL_VALUE
    : DIGIT+ '.' DIGIT*
    | '.' DIGIT+
    ;

DOUBLE_VALUE
    : DIGIT+ ('.' DIGIT*)? EXPONENT
    | '.' DIGIT+ EXPONENT
    ;

IDENTIFIER
    : (LETTER | '_') (LETTER | DIGIT | '_')*
    ;

DIGIT_IDENTIFIER
    : DIGIT (LETTER | DIGIT | '_')+
    ;

QUOTED_IDENTIFIER
    : '""' ( ~'""' | '""""' )* '""'
    ;

BACKQUOTED_IDENTIFIER
    : '`' ( ~'`' | '``' )* '`'
    ;

fragment EXPONENT
    : 'E' [+-]? DIGIT+
    ;

fragment DIGIT
    : [0-9]
    ;

fragment LETTER
    : [A-Z]
    ;

SIMPLE_COMMENT
    : '--' ~[\\r\\n]* '\\r'? '\\n'? -> channel(HIDDEN)
    ;

BRACKETED_COMMENT
    : '/*' .*? '*/' -> channel(HIDDEN)
    ;

WS
    : [ \\r\\n\\t]+ -> channel(HIDDEN)
    ;

// Catch-all for anything we can't recognize.
// We use this to be able to ignore and recover all the text
// when splitting statements with DelimiterLexer
UNRECOGNIZED
    : .
    ;
",8043,False,1475.3601844470904,median
"[[salesforce-component]]
== Salesforce Component

*Available as of Camel version 2.12*

This component supports producer and consumer endpoints to communicate
with Salesforce using Java DTOs.  +
 There is a companion maven plugin Camel Salesforce Plugin that
generates these DTOs (see further below).

Maven users will need to add the following dependency to their `pom.xml`
for this component:

[source,xml]
----
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-salesforce</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
----

NOTE: Developers wishing to contribute to the component are instructed
to look at the https://github.com/apache/camel/tree/master/components/camel-salesforce/camel-salesforce-component/README.md[README.md] file on instructions on how to get started and
setup your environment for running integration tests.

=== Authenticating to Salesforce

The component supports three OAuth authentication flows:

* https://help.salesforce.com/articleView?id=remoteaccess_oauth_username_password_flow.htm[OAuth 2.0 Username-Password Flow]
* https://help.salesforce.com/articleView?id=remoteaccess_oauth_refresh_token_flow.htm[OAuth 2.0 Refresh Token Flow]
* https://help.salesforce.com/articleView?id=remoteaccess_oauth_jwt_flow.htm[OAuth 2.0 JWT Bearer Token Flow]

For each of the flow different set of properties needs to be set:

.Properties to set for each authentication flow
|===
| Property     | Where to find it on Salesforce     | Flow

| clientId     | Connected App, Consumer Key        | All flows
| clientSecret | Connected App, Consumer Secret     | Username-Password, Refresh Token
| userName     | Salesforce user username           | Username-Password, JWT Bearer Token
| password     | Salesforce user password           | Username-Password
| refreshToken | From OAuth flow callback           | Refresh Token
| keystore     | Connected App, Digital Certificate | JWT Bearer Token
|===

The component auto determines what flow you're trying to configure, to
be remove ambiguity set the `authenticationType` property.

NOTE: Using Username-Password Flow in production is not encouraged.

NOTE: The certificate used in JWT Bearer Token Flow can be a selfsigned 
certificate. The KeyStore holding the certificate and the private key
must contain only single certificate-private key entry.

=== URI format

When used as a consumer, receiving streaming events, the URI scheme is:

[source,java]
----
salesforce:topic?options
----

When used as a producer, invoking the Salesforce REST APIs, the URI
scheme is:

[source,java]
----
salesforce:operationName?options
----

You can append query options to the URI in the following format,
`?option=value&option=value&...`

=== Passing in Salesforce headers and fetching Salesforce response headers

There is support to pass https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/headers.htm[Salesforce headers]
via inbound message headers, header names that start with `Sforce` or
`x-sfdc` on the Camel message will be passed on in the request, and
response headers that start with `Sforce` will be present in the outbound
message headers.

For example to fetch API limits you can specify:

[source,java]
----
// in your Camel route set the header before Salesforce endpoint
//...
  .setHeader(""Sforce-Limit-Info"", constant(""api-usage""))
  .to(""salesforce:getGlobalObjects"")
  .to(myProcessor);

// myProcessor will receive `Sforce-Limit-Info` header on the outbound
// message
class MyProcessor implements Processor {
    public void process(Exchange exchange) throws Exception {
        Message in = exchange.getIn();
        String apiLimits = in.getHeader(""Sforce-Limit-Info"", String.class);
   }
}
----

=== Supported Salesforce APIs

The component supports the following Salesforce APIs

Producer endpoints can use the following APIs. Most of the APIs process
one record at a time, the Query API can retrieve multiple Records.

==== Rest API

You can use the following for `operationName`:

* getVersions - Gets supported Salesforce REST API versions
* getResources - Gets available Salesforce REST Resource endpoints
* getGlobalObjects - Gets metadata for all available SObject types
* getBasicInfo - Gets basic metadata for a specific SObject type
* getDescription - Gets comprehensive metadata for a specific SObject
type
* getSObject - Gets an SObject using its Salesforce Id
* createSObject - Creates an SObject
* updateSObject - Updates an SObject using Id
* deleteSObject - Deletes an SObject using Id
* getSObjectWithId - Gets an SObject using an external (user defined) id
field
* upsertSObject - Updates or inserts an SObject using an external id
* deleteSObjectWithId - Deletes an SObject using an external id
* query - Runs a Salesforce SOQL query
* queryMore - Retrieves more results (in case of large number of
results) using result link returned from the 'query' API
* search - Runs a Salesforce SOSL query
* limits - fetching organization API usage limits
* recent - fetching recent items
* approval - submit a record or records (batch) for approval process
* approvals - fetch a list of all approval processes
* composite - submit up to 25 possibly related REST requests and receive individual responses
* composite-tree - create up to 200 records with parent-child relationships (up to 5 levels) in one go
* composite-batch - submit a composition of requests in batch
* queryAll - Runs a SOQL query. It returns the results that are deleted because of a merge or delete. Also returns the  information about archived Task and Event records.
* getBlobField - Retrieves the specified blob field from an individual record.
* apexCall - Executes a user defined APEX REST API call.

For example, the following producer endpoint uses the upsertSObject API,
with the sObjectIdName parameter specifying 'Name' as the external id
field. 
The request message body should be an SObject DTO generated using the
maven plugin.  
The response message will either be `null` if an existing record was
updated, or `CreateSObjectResult` with an id of the new record, or a
list of errors while creating the new object.

[source,java]
----
...to(""salesforce:upsertSObject?sObjectIdName=Name"")...
----

==== Rest Bulk API

Producer endpoints can use the following APIs. All Job data formats,
i.e. xml, csv, zip/xml, and zip/csv are supported.  +
 The request and response have to be marshalled/unmarshalled by the
route. Usually the request will be some stream source like a CSV file,
 +
 and the response may also be saved to a file to be correlated with the
request.

You can use the following for `operationName`:

* createJob - Creates a Salesforce Bulk Job
* getJob - Gets a Job using its Salesforce Id
* closeJob - Closes a Job
* abortJob - Aborts a Job
* createBatch - Submits a Batch within a Bulk Job
* getBatch - Gets a Batch using Id
* getAllBatches - Gets all Batches for a Bulk Job Id
* getRequest - Gets Request data (XML/CSV) for a Batch
* getResults - Gets the results of the Batch when its complete
* createBatchQuery - Creates a Batch from an SOQL query
* getQueryResultIds - Gets a list of Result Ids for a Batch Query
* getQueryResult - Gets results for a Result Id
* getRecentReports - Gets up to 200 of the reports you most recently viewed by sending a GET request to the Report List resource.
* getReportDescription - Retrieves the report, report type, and related metadata for a report, either in a tabular or summary or matrix format.
* executeSyncReport - Runs a report synchronously with or without changing filters and returns the latest summary data.
* executeAsyncReport - Runs an instance of a report asynchronously with or without filters and returns the summary data with or without details.
* getReportInstances - Returns a list of instances for a report that you requested to be run asynchronously. Each item in the list is treated as a separate instance of the report.
* getReportResults: Contains the results of running a report.

For example, the following producer endpoint uses the createBatch API to
create a Job Batch. The in message must contain a body that can be converted into an
`InputStream` (usually UTF-8 CSV or XML content from a file, etc.) and
header fields 'jobId' for the Job and 'contentType' for the Job content
type, which can be XML, CSV, ZIP_XML or ZIP_CSV. The put message body
will contain `BatchInfo` on success, or throw a `SalesforceException` on
error.

[source,java]
----
...to(""salesforce:createBatchJob"")..
----

==== Rest Streaming API

Consumer endpoints can use the following syntax for streaming endpoints
to receive Salesforce notifications on create/update.

To create and subscribe to a topic

[source,java]
----
from(""salesforce:CamelTestTopic?notifyForFields=ALL&notifyForOperations=ALL&sObjectName=Merchandise__c&updateTopic=true&sObjectQuery=SELECT Id, Name FROM Merchandise__c"")...
----

To subscribe to an existing topic

[source,java]
----
from(""salesforce:CamelTestTopic&sObjectName=Merchandise__c"")...
----

==== Platform events

To emit a platform event use `createSObject` operation. And set the
message body can be JSON string or InputStream with key-value data --
in that case `sObjectName` needs to be set to the API name of the
event, or a class that extends from AbstractDTOBase with the
appropriate class name for the event.

For example using a DTO:

[source,java]
----
class Order_Event__e extends AbstractDTOBase {
  @JsonProperty(""OrderNumber"")
  private String orderNumber;
  // ... other properties and getters/setters
}

from(""timer:tick"")
    .process(exchange -> {
        final Message in = exchange.getIn();
        String orderNumber = ""ORD"" + String.valueOf(in.getHeader(Exchange.TIMER_COUNTER));
        Order_Event__e event = new Order_Event__e();
        event.setOrderNumber(orderNumber);
        in.setBody(event);
    })
    .to(""salesforce:createSObject"");
----

Or using JSON event data:

[source,java]
----
from(""timer:tick"")
    .process(exchange -> {
        final Message in = exchange.getIn();
        String orderNumber = ""ORD"" + String.valueOf(in.getHeader(Exchange.TIMER_COUNTER));
        in.setBody(""{\\""OrderNumber\\"":\\"""" + orderNumber + ""\\""}"");
    })
    .to(""salesforce:createSObject?sObjectName=Order_Event__e"");
----

To receive platform events use the consumer endpoint with the API name of
the platform event prefixed with `event/` (or `/event/`), e.g.:
`salesforce:events/Order_Event__e`. Processor consuming from that
endpoint will receive either `org.apache.camel.component.salesforce.api.dto.PlatformEvent`
object or `org.cometd.bayeux.Message` in the body depending on the
`rawPayload` being `false` or `true` respectively.

For example, in the simplest form to consume one event:

[source,java]
----
PlatformEvent event = consumer.receiveBody(""salesforce:event/Order_Event__e"", PlatformEvent.class);
----

==== Change data capture events

On the one hand, Salesforce could be configured to emit notifications for record changes of select objects.
On the other hand, the Camel Salesforce component could react to such notifications, allowing for instance to
https://trailhead.salesforce.com/en/content/learn/modules/change-data-capture/understand-change-data-capture[synchronize those changes into an external system].

The notifications of interest could be specified in the `from(""salesforce:XXX"")` clause of a Camel route via the subscription channel, e.g:

[source,java]
----
from(""salesforce:data/ChangeEvents?replayId=-1"").log(""being notified of all change events"")
from(""salesforce:data/AccountChangeEvent?replayId=-1"").log(""being notified of change events for Account records"")
from(""salesforce:data/Employee__ChangeEvent?replayId=-1"").log(""being notified of change events for Employee__c custom object"")
----

The received message contains either `java.util.Map<String,Object>` or `org.cometd.bayeux.Message` in the body depending on the `rawPayload` being `false` or `true` respectively. The `CamelSalesforceChangeType` header could be valued to one of `CREATE`, `UPDATE`,  `DELETE` or `UNDELETE`.

More details about how to use the Camel Salesforce component change data capture capabilities could be found in the https://github.com/apache/camel/tree/master/components/camel-salesforce/camel-salesforce-component/src/test/java/org/apache/camel/component/salesforce/ChangeEventsConsumerIntegrationTest.java[ChangeEventsConsumerIntegrationTest].

The https://developer.salesforce.com/docs/atlas.en-us.change_data_capture.meta/change_data_capture/cdc_intro.htm[Salesforce developer guide]
is a good fit to better know the subtleties of implementing a change data capture integration application.
The dynamic nature of change event body fields, high level replication steps as well as security considerations could be of interest.

=== Examples

==== Uploading a document to a ContentWorkspace

Create the ContentVersion in Java, using a Processor instance:

[source,java]
----
public class ContentProcessor implements Processor {
    public void process(Exchange exchange) throws Exception {
        Message message = exchange.getIn();

        ContentVersion cv = new ContentVersion();
        ContentWorkspace cw = getWorkspace(exchange);
        cv.setFirstPublishLocationId(cw.getId());
        cv.setTitle(""test document"");
        cv.setPathOnClient(""test_doc.html"");
        byte[] document = message.getBody(byte[].class);
        ObjectMapper mapper = new ObjectMapper();
        String enc = mapper.convertValue(document, String.class);
        cv.setVersionDataUrl(enc);
        message.setBody(cv);
    }

    protected ContentWorkspace getWorkSpace(Exchange exchange) {
        // Look up the content workspace somehow, maybe use enrich() to add it to a
        // header that can be extracted here
        ....
    }
} 
----

Give the output from the processor to the Salesforce component:

[source,java]
----
from(""file:///home/camel/library"")
    .to(new ContentProcessor())     // convert bytes from the file into a ContentVersion SObject 
                                    // for the salesforce component
    .to(""salesforce:createSObject""); 
----

=== Using Salesforce Limits API

With `salesforce:limits` operation you can fetch of API limits from Salesforce and then act upon that data received.
The result of `salesforce:limits` operation is mapped to `org.apache.camel.component.salesforce.api.dto.Limits`
class and can be used in a custom processors or expressions.

For instance, consider that you need to limit the API usage of Salesforce so that 10% of daily API requests is left for
other routes. The body of output message contains an instance of
`org.apache.camel.component.salesforce.api.dto.Limits` object that can be used in conjunction with
Content Based Router and Content Based Router and 
xref:spel-language.adoc[Spring Expression Language (SpEL)] to choose when to perform queries.

Notice how multiplying `1.0` with the integer value held in `body.dailyApiRequests.remaining` makes the expression
evaluate as with floating point arithmetic, without it - it would end up making integral division which would result
with either `0` (some API limits consumed) or `1` (no API limits consumed).

[source,java]
----
from(""direct:querySalesforce"")
    .to(""salesforce:limits"")
    .choice()
    .when(spel(""#{1.0 * body.dailyApiRequests.remaining / body.dailyApiRequests.max < 0.1}""))
        .to(""salesforce:query?..."")
    .otherwise()
        .setBody(constant(""Used up Salesforce API limits, leaving 10% for critical routes""))
    .endChoice()
----

=== Working with approvals

All the properties are named exactly the same as in the Salesforce REST API prefixed with `approval.`. You can set
approval properties by setting `approval.PropertyName` of the Endpoint these will be used as template -- meaning
that any property not present in either body or header will be taken from the Endpoint configuration. Or you can set
the approval template on the Endpoint by assigning `approval` property to a reference onto a bean in the Registry.

You can also provide header values using the same `approval.PropertyName` in the incoming message headers.

And finally body can contain one `AprovalRequest` or an `Iterable` of `ApprovalRequest` objects to process as
a batch.

The important thing to remember is the priority of the values specified in these three mechanisms:

. value in body takes precedence before any other
. value in message header takes precedence before template value
. value in template is set if no other value in header or body was given

For example to send one record for approval using values in headers use:

Given a route:

[source,java]
----
from(""direct:example1"")//
        .setHeader(""approval.ContextId"", simple(""${body['contextId']}""))
        .setHeader(""approval.NextApproverIds"", simple(""${body['nextApproverIds']}""))
        .to(""salesforce:approval?""//
            + ""approval.actionType=Submit""//
            + ""&approval.comments=this is a test""//
            + ""&approval.processDefinitionNameOrId=Test_Account_Process""//
            + ""&approval.skipEntryCriteria=true"");
----

You could send a record for approval using:

[source,java]
----
final Map<String, String> body = new HashMap<>();
body.put(""contextId"", accountIds.iterator().next());
body.put(""nextApproverIds"", userId);

final ApprovalResult result = template.requestBody(""direct:example1"", body, ApprovalResult.class);
----

=== Using Salesforce Recent Items API

To fetch the recent items use `salesforce:recent` operation. This operation returns an `java.util.List` of
`org.apache.camel.component.salesforce.api.dto.RecentItem` objects (`List<RecentItem>`) that in turn contain
the `Id`, `Name` and `Attributes` (with `type` and `url` properties). You can limit the number of returned items
by specifying `limit` parameter set to maximum number of records to return. For example:

[source,java]
----
from(""direct:fetchRecentItems"")
    to(""salesforce:recent"")
        .split().body()
            .log(""${body.name} at ${body.attributes.url}"");
----

=== Using Salesforce Composite API to submit SObject tree

To create up to 200 records including parent-child relationships use `salesforce:composite-tree` operation. This
requires an instance of `org.apache.camel.component.salesforce.api.dto.composite.SObjectTree` in the input 
message and returns the same tree of objects in the output message. The 
`org.apache.camel.component.salesforce.api.dto.AbstractSObjectBase` instances within the tree get updated with
the identifier values (`Id` property) or their corresponding
`org.apache.camel.component.salesforce.api.dto.composite.SObjectNode` is populated with `errors` on failure.

Note that for some records operation can succeed and for some it can fail -- so you need to manually check for errors.

Easiest way to use this functionality is to use the DTOs generated by the `camel-salesforce-maven-plugin`, but you
also have the option of customizing the references that identify the each object in the tree, for instance primary keys
from your database.

Lets look at an example:

[source,java]
----
Account account = ...
Contact president = ...
Contact marketing = ...

Account anotherAccount = ...
Contact sales = ...
Asset someAsset = ...

// build the tree
SObjectTree request = new SObjectTree();
request.addObject(account).addChildren(president, marketing);
request.addObject(anotherAccount).addChild(sales).addChild(someAsset);

final SObjectTree response = template.requestBody(""salesforce:composite-tree"", tree, SObjectTree.class);
final Map<Boolean, List<SObjectNode>> result = response.allNodes()
                                                   .collect(Collectors.groupingBy(SObjectNode::hasErrors));

final List<SObjectNode> withErrors = result.get(true);
final List<SObjectNode> succeeded = result.get(false);

final String firstId = succeeded.get(0).getId();
----

=== Using Salesforce Composite API to submit multiple requests in a batch
The Composite API batch operation (`composite-batch`) allows you to accumulate multiple requests in a batch and then
submit them in one go, saving the round trip cost of multiple individual requests. Each response is then received in a
list of responses with the order preserved, so that the n-th requests response is in the n-th place of the response.

NOTE: The results can vary from API to API so the result of the request is given as a `java.lang.Object`. In most cases
the result will be a `java.util.Map` with string keys and values or other `java.util.Map` as value. Requests made in
JSON format hold some type information (i.e. it is known what values are strings and what values are numbers), so in
general those will be more type friendly. Note that the responses will vary between XML and JSON, this is due to the
responses from Salesforce API being different. So be careful if you switch between formats without changing the response
handling code.

Lets look at an example:

[source,java]
----
final String acountId = ...
final SObjectBatch batch = new SObjectBatch(""38.0"");

final Account updates = new Account();
updates.setName(""NewName"");
batch.addUpdate(""Account"", accountId, updates);

final Account newAccount = new Account();
newAccount.setName(""Account created from Composite batch API"");
batch.addCreate(newAccount);

batch.addGet(""Account"", accountId, ""Name"", ""BillingPostalCode"");

batch.addDelete(""Account"", accountId);

final SObjectBatchResponse response = template.requestBody(""salesforce:composite-batch?format=JSON"", batch, SObjectBatchResponse.class);

boolean hasErrors = response.hasErrors(); // if any of the requests has resulted in either 4xx or 5xx HTTP status
final List<SObjectBatchResult> results = response.getResults(); // results of three operations sent in batch

final SObjectBatchResult updateResult = results.get(0); // update result
final int updateStatus = updateResult.getStatusCode(); // probably 204
final Object updateResultData = updateResult.getResult(); // probably null

final SObjectBatchResult createResult = results.get(1); // create result
@SuppressWarnings(""unchecked"")
final Map<String, Object> createData = (Map<String, Object>) createResult.getResult();
final String newAccountId = createData.get(""id""); // id of the new account, this is for JSON, for XML it would be createData.get(""Result"").get(""id"")

final SObjectBatchResult retrieveResult = results.get(2); // retrieve result
@SuppressWarnings(""unchecked"")
final Map<String, Object> retrieveData = (Map<String, Object>) retrieveResult.getResult();
final String accountName = retrieveData.get(""Name""); // Name of the retrieved account, this is for JSON, for XML it would be createData.get(""Account"").get(""Name"")
final String accountBillingPostalCode = retrieveData.get(""BillingPostalCode""); // Name of the retrieved account, this is for JSON, for XML it would be createData.get(""Account"").get(""BillingPostalCode"")

final SObjectBatchResult deleteResult = results.get(3); // delete result
final int updateStatus = deleteResult.getStatusCode(); // probably 204
final Object updateResultData = deleteResult.getResult(); // probably null
----

=== Using Salesforce Composite API to submit multiple chained requests
The `composite` operation allows submitting up to 25 requests that can be chained together, for instance identifier
generated in previous request can be used in subsequent request. Individual requests and responses are linked with the
provided _reference_.

NOTE: Composite API supports only JSON payloads.

NOTE: As with the batch API the results can vary from API to API so the result of the request is given as a
`java.lang.Object`. In most cases the result will be a `java.util.Map` with string keys and values or other
`java.util.Map` as value. Requests made in JSON format hold some type information (i.e. it is known what values are
strings and what values are numbers), so in general those will be more type friendly.

Lets look at an example:

[source,java]
----
SObjectComposite composite = new SObjectComposite(""38.0"", true);

// first insert operation via an external id
final Account updateAccount = new TestAccount();
updateAccount.setName(""Salesforce"");
updateAccount.setBillingStreet(""Landmark @ 1 Market Street"");
updateAccount.setBillingCity(""San Francisco"");
updateAccount.setBillingState(""California"");
updateAccount.setIndustry(Account_IndustryEnum.TECHNOLOGY);
composite.addUpdate(""Account"", ""001xx000003DIpcAAG"", updateAccount, ""UpdatedAccount"");

final Contact newContact = new TestContact();
newContact.setLastName(""John Doe"");
newContact.setPhone(""1234567890"");
composite.addCreate(newContact, ""NewContact"");

final AccountContactJunction__c junction = new AccountContactJunction__c();
junction.setAccount__c(""001xx000003DIpcAAG"");
junction.setContactId__c(""@{NewContact.id}"");
composite.addCreate(junction, ""JunctionRecord"");

final SObjectCompositeResponse response = template.requestBody(""salesforce:composite?format=JSON"", composite, SObjectCompositeResponse.class);
final List<SObjectCompositeResult> results = response.getCompositeResponse();

final SObjectCompositeResult accountUpdateResult = results.stream().filter(r -> ""UpdatedAccount"".equals(r.getReferenceId())).findFirst().get()
final int statusCode = accountUpdateResult.getHttpStatusCode(); // should be 200
final Map<String, ?> accountUpdateBody = accountUpdateResult.getBody();

final SObjectCompositeResult contactCreationResult = results.stream().filter(r -> ""JunctionRecord"".equals(r.getReferenceId())).findFirst().get()
----

=== Generating SOQL query strings

`org.apache.camel.component.salesforce.api.utils.QueryHelper` contains helper
methods to generate SOQL queries. For instance to fetch all custom fields from
_Account_ SObject you can simply generate the SOQL SELECT by invoking:

[source,java]
----
String allCustomFieldsQuery = QueryHelper.queryToFetchFilteredFieldsOf(new Account(), SObjectField::isCustom);
----

=== Camel Salesforce Maven Plugin

This Maven plugin generates DTOs for the Camel. 

For obvious security reasons it is recommended that the clientId,
clientSecret, userName and password fields be not set in the pom.xml.  
The plugin should be configured for the rest of the properties, and can
be executed using the following command:

[source,java]
----
mvn camel-salesforce:generate -DcamelSalesforce.clientId=<clientid> -DcamelSalesforce.clientSecret=<clientsecret> \\
    -DcamelSalesforce.userName=<username> -DcamelSalesforce.password=<password>
----

The generated DTOs use Jackson and XStream annotations. All Salesforce
field types are supported. Date and time fields are mapped to
`java.time.ZonedDateTime` by default, and picklist fields are mapped to
generated Java Enumerations.

Please refer to
https://github.com/apache/camel/tree/master/components/camel-salesforce/camel-salesforce-maven-plugin[README.md]
for details on how to generate the DTO.

=== Options







// component options: START
The Salesforce component supports 30 options, which are listed below.



[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *authenticationType* (security) | Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set, set this property to eliminate any ambiguity. |  | AuthenticationType
| *loginConfig* (security) | All authentication configuration in one nested bean, all properties set there can be set directly on the component as well |  | SalesforceLoginConfig
| *instanceUrl* (security) | URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication |  | String
| *loginUrl* (security) | *Required* URL of the Salesforce instance used for authentication, by default set to https://login.salesforce.com | https://login.salesforce.com | String
| *clientId* (security) | *Required* OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. |  | String
| *clientSecret* (security) | OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. |  | String
| *keystore* (security) | KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain, so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. |  | KeyStoreParameters
| *refreshToken* (security) | Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token, or configure using the builtin callback at https://login.salesforce.com/services/oauth2/success or https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. |  | String
| *userName* (security) | Username used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. |  | String
| *password* (security) | Password used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. |  | String
| *lazyLogin* (security) | If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generally set this to the (default) false and authenticate early and be immediately aware of any authentication issues. | false | boolean
| *config* (common) | Global endpoint configuration - use to set values that are common to all endpoints |  | SalesforceEndpoint Config
| *httpClientProperties* (common) | Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. |  | Map
| *longPollingTransport Properties* (common) | Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api |  | Map
| *sslContextParameters* (security) | SSL parameters to use, see SSLContextParameters class for all available options. |  | SSLContextParameters
| *useGlobalSslContext Parameters* (security) | Enable usage of global SSL context parameters | false | boolean
| *httpProxyHost* (proxy) | Hostname of the HTTP proxy server to use. |  | String
| *httpProxyPort* (proxy) | Port number of the HTTP proxy server to use. |  | Integer
| *httpProxyUsername* (security) | Username to use to authenticate against the HTTP proxy server. |  | String
| *httpProxyPassword* (security) | Password to use to authenticate against the HTTP proxy server. |  | String
| *isHttpProxySocks4* (proxy) | If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. | false | boolean
| *isHttpProxySecure* (security) | If set to false disables the use of TLS when accessing the HTTP proxy. | true | boolean
| *httpProxyIncluded Addresses* (proxy) | A list of addresses for which HTTP proxy server should be used. |  | Set
| *httpProxyExcluded Addresses* (proxy) | A list of addresses for which HTTP proxy server should not be used. |  | Set
| *httpProxyAuthUri* (security) | Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. |  | String
| *httpProxyRealm* (security) | Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server. |  | String
| *httpProxyUseDigest Auth* (security) | If set to true Digest authentication will be used when authenticating to the HTTP proxy,otherwise Basic authorization method will be used | false | boolean
| *packages* (common) | In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. |  | String[]
| *resolveProperty Placeholders* (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean
| *basicPropertyBinding* (advanced) | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
|===
// component options: END










// endpoint options: START
The Salesforce endpoint is configured using URI syntax:

----
salesforce:operationName:topicName
----

with the following path and query parameters:

==== Path Parameters (2 parameters):


[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *operationName* | The operation to use |  | OperationName
| *topicName* | The name of the topic/channel to use |  | String
|===


==== Query Parameters (46 parameters):


[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *apexMethod* (common) | APEX method name |  | String
| *apexQueryParams* (common) | Query params for APEX method |  | Map
| *apexUrl* (common) | APEX method URL |  | String
| *apiVersion* (common) | Salesforce API version, defaults to SalesforceEndpointConfig.DEFAULT_VERSION |  | String
| *backoffIncrement* (common) | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. |  | long
| *batchId* (common) | Bulk API Batch ID |  | String
| *contentType* (common) | Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV |  | ContentType
| *defaultReplayId* (common) | Default replayId setting if no value is found in initialReplayIdMap |  | Long
| *format* (common) | Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON |  | PayloadFormat
| *httpClient* (common) | Custom Jetty Http Client to use to connect to Salesforce. |  | SalesforceHttpClient
| *includeDetails* (common) | Include details in Salesforce1 Analytics report, defaults to false. |  | Boolean
| *initialReplayIdMap* (common) | Replay IDs to start from per channel name. |  | Map
| *instanceId* (common) | Salesforce1 Analytics report execution instance ID |  | String
| *jobId* (common) | Bulk API Job ID |  | String
| *limit* (common) | Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. |  | Integer
| *maxBackoff* (common) | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. |  | long
| *notFoundBehaviour* (common) | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL NotFoundBehaviour#NULL or should a exception be signaled on the exchange NotFoundBehaviour#EXCEPTION - the default. |  | NotFoundBehaviour
| *notifyForFields* (common) | Notify for fields, options are ALL, REFERENCED, SELECT, WHERE |  | NotifyForFieldsEnum
| *notifyForOperationCreate* (common) | Notify for create operation, defaults to false (API version = 29.0) |  | Boolean
| *notifyForOperationDelete* (common) | Notify for delete operation, defaults to false (API version = 29.0) |  | Boolean
| *notifyForOperations* (common) | Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version 29.0) |  | NotifyForOperations Enum
| *notifyForOperationUndelete* (common) | Notify for un-delete operation, defaults to false (API version = 29.0) |  | Boolean
| *notifyForOperationUpdate* (common) | Notify for update operation, defaults to false (API version = 29.0) |  | Boolean
| *objectMapper* (common) | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. |  | ObjectMapper
| *rawPayload* (common) | Use raw payload String for request and response (either JSON or XML depending on format), instead of DTOs, false by default | false | boolean
| *reportId* (common) | Salesforce1 Analytics report Id |  | String
| *reportMetadata* (common) | Salesforce1 Analytics report metadata for filtering |  | ReportMetadata
| *resultId* (common) | Bulk API Result ID |  | String
| *serializeNulls* (common) | Should the NULL values of given DTO be serialized with empty (NULL) values. This affects only JSON data format. | false | boolean
| *sObjectBlobFieldName* (common) | SObject blob field name |  | String
| *sObjectClass* (common) | Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin |  | String
| *sObjectFields* (common) | SObject fields to retrieve |  | String
| *sObjectId* (common) | SObject ID if required by API |  | String
| *sObjectIdName* (common) | SObject external ID field name |  | String
| *sObjectIdValue* (common) | SObject external ID field value |  | String
| *sObjectName* (common) | SObject name if required or supported by API |  | String
| *sObjectQuery* (common) | Salesforce SOQL query string |  | String
| *sObjectSearch* (common) | Salesforce SOSL search string |  | String
| *updateTopic* (common) | Whether to update an existing Push Topic when using the Streaming API, defaults to false | false | boolean
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *replayId* (consumer) | The replayId value to use when subscribing |  | Long
| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. |  | ExchangePattern
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
|===
// endpoint options: END
// spring-boot-auto-configure options: START
=== Spring Boot Auto-Configuration

When using Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-salesforce-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>
----


The component supports 86 options, which are listed below.



[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *camel.component.salesforce.authentication-type* | Explicit authentication method to be used, one of USERNAME_PASSWORD, REFRESH_TOKEN or JWT. Salesforce component can auto-determine the authentication method to use from the properties set, set this property to eliminate any ambiguity. |  | AuthenticationType
| *camel.component.salesforce.basic-property-binding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean
| *camel.component.salesforce.client-id* | OAuth Consumer Key of the connected app configured in the Salesforce instance setup. Typically a connected app needs to be configured but one can be provided by installing a package. |  | String
| *camel.component.salesforce.client-secret* | OAuth Consumer Secret of the connected app configured in the Salesforce instance setup. |  | String
| *camel.component.salesforce.config.apex-method* | APEX method name |  | String
| *camel.component.salesforce.config.apex-query-params* | Query params for APEX method |  | Map
| *camel.component.salesforce.config.apex-url* | APEX method URL |  | String
| *camel.component.salesforce.config.api-version* | Salesforce API version, defaults to SalesforceEndpointConfig.DEFAULT_VERSION |  | String
| *camel.component.salesforce.config.approval* | The approval request for Approval API. |  | ApprovalRequest
| *camel.component.salesforce.config.approval-action-type* | Represents the kind of action to take: Submit, Approve, or Reject. |  | ApprovalRequest$Action
| *camel.component.salesforce.config.approval-comments* | The comment to add to the history step associated with this request. |  | String
| *camel.component.salesforce.config.approval-context-actor-id* | The ID of the submitter who’s requesting the approval record. |  | String
| *camel.component.salesforce.config.approval-context-id* | The ID of the item that is being acted upon. |  | String
| *camel.component.salesforce.config.approval-next-approver-ids* | If the process requires specification of the next approval, the ID of the user to be assigned the next request. |  | List
| *camel.component.salesforce.config.approval-process-definition-name-or-id* | The developer name or ID of the process definition. |  | String
| *camel.component.salesforce.config.approval-skip-entry-criteria* | Determines whether to evaluate the entry criteria for the process (true) or not (false) if the process definition name or ID isn’t null. If the process definition name or ID isn’t specified, this argument is ignored, and standard evaluation is followed based on process order. By default, the entry criteria isn’t skipped if it’s not set by this request. |  | Boolean
| *camel.component.salesforce.config.backoff-increment* | Backoff interval increment for Streaming connection restart attempts for failures beyond CometD auto-reconnect. |  | Long
| *camel.component.salesforce.config.batch-id* | Bulk API Batch ID |  | String
| *camel.component.salesforce.config.content-type* | Bulk API content type, one of XML, CSV, ZIP_XML, ZIP_CSV |  | ContentType
| *camel.component.salesforce.config.default-replay-id* | Default replayId setting if no value is found in {@link #initialReplayIdMap} |  | Long
| *camel.component.salesforce.config.format* | Payload format to use for Salesforce API calls, either JSON or XML, defaults to JSON |  | PayloadFormat
| *camel.component.salesforce.config.http-client* | Custom Jetty Http Client to use to connect to Salesforce. |  | SalesforceHttpClient
| *camel.component.salesforce.config.include-details* | Include details in Salesforce1 Analytics report, defaults to false. |  | Boolean
| *camel.component.salesforce.config.initial-replay-id-map* | Replay IDs to start from per channel name. |  | Map
| *camel.component.salesforce.config.instance-id* | Salesforce1 Analytics report execution instance ID |  | String
| *camel.component.salesforce.config.job-id* | Bulk API Job ID |  | String
| *camel.component.salesforce.config.limit* | Limit on number of returned records. Applicable to some of the API, check the Salesforce documentation. |  | Integer
| *camel.component.salesforce.config.max-backoff* | Maximum backoff interval for Streaming connection restart attempts for failures beyond CometD auto-reconnect. |  | Long
| *camel.component.salesforce.config.not-found-behaviour* | Sets the behaviour of 404 not found status received from Salesforce API. Should the body be set to NULL {@link NotFoundBehaviour#NULL} or should a exception be signaled on the exchange {@link NotFoundBehaviour#EXCEPTION} - the default. |  | NotFoundBehaviour
| *camel.component.salesforce.config.notify-for-fields* | Notify for fields, options are ALL, REFERENCED, SELECT, WHERE |  | NotifyForFieldsEnum
| *camel.component.salesforce.config.notify-for-operation-create* | Notify for create operation, defaults to false (API version >= 29.0) |  | Boolean
| *camel.component.salesforce.config.notify-for-operation-delete* | Notify for delete operation, defaults to false (API version >= 29.0) |  | Boolean
| *camel.component.salesforce.config.notify-for-operation-undelete* | Notify for un-delete operation, defaults to false (API version >= 29.0) |  | Boolean
| *camel.component.salesforce.config.notify-for-operation-update* | Notify for update operation, defaults to false (API version >= 29.0) |  | Boolean
| *camel.component.salesforce.config.notify-for-operations* | Notify for operations, options are ALL, CREATE, EXTENDED, UPDATE (API version < 29.0) |  | NotifyForOperations Enum
| *camel.component.salesforce.config.object-mapper* | Custom Jackson ObjectMapper to use when serializing/deserializing Salesforce objects. |  | ObjectMapper
| *camel.component.salesforce.config.raw-payload* | Use raw payload {@link String} for request and response (either JSON or XML depending on {@code format}), instead of DTOs, false by default | false | Boolean
| *camel.component.salesforce.config.report-id* | Salesforce1 Analytics report Id |  | String
| *camel.component.salesforce.config.report-metadata* | Salesforce1 Analytics report metadata for filtering |  | ReportMetadata
| *camel.component.salesforce.config.result-id* | Bulk API Result ID |  | String
| *camel.component.salesforce.config.s-object-blob-field-name* | SObject blob field name |  | String
| *camel.component.salesforce.config.s-object-class* | Fully qualified SObject class name, usually generated using camel-salesforce-maven-plugin |  | String
| *camel.component.salesforce.config.s-object-fields* | SObject fields to retrieve |  | String
| *camel.component.salesforce.config.s-object-id* | SObject ID if required by API |  | String
| *camel.component.salesforce.config.s-object-id-name* | SObject external ID field name |  | String
| *camel.component.salesforce.config.s-object-id-value* | SObject external ID field value |  | String
| *camel.component.salesforce.config.s-object-name* | SObject name if required or supported by API |  | String
| *camel.component.salesforce.config.s-object-query* | Salesforce SOQL query string |  | String
| *camel.component.salesforce.config.s-object-search* | Salesforce SOSL search string |  | String
| *camel.component.salesforce.config.serialize-nulls* | Should the NULL values of given DTO be serialized with empty (NULL) values. This affects only JSON data format. | false | Boolean
| *camel.component.salesforce.config.update-topic* | Whether to update an existing Push Topic when using the Streaming API, defaults to false | false | Boolean
| *camel.component.salesforce.enabled* | Enable salesforce component | true | Boolean
| *camel.component.salesforce.http-client-properties* | Used to set any properties that can be configured on the underlying HTTP client. Have a look at properties of SalesforceHttpClient and the Jetty HttpClient for all available options. The option is a java.util.Map<java.lang.String,java.lang.Object> type. |  | String
| *camel.component.salesforce.http-proxy-auth-uri* | Used in authentication against the HTTP proxy server, needs to match the URI of the proxy server in order for the httpProxyUsername and httpProxyPassword to be used for authentication. |  | String
| *camel.component.salesforce.http-proxy-excluded-addresses* | A list of addresses for which HTTP proxy server should not be used. The option is a java.util.Set<java.lang.String> type. |  | String
| *camel.component.salesforce.http-proxy-host* | Hostname of the HTTP proxy server to use. |  | String
| *camel.component.salesforce.http-proxy-included-addresses* | A list of addresses for which HTTP proxy server should be used. The option is a java.util.Set<java.lang.String> type. |  | String
| *camel.component.salesforce.http-proxy-password* | Password to use to authenticate against the HTTP proxy server. |  | String
| *camel.component.salesforce.http-proxy-port* | Port number of the HTTP proxy server to use. |  | Integer
| *camel.component.salesforce.http-proxy-realm* | Realm of the proxy server, used in preemptive Basic/Digest authentication methods against the HTTP proxy server. |  | String
| *camel.component.salesforce.http-proxy-use-digest-auth* | If set to true Digest authentication will be used when authenticating to the HTTP proxy,otherwise Basic authorization method will be used | false | Boolean
| *camel.component.salesforce.http-proxy-username* | Username to use to authenticate against the HTTP proxy server. |  | String
| *camel.component.salesforce.instance-url* | URL of the Salesforce instance used after authentication, by default received from Salesforce on successful authentication |  | String
| *camel.component.salesforce.is-http-proxy-secure* | If set to false disables the use of TLS when accessing the HTTP proxy. | true | Boolean
| *camel.component.salesforce.is-http-proxy-socks4* | If set to true the configures the HTTP proxy to use as a SOCKS4 proxy. | false | Boolean
| *camel.component.salesforce.keystore* | KeyStore parameters to use in OAuth JWT flow. The KeyStore should contain only one entry with private key and certificate. Salesforce does not verify the certificate chain, so this can easily be a selfsigned certificate. Make sure that you upload the certificate to the corresponding connected app. The option is a org.apache.camel.support.jsse.KeyStoreParameters type. |  | String
| *camel.component.salesforce.lazy-login* | If set to true prevents the component from authenticating to Salesforce with the start of the component. You would generally set this to the (default) false and authenticate early and be immediately aware of any authentication issues. | false | Boolean
| *camel.component.salesforce.login-config.client-id* | Salesforce connected application Consumer Key |  | String
| *camel.component.salesforce.login-config.client-secret* | Salesforce connected application Consumer Secret |  | String
| *camel.component.salesforce.login-config.instance-url* | Configuration object for Salesforce login properties |  | String
| *camel.component.salesforce.login-config.keystore* | Keystore parameters for keystore containing certificate and private key needed for OAuth 2.0 JWT Bearer Token Flow. |  | KeyStoreParameters
| *camel.component.salesforce.login-config.lazy-login* | Flag to enable/disable lazy OAuth, default is false. When enabled, OAuth token retrieval or generation is not done until the first API call | false | Boolean
| *camel.component.salesforce.login-config.login-url* | Salesforce login URL, defaults to https://login.salesforce.com | https://login.salesforce.com | String
| *camel.component.salesforce.login-config.password* | Salesforce account password |  | String
| *camel.component.salesforce.login-config.refresh-token* | Salesforce connected application Consumer token |  | String
| *camel.component.salesforce.login-config.type* | Salesforce connected application Consumer token |  | AuthenticationType
| *camel.component.salesforce.login-config.user-name* | Salesforce account user name |  | String
| *camel.component.salesforce.login-url* | URL of the Salesforce instance used for authentication, by default set to https://login.salesforce.com | https://login.salesforce.com | String
| *camel.component.salesforce.long-polling-transport-properties* | Used to set any properties that can be configured on the LongPollingTransport used by the BayeuxClient (CometD) used by the streaming api. The option is a java.util.Map<java.lang.String,java.lang.Object> type. |  | String
| *camel.component.salesforce.packages* | In what packages are the generated DTO classes. Typically the classes would be generated using camel-salesforce-maven-plugin. Set it if using the generated DTOs to gain the benefit of using short SObject names in parameters/header values. |  | String[]
| *camel.component.salesforce.password* | Password used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. Make sure that you append security token to the end of the password if using one. |  | String
| *camel.component.salesforce.refresh-token* | Refresh token already obtained in the refresh token OAuth flow. One needs to setup a web application and configure a callback URL to receive the refresh token, or configure using the builtin callback at https://login.salesforce.com/services/oauth2/success or https://test.salesforce.com/services/oauth2/success and then retrive the refresh_token from the URL at the end of the flow. Note that in development organizations Salesforce allows hosting the callback web application at localhost. |  | String
| *camel.component.salesforce.resolve-property-placeholders* | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | Boolean
| *camel.component.salesforce.ssl-context-parameters* | SSL parameters to use, see SSLContextParameters class for all available options. The option is a org.apache.camel.support.jsse.SSLContextParameters type. |  | String
| *camel.component.salesforce.use-global-ssl-context-parameters* | Enable usage of global SSL context parameters | false | Boolean
| *camel.component.salesforce.user-name* | Username used in OAuth flow to gain access to access token. It's easy to get started with password OAuth flow, but in general one should avoid it as it is deemed less secure than other flows. |  | String
|===
// spring-boot-auto-configure options: END
",12143,False,2170.011702418554,median
"[[scoreCalculation]]
= Score calculation
:doctype: book
:imagesdir: ..
:sectnums:
:toc: left
:icons: font
:experimental:


[[scoreTerminology]]
== Score terminology


[[whatIsAScore]]
=== What is a score?

Every `@PlanningSolution` class has a score.
The score is an objective way to compare two solutions.
The solution with the higher score is better.
The `Solver` aims to find the solution with the highest `Score` of all possible solutions.
The _best solution_ is the solution with the highest `Score` that `Solver` has encountered during solving,
which might be the __optimal solution__.

OptaPlanner cannot automatically know which solution is best for your business,
so you need to tell it how to calculate the score of a given `@PlanningSolution` instance according to your business needs.
If you forget or are unable to implement an important business constraint, the solution is probably useless:

image::ScoreCalculation/optimalWithIncompleteConstraints.png[align=""center""]


[[formalizeTheBusinessConstraints]]
=== Formalize the business constraints

To implement a verbal business constraint, it needs to be formalized as a score constraint.
Luckily, defining constraints in OptaPlanner is very flexible through the following score techniques:

* **Score signum (positive or negative)**: maximize or minimize a constraint type
* **Score weight**: put a cost/profit on a constraint type
* **Score level (hard, soft, ...)**: prioritize a group of constraint types
* *Pareto scoring* (rarely used)

Take the time to acquaint yourself with the first three techniques.
Once you understand them, formalizing most business constraints becomes straightforward.

[NOTE]
====
Do not presume that your business knows all its score constraints in advance.
Expect score constraints to be added, changed or removed after the first releases.
====


[[scoreConstraintSignum]]
=== Score constraint signum (positive or negative)

All score techniques are based on constraints.
A constraint can be a simple pattern (such as __Maximize the apple harvest in the solution__) or a more complex pattern.
A positive constraint is a constraint you want to maximize.
A negative constraint is a constraint you want to minimize

image::ScoreCalculation/positiveAndNegativeConstraints.png[align=""center""]

The image above illustrates that **the optimal solution always has the highest score**,
regardless if the constraints are positive or negative.

Most planning problems have only negative constraints and therefore have a negative score.
In that case, the score is the sum of the weight of the negative constraints being broken, with a perfect score of 0.
For example in n queens, the score is the negative of the number of queen pairs which can attack each other.

Negative and positive constraints can be combined, even in the same score level.

When a constraint activates (because the negative constraint is broken or the positive constraint is fulfilled)
on a certain planning entity set, it is called a __constraint match__.


[[scoreConstraintWeight]]
=== Score constraint weight

Not all score constraints are equally important.
If breaking one constraint is equally bad as breaking another constraint x times,
then those two constraints have a different weight (but they are in the same score level).
For example in vehicle routing, you can make one _unhappy driver_ constraint match count
as much as two _fuel tank usage_ constraint matches:

image::ScoreCalculation/scoreWeighting.png[align=""center""]

Score weighting is easy in use cases where you can __put a price tag on everything__.
In that case, the positive constraints maximize revenue and the negative constraints minimize expenses, so together they maximize profit.
Alternatively, score weighting is also often used to create social <<fairnessScoreConstraints,fairness>>.
For example, a nurse, who requests a free day, pays a higher weight on New Years eve than on a normal day.

The weight of a constraint match can depend on the planning entities involved.
For example in cloud balancing, the weight of the soft constraint match for an active `Computer`
is the maintenance `cost` of that `Computer` (which differs per computer).

Putting a good weight on a constraint is often a difficult analytical decision,
because it is about making choices and trade-offs against other constraints.
Different stakeholders have different priorities.
*Don't waste time with constraint weight discussions at the start of an implementation,
instead add a <<constraintConfiguration, constraint configuration>>
and  allow users to change them through a UI.*
A non-accurate weight is less damaging than mediocre algorithms:

image::ScoreCalculation/scoreTradeoffInPerspective.png[align=""center""]

Most use cases use a `Score` with `int` weights, such as <<hardSoftScore,HardSoftScore>>.


[[scoreLevel]]
=== Score constraint level (hard, soft, ...)

Sometimes a score constraint outranks another score constraint, no matter how many times the latter is broken.
In that case, those score constraints are in different levels.
For example, a nurse cannot do two shifts at the same time (due to the constraints of physical reality),
so this outranks all nurse happiness constraints.

Most use cases have only two score levels, hard and soft.
The levels of two scores are compared lexicographically.
The first score level gets compared first.
If those differ, the remaining score levels are ignored.
For example, a score that breaks `0` hard constraints and `1000000` soft constraints is better
than a score that breaks `1` hard constraint and `0` soft constraints.

image::ScoreCalculation/scoreLevels.png[align=""center""]

If there are two (or more) score levels, for example <<hardSoftScore,HardSoftScore>>,
then a score is _feasible_ if no hard constraints are broken.

[NOTE]
====
By default, OptaPlanner will always assign all planning variables a planning value.
If there is no feasible solution, this means the best solution will be infeasible.
To instead leave some of the planning entities unassigned, apply <<overconstrainedPlanning,overconstrained planning>>.
====

For each constraint, you need to pick a score level, a score weight and a score signum.
For example: `-1soft` which has score level of ``soft``, a weight of `1` and a negative signum.
Do not use a big constraint weight when your business actually wants different score levels.
That hack, known as __score folding__, is broken:

image::ScoreCalculation/scoreFoldingIsBroken.png[align=""center""]


[NOTE]
====
Your business might tell you that your hard constraints all have the same weight, because they cannot be broken (so the weight does not matter). This is not true because if no feasible solution exists for a specific dataset, the least infeasible solution allows the business to estimate how many business resources they are lacking.
For example in cloud balancing, how many new computers to buy.

Furthermore, it will likely create a <<scoreTrap,score trap>>.
For example in cloud balance if a `Computer` has seven CPU too little for its ``Process``es, then it must be weighted seven times as much as if it had only one CPU too little.
====

Three or more score levels are also supported.
For example: a company might decide that profit outranks employee satisfaction (or vice versa),
while both are outranked by the constraints of physical reality.

[NOTE]
====
To model <<fairnessScoreConstraints,fairness or load balancing>>, there is no need to use lots of score levels
(even though OptaPlanner can handle many score levels).
====

Most use cases use a `Score` with two or three weights,
such as <<hardSoftScore,HardSoftScore>> and <<hardMediumSoftScore,HardMediumSoftScore>>.


[[paretoScoring]]
=== Pareto scoring (AKA multi-objective optimization scoring)

Far less common is the use case of pareto optimization, which is also known as _multi-objective optimization_.
In pareto scoring, score constraints are in the same score level, yet they are not weighted against each other.
When two scores are compared, each of the score constraints are compared individually and the score with the most dominating score constraints wins.
Pareto scoring can even be combined with score levels and score constraint weighting.

Consider this example with positive constraints, where we want to get the most apples and oranges.
Since it is impossible to compare apples and oranges, we can not weigh them against each other.
Yet, despite that we can not compare them, we can state that two apples are better than one apple.
Similarly, we can state that two apples and one orange are better than just one orange.
So despite our inability to compare some Scores conclusively (at which point we declare them equal), we can find a set of optimal scores.
Those are called pareto optimal.

image::ScoreCalculation/paretoOptimizationScoring.png[align=""center""]

Scores are considered equal far more often.
It is left up to a human to choose the better out of a set of best solutions (with equal scores) found by OptaPlanner.
In the example above, the user must choose between solution A (three apples and one orange) and solution B (one apple and six oranges). It is guaranteed that OptaPlanner has not found another solution which has more apples or more oranges or even a better combination of both (such as two apples and three oranges).

To implement pareto scoring in OptaPlanner, <<customScore,implement a custom `ScoreDefinition` and `Score`>> (and replace the ``BestSolutionRecaller``). Future versions will provide out-of-the-box support.

[NOTE]
====
A pareto ``Score``'s `compareTo` method is not transitive because it does a pareto comparison.
For example: having two apples is greater than one apple.
One apple is equal to One orange.
Yet, two apples are not greater than one orange (but actually equal). Pareto comparison violates the contract of the interface ``java.lang.Comparable``'s `compareTo` method, but Planners systems are __pareto comparison safe__, unless explicitly stated otherwise in this documentation.
====


[[combiningScoreTechniques]]
=== Combining score techniques

All the score techniques mentioned above, can be combined seamlessly:

image::ScoreCalculation/scoreComposition.png[align=""center""]


[[scoreInterface]]
=== `Score` interface

A score is represented by the `Score` interface, which naturally extends ``Comparable``:

[source,java,options=""nowrap""]
----
public interface Score<...> extends Comparable<...> {
    ...
}
----

The `Score` implementation to use depends on your use case.
Your score might not efficiently fit in a single `long` value.
OptaPlanner has several built-in `Score` implementations, but you can implement a custom `Score` too.
Most use cases tend to use the built-in ``HardSoftScore``.

image::ScoreCalculation/scoreClassDiagram.png[align=""center""]

All Score implementations also have an `initScore` (which is an ``int``).It is mostly intended for internal use in OptaPlanner: it is the negative number of uninitialized planning variables.
From a user's perspective this is ``0``, unless a Construction Heuristic is terminated before it could initialize all planning variables (in which case `Score.isSolutionInitialized()` returns ``false``).

The `Score` implementation (for example ``HardSoftScore``) must be the same throughout a `Solver` runtime.
The `Score` implementation is configured in the solution domain class:

[source,java,options=""nowrap""]
----
@PlanningSolution
public class CloudBalance {
    ...

    @PlanningScore
    private HardSoftScore score;

}
----

[[avoidFloatingPointNumbersInScoreCalculation]]
=== Avoid floating point numbers in score calculation

Avoid the use of `float` or `double` in score calculation.
Use `BigDecimal` or scaled `long` instead.

Floating point numbers (``float`` and ``double``) cannot represent a decimal number correctly.
For example: a `double` cannot hold the value `0.05` correctly.
Instead, it holds the nearest representable value.
Arithmetic (including addition and subtraction) with floating point numbers, especially for planning problems, leads to incorrect decisions:

image::ScoreCalculation/scoreWeightType.png[align=""center""]

Additionally, floating point number addition is not associative:

[source,java,options=""nowrap""]
----
System.out.println( ((0.01 + 0.02) + 0.03) == (0.01 + (0.02 + 0.03)) ); // returns false
----

This leads to __score corruption__.

Decimal numbers (``BigDecimal``) have none of these problems.

[NOTE]
====
BigDecimal arithmetic is considerably slower than ``int``, `long` or `double` arithmetic.
In experiments we have seen the score calculation take five times longer.

Therefore, in many cases, it can be worthwhile to multiply _all_ numbers for a single score weight by a plural of ten, so the score weight fits in a scaled `int` or ``long``.
For example, if we multiply all weights by ``1000``, a fuelCost of `0.07` becomes a fuelCostMillis of `70` and no longer uses a decimal score weight.
====


[[scoreType]]
== Choose a score type

Depending on the number of score levels and type of score weights you need, choose a `Score` type.
Most use cases use a ``HardSoftScore``.

[NOTE]
====
To properly write a `Score` to a database (with JPA/Hibernate) or to XML/JSON (with XStream/JAXB/Jackson),
see <<integration,the integration chapter>>.
====


[[simpleScore]]
=== `SimpleScore`

A `SimpleScore` has a single `int` value, for example ``-123``.
It has a single score level.

[source,java,options=""nowrap""]
----
    @PlanningScore
    private SimpleScore score;
----

Variants of this `Score` type:

* `SimpleLongScore` uses a `long` value instead of an `int` value.
* `SimpleBigDecimalScore` uses a `BigDecimal` value instead of an `int` value.


[[hardSoftScore]]
=== `HardSoftScore` (Recommended)

A `HardSoftScore` has a hard `int` value and a soft `int` value, for example ``-123hard/-456soft``.
It has two score levels (hard and soft).

[source,java,options=""nowrap""]
----
    @PlanningScore
    private HardSoftScore score;
----

Variants of this `Score` type:

* `HardSoftLongScore` uses `long` values instead of `int` values.
* `HardSoftBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[hardMediumSoftScore]]
=== `HardMediumSoftScore`

A `HardMediumSoftScore` which has a hard `int` value, a medium `int` value and a soft `int` value, for example ``-123hard/-456medium/-789soft``.
It has three score levels (hard, medium and soft).
The hard level determines if the solution is feasible,
and the medium level and soft level score values determine
how well the solution meets business goals.
Higher medium values take precedence over soft values irrespective of the soft value.

[source,java,options=""nowrap""]
----
    @PlanningScore
    private HardMediumSoftScore score;
----

Variants of this `Score` type:

* `HardMediumSoftLongScore` uses `long` values instead of `int` values.
* `HardMediumSoftBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[bendableScore]]
=== `BendableScore`

A `BendableScore` has a configurable number of score levels.
It has an array of hard `int` values and an array of soft `int` values,
for example with two hard levels and three soft levels, the score can be ``[-123/-456]hard/[-789/-012/-345]soft``.
In that case, it has five score levels.
A solution is feasible if all hard levels are at least zero.

A BendableScore with one hard level and one soft level is equivalent to a HardSoftScore,
while a BendableScore with one hard level and two soft levels is equivalent to a HardMediumSoftScore.

[source,java,options=""nowrap""]
----
    @PlanningScore(bendableHardLevelsSize = 2, bendableSoftLevelsSize = 3)
    private BendableScore score;
----

The number of hard and soft score levels need to be set at compilation time.
It is not flexible to change during solving.

[NOTE]
====
Do not use a `BendableScore` with seven levels just because you have seven constraints.
It is extremely rare to use a different score level for each constraint, because that means one constraint match on soft 0 outweighs even a million constraint matches of soft 1.

Usually, multiple constraints share the same level and are weighted against each other.
Use <<explainingTheScore,explaining the score>> to get the weight of individual constraints in the same level.
====

Variants of this `Score` type:

* `BendableLongScore` uses `long` values instead of `int` values.
* `BendableBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[customScore]]
=== Implementing a custom score

Internally, each `Score` implementation also has a `ScoreDefinition` implementation.
For example: `SimpleScore` is defined by ``SimpleScoreDefinition``.
The `ScoreDefinition` interface defines the score representation.

To implement a custom ``Score``, also implement such a custom ``ScoreDefinition``.
Extend `AbstractScoreDefinition` (preferably by copy pasting ``HardSoftScoreDefinition``) and start from there.
Then hook your custom `ScoreDefinition` in the domain:

[source,java,options=""nowrap""]
----
    @PlanningScore(scoreDefinitionClass = MyCustomScoreDefinition.class)
    private MyCustomScore score;
----

To have it integrate seamlessly with <<jpaAndHibernatePersistingAScore,JPA/Hibernate>>,
<<integrationWithXStream,XStream>>, <<integrationWithJackson,Jackson>>, ...,
you'll need to write custom glue code too.


[[calculateTheScore]]
== Calculate the `Score`


[[scoreCalculationTypes]]
=== Score calculation types

There are several ways to calculate the `Score` of a solution:

* **<<easyJavaScoreCalculation,Easy Java score calculation>>**: Implement all constraints together in a single method in Java (or another JVM language). Does not scale.
* **<<constraintStreams,Constraint streams score calculation>>**: Implement each constraint as a separate ConstraintStream in Java (or another JVM language). Fast and scalable.
* **<<incrementalJavaScoreCalculation,Incremental Java score calculation>>** (not recommended): Implement multiple low-level methods in Java (or another JVM language). Fast and scalable. Very difficult to implement and maintain.
* **<<droolsScoreCalculation,Drools score calculation>>**: Implement each constraint as a separate score rule in DRL. Scalable.

Every score calculation type can work with any Score definition (such as ``HardSoftScore`` or ``HardMediumSoftScore``).
All score calculation types are Object Oriented and can reuse existing Java code.

[IMPORTANT]
====
The score calculation must be read-only.
It must not change the planning entities or the problem facts in any way.
For example, it must not call a setter method on a planning entity in the score calculation.

OptaPlanner does not recalculate the score of a solution if it can predict it (unless an <<environmentMode,environmentMode assertion>> is enabled).
For example, after a winning step is done, there is no need to calculate the score because that move was done and undone earlier.
As a result, there is no guarantee that changes applied during score calculation actually happen.

To update planning entities when the planning variable change, use <<shadowVariable,shadow variables>> instead.
====


[[easyJavaScoreCalculation]]
=== Easy Java score calculation

An easy way to implement your score calculation in Java.

* Advantages:
** Plain old Java: no learning curve
** Opportunity to delegate score calculation to an existing code base or legacy system
* Disadvantages:
** Slower
** Does not scale because there is no <<incrementalScoreCalculation,incremental score calculation>>

Implement the one method of the interface ``EasyScoreCalculator``:

[source,java,options=""nowrap""]
----
public interface EasyScoreCalculator<Solution_> {

    Score calculateScore(Solution_ solution);

}
----

For example in n queens:

[source,java,options=""nowrap""]
----
public class NQueensEasyScoreCalculator implements EasyScoreCalculator<NQueens> {

    public SimpleScore calculateScore(NQueens nQueens) {
        int n = nQueens.getN();
        List<Queen> queenList = nQueens.getQueenList();

        int score = 0;
        for (int i = 0; i < n; i++) {
            for (int j = i + 1; j < n; j++) {
                Queen leftQueen = queenList.get(i);
                Queen rightQueen = queenList.get(j);
                if (leftQueen.getRow() != null && rightQueen.getRow() != null) {
                    if (leftQueen.getRowIndex() == rightQueen.getRowIndex()) {
                        score--;
                    }
                    if (leftQueen.getAscendingDiagonalIndex() == rightQueen.getAscendingDiagonalIndex()) {
                        score--;
                    }
                    if (leftQueen.getDescendingDiagonalIndex() == rightQueen.getDescendingDiagonalIndex()) {
                        score--;
                    }
                }
            }
        }
        return SimpleScore.valueOf(score);
    }

}
----

Configure it in the solver configuration:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <easyScoreCalculatorClass>org.optaplanner.examples.nqueens.solver.score.NQueensEasyScoreCalculator</easyScoreCalculatorClass>
  </scoreDirectorFactory>
----

To configure values of an `EasyScoreCalculator` dynamically in the solver configuration
(so the <<benchmarker,Benchmarker>> can tweak those parameters),
add the `easyScoreCalculatorCustomProperties` element and use <<customPropertiesConfiguration,custom properties>>:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <easyScoreCalculatorClass>...MyEasyScoreCalculator</easyScoreCalculatorClass>
    <easyScoreCalculatorCustomProperties>
      <myCacheSize>1000</myCacheSize>
    </easyScoreCalculatorCustomProperties>
  </scoreDirectorFactory>
----


[[incrementalJavaScoreCalculation]]
=== Incremental Java score calculation

A way to implement your score calculation incrementally in Java.

* Advantages:
** Very fast and scalable
*** Currently the fastest if implemented correctly
* Disadvantages:
** Hard to write
*** A scalable implementation heavily uses maps, indexes, ... (things the Drools rule engine can do for you)
*** You have to learn, design, write and improve all these performance optimizations yourself
** Hard to read
*** Regular score constraint changes can lead to a high maintenance cost

Implement all the methods of the interface `IncrementalScoreCalculator`
and extend the class ``AbstractIncrementalScoreCalculator``:

[source,java,options=""nowrap""]
----
public interface IncrementalScoreCalculator<Solution_> {

    void resetWorkingSolution(Solution_ workingSolution);

    void beforeEntityAdded(Object entity);

    void afterEntityAdded(Object entity);

    void beforeVariableChanged(Object entity, String variableName);

    void afterVariableChanged(Object entity, String variableName);

    void beforeEntityRemoved(Object entity);

    void afterEntityRemoved(Object entity);

    Score calculateScore();

}
----

image::ScoreCalculation/incrementalScoreCalculatorSequenceDiagram.png[align=""center""]

For example in n queens:

[source,java,options=""nowrap""]
----
public class NQueensAdvancedIncrementalScoreCalculator extends AbstractIncrementalScoreCalculator<NQueens> {

    private Map<Integer, List<Queen>> rowIndexMap;
    private Map<Integer, List<Queen>> ascendingDiagonalIndexMap;
    private Map<Integer, List<Queen>> descendingDiagonalIndexMap;

    private int score;

    public void resetWorkingSolution(NQueens nQueens) {
        int n = nQueens.getN();
        rowIndexMap = new HashMap<Integer, List<Queen>>(n);
        ascendingDiagonalIndexMap = new HashMap<Integer, List<Queen>>(n * 2);
        descendingDiagonalIndexMap = new HashMap<Integer, List<Queen>>(n * 2);
        for (int i = 0; i < n; i++) {
            rowIndexMap.put(i, new ArrayList<Queen>(n));
            ascendingDiagonalIndexMap.put(i, new ArrayList<Queen>(n));
            descendingDiagonalIndexMap.put(i, new ArrayList<Queen>(n));
            if (i != 0) {
                ascendingDiagonalIndexMap.put(n - 1 + i, new ArrayList<Queen>(n));
                descendingDiagonalIndexMap.put((-i), new ArrayList<Queen>(n));
            }
        }
        score = 0;
        for (Queen queen : nQueens.getQueenList()) {
            insert(queen);
        }
    }

    public void beforeEntityAdded(Object entity) {
        // Do nothing
    }

    public void afterEntityAdded(Object entity) {
        insert((Queen) entity);
    }

    public void beforeVariableChanged(Object entity, String variableName) {
        retract((Queen) entity);
    }

    public void afterVariableChanged(Object entity, String variableName) {
        insert((Queen) entity);
    }

    public void beforeEntityRemoved(Object entity) {
        retract((Queen) entity);
    }

    public void afterEntityRemoved(Object entity) {
        // Do nothing
    }

    private void insert(Queen queen) {
        Row row = queen.getRow();
        if (row != null) {
            int rowIndex = queen.getRowIndex();
            List<Queen> rowIndexList = rowIndexMap.get(rowIndex);
            score -= rowIndexList.size();
            rowIndexList.add(queen);
            List<Queen> ascendingDiagonalIndexList = ascendingDiagonalIndexMap.get(queen.getAscendingDiagonalIndex());
            score -= ascendingDiagonalIndexList.size();
            ascendingDiagonalIndexList.add(queen);
            List<Queen> descendingDiagonalIndexList = descendingDiagonalIndexMap.get(queen.getDescendingDiagonalIndex());
            score -= descendingDiagonalIndexList.size();
            descendingDiagonalIndexList.add(queen);
        }
    }

    private void retract(Queen queen) {
        Row row = queen.getRow();
        if (row != null) {
            List<Queen> rowIndexList = rowIndexMap.get(queen.getRowIndex());
            rowIndexList.remove(queen);
            score += rowIndexList.size();
            List<Queen> ascendingDiagonalIndexList = ascendingDiagonalIndexMap.get(queen.getAscendingDiagonalIndex());
            ascendingDiagonalIndexList.remove(queen);
            score += ascendingDiagonalIndexList.size();
            List<Queen> descendingDiagonalIndexList = descendingDiagonalIndexMap.get(queen.getDescendingDiagonalIndex());
            descendingDiagonalIndexList.remove(queen);
            score += descendingDiagonalIndexList.size();
        }
    }

    public SimpleScore calculateScore() {
        return SimpleScore.valueOf(score);
    }

}
----

Configure it in the solver configuration:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <incrementalScoreCalculatorClass>org.optaplanner.examples.nqueens.solver.score.NQueensAdvancedIncrementalScoreCalculator</incrementalScoreCalculatorClass>
  </scoreDirectorFactory>
----

[IMPORTANT]
====
A piece of incremental score calculator code can be difficult to write and to review.
<<invalidScoreDetection,Assert its correctness>> by using an ``EasyScoreCalculator`` to fulfill
the assertions triggered by the ``environmentMode``.
====

To configure values of an `IncrementalScoreCalculator` dynamically in the solver configuration
(so the <<benchmarker,Benchmarker>> can tweak those parameters),
add the `incrementalScoreCalculatorCustomProperties` element and use <<customPropertiesConfiguration,custom properties>>:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <incrementalScoreCalculatorClass>...MyIncrementalScoreCalculator</incrementalScoreCalculatorClass>
    <incrementalScoreCalculatorCustomProperties>
      <myCacheSize>1000</myCacheSize>
    </incrementalScoreCalculatorCustomProperties>
  </scoreDirectorFactory>
----


[[constraintMatchAwareIncrementalScoreCalculator]]
==== `ConstraintMatchAwareIncrementalScoreCalculator`

Optionally, also implement the `ConstraintMatchAwareIncrementalScoreCalculator` interface to:

* Explain a score by splitting it up per score constraint with `ScoreDirector.getConstraintMatchTotals()`.
* Visualize or sort planning entities by how many constraints each one breaks with `ScoreDirector.getIndictmentMap()`.
* Receive a detailed analysis if the `IncrementalScoreCalculator` is corrupted in `FAST_ASSERT` or `FULL_ASSERT` `environmentMode`,

[source,java,options=""nowrap""]
----
public interface ConstraintMatchAwareIncrementalScoreCalculator<Solution_> {

    void resetWorkingSolution(Solution_ workingSolution, boolean constraintMatchEnabled);

    Collection<ConstraintMatchTotal> getConstraintMatchTotals();

    Map<Object, Indictment> getIndictmentMap();
}
----

For example in machine reassignment, create one ConstraintMatchTotal per constraint type
and call `addConstraintMatch()` for each constraint match:

[source,java,options=""nowrap""]
----
public class MachineReassignmentIncrementalScoreCalculator
        implements ConstraintMatchAwareIncrementalScoreCalculator<MachineReassignment> {
    ...

    @Override
    public void resetWorkingSolution(MachineReassignment workingSolution, boolean constraintMatchEnabled) {
        resetWorkingSolution(workingSolution);
        // ignore constraintMatchEnabled, it is always presumed enabled
    }

    @Override
    public Collection<ConstraintMatchTotal> getConstraintMatchTotals() {
        ConstraintMatchTotal maximumCapacityMatchTotal = new ConstraintMatchTotal(
                CONSTRAINT_PACKAGE, ""maximumCapacity"", HardSoftLongScore.ZERO);
        ...
        for (MrMachineScorePart machineScorePart : machineScorePartMap.values()) {
            for (MrMachineCapacityScorePart machineCapacityScorePart : machineScorePart.machineCapacityScorePartList) {
                if (machineCapacityScorePart.maximumAvailable < 0L) {
                    maximumCapacityMatchTotal.addConstraintMatch(
                            Arrays.asList(machineCapacityScorePart.machineCapacity),
                            HardSoftLongScore.valueOf(machineCapacityScorePart.maximumAvailable, 0));
                }
            }
        }
        ...
        List<ConstraintMatchTotal> constraintMatchTotalList = new ArrayList<>(4);
        constraintMatchTotalList.add(maximumCapacityMatchTotal);
        ...
        return constraintMatchTotalList;
    }

    @Override
    public Map<Object, Indictment> getIndictmentMap() {
        return null; // Calculate it non-incrementally from getConstraintMatchTotals()
    }
}
----

That `getConstraintMatchTotals()` code often duplicates some of the logic of the normal `IncrementalScoreCalculator` methods.
Drools Score Calculation doesn't have this disadvantage, because it is constraint match aware automatically when needed,
without any extra domain-specific code.


[[initializingScoreTrend]]
=== `InitializingScoreTrend`

The `InitializingScoreTrend` specifies how the Score will change as more and more variables are initialized (while the already initialized variables do not change). Some optimization algorithms (such Construction Heuristics and Exhaustive Search) run faster if they have such information.

For the Score (or each <<scoreLevel,score level>> separately), specify a trend:

* `ANY` (default): Initializing an extra variable can change the score positively or negatively. Gives no performance gain.
* `ONLY_UP` (rare): Initializing an extra variable can only change the score positively. Implies that:
** There are only positive constraints
** And initializing the next variable can not unmatch a positive constraint that was matched by a previous initialized variable.
* ``ONLY_DOWN``: Initializing an extra variable can only change the score negatively. Implies that:
** There are only negative constraints
** And initializing the next variable can not unmatch a negative constraint that was matched by a previous initialized variable.

Most use cases only have negative constraints.
Many of those have an `InitializingScoreTrend` that only goes down:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <scoreDrl>.../cloudBalancingConstraints.drl</scoreDrl>
    <initializingScoreTrend>ONLY_DOWN</initializingScoreTrend>
  </scoreDirectorFactory>
----

Alternatively, you can also specify the trend for each score level separately:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <scoreDrl>.../cloudBalancingConstraints.drl</scoreDrl>
    <initializingScoreTrend>ONLY_DOWN/ONLY_DOWN</initializingScoreTrend>
  </scoreDirectorFactory>
----


[[invalidScoreDetection]]
=== Invalid score detection

When you put the <<environmentMode,`environmentMode`>> in `FULL_ASSERT` (or ``FAST_ASSERT``),
it will detect score corruption in the <<incrementalScoreCalculation,incremental score calculation>>.
However, that will not verify that your score calculator actually implements your score constraints as your business desires.
For example, one constraint might consistently match the wrong pattern.
To verify the constraints against an independent implementation, configure a ``assertionScoreDirectorFactory``:

[source,xml,options=""nowrap""]
----
  <environmentMode>FAST_ASSERT</environmentMode>
  ...
  <scoreDirectorFactory>
    <constraintProviderClass>org.optaplanner.examples.nqueens.solver.score.NQueensConstraintProvider</constraintProviderClass>
    <assertionScoreDirectorFactory>
      <easyScoreCalculatorClass>org.optaplanner.examples.nqueens.solver.score.NQueensEasyScoreCalculator</easyScoreCalculatorClass>
    </assertionScoreDirectorFactory>
  </scoreDirectorFactory>
----

This way, the `NQueensConstraintProvider` implementation is validated by the ``EasyScoreCalculator``.

[NOTE]
====
This works well to isolate score corruption,
but to verify that the constraint implement the real business needs,
<<constraintStreamsTesting, a unit test with a ConstraintVerifier>> is usually better.
====


[[scoreCalculationPerformanceTricks]]
== Score calculation performance tricks


[[scoreCalculationPerformanceTricksOverview]]
=== Overview

The `Solver` will normally spend most of its execution time running the score calculation
(which is called in its deepest loops).
Faster score calculation will return the same solution in less time with the same algorithm,
which normally means a better solution in equal time.


[[scoreCalculationSpeed]]
=== Score calculation speed

After solving a problem, the `Solver` will log the __score calculation speed per second__.
This is a good measurement of Score calculation performance,
despite that it is affected by non score calculation execution time.
It depends on the problem scale of the problem dataset.
Normally, even for high scale problems, it is higher than ``1000``, except if you are using an ``EasyScoreCalculator``.

[IMPORTANT]
====
When improving your score calculation, focus on maximizing the score calculation speed, instead of maximizing the best score.
A big improvement in score calculation can sometimes yield little or no best score improvement, for example when the algorithm is stuck in a local or global optima.
If you are watching the calculation speed instead, score calculation improvements are far more visible.

Furthermore, watching the calculation speed allows you to remove or add score constraints,
and still compare it with the original's calculation speed.
Comparing the best score with the original's best score is pointless: it's comparing apples and oranges.
====


[[incrementalScoreCalculation]]
=== Incremental score calculation (with deltas)

When a solution changes, incremental score calculation (AKA delta based score calculation)
calculates the delta with the previous state to find the new ``Score``,
instead of recalculating the entire score on every solution evaluation.

For example, when a single queen A moves from row `1` to ``2``,
it will not bother to check if queen B and C can attack each other, since neither of them changed:

image::ScoreCalculation/incrementalScoreCalculationNQueens04.png[align=""center""]

Similarly in employee rostering:

image::ScoreCalculation/incrementalScoreCalculationEmployeeRostering.png[align=""center""]

This is a huge performance and scalability gain.
*Drools score calculation gives you this huge scalability gain without forcing you to write a complicated incremental score calculation algorithm.*
Just let the Drools rule engine do the hard work.

Notice that the speedup is relative to the size of your planning problem (your __n__), making incremental score calculation far more scalable.


[[avoidCallingRemoteServicesDuringScoreCalculation]]
=== Avoid calling remote services during score calculation

Do not call remote services in your score calculation (except if you are bridging `EasyScoreCalculator` to a legacy system). The network latency will kill your score calculation performance.
Cache the results of those remote services if possible.

If some parts of a constraint can be calculated once, when the `Solver` starts, and never change during solving,
then turn them into <<cachedProblemFact,cached problem facts>>.


[[pointlessConstraints]]
=== Pointless constraints

If you know a certain constraint can never be broken (or it is always broken), do not write a score constraint for it.
For example in n queens, the score calculation does not check if multiple queens occupy the same column,
because a ``Queen``'s `column` never changes and every solution starts with each `Queen` on a different ``column``.

[NOTE]
====
Do not go overboard with this.
If some datasets do not use a specific constraint but others do, just return out of the constraint as soon as you can.
There is no need to dynamically change your score calculation based on the dataset.
====


[[buildInHardConstraint]]
=== Built-in hard constraint

Instead of implementing a hard constraint, it can sometimes be built in.
For example, if `Lecture` A should never be assigned to `Room` X, but it uses `ValueRangeProvider` on Solution,
so the `Solver` will often try to assign it to `Room` X too (only to find out that it breaks a hard constraint).
Use <<valueRangeProviderOnPlanningEntity,a ValueRangeProvider on the planning entity>> or <<filteredSelection,filtered selection>> to define that Course A should only be assigned a `Room` different than X.

This can give a good performance gain in some use cases, not just because the score calculation is faster,
but mainly because most optimization algorithms will spend less time evaluating infeasible solutions.
However, usually this is not a good idea because there is a real risk of trading short term benefits for long term harm:

* Many optimization algorithms rely on the freedom to break hard constraints when changing planning entities,
to get out of local optima.
* Both implementation approaches have limitations (feature compatibility, disabling automatic performance optimizations),
as explained in their documentation.


[[otherScoreCalculationPerformanceTricks]]
=== Other score calculation performance tricks

* Verify that your score calculation happens in the correct `Number` type.
If you are making the sum of `int` values, do not let Drools sum it in a `double` which takes longer.
* For optimal performance, always use server mode (``java -server``).
We have seen performance increases of 50% by turning on server mode.
* For optimal performance, use the latest Java version.
For example, in the past we have seen performance increases of 30% by switching from java 1.5 to 1.6.
* Always remember that premature optimization is the root of all evil.
Make sure your design is flexible enough to allow configuration based tweaking.


[[scoreTrap]]
=== Score trap

Make sure that none of your score constraints cause a score trap.
A trapped score constraint uses the same weight for different constraint matches, when it could just as easily use a different weight.
It effectively lumps its constraint matches together, which creates a flatlined score function for that constraint.
This can cause a solution state in which several moves need to be done to resolve or lower the weight of that single constraint.
Some examples of score traps:

* You need two doctors at each table, but you are only moving one doctor at a time. So the solver has no incentive to move a doctor to a table with no doctors. Punish a table with no doctors more than a table with only one doctor in that score constraint in the score function.
* Two exams need to be conducted at the same time, but you are only moving one exam at a time. So the solver has to move one of those exams to another timeslot without moving the other in the same move. Add a coarse-grained move that moves both exams at the same time.

For example, consider this score trap.
If the blue item moves from an overloaded computer to an empty computer, the hard score should improve.
The trapped score implementation fails to do that:

image::ScoreCalculation/scoreTrap.png[align=""center""]

The Solver should eventually get out of this trap, but it will take a lot of effort (especially if there are even more processes on the overloaded computer). Before they do that, they might actually start moving more processes into that overloaded computer, as there is no penalty for doing so.

[NOTE]
====
Avoiding score traps does not mean that your score function should be smart enough to avoid local optima.
Leave it to the optimization algorithms to deal with the local optima.

Avoiding score traps means to avoid, for each score constraint individually, a flatlined score function.
====

[IMPORTANT]
====
Always specify the degree of infeasibility.
The business will often say ""if the solution is infeasible, it does not matter how infeasible it is."" While that is true for the business, it is not true for score calculation as it benefits from knowing how infeasible it is.
In practice, soft constraints usually do this naturally and it is just a matter of doing it for the hard constraints too.
====

There are several ways to deal with a score trap:

* Improve the score constraint to make a distinction in the score weight. For example, penalize `-1hard` for every missing CPU, instead of just `-1hard` if any CPU is missing.
* If changing the score constraint is not allowed from the business perspective, add a lower score level with a score constraint that makes such a distinction. For example, penalize `-1subsoft` for every missing CPU, on top of `-1hard` if any CPU is missing. The business ignores the subsoft score level.
* Add coarse-grained moves and union select them with the existing fine-grained moves. A coarse-grained move effectively does multiple moves to directly get out of a score trap with a single move. For example, move multiple items from the same container to another container.


[[stepLimitBenchmark]]
=== `stepLimit` benchmark

Not all score constraints have the same performance cost.
Sometimes one score constraint can kill the score calculation performance outright.
Use the <<benchmarker,Benchmarker>> to do a one minute run and check what happens to the score calculation speed if you comment out all but one of the score constraints.


[[fairnessScoreConstraints]]
=== Fairness score constraints

Some use cases have a business requirement to provide a fair schedule (usually as a soft score constraint), for example:

* Fairly distribute the workload amongst the employees, to avoid envy.
* Evenly distribute the workload amongst assets, to improve reliability.

Implementing such a constraint can seem difficult (especially because there are different ways to formalize fairness), but usually the _squared workload_ implementation behaves most desirable.
For each employee/asset, count the workload `w` and subtract `w²` from the score.

image::ScoreCalculation/fairnessScoreConstraint.png[align=""center""]

As shown above, the _squared workload_ implementation guarantees that if you select two employees from a given solution and make their distribution between those two employees fairer, then the resulting new solution will have a better overall score.
Do not just use the difference from the average workload, as that can lead to unfairness, as demonstrated below.

image::ScoreCalculation/fairnessScoreConstraintPitfall.png[align=""center""]


[NOTE]
====
Instead of the __squared workload__, it is also possible to use the https://en.wikipedia.org/wiki/Variance[variance]
(squared difference to the average) or the http://en.wikipedia.org/wiki/Standard_deviation[standard deviation]
(square root of the variance).
This has no effect on the score comparison, because the average will not change during planning.
It is just more work to implement (because the average needs to be known) and trivially slower (because the calculation is a bit longer).
====

When the workload is perfectly balanced, the user often likes to see a `0` score, instead of the distracting `-34soft` in the image above (for the last solution which is almost perfectly balanced).
To nullify this, either add the average multiplied by the number of entities to the score or instead show the variance or standard deviation in the UI.

[[constraintConfiguration]]
== Constraint configuration: adjust constraint weights dynamically

Deciding the correct <<scoreConstraintWeight,weight>> and <<scoreLevel,level>> for each constraint is not easy.
It often involves negotiating with different stakeholders and their priorities.
Furthermore, quantifying the impact of soft constraints is often a new experience for business managers, so they 'll need a number of iterations to get it right.

Don't get stuck between a rock and a hard place.
Provide a UI to adjust the constraint weights and visualize the resulting solution, so the business managers can tweak the constraint weights themselves:

image::ScoreCalculation/parameterizeTheScoreWeights.png[align=""center""]

[[createAConstraintConfiguration]]
=== Create a constraint configuration

First, create a new class to hold the constraint weights and other constraint parameters.
Annotate it with `@ConstraintConfiguration`:

[source,java,options=""nowrap""]
----
@ConstraintConfiguration
public class ConferenceConstraintConfiguration {
    ...
}
----

There will be exactly one instance of this class per planning solution.
The planning solution and the constraint configuration have a one to one relationship,
but they serve a different purpose, so they aren't merged into a single class.
A `@ConstraintConfiguration` class can extend a parent `@ConstraintConfiguration` class,
which can be useful in international use cases with many regional constraints.

Add the constraint configuration on the planning solution
and annotate that field or property with `@ConstraintConfigurationProvider`:

[source,java,options=""nowrap""]
----
@PlanningSolution
public class ConferenceSolution {

    @ConstraintConfigurationProvider
    private ConferenceConstraintConfiguration constraintConfiguration;

    ...
}
----

The `@ConstraintConfigurationProvider` annotation automatically exposes the constraint configuration
as a <<problemFacts,problem fact>>, there is no need to add a `@ProblemFactProperty` annotation.

The constraint configuration class holds the <<constraintWeight, constraint weights>>,
but it can also hold constraint parameters.
For example in conference scheduling, the minimum pause constraint has a constraint weight (like any other constraint),
but it also has a constraint parameter that defines the length of the minimum pause between two talks of the same speaker.
That pause length depends on the conference (= the planning problem):
in some big conferences 20 minutes isn't enough to go from one room to the other.
That pause length is a field in the constraint configuration without a `@ConstraintWeight` annotation.


[[constraintWeight]]
=== Add a constraint weight for each constraint

In the constraint configuration class, add a `@ConstraintWeight` field or property for each constraint:

[source,java,options=""nowrap""]
----
@ConstraintConfiguration(constraintPackage = ""...conferencescheduling.solver"")
public class ConferenceConstraintConfiguration {

    @ConstraintWeight(""Speaker conflict"")
    private HardMediumSoftScore speakerConflict = HardMediumSoftScore.ofHard(10);

    @ConstraintWeight(""Theme track conflict"")
    private HardMediumSoftScore themeTrackConflict = HardMediumSoftScore.ofSoft(10);
    @ConstraintWeight(""Content conflict"")
    private HardMediumSoftScore contentConflict = HardMediumSoftScore.ofSoft(100);

    ...
}
----

The type of the constraint weights must be the same score class as <<scoreOfASolution,the planning solution's score member>>.
For example in conference scheduling, `ConferenceSolution.getScore()` and `ConferenceConstraintConfiguration.getSpeakerConflict()`
both return a `HardMediumSoftScore`.

A constraint weight cannot be null.
Give each constraint weight a default value, but expose them in a UI so the business users can tweak them.
The example above uses the `ofHard()`, `ofMedium()` and `ofSoft()` methods to do that.
Notice how it defaults the _content conflict_ constraint as ten times more important than the _theme track conflict_ constraint.
Normally, a constraint weight only uses one score level,
but it's possible to use multiple score levels (at a small performance cost).

Each constraint has a constraint package and a constraint name, together they form the constraint id.
These connect the constraint weight with the constraint implementation.
*For each constraint weight, there must be a constraint implementation with the same package and the same name.*

* The `@ConstraintConfiguration` annotation has a `constraintPackage` property that defaults to the package of the constraint configuration class.
Most cases with <<droolsScoreCalculation,Drools score calculation>>, need to override that because the DRLs use another package.
For example, the DRL below uses the package `...conferencescheduling.solver`,
so the constraint configuration above specifies a `constraintPackage`.
Cases with <<constraintStreams,Constraint streams>>, normally don't need to specify it.

* The `@ConstraintWeight` annotation has a `value` which is the constraint name (for example ""Speaker conflict"").
It inherits the constraint package from the `@ConstraintConfiguration`,
but it can override that, for example `@ConstraintWeight(constraintPackage = ""...region.france"", ...)`
to use a different constraint package than some of the other weights.

So every constraint weight ends up with a constraint package and a constraint name.
Each constraint weight links with a constraint implementation,
for example in <<droolsScoreCalculation,Drools score calculation>>:

[source,options=""nowrap""]
----
package ...conferencescheduling.solver;

rule ""Speaker conflict""
    when
        ...
    then
        scoreHolder.penalize(kcontext);
end

rule ""Theme track conflict""
    when
        ...
    then
        scoreHolder.penalize(kcontext, ...);
end

rule ""Content conflict""
    when
        ...
    then
        scoreHolder.penalize(kcontext, ...);
end
----

Each of the constraint weights defines the score level and score weight of their constraint.
The constraint implementation calls `reward()` or `penalize()` and the constraint weight is automatically applied.

If the constraint implementation provides a match weight, that *match weight is multiplied with the constraint weight*.
For example, the _content conflict_ constraint weight defaults to `100soft`
and the constraint implementation penalizes each match based on the number of shared content tags:

[source,java,options=""nowrap""]
----
    @ConstraintWeight(""Content conflict"")
    private HardMediumSoftScore contentConflict = HardMediumSoftScore.ofSoft(100);
----

[source,options=""nowrap""]
----
rule ""Content conflict""
    when
        $talk1 : Talk(...)
        $talk2 : Talk(...)
    then
        scoreHolder.penalize(kcontext,
                $talk2.overlappingContentCount($talk1));
end
----

So when 2 overlapping talks share only 1 content tag, the score is impacted by `-100soft`.
But when 2 overlapping talks share 3 content tags, the match weight is `3`, so the score is impacted by `-300soft`.

[[explainingTheScore]]
== Explaining the score: which constraints are broken?

The easiest way to explain the score during development is to print the return value of `explainScore()`, but only use that method for diagnostic purposes:

[source,java,options=""nowrap""]
----
System.out.println(scoreManager.explainScore(solution));
----

For example in conference scheduling, this prints that talk `S51` is responsible for breaking the hard constraint `Speaker required room tag`:

----
Explanation of score (-1hard/-806soft):
    Constraint match totals:
        -1hard: constraint (Speaker required room tag) has 1 matches:
            -1hard: justifications ([S51])
        -340soft: constraint (Theme track conflict) has 32 matches:
            -20soft: justifications ([S68, S66])
            -20soft: justifications ([S61, S44])
            ...
        ...
    Indictments (top 5 of 72):
        -1hard/-22soft: justification (S51) has 12 matches:
            -1hard: constraint (Speaker required room tag)
            -10soft: constraint (Theme track conflict)
            ...
        ...
----

[IMPORTANT]
====
Do not attempt to parse this string or use it in your UI or exposed services.
Instead use the ConstraintMatch API below and do it properly.
====

[[usingScoreCalculationOutsideTheSolver]]
=== Using score calculation outside the `Solver`

If other parts of your application, for example your webUI, need to calculate the score of a solution,
reuse the `ScoreDirectorFactory` of the `SolverFactory` to build a separate `ScoreDirector` for that webUI:

[source,java,options=""nowrap""]
----
ScoreDirectorFactory<CloudBalance> scoreDirectorFactory = solverFactory.getScoreDirectorFactory();
try (ScoreDirector<CloudBalance> guiScoreDirector = scoreDirectorFactory.buildScoreDirector()) {
    ...
}
----

[NOTE]
====
The `try` ARM will call `ScoreDirector.close()` when the `ScoreDirector` becomes useless,
to avoid a memory leak, especially with <<droolsScoreCalculation,Drools score calculation>>.
====

Then use it when you need to calculate the `Score` of a solution:

[source,java,options=""nowrap""]
----
guiScoreDirector.setWorkingSolution(cloudBalance);
Score score = guiScoreDirector.calculateScore();
----

Furthermore, the `ScoreDirector` can explain the score through constraint match totals and/or indictments:

image::ScoreCalculation/scoreVisualization.png[align=""center""]


[[constraintMatchTotal]]
=== Constraint match total: break down the score by constraint

To break down the score per constraint, get the ``ConstraintMatchTotal``s from the ``ScoreDirector``:

[source,java,options=""nowrap""]
----
Collection<ConstraintMatchTotal> constraintMatchTotals = guiScoreDirector.getConstraintMatchTotals();
for (ConstraintMatchTotal constraintMatchTotal : constraintMatchTotals) {
    String constraintName = constraintMatchTotal.getConstraintName();
    // The score impact of that constraint
    HardSoftScore totalScore = (HardSoftScore) constraintMatchTotal.getScore();

    for (ConstraintMatch constraintMatch : constraintMatchTotal.getConstraintMatchSet()) {
        List<Object> justificationList = constraintMatch.getJustificationList();
        HardSoftScore score = (HardSoftScore) constraintMatch.getScore();
        ...
    }
}
----

Each `ConstraintMatchTotal` represents one constraint and has a part of the overall score.
The sum of all the `ConstraintMatchTotal.getScore()` equals the overall score.

[NOTE]
====
<<droolsScoreCalculation,Drools score calculation>> supports constraint matches automatically,
but <<incrementalJavaScoreCalculation,incremental Java score calculation>> requires
<<constraintMatchAwareIncrementalScoreCalculator,implementing an extra interface>>.
====


[[indictmentHeatMap]]
=== Indictment heat map: visualize the hot planning entities

To show a heat map in the UI that highlights the planning entities and problem facts have an impact on the ``Score``,
get the `Indictment` map from the ``ScoreDirector``:

[source,java,options=""nowrap""]
----
Map<Object, Indictment> indictmentMap = guiScoreDirector.getIndictmentMap();
for (CloudProcess process : cloudBalance.getProcessList()) {
    Indictment indictment = indictmentMap.get(process);
    if (indictment == null) {
        continue;
    }
    // The score impact of that planning entity
    HardSoftScore totalScore = (HardSoftScore) indictment.getScore();

    for (ConstraintMatch constraintMatch : indictment.getConstraintMatchSet()) {
        String constraintName = constraintMatch.getConstraintName();
        HardSoftScore score = (HardSoftScore) constraintMatch.getScore();
        ...
    }
}
----

Each `Indictment` is the sum of all constraints where that justification object is involved with.
The sum of all the `Indictment.getScoreTotal()` differs from the overall score,
because multiple ``Indictment``s can share the same `ConstraintMatch`.

[NOTE]
====
<<droolsScoreCalculation,Drools score calculation>> supports constraint matches automatically,
but <<incrementalJavaScoreCalculation,incremental Java score calculation>> requires
<<constraintMatchAwareIncrementalScoreCalculator,implementing an extra interface>>.
====


[[testingScoreConstraints]]
== Testing score constraints

It's recommended to write a unit test for each score constraint individually to check that it behaves correctly.
Different score calculation types come with different tools for testing.
For more, see <<constraintStreamsTesting,testing constraint streams>> or
<<testingDroolsConstraints,testing Drools constraints>>.
",12045,False,2103.535804969724,median
"*&---------------------------------------------------------------------*
*&  Include           ZABAPGIT_OBJECTS
*&---------------------------------------------------------------------*

*----------------------------------------------------------------------*
*       CLASS lcl_objects_activation DEFINITION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects_activation DEFINITION FINAL.

  PUBLIC SECTION.
    CLASS-METHODS add
      IMPORTING iv_type TYPE trobjtype
                iv_name TYPE clike
      RAISING   lcx_exception.

    CLASS-METHODS add_item
      IMPORTING is_item TYPE ty_item
      RAISING   lcx_exception.

    CLASS-METHODS activate
      IMPORTING iv_ddic TYPE abap_bool DEFAULT abap_false
      RAISING   lcx_exception.

    CLASS-METHODS clear.

  PRIVATE SECTION.
    CLASS-METHODS fix_class_methods
      IMPORTING iv_obj_name TYPE trobj_name
      CHANGING  ct_objects  TYPE dwinactiv_tab.

    CLASS-DATA: gt_objects TYPE TABLE OF dwinactiv.

ENDCLASS.                    ""lcl_objects_activation DEFINITION

*----------------------------------------------------------------------*
*       CLASS lcl_objects_activation IMPLEMENTATION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects_activation IMPLEMENTATION.

  METHOD add_item.
    add( iv_type = is_item-obj_type
         iv_name = is_item-obj_name ).
  ENDMETHOD.                    ""add_item

  METHOD clear.
    CLEAR gt_objects.
  ENDMETHOD.                    ""clear

  METHOD activate.

    IF NOT gt_objects IS INITIAL.
      CALL FUNCTION 'RS_WORKING_OBJECTS_ACTIVATE'
        EXPORTING
          activate_ddic_objects  = iv_ddic
          with_popup             = abap_true
        TABLES
          objects                = gt_objects
        EXCEPTIONS
          excecution_error       = 1
          cancelled              = 2
          insert_into_corr_error = 3
          OTHERS                 = 4.
      IF sy-subrc <> 0.
        lcx_exception=>raise( 'error from RS_WORKING_OBJECTS_ACTIVATE' ).
      ENDIF.
    ENDIF.

  ENDMETHOD.                    ""activate

  METHOD fix_class_methods.
* function module RS_WORKING_OBJECTS_ACTIVATE assumes that
* METH lines contains spaces between class and method name
* however, classes named with 30 characters
* eg. ZCL_CLAS_TESTTESTTESTTESTTESTT
* this will not be true, so find all the method includes instead

    DATA: lt_methods TYPE seop_methods_w_include,
          lv_class   TYPE seoclsname.

    FIELD-SYMBOLS: <ls_method> LIKE LINE OF lt_methods,
                   <ls_object> LIKE LINE OF ct_objects.


    lv_class = iv_obj_name.

    cl_oo_classname_service=>get_all_method_includes(
      EXPORTING
        clsname            = lv_class
      RECEIVING
        result             = lt_methods
      EXCEPTIONS
        class_not_existing = 1
        OTHERS             = 2 ).
    ASSERT sy-subrc = 0.
    DELETE ct_objects WHERE object = 'METH'.
    LOOP AT lt_methods ASSIGNING <ls_method>.
      APPEND INITIAL LINE TO ct_objects ASSIGNING <ls_object>.
      <ls_object>-object = 'METH'.
      <ls_object>-obj_name = <ls_method>-incname.
    ENDLOOP.

  ENDMETHOD.

  METHOD add.

* function group SEWORKINGAREA
* function module RS_INSERT_INTO_WORKING_AREA
* class CL_WB_ACTIVATION_WORK_AREA

    DATA: lt_objects  TYPE dwinactiv_tab,
          lv_obj_name TYPE dwinactiv-obj_name.

    FIELD-SYMBOLS: <ls_object> LIKE LINE OF lt_objects.


    lv_obj_name = iv_name.

    CASE iv_type.
      WHEN 'CLAS' OR 'WDYN'.
* todo, move this to the object type include instead
        CALL FUNCTION 'RS_INACTIVE_OBJECTS_IN_OBJECT'
          EXPORTING
            obj_name         = lv_obj_name
            object           = iv_type
          TABLES
            inactive_objects = lt_objects
          EXCEPTIONS
            object_not_found = 1
            OTHERS           = 2.
        IF sy-subrc <> 0.
          lcx_exception=>raise( 'Error from RS_INACTIVE_OBJECTS_IN_OBJECT' ).
        ENDIF.

        IF iv_type = 'CLAS'.
          fix_class_methods( EXPORTING iv_obj_name = lv_obj_name
                             CHANGING ct_objects = lt_objects ).
        ENDIF.

        APPEND LINES OF lt_objects TO gt_objects.
      WHEN OTHERS.
        APPEND INITIAL LINE TO gt_objects ASSIGNING <ls_object>.
        <ls_object>-object   = iv_type.
        <ls_object>-obj_name = lv_obj_name.
    ENDCASE.

  ENDMETHOD.                    ""activate

ENDCLASS.                    ""lcl_objects_activation IMPLEMENTATION

*----------------------------------------------------------------------*
*       CLASS lcl_objects_files DEFINITION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects_files DEFINITION.

  PUBLIC SECTION.
    METHODS:
      constructor
        IMPORTING is_item TYPE ty_item,
      add_string
        IMPORTING iv_extra  TYPE clike OPTIONAL
                  iv_ext    TYPE string
                  iv_string TYPE string
        RAISING   lcx_exception,
      read_string
        IMPORTING iv_extra         TYPE clike OPTIONAL
                  iv_ext           TYPE string
        RETURNING VALUE(rv_string) TYPE string
        RAISING   lcx_exception,
      add_xml
        IMPORTING iv_extra     TYPE clike OPTIONAL
                  io_xml       TYPE REF TO lcl_xml_output
                  iv_normalize TYPE sap_bool DEFAULT abap_true
                  is_metadata  TYPE ty_metadata OPTIONAL
        RAISING   lcx_exception,
* needed since type-check during dynamic call fails even if the object is compatible
      add_xml_from_plugin
        IMPORTING iv_extra     TYPE clike OPTIONAL
                  io_xml       TYPE REF TO object
                  iv_normalize TYPE sap_bool DEFAULT abap_true
        RAISING   lcx_exception ##called,
      read_xml
        IMPORTING iv_extra      TYPE clike OPTIONAL
        RETURNING VALUE(ro_xml) TYPE REF TO lcl_xml_input
        RAISING   lcx_exception,
      read_abap
        IMPORTING iv_extra       TYPE clike OPTIONAL
                  iv_error       TYPE sap_bool DEFAULT abap_true
        RETURNING VALUE(rt_abap) TYPE abaptxt255_tab
        RAISING   lcx_exception,
      add_abap
        IMPORTING iv_extra TYPE clike OPTIONAL
                  it_abap  TYPE STANDARD TABLE
        RAISING   lcx_exception,
      add
        IMPORTING is_file TYPE ty_file,
      add_raw
        IMPORTING iv_extra TYPE clike OPTIONAL
                  iv_ext   TYPE string
                  iv_data  TYPE xstring
        RAISING   lcx_exception,
      read_raw
        IMPORTING iv_extra       TYPE clike OPTIONAL
                  iv_ext         TYPE string
        RETURNING VALUE(rv_data) TYPE xstring
        RAISING   lcx_exception,
      get_files
        RETURNING VALUE(rt_files) TYPE ty_files_tt,
      set_files
        IMPORTING it_files TYPE ty_files_tt,
      get_accessed_files
        RETURNING VALUE(rt_files) TYPE ty_file_signatures_tt.

  PRIVATE SECTION.
    DATA: ms_item           TYPE ty_item,
          mt_accessed_files TYPE ty_file_signatures_tt,
          mt_files          TYPE ty_files_tt.

    METHODS:
      read_file
        IMPORTING iv_filename TYPE string
                  iv_error    TYPE abap_bool DEFAULT abap_true
        EXPORTING ev_data     TYPE xstring
        RAISING   lcx_exception,
      filename
        IMPORTING iv_extra           TYPE clike OPTIONAL
                  iv_ext             TYPE string
        RETURNING VALUE(rv_filename) TYPE string.

ENDCLASS.                    ""lcl_objects_files DEFINITION

INTERFACE lif_object_comparison_result.
  METHODS:
    show_confirmation_dialog,
    is_result_complete_halt
      RETURNING VALUE(rv_response) TYPE abap_bool.

ENDINTERFACE.

""Null Object Pattern
CLASS lcl_null_comparison_result DEFINITION FINAL.
  PUBLIC SECTION.
    INTERFACES lif_object_comparison_result.
ENDCLASS.
CLASS lcl_null_comparison_result IMPLEMENTATION.

  METHOD lif_object_comparison_result~is_result_complete_halt.
    rv_response = abap_false.
  ENDMETHOD.

  METHOD lif_object_comparison_result~show_confirmation_dialog.
    RETURN.
  ENDMETHOD.

ENDCLASS.

*----------------------------------------------------------------------*
*       INTERFACE lif_object DEFINITION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
INTERFACE lif_object.

  METHODS:
    serialize
      IMPORTING io_xml TYPE REF TO lcl_xml_output
      RAISING   lcx_exception,
    deserialize
      IMPORTING iv_package TYPE devclass
                io_xml     TYPE REF TO lcl_xml_input
      RAISING   lcx_exception,
    delete
      RAISING lcx_exception,
    exists
      RETURNING VALUE(rv_bool) TYPE abap_bool
      RAISING   lcx_exception,
    changed_by
      RETURNING VALUE(rv_user) TYPE xubname
      RAISING   lcx_exception,
    jump
      RAISING lcx_exception,
    get_metadata
      RETURNING VALUE(rs_metadata) TYPE ty_metadata,
    has_changed_since
      IMPORTING iv_timestamp      TYPE timestamp
      RETURNING VALUE(rv_changed) TYPE abap_bool
      RAISING   lcx_exception.
  METHODS:
    compare_to_remote_version
      IMPORTING io_remote_version_xml       TYPE REF TO lcl_xml_input
      RETURNING VALUE(ro_comparison_result) TYPE REF TO lif_object_comparison_result
      RAISING   lcx_exception.

  DATA: mo_files TYPE REF TO lcl_objects_files.

ENDINTERFACE.                    ""lif_object DEFINITION

*----------------------------------------------------------------------*
*       CLASS lcl_objects_files IMPLEMENTATION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects_files IMPLEMENTATION.

  METHOD constructor.
    ms_item = is_item.
  ENDMETHOD.                    ""constructor

  METHOD add.
    APPEND is_file TO mt_files.
  ENDMETHOD.                    ""add

  METHOD get_files.
    rt_files = mt_files.
  ENDMETHOD.                    ""get_files

  METHOD set_files.
    mt_files = it_files.
  ENDMETHOD.                    ""set_files

  METHOD get_accessed_files.
    rt_files = mt_accessed_files.
  ENDMETHOD.  "" get_accessed_files.

  METHOD read_string.

    DATA: lv_filename TYPE string,
          lv_data     TYPE xstring.

    lv_filename = filename( iv_extra = iv_extra
                            iv_ext   = iv_ext ).            ""#EC NOTEXT

    read_file( EXPORTING iv_filename = lv_filename
               IMPORTING ev_data     = lv_data ).

    rv_string = lcl_convert=>xstring_to_string_utf8( lv_data ).

  ENDMETHOD.                    ""read_string

  METHOD read_abap.

    DATA: lv_filename TYPE string,
          lv_data     TYPE xstring,
          lv_abap     TYPE string.


    lv_filename = filename( iv_extra = iv_extra
                            iv_ext   = 'abap' ).            ""#EC NOTEXT

    read_file( EXPORTING iv_filename = lv_filename
                         iv_error    = iv_error
               IMPORTING ev_data     = lv_data ).

    IF lv_data IS INITIAL. "" Post-handling of iv_error = false
      RETURN.
    ENDIF.

    lv_abap = lcl_convert=>xstring_to_string_utf8( lv_data ).

    SPLIT lv_abap AT gc_newline INTO TABLE rt_abap.

  ENDMETHOD.                    ""read_abap

  METHOD add_abap.

    DATA: lv_source TYPE string,
          ls_file   TYPE ty_file.


    CONCATENATE LINES OF it_abap INTO lv_source SEPARATED BY gc_newline.
* when editing files via eg. GitHub web interface it adds a newline at end of file
    lv_source = lv_source && gc_newline.

    ls_file-path = '/'.
    ls_file-filename = filename( iv_extra = iv_extra
                                 iv_ext   = 'abap' ).       ""#EC NOTEXT
    ls_file-data = lcl_convert=>string_to_xstring_utf8( lv_source ).

    APPEND ls_file TO mt_files.

  ENDMETHOD.                    ""abap_to_file

  METHOD add_string.

    DATA: ls_file TYPE ty_file.


    ls_file-path = '/'.
    ls_file-filename = filename( iv_extra = iv_extra
                                 iv_ext   = iv_ext ).       ""#EC NOTEXT
    ls_file-data = lcl_convert=>string_to_xstring_utf8( iv_string ).

    APPEND ls_file TO mt_files.

  ENDMETHOD.                    ""add_string

  METHOD add_xml.

    DATA: lv_xml  TYPE string,
          ls_file TYPE ty_file.


    lv_xml = io_xml->render( iv_normalize = iv_normalize
                             is_metadata = is_metadata ).
    ls_file-path = '/'.

    ls_file-filename = filename( iv_extra = iv_extra
                                 iv_ext   = 'xml' ).        ""#EC NOTEXT

    REPLACE FIRST OCCURRENCE
      OF REGEX '<\\?xml version=""1\\.0"" encoding=""[\\w-]+""\\?>'
      IN lv_xml
      WITH '<?xml version=""1.0"" encoding=""utf-8""?>'.
    ASSERT sy-subrc = 0.

    ls_file-data = lcl_convert=>string_to_xstring_utf8( lv_xml ).

    APPEND ls_file TO mt_files.

  ENDMETHOD.                    ""do

  METHOD read_xml.

    DATA: lv_filename TYPE string,
          lv_data     TYPE xstring,
          lv_xml      TYPE string.

    lv_filename = filename( iv_extra = iv_extra
                            iv_ext   = 'xml' ).             ""#EC NOTEXT

    read_file( EXPORTING iv_filename = lv_filename
               IMPORTING ev_data     = lv_data ).

    lv_xml = lcl_convert=>xstring_to_string_utf8( lv_data ).

    CREATE OBJECT ro_xml
      EXPORTING
        iv_xml = lv_xml.

  ENDMETHOD.                    ""read_xml

  METHOD filename.

    DATA: lv_obj_name TYPE string.


    IF ms_item-obj_type = 'SICF'.
* multiple SICF nodes with same name cannot be added to repository
      lv_obj_name = ms_item-obj_name(15).
    ELSE.
      lv_obj_name = ms_item-obj_name.
    ENDIF.


    IF iv_extra IS INITIAL.
      CONCATENATE lv_obj_name '.' ms_item-obj_type '.' iv_ext
        INTO rv_filename.                                   ""#EC NOTEXT
    ELSE.
      CONCATENATE lv_obj_name '.' ms_item-obj_type '.' iv_extra '.' iv_ext
        INTO rv_filename.                                   ""#EC NOTEXT
    ENDIF.

* handle namespaces
    REPLACE ALL OCCURRENCES OF '/' IN rv_filename WITH '#'.
    TRANSLATE rv_filename TO LOWER CASE.

  ENDMETHOD.                    ""filename

  METHOD add_xml_from_plugin.
*    this method wraps add_xml as in the plugin. This is necessary as the wrapped
*    xml-object in the plugin can only be typed to object.
*    ABAP does not perform implicit type casts (also if compatible) in signatures,
*    therefore this method's signature is typed ref to object
    DATA lo_xml TYPE REF TO lcl_xml_output.

    lo_xml ?= io_xml.

    me->add_xml(
      iv_extra     = iv_extra
      io_xml       = lo_xml
      iv_normalize = iv_normalize ).

  ENDMETHOD.                    ""add_xml_from_plugin

  METHOD read_file.

    FIELD-SYMBOLS: <ls_file>     LIKE LINE OF mt_files,
                   <ls_accessed> LIKE LINE OF mt_accessed_files.

    CLEAR ev_data.
    READ TABLE mt_files ASSIGNING <ls_file> WITH KEY filename = iv_filename.

    IF sy-subrc <> 0.
      IF iv_error = abap_true.
        lcx_exception=>raise( |File not found: { iv_filename }| ).
      ELSE.
        RETURN.
      ENDIF.
    ENDIF.

    "" Update access table
    READ TABLE mt_accessed_files TRANSPORTING NO FIELDS
      WITH KEY path = <ls_file>-path filename = <ls_file>-filename.
    IF sy-subrc > 0. "" Not found ? -> Add
      APPEND INITIAL LINE TO mt_accessed_files ASSIGNING <ls_accessed>.
      MOVE-CORRESPONDING <ls_file> TO <ls_accessed>.
    ENDIF.

    ev_data = <ls_file>-data.

  ENDMETHOD.  "" read_file.

  METHOD add_raw.

    DATA: ls_file TYPE ty_file.

    ls_file-path     = '/'.
    ls_file-data     = iv_data.
    ls_file-filename = filename( iv_extra = iv_extra
                                 iv_ext   = iv_ext ).

    APPEND ls_file TO mt_files.

  ENDMETHOD.                    ""add_raw

  METHOD read_raw.

    DATA: lv_filename TYPE string.

    lv_filename = filename( iv_extra = iv_extra
                            iv_ext   = iv_ext ).

    read_file( EXPORTING iv_filename = lv_filename
               IMPORTING ev_data     = rv_data ).

  ENDMETHOD.                    ""read_raw

ENDCLASS.                    ""lcl_objects_files IMPLEMENTATION

*----------------------------------------------------------------------*
*       CLASS lcl_objects_super DEFINITION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects_super DEFINITION ABSTRACT.

  PUBLIC SECTION.

    METHODS:
      constructor
        IMPORTING
          is_item     TYPE ty_item
          iv_language TYPE spras.

    CONSTANTS: c_user_unknown TYPE xubname VALUE 'UNKNOWN'.

  PROTECTED SECTION.

    DATA: ms_item     TYPE ty_item,
          mv_language TYPE spras.

    METHODS:
      get_metadata
        RETURNING VALUE(rs_metadata) TYPE ty_metadata,
      corr_insert
        IMPORTING iv_package TYPE devclass
        RAISING   lcx_exception,
      tadir_insert
        IMPORTING iv_package TYPE devclass
        RAISING   lcx_exception,
      jump_se11
        IMPORTING iv_radio TYPE string
                  iv_field TYPE string
        RAISING   lcx_exception.

ENDCLASS.                    ""lcl_objects_super DEFINITION

**********************************************************************
* Enable plugins

CLASS lcl_objects_bridge DEFINITION INHERITING FROM lcl_objects_super FINAL.

  PUBLIC SECTION.

    CLASS-METHODS class_constructor.

    METHODS constructor
      IMPORTING is_item TYPE ty_item
      RAISING   cx_sy_create_object_error.

    INTERFACES lif_object.
    ALIASES mo_files FOR lif_object~mo_files.

  PRIVATE SECTION.
    DATA: mo_plugin TYPE REF TO object.

    TYPES: BEGIN OF ty_s_objtype_map,
             obj_typ      TYPE trobjtype,
             plugin_class TYPE seoclsname,
           END OF ty_s_objtype_map,
           ty_t_objtype_map TYPE SORTED TABLE OF ty_s_objtype_map WITH UNIQUE KEY obj_typ.

    CLASS-DATA gt_objtype_map TYPE ty_t_objtype_map.

ENDCLASS.                    ""lcl_objects_bridge DEFINITION

*----------------------------------------------------------------------*
*       CLASS lcl_objects_bridge IMPLEMENTATION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects_bridge IMPLEMENTATION.

  METHOD lif_object~has_changed_since.
    rv_changed = abap_true.
  ENDMETHOD.  ""lif_object~has_changed_since

  METHOD lif_object~get_metadata.

    CALL METHOD mo_plugin->('ZIF_ABAPGIT_PLUGIN~GET_METADATA')
      RECEIVING
        rs_metadata = rs_metadata.

  ENDMETHOD.                    ""lif_object~get_metadata

  METHOD lif_object~changed_by.
    rv_user = c_user_unknown. "" todo
  ENDMETHOD.

  METHOD constructor.

    DATA ls_objtype_map LIKE LINE OF gt_objtype_map.

    super->constructor( is_item = is_item
                        iv_language = gc_english ).

*    determine the responsible plugin
    READ TABLE gt_objtype_map INTO ls_objtype_map
      WITH TABLE KEY obj_typ = is_item-obj_type.
    IF sy-subrc = 0.
      CREATE OBJECT mo_plugin TYPE (ls_objtype_map-plugin_class).

      CALL METHOD mo_plugin->('SET_ITEM')
        EXPORTING
          iv_obj_type = is_item-obj_type
          iv_obj_name = is_item-obj_name.
    ELSE.
      RAISE EXCEPTION TYPE cx_sy_create_object_error
        EXPORTING
          classname = 'LCL_OBJECTS_BRIDGE'.
    ENDIF.
  ENDMETHOD.                    ""constructor

  METHOD lif_object~serialize.

    CALL METHOD mo_plugin->('WRAP_SERIALIZE')
      EXPORTING
        io_xml = io_xml.

  ENDMETHOD.                    ""lif_object~serialize

  METHOD lif_object~deserialize.

    DATA: lx_plugin        TYPE REF TO cx_static_check.

    TRY.
        CALL METHOD mo_plugin->('WRAP_DESERIALIZE')
          EXPORTING
            iv_package = iv_package
            io_xml     = io_xml.
      CATCH cx_static_check INTO lx_plugin.
        RAISE EXCEPTION TYPE lcx_exception
          EXPORTING
            ix_previous = lx_plugin
            iv_text     = lx_plugin->get_text( ).
    ENDTRY.
  ENDMETHOD.                    ""lif_object~deserialize

  METHOD lif_object~delete.
    DATA lx_plugin TYPE REF TO cx_static_check.

    TRY.
        CALL METHOD mo_plugin->('ZIF_ABAPGIT_PLUGIN~DELETE').
      CATCH cx_static_check INTO lx_plugin.
        RAISE EXCEPTION TYPE lcx_exception
          EXPORTING
            ix_previous = lx_plugin
            iv_text     = lx_plugin->get_text( ).
    ENDTRY.

  ENDMETHOD.                    ""lif_object~delete

  METHOD lif_object~exists.

    CALL METHOD mo_plugin->('ZIF_ABAPGIT_PLUGIN~EXISTS')
      RECEIVING
        rv_bool = rv_bool.

  ENDMETHOD.                    ""lif_object~exists

  METHOD lif_object~jump.

    CALL METHOD mo_plugin->('ZIF_ABAPGIT_PLUGIN~JUMP').

  ENDMETHOD.                    ""lif_object~jump

  METHOD class_constructor.

    DATA lt_plugin_class    TYPE STANDARD TABLE OF seoclsname WITH DEFAULT KEY.
    DATA lv_plugin_class    LIKE LINE OF lt_plugin_class.
    DATA lo_plugin          TYPE REF TO object.
    DATA lt_plugin_obj_type TYPE objtyptable.
    DATA ls_objtype_map     LIKE LINE OF gt_objtype_map.


    SELECT ext~clsname
      FROM vseoextend AS ext
      INTO TABLE lt_plugin_class
      WHERE ext~refclsname LIKE 'ZCL_ABAPGIT_OBJECT%'
      AND ext~version = '1'.                              ""#EC CI_SUBRC

    CLEAR gt_objtype_map.
    LOOP AT lt_plugin_class INTO lv_plugin_class
        WHERE table_line <> 'ZCL_ABAPGIT_OBJECT_BY_SOBJ'.
* have the generic plugin only as fallback
      TRY.
          CREATE OBJECT lo_plugin TYPE (lv_plugin_class).
        CATCH cx_sy_create_object_error.
          CONTINUE. "">>>>>>>>>>>>>>
      ENDTRY.

      CALL METHOD lo_plugin->('GET_SUPPORTED_OBJ_TYPES')
        IMPORTING
          rt_obj_type = lt_plugin_obj_type.

      ls_objtype_map-plugin_class = lv_plugin_class.
      LOOP AT lt_plugin_obj_type INTO ls_objtype_map-obj_typ.
        INSERT ls_objtype_map INTO TABLE gt_objtype_map.
        IF sy-subrc <> 0.
* No exception in class-contructor possible.
* Anyway, a shortdump is more appropriate in this case
          ASSERT 'There must not be' =
            |multiple abapGit-Plugins for the same object type {
            ls_objtype_map-obj_typ }|.
        ENDIF.
      ENDLOOP.
    ENDLOOP. ""at plugins

* and the same for the generic plugin if exists
* have the generic plugin only as fallback
    LOOP AT lt_plugin_class INTO lv_plugin_class
        WHERE table_line = 'ZCL_ABAPGIT_OBJECT_BY_SOBJ'.
      CREATE OBJECT lo_plugin TYPE (lv_plugin_class).

      CALL METHOD lo_plugin->('GET_SUPPORTED_OBJ_TYPES')
        RECEIVING
          rt_obj_type = lt_plugin_obj_type.

      ls_objtype_map-plugin_class = lv_plugin_class.
      LOOP AT lt_plugin_obj_type INTO ls_objtype_map-obj_typ.
        INSERT ls_objtype_map INTO TABLE gt_objtype_map. ""knowingly ignore the subrc
      ENDLOOP.
    ENDLOOP. ""at plugins

  ENDMETHOD.                    ""class_constructor

  METHOD lif_object~compare_to_remote_version.
    CREATE OBJECT ro_comparison_result TYPE lcl_null_comparison_result.
  ENDMETHOD.

ENDCLASS.                    ""lcl_objects_bridge IMPLEMENTATION

**********************************************************************

CLASS lcl_objects_program DEFINITION INHERITING FROM lcl_objects_super.

  PUBLIC SECTION.
    TYPES: BEGIN OF ty_progdir,
             name    TYPE progdir-name,
             state   TYPE progdir-state,
             sqlx    TYPE progdir-sqlx,
             edtx    TYPE progdir-edtx,
             varcl   TYPE progdir-varcl,
             dbapl   TYPE progdir-dbapl,
             dbna    TYPE progdir-dbna,
             clas    TYPE progdir-clas,
             type    TYPE progdir-type,
             occurs  TYPE progdir-occurs,
             subc    TYPE progdir-subc,
             appl    TYPE progdir-appl,
             secu    TYPE progdir-secu,
             cnam    TYPE progdir-cnam,
             cdat    TYPE progdir-cdat,
             unam    TYPE progdir-unam,
             udat    TYPE progdir-udat,
             vern    TYPE progdir-vern,
             levl    TYPE progdir-levl,
             rstat   TYPE progdir-rstat,
             rmand   TYPE progdir-rmand,
             rload   TYPE progdir-rload,
             fixpt   TYPE progdir-fixpt,
             sset    TYPE progdir-sset,
             sdate   TYPE progdir-sdate,
             stime   TYPE progdir-stime,
             idate   TYPE progdir-idate,
             itime   TYPE progdir-itime,
             ldbname TYPE progdir-ldbname,
             uccheck TYPE progdir-uccheck,
           END OF ty_progdir.

    METHODS serialize_program
      IMPORTING io_xml     TYPE REF TO lcl_xml_output OPTIONAL
                is_item    TYPE ty_item
                io_files   TYPE REF TO lcl_objects_files
                iv_program TYPE programm OPTIONAL
                iv_extra   TYPE clike OPTIONAL
      RAISING   lcx_exception.

    METHODS read_progdir
      IMPORTING iv_program        TYPE programm
      RETURNING VALUE(rs_progdir) TYPE ty_progdir.

    METHODS deserialize_program
      IMPORTING is_progdir TYPE ty_progdir
                it_source  TYPE abaptxt255_tab
                it_tpool   TYPE textpool_table
                iv_package TYPE devclass
      RAISING   lcx_exception.

  PROTECTED SECTION.

    TYPES: ty_spaces_tt TYPE STANDARD TABLE OF i WITH DEFAULT KEY.

    TYPES: BEGIN OF ty_dynpro,
             header     TYPE rpy_dyhead,
             containers TYPE dycatt_tab,
             fields     TYPE dyfatc_tab,
             flow_logic TYPE swydyflow,
             spaces     TYPE ty_spaces_tt,
           END OF ty_dynpro.

    TYPES: ty_dynpro_tt TYPE STANDARD TABLE OF ty_dynpro WITH DEFAULT KEY.

    TYPES: BEGIN OF ty_cua,
             adm TYPE rsmpe_adm,
             sta TYPE STANDARD TABLE OF rsmpe_stat WITH DEFAULT KEY,
             fun TYPE STANDARD TABLE OF rsmpe_funt WITH DEFAULT KEY,
             men TYPE STANDARD TABLE OF rsmpe_men WITH DEFAULT KEY,
             mtx TYPE STANDARD TABLE OF rsmpe_mnlt WITH DEFAULT KEY,
             act TYPE STANDARD TABLE OF rsmpe_act WITH DEFAULT KEY,
             but TYPE STANDARD TABLE OF rsmpe_but WITH DEFAULT KEY,
             pfk TYPE STANDARD TABLE OF rsmpe_pfk WITH DEFAULT KEY,
             set TYPE STANDARD TABLE OF rsmpe_staf WITH DEFAULT KEY,
             doc TYPE STANDARD TABLE OF rsmpe_atrt WITH DEFAULT KEY,
             tit TYPE STANDARD TABLE OF rsmpe_titt WITH DEFAULT KEY,
             biv TYPE STANDARD TABLE OF rsmpe_buts WITH DEFAULT KEY,
           END OF ty_cua.

    METHODS serialize_dynpros
      IMPORTING iv_program_name  TYPE programm
      RETURNING VALUE(rt_dynpro) TYPE ty_dynpro_tt
      RAISING   lcx_exception.

    METHODS serialize_cua
      IMPORTING iv_program_name TYPE programm
      RETURNING VALUE(rs_cua)   TYPE ty_cua
      RAISING   lcx_exception.

    METHODS deserialize_dynpros
      IMPORTING it_dynpros TYPE ty_dynpro_tt
      RAISING   lcx_exception.

    METHODS deserialize_textpool
      IMPORTING iv_program  TYPE programm
                it_tpool    TYPE textpool_table
                iv_language TYPE langu OPTIONAL
      RAISING   lcx_exception.

    METHODS deserialize_cua
      IMPORTING iv_program_name TYPE programm
                is_cua          TYPE ty_cua
      RAISING   lcx_exception.

    METHODS check_prog_changed_since
      IMPORTING iv_program        TYPE programm
                iv_timestamp      TYPE timestamp
                iv_skip_gui       TYPE abap_bool DEFAULT abap_false
      RETURNING VALUE(rv_changed) TYPE abap_bool.

    CLASS-METHODS:
      add_tpool
        IMPORTING it_tpool        TYPE textpool_table
        RETURNING VALUE(rt_tpool) TYPE ty_tpool_tt,
      read_tpool
        IMPORTING it_tpool        TYPE ty_tpool_tt
        RETURNING VALUE(rt_tpool) TYPE ty_tpool_tt.

  PRIVATE SECTION.
    METHODS:
      condense_flow
        EXPORTING et_spaces TYPE ty_spaces_tt
        CHANGING  ct_flow   TYPE swydyflow,
      uncondense_flow
        IMPORTING it_flow        TYPE swydyflow
                  it_spaces      TYPE ty_spaces_tt
        RETURNING VALUE(rt_flow) TYPE swydyflow.


ENDCLASS.                    ""lcl_objects_program DEFINITION

*----------------------------------------------------------------------*
*       CLASS lcl_objects_program IMPLEMENTATION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects_program IMPLEMENTATION.

  METHOD condense_flow.

    DATA: lv_spaces LIKE LINE OF et_spaces.

    FIELD-SYMBOLS: <ls_flow> LIKE LINE OF ct_flow.


    CLEAR et_spaces.

    LOOP AT ct_flow ASSIGNING <ls_flow>.
      lv_spaces = 0.

      WHILE NOT <ls_flow>-line IS INITIAL AND <ls_flow>-line(1) = space.
        lv_spaces = lv_spaces + 1.
        <ls_flow>-line = <ls_flow>-line+1.
      ENDWHILE.

      APPEND lv_spaces TO et_spaces.
    ENDLOOP.

  ENDMETHOD.

  METHOD uncondense_flow.

    DATA: lv_spaces LIKE LINE OF it_spaces.

    FIELD-SYMBOLS: <ls_flow>   LIKE LINE OF it_flow,
                   <ls_output> LIKE LINE OF rt_flow.


    LOOP AT it_flow ASSIGNING <ls_flow>.
      APPEND INITIAL LINE TO rt_flow ASSIGNING <ls_output>.
      <ls_output>-line = <ls_flow>-line.

      READ TABLE it_spaces INDEX sy-tabix INTO lv_spaces.
      IF sy-subrc = 0.
        SHIFT <ls_output>-line RIGHT BY lv_spaces PLACES IN CHARACTER MODE.
      ENDIF.
    ENDLOOP.

  ENDMETHOD.

  METHOD serialize_program.

    DATA: ls_progdir      TYPE ty_progdir,
          lv_program_name TYPE programm,
          lt_dynpros      TYPE ty_dynpro_tt,
          ls_cua          TYPE ty_cua,
          lt_source       TYPE TABLE OF abaptxt255,
          lt_tpool        TYPE textpool_table,
          ls_tpool        LIKE LINE OF lt_tpool,
          lo_xml          TYPE REF TO lcl_xml_output.

    IF iv_program IS INITIAL.
      lv_program_name = is_item-obj_name.
    ELSE.
      lv_program_name = iv_program.
    ENDIF.

    CALL FUNCTION 'RPY_PROGRAM_READ'
      EXPORTING
        program_name     = lv_program_name
        with_lowercase   = abap_true
      TABLES
        source_extended  = lt_source
        textelements     = lt_tpool
      EXCEPTIONS
        cancelled        = 1
        not_found        = 2
        permission_error = 3
        OTHERS           = 4.
    IF sy-subrc = 2.
      RETURN.
    ELSEIF sy-subrc <> 0.
      lcx_exception=>raise( 'Error reading program' ).
    ENDIF.

    ls_progdir = read_progdir( lv_program_name ).

    IF io_xml IS BOUND.
      lo_xml = io_xml.
    ELSE.
      CREATE OBJECT lo_xml.
    ENDIF.

    lo_xml->add( iv_name = 'PROGDIR'
                 ig_data = ls_progdir ).
    IF ls_progdir-subc = '1'.
      lt_dynpros = serialize_dynpros( lv_program_name ).
      lo_xml->add( iv_name = 'DYNPROS'
                   ig_data = lt_dynpros ).

      ls_cua = serialize_cua( lv_program_name ).
      IF NOT ls_cua IS INITIAL.
        lo_xml->add( iv_name = 'CUA'
                     ig_data = ls_cua ).
      ENDIF.
    ENDIF.

    READ TABLE lt_tpool WITH KEY id = 'R' INTO ls_tpool.
    IF sy-subrc = 0 AND ls_tpool-key = '' AND ls_tpool-length = 0.
      DELETE lt_tpool INDEX sy-tabix.
    ENDIF.

    lo_xml->add( iv_name = 'TPOOL'
                 ig_data = add_tpool( lt_tpool ) ).

    IF NOT io_xml IS BOUND.
      io_files->add_xml( iv_extra = iv_extra
                         io_xml   = lo_xml ).
    ENDIF.

    io_files->add_abap( iv_extra = iv_extra
                        it_abap  = lt_source ).

  ENDMETHOD.                    ""serialize_program

  METHOD deserialize_program.

    DATA: lv_exists      TYPE sap_bool,
          lv_progname    TYPE reposrc-progname,
          ls_tpool       LIKE LINE OF it_tpool,
          lv_title       TYPE rglif-title,
          ls_progdir_new TYPE progdir.

    FIELD-SYMBOLS: <lg_any> TYPE any.


    CALL FUNCTION 'RS_CORR_INSERT'
      EXPORTING
        object              = is_progdir-name
        object_class        = 'ABAP'
        devclass            = iv_package
        master_language     = mv_language
        mode                = 'INSERT'
      EXCEPTIONS
        cancelled           = 1
        permission_failure  = 2
        unknown_objectclass = 3
        OTHERS              = 4.
    IF sy-subrc = 1.
      lcx_exception=>raise( 'Cancelled' ).
    ELSEIF sy-subrc <> 0.
      lcx_exception=>raise( 'error from RS_CORR_INSERT' ).
    ENDIF.

    READ TABLE it_tpool INTO ls_tpool WITH KEY id = 'R'.  ""#EC CI_SUBRC
    IF sy-subrc = 0.
* there is a bug in RPY_PROGRAM_UPDATE, the header line of TTAB is not
* cleared, so the title length might be inherited from a different program.
      ASSIGN ('(SAPLSIFP)TTAB') TO <lg_any>.
      IF sy-subrc = 0.
        CLEAR <lg_any>.
      ENDIF.

      lv_title = ls_tpool-entry.
    ENDIF.

    SELECT SINGLE progname FROM reposrc INTO lv_progname
      WHERE progname = is_progdir-name
      AND r3state = 'A'.
    IF sy-subrc = 0.
      lv_exists = abap_true.
    ELSE.
      lv_exists = abap_false.
    ENDIF.

    IF lv_exists = abap_true.
      CALL FUNCTION 'RPY_PROGRAM_UPDATE'
        EXPORTING
          program_name     = is_progdir-name
          title_string     = lv_title
          save_inactive    = 'I'
        TABLES
          source_extended  = it_source
        EXCEPTIONS
          cancelled        = 1
          permission_error = 2
          not_found        = 3
          OTHERS           = 4.
      IF sy-subrc <> 0.
        IF sy-msgid = 'EU' AND sy-msgno = '510'.
          lcx_exception=>raise( 'User is currently editing program' ).
        ELSE.
          lcx_exception=>raise( 'PROG, error updating' ).
        ENDIF.
      ENDIF.
    ELSE.
* function module RPY_PROGRAM_INSERT cannot handle function group includes

      IF strlen( is_progdir-name ) > 30.
        "" special treatment for extenstions
        "" if the program name exceeds 30 characters it is not a usual
        "" ABAP program but might be some extension, which requires the internal
        "" addition EXTENSION TYPE, see
        "" http://help.sap.com/abapdocu_751/en/abapinsert_report_internal.htm#!ABAP_ADDITION_1@1@
        "" This e.g. occurs in case of transportable Code Inspector variants (ending with ===VC)
        INSERT REPORT is_progdir-name
         FROM it_source
         STATE 'I'
         EXTENSION TYPE is_progdir-name+30.
        IF sy-subrc <> 0.
          lcx_exception=>raise( 'error from INSERT REPORT .. EXTENSION TYPE' ).
        ENDIF.
      ELSE.
        INSERT REPORT is_progdir-name
          FROM it_source
          STATE 'I'
          PROGRAM TYPE is_progdir-subc.
        IF sy-subrc <> 0.
          lcx_exception=>raise( 'error from INSERT REPORT' ).
        ENDIF.
      ENDIF.

      IF NOT it_tpool[] IS INITIAL.
        INSERT TEXTPOOL is_progdir-name
          FROM it_tpool
          LANGUAGE mv_language
          STATE 'I'.
        IF sy-subrc <> 0.
          lcx_exception=>raise( 'error from INSERT TEXTPOOL' ).
        ENDIF.
      ENDIF.

    ENDIF.

    CALL FUNCTION 'READ_PROGDIR'
      EXPORTING
        i_progname = is_progdir-name
        i_state    = 'I'
      IMPORTING
        e_progdir  = ls_progdir_new
      EXCEPTIONS
        not_exists = 1
        OTHERS     = 2.
    IF sy-subrc <> 0.
      lcx_exception=>raise( 'not found in PROGDIR' ).
    ENDIF.

* todo, package?

    ls_progdir_new-ldbname = is_progdir-ldbname.
    ls_progdir_new-dbna    = is_progdir-dbna.
    ls_progdir_new-dbapl   = is_progdir-dbapl.
    ls_progdir_new-rload   = is_progdir-rload.
    ls_progdir_new-fixpt   = is_progdir-fixpt.
    ls_progdir_new-varcl   = is_progdir-varcl.
    ls_progdir_new-appl    = is_progdir-appl.
    ls_progdir_new-rstat   = is_progdir-rstat.

    CALL FUNCTION 'UPDATE_PROGDIR'
      EXPORTING
        i_progdir    = ls_progdir_new
        i_progname   = ls_progdir_new-name
        i_state      = ls_progdir_new-state
      EXCEPTIONS
        not_executed = 1
        OTHERS       = 2.
    IF sy-subrc <> 0.
      lcx_exception=>raise( 'PROG, error inserting' ).
    ENDIF.

    SELECT SINGLE * FROM progdir INTO ls_progdir_new
      WHERE name = ls_progdir_new-name
      AND state = ls_progdir_new-state.
    IF sy-subrc = 0 AND is_progdir-varcl = space AND ls_progdir_new-varcl = abap_true.
* function module UPDATE_PROGDIR does not update VARCL
      UPDATE progdir SET varcl = is_progdir-varcl
        WHERE name = ls_progdir_new-name
        AND state = ls_progdir_new-state.
    ENDIF.

    lcl_objects_activation=>add( iv_type = 'REPS'
                                 iv_name = is_progdir-name ).

  ENDMETHOD.                    ""deserialize_program

  METHOD read_progdir.

    DATA: ls_sapdir TYPE progdir.


    CALL FUNCTION 'READ_PROGDIR'
      EXPORTING
        i_progname = iv_program
        i_state    = 'A'
      IMPORTING
        e_progdir  = ls_sapdir.
    MOVE-CORRESPONDING ls_sapdir TO rs_progdir.

    CLEAR: rs_progdir-edtx,
           rs_progdir-cnam,
           rs_progdir-cdat,
           rs_progdir-unam,
           rs_progdir-udat,
           rs_progdir-levl,
           rs_progdir-vern,
           rs_progdir-rmand,
           rs_progdir-sdate,
           rs_progdir-stime,
           rs_progdir-idate,
           rs_progdir-itime.

  ENDMETHOD.                    ""read_progdir

  METHOD serialize_cua.

    CALL FUNCTION 'RS_CUA_INTERNAL_FETCH'
      EXPORTING
        program         = iv_program_name
        language        = mv_language
        state           = 'A'
      IMPORTING
        adm             = rs_cua-adm
      TABLES
        sta             = rs_cua-sta
        fun             = rs_cua-fun
        men             = rs_cua-men
        mtx             = rs_cua-mtx
        act             = rs_cua-act
        but             = rs_cua-but
        pfk             = rs_cua-pfk
        set             = rs_cua-set
        doc             = rs_cua-doc
        tit             = rs_cua-tit
        biv             = rs_cua-biv
      EXCEPTIONS
        not_found       = 1
        unknown_version = 2
        OTHERS          = 3.
    IF sy-subrc <> 0.
      lcx_exception=>raise( 'error from RS_CUA_INTERNAL_FETCH' ).
    ENDIF.

  ENDMETHOD.                    ""serialize_cua

  METHOD serialize_dynpros.

    DATA: ls_header               TYPE rpy_dyhead,
          lt_containers           TYPE dycatt_tab,
          lt_fields_to_containers TYPE dyfatc_tab,
          lt_flow_logic           TYPE swydyflow,
          lt_d020s                TYPE TABLE OF d020s.

    FIELD-SYMBOLS: <ls_d020s>       LIKE LINE OF lt_d020s,
                   <lv_outputstyle> TYPE scrpostyle,
                   <ls_field>       LIKE LINE OF lt_fields_to_containers,
                   <ls_dynpro>      LIKE LINE OF rt_dynpro.


    CALL FUNCTION 'RS_SCREEN_LIST'
      EXPORTING
        dynnr     = ''
        progname  = iv_program_name
      TABLES
        dynpros   = lt_d020s
      EXCEPTIONS
        not_found = 1
        OTHERS    = 2.
    IF sy-subrc = 2.
      lcx_exception=>raise( 'error from screen_list' ).
    ENDIF.

* loop dynpros and skip generated selection screens
    LOOP AT lt_d020s ASSIGNING <ls_d020s> WHERE type <> 'S'.

      CALL FUNCTION 'RPY_DYNPRO_READ'
        EXPORTING
          progname             = iv_program_name
          dynnr                = <ls_d020s>-dnum
        IMPORTING
          header               = ls_header
        TABLES
          containers           = lt_containers
          fields_to_containers = lt_fields_to_containers
          flow_logic           = lt_flow_logic
        EXCEPTIONS
          cancelled            = 1
          not_found            = 2
          permission_error     = 3
          OTHERS               = 4.
      IF sy-subrc <> 0.
        lcx_exception=>raise( 'Error while reading dynpro' ).
      ENDIF.

      LOOP AT lt_fields_to_containers ASSIGNING <ls_field>.
* output style is a NUMC field, the XML conversion will fail if it contains invalid value
* field does not exist in all versions
        ASSIGN COMPONENT 'OUTPUTSTYLE' OF STRUCTURE <ls_field> TO <lv_outputstyle>.
        IF sy-subrc = 0 AND <lv_outputstyle> = '  '.
          CLEAR <lv_outputstyle>.
        ENDIF.
      ENDLOOP.

      APPEND INITIAL LINE TO rt_dynpro ASSIGNING <ls_dynpro>.
      <ls_dynpro>-header     = ls_header.
      <ls_dynpro>-containers = lt_containers.
      <ls_dynpro>-fields     = lt_fields_to_containers.

      condense_flow( IMPORTING et_spaces = <ls_dynpro>-spaces
                     CHANGING ct_flow = lt_flow_logic ).
      <ls_dynpro>-flow_logic = lt_flow_logic.

    ENDLOOP.

  ENDMETHOD.                    ""serialize_dynpros


  METHOD deserialize_dynpros.

    DATA: lv_name   TYPE dwinactiv-obj_name,
          ls_dynpro LIKE LINE OF it_dynpros.


* ls_dynpro is changed by the function module, a field-symbol will cause
* the program to dump since it_dynpros cannot be changed
    LOOP AT it_dynpros INTO ls_dynpro.

      ls_dynpro-flow_logic = uncondense_flow(
        it_flow = ls_dynpro-flow_logic
        it_spaces = ls_dynpro-spaces ).

      CALL FUNCTION 'RPY_DYNPRO_INSERT'
        EXPORTING
          header                 = ls_dynpro-header
          suppress_exist_checks  = abap_true
        TABLES
          containers             = ls_dynpro-containers
          fields_to_containers   = ls_dynpro-fields
          flow_logic             = ls_dynpro-flow_logic
        EXCEPTIONS
          cancelled              = 1
          already_exists         = 2
          program_not_exists     = 3
          not_executed           = 4
          missing_required_field = 5
          illegal_field_value    = 6
          field_not_allowed      = 7
          not_generated          = 8
          illegal_field_position = 9
          OTHERS                 = 10.
      IF sy-subrc <> 2 AND sy-subrc <> 0.
        lcx_exception=>raise( 'error from RPY_DYNPRO_INSERT' ).
      ENDIF.
* todo, RPY_DYNPRO_UPDATE?

      CONCATENATE ls_dynpro-header-program ls_dynpro-header-screen
        INTO lv_name RESPECTING BLANKS.
      ASSERT NOT lv_name IS INITIAL.

      lcl_objects_activation=>add( iv_type = 'DYNP'
                                   iv_name = lv_name ).

    ENDLOOP.

  ENDMETHOD.                    ""deserialize_dynpros

  METHOD add_tpool.

    FIELD-SYMBOLS: <ls_tpool_in>  LIKE LINE OF it_tpool,
                   <ls_tpool_out> LIKE LINE OF rt_tpool.


    LOOP AT it_tpool ASSIGNING <ls_tpool_in>.
      APPEND INITIAL LINE TO rt_tpool ASSIGNING <ls_tpool_out>.
      MOVE-CORRESPONDING <ls_tpool_in> TO <ls_tpool_out>.
      IF <ls_tpool_out>-id = 'S'.
        <ls_tpool_out>-split = <ls_tpool_out>-entry.
        <ls_tpool_out>-entry = <ls_tpool_out>-entry+8.
      ENDIF.
    ENDLOOP.

  ENDMETHOD.                    ""add_tpool

  METHOD read_tpool.

    FIELD-SYMBOLS: <ls_tpool_in>  LIKE LINE OF it_tpool,
                   <ls_tpool_out> LIKE LINE OF rt_tpool.


    LOOP AT it_tpool ASSIGNING <ls_tpool_in>.
      APPEND INITIAL LINE TO rt_tpool ASSIGNING <ls_tpool_out>.
      MOVE-CORRESPONDING <ls_tpool_in> TO <ls_tpool_out>.
      IF <ls_tpool_out>-id = 'S'.
        CONCATENATE <ls_tpool_in>-split <ls_tpool_in>-entry
          INTO <ls_tpool_out>-entry
          RESPECTING BLANKS.
      ENDIF.
    ENDLOOP.

  ENDMETHOD.                    ""read_tpool

  METHOD deserialize_textpool.

    DATA lv_language TYPE langu.

    IF iv_language IS INITIAL.
      lv_language = mv_language.
    ELSE.
      lv_language = iv_language.
    ENDIF.

    READ TABLE it_tpool WITH KEY id = 'R' TRANSPORTING NO FIELDS.
    IF ( sy-subrc = 0 AND lines( it_tpool ) = 1 ) OR lines( it_tpool ) = 0.
      RETURN. "" no action for includes
    ENDIF.

    INSERT TEXTPOOL iv_program
      FROM it_tpool
      LANGUAGE lv_language.
    IF sy-subrc <> 0.
      lcx_exception=>raise( 'error from INSERT TEXTPOOL' ).
    ENDIF.

    IF lv_language = mv_language. "" Add just once
      lcl_objects_activation=>add( iv_type = 'REPT'
                                   iv_name = iv_program ).
    ENDIF.

  ENDMETHOD.                    ""deserialize_textpool

  METHOD deserialize_cua.

    DATA: ls_tr_key TYPE trkey.


    IF lines( is_cua-sta ) = 0
        AND lines( is_cua-fun ) = 0
        AND lines( is_cua-men ) = 0
        AND lines( is_cua-mtx ) = 0
        AND lines( is_cua-act ) = 0
        AND lines( is_cua-but ) = 0
        AND lines( is_cua-pfk ) = 0
        AND lines( is_cua-set ) = 0
        AND lines( is_cua-doc ) = 0
        AND lines( is_cua-tit ) = 0
        AND lines( is_cua-biv ) = 0.
      RETURN.
    ENDIF.

    SELECT SINGLE devclass INTO ls_tr_key-devclass
      FROM tadir
      WHERE pgmid = 'R3TR'
      AND object = ms_item-obj_type
      AND obj_name = ms_item-obj_name.                  ""#EC CI_GENBUFF
    IF sy-subrc <> 0.
      lcx_exception=>raise( 'not found in tadir' ).
    ENDIF.

    ls_tr_key-obj_type = ms_item-obj_type.
    ls_tr_key-obj_name = ms_item-obj_name.
    ls_tr_key-sub_type = 'CUAD'.
    ls_tr_key-sub_name = iv_program_name.

    sy-tcode = 'SE41' ##write_ok. "" evil hack, workaround to handle fixes in note 2159455
    CALL FUNCTION 'RS_CUA_INTERNAL_WRITE'
      EXPORTING
        program   = iv_program_name
        language  = mv_language
        tr_key    = ls_tr_key
        adm       = is_cua-adm
        state     = 'I'
      TABLES
        sta       = is_cua-sta
        fun       = is_cua-fun
        men       = is_cua-men
        mtx       = is_cua-mtx
        act       = is_cua-act
        but       = is_cua-but
        pfk       = is_cua-pfk
        set       = is_cua-set
        doc       = is_cua-doc
        tit       = is_cua-tit
        biv       = is_cua-biv
      EXCEPTIONS
        not_found = 1
        OTHERS    = 2.
    IF sy-subrc <> 0.
      lcx_exception=>raise( 'error from RS_CUA_INTERNAL_WRITE' ).
    ENDIF.

    lcl_objects_activation=>add( iv_type = 'CUAD'
                                 iv_name = iv_program_name ).

  ENDMETHOD.                    ""deserialize_cua

  METHOD check_prog_changed_since.

    DATA: lv_date    TYPE dats,
          lv_time    TYPE tims,
          lv_ts      TYPE timestamp,
          lt_screens TYPE STANDARD TABLE OF d020s,
          lt_eudb    TYPE STANDARD TABLE OF eudb.

    FIELD-SYMBOLS: <ls_screen> LIKE LINE OF lt_screens,
                   <ls_eudb>   LIKE LINE OF lt_eudb.

    SELECT SINGLE udat utime FROM reposrc "" Program
      INTO (lv_date, lv_time)
      WHERE progname = iv_program
      AND   r3state = 'A'.

    _object_check_timestamp lv_date lv_time.

    SELECT SINGLE udat utime FROM repotext "" Program text pool
      INTO (lv_date, lv_time)
      WHERE progname = iv_program
      AND   r3state = 'A'.

    IF sy-subrc = 0. "" Text not found ? Assuming no changes, see #404
      _object_check_timestamp lv_date lv_time.
    ENDIF.

    IF iv_skip_gui = abap_true.
      RETURN.
    ENDIF.

    SELECT dgen tgen FROM d020s           "" Screens
      INTO CORRESPONDING FIELDS OF TABLE lt_screens
      WHERE prog = iv_program ##TOO_MANY_ITAB_FIELDS.

    LOOP AT lt_screens ASSIGNING <ls_screen>.
      _object_check_timestamp <ls_screen>-dgen <ls_screen>-tgen.
    ENDLOOP.

    SELECT vdatum vzeit FROM eudb         "" GUI
      INTO CORRESPONDING FIELDS OF TABLE lt_eudb
      WHERE relid = 'CU'
      AND   name  = iv_program
      AND   srtf2 = 0 ##TOO_MANY_ITAB_FIELDS.

    LOOP AT lt_eudb ASSIGNING <ls_eudb>.
      _object_check_timestamp <ls_eudb>-vdatum <ls_eudb>-vzeit.
    ENDLOOP.

  ENDMETHOD.  ""check_prog_changed_since

ENDCLASS.                    ""lcl_objects_program IMPLEMENTATION

*----------------------------------------------------------------------*
*       CLASS lcl_objects_super IMPLEMENTATION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects_super IMPLEMENTATION.

  METHOD constructor.
    ms_item = is_item.
    ASSERT NOT ms_item IS INITIAL.
    mv_language = iv_language.
    ASSERT NOT mv_language IS INITIAL.
  ENDMETHOD.                    ""constructor

  METHOD jump_se11.

    DATA: lt_bdcdata TYPE TABLE OF bdcdata.

    FIELD-SYMBOLS: <ls_bdcdata> LIKE LINE OF lt_bdcdata.


    APPEND INITIAL LINE TO lt_bdcdata ASSIGNING <ls_bdcdata>.
    <ls_bdcdata>-program  = 'SAPLSD_ENTRY'.
    <ls_bdcdata>-dynpro   = '1000'.
    <ls_bdcdata>-dynbegin = abap_true.

    APPEND INITIAL LINE TO lt_bdcdata ASSIGNING <ls_bdcdata>.
    <ls_bdcdata>-fnam = 'BDC_OKCODE'.
    <ls_bdcdata>-fval = '=WB_DISPLAY'.

    APPEND INITIAL LINE TO lt_bdcdata ASSIGNING <ls_bdcdata>.
    <ls_bdcdata>-fnam = iv_radio.
    <ls_bdcdata>-fval = abap_true.

    APPEND INITIAL LINE TO lt_bdcdata ASSIGNING <ls_bdcdata>.
    <ls_bdcdata>-fnam = iv_field.
    <ls_bdcdata>-fval = ms_item-obj_name.

    CALL FUNCTION 'ABAP4_CALL_TRANSACTION'
      STARTING NEW TASK 'GIT'
      EXPORTING
        tcode                 = 'SE11'
        mode_val              = 'E'
      TABLES
        using_tab             = lt_bdcdata
      EXCEPTIONS
        system_failure        = 1
        communication_failure = 2
        resource_failure      = 3
        OTHERS                = 4
        ##fm_subrc_ok.                                                   ""#EC CI_SUBRC

  ENDMETHOD.                                                ""jump_se11

  METHOD get_metadata.
    rs_metadata-class =
      cl_abap_classdescr=>describe_by_object_ref( me )->get_relative_name( ).
    rs_metadata-version = 'v1.0.0' ##no_text.
  ENDMETHOD.                    ""get_metadata

  METHOD tadir_insert.

    CALL FUNCTION 'TR_TADIR_INTERFACE'
      EXPORTING
        wi_test_modus       = abap_false
        wi_tadir_pgmid      = 'R3TR'
        wi_tadir_object     = ms_item-obj_type
        wi_tadir_obj_name   = ms_item-obj_name
        wi_tadir_author     = sy-uname
        wi_tadir_devclass   = iv_package
        wi_tadir_masterlang = mv_language
      EXCEPTIONS
        OTHERS              = 1.
    IF sy-subrc <> 0.
      lcx_exception=>raise( 'error from TR_TADIR_INTERFACE' ).
    ENDIF.

  ENDMETHOD.

  METHOD corr_insert.

    DATA: ls_object TYPE ddenqs.


    ls_object-objtype = ms_item-obj_type.
    ls_object-objname = ms_item-obj_name.

    CALL FUNCTION 'RS_CORR_INSERT'
      EXPORTING
        object              = ls_object
        object_class        = 'DICT'
        devclass            = iv_package
        master_language     = mv_language
        mode                = 'INSERT'
      EXCEPTIONS
        cancelled           = 1
        permission_failure  = 2
        unknown_objectclass = 3
        OTHERS              = 4.
    IF sy-subrc = 1.
      lcx_exception=>raise( 'Cancelled' ).
    ELSEIF sy-subrc <> 0.
      lcx_exception=>raise( 'error from RS_CORR_INSERT' ).
    ENDIF.

  ENDMETHOD.                    ""corr_insert

ENDCLASS.                    ""lcl_objects_super IMPLEMENTATION

*----------------------------------------------------------------------*
*       CLASS lcl_object DEFINITION
*----------------------------------------------------------------------*
*
*----------------------------------------------------------------------*
CLASS lcl_objects DEFINITION FINAL.

  PUBLIC SECTION.
    TYPES: ty_types_tt TYPE STANDARD TABLE OF tadir-object WITH DEFAULT KEY.

    TYPES: BEGIN OF ty_deserialization,
             obj     TYPE REF TO lif_object,
             xml     TYPE REF TO lcl_xml_input,
             package TYPE devclass,
             item    TYPE ty_item,
           END OF ty_deserialization.

    TYPES: ty_deserialization_tt TYPE STANDARD TABLE OF ty_deserialization WITH DEFAULT KEY.

    CLASS-METHODS serialize
      IMPORTING is_item         TYPE ty_item
                iv_language     TYPE spras
                io_log          TYPE REF TO lcl_log OPTIONAL
      RETURNING VALUE(rt_files) TYPE ty_files_tt
      RAISING   lcx_exception.

    CLASS-METHODS deserialize
      IMPORTING io_repo                  TYPE REF TO lcl_repo
      RETURNING VALUE(rt_accessed_files) TYPE ty_file_signatures_tt
      RAISING   lcx_exception.

    CLASS-METHODS delete
      IMPORTING it_tadir TYPE ty_tadir_tt
      RAISING   lcx_exception.

    CLASS-METHODS jump
      IMPORTING is_item TYPE ty_item
      RAISING   lcx_exception.

    CLASS-METHODS changed_by
      IMPORTING is_item        TYPE ty_item
      RETURNING VALUE(rv_user) TYPE xubname
      RAISING   lcx_exception.

    CLASS-METHODS has_changed_since
      IMPORTING is_item           TYPE ty_item
                iv_timestamp      TYPE timestamp
      RETURNING VALUE(rv_changed) TYPE abap_bool
      RAISING   lcx_exception.

    CLASS-METHODS is_supported
      IMPORTING is_item        TYPE ty_item
                iv_native_only TYPE abap_bool DEFAULT abap_false
      RETURNING VALUE(rv_bool) TYPE abap_bool.

    CLASS-METHODS exists
      IMPORTING is_item        TYPE ty_item
      RETURNING VALUE(rv_bool) TYPE abap_bool.

    CLASS-METHODS supported_list
      RETURNING VALUE(rt_types) TYPE ty_types_tt.

  PRIVATE SECTION.

    CLASS-DATA: mv_langs_installed TYPE scplangs.

    CLASS-METHODS check_duplicates
      IMPORTING it_files TYPE ty_files_tt
      RAISING   lcx_exception.

    CLASS-METHODS create_object
      IMPORTING is_item        TYPE ty_item
                iv_language    TYPE spras
                is_metadata    TYPE ty_metadata OPTIONAL
                iv_native_only TYPE abap_bool DEFAULT abap_false
      RETURNING VALUE(ri_obj)  TYPE REF TO lif_object
      RAISING   lcx_exception.

    CLASS-METHODS
      prioritize_deser
        IMPORTING it_results        TYPE ty_results_tt
        RETURNING VALUE(rt_results) TYPE ty_results_tt.

    CLASS-METHODS class_name
      IMPORTING is_item              TYPE ty_item
      RETURNING VALUE(rv_class_name) TYPE string.

    CLASS-METHODS resolve_ddic
      CHANGING ct_tadir TYPE ty_tadir_tt
      RAISING  lcx_exception.

    CLASS-METHODS warning_overwrite
      CHANGING ct_results TYPE ty_results_tt
      RAISING  lcx_exception.

    CLASS-METHODS warning_package
      IMPORTING is_item          TYPE ty_item
                iv_package       TYPE devclass
      RETURNING VALUE(rv_cancel) TYPE abap_bool
      RAISING   lcx_exception.

    CLASS-METHODS update_package_tree
      IMPORTING iv_package TYPE devclass.

    CLASS-METHODS delete_obj
      IMPORTING is_item TYPE ty_item
      RAISING   lcx_exception.

    CLASS-METHODS compare_remote_to_local
      IMPORTING
        io_object TYPE REF TO lif_object
        it_remote TYPE ty_files_tt
        is_result TYPE ty_result
      RAISING
        lcx_exception.

    CLASS-METHODS deserialize_objects
      IMPORTING it_objects TYPE ty_deserialization_tt
                iv_ddic    TYPE abap_bool DEFAULT abap_false
                iv_descr   TYPE string
      CHANGING  ct_files   TYPE ty_file_signatures_tt
      RAISING   lcx_exception.

ENDCLASS.                    ""lcl_object DEFINITION
",13246,True,2735.916372326492,median
"== Video Options

=== Composite Video Mode

==== `sdtv_mode`

The `sdtv_mode` command defines the TV standard used for composite video output. On the original Raspberry Pi, composite video is output on the RCA socket. On other Raspberry Pi's, except for Pi Zero and Compute Module, composite video is output along with sound on the 4 pole TRRS (""headphone"") socket. On the Pi Zero, there is an unpopulated header labelled ""TV"" which outputs composite video. On the Compute Module, composite video is available via the TVDAC pin. The default value of `sdtv_mode` is `0`.

|===
| sdtv_mode | result

| 0
| Normal NTSC

| 1
| Japanese version of NTSC -- no pedestal

| 2
| Normal PAL

| 3
| Brazilian version of PAL -- 525/60 rather than 625/50, different subcarrier

| 16
| Progressive scan NTSC

| 18
| Progressive scan PAL
|===

==== `sdtv_aspect`

The `sdtv_aspect` command defines the aspect ratio for composite video output. The default value is `1`.

|===
| sdtv_aspect | result

| 1
| 4:3

| 2
| 14:9

| 3
| 16:9
|===

==== `sdtv_disable_colourburst`

Setting `sdtv_disable_colourburst` to `1` disables colourburst on composite video output. The picture will be displayed in monochrome, but it may appear sharper.

==== `enable_tvout` (Raspberry Pi 4, Model B Only)

On the Raspberry Pi 4, composite output is disabled by default, due to the way the internal clocks are interrelated and allocated. Because composite video requires a very specific clock, setting that clock to the required speed on the Pi 4 means that other clocks connected to it are detrimentally affected, which slightly slows down the entire system. Since composite video is a less commonly used function, we decided to disable it by default to prevent this system slowdown.

To enable composite output, use the `enable_tvout=1` option. As described above, this will detrimentally affect performance to a small degree.

On older Pi models, the composite behaviour remains the same.

=== HDMI Mode

NOTE: Because the Raspberry Pi 4B has two HDMI ports, some HDMI commands can be applied to either port. You can use the syntax `<command>:<port>`, where port is 0 or 1, to specify which port the setting should apply to. If no port is specified, the default is 0. If you specify a port number on a command that does not require a port number, the port is ignored. Further details on the syntax and alternatives mechanisms can be found in the HDMI sub-section of the xref:config_txt.adoc#conditional-filters[conditionals section] of the documentation.

In order to support dual 4k displays, the Raspberry Pi 4 has xref:config_txt.adoc#raspberry-pi-4-hdmi-pipeline[updated video hardware], which imposes minor restrictions on the modes supported.

==== `hdmi_safe`

Setting `hdmi_safe` to `1` will lead to ""safe mode"" settings being used to try to boot with maximum HDMI compatibility. This is the same as setting the following parameters:

----
hdmi_force_hotplug=1
hdmi_ignore_edid=0xa5000080
config_hdmi_boost=4
hdmi_group=2
hdmi_mode=4
disable_overscan=0
overscan_left=24
overscan_right=24
overscan_top=24
overscan_bottom=24
----

==== `hdmi_ignore_edid`

Setting `hdmi_ignore_edid` to `0xa5000080` enables the ignoring of EDID/display data if your display does not have an accurate https://en.wikipedia.org/wiki/Extended_display_identification_data[EDID]. It requires this unusual value to ensure that it is not triggered accidentally.

==== `hdmi_edid_file`

Setting `hdmi_edid_file` to `1` will cause the GPU to read EDID data from the `edid.dat` file, located in the boot partition, instead of reading it from the monitor. More information is available https://forums.raspberrypi.com/viewtopic.php?p=173430#p173430[on the forums].

==== `hdmi_edid_filename`

On the Raspberry Pi 4B, you can use the `hdmi_edid_filename` command to specify the filename of the EDID file to use, and also to specify which port the file is to be applied to. This also requires `hdmi_edid_file=1` to enable EDID files.

For example:

----
hdmi_edid_file=1
hdmi_edid_filename:0=FileForPortZero.edid
hdmi_edid_filename:1=FileForPortOne.edid
----

==== `hdmi_force_edid_audio`

Setting `hdmi_force_edid_audio` to `1` pretends that all audio formats are supported by the display, allowing passthrough of DTS/AC3 even when this is not reported as supported.

==== `hdmi_ignore_edid_audio`

Setting `hdmi_ignore_edid_audio` to `1` pretends that all audio formats are unsupported by the display. This means ALSA will default to the analogue audio (headphone) jack.

==== `hdmi_force_edid_3d`

Setting `hdmi_force_edid_3d` to `1` pretends that all CEA modes support 3D, even when the EDID does not indicate support for this.

==== `hdmi_ignore_cec_init`

Setting `hdmi_ignore_cec_init` to `1` will stop the initial active source message being sent during bootup. This prevents a CEC-enabled TV from coming out of standby and channel-switching when you are rebooting your Raspberry Pi.

==== `hdmi_ignore_cec`

Setting `hdmi_ignore_cec` to `1` pretends that https://en.wikipedia.org/wiki/Consumer_Electronics_Control#CEC[CEC] is not supported at all by the TV. No CEC functions will be supported.

==== `cec_osd_name`

The `cec_osd_name` command sets the initial CEC name of the device. The default is Raspberry Pi.

==== `hdmi_pixel_encoding`

The `hdmi_pixel_encoding` command forces the pixel encoding mode. By default, it will use the mode requested from the EDID, so you shouldn't need to change it.

|===
| hdmi_pixel_encoding | result

| 0
| default (RGB limited for CEA, RGB full for DMT)

| 1
| RGB limited (16-235)

| 2
| RGB full (0-255)

| 3
| YCbCr limited (16-235)

| 4
| YCbCr full (0-255)
|===

==== `hdmi_max_pixel_freq`

The pixel frequency is used by the firmware and KMS to filter HDMI modes. Note, this is not the same as the frame rate. It specifies the maximum frequency that a valid mode can have, thereby culling out higher frequency modes. So for example, if you wish to disable all 4K modes, you could specify a maximum frequency of 200000000, since all 4K modes have frequencies greater than this.

==== `hdmi_blanking`

The `hdmi_blanking` command controls what happens when the operating system asks for the display to be put into standby mode, using DPMS, to save power. If this option is not set or set to 0, the HDMI output is blanked but not switched off. In order to mimic the behaviour of other computers, you can set the HDMI output to switch off as well by setting this option to 1: the attached display will go into a low power standby mode.

NOTE: On the Raspberry Pi 4, setting `hdmi_blanking=1` will not cause the HDMI output to be switched off, since this feature has not yet been implemented. This feature may cause issues when using applications which don't use the framebuffer, such as `omxplayer`.

|===
| hdmi_blanking | result

| 0
| HDMI output will be blanked

| 1
| HDMI output will be switched off and blanked
|===

==== `hdmi_drive`

The `hdmi_drive` command allows you to choose between HDMI and DVI output modes.

|===
| hdmi_drive | result

| 1
| Normal DVI mode (no sound)

| 2
| Normal HDMI mode (sound will be sent if supported and enabled)
|===

==== `config_hdmi_boost`

Configures the signal strength of the HDMI interface. The minimum value is `0` and the maximum is `11`.

The default value for the original Model B and A is `2`. The default value for the Model B+ and all later models is `5`.

If you are seeing HDMI issues (speckling, interference) then try `7`. Very long HDMI cables may need up to `11`, but values this high should not be used unless absolutely necessary.

This option is ignored on the Raspberry Pi 4.

==== `hdmi_group`

The `hdmi_group` command defines the HDMI output group to be either CEA (Consumer Electronics Association, the standard typically used by TVs) or DMT (Display Monitor Timings, the standard typically used by monitors). This setting should be used in conjunction with `hdmi_mode`.

|===
| hdmi_group | result

| 0
| Auto-detect from EDID

| 1
| CEA

| 2
| DMT
|===

==== `hdmi_mode`

Together with `hdmi_group`, `hdmi_mode` defines the HDMI output format. Format mode numbers are derived from the https://web.archive.org/web/20171201033424/https://standards.cta.tech/kwspub/published_docs/CTA-861-G_FINAL_revised_2017.pdf[CTA specification].

To set a custom display mode not listed here, see more information on https://forums.raspberrypi.com/viewtopic.php?f=29&t=24679[the forums].

NOTE: Not all modes are available on all models.

These values are valid if `hdmi_group=1` (CEA):

[cols="",,,^,""]
|===
| hdmi_mode | Resolution | Frequency | Screen Aspect | Notes

| 1
| VGA (640x480)
| 60Hz
| 4:3
|

| 2
| 480p
| 60Hz
| 4:3
|

| 3
| 480p
| 60Hz
| 16:9
|

| 4
| 720p
| 60Hz
| 16:9
|

| 5
| 1080i
| 60Hz
| 16:9
|

| 6
| 480i
| 60Hz
| 4:3
|

| 7
| 480i
| 60Hz
| 16:9
|

| 8
| 240p
| 60Hz
| 4:3
|

| 9
| 240p
| 60Hz
| 16:9
|

| 10
| 480i
| 60Hz
| 4:3
| pixel quadrupling

| 11
| 480i
| 60Hz
| 16:9
| pixel quadrupling

| 12
| 240p
| 60Hz
| 4:3
| pixel quadrupling

| 13
| 240p
| 60Hz
| 16:9
| pixel quadrupling

| 14
| 480p
| 60Hz
| 4:3
| pixel doubling

| 15
| 480p
| 60Hz
| 16:9
| pixel doubling

| 16
| 1080p
| 60Hz
| 16:9
|

| 17
| 576p
| 50Hz
| 4:3
|

| 18
| 576p
| 50Hz
| 16:9
|

| 19
| 720p
| 50Hz
| 16:9
|

| 20
| 1080i
| 50Hz
| 16:9
|

| 21
| 576i
| 50Hz
| 4:3
|

| 22
| 576i
| 50Hz
| 16:9
|

| 23
| 288p
| 50Hz
| 4:3
|

| 24
| 288p
| 50Hz
| 16:9
|

| 25
| 576i
| 50Hz
| 4:3
| pixel quadrupling

| 26
| 576i
| 50Hz
| 16:9
| pixel quadrupling

| 27
| 288p
| 50Hz
| 4:3
| pixel quadrupling

| 28
| 288p
| 50Hz
| 16:9
| pixel quadrupling

| 29
| 576p
| 50Hz
| 4:3
| pixel doubling

| 30
| 576p
| 50Hz
| 16:9
| pixel doubling

| 31
| 1080p
| 50Hz
| 16:9
|

| 32
| 1080p
| 24Hz
| 16:9
|

| 33
| 1080p
| 25Hz
| 16:9
|

| 34
| 1080p
| 30Hz
| 16:9
|

| 35
| 480p
| 60Hz
| 4:3
| pixel quadrupling

| 36
| 480p
| 60Hz
| 16:9
| pixel quadrupling

| 37
| 576p
| 50Hz
| 4:3
| pixel quadrupling

| 38
| 576p
| 50Hz
| 16:9
| pixel quadrupling

| 39
| 1080i
| 50Hz
| 16:9
| reduced blanking

| 40
| 1080i
| 100Hz
| 16:9
|

| 41
| 720p
| 100Hz
| 16:9
|

| 42
| 576p
| 100Hz
| 4:3
|

| 43
| 576p
| 100Hz
| 16:9
|

| 44
| 576i
| 100Hz
| 4:3
|

| 45
| 576i
| 100Hz
| 16:9
|

| 46
| 1080i
| 120Hz
| 16:9
|

| 47
| 720p
| 120Hz
| 16:9
|

| 48
| 480p
| 120Hz
| 4:3
|

| 49
| 480p
| 120Hz
| 16:9
|

| 50
| 480i
| 120Hz
| 4:3
|

| 51
| 480i
| 120Hz
| 16:9
|

| 52
| 576p
| 200Hz
| 4:3
|

| 53
| 576p
| 200Hz
| 16:9
|

| 54
| 576i
| 200Hz
| 4:3
|

| 55
| 576i
| 200Hz
| 16:9
|

| 56
| 480p
| 240Hz
| 4:3
|

| 57
| 480p
| 240Hz
| 16:9
|

| 58
| 480i
| 240Hz
| 4:3
|

| 59
| 480i
| 240Hz
| 16:9
|

| 60
| 720p
| 24Hz
| 16:9
|

| 61
| 720p
| 25Hz
| 16:9
|

| 62
| 720p
| 30Hz
| 16:9
|

| 63
| 1080p
| 120Hz
| 16:9
|

| 64
| 1080p
| 100Hz
| 16:9
|

| 65
| Custom
|
|
|

| 66
| 720p
| 25Hz
| 64:27
| Pi 4

| 67
| 720p
| 30Hz
| 64:27
| Pi 4

| 68
| 720p
| 50Hz
| 64:27
| Pi 4

| 69
| 720p
| 60Hz
| 64:27
| Pi 4

| 70
| 720p
| 100Hz
| 64:27
| Pi 4

| 71
| 720p
| 120Hz
| 64:27
| Pi 4

| 72
| 1080p
| 24Hz
| 64:27
| Pi 4

| 73
| 1080p
| 25Hz
| 64:27
| Pi 4

| 74
| 1080p
| 30Hz
| 64:27
| Pi 4

| 75
| 1080p
| 50Hz
| 64:27
| Pi 4

| 76
| 1080p
| 60Hz
| 64:27
| Pi 4

| 77
| 1080p
| 100Hz
| 64:27
| Pi 4

| 78
| 1080p
| 120Hz
| 64:27
| Pi 4

| 79
| 1680x720
| 24Hz
| 64:27
| Pi 4

| 80
| 1680x720
| 25z
| 64:27
| Pi 4

| 81
| 1680x720
| 30Hz
| 64:27
| Pi 4

| 82
| 1680x720
| 50Hz
| 64:27
| Pi 4

| 83
| 1680x720
| 60Hz
| 64:27
| Pi 4

| 84
| 1680x720
| 100Hz
| 64:27
| Pi 4

| 85
| 1680x720
| 120Hz
| 64:27
| Pi 4

| 86
| 2560x720
| 24Hz
| 64:27
| Pi 4

| 87
| 2560x720
| 25Hz
| 64:27
| Pi 4

| 88
| 2560x720
| 30Hz
| 64:27
| Pi 4

| 89
| 2560x720
| 50Hz
| 64:27
| Pi 4

| 90
| 2560x720
| 60Hz
| 64:27
| Pi 4

| 91
| 2560x720
| 100Hz
| 64:27
| Pi 4

| 92
| 2560x720
| 120Hz
| 64:27
| Pi 4

| 93
| 2160p
| 24Hz
| 16:9
| Pi 4

| 94
| 2160p
| 25Hz
| 16:9
| Pi 4

| 95
| 2160p
| 30Hz
| 16:9
| Pi 4

| 96
| 2160p
| 50Hz
| 16:9
| Pi 4

| 97
| 2160p
| 60Hz
| 16:9
| Pi 4

| 98
| 4096x2160
| 24Hz
| 256:135
| Pi 4

| 99
| 4096x2160
| 25Hz
| 256:135
| Pi 4

| 100
| 4096x2160
| 30Hz
| 256:135
| Pi 4

| 101
| 4096x2160
| 50Hz
| 256:135
| Pi 4

| 102
| 4096x2160
| 60Hz
| 256:135
| Pi 4

| 103
| 2160p
| 24Hz
| 64:27
| Pi 4

| 104
| 2160p
| 25Hz
| 64:27
| Pi 4

| 105
| 2160p
| 30Hz
| 64:27
| Pi 4

| 106
| 2160p
| 50Hz
| 64:27
| Pi 4

| 107
| 2160p
| 60Hz
| 64:27
| Pi 4
|===

Pixel doubling and quadrupling indicates a higher clock rate, with each pixel repeated two or four times respectively.

These values are valid if `hdmi_group=2` (DMT):

[cols="",,,^,""]
|===
| hdmi_mode | Resolution | Frequency | Screen Aspect | Notes

| 1
| 640x350
| 85Hz
|
|

| 2
| 640x400
| 85Hz
| 16:10
|

| 3
| 720x400
| 85Hz
|
|

| 4
| 640x480
| 60Hz
| 4:3
|

| 5
| 640x480
| 72Hz
| 4:3
|

| 6
| 640x480
| 75Hz
| 4:3
|

| 7
| 640x480
| 85Hz
| 4:3
|

| 8
| 800x600
| 56Hz
| 4:3
|

| 9
| 800x600
| 60Hz
| 4:3
|

| 10
| 800x600
| 72Hz
| 4:3
|

| 11
| 800x600
| 75Hz
| 4:3
|

| 12
| 800x600
| 85Hz
| 4:3
|

| 13
| 800x600
| 120Hz
| 4:3
|

| 14
| 848x480
| 60Hz
| 16:9
|

| 15
| 1024x768
| 43Hz
| 4:3
| incompatible with the Raspberry Pi

| 16
| 1024x768
| 60Hz
| 4:3
|

| 17
| 1024x768
| 70Hz
| 4:3
|

| 18
| 1024x768
| 75Hz
| 4:3
|

| 19
| 1024x768
| 85Hz
| 4:3
|

| 20
| 1024x768
| 120Hz
| 4:3
|

| 21
| 1152x864
| 75Hz
| 4:3
|

| 22
| 1280x768
| 60Hz
| 15:9
| reduced blanking

| 23
| 1280x768
| 60Hz
| 15:9
|

| 24
| 1280x768
| 75Hz
| 15:9
|

| 25
| 1280x768
| 85Hz
| 15:9
|

| 26
| 1280x768
| 120Hz
| 15:9
| reduced blanking

| 27
| 1280x800
| 60
| 16:10
| reduced blanking

| 28
| 1280x800
| 60Hz
| 16:10
|

| 29
| 1280x800
| 75Hz
| 16:10
|

| 30
| 1280x800
| 85Hz
| 16:10
|

| 31
| 1280x800
| 120Hz
| 16:10
| reduced blanking

| 32
| 1280x960
| 60Hz
| 4:3
|

| 33
| 1280x960
| 85Hz
| 4:3
|

| 34
| 1280x960
| 120Hz
| 4:3
| reduced blanking

| 35
| 1280x1024
| 60Hz
| 5:4
|

| 36
| 1280x1024
| 75Hz
| 5:4
|

| 37
| 1280x1024
| 85Hz
| 5:4
|

| 38
| 1280x1024
| 120Hz
| 5:4
| reduced blanking

| 39
| 1360x768
| 60Hz
| 16:9
|

| 40
| 1360x768
| 120Hz
| 16:9
| reduced blanking

| 41
| 1400x1050
| 60Hz
| 4:3
| reduced blanking

| 42
| 1400x1050
| 60Hz
| 4:3
|

| 43
| 1400x1050
| 75Hz
| 4:3
|

| 44
| 1400x1050
| 85Hz
| 4:3
|

| 45
| 1400x1050
| 120Hz
| 4:3
| reduced blanking

| 46
| 1440x900
| 60Hz
| 16:10
| reduced blanking

| 47
| 1440x900
| 60Hz
| 16:10
|

| 48
| 1440x900
| 75Hz
| 16:10
|

| 49
| 1440x900
| 85Hz
| 16:10
|

| 50
| 1440x900
| 120Hz
| 16:10
| reduced blanking

| 51
| 1600x1200
| 60Hz
| 4:3
|

| 52
| 1600x1200
| 65Hz
| 4:3
|

| 53
| 1600x1200
| 70Hz
| 4:3
|

| 54
| 1600x1200
| 75Hz
| 4:3
|

| 55
| 1600x1200
| 85Hz
| 4:3
|

| 56
| 1600x1200
| 120Hz
| 4:3
| reduced blanking

| 57
| 1680x1050
| 60Hz
| 16:10
| reduced blanking

| 58
| 1680x1050
| 60Hz
| 16:10
|

| 59
| 1680x1050
| 75Hz
| 16:10
|

| 60
| 1680x1050
| 85Hz
| 16:10
|

| 61
| 1680x1050
| 120Hz
| 16:10
| reduced blanking

| 62
| 1792x1344
| 60Hz
| 4:3
|

| 63
| 1792x1344
| 75Hz
| 4:3
|

| 64
| 1792x1344
| 120Hz
| 4:3
| reduced blanking

| 65
| 1856x1392
| 60Hz
| 4:3
|

| 66
| 1856x1392
| 75Hz
| 4:3
|

| 67
| 1856x1392
| 120Hz
| 4:3
| reduced blanking

| 68
| 1920x1200
| 60Hz
| 16:10
| reduced blanking

| 69
| 1920x1200
| 60Hz
| 16:10
|

| 70
| 1920x1200
| 75Hz
| 16:10
|

| 71
| 1920x1200
| 85Hz
| 16:10
|

| 72
| 1920x1200
| 120Hz
| 16:10
| reduced blanking

| 73
| 1920x1440
| 60Hz
| 4:3
|

| 74
| 1920x1440
| 75Hz
| 4:3
|

| 75
| 1920x1440
| 120Hz
| 4:3
| reduced blanking

| 76
| 2560x1600
| 60Hz
| 16:10
| reduced blanking

| 77
| 2560x1600
| 60Hz
| 16:10
|

| 78
| 2560x1600
| 75Hz
| 16:10
|

| 79
| 2560x1600
| 85Hz
| 16:10
|

| 80
| 2560x1600
| 120Hz
| 16:10
| reduced blanking

| 81
| 1366x768
| 60Hz
| 16:9
| xref:config_txt.adoc#raspberry-pi-4-hdmi-pipeline[NOT on Raspberry Pi 4]

| 82
| 1920x1080
| 60Hz
| 16:9
| 1080p

| 83
| 1600x900
| 60Hz
| 16:9
| reduced blanking

| 84
| 2048x1152
| 60Hz
| 16:9
| reduced blanking

| 85
| 1280x720
| 60Hz
| 16:9
| 720p

| 86
| 1366x768
| 60Hz
| 16:9
| reduced blanking
|===

NOTE: There is a https://forums.raspberrypi.com/viewtopic.php?f=26&t=20155&p=195443#p195443[pixel clock limit]. The highest supported mode on models prior to the Raspberry Pi 4 is 1920x1200 at 60Hz with reduced blanking, whilst the Raspberry Pi 4 can support up to 4096x2160 (known as 4k) at 60Hz. Also note that if you are using both HDMI ports of the Raspberry Pi 4 for 4k output, then you are limited to 30Hz on both.

==== `hdmi_timings`

This allows setting of raw HDMI timing values for a custom mode, selected using `hdmi_group=2` and `hdmi_mode=87`.

[source]
----
hdmi_timings=<h_active_pixels> <h_sync_polarity> <h_front_porch> <h_sync_pulse> <h_back_porch> <v_active_lines> <v_sync_polarity> <v_front_porch> <v_sync_pulse> <v_back_porch> <v_sync_offset_a> <v_sync_offset_b> <pixel_rep> <frame_rate> <interlaced> <pixel_freq> <aspect_ratio>
----

[source]
----
<h_active_pixels> = horizontal pixels (width)
<h_sync_polarity> = invert hsync polarity
<h_front_porch>   = horizontal forward padding from DE active edge
<h_sync_pulse>    = hsync pulse width in pixel clocks
<h_back_porch>    = vertical back padding from DE active edge
<v_active_lines>  = vertical pixels height (lines)
<v_sync_polarity> = invert vsync polarity
<v_front_porch>   = vertical forward padding from DE active edge
<v_sync_pulse>    = vsync pulse width in pixel clocks
<v_back_porch>    = vertical back padding from DE active edge
<v_sync_offset_a> = leave at zero
<v_sync_offset_b> = leave at zero
<pixel_rep>       = leave at zero
<frame_rate>      = screen refresh rate in Hz
<interlaced>      = leave at zero
<pixel_freq>      = clock frequency (width*height*framerate)
<aspect_ratio>    = *
----

`*` The aspect ratio can be set to one of eight values (choose the closest for your screen):

[source]
----
HDMI_ASPECT_4_3 = 1
HDMI_ASPECT_14_9 = 2
HDMI_ASPECT_16_9 = 3
HDMI_ASPECT_5_4 = 4
HDMI_ASPECT_16_10 = 5
HDMI_ASPECT_15_9 = 6
HDMI_ASPECT_21_9 = 7
HDMI_ASPECT_64_27 = 8
----

==== `hdmi_force_mode`

Setting to `1` will remove all other modes except the ones specified by `hdmi_mode` and `hdmi_group` from the internal list, meaning they will not appear in any enumerated lists of modes. This option may help if a display seems to be ignoring the `hdmi_mode` and `hdmi_group` settings.

==== `edid_content_type`

Forces the EDID content type to a specific value.

The options are:

* `0` = `EDID_ContentType_NODATA`, content type none.
* `1` = `EDID_ContentType_Graphics`, content type graphics, ITC must be set to 1
* `2` = `EDID_ContentType_Photo`, content type photo
* `3` = `EDID_ContentType_Cinema`,  content type cinema
* `4` = `EDID_ContentType_Game`,  content type game

=== Which Values are Valid for my Monitor?

Your HDMI monitor may only support a limited set of formats. To find out which formats are supported, use the following method:

. Set the output format to VGA 60Hz (`hdmi_group=1` and `hdmi_mode=1`) and boot up your Raspberry Pi
. Enter the following command to give a list of CEA-supported modes: `/opt/vc/bin/tvservice -m CEA`
. Enter the following command to give a list of DMT-supported modes: `/opt/vc/bin/tvservice -m DMT`
. Enter the following command to show your current state: `/opt/vc/bin/tvservice -s`
. Enter the following commands to dump more detailed information from your monitor: `/opt/vc/bin/tvservice -d edid.dat; /opt/vc/bin/edidparser edid.dat`

The `edid.dat` should also be provided when troubleshooting problems with the default HDMI mode.

[[custom-mode]]
=== Custom Mode

If your monitor requires a mode that is not in one of the tables above, then it's possible to define a custom CVT mode for it instead:

[source]
----
hdmi_cvt=<width> <height> <framerate> <aspect> <margins> <interlace> <rb>
----

|===
| Value | Default | Description

| width
| (required)
| width in pixels

| height
| (required)
| height in pixels

| framerate
| (required)
| framerate in Hz

| aspect
| 3
| aspect ratio 1=4:3, 2=14:9, 3=16:9, 4=5:4, 5=16:10, 6=15:9

| margins
| 0
| 0=margins disabled, 1=margins enabled

| interlace
| 0
| 0=progressive, 1=interlaced

| rb
| 0
| 0=normal, 1=reduced blanking
|===

Fields at the end can be omitted to use the default values.

Note that this simply *creates* the mode (group 2 mode 87). In order to make the Pi use this by default, you must add some additional settings. For example, the following selects an 800 × 480 resolution and enables audio drive:

----
hdmi_cvt=800 480 60 6
hdmi_group=2
hdmi_mode=87
hdmi_drive=2
----

This may not work if your monitor does not support standard CVT timings.

=== LCD Displays and Touchscreens

==== `ignore_lcd`

By default the Raspberry Pi LCD display is used when it is detected on the I2C bus. `ignore_lcd=1` will skip this detection phase, and therefore the LCD display will not be used.

==== `display_default_lcd`

If a Raspberry Pi DSI LCD is detected it will be used as the default display and will show the framebuffer. Setting `display_default_lcd=0` will ensure the LCD is not the default display, which usually implies the HDMI output will be the default. The LCD can still be used by choosing its display number from supported applications, for example, omxplayer.

==== `lcd_framerate`

Specify the framerate of the Raspberry Pi LCD display, in Hertz/fps. Defaults to 60Hz.

==== `lcd_rotate`

This flips the display using the LCD's inbuilt flip functionality, which is a cheaper operation that using the GPU-based rotate operation.

For example, `lcd_rotate=2` will compensate for an upside down display.

==== `disable_touchscreen`

Enable/disable the touchscreen.

`disable_touchscreen=1` will disable the touchscreen on the official Raspberry Pi LCD display.

==== `enable_dpi_lcd`

Enable LCD displays attached to the DPI GPIOs. This is to allow the use of third-party LCD displays using the parallel display interface.

==== `dpi_group`, `dpi_mode`, `dpi_output_format`

The `dpi_group` and `dpi_mode` `config.txt` parameters are used to set either predetermined modes (DMT or CEA modes as used by HDMI above). A user can generate custom modes in much the same way as for HDMI (see `dpi_timings` section).

`dpi_output_format` is a bitmask specifying various parameters used to set up the display format.

==== `dpi_timings`

This allows setting of raw DPI timing values for a custom mode, selected using `dpi_group=2` and `dpi_mode=87`.

[source]
----
dpi_timings=<h_active_pixels> <h_sync_polarity> <h_front_porch> <h_sync_pulse> <h_back_porch> <v_active_lines> <v_sync_polarity> <v_front_porch> <v_sync_pulse> <v_back_porch> <v_sync_offset_a> <v_sync_offset_b> <pixel_rep> <frame_rate> <interlaced> <pixel_freq> <aspect_ratio>
----

[source]
----
<h_active_pixels> = horizontal pixels (width)
<h_sync_polarity> = invert hsync polarity
<h_front_porch>   = horizontal forward padding from DE active edge
<h_sync_pulse>    = hsync pulse width in pixel clocks
<h_back_porch>    = vertical back padding from DE active edge
<v_active_lines>  = vertical pixels height (lines)
<v_sync_polarity> = invert vsync polarity
<v_front_porch>   = vertical forward padding from DE active edge
<v_sync_pulse>    = vsync pulse width in pixel clocks
<v_back_porch>    = vertical back padding from DE active edge
<v_sync_offset_a> = leave at zero
<v_sync_offset_b> = leave at zero
<pixel_rep>       = leave at zero
<frame_rate>      = screen refresh rate in Hz
<interlaced>      = leave at zero
<pixel_freq>      = clock frequency (width*height*framerate)
<aspect_ratio>    = *
----

`*` The aspect ratio can be set to one of eight values (choose the closest for your screen):

----
HDMI_ASPECT_4_3 = 1
HDMI_ASPECT_14_9 = 2
HDMI_ASPECT_16_9 = 3
HDMI_ASPECT_5_4 = 4
HDMI_ASPECT_16_10 = 5
HDMI_ASPECT_15_9 = 6
HDMI_ASPECT_21_9 = 7
HDMI_ASPECT_64_27 = 8
----

=== Generic Display Options

==== `hdmi_force_hotplug`

Setting `hdmi_force_hotplug` to `1` pretends that the HDMI hotplug signal is asserted, so it appears that a HDMI display is attached. In other words, HDMI output mode will be used, even if no HDMI monitor is detected.

==== `hdmi_ignore_hotplug`

Setting `hdmi_ignore_hotplug` to `1` pretends that the HDMI hotplug signal is not asserted, so it appears that a HDMI display is not attached. In other words, composite output mode will be used, even if an HDMI monitor is detected.

==== `overscan_left`

The `overscan_left` command specifies the number of pixels to add to the firmware default value of overscan on the left edge of the screen. The default value is `0`.

Increase this value if the text flows off the left edge of the screen; decrease it if there is a black border between the left edge of the screen and the text.

==== `overscan_right`

The `overscan_right` command specifies the number of pixels to add to the firmware default value of overscan on the right edge of the screen. The default value is `0`.

Increase this value if the text flows off the right edge of the screen; decrease it if there is a black border between the right edge of the screen and the text.

==== `overscan_top`

The `overscan_top` command specifies the number of pixels to add to the firmware default value of overscan on the top edge of the screen. The default value is `0`.

Increase this value if the text flows off the top edge of the screen; decrease it if there is a black border between the top edge of the screen and the text.

==== `overscan_bottom`

The `overscan_bottom` command specifies the number of pixels to add to the firmware default value of overscan on the bottom edge of the screen. The default value is `0`.

Increase this value if the text flows off the bottom edge of the screen; decrease it if there is a black border between the bottom edge of the screen and the text.

==== `overscan_scale`

Set `overscan_scale` to `1` to force any non-framebuffer layers to conform to the overscan settings. The default value is `0`.

*NOTE:* this feature is generally not recommended: it can reduce image quality because all layers on the display will be scaled by the GPU. Disabling overscan on the display itself is the recommended option to avoid images being scaled twice (by the GPU and the display).

==== `framebuffer_width`

The `framebuffer_width` command specifies the console framebuffer width in pixels. The default is the display width minus the total horizontal overscan.

==== `framebuffer_height`

The `framebuffer_height` command specifies the console framebuffer height in pixels. The default is the display height minus the total vertical overscan.

==== `max_framebuffer_height`, `max_framebuffer_width`

Specifies the maximum dimensions that the internal frame buffer is allowed to be.

==== `framebuffer_depth`

Use `framebuffer_depth` to specify the console framebuffer depth in bits per pixel. The default value is `16`.

|===
| framebuffer_depth | result | notes

| 8
| 8bit framebuffer
| Default RGB palette makes screen unreadable

| 16
| 16bit framebuffer
|

| 24
| 24bit framebuffer
| May result in a corrupted display

| 32
| 32bit framebuffer
| May need to be used in conjunction with `framebuffer_ignore_alpha=1`
|===

==== `framebuffer_ignore_alpha`

Set `framebuffer_ignore_alpha` to `1` to disable the alpha channel. Can help with the display of a 32bit `framebuffer_depth`.

==== `framebuffer_priority`

In a system with multiple displays, using the legacy (pre-KMS) graphics driver, this forces a specific internal display device to be the first Linux framebuffer (i.e. `/dev/fb0`).

The options that can be set are:

|===
| Display | ID

| Main LCD
| 0

| Secondary LCD
| 1

| HDMI 0
| 2

| Composite
| 3

| HDMI 1
| 7
|===

==== `max_framebuffers`

This configuration entry sets the maximum number of firmware framebuffers that can be created. Valid options are 0, 1, and 2. By default on devices before the Pi4 this is set to 1, so will need to be increased to 2 when using more than one display, for example HDMI and a DSI or DPI display. The Raspberry Pi4 configuration sets this to 2 by default as it has two HDMI ports.

Generally in most cases it is safe to set this to 2, as framebuffers will only be created when an attached device is actually detected.

Setting this value to 0 can be used to reduce memory requirements when used in headless mode as it will prevent any framebuffers from being allocated.

==== `test_mode`

The `test_mode` command displays a test image and sound during boot (over the composite video and analogue audio outputs only) for the given number of seconds, before continuing to boot the OS as normal. This is used as a manufacturing test; the default value is `0`.

==== `display_hdmi_rotate`

Use `display_hdmi_rotate` to rotate or flip the HDMI display orientation. The default value is `0`.

|===
| display_hdmi_rotate | result

| 0
| no rotation

| 1
| rotate 90 degrees clockwise

| 2
| rotate 180 degrees clockwise

| 3
| rotate 270 degrees clockwise

| 0x10000
| horizontal flip

| 0x20000
| vertical flip
|===

Note that the 90 and 270 degree rotation options require additional memory on the GPU, so these will not work with the 16MB GPU split.

If using the VC4 FKMS V3D driver (this is the default on the Raspberry Pi 4), then 90 and 270 degree rotations are not supported. The Screen Configuration utility xref:configuration.adoc#rotating-your-display[provides display rotations] for this driver. 

==== `display_lcd_rotate`

For the legacy graphics driver (default on models prior to the Pi4), use `display_lcd_rotate` to rotate or flip the LCD orientation. Parameters are the same as `display_hdmi_rotate`. See also `lcd_rotate`.

==== `display_rotate`

`display_rotate` is deprecated in the latest firmware but has been retained for backwards compatibility. Please use `display_lcd_rotate` and `display_hdmi_rotate` instead.

Use `display_rotate` to rotate or flip the screen orientation. Parameters are the same as `display_hdmi_rotate`.

==== `disable_fw_kms_setup`

By default, the firmware parses the EDID of any HDMI attached display, picks an appropriate video mode, then passes the resolution and frame rate of the mode, along with overscan parameters, to the Linux kernel via settings on the kernel command line. In rare circumstances, this can have the effect of choosing a mode that is not in the EDID, and may be incompatible with the device. You can use `disable_fw_kms_setup=1` to disable the passing of these parameters and avoid this problem. The Linux video mode system (KMS) will then parse the EDID itself and pick an appropriate mode.

=== Other Options

==== `dispmanx_offline`

Forces `dispmanx` composition to be done offline in two offscreen framebuffers. This can allow more `dispmanx` elements to be composited, but is slower and may limit screen framerate to typically 30fps.
",12131,True,2500.359856526312,median
"[[main-component]]
= Main Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: core/camel-main/src/main/docs/main.adoc
:docTitle: Main
:artifactId: camel-main
:description: Camel Main support
:since: 3.0
:supportLevel: Stable
//Manually maintained attributes
:group: Core

*Since Camel {since}*

This module is used for running Camel standalone via a main class extended from `camel-main`.

== Configuration options

When running Camel via `camel-main` you can configure Camel in the `application.properties` file.

The following table lists all the options:

// main options: START
[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *camel.main.allowUseOriginal{zwsp}Message* | Sets whether to allow access to the original message from Camel's error handler, or from org.apache.camel.spi.UnitOfWork.getOriginalInMessage(). Turning this off can optimize performance, as defensive copy of the original message is not needed. Default is false. |  | boolean
| *camel.main.autoConfiguration{zwsp}Enabled* | Whether auto configuration of components, dataformats, languages is enabled or not. When enabled the configuration parameters are loaded from the properties component and optionally from the classpath file META-INF/services/org/apache/camel/autowire.properties. You can prefix the parameters in the properties file with: - camel.component.name.option1=value1 - camel.component.name.option2=value2 - camel.dataformat.name.option1=value1 - camel.dataformat.name.option2=value2 - camel.language.name.option1=value1 - camel.language.name.option2=value2 Where name is the name of the component, dataformat or language such as seda,direct,jaxb. The auto configuration also works for any options on components that is a complex type (not standard Java type) and there has been an explicit single bean instance registered to the Camel registry via the org.apache.camel.spi.Registry#bind(String,Object) method or by using the org.apache.camel.BindToRegistry annotation style. This option is default enabled. | true | boolean
| *camel.main.autoConfiguration{zwsp}EnvironmentVariablesEnabled* | Whether auto configuration should include OS environment variables as well. When enabled this allows to overrule any configuration using an OS environment variable. For example to set a shutdown timeout of 5 seconds: CAMEL_MAIN_SHUTDOWNTIMEOUT=5. This option is default enabled. | true | boolean
| *camel.main.autoConfiguration{zwsp}FailFast* | Whether auto configuration should fail fast when configuring one ore more properties fails for whatever reason such as a invalid property name, etc. This option is default enabled. | true | boolean
| *camel.main.autoConfiguration{zwsp}LogSummary* | Whether auto configuration should log a summary with the configured properties. This option is default enabled. | true | boolean
| *camel.main.autoStartup* | Sets whether the object should automatically start when Camel starts. Important: Currently only routes can be disabled, as CamelContext's are always started. Note: When setting auto startup false on CamelContext then that takes precedence and no routes are started. You would need to start CamelContext explicit using the org.apache.camel.CamelContext.start() method, to start the context, and then you would need to start the routes manually using CamelContext.getRouteController().startRoute(String). Default is true to always start up. | true | boolean
| *camel.main.autowiredEnabled* | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. Default is true. | true | boolean
| *camel.main.backlogTracing* | Sets whether backlog tracing is enabled or not. Default is false. |  | boolean
| *camel.main.beanIntrospection{zwsp}ExtendedStatistics* | Sets whether bean introspection uses extended statistics. The default is false. |  | boolean
| *camel.main.beanIntrospection{zwsp}LoggingLevel* | Sets the logging level used by bean introspection, logging activity of its usage. The default is TRACE. |  | LoggingLevel
| *camel.main.beanPostProcessor{zwsp}Enabled* | Can be used to turn off bean post processing. Be careful to turn this off, as this means that beans that use Camel annotations such as org.apache.camel.EndpointInject , org.apache.camel.ProducerTemplate , org.apache.camel.Produce , org.apache.camel.Consume etc will not be injected and in use. Turning this off should only be done if you are sure you do not use any of these Camel features. Not all runtimes allow turning this off (such as camel-blueprint or camel-cdi with XML). The default value is true (enabled). | true | boolean
| *camel.main.caseInsensitive{zwsp}Headers* | Whether to use case sensitive or insensitive headers. Important: When using case sensitive (this is set to false). Then the map is case sensitive which means headers such as content-type and Content-Type are two different keys which can be a problem for some protocols such as HTTP based, which rely on case insensitive headers. However case sensitive implementations can yield faster performance. Therefore use case sensitive implementation with care. Default is true. | true | boolean
| *camel.main.configuration{zwsp}Classes* | Sets classes names that will be used to configure the camel context as example by providing custom beans through org.apache.camel.BindToRegistry annotation. |  | String
| *camel.main.configurations* | Sets the configuration objects used to configure the camel context. |  | List
| *camel.main.consumerTemplate{zwsp}CacheSize* | Consumer template endpoints cache size. | 1000 | int
| *camel.main.durationHitExitCode* | Sets the exit code for the application if duration was hit |  | int
| *camel.main.durationMaxIdle{zwsp}Seconds* | To specify for how long time in seconds Camel can be idle before automatic terminating the JVM. You can use this to run Camel for a short while. |  | int
| *camel.main.durationMaxMessages* | To specify how many messages to process by Camel before automatic terminating the JVM. You can use this to run Camel for a short while. |  | int
| *camel.main.durationMaxSeconds* | To specify for how long time in seconds to keep running the JVM before automatic terminating the JVM. You can use this to run Camel for a short while. |  | int
| *camel.main.endpointBridgeError{zwsp}Handler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored. The default value is false. |  | boolean
| *camel.main.endpointLazyStart{zwsp}Producer* | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. The default value is false. |  | boolean
| *camel.main.endpointRuntime{zwsp}StatisticsEnabled* | Sets whether endpoint runtime statistics is enabled (gathers runtime usage of each incoming and outgoing endpoints). The default value is false. |  | boolean
| *camel.main.fileConfigurations* | Directory to load additional configuration files that contains configuration values that takes precedence over any other configuration. This can be used to refer to files that may have secret configuration that has been mounted on the file system for containers. You can specify a pattern to load from sub directories and a name pattern such as /var/app/secret/.properties, multiple directories can be separated by comma. |  | String
| *camel.main.inflightRepository{zwsp}BrowseEnabled* | Sets whether the inflight repository should allow browsing each inflight exchange. This is by default disabled as there is a very slight performance overhead when enabled. |  | boolean
| *camel.main.javaRoutesExclude{zwsp}Pattern* | Used for exclusive filtering RouteBuilder classes which are collected from the registry or via classpath scanning. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. For example to exclude all classes starting with Bar use: &#42;&#42;/Bar&#42; To exclude all routes form a specific package use: com/mycompany/bar/&#42; To exclude all routes form a specific package and its sub-packages use double wildcards: com/mycompany/bar/&#42;&#42; And to exclude all routes from two specific packages use: com/mycompany/bar/&#42;,com/mycompany/stuff/&#42; |  | String
| *camel.main.javaRoutesInclude{zwsp}Pattern* | Used for inclusive filtering RouteBuilder classes which are collected from the registry or via classpath scanning. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma. Multiple patterns can be specified separated by comma. For example to include all classes starting with Foo use: &#42;&#42;/Foo To include all routes form a specific package use: com/mycompany/foo/&#42; To include all routes form a specific package and its sub-packages use double wildcards: com/mycompany/foo/&#42;&#42; And to include all routes from two specific packages use: com/mycompany/foo/&#42;,com/mycompany/stuff/&#42; |  | String
| *camel.main.jmxEnabled* | Enable JMX in your Camel application. | true | boolean
| *camel.main.jmxManagementName{zwsp}Pattern* | The naming pattern for creating the CamelContext JMX management name. The default pattern is #name# | #name# | String
| *camel.main.jmxManagement{zwsp}StatisticsLevel* | Sets the JMX statistics level, the level can be set to Extended to gather additional information The default value is Default. | Default | ManagementStatisticsLevel
| *camel.main.lightweight* | Experimental: Configure the context to be lightweight. This will trigger some optimizations and memory reduction options. Lightweight context have some limitations. At this moment, dynamic endpoint destinations are not supported. |  | boolean
| *camel.main.loadTypeConverters* | Whether to load custom type converters by scanning classpath. This is used for backwards compatibility with Camel 2.x. Its recommended to migrate to use fast type converter loading by setting Converter(loader = true) on your custom type converter classes. |  | boolean
| *camel.main.logDebugMaxChars* | Is used to limit the maximum length of the logging Camel message bodies. If the message body is longer than the limit, the log message is clipped. Use -1 to have unlimited length. Use for example 1000 to log at most 1000 characters. |  | int
| *camel.main.logExhaustedMessage{zwsp}Body* | Sets whether to log exhausted message body with message history. Default is false. |  | boolean
| *camel.main.logMask* | Sets whether log mask is enabled or not. Default is false. |  | boolean
| *camel.main.mdcLoggingKeys{zwsp}Pattern* | Sets the pattern used for determine which custom MDC keys to propagate during message routing when the routing engine continues routing asynchronously for the given message. Setting this pattern to will propagate all custom keys. Or setting the pattern to foo,bar will propagate any keys starting with either foo or bar. Notice that a set of standard Camel MDC keys are always propagated which starts with camel. as key name. The match rules are applied in this order (case insensitive): 1. exact match, returns true 2. wildcard match (pattern ends with a and the name starts with the pattern), returns true 3. regular expression match, returns true 4. otherwise returns false |  | String
| *camel.main.messageHistory* | Sets whether message history is enabled or not. Default is false. |  | boolean
| *camel.main.name* | Sets the name of the CamelContext. |  | String
| *camel.main.packageScanRoute{zwsp}Builders* | Sets package names for scanning for org.apache.camel.builder.RouteBuilder classes as candidates to be included. If you are using Spring Boot then its instead recommended to use Spring Boots component scanning and annotate your route builder classes with Component. In other words only use this for Camel Main in standalone mode. |  | String
| *camel.main.producerTemplate{zwsp}CacheSize* | Producer template endpoints cache size. | 1000 | int
| *camel.main.routeControllerBack{zwsp}OffDelay* | Backoff delay in millis when restarting a route that failed to startup. |  | long
| *camel.main.routeControllerBack{zwsp}OffMaxAttempts* | Backoff maximum number of attempts to restart a route that failed to startup. When this threshold has been exceeded then the controller will give up attempting to restart the route, and the route will remain as stopped. |  | long
| *camel.main.routeControllerBack{zwsp}OffMaxDelay* | Backoff maximum delay in millis when restarting a route that failed to startup. |  | long
| *camel.main.routeControllerBack{zwsp}OffMaxElapsedTime* | Backoff maximum elapsed time in millis, after which the backoff should be considered exhausted and no more attempts should be made. |  | long
| *camel.main.routeControllerBack{zwsp}OffMultiplier* | Backoff multiplier to use for exponential backoff. This is used to extend the delay between restart attempts. |  | double
| *camel.main.routeController{zwsp}ExcludeRoutes* | Pattern for filtering routes to be excluded as supervised. The pattern is matching on route id, and endpoint uri for the route. Multiple patterns can be separated by comma. For example to exclude all JMS routes, you can say jms:. And to exclude routes with specific route ids mySpecialRoute,myOtherSpecialRoute. The pattern supports wildcards and uses the matcher from org.apache.camel.support.PatternHelper#matchPattern. |  | String
| *camel.main.routeController{zwsp}IncludeRoutes* | Pattern for filtering routes to be included as supervised. The pattern is matching on route id, and endpoint uri for the route. Multiple patterns can be separated by comma. For example to include all kafka routes, you can say kafka:. And to include routes with specific route ids myRoute,myOtherRoute. The pattern supports wildcards and uses the matcher from org.apache.camel.support.PatternHelper#matchPattern. |  | String
| *camel.main.routeController{zwsp}InitialDelay* | Initial delay in milli seconds before the route controller starts, after CamelContext has been started. |  | long
| *camel.main.routeController{zwsp}LoggingLevel* | Sets the logging level used for logging route activity (such as starting and stopping routes). The default logging level is DEBUG. | DEBUG | LoggingLevel
| *camel.main.routeController{zwsp}SuperviseEnabled* | To enable using supervising route controller which allows Camel to startup and then the controller takes care of starting the routes in a safe manner. This can be used when you want to startup Camel despite a route may otherwise fail fast during startup and cause Camel to fail to startup as well. By delegating the route startup to the supervising route controller then its manages the startup using a background thread. The controller allows to be configured with various settings to attempt to restart failing routes. |  | boolean
| *camel.main.routeController{zwsp}ThreadPoolSize* | The number of threads used by the route controller scheduled thread pool that are used for restarting routes. The pool uses 1 thread by default, but you can increase this to allow the controller to concurrently attempt to restart multiple routes in case more than one route has problems starting. |  | int
| *camel.main.routeController{zwsp}UnhealthyOnExhausted* | Whether to mark the route as unhealthy (down) when all restarting attempts (backoff) have failed and the route is not successfully started and the route manager is giving up. Setting this to true allows health checks to know about this and can report the Camel application as DOWN. The default is false. |  | boolean
| *camel.main.routeFilterExclude{zwsp}Pattern* | Used for filtering routes routes matching the given pattern, which follows the following rules: - Match by route id - Match by route input endpoint uri The matching is using exact match, by wildcard and regular expression as documented by PatternHelper#matchPattern(String,String) . For example to only include routes which starts with foo in their route id's, use: include=foo&#42; And to exclude routes which starts from JMS endpoints, use: exclude=jms:&#42; Multiple patterns can be separated by comma, for example to exclude both foo and bar routes, use: exclude=foo&#42;,bar&#42; Exclude takes precedence over include. |  | String
| *camel.main.routeFilterInclude{zwsp}Pattern* | Used for filtering routes matching the given pattern, which follows the following rules: - Match by route id - Match by route input endpoint uri The matching is using exact match, by wildcard and regular expression as documented by PatternHelper#matchPattern(String,String) . For example to only include routes which starts with foo in their route id's, use: include=foo&#42; And to exclude routes which starts from JMS endpoints, use: exclude=jms:&#42; Multiple patterns can be separated by comma, for example to exclude both foo and bar routes, use: exclude=foo&#42;,bar&#42; Exclude takes precedence over include. |  | String
| *camel.main.routesBuilder{zwsp}Classes* | Sets classes names that implement RoutesBuilder . |  | String
| *camel.main.routesBuilders* | Sets the RoutesBuilder instances. |  | List
| *camel.main.routesCollector{zwsp}Enabled* | Whether the routes collector is enabled or not. When enabled Camel will auto-discover routes (RouteBuilder instances from the registry and also load additional routes from the file system). The routes collector is default enabled. | true | boolean
| *camel.main.routesExclude{zwsp}Pattern* | Used for exclusive filtering of routes from directories. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma, as example, to exclude all the routes from a directory whose name contains foo use: &#42;&#42;/foo. |  | String
| *camel.main.routesInclude{zwsp}Pattern* | Used for inclusive filtering of routes from directories. The exclusive filtering takes precedence over inclusive filtering. The pattern is using Ant-path style pattern. Multiple patterns can be specified separated by comma, as example, to include all the routes from a directory whose name contains foo use: &#42;&#42;/foo. | classpath:camel/*.xml,classpath:camel-template/*.xml,classpath:camel-rest/*.xml | String
| *camel.main.shutdownLogInflight{zwsp}ExchangesOnTimeout* | Sets whether to log information about the inflight Exchanges which are still running during a shutdown which didn't complete without the given timeout. This requires to enable the option inflightRepositoryBrowseEnabled. | true | boolean
| *camel.main.shutdownNowOn{zwsp}Timeout* | Sets whether to force shutdown of all consumers when a timeout occurred and thus not all consumers was shutdown within that period. You should have good reasons to set this option to false as it means that the routes keep running and is halted abruptly when CamelContext has been shutdown. | true | boolean
| *camel.main.shutdownRoutesIn{zwsp}ReverseOrder* | Sets whether routes should be shutdown in reverse or the same order as they were started. | true | boolean
| *camel.main.shutdownSuppress{zwsp}LoggingOnTimeout* | Whether Camel should try to suppress logging during shutdown and timeout was triggered, meaning forced shutdown is happening. And during forced shutdown we want to avoid logging errors/warnings et all in the logs as a side-effect of the forced timeout. Notice the suppress is a best effort as there may still be some logs coming from 3rd party libraries and whatnot, which Camel cannot control. This option is default false. |  | boolean
| *camel.main.shutdownTimeout* | Timeout in seconds to graceful shutdown Camel. | 45 | int
| *camel.main.startupRecorder* | To use startup recorder for capturing execution time during starting Camel. The recorder can be one of: false, logging, java-flight-recorder The default is false. |  | String
| *camel.main.startupRecorderDir* | Directory to store the recording. By default the user home directory will be used. Use false to turn off saving recording to disk. |  | String
| *camel.main.startupRecorder{zwsp}Duration* | How long time to run the startup recorder. Use 0 (default) to keep the recorder running until the JVM is exited. Use -1 to stop the recorder right after Camel has been started (to only focus on potential Camel startup performance bottlenecks) Use a positive value to keep recording for N seconds. When the recorder is stopped then the recording is auto saved to disk (note: save to disk can be disabled by setting startupRecorderDir to false) |  | long
| *camel.main.startupRecorderMax{zwsp}Depth* | To filter our sub steps at a maximum depth. Use -1 for no maximum. Use 0 for no sub steps. Use 1 for max 1 sub step, and so forth. The default is -1. | -1 | int
| *camel.main.startupRecorder{zwsp}Profile* | To use a specific Java Flight Recorder profile configuration, such as default or profile. The default is default. | default | String
| *camel.main.startupRecorder{zwsp}Recording* | To enable Java Flight Recorder to start a recording and automatic dump the recording to disk after startup is complete. This requires that camel-jfr is on the classpath. The default is true. | true | boolean
| *camel.main.startupSummaryLevel* | Controls the level of information logged during startup (and shutdown) of CamelContext. | Default | StartupSummaryLevel
| *camel.main.streamCachingAny{zwsp}SpoolRules* | Sets whether if just any of the org.apache.camel.spi.StreamCachingStrategy.SpoolRule rules returns true then shouldSpoolCache(long) returns true, to allow spooling to disk. If this option is false, then all the org.apache.camel.spi.StreamCachingStrategy.SpoolRule must return true. The default value is false which means that all the rules must return true. |  | boolean
| *camel.main.streamCachingBuffer{zwsp}Size* | Sets the stream caching buffer size to use when allocating in-memory buffers used for in-memory stream caches. The default size is 4096. |  | int
| *camel.main.streamCaching{zwsp}Enabled* | Sets whether stream caching is enabled or not. Default is false. |  | boolean
| *camel.main.streamCachingRemove{zwsp}SpoolDirectoryWhenStopping* | Whether to remove stream caching temporary directory when stopping. This option is default true. | true | boolean
| *camel.main.streamCachingSpool{zwsp}Cipher* | Sets a stream caching cipher name to use when spooling to disk to write with encryption. By default the data is not encrypted. |  | String
| *camel.main.streamCachingSpool{zwsp}Directory* | Sets the stream caching spool (temporary) directory to use for overflow and spooling to disk. If no spool directory has been explicit configured, then a temporary directory is created in the java.io.tmpdir directory. |  | String
| *camel.main.streamCachingSpool{zwsp}Threshold* | Stream caching threshold in bytes when overflow to disk is activated. The default threshold is 128kb. Use -1 to disable overflow to disk. |  | long
| *camel.main.streamCachingSpool{zwsp}UsedHeapMemoryLimit* | Sets what the upper bounds should be when streamCachingSpoolUsedHeapMemoryThreshold is in use. |  | String
| *camel.main.streamCachingSpool{zwsp}UsedHeapMemoryThreshold* | Sets a percentage (1-99) of used heap memory threshold to activate stream caching spooling to disk. |  | int
| *camel.main.streamCaching{zwsp}StatisticsEnabled* | Sets whether stream caching statistics is enabled. |  | boolean
| *camel.main.threadNamePattern* | Sets the thread name pattern used for creating the full thread name. The default pattern is: Camel (#camelId#) thread ##counter# - #name# Where #camelId# is the name of the CamelContext. and #counter# is a unique incrementing counter. and #name# is the regular thread name. You can also use #longName# which is the long thread name which can includes endpoint parameters etc. |  | String
| *camel.main.tracing* | Sets whether tracing is enabled or not. Default is false. |  | boolean
| *camel.main.tracingPattern* | Tracing pattern to match which node EIPs to trace. For example to match all To EIP nodes, use to. The pattern matches by node and route id's Multiple patterns can be separated by comma. |  | String
| *camel.main.useBreadcrumb* | Set whether breadcrumb is enabled. The default value is false. |  | boolean
| *camel.main.useDataType* | Whether to enable using data type on Camel messages. Data type are automatic turned on if one ore more routes has been explicit configured with input and output types. Otherwise data type is default off. |  | boolean
| *camel.main.useMdcLogging* | To turn on MDC logging |  | boolean
| *camel.faulttolerance.bulkhead{zwsp}Enabled* | Whether bulkhead is enabled or not on the circuit breaker. Default is false. | false | Boolean
| *camel.faulttolerance.bulkhead{zwsp}ExecutorServiceRef* | References to a custom thread pool to use when bulkhead is enabled. |  | String
| *camel.faulttolerance.bulkhead{zwsp}MaxConcurrentCalls* | Configures the max amount of concurrent calls the bulkhead will support. Default value is 10. | 10 | Integer
| *camel.faulttolerance.bulkhead{zwsp}WaitingTaskQueue* | Configures the task queue size for holding waiting tasks to be processed by the bulkhead. Default value is 10. | 10 | Integer
| *camel.faulttolerance.circuit{zwsp}BreakerRef* | Refers to an existing io.smallrye.faulttolerance.core.circuit.breaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use. |  | String
| *camel.faulttolerance.delay* | Control how long the circuit breaker stays open. The value are in seconds and the default is 5 seconds. | 5 | Long
| *camel.faulttolerance.failure{zwsp}Ratio* | Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage. | 50 | Integer
| *camel.faulttolerance.request{zwsp}VolumeThreshold* | Controls the size of the rolling window used when the circuit breaker is closed Default value is 20. | 20 | Integer
| *camel.faulttolerance.success{zwsp}Threshold* | Controls the number of trial calls which are allowed when the circuit breaker is half-open Default value is 1. | 1 | Integer
| *camel.faulttolerance.timeout{zwsp}Duration* | Configures the thread execution timeout. Default value is 1000 milliseconds. | 1000 | Long
| *camel.faulttolerance.timeout{zwsp}Enabled* | Whether timeout is enabled or not on the circuit breaker. Default is false. | false | Boolean
| *camel.faulttolerance.timeout{zwsp}PoolSize* | Configures the pool size of the thread pool when timeout is enabled. Default value is 10. | 10 | Integer
| *camel.faulttolerance.timeout{zwsp}ScheduledExecutorServiceRef* | References to a custom thread pool to use when timeout is enabled |  | String
| *camel.health.config* | Set additional HealthConfigurationProperties for fine grained configuration of health checks. |  | Map
| *camel.health.contextEnabled* | Whether context health check is enabled | true | Boolean
| *camel.health.enabled* | Whether health check is enabled globally | true | Boolean
| *camel.health.registryEnabled* | Whether registry health check is enabled | true | Boolean
| *camel.health.routesEnabled* | Whether routes health check is enabled | true | Boolean
| *camel.hystrix.allowMaximumSize{zwsp}ToDivergeFromCoreSize* | Allows the configuration for maximumSize to take effect. That value can then be equal to, or higher, than coreSize |  | Boolean
| *camel.hystrix.circuitBreaker{zwsp}Enabled* | Whether to use a HystrixCircuitBreaker or not. If false no circuit-breaker logic will be used and all requests permitted. This is similar in effect to circuitBreakerForceClosed() except that continues tracking metrics and knowing whether it should be open/closed, this property results in not even instantiating a circuit-breaker. |  | Boolean
| *camel.hystrix.circuitBreaker{zwsp}ErrorThresholdPercentage* | Error percentage threshold (as whole number such as 50) at which point the circuit breaker will trip open and reject requests. It will stay tripped for the duration defined in circuitBreakerSleepWindowInMilliseconds; The error percentage this is compared against comes from HystrixCommandMetrics.getHealthCounts(). |  | Integer
| *camel.hystrix.circuitBreaker{zwsp}ForceClosed* | If true the HystrixCircuitBreaker#allowRequest() will always return true to allow requests regardless of the error percentage from HystrixCommandMetrics.getHealthCounts(). The circuitBreakerForceOpen() property takes precedence so if it set to true this property does nothing. |  | Boolean
| *camel.hystrix.circuitBreaker{zwsp}ForceOpen* | If true the HystrixCircuitBreaker.allowRequest() will always return false, causing the circuit to be open (tripped) and reject all requests. This property takes precedence over circuitBreakerForceClosed(); |  | Boolean
| *camel.hystrix.circuitBreaker{zwsp}RequestVolumeThreshold* | Minimum number of requests in the metricsRollingStatisticalWindowInMilliseconds() that must exist before the HystrixCircuitBreaker will trip. If below this number the circuit will not trip regardless of error percentage. |  | Integer
| *camel.hystrix.circuitBreaker{zwsp}SleepWindowInMilliseconds* | The time in milliseconds after a HystrixCircuitBreaker trips open that it should wait before trying requests again. |  | Integer
| *camel.hystrix.corePoolSize* | Core thread-pool size that gets passed to java.util.concurrent.ThreadPoolExecutor#setCorePoolSize(int) |  | Integer
| *camel.hystrix.execution{zwsp}IsolationSemaphoreMax{zwsp}ConcurrentRequests* | Number of concurrent requests permitted to HystrixCommand.run(). Requests beyond the concurrent limit will be rejected. Applicable only when executionIsolationStrategy == SEMAPHORE. |  | Integer
| *camel.hystrix.execution{zwsp}IsolationStrategy* | What isolation strategy HystrixCommand.run() will be executed with. If THREAD then it will be executed on a separate thread and concurrent requests limited by the number of threads in the thread-pool. If SEMAPHORE then it will be executed on the calling thread and concurrent requests limited by the semaphore count. |  | String
| *camel.hystrix.execution{zwsp}IsolationThreadInterruptOn{zwsp}Timeout* | Whether the execution thread should attempt an interrupt (using Future#cancel ) when a thread times out. Applicable only when executionIsolationStrategy() == THREAD. |  | Boolean
| *camel.hystrix.executionTimeout{zwsp}Enabled* | Whether the timeout mechanism is enabled for this command |  | Boolean
| *camel.hystrix.executionTimeout{zwsp}InMilliseconds* | Time in milliseconds at which point the command will timeout and halt execution. If executionIsolationThreadInterruptOnTimeout == true and the command is thread-isolated, the executing thread will be interrupted. If the command is semaphore-isolated and a HystrixObservableCommand, that command will get unsubscribed. |  | Integer
| *camel.hystrix.fallbackEnabled* | Whether HystrixCommand.getFallback() should be attempted when failure occurs. |  | Boolean
| *camel.hystrix.fallback{zwsp}IsolationSemaphoreMax{zwsp}ConcurrentRequests* | Number of concurrent requests permitted to HystrixCommand.getFallback(). Requests beyond the concurrent limit will fail-fast and not attempt retrieving a fallback. |  | Integer
| *camel.hystrix.groupKey* | Sets the group key to use. The default value is CamelHystrix. |  | String
| *camel.hystrix.keepAliveTime* | Keep-alive time in minutes that gets passed to ThreadPoolExecutor#setKeepAliveTime(long,TimeUnit) |  | Integer
| *camel.hystrix.maximumSize* | Maximum thread-pool size that gets passed to ThreadPoolExecutor#setMaximumPoolSize(int) . This is the maximum amount of concurrency that can be supported without starting to reject HystrixCommands. Please note that this setting only takes effect if you also set allowMaximumSizeToDivergeFromCoreSize |  | Integer
| *camel.hystrix.maxQueueSize* | Max queue size that gets passed to BlockingQueue in HystrixConcurrencyStrategy.getBlockingQueue(int) This should only affect the instantiation of a threadpool - it is not eliglible to change a queue size on the fly. For that, use queueSizeRejectionThreshold(). |  | Integer
| *camel.hystrix.metricsHealth{zwsp}SnapshotIntervalInMilliseconds* | Time in milliseconds to wait between allowing health snapshots to be taken that calculate success and error percentages and affect HystrixCircuitBreaker.isOpen() status. On high-volume circuits the continual calculation of error percentage can become CPU intensive thus this controls how often it is calculated. |  | Integer
| *camel.hystrix.metricsRolling{zwsp}PercentileBucketSize* | Maximum number of values stored in each bucket of the rolling percentile. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics. |  | Integer
| *camel.hystrix.metricsRolling{zwsp}PercentileEnabled* | Whether percentile metrics should be captured using HystrixRollingPercentile inside HystrixCommandMetrics. |  | Boolean
| *camel.hystrix.metricsRolling{zwsp}PercentileWindowBuckets* | Number of buckets the rolling percentile window is broken into. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics. |  | Integer
| *camel.hystrix.metricsRolling{zwsp}PercentileWindowInMilliseconds* | Duration of percentile rolling window in milliseconds. This is passed into HystrixRollingPercentile inside HystrixCommandMetrics. |  | Integer
| *camel.hystrix.metricsRolling{zwsp}StatisticalWindowBuckets* | Number of buckets the rolling statistical window is broken into. This is passed into HystrixRollingNumber inside HystrixCommandMetrics. |  | Integer
| *camel.hystrix.metricsRolling{zwsp}StatisticalWindowIn{zwsp}Milliseconds* | This property sets the duration of the statistical rolling window, in milliseconds. This is how long metrics are kept for the thread pool. The window is divided into buckets and rolls by those increments. |  | Integer
| *camel.hystrix.queueSize{zwsp}RejectionThreshold* | Queue size rejection threshold is an artificial max size at which rejections will occur even if maxQueueSize has not been reached. This is done because the maxQueueSize of a BlockingQueue can not be dynamically changed and we want to support dynamically changing the queue size that affects rejections. This is used by HystrixCommand when queuing a thread for execution. |  | Integer
| *camel.hystrix.requestLog{zwsp}Enabled* | Whether HystrixCommand execution and events should be logged to HystrixRequestLog. |  | Boolean
| *camel.hystrix.threadPoolKey* | Sets the thread pool key to use. Will by default use the same value as groupKey has been configured to use. |  | String
| *camel.hystrix.threadPool{zwsp}RollingNumberStatisticalWindow{zwsp}Buckets* | Number of buckets the rolling statistical window is broken into. This is passed into HystrixRollingNumber inside each HystrixThreadPoolMetrics instance. |  | Integer
| *camel.hystrix.threadPool{zwsp}RollingNumberStatisticalWindow{zwsp}InMilliseconds* | Duration of statistical rolling window in milliseconds. This is passed into HystrixRollingNumber inside each HystrixThreadPoolMetrics instance. |  | Integer
| *camel.lra.coordinatorContext{zwsp}Path* | The context-path for the LRA coordinator. Is default /lra-coordinator | /lra-coordinator | String
| *camel.lra.coordinatorUrl* | The URL for the LRA coordinator service that orchestrates the transactions |  | String
| *camel.lra.localParticipant{zwsp}ContextPath* | The context-path for the local participant. Is default /lra-participant | /lra-participant | String
| *camel.lra.localParticipantUrl* | The URL for the local participant |  | String
| *camel.resilience4j.automatic{zwsp}TransitionFromOpenToHalfOpen{zwsp}Enabled* | Enables automatic transition from OPEN to HALF_OPEN state once the waitDurationInOpenState has passed. |  | Boolean
| *camel.resilience4j.bulkhead{zwsp}Enabled* | Whether bulkhead is enabled or not on the circuit breaker. | false | Boolean
| *camel.resilience4j.bulkheadMax{zwsp}ConcurrentCalls* | Configures the max amount of concurrent calls the bulkhead will support. |  | Integer
| *camel.resilience4j.bulkheadMax{zwsp}WaitDuration* | Configures a maximum amount of time which the calling thread will wait to enter the bulkhead. If bulkhead has space available, entry is guaranteed and immediate. If bulkhead is full, calling threads will contest for space, if it becomes available. maxWaitDuration can be set to 0. Note: for threads running on an event-loop or equivalent (rx computation pool, etc), setting maxWaitDuration to 0 is highly recommended. Blocking an event-loop thread will most likely have a negative effect on application throughput. |  | Integer
| *camel.resilience4j.circuit{zwsp}BreakerRef* | Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreaker instance to lookup and use from the registry. When using this, then any other circuit breaker options are not in use. |  | String
| *camel.resilience4j.configRef* | Refers to an existing io.github.resilience4j.circuitbreaker.CircuitBreakerConfig instance to lookup and use from the registry. |  | String
| *camel.resilience4j.failureRate{zwsp}Threshold* | Configures the failure rate threshold in percentage. If the failure rate is equal or greater than the threshold the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 50 percentage. | 50 | Float
| *camel.resilience4j.minimum{zwsp}NumberOfCalls* | Configures configures the minimum number of calls which are required (per sliding window period) before the CircuitBreaker can calculate the error rate. For example, if minimumNumberOfCalls is 10, then at least 10 calls must be recorded, before the failure rate can be calculated. If only 9 calls have been recorded the CircuitBreaker will not transition to open even if all 9 calls have failed. Default minimumNumberOfCalls is 100 | 100 | Integer
| *camel.resilience4j.permitted{zwsp}NumberOfCallsInHalfOpenState* | Configures the number of permitted calls when the CircuitBreaker is half open. The size must be greater than 0. Default size is 10. | 10 | Integer
| *camel.resilience4j.sliding{zwsp}WindowSize* | Configures the size of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. slidingWindowSize configures the size of the sliding window. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. The slidingWindowSize must be greater than 0. The minimumNumberOfCalls must be greater than 0. If the slidingWindowType is COUNT_BASED, the minimumNumberOfCalls cannot be greater than slidingWindowSize . If the slidingWindowType is TIME_BASED, you can pick whatever you want. Default slidingWindowSize is 100. | 100 | Integer
| *camel.resilience4j.sliding{zwsp}WindowType* | Configures the type of the sliding window which is used to record the outcome of calls when the CircuitBreaker is closed. Sliding window can either be count-based or time-based. If slidingWindowType is COUNT_BASED, the last slidingWindowSize calls are recorded and aggregated. If slidingWindowType is TIME_BASED, the calls of the last slidingWindowSize seconds are recorded and aggregated. Default slidingWindowType is COUNT_BASED. | COUNT_BASED | String
| *camel.resilience4j.slowCall{zwsp}DurationThreshold* | Configures the duration threshold (seconds) above which calls are considered as slow and increase the slow calls percentage. Default value is 60 seconds. | 60 | Integer
| *camel.resilience4j.slowCall{zwsp}RateThreshold* | Configures a threshold in percentage. The CircuitBreaker considers a call as slow when the call duration is greater than slowCallDurationThreshold(Duration. When the percentage of slow calls is equal or greater the threshold, the CircuitBreaker transitions to open and starts short-circuiting calls. The threshold must be greater than 0 and not greater than 100. Default value is 100 percentage which means that all recorded calls must be slower than slowCallDurationThreshold. | 100 | Float
| *camel.resilience4j.timeout{zwsp}CancelRunningFuture* | Configures whether cancel is called on the running future. Defaults to true. | true | Boolean
| *camel.resilience4j.timeout{zwsp}Duration* | Configures the thread execution timeout (millis). Default value is 1000 millis (1 second). | 1000 | Integer
| *camel.resilience4j.timeout{zwsp}Enabled* | Whether timeout is enabled or not on the circuit breaker. Default is false. | false | Boolean
| *camel.resilience4j.timeout{zwsp}ExecutorServiceRef* | References to a custom thread pool to use when timeout is enabled (uses ForkJoinPool#commonPool() by default) |  | String
| *camel.resilience4j.wait{zwsp}DurationInOpenState* | Configures the wait duration (in seconds) which specifies how long the CircuitBreaker should stay open, before it switches to half open. Default value is 60 seconds. | 60 | Integer
| *camel.resilience4j.writable{zwsp}StackTraceEnabled* | Enables writable stack traces. When set to false, Exception.getStackTrace returns a zero length array. This may be used to reduce log spam when the circuit breaker is open as the cause of the exceptions is already known (the circuit breaker is short-circuiting calls). |  | Boolean
| *camel.rest.apiComponent* | Sets the name of the Camel component to use as the REST API (such as swagger or openapi) |  | String
| *camel.rest.apiContextIdPattern* | Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern. The pattern #name# refers to the CamelContext name, to match on the current CamelContext only. For any other value, the pattern uses the rules from org.apache.camel.support.EndpointHelper#matchPattern(String,String) |  | String
| *camel.rest.apiContextListing* | Sets whether listing of all available CamelContext's with REST services in the JVM is enabled. If enabled it allows to discover these contexts, if false then only the current CamelContext is in use. |  | boolean
| *camel.rest.apiContextPath* | Sets a leading API context-path the REST API services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path. |  | String
| *camel.rest.apiContextRouteId* | Sets the route id to use for the route that services the REST API. The route will by default use an auto assigned route id. |  | String
| *camel.rest.apiHost* | To use an specific hostname for the API documentation (eg swagger) This can be used to override the generated host with this configured hostname |  | String
| *camel.rest.apiProperties* | Sets additional options on api level |  | Map
| *camel.rest.apiVendorExtension* | Whether vendor extension is enabled in the Rest APIs. If enabled then Camel will include additional information as vendor extension (eg keys starting with x-) such as route ids, class names etc. Not all 3rd party API gateways and tools supports vendor-extensions when importing your API docs. |  | boolean
| *camel.rest.bindingMode* | Sets the binding mode to be used by the REST consumer | RestBindingMode.off | RestBindingMode
| *camel.rest.clientRequest{zwsp}Validation* | Whether to enable validation of the client request to check whether the Content-Type and Accept headers from the client is supported by the Rest-DSL configuration of its consumes/produces settings. This can be turned on, to enable this check. In case of validation error, then HTTP Status codes 415 or 406 is returned. The default value is false. |  | boolean
| *camel.rest.component* | Sets the name of the Camel component to use as the REST consumer |  | String
| *camel.rest.componentProperties* | Sets additional options on component level |  | Map
| *camel.rest.consumerProperties* | Sets additional options on consumer level |  | Map
| *camel.rest.contextPath* | Sets a leading context-path the REST services will be using. This can be used when using components such as camel-servlet where the deployed web application is deployed using a context-path. Or for components such as camel-jetty or camel-netty-http that includes a HTTP server. |  | String
| *camel.rest.corsHeaders* | Sets the CORS headers to use if CORS has been enabled. |  | Map
| *camel.rest.dataFormat{zwsp}Properties* | Sets additional options on data format level |  | Map
| *camel.rest.enableCORS* | To specify whether to enable CORS which means Camel will automatic include CORS in the HTTP headers in the response. This option is default false |  | boolean
| *camel.rest.endpointProperties* | Sets additional options on endpoint level |  | Map
| *camel.rest.host* | Sets the hostname to use by the REST consumer |  | String
| *camel.rest.hostNameResolver* | Sets the resolver to use for resolving hostname | RestHostNameResolver.allLocalIp | RestHostNameResolver
| *camel.rest.jsonDataFormat* | Sets a custom json data format to be used Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance. |  | String
| *camel.rest.port* | Sets the port to use by the REST consumer |  | int
| *camel.rest.producerApiDoc* | Sets the location of the api document (swagger api) the REST producer will use to validate the REST uri and query parameters are valid accordingly to the api document. This requires adding camel-swagger-java to the classpath, and any miss configuration will let Camel fail on startup and report the error(s). The location of the api document is loaded from classpath by default, but you can use file: or http: to refer to resources to load from file or http url. |  | String
| *camel.rest.producerComponent* | Sets the name of the Camel component to use as the REST producer |  | String
| *camel.rest.scheme* | Sets the scheme to use by the REST consumer |  | String
| *camel.rest.skipBindingOnError{zwsp}Code* | Whether to skip binding output if there is a custom HTTP error code, and instead use the response body as-is. This option is default true. | true | boolean
| *camel.rest.useXForwardHeaders* | WWhether to use X-Forward headers to set host etc. for Swagger. This option is default true. | true | boolean
| *camel.rest.xmlDataFormat* | Sets a custom xml data format to be used. Important: This option is only for setting a custom name of the data format, not to refer to an existing data format instance. |  | String
| *camel.threadpool.allowCore{zwsp}ThreadTimeOut* | Sets default whether to allow core threads to timeout |  | Boolean
| *camel.threadpool.config* | Adds a configuration for a specific thread pool profile (inherits default values) |  | Map
| *camel.threadpool.keepAliveTime* | Sets the default keep alive time for inactive threads |  | Long
| *camel.threadpool.maxPoolSize* | Sets the default maximum pool size |  | Integer
| *camel.threadpool.maxQueueSize* | Sets the default maximum number of tasks in the work queue. Use -1 or an unbounded queue |  | Integer
| *camel.threadpool.poolSize* | Sets the default core pool size (threads to keep minimum in pool) |  | Integer
| *camel.threadpool.rejected{zwsp}Policy* | Sets the default handler for tasks which cannot be executed by the thread pool. |  | ThreadPoolRejectedPolicy
| *camel.threadpool.timeUnit* | Sets the default time unit used for keep alive time |  | TimeUnit
|===
// main options: END

== Specifying custom beans

Custom beans can be configured in `camel-main` via properties (such as in the `application.properties` file).

For example to create a `DataSource` for a Postgress database, you can create a new bean instance via `#class:` with the class name (fully qualified).
Properties on the data source can then additional configured such as the server and database name, etc.

[source,properties]
----
camel.beans.myDS = #class:org.postgresql.jdbc3.Jdbc3PoolingDataSource
camel.beans.myDS.dataSourceName = myDS
camel.beans.myDS.serverName = mypostrgress
camel.beans.myDS.databaseName = test
camel.beans.myDS.user = testuser
camel.beans.myDS.password = testpassword
camel.beans.myDS.maxConnections = 10
----

The bean is registered in the Camel Registry with the name `myDS`.

If you use the SQL component then the datasource can be configured on the SQL component:

[source,properties]
----
camel.component.sql.dataSource = #myDS
----

To refer to a custom bean you may want to favour using `#bean:` style, as this states the intention more clearly that its referring to a bean,
and not just a text value that happens to start with a `#` sign:

[source,properties]
----
camel.component.sql.dataSource = #bean:myDS
----

=== Creating a custom bean with constructor parameters

When creating a bean then parameters to the constructor can be provided.
Suppose we have a class `MyFoo` with a constructor:

[source,java]
----
public class MyFoo {
    private String name;
    private boolean important;
    private int id;

    public MyFoo(String name, boolean important, int id) {
        this.name = name;
        this.important = important;
        this.id = id;
    }
}
----

Then we can create a bean instance with name `foo` and provide parameters to the constructor as shown:

[source,properties]
----
camel.beans.foo = #class:com.foo.MyBean(""Hello World"", true, 123)
----

=== Optional parameters on beans

If a parameter on a bean is not mandatory then the parameter can be marked as optional using `?` syntax, as shown:

[source,properties]
----
camel.beans.foo = #class:com.foo.MyBean(""Hello World"", true, 123)
camel.beans.foo.?company = Acme
----

Then the company parameter is only set if `MyBean` has this option (silent ignore if no option present).
Otherwise if a parameter is set and the bean does not have such a parameter, then an exception is thrown by Camel.

=== Nested parameters on beans

You can configure nested parameters separating them via `.` (dot).

For example given this `Country` class:

[source,java]
----
public class Country {
    private String iso;
    private String name;

    public void setIso(String iso) {
        this.iso = iso;
    }

    public void setName(String name) {
        this.name = name;
    }
}
----

Which is an option on the `MyBean` class.
Then we can then configure its iso and name parameter as shown below:

[source,properties]
----
camel.beans.foo = #class:com.foo.MyBean(""Hello World"", true, 123)
camel.beans.foo.country.iso = USA
camel.beans.foo.country.name = United States of America
----

Camel will automatic create an instance of `Country` if `MyBean` has a getter/setter for this option, and that the `Country` bean
has a default no-arg constructor.

=== Configuring singleton beans by their type

In the example above the SQL component was configured with the name of the `DataSource`. There can be situations where you know there is only
a single instance of a data source in the Camel registry. In such a situation you can instead refer to the class
or interface type via the `#type:` prefix as shown below:

[source,properties]
----
camel.component.sql.dataSource = #type:javax.sql.DataSource
----

If there is no bean in the registry with the type `javax.sql.DataSource` then the option isn't configured.

=== Autowiring beans

The example above can be taken one step further by letting `camel-main` try to autowire the beans.

[source,properties]
----
camel.component.sql.dataSource = #autowired
----

In this situation then `#autowrired` will make Camel detect the type of the `dataSource` option on the `SQL` component.
As the type is a `javax.sql.DataSource` instance, then Camel will lookup in the registry if there is a single instance of the same type.
If there is no such bean then the option isn't configured.

== Defining a Map bean

You can specify `java.util.Map` beans in `camel-main` via properties (such as in the `application.properties` file).

Maps have a special syntax with brackets as shown below:

[source,properties]
----
camel.beans.mymap[table] = 12
camel.beans.mymap[food] = Big Burger
camel.beans.mymap[cheese] = yes
camel.beans.mymap[quantity] = 1
----

The Map is registered in the Camel Registry with the name `mymap`.

== Defining a List bean

This is similar to Map bean where the key is the index, eg 0, 1, 2, etc:

[source,properties]
----
camel.beans.myprojects[0] = Camel
camel.beans.myprojects[1] = Kafka
camel.beans.myprojects[2] = Quarkus
----

The List is registered in the Camel Registry with the name `myprojects`.

== Examples

You can find a set of examples using `camel-main` in https://github.com/apache/camel-examples[Camel Examples]
which demonstrate running Camel in standalone with `camel-main`.
",12404,False,2156.894746080707,median
"CLASS zcl_abapgit_ajson DEFINITION
  PUBLIC
  CREATE PRIVATE .

  PUBLIC SECTION.

    INTERFACES zif_abapgit_ajson .

    ALIASES:
      exists FOR zif_abapgit_ajson~exists,
      members FOR zif_abapgit_ajson~members,
      get FOR zif_abapgit_ajson~get,
      get_boolean FOR zif_abapgit_ajson~get_boolean,
      get_integer FOR zif_abapgit_ajson~get_integer,
      get_number FOR zif_abapgit_ajson~get_number,
      get_date FOR zif_abapgit_ajson~get_date,
      get_timestamp FOR zif_abapgit_ajson~get_timestamp,
      get_string FOR zif_abapgit_ajson~get_string,
      slice FOR zif_abapgit_ajson~slice,
      to_abap FOR zif_abapgit_ajson~to_abap,
      array_to_string_table FOR zif_abapgit_ajson~array_to_string_table.

    ALIASES:
      clear FOR zif_abapgit_ajson~clear,
      set FOR zif_abapgit_ajson~set,
      set_boolean FOR zif_abapgit_ajson~set_boolean,
      set_string FOR zif_abapgit_ajson~set_string,
      set_integer FOR zif_abapgit_ajson~set_integer,
      set_date FOR zif_abapgit_ajson~set_date,
      set_timestamp FOR zif_abapgit_ajson~set_timestamp,
      set_null FOR zif_abapgit_ajson~set_null,
      delete FOR zif_abapgit_ajson~delete,
      touch_array FOR zif_abapgit_ajson~touch_array,
      push FOR zif_abapgit_ajson~push,
      stringify FOR zif_abapgit_ajson~stringify.

    ALIASES:
      mt_json_tree FOR zif_abapgit_ajson~mt_json_tree,
      keep_item_order FOR zif_abapgit_ajson~keep_item_order,
      freeze FOR zif_abapgit_ajson~freeze.

    CLASS-METHODS parse
      IMPORTING
        !iv_json           TYPE string
        !iv_freeze         TYPE abap_bool DEFAULT abap_false
        !ii_custom_mapping TYPE REF TO zif_abapgit_ajson_mapping OPTIONAL
      RETURNING
        VALUE(ro_instance) TYPE REF TO zcl_abapgit_ajson
      RAISING
        zcx_abapgit_ajson_error .

    CLASS-METHODS create_empty
      IMPORTING
        !ii_custom_mapping TYPE REF TO zif_abapgit_ajson_mapping OPTIONAL
      RETURNING
        VALUE(ro_instance) TYPE REF TO zcl_abapgit_ajson.

  PROTECTED SECTION.

  PRIVATE SECTION.

    TYPES:
      tty_node_stack TYPE STANDARD TABLE OF REF TO zif_abapgit_ajson=>ty_node WITH DEFAULT KEY.

    DATA mv_read_only TYPE abap_bool.
    DATA mi_custom_mapping TYPE REF TO zif_abapgit_ajson_mapping.
    DATA mv_keep_item_order TYPE abap_bool.

    METHODS get_item
      IMPORTING
        iv_path        TYPE string
      RETURNING
        VALUE(rv_item) TYPE REF TO zif_abapgit_ajson=>ty_node.
    METHODS prove_path_exists
      IMPORTING
        iv_path              TYPE string
      RETURNING
        VALUE(rt_node_stack) TYPE tty_node_stack
      RAISING
        zcx_abapgit_ajson_error.
    METHODS delete_subtree
      IMPORTING
        iv_path           TYPE string
        iv_name           TYPE string
      RETURNING
        VALUE(rv_deleted) TYPE abap_bool.

ENDCLASS.



CLASS zcl_abapgit_ajson IMPLEMENTATION.


  METHOD create_empty.
    CREATE OBJECT ro_instance.
    ro_instance->mi_custom_mapping = ii_custom_mapping.
  ENDMETHOD.


  METHOD delete_subtree.

    DATA lv_parent_path TYPE string.
    DATA lv_parent_path_len TYPE i.
    FIELD-SYMBOLS <node> LIKE LINE OF mt_json_tree.
    READ TABLE mt_json_tree ASSIGNING <node>
      WITH KEY
        path = iv_path
        name = iv_name.
    IF sy-subrc = 0. "" Found ? delete !
      IF <node>-children > 0. "" only for objects and arrays
        lv_parent_path = iv_path && iv_name && '/'.
        lv_parent_path_len = strlen( lv_parent_path ).
        LOOP AT mt_json_tree ASSIGNING <node>.
          IF strlen( <node>-path ) >= lv_parent_path_len
            AND substring( val = <node>-path
                           len = lv_parent_path_len ) = lv_parent_path.
            DELETE mt_json_tree INDEX sy-tabix.
          ENDIF.
        ENDLOOP.
      ENDIF.

      DELETE mt_json_tree WHERE path = iv_path AND name = iv_name.
      rv_deleted = abap_true.

      DATA ls_path TYPE zif_abapgit_ajson=>ty_path_name.
      ls_path = lcl_utils=>split_path( iv_path ).
      READ TABLE mt_json_tree ASSIGNING <node>
        WITH KEY
          path = ls_path-path
          name = ls_path-name.
      IF sy-subrc = 0.
        <node>-children = <node>-children - 1.
      ENDIF.
    ENDIF.

  ENDMETHOD.


  METHOD get_item.

    FIELD-SYMBOLS <item> LIKE LINE OF mt_json_tree.
    DATA ls_path_name TYPE zif_abapgit_ajson=>ty_path_name.
    ls_path_name = lcl_utils=>split_path( iv_path ).

    READ TABLE mt_json_tree
      ASSIGNING <item>
      WITH KEY
        path = ls_path_name-path
        name = ls_path_name-name.
    IF sy-subrc = 0.
      GET REFERENCE OF <item> INTO rv_item.
    ENDIF.

  ENDMETHOD.


  METHOD parse.

    DATA lo_parser TYPE REF TO lcl_json_parser.

    CREATE OBJECT ro_instance.
    CREATE OBJECT lo_parser.
    ro_instance->mt_json_tree = lo_parser->parse( iv_json ).
    ro_instance->mi_custom_mapping = ii_custom_mapping.

    IF iv_freeze = abap_true.
      ro_instance->freeze( ).
    ENDIF.

  ENDMETHOD.


  METHOD prove_path_exists.

    DATA lt_path TYPE string_table.
    DATA lr_node LIKE LINE OF rt_node_stack.
    DATA lr_node_parent LIKE LINE OF rt_node_stack.
    DATA lv_cur_path TYPE string.
    DATA lv_cur_name TYPE string.
    DATA ls_new_node LIKE LINE OF mt_json_tree.

    SPLIT iv_path AT '/' INTO TABLE lt_path.
    DELETE lt_path WHERE table_line IS INITIAL.

    DO.
      lr_node_parent = lr_node.
      READ TABLE mt_json_tree REFERENCE INTO lr_node
        WITH KEY
          path = lv_cur_path
          name = lv_cur_name.
      IF sy-subrc <> 0. "" New node, assume it is always object as it has a named child, use touch_array to init array
        CLEAR ls_new_node.
        IF lr_node_parent IS NOT INITIAL. "" if has parent
          lr_node_parent->children = lr_node_parent->children + 1.
          IF lr_node_parent->type = zif_abapgit_ajson=>node_type-array.
            ls_new_node-index = lcl_utils=>validate_array_index(
              iv_path  = lv_cur_path
              iv_index = lv_cur_name ).
          ENDIF.
        ENDIF.
        ls_new_node-path = lv_cur_path.
        ls_new_node-name = lv_cur_name.
        ls_new_node-type = zif_abapgit_ajson=>node_type-object.
        INSERT ls_new_node INTO TABLE mt_json_tree REFERENCE INTO lr_node.
      ENDIF.
      INSERT lr_node INTO rt_node_stack INDEX 1.
      lv_cur_path = lv_cur_path && lv_cur_name && '/'.
      READ TABLE lt_path INDEX sy-index INTO lv_cur_name.
      IF sy-subrc <> 0.
        EXIT. "" no more segments
      ENDIF.
    ENDDO.

    ASSERT lv_cur_path = iv_path. "" Just in case

  ENDMETHOD.


  METHOD zif_abapgit_ajson~array_to_string_table.

    DATA lv_normalized_path TYPE string.
    DATA lr_node TYPE REF TO zif_abapgit_ajson=>ty_node.
    FIELD-SYMBOLS <item> LIKE LINE OF mt_json_tree.

    lv_normalized_path = lcl_utils=>normalize_path( iv_path ).
    lr_node = get_item( iv_path ).

    IF lr_node IS INITIAL.
      zcx_abapgit_ajson_error=>raise( |Path not found: { iv_path }| ).
    ENDIF.
    IF lr_node->type <> zif_abapgit_ajson=>node_type-array.
      zcx_abapgit_ajson_error=>raise( |Array expected at: { iv_path }| ).
    ENDIF.

    LOOP AT mt_json_tree ASSIGNING <item> WHERE path = lv_normalized_path.
      CASE <item>-type.
        WHEN zif_abapgit_ajson=>node_type-number OR zif_abapgit_ajson=>node_type-string.
          APPEND <item>-value TO rt_string_table.
        WHEN zif_abapgit_ajson=>node_type-null.
          APPEND '' TO rt_string_table.
        WHEN zif_abapgit_ajson=>node_type-boolean.
          DATA lv_tmp TYPE string.
          IF <item>-value = 'true'.
            lv_tmp = abap_true.
          ELSE.
            CLEAR lv_tmp.
          ENDIF.
          APPEND lv_tmp TO rt_string_table.
        WHEN OTHERS.
          zcx_abapgit_ajson_error=>raise( |Cannot convert [{ <item>-type
            }] to string at [{ <item>-path }{ <item>-name }]| ).
      ENDCASE.
    ENDLOOP.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~clear.

    IF mv_read_only = abap_true.
      zcx_abapgit_ajson_error=>raise( 'This json instance is read only' ).
    ENDIF.

    CLEAR mt_json_tree.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~delete.

    IF mv_read_only = abap_true.
      zcx_abapgit_ajson_error=>raise( 'This json instance is read only' ).
    ENDIF.

    DATA ls_split_path TYPE zif_abapgit_ajson=>ty_path_name.
    ls_split_path = lcl_utils=>split_path( iv_path ).

    delete_subtree(
      iv_path = ls_split_path-path
      iv_name = ls_split_path-name ).

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~exists.

    DATA lv_item TYPE REF TO zif_abapgit_ajson=>ty_node.
    lv_item = get_item( iv_path ).
    IF lv_item IS NOT INITIAL.
      rv_exists = abap_true.
    ENDIF.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~freeze.
    mv_read_only = abap_true.
  ENDMETHOD.


  METHOD zif_abapgit_ajson~get.

    DATA lv_item TYPE REF TO zif_abapgit_ajson=>ty_node.
    lv_item = get_item( iv_path ).
    IF lv_item IS NOT INITIAL.
      rv_value = lv_item->value.
    ENDIF.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~get_boolean.

    DATA lv_item TYPE REF TO zif_abapgit_ajson=>ty_node.
    lv_item = get_item( iv_path ).
    IF lv_item IS INITIAL OR lv_item->type = zif_abapgit_ajson=>node_type-null.
      RETURN.
    ELSEIF lv_item->type = zif_abapgit_ajson=>node_type-boolean.
      rv_value = boolc( lv_item->value = 'true' ).
    ELSEIF lv_item->value IS NOT INITIAL.
      rv_value = abap_true.
    ENDIF.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~get_date.

    DATA lv_item TYPE REF TO zif_abapgit_ajson=>ty_node.
    DATA lv_y TYPE c LENGTH 4.
    DATA lv_m TYPE c LENGTH 2.
    DATA lv_d TYPE c LENGTH 2.

    lv_item = get_item( iv_path ).

    IF lv_item IS NOT INITIAL AND lv_item->type = zif_abapgit_ajson=>node_type-string.
      FIND FIRST OCCURRENCE OF REGEX '^(\\d{4})-(\\d{2})-(\\d{2})(T|$)'
        IN lv_item->value
        SUBMATCHES lv_y lv_m lv_d.
      CONCATENATE lv_y lv_m lv_d INTO rv_value.
    ENDIF.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~get_integer.

    DATA lv_item TYPE REF TO zif_abapgit_ajson=>ty_node.
    lv_item = get_item( iv_path ).
    IF lv_item IS NOT INITIAL AND lv_item->type = zif_abapgit_ajson=>node_type-number.
      rv_value = lv_item->value.
    ENDIF.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~get_node_type.

    DATA lv_item TYPE REF TO zif_abapgit_ajson=>ty_node.
    lv_item = get_item( iv_path ).
    IF lv_item IS NOT INITIAL.
      rv_node_type = lv_item->type.
    ENDIF.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~get_number.

    DATA lv_item TYPE REF TO zif_abapgit_ajson=>ty_node.
    lv_item = get_item( iv_path ).
    IF lv_item IS NOT INITIAL AND lv_item->type = zif_abapgit_ajson=>node_type-number.
      rv_value = lv_item->value.
    ENDIF.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~get_string.

    DATA lv_item TYPE REF TO zif_abapgit_ajson=>ty_node.
    lv_item = get_item( iv_path ).
    IF lv_item IS NOT INITIAL AND lv_item->type <> zif_abapgit_ajson=>node_type-null.
      rv_value = lv_item->value.
    ENDIF.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~get_timestamp.

    DATA lo_to_abap TYPE REF TO lcl_json_to_abap.
    DATA lr_item TYPE REF TO zif_abapgit_ajson=>ty_node.

    lr_item = get_item( iv_path ).

    IF lr_item IS INITIAL.
      RETURN.
    ENDIF.

    CREATE OBJECT lo_to_abap.

    TRY.
        rv_value = lo_to_abap->to_timestamp( is_path = lr_item->* ).
      CATCH zcx_abapgit_ajson_error.
        RETURN.
    ENDTRY.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~keep_item_order.
    mv_keep_item_order = abap_true.
    ri_json = me.
  ENDMETHOD.


  METHOD zif_abapgit_ajson~members.

    DATA lv_normalized_path TYPE string.
    FIELD-SYMBOLS <item> LIKE LINE OF mt_json_tree.

    lv_normalized_path = lcl_utils=>normalize_path( iv_path ).

    LOOP AT mt_json_tree ASSIGNING <item> WHERE path = lv_normalized_path.
      APPEND <item>-name TO rt_members.
    ENDLOOP.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~push.

    DATA lr_parent TYPE REF TO zif_abapgit_ajson=>ty_node.
    DATA lr_new_node TYPE REF TO zif_abapgit_ajson=>ty_node.

    IF mv_read_only = abap_true.
      zcx_abapgit_ajson_error=>raise( 'This json instance is read only' ).
    ENDIF.

    lr_parent = get_item( iv_path ).

    IF lr_parent IS INITIAL.
      zcx_abapgit_ajson_error=>raise( |Path [{ iv_path }] does not exist| ).
    ENDIF.

    IF lr_parent->type <> zif_abapgit_ajson=>node_type-array.
      zcx_abapgit_ajson_error=>raise( |Path [{ iv_path }] is not array| ).
    ENDIF.

    DATA lt_new_nodes TYPE zif_abapgit_ajson=>ty_nodes_tt.
    DATA ls_new_path TYPE zif_abapgit_ajson=>ty_path_name.

    ls_new_path-path = lcl_utils=>normalize_path( iv_path ).
    ls_new_path-name = |{ lr_parent->children + 1 }|.

    lt_new_nodes = lcl_abap_to_json=>convert(
      iv_keep_item_order = mv_keep_item_order
      iv_data   = iv_val
      is_prefix = ls_new_path ).
    READ TABLE lt_new_nodes INDEX 1 REFERENCE INTO lr_new_node. "" assume first record is the array item - not ideal !
    ASSERT sy-subrc = 0.
    lr_new_node->index = lr_parent->children + 1.

    "" update data
    lr_parent->children = lr_parent->children + 1.
    INSERT LINES OF lt_new_nodes INTO TABLE mt_json_tree.

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~set.

    DATA ls_split_path TYPE zif_abapgit_ajson=>ty_path_name.
    DATA lr_parent TYPE REF TO zif_abapgit_ajson=>ty_node.
    DATA lt_node_stack TYPE tty_node_stack.

    IF mv_read_only = abap_true.
      zcx_abapgit_ajson_error=>raise( 'This json instance is read only' ).
    ENDIF.

    IF iv_val IS INITIAL AND iv_ignore_empty = abap_true AND iv_node_type IS INITIAL.
      RETURN. "" nothing to assign
    ENDIF.

    IF iv_node_type IS NOT INITIAL
      AND iv_node_type <> zif_abapgit_ajson=>node_type-boolean AND iv_node_type <> zif_abapgit_ajson=>node_type-null
      AND iv_node_type <> zif_abapgit_ajson=>node_type-number AND iv_node_type <> zif_abapgit_ajson=>node_type-string.
      zcx_abapgit_ajson_error=>raise( |Unexpected type { iv_node_type }| ).
    ENDIF.

    ls_split_path = lcl_utils=>split_path( iv_path ).
    IF ls_split_path IS INITIAL. "" Assign root, exceptional processing
      IF iv_node_type IS NOT INITIAL.
        mt_json_tree = lcl_abap_to_json=>insert_with_type(
          iv_keep_item_order = mv_keep_item_order
          iv_data            = iv_val
          iv_type            = iv_node_type
          is_prefix          = ls_split_path
          ii_custom_mapping  = mi_custom_mapping ).
      ELSE.
        mt_json_tree = lcl_abap_to_json=>convert(
          iv_keep_item_order = mv_keep_item_order
          iv_data            = iv_val
          is_prefix          = ls_split_path
          ii_custom_mapping  = mi_custom_mapping ).
      ENDIF.
      RETURN.
    ENDIF.

    "" Ensure whole path exists
    lt_node_stack = prove_path_exists( ls_split_path-path ).
    READ TABLE lt_node_stack INDEX 1 INTO lr_parent.
    ASSERT sy-subrc = 0.

    "" delete if exists with subtree
    delete_subtree(
      iv_path = ls_split_path-path
      iv_name = ls_split_path-name ).

    "" convert to json
    DATA lt_new_nodes TYPE zif_abapgit_ajson=>ty_nodes_tt.
    DATA lv_array_index TYPE i.

    IF lr_parent->type = zif_abapgit_ajson=>node_type-array.
      lv_array_index = lcl_utils=>validate_array_index(
        iv_path  = ls_split_path-path
        iv_index = ls_split_path-name ).
    ENDIF.

    IF iv_node_type IS NOT INITIAL.
      lt_new_nodes = lcl_abap_to_json=>insert_with_type(
        iv_keep_item_order = mv_keep_item_order
        iv_data            = iv_val
        iv_type            = iv_node_type
        iv_array_index     = lv_array_index
        is_prefix          = ls_split_path
        ii_custom_mapping  = mi_custom_mapping ).
    ELSE.
      lt_new_nodes = lcl_abap_to_json=>convert(
        iv_keep_item_order = mv_keep_item_order
        iv_data            = iv_val
        iv_array_index     = lv_array_index
        is_prefix          = ls_split_path
        ii_custom_mapping  = mi_custom_mapping ).
    ENDIF.

    "" update data
    lr_parent->children = lr_parent->children + 1.
    INSERT LINES OF lt_new_nodes INTO TABLE mt_json_tree.

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~set_boolean.

    DATA lv_bool TYPE abap_bool.
    lv_bool = boolc( iv_val IS NOT INITIAL ).
    zif_abapgit_ajson~set(
      iv_ignore_empty = abap_false
      iv_path = iv_path
      iv_val  = lv_bool ).

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~set_date.

    DATA lv_val TYPE string.

    IF iv_val IS NOT INITIAL.
      lv_val = iv_val+0(4) && '-' && iv_val+4(2) && '-' && iv_val+6(2).
    ENDIF.

    zif_abapgit_ajson~set(
      iv_ignore_empty = abap_false
      iv_path = iv_path
      iv_val  = lv_val ).

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~set_integer.

    zif_abapgit_ajson~set(
      iv_ignore_empty = abap_false
      iv_path = iv_path
      iv_val  = iv_val ).

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~set_null.

    DATA lv_null_ref TYPE REF TO data.
    zif_abapgit_ajson~set(
      iv_ignore_empty = abap_false
      iv_path = iv_path
      iv_val  = lv_null_ref ).

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~set_string.

    DATA lv_val TYPE string.
    lv_val = iv_val.
    zif_abapgit_ajson~set(
      iv_ignore_empty = abap_false
      iv_path = iv_path
      iv_val  = lv_val ).

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~set_timestamp.

    CONSTANTS lc_utc TYPE c LENGTH 6 VALUE 'UTC'.

    DATA:
      lv_date          TYPE d,
      lv_time          TYPE t,
      lv_timestamp_iso TYPE string.

    IF iv_val IS INITIAL.
      "" The zero value is January 1, year 1, 00:00:00.000000000 UTC.
      lv_date = '00010101'.
    ELSE.

      CONVERT TIME STAMP iv_val TIME ZONE lc_utc
        INTO DATE lv_date TIME lv_time.

    ENDIF.

    lv_timestamp_iso =
        lv_date+0(4) && '-' && lv_date+4(2) && '-' && lv_date+6(2) &&
        'T' &&
        lv_time+0(2) && '-' && lv_time+2(2) && '-' && lv_time+4(2) &&
        'Z'.

    zif_abapgit_ajson~set(
      iv_ignore_empty = abap_false
      iv_path = iv_path
      iv_val  = lv_timestamp_iso ).

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~slice.

    DATA lo_section         TYPE REF TO zcl_abapgit_ajson.
    DATA ls_item            LIKE LINE OF mt_json_tree.
    DATA lv_normalized_path TYPE string.
    DATA ls_path_parts      TYPE zif_abapgit_ajson=>ty_path_name.
    DATA lv_path_len        TYPE i.

    CREATE OBJECT lo_section.
    lv_normalized_path = lcl_utils=>normalize_path( iv_path ).
    lv_path_len        = strlen( lv_normalized_path ).
    ls_path_parts      = lcl_utils=>split_path( lv_normalized_path ).

    LOOP AT mt_json_tree INTO ls_item.
      "" TODO potentially improve performance due to sorted tree (all path started from same prefix go in a row)
      IF strlen( ls_item-path ) >= lv_path_len
          AND substring( val = ls_item-path
                         len = lv_path_len ) = lv_normalized_path.
        ls_item-path = substring( val = ls_item-path
                                  off = lv_path_len - 1 ). "" less closing '/'
        INSERT ls_item INTO TABLE lo_section->mt_json_tree.
      ELSEIF ls_item-path = ls_path_parts-path AND ls_item-name = ls_path_parts-name.
        CLEAR: ls_item-path, ls_item-name. "" this becomes a new root
        INSERT ls_item INTO TABLE lo_section->mt_json_tree.
      ENDIF.
    ENDLOOP.

    ri_json = lo_section.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~stringify.

    rv_json = lcl_json_serializer=>stringify(
      it_json_tree       = mt_json_tree
      iv_keep_item_order = mv_keep_item_order
      iv_indent          = iv_indent ).

  ENDMETHOD.


  METHOD zif_abapgit_ajson~touch_array.

    DATA lr_node TYPE REF TO zif_abapgit_ajson=>ty_node.
    DATA ls_new_node LIKE LINE OF mt_json_tree.
    DATA ls_split_path TYPE zif_abapgit_ajson=>ty_path_name.

    IF mv_read_only = abap_true.
      zcx_abapgit_ajson_error=>raise( 'This json instance is read only' ).
    ENDIF.

    ls_split_path = lcl_utils=>split_path( iv_path ).
    IF ls_split_path IS INITIAL. "" Assign root, exceptional processing
      ls_new_node-path = ls_split_path-path.
      ls_new_node-name = ls_split_path-name.
      ls_new_node-type = 'array'.
      INSERT ls_new_node INTO TABLE mt_json_tree.
      RETURN.
    ENDIF.

    IF iv_clear = abap_true.
      delete_subtree(
        iv_path = ls_split_path-path
        iv_name = ls_split_path-name ).
    ELSE.
      lr_node = get_item( iv_path ).
    ENDIF.

    IF lr_node IS INITIAL. "" Or node was cleared

      DATA lr_parent TYPE REF TO zif_abapgit_ajson=>ty_node.
      DATA lt_node_stack TYPE tty_node_stack.

      lt_node_stack = prove_path_exists( ls_split_path-path ).
      READ TABLE lt_node_stack INDEX 1 INTO lr_parent.
      ASSERT sy-subrc = 0.
      lr_parent->children = lr_parent->children + 1.

      ls_new_node-path = ls_split_path-path.
      ls_new_node-name = ls_split_path-name.
      ls_new_node-type = zif_abapgit_ajson=>node_type-array.
      INSERT ls_new_node INTO TABLE mt_json_tree.

    ELSEIF lr_node->type <> zif_abapgit_ajson=>node_type-array.
      zcx_abapgit_ajson_error=>raise( |Path [{ iv_path }] already used and is not array| ).
    ENDIF.

    ri_json = me.

  ENDMETHOD.


  METHOD zif_abapgit_ajson~to_abap.

    DATA lo_to_abap TYPE REF TO lcl_json_to_abap.

    CLEAR ev_container.
    lcl_json_to_abap=>bind(
      EXPORTING
        ii_custom_mapping = mi_custom_mapping
      CHANGING
        c_obj             = ev_container
        co_instance       = lo_to_abap ).
    lo_to_abap->to_abap( mt_json_tree ).

  ENDMETHOD.
ENDCLASS.
",6078,False,1419.514012395053,median
"/*
 * Licensed under the Apache License, Version 2.0 (the ""License"");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an ""AS IS"" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * This file is an adaptation of Presto's presto-parser/src/main/antlr4/com/facebook/presto/sql/parser/SqlBase.g4 grammar.
 */

grammar SqlBase;

@members {
  /**
   * Verify whether current token is a valid decimal token (which contains dot).
   * Returns true if the character that follows the token is not a digit or letter or underscore.
   *
   * For example:
   * For char stream ""2.3"", ""2."" is not a valid decimal token, because it is followed by digit '3'.
   * For char stream ""2.3_"", ""2.3"" is not a valid decimal token, because it is followed by '_'.
   * For char stream ""2.3W"", ""2.3"" is not a valid decimal token, because it is followed by 'W'.
   * For char stream ""12.0D 34.E2+0.12 ""  12.0D is a valid decimal token because it is folllowed
   * by a space. 34.E2 is a valid decimal token because it is followed by symbol '+'
   * which is not a digit or letter or underscore.
   */
  public boolean isValidDecimal() {
    int nextChar = _input.LA(1);
    if (nextChar >= 'A' && nextChar <= 'Z' || nextChar >= '0' && nextChar <= '9' ||
      nextChar == '_') {
      return false;
    } else {
      return true;
    }
  }
}

tokens {
    DELIMITER
}

singleStatement
    : statement EOF
    ;

singleExpression
    : namedExpression EOF
    ;

singleTableIdentifier
    : tableIdentifier EOF
    ;

singleFunctionIdentifier
    : functionIdentifier EOF
    ;

singleDataType
    : dataType EOF
    ;

singleTableSchema
    : colTypeList EOF
    ;

statement
    : query                                                            #statementDefault
    | USE db=identifier                                                #use
    | CREATE DATABASE (IF NOT EXISTS)? identifier
        (COMMENT comment=STRING)? locationSpec?
        (WITH DBPROPERTIES tablePropertyList)?                         #createDatabase
    | ALTER DATABASE identifier SET DBPROPERTIES tablePropertyList     #setDatabaseProperties
    | DROP DATABASE (IF EXISTS)? identifier (RESTRICT | CASCADE)?      #dropDatabase
    | createTableHeader ('(' colTypeList ')')? tableProvider
        (OPTIONS options=tablePropertyList)?
        (PARTITIONED BY partitionColumnNames=identifierList)?
        bucketSpec? locationSpec?
        (COMMENT comment=STRING)?
        (TBLPROPERTIES tableProps=tablePropertyList)?
        (AS? query)?                                                   #createTable
    | createTableHeader ('(' columns=colTypeList ')')?
        (COMMENT comment=STRING)?
        (PARTITIONED BY '(' partitionColumns=colTypeList ')')?
        bucketSpec? skewSpec?
        rowFormat?  createFileFormat? locationSpec?
        (TBLPROPERTIES tablePropertyList)?
        (AS? query)?                                                   #createHiveTable
    | CREATE TABLE (IF NOT EXISTS)? target=tableIdentifier
        LIKE source=tableIdentifier locationSpec?                      #createTableLike
    | ANALYZE TABLE tableIdentifier partitionSpec? COMPUTE STATISTICS
        (identifier | FOR COLUMNS identifierSeq)?                      #analyze
    | ALTER TABLE tableIdentifier
        ADD COLUMNS '(' columns=colTypeList ')'                        #addTableColumns
    | ALTER (TABLE | VIEW) from=tableIdentifier
        RENAME TO to=tableIdentifier                                   #renameTable
    | ALTER (TABLE | VIEW) tableIdentifier
        SET TBLPROPERTIES tablePropertyList                            #setTableProperties
    | ALTER (TABLE | VIEW) tableIdentifier
        UNSET TBLPROPERTIES (IF EXISTS)? tablePropertyList             #unsetTableProperties
    | ALTER TABLE tableIdentifier partitionSpec?
        CHANGE COLUMN? identifier colType colPosition?                 #changeColumn
    | ALTER TABLE tableIdentifier (partitionSpec)?
        SET SERDE STRING (WITH SERDEPROPERTIES tablePropertyList)?     #setTableSerDe
    | ALTER TABLE tableIdentifier (partitionSpec)?
        SET SERDEPROPERTIES tablePropertyList                          #setTableSerDe
    | ALTER TABLE tableIdentifier ADD (IF NOT EXISTS)?
        partitionSpecLocation+                                         #addTablePartition
    | ALTER VIEW tableIdentifier ADD (IF NOT EXISTS)?
        partitionSpec+                                                 #addTablePartition
    | ALTER TABLE tableIdentifier
        from=partitionSpec RENAME TO to=partitionSpec                  #renameTablePartition
    | ALTER TABLE tableIdentifier
        DROP (IF EXISTS)? partitionSpec (',' partitionSpec)* PURGE?    #dropTablePartitions
    | ALTER VIEW tableIdentifier
        DROP (IF EXISTS)? partitionSpec (',' partitionSpec)*           #dropTablePartitions
    | ALTER TABLE tableIdentifier partitionSpec? SET locationSpec      #setTableLocation
    | ALTER TABLE tableIdentifier RECOVER PARTITIONS                   #recoverPartitions
    | DROP TABLE (IF EXISTS)? tableIdentifier PURGE?                   #dropTable
    | DROP VIEW (IF EXISTS)? tableIdentifier                           #dropTable
    | CREATE (OR REPLACE)? (GLOBAL? TEMPORARY)?
        VIEW (IF NOT EXISTS)? tableIdentifier
        identifierCommentList? (COMMENT STRING)?
        (PARTITIONED ON identifierList)?
        (TBLPROPERTIES tablePropertyList)? AS query                    #createView
    | CREATE (OR REPLACE)? GLOBAL? TEMPORARY VIEW
        tableIdentifier ('(' colTypeList ')')? tableProvider
        (OPTIONS tablePropertyList)?                                   #createTempViewUsing
    | ALTER VIEW tableIdentifier AS? query                             #alterViewQuery
    | CREATE (OR REPLACE)? TEMPORARY? FUNCTION (IF NOT EXISTS)?
        qualifiedName AS className=STRING
        (USING resource (',' resource)*)?                              #createFunction
    | DROP TEMPORARY? FUNCTION (IF EXISTS)? qualifiedName              #dropFunction
    | EXPLAIN (LOGICAL | FORMATTED | EXTENDED | CODEGEN | COST)?
        statement                                                      #explain
    | SHOW TABLES ((FROM | IN) db=identifier)?
        (LIKE? pattern=STRING)?                                        #showTables
    | SHOW TABLE EXTENDED ((FROM | IN) db=identifier)?
        LIKE pattern=STRING partitionSpec?                             #showTable
    | SHOW DATABASES (LIKE pattern=STRING)?                            #showDatabases
    | SHOW TBLPROPERTIES table=tableIdentifier
        ('(' key=tablePropertyKey ')')?                                #showTblProperties
    | SHOW COLUMNS (FROM | IN) tableIdentifier
        ((FROM | IN) db=identifier)?                                   #showColumns
    | SHOW PARTITIONS tableIdentifier partitionSpec?                   #showPartitions
    | SHOW identifier? FUNCTIONS
        (LIKE? (qualifiedName | pattern=STRING))?                      #showFunctions
    | SHOW CREATE TABLE tableIdentifier                                #showCreateTable
    | (DESC | DESCRIBE) FUNCTION EXTENDED? describeFuncName            #describeFunction
    | (DESC | DESCRIBE) DATABASE EXTENDED? identifier                  #describeDatabase
    | (DESC | DESCRIBE) TABLE? option=(EXTENDED | FORMATTED)?
        tableIdentifier partitionSpec? describeColName?                #describeTable
    | REFRESH TABLE tableIdentifier                                    #refreshTable
    | REFRESH (STRING | .*?)                                           #refreshResource
    | CACHE LAZY? TABLE tableIdentifier (AS? query)?                   #cacheTable
    | UNCACHE TABLE (IF EXISTS)? tableIdentifier                       #uncacheTable
    | CLEAR CACHE                                                      #clearCache
    | LOAD DATA LOCAL? INPATH path=STRING OVERWRITE? INTO TABLE
        tableIdentifier partitionSpec?                                 #loadData
    | TRUNCATE TABLE tableIdentifier partitionSpec?                    #truncateTable
    | MSCK REPAIR TABLE tableIdentifier                                #repairTable
    | op=(ADD | LIST) identifier .*?                                   #manageResource
    | SET ROLE .*?                                                     #failNativeCommand
    | SET .*?                                                          #setConfiguration
    | RESET                                                            #resetConfiguration
    | unsupportedHiveNativeCommands .*?                                #failNativeCommand
    ;

unsupportedHiveNativeCommands
    : kw1=CREATE kw2=ROLE
    | kw1=DROP kw2=ROLE
    | kw1=GRANT kw2=ROLE?
    | kw1=REVOKE kw2=ROLE?
    | kw1=SHOW kw2=GRANT
    | kw1=SHOW kw2=ROLE kw3=GRANT?
    | kw1=SHOW kw2=PRINCIPALS
    | kw1=SHOW kw2=ROLES
    | kw1=SHOW kw2=CURRENT kw3=ROLES
    | kw1=EXPORT kw2=TABLE
    | kw1=IMPORT kw2=TABLE
    | kw1=SHOW kw2=COMPACTIONS
    | kw1=SHOW kw2=CREATE kw3=TABLE
    | kw1=SHOW kw2=TRANSACTIONS
    | kw1=SHOW kw2=INDEXES
    | kw1=SHOW kw2=LOCKS
    | kw1=CREATE kw2=INDEX
    | kw1=DROP kw2=INDEX
    | kw1=ALTER kw2=INDEX
    | kw1=LOCK kw2=TABLE
    | kw1=LOCK kw2=DATABASE
    | kw1=UNLOCK kw2=TABLE
    | kw1=UNLOCK kw2=DATABASE
    | kw1=CREATE kw2=TEMPORARY kw3=MACRO
    | kw1=DROP kw2=TEMPORARY kw3=MACRO
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=NOT kw4=CLUSTERED
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=CLUSTERED kw4=BY
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=NOT kw4=SORTED
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=SKEWED kw4=BY
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=NOT kw4=SKEWED
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=NOT kw4=STORED kw5=AS kw6=DIRECTORIES
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=SET kw4=SKEWED kw5=LOCATION
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=EXCHANGE kw4=PARTITION
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=ARCHIVE kw4=PARTITION
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=UNARCHIVE kw4=PARTITION
    | kw1=ALTER kw2=TABLE tableIdentifier kw3=TOUCH
    | kw1=ALTER kw2=TABLE tableIdentifier partitionSpec? kw3=COMPACT
    | kw1=ALTER kw2=TABLE tableIdentifier partitionSpec? kw3=CONCATENATE
    | kw1=ALTER kw2=TABLE tableIdentifier partitionSpec? kw3=SET kw4=FILEFORMAT
    | kw1=ALTER kw2=TABLE tableIdentifier partitionSpec? kw3=REPLACE kw4=COLUMNS
    | kw1=START kw2=TRANSACTION
    | kw1=COMMIT
    | kw1=ROLLBACK
    | kw1=DFS
    | kw1=DELETE kw2=FROM
    ;

createTableHeader
    : CREATE TEMPORARY? EXTERNAL? TABLE (IF NOT EXISTS)? tableIdentifier
    ;

bucketSpec
    : CLUSTERED BY identifierList
      (SORTED BY orderedIdentifierList)?
      INTO INTEGER_VALUE BUCKETS
    ;

skewSpec
    : SKEWED BY identifierList
      ON (constantList | nestedConstantList)
      (STORED AS DIRECTORIES)?
    ;

locationSpec
    : LOCATION STRING
    ;

query
    : ctes? queryNoWith
    ;

insertInto
    : INSERT OVERWRITE TABLE tableIdentifier (partitionSpec (IF NOT EXISTS)?)?                              #insertOverwriteTable
    | INSERT INTO TABLE? tableIdentifier partitionSpec?                                                     #insertIntoTable
    | INSERT OVERWRITE LOCAL? DIRECTORY path=STRING rowFormat? createFileFormat?                            #insertOverwriteHiveDir
    | INSERT OVERWRITE LOCAL? DIRECTORY (path=STRING)? tableProvider (OPTIONS options=tablePropertyList)?   #insertOverwriteDir
    ;

partitionSpecLocation
    : partitionSpec locationSpec?
    ;

partitionSpec
    : PARTITION '(' partitionVal (',' partitionVal)* ')'
    ;

partitionVal
    : identifier (EQ constant)?
    ;

describeFuncName
    : qualifiedName
    | STRING
    | comparisonOperator
    | arithmeticOperator
    | predicateOperator
    ;

describeColName
    : nameParts+=identifier ('.' nameParts+=identifier)*
    ;

ctes
    : WITH namedQuery (',' namedQuery)*
    ;

namedQuery
    : name=identifier AS? '(' query ')'
    ;

tableProvider
    : USING qualifiedName
    ;

tablePropertyList
    : '(' tableProperty (',' tableProperty)* ')'
    ;

tableProperty
    : key=tablePropertyKey (EQ? value=tablePropertyValue)?
    ;

tablePropertyKey
    : identifier ('.' identifier)*
    | STRING
    ;

tablePropertyValue
    : INTEGER_VALUE
    | DECIMAL_VALUE
    | booleanValue
    | STRING
    ;

constantList
    : '(' constant (',' constant)* ')'
    ;

nestedConstantList
    : '(' constantList (',' constantList)* ')'
    ;

createFileFormat
    : STORED AS fileFormat
    | STORED BY storageHandler
    ;

fileFormat
    : INPUTFORMAT inFmt=STRING OUTPUTFORMAT outFmt=STRING    #tableFileFormat
    | identifier                                             #genericFileFormat
    ;

storageHandler
    : STRING (WITH SERDEPROPERTIES tablePropertyList)?
    ;

resource
    : identifier STRING
    ;

queryNoWith
    : insertInto? queryTerm queryOrganization                                              #singleInsertQuery
    | fromClause multiInsertQueryBody+                                                     #multiInsertQuery
    ;

queryOrganization
    : (ORDER BY order+=sortItem (',' order+=sortItem)*)?
      (CLUSTER BY clusterBy+=expression (',' clusterBy+=expression)*)?
      (DISTRIBUTE BY distributeBy+=expression (',' distributeBy+=expression)*)?
      (SORT BY sort+=sortItem (',' sort+=sortItem)*)?
      windows?
      (LIMIT (ALL | limit=expression))?
    ;

multiInsertQueryBody
    : insertInto?
      querySpecification
      queryOrganization
    ;

queryTerm
    : queryPrimary                                                                         #queryTermDefault
    | left=queryTerm operator=(INTERSECT | UNION | EXCEPT | SETMINUS) setQuantifier? right=queryTerm  #setOperation
    ;

queryPrimary
    : querySpecification                                                    #queryPrimaryDefault
    | TABLE tableIdentifier                                                 #table
    | inlineTable                                                           #inlineTableDefault1
    | '(' queryNoWith  ')'                                                  #subquery
    ;

sortItem
    : expression ordering=(ASC | DESC)? (NULLS nullOrder=(LAST | FIRST))?
    ;

querySpecification
    : (((SELECT kind=TRANSFORM '(' namedExpressionSeq ')'
        | kind=MAP namedExpressionSeq
        | kind=REDUCE namedExpressionSeq))
       inRowFormat=rowFormat?
       (RECORDWRITER recordWriter=STRING)?
       USING script=STRING
       (AS (identifierSeq | colTypeList | ('(' (identifierSeq | colTypeList) ')')))?
       outRowFormat=rowFormat?
       (RECORDREADER recordReader=STRING)?
       fromClause?
       (WHERE where=booleanExpression)?)
    | ((kind=SELECT (hints+=hint)* setQuantifier? namedExpressionSeq fromClause?
       | fromClause (kind=SELECT setQuantifier? namedExpressionSeq)?)
       lateralView*
       (WHERE where=booleanExpression)?
       aggregation?
       (HAVING having=booleanExpression)?
       windows?)
    ;

hint
    : '/*+' hintStatements+=hintStatement (','? hintStatements+=hintStatement)* '*/'
    ;

hintStatement
    : hintName=identifier
    | hintName=identifier '(' parameters+=primaryExpression (',' parameters+=primaryExpression)* ')'
    ;

fromClause
    : FROM relation (',' relation)* lateralView*
    ;

aggregation
    : GROUP BY groupingExpressions+=expression (',' groupingExpressions+=expression)* (
      WITH kind=ROLLUP
    | WITH kind=CUBE
    | kind=GROUPING SETS '(' groupingSet (',' groupingSet)* ')')?
    ;

groupingSet
    : '(' (expression (',' expression)*)? ')'
    | expression
    ;

lateralView
    : LATERAL VIEW (OUTER)? qualifiedName '(' (expression (',' expression)*)? ')' tblName=identifier (AS? colName+=identifier (',' colName+=identifier)*)?
    ;

setQuantifier
    : DISTINCT
    | ALL
    ;

relation
    : relationPrimary joinRelation*
    ;

joinRelation
    : (joinType) JOIN right=relationPrimary joinCriteria?
    | NATURAL joinType JOIN right=relationPrimary
    ;

joinType
    : INNER?
    | CROSS
    | LEFT OUTER?
    | LEFT SEMI
    | RIGHT OUTER?
    | FULL OUTER?
    | LEFT? ANTI
    ;

joinCriteria
    : ON booleanExpression
    | USING '(' identifier (',' identifier)* ')'
    ;

sample
    : TABLESAMPLE '('
      ( (negativeSign=MINUS? percentage=(INTEGER_VALUE | DECIMAL_VALUE) sampleType=PERCENTLIT)
      | (expression sampleType=ROWS)
      | sampleType=BYTELENGTH_LITERAL
      | (sampleType=BUCKET numerator=INTEGER_VALUE OUT OF denominator=INTEGER_VALUE (ON (identifier | qualifiedName '(' ')'))?))
      ')'
    ;

identifierList
    : '(' identifierSeq ')'
    ;

identifierSeq
    : identifier (',' identifier)*
    ;

orderedIdentifierList
    : '(' orderedIdentifier (',' orderedIdentifier)* ')'
    ;

orderedIdentifier
    : identifier ordering=(ASC | DESC)?
    ;

identifierCommentList
    : '(' identifierComment (',' identifierComment)* ')'
    ;

identifierComment
    : identifier (COMMENT STRING)?
    ;

relationPrimary
    : tableIdentifier sample? tableAlias      #tableName
    | '(' queryNoWith ')' sample? tableAlias  #aliasedQuery
    | '(' relation ')' sample? tableAlias     #aliasedRelation
    | inlineTable                             #inlineTableDefault2
    | functionTable                           #tableValuedFunction
    ;

inlineTable
    : VALUES expression (',' expression)* tableAlias
    ;

functionTable
    : identifier '(' (expression (',' expression)*)? ')' tableAlias
    ;

tableAlias
    : (AS? strictIdentifier identifierList?)?
    ;

rowFormat
    : ROW FORMAT SERDE name=STRING (WITH SERDEPROPERTIES props=tablePropertyList)?  #rowFormatSerde
    | ROW FORMAT DELIMITED
      (FIELDS TERMINATED BY fieldsTerminatedBy=STRING (ESCAPED BY escapedBy=STRING)?)?
      (COLLECTION ITEMS TERMINATED BY collectionItemsTerminatedBy=STRING)?
      (MAP KEYS TERMINATED BY keysTerminatedBy=STRING)?
      (LINES TERMINATED BY linesSeparatedBy=STRING)?
      (NULL DEFINED AS nullDefinedAs=STRING)?                                       #rowFormatDelimited
    ;

tableIdentifier
    : (db=identifier '.')? table=identifier
    ;

functionIdentifier
    : (db=identifier '.')? function=identifier
    ;

namedExpression
    : expression (AS? (identifier | identifierList))?
    ;

namedExpressionSeq
    : namedExpression (',' namedExpression)*
    ;

expression
    : booleanExpression
    ;

booleanExpression
    : NOT booleanExpression                                        #logicalNot
    | EXISTS '(' query ')'                                         #exists
    | predicated                                                   #booleanDefault
    | left=booleanExpression operator=AND right=booleanExpression  #logicalBinary
    | left=booleanExpression operator=OR right=booleanExpression   #logicalBinary
    ;

// workaround for:
//  https://github.com/antlr/antlr4/issues/780
//  https://github.com/antlr/antlr4/issues/781
predicated
    : valueExpression predicate?
    ;

predicate
    : NOT? kind=BETWEEN lower=valueExpression AND upper=valueExpression
    | NOT? kind=IN '(' expression (',' expression)* ')'
    | NOT? kind=IN '(' query ')'
    | NOT? kind=(RLIKE | LIKE) pattern=valueExpression
    | IS NOT? kind=NULL
    | IS NOT? kind=DISTINCT FROM right=valueExpression
    ;

valueExpression
    : primaryExpression                                                                      #valueExpressionDefault
    | operator=(MINUS | PLUS | TILDE) valueExpression                                        #arithmeticUnary
    | left=valueExpression operator=(ASTERISK | SLASH | PERCENT | DIV) right=valueExpression #arithmeticBinary
    | left=valueExpression operator=(PLUS | MINUS | CONCAT_PIPE) right=valueExpression       #arithmeticBinary
    | left=valueExpression operator=AMPERSAND right=valueExpression                          #arithmeticBinary
    | left=valueExpression operator=HAT right=valueExpression                                #arithmeticBinary
    | left=valueExpression operator=PIPE right=valueExpression                               #arithmeticBinary
    | left=valueExpression comparisonOperator right=valueExpression                          #comparison
    ;

primaryExpression
    : name=(CURRENT_DATE | CURRENT_TIMESTAMP)                                                  #timeFunctionCall
    | CASE whenClause+ (ELSE elseExpression=expression)? END                                   #searchedCase
    | CASE value=expression whenClause+ (ELSE elseExpression=expression)? END                  #simpleCase
    | CAST '(' expression AS dataType ')'                                                      #cast
    | STRUCT '(' (argument+=namedExpression (',' argument+=namedExpression)*)? ')'             #struct
    | FIRST '(' expression (IGNORE NULLS)? ')'                                                 #first
    | LAST '(' expression (IGNORE NULLS)? ')'                                                  #last
    | POSITION '(' substr=valueExpression IN str=valueExpression ')'                           #position
    | constant                                                                                 #constantDefault
    | ASTERISK                                                                                 #star
    | qualifiedName '.' ASTERISK                                                               #star
    | '(' namedExpression (',' namedExpression)+ ')'                                           #rowConstructor
    | '(' query ')'                                                                            #subqueryExpression
    | qualifiedName '(' (setQuantifier? argument+=expression (',' argument+=expression)*)? ')'
       (OVER windowSpec)?                                                                      #functionCall
    | value=primaryExpression '[' index=valueExpression ']'                                    #subscript
    | identifier                                                                               #columnReference
    | base=primaryExpression '.' fieldName=identifier                                          #dereference
    | '(' expression ')'                                                                       #parenthesizedExpression
    ;

constant
    : NULL                                                                                     #nullLiteral
    | interval                                                                                 #intervalLiteral
    | identifier STRING                                                                        #typeConstructor
    | number                                                                                   #numericLiteral
    | booleanValue                                                                             #booleanLiteral
    | STRING+                                                                                  #stringLiteral
    ;

comparisonOperator
    : EQ | NEQ | NEQJ | LT | LTE | GT | GTE | NSEQ
    ;

arithmeticOperator
    : PLUS | MINUS | ASTERISK | SLASH | PERCENT | DIV | TILDE | AMPERSAND | PIPE | CONCAT_PIPE | HAT
    ;

predicateOperator
    : OR | AND | IN | NOT
    ;

booleanValue
    : TRUE | FALSE
    ;

interval
    : INTERVAL intervalField*
    ;

intervalField
    : value=intervalValue unit=identifier (TO to=identifier)?
    ;

intervalValue
    : (PLUS | MINUS)? (INTEGER_VALUE | DECIMAL_VALUE)
    | STRING
    ;

colPosition
    : FIRST | AFTER identifier
    ;

dataType
    : complex=ARRAY '<' dataType '>'                            #complexDataType
    | complex=MAP '<' dataType ',' dataType '>'                 #complexDataType
    | complex=STRUCT ('<' complexColTypeList? '>' | NEQ)        #complexDataType
    | identifier ('(' INTEGER_VALUE (',' INTEGER_VALUE)* ')')?  #primitiveDataType
    ;

colTypeList
    : colType (',' colType)*
    ;

colType
    : identifier dataType (COMMENT STRING)?
    ;

complexColTypeList
    : complexColType (',' complexColType)*
    ;

complexColType
    : identifier ':' dataType (COMMENT STRING)?
    ;

whenClause
    : WHEN condition=expression THEN result=expression
    ;

windows
    : WINDOW namedWindow (',' namedWindow)*
    ;

namedWindow
    : identifier AS windowSpec
    ;

windowSpec
    : name=identifier  #windowRef
    | '('
      ( CLUSTER BY partition+=expression (',' partition+=expression)*
      | ((PARTITION | DISTRIBUTE) BY partition+=expression (',' partition+=expression)*)?
        ((ORDER | SORT) BY sortItem (',' sortItem)*)?)
      windowFrame?
      ')'              #windowDef
    ;

windowFrame
    : frameType=RANGE start=frameBound
    | frameType=ROWS start=frameBound
    | frameType=RANGE BETWEEN start=frameBound AND end=frameBound
    | frameType=ROWS BETWEEN start=frameBound AND end=frameBound
    ;

frameBound
    : UNBOUNDED boundType=(PRECEDING | FOLLOWING)
    | boundType=CURRENT ROW
    | expression boundType=(PRECEDING | FOLLOWING)
    ;

qualifiedName
    : identifier ('.' identifier)*
    ;

identifier
    : strictIdentifier
    | ANTI | FULL | INNER | LEFT | SEMI | RIGHT | NATURAL | JOIN | CROSS | ON
    | UNION | INTERSECT | EXCEPT | SETMINUS
    ;

strictIdentifier
    : IDENTIFIER             #unquotedIdentifier
    | quotedIdentifier       #quotedIdentifierAlternative
    | nonReserved            #unquotedIdentifier
    ;

quotedIdentifier
    : BACKQUOTED_IDENTIFIER
    ;

number
    : MINUS? DECIMAL_VALUE            #decimalLiteral
    | MINUS? INTEGER_VALUE            #integerLiteral
    | MINUS? BIGINT_LITERAL           #bigIntLiteral
    | MINUS? SMALLINT_LITERAL         #smallIntLiteral
    | MINUS? TINYINT_LITERAL          #tinyIntLiteral
    | MINUS? DOUBLE_LITERAL           #doubleLiteral
    | MINUS? BIGDECIMAL_LITERAL       #bigDecimalLiteral
    ;

nonReserved
    : SHOW | TABLES | COLUMNS | COLUMN | PARTITIONS | FUNCTIONS | DATABASES
    | ADD
    | OVER | PARTITION | RANGE | ROWS | PRECEDING | FOLLOWING | CURRENT | ROW | LAST | FIRST | AFTER
    | MAP | ARRAY | STRUCT
    | LATERAL | WINDOW | REDUCE | TRANSFORM | SERDE | SERDEPROPERTIES | RECORDREADER
    | DELIMITED | FIELDS | TERMINATED | COLLECTION | ITEMS | KEYS | ESCAPED | LINES | SEPARATED
    | EXTENDED | REFRESH | CLEAR | CACHE | UNCACHE | LAZY | GLOBAL | TEMPORARY | OPTIONS
    | GROUPING | CUBE | ROLLUP
    | EXPLAIN | FORMAT | LOGICAL | FORMATTED | CODEGEN | COST
    | TABLESAMPLE | USE | TO | BUCKET | PERCENTLIT | OUT | OF
    | SET | RESET
    | VIEW | REPLACE
    | IF
    | POSITION
    | NO | DATA
    | START | TRANSACTION | COMMIT | ROLLBACK | IGNORE
    | SORT | CLUSTER | DISTRIBUTE | UNSET | TBLPROPERTIES | SKEWED | STORED | DIRECTORIES | LOCATION
    | EXCHANGE | ARCHIVE | UNARCHIVE | FILEFORMAT | TOUCH | COMPACT | CONCATENATE | CHANGE
    | CASCADE | RESTRICT | BUCKETS | CLUSTERED | SORTED | PURGE | INPUTFORMAT | OUTPUTFORMAT
    | DBPROPERTIES | DFS | TRUNCATE | COMPUTE | LIST
    | STATISTICS | ANALYZE | PARTITIONED | EXTERNAL | DEFINED | RECORDWRITER
    | REVOKE | GRANT | LOCK | UNLOCK | MSCK | REPAIR | RECOVER | EXPORT | IMPORT | LOAD | VALUES | COMMENT | ROLE
    | ROLES | COMPACTIONS | PRINCIPALS | TRANSACTIONS | INDEX | INDEXES | LOCKS | OPTION | LOCAL | INPATH
    | ASC | DESC | LIMIT | RENAME | SETS
    | AT | NULLS | OVERWRITE | ALL | ALTER | AS | BETWEEN | BY | CREATE | DELETE
    | DESCRIBE | DROP | EXISTS | FALSE | FOR | GROUP | IN | INSERT | INTO | IS |LIKE
    | NULL | ORDER | OUTER | TABLE | TRUE | WITH | RLIKE
    | AND | CASE | CAST | DISTINCT | DIV | ELSE | END | FUNCTION | INTERVAL | MACRO | OR | STRATIFY | THEN
    | UNBOUNDED | WHEN
    | DATABASE | SELECT | FROM | WHERE | HAVING | TO | TABLE | WITH | NOT | CURRENT_DATE | CURRENT_TIMESTAMP
    | DIRECTORY
    ;

SELECT: 'SELECT';
FROM: 'FROM';
ADD: 'ADD';
AS: 'AS';
ALL: 'ALL';
DISTINCT: 'DISTINCT';
WHERE: 'WHERE';
GROUP: 'GROUP';
BY: 'BY';
GROUPING: 'GROUPING';
SETS: 'SETS';
CUBE: 'CUBE';
ROLLUP: 'ROLLUP';
ORDER: 'ORDER';
HAVING: 'HAVING';
LIMIT: 'LIMIT';
AT: 'AT';
OR: 'OR';
AND: 'AND';
IN: 'IN';
NOT: 'NOT' | '!';
NO: 'NO';
EXISTS: 'EXISTS';
BETWEEN: 'BETWEEN';
LIKE: 'LIKE';
RLIKE: 'RLIKE' | 'REGEXP';
IS: 'IS';
NULL: 'NULL';
TRUE: 'TRUE';
FALSE: 'FALSE';
NULLS: 'NULLS';
ASC: 'ASC';
DESC: 'DESC';
FOR: 'FOR';
INTERVAL: 'INTERVAL';
CASE: 'CASE';
WHEN: 'WHEN';
THEN: 'THEN';
ELSE: 'ELSE';
END: 'END';
JOIN: 'JOIN';
CROSS: 'CROSS';
OUTER: 'OUTER';
INNER: 'INNER';
LEFT: 'LEFT';
SEMI: 'SEMI';
RIGHT: 'RIGHT';
FULL: 'FULL';
NATURAL: 'NATURAL';
ON: 'ON';
LATERAL: 'LATERAL';
WINDOW: 'WINDOW';
OVER: 'OVER';
PARTITION: 'PARTITION';
RANGE: 'RANGE';
ROWS: 'ROWS';
UNBOUNDED: 'UNBOUNDED';
PRECEDING: 'PRECEDING';
FOLLOWING: 'FOLLOWING';
CURRENT: 'CURRENT';
FIRST: 'FIRST';
AFTER: 'AFTER';
LAST: 'LAST';
ROW: 'ROW';
WITH: 'WITH';
VALUES: 'VALUES';
CREATE: 'CREATE';
TABLE: 'TABLE';
DIRECTORY: 'DIRECTORY';
VIEW: 'VIEW';
REPLACE: 'REPLACE';
INSERT: 'INSERT';
DELETE: 'DELETE';
INTO: 'INTO';
DESCRIBE: 'DESCRIBE';
EXPLAIN: 'EXPLAIN';
FORMAT: 'FORMAT';
LOGICAL: 'LOGICAL';
CODEGEN: 'CODEGEN';
COST: 'COST';
CAST: 'CAST';
SHOW: 'SHOW';
TABLES: 'TABLES';
COLUMNS: 'COLUMNS';
COLUMN: 'COLUMN';
USE: 'USE';
PARTITIONS: 'PARTITIONS';
FUNCTIONS: 'FUNCTIONS';
DROP: 'DROP';
UNION: 'UNION';
EXCEPT: 'EXCEPT';
SETMINUS: 'MINUS';
INTERSECT: 'INTERSECT';
TO: 'TO';
TABLESAMPLE: 'TABLESAMPLE';
STRATIFY: 'STRATIFY';
ALTER: 'ALTER';
RENAME: 'RENAME';
ARRAY: 'ARRAY';
MAP: 'MAP';
STRUCT: 'STRUCT';
COMMENT: 'COMMENT';
SET: 'SET';
RESET: 'RESET';
DATA: 'DATA';
START: 'START';
TRANSACTION: 'TRANSACTION';
COMMIT: 'COMMIT';
ROLLBACK: 'ROLLBACK';
MACRO: 'MACRO';
IGNORE: 'IGNORE';

IF: 'IF';
POSITION: 'POSITION';

EQ  : '=' | '==';
NSEQ: '<=>';
NEQ : '<>';
NEQJ: '!=';
LT  : '<';
LTE : '<=' | '!>';
GT  : '>';
GTE : '>=' | '!<';

PLUS: '+';
MINUS: '-';
ASTERISK: '*';
SLASH: '/';
PERCENT: '%';
DIV: 'DIV';
TILDE: '~';
AMPERSAND: '&';
PIPE: '|';
CONCAT_PIPE: '||';
HAT: '^';

PERCENTLIT: 'PERCENT';
BUCKET: 'BUCKET';
OUT: 'OUT';
OF: 'OF';

SORT: 'SORT';
CLUSTER: 'CLUSTER';
DISTRIBUTE: 'DISTRIBUTE';
OVERWRITE: 'OVERWRITE';
TRANSFORM: 'TRANSFORM';
REDUCE: 'REDUCE';
USING: 'USING';
SERDE: 'SERDE';
SERDEPROPERTIES: 'SERDEPROPERTIES';
RECORDREADER: 'RECORDREADER';
RECORDWRITER: 'RECORDWRITER';
DELIMITED: 'DELIMITED';
FIELDS: 'FIELDS';
TERMINATED: 'TERMINATED';
COLLECTION: 'COLLECTION';
ITEMS: 'ITEMS';
KEYS: 'KEYS';
ESCAPED: 'ESCAPED';
LINES: 'LINES';
SEPARATED: 'SEPARATED';
FUNCTION: 'FUNCTION';
EXTENDED: 'EXTENDED';
REFRESH: 'REFRESH';
CLEAR: 'CLEAR';
CACHE: 'CACHE';
UNCACHE: 'UNCACHE';
LAZY: 'LAZY';
FORMATTED: 'FORMATTED';
GLOBAL: 'GLOBAL';
TEMPORARY: 'TEMPORARY' | 'TEMP';
OPTIONS: 'OPTIONS';
UNSET: 'UNSET';
TBLPROPERTIES: 'TBLPROPERTIES';
DBPROPERTIES: 'DBPROPERTIES';
BUCKETS: 'BUCKETS';
SKEWED: 'SKEWED';
STORED: 'STORED';
DIRECTORIES: 'DIRECTORIES';
LOCATION: 'LOCATION';
EXCHANGE: 'EXCHANGE';
ARCHIVE: 'ARCHIVE';
UNARCHIVE: 'UNARCHIVE';
FILEFORMAT: 'FILEFORMAT';
TOUCH: 'TOUCH';
COMPACT: 'COMPACT';
CONCATENATE: 'CONCATENATE';
CHANGE: 'CHANGE';
CASCADE: 'CASCADE';
RESTRICT: 'RESTRICT';
CLUSTERED: 'CLUSTERED';
SORTED: 'SORTED';
PURGE: 'PURGE';
INPUTFORMAT: 'INPUTFORMAT';
OUTPUTFORMAT: 'OUTPUTFORMAT';
DATABASE: 'DATABASE' | 'SCHEMA';
DATABASES: 'DATABASES' | 'SCHEMAS';
DFS: 'DFS';
TRUNCATE: 'TRUNCATE';
ANALYZE: 'ANALYZE';
COMPUTE: 'COMPUTE';
LIST: 'LIST';
STATISTICS: 'STATISTICS';
PARTITIONED: 'PARTITIONED';
EXTERNAL: 'EXTERNAL';
DEFINED: 'DEFINED';
REVOKE: 'REVOKE';
GRANT: 'GRANT';
LOCK: 'LOCK';
UNLOCK: 'UNLOCK';
MSCK: 'MSCK';
REPAIR: 'REPAIR';
RECOVER: 'RECOVER';
EXPORT: 'EXPORT';
IMPORT: 'IMPORT';
LOAD: 'LOAD';
ROLE: 'ROLE';
ROLES: 'ROLES';
COMPACTIONS: 'COMPACTIONS';
PRINCIPALS: 'PRINCIPALS';
TRANSACTIONS: 'TRANSACTIONS';
INDEX: 'INDEX';
INDEXES: 'INDEXES';
LOCKS: 'LOCKS';
OPTION: 'OPTION';
ANTI: 'ANTI';
LOCAL: 'LOCAL';
INPATH: 'INPATH';
CURRENT_DATE: 'CURRENT_DATE';
CURRENT_TIMESTAMP: 'CURRENT_TIMESTAMP';

STRING
    : '\\'' ( ~('\\''|'\\\\') | ('\\\\' .) )* '\\''
    | '""' ( ~('""'|'\\\\') | ('\\\\' .) )* '""'
    ;

BIGINT_LITERAL
    : DIGIT+ 'L'
    ;

SMALLINT_LITERAL
    : DIGIT+ 'S'
    ;

TINYINT_LITERAL
    : DIGIT+ 'Y'
    ;

BYTELENGTH_LITERAL
    : DIGIT+ ('B' | 'K' | 'M' | 'G')
    ;

INTEGER_VALUE
    : DIGIT+
    ;

DECIMAL_VALUE
    : DIGIT+ EXPONENT
    | DECIMAL_DIGITS EXPONENT? {isValidDecimal()}?
    ;

DOUBLE_LITERAL
    : DIGIT+ EXPONENT? 'D'
    | DECIMAL_DIGITS EXPONENT? 'D' {isValidDecimal()}?
    ;

BIGDECIMAL_LITERAL
    : DIGIT+ EXPONENT? 'BD'
    | DECIMAL_DIGITS EXPONENT? 'BD' {isValidDecimal()}?
    ;

IDENTIFIER
    : (LETTER | DIGIT | '_')+
    ;

BACKQUOTED_IDENTIFIER
    : '`' ( ~'`' | '``' )* '`'
    ;

fragment DECIMAL_DIGITS
    : DIGIT+ '.' DIGIT*
    | '.' DIGIT+
    ;

fragment EXPONENT
    : 'E' [+-]? DIGIT+
    ;

fragment DIGIT
    : [0-9]
    ;

fragment LETTER
    : [A-Z]
    ;

SIMPLE_COMMENT
    : '--' ~[\\r\\n]* '\\r'? '\\n'? -> channel(HIDDEN)
    ;

BRACKETED_EMPTY_COMMENT
    : '/**/' -> channel(HIDDEN)
    ;

BRACKETED_COMMENT
    : '/*' ~[+] .*? '*/' -> channel(HIDDEN)
    ;

WS
    : [ \\r\\n\\t]+ -> channel(HIDDEN)
    ;

// Catch-all for anything we can't recognize.
// We use this to be able to ignore and recover all the text
// when splitting statements with DelimiterLexer
UNRECOGNIZED
    : .
    ;
",8345,False,1590.7091062281813,median
"// Copyright (c) 2011-2015 The Bitcoin Core developers
// Copyright (c) 2014-2021 The Dash Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.

#include <qt/bitcoingui.h>

#include <qt/bitcoinunits.h>
#include <qt/clientmodel.h>
#include <qt/codesafe.h>
#include <qt/guiconstants.h>
#include <qt/guiutil.h>
#include <qt/modaloverlay.h>
#include <qt/networkstyle.h>
#include <qt/notificator.h>
#include <qt/openuridialog.h>
#include <qt/optionsdialog.h>
#include <qt/optionsmodel.h>
#include <qt/rpcconsole.h>
#include <qt/utilitydialog.h>

#ifdef ENABLE_WALLET
#include <qt/walletframe.h>
#include <qt/walletmodel.h>
#include <qt/walletview.h>
#endif // ENABLE_WALLET

#ifdef Q_OS_MAC
#include <qt/macdockiconhandler.h>
#endif

#include <chainparams.h>
#include <init.h>
#include <interfaces/handler.h>
#include <interfaces/node.h>
#include <miner.h>
#include <ui_interface.h>
#include <util.h>
#include <qt/masternodelist.h>
#include <validation.h>

#include <iostream>

#include <QAction>
#include <QApplication>
#include <QButtonGroup>
#include <QComboBox>
#include <QDateTime>
#include <QDesktopWidget>
#include <QDragEnterEvent>
#include <QListWidget>
#include <QMenuBar>
#include <QMessageBox>
#include <QMimeData>
#include <QProgressDialog>
#include <QSettings>
#include <QShortcut>
#include <QStackedWidget>
#include <QStatusBar>
#include <QStyle>
#include <QTimer>
#include <QToolBar>
#include <QToolButton>
#include <QUrlQuery>
#include <QVBoxLayout>

const std::string BitcoinGUI::DEFAULT_UIPLATFORM =
#if defined(Q_OS_MAC)
        ""macosx""
#elif defined(Q_OS_WIN)
        ""windows""
#else
        ""other""
#endif
        ;

BitcoinGUI::BitcoinGUI(interfaces::Node& node, const NetworkStyle* networkStyle, QWidget* parent) :
    QMainWindow(parent),
    enableWallet(false),
    m_node(node),
    clientModel(0),
    walletFrame(0),
    unitDisplayControl(0),
    labelWalletEncryptionIcon(0),
    labelWalletHDStatusIcon(0),
    labelConnectionsIcon(0),
    labelBlocksIcon(0),
    progressBarLabel(0),
    progressBar(0),
    progressDialog(0),
    appMenuBar(0),
    appToolBar(0),
    appToolBarLogoAction(0),
    overviewButton(0),
    historyButton(0),
    masternodeButton(0),
    governanceButton(0),
    quitAction(0),
    sendCoinsButton(0),
    coinJoinCoinsButton(0),
    sendCoinsMenuAction(0),
    coinJoinCoinsMenuAction(0),
    usedSendingAddressesAction(0),
    usedReceivingAddressesAction(0),
    signMessageAction(0),
    verifyMessageAction(0),
    aboutAction(0),
    receiveCoinsButton(0),
    receiveCoinsMenuAction(0),
    optionsAction(0),
    toggleHideAction(0),
    encryptWalletAction(0),
    toggleStakingAction(0),
    backupWalletAction(0),
    changePassphraseAction(0),
    aboutQtAction(0),
    openRPCConsoleAction(0),
    openAction(0),
    showHelpMessageAction(0),
    showCoinJoinHelpAction(0),
    trayIcon(0),
    trayIconMenu(0),
    dockIconMenu(0),
    notificator(0),
    rpcConsole(0),
    helpMessageDialog(0),
    modalOverlay(0),
    tabGroup(0),
    timerConnecting(0),
    timerSpinner(0)
{
    GUIUtil::loadTheme(true);

    QSettings settings;
    if (!restoreGeometry(settings.value(""MainWindowGeometry"").toByteArray())) {
        // Restore failed (perhaps missing setting), center the window
        move(QApplication::desktop()->availableGeometry().center() - frameGeometry().center());
    }

    QString windowTitle = tr(PACKAGE_NAME) + "" - "";
#ifdef ENABLE_WALLET
    enableWallet = WalletModel::isWalletEnabled();
#endif // ENABLE_WALLET
    if(enableWallet)
    {
        windowTitle += tr(""Wallet"");
    } else {
        windowTitle += tr(""Node"");
    }
    QString userWindowTitle = QString::fromStdString(gArgs.GetArg(""-windowtitle"", """"));
    if(!userWindowTitle.isEmpty()) windowTitle += "" - "" + userWindowTitle;
    windowTitle += "" "" + networkStyle->getTitleAddText();
    QApplication::setWindowIcon(networkStyle->getTrayAndWindowIcon());
    setWindowIcon(networkStyle->getTrayAndWindowIcon());
    setWindowTitle(windowTitle);

    rpcConsole = new RPCConsole(node, this, enableWallet ? Qt::Window : Qt::Widget);
    helpMessageDialog = new HelpMessageDialog(node, this, HelpMessageDialog::cmdline);
#ifdef ENABLE_WALLET
    if(enableWallet)
    {
        /** Create wallet frame*/
        walletFrame = new WalletFrame(this);
    } else
#endif // ENABLE_WALLET
    {
        /* When compiled without wallet or -disablewallet is provided,
         * the central widget is the rpc console.
         */
        setCentralWidget(rpcConsole);
    }

    // Accept D&D of URIs
    setAcceptDrops(true);

    // Create actions for the toolbar, menu bar and tray/dock icon
    // Needs walletFrame to be initialized
    createActions();

    // Create application menu bar
    createMenuBar();

    // Create the toolbars
    createToolBars();

    // Create system tray icon and notification
    createTrayIcon(networkStyle);

    // Create status bar
    statusBar();

    // Launch caller
    caller();

    // Disable size grip because it looks ugly and nobody needs it
    statusBar()->setSizeGripEnabled(false);

    // Status bar notification icons
    QFrame *frameBlocks = new QFrame();
    frameBlocks->setContentsMargins(0,0,0,0);
    frameBlocks->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Preferred);
    QHBoxLayout *frameBlocksLayout = new QHBoxLayout(frameBlocks);
    frameBlocksLayout->setContentsMargins(3,0,3,0);
    frameBlocksLayout->setSpacing(3);
    unitDisplayControl = new UnitDisplayStatusBarControl();
    labelStakingIcon = new QLabel();
    labelWalletEncryptionIcon = new QLabel();
    labelWalletHDStatusIcon = new QLabel();
    labelConnectionsIcon = new GUIUtil::ClickableLabel();

    labelBlocksIcon = new GUIUtil::ClickableLabel();
    if(enableWallet)
    {
        frameBlocksLayout->addStretch();
        frameBlocksLayout->addWidget(unitDisplayControl);
        frameBlocksLayout->addStretch();
        frameBlocksLayout->addWidget(labelWalletHDStatusIcon);
        frameBlocksLayout->addWidget(labelWalletEncryptionIcon);
    }
    frameBlocksLayout->addStretch();
    frameBlocksLayout->addWidget(labelConnectionsIcon);
    frameBlocksLayout->addStretch();
    frameBlocksLayout->addWidget(labelBlocksIcon);
    frameBlocksLayout->addWidget(labelStakingIcon);
    frameBlocksLayout->addStretch();

    // Hide the spinner/synced icon by default to avoid
    // that the spinner starts before we have any connections
    labelBlocksIcon->hide();

    // Progress bar and label for blocks download
    progressBarLabel = new QLabel();
    progressBarLabel->setVisible(true);
    progressBarLabel->setObjectName(""lblStatusBarProgress"");
    progressBar = new GUIUtil::ProgressBar();
    progressBar->setAlignment(Qt::AlignCenter);
    progressBar->setVisible(true);

    // Override style sheet for progress bar for styles that have a segmented progress bar,
    // as they make the text unreadable (workaround for issue #1071)
    // See https://doc.qt.io/qt-5/gallery.html
    QString curStyle = QApplication::style()->metaObject()->className();
    if(curStyle == ""QWindowsStyle"" || curStyle == ""QWindowsXPStyle"")
    {
        progressBar->setStyleSheet(""QProgressBar { background-color: #F8F8F8; border: 1px solid grey; border-radius: 7px; padding: 1px; text-align: center; } QProgressBar::chunk { background: QLinearGradient(x1: 0, y1: 0, x2: 1, y2: 0, stop: 0 #00CCFF, stop: 1 #33CCFF); border-radius: 7px; margin: 0px; }"");
    }

    statusBar()->addWidget(progressBarLabel);
    statusBar()->addWidget(progressBar);
    statusBar()->addPermanentWidget(frameBlocks);

    // Install event filter to be able to catch status tip events (QEvent::StatusTip)
    this->installEventFilter(this);

    // Initially wallet actions should be disabled
    setWalletActionsEnabled(false);

    // Subscribe to notifications from core
    subscribeToCoreSignals();

    // Jump to peers tab by clicking on connections icon
    connect(labelConnectionsIcon, SIGNAL(clicked(QPoint)), this, SLOT(showPeers()));

    modalOverlay = new ModalOverlay(this->centralWidget());
#ifdef ENABLE_WALLET
    if(enableWallet) {
        connect(walletFrame, SIGNAL(requestedSyncWarningInfo()), this, SLOT(showModalOverlay()));
        connect(labelBlocksIcon, SIGNAL(clicked(QPoint)), this, SLOT(showModalOverlay()));
        connect(progressBar, SIGNAL(clicked(QPoint)), this, SLOT(showModalOverlay()));
    }
#endif

#ifdef Q_OS_MAC
    m_app_nap_inhibitor = new CAppNapInhibitor;
#endif

    QTimer* timerStakingIcon = new QTimer(labelStakingIcon);
    connect(timerStakingIcon, SIGNAL(timeout()), this, SLOT(setStakingStatus()));
    timerStakingIcon->start(10000);
    setStakingStatus();

    incomingTransactionsTimer = new QTimer(this);
    incomingTransactionsTimer->setSingleShot(true);
    connect(incomingTransactionsTimer, SIGNAL(timeout()), SLOT(showIncomingTransactions()));

    bool fDebugCustomStyleSheets = gArgs.GetBoolArg(""-debug-ui"", false) && GUIUtil::isStyleSheetDirectoryCustom();
    if (fDebugCustomStyleSheets) {
        timerCustomCss = new QTimer(this);
        QObject::connect(timerCustomCss, &QTimer::timeout, [=]() {
            if (!m_node.shutdownRequested()) {
                GUIUtil::loadStyleSheet();
            }
        });
        timerCustomCss->start(200);
    }
}

BitcoinGUI::~BitcoinGUI()
{
    // Unsubscribe from notifications from core
    unsubscribeFromCoreSignals();

    QSettings settings;
    settings.setValue(""MainWindowGeometry"", saveGeometry());
    if(trayIcon) // Hide tray icon, as deleting will let it linger until quit (on Ubuntu)
        trayIcon->hide();
#ifdef Q_OS_MAC
    delete m_app_nap_inhibitor;
    delete appMenuBar;
    MacDockIconHandler::cleanup();
#endif

    delete rpcConsole;
    delete tabGroup;
}

void BitcoinGUI::startSpinner()
{
    if (labelBlocksIcon == nullptr || labelBlocksIcon->isHidden() || timerSpinner != nullptr) {
        return;
    }
    auto getNextFrame = []() {
        static std::vector<std::unique_ptr<QPixmap>> vecFrames;
        static std::vector<std::unique_ptr<QPixmap>>::iterator itFrame;
        while (vecFrames.size() < SPINNER_FRAMES) {
            QString&& strFrame = QString(""spinner-%1"").arg(vecFrames.size(), 3, 10, QChar('0'));
            QPixmap&& frame = getIcon(strFrame, GUIUtil::ThemedColor::ORANGE, MOVIES_PATH).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE);
            itFrame = vecFrames.insert(vecFrames.end(), std::make_unique<QPixmap>(frame));
        }
        assert(vecFrames.size() == SPINNER_FRAMES);
        if (itFrame == vecFrames.end()) {
            itFrame = vecFrames.begin();
        }
        return *itFrame++->get();
    };

    timerSpinner = new QTimer(this);
    QObject::connect(timerSpinner, &QTimer::timeout, [=]() {
        if (timerSpinner == nullptr) {
            return;
        }
        labelBlocksIcon->setPixmap(getNextFrame());
    });
    timerSpinner->start(40);
}

void BitcoinGUI::stopSpinner()
{
    if (timerSpinner == nullptr) {
        return;
    }
    timerSpinner->deleteLater();
    timerSpinner = nullptr;
}

void BitcoinGUI::startConnectingAnimation()
{
    static int nStep{-1};
    const int nAnimationSteps = 10;

    if (timerConnecting != nullptr) {
        return;
    }

    timerConnecting = new QTimer(this);
    QObject::connect(timerConnecting, &QTimer::timeout, [=]() {

        if (timerConnecting == nullptr) {
            return;
        }

        QString strImage;
        GUIUtil::ThemedColor color;

        nStep = (nStep + 1) % (nAnimationSteps + 1);
        if (nStep == 0) {
            strImage = ""connect_4"";
            color = GUIUtil::ThemedColor::ICON_ALTERNATIVE_COLOR;
        } else if (nStep == nAnimationSteps / 2) {
            strImage = ""connect_1"";
            color = GUIUtil::ThemedColor::ORANGE;
        } else {
            return;
        }
        labelConnectionsIcon->setPixmap(GUIUtil::getIcon(strImage, color).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
    });
    timerConnecting->start(100);
}

void BitcoinGUI::stopConnectingAnimation()
{
    if (timerConnecting == nullptr) {
        return;
    }
    timerConnecting->deleteLater();
    timerConnecting = nullptr;
}

void BitcoinGUI::toggleStaking() {
    fGlobalStakingToggle = !fGlobalStakingToggle;
    LogPrintf(""Staking is now %s\\n"", fGlobalStakingToggle ? ""enabled"" : ""disabled"");
}

void BitcoinGUI::createActions()
{
    sendCoinsMenuAction = new QAction(tr(""&Send""), this);
    sendCoinsMenuAction->setStatusTip(tr(""Send coins to a PAC address""));
    sendCoinsMenuAction->setToolTip(sendCoinsMenuAction->statusTip());

    coinJoinCoinsMenuAction = new QAction(""&CoinJoin"", this);
    coinJoinCoinsMenuAction->setStatusTip(tr(""Send %1 funds to a PAC address"").arg(""CoinJoin""));
    coinJoinCoinsMenuAction->setToolTip(coinJoinCoinsMenuAction->statusTip());

    receiveCoinsMenuAction = new QAction(tr(""&Receive""), this);
    receiveCoinsMenuAction->setStatusTip(tr(""Request payments (generates QR codes and pac: URIs)""));
    receiveCoinsMenuAction->setToolTip(receiveCoinsMenuAction->statusTip());

    // These showNormalIfMinimized are needed because Send Coins and Receive Coins
    // can be triggered from the tray menu, and need to show the GUI to be useful.
    connect(sendCoinsMenuAction, SIGNAL(triggered()), this, SLOT(showNormalIfMinimized()));
    connect(sendCoinsMenuAction, SIGNAL(triggered()), this, SLOT(gotoSendCoinsPage()));
    connect(coinJoinCoinsMenuAction, SIGNAL(triggered()), this, SLOT(showNormalIfMinimized()));
    connect(coinJoinCoinsMenuAction, SIGNAL(triggered()), this, SLOT(gotoCoinJoinCoinsPage()));
    connect(receiveCoinsMenuAction, SIGNAL(triggered()), this, SLOT(showNormalIfMinimized()));
    connect(receiveCoinsMenuAction, SIGNAL(triggered()), this, SLOT(gotoReceiveCoinsPage()));

    quitAction = new QAction(tr(""E&xit""), this);
    quitAction->setStatusTip(tr(""Quit application""));
    quitAction->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_Q));
    quitAction->setMenuRole(QAction::QuitRole);
    aboutAction = new QAction(tr(""&About %1"").arg(tr(PACKAGE_NAME)), this);
    aboutAction->setStatusTip(tr(""Show information about pacprotocol""));
    aboutAction->setMenuRole(QAction::AboutRole);
    aboutAction->setEnabled(false);
    aboutQtAction = new QAction(tr(""About &Qt""), this);
    aboutQtAction->setStatusTip(tr(""Show information about Qt""));
    aboutQtAction->setMenuRole(QAction::AboutQtRole);
    optionsAction = new QAction(tr(""&Options...""), this);
    optionsAction->setStatusTip(tr(""Modify configuration options for %1"").arg(tr(PACKAGE_NAME)));
    optionsAction->setMenuRole(QAction::PreferencesRole);
    optionsAction->setEnabled(false);
    toggleHideAction = new QAction(tr(""&Show / Hide""), this);
    toggleHideAction->setStatusTip(tr(""Show or hide the main Window""));

    encryptWalletAction = new QAction(tr(""  &Encrypt Wallet...""), this);
    encryptWalletAction->setStatusTip(tr(""Encrypt the private keys that belong to your wallet""));
    toggleStakingAction = new QAction(tr(""  &Toggle staking...""), this);
    toggleStakingAction->setStatusTip(tr(""Enable/disable whether the wallet is permitted to stake""));
    toggleStakingAction->setCheckable(true);
    backupWalletAction = new QAction(tr(""&Backup Wallet...""), this);
    backupWalletAction->setStatusTip(tr(""Backup wallet to another location""));
    changePassphraseAction = new QAction(tr(""&Change Passphrase...""), this);
    changePassphraseAction->setStatusTip(tr(""Change the passphrase used for wallet encryption""));
    unlockWalletAction = new QAction(tr(""&Unlock Wallet...""), this);
    unlockWalletAction->setToolTip(tr(""Unlock wallet""));
    lockWalletAction = new QAction(tr(""&Lock Wallet""), this);
    signMessageAction = new QAction(tr(""Sign &message...""), this);
    signMessageAction->setStatusTip(tr(""Sign messages with your PAC addresses to prove you own them""));
    verifyMessageAction = new QAction(tr(""&Verify message...""), this);
    verifyMessageAction->setStatusTip(tr(""Verify messages to ensure they were signed with specified PAC addresses""));

    openInfoAction = new QAction(tr(""&Information""), this);
    openInfoAction->setStatusTip(tr(""Show diagnostic information""));
    openRPCConsoleAction = new QAction(tr(""&Debug console""), this);
    openRPCConsoleAction->setStatusTip(tr(""Open debugging console""));
    openGraphAction = new QAction(tr(""&Network Monitor""), this);
    openGraphAction->setStatusTip(tr(""Show network monitor""));
    openPeersAction = new QAction(tr(""&Peers list""), this);
    openPeersAction->setStatusTip(tr(""Show peers info""));
    openRepairAction = new QAction(tr(""Wallet &Repair""), this);
    openRepairAction->setStatusTip(tr(""Show wallet repair options""));
    openConfEditorAction = new QAction(tr(""Open Wallet &Configuration File""), this);
    openConfEditorAction->setStatusTip(tr(""Open configuration file""));
    // override TextHeuristicRole set by default which confuses this action with application settings
    openConfEditorAction->setMenuRole(QAction::NoRole);
    showBackupsAction = new QAction(tr(""Show Automatic &Backups""), this);
    showBackupsAction->setStatusTip(tr(""Show automatically created wallet backups""));
    // initially disable the debug window menu items
    openInfoAction->setEnabled(false);
    openRPCConsoleAction->setEnabled(false);
    openGraphAction->setEnabled(false);
    openPeersAction->setEnabled(false);
    openRepairAction->setEnabled(false);

    usedSendingAddressesAction = new QAction(tr(""&Sending addresses...""), this);
    usedSendingAddressesAction->setStatusTip(tr(""Show the list of used sending addresses and labels""));
    usedReceivingAddressesAction = new QAction(tr(""&Receiving addresses...""), this);
    usedReceivingAddressesAction->setStatusTip(tr(""Show the list of used receiving addresses and labels""));

    openAction = new QAction(tr(""Open &URI...""), this);
    openAction->setStatusTip(tr(""Open a pac: URI or payment request""));

    showHelpMessageAction = new QAction(tr(""&Command-line options""), this);
    showHelpMessageAction->setMenuRole(QAction::NoRole);
    showHelpMessageAction->setStatusTip(tr(""Show the %1 help message to get a list with possible PAC command-line options"").arg(tr(PACKAGE_NAME)));

    showCoinJoinHelpAction = new QAction(tr(""%1 &information"").arg(""CoinJoin""), this);
    showCoinJoinHelpAction->setMenuRole(QAction::NoRole);
    showCoinJoinHelpAction->setStatusTip(tr(""Show the %1 basic information"").arg(""CoinJoin""));

    connect(quitAction, SIGNAL(triggered()), qApp, SLOT(quit()));
    connect(aboutAction, SIGNAL(triggered()), this, SLOT(aboutClicked()));
    connect(aboutQtAction, SIGNAL(triggered()), qApp, SLOT(aboutQt()));
    connect(optionsAction, SIGNAL(triggered()), this, SLOT(optionsClicked()));
    connect(toggleHideAction, SIGNAL(triggered()), this, SLOT(toggleHidden()));
    connect(showHelpMessageAction, SIGNAL(triggered()), this, SLOT(showHelpMessageClicked()));
    connect(showCoinJoinHelpAction, SIGNAL(triggered()), this, SLOT(showCoinJoinHelpClicked()));

    // Jump directly to tabs in RPC-console
    connect(openInfoAction, SIGNAL(triggered()), this, SLOT(showInfo()));
    connect(openRPCConsoleAction, SIGNAL(triggered()), this, SLOT(showConsole()));
    connect(openGraphAction, SIGNAL(triggered()), this, SLOT(showGraph()));
    connect(openPeersAction, SIGNAL(triggered()), this, SLOT(showPeers()));
    connect(openRepairAction, SIGNAL(triggered()), this, SLOT(showRepair()));

    // Open configs and backup folder from menu
    connect(openConfEditorAction, SIGNAL(triggered()), this, SLOT(showConfEditor()));
    connect(showBackupsAction, SIGNAL(triggered()), this, SLOT(showBackups()));

    // Get restart command-line parameters and handle restart
    connect(rpcConsole, SIGNAL(handleRestart(QStringList)), this, SLOT(handleRestart(QStringList)));

    // prevents an open debug window from becoming stuck/unusable on client shutdown
    connect(quitAction, SIGNAL(triggered()), rpcConsole, SLOT(hide()));

#ifdef ENABLE_WALLET
    if(walletFrame)
    {
        connect(encryptWalletAction, SIGNAL(triggered()), walletFrame, SLOT(encryptWallet()));
        connect(toggleStakingAction, SIGNAL(triggered()), this, SLOT(toggleStaking()));
        connect(backupWalletAction, SIGNAL(triggered()), walletFrame, SLOT(backupWallet()));
        connect(changePassphraseAction, SIGNAL(triggered()), walletFrame, SLOT(changePassphrase()));
        connect(unlockWalletAction, SIGNAL(triggered()), walletFrame, SLOT(unlockWallet()));
        connect(lockWalletAction, SIGNAL(triggered()), walletFrame, SLOT(lockWallet()));
        connect(signMessageAction, SIGNAL(triggered()), this, SLOT(showNormalIfMinimized()));
        connect(signMessageAction, SIGNAL(triggered()), this, SLOT(gotoSignMessageTab()));
        connect(verifyMessageAction, SIGNAL(triggered()), this, SLOT(showNormalIfMinimized()));
        connect(verifyMessageAction, SIGNAL(triggered()), this, SLOT(gotoVerifyMessageTab()));
        connect(usedSendingAddressesAction, SIGNAL(triggered()), walletFrame, SLOT(usedSendingAddresses()));
        connect(usedReceivingAddressesAction, SIGNAL(triggered()), walletFrame, SLOT(usedReceivingAddresses()));
        connect(openAction, SIGNAL(triggered()), this, SLOT(openClicked()));
    }
#endif // ENABLE_WALLET

    new QShortcut(QKeySequence(Qt::CTRL + Qt::SHIFT + Qt::Key_I), this, SLOT(showInfo()));
    new QShortcut(QKeySequence(Qt::CTRL + Qt::SHIFT + Qt::Key_C), this, SLOT(showConsole()));
    new QShortcut(QKeySequence(Qt::CTRL + Qt::SHIFT + Qt::Key_G), this, SLOT(showGraph()));
    new QShortcut(QKeySequence(Qt::CTRL + Qt::SHIFT + Qt::Key_P), this, SLOT(showPeers()));
    new QShortcut(QKeySequence(Qt::CTRL + Qt::SHIFT + Qt::Key_R), this, SLOT(showRepair()));
}

void BitcoinGUI::createMenuBar()
{
#ifdef Q_OS_MAC
    // Create a decoupled menu bar on Mac which stays even if the window is closed
    appMenuBar = new QMenuBar();
#else
    // Get the main window's menu bar on other platforms
    appMenuBar = menuBar();
#endif

    // Configure the menus
    QMenu *file = appMenuBar->addMenu(tr(""&File""));
    if(walletFrame)
    {
        file->addAction(openAction);
        file->addAction(backupWalletAction);
        file->addAction(signMessageAction);
        file->addAction(verifyMessageAction);
        file->addSeparator();
        file->addAction(usedSendingAddressesAction);
        file->addAction(usedReceivingAddressesAction);
        file->addSeparator();
    }
    file->addAction(quitAction);

    QMenu *settings = appMenuBar->addMenu(tr(""&Settings""));
    if(walletFrame)
    {
        settings->addAction(encryptWalletAction);
        settings->addAction(toggleStakingAction);
        settings->addAction(changePassphraseAction);
        settings->addAction(unlockWalletAction);
        settings->addAction(lockWalletAction);
        settings->addSeparator();
    }
    settings->addAction(optionsAction);

    if(walletFrame)
    {
        QMenu *tools = appMenuBar->addMenu(tr(""&Tools""));
        tools->addAction(openInfoAction);
        tools->addAction(openRPCConsoleAction);
        tools->addAction(openGraphAction);
        tools->addAction(openPeersAction);
        tools->addAction(openRepairAction);
        tools->addSeparator();
        tools->addAction(openConfEditorAction);
        tools->addAction(showBackupsAction);
    }

    QMenu *help = appMenuBar->addMenu(tr(""&Help""));
    help->addAction(showHelpMessageAction);
    help->addAction(showCoinJoinHelpAction);
    help->addSeparator();
    help->addAction(aboutAction);
    help->addAction(aboutQtAction);
}

void BitcoinGUI::createToolBars()
{
#ifdef ENABLE_WALLET
    if(walletFrame)
    {
        QToolBar *toolbar = new QToolBar(tr(""Tabs toolbar""));
        appToolBar = toolbar;
        toolbar->setContextMenuPolicy(Qt::PreventContextMenu);
        toolbar->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
        toolbar->setToolButtonStyle(Qt::ToolButtonTextOnly);
        toolbar->setMovable(false); // remove unused icon in upper left corner

        tabGroup = new QButtonGroup(this);

        overviewButton = new QToolButton(this);
        overviewButton->setText(tr(""&Overview""));
        overviewButton->setStatusTip(tr(""Show general overview of wallet""));
        tabGroup->addButton(overviewButton);

        sendCoinsButton = new QToolButton(this);
        sendCoinsButton->setText(sendCoinsMenuAction->text());
        sendCoinsButton->setStatusTip(sendCoinsMenuAction->statusTip());
        tabGroup->addButton(sendCoinsButton);

        receiveCoinsButton = new QToolButton(this);
        receiveCoinsButton->setText(receiveCoinsMenuAction->text());
        receiveCoinsButton->setStatusTip(receiveCoinsMenuAction->statusTip());
        tabGroup->addButton(receiveCoinsButton);

        historyButton = new QToolButton(this);
        historyButton->setText(tr(""&Transactions""));
        historyButton->setStatusTip(tr(""Browse transaction history""));
        tabGroup->addButton(historyButton);

        coinJoinCoinsButton = new QToolButton(this);
        coinJoinCoinsButton->setText(coinJoinCoinsMenuAction->text());
        coinJoinCoinsButton->setStatusTip(coinJoinCoinsMenuAction->statusTip());
        tabGroup->addButton(coinJoinCoinsButton);

        QSettings settings;
        if (settings.value(""fShowMasternodesTab"").toBool()) {
            masternodeButton = new QToolButton(this);
            masternodeButton->setText(tr(""&Masternodes""));
            masternodeButton->setStatusTip(tr(""Browse masternodes""));
            tabGroup->addButton(masternodeButton);
            connect(masternodeButton, SIGNAL(clicked()), this, SLOT(gotoMasternodePage()));
        }

        governanceButton = new QToolButton(this);
        governanceButton->setText(tr(""&Governance""));
        governanceButton->setStatusTip(tr(""Show governance items""));
        governanceButton->setToolTip(governanceButton->statusTip());
        governanceButton->setCheckable(true);
        tabGroup->addButton(governanceButton);

        connect(overviewButton, SIGNAL(clicked()), this, SLOT(gotoOverviewPage()));
        connect(sendCoinsButton, SIGNAL(clicked()), this, SLOT(gotoSendCoinsPage()));
        connect(coinJoinCoinsButton, SIGNAL(clicked()), this, SLOT(gotoCoinJoinCoinsPage()));
        connect(receiveCoinsButton, SIGNAL(clicked()), this, SLOT(gotoReceiveCoinsPage()));
        connect(historyButton, SIGNAL(clicked()), this, SLOT(gotoHistoryPage()));
        connect(governanceButton, SIGNAL(clicked()), this, SLOT(gotoGovernancePage()));

        // Give the selected tab button a bolder font.
        connect(tabGroup, SIGNAL(buttonToggled(QAbstractButton *, bool)), this, SLOT(highlightTabButton(QAbstractButton *, bool)));

        for (auto button : tabGroup->buttons()) {
            GUIUtil::setFont({button}, GUIUtil::FontWeight::Normal, 16);
            button->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);
            button->setToolTip(button->statusTip());
            button->setCheckable(true);
            toolbar->addWidget(button);
        }

        overviewButton->setChecked(true);
        GUIUtil::updateFonts();

#ifdef ENABLE_WALLET
        m_wallet_selector = new QComboBox(this);
        connect(m_wallet_selector, SIGNAL(currentIndexChanged(int)), this, SLOT(setCurrentWalletBySelectorIndex(int)));

        QVBoxLayout* walletSelectorLayout = new QVBoxLayout(this);
        walletSelectorLayout->addWidget(m_wallet_selector);
        walletSelectorLayout->setSpacing(0);
        walletSelectorLayout->setMargin(0);
        walletSelectorLayout->setContentsMargins(5, 0, 5, 0);
        QWidget* walletSelector = new QWidget(this);
        walletSelector->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Preferred);
        walletSelector->setObjectName(""walletSelector"");
        walletSelector->setLayout(walletSelectorLayout);
        m_wallet_selector_action = appToolBar->insertWidget(appToolBarLogoAction, walletSelector);
        m_wallet_selector_action->setVisible(false);
#endif

        QLabel *logoLabel = new QLabel();
        logoLabel->setObjectName(""lblToolbarLogo"");
        logoLabel->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);

        appToolBarLogoAction = toolbar->addWidget(logoLabel);

        /** Create additional container for toolbar and walletFrame and make it the central widget.
            This is a workaround mostly for toolbar styling on Mac OS but should work fine for every other OSes too.
        */
        QVBoxLayout *layout = new QVBoxLayout;
        layout->addWidget(toolbar);
        layout->addWidget(walletFrame);
        layout->setSpacing(0);
        layout->setContentsMargins(QMargins());
        QWidget *containerWidget = new QWidget();
        containerWidget->setLayout(layout);
        setCentralWidget(containerWidget);
    }
#endif // ENABLE_WALLET
}

void BitcoinGUI::setClientModel(ClientModel *_clientModel)
{
    this->clientModel = _clientModel;
    if(_clientModel)
    {
        // Create system tray menu (or setup the dock menu) that late to prevent users from calling actions,
        // while the client has not yet fully loaded
        if (trayIcon) {
            // do so only if trayIcon is already set
            trayIconMenu = new QMenu(this);
            trayIcon->setContextMenu(trayIconMenu);
            createIconMenu(trayIconMenu);

#ifndef Q_OS_MAC
            // Show main window on tray icon click
            // Note: ignore this on Mac - this is not the way tray should work there
            connect(trayIcon, SIGNAL(activated(QSystemTrayIcon::ActivationReason)),
                    this, SLOT(trayIconActivated(QSystemTrayIcon::ActivationReason)));
#else
            // Note: On Mac, the dock icon is also used to provide menu functionality
            // similar to one for tray icon
            MacDockIconHandler *dockIconHandler = MacDockIconHandler::instance();
            connect(dockIconHandler, SIGNAL(dockIconClicked()), this, SLOT(macosDockIconActivated()));

            dockIconMenu = new QMenu(this);
            dockIconMenu->setAsDockMenu();

            createIconMenu(dockIconMenu);
#endif
        }

        // Keep up to date with client
        updateNetworkState();
        setNumConnections(_clientModel->getNumConnections());
        connect(_clientModel, SIGNAL(numConnectionsChanged(int)), this, SLOT(setNumConnections(int)));
        connect(_clientModel, SIGNAL(networkActiveChanged(bool)), this, SLOT(setNetworkActive(bool)));

        modalOverlay->setKnownBestHeight(_clientModel->getHeaderTipHeight(), QDateTime::fromTime_t(_clientModel->getHeaderTipTime()));
        setNumBlocks(m_node.getNumBlocks(), QDateTime::fromTime_t(m_node.getLastBlockTime()), QString::fromStdString(m_node.getLastBlockHash()), m_node.getVerificationProgress(), false);
        connect(_clientModel, SIGNAL(numBlocksChanged(int,QDateTime,QString,double,bool)), this, SLOT(setNumBlocks(int,QDateTime,QString,double,bool)));

        connect(_clientModel, SIGNAL(additionalDataSyncProgressChanged(double)), this, SLOT(setAdditionalDataSyncProgress(double)));

        // Receive and report messages from client model
        connect(_clientModel, SIGNAL(message(QString,QString,unsigned int)), this, SLOT(message(QString,QString,unsigned int)));

        // Show progress dialog
        connect(_clientModel, SIGNAL(showProgress(QString,int)), this, SLOT(showProgress(QString,int)));

        rpcConsole->setClientModel(_clientModel);
#ifdef ENABLE_WALLET
        if(walletFrame)
        {
            walletFrame->setClientModel(_clientModel);
        }
#endif // ENABLE_WALLET
        unitDisplayControl->setOptionsModel(_clientModel->getOptionsModel());

        OptionsModel* optionsModel = _clientModel->getOptionsModel();
        if(optionsModel)
        {
            // be aware of the tray icon disable state change reported by the OptionsModel object.
            connect(optionsModel,SIGNAL(hideTrayIconChanged(bool)),this,SLOT(setTrayIconVisible(bool)));

            // initialize the disable state of the tray icon with the current value in the model.
            setTrayIconVisible(optionsModel->getHideTrayIcon());

            connect(optionsModel, SIGNAL(coinJoinEnabledChanged()), this, SLOT(updateCoinJoinVisibility()));
        }
    } else {
        // Disable possibility to show main window via action
        toggleHideAction->setEnabled(false);
        if(trayIconMenu)
        {
            // Disable context menu on tray icon
            trayIconMenu->clear();
        }
        // Propagate cleared model to child objects
        rpcConsole->setClientModel(nullptr);
#ifdef ENABLE_WALLET
        if (walletFrame)
        {
            walletFrame->setClientModel(nullptr);
        }
#endif // ENABLE_WALLET
        unitDisplayControl->setOptionsModel(nullptr);

#ifdef Q_OS_MAC
        if(dockIconMenu)
        {
            // Disable context menu on dock icon
            dockIconMenu->clear();
        }
#endif
    }

    updateCoinJoinVisibility();
}

#ifdef ENABLE_WALLET
bool BitcoinGUI::addWallet(WalletModel *walletModel)
{
    if(!walletFrame)
        return false;
    const QString name = walletModel->getWalletName();
    QString display_name = name.isEmpty() ? ""[""+tr(""default wallet"")+""]"" : name;
    setWalletActionsEnabled(true);
    m_wallet_selector->addItem(display_name, name);
    if (m_wallet_selector->count() == 2) {
        m_wallet_selector_action->setVisible(true);
    }
    rpcConsole->addWallet(walletModel);
    return walletFrame->addWallet(walletModel);
}

bool BitcoinGUI::removeWallet(WalletModel* walletModel)
{
    if (!walletFrame) return false;
    QString name = walletModel->getWalletName();
    int index = m_wallet_selector->findData(name);
    m_wallet_selector->removeItem(index);
    if (m_wallet_selector->count() == 0) {
        setWalletActionsEnabled(false);
    } else if (m_wallet_selector->count() == 1) {
        m_wallet_selector_action->setVisible(false);
    }
    rpcConsole->removeWallet(walletModel);
    return walletFrame->removeWallet(name);
}

bool BitcoinGUI::setCurrentWallet(const QString& name)
{
    if(!walletFrame)
        return false;
    return walletFrame->setCurrentWallet(name);
}

bool BitcoinGUI::setCurrentWalletBySelectorIndex(int index)
{
    QString internal_name = m_wallet_selector->itemData(index).toString();
    return setCurrentWallet(internal_name);
}

void BitcoinGUI::removeAllWallets()
{
    if(!walletFrame)
        return;
    setWalletActionsEnabled(false);
    walletFrame->removeAllWallets();
}
#endif // ENABLE_WALLET

void BitcoinGUI::setWalletActionsEnabled(bool enabled)
{
#ifdef ENABLE_WALLET
    if (walletFrame != nullptr) {
        overviewButton->setEnabled(enabled);
        sendCoinsButton->setEnabled(enabled);
        coinJoinCoinsButton->setEnabled(enabled && clientModel->coinJoinOptions().isEnabled());
        receiveCoinsButton->setEnabled(enabled);
        historyButton->setEnabled(enabled);
        if (masternodeButton != nullptr) {
            QSettings settings;
            masternodeButton->setEnabled(enabled && settings.value(""fShowMasternodesTab"").toBool());
        }
    }
#endif // ENABLE_WALLET

    sendCoinsMenuAction->setEnabled(enabled);
#ifdef ENABLE_WALLET
    coinJoinCoinsMenuAction->setEnabled(enabled && clientModel->coinJoinOptions().isEnabled());
#else
    coinJoinCoinsMenuAction->setEnabled(enabled);
#endif // ENABLE_WALLET
    receiveCoinsMenuAction->setEnabled(enabled);

    encryptWalletAction->setEnabled(enabled);
    governanceButton->setEnabled(enabled);
    toggleStakingAction->setEnabled(enabled);
    backupWalletAction->setEnabled(enabled);
    changePassphraseAction->setEnabled(enabled);
    signMessageAction->setEnabled(enabled);
    verifyMessageAction->setEnabled(enabled);
    usedSendingAddressesAction->setEnabled(enabled);
    usedReceivingAddressesAction->setEnabled(enabled);
    openAction->setEnabled(enabled);
}

void BitcoinGUI::createTrayIcon(const NetworkStyle *networkStyle)
{
    trayIcon = new QSystemTrayIcon(this);
    QString toolTip = tr(""%1 client"").arg(tr(PACKAGE_NAME)) + "" "" + networkStyle->getTitleAddText();
    trayIcon->setToolTip(toolTip);
    trayIcon->setIcon(networkStyle->getTrayAndWindowIcon());
    trayIcon->hide();
    notificator = new Notificator(QApplication::applicationName(), trayIcon, this);
}

void BitcoinGUI::createIconMenu(QMenu *pmenu)
{
    // Configuration of the tray icon (or dock icon) icon menu
    pmenu->addAction(toggleHideAction);
    pmenu->addSeparator();
    pmenu->addAction(sendCoinsMenuAction);
    pmenu->addAction(coinJoinCoinsMenuAction);
    pmenu->addAction(receiveCoinsMenuAction);
    pmenu->addSeparator();
    pmenu->addAction(signMessageAction);
    pmenu->addAction(verifyMessageAction);
    pmenu->addSeparator();
    pmenu->addAction(optionsAction);
    pmenu->addAction(openInfoAction);
    pmenu->addAction(openRPCConsoleAction);
    pmenu->addAction(openGraphAction);
    pmenu->addAction(openPeersAction);
    pmenu->addAction(openRepairAction);
    pmenu->addSeparator();
    pmenu->addAction(openConfEditorAction);
    pmenu->addAction(showBackupsAction);
#ifndef Q_OS_MAC // This is built-in on Mac
    pmenu->addSeparator();
    pmenu->addAction(quitAction);
#endif
}

#ifndef Q_OS_MAC
void BitcoinGUI::trayIconActivated(QSystemTrayIcon::ActivationReason reason)
{
    if(reason == QSystemTrayIcon::Trigger)
    {
        // Click on system tray icon triggers show/hide of the main window
        toggleHidden();
    }
}
#else
void BitcoinGUI::macosDockIconActivated()
{
    showNormalIfMinimized();
    activateWindow();
}
#endif

void BitcoinGUI::optionsClicked()
{
    if(!clientModel || !clientModel->getOptionsModel())
        return;

    OptionsDialog dlg(this, enableWallet);
    dlg.setModel(clientModel->getOptionsModel());
    connect(&dlg, &OptionsDialog::appearanceChanged, [=]() {
        updateWidth();
    });
    dlg.exec();

    updateCoinJoinVisibility();
}

void BitcoinGUI::aboutClicked()
{
    if(!clientModel)
        return;

    HelpMessageDialog dlg(m_node, this, HelpMessageDialog::about);
    dlg.exec();
}

void BitcoinGUI::showDebugWindow()
{
    GUIUtil::bringToFront(rpcConsole);
}

void BitcoinGUI::showInfo()
{
    rpcConsole->setTabFocus(RPCConsole::TAB_INFO);
    showDebugWindow();
}

void BitcoinGUI::showConsole()
{
    rpcConsole->setTabFocus(RPCConsole::TAB_CONSOLE);
    showDebugWindow();
}

void BitcoinGUI::showGraph()
{
    rpcConsole->setTabFocus(RPCConsole::TAB_GRAPH);
    showDebugWindow();
}

void BitcoinGUI::showPeers()
{
    rpcConsole->setTabFocus(RPCConsole::TAB_PEERS);
    showDebugWindow();
}

void BitcoinGUI::showRepair()
{
    rpcConsole->setTabFocus(RPCConsole::TAB_REPAIR);
    showDebugWindow();
}

void BitcoinGUI::showConfEditor()
{
    GUIUtil::openConfigfile();
}

void BitcoinGUI::showBackups()
{
    GUIUtil::showBackups();
}

void BitcoinGUI::showHelpMessageClicked()
{
    helpMessageDialog->show();
}

void BitcoinGUI::showCoinJoinHelpClicked()
{
    if(!clientModel)
        return;

    HelpMessageDialog dlg(m_node, this, HelpMessageDialog::pshelp);
    dlg.exec();
}

#ifdef ENABLE_WALLET
void BitcoinGUI::openClicked()
{
    OpenURIDialog dlg(this);
    if(dlg.exec())
    {
        Q_EMIT receivedURI(dlg.getURI());
    }
}

void BitcoinGUI::highlightTabButton(QAbstractButton *button, bool checked)
{
    GUIUtil::setFont({button}, checked ? GUIUtil::FontWeight::Bold : GUIUtil::FontWeight::Normal, 16);
    GUIUtil::updateFonts();
}

void BitcoinGUI::gotoOverviewPage()
{
    overviewButton->setChecked(true);
    if (walletFrame) walletFrame->gotoOverviewPage();
}

void BitcoinGUI::gotoHistoryPage()
{
    historyButton->setChecked(true);
    if (walletFrame) walletFrame->gotoHistoryPage();
}

void BitcoinGUI::gotoMasternodePage()
{
    QSettings settings;
    if (settings.value(""fShowMasternodesTab"").toBool() && masternodeButton) {
        masternodeButton->setChecked(true);
        if (walletFrame) walletFrame->gotoMasternodePage();
    }
}

void BitcoinGUI::gotoGovernancePage()
{
    governanceButton->setChecked(true);
    if (walletFrame) walletFrame->gotoGovernancePage();
}

void BitcoinGUI::gotoReceiveCoinsPage()
{
    receiveCoinsButton->setChecked(true);
    if (walletFrame) walletFrame->gotoReceiveCoinsPage();
}

void BitcoinGUI::gotoSendCoinsPage(QString addr)
{
    sendCoinsButton->setChecked(true);
    if (walletFrame) walletFrame->gotoSendCoinsPage(addr);
}

void BitcoinGUI::gotoCoinJoinCoinsPage(QString addr)
{
    coinJoinCoinsButton->setChecked(true);
    if (walletFrame) walletFrame->gotoCoinJoinCoinsPage(addr);
}

void BitcoinGUI::gotoSignMessageTab(QString addr)
{
    if (walletFrame) walletFrame->gotoSignMessageTab(addr);
}

void BitcoinGUI::gotoVerifyMessageTab(QString addr)
{
    if (walletFrame) walletFrame->gotoVerifyMessageTab(addr);
}
#endif // ENABLE_WALLET

void BitcoinGUI::updateNetworkState()
{
    if (clientModel == nullptr) {
        return;
    }

    static int nCountPrev{0};
    static bool fNetworkActivePrev{false};
    int count = clientModel->getNumConnections();
    bool fNetworkActive = m_node.getNetworkActive();
    QString icon;
    GUIUtil::ThemedColor color = GUIUtil::ThemedColor::ORANGE;
    switch(count)
    {
    case 0: icon = ""connect_4""; color = GUIUtil::ThemedColor::ICON_ALTERNATIVE_COLOR; break;
    case 1: case 2: icon = ""connect_1""; break;
    case 3: case 4: case 5: icon = ""connect_2""; break;
    case 6: case 7: icon = ""connect_3""; break;
    default: icon = ""connect_4""; color = GUIUtil::ThemedColor::GREEN; break;
    }

    labelBlocksIcon->setVisible(count > 0);
    updateProgressBarVisibility();

    bool fNetworkBecameActive = (!fNetworkActivePrev && fNetworkActive) || (nCountPrev == 0 && count > 0);
    bool fNetworkBecameInactive = (fNetworkActivePrev && !fNetworkActive) || (nCountPrev > 0 && count == 0);

    if (fNetworkBecameActive) {
        // If the sync process still signals synced after five seconds represent it in the UI.
        if (m_node.masternodeSync().isSynced()) {
            QTimer::singleShot(5000, this, [&]() {
                if (clientModel->getNumConnections() > 0 && m_node.masternodeSync().isSynced()) {
                    setAdditionalDataSyncProgress(1);
                }
            });
        }
        startSpinner();
    } else if (fNetworkBecameInactive) {
        labelBlocksIcon->hide();
        stopSpinner();
    }

    if (fNetworkBecameActive || fNetworkBecameInactive) {
        setNumBlocks(m_node.getNumBlocks(), QDateTime::fromTime_t(m_node.getLastBlockTime()), QString::fromStdString(m_node.getLastBlockHash()), m_node.getVerificationProgress(), false);
    }

    nCountPrev = count;
    fNetworkActivePrev = fNetworkActive;

    if (fNetworkActive) {
        labelConnectionsIcon->setToolTip(tr(""%n active connection(s) to PAC network"", """", count));
    } else {
        labelConnectionsIcon->setToolTip(tr(""Network activity disabled""));
        icon = ""connect_4"";
        color = GUIUtil::ThemedColor::RED;
    }

    if (fNetworkActive && count == 0) {
        startConnectingAnimation();
    }
    if (!fNetworkActive || count > 0) {
        stopConnectingAnimation();
        labelConnectionsIcon->setPixmap(GUIUtil::getIcon(icon, color).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
    }
}

void BitcoinGUI::setNumConnections(int count)
{
    updateNetworkState();
}

void BitcoinGUI::setNetworkActive(bool networkActive)
{
    updateNetworkState();
}

void BitcoinGUI::updateHeadersSyncProgressLabel()
{
    int64_t headersTipTime = clientModel->getHeaderTipTime();
    int headersTipHeight = clientModel->getHeaderTipHeight();
    int estHeadersLeft = (GetTime() - headersTipTime) / Params().GetConsensus().nPowTargetSpacing;
    if (estHeadersLeft > HEADER_HEIGHT_DELTA_SYNC)
        progressBarLabel->setText(tr(""Syncing Headers (%1%)..."").arg(QString::number(100.0 / (headersTipHeight+estHeadersLeft)*headersTipHeight, 'f', 1)));
}

void BitcoinGUI::updateProgressBarVisibility()
{
    if (clientModel == nullptr) {
        return;
    }
    // Show the progress bar label if the network is active + we are out of sync or we have no connections.
    bool fShowProgressBarLabel = m_node.getNetworkActive() && (!m_node.masternodeSync().isSynced() || clientModel->getNumConnections() == 0);
    // Show the progress bar only if the the network active + we are not synced + we have any connection. Unlike with the label
    // which gives an info text about the connecting phase there is no reason to show the progress bar if we don't have connections
    // since it will not get any updates in this case.
    bool fShowProgressBar = m_node.getNetworkActive() && !m_node.masternodeSync().isSynced() && clientModel->getNumConnections() > 0;
    progressBarLabel->setVisible(fShowProgressBarLabel);
    progressBar->setVisible(fShowProgressBar);
}

void BitcoinGUI::updateCoinJoinVisibility()
{
#ifdef ENABLE_WALLET
    bool fEnabled = m_node.coinJoinOptions().isEnabled();
#else
    bool fEnabled = false;
#endif
    // CoinJoin button is the third QToolButton, show/hide the underlying QAction
    // Hiding the QToolButton itself doesn't work for the GUI part
    // but is still needed for shortcuts to work properly.
    if (appToolBar != nullptr) {
        appToolBar->actions()[4]->setVisible(fEnabled);
        coinJoinCoinsButton->setVisible(fEnabled);
        GUIUtil::updateButtonGroupShortcuts(tabGroup);
    }
    coinJoinCoinsMenuAction->setVisible(fEnabled);
    showCoinJoinHelpAction->setVisible(fEnabled);
    updateWidth();
}

void BitcoinGUI::updateWidth()
{
    if (walletFrame == nullptr) {
        return;
    }
    if (windowState() & (Qt::WindowMaximized | Qt::WindowFullScreen)) {
        return;
    }
    int nWidthWidestButton{0};
    int nButtonsVisible{0};
    for (QAbstractButton* button : tabGroup->buttons()) {
        if (!button->isEnabled()) {
            continue;
        }
        QFontMetrics fm(button->font());
        nWidthWidestButton = std::max<int>(nWidthWidestButton, fm.width(button->text()));
        ++nButtonsVisible;
    }
    // Add 30 per button as padding and use minimum 980 which is the minimum required to show all tab's contents
    // Use nButtonsVisible + 1 <- for the dash logo
    int nWidth = std::max<int>(980, (nWidthWidestButton + 30) * (nButtonsVisible + 1));
    setMinimumWidth(nWidth);
    resize(nWidth, height());
}

void BitcoinGUI::setNumBlocks(int count, const QDateTime& blockDate, const QString& blockHash, double nVerificationProgress, bool header)
{
#ifdef Q_OS_MAC
    // Disabling macOS App Nap on initial sync, disk, reindex operations and mixing.
    bool disableAppNap = !m_node.masternodeSync().isSynced();
#ifdef ENABLE_WALLET
    for (const auto& wallet : m_node.getWallets()) {
        disableAppNap |= wallet->coinJoin().isMixing();
    }
#endif // ENABLE_WALLET
    if (disableAppNap) {
        m_app_nap_inhibitor->disableAppNap();
    } else {
        m_app_nap_inhibitor->enableAppNap();
    }
#endif // Q_OS_MAC

    if (modalOverlay)
    {
        if (header)
            modalOverlay->setKnownBestHeight(count, blockDate);
        else
            modalOverlay->tipUpdate(count, blockDate, nVerificationProgress);
    }
    if (!clientModel)
        return;

    updateProgressBarVisibility();

    // Prevent orphan statusbar messages (e.g. hover Quit in main menu, wait until chain-sync starts -> garbled text)
    statusBar()->clearMessage();

    // Acquire current block source
    enum BlockSource blockSource = clientModel->getBlockSource();
    switch (blockSource) {
        case BlockSource::NETWORK:
            if (header) {
                updateHeadersSyncProgressLabel();
                return;
            }
            progressBarLabel->setText(tr(""Synchronizing with network...""));
            updateHeadersSyncProgressLabel();
            break;
        case BlockSource::DISK:
            if (header) {
                progressBarLabel->setText(tr(""Indexing blocks on disk...""));
            } else {
                progressBarLabel->setText(tr(""Processing blocks on disk...""));
            }
            break;
        case BlockSource::REINDEX:
            progressBarLabel->setText(tr(""Reindexing blocks on disk...""));
            break;
        case BlockSource::NONE:
            if (header) {
                return;
            }
            progressBarLabel->setText(tr(""Connecting to peers...""));
            break;
    }

    QString tooltip;

    QDateTime currentDate = QDateTime::currentDateTime();
    qint64 secs = blockDate.secsTo(currentDate);

    tooltip = tr(""Processed %n block(s) of transaction history."", """", count);

    // Set icon state: spinning if catching up, tick otherwise
#ifdef ENABLE_WALLET
    if (walletFrame)
    {
        if(secs < 25*60) // 90*60 in bitcoin
        {
            modalOverlay->showHide(true, true);
            // TODO instead of hiding it forever, we should add meaningful information about MN sync to the overlay
            modalOverlay->hideForever();
        }
        else
        {
            modalOverlay->showHide();
        }
    }
#endif // ENABLE_WALLET

    if(!m_node.masternodeSync().isBlockchainSynced())
    {
        QString timeBehindText = GUIUtil::formatNiceTimeOffset(secs);

        progressBar->setFormat(tr(""%1 behind"").arg(timeBehindText));
        progressBar->setMaximum(1000000000);
        progressBar->setValue(nVerificationProgress * 1000000000.0 + 0.5);

        tooltip = tr(""Catching up..."") + QString(""<br>"") + tooltip;

#ifdef ENABLE_WALLET
        if(walletFrame)
        {
            walletFrame->showOutOfSyncWarning(true);
        }
#endif // ENABLE_WALLET

        tooltip += QString(""<br>"");
        tooltip += tr(""Last received block was generated %1 ago."").arg(timeBehindText);
        tooltip += QString(""<br>"");
        tooltip += tr(""Transactions after this will not yet be visible."");
    } else if (fDisableGovernance) {
        setAdditionalDataSyncProgress(1);
    }

    // Don't word-wrap this (fixed-width) tooltip
    tooltip = QString(""<nobr>"") + tooltip + QString(""</nobr>"");

    labelBlocksIcon->setToolTip(tooltip);
    progressBarLabel->setToolTip(tooltip);
    progressBar->setToolTip(tooltip);
}

void BitcoinGUI::setAdditionalDataSyncProgress(double nSyncProgress)
{
    if(!clientModel)
        return;

    // If masternodeSync.Reset() has been called make sure status bar shows the correct information.
    if (nSyncProgress == -1) {
        setNumBlocks(m_node.getNumBlocks(), QDateTime::fromTime_t(m_node.getLastBlockTime()), QString::fromStdString(m_node.getLastBlockHash()), m_node.getVerificationProgress(), false);
        if (clientModel->getNumConnections()) {
            labelBlocksIcon->show();
            startSpinner();
        }
        return;
    }

    // No additional data sync should be happening while blockchain is not synced, nothing to update
    if(!m_node.masternodeSync().isBlockchainSynced())
        return;

    // Prevent orphan statusbar messages (e.g. hover Quit in main menu, wait until chain-sync starts -> garbelled text)
    statusBar()->clearMessage();

    QString tooltip;

    // Set icon state: spinning if catching up, tick otherwise
    QString strSyncStatus;
    tooltip = tr(""Up to date"") + QString("".<br>"") + tooltip;

#ifdef ENABLE_WALLET
    if(walletFrame)
        walletFrame->showOutOfSyncWarning(false);
#endif // ENABLE_WALLET

    updateProgressBarVisibility();

    if(m_node.masternodeSync().isSynced()) {
        stopSpinner();
        labelBlocksIcon->setPixmap(GUIUtil::getIcon(""synced"", GUIUtil::ThemedColor::GREEN).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
    } else {
        progressBar->setFormat(tr(""Synchronizing additional data: %p%""));
        progressBar->setMaximum(1000000000);
        progressBar->setValue(nSyncProgress * 1000000000.0 + 0.5);
    }

    strSyncStatus = QString(m_node.masternodeSync().getSyncStatus().c_str());
    progressBarLabel->setText(strSyncStatus);
    tooltip = strSyncStatus + QString(""<br>"") + tooltip;

    // Don't word-wrap this (fixed-width) tooltip
    tooltip = QString(""<nobr>"") + tooltip + QString(""</nobr>"");

    labelBlocksIcon->setToolTip(tooltip);
    progressBarLabel->setToolTip(tooltip);
    progressBar->setToolTip(tooltip);
}

void BitcoinGUI::message(const QString &title, const QString &message, unsigned int style, bool *ret)
{
    QString strTitle = tr(""pacprotocol""); // default title
    // Default to information icon
    int nMBoxIcon = QMessageBox::Information;
    int nNotifyIcon = Notificator::Information;

    QString msgType;

    // Prefer supplied title over style based title
    if (!title.isEmpty()) {
        msgType = title;
    }
    else {
        switch (style) {
        case CClientUIInterface::MSG_ERROR:
            msgType = tr(""Error"");
            break;
        case CClientUIInterface::MSG_WARNING:
            msgType = tr(""Warning"");
            break;
        case CClientUIInterface::MSG_INFORMATION:
            msgType = tr(""Information"");
            break;
        default:
            break;
        }
    }
    // Append title to ""pacprotocol - ""
    if (!msgType.isEmpty())
        strTitle += "" - "" + msgType;

    // Check for error/warning icon
    if (style & CClientUIInterface::ICON_ERROR) {
        nMBoxIcon = QMessageBox::Critical;
        nNotifyIcon = Notificator::Critical;
    }
    else if (style & CClientUIInterface::ICON_WARNING) {
        nMBoxIcon = QMessageBox::Warning;
        nNotifyIcon = Notificator::Warning;
    }

    // Display message
    if (style & CClientUIInterface::MODAL) {
        // Check for buttons, use OK as default, if none was supplied
        QMessageBox::StandardButton buttons;
        if (!(buttons = (QMessageBox::StandardButton)(style & CClientUIInterface::BTN_MASK)))
            buttons = QMessageBox::Ok;

        showNormalIfMinimized();
        QMessageBox mBox(static_cast<QMessageBox::Icon>(nMBoxIcon), strTitle, message, buttons, this);
        mBox.setTextFormat(Qt::PlainText);
        int r = mBox.exec();
        if (ret != nullptr)
            *ret = r == QMessageBox::Ok;
    }
    else
        notificator->notify(static_cast<Notificator::Class>(nNotifyIcon), strTitle, message);
}

void BitcoinGUI::changeEvent(QEvent *e)
{
    QMainWindow::changeEvent(e);
#ifndef Q_OS_MAC // Ignored on Mac
    if(e->type() == QEvent::WindowStateChange)
    {
        if(clientModel && clientModel->getOptionsModel() && clientModel->getOptionsModel()->getMinimizeToTray())
        {
            QWindowStateChangeEvent *wsevt = static_cast<QWindowStateChangeEvent*>(e);
            if(!(wsevt->oldState() & Qt::WindowMinimized) && isMinimized())
            {
                QTimer::singleShot(0, this, SLOT(hide()));
                e->ignore();
            }
            else if((wsevt->oldState() & Qt::WindowMinimized) && !isMinimized())
            {
                QTimer::singleShot(0, this, SLOT(show()));
                e->ignore();
            }
        }
    }
#endif
    if (e->type() == QEvent::StyleChange) {
        updateNetworkState();
#ifdef ENABLE_WALLET
        updateWalletStatus();
#endif
        if (m_node.masternodeSync().isSynced()) {
            labelBlocksIcon->setPixmap(GUIUtil::getIcon(""synced"", GUIUtil::ThemedColor::GREEN).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
        }
    }
}

void BitcoinGUI::closeEvent(QCloseEvent *event)
{
#ifndef Q_OS_MAC // Ignored on Mac
    if(clientModel && clientModel->getOptionsModel())
    {
        if(!clientModel->getOptionsModel()->getMinimizeOnClose())
        {
            // close rpcConsole in case it was open to make some space for the shutdown window
            rpcConsole->close();

            QApplication::quit();
        }
        else
        {
            QMainWindow::showMinimized();
            event->ignore();
        }
    }
#else
    QMainWindow::closeEvent(event);
#endif
}

void BitcoinGUI::showEvent(QShowEvent *event)
{
    // enable the debug window when the main window shows up
    openInfoAction->setEnabled(true);
    openRPCConsoleAction->setEnabled(true);
    openGraphAction->setEnabled(true);
    openPeersAction->setEnabled(true);
    openRepairAction->setEnabled(true);
    aboutAction->setEnabled(true);
    optionsAction->setEnabled(true);

    if (!event->spontaneous()) {
        updateCoinJoinVisibility();
    }
}

#ifdef ENABLE_WALLET
void BitcoinGUI::incomingTransaction(const QString& date, int unit, const CAmount& amount, const QString& type, const QString& address, const QString& label, const QString& walletName)
{
    IncomingTransactionMessage itx = {
            date, unit, amount, type, address, label, walletName
    };
    incomingTransactions.emplace_back(itx);

    if (incomingTransactions.size() == 1) {
        // first TX since we last showed pending messages, let's wait 100ms and then show each individual message
        incomingTransactionsTimer->start(100);
    } else if (incomingTransactions.size() == 10) {
        // we seem to have received 10 TXs in 100ms and we can expect even more, so let's pause for 1 sec and
        // show a ""Multiple TXs sent/received!"" message instead of individual messages
        incomingTransactionsTimer->start(1000);
    }
}
void BitcoinGUI::showIncomingTransactions()
{
    auto txs = std::move(this->incomingTransactions);

    if (txs.empty()) {
        return;
    }

    if (txs.size() >= 100) {
        // Show one balloon for all transactions instead of showing one for each individual one
        // (which would kill some systems)

        CAmount sentAmount = 0;
        CAmount receivedAmount = 0;
        int sentCount = 0;
        int receivedCount = 0;
        for (auto& itx : txs) {
            if (itx.amount < 0) {
                sentAmount += itx.amount;
                sentCount++;
            } else {
                receivedAmount += itx.amount;
                receivedCount++;
            }
        }

        QString title;
        if (sentCount > 0 && receivedCount > 0) {
            title = tr(""Received and sent multiple transactions"");
        } else if (sentCount > 0) {
            title = tr(""Sent multiple transactions"");
        } else if (receivedCount > 0) {
            title = tr(""Received multiple transactions"");
        } else {
            return;
        }

        // Use display unit of last entry
        int unit = txs.back().unit;

        QString msg;
        if (sentCount > 0) {
            msg += tr(""Sent Amount: %1\\n"").arg(BitcoinUnits::formatWithUnit(unit, sentAmount, true));
        }
        if (receivedCount > 0) {
            msg += tr(""Received Amount: %1\\n"").arg(BitcoinUnits::formatWithUnit(unit, receivedAmount, true));
        }

        message(title, msg, CClientUIInterface::MSG_INFORMATION);
    } else {
        for (auto& itx : txs) {
            // On new transaction, make an info balloon
            QString msg = tr(""Date: %1\\n"").arg(itx.date) +
                          tr(""Amount: %1\\n"").arg(BitcoinUnits::formatWithUnit(itx.unit, itx.amount, true));
            if (m_node.getWallets().size() > 1 && !itx.walletName.isEmpty()) {
                msg += tr(""Wallet: %1\\n"").arg(itx.walletName);
            }
            msg += tr(""Type: %1\\n"").arg(itx.type);
            if (!itx.label.isEmpty())
                msg += tr(""Label: %1\\n"").arg(itx.label);
            else if (!itx.address.isEmpty())
                msg += tr(""Address: %1\\n"").arg(itx.address);
            message((itx.amount)<0 ? tr(""Sent transaction"") : tr(""Incoming transaction""),
                    msg, CClientUIInterface::MSG_INFORMATION);
        }
    }
}
#endif // ENABLE_WALLET

void BitcoinGUI::dragEnterEvent(QDragEnterEvent *event)
{
    // Accept only URIs
    if(event->mimeData()->hasUrls())
        event->acceptProposedAction();
}

void BitcoinGUI::dropEvent(QDropEvent *event)
{
    if(event->mimeData()->hasUrls())
    {
        for (const QUrl &uri : event->mimeData()->urls())
        {
            Q_EMIT receivedURI(uri.toString());
        }
    }
    event->acceptProposedAction();
}

bool BitcoinGUI::eventFilter(QObject *object, QEvent *event)
{
    // Catch status tip events
    if (event->type() == QEvent::StatusTip)
    {
        // Prevent adding text from setStatusTip(), if we currently use the status bar for displaying other stuff
        if (progressBarLabel->isVisible() || progressBar->isVisible())
            return true;
    }
    return QMainWindow::eventFilter(object, event);
}

#ifdef ENABLE_WALLET
bool BitcoinGUI::handlePaymentRequest(const SendCoinsRecipient& recipient)
{
    // URI has to be valid
    if (walletFrame && walletFrame->handlePaymentRequest(recipient))
    {
        showNormalIfMinimized();
        gotoSendCoinsPage();
        return true;
    }
    return false;
}

void BitcoinGUI::setHDStatus(int hdEnabled)
{
    if (hdEnabled) {
        labelWalletHDStatusIcon->setPixmap(GUIUtil::getIcon(""hd_enabled"", GUIUtil::ThemedColor::GREEN).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
        labelWalletHDStatusIcon->setToolTip(tr(""HD key generation is <b>enabled</b>""));
    }
    labelWalletHDStatusIcon->setVisible(hdEnabled);
}

void BitcoinGUI::setStakingStatus()
{
    if (nLastCoinStakeSearchInterval && isStakingEnabled()) {
        labelStakingIcon->show();
        labelStakingIcon->setPixmap(QIcon("":/icons/staking_active"").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
        labelStakingIcon->setToolTip(tr(""Staking is active\\n""));
    } else {
        labelStakingIcon->show();
        labelStakingIcon->setPixmap(QIcon("":/icons/staking_inactive"").pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
        labelStakingIcon->setToolTip(tr(""Staking is inactive\\n""));
    }
}

void BitcoinGUI::setEncryptionStatus(int status)
{
    switch(status)
    {
    case WalletModel::Unencrypted:
        labelWalletEncryptionIcon->show();
        labelWalletEncryptionIcon->setPixmap(GUIUtil::getIcon(""lock_open"", GUIUtil::ThemedColor::RED).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
        labelWalletEncryptionIcon->setToolTip(tr(""Wallet is <b>unencrypted</b>""));
        changePassphraseAction->setEnabled(false);
        unlockWalletAction->setVisible(false);
        lockWalletAction->setVisible(false);
        encryptWalletAction->setEnabled(true);
        break;
    case WalletModel::Unlocked:
        labelWalletEncryptionIcon->show();
        labelWalletEncryptionIcon->setPixmap(GUIUtil::getIcon(""lock_open"", GUIUtil::ThemedColor::RED).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
        labelWalletEncryptionIcon->setToolTip(tr(""Wallet is <b>encrypted</b> and currently <b>unlocked</b>""));
        changePassphraseAction->setEnabled(true);
        unlockWalletAction->setVisible(false);
        lockWalletAction->setVisible(true);
        encryptWalletAction->setEnabled(false); // TODO: decrypt currently not supported
        break;
    case WalletModel::UnlockedForMixingOnly:
        labelWalletEncryptionIcon->show();
        labelWalletEncryptionIcon->setPixmap(GUIUtil::getIcon(""lock_open"", GUIUtil::ThemedColor::ORANGE).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
        labelWalletEncryptionIcon->setToolTip(tr(""Wallet is <b>encrypted</b> and currently <b>unlocked</b> for mixing only""));
        changePassphraseAction->setEnabled(true);
        unlockWalletAction->setVisible(true);
        lockWalletAction->setVisible(true);
        encryptWalletAction->setEnabled(false); // TODO: decrypt currently not supported
        break;
    case WalletModel::Locked:
        labelWalletEncryptionIcon->show();
        labelWalletEncryptionIcon->setPixmap(GUIUtil::getIcon(""lock_closed"", GUIUtil::ThemedColor::GREEN).pixmap(STATUSBAR_ICONSIZE, STATUSBAR_ICONSIZE));
        labelWalletEncryptionIcon->setToolTip(tr(""Wallet is <b>encrypted</b> and currently <b>locked</b>""));
        changePassphraseAction->setEnabled(true);
        unlockWalletAction->setVisible(true);
        lockWalletAction->setVisible(false);
        encryptWalletAction->setEnabled(false); // TODO: decrypt currently not supported
        break;
    }
}

void BitcoinGUI::updateWalletStatus()
{
    if (!walletFrame) {
        return;
    }
    WalletView * const walletView = walletFrame->currentWalletView();
    if (!walletView) {
        return;
    }
    WalletModel * const walletModel = walletView->getWalletModel();
    setEncryptionStatus(walletModel->getEncryptionStatus());
    setHDStatus(walletModel->wallet().hdEnabled());
}
#endif // ENABLE_WALLET

void BitcoinGUI::showNormalIfMinimized(bool fToggleHidden)
{
    if(!clientModel)
        return;

    if (!isHidden() && !isMinimized() && !GUIUtil::isObscured(this) && fToggleHidden) {
        hide();
    } else {
        GUIUtil::bringToFront(this);
    }
}

void BitcoinGUI::toggleHidden()
{
    showNormalIfMinimized(true);
}

void BitcoinGUI::detectShutdown()
{
    if (m_node.shutdownRequested())
    {
        if(rpcConsole)
            rpcConsole->hide();
        qApp->quit();
    }
}

void BitcoinGUI::showProgress(const QString &title, int nProgress)
{
    if (nProgress == 0)
    {
        progressDialog = new QProgressDialog(title, """", 0, 100, this);
        progressDialog->setWindowModality(Qt::ApplicationModal);
        progressDialog->setMinimumDuration(0);
        progressDialog->setCancelButton(0);
        progressDialog->setAutoClose(false);
        progressDialog->setValue(0);
    }
    else if (nProgress == 100)
    {
        if (progressDialog)
        {
            progressDialog->close();
            progressDialog->deleteLater();
        }
    }
    else if (progressDialog)
        progressDialog->setValue(nProgress);
}

void BitcoinGUI::setTrayIconVisible(bool fHideTrayIcon)
{
    if (trayIcon)
    {
        trayIcon->setVisible(!fHideTrayIcon);
    }
}

void BitcoinGUI::showModalOverlay()
{
    if (modalOverlay && (progressBar->isVisible() || modalOverlay->isLayerVisible()))
        modalOverlay->toggleVisibility();
}

static bool ThreadSafeMessageBox(BitcoinGUI *gui, const std::string& message, const std::string& caption, unsigned int style)
{
    bool modal = (style & CClientUIInterface::MODAL);
    // The SECURE flag has no effect in the Qt GUI.
    // bool secure = (style & CClientUIInterface::SECURE);
    style &= ~CClientUIInterface::SECURE;
    bool ret = false;
    // In case of modal message, use blocking connection to wait for user to click a button
    QMetaObject::invokeMethod(gui, ""message"",
                               modal ? GUIUtil::blockingGUIThreadConnection() : Qt::QueuedConnection,
                               Q_ARG(QString, QString::fromStdString(caption)),
                               Q_ARG(QString, QString::fromStdString(message)),
                               Q_ARG(unsigned int, style),
                               Q_ARG(bool*, &ret));
    return ret;
}

void BitcoinGUI::subscribeToCoreSignals()
{
    // Connect signals to client
    m_handler_message_box = m_node.handleMessageBox(boost::bind(ThreadSafeMessageBox, this, _1, _2, _3));
    m_handler_question = m_node.handleQuestion(boost::bind(ThreadSafeMessageBox, this, _1, _3, _4));
}

void BitcoinGUI::unsubscribeFromCoreSignals()
{
    // Disconnect signals from client
    m_handler_message_box->disconnect();
    m_handler_question->disconnect();
}

void BitcoinGUI::toggleNetworkActive()
{
    m_node.setNetworkActive(!m_node.getNetworkActive());
}

/** Get restart command-line parameters and request restart */
void BitcoinGUI::handleRestart(QStringList args)
{
    if (!m_node.shutdownRequested())
        Q_EMIT requestedRestart(args);
}

UnitDisplayStatusBarControl::UnitDisplayStatusBarControl() :
    optionsModel(0),
    menu(0)
{
    createContextMenu();
    setToolTip(tr(""Unit to show amounts in. Click to select another unit.""));
    QList<BitcoinUnits::Unit> units = BitcoinUnits::availableUnits();
    int max_width = 0;
    const QFontMetrics fm(GUIUtil::getFontNormal());
    for (const BitcoinUnits::Unit unit : units)
    {
        max_width = qMax(max_width, fm.width(BitcoinUnits::name(unit)));
    }
    setMinimumSize(max_width, 0);
    setAlignment(Qt::AlignRight | Qt::AlignVCenter);
}

/** So that it responds to button clicks */
void UnitDisplayStatusBarControl::mousePressEvent(QMouseEvent *event)
{
    onDisplayUnitsClicked(event->pos());
}

/** Creates context menu, its actions, and wires up all the relevant signals for mouse events. */
void UnitDisplayStatusBarControl::createContextMenu()
{
    menu = new QMenu(this);
    for (BitcoinUnits::Unit u : BitcoinUnits::availableUnits())
    {
        QAction *menuAction = new QAction(QString(BitcoinUnits::name(u)), this);
        menuAction->setData(QVariant(u));
        menu->addAction(menuAction);
    }
    connect(menu,SIGNAL(triggered(QAction*)),this,SLOT(onMenuSelection(QAction*)));
}

/** Lets the control know about the Options Model (and its signals) */
void UnitDisplayStatusBarControl::setOptionsModel(OptionsModel *_optionsModel)
{
    if (_optionsModel)
    {
        this->optionsModel = _optionsModel;

        // be aware of a display unit change reported by the OptionsModel object.
        connect(_optionsModel,SIGNAL(displayUnitChanged(int)),this,SLOT(updateDisplayUnit(int)));

        // initialize the display units label with the current value in the model.
        updateDisplayUnit(_optionsModel->getDisplayUnit());
    }
}

/** When Display Units are changed on OptionsModel it will refresh the display text of the control on the status bar */
void UnitDisplayStatusBarControl::updateDisplayUnit(int newUnits)
{
    setText(BitcoinUnits::name(newUnits));
}

/** Shows context menu with Display Unit options by the mouse coordinates */
void UnitDisplayStatusBarControl::onDisplayUnitsClicked(const QPoint& point)
{
    QPoint globalPos = mapToGlobal(point);
    menu->exec(globalPos);
}

/** Tells underlying optionsModel to update its current display unit. */
void UnitDisplayStatusBarControl::onMenuSelection(QAction* action)
{
    if (action)
    {
        optionsModel->setDisplayUnit(action->data());
    }
}
",16206,True,2837.519875598231,median
"CLASS zcl_ci_test_translations DEFINITION
  PUBLIC
  INHERITING FROM cl_ci_test_root
  FINAL
  CREATE PUBLIC .

  PUBLIC SECTION.
    METHODS constructor .
    METHODS run REDEFINITION .
  PROTECTED SECTION.

  PRIVATE SECTION.
    CONSTANTS c_my_name TYPE seoclsname VALUE 'ZCL_CI_TEST_TRANSLATIONS' ##NO_TEXT.
    TYPES: BEGIN OF tp
         , key TYPE syst_msgv  "" 50 characters. We run into problems with MESSAGE if we use more than that
         , END OF tp
         , ttp TYPE SORTED TABLE OF tp WITH UNIQUE KEY key
         .
    DATA: m_spras TYPE spras      "" 1 character
        , m_laiso TYPE t002-laiso "" ISO language (2 characters)
              .

    METHODS: check_program_texts
           , check_screen_texts
           , check_single_generic
               IMPORTING i_check_code TYPE sci_errc
                         i_screen     TYPE d020s-dnum OPTIONAL "" only to be filled for screen checks
           , check_list_generic
               IMPORTING i_check_code TYPE sci_errc
                         i_screen     TYPE d020s-dnum OPTIONAL "" only to be filled for screen checks
           , set_language_from_index
               IMPORTING i_index TYPE sy-index
           , is_master_language_missing
               RETURNING VALUE(r) TYPE abap_bool,
             remove_screen_ddic_fields
               IMPORTING i_program_name TYPE progname
                         i_screen TYPE d020s-dnum
               CHANGING  c_fields TYPE zcl_ci_test_translations=>ttp.

ENDCLASS.



CLASS zcl_ci_test_translations IMPLEMENTATION.


  METHOD check_list_generic.
    DATA: it_key TYPE ttp
        , it_key_de TYPE ttp
        , it_key_en LIKE it_key_de
        , it_key_missing LIKE it_key_de
        , pattern TYPE char40
        .

    DO 2 TIMES.
      set_language_from_index( sy-index ).
      CASE i_check_code.
        WHEN '0004'.
          SELECT msgnr FROM t100
            WHERE arbgb = @object_name ""#ec ci_conv_ok
              AND sprsl = @m_spras
            INTO TABLE @it_key.                           ""#EC CI_SUBRC
        WHEN '0008'.
          SELECT domvalue_l FROM dd07t
            WHERE domname    = @object_name ""#ec ci_conv_ok
              AND ddlanguage = @m_spras
              AND as4local   = 'A'
              AND ddtext    <> ''
            INTO TABLE @it_key.                           ""#EC CI_SUBRC
        WHEN '0009'.
          pattern = |{ object_name }___|. "" followed by 3 digits
          SELECT object FROM doktl
            WHERE id = 'NA'  "" message
              AND object LIKE @pattern ""#ec ci_conv_ok
              AND langu = @m_spras                      ""#EC CI_NOORDER
            INTO TABLE @DATA(it_key_duplicates).          ""#EC CI_SUBRC
          SORT it_key_duplicates BY table_line. ""#EC CI_SORTLOOP . Cannot use DISTINCT because doktl is a cluster table
          DELETE ADJACENT DUPLICATES FROM it_key_duplicates COMPARING table_line.
          it_key = it_key_duplicates.
        WHEN '0010'.
          SELECT SINGLE @abap_true
            FROM d342l
            WHERE progname = @program_name
            INTO @data(dummy).
          IF sy-subrc = 0. "" if all GUI status have been deleted (no entry in table d342l), the texts still remain as zombies, but we do not want to check them.
            "" However, the entry in d342l also sometimes remains, even though the GUI status has been deleted. So in some cases there will still be false (zombie) findings
            DATA(separator) = '|'.
            SELECT DISTINCT obj_type && @separator && texttype && @separator && obj_code FROM rsmptexts
              WHERE progname = @program_name ""#ec ci_conv_ok
                "" do not check technical texts:
                AND ( texttype <> 'T'      "" various texts of GUI-Status
                      OR obj_type = 'T' )  "" GUI-Title
                AND sprsl = @m_spras       "" #EC CI_CMPLX_WHERE
              INTO TABLE @it_key.                         ""#EC CI_SUBRC
          ENDIF.
        WHEN '0012'.
          SELECT fldn FROM d021t
            WHERE prog = @program_name ""#ec ci_conv_ok
              AND dynr = @i_screen
              AND lang = @m_spras
            INTO TABLE @it_key.                           ""#EC CI_SUBRC
        WHEN '0014'.
          pattern = |{ object_name WIDTH = 30 }%|. "" first 30 chars = componentname + spaces (followed by viewname from pos 31)
          SELECT CASE sotr_head~alias_name
                   WHEN ' ' THEN sotr_head~concept
                   ELSE sotr_head~alias_name
                 END AS key
            FROM sotr_use INNER JOIN sotr_head ON sotr_use~concept = sotr_head~concept
                          INNER JOIN sotr_text ON sotr_use~concept = sotr_text~concept
            WHERE sotr_use~pgmid  = 'LIMU'
              AND sotr_use~object = 'WDYV'
              AND sotr_use~obj_name LIKE @pattern
              AND sotr_text~langu = @m_spras
            INTO TABLE @it_key.                           ""#EC CI_SUBRC
        WHEN OTHERS.
          ASSERT 1 = 0.
      ENDCASE.

      CASE sy-index.
        WHEN 1. MOVE-CORRESPONDING it_key TO it_key_de.
        WHEN 2. MOVE-CORRESPONDING it_key TO it_key_en.
      ENDCASE.
    ENDDO.

    "" need to synchronize at this point, otherwise the filtering cannot be done both ways
    DO 2 TIMES.
      set_language_from_index( sy-index ).
      CASE sy-index.
        WHEN 1. it_key_missing = FILTER #( it_key_en EXCEPT IN it_key_de WHERE key = key ).
        WHEN 2. it_key_missing = FILTER #( it_key_de EXCEPT IN it_key_en WHERE key = key ).
      ENDCASE.
      IF i_check_code = '0012'.
        remove_screen_ddic_fields( EXPORTING i_program_name = program_name
                                             i_screen       = i_screen
                                   CHANGING  c_fields       = it_key_missing ).
      ENDIF.
      LOOP AT it_key_missing ASSIGNING FIELD-SYMBOL(<wa>).
        inform( p_sub_obj_type = object_type
                p_sub_obj_name = object_name
                p_test     = c_my_name
                p_code     = i_check_code
                "" in case 0012 (Screen [dynpro] field),
                "" if the master language entry is missing (i.e. field has been deleted, but translation was not deleted),
                "" ignore, because of very low risk
                "" (I also verified that the Autotext numbers are not reused - EvG)
                "" This case still occurs after I implemented the remove_screen_ddic_fields() method - 08.05.2019 with SAPMZE32 / 9090
                p_kind     = COND #( WHEN i_check_code = '0012' AND is_master_language_missing( ) THEN c_note
                                                                                                  ELSE c_warning )
                p_param_1  = COND #( WHEN i_check_code = '0012' THEN i_screen && '|' && <wa>-key
                                     ELSE <wa>-key )
                p_param_2  = m_laiso ).
      ENDLOOP.
    ENDDO.
  ENDMETHOD.


  METHOD check_program_texts.
    DATA: it_tpool TYPE textpool_table
        , it_de TYPE SORTED TABLE OF textpool WITH UNIQUE KEY id key
        , it_en LIKE it_de
        , it_missing LIKE it_de
        , check_code TYPE sci_errc
        .
    CHECK program_name IS NOT INITIAL.
    DO 2 TIMES.
      set_language_from_index( sy-index ).
      CLEAR it_tpool.
      READ TEXTPOOL program_name LANGUAGE m_spras INTO it_tpool.
      SORT it_tpool BY id key.                         ""#EC CI_SORTLOOP
      DELETE ADJACENT DUPLICATES FROM it_tpool COMPARING id key. "" we do not want to crash because of inconsistent data (e.g. report ZKFVBMTASNEU)

      CASE sy-index.
        WHEN 1. MOVE-CORRESPONDING it_tpool TO it_de.
        WHEN 2. MOVE-CORRESPONDING it_tpool TO it_en.
      ENDCASE.
    ENDDO.

    "" need to synchronize at this point, otherwise the filtering cannot be done both ways
    DO 2 TIMES.
      "" first iteration: m_spras = D. it_missing = texts missing in DE (i.e. existing only in EN)
      set_language_from_index( sy-index ).
      CASE sy-index.
        WHEN 1. it_missing = FILTER #( it_en EXCEPT IN it_de WHERE id = id AND key = key ).
        WHEN 2. it_missing = FILTER #( it_de EXCEPT IN it_en WHERE id = id AND key = key ).
      ENDCASE.

      "" We observed once there was an ID=R Length=0 entry for a function group. Therefore:
      DELETE it_missing WHERE length = 0.               ""#EC CI_SORTSEQ

      LOOP AT it_missing ASSIGNING FIELD-SYMBOL(<wa>).
        CASE <wa>-id.
          WHEN 'S'.
            check_code = '0001'.
            IF <wa>-entry(1) = 'D'.
              "" if the DDIC-Flag is set in the original language, texts are taken from DDIC.
              "" But a ""dummy"" translation ""."" to other languages is required for technical reasons
              "" see note https://launchpad.support.sap.com/#/notes/2287306
              "" ATTENTION: the logic here has to be checked when we add a further languages (besides DE and EN)
              check_code = '0016'. "" Dummy-Text ""."" missing   --- Note that in this case there only p_param_2 / &2 is used
            ENDIF.
            "" in case 0001 (Parameters),
            "" if the master language entry is missing (i.e. parameter has been removed, but translation was not deleted),
            "" ignore, because of very low risk
            IF is_master_language_missing( ).
              DATA(prio3_only) = abap_true.
            ENDIF.
          WHEN 'I'. check_code = '0002'.
          WHEN 'R'. check_code = '0003'.
          WHEN OTHERS. "" check for list headings not supported
        ENDCASE.
        CHECK check_code IS NOT INITIAL. "" correction EvG 20180509 after Upgrade
        inform( p_sub_obj_type = object_type
                p_sub_obj_name = object_name
                p_test     = c_my_name
                p_code     = check_code
                p_kind     = COND #( WHEN prio3_only = abap_false THEN c_warning
                                                                  ELSE c_note )
                p_param_1  = <wa>-key
                p_param_2  = m_laiso ).
      ENDLOOP.
    ENDDO.

    DATA(it_both) = FILTER #( it_en IN it_de WHERE id = id AND key = key ).
    LOOP AT it_both ASSIGNING <wa> WHERE id = 'S'.
      DATA(wa_de) = it_de[ id = <wa>-id key = <wa>-key ].
      DATA(wa_en) = it_en[ id = <wa>-id key = <wa>-key ].
      IF    ( wa_de-entry(1) = 'D' AND wa_en-entry(1) = ' ' )
         OR ( wa_de-entry(1) = ' ' AND wa_en-entry(1) = 'D' ).
        inform( p_sub_obj_type = object_type
                p_sub_obj_name = object_name
                p_test     = c_my_name
                p_code     = '0006'
                p_param_1  = <wa>-key ).
      ENDIF.
    ENDLOOP.

  ENDMETHOD.


  METHOD check_screen_texts.
    SELECT dnum FROM d020s
      WHERE type = '' "" exclude generated screens
        AND prog = @program_name
      INTO TABLE @DATA(screens).                          ""#EC CI_SUBRC
    LOOP AT screens ASSIGNING FIELD-SYMBOL(<screen>).
      check_single_generic( i_check_code = '0011'
                            i_screen = CONV #( <screen> ) ).
      check_list_generic( i_check_code = '0012'
                          i_screen = CONV #( <screen> ) ).
    ENDLOOP.
  ENDMETHOD.


  METHOD check_single_generic.
    DATA: missing TYPE abap_bool
        , exists TYPE abap_bool
        .

    DO 2 TIMES.
      set_language_from_index( sy-index ).
      exists = abap_false.
      CASE i_check_code.
        WHEN '0005'.
          SELECT SINGLE @abap_true FROM dd04t
            WHERE rollname = @object_name ""#ec ci_conv_ok
              AND ddlanguage = @m_spras
            INTO @exists.                                 ""#EC CI_SUBRC
        WHEN '0007'.
          SELECT SINGLE @abap_true FROM tstct
            WHERE tcode = @object_name ""#ec ci_conv_ok
              AND sprsl = @m_spras
            INTO @exists.                                 ""#EC CI_SUBRC
        WHEN '0011'.
          SELECT SINGLE @abap_true FROM d020t
            WHERE prog = @program_name ""#ec ci_conv_ok
              AND dynr = @i_screen
              AND lang = @m_spras
            INTO @exists.                                 ""#EC CI_SUBRC
        WHEN '0013'.
          SELECT SINGLE @abap_true FROM tparat
            WHERE paramid = @object_name ""#ec ci_conv_ok
              AND sprache = @m_spras
            INTO @exists.                                 ""#EC CI_SUBRC
        WHEN '0015'.
          SELECT SINGLE @abap_true FROM tdevct
            WHERE devclass = @object_name ""#ec ci_conv_ok
              AND spras = @m_spras
            INTO @exists.                                 ""#EC CI_SUBRC
        WHEN OTHERS.
          ASSERT 1 = 0.
      ENDCASE.
      CASE sy-index.
        WHEN 1. DATA(de_exists) = exists.
        WHEN 2. DATA(en_exists) = exists.
      ENDCASE.
    ENDDO.

    "" need to synchronize at this point, otherwise the filtering cannot be done both ways
    DO 2 TIMES.
      set_language_from_index( sy-index ).
      CASE sy-index.
        WHEN 1. missing = xsdbool( de_exists = abap_false AND en_exists = abap_true  ).
        WHEN 2. missing = xsdbool( de_exists = abap_true  AND en_exists = abap_false ).
      ENDCASE.
      IF missing = abap_true.
        inform( p_sub_obj_type = object_type
                p_sub_obj_name = object_name
                p_test         = c_my_name
                p_code         = i_check_code
                "" in case 0005 (Data Element),
                "" if the master language entry is missing (i.e. Data element has been deleted, but translation was not deleted),
                "" ignore, because of very low risk
                p_kind         = COND #( WHEN i_check_code = '0005' AND is_master_language_missing( ) THEN c_note
                                                                                                      ELSE c_warning )
                p_param_1      = i_screen    "" this is only filled for check 0011. All other texts here should not make use of &1
                p_param_2      = m_laiso ).  "" PARAM1 should be something key-like, for the filtering of Z_DELTA check variant
      ENDIF.
    ENDDO.

  ENDMETHOD.


  METHOD constructor .
************************************************************************
* ATC/Code Inspector Test for missing translations.
* Checks for various object types, that texts are maintained in DE and EN.
* Author: Edo von Glan, www.draeger.com
*
* Known limitations of this check
* - Navigation to objects (translated texts) is not possible
* - If there are several GUI status for one program, the message does not reveal
*   in which status the text is missing (because info is not directly available in
*   RSMPTEXTS, would need to evaluate output of function RS_CUA_INTERNAL_FETCH
*   for various object types)
*
* Possible additional object types / checks
*    DD01T R/3 DD: domain texts - not sure if this is ever visible for the user
*    DD02T SAP DD: SAP Table Texts - not sure if this is ever visible for the user
*    DD30T Search help texts - not sure if this is ever visible for the user
*    SE61-Texts in general
*
* Note concerning other languages:
*   Currently, DE and EN are checked.
*   It would be difficult to check more than 2 languages (big change of logic / code necessary).
*   However, it would be easily possible to replace EN with a different language as second language, maybe dependent
*   on the check variant (e.g. Z_TRANSLATION_FR might replace EN with FR)
************************************************************************
* MIT License
*
* Copyright (c) 2019 DSAG
*
* 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.
************************************************************************

    DEFINE fill_message.
      CLEAR smsg.
      smsg-test = c_my_name.
      smsg-code = &1. ""message code
      smsg-kind = &2. ""message priority
      smsg-text = &3. ""message text
      smsg-pcom = &4. ""pseudocomment
      INSERT smsg INTO TABLE scimessages.
    END-OF-DEFINITION.

    super->constructor( ).

    description    = TEXT-000.
    category       = 'ZCL_CI_CATEGORY_DSAG' ##NO_TEXT.
    position       = 1.
    has_attributes = abap_false.
    attributes_ok  = abap_false.
    has_documentation = abap_true.

    add_obj_type( 'PROG' ).
    add_obj_type( 'FUGR' ).
    add_obj_type( 'CLAS' ).
    add_obj_type( 'INTF' ).
    add_obj_type( 'MSAG' ).
    add_obj_type( 'DOMA' ).
    add_obj_type( 'DTEL' ).
    add_obj_type( 'TRAN' ).
    add_obj_type( 'PARA' ).
    add_obj_type( 'WDYN' ).
    add_obj_type( 'DEVC' ).

    fill_message '0001' c_warning TEXT-001 c_exceptn_imposibl . "" Selektionstext &1 fehlt in Sprache &2  (TEXTPOOL-ID = S)
    fill_message '0002' c_warning TEXT-002 c_exceptn_imposibl . "" Textsymbol &1 fehlt in Sprache &2 (TEXTPOOL-ID = I)
    fill_message '0003' c_warning TEXT-003 c_exceptn_imposibl . "" Programmtitel fehlt in Sprache &2 (TEXTPOOL-ID = R)
    fill_message '0004' c_warning TEXT-004 c_exceptn_imposibl . "" Nachricht &1 fehlt in Sprache &2
    fill_message '0005' c_warning TEXT-005 c_exceptn_imposibl . "" Text zu Datenelement fehlt in Sprache &2
    fill_message '0006' c_note    TEXT-006 c_exceptn_imposibl . "" Selektionstext &1 hat inkonsistenten DDIC-Bezug (DE/EN)
    fill_message '0007' c_warning TEXT-007 c_exceptn_imposibl . "" Text zu Transaktion fehlt in Sprache &2
    fill_message '0008' c_warning TEXT-008 c_exceptn_imposibl . "" Text zu Festwert &1 fehlt in Sprache &2
    fill_message '0009' c_warning TEXT-009 c_exceptn_imposibl . "" Langtext zu Nachricht &1 fehlt in Sprache &2
    fill_message '0010' c_warning TEXT-010 c_exceptn_imposibl . "" GUI-Text &1 fehlt in Sprache &2
    fill_message '0011' c_warning TEXT-011 c_exceptn_imposibl . "" Text zu Dynpro &1 fehlt in Sprache &2
    fill_message '0012' c_warning TEXT-012 c_exceptn_imposibl . "" Text zu Dynpro-Feld &1 fehlt in Sprache &2
    fill_message '0013' c_warning TEXT-013 c_exceptn_imposibl . "" Text zu GET/SET-Parameter fehlt in Sprache &2
    fill_message '0014' c_warning TEXT-014 c_exceptn_imposibl . "" OTR-Text zu Konzept &1 fehlt in Sprache &2
    fill_message '0015' c_warning TEXT-015 c_exceptn_imposibl . "" Kurzbeschreibung zu Paket &1 fehlt in Sprache &2
    fill_message '0016' c_warning TEXT-016 c_exceptn_imposibl . "" Dummy-Text ""."" zu DDIC-Selektionsparameter &1 fehlt in Sprache &2

  ENDMETHOD.


  METHOD is_master_language_missing.
    SELECT SINGLE masterlang
      FROM tadir
      WHERE pgmid     = 'R3TR'
        AND object   = @object_type
        AND obj_name = @object_name
      INTO @DATA(master_language).
    IF sy-subrc <> 0 OR master_language IS INITIAL.
      SELECT SINGLE rload
        FROM reposrc
        WHERE progname = @program_name
          AND r3state = 'A'
        INTO @master_language.
      IF sy-subrc <> 0 OR master_language IS INITIAL.
        LOG-POINT ID zlog FIELDS object_type object_name program_name.
        r = abap_false. "" like this, there may be an error on the side of giving too many warnings (which we prefer to too few)
        RETURN.
      ENDIF.
    ENDIF.

    r = xsdbool( m_spras = master_language ).

  ENDMETHOD.


  METHOD run.
    CHECK object_type IN typelist.
    check_program_texts( ).
    check_screen_texts( ).
    CASE object_type.
      WHEN 'DTEL'.
        check_single_generic( '0005' ).
      WHEN 'DOMA'.
        check_list_generic( '0008' ).
      WHEN 'MSAG'.
        check_list_generic( '0004' ).
        check_list_generic( '0009' ).
      WHEN 'PROG' OR 'FUGR'.
        check_list_generic( '0010' ).
      WHEN 'TRAN'.
        check_single_generic( '0007' ).
      WHEN 'PARA'.
        check_single_generic( '0013' ).
      WHEN 'WDYN'.  "" R3TR WDYN --> LIMU WDYV --> OTR text
        check_list_generic( '0014' ).
      WHEN 'DEVC'.
        check_single_generic( '0015' ).
    ENDCASE.

  ENDMETHOD.


  METHOD set_language_from_index.
    CASE i_index.
      WHEN 1. m_spras = 'D'.
      WHEN 2. m_spras = 'E'.
    ENDCASE.
    SELECT SINGLE laiso FROM t002
      WHERE spras = @m_spras
      INTO @m_laiso.
    ASSERT sy-subrc = 0.
  ENDMETHOD.

  METHOD remove_screen_ddic_fields.
    DATA: screen_fields TYPE dyfatc_tab.
    CHECK c_fields IS NOT INITIAL.
    CALL FUNCTION 'RPY_DYNPRO_READ'
      EXPORTING
        progname              = i_program_name
        dynnr                 = i_screen
        suppress_exist_checks = 'X'                  "" Unterdrücken Existenzcheck des Dynpros
        suppress_corr_checks  = 'X'                  "" Unterdrücken Verprobung Anzeigeberechtigung
      TABLES
        fields_to_containers  = screen_fields
      EXCEPTIONS
        cancelled             = 1                    "" Abbruch durch Nutzer im Korrektur-popup
        not_found             = 2                    "" Dynpro nicht gefunden
        permission_error      = 3                    "" keine Berechtigung im Importieren (Lesen)
        OTHERS                = 4.
    ASSERT ID zlog FIELDS i_program_name i_screen CONDITION sy-subrc = 0.
    LOOP AT c_fields REFERENCE INTO DATA(check_field).

      IF NOT line_exists( screen_fields[ name = check_field->key type = 'TEXT' ] )
         OR               screen_fields[ name = check_field->key type = 'TEXT' ]-from_dict = 'X'.
        DELETE c_fields USING KEY loop_key.
      ENDIF.
    ENDLOOP.
    "" Alternative implementation:
    "" function DYNPRO_IMPORT, then
    "" data FLG1DDF type X length 1 value '20'.
    "" from_dict = <field>-FLG1 BIT_AND FLG1DDF (in SAP code, the obsolete operator 'o' is used)
  ENDMETHOD.

ENDCLASS.
",5836,False,1166.5184556224915,median
"// 
//     Licensed to the Apache Software Foundation (ASF) under one
//     or more contributor license agreements.  See the NOTICE file
//     distributed with this work for additional information
//     regarding copyright ownership.  The ASF licenses this file
//     to you under the Apache License, Version 2.0 (the
//     ""License""); you may not use this file except in compliance
//     with the License.  You may obtain a copy of the License at
// 
//       http://www.apache.org/licenses/LICENSE-2.0
// 
//     Unless required by applicable law or agreed to in writing,
//     software distributed under the License is distributed on an
//     ""AS IS"" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
//     KIND, either express or implied.  See the License for the
//     specific language governing permissions and limitations
//     under the License.
//

= NetBeans IDEでのGitサポートの使用
:jbake-type: tutorial
:jbake-tags: tutorials 
:jbake-status: published
:icons: font
:syntax: true
:source-highlighter: pygments
:toc: left
:toc-title:
:description: NetBeans IDEでのGitサポートの使用 - Apache NetBeans
:keywords: Apache NetBeans, Tutorials, NetBeans IDEでのGitサポートの使用

NetBeans IDEはGitバージョン管理クライアントをサポートしています。IDEのGitサポートにより、IDE内のプロジェクトから直接バージョン管理タスクを実行できます。このドキュメントでは、バージョン管理ソフトウェアを使用する場合の標準的なワークフローを説明することによって、IDEの基本的なバージョン管理タスクの実行方法を示します。

Gitは、小さなプロジェクトから非常に大きなプロジェクトまであらゆるものを高速かつ効率的に処理するように設計された、無料かつオープン・ソースの分散バージョン管理システムです。すべてのGitクローンは、ネットワーク・アクセスや中央のサーバーに依存せずに、完全な履歴およびリビジョン・トラック機能を備え、すべてを完備したリポジトリです。分岐やマージの実行は高速で簡単です。Gitはファイルのバージョン管理に使用され、Mercurial、Subversion、CVS、Perforceなどのツールによく似ています。

== 内容

image::images/netbeans-stamp-80-74.png[title=""このページの内容は、NetBeans IDE 7.4および8.0に適用されます""]

* <<initialize,Gitリポジトリの初期化>>
* <<clone,Gitリポジトリのクローン>>
* <<github,SSHプロトコルによるGitHubからのリポジトリのクローン>>
* <<add,Gitリポジトリへのファイルの追加>>
* <<editing,ファイルの編集>>
* <<viewChanges,ソース・エディタでの変更の表示>>
* <<viewFileStatus,ファイルのステータス情報の表示>>
* <<diff,ファイル・リビジョンの比較>>
* <<revert,変更を元に戻す>>
* <<committing,リポジトリへのソースのコミット>>
* <<branch,分岐の操作>>
* <<branchCreate,分岐の作成>>
* <<branchCheckOut,分岐のチェックアウト>>
* <<branchMerge,マージ>>
* <<branchDelete,分岐の削除>>
* <<remote,リモート・リポジトリの操作>>
* <<fetch,フェッチ>>
* <<pull,プル>>
* <<push,プッシュ>>
* <<summary,サマリー>>
* <<seealso,関連項目>>


== 要件

*このチュートリアルを完了するには、次のソフトウェアとリソースが必要です。*

|===
|ソフトウェアまたはリソース |必須バージョン 

|link:https://netbeans.org/downloads/index.html[+NetBeans IDE+] |バージョン7.4または8.0 

|link:http://www.oracle.com/technetwork/java/javase/downloads/index.html[+Java Development Kit+] (JDK) |バージョン7または8 
|===


== Gitリポジトリの初期化

まだソース管理されていない既存のファイルからGitリポジトリを初期化するには、次の手順を完了する必要があります。

1. 「プロジェクト」ウィンドウで、バージョン管理されていないプロジェクトを選択し、プロジェクト名を右クリックします。
2. コンテキスト・メニューで「 ``バージョン管理`` 」>「 ``Gitリポジトリの初期化`` 」(または、メイン・メニューの「 ``チーム`` 」>「 ``Git`` 」>「 ``初期化`` 」)を選択します。

[.feature]
--
image::images/initialize-git-repo-small.png[role=""left"", link=""images/initialize-git-repo.png""]
--

[start=3]
1. 「 ``Gitリポジトリの初期化`` 」ダイアログ・ボックスで、バージョン管理されるファイルの保存先リポジトリへのパスを指定するか、「参照」をクリックして、必要なディレクトリを参照します。
2. 「OK」をクリックします。

 ``.git`` サブフォルダは、上のステップ3で指定したフォルダ(デフォルトでNetBeansプロジェクト・フォルダ)に作成され、プロジェクト・スナップショットのすべてのデータが格納されるGitリポジトリです。Gitは指定されたフォルダ内のすべてのファイルのバージョン管理を開始します。
「 ``ウィンドウ`` 」>「 ``出力`` 」>「 ``出力`` 」を開いて、ローカル作業ディレクトリ下のリポジトリの作成の進捗に関するIDEのレポートを表示できます。

image::images/output-init.png[]

すべてのプロジェクト・ファイルが作業ツリーで「 ``追加済み`` 」とマークされます。ファイル・<<viewFileStatus,ステータス>>を表示するには、「プロジェクト」ウィンドウ内のファイル名の上にカーソルを置きます。次の図に示すように、作業ツリーのファイルのステータスが、斜線の右側に緑で表示されます。

image::images/new-locally.png[]

Gitリポジトリの初期化後、Gitリポジトリにファイルを<<add,追加>>するか、または直接それらを<<committing,コミット>>します。


== Gitリポジトリのクローン

既存のGitリポジトリのコピーを取得するには、それをクローンする必要があります。IDEでリポジトリをクローン・ウィザードを起動する前に、GitリポジトリのURLがわかっていることを確認します。

1. メイン・メニューから「 ``チーム`` 」>「 ``Git`` 」>「 ``クローン`` 」を選択します。リポジトリをクローン・ウィザードが表示されます。

[.feature]
--
image::images/clone-wizard-small.png[role=""left"", link=""images/clone-wizard.png""]
--

[start=2]
1. リポジトリ・ページで、Gitリポジトリの場所へのパス、ユーザー名、およびパスワードを指定します(必要に応じて、今後のためにそれらを保存できます)。
2. (オプション)「プロキシ構成」をクリックし、「オプション」ダイアログ・ボックスを表示して、プロキシ・サーバー設定を設定します。終了したら「OK」をクリックします。
3. 「次」をクリックして、ウィザードの次のステップに切り替えます。
4. リモート分岐ページで、ローカル・リポジトリにフェッチ(ダウンロード)するリポジトリ分岐を選択します。「次」をクリックします。
5. 出力先ディレクトリ・ページで、次を指定します。
* 「親ディレクトリ」フィールドでは、ハード・ドライブ上にクローンされるリポジトリ用のディレクトリへのパス(または、「参照」ボタンをクリックし、ディレクトリに移動する)。
「親ディレクトリ」フィールドには、すべてのNetBeansプロジェクトが格納されるデフォルトの ``NetBeansProjects`` ディレクトリへのパスが事前入力されています。
* 「クローン名」フィールドの、元のプロジェクトをクローンするローカル・フォルダの名前。
デフォルトで、「クローン名」には実際のGitリポジトリ名が入力されています。
* 「分岐のチェックアウト」フィールドで、作業ツリーにチェックアウトする分岐を選択します。
* 「リモート名」フィールドの、クローンする元のリポジトリを表す名前。
 ``origin`` はクローンするリポジトリのデフォルトのエイリアスです。これは推奨される値です。
* 「クローン後にNetBeansプロジェクトをスキャン」チェックボックスを選択されたままにして、クローンの終了直後に、事後スキャンをアクティブ化します。(プラグインはクローンされたリソースでNetBeansプロジェクトを検索し、見つかったプロジェクトを開くように提案します。)

[start=7]
1. 「終了」をクリックします。
Gitリポジトリのクローン後、ウィザードで選択したフォルダ内にメタデータ ``.git`` フォルダが作成されます。


=== SSHプロトコルによるGitHubからのリポジトリのクローン

SSHプロトコルによってGitHubからリポジトリをクローンするには、次のように進みます。

*注意:* SSHによってクローンするには、GitHubアカウントを持っており、プロジェクト・メンバーである必要があります。

1. メイン・メニューから「 ``チーム`` 」>「 ``Git`` 」>「 ``クローン`` 」を選択します。リポジトリをクローン・ウィザードが表示されます。
2. リポジトリをクローン・ウィザードのリモート・リポジトリ・ページで、「リポジトリURL」フィールドに、必要なリポジトリへのパス、たとえば ``git@github.com:tstupka/koliba.git`` などを指定します。
3. 「ユーザー名」テキスト・フィールドに ``git`` が指定されていることを確認します。
4. 「秘密/公開鍵」オプションを選択します。
5. (*Gitサーバーへの自動化されたSSHアクセスにSSHエージェントまたはPageantを使用中の場合はスキップします。*)SSH秘密鍵およびパス・フレーズを使用してGitサーバーにアクセスするには次の手順を実行します。

[start=1]
1. 鍵ファイルへのパス、たとえば ``C:\\Users\\key`` などを指定します。

*注意:* OpenSSH秘密鍵形式が必要です。Microsoft Windowsに対応のPuTTYgenで生成された鍵は、IDEを使用する前に、OpenSSH形式に変換する必要があります。

[start=2]
1. 鍵ファイルのパス・フレーズ、たとえば ``abcd`` などを入力します。

[start=3]
1. (オプション)必要に応じて、「パス・フレーズを保存」オプションを選択します。

[start=6]
1. (*Gitサーバーへの自動化されたSSHアクセスにSSHエージェントまたはPageantを使用中の場合に適用されます。*)正しく構成されたSSHエージェントまたはPageant経由でIDEからGitサーバーへの認証されたアクセスを得るには、「秘密鍵ファイル」および「パス・フレーズ」フィールドを空のままにします。
2. (オプション)「プロキシ構成」をクリックし、「オプション」ダイアログ・ボックスを表示して、プロキシ・サーバー設定を設定します。終了したら「OK」をクリックします。

[.feature]
--
image::images/github-repo-small.png[role=""left"", link=""images/github-repo.png""]
--

[start=8]
1. 「次」をクリックします。
2. リモート分岐ページで、ローカル・リポジトリにフェッチ(ダウンロード)するリポジトリ分岐、たとえば ``master`` などを選択します。

[.feature]
--
image::images/github-branches-small.png[role=""left"", link=""images/github-branches.png""]
--

[start=10]
1. 「次」をクリックします。
2. 出力先ディレクトリ・ページで、次を指定します。
* 「親ディレクトリ」フィールドでは、ハード・ドライブ上にクローンされるリポジトリ用のディレクトリへのパス(または、「参照」ボタンをクリックし、ディレクトリに移動する)。
「親ディレクトリ」フィールドには、すべてのNetBeansプロジェクトが格納されるデフォルトの ``NetBeansProjects`` ディレクトリへのパスが事前入力されています。
* 「クローン名」フィールドの、元のプロジェクトをクローンするローカル・フォルダの名前。
デフォルトで、「クローン名」には実際のGitリポジトリ名が入力されています。
* 「分岐のチェックアウト」フィールドで、作業ツリーにチェックアウトする分岐を選択します。
* 「リモート名」フィールドの、クローンする元のリポジトリを表す名前。
 ``origin`` はクローンするリポジトリのデフォルトのエイリアスです。これは推奨される値です。
* 「クローン後にNetBeansプロジェクトをスキャン」チェックボックスを選択されたままにして、クローンの終了直後に、事後スキャンをアクティブ化します。(プラグインはクローンされたリソースでNetBeansプロジェクトを検索し、見つかったプロジェクトを開くように提案します。)

[.feature]
--
image::images/github-destination-small.png[role=""left"", link=""images/github-destination.png""]
--

[start=12]
1. 「終了」をクリックします。
リポジトリがクローンされると、「クローン完了」メッセージが表示されます。

image::images/clone-completed.png[]

[start=13]
1. 目的のオプションを選択します。


== Gitリポジトリへのファイルの追加

新しいファイルのトラックを開始し、さらに、Gitリポジトリ内のすでにトラックされているファイルへの変更をステージングするには、それをリポジトリに追加する必要があります。

Gitリポジトリにファイルが追加されると、IDEはプロジェクトのスナップショットを作成し、最初に索引に保存します。コミットが実行されると、IDEはそれらのスナップショットをHEADに保存します。IDEでは、次の表に説明する2つのワークフローから選択できます。

|===
|ワークフローの説明 |新規または変更済のファイルを索引に明示的に追加し、索引でステージングされているファイルのみをHEADにコミットします。 |新規または変更済のファイルの索引への追加をスキップし、必要なファイルを直接HEADにコミットします。 

|ワークフローに従う手順  |

1. 「プロジェクト」ウィンドウで、追加するファイルを右クリックします。
2. コンテキスト・メニューで「 ``Git`` 」>「 ``追加`` 」を選択します。
これにより、コミットする前に、ファイルの内容が索引に追加されます。
[start=3]
1. 「プロジェクト」ウィンドウで、コミットするファイルを右クリックします。
2. 「コミット」ダイアログ・ボックスで、「HEADと索引間の変更」(image::images/changes-head-index.png[])トグル・ボタンを選択します。
これにより、すでにステージングされているファイルの一覧が表示されます。
[start=5]
1. 下の<<committing,リポジトリへソースのコミット>>の項で説明するように、ファイルをコミットします。
 |

1. 「プロジェクト」ウィンドウで、コミットするファイルを右クリックします。
2. コンテキスト・メニューで、「 ``Git`` 」>「 ``コミット`` 」を選択します。
3. 「コミット」ダイアログ・ボックスで、「索引と作業ツリー間の変更」(image::images/changes-head-wt.png[])トグル・ボタンを選択します。
これにより、ステージングされていないファイルの一覧が表示されます。
4. 下の<<committing,リポジトリへソースのコミット>>の項で説明するように、ファイルをコミットします。
 
|===

*注意:* 次の図に示すように、HEAD内のファイルの<<viewFileStatus,ステータス>>が、斜線の左側に緑で表示されます。

image::images/new.png[]

アクションは、フォルダに対して起動した場合に、NetBeans IDEフラット・フォルダ内容構造を順守しながら、再帰的に動作します。


== ファイルの編集

Gitバージョン管理プロジェクトをIDEで開くと、ソースの変更を開始できます。NetBeans IDEで開く任意のプロジェクトと同様に、(「プロジェクト」(Ctrl-1)、「ファイル」(Ctrl-2)、「お気に入り」(Ctrl-3)ウィンドウなどの) IDEのウィンドウで表示されているファイルのノードをダブルクリックすると、ファイルをソース・エディタで開くことができます。

IDEでソース・ファイルを操作する場合、自由に使用できる様々なUIコンポーネントがあります。これらは、表示およびバージョン管理コマンドの操作で役立ちます。

* <<viewChanges,ソース・エディタでの変更の表示>>
* <<viewFileStatus,ファイルのステータス情報の表示>>
* <<revert,変更を元に戻す>>


=== ソース・エディタでの変更の表示

IDEのソース・エディタでバージョン管理されたファイルを開くと、Gitリポジトリからの基本バージョンに照らしあわせながら、そのファイルに行われた変更がリアル・タイムで表示されます。作業に伴って、IDEはソース・エディタのマージンに色分けを使用し、次の情報を伝えます。

|===
|*青* (     ) |古いリビジョンの後で変更された行を示します。 

|*緑* (     ) |古いリビジョンの後で追加された行を示します。 

|*赤* (     ) |古いリビジョンの後で除去された行を示します。 
|===

ソース・エディタの左側のマージンには、行ごとに発生した変更が表示されています。行を変更すると、その変更がすぐに左側のマージンに表示されます。

image::images/left-margin.png[]

*注意:* マージンの色グループをクリックして、バージョン管理コマンドをコールできます。たとえば、下の図は、赤いアイコンをクリックすると使用可能なウィジェットを示しており、ローカル・コピーから行が除去されたことを示します。

image::images/left-widgets.png[]

ソース・エディタの右側のマージンには、上から下に向かって、ファイル全体に行われた変更の概要が表示されます。ファイルに変更を行うと、すぐに色分けが生成されます。

image::images/right-margin.png[]

*注意*: マージンの特定の場所をクリックすると、インライン・カーソルがファイルのその場所にすぐに移動します。影響を受ける行数を表示するには、右側のマージンの色つきアイコンの上にマウスを動かします。

image::images/right-lines-number.png[]


=== ファイルのステータス情報の表示

「プロジェクト」(Ctrl-1)、「ファイル」(Ctrl-2)、「お気に入り」(Ctrl-3)または「バージョン管理」ビューで作業する場合、IDEには、ファイルのステータス情報を表示するのに役立つ視覚機能がいくつかあります。次の例では、バッジ(例: image::images/blue-badge.png[])、ファイル名の色、および隣接するステータス・ラベルすべての相互の対応方法を確認し、ファイルに対するバージョン管理情報をトラックする単純だが効果的な方法について説明します。

image::images/file-status.png[]

バッジ、色分け、ファイル・ステータス・ラベル、およびおそらく最も重要なGit差分ビューアはすべて、IDEでのバージョン管理情報を効率的に表示し、管理する能力に貢献します。

* <<badges,バッジと色分け>>
* <<fileStatus,ファイル・ステータス・ラベル>>
* <<versioningView,Gitバージョン管理ビュー>>


==== バッジと色分け

バッジはプロジェクト、フォルダおよびパッケージ・ノードに適用され、そのノードに含まれているファイルのステータスを示します。

バッジに使用される色のスキームを次の表に示します。

|===
|UIコンポーネント |説明 

|*青のバッジ*(image::images/blue-badge.png[]) |作業ツリー内の変更、追加、または削除されたファイルの存在を示します。パッケージの場合、このバッジは、パッケージ自体にのみ適用され、そのサブパッケージには適用されません。プロジェクトまたはフォルダの場合、このバッジはその項目または含まれるサブフォルダ内の内容の変更を示します。 

|*赤のバッジ*(image::images/red-badge.png[]) |_競合する_ファイルを含むプロジェクト、フォルダまたはパッケージをマークします。パッケージの場合、このバッジは、パッケージ自体にのみ適用され、そのサブパッケージには適用されません。プロジェクトまたはフォルダの場合、このバッジはその項目または含まれるサブフォルダ内の競合を示しています。 
|===

色分けは、リポジトリに照らして、現在のステータスを示す目的でファイル名に適用されます。

|===
|色 |例 |説明 

|*特定の色なし(黒)* |image::images/black-text.png[] |ファイルに変更がないことを示します。 

|*青* |image::images/blue-text.png[] |ファイルがローカルに変更されたことを示します。 

|*緑* |image::images/green-text.png[] |ファイルがローカルに追加されたことを示します。 

|*赤* |image::images/red-text.png[] |ファイルにマージの競合があることを示します。 

|*グレー* |image::images/gray-text.png[] |ファイルがGitによって無視され、バージョン管理コマンド(更新やコミットなど)に含まれないことを示します。ファイルはバージョン管理されている場合、無視できません。 
|===


==== ファイル・ステータス・ラベル

IDEはファイルの2つのステータス値を表示します。

* ファイルの作業ツリーと索引状態の相違を示すステータス。
* ファイルの索引状態と現在のHEADコミットの相違を示すステータス。

ファイル・ステータス・ラベルは、バージョン管理ファイルのステータスを、IDEのウィンドウにテキストで示します。

|===
|ステータス・ラベル |意味 

|*-* |変更なし 

|*A* |追加済 

|*U* |更新済であるが未マージ 

|*M* |変更 

|*D* |削除済 

|*I* |無視 

|*R* |名前変更済 
|===

デフォルトで、IDEは、ファイルをウィンドウに一覧表示するときに、そのファイルの右側にステータス情報(新規、変更済、無視など)およびフォルダ情報をグレー・テキストで表示します。

image::images/file-labels.png[]

マージの競合があるファイルは未マージステータスを示し、一般にユーザーの明示的なアクションによって解決されるまで、赤い色で注釈が付けられます。マージされていないファイルのステータス・ラベルは、シナリオによって異なります(たとえば、 ``A/A``  - 未マージ、両方追加済)。

ファイル・ステータス・ラベルは、メイン・メニューから「 ``表示`` 」>「 ``バージョン・ラベルを表示`` 」を選択して、オンとオフを切り替えできます。


==== Gitバージョン管理ビュー

Gitバージョン管理ビューは、ローカルの作業ツリーの選択されたフォルダ内でファイルに行われた変更のすべてを、リアル・タイムで一覧表示します。これはIDEの下のパネルにデフォルトで開き、追加、削除または変更されたファイルを一覧表示します。

バージョン管理ビューを開くには、(「プロジェクト」ウィンドウ、「ファイル」ウィンドウまたは「お気に入り」ウィンドウなどから)バージョン管理ファイルまたはフォルダを選択し、右クリック・メニューから「 ``Git`` 」>「 ``変更を表示`` 」を選択するか、またはメイン・メニューから「 ``チーム`` 」>「 ``変更を表示`` 」を選択します。IDEの最下部に次のウィンドウが表示されます。

[.feature]
--
image::images/versioning-view-small.png[role=""left"", link=""images/versioning-view.png""]
--

デフォルトでは、バージョン管理ビューは、作業ツリー内の選択されたパッケージまたはフォルダ内の変更されたすべてのファイルを一覧表示します。ツールバーのボタンを使用して、索引とHEAD、作業ツリーと索引、または作業ツリーとHEAD間で相違があるファイルの一覧を表示するように選択できます。一覧表示されたファイルの上にある列の見出しをクリックして、名前、ステータス、または場所でファイルをソートすることもできます。

「バージョン管理」ビューのツールバーには、一覧に表示されているすべてのファイルに対して一般的なGitタスクを呼び出すことができるボタンも用意されています。次の表は、「バージョン管理」ビューのツールバーにあるGitコマンドをまとめています。

|===
|アイコン |名前 |機能 

|image::images/changes-head-wt.png[] |*HEADと作業ツリー間の変更* |すでにステージングされているか、変更または作成のみされていて、まだステージングされていないファイルの一覧を表示します。 

|image::images/changes-head-index.png[] |*HEADと索引間の変更* |ステージングされているファイルの一覧を表示します。 

|image::images/changes-index-wt.png[] |*索引と作業ツリー間の変更* |ステージング済の状態と作業ツリーの状態に相違があるファイルを表示します。 

|image::images/refresh.png[] |*ステータスのリフレッシュ* |選択したファイルとフォルダのステータスをリフレッシュします。「バージョン管理」ビューに表示されたファイルは、外部で行われた可能性のある任意の変更を反映してリフレッシュできます。 

|image::images/open-diff.png[] |*差分を開く* |差分ビューアを開くと、ローカルのコピーとリポジトリで保持されているバージョンを並べた比較が表示されます。 

|image::images/update.png[] |*変更内容を元に戻す* |「<<revertdialog,変更内容を元に戻す>>」ダイアログ・ボックスを表示します。 

|image::images/commit-button.png[] |*変更をコミット* |「<<commitdialog,コミット>>」ダイアログ・ボックスを表示します。 
|===

「バージョン管理」ビューで、変更したファイルに対応する表の行を選択し、右クリック・メニューからコマンドを選択すると、他のGitコマンドにアクセスできます。

[.feature]
--
image::images/versioning-right-click-small.png[role=""left"", link=""images/versioning-right-click.png""]
--


=== ファイル・リビジョンの比較

ファイル・バージョンの比較は、バージョン管理されているプロジェクトでの作業で共通のタスクです。IDEでは、「差分」コマンドを使用して、リビジョンを比較できます。

*注意:* 複数の比較モード(「HEADとの差分」、「トラック済との差分」、「差分の対象」)がIDEで使用可能です。

1. バージョン管理されたファイルまたはフォルダを選択します(「 ``プロジェクト`` 」、「 ``ファイル`` 」、「 ``お気に入り`` 」ウィンドウなどから)。
2. メイン・メニューから「 ``チーム`` 」>「 ``差分`` 」>「 ``HEADとの差分`` 」を選択します。
選択したファイルとリビジョンについてグラフィカルな差分ビューアがIDEのメイン・ウィンドウで開きます。差分ビューアには2つのコピーが並んだパネルに表示されます。右側により現在に近いコピーが表示されるため、作業ツリーに対してリポジトリ・リビジョンを比較すると、右パネルに作業ツリーが表示されます。

[.feature]
--
image::images/diff-viewer-small.png[role=""left"", link=""images/diff-viewer.png""]
--

差分ビューアは、バージョン管理の変更を表示する場所に使用されているのと同じ<<color-coding-table,色分け>>を利用します。前に表示したスクリーン・ショットの緑色のブロックは、より現在に近いリビジョンに追加された内容を示します。赤いブロックは、前のリビジョンの内容が、より最近のリビジョンから除去されたことを示します。青は、強調表示された行で変更が発生したことを示します。

*注意:* 他のリビジョンは、差分ビューア・ツールバーの下の「 ``差分`` 」および「 ``送信先`` 」ドロップダウン・リストから選択できます。

差分ビューアのツールバーには、一覧に表示されているすべてのファイルに対して一般的なGitタスクを呼び出すことができるボタンも用意されています。次の表は、差分ビューアのツールバーにあるGitコマンドをまとめています。

|===
|アイコン |名前 |機能 

|image::images/changes-head-wt.png[] |*HEADと作業ツリー間の変更* |すでにステージングされているか、変更または作成のみされていて、まだステージングされていないファイルの一覧を表示します。 

|image::images/changes-head-index.png[] |*HEADと索引間の変更* |ステージングされているファイルの一覧を表示します。 

|image::images/changes-index-wt.png[] |*索引と作業ツリー間の変更* |ステージング済の状態と作業ツリーの状態に相違があるファイルを表示します。 

|image::images/nextdiff.png[] |*次の差分へ* |ファイル内の次の差分を表示します。 

|image::images/prevdiff.png[] |*前の差分へ* |ファイル内の前の差分を表示します。 

|image::images/refresh.png[] |*ステータスのリフレッシュ* |選択したファイルとフォルダのステータスをリフレッシュします。「バージョン管理」ウィンドウに表示されたファイルは、外部で行われた可能性のある任意の変更を反映してリフレッシュできます。 

|image::images/update.png[] |*変更内容を元に戻す* |「<<revertdialog,変更内容を元に戻す>>」ダイアログ・ボックスを表示します。 

|image::images/commit-button.png[] |*変更をコミット* |「<<commitdialog,コミット>>」ダイアログ・ボックスを表示します。 
|===

作業ツリー内のローカル・コピーで差分の取得を実行する場合、IDEの差分ビューア内から直接変更を行うことができます。これを行うには、カーソルを差分ビューアの右ペインに置き、それに従ってファイルを変更するか、または強調表示された各変更の前後で表示されるインライン・アイコンを使用します。

|===
|アイコン |名前 |機能 

|image::images/insert.png[] |*置換* |強調表示されたテキストを作業ツリー・コピーに挿入します。 

|image::images/arrow.png[] |*すべて移動* |ローカル作業ツリー・コピー全体を元に戻します。 

|image::images/remove.png[] |*除去* |ローカル作業ツリー・コピーから強調表示されたテキストを除去します。 
|===


=== 変更を元に戻す

作業ツリー内の選択したファイルに行ったローカルの変更をスローし、それらのファイルを索引またはHEAD内のファイルで置き換えるには、次を実行します。

1. バージョン管理されたファイルまたはフォルダを選択します(「 ``プロジェクト`` 」、「 ``ファイル`` 」、「 ``お気に入り`` 」ウィンドウなどから)。
2. メイン・メニューから「 ``チーム`` 」>「 ``変更内容を元に戻す`` 」を選択します。
「 ``変更内容を元に戻す`` 」ダイアログ・ボックスが表示されます。

image::images/revert.png[]

[start=3]
1. 追加のオプション(「 ``索引のコミットされていない変更のみをHEADに戻す`` 」など)を指定します。
2. 「元に戻す」をクリックします。

IDEによって、選択したファイルが上の<<three,ステップ3>>で指定したファイルで置き換えられます。


== リポジトリへのソースのコミット

ファイルをGitリポジトリにコミットするには、次を実行します。

1. 「 ``プロジェクト`` 」ウィンドウで、コミットするファイルを右クリックします。
2. コンテキスト・メニューで、「 ``Git`` 」>「 ``コミット`` 」を選択します。

「 ``コミット`` 」ダイアログ・ボックスが表示されます。

[.feature]
--
image::images/commit-small.png[role=""left"", link=""images/commit.png""]
--

「 ``コミット`` 」ダイアログ・ボックスには次のコンポーネントが含まれます。

* コミットされる変更を説明するための「 ``コミット・メッセージ`` 」テキスト領域
* 必要に応じて、変更を行ったユーザーと物理的にファイルをコミットしたユーザーを区別できる「 ``作成者`` 」および「 ``コミッタ`` 」ドロップダウン・リスト。
* 「 ``コミットするファイル`` 」セクションには、次が表示されます。
* 変更されたすべてのファイル
* 作業ツリーで(ローカルで)削除されたすべてのファイル
* すべての新規ファイル(Gitリポジトリにまだ存在しないファイル)
* 名前を変更したすべてのファイル。

実際のコミットが実行されるモードを切り替える2つのトグル・ボタンがここで利用できます。

|===
|UIコンポーネント |名前 |説明 

|image::images/changes-head-index.png[] |*HEADと索引間の変更* |ステージングされているファイルの一覧を表示します。 

|image::images/changes-head-wt.png[] |*HEADと作業ツリー間の変更* |すでにステージングされているか、変更または作成のみされていて、まだステージングされていないファイルの一覧を表示します。 
|===

*注意*: ここで、コミットから個々のファイルを除外するかどうかを指定するには、「 ``コミット`` 」という最初の列のチェックボックスを選択解除するか、「 ``コミット・アクション`` 」列のファイル行を右クリックし、ポップアップ・メニューから「 ``コミットから除外`` 」を選択します。ここで差分ビューアを表示するには、「 ``コミット・アクション`` 」列のファイル行を右クリックし、ポップアップ・メニューから「 ``差分`` 」を選択します。

* コミットされる変更に関する問題をトラックするための「 ``問題を更新`` 」セクション。

*注意*: IDEで問題のトラックを開始するには、JIRAまたはSubversionプラグインをインストールする必要があります。

[start=3]
1. 「 ``コミット・メッセージ`` 」テキスト領域にコミット・メッセージを入力します。または、次のいずれかを実行できます。
* 右上隅にある「 ``最近のメッセージ`` 」(image::images/recent-msgs.png[])アイコンをクリックして、以前使用したメッセージのリストを表示して選択します。
* 右上隅にある「 ``テンプレートをロード`` 」(image::images/msg-template.png[])アイコンをクリックして、メッセージ・テンプレートを選択します。

[start=4]
1. 個々のファイルのアクションを指定して「 ``コミット`` 」をクリックします。
IDEによってコミットが実行され、スナップショットがリポジトリに保存されます。コミット・アクションが実行されると、インタフェースの右下にあるIDEのステータス・バーが表示されます。コミットに成功すると、「 ``プロジェクト`` 」、「 ``ファイル`` 」および「 ``お気に入り`` 」ウィンドウのバージョン管理バッジが消え、コミットされたファイルの色分けが黒に戻ります。


== 分岐の操作

IDEのGitサポートでは、分岐を使用して、コード・ベース全体の様々なバージョンを管理できます。

IDEで分岐を操作する場合、次のアクションがサポートされます。

* <<branchCreate,作成>>
* <<branchCheckOut,チェックアウト>>
* <<branchMerge,マージ>>
* <<branchDelete,削除>>


=== 分岐の作成

メイン・トランクを妨げずに、安定化や実験の目的で、別個のバージョンのファイル・システムを操作する場合に、ローカル分岐を作成するには、次の完了を実行します。

1. 「プロジェクト」または「ファイル」ウィンドウで、分岐を作成するリポジトリからプロジェクトまたはフォルダを選択します。
2. メイン・メニューで「チーム」>「分岐/タグ」>「分岐の作成」を選択します。

*注意:* または、バージョン管理されたプロジェクトまたはフォルダを右クリックし、ポップアップ・メニューから「Git」>「分岐/タグ」>「分岐の作成」を選択します。

「分岐の作成」ダイアログ・ボックスが表示されます。

[.feature]
--
image::images/create-branch-small.png[role=""left"", link=""images/create-branch.png""]
--

[start=3]
1. 「分岐名」フィールドで、作成する分岐の名前を入力します。
2. コミットID、既存の分岐、またはタグ名を「リビジョン」フィールドに入力して、選択した項目の特定のリビジョンを入力するか、「選択」を押して、リポジトリで管理されているリビジョンの一覧を表示します。
3. (オプション)「リビジョンを選択」ダイアログ・ボックスで、「分岐」を展開し、必要な分岐を選択して、隣接する一覧のコミットIDを指定し、「選択」を押します。
4. 分岐させるリビジョンに固有の「コミットID」、「作成者」、「メッセージ」フィールドの情報を確認して、「作成」をクリックします。
分岐がGitリポジトリの ``「分岐」/「ローカル」`` フォルダに追加されます。

[.feature]
--
image::images/branch-added-small.png[role=""left"", link=""images/branch-added.png""]
--


=== チェックアウト

すでに存在する分岐上のファイルを編集する必要がある場合は、分岐をチェックアウトすることによって、ファイルを作業ツリーにコピーできます。

リビジョンをチェックアウトするには、次を実行します。

1. メイン・メニューから「チーム」>「チェックアウト」>「リビジョンのチェックアウト」を選択します。
「選択されたリビジョンをチェックアウト」ダイアログ・ボックスが表示されます。

[.feature]
--
image::images/chkout-rev-small.png[role=""left"", link=""images/chkout-rev.png""]
--

[start=2]
1. コミットID、既存の分岐またはタグ名を「リビジョン」フィールドに入力して、必要なリビジョンを指定するか、「選択」を押して、リポジトリで管理されているリビジョンの一覧を表示します。
2. 前のステップで「選択」を押さなかった場合、スキップします。「リビジョンを選択」ダイアログ・ボックスで、「分岐」を展開し、必要な分岐を選択して、必要に応じて、隣接する一覧のコミットIDを指定し、「選択」を押します。

*注意:* 指定したリビジョンが分岐名でマークされていない有効なコミットを表している場合、HEADがデタッチされ、分岐上にいなくなります。

[start=4]
1. チェックアウトされるリビジョンに固有の「コミットID」、「作成者」、「メッセージ」フィールド情報を確認します。
2. チェックアウトしたリビジョンから新しい分岐を作成するには、「新しい分岐としてチェックアウト」オプションを選択し、「分岐名」フィールドに名前を入力します。
3. 「チェックアウト」を押して、リビジョンをチェックアウトします。
作業ツリーおよび索引内のファイルが、指定したリビジョンのバージョンに一致するように更新されます。

*注意:* すでに存在する分岐(いずれかの分岐の一番上にないコミットなど)にファイルを切り替える場合、「チーム」>「Git」>「分岐」>「分岐に切替え」コマンドを使用し、「選択された分岐に切替え」ダイアログ・ボックスで分岐を指定して、(オプションで)新しい分岐としてチェックアウトし、「切替え」を押します。

IDEは、IDEで現在選択されているファイル、フォルダまたはプロジェクトの状況に応じたチェックアウトをサポートしています。索引から、一部のファイル(分岐ではなく)をチェックアウトするには、次の手順を完了します。

1. メイン・メニューから「チーム」>「チェックアウト」>「ファイルのチェックアウト」を選択します。
「選択されたパスをチェックアウト」ダイアログ・ボックスが表示されます。

[.feature]
--
image::images/chkout-path-small.png[role=""left"", link=""images/chkout-path.png""]
--

[start=2]
1. 「選択されたリビジョンからのエントリで索引を更新」オプションを選択します。
選択した場合、チェックアウト前に選択したリビジョンの状態で索引が更新されます(作業ツリーと索引の両方の選択したファイルが更新されます)。
2. コミットID、既存の分岐またはタグ名を「リビジョン」フィールドに入力して、必要なリビジョンを指定するか、「選択」を押して、リポジトリで管理されているリビジョンの一覧を表示します。
3. 前のステップで「選択」を押さなかった場合、スキップします。「リビジョンを選択」ダイアログ・ボックスで、「分岐」を展開し、必要な分岐を選択して、必要に応じて、隣接する一覧のリビジョン番号を指定し、「選択」を押します。
4. 「チェックアウト」を押して、チェックアウトを完了します。


=== マージ

リポジトリ・リビジョンから変更を作業ツリーに移行するには、次のように実行します。

1. メイン・メニューから「チーム」>「分岐/タグ」>「リビジョンをマージ」を選択します。
「リビジョンをマージ」ダイアログ・ボックスが表示されます。

[.feature]
--
image::images/merge-small.png[role=""left"", link=""images/merge.png""]
--

[start=2]
1. コミットID、既存の分岐またはタグ名を「リビジョン」フィールドに入力して、必要なリビジョンを指定するか、「選択」を押して、リポジトリで管理されているリビジョンの一覧を表示します。
2. 前のステップで「選択」を押さなかった場合、スキップします。「リビジョンを選択」ダイアログ・ボックスで、「分岐」を展開し、必要な分岐を選択して、必要に応じて、隣接する一覧のコミットIDを指定し、「選択」を押します。
3. 「マージ」を押します。
現在の分岐、作業ツリーの内容、指定した分岐間の3方向のマージが実行されます。

*注意:* マージの競合が発生した場合、競合するファイルが<<badges,赤のバッジ>>でマークされ、競合が示されます。

*注意:* マージ後、変更をHEADに追加するために、変更を<<committing,コミット>>する必要があります。


=== 分岐の削除

不要なローカル分岐を削除するには、次の手順を完了します。

1. メイン・メニューから「チーム」>「リポジトリ・ブラウザ」を選択します。
2. Gitリポジトリ・ブラウザで、削除する分岐を選択します。

*注意:* 分岐は非アクティブである、つまり現在作業ツリーにチェックアウトされていない必要があります。

[start=3]
1. 選択した分岐を右クリックし、ポップアップ・メニューから「分岐を削除」を選択します。
2. 「分岐を削除」ダイアログ・ボックスで、「OK」を押して、分岐の削除を確認します。
分岐がローカル・リポジトリとGitリポジトリ・ブラウザから除去されます。


== リモート・リポジトリの操作

他の開発者と協力する場合、作業を共有する必要があり、これには、インターネットまたはネットワーク上でホストされるリモート・リポジトリとのデータのフェッチ、プッシュ、プルが含まれます。

* <<fetch,フェッチ>>
* <<pull,プル>>
* <<push,プッシュ>>


=== フェッチ

フェッチは、元のリモート・リポジトリからまだ持っていない変更を取得します。これは、ローカル分岐を変更しません。フェッチはリモート・リポジトリからすべての分岐を取得し、いつでも分岐にマージしたり、単に検査したりすることができます。

更新をフェッチするには、次のように実行します。

1. 「チーム」>「リモート」>「フェッチ」を選択します。
「リモート・リポジトリからフェッチ」ウィザードが表示されます。

[.feature]
--
image::images/fetch-small.png[role=""left"", link=""images/fetch.png""]
--

[start=2]
1. ウィザードのリモート・リポジトリ・ページで、構成済のリポジトリ(以前に構成されたリポジトリへのパスを使用する)または「Gitリポジトリの場所を指定」オプション(必要に応じて、まだアクセスされていないリモート・リポジトリへのパス、その名前、ログイン、パスワード、およびプロキシ構成を定義する)を選択し、「次」をクリックします。
2. ウィザードのリモート分岐ページで、変更をフェッチする分岐を選択し、「終了」をクリックします。
リモート分岐のローカル・コピーが作成されます。Gitリポジトリ・ブラウザの「 ``分岐`` 」>「 ``リモート`` 」ディレクトリで、選択した分岐が更新されます。
次に、フェッチした更新をローカル分岐にマージできます。


=== プル

リモートGitリポジトリから更新をプルすると、リポジトリから変更がフェッチされ、ローカル・リポジトリの現在のHEADにマージされます。
プルを実行するには、次の手順を完了します。

1. 「チーム」>「リモート」>「プル」を選択します。
リモート・リポジトリからプル・ウィザードが表示されます。

[.feature]
--
image::images/pull-small.png[role=""left"", link=""images/pull.png""]
--

[start=2]
1. ウィザードのリモート・リポジトリ・ページで、構成済のリポジトリ(以前に構成されたリポジトリへのパスを使用する)または「Gitリポジトリの場所を指定」オプション(必要に応じて、まだアクセスされていないリモート・リポジトリへのパス、その名前、ログインとパスワードを定義する)を選択し、「次」をクリックします。
2. ウィザードのリモート分岐ページで、変更がプルされる分岐を選択し、「終了」をクリックします。
ローカル・リポジトリが元のリポジトリと同期されます。


=== プッシュ

ローカルGitリポジトリの変更を公開Gitリポジトリに貢献するには、次の手順を実行します。

1. 「チーム」>「リモート」>「プッシュ」を選択します。
リモート・リポジトリへプッシュ・ウィザードが表示されます。

[.feature]
--
image::images/push-small.png[role=""left"", link=""images/push.png""]
--

[start=2]
1. ウィザードのリモート・リポジトリ・ページで、構成済のリポジトリ(以前に構成されたリポジトリへのパスを使用する)または「Gitリポジトリの場所を指定」オプション(必要に応じて、まだアクセスされていないリモート・リポジトリへのパス、その名前、ログインとパスワードを定義する)を選択し、「次」をクリックします。
2. ローカル分岐を選択ページで、編集をプッシュする分岐を選択し、「次」をクリックします。
3. ローカル参照を更新ページで、ローカル・リポジトリの「リモート」ディレクトリ内の更新する分岐を選択し、「終了」をクリックします。
指定したリモート・リポジトリの分岐がローカル分岐の最新の状態で更新されます。


== サマリー

このチュートリアルでは、IDEのGitサポートを使用する場合の標準的なワークフローを説明することによって、IDEの基本的なバージョン管理タスクの実行方法を示しました。IDEに含まれるGit固有の機能の一部を紹介しながら、バージョン管理されたプロジェクトの設定とバージョン管理されたファイルの基本タスクの実行方法を示しました。

link:/about/contact_form.html?to=3&subject=Feedback:%20Using%20Git%20Support%20in%20NetBeans%20IDE[+このチュートリアルに関するご意見をお寄せください+]



== 関連項目

関連する資料については、次のドキュメントを参照してください。

* link:clearcase.html[+NetBeans IDEでのClearCaseサポートの使用+]
* link:subversion.html[+NetBeans IDEでのSubversionサポートの使用+]
* link:mercurial.html[+NetBeans IDEでのMercurialサポートの使用+]
* link:cvs.html[+NetBeans IDEでのCVSサポートの使用+]
* link:http://www.oracle.com/pls/topic/lookup?ctx=nb8000&id=NBDAG234[+NetBeans IDEによるアプリケーションの開発+]の_バージョン管理によるアプリケーションのバージョニング_
",12319,True,2559.305384822296,median
"/*******************************************************************************
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Camilo Sanchez (Camiloasc1)
 *
 * 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.
 ******************************************************************************/
grammar CPP14;
/*Basic concepts*/


translationunit
   : declarationseq? EOF
   ;
/*Expressions*/


primaryexpression
   : literal
   | This
   | '(' expression ')'
   | idexpression
   | lambdaexpression
   ;

idexpression
   : unqualifiedid
   | qualifiedid
   ;

unqualifiedid
   : Identifier
   | operatorfunctionid
   | conversionfunctionid
   | literaloperatorid
   | '~' classname
   | '~' decltypespecifier
   | templateid
   ;

qualifiedid
   : nestednamespecifier Template? unqualifiedid
   ;

nestednamespecifier
   : '::'
   | thetypename '::'
   | namespacename '::'
   | decltypespecifier '::'
   | nestednamespecifier Identifier '::'
   | nestednamespecifier Template? simpletemplateid '::'
   ;

lambdaexpression
   : lambdaintroducer lambdadeclarator? compoundstatement
   ;

lambdaintroducer
   : '[' lambdacapture? ']'
   ;

lambdacapture
   : capturedefault
   | capturelist
   | capturedefault ',' capturelist
   ;

capturedefault
   : '&'
   | '='
   ;

capturelist
   : capture '...'?
   | capturelist ',' capture '...'?
   ;

capture
   : simplecapture
   | initcapture
   ;

simplecapture
   : Identifier
   | '&' Identifier
   | This
   ;

initcapture
   : Identifier initializer
   | '&' Identifier initializer
   ;

lambdadeclarator
   : '(' parameterdeclarationclause ')' Mutable? exceptionspecification? attributespecifierseq? trailingreturntype?
   ;

postfixexpression
   : primaryexpression
   | postfixexpression '[' expression ']'
   | postfixexpression '[' bracedinitlist ']'
   | postfixexpression '(' expressionlist? ')'
   | simpletypespecifier '(' expressionlist? ')'
   | typenamespecifier '(' expressionlist? ')'
   | simpletypespecifier bracedinitlist
   | typenamespecifier bracedinitlist
   | postfixexpression '.' Template? idexpression
   | postfixexpression '->' Template? idexpression
   | postfixexpression '.' pseudodestructorname
   | postfixexpression '->' pseudodestructorname
   | postfixexpression '++'
   | postfixexpression '--'
   | Dynamic_cast '<' thetypeid '>' '(' expression ')'
   | Static_cast '<' thetypeid '>' '(' expression ')'
   | Reinterpret_cast '<' thetypeid '>' '(' expression ')'
   | Const_cast '<' thetypeid '>' '(' expression ')'
   | typeidofthetypeid '(' expression ')'
   | typeidofthetypeid '(' thetypeid ')'
   ;
/*
add a middle layer to eliminate duplicated function declarations
*/


typeidofexpr
   : Typeid_
   ;

typeidofthetypeid
   : Typeid_
   ;

expressionlist
   : initializerlist
   ;

pseudodestructorname
   : nestednamespecifier? thetypename '::' '~' thetypename
   | nestednamespecifier Template simpletemplateid '::' '~' thetypename
   | nestednamespecifier? '~' thetypename
   | '~' decltypespecifier
   ;

unaryexpression
   : postfixexpression
   | '++' castexpression
   | '--' castexpression
   | unaryoperator castexpression
   | Sizeof unaryexpression
   | Sizeof '(' thetypeid ')'
   | Sizeof '...' '(' Identifier ')'
   | Alignof '(' thetypeid ')'
   | noexceptexpression
   | newexpression
   | deleteexpression
   ;

unaryoperator
   : '|'
   | '*'
   | '&'
   | '+'
   | '!'
   | '~'
   | '-'
   | 'not'
   ;

newexpression
   : '::'? New newplacement? newtypeid newinitializer?
   | '::'? New newplacement? '(' thetypeid ')' newinitializer?
   ;

newplacement
   : '(' expressionlist ')'
   ;

newtypeid
   : typespecifierseq newdeclarator?
   ;

newdeclarator
   : ptroperator newdeclarator?
   | noptrnewdeclarator
   ;

noptrnewdeclarator
   : '[' expression ']' attributespecifierseq?
   | noptrnewdeclarator '[' constantexpression ']' attributespecifierseq?
   ;

newinitializer
   : '(' expressionlist? ')'
   | bracedinitlist
   ;

deleteexpression
   : '::'? Delete castexpression
   | '::'? Delete '[' ']' castexpression
   ;

noexceptexpression
   : Noexcept '(' expression ')'
   ;

castexpression
   : unaryexpression
   | '(' thetypeid ')' castexpression
   ;

pmexpression
   : castexpression
   | pmexpression '.*' castexpression
   | pmexpression '->*' castexpression
   ;

multiplicativeexpression
   : pmexpression
   | multiplicativeexpression '*' pmexpression
   | multiplicativeexpression '/' pmexpression
   | multiplicativeexpression '%' pmexpression
   ;

additiveexpression
   : multiplicativeexpression
   | additiveexpression '+' multiplicativeexpression
   | additiveexpression '-' multiplicativeexpression
   ;

shiftexpression
   : additiveexpression
   | shiftexpression shiftoperator additiveexpression
   ;

shiftoperator
  : RightShift
  | LeftShift
  ;

relationalexpression
   : shiftexpression
   | relationalexpression '<' shiftexpression
   | relationalexpression '>' shiftexpression
   | relationalexpression '<=' shiftexpression
   | relationalexpression '>=' shiftexpression
   ;

equalityexpression
   : relationalexpression
   | equalityexpression '==' relationalexpression
   | equalityexpression '!=' relationalexpression
   ;

andexpression
   : equalityexpression
   | andexpression '&' equalityexpression
   ;

exclusiveorexpression
   : andexpression
   | exclusiveorexpression '^' andexpression
   ;

inclusiveorexpression
   : exclusiveorexpression
   | inclusiveorexpression '|' exclusiveorexpression
   ;

logicalandexpression
   : inclusiveorexpression
   | logicalandexpression '&&' inclusiveorexpression
   | logicalandexpression 'and' inclusiveorexpression
   ;

logicalorexpression
   : logicalandexpression
   | logicalorexpression '||' logicalandexpression
   | logicalorexpression 'or' logicalandexpression
   ;

conditionalexpression
   : logicalorexpression
   | logicalorexpression '?' expression ':' assignmentexpression
   ;

assignmentexpression
   : conditionalexpression
   | logicalorexpression assignmentoperator initializerclause
   | throwexpression
   ;

assignmentoperator
   : '='
   | '*='
   | '/='
   | '%='
   | '+='
   | '-='
   | RightShiftAssign
   | LeftShiftAssign
   | '&='
   | '^='
   | '|='
   ;

expression
   : assignmentexpression
   | expression ',' assignmentexpression
   ;

constantexpression
   : conditionalexpression
   ;
/*Statements*/


statement
   : labeledstatement
   | attributespecifierseq? expressionstatement
   | attributespecifierseq? compoundstatement
   | attributespecifierseq? selectionstatement
   | attributespecifierseq? iterationstatement
   | attributespecifierseq? jumpstatement
   | declarationstatement
   | attributespecifierseq? tryblock
   ;

labeledstatement
   : attributespecifierseq? Identifier ':' statement
   | attributespecifierseq? Case constantexpression ':' statement
   | attributespecifierseq? Default ':' statement
   ;

expressionstatement
   : expression? ';'
   ;

compoundstatement
   : '{' statementseq? '}'
   ;

statementseq
   : statement
   | statementseq statement
   ;

selectionstatement
   : If '(' condition ')' statement
   | If '(' condition ')' statement Else statement
   | Switch '(' condition ')' statement
   ;

condition
   : expression
   | attributespecifierseq? declspecifierseq declarator '=' initializerclause
   | attributespecifierseq? declspecifierseq declarator bracedinitlist
   ;

iterationstatement
   : While '(' condition ')' statement
   | Do statement While '(' expression ')' ';'
   | For '(' forinitstatement condition? ';' expression? ')' statement
   | For '(' forrangedeclaration ':' forrangeinitializer ')' statement
   ;

forinitstatement
   : expressionstatement
   | simpledeclaration
   ;

forrangedeclaration
   : attributespecifierseq? declspecifierseq declarator
   ;

forrangeinitializer
   : expression
   | bracedinitlist
   ;

jumpstatement
   : Break ';'
   | Continue ';'
   | Return expression? ';'
   | Return bracedinitlist ';'
   | Goto Identifier ';'
   ;

declarationstatement
   : blockdeclaration
   ;
/*Declarations*/


declarationseq
   : declaration
   | declarationseq declaration
   ;

declaration
   : blockdeclaration
   | functiondefinition
   | templatedeclaration
   | explicitinstantiation
   | explicitspecialization
   | linkagespecification
   | namespacedefinition
   | emptydeclaration
   | attributedeclaration
   ;

blockdeclaration
   : simpledeclaration
   | asmdefinition
   | namespacealiasdefinition
   | usingdeclaration
   | usingdirective
   | static_assertdeclaration
   | aliasdeclaration
   | opaqueenumdeclaration
   ;

aliasdeclaration
   : Using Identifier attributespecifierseq? '=' thetypeid ';'
   ;

simpledeclaration
   : declspecifierseq? initdeclaratorlist? ';'
   | attributespecifierseq declspecifierseq? initdeclaratorlist ';'
   ;

static_assertdeclaration
   : Static_assert '(' constantexpression ',' Stringliteral ')' ';'
   ;

emptydeclaration
   : ';'
   ;

attributedeclaration
   : attributespecifierseq ';'
   ;

declspecifier
   : storageclassspecifier
   | typespecifier
   | functionspecifier
   | Friend
   | Typedef
   | Constexpr
   ;

declspecifierseq
   : declspecifier attributespecifierseq?
   | declspecifier declspecifierseq
   ;

storageclassspecifier
   : Register
   | Static
   | Thread_local
   | Extern
   | Mutable
   ;

functionspecifier
   : Inline
   | Virtual
   | Explicit
   ;

typedefname
   : Identifier
   ;

typespecifier
   : trailingtypespecifier
   | classspecifier
   | enumspecifier
   ;

trailingtypespecifier
   : simpletypespecifier
   | elaboratedtypespecifier
   | typenamespecifier
   | cvqualifier
   ;

typespecifierseq
   : typespecifier attributespecifierseq?
   | typespecifier typespecifierseq
   ;

trailingtypespecifierseq
   : trailingtypespecifier attributespecifierseq?
   | trailingtypespecifier trailingtypespecifierseq
   ;

simpletypespecifier
   : nestednamespecifier? thetypename
   | nestednamespecifier Template simpletemplateid
   | Char
   | Char16
   | Char32
   | Wchar
   | Bool
   | Short
   | Int
   | Long
   | Signed
   | Unsigned
   | Float
   | Double
   | Void
   | Auto
   | decltypespecifier
   ;

thetypename
   : classname
   | enumname
   | typedefname
   | simpletemplateid
   ;

decltypespecifier
   : Decltype '(' expression ')'
   | Decltype '(' Auto ')'
   ;

elaboratedtypespecifier
   : classkey attributespecifierseq? nestednamespecifier? Identifier
   | classkey simpletemplateid
   | classkey nestednamespecifier Template? simpletemplateid
   | Enum nestednamespecifier? Identifier
   ;

enumname
   : Identifier
   ;

enumspecifier
   : enumhead '{' enumeratorlist? '}'
   | enumhead '{' enumeratorlist ',' '}'
   ;

enumhead
   : enumkey attributespecifierseq? Identifier? enumbase?
   | enumkey attributespecifierseq? nestednamespecifier Identifier enumbase?
   ;

opaqueenumdeclaration
   : enumkey attributespecifierseq? Identifier enumbase? ';'
   ;

enumkey
   : Enum
   | Enum Class
   | Enum Struct
   ;

enumbase
   : ':' typespecifierseq
   ;

enumeratorlist
   : enumeratordefinition
   | enumeratorlist ',' enumeratordefinition
   ;

enumeratordefinition
   : enumerator
   | enumerator '=' constantexpression
   ;

enumerator
   : Identifier
   ;

namespacename
   : originalnamespacename
   | namespacealias
   ;

originalnamespacename
   : Identifier
   ;

namespacedefinition
   : namednamespacedefinition
   | unnamednamespacedefinition
   ;

namednamespacedefinition
   : originalnamespacedefinition
   | extensionnamespacedefinition
   ;

originalnamespacedefinition
   : Inline? Namespace Identifier '{' namespacebody '}'
   ;

extensionnamespacedefinition
   : Inline? Namespace originalnamespacename '{' namespacebody '}'
   ;

unnamednamespacedefinition
   : Inline? Namespace '{' namespacebody '}'
   ;

namespacebody
   : declarationseq?
   ;

namespacealias
   : Identifier
   ;

namespacealiasdefinition
   : Namespace Identifier '=' qualifiednamespacespecifier ';'
   ;

qualifiednamespacespecifier
   : nestednamespecifier? namespacename
   ;

usingdeclaration
   : Using Typename_? nestednamespecifier unqualifiedid ';'
   | Using '::' unqualifiedid ';'
   ;

usingdirective
   : attributespecifierseq? Using Namespace nestednamespecifier? namespacename ';'
   ;

asmdefinition
   : Asm '(' Stringliteral ')' ';'
   ;

linkagespecification
   : Extern Stringliteral '{' declarationseq? '}'
   | Extern Stringliteral declaration
   ;

attributespecifierseq
   : attributespecifier
   | attributespecifierseq attributespecifier
   ;

attributespecifier
   : '[' '[' attributelist ']' ']'
   | alignmentspecifier
   ;

alignmentspecifier
   : Alignas '(' thetypeid '...'? ')'
   | Alignas '(' constantexpression '...'? ')'
   ;

attributelist
   : attribute?
   | attributelist ',' attribute?
   | attribute '...'
   | attributelist ',' attribute '...'
   ;

attribute
   : attributetoken attributeargumentclause?
   ;

attributetoken
   : Identifier
   | attributescopedtoken
   ;

attributescopedtoken
   : attributenamespace '::' Identifier
   ;

attributenamespace
   : Identifier
   ;

attributeargumentclause
   : '(' balancedtokenseq ')'
   ;

balancedtokenseq
   : balancedtoken?
   | balancedtokenseq balancedtoken
   ;

balancedtoken
   : '(' balancedtokenseq ')'
   | '[' balancedtokenseq ']'
   | '{' balancedtokenseq '}'
   | ~('('|')'|'{'|'}'|'['|']')+
   ;
/*Declarators*/


initdeclaratorlist
   : initdeclarator
   | initdeclaratorlist ',' initdeclarator
   ;

initdeclarator
   : declarator initializer?
   ;

declarator
   : ptrdeclarator
   | noptrdeclarator parametersandqualifiers trailingreturntype
   ;

ptrdeclarator
   : noptrdeclarator
   | ptroperator ptrdeclarator
   ;

noptrdeclarator
   : declaratorid attributespecifierseq?
   | noptrdeclarator parametersandqualifiers
   | noptrdeclarator '[' constantexpression? ']' attributespecifierseq?
   | '(' ptrdeclarator ')'
   ;

parametersandqualifiers
   : '(' parameterdeclarationclause ')' cvqualifierseq? refqualifier? exceptionspecification? attributespecifierseq?
   ;

trailingreturntype
   : '->' trailingtypespecifierseq abstractdeclarator?
   ;

ptroperator
   : '*' attributespecifierseq? cvqualifierseq?
   | '&' attributespecifierseq?
   | '&&' attributespecifierseq?
   | nestednamespecifier '*' attributespecifierseq? cvqualifierseq?
   ;

cvqualifierseq
   : cvqualifier cvqualifierseq?
   ;

cvqualifier
   : Const
   | Volatile
   ;

refqualifier
   : '&'
   | '&&'
   ;

declaratorid
   : '...'? idexpression
   ;

thetypeid
   : typespecifierseq abstractdeclarator?
   ;

abstractdeclarator
   : ptrabstractdeclarator
   | noptrabstractdeclarator? parametersandqualifiers trailingreturntype
   | abstractpackdeclarator
   ;

ptrabstractdeclarator
   : noptrabstractdeclarator
   | ptroperator ptrabstractdeclarator?
   ;

noptrabstractdeclarator
   : noptrabstractdeclarator parametersandqualifiers
   | parametersandqualifiers
   | noptrabstractdeclarator '[' constantexpression? ']' attributespecifierseq?
   | '[' constantexpression? ']' attributespecifierseq?
   | '(' ptrabstractdeclarator ')'
   ;

abstractpackdeclarator
   : noptrabstractpackdeclarator
   | ptroperator abstractpackdeclarator
   ;

noptrabstractpackdeclarator
   : noptrabstractpackdeclarator parametersandqualifiers
   | noptrabstractpackdeclarator '[' constantexpression? ']' attributespecifierseq?
   | '...'
   ;

parameterdeclarationclause
   : parameterdeclarationlist? '...'?
   | parameterdeclarationlist ',' '...'
   ;

parameterdeclarationlist
   : parameterdeclaration
   | parameterdeclarationlist ',' parameterdeclaration
   ;

parameterdeclaration
   : attributespecifierseq? declspecifierseq declarator
   | attributespecifierseq? declspecifierseq declarator '=' initializerclause
   | attributespecifierseq? declspecifierseq abstractdeclarator?
   | attributespecifierseq? declspecifierseq abstractdeclarator? '=' initializerclause
   ;

functiondefinition
   : attributespecifierseq? declspecifierseq? declarator virtspecifierseq? functionbody
   ;

functionbody
   : ctorinitializer? compoundstatement
   | functiontryblock
   | '=' Default ';'
   | '=' Delete ';'
   ;

initializer
   : braceorequalinitializer
   | '(' expressionlist ')'
   ;

braceorequalinitializer
   : '=' initializerclause
   | bracedinitlist
   ;

initializerclause
   : assignmentexpression
   | bracedinitlist
   ;

initializerlist
   : initializerclause '...'?
   | initializerlist ',' initializerclause '...'?
   ;

bracedinitlist
   : '{' initializerlist ','? '}'
   | '{' '}'
   ;
/*Classes*/


classname
   : Identifier
   | simpletemplateid
   ;

classspecifier
   : classhead '{' memberspecification? '}'
   ;

classhead
   : classkey attributespecifierseq? classheadname classvirtspecifier? baseclause?
   | classkey attributespecifierseq? baseclause?
   ;

classheadname
   : nestednamespecifier? classname
   ;

classvirtspecifier
   : Final
   ;

classkey
   : Class
   | Struct
   | Union
   ;

memberspecification
   : memberdeclaration memberspecification?
   | accessspecifier ':' memberspecification?
   ;

memberdeclaration
   : attributespecifierseq? declspecifierseq? memberdeclaratorlist? ';'
   | functiondefinition
   | usingdeclaration
   | static_assertdeclaration
   | templatedeclaration
   | aliasdeclaration
   | emptydeclaration
   ;

memberdeclaratorlist
   : memberdeclarator
   | memberdeclaratorlist ',' memberdeclarator
   ;

memberdeclarator
   : declarator virtspecifierseq? purespecifier?
   | declarator braceorequalinitializer?
   | Identifier? attributespecifierseq? ':' constantexpression
   ;

virtspecifierseq
   : virtspecifier
   | virtspecifierseq virtspecifier
   ;

virtspecifier
   : Override
   | Final
   ;
/*
purespecifier:
   '=' '0'//Conflicts with the lexer
 ;
 */


purespecifier
   : Assign val = Octalliteral
   {if($val.text.compareTo(""0"")!=0) throw new InputMismatchException(this);}
   ;
/*Derived classes*/


baseclause
   : ':' basespecifierlist
   ;

basespecifierlist
   : basespecifier '...'?
   | basespecifierlist ',' basespecifier '...'?
   ;

basespecifier
   : attributespecifierseq? basetypespecifier
   | attributespecifierseq? Virtual accessspecifier? basetypespecifier
   | attributespecifierseq? accessspecifier Virtual? basetypespecifier
   ;

classordecltype
   : nestednamespecifier? classname
   | decltypespecifier
   ;

basetypespecifier
   : classordecltype
   ;

accessspecifier
   : Private
   | Protected
   | Public
   ;
/*Special member functions*/


conversionfunctionid
   : Operator conversiontypeid
   ;

conversiontypeid
   : typespecifierseq conversiondeclarator?
   ;

conversiondeclarator
   : ptroperator conversiondeclarator?
   ;

ctorinitializer
   : ':' meminitializerlist
   ;

meminitializerlist
   : meminitializer '...'?
   | meminitializer '...'? ',' meminitializerlist
   ;

meminitializer
   : meminitializerid '(' expressionlist? ')'
   | meminitializerid bracedinitlist
   ;

meminitializerid
   : classordecltype
   | Identifier
   ;
/*Overloading*/


operatorfunctionid
   : Operator theoperator
   ;

literaloperatorid
   : Operator Stringliteral Identifier
   | Operator Userdefinedstringliteral
   ;
/*Templates*/


templatedeclaration
   : Template '<' templateparameterlist '>' declaration
   ;

templateparameterlist
   : templateparameter
   | templateparameterlist ',' templateparameter
   ;

templateparameter
   : typeparameter
   | parameterdeclaration
   ;

typeparameter
   : Class '...'? Identifier?
   | Class Identifier? '=' thetypeid
   | Typename_ '...'? Identifier?
   | Typename_ Identifier? '=' thetypeid
   | Template '<' templateparameterlist '>' Class '...'? Identifier?
   | Template '<' templateparameterlist '>' Class Identifier? '=' idexpression
   ;

simpletemplateid
   : templatename '<' templateargumentlist? '>'
   ;

templateid
   : simpletemplateid
   | operatorfunctionid '<' templateargumentlist? '>'
   | literaloperatorid '<' templateargumentlist? '>'
   ;

templatename
   : Identifier
   ;

templateargumentlist
   : templateargument '...'?
   | templateargumentlist ',' templateargument '...'?
   ;

templateargument
   : thetypeid
   | constantexpression
   | idexpression
   ;

typenamespecifier
   : Typename_ nestednamespecifier Identifier
   | Typename_ nestednamespecifier Template? simpletemplateid
   ;

explicitinstantiation
   : Extern? Template declaration
   ;

explicitspecialization
   : Template '<' '>' declaration
   ;
/*Exception handling*/


tryblock
   : Try compoundstatement handlerseq
   ;

functiontryblock
   : Try ctorinitializer? compoundstatement handlerseq
   ;

handlerseq
   : handler handlerseq?
   ;

handler
   : Catch '(' exceptiondeclaration ')' compoundstatement
   ;

exceptiondeclaration
   : attributespecifierseq? typespecifierseq declarator
   | attributespecifierseq? typespecifierseq abstractdeclarator?
   | '...'
   ;

throwexpression
   : Throw assignmentexpression?
   ;

exceptionspecification
   : dynamicexceptionspecification
   | noexceptspecification
   ;

dynamicexceptionspecification
   : Throw '(' typeidlist? ')'
   ;

typeidlist
   : thetypeid '...'?
   | typeidlist ',' thetypeid '...'?
   ;

noexceptspecification
   : Noexcept '(' constantexpression ')'
   | Noexcept
   ;
/*Preprocessing directives*/


MultiLineMacro
   : '#' (~ [\\n]*? '\\\\' '\\r'? '\\n')+ ~ [\\n]+ -> channel (HIDDEN)
   ;

Directive
   : '#' ~ [\\n]* -> channel (HIDDEN)
   ;
/*Lexer*/

/*Keywords*/


Alignas
   : 'alignas'
   ;

Alignof
   : 'alignof'
   ;

Asm
   : 'asm'
   ;

Auto
   : 'auto'
   ;

Bool
   : 'bool'
   ;

Break
   : 'break'
   ;

Case
   : 'case'
   ;

Catch
   : 'catch'
   ;

Char
   : 'char'
   ;

Char16
   : 'char16_t'
   ;

Char32
   : 'char32_t'
   ;

Class
   : 'class'
   ;

Const
   : 'const'
   ;

Constexpr
   : 'constexpr'
   ;

Const_cast
   : 'const_cast'
   ;

Continue
   : 'continue'
   ;

Decltype
   : 'decltype'
   ;

Default
   : 'default'
   ;

Delete
   : 'delete'
   ;

Do
   : 'do'
   ;

Double
   : 'double'
   ;

Dynamic_cast
   : 'dynamic_cast'
   ;

Else
   : 'else'
   ;

Enum
   : 'enum'
   ;

Explicit
   : 'explicit'
   ;

Export
   : 'export'
   ;

Extern
   : 'extern'
   ;

Faalse
   : 'false'
   ;

Final
   : 'final'
   ;

Float
   : 'float'
   ;

For
   : 'for'
   ;

Friend
   : 'friend'
   ;

Goto
   : 'goto'
   ;

If
   : 'if'
   ;

Inline
   : 'inline'
   ;

Int
   : 'int'
   ;

Long
   : 'long'
   ;

Mutable
   : 'mutable'
   ;

Namespace
   : 'namespace'
   ;

New
   : 'new'
   ;

Noexcept
   : 'noexcept'
   ;

Nullptr
   : 'nullptr'
   ;

Operator
   : 'operator'
   ;

Override
   : 'override'
   ;

Private
   : 'private'
   ;

Protected
   : 'protected'
   ;

Public
   : 'public'
   ;

Register
   : 'register'
   ;

Reinterpret_cast
   : 'reinterpret_cast'
   ;

Return
   : 'return'
   ;

Short
   : 'short'
   ;

Signed
   : 'signed'
   ;

Sizeof
   : 'sizeof'
   ;

Static
   : 'static'
   ;

Static_assert
   : 'static_assert'
   ;

Static_cast
   : 'static_cast'
   ;

Struct
   : 'struct'
   ;

Switch
   : 'switch'
   ;

Template
   : 'template'
   ;

This
   : 'this'
   ;

Thread_local
   : 'thread_local'
   ;

Throw
   : 'throw'
   ;

Trrue
   : 'true'
   ;

Try
   : 'try'
   ;

Typedef
   : 'typedef'
   ;

Typeid_
   : 'typeid'
   ;

Typename_
   : 'typename'
   ;

Union
   : 'union'
   ;

Unsigned
   : 'unsigned'
   ;

Using
   : 'using'
   ;

Virtual
   : 'virtual'
   ;

Void
   : 'void'
   ;

Volatile
   : 'volatile'
   ;

Wchar
   : 'wchar_t'
   ;

While
   : 'while'
   ;
/*Operators*/


LeftParen
   : '('
   ;

RightParen
   : ')'
   ;

LeftBracket
   : '['
   ;

RightBracket
   : ']'
   ;

LeftBrace
   : '{'
   ;

RightBrace
   : '}'
   ;

Plus
   : '+'
   ;

Minus
   : '-'
   ;

Star
   : '*'
   ;

Div
   : '/'
   ;

Mod
   : '%'
   ;

Caret
   : '^'
   ;

And
   : '&'
   ;

Or
   : '|'
   ;

Tilde
   : '~'
   ;

Not
   : '!'
   | 'not'
   ;

Assign
   : '='
   ;

Less
   : '<'
   ;

Greater
   : '>'
   ;

PlusAssign
   : '+='
   ;

MinusAssign
   : '-='
   ;

StarAssign
   : '*='
   ;

DivAssign
   : '/='
   ;

ModAssign
   : '%='
   ;

XorAssign
   : '^='
   ;

AndAssign
   : '&='
   ;

OrAssign
   : '|='
   ;

LeftShift
   : '<<'
   ;

RightShift
   :
   '>>'
   ;

LeftShiftAssign
   : '<<='
   ;

RightShiftAssign
   :
   '>>='
   ;

Equal
   : '=='
   ;

NotEqual
   : '!='
   ;

LessEqual
   : '<='
   ;

GreaterEqual
   : '>='
   ;

AndAnd
   : '&&'
   | 'and'
   ;

OrOr
   : '||'
   | 'or'
   ;

PlusPlus
   : '++'
   ;

MinusMinus
   : '--'
   ;

Comma
   : ','
   ;

ArrowStar
   : '->*'
   ;

Arrow
   : '->'
   ;

Question
   : '?'
   ;

Colon
   : ':'
   ;

Doublecolon
   : '::'
   ;

Semi
   : ';'
   ;

Dot
   : '.'
   ;

DotStar
   : '.*'
   ;

Ellipsis
   : '...'
   ;

theoperator
   : New
   | Delete
   | New '[' ']'
   | Delete '[' ']'
   | '+'
   | '-'
   | '*'
   | '/'
   | '%'
   | '^'
   | '&'
   | '|'
   | '~'
   | '!'
   | 'not'
   | '='
   | '<'
   | '>'
   | '+='
   | '-='
   | '*='
   | '/='
   | '%='
   | '^='
   | '&='
   | '|='
   | LeftShift
   | RightShift
   | RightShiftAssign
   | LeftShiftAssign
   | '=='
   | '!='
   | '<='
   | '>='
   | '&&'
   | 'and'
   | '||'
   | 'or'
   | '++'
   | '--'
   | ','
   | '->*'
   | '->'
   | '(' ')'
   | '[' ']'
   ;
/*Lexer*/


fragment Hexquad
   : HEXADECIMALDIGIT HEXADECIMALDIGIT HEXADECIMALDIGIT HEXADECIMALDIGIT
   ;

fragment Universalcharactername
   : '\\\\u' Hexquad
   | '\\\\U' Hexquad Hexquad
   ;

Identifier
   :
/*
   Identifiernondigit
   | Identifier Identifiernondigit
   | Identifier DIGIT
   */
   Identifiernondigit (Identifiernondigit | DIGIT)*
   ;

fragment Identifiernondigit
   : NONDIGIT
   | Universalcharactername
   ;

fragment NONDIGIT
   : [a-zA-Z_]
   ;

fragment DIGIT
   : [0-9]
   ;

literal
   : Integerliteral
   | Characterliteral
   | Floatingliteral
   | Stringliteral
   | booleanliteral
   | pointerliteral
   | userdefinedliteral
   ;

Integerliteral
   : Decimalliteral Integersuffix?
   | Octalliteral Integersuffix?
   | Hexadecimalliteral Integersuffix?
   | Binaryliteral Integersuffix?
   ;

Decimalliteral
   : NONZERODIGIT ('\\''? DIGIT)*
   ;

Octalliteral
   : '0' ('\\''? OCTALDIGIT)*
   ;

Hexadecimalliteral
   : ('0x' | '0X') HEXADECIMALDIGIT ('\\''? HEXADECIMALDIGIT)*
   ;

Binaryliteral
   : ('0b' | '0B') BINARYDIGIT ('\\''? BINARYDIGIT)*
   ;

fragment NONZERODIGIT
   : [1-9]
   ;

fragment OCTALDIGIT
   : [0-7]
   ;

fragment HEXADECIMALDIGIT
   : [0-9a-fA-F]
   ;

fragment BINARYDIGIT
   : [01]
   ;

Integersuffix
   : Unsignedsuffix Longsuffix?
   | Unsignedsuffix Longlongsuffix?
   | Longsuffix Unsignedsuffix?
   | Longlongsuffix Unsignedsuffix?
   ;

fragment Unsignedsuffix
   : [uU]
   ;

fragment Longsuffix
   : [lL]
   ;

fragment Longlongsuffix
   : 'll'
   | 'LL'
   ;

Characterliteral
   : '\\'' Cchar+ '\\''
   | 'u' '\\'' Cchar+ '\\''
   | 'U' '\\'' Cchar+ '\\''
   | 'L' '\\'' Cchar+ '\\''
   ;

fragment Cchar
   : ~ ['\\\\\\r\\n]
   | Escapesequence
   | Universalcharactername
   ;

fragment Escapesequence
   : Simpleescapesequence
   | Octalescapesequence
   | Hexadecimalescapesequence
   ;

fragment Simpleescapesequence
   : '\\\\\\''
   | '\\\\""'
   | '\\\\?'
   | '\\\\\\\\'
   | '\\\\a'
   | '\\\\b'
   | '\\\\f'
   | '\\\\n'
   | '\\\\r'
   | '\\\\t'
   | '\\\\v'
   ;

fragment Octalescapesequence
   : '\\\\' OCTALDIGIT
   | '\\\\' OCTALDIGIT OCTALDIGIT
   | '\\\\' OCTALDIGIT OCTALDIGIT OCTALDIGIT
   ;

fragment Hexadecimalescapesequence
   : '\\\\x' HEXADECIMALDIGIT+
   ;

Floatingliteral
   : Fractionalconstant Exponentpart? Floatingsuffix?
   | Digitsequence Exponentpart Floatingsuffix?
   ;

fragment Fractionalconstant
   : Digitsequence? '.' Digitsequence
   | Digitsequence '.'
   ;

fragment Exponentpart
   : 'e' SIGN? Digitsequence
   | 'E' SIGN? Digitsequence
   ;

fragment SIGN
   : [+-]
   ;

fragment Digitsequence
   : DIGIT ('\\''? DIGIT)*
   ;

fragment Floatingsuffix
   : [flFL]
   ;

Stringliteral
   : Encodingprefix? '""' Schar* '""'
   | Encodingprefix? 'R' Rawstring
   ;

fragment Encodingprefix
   : 'u8'
   | 'u'
   | 'U'
   | 'L'
   ;

fragment Schar
   : ~ [""\\\\\\r\\n]
   | Escapesequence
   | Universalcharactername
   ;

fragment Rawstring
   : '""' .*? '(' .*? ')' .*? '""'
   ;

booleanliteral
   : Faalse
   | Trrue
   ;

pointerliteral
   : Nullptr
   ;

userdefinedliteral
   : Userdefinedintegerliteral
   | Userdefinedfloatingliteral
   | Userdefinedstringliteral
   | Userdefinedcharacterliteral
   ;

Userdefinedintegerliteral
   : Decimalliteral Udsuffix
   | Octalliteral Udsuffix
   | Hexadecimalliteral Udsuffix
   | Binaryliteral Udsuffix
   ;

Userdefinedfloatingliteral
   : Fractionalconstant Exponentpart? Udsuffix
   | Digitsequence Exponentpart Udsuffix
   ;

Userdefinedstringliteral
   : Stringliteral Udsuffix
   ;

Userdefinedcharacterliteral
   : Characterliteral Udsuffix
   ;

fragment Udsuffix
   : Identifier
   ;

Whitespace
   : [ \\t]+ -> skip
   ;

Newline
   : ('\\r' '\\n'? | '\\n')
   ;

BlockComment
   : '/*' .*? '*/' -> skip
   ;

LineComment
   : '//' ~ [\\r\\n]* -> skip
   ;",8118,False,1547.8798793033757,median
"/*
 * This file is adapted from the Antlr4 Java grammar which has the following license
 *
 *  Copyright (c) 2013 Terence Parr, Sam Harwell
 *  All rights reserved.
 *  [The ""BSD licence""]
 *
 *    http://www.opensource.org/licenses/bsd-license.php
 *
 * Subsequent modifications by the Groovy community have been done under the Apache License v2:
 *
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  ""License""); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  ""AS IS"" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 */

/**
 * The Groovy grammar is based on the official grammar for Java:
 * https://github.com/antlr/grammars-v4/blob/master/java/Java.g4
 */
parser grammar GroovyParser;

options {
    tokenVocab = GroovyLexer;
    contextSuperClass = GroovyParserRuleContext;
    superClass = AbstractParser;
}

@header {
    import java.util.Map;
    import org.codehaus.groovy.ast.NodeMetaDataHandler;
    import org.apache.groovy.parser.antlr4.SemanticPredicates;
}

@members {

    public static class GroovyParserRuleContext extends ParserRuleContext implements NodeMetaDataHandler {
        private Map metaDataMap = null;

        public GroovyParserRuleContext() {}

        public GroovyParserRuleContext(ParserRuleContext parent, int invokingStateNumber) {
            super(parent, invokingStateNumber);
        }

        @Override
        public Map<?, ?> getMetaDataMap() {
            return this.metaDataMap;
        }

        @Override
        public void setMetaDataMap(Map<?, ?> metaDataMap) {
            this.metaDataMap = metaDataMap;
        }
    }

    @Override
    public int getSyntaxErrorSource() {
        return GroovySyntaxError.PARSER;
    }

    @Override
    public int getErrorLine() {
        Token token = _input.LT(-1);

        if (null == token) {
            return -1;
        }

        return token.getLine();
    }

    @Override
    public int getErrorColumn() {
        Token token = _input.LT(-1);

        if (null == token) {
            return -1;
        }

        return token.getCharPositionInLine() + 1 + token.getText().length();
    }
}

// starting point for parsing a groovy file
compilationUnit
    :   nls
        packageDeclaration? sep? scriptStatements? EOF
    ;

scriptStatements
    :   scriptStatement (sep scriptStatement)* sep?
    ;

scriptStatement
    :   importDeclaration // Import statement.  Can be used in any scope.  Has ""import x as y"" also.
    |   typeDeclaration
    |   statement
    ;

packageDeclaration
    :   annotationsOpt PACKAGE qualifiedName
    ;

importDeclaration
    :   annotationsOpt IMPORT STATIC? qualifiedName (DOT MUL | AS alias=identifier)?
    ;


typeDeclaration
    :   classOrInterfaceModifiersOpt classDeclaration
    ;

modifier
    :   classOrInterfaceModifier
    |   m=(   NATIVE
          |   SYNCHRONIZED
          |   TRANSIENT
          |   VOLATILE
          |   DEF
          |   VAR
          )
    ;

modifiersOpt
    :   (modifiers nls)?
    ;

modifiers
    :   modifier (nls modifier)*
    ;

classOrInterfaceModifiersOpt
    :   (classOrInterfaceModifiers
            NL* /* Use `NL*` here for better performance, so DON'T replace it with `nls` */
        )?
    ;

classOrInterfaceModifiers
    :   classOrInterfaceModifier (nls classOrInterfaceModifier)*
    ;

classOrInterfaceModifier
    :   annotation       // class or interface
    |   m=(   PUBLIC     // class or interface
          |   PROTECTED  // class or interface
          |   PRIVATE    // class or interface
          |   STATIC     // class or interface
          |   ABSTRACT   // class or interface
          |   FINAL      // class only -- does not apply to interfaces
          |   STRICTFP   // class or interface
          |   DEFAULT    // interface only -- does not apply to classes
          )
    ;

variableModifier
    :   annotation
    |   m=( FINAL
          | DEF
          | VAR
          // Groovy supports declaring local variables as instance/class fields,
          // e.g. import groovy.transform.*; @Field static List awe = [1, 2, 3]
          // e.g. import groovy.transform.*; def a = { @Field public List awe = [1, 2, 3] }
          // Notice: Groovy 2.4.7 just allows to declare local variables with the following modifiers when using annotations(e.g. @Field)
          // TODO check whether the following modifiers accompany annotations or not. Because the legacy codes(e.g. benchmark/bench/heapsort.groovy) allow to declare the special instance/class fields without annotations, we leave it as it is for the time being
          | PUBLIC
          | PROTECTED
          | PRIVATE
          | STATIC
          | ABSTRACT
          | STRICTFP
          )
    ;

variableModifiersOpt
    :   (variableModifiers nls)?
    ;

variableModifiers
    :   variableModifier (nls variableModifier)*
    ;

typeParameters
    :   LT nls typeParameter (COMMA nls typeParameter)* nls GT
    ;

typeParameter
    :   className (EXTENDS nls typeBound)?
    ;

typeBound
    :   type (BITAND nls type)*
    ;

typeList
    :   type (COMMA nls type)*
    ;


/**
 *  t   0: class; 1: interface; 2: enum; 3: annotation; 4: trait
 */
classDeclaration
locals[ int t ]
    :   (   CLASS { $t = 0; }
        |   INTERFACE { $t = 1; }
        |   ENUM { $t = 2; }
        |   AT INTERFACE { $t = 3; }
        |   TRAIT { $t = 4; }
        )
        identifier
        (nls typeParameters)?
        (nls EXTENDS nls scs=typeList)?
        (nls IMPLEMENTS nls is=typeList)?
        nls classBody[$t]
    ;

// t    see the comment of classDeclaration
classBody[int t]
    :   LBRACE nls
        (
            /* Only enum can have enum constants */
            { 2 == $t }?
            enumConstants (nls COMMA)? sep?
        |
        )
        (classBodyDeclaration[$t] (sep classBodyDeclaration[$t])*)? sep? RBRACE
    ;

enumConstants
    :   enumConstant (nls COMMA nls enumConstant)*
    ;

enumConstant
    :   annotationsOpt identifier arguments? anonymousInnerClassDeclaration[1]?
    ;

classBodyDeclaration[int t]
    :   (STATIC nls)? block
    |   memberDeclaration[$t]
    ;

memberDeclaration[int t]
    :   methodDeclaration[0, $t]
    |   fieldDeclaration
    |   modifiersOpt classDeclaration
    ;

/**
 *  t   0: *class member* all kinds of method declaration AND constructor declaration,
 *      1: normal method declaration, 2: abstract method declaration
 *      3: normal method declaration OR abstract method declaration
 *  ct  9: script, other see the comment of classDeclaration
 */
methodDeclaration[int t, int ct]
    :   modifiersOpt
        (   { 3 == $ct }?
            returnType[$ct] methodName LPAREN rparen (DEFAULT nls elementValue)?
        |
            typeParameters? returnType[$ct]?
            methodName formalParameters (nls THROWS nls qualifiedClassNameList)?
            (nls methodBody)?
        )
    ;

methodName
    :   identifier
    |   stringLiteral
    ;

returnType[int ct]
    :
        standardType
    |   VOID
    ;

fieldDeclaration
    :   variableDeclaration[1]
    ;

variableDeclarators
    :   variableDeclarator (COMMA nls variableDeclarator)*
    ;

variableDeclarator
    :   variableDeclaratorId (nls ASSIGN nls variableInitializer)?
    ;

variableDeclaratorId
    :   identifier
    ;

variableInitializer
    :   enhancedStatementExpression
    ;

variableInitializers
    :   variableInitializer (nls COMMA nls variableInitializer)* nls COMMA?
    ;

emptyDims
    :   (annotationsOpt LBRACK RBRACK)+
    ;

emptyDimsOpt
    :   emptyDims?
    ;

standardType
options { baseContext = type; }
    :   annotationsOpt
        (
            primitiveType
        |
            standardClassOrInterfaceType
        )
        emptyDimsOpt
    ;

type
    :   annotationsOpt
        (
            (
                primitiveType
            |
                // !!! Error Alternative !!!
                 VOID
            )
        |
                generalClassOrInterfaceType
        )
        emptyDimsOpt
    ;

classOrInterfaceType
    :   (   qualifiedClassName
        |   qualifiedStandardClassName
        ) typeArguments?
    ;

generalClassOrInterfaceType
options { baseContext = classOrInterfaceType; }
    :   qualifiedClassName typeArguments?
    ;

standardClassOrInterfaceType
options { baseContext = classOrInterfaceType; }
    :   qualifiedStandardClassName typeArguments?
    ;

primitiveType
    :   BuiltInPrimitiveType
    ;

typeArguments
    :   LT nls typeArgument (COMMA nls typeArgument)* nls GT
    ;

typeArgument
    :   type
    |   annotationsOpt QUESTION ((EXTENDS | SUPER) nls type)?
    ;

annotatedQualifiedClassName
    :   annotationsOpt qualifiedClassName
    ;

qualifiedClassNameList
    :   annotatedQualifiedClassName (COMMA nls annotatedQualifiedClassName)*
    ;

formalParameters
    :   LPAREN formalParameterList? rparen
    ;

formalParameterList
    :   (formalParameter | thisFormalParameter) (COMMA nls formalParameter)*
    ;

thisFormalParameter
    :   type THIS
    ;

formalParameter
    :   variableModifiersOpt type? ELLIPSIS? variableDeclaratorId (nls ASSIGN nls expression)?
    ;

methodBody
    :   block
    ;

qualifiedName
    :   qualifiedNameElement (DOT qualifiedNameElement)*
    ;

/**
 *  Java doesn't have the keywords 'as', 'in', 'def', 'trait' so we make some allowances
 *  for them in package names for better integration with existing Java packages
 */
qualifiedNameElement
    :   identifier
    |   DEF
    |   IN
    |   AS
    |   TRAIT
    ;

qualifiedNameElements
    :   (qualifiedNameElement DOT)*
    ;

qualifiedClassName
    :   qualifiedNameElements identifier
    ;

qualifiedStandardClassName
    :   qualifiedNameElements className (DOT className)*
    ;

literal
    :   IntegerLiteral                                                                      #integerLiteralAlt
    |   FloatingPointLiteral                                                                #floatingPointLiteralAlt
    |   stringLiteral                                                                       #stringLiteralAlt
    |   BooleanLiteral                                                                      #booleanLiteralAlt
    |   NullLiteral                                                                         #nullLiteralAlt
    ;

// GSTRING

gstring
    :   GStringBegin gstringValue (GStringPart  gstringValue)* GStringEnd
    ;

gstringValue
    :   gstringPath
    |   closure
    ;

gstringPath
    :   identifier GStringPathPart*
    ;


// LAMBDA EXPRESSION
lambdaExpression
options { baseContext = standardLambdaExpression; }
	:	lambdaParameters nls ARROW nls lambdaBody
	;

// JAVA STANDARD LAMBDA EXPRESSION
standardLambdaExpression
	:	standardLambdaParameters nls ARROW nls lambdaBody
	;

lambdaParameters
options { baseContext = standardLambdaParameters; }
    :   formalParameters

    // { a -> a * 2 } can be parsed as a lambda expression in a block, but we expect a closure.
    // So it is better to put parameters in the parentheses and the following single parameter without parentheses is limited
//    |   variableDeclaratorId
    ;

standardLambdaParameters
    :   formalParameters
    |   variableDeclaratorId
    ;

lambdaBody
	:	block
	|	statementExpression
	;

// CLOSURE
closure
    :   LBRACE nls (formalParameterList? nls ARROW nls)? blockStatementsOpt RBRACE
    ;

// GROOVY-8991: Difference in behaviour with closure and lambda
closureOrLambdaExpression
    :   closure
    |   lambdaExpression
    ;

blockStatementsOpt
    :   blockStatements?
    ;

blockStatements
    :   blockStatement (sep blockStatement)* sep?
    ;

// ANNOTATIONS

annotationsOpt
    :   (annotation (nls annotation)* nls)?
    ;

annotation
    :   AT annotationName ( LPAREN elementValues? rparen)?
    ;

elementValues
    :   elementValuePairs
    |   elementValue
    ;

annotationName : qualifiedClassName ;

elementValuePairs
    :   elementValuePair (COMMA elementValuePair)*
    ;

elementValuePair
    :   elementValuePairName nls ASSIGN nls elementValue
    ;

elementValuePairName
    :   identifier
    |   keywords
    ;

// TODO verify the potential performance issue because rule expression contains sub-rule assignments(https://github.com/antlr/grammars-v4/issues/215)
elementValue
    :   elementValueArrayInitializer
    |   annotation
    |   expression
    ;

elementValueArrayInitializer
    :   LBRACK (elementValue (COMMA elementValue)* COMMA?)? RBRACK
    ;

// STATEMENTS / BLOCKS

block
    :   LBRACE sep? blockStatementsOpt RBRACE
    ;

blockStatement
    :   localVariableDeclaration
    |   statement
    ;

localVariableDeclaration
    :   { !SemanticPredicates.isInvalidLocalVariableDeclaration(_input) }?
        variableDeclaration[0]
    ;

/**
 *  t   0: local variable declaration; 1: field declaration
 */
variableDeclaration[int t]
    :   modifiers nls
        (   type? variableDeclarators
        |   typeNamePairs nls ASSIGN nls variableInitializer
        )
    |
        type variableDeclarators
    ;

typeNamePairs
    :   LPAREN typeNamePair (COMMA typeNamePair)* rparen
    ;

typeNamePair
    :   type? variableDeclaratorId
    ;

variableNames
    :   LPAREN variableDeclaratorId (COMMA variableDeclaratorId)+ rparen
    ;

conditionalStatement
    :   ifElseStatement
    |   switchStatement
    ;

ifElseStatement
    :   IF expressionInPar nls tb=statement ((nls | sep) ELSE nls fb=statement)?
    ;

switchStatement
    :   SWITCH expressionInPar nls LBRACE nls (switchBlockStatementGroup+ nls)? RBRACE
    ;

loopStatement
    :   FOR LPAREN forControl rparen nls statement                                                            #forStmtAlt
    |   WHILE expressionInPar nls statement                                                                   #whileStmtAlt
    |   DO nls statement nls WHILE expressionInPar                                                            #doWhileStmtAlt
    ;

continueStatement
    :   CONTINUE
        identifier?
    ;

breakStatement
    :   BREAK
        identifier?
    ;

tryCatchStatement
    :   TRY resources? nls block
        (nls catchClause)*
        (nls finallyBlock)?
    ;

assertStatement
    :   ASSERT ce=expression (nls (COLON | COMMA) nls me=expression)?
    ;

statement
    :   block                                                                                               #blockStmtAlt
    |   conditionalStatement                                                                                #conditionalStmtAlt
    |   loopStatement                                                                                       #loopStmtAlt
    |   tryCatchStatement                                                                                   #tryCatchStmtAlt
    |   SYNCHRONIZED expressionInPar nls block                                                              #synchronizedStmtAlt
    |   RETURN expression?                                                                                  #returnStmtAlt
    |   THROW expression                                                                                    #throwStmtAlt
    |   breakStatement                                                                                      #breakStmtAlt
    |   continueStatement                                                                                   #continueStmtAlt
    |   identifier COLON nls statement                                                                      #labeledStmtAlt
    |   assertStatement                                                                                     #assertStmtAlt
    |   localVariableDeclaration                                                                            #localVariableDeclarationStmtAlt

    // validate the method in the AstBuilder#visitMethodDeclaration, e.g. method without method body is not allowed
    |   { !SemanticPredicates.isInvalidMethodDeclaration(_input) }?
        methodDeclaration[3, 9]                                                                             #methodDeclarationStmtAlt

    |   statementExpression                                                                                 #expressionStmtAlt
    |   SEMI                                                                                                #emptyStmtAlt
    ;

catchClause
    :   CATCH LPAREN variableModifiersOpt catchType? identifier rparen nls block
    ;

catchType
    :   qualifiedClassName (BITOR qualifiedClassName)*
    ;

finallyBlock
    :   FINALLY nls block
    ;

resources
    :   LPAREN nls resourceList sep? rparen
    ;

resourceList
    :   resource (sep resource)*
    ;

resource
    :   localVariableDeclaration
    |   expression
    ;


/** Matches cases then statements, both of which are mandatory.
 *  To handle empty cases at the end, we add switchLabel* to statement.
 */
switchBlockStatementGroup
    :   switchLabel (nls switchLabel)* nls blockStatements
    ;

switchLabel
    :   CASE expression COLON
    |   DEFAULT COLON
    ;

forControl
    :   enhancedForControl
    |   classicalForControl
    ;

enhancedForControl
    :   variableModifiersOpt type? variableDeclaratorId (COLON | IN) expression
    ;

classicalForControl
    :   forInit? SEMI expression? SEMI forUpdate?
    ;

forInit
    :   localVariableDeclaration
    |   expressionList[false]
    ;

forUpdate
    :   expressionList[false]
    ;


// EXPRESSIONS

castParExpression
    :   LPAREN type rparen
    ;

parExpression
    :   expressionInPar
    ;

expressionInPar
    :   LPAREN enhancedStatementExpression rparen
    ;

expressionList[boolean canSpread]
    :   expressionListElement[$canSpread] (COMMA expressionListElement[$canSpread])*
    ;

expressionListElement[boolean canSpread]
    :   MUL? expression
    ;

enhancedStatementExpression
    :   statementExpression
    |   standardLambdaExpression
    ;

statementExpression
    :   commandExpression                   #commandExprAlt
    ;

postfixExpression
    :   pathExpression op=(INC | DEC)?
    ;

expression
    // qualified names, array expressions, method invocation, post inc/dec, type casting (level 1)
    // The cast expression must be put before pathExpression to resovle the ambiguities between type casting and call on parentheses expression, e.g. (int)(1 / 2)
    :   castParExpression castOperandExpression                                             #castExprAlt
    |   postfixExpression                                                                   #postfixExprAlt

    // ~(BNOT)/!(LNOT) (level 1)
    |   (BITNOT | NOT) nls expression                                                       #unaryNotExprAlt

    // math power operator (**) (level 2)
    |   left=expression op=POWER nls right=expression                                       #powerExprAlt

    // ++(prefix)/--(prefix)/+(unary)/-(unary) (level 3)
    |   op=(INC | DEC | ADD | SUB) expression                                               #unaryAddExprAlt

    // multiplication/division/modulo (level 4)
    |   left=expression nls op=(MUL | DIV | MOD) nls right=expression                       #multiplicativeExprAlt

    // binary addition/subtraction (level 5)
    |   left=expression op=(ADD | SUB) nls right=expression                                 #additiveExprAlt

    // bit shift expressions (level 6)
    |   left=expression nls
            (           (   dlOp=LT LT
                        |   tgOp=GT GT GT
                        |   dgOp=GT GT
                        )
            |   rangeOp=(    RANGE_INCLUSIVE
                        |    RANGE_EXCLUSIVE
                        )
            ) nls
        right=expression                                                                    #shiftExprAlt

    // boolean relational expressions (level 7)
    |   left=expression nls op=(AS | INSTANCEOF | NOT_INSTANCEOF) nls type                  #relationalExprAlt
    |   left=expression nls op=(LE | GE | GT | LT | IN | NOT_IN)  nls right=expression      #relationalExprAlt

    // equality/inequality (==/!=) (level 8)
    |   left=expression nls
            op=(    IDENTICAL
               |    NOT_IDENTICAL
               |    EQUAL
               |    NOTEQUAL
               |    SPACESHIP
               ) nls
        right=expression                                                                    #equalityExprAlt

    // regex find and match (=~ and ==~) (level 8.5)
    // jez: moved =~ closer to precedence of == etc, as...
    // 'if (foo =~ ""a.c"")' is very close in intent to 'if (foo == ""abc"")'
    |   left=expression nls op=(REGEX_FIND | REGEX_MATCH) nls right=expression              #regexExprAlt

    // bitwise or non-short-circuiting and (&)  (level 9)
    |   left=expression nls op=BITAND nls right=expression                                  #andExprAlt

    // exclusive or (^)  (level 10)
    |   left=expression nls op=XOR nls right=expression                                     #exclusiveOrExprAlt

    // bitwise or non-short-circuiting or (|)  (level 11)
    |   left=expression nls op=BITOR nls right=expression                                   #inclusiveOrExprAlt

    // logical and (&&)  (level 12)
    |   left=expression nls op=AND nls right=expression                                     #logicalAndExprAlt

    // logical or (||)  (level 13)
    |   left=expression nls op=OR nls right=expression                                      #logicalOrExprAlt

    // conditional test (level 14)
    |   <assoc=right> con=expression nls
        (   QUESTION nls tb=expression nls COLON nls
        |   ELVIS nls
        )
        fb=expression                                                                       #conditionalExprAlt

    // assignment expression (level 15)
    // ""(a) = [1]"" is a special case of multipleAssignmentExprAlt, it will be handle by assignmentExprAlt
    |   <assoc=right> left=variableNames nls op=ASSIGN nls right=statementExpression        #multipleAssignmentExprAlt
    |   <assoc=right> left=expression nls
                        op=(   ASSIGN
                           |   ADD_ASSIGN
                           |   SUB_ASSIGN
                           |   MUL_ASSIGN
                           |   DIV_ASSIGN
                           |   AND_ASSIGN
                           |   OR_ASSIGN
                           |   XOR_ASSIGN
                           |   RSHIFT_ASSIGN
                           |   URSHIFT_ASSIGN
                           |   LSHIFT_ASSIGN
                           |   MOD_ASSIGN
                           |   POWER_ASSIGN
                           |   ELVIS_ASSIGN
                           ) nls
                     enhancedStatementExpression                                            #assignmentExprAlt
    ;


castOperandExpression
options { baseContext = expression; }
    :   castParExpression castOperandExpression                                             #castExprAlt
    |   postfixExpression                                                                   #postfixExprAlt

    // ~(BNOT)/!(LNOT) (level 1)
    |   (BITNOT | NOT) nls castOperandExpression                                            #unaryNotExprAlt

    // ++(prefix)/--(prefix)/+(unary)/-(unary) (level 3)
    |   op=(INC | DEC | ADD | SUB) castOperandExpression                                    #unaryAddExprAlt
    ;

commandExpression
    :   expression
        (
            { !SemanticPredicates.isFollowingArgumentsOrClosure($expression.ctx) }?
            argumentList
        |
            /* if pathExpression is a method call, no need to have any more arguments */
        )

        commandArgument*
    ;

commandArgument
    :   commandPrimary
        // what follows is either a normal argument, parens,
        // an appended block, an index operation, or nothing
        // parens (a b already processed):
        //      a b c() d e -> a(b).c().d(e)
        //      a b c()() d e -> a(b).c().call().d(e)
        // index (a b already processed):
        //      a b c[x] d e -> a(b).c[x].d(e)
        //      a b c[x][y] d e -> a(b).c[x][y].d(e)
        // block (a b already processed):
        //      a b c {x} d e -> a(b).c({x}).d(e)
        //
        // parens/block completes method call
        // index makes method call to property get with index
        //
        (   pathElement+
        |   argumentList
        )?
    ;

/**
 *  A ""path expression"" is a name or other primary, possibly qualified by various
 *  forms of dot, and/or followed by various kinds of brackets.
 *  It can be used for value or assigned to, or else further qualified, indexed, or called.
 *  It is called a ""path"" because it looks like a linear path through a data structure.
 *  Examples:  x.y, x?.y, x*.y, x.@y; x[], x[y], x[y,z]; x(), x(y), x(y,z); x{s}; a.b[n].c(x).d{s}
 *  (Compare to a C lvalue, or LeftHandSide in the JLS section 15.26.)
 *  General expressions are built up from path expressions, using operators like '+' and '='.
 *
 *  t   0: primary, 1: namePart, 2: arguments, 3: closureOrLambdaExpression, 4: indexPropertyArgs, 5: namedPropertyArgs,
 *      6: non-static inner class creator
 */
pathExpression returns [int t]
    :   primary (pathElement { $t = $pathElement.t; })*
    ;

pathElement returns [int t]
    :   nls
        (
            // AT: foo.@bar selects the field (or attribute), not property
            (
                (   DOT                 // The all-powerful dot.
                |   SPREAD_DOT          // Spread operator:  x*.y  ===  x?.collect{it.y}
                |   SAFE_DOT            // Optional-null operator:  x?.y  === (x==null)?null:x.y
                |   SAFE_CHAIN_DOT      // Optional-null chain operator:  x??.y.z  === x?.y?.z
                ) nls (AT | nonWildcardTypeArguments)?
            |
                METHOD_POINTER nls      // Method pointer operator: foo.&y == foo.metaClass.getMethodPointer(foo, ""y"")
            |
                METHOD_REFERENCE nls    // Method reference: System.out::println
            )
            namePart
            { $t = 1; }
        |
            DOT nls NEW creator[1]
            { $t = 6; }

            // Can always append a block, as foo{bar}
        |   closureOrLambdaExpression
            { $t = 3; }
        )

    |   arguments
        { $t = 2; }

    // Element selection is always an option, too.
    // In Groovy, the stuff between brackets is a general argument list,
    // since the bracket operator is transformed into a method call.
    |   indexPropertyArgs
        { $t = 4; }

    |   namedPropertyArgs
        { $t = 5; }
    ;

/**
 *  This is the grammar for what can follow a dot:  x.a, x.@a, x.&a, x.'a', etc.
 */
namePart
    :
        (   identifier

        // foo.'bar' is in all ways same as foo.bar, except that bar can have an arbitrary spelling
        |   stringLiteral

        |   dynamicMemberName

        /* just a PROPOSAL, which has not been implemented yet!
        // PROPOSAL, DECIDE:  Is this inline form of the 'with' statement useful?
        // Definition:  a.{foo} === {with(a) {foo}}
        // May cover some path expression use-cases previously handled by dynamic scoping (closure delegates).
        |   block
        */

        // let's allow common keywords as property names
        |   keywords
        )
    ;

/**
 *  If a dot is followed by a parenthesized or quoted expression, the member is computed dynamically,
 *  and the member selection is done only at runtime.  This forces a statically unchecked member access.
 */
dynamicMemberName
    :   parExpression
    |   gstring
    ;

/** An expression may be followed by [...].
 *  Unlike Java, these brackets may contain a general argument list,
 *  which is passed to the array element operator, which can make of it what it wants.
 *  The brackets may also be empty, as in T[].  This is how Groovy names array types.
 */
indexPropertyArgs
    :   QUESTION? LBRACK expressionList[true]? RBRACK
    ;

namedPropertyArgs
    :   QUESTION? LBRACK (namedPropertyArgList | COLON) RBRACK
    ;

primary
    :
        // Append `typeArguments?` to `identifier` to support constructor reference with generics, e.g. HashMap<String, Integer>::new
        // Though this is not a graceful solution, it is much faster than replacing `builtInType` with `type`
        identifier typeArguments?                                                           #identifierPrmrAlt
    |   literal                                                                             #literalPrmrAlt
    |   gstring                                                                             #gstringPrmrAlt
    |   NEW nls creator[0]                                                                  #newPrmrAlt
    |   THIS                                                                                #thisPrmrAlt
    |   SUPER                                                                               #superPrmrAlt
    |   parExpression                                                                       #parenPrmrAlt
    |   closureOrLambdaExpression                                                           #closureOrLambdaExpressionPrmrAlt
    |   list                                                                                #listPrmrAlt
    |   map                                                                                 #mapPrmrAlt
    |   builtInType                                                                         #builtInTypePrmrAlt
    ;

namedPropertyArgPrimary
options { baseContext = primary; }
    :   identifier                                                                          #identifierPrmrAlt
    |   literal                                                                             #literalPrmrAlt
    |   gstring                                                                             #gstringPrmrAlt
    |   parExpression                                                                       #parenPrmrAlt
    ;

commandPrimary
options { baseContext = primary; }
    :   identifier                                                                          #identifierPrmrAlt
    |   literal                                                                             #literalPrmrAlt
    |   gstring                                                                             #gstringPrmrAlt
    ;

list
    :   LBRACK expressionList[true]? COMMA? RBRACK
    ;

map
    :   LBRACK
        (   mapEntryList COMMA?
        |   COLON
        )
        RBRACK
    ;

mapEntryList
    :   mapEntry (COMMA mapEntry)*
    ;

namedPropertyArgList
options { baseContext = mapEntryList; }
    :   namedPropertyArg (COMMA namedPropertyArg)*
    ;

mapEntry
    :   mapEntryLabel COLON nls expression
    |   MUL COLON nls expression
    ;

namedPropertyArg
options { baseContext = mapEntry; }
    :   namedPropertyArgLabel COLON nls expression
    |   MUL COLON nls expression
    ;

mapEntryLabel
    :   keywords
    |   primary
    ;

namedPropertyArgLabel
options { baseContext = mapEntryLabel; }
    :   keywords
    |   namedPropertyArgPrimary
    ;

/**
 *  t 0: general creation; 1: non-static inner class creation
 */
creator[int t]
    :   createdName
        (   nls arguments anonymousInnerClassDeclaration[0]?
        |   dim+ (nls arrayInitializer)?
        )
    ;

dim
    :   annotationsOpt LBRACK expression? RBRACK
    ;

arrayInitializer
    :   LBRACE nls (variableInitializers nls)? RBRACE
    ;

/**
 *  t   0: anonymous inner class; 1: anonymous enum
 */
anonymousInnerClassDeclaration[int t]
    :   classBody[0]
    ;

createdName
    :   annotationsOpt
        (   primitiveType
        |   qualifiedClassName typeArgumentsOrDiamond?
        )
    ;

nonWildcardTypeArguments
    :   LT nls typeList nls GT
    ;

typeArgumentsOrDiamond
    :   LT GT
    |   typeArguments
    ;

arguments
    :   LPAREN enhancedArgumentList? COMMA? rparen
    ;

argumentList
options { baseContext = enhancedArgumentList; }
    :   argumentListElement
        (   COMMA nls
            argumentListElement
        )*
    ;

enhancedArgumentList
    :   enhancedArgumentListElement
        (   COMMA nls
            enhancedArgumentListElement
        )*
    ;

argumentListElement
options { baseContext = enhancedArgumentListElement; }
    :   expressionListElement[true]
    |   namedPropertyArg
    ;

enhancedArgumentListElement
    :   expressionListElement[true]
    |   standardLambdaExpression
    |   namedPropertyArg
    ;

stringLiteral
    :   StringLiteral
    ;

className
    :   CapitalizedIdentifier
    ;

identifier
    :   Identifier
    |   CapitalizedIdentifier
    |   VAR
    |   IN
//    |   DEF
    |   TRAIT
    |   AS
    |
        // if 'static' followed by DOT, we can treat them as identifiers, e.g. static.unused = { -> }
        { DOT == _input.LT(2).getType() }?
        STATIC
    ;

builtInType
    :   BuiltInPrimitiveType
    |   VOID
    ;

keywords
    :   ABSTRACT
    |   AS
    |   ASSERT
    |   BREAK
    |   CASE
    |   CATCH
    |   CLASS
    |   CONST
    |   CONTINUE
    |   DEF
    |   DEFAULT
    |   DO
    |   ELSE
    |   ENUM
    |   EXTENDS
    |   FINAL
    |   FINALLY
    |   FOR
    |   GOTO
    |   IF
    |   IMPLEMENTS
    |   IMPORT
    |   IN
    |   INSTANCEOF
    |   INTERFACE
    |   NATIVE
    |   NEW
    |   PACKAGE
    |   RETURN
    |   STATIC
    |   STRICTFP
    |   SUPER
    |   SWITCH
    |   SYNCHRONIZED
    |   THIS
    |   THROW
    |   THROWS
    |   TRANSIENT
    |   TRAIT
    |   THREADSAFE
    |   TRY
    |   VAR
    |   VOLATILE
    |   WHILE

    |   NullLiteral
    |   BooleanLiteral

    |   BuiltInPrimitiveType
    |   VOID

    |   PUBLIC
    |   PROTECTED
    |   PRIVATE
    ;

rparen
    :   RPAREN
    |
        // !!!Error Alternative, impact the performance of parsing
        { require(false, ""Missing ')'""); }
    ;

nls
    :   NL*
    ;

sep :   (NL | SEMI)+
    ;
",7986,False,1527.118058078115,median
"// This file is licensed under the Elastic License 2.0. Copyright 2021-present, StarRocks Limited.

#include ""exprs/vectorized/math_functions.h""

#include <glog/logging.h>
#include <gtest/gtest.h>

#include ""exprs/vectorized/mock_vectorized_expr.h""
#include ""math.h""

#define PI acos(-1)

namespace starrocks {
namespace vectorized {
class VecMathFunctionsTest : public ::testing::Test {
public:
    void SetUp() override {}
};

TEST_F(VecMathFunctionsTest, truncateTest) {
    {
        Columns columns;

        auto c0 = DoubleColumn::create();
        auto c1 = Int32Column::create();

        double dous[] = {2341.2341111, 4999.90134, 2144.2855, 934.12439};
        int ints[] = {2, 3, 1, 4};

        double expected_res[] = {2341.23, 4999.901, 2144.2, 934.1243};

        for (int i = 0; i < sizeof(dous) / sizeof(dous[0]); ++i) {
            c0->append(dous[i]);
            c1->append(ints[i]);
        }

        columns.emplace_back(c0);
        columns.emplace_back(c1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr res = MathFunctions::truncate(ctx.get(), columns);

        auto* raw_res = ColumnHelper::cast_to<TYPE_DOUBLE>(res)->get_data().data();

        for (int i = 0; i < sizeof(expected_res) / sizeof(expected_res[0]); ++i) {
            ASSERT_EQ(expected_res[i], raw_res[i]);
        }
    }
}

TEST_F(VecMathFunctionsTest, truncateNanTest) {
    {
        Columns columns;

        auto c0 = DoubleColumn::create();
        auto c1 = Int32Column::create();

        c0->append(0);
        c1->append(1591994755);

        columns.emplace_back(c0);
        columns.emplace_back(c1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr res = MathFunctions::truncate(ctx.get(), columns);

        ASSERT_EQ(true, res->is_null(0));
    }
}

static constexpr uint8_t TYPE_ROUND = 0;
static constexpr uint8_t TYPE_ROUND_UP_TO = 1;
static constexpr uint8_t TYPE_TRUNCATE = 2;

template <uint8_t type>
static void testRoundDecimal(const std::vector<std::string>& arg0_values, const std::vector<uint8_t>& arg0_null_flags,
                             const int32_t precision, const int32_t scale, const std::vector<int32_t>& arg1_values,
                             const std::vector<uint8_t>& arg1_null_flags, const std::vector<std::string>& res_values,
                             const std::vector<uint8_t>& res_null_flags) {
    ASSERT_GE(precision, 0);
    ASSERT_LE(precision, decimal_precision_limit<int128_t>);
    ASSERT_GE(scale, 0);
    ASSERT_LE(scale, decimal_precision_limit<int128_t>);
    ASSERT_TRUE(arg0_null_flags.empty() || arg0_null_flags.size() == arg0_values.size());
    ASSERT_TRUE(arg1_null_flags.empty() || arg1_null_flags.size() == arg1_values.size());
    ASSERT_TRUE(res_null_flags.empty() || res_null_flags.size() == res_values.size());

    Columns columns;

    auto arg0_data_column = DecimalV3Column<int128_t>::create(precision, scale);
    auto arg1_data_column = Int32Column::create();

    ASSERT_EQ(arg0_values.size(), arg1_values.size());
    std::set<std::string> arg0_distinct_values;
    bool arg0_has_null = false;
    bool arg0_all_null = true;
    for (auto i = 0; i < arg0_values.size(); i++) {
        if (!arg0_null_flags.empty() && arg0_null_flags[i] == 1) {
            arg0_has_null = true;
            arg0_data_column->append_default(1);
            continue;
        }
        arg0_all_null = false;
        int128_t value;
        DecimalV3Cast::from_string<int128_t>(&value, precision, scale, arg0_values[i].c_str(), arg0_values[i].length());
        arg0_data_column->append(value);
        arg0_distinct_values.insert(arg0_values[i]);
    }
    std::set<int32_t> arg1_distinct_values;
    bool arg1_has_null = false;
    bool arg1_all_null = true;
    for (auto i = 0; i < arg1_values.size(); i++) {
        if (!arg1_null_flags.empty() && arg1_null_flags[i] == 1) {
            arg1_has_null = true;
            arg1_data_column->append_default(1);
            continue;
        }
        arg1_all_null = false;
        arg1_data_column->append(arg1_values[i]);
        arg1_distinct_values.insert(arg1_values[i]);
    }

    ColumnPtr c0;
    bool c0_const = false;
    bool c0_nullable = false;
    if (arg0_all_null) {
        // ConstNullColumn
        c0_const = true;
        c0_nullable = true;
        c0 = ColumnHelper::create_const_null_column(arg0_data_column->size());
    } else if (!arg0_has_null && arg0_distinct_values.size() == 1) {
        // ConstColumn
        c0_const = true;
        c0 = ConstColumn::create(arg0_data_column, arg0_data_column->size());
    } else {
        if (arg0_null_flags.empty()) {
            // normal Column
            c0 = arg0_data_column;
        } else {
            // NullableColumn
            c0_nullable = true;
            auto null_flags = NullColumn::create();
            for (int i = 0; i < arg0_values.size(); i++) {
                null_flags->append(arg0_null_flags[i]);
            }
            c0 = NullableColumn::create(arg0_data_column, null_flags);
        }
    }

    ColumnPtr c1;
    bool c1_const = false;
    bool c1_nullable = false;
    if (arg1_all_null) {
        // ConstNullColumn
        c1_const = true;
        c1_nullable = true;
        c1 = ColumnHelper::create_const_null_column(arg1_data_column->size());
    } else if (!arg1_has_null && arg1_distinct_values.size() == 1) {
        // ConstColumn
        c1_const = true;
        c1 = ConstColumn::create(arg1_data_column, arg1_data_column->size());
    } else {
        if (arg1_null_flags.empty()) {
            // normal Column
            c1 = arg1_data_column;
        } else {
            // NullableColumn
            c1_nullable = true;
            auto null_flags = NullColumn::create();
            for (int i = 0; i < arg1_values.size(); i++) {
                null_flags->append(arg1_null_flags[i]);
            }
            c1 = NullableColumn::create(arg1_data_column, null_flags);
        }
    }

    columns.emplace_back(c0);
    if (type == TYPE_ROUND) {
        c1_const = true;
        c1_nullable = false;
    } else {
        columns.emplace_back(c1);
    }

    FunctionContext::TypeDesc return_type;
    return_type.precision = decimal_precision_limit<int128_t>;
    if (arg1_values.size() == 1 || c1_const) {
        if (arg1_values[0] < 0) {
            return_type.scale = 0;
        } else if (arg1_values[0] > decimal_precision_limit<int128_t>) {
            return_type.scale = decimal_precision_limit<int128_t>;
        } else {
            return_type.scale = arg1_values[0];
        }
    } else {
        return_type.scale = scale;
    }
    std::unique_ptr<FunctionContext> ctx(
            FunctionContext::create_test_context(std::vector<starrocks_udf::FunctionContext::TypeDesc>(), return_type));
    ColumnPtr res_column;
    bool res_const = false;
    if (type == TYPE_ROUND) {
        res_column = MathFunctions::round_decimal128(ctx.get(), columns);
    } else if (type == TYPE_ROUND_UP_TO) {
        res_column = MathFunctions::round_up_to_decimal128(ctx.get(), columns);
    } else {
        ASSERT_EQ(type, TYPE_TRUNCATE);
        res_column = MathFunctions::truncate_decimal128(ctx.get(), columns);
    }
    DecimalV3Column<int128_t>* decimal_res_column;
    NullColumn* null_fags_res_column = nullptr;

    if ((c0_const && c0_nullable) || (c1_const && c1_nullable)) {
        ASSERT_TRUE(res_column->only_null());
        res_const = true;
        return;
    } else if (c0_const && c1_const) {
        ASSERT_TRUE(res_column->is_constant());
        res_const = true;
        decimal_res_column =
                ColumnHelper::cast_to<TYPE_DECIMAL128>(FunctionHelper::get_data_column_of_const(res_column)).get();
    } else if (c0_nullable || c1_nullable) {
        ASSERT_TRUE(res_column->is_nullable());
        decimal_res_column =
                ColumnHelper::cast_to<TYPE_DECIMAL128>(FunctionHelper::get_data_column_of_nullable(res_column)).get();
        null_fags_res_column = down_cast<NullableColumn*>(res_column.get())->null_column().get();
    } else {
        ASSERT_FALSE(res_column->is_constant());
        ASSERT_FALSE(res_column->is_nullable());
        decimal_res_column = ColumnHelper::cast_to<TYPE_DECIMAL128>(res_column).get();
    }

    ASSERT_EQ(decimal_precision_limit<int128_t>, decimal_res_column->precision());
    ASSERT_EQ(return_type.scale, decimal_res_column->scale());
    if (res_null_flags.size() == res_values.size()) {
        ASSERT_TRUE(null_fags_res_column != nullptr);
        const auto end = res_const ? 0 : res_values.size();
        for (auto i = 0; i < end; i++) {
            if (res_null_flags[i] > 0) {
                ASSERT_EQ(res_null_flags[i], null_fags_res_column->get_data()[i]);
            } else {
                ASSERT_EQ(res_values[i], DecimalV3Cast::to_string<int128_t>(decimal_res_column->get_data()[i],
                                                                            return_type.precision, return_type.scale));
            }
        }
    } else {
        const auto end = res_const ? 0 : res_values.size();
        for (auto i = 0; i < end; i++) {
            ASSERT_EQ(res_values[i], DecimalV3Cast::to_string<int128_t>(decimal_res_column->get_data()[i],
                                                                        return_type.precision, return_type.scale));
        }
    }
}

TEST_F(VecMathFunctionsTest, DecimalRoundTest) {
    testRoundDecimal<TYPE_ROUND>({""18450.76""}, {}, 10, 2, {0}, {}, {""18451""}, {});
    testRoundDecimal<TYPE_ROUND>({""0.1""}, {}, 10, 1, {0}, {}, {""0""}, {});
    testRoundDecimal<TYPE_ROUND>({""0.499""}, {}, 10, 3, {0}, {}, {""0""}, {});
    testRoundDecimal<TYPE_ROUND>({""0.5""}, {}, 10, 1, {0}, {}, {""1""}, {});
    testRoundDecimal<TYPE_ROUND>({""0.50""}, {}, 10, 2, {0}, {}, {""1""}, {});
    testRoundDecimal<TYPE_ROUND>({""-0.1""}, {}, 10, 1, {0}, {}, {""0""}, {});
    testRoundDecimal<TYPE_ROUND>({""-0.5""}, {}, 10, 1, {0}, {}, {""-1""}, {});
    testRoundDecimal<TYPE_ROUND>({""-0.50""}, {}, 10, 2, {0}, {}, {""-1""}, {});
    testRoundDecimal<TYPE_ROUND>({""-0.91""}, {}, 10, 2, {0}, {}, {""-1""}, {});
}

TEST_F(VecMathFunctionsTest, DecimalRoundNullTest) {
    testRoundDecimal<TYPE_ROUND>({""INVALID""}, {1}, 10, 2, {0}, {}, {""INVALID""}, {1});

    testRoundDecimal<TYPE_ROUND>({""INVALID"", ""INVALID""}, {1, 1}, 10, 2, {0, 0}, {}, {""INVALID"", ""INVALID""}, {1, 1});
}

TEST_F(VecMathFunctionsTest, DecimalRoundUpToTest) {
    testRoundDecimal<TYPE_ROUND_UP_TO>({""18450.76""}, {}, 10, 2, {-1}, {}, {""18451""}, {});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""18450.76""}, {}, 10, 2, {0}, {}, {""18451""}, {});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""18450.76""}, {}, 10, 2, {1}, {}, {""18450.8""}, {});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""18450.76""}, {}, 10, 2, {2}, {}, {""18450.76""}, {});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""18450.76""}, {}, 10, 2, {5}, {}, {""18450.76000""}, {});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""0.1""}, {}, 10, 2, {38}, {}, {""0.10000000000000000000000000000000000000""}, {});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""0.1""}, {}, 10, 2, {1000}, {}, {""0.10000000000000000000000000000000000000""},
                                       {});

    testRoundDecimal<TYPE_ROUND_UP_TO>({""12345.67899"", ""12345.67899"", ""12345.67899"", ""12345.67899"", ""12345.67899""}, {},
                                       15, 5, {2, 2, 2, 2, 2}, {},
                                       {""12345.68"", ""12345.68"", ""12345.68"", ""12345.68"", ""12345.68""}, {});
}

TEST_F(VecMathFunctionsTest, DecimalRoundUpToNullTest) {
    testRoundDecimal<TYPE_ROUND_UP_TO>({""18450.76""}, {}, 10, 2, {0}, {1}, {""INVALID""}, {1});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""INVALID""}, {1}, 10, 2, {2}, {}, {""INVALID""}, {1});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""INVALID""}, {1}, 10, 2, {0}, {1}, {""INVALID""}, {1});

    testRoundDecimal<TYPE_ROUND_UP_TO>({""18450.76"", ""18450.76""}, {}, 10, 2, {0, 0}, {1, 1}, {""INVALID"", ""INVALID""},
                                       {1, 1});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""INVALID"", ""INVALID""}, {1, 1}, 10, 2, {2, 2}, {}, {""INVALID"", ""INVALID""},
                                       {1, 1});
    testRoundDecimal<TYPE_ROUND_UP_TO>({""INVALID"", ""INVALID""}, {1, 1}, 10, 2, {0, 0}, {1, 1}, {""INVALID"", ""INVALID""},
                                       {1, 1});
}

TEST_F(VecMathFunctionsTest, DecimalRoundUpToByColTest) {
    testRoundDecimal<TYPE_ROUND_UP_TO>(
            {""123.45678"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678""}, {}, 15, 5,
            {0, 1, 2, 3, 4, 5, 6}, {},
            {""123"", ""123.50000"", ""123.46000"", ""123.45700"", ""123.45680"", ""123.45678"", ""123.45678""}, {});
    testRoundDecimal<TYPE_ROUND_UP_TO>(
            {""123.45678"", ""INVALID"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678""},
            {0, 1, 0, 0, 0, 0, 0}, 15, 5, {0, 1, 2, 3, 4, 5, 6}, {0, 0, 0, 0, 0, 0, 1},
            {""123"", ""INVALID"", ""123.46000"", ""123.45700"", ""123.45680"", ""123.45678"", ""INVALID""}, {0, 1, 0, 0, 0, 0, 1});
}

TEST_F(VecMathFunctionsTest, DecimalTruncateTest) {
    testRoundDecimal<TYPE_TRUNCATE>({""18450.76""}, {}, 10, 2, {-1}, {}, {""18450""}, {});
    testRoundDecimal<TYPE_TRUNCATE>({""18450.76""}, {}, 10, 2, {0}, {}, {""18450""}, {});
    testRoundDecimal<TYPE_TRUNCATE>({""18450.76""}, {}, 10, 2, {1}, {}, {""18450.7""}, {});
    testRoundDecimal<TYPE_TRUNCATE>({""18450.76""}, {}, 10, 2, {2}, {}, {""18450.76""}, {});
    testRoundDecimal<TYPE_TRUNCATE>({""18450.76""}, {}, 10, 2, {5}, {}, {""18450.76000""}, {});
    testRoundDecimal<TYPE_TRUNCATE>({""0.1""}, {}, 10, 2, {38}, {}, {""0.10000000000000000000000000000000000000""}, {});
    testRoundDecimal<TYPE_TRUNCATE>({""0.1""}, {}, 10, 2, {1000}, {}, {""0.10000000000000000000000000000000000000""}, {});

    testRoundDecimal<TYPE_TRUNCATE>({""12345.67899"", ""12345.67899"", ""12345.67899"", ""12345.67899"", ""12345.67899""}, {}, 15,
                                    5, {2, 2, 2, 2, 2}, {},
                                    {""12345.67"", ""12345.67"", ""12345.67"", ""12345.67"", ""12345.67""}, {});
}

TEST_F(VecMathFunctionsTest, DecimalTruncateNullTest) {
    testRoundDecimal<TYPE_TRUNCATE>({""18450.76""}, {}, 10, 2, {0}, {1}, {""INVALID""}, {1});
    testRoundDecimal<TYPE_TRUNCATE>({""INVALID""}, {1}, 10, 2, {2}, {}, {""INVALID""}, {1});
    testRoundDecimal<TYPE_TRUNCATE>({""INVALID""}, {1}, 10, 2, {0}, {1}, {""INVALID""}, {1});

    testRoundDecimal<TYPE_TRUNCATE>({""18450.76"", ""18450.76""}, {}, 10, 2, {0, 0}, {1, 1}, {""INVALID"", ""INVALID""},
                                    {1, 1});
    testRoundDecimal<TYPE_TRUNCATE>({""INVALID"", ""INVALID""}, {1, 1}, 10, 2, {2, 2}, {}, {""INVALID"", ""INVALID""}, {1, 1});
    testRoundDecimal<TYPE_TRUNCATE>({""INVALID"", ""INVALID""}, {1, 1}, 10, 2, {0, 0}, {1, 1}, {""INVALID"", ""INVALID""},
                                    {1, 1});
}

TEST_F(VecMathFunctionsTest, DecimalTruncateByColTest) {
    testRoundDecimal<TYPE_TRUNCATE>(
            {""123.45678"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678""}, {}, 15, 5,
            {0, 1, 2, 3, 4, 5, 6}, {},
            {""123"", ""123.40000"", ""123.45000"", ""123.45600"", ""123.45670"", ""123.45678"", ""123.45678""}, {});
    testRoundDecimal<TYPE_TRUNCATE>(
            {""123.45678"", ""INVALID"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678"", ""123.45678""},
            {0, 1, 0, 0, 0, 0, 0}, 15, 5, {0, 1, 2, 3, 4, 5, 6}, {0, 0, 0, 0, 0, 0, 1},
            {""123"", ""INVALID"", ""123.45000"", ""123.45600"", ""123.45670"", ""123.45678"", ""INVALID""}, {0, 1, 0, 0, 0, 0, 1});
    // truncate(v,d), v is const column
    testRoundDecimal<TYPE_TRUNCATE>({""12345.6789"", ""12345.6789"", ""12345.6789"", ""12345.6789""}, {}, 15, 5, {1, 2, 3, 4},
                                    {}, {""12345.60000"", ""12345.67000"", ""12345.67800"", ""12345.67890""}, {});
}

TEST_F(VecMathFunctionsTest, RoundUpToTest) {
    {
        Columns columns;

        auto tc1 = DoubleColumn::create();
        auto tc2 = Int32Column::create();

        double dous[] = {2341.2341111, 4999.90134, 2144.2855, 934.12439};
        int ints[] = {2, 3, 1, 4};

        double res[] = {2341.23, 4999.901, 2144.3, 934.1244};

        for (int i = 0; i < sizeof(dous) / sizeof(dous[0]); ++i) {
            tc1->append(dous[i]);
            tc2->append(ints[i]);
        }

        columns.emplace_back(tc1);
        columns.emplace_back(tc2);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::round_up_to(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_DOUBLE>(result);

        for (int i = 0; i < sizeof(res) / sizeof(res[0]); ++i) {
            ASSERT_EQ(res[i], v->get_data()[i]);
        }
    }
}

TEST_F(VecMathFunctionsTest, BinTest) {
    {
        Columns columns;

        auto tc1 = Int64Column::create();

        int64_t ints[] = {1, 2, 256};

        std::string res[] = {""1"", ""10"", ""100000000""};

        for (int i = 0; i < sizeof(ints) / sizeof(ints[0]); ++i) {
            tc1->append(ints[i]);
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::bin(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_VARCHAR>(result);

        for (int i = 0; i < sizeof(res) / sizeof(res[0]); ++i) {
            ASSERT_EQ(res[i], v->get_data()[i].to_string());
        }
    }
}

TEST_F(VecMathFunctionsTest, LeastDecimalTest) {
    Columns columns;

    auto tc1 = DecimalColumn::create();
    {
        std::string str[] = {""3333333333.2222222222"", ""-740740740.716049""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc1->append(dec_values[i]);
        }
    }

    auto tc2 = DecimalColumn::create();
    {
        std::string str[] = {""2342.111"", ""9866.9011""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc2->append(dec_values[i]);
        }
    }

    columns.emplace_back(tc1);
    columns.emplace_back(tc2);

    std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
    ColumnPtr result = MathFunctions::template least<TYPE_DECIMALV2>(ctx.get(), columns);

    auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(result);

    std::string result_str[] = {""2342.111"", ""-740740740.716049""};
    DecimalV2Value results[sizeof(result_str) / sizeof(result_str[0])];
    for (int i = 0; i < sizeof(result_str) / sizeof(result_str[0]); ++i) {
        results[i] = DecimalV2Value(result_str[i]);
    }

    for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
        ASSERT_EQ(results[i], v->get_data()[i]);
    }
}

TEST_F(VecMathFunctionsTest, GreatestDecimalTest) {
    Columns columns;

    auto tc1 = DecimalColumn::create();
    {
        std::string str[] = {""3333333333.2222222222"", ""-740740740.716049""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc1->append(dec_values[i]);
        }
    }

    auto tc2 = DecimalColumn::create();
    {
        std::string str[] = {""2342.111"", ""9866.9011""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc2->append(dec_values[i]);
        }
    }

    columns.emplace_back(tc1);
    columns.emplace_back(tc2);

    std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
    ColumnPtr result = MathFunctions::template greatest<TYPE_DECIMALV2>(ctx.get(), columns);

    auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(result);

    std::string result_str[] = {""3333333333.2222222222"", ""9866.9011""};
    DecimalV2Value results[sizeof(result_str) / sizeof(result_str[0])];
    for (int i = 0; i < sizeof(result_str) / sizeof(result_str[0]); ++i) {
        results[i] = DecimalV2Value(result_str[i]);
    }

    for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
        ASSERT_EQ(results[i], v->get_data()[i]);
    }
}

TEST_F(VecMathFunctionsTest, PositiveDecimalTest) {
    Columns columns;

    auto tc1 = DecimalColumn::create();
    {
        std::string str[] = {""-3333333333.2222222222"", ""-740740740.716049""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc1->append(dec_values[i]);
        }
    }

    columns.emplace_back(tc1);

    std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
    ColumnPtr result = MathFunctions::template positive<TYPE_DECIMALV2>(ctx.get(), columns);

    auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(result);

    std::string result_str[] = {""-3333333333.2222222222"", ""-740740740.716049""};
    DecimalV2Value results[sizeof(result_str) / sizeof(result_str[0])];
    for (int i = 0; i < sizeof(result_str) / sizeof(result_str[0]); ++i) {
        results[i] = DecimalV2Value(result_str[i]);
    }

    for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
        ASSERT_EQ(results[i], v->get_data()[i]);
    }
}

TEST_F(VecMathFunctionsTest, NegativeDecimalTest) {
    Columns columns;

    auto tc1 = DecimalColumn::create();
    {
        std::string str[] = {""3333333333.2222222222"", ""740740740.716049""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc1->append(dec_values[i]);
        }
    }

    columns.emplace_back(tc1);

    std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
    ColumnPtr result = MathFunctions::template negative<TYPE_DECIMALV2>(ctx.get(), columns);

    auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(result);

    std::string result_str[] = {""-3333333333.2222222222"", ""-740740740.716049""};
    DecimalV2Value results[sizeof(result_str) / sizeof(result_str[0])];
    for (int i = 0; i < sizeof(result_str) / sizeof(result_str[0]); ++i) {
        results[i] = DecimalV2Value(result_str[i]);
    }

    for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
        ASSERT_EQ(results[i], v->get_data()[i]);
    }
}

TEST_F(VecMathFunctionsTest, ModDecimalGeneralTest) {
    Columns columns;

    auto tc1 = DecimalColumn::create();
    {
        std::string str[] = {""3333333333.3222222222"", ""2342414342.132"", ""32413241.12342"", ""999234812.222""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc1->append(dec_values[i]);
        }
    }

    auto tc2 = DecimalColumn::create();
    {
        std::string str[] = {""4"", ""3"", ""0"", ""1""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc2->append(dec_values[i]);
        }
    }

    columns.emplace_back(tc1);
    columns.emplace_back(tc2);

    std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
    ColumnPtr result = MathFunctions::template mod<TYPE_DECIMALV2>(ctx.get(), columns);

    //auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(result);
    auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(ColumnHelper::as_raw_column<NullableColumn>(result)->data_column());

    std::string str[] = {""1.3222222222"", ""2.132"", ""0.12342"", ""0.222""};
    DecimalV2Value results[sizeof(str) / sizeof(str[0])];
    for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
        results[i] = DecimalV2Value(str[i]);
    }

    for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
        ASSERT_EQ(results[i], v->get_data()[i]);
    }
}

TEST_F(VecMathFunctionsTest, ModDecimalBigTest) {
    Columns columns;

    auto tc1 = DecimalColumn::create();
    {
        std::string str[] = {
                ""333333099873333.322222222"", ""23112133142414342.132"", ""413241.12342"", ""999234812.222"", ""68482.48227"",
                ""2413424287348.24221""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc1->append(dec_values[i]);
        }
    }

    auto tc2 = DecimalColumn::create();
    {
        std::string str[] = {""4535.3452"", ""7.34535"", ""2.91"", ""71.234"", ""34241.24114"", ""777982341.234234""};
        DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
        for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
            dec_values[i] = DecimalV2Value(str[i]);
        }
        for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
            tc2->append(dec_values[i]);
        }
    }

    columns.emplace_back(tc1);
    columns.emplace_back(tc2);

    std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
    ColumnPtr result = MathFunctions::template mod<TYPE_DECIMALV2>(ctx.get(), columns);

    //auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(result);
    auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(ColumnHelper::as_raw_column<NullableColumn>(result)->data_column());

    std::string str[] = {""163.573422222"", ""4.4786"", ""0.75342"", ""19.69"", ""34241.24113"", ""123064839.648342""};
    DecimalV2Value results[sizeof(str) / sizeof(str[0])];
    for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
        results[i] = DecimalV2Value(str[i]);
    }

    for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
        ASSERT_EQ(results[i], v->get_data()[i]);
    }
}

TEST_F(VecMathFunctionsTest, Conv_intTest) {
    {
        Columns columns;

        auto tc1 = Int64Column::create();
        auto tc2 = Int8Column::create();
        auto tc3 = Int8Column::create();

        int64_t bigints[] = {1,           2,           35,          10,         10,         10,         10,
                             3,           3,           99999999,    99999999,   99999999,   99999999,   -99999999,
                             -99999999,   -99999999,   -99999999,   4294967296, 4294967296, 4294967296, 4294967296,
                             -4294967296, -4294967296, -4294967296, -4294967296};
        int8_t baseints[] = {10,  10,  10, 2,  2,   -2,  -2, -2, -2,  -16, -16, 16, 16,
                             -16, -16, 16, 16, -16, -16, 16, 16, -16, -16, -16, -16};
        int8_t destints[] = {10, 16,  36, 10,  -10, 10,  -10, 10,  10, 10,  -10, 10, -10,
                             10, -10, 10, -10, 10,  -10, 10,  -10, 10, -10, 10,  -10};

        std::string results[] = {""1"",
                                 ""2"",
                                 ""Z"",
                                 ""2"",
                                 ""2"",
                                 ""2"",
                                 ""2"",
                                 ""0"",
                                 ""0"",
                                 ""2576980377"",
                                 ""2576980377"",
                                 ""2576980377"",
                                 ""2576980377"",
                                 ""18446744071132571239"",
                                 ""-2576980377"",
                                 ""18446744071132571239"",
                                 ""-2576980377"",
                                 ""285960729238"",
                                 ""285960729238"",
                                 ""285960729238"",
                                 ""285960729238"",
                                 ""18446743787748822378"",
                                 ""-285960729238"",
                                 ""18446743787748822378"",
                                 ""-285960729238""};

        for (int i = 0; i < sizeof(bigints) / sizeof(bigints[0]); ++i) {
            tc1->append(bigints[i]);
            tc2->append(baseints[i]);
            tc3->append(destints[i]);
        }

        columns.emplace_back(tc1);
        columns.emplace_back(tc2);
        columns.emplace_back(tc3);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::conv_int(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_VARCHAR>(result);

        for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i].to_string());
        }
    }
}

TEST_F(VecMathFunctionsTest, Conv_stringTest) {
    {
        Columns columns;

        auto tc1 = BinaryColumn::create();
        auto tc2 = Int8Column::create();
        auto tc3 = Int8Column::create();

        std::string bigints[] = {""1"",
                                 ""2"",
                                 ""35"",
                                 ""1000"",
                                 ""103"",
                                 ""114"",
                                 ""18446744073709551617"",
                                 ""10"",
                                 ""10"",
                                 ""10"",
                                 ""10"",
                                 ""-9223372036854775808"",
                                 ""-9223372036854775808"",
                                 ""-9223372036854775808"",
                                 ""-9223372036854775808"",
                                 ""9223372036854775808"",
                                 ""9223372036854775808"",
                                 ""9223372036854775808"",
                                 ""9223372036854775808"",
                                 ""-9223372036854775809"",
                                 ""-9223372036854775809"",
                                 ""-9223372036854775809"",
                                 ""-9223372036854775809"",
                                 ""18446744073709551616"",
                                 ""18446744073709551616"",
                                 ""18446744073709551616"",
                                 ""18446744073709551616"",
                                 ""-18446744073709551616"",
                                 ""-18446744073709551616"",
                                 ""-18446744073709551616"",
                                 ""-18446744073709551616"",
                                 ""de0b6b3a7640000"",
                                 ""8ac7230489e80000"",
                                 ""a""};
        int8_t baseints[] = {10, 10, 10,  8,   35, 35, 10,  -2,  -2, 2,  2,   -10, -10, 10, 10, -10, -10,
                             10, 10, -10, -10, 10, 10, -10, -10, 10, 10, -10, -10, 10,  10, 16, 16,  10};
        int8_t destints[] = {10, 16,  36, 10,  10, 10,  10, 10,  -10, 10,  -10, 10,  -10, 10,  -10, 10, -10,
                             10, -10, 10, -10, 10, -10, 10, -10, 10,  -10, 10,  -10, 10,  -10, 10,  10, 10};

        std::string results[] = {""1"",
                                 ""2"",
                                 ""Z"",
                                 ""512"",
                                 ""1228"",
                                 ""1264"",
                                 ""18446744073709551615"",
                                 ""2"",
                                 ""2"",
                                 ""2"",
                                 ""2"",
                                 ""9223372036854775808"",
                                 ""-9223372036854775808"",
                                 ""9223372036854775808"",
                                 ""-9223372036854775808"",
                                 ""9223372036854775807"",
                                 ""9223372036854775807"",
                                 ""9223372036854775808"",
                                 ""-9223372036854775808"",
                                 ""9223372036854775808"",
                                 ""-9223372036854775808"",
                                 ""9223372036854775807"",
                                 ""9223372036854775807"",
                                 ""9223372036854775807"",
                                 ""9223372036854775807"",
                                 ""18446744073709551615"",
                                 ""-1"",
                                 ""9223372036854775808"",
                                 ""-9223372036854775808"",
                                 ""0"",
                                 ""0"",
                                 ""1000000000000000000"",
                                 ""10000000000000000000"",
                                 ""0""};

        for (int i = 0; i < sizeof(bigints) / sizeof(bigints[0]); ++i) {
            tc1->append(bigints[i]);
            tc2->append(baseints[i]);
            tc3->append(destints[i]);
        }

        columns.emplace_back(tc1);
        columns.emplace_back(tc2);
        columns.emplace_back(tc3);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::conv_string(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_VARCHAR>(result);

        for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i].to_string());
        }
    }
}

TEST_F(VecMathFunctionsTest, LnTest) {
    {
        Columns columns;

        auto tc1 = DoubleColumn::create();
        tc1->append(0);
        tc1->append(2.0);
        tc1->append(-1);
        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result_log10 = MathFunctions::log10(ctx.get(), columns);
        ColumnPtr result_ln = MathFunctions::ln(ctx.get(), columns);

        ASSERT_EQ(true, result_log10->is_null(0));
        ASSERT_EQ(std::log10(2), result_log10->get(1).get_double());
        ASSERT_EQ(true, result_log10->is_null(2));

        ASSERT_EQ(true, result_ln->is_null(0));
        ASSERT_EQ(std::log(2), result_ln->get(1).get_double());
        ASSERT_EQ(true, result_ln->is_null(2));
    }
}

TEST_F(VecMathFunctionsTest, ExpTest) {
    {
        Columns columns;

        auto tc1 = DoubleColumn::create();
        tc1->append(0);
        tc1->append(2.0);
        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result_exp = MathFunctions::exp(ctx.get(), columns);

        ASSERT_EQ(false, result_exp->is_null(0));
        ASSERT_EQ(std::exp(0), result_exp->get(0).get_double());
        ASSERT_EQ(std::exp(2), result_exp->get(1).get_double());
    }
}

TEST_F(VecMathFunctionsTest, ExpOverflowTest) {
    {
        Columns columns;

        auto tc1 = DoubleColumn::create();
        tc1->append(2.47498282E8);
        tc1->append(2.47498282E3);
        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result_exp = MathFunctions::exp(ctx.get(), columns);

        ASSERT_EQ(true, result_exp->is_null(0));
        ASSERT_EQ(true, result_exp->is_null(1));
    }
}

TEST_F(VecMathFunctionsTest, squareTest) {
    {
        Columns columns;

        auto tc1 = DoubleColumn::create();
        tc1->append(0);
        tc1->append(2.0);
        tc1->append(-1);
        tc1->append(std::nan(""not a double number""));
        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result_square = MathFunctions::square(ctx.get(), columns);

        ASSERT_EQ(0, result_square->get(0).get_double());
        ASSERT_EQ(4, result_square->get(1).get_double());
        ASSERT_EQ(1, result_square->get(2).get_double());
        ASSERT_EQ(true, result_square->is_null(3));
    }
}

TEST_F(VecMathFunctionsTest, AbsTest) {
    {
        Columns columns;

        auto tc1 = Int8Column::create();
        int8_t inputs[] = {10, 10, 10, 8, -35, 35, -128};
        int16_t results[] = {10, 10, 10, 8, 35, 35, 128};

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            tc1->append(inputs[i]);
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::abs_tinyint(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_SMALLINT>(result);

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i]);
        }
    }

    {
        Columns columns;

        auto tc1 = Int16Column::create();
        int16_t inputs[] = {1000, 1000, 1000, -500, -35, 35, -32768};
        int32_t results[] = {1000, 1000, 1000, 500, 35, 35, 32768};

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            tc1->append(inputs[i]);
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::abs_smallint(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_INT>(result);

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i]);
        }
    }

    {
        Columns columns;

        auto tc1 = Int32Column::create();
        int32_t inputs[] = {23424242, -1111188324, 909877, -4353525, -39879711, 35, -2147483648};
        int64_t results[] = {23424242, 1111188324, 909877, 4353525, 39879711, 35, 2147483648};

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            tc1->append(inputs[i]);
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::abs_int(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_BIGINT>(result);

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i]);
        }
    }

    {
        Columns columns;

        auto tc1 = Int64Column::create();
        int64_t inputs[] = {2342423422442, -11111883200004,         90987700000, -435352241435, -398797110000,
                            3523411,       -9223372036854775807 - 1};
        int128_t results[] = {2342423422442, 11111883200004, 90987700000,         435352241435,
                              398797110000,  3523411,        9223372036854775808U};

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            tc1->append(inputs[i]);
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::abs_bigint(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_LARGEINT>(result);

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i]);
        }
    }

    {
        Columns columns;

        auto tc1 = Int128Column::create();
        int128_t inputs[] = {2342423422442, -1111188320000004,   -90987700000241,
                             -435352241435, -390241238797110000, -3523411};
        int128_t results[] = {2342423422442, 1111188320000004,   90987700000241,
                              435352241435,  390241238797110000, 3523411};

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            tc1->append(inputs[i]);
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::abs_largeint(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_LARGEINT>(result);

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i]);
        }
    }

    {
        Columns columns;

        auto tc1 = DoubleColumn::create();
        double inputs[] = {23424222.124, -34123412.24311, -23412487.1111, -97241.8761, -2349723, -3523411};
        double results[] = {23424222.124, 34123412.24311, 23412487.1111, 97241.8761, 2349723, 3523411};

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            tc1->append(inputs[i]);
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::abs_double(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_DOUBLE>(result);

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i]);
        }
    }

    {
        Columns columns;

        auto tc1 = FloatColumn::create();
        float inputs[] = {23424222.124, -34123412.24311, -23412487.1111, -97241.8761, -2349723, -3523411};
        float results[] = {23424222.124, 34123412.24311, 23412487.1111, 97241.8761, 2349723, 3523411};

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            tc1->append(inputs[i]);
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::abs_float(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_FLOAT>(result);

        for (int i = 0; i < sizeof(inputs) / sizeof(inputs[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i]);
        }
    }

    {
        Columns columns;

        auto tc1 = DecimalColumn::create();
        {
            std::string str[] = {""3333333333.2222222222"", ""-740740740.716049""};
            DecimalV2Value dec_values[sizeof(str) / sizeof(str[0])];
            for (int i = 0; i < sizeof(str) / sizeof(str[0]); ++i) {
                dec_values[i] = DecimalV2Value(str[i]);
            }
            for (int i = 0; i < sizeof(dec_values) / sizeof(dec_values[0]); ++i) {
                tc1->append(dec_values[i]);
            }
        }

        columns.emplace_back(tc1);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::abs_decimalv2val(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_DECIMALV2>(result);

        std::string result_str[] = {""3333333333.2222222222"", ""740740740.716049""};
        DecimalV2Value results[sizeof(result_str) / sizeof(result_str[0])];
        for (int i = 0; i < sizeof(result_str) / sizeof(result_str[0]); ++i) {
            results[i] = DecimalV2Value(result_str[i]);
        }

        for (int i = 0; i < sizeof(results) / sizeof(results[0]); ++i) {
            ASSERT_EQ(results[i], v->get_data()[i]);
        }
    }
}

TEST_F(VecMathFunctionsTest, CotTest) {
    {
        Columns columns;
        auto tc1 = DoubleColumn::create();
        tc1->append(0);
        tc1->append(0.1);
        tc1->append(0.2);
        tc1->append(0.3);
        columns.emplace_back(tc1);

        Columns columns2;
        auto tc2 = DoubleColumn::create();
        tc2->append(0);
        tc2->append(0.1);
        tc2->append(0.2);
        tc2->append(0.3);
        columns2.emplace_back(tc2);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::cot(ctx.get(), columns);
        ColumnPtr result2 = MathFunctions::tan(ctx.get(), columns2);

        auto nullable = ColumnHelper::as_raw_column<NullableColumn>(result);
        auto v = ColumnHelper::cast_to<TYPE_DOUBLE>(nullable->data_column());
        auto v2 = ColumnHelper::cast_to<TYPE_DOUBLE>(result2);

        ASSERT_TRUE(nullable->is_null(0));
        for (int i = 1; i < 4; ++i) {
            LOG(INFO) << ""v->get_data()[i]: "" << v->get_data()[i] << "" v2->get_data()[i]: "" << v2->get_data()[i];
            ASSERT_TRUE((1 - v->get_data()[i] * v2->get_data()[i]) < 0.1);
        }
    }
}

TEST_F(VecMathFunctionsTest, Atan2Test) {
    {
        Columns columns;
        auto tc1 = DoubleColumn::create();
        tc1->append(0.1);
        tc1->append(0.2);
        tc1->append(0.3);
        columns.emplace_back(tc1);

        auto tc2 = DoubleColumn::create();
        tc2->append(0.1);
        tc2->append(0.2);
        tc2->append(0.3);
        columns.emplace_back(tc2);

        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::atan2(ctx.get(), columns);

        auto v = ColumnHelper::cast_to<TYPE_DOUBLE>(result);

        for (int i = 0; i < 3; ++i) {
            ASSERT_TRUE((v->get_data()[i] - (PI / 4)) < 0.1);
        }
    }
}

TEST_F(VecMathFunctionsTest, OutputNanTest) {
    Columns columns;
    auto tc1 = DoubleColumn::create();
    tc1->append(-10);
    tc1->append(1.0);
    tc1->append(std::nan(""not a double number""));
    columns.emplace_back(tc1);

    {
        std::vector<bool> null_expect = {true, false, true};
        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::acos(ctx.get(), columns);
        auto nullable = ColumnHelper::as_raw_column<NullableColumn>(result);
        ASSERT_EQ(nullable->size(), null_expect.size());
        for (size_t i = 0; i < nullable->size(); i++) {
            ASSERT_EQ(nullable->is_null(i), null_expect[i]);
        }
    }

    {
        std::vector<bool> null_expect = {false, false, true};
        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::sin(ctx.get(), columns);
        auto nullable = ColumnHelper::as_raw_column<NullableColumn>(result);
        ASSERT_EQ(nullable->size(), null_expect.size());
        for (size_t i = 0; i < nullable->size(); i++) {
            ASSERT_EQ(nullable->is_null(i), null_expect[i]);
        }
    }

    {
        std::vector<bool> null_expect = {true, false, true};
        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::asin(ctx.get(), columns);
        auto nullable = ColumnHelper::as_raw_column<NullableColumn>(result);
        ASSERT_EQ(nullable->size(), null_expect.size());
        for (size_t i = 0; i < nullable->size(); i++) {
            ASSERT_EQ(nullable->is_null(i), null_expect[i]);
        }
    }

    {
        std::vector<bool> null_expect = {true, false, true};
        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::log2(ctx.get(), columns);
        auto nullable = ColumnHelper::as_raw_column<NullableColumn>(result);
        ASSERT_EQ(nullable->size(), null_expect.size());
        for (size_t i = 0; i < nullable->size(); i++) {
            ASSERT_EQ(nullable->is_null(i), null_expect[i]);
        }
    }

    {
        Columns binary_columns;
        auto tc1 = DoubleColumn::create();
        tc1->append(-0.9);
        tc1->append(0.2);
        tc1->append(0.3);
        binary_columns.emplace_back(tc1);

        auto tc2 = DoubleColumn::create();
        tc2->append(0.8);
        tc2->append(0.2);
        tc2->append(0.3);
        binary_columns.emplace_back(tc2);

        std::vector<bool> null_expect = {true, false, false};
        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::pow(ctx.get(), binary_columns);
        auto nullable = ColumnHelper::as_raw_column<NullableColumn>(result);
        ASSERT_EQ(nullable->size(), null_expect.size());
        for (size_t i = 0; i < nullable->size(); i++) {
            ASSERT_EQ(nullable->is_null(i), null_expect[i]);
        }
    }

    {
        Columns binary_columns;
        auto tc1 = DoubleColumn::create();
        tc1->append(std::nan(""not a double number""));
        tc1->append(0.2);
        tc1->append(0.3);
        binary_columns.emplace_back(tc1);

        auto tc2 = DoubleColumn::create();
        tc2->append(0.8);
        tc2->append(0.2);
        tc2->append(0.3);
        binary_columns.emplace_back(tc2);

        std::vector<bool> null_expect = {true, false, false};
        std::unique_ptr<FunctionContext> ctx(FunctionContext::create_test_context());
        ColumnPtr result = MathFunctions::atan2(ctx.get(), binary_columns);
        auto nullable = ColumnHelper::as_raw_column<NullableColumn>(result);
        ASSERT_EQ(nullable->size(), null_expect.size());
        for (size_t i = 0; i < nullable->size(); i++) {
            ASSERT_EQ(nullable->is_null(i), null_expect[i]);
        }
    }
}

} // namespace vectorized
} // namespace starrocks
",16224,True,3442.6916425757986,median
"/*
Copyright (c) 2010-2016, Mathieu Labbe - IntRoLab - Universite de Sherbrooke
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the Universite de Sherbrooke nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ""AS IS"" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/



#include <rtabmap/core/RegistrationVis.h>
#include <rtabmap/core/util3d_motion_estimation.h>
#include <rtabmap/core/util3d_features.h>
#include <rtabmap/core/util3d.h>
#include <rtabmap/core/VWDictionary.h>
#include <rtabmap/core/util2d.h>
#include <rtabmap/core/Features2d.h>
#include <rtabmap/core/VisualWord.h>
#include <rtabmap/core/Optimizer.h>
#include <rtabmap/core/util3d_transforms.h>
#include <rtabmap/utilite/ULogger.h>
#include <rtabmap/utilite/UConversion.h>
#include <rtabmap/utilite/UStl.h>
#include <rtabmap/utilite/UTimer.h>
#include <rtabmap/utilite/UMath.h>

#include <rtflann/flann.hpp>

namespace rtabmap {

RegistrationVis::RegistrationVis(const ParametersMap & parameters, Registration * child) :
		Registration(parameters, child),
		_minInliers(Parameters::defaultVisMinInliers()),
		_inlierDistance(Parameters::defaultVisInlierDistance()),
		_iterations(Parameters::defaultVisIterations()),
		_refineIterations(Parameters::defaultVisRefineIterations()),
		_epipolarGeometryVar(Parameters::defaultVisEpipolarGeometryVar()),
		_estimationType(Parameters::defaultVisEstimationType()),
		_forwardEstimateOnly(Parameters::defaultVisForwardEstOnly()),
		_PnPReprojError(Parameters::defaultVisPnPReprojError()),
		_PnPFlags(Parameters::defaultVisPnPFlags()),
		_PnPRefineIterations(Parameters::defaultVisPnPRefineIterations()),
		_correspondencesApproach(Parameters::defaultVisCorType()),
		_flowWinSize(Parameters::defaultVisCorFlowWinSize()),
		_flowIterations(Parameters::defaultVisCorFlowIterations()),
		_flowEps(Parameters::defaultVisCorFlowEps()),
		_flowMaxLevel(Parameters::defaultVisCorFlowMaxLevel()),
		_nndr(Parameters::defaultVisCorNNDR()),
		_guessWinSize(Parameters::defaultVisCorGuessWinSize()),
		_bundleAdjustment(Parameters::defaultVisBundleAdjustment())
{
	_featureParameters = Parameters::getDefaultParameters();
	uInsert(_featureParameters, ParametersPair(Parameters::kKpNNStrategy(), _featureParameters.at(Parameters::kVisCorNNType())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpNndrRatio(), _featureParameters.at(Parameters::kVisCorNNDR())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpDetectorStrategy(), _featureParameters.at(Parameters::kVisFeatureType())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpMaxFeatures(), _featureParameters.at(Parameters::kVisMaxFeatures())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpMaxDepth(), _featureParameters.at(Parameters::kVisMaxDepth())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpMinDepth(), _featureParameters.at(Parameters::kVisMinDepth())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpRoiRatios(), _featureParameters.at(Parameters::kVisRoiRatios())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpSubPixEps(), _featureParameters.at(Parameters::kVisSubPixWinSize())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpSubPixIterations(), _featureParameters.at(Parameters::kVisSubPixIterations())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpSubPixWinSize(), _featureParameters.at(Parameters::kVisSubPixEps())));
	uInsert(_featureParameters, ParametersPair(Parameters::kKpNewWordsComparedTogether(), ""false""));

	this->parseParameters(parameters);
}

void RegistrationVis::parseParameters(const ParametersMap & parameters)
{
	Registration::parseParameters(parameters);

	Parameters::parse(parameters, Parameters::kVisMinInliers(), _minInliers);
	Parameters::parse(parameters, Parameters::kVisInlierDistance(), _inlierDistance);
	Parameters::parse(parameters, Parameters::kVisIterations(), _iterations);
	Parameters::parse(parameters, Parameters::kVisRefineIterations(), _refineIterations);
	Parameters::parse(parameters, Parameters::kVisEstimationType(), _estimationType);
	Parameters::parse(parameters, Parameters::kVisForwardEstOnly(), _forwardEstimateOnly);
	Parameters::parse(parameters, Parameters::kVisEpipolarGeometryVar(), _epipolarGeometryVar);
	Parameters::parse(parameters, Parameters::kVisPnPReprojError(), _PnPReprojError);
	Parameters::parse(parameters, Parameters::kVisPnPFlags(), _PnPFlags);
	Parameters::parse(parameters, Parameters::kVisPnPRefineIterations(), _PnPRefineIterations);
	Parameters::parse(parameters, Parameters::kVisCorType(), _correspondencesApproach);
	Parameters::parse(parameters, Parameters::kVisCorFlowWinSize(), _flowWinSize);
	Parameters::parse(parameters, Parameters::kVisCorFlowIterations(), _flowIterations);
	Parameters::parse(parameters, Parameters::kVisCorFlowEps(), _flowEps);
	Parameters::parse(parameters, Parameters::kVisCorFlowMaxLevel(), _flowMaxLevel);
	Parameters::parse(parameters, Parameters::kVisCorNNDR(), _nndr);
	Parameters::parse(parameters, Parameters::kVisCorGuessWinSize(), _guessWinSize);
	Parameters::parse(parameters, Parameters::kVisBundleAdjustment(), _bundleAdjustment);
	uInsert(_bundleParameters, parameters);

	UASSERT_MSG(_minInliers >= 1, uFormat(""value=%d"", _minInliers).c_str());
	UASSERT_MSG(_inlierDistance > 0.0f, uFormat(""value=%f"", _inlierDistance).c_str());
	UASSERT_MSG(_iterations > 0, uFormat(""value=%d"", _iterations).c_str());

	// override feature parameters
	for(ParametersMap::const_iterator iter=parameters.begin(); iter!=parameters.end(); ++iter)
	{
		std::string group = uSplit(iter->first, '/').front();
		if(Parameters::isFeatureParameter(iter->first) || group.compare(""Stereo"") == 0)
		{
			uInsert(_featureParameters, ParametersPair(iter->first, iter->second));
		}
	}

	if(uContains(parameters, Parameters::kVisCorNNType()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpNNStrategy(), parameters.at(Parameters::kVisCorNNType())));
	}
	if(uContains(parameters, Parameters::kVisCorNNDR()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpNndrRatio(), parameters.at(Parameters::kVisCorNNDR())));
	}
	if(uContains(parameters, Parameters::kVisFeatureType()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpDetectorStrategy(), parameters.at(Parameters::kVisFeatureType())));
	}
	if(uContains(parameters, Parameters::kVisMaxFeatures()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpMaxFeatures(), parameters.at(Parameters::kVisMaxFeatures())));
	}
	if(uContains(parameters, Parameters::kVisMaxDepth()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpMaxDepth(), parameters.at(Parameters::kVisMaxDepth())));
	}
	if(uContains(parameters, Parameters::kVisMinDepth()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpMinDepth(), parameters.at(Parameters::kVisMinDepth())));
	}
	if(uContains(parameters, Parameters::kVisRoiRatios()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpRoiRatios(), parameters.at(Parameters::kVisRoiRatios())));
	}
	if(uContains(parameters, Parameters::kVisSubPixEps()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpSubPixEps(), parameters.at(Parameters::kVisSubPixEps())));
	}
	if(uContains(parameters, Parameters::kVisSubPixIterations()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpSubPixIterations(), parameters.at(Parameters::kVisSubPixIterations())));
	}
	if(uContains(parameters, Parameters::kVisSubPixWinSize()))
	{
		uInsert(_featureParameters, ParametersPair(Parameters::kKpSubPixWinSize(), parameters.at(Parameters::kVisSubPixWinSize())));
	}
}

RegistrationVis::~RegistrationVis()
{
}

Feature2D * RegistrationVis::createFeatureDetector() const
{
	return Feature2D::create(_featureParameters);
}

Transform RegistrationVis::computeTransformationImpl(
			Signature & fromSignature,
			Signature & toSignature,
			Transform guess, // (flowMaxLevel is set to 0 when guess is used)
			RegistrationInfo & info) const
{
	UDEBUG(""%s=%d"", Parameters::kVisMinInliers().c_str(), _minInliers);
	UDEBUG(""%s=%f"", Parameters::kVisInlierDistance().c_str(), _inlierDistance);
	UDEBUG(""%s=%d"", Parameters::kVisIterations().c_str(), _iterations);
	UDEBUG(""%s=%d"", Parameters::kVisEstimationType().c_str(), _estimationType);
	UDEBUG(""%s=%d"", Parameters::kVisForwardEstOnly().c_str(), _forwardEstimateOnly);
	UDEBUG(""%s=%f"", Parameters::kVisEpipolarGeometryVar().c_str(), _epipolarGeometryVar);
	UDEBUG(""%s=%f"", Parameters::kVisPnPReprojError().c_str(), _PnPReprojError);
	UDEBUG(""%s=%d"", Parameters::kVisPnPFlags().c_str(), _PnPFlags);
	UDEBUG(""%s=%d"", Parameters::kVisCorType().c_str(), _correspondencesApproach);
	UDEBUG(""%s=%d"", Parameters::kVisCorFlowWinSize().c_str(), _flowWinSize);
	UDEBUG(""%s=%d"", Parameters::kVisCorFlowIterations().c_str(), _flowIterations);
	UDEBUG(""%s=%f"", Parameters::kVisCorFlowEps().c_str(), _flowEps);
	UDEBUG(""%s=%d"", Parameters::kVisCorFlowMaxLevel().c_str(), _flowMaxLevel);
	UDEBUG(""guess=%s"", guess.prettyPrint().c_str());

	UDEBUG(""Input(%d): from=%d words, %d 3D words, %d words descriptors,  %d kpts, %d kpts3D, %d descriptors, image=%dx%d"",
			fromSignature.id(),
			(int)fromSignature.getWords().size(),
			(int)fromSignature.getWords3().size(),
			(int)fromSignature.getWordsDescriptors().size(),
			(int)fromSignature.sensorData().keypoints().size(),
			(int)fromSignature.sensorData().keypoints3D().size(),
			fromSignature.sensorData().descriptors().rows,
			fromSignature.sensorData().imageRaw().cols,
			fromSignature.sensorData().imageRaw().rows);

	UDEBUG(""Input(%d): to=%d words, %d 3D words, %d words descriptors, %d kpts, %d kpts3D, %d descriptors, image=%dx%d"",
			toSignature.id(),
			(int)toSignature.getWords().size(),
			(int)toSignature.getWords3().size(),
			(int)toSignature.getWordsDescriptors().size(),
			(int)toSignature.sensorData().keypoints().size(),
			(int)toSignature.sensorData().keypoints3D().size(),
			toSignature.sensorData().descriptors().rows,
			toSignature.sensorData().imageRaw().cols,
			toSignature.sensorData().imageRaw().rows);

	std::string msg;

	////////////////////
	// Find correspondences
	////////////////////
	//recompute correspondences if descriptors are provided
	if((fromSignature.getWordsDescriptors().empty() && toSignature.getWordsDescriptors().empty()) &&
	   (_estimationType<2 || fromSignature.getWords().size()) && // required only for 2D->2D
	   (_estimationType==0 || toSignature.getWords().size()) && // required only for 3D->2D or 2D->2D
	   fromSignature.getWords3().size() && // required in all estimation approaches
	   (_estimationType==1 || toSignature.getWords3().size())) // required only for 3D->3D and 2D->2D
	{
		// no need to extract new features, we have all the data we need
		UDEBUG("""");
	}
	else
	{
		UDEBUG("""");
		// just some checks to make sure that input data are ok
		UASSERT(fromSignature.getWords().empty() ||
				fromSignature.getWords3().empty() ||
				(fromSignature.getWords().size() == fromSignature.getWords3().size()));
		UASSERT((int)fromSignature.sensorData().keypoints().size() == fromSignature.sensorData().descriptors().rows ||
				fromSignature.getWords().size() == fromSignature.getWordsDescriptors().size() ||
				fromSignature.sensorData().descriptors().rows == 0 ||
				fromSignature.getWordsDescriptors().size() == 0);
		UASSERT((toSignature.getWords().empty() && toSignature.getWords3().empty())||
				(toSignature.getWords().size() && toSignature.getWords3().empty())||
				(toSignature.getWords().size() == toSignature.getWords3().size()));
		UASSERT((int)toSignature.sensorData().keypoints().size() == toSignature.sensorData().descriptors().rows ||
				toSignature.getWords().size() == toSignature.getWordsDescriptors().size() ||
				toSignature.sensorData().descriptors().rows == 0 ||
				toSignature.getWordsDescriptors().size() == 0);
		UASSERT(fromSignature.sensorData().imageRaw().empty() ||
				fromSignature.sensorData().imageRaw().type() == CV_8UC1 ||
				fromSignature.sensorData().imageRaw().type() == CV_8UC3);
		UASSERT(toSignature.sensorData().imageRaw().empty() ||
				toSignature.sensorData().imageRaw().type() == CV_8UC1 ||
				toSignature.sensorData().imageRaw().type() == CV_8UC3);

		Feature2D * detector = createFeatureDetector();
		std::vector<cv::KeyPoint> kptsFrom;
		cv::Mat imageFrom = fromSignature.sensorData().imageRaw();
		cv::Mat imageTo = toSignature.sensorData().imageRaw();

		std::vector<int> orignalWordsFromIds;
		if(fromSignature.getWords().empty())
		{
			if(fromSignature.sensorData().keypoints().empty())
			{
				if(!imageFrom.empty())
				{
					if(imageFrom.channels() > 1)
					{
						cv::Mat tmp;
						cv::cvtColor(imageFrom, tmp, cv::COLOR_BGR2GRAY);
						imageFrom = tmp;
					}

					cv::Mat depthMask;
					if(!fromSignature.sensorData().depthRaw().empty())
					{
						if(imageFrom.rows % fromSignature.sensorData().depthRaw().rows == 0 &&
						   imageFrom.cols % fromSignature.sensorData().depthRaw().cols == 0 &&
						   imageFrom.rows/fromSignature.sensorData().depthRaw().rows == fromSignature.sensorData().imageRaw().cols/fromSignature.sensorData().depthRaw().cols)
						{
							depthMask = util2d::interpolate(fromSignature.sensorData().depthRaw(), fromSignature.sensorData().imageRaw().rows/fromSignature.sensorData().depthRaw().rows, 0.1f);
						}
					}

					kptsFrom = detector->generateKeypoints(
							imageFrom,
							depthMask);
				}
			}
			else
			{
				kptsFrom = fromSignature.sensorData().keypoints();
			}
		}
		else
		{
			kptsFrom.resize(fromSignature.getWords().size());
			orignalWordsFromIds.resize(fromSignature.getWords().size());
			int i=0;
			bool allUniques = true;
			for(std::multimap<int, cv::KeyPoint>::const_iterator iter=fromSignature.getWords().begin(); iter!=fromSignature.getWords().end(); ++iter)
			{
				kptsFrom[i] = iter->second;
				orignalWordsFromIds[i] = iter->first;
				if(i>0 && iter->first==orignalWordsFromIds[i-1])
				{
					allUniques = false;
				}
				++i;
			}
			if(!allUniques)
			{
				UDEBUG(""IDs are not unique, IDs will be regenerated!"");
				orignalWordsFromIds.clear();
			}
		}

		std::multimap<int, cv::KeyPoint> wordsFrom;
		std::multimap<int, cv::KeyPoint> wordsTo;
		std::multimap<int, cv::Point3f> words3From;
		std::multimap<int, cv::Point3f> words3To;
		std::multimap<int, cv::Mat> wordsDescFrom;
		std::multimap<int, cv::Mat> wordsDescTo;
		if(_correspondencesApproach == 1 && //Optical Flow
		   !imageFrom.empty() &&
		   !imageTo.empty())
		{
			UDEBUG("""");
			// convert to grayscale
			if(imageFrom.channels() > 1)
			{
				cv::Mat tmp;
				cv::cvtColor(imageFrom, tmp, cv::COLOR_BGR2GRAY);
				imageFrom = tmp;
			}
			if(imageTo.channels() > 1)
			{
				cv::Mat tmp;
				cv::cvtColor(imageTo, tmp, cv::COLOR_BGR2GRAY);
				imageTo = tmp;
			}

			std::vector<cv::Point3f> kptsFrom3D;
			if(kptsFrom.size() == fromSignature.getWords3().size())
			{
				kptsFrom3D = uValues(fromSignature.getWords3());
			}
			else if(kptsFrom.size() == fromSignature.sensorData().keypoints3D().size())
			{
				kptsFrom3D = fromSignature.sensorData().keypoints3D();
			}
			else
			{
				kptsFrom3D = detector->generateKeypoints3D(fromSignature.sensorData(), kptsFrom);
			}

			if(!imageTo.empty())
			{
				std::vector<cv::Point2f> cornersFrom;
				cv::KeyPoint::convert(kptsFrom, cornersFrom);
				std::vector<cv::Point2f> cornersTo;
				bool guessSet = !guess.isIdentity() && !guess.isNull();
				if(guessSet)
				{
					Transform localTransform = fromSignature.sensorData().cameraModels().size()?fromSignature.sensorData().cameraModels()[0].localTransform():fromSignature.sensorData().stereoCameraModel().left().localTransform();
					Transform guessCameraRef = (guess * localTransform).inverse();
					cv::Mat R = (cv::Mat_<double>(3,3) <<
							(double)guessCameraRef.r11(), (double)guessCameraRef.r12(), (double)guessCameraRef.r13(),
							(double)guessCameraRef.r21(), (double)guessCameraRef.r22(), (double)guessCameraRef.r23(),
							(double)guessCameraRef.r31(), (double)guessCameraRef.r32(), (double)guessCameraRef.r33());
					cv::Mat rvec(1,3, CV_64FC1);
					cv::Rodrigues(R, rvec);
					cv::Mat tvec = (cv::Mat_<double>(1,3) << (double)guessCameraRef.x(), (double)guessCameraRef.y(), (double)guessCameraRef.z());
					cv::Mat K = fromSignature.sensorData().cameraModels().size()?fromSignature.sensorData().cameraModels()[0].K():fromSignature.sensorData().stereoCameraModel().left().K();
					cv::projectPoints(kptsFrom3D, rvec, tvec, K, cv::Mat(), cornersTo);
				}

				// Find features in the new left image
				UDEBUG(""guessSet = %d"", guessSet?1:0);
				std::vector<unsigned char> status;
				std::vector<float> err;
				UDEBUG(""cv::calcOpticalFlowPyrLK() begin"");
				cv::calcOpticalFlowPyrLK(
						imageFrom,
						imageTo,
						cornersFrom,
						cornersTo,
						status,
						err,
						cv::Size(_flowWinSize, _flowWinSize),
						guessSet?0:_flowMaxLevel,
						cv::TermCriteria(cv::TermCriteria::COUNT+cv::TermCriteria::EPS, _flowIterations, _flowEps),
						cv::OPTFLOW_LK_GET_MIN_EIGENVALS | (guessSet?cv::OPTFLOW_USE_INITIAL_FLOW:0), 1e-4);
				UDEBUG(""cv::calcOpticalFlowPyrLK() end"");

				UASSERT(kptsFrom.size() == kptsFrom3D.size());
				std::vector<cv::KeyPoint> kptsTo(kptsFrom.size());
				std::vector<cv::Point3f> kptsFrom3DKept(kptsFrom3D.size());
				std::vector<int> orignalWordsFromIdsCpy = orignalWordsFromIds;
				int ki = 0;
				for(unsigned int i=0; i<status.size(); ++i)
				{
					if(status[i] &&
					   uIsInBounds(cornersTo[i].x, 0.0f, float(imageTo.cols)) &&
					   uIsInBounds(cornersTo[i].y, 0.0f, float(imageTo.rows)))
					{
						if(orignalWordsFromIdsCpy.size())
						{
							orignalWordsFromIds[ki] = orignalWordsFromIdsCpy[i];
						}
						kptsFrom[ki] = cv::KeyPoint(cornersFrom[i], 1);
						kptsFrom3DKept[ki] = kptsFrom3D[i];
						kptsTo[ki++] = cv::KeyPoint(cornersTo[i], 1);
					}
				}
				if(orignalWordsFromIds.size())
				{
					orignalWordsFromIds.resize(ki);
				}
				kptsFrom.resize(ki);
				kptsTo.resize(ki);
				kptsFrom3DKept.resize(ki);
				kptsFrom3D = kptsFrom3DKept;

				std::vector<cv::Point3f> kptsTo3D;
				if(_estimationType == 0 || (_estimationType == 1 && !varianceFromInliersCount()) || !_forwardEstimateOnly)
				{
					kptsTo3D = detector->generateKeypoints3D(toSignature.sensorData(), kptsTo);
				}

				UASSERT(kptsFrom.size() == kptsFrom3DKept.size());
				UASSERT(kptsFrom.size() == kptsTo.size());
				UASSERT(kptsTo3D.size() == 0 || kptsTo.size() == kptsTo3D.size());
				for(unsigned int i=0; i< kptsFrom3DKept.size(); ++i)
				{
					int id = orignalWordsFromIds.size()?orignalWordsFromIds[i]:i;
					wordsFrom.insert(std::make_pair(id, kptsFrom[i]));
					words3From.insert(std::make_pair(id, kptsFrom3DKept[i]));
					wordsTo.insert(std::make_pair(id, kptsTo[i]));
					if(kptsTo3D.size())
					{
						words3To.insert(std::make_pair(id, kptsTo3D[i]));
					}
				}
				toSignature.sensorData().setFeatures(kptsTo, kptsTo3D, cv::Mat());
			}
			else
			{
				UASSERT(kptsFrom.size() == kptsFrom3D.size());
				for(unsigned int i=0; i< kptsFrom3D.size(); ++i)
				{
					if(util3d::isFinite(kptsFrom3D[i]))
					{
						int id = orignalWordsFromIds.size()?orignalWordsFromIds[i]:i;
						wordsFrom.insert(std::make_pair(id, kptsFrom[i]));
						words3From.insert(std::make_pair(id, kptsFrom3D[i]));
					}
				}
				toSignature.sensorData().setFeatures(std::vector<cv::KeyPoint>(), std::vector<cv::Point3f>(), cv::Mat());
			}

			fromSignature.sensorData().setFeatures(kptsFrom, kptsFrom3D, cv::Mat());
		}
		else // Features Matching
		{
			UDEBUG("""");
			std::vector<cv::KeyPoint> kptsTo;
			if(toSignature.getWords().empty())
			{
				if(toSignature.sensorData().keypoints().empty() &&
				   !imageTo.empty())
				{
					if(imageTo.channels() > 1)
					{
						cv::Mat tmp;
						cv::cvtColor(imageTo, tmp, cv::COLOR_BGR2GRAY);
						imageTo = tmp;
					}

					cv::Mat depthMask;
					if(!toSignature.sensorData().depthRaw().empty())
					{
						if(imageTo.rows % toSignature.sensorData().depthRaw().rows == 0 &&
						   imageTo.cols % toSignature.sensorData().depthRaw().cols == 0 &&
						   imageTo.rows/toSignature.sensorData().depthRaw().rows == imageTo.cols/toSignature.sensorData().depthRaw().cols)
						{
							depthMask = util2d::interpolate(toSignature.sensorData().depthRaw(), imageTo.rows/toSignature.sensorData().depthRaw().rows, 0.1f);
						}
					}

					kptsTo = detector->generateKeypoints(
							imageTo,
							depthMask);
				}
				else
				{
					kptsTo = toSignature.sensorData().keypoints();
				}
			}
			else
			{
				kptsTo = uValues(toSignature.getWords());
			}

			// extract descriptors
			UDEBUG(""kptsFrom=%d"", (int)kptsFrom.size());
			UDEBUG(""kptsTo=%d"", (int)kptsTo.size());
			cv::Mat descriptorsFrom;
			if(fromSignature.getWordsDescriptors().size() &&
					((kptsFrom.empty() && fromSignature.getWordsDescriptors().size()) ||
					 fromSignature.getWordsDescriptors().size() == kptsFrom.size()))
			{
				descriptorsFrom = cv::Mat(fromSignature.getWordsDescriptors().size(),
						fromSignature.getWordsDescriptors().begin()->second.cols,
						fromSignature.getWordsDescriptors().begin()->second.type());
				int i=0;
				for(std::multimap<int, cv::Mat>::const_iterator iter=fromSignature.getWordsDescriptors().begin();
					iter!=fromSignature.getWordsDescriptors().end();
					++iter, ++i)
				{
					iter->second.copyTo(descriptorsFrom.row(i));
				}
			}
			else if(fromSignature.sensorData().descriptors().rows == (int)kptsFrom.size())
			{
				descriptorsFrom = fromSignature.sensorData().descriptors();
			}
			else if(!imageFrom.empty())
			{
				if(imageFrom.channels() > 1)
				{
					cv::Mat tmp;
					cv::cvtColor(imageFrom, tmp, cv::COLOR_BGR2GRAY);
					imageFrom = tmp;
				}
				orignalWordsFromIds.clear();
				descriptorsFrom = detector->generateDescriptors(imageFrom, kptsFrom);
			}

			cv::Mat descriptorsTo;
			if(kptsTo.size())
			{
				if(toSignature.getWordsDescriptors().size() == kptsTo.size())
				{
					descriptorsTo = cv::Mat(toSignature.getWordsDescriptors().size(),
							toSignature.getWordsDescriptors().begin()->second.cols,
							toSignature.getWordsDescriptors().begin()->second.type());
					int i=0;
					for(std::multimap<int, cv::Mat>::const_iterator iter=toSignature.getWordsDescriptors().begin();
						iter!=toSignature.getWordsDescriptors().end();
						++iter, ++i)
					{
						iter->second.copyTo(descriptorsTo.row(i));
					}
				}
				else if(toSignature.sensorData().descriptors().rows == (int)kptsTo.size())
				{
					descriptorsTo = toSignature.sensorData().descriptors();
				}
				else if(!imageTo.empty())
				{
					if(imageTo.channels() > 1)
					{
						cv::Mat tmp;
						cv::cvtColor(imageTo, tmp, cv::COLOR_BGR2GRAY);
						imageTo = tmp;
					}

					descriptorsTo = detector->generateDescriptors(imageTo, kptsTo);
				}
			}

			// create 3D keypoints
			std::vector<cv::Point3f> kptsFrom3D;
			std::vector<cv::Point3f> kptsTo3D;
			if(kptsFrom.size() == fromSignature.getWords3().size())
			{
				kptsFrom3D = uValues(fromSignature.getWords3());
			}
			else if(kptsFrom.size() == fromSignature.sensorData().keypoints3D().size())
			{
				kptsFrom3D = fromSignature.sensorData().keypoints3D();
			}
			else
			{
				if(fromSignature.getWords3().size() && kptsFrom.size() != fromSignature.getWords3().size())
				{
					UWARN(""kptsFrom (%d) is not the same size as fromSignature.getWords3() (%d), there ""
						   ""is maybe a problem with the logic above (getWords3() should be null or equal to kptsfrom)."",
						   kptsFrom.size(),
						   fromSignature.getWords3().size());
				}
				else if(fromSignature.sensorData().keypoints3D().size() && kptsFrom.size() != fromSignature.sensorData().keypoints3D().size())
				{
					UWARN(""kptsFrom (%d) is not the same size as fromSignature.sensorData().keypoints3D() (%d), there ""
						   ""is maybe a problem with the logic above (keypoints3D() should be null or equal to kptsfrom)."",
						   kptsFrom.size(),
						   fromSignature.sensorData().keypoints3D().size());
				}
				kptsFrom3D = detector->generateKeypoints3D(fromSignature.sensorData(), kptsFrom);
				UDEBUG(""generated kptsFrom3D=%d"", (int)kptsFrom3D.size());
				if(detector->getMinDepth() > 0.0f || detector->getMaxDepth() > 0.0f)
				{
					//remove all keypoints/descriptors with no valid 3D points
					UASSERT((int)kptsFrom.size() == descriptorsFrom.rows &&
							kptsFrom3D.size() == kptsFrom.size());
					std::vector<cv::KeyPoint> validKeypoints(kptsFrom.size());
					std::vector<cv::Point3f> validKeypoints3D(kptsFrom.size());
					cv::Mat validDescriptors(descriptorsFrom.size(), descriptorsFrom.type());
					std::vector<int> validKeypointsIds;
					if(orignalWordsFromIds.size())
					{
						validKeypointsIds.resize(kptsFrom.size());
					}

					int oi=0;
					for(unsigned int i=0; i<kptsFrom3D.size(); ++i)
					{
						if(util3d::isFinite(kptsFrom3D[i]))
						{
							validKeypoints[oi] = kptsFrom[i];
							validKeypoints3D[oi] = kptsFrom3D[i];
							if(orignalWordsFromIds.size())
							{
								validKeypointsIds[oi] = orignalWordsFromIds[i];
							}
							descriptorsFrom.row(i).copyTo(validDescriptors.row(oi));
							++oi;
						}
					}
					UDEBUG(""Removed %d invalid 3D points"", (int)kptsFrom3D.size()-oi);
					validKeypoints.resize(oi);
					validKeypoints3D.resize(oi);
					kptsFrom = validKeypoints;
					kptsFrom3D = validKeypoints3D;
					
					if(orignalWordsFromIds.size())
					{
					validKeypointsIds.resize(oi);
						orignalWordsFromIds = validKeypointsIds;
					}
					descriptorsFrom = validDescriptors.rowRange(0, oi).clone();
				}
			}

			if(kptsTo.size() == toSignature.getWords3().size())
			{
				kptsTo3D = uValues(toSignature.getWords3());
			}
			else if(kptsTo.size() == toSignature.sensorData().keypoints3D().size())
			{
				kptsTo3D = toSignature.sensorData().keypoints3D();
			}
			else
			{
				if(toSignature.getWords3().size() && kptsTo.size() != toSignature.getWords3().size())
				{
					UWARN(""kptsTo (%d) is not the same size as toSignature.getWords3() (%d), there ""
						   ""is maybe a problem with the logic above (getWords3() should be null or equal to kptsTo)."",
						   (int)kptsTo.size(),
						   (int)toSignature.getWords3().size());
				}
				else if(toSignature.sensorData().keypoints3D().size() && kptsTo.size() != toSignature.sensorData().keypoints3D().size())
				{
					UWARN(""kptsTo (%d) is not the same size as toSignature.sensorData().keypoints3D() (%d), there ""
						   ""is maybe a problem with the logic above (keypoints3D() should be null or equal to kptsTo)."",
						   (int)kptsTo.size(),
						   (int)toSignature.sensorData().keypoints3D().size());
				}
				kptsTo3D = detector->generateKeypoints3D(toSignature.sensorData(), kptsTo);
				if(kptsTo3D.size() && (detector->getMinDepth() > 0.0f || detector->getMaxDepth() > 0.0f))
				{
					UDEBUG("""");
					//remove all keypoints/descriptors with no valid 3D points
					UASSERT((int)kptsTo.size() == descriptorsTo.rows &&
							kptsTo3D.size() == kptsTo.size());
					std::vector<cv::KeyPoint> validKeypoints(kptsTo.size());
					std::vector<cv::Point3f> validKeypoints3D(kptsTo.size());
					cv::Mat validDescriptors(descriptorsTo.size(), descriptorsTo.type());

					int oi=0;
					for(unsigned int i=0; i<kptsTo3D.size(); ++i)
					{
						if(util3d::isFinite(kptsTo3D[i]))
						{
							validKeypoints[oi] = kptsTo[i];
							validKeypoints3D[oi] = kptsTo3D[i];
							descriptorsTo.row(i).copyTo(validDescriptors.row(oi));
							++oi;
						}
					}
					UDEBUG(""Removed %d invalid 3D points"", (int)kptsTo3D.size()-oi);
					validKeypoints.resize(oi);
					validKeypoints3D.resize(oi);
					kptsTo = validKeypoints;
					kptsTo3D = validKeypoints3D;
					descriptorsTo = validDescriptors.rowRange(0, oi).clone();
				}
			}

			UASSERT(kptsFrom.empty() || descriptorsFrom.rows == 0 || int(kptsFrom.size()) == descriptorsFrom.rows);

			fromSignature.sensorData().setFeatures(kptsFrom, kptsFrom3D, descriptorsFrom);
			toSignature.sensorData().setFeatures(kptsTo, kptsTo3D, descriptorsTo);

			UDEBUG(""descriptorsFrom=%d"", descriptorsFrom.rows);
			UDEBUG(""descriptorsTo=%d"", descriptorsTo.rows);

			// We have all data we need here, so match!
			if(descriptorsFrom.rows > 0 && descriptorsTo.rows > 0)
			{
				cv::Size imageSize = imageTo.size();
				bool isCalibrated = false; // multiple cameras not supported.
				if(imageSize.height == 0 || imageSize.width == 0)
				{
					imageSize = toSignature.sensorData().cameraModels().size() == 1?toSignature.sensorData().cameraModels()[0].imageSize():toSignature.sensorData().stereoCameraModel().left().imageSize();
				}
				isCalibrated = imageSize.height != 0 && imageSize.width != 0 && toSignature.sensorData().cameraModels().size()==1?toSignature.sensorData().cameraModels()[0].isValidForProjection():toSignature.sensorData().stereoCameraModel().isValidForProjection();

				// If guess is set, limit the search of matches using optical flow window size
				bool guessSet = !guess.isIdentity() && !guess.isNull();
				if(guessSet && _guessWinSize > 0 && kptsFrom3D.size() &&
						isCalibrated) // needed for projection
				{
					UDEBUG("""");
					UASSERT((int)kptsTo.size() == descriptorsTo.rows);
					UASSERT((int)kptsFrom3D.size() == descriptorsFrom.rows);

					// Use guess to project 3D ""from"" keypoints into ""to"" image
					if(toSignature.sensorData().cameraModels().size() > 1)
					{
						UFATAL(""Guess reprojection feature matching is not supported for multiple cameras."");
					}

					Transform localTransform = toSignature.sensorData().cameraModels().size()?toSignature.sensorData().cameraModels()[0].localTransform():toSignature.sensorData().stereoCameraModel().left().localTransform();
					Transform guessCameraRef = (guess * localTransform).inverse();
					cv::Mat R = (cv::Mat_<double>(3,3) <<
							(double)guessCameraRef.r11(), (double)guessCameraRef.r12(), (double)guessCameraRef.r13(),
							(double)guessCameraRef.r21(), (double)guessCameraRef.r22(), (double)guessCameraRef.r23(),
							(double)guessCameraRef.r31(), (double)guessCameraRef.r32(), (double)guessCameraRef.r33());
					cv::Mat rvec(1,3, CV_64FC1);
					cv::Rodrigues(R, rvec);
					cv::Mat tvec = (cv::Mat_<double>(1,3) << (double)guessCameraRef.x(), (double)guessCameraRef.y(), (double)guessCameraRef.z());
					cv::Mat K = toSignature.sensorData().cameraModels().size()?toSignature.sensorData().cameraModels()[0].K():toSignature.sensorData().stereoCameraModel().left().K();
					std::vector<cv::Point2f> projected;
					cv::projectPoints(kptsFrom3D, rvec, tvec, K, cv::Mat(), projected);

					//remove projected points outside of the image
					UASSERT((int)projected.size() == descriptorsFrom.rows);
					std::vector<cv::Point2f> cornersProjected(projected.size());
					std::vector<int> projectedIndexToDescIndex(projected.size());
					int oi=0;
					Transform guessInv = guess.inverse();
					for(unsigned int i=0; i<projected.size(); ++i)
					{
						if(uIsInBounds(projected[i].x, 0.0f, float(imageSize.width-1)) &&
						   uIsInBounds(projected[i].y, 0.0f, float(imageSize.height-1)) &&
						   util3d::transformPoint(kptsFrom3D[i], guessInv).x > 0.0)
						{
							projectedIndexToDescIndex[oi] = i;
							cornersProjected[oi++] = projected[i];
						}
					}
					projectedIndexToDescIndex.resize(oi);
					cornersProjected.resize(oi);



					UDEBUG(""cornersProjected=%d"", (int)cornersProjected.size());

					// For each projected feature guess of ""from"" in ""to"", find its matching feature in
					// the radius around the projected guess.
					// TODO: do cross-check?
					if(cornersProjected.size())
					{

						// Create kd-tree for projected keypoints
						rtflann::Matrix<float> cornersProjectedMat((float*)cornersProjected.data(), cornersProjected.size(), 2);
						rtflann::Index<rtflann::L2_Simple<float> > index(cornersProjectedMat, rtflann::KDTreeIndexParams());
						index.buildIndex();

						std::vector< std::vector<size_t> > indices;
						std::vector<std::vector<float> > dists;
						float radius = (float)_guessWinSize; // pixels
						std::vector<cv::Point2f> pointsTo;
						cv::KeyPoint::convert(kptsTo, pointsTo);
						rtflann::Matrix<float> pointsToMat((float*)pointsTo.data(), pointsTo.size(), 2);
						index.radiusSearch(pointsToMat, indices, dists, radius*radius, rtflann::SearchParams());

						UASSERT(indices.size() == pointsToMat.rows);
						UASSERT(descriptorsFrom.cols == descriptorsTo.cols);
						UASSERT(descriptorsFrom.rows == (int)kptsFrom.size());
						UASSERT((int)pointsToMat.rows == descriptorsTo.rows);
						UASSERT(pointsToMat.rows == kptsTo.size());
						UDEBUG(""radius search done for guess"");

						// Process results (Nearest Neighbor Distance Ratio)
						int newToId = orignalWordsFromIds.size()?orignalWordsFromIds.back():descriptorsFrom.rows;
						std::map<int,int> addedWordsFrom; //<id, index>
						std::map<int, int> duplicates; //<fromId, toId>
						int newWords = 0;
						for(unsigned int i = 0; i < pointsToMat.rows; ++i)
						{
							if(kptsTo3D.empty() || util3d::isFinite(kptsTo3D[i]))
							{
								int octave = kptsTo[i].octave;
								int matchedIndex = -1;
								if(indices[i].size() >= 2)
								{
									cv::Mat descriptors;
									std::vector<int> descriptorsIndices(indices[i].size());
									int oi=0;
									for(unsigned int j=0; j<indices[i].size(); ++j)
									{
										if(kptsFrom.at(projectedIndexToDescIndex[indices[i].at(j)]).octave==octave)
										{
											descriptors.push_back(descriptorsFrom.row(projectedIndexToDescIndex[indices[i].at(j)]));
											descriptorsIndices[oi++] = indices[i].at(j);
										}
									}
									descriptorsIndices.resize(oi);
									if(oi >=2)
									{
										std::vector<std::vector<cv::DMatch> > matches;
										cv::BFMatcher matcher(descriptors.type()==CV_8U?cv::NORM_HAMMING:cv::NORM_L2SQR);
										matcher.knnMatch(descriptorsTo.row(i), descriptors, matches, 2);
										UASSERT(matches.size() == 1);
										UASSERT(matches[0].size() == 2);
										if(matches[0].at(0).distance < _nndr * matches[0].at(1).distance)
										{
											matchedIndex = descriptorsIndices.at(matches[0].at(0).trainIdx);
										}
									}
									else if(oi == 1)
									{
										matchedIndex = descriptorsIndices[0];
									}
								}
								else if(indices[i].size() == 1 &&
									    kptsFrom.at(projectedIndexToDescIndex[indices[i].at(0)]).octave == octave)
								{
									matchedIndex = indices[i].at(0);
								}

								if(matchedIndex >= 0)
								{
									matchedIndex = projectedIndexToDescIndex[matchedIndex];
									int id = orignalWordsFromIds.size()?orignalWordsFromIds[matchedIndex]:matchedIndex;

									if(addedWordsFrom.find(matchedIndex) != addedWordsFrom.end())
									{
										id = addedWordsFrom.at(matchedIndex);
										duplicates.insert(std::make_pair(matchedIndex, id));
									}
									else
									{
										addedWordsFrom.insert(std::make_pair(matchedIndex, id));

										if(kptsFrom.size())
										{
											wordsFrom.insert(std::make_pair(id, kptsFrom[matchedIndex]));
										}
										words3From.insert(std::make_pair(id, kptsFrom3D[matchedIndex]));
										wordsDescFrom.insert(std::make_pair(id, descriptorsFrom.row(matchedIndex)));
									}

									wordsTo.insert(std::make_pair(id, kptsTo[i]));
									wordsDescTo.insert(std::make_pair(id, descriptorsTo.row(i)));
									if(kptsTo3D.size())
									{
										words3To.insert(std::make_pair(id, kptsTo3D[i]));
									}
								}
								else
								{
									// gen fake ids
									wordsTo.insert(std::make_pair(newToId, kptsTo[i]));
									wordsDescTo.insert(std::make_pair(newToId, descriptorsTo.row(i)));
									if(kptsTo3D.size())
									{
										words3To.insert(std::make_pair(newToId, kptsTo3D[i]));
									}

									++newToId;
									++newWords;
								}
							}
						}

						UDEBUG(""addedWordsFrom=%d/%d (duplicates=%d, newWords=%d), kptsTo=%d, wordsTo=%d, words3From=%d"",
								(int)addedWordsFrom.size(), (int)cornersProjected.size(), (int)duplicates.size(), newWords,
								(int)kptsTo.size(), (int)wordsTo.size(), (int)words3From.size());

						// create fake ids for not matched words from ""from""
						int addWordsFromNotMatched = 0;
						for(unsigned int i=0; i<kptsFrom3D.size(); ++i)
						{
							if(util3d::isFinite(kptsFrom3D[i]) && addedWordsFrom.find(i) == addedWordsFrom.end())
							{
								int id = orignalWordsFromIds.size()?orignalWordsFromIds[i]:i;
								wordsFrom.insert(std::make_pair(id, kptsFrom[i]));
								wordsDescFrom.insert(std::make_pair(id, descriptorsFrom.row(i)));
								words3From.insert(std::make_pair(id, kptsFrom3D[i]));

								++addWordsFromNotMatched;
							}
						}
						UDEBUG(""addWordsFromNotMatched=%d -> words3From=%d"", addWordsFromNotMatched, (int)words3From.size());

						/*std::vector<cv::KeyPoint> matches(wordsTo.size());
						int oi=0;
						for(std::multimap<int, cv::KeyPoint>::iterator iter = wordsTo.begin(); iter!=wordsTo.end(); ++iter)
						{
							if(iter->first < (orignalWordsFromIds.size()?orignalWordsFromIds.back():descriptorsFrom.rows) && wordsTo.count(iter->first) <= 1)
							{
								matches[oi++] = iter->second;
							}
						}
						matches.resize(oi);
						UDEBUG(""guess=%s"", guess.prettyPrint().c_str());
						std::vector<cv::KeyPoint> projectedKpts;
						cv::KeyPoint::convert(cornersProjected, projectedKpts);
						cv::Mat image = toSignature.sensorData().imageRaw().clone();
						drawKeypoints(image, kptsTo, image, cv::Scalar(0,0,255));
						drawKeypoints(image, projectedKpts, image, cv::Scalar(0,255,255)); // BGR
						drawKeypoints(image, matches, image, cv::Scalar(0,255,0));
						cv::imwrite(""projected.bmp"", image);
						UWARN(""saved projected.bmp"");*/

					}
					else
					{
						UWARN(""All projected points are outside the camera. Guess (%s) is wrong or images are not overlapping."", guess.prettyPrint().c_str());
					}
					UDEBUG("""");
				}
				else
				{
					if(guessSet && _guessWinSize > 0 && kptsFrom3D.size() && !isCalibrated)
					{
						if(fromSignature.sensorData().cameraModels().size() > 1 || toSignature.sensorData().cameraModels().size() > 1)
						{
							UWARN(""Finding correspondences with the guess cannot ""
								  ""be done with multiple cameras, global matching is ""
								   ""done instead. Please set \\""%s\\"" to 0 to avoid this warning."",
								   Parameters::kVisCorGuessWinSize().c_str());
						}
						else
						{
							UWARN(""Calibration not found! Finding correspondences ""
								   ""with the guess cannot be done, global matching is ""
								   ""done instead."");
						}
					}

					UDEBUG("""");
					// match between all descriptors
					VWDictionary dictionary(_featureParameters);
					std::list<int> fromWordIds;
					for (int i = 0; i < descriptorsFrom.rows; ++i)
					{
						int id = orignalWordsFromIds.size() ? orignalWordsFromIds[i] : i;
						dictionary.addWord(new VisualWord(id, descriptorsFrom.row(i), 1));
						fromWordIds.push_back(id);
					}

					std::list<int> toWordIds;
					if(descriptorsTo.rows)
					{
						dictionary.update();
						toWordIds = dictionary.addNewWords(descriptorsTo, 2);
					}
					dictionary.clear(false);

					std::multiset<int> fromWordIdsSet(fromWordIds.begin(), fromWordIds.end());
					std::multiset<int> toWordIdsSet(toWordIds.begin(), toWordIds.end());

					UASSERT(kptsFrom3D.empty() || fromWordIds.size() == kptsFrom3D.size());
					UASSERT(int(fromWordIds.size()) == descriptorsFrom.rows);
					int i=0;
					for(std::list<int>::iterator iter=fromWordIds.begin(); iter!=fromWordIds.end(); ++iter)
					{
						if(fromWordIdsSet.count(*iter) == 1)
						{
							if (kptsFrom.size())
							{
								wordsFrom.insert(std::make_pair(*iter, kptsFrom[i]));
							}
							if(kptsFrom3D.size())
							{
								words3From.insert(std::make_pair(*iter, kptsFrom3D[i]));
							}
							wordsDescFrom.insert(std::make_pair(*iter, descriptorsFrom.row(i)));
						}
						++i;
					}
					UASSERT(kptsTo3D.size() == 0 || kptsTo3D.size() == kptsTo.size());
					UASSERT(toWordIds.size() == kptsTo.size());
					UASSERT(int(toWordIds.size()) == descriptorsTo.rows);
					i=0;
					for(std::list<int>::iterator iter=toWordIds.begin(); iter!=toWordIds.end(); ++iter)
					{
						if(toWordIdsSet.count(*iter) == 1)
						{
							wordsTo.insert(std::make_pair(*iter, kptsTo[i]));
							wordsDescTo.insert(std::make_pair(*iter, descriptorsTo.row(i)));
							if(kptsTo3D.size())
							{
								words3To.insert(std::make_pair(*iter, kptsTo3D[i]));
							}
						}
						++i;
					}
				}
			}
			else if(descriptorsFrom.rows)
			{
				//just create fake words
				UASSERT(kptsFrom3D.empty() || int(kptsFrom3D.size()) == descriptorsFrom.rows);
				for(int i=0; i<descriptorsFrom.rows; ++i)
				{
					wordsFrom.insert(std::make_pair(i, kptsFrom[i]));
					wordsDescFrom.insert(std::make_pair(i, descriptorsFrom.row(i)));
					if(kptsFrom3D.size())
					{
						words3From.insert(std::make_pair(i, kptsFrom3D[i]));
					}
				}
			}
		}
		fromSignature.setWords(wordsFrom);
		fromSignature.setWords3(words3From);
		fromSignature.setWordsDescriptors(wordsDescFrom);
		toSignature.setWords(wordsTo);
		toSignature.setWords3(words3To);
		toSignature.setWordsDescriptors(wordsDescTo);
		delete detector;
	}

	/////////////////////
	// Motion estimation
	/////////////////////
	Transform transform;
	cv::Mat covariance = cv::Mat::eye(6,6,CV_64FC1);
	int inliersCount = 0;
	int matchesCount = 0;
	if(toSignature.getWords().size())
	{
		Transform transforms[2];
		std::vector<int> inliers[2];
		std::vector<int> matches[2];
		cv::Mat covariances[2];
		covariances[0] = cv::Mat::eye(6,6,CV_64FC1);
		covariances[1] = cv::Mat::eye(6,6,CV_64FC1);
		for(int dir=0; dir<(!_forwardEstimateOnly?2:1); ++dir)
		{
			// A to B
			Signature * signatureA;
			Signature * signatureB;
			if(dir == 0)
			{
				signatureA = &fromSignature;
				signatureB = &toSignature;
			}
			else
			{
				signatureA = &toSignature;
				signatureB = &fromSignature;
			}
			if(_estimationType == 2) // Epipolar Geometry
			{
				UDEBUG("""");
				if(!signatureB->sensorData().stereoCameraModel().isValidForProjection() &&
				   (signatureB->sensorData().cameraModels().size() != 1 ||
					!signatureB->sensorData().cameraModels()[0].isValidForProjection()))
				{
					UERROR(""Calibrated camera required (multi-cameras not supported)."");
				}
				else if((int)signatureA->getWords().size() >= _minInliers &&
						(int)signatureB->getWords().size() >= _minInliers)
				{
					UASSERT(signatureA->sensorData().stereoCameraModel().isValidForProjection() || (signatureA->sensorData().cameraModels().size() == 1 && signatureA->sensorData().cameraModels()[0].isValidForProjection()));
					const CameraModel & cameraModel = signatureA->sensorData().stereoCameraModel().isValidForProjection()?signatureA->sensorData().stereoCameraModel().left():signatureA->sensorData().cameraModels()[0];

					// we only need the camera transform, send guess words3 for scale estimation
					Transform cameraTransform;
					double variance = 1.0f;
					std::map<int, cv::Point3f> inliers3D = util3d::generateWords3DMono(
							uMultimapToMapUnique(signatureA->getWords()),
							uMultimapToMapUnique(signatureB->getWords()),
							cameraModel,
							cameraTransform,
							_iterations,
							_PnPReprojError,
							_PnPFlags, // cv::SOLVEPNP_ITERATIVE
							_PnPRefineIterations,
							1.0f,
							0.99f,
							uMultimapToMapUnique(signatureA->getWords3()), // for scale estimation
							&variance);
					covariances[dir] *= variance;
					inliers[dir] = uKeys(inliers3D);

					if(!cameraTransform.isNull())
					{
						if((int)inliers3D.size() >= _minInliers)
						{
							if(variance <= _epipolarGeometryVar)
							{
								transforms[dir] = cameraTransform;
							}
							else
							{
								msg = uFormat(""Variance is too high! (max inlier distance=%f, variance=%f)"", _epipolarGeometryVar, variance);
								UINFO(msg.c_str());
							}
						}
						else
						{
							msg = uFormat(""Not enough inliers %d < %d"", (int)inliers3D.size(), _minInliers);
							UINFO(msg.c_str());
						}
					}
					else
					{
						msg = uFormat(""No camera transform found"");
						UINFO(msg.c_str());
					}
				}
				else if(signatureA->getWords().size() == 0)
				{
					msg = uFormat(""No enough features (%d)"", (int)signatureA->getWords().size());
					UWARN(msg.c_str());
				}
				else
				{
					msg = uFormat(""No camera model"");
					UWARN(msg.c_str());
				}
			}
			else if(_estimationType == 1) // PnP
			{
				UDEBUG("""");
				if(!signatureB->sensorData().stereoCameraModel().isValidForProjection() &&
				   (signatureB->sensorData().cameraModels().size() != 1 ||
					!signatureB->sensorData().cameraModels()[0].isValidForProjection()))
				{
					UERROR(""Calibrated camera required (multi-cameras not supported). Id=%d Models=%d StereoModel=%d weight=%d"",
							signatureB->id(),
							(int)signatureB->sensorData().cameraModels().size(),
							signatureB->sensorData().stereoCameraModel().isValidForProjection()?1:0,
							signatureB->getWeight());
				}
				else
				{
					UDEBUG(""words from3D=%d to2D=%d"", (int)signatureA->getWords3().size(), (int)signatureB->getWords().size());
					// 3D to 2D
					if((int)signatureA->getWords3().size() >= _minInliers &&
					   (int)signatureB->getWords().size() >= _minInliers)
					{
						UASSERT(signatureB->sensorData().stereoCameraModel().isValidForProjection() || (signatureB->sensorData().cameraModels().size() == 1 && signatureB->sensorData().cameraModels()[0].isValidForProjection()));
						const CameraModel & cameraModel = signatureB->sensorData().stereoCameraModel().isValidForProjection()?signatureB->sensorData().stereoCameraModel().left():signatureB->sensorData().cameraModels()[0];

						std::vector<int> inliersV;
						std::vector<int> matchesV;
						transforms[dir] = util3d::estimateMotion3DTo2D(
								uMultimapToMapUnique(signatureA->getWords3()),
								uMultimapToMapUnique(signatureB->getWords()),
								cameraModel,
								_minInliers,
								_iterations,
								_PnPReprojError,
								_PnPFlags,
								_PnPRefineIterations,
								dir==0?(!guess.isNull()?guess:Transform::getIdentity()):!transforms[0].isNull()?transforms[0].inverse():(!guess.isNull()?guess.inverse():Transform::getIdentity()),
								uMultimapToMapUnique(signatureB->getWords3()),
								varianceFromInliersCount()?0:&covariances[dir],
								&matchesV,
								&inliersV);
						inliers[dir] = inliersV;
						matches[dir] = matchesV;
						if(transforms[dir].isNull())
						{
							msg = uFormat(""Not enough inliers %d/%d (matches=%d) between %d and %d"",
									(int)inliers[dir].size(), _minInliers, (int)matches[dir].size(), signatureA->id(), signatureB->id());
							UINFO(msg.c_str());
						}
					}
					else
					{
						msg = uFormat(""Not enough features in images (old=%d, new=%d, min=%d)"",
								(int)signatureA->getWords3().size(), (int)signatureB->getWords().size(), _minInliers);
						UINFO(msg.c_str());
					}
				}

			}
			else
			{
				UDEBUG("""");
				// 3D -> 3D
				if((int)signatureA->getWords3().size() >= _minInliers &&
				   (int)signatureB->getWords3().size() >= _minInliers)
				{
					std::vector<int> inliersV;
					std::vector<int> matchesV;
					transforms[dir] = util3d::estimateMotion3DTo3D(
							uMultimapToMapUnique(signatureA->getWords3()),
							uMultimapToMapUnique(signatureB->getWords3()),
							_minInliers,
							_inlierDistance,
							_iterations,
							_refineIterations,
							&covariances[dir],
							&matchesV,
							&inliersV);
					inliers[dir] = inliersV;
					matches[dir] = matchesV;
					if(transforms[dir].isNull())
					{
						msg = uFormat(""Not enough inliers %d/%d (matches=%d) between %d and %d"",
								(int)inliers[dir].size(), _minInliers, (int)matches[dir].size(), signatureA->id(), signatureB->id());
						UINFO(msg.c_str());
					}
				}
				else
				{
					msg = uFormat(""Not enough 3D features in images (old=%d, new=%d, min=%d)"",
							(int)signatureA->getWords3().size(), (int)signatureB->getWords3().size(), _minInliers);
					UINFO(msg.c_str());
				}
			}
		}

		if(!_forwardEstimateOnly)
		{
			UDEBUG(""from->to=%s"", transforms[0].prettyPrint().c_str());
			UDEBUG(""to->from=%s"", transforms[1].prettyPrint().c_str());
		}

		std::vector<int> allInliers = inliers[0];
		if(inliers[1].size())
		{
			std::set<int> allInliersSet(allInliers.begin(), allInliers.end());
			unsigned int oi = allInliers.size();
			allInliers.resize(allInliers.size() + inliers[1].size());
			for(unsigned int i=0; i<inliers[1].size(); ++i)
			{
				if(allInliersSet.find(inliers[1][i]) == allInliersSet.end())
				{
					allInliers[oi++] = inliers[1][i];
				}
			}
			allInliers.resize(oi);
		}
		std::vector<int> allMatches = matches[0];
		if(matches[1].size())
		{
			std::set<int> allMatchesSet(allMatches.begin(), allMatches.end());
			unsigned int oi = allMatches.size();
			allMatches.resize(allMatches.size() + matches[1].size());
			for(unsigned int i=0; i<matches[1].size(); ++i)
			{
				if(allMatchesSet.find(matches[1][i]) == allMatchesSet.end())
				{
					allMatches[oi++] = matches[1][i];
				}
			}
			allMatches.resize(oi);
		}

		if(_bundleAdjustment > 0 &&
			_estimationType < 2 &&
			!transforms[0].isNull() &&
			allInliers.size() &&
			fromSignature.getWords3().size() &&
			toSignature.getWords().size() &&
			fromSignature.sensorData().cameraModels().size() <= 1 &&
			toSignature.sensorData().cameraModels().size() <= 1)
		{
			Optimizer * sba = Optimizer::create(_bundleAdjustment==2?Optimizer::kTypeCVSBA:Optimizer::kTypeG2O, _bundleParameters);

			std::map<int, Transform> poses;
			std::multimap<int, Link> links;
			std::map<int, cv::Point3f> points3DMap;

			poses.insert(std::make_pair(1, Transform::getIdentity()));
			poses.insert(std::make_pair(2, transforms[0]));

			cv::Mat cov = covariances[0].clone();
			normalizeCovariance(cov, transform);

			links.insert(std::make_pair(1, Link(1, 2, Link::kNeighbor, transforms[0], cov.inv())));
			if(!transforms[1].isNull() && inliers[1].size())
			{
				cov = covariances[1].clone();
				normalizeCovariance(cov, transform);
				links.insert(std::make_pair(2, Link(2, 1, Link::kNeighbor, transforms[1], cov.inv())));
			}

			std::map<int, Transform> optimizedPoses;

			UASSERT(toSignature.sensorData().stereoCameraModel().isValidForProjection() ||
					(toSignature.sensorData().cameraModels().size() == 1 && toSignature.sensorData().cameraModels()[0].isValidForProjection()));

			std::map<int, CameraModel> models;

			CameraModel cameraModelFrom;
			if(fromSignature.sensorData().stereoCameraModel().isValidForProjection())
			{
				cameraModelFrom = fromSignature.sensorData().stereoCameraModel().left();
				// Set Tx=-baseline*fx for Stereo BA
				cameraModelFrom = CameraModel(cameraModelFrom.fx(),
						cameraModelFrom.fy(),
						cameraModelFrom.cx(),
						cameraModelFrom.cy(),
						cameraModelFrom.localTransform(),
						-fromSignature.sensorData().stereoCameraModel().baseline()*cameraModelFrom.fy());
			}
			else if(fromSignature.sensorData().cameraModels().size() == 1)
			{
				cameraModelFrom = fromSignature.sensorData().cameraModels()[0];
			}

			CameraModel cameraModelTo;
			if(toSignature.sensorData().stereoCameraModel().isValidForProjection())
			{
				cameraModelTo = toSignature.sensorData().stereoCameraModel().left();
				// Set Tx=-baseline*fx for Stereo BA
				cameraModelTo = CameraModel(cameraModelTo.fx(),
						cameraModelTo.fy(),
						cameraModelTo.cx(),
						cameraModelTo.cy(),
						cameraModelTo.localTransform(),
						-toSignature.sensorData().stereoCameraModel().baseline()*cameraModelTo.fy());
			}
			else if(toSignature.sensorData().cameraModels().size() == 1)
			{
				cameraModelTo = toSignature.sensorData().cameraModels()[0];
			}

			models.insert(std::make_pair(1, cameraModelFrom.isValidForProjection()?cameraModelFrom:cameraModelTo));
			models.insert(std::make_pair(2, cameraModelTo));

			std::map<int, std::map<int, cv::Point3f> > wordReferences;
			for(unsigned int i=0; i<allInliers.size(); ++i)
			{
				int wordId = allInliers[i];
				const cv::Point3f & pt3D = fromSignature.getWords3().find(wordId)->second;
				points3DMap.insert(std::make_pair(wordId, pt3D));

				std::map<int, cv::Point3f> ptMap;
				if(fromSignature.getWords().size() && cameraModelFrom.isValidForProjection())
				{
					const cv::Point2f & kpt = fromSignature.getWords().find(wordId)->second.pt;
					ptMap.insert(std::make_pair(1,cv::Point3f(kpt.x, kpt.y, pt3D.x)));
				}
				if(toSignature.getWords().size() && cameraModelTo.isValidForProjection())
				{
					const cv::Point2f & kpt = toSignature.getWords().find(wordId)->second.pt;
					UASSERT(toSignature.getWords3().find(wordId) != toSignature.getWords3().end());
					ptMap.insert(std::make_pair(2,cv::Point3f(kpt.x, kpt.y, toSignature.getWords3().find(wordId)->second.x)));
				}

				wordReferences.insert(std::make_pair(wordId, ptMap));

				//UDEBUG(""%d (%f,%f,%f)"", wordId, points3DMap.at(wordId).x, points3DMap.at(wordId).y, points3DMap.at(wordId).z);
				//for(std::map<int, cv::Point3f>::iterator iter=ptMap.begin(); iter!=ptMap.end(); ++iter)
				//{
				//	UDEBUG(""%d (%f,%f) d=%f"", iter->first, iter->second.x, iter->second.y, iter->second.z);
				//}
			}

			std::set<int> sbaOutliers;
			optimizedPoses = sba->optimizeBA(1, poses, links, models, points3DMap, wordReferences, &sbaOutliers);
			delete sba;

			//update transform
			if(optimizedPoses.size() == 2 &&
				!optimizedPoses.begin()->second.isNull() &&
				!optimizedPoses.rbegin()->second.isNull())
			{
				UDEBUG(""Pose optimization: %s -> %s"", transforms[0].prettyPrint().c_str(), optimizedPoses.rbegin()->second.prettyPrint().c_str());
				transforms[0] = optimizedPoses.rbegin()->second;
				transforms[1].setNull();
				// update 3D points, both from and to signatures
				/*std::multimap<int, cv::Point3f> cpyWordsFrom3 = fromSignature.getWords3();
				std::multimap<int, cv::Point3f> cpyWordsTo3 = toSignature.getWords3();
				Transform invT = transforms[0].inverse();
				for(std::map<int, cv::Point3f>::iterator iter=points3DMap.begin(); iter!=points3DMap.end(); ++iter)
				{
					cpyWordsFrom3.find(iter->first)->second = iter->second;
					if(cpyWordsTo3.find(iter->first) != cpyWordsTo3.end())
					{
						cpyWordsTo3.find(iter->first)->second = util3d::transformPoint(iter->second, invT);
					}
				}
				fromSignature.setWords3(cpyWordsFrom3);
				toSignature.setWords3(cpyWordsTo3);*/

				if(sbaOutliers.size())
				{
					std::vector<int> newInliers(allInliers.size());
					int oi=0;
					for(unsigned int i=0; i<allInliers.size(); ++i)
					{
						if(sbaOutliers.find(allInliers[i]) == sbaOutliers.end())
						{
							newInliers[oi++] = allInliers[i];
						}
					}
					newInliers.resize(oi);
					UDEBUG(""BA outliers ratio %f"", float(sbaOutliers.size())/float(allInliers.size()));
					allInliers = newInliers;
				}
			}
		}

		info.inliersIDs = allInliers;
		info.matchesIDs = allMatches;
		inliersCount = (int)allInliers.size();
		matchesCount = (int)allMatches.size();
		if(!transforms[1].isNull())
		{
			transforms[1] = transforms[1].inverse();
			if(transforms[0].isNull())
			{
				transform = transforms[1];
				covariance = covariances[1];
			}
			else
			{
				transform = transforms[0].interpolate(0.5f, transforms[1]);
				covariance = (covariances[0]+covariances[1])/2.0f;
			}
		}
		else
		{
			transform = transforms[0];
			covariance = covariances[0];
		}
	}
	else if(toSignature.sensorData().isValid())
	{
		UWARN(""Missing correspondences for registration (%d->%d). fromWords = %d fromImageEmpty=%d toWords = %d toImageEmpty=%d"",
				fromSignature.id(), toSignature.id(),
				(int)fromSignature.getWords().size(), fromSignature.sensorData().imageRaw().empty()?1:0,
				(int)toSignature.getWords().size(), toSignature.sensorData().imageRaw().empty()?1:0);
	}

	info.inliers = inliersCount;
	info.matches = matchesCount;
	info.rejectedMsg = msg;
	info.covariance = covariance;

	UDEBUG(""transform=%s"", transform.prettyPrint().c_str());
	return transform;
}

}
",16280,True,2984.8660240593595,median
"/*
 *  Copyright 2019-2020 Diligent Graphics LLC
 *  Copyright 2015-2019 Egor Yusov
 *  
 *  Licensed under the Apache License, Version 2.0 (the ""License"");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an ""AS IS"" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *  In no event and under no legal theory, whether in tort (including negligence), 
 *  contract, or otherwise, unless required by applicable law (such as deliberate 
 *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
 *  liable for any damages, including any direct, indirect, special, incidental, 
 *  or consequential damages of any character arising as a result of this License or 
 *  out of the use or inability to use the software (including but not limited to damages 
 *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
 *  all other commercial damages or losses), even if such Contributor has been advised 
 *  of the possibility of such damages.
 */

#include <algorithm>

#include ""GraphicsAccessories.hpp""
#include ""DebugUtilities.hpp""
#include ""Align.hpp""

namespace Diligent
{

const Char* GetValueTypeString(VALUE_TYPE Val)
{
    static const Char* ValueTypeStrings[VT_NUM_TYPES] = {};
    static bool        bIsInit                        = false;
    if (!bIsInit)
    {
        // clang-format off
#define INIT_VALUE_TYPE_STR( ValType ) ValueTypeStrings[ValType] = #ValType
        INIT_VALUE_TYPE_STR( VT_UNDEFINED );
        INIT_VALUE_TYPE_STR( VT_INT8    );
        INIT_VALUE_TYPE_STR( VT_INT16   );
        INIT_VALUE_TYPE_STR( VT_INT32   );
        INIT_VALUE_TYPE_STR( VT_UINT8   );
        INIT_VALUE_TYPE_STR( VT_UINT16  );
        INIT_VALUE_TYPE_STR( VT_UINT32  );
        INIT_VALUE_TYPE_STR( VT_FLOAT16 );
        INIT_VALUE_TYPE_STR( VT_FLOAT32 );
#undef  INIT_VALUE_TYPE_STR
        // clang-format on
        static_assert(VT_NUM_TYPES == VT_FLOAT32 + 1, ""Not all value type strings initialized."");
        bIsInit = true;
    }

    if (Val >= VT_UNDEFINED && Val < VT_NUM_TYPES)
    {
        return ValueTypeStrings[Val];
    }
    else
    {
        UNEXPECTED(""Incorrect value type ("", Val, "")"");
        return ""unknown value type"";
    }
}

class TexFormatToViewFormatConverter
{
public:
    TexFormatToViewFormatConverter()
    {
        // clang-format off
        static_assert(TEXTURE_VIEW_SHADER_RESOURCE == 1, ""TEXTURE_VIEW_SHADER_RESOURCE == 1 expected"");
        static_assert(TEXTURE_VIEW_RENDER_TARGET == 2, ""TEXTURE_VIEW_RENDER_TARGET == 2 expected"");
        static_assert(TEXTURE_VIEW_DEPTH_STENCIL == 3, ""TEXTURE_VIEW_DEPTH_STENCIL == 3 expected"");
        static_assert(TEXTURE_VIEW_UNORDERED_ACCESS == 4, ""TEXTURE_VIEW_UNORDERED_ACCESS == 4 expected"");
#define INIT_TEX_VIEW_FORMAT_INFO(TexFmt, SRVFmt, RTVFmt, DSVFmt, UAVFmt)\\
        {\\
            m_ViewFormats[ TexFmt ][TEXTURE_VIEW_SHADER_RESOURCE-1]  = TEX_FORMAT_##SRVFmt; \\
            m_ViewFormats[ TexFmt ][TEXTURE_VIEW_RENDER_TARGET-1]    = TEX_FORMAT_##RTVFmt; \\
            m_ViewFormats[ TexFmt ][TEXTURE_VIEW_DEPTH_STENCIL-1]    = TEX_FORMAT_##DSVFmt; \\
            m_ViewFormats[ TexFmt ][TEXTURE_VIEW_UNORDERED_ACCESS-1] = TEX_FORMAT_##UAVFmt; \\
        }
        
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_UNKNOWN,                 UNKNOWN, UNKNOWN, UNKNOWN, UNKNOWN);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA32_TYPELESS,         RGBA32_FLOAT, RGBA32_FLOAT, UNKNOWN, RGBA32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA32_FLOAT,            RGBA32_FLOAT, RGBA32_FLOAT, UNKNOWN, RGBA32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA32_UINT,             RGBA32_UINT,  RGBA32_UINT,  UNKNOWN, RGBA32_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA32_SINT,             RGBA32_SINT,  RGBA32_SINT,  UNKNOWN, RGBA32_SINT);
                                                                       
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGB32_TYPELESS,          RGB32_FLOAT, RGB32_FLOAT, UNKNOWN, RGB32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGB32_FLOAT,             RGB32_FLOAT, RGB32_FLOAT, UNKNOWN, RGB32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGB32_UINT,              RGB32_UINT,  RGB32_UINT,  UNKNOWN, RGB32_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGB32_SINT,              RGB32_SINT,  RGB32_SINT,  UNKNOWN, RGB32_SINT);
                                                                      
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA16_TYPELESS,         RGBA16_FLOAT, RGBA16_FLOAT, UNKNOWN, RGBA16_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA16_FLOAT,            RGBA16_FLOAT, RGBA16_FLOAT, UNKNOWN, RGBA16_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA16_UNORM,            RGBA16_UNORM, RGBA16_UNORM, UNKNOWN, RGBA16_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA16_UINT,             RGBA16_UINT,  RGBA16_UINT,  UNKNOWN, RGBA16_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA16_SNORM,            RGBA16_SNORM, RGBA16_SNORM, UNKNOWN, RGBA16_SNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA16_SINT,             RGBA16_SINT,  RGBA16_SINT,  UNKNOWN, RGBA16_SINT);
                                                                       
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG32_TYPELESS,           RG32_FLOAT, RG32_FLOAT, UNKNOWN, RG32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG32_FLOAT,              RG32_FLOAT, RG32_FLOAT, UNKNOWN, RG32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG32_UINT,               RG32_UINT,  RG32_UINT,  UNKNOWN, RG32_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG32_SINT,               RG32_SINT,  RG32_SINT,  UNKNOWN, RG32_SINT);
                                                                       
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R32G8X24_TYPELESS,       R32_FLOAT_X8X24_TYPELESS, UNKNOWN, D32_FLOAT_S8X24_UINT, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_D32_FLOAT_S8X24_UINT,    R32_FLOAT_X8X24_TYPELESS, UNKNOWN, D32_FLOAT_S8X24_UINT, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R32_FLOAT_X8X24_TYPELESS,R32_FLOAT_X8X24_TYPELESS, UNKNOWN, D32_FLOAT_S8X24_UINT, R32_FLOAT_X8X24_TYPELESS);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_X32_TYPELESS_G8X24_UINT, X32_TYPELESS_G8X24_UINT,  UNKNOWN, D32_FLOAT_S8X24_UINT, X32_TYPELESS_G8X24_UINT);
                                                                       
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGB10A2_TYPELESS,        RGB10A2_UNORM, RGB10A2_UNORM, UNKNOWN, RGB10A2_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGB10A2_UNORM,           RGB10A2_UNORM, RGB10A2_UNORM, UNKNOWN, RGB10A2_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGB10A2_UINT,            RGB10A2_UINT,  RGB10A2_UINT,  UNKNOWN, RGB10A2_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R11G11B10_FLOAT,         R11G11B10_FLOAT, R11G11B10_FLOAT, UNKNOWN, R11G11B10_FLOAT);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA8_TYPELESS,          RGBA8_UNORM_SRGB, RGBA8_UNORM_SRGB, UNKNOWN, RGBA8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA8_UNORM,             RGBA8_UNORM,      RGBA8_UNORM,      UNKNOWN, RGBA8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA8_UNORM_SRGB,        RGBA8_UNORM_SRGB, RGBA8_UNORM_SRGB, UNKNOWN, RGBA8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA8_UINT,              RGBA8_UINT,       RGBA8_UINT,       UNKNOWN, RGBA8_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA8_SNORM,             RGBA8_SNORM,      RGBA8_SNORM,      UNKNOWN, RGBA8_SNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGBA8_SINT,              RGBA8_SINT,       RGBA8_SINT,       UNKNOWN, RGBA8_SINT);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG16_TYPELESS,           RG16_FLOAT, RG16_FLOAT, UNKNOWN, RG16_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG16_FLOAT,              RG16_FLOAT, RG16_FLOAT, UNKNOWN, RG16_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG16_UNORM,              RG16_UNORM, RG16_UNORM, UNKNOWN, RG16_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG16_UINT,               RG16_UINT,  RG16_UINT,  UNKNOWN, RG16_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG16_SNORM,              RG16_SNORM, RG16_SNORM, UNKNOWN, RG16_SNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG16_SINT,               RG16_SINT,  RG16_SINT,  UNKNOWN, RG16_SINT);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R32_TYPELESS,            R32_FLOAT, R32_FLOAT, D32_FLOAT, R32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_D32_FLOAT,               R32_FLOAT, R32_FLOAT, D32_FLOAT, R32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R32_FLOAT,               R32_FLOAT, R32_FLOAT, D32_FLOAT, R32_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R32_UINT,                R32_UINT,  R32_UINT,  UNKNOWN,   R32_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R32_SINT,                R32_SINT,  R32_SINT,  UNKNOWN,   R32_SINT);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R24G8_TYPELESS,          R24_UNORM_X8_TYPELESS, UNKNOWN, D24_UNORM_S8_UINT, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_D24_UNORM_S8_UINT,       R24_UNORM_X8_TYPELESS, UNKNOWN, D24_UNORM_S8_UINT, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R24_UNORM_X8_TYPELESS,   R24_UNORM_X8_TYPELESS, UNKNOWN, D24_UNORM_S8_UINT, R24_UNORM_X8_TYPELESS);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_X24_TYPELESS_G8_UINT,    X24_TYPELESS_G8_UINT,  UNKNOWN, D24_UNORM_S8_UINT, X24_TYPELESS_G8_UINT);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG8_TYPELESS,            RG8_UNORM, RG8_UNORM, UNKNOWN, RG8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG8_UNORM,               RG8_UNORM, RG8_UNORM, UNKNOWN, RG8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG8_UINT,                RG8_UINT,  RG8_UINT,  UNKNOWN, RG8_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG8_SNORM,               RG8_SNORM, RG8_SNORM, UNKNOWN, RG8_SNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG8_SINT,                RG8_SINT,  RG8_SINT,  UNKNOWN, RG8_SINT);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R16_TYPELESS,            R16_FLOAT, R16_FLOAT, UNKNOWN,   R16_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R16_FLOAT,               R16_FLOAT, R16_FLOAT, UNKNOWN,   R16_FLOAT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_D16_UNORM,               R16_UNORM, R16_UNORM, D16_UNORM, R16_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R16_UNORM,               R16_UNORM, R16_UNORM, D16_UNORM, R16_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R16_UINT,                R16_UINT,  R16_UINT,  UNKNOWN,   R16_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R16_SNORM,               R16_SNORM, R16_SNORM, UNKNOWN,   R16_SNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R16_SINT,                R16_SINT,  R16_SINT,  UNKNOWN,   R16_SINT);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R8_TYPELESS,             R8_UNORM, R8_UNORM, UNKNOWN, R8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R8_UNORM,                R8_UNORM, R8_UNORM, UNKNOWN, R8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R8_UINT,                 R8_UINT,  R8_UINT,  UNKNOWN, R8_UINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R8_SNORM,                R8_SNORM, R8_SNORM, UNKNOWN, R8_SNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R8_SINT,                 R8_SINT,  R8_SINT,  UNKNOWN, R8_SINT);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_A8_UNORM,                A8_UNORM, A8_UNORM, UNKNOWN, A8_UNORM);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R1_UNORM,                R1_UNORM, R1_UNORM, UNKNOWN, R1_UNORM);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RGB9E5_SHAREDEXP,        RGB9E5_SHAREDEXP, RGB9E5_SHAREDEXP, UNKNOWN, RGB9E5_SHAREDEXP);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_RG8_B8G8_UNORM,          RG8_B8G8_UNORM,  RG8_B8G8_UNORM,  UNKNOWN, RG8_B8G8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_G8R8_G8B8_UNORM,         G8R8_G8B8_UNORM, G8R8_G8B8_UNORM, UNKNOWN, G8R8_G8B8_UNORM);

        // http://www.g-truc.net/post-0335.html
        // http://renderingpipeline.com/2012/07/texture-compression/
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC1_TYPELESS,            BC1_UNORM_SRGB, UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC1_UNORM,               BC1_UNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC1_UNORM_SRGB,          BC1_UNORM_SRGB, UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC2_TYPELESS,            BC2_UNORM_SRGB, UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC2_UNORM,               BC2_UNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC2_UNORM_SRGB,          BC2_UNORM_SRGB, UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC3_TYPELESS,            BC3_UNORM_SRGB, UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC3_UNORM,               BC3_UNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC3_UNORM_SRGB,          BC3_UNORM_SRGB, UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC4_TYPELESS,            BC4_UNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC4_UNORM,               BC4_UNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC4_SNORM,               BC4_SNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC5_TYPELESS,            BC5_UNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC5_UNORM,               BC5_UNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC5_SNORM,               BC5_SNORM,      UNKNOWN, UNKNOWN, UNKNOWN);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_B5G6R5_UNORM,            B5G6R5_UNORM,   B5G6R5_UNORM,    UNKNOWN, B5G6R5_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_B5G5R5A1_UNORM,          B5G5R5A1_UNORM, B5G5R5A1_UNORM,  UNKNOWN, B5G5R5A1_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BGRA8_UNORM,             BGRA8_UNORM,    BGRA8_UNORM,     UNKNOWN, BGRA8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BGRX8_UNORM,             BGRX8_UNORM,    BGRX8_UNORM,     UNKNOWN, BGRX8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_R10G10B10_XR_BIAS_A2_UNORM, R10G10B10_XR_BIAS_A2_UNORM, UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BGRA8_TYPELESS,          BGRA8_UNORM_SRGB, BGRA8_UNORM_SRGB, UNKNOWN, BGRA8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BGRA8_UNORM_SRGB,        BGRA8_UNORM_SRGB, BGRA8_UNORM_SRGB, UNKNOWN, BGRA8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BGRX8_TYPELESS,          BGRX8_UNORM_SRGB, BGRX8_UNORM_SRGB, UNKNOWN, BGRX8_UNORM);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BGRX8_UNORM_SRGB,        BGRX8_UNORM_SRGB, BGRX8_UNORM_SRGB, UNKNOWN, BGRX8_UNORM);

        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC6H_TYPELESS,           BC6H_UF16,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC6H_UF16,               BC6H_UF16,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC6H_SF16,               BC6H_SF16,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC7_TYPELESS,            BC7_UNORM_SRGB, UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC7_UNORM,               BC7_UNORM,      UNKNOWN, UNKNOWN, UNKNOWN);
        INIT_TEX_VIEW_FORMAT_INFO( TEX_FORMAT_BC7_UNORM_SRGB,          BC7_UNORM_SRGB, UNKNOWN, UNKNOWN, UNKNOWN);
#undef INIT_TVIEW_FORMAT_INFO
        // clang-format on
    }

    TEXTURE_FORMAT GetViewFormat(TEXTURE_FORMAT Format, TEXTURE_VIEW_TYPE ViewType, Uint32 BindFlags)
    {
        VERIFY(ViewType > TEXTURE_VIEW_UNDEFINED && ViewType < TEXTURE_VIEW_NUM_VIEWS, ""Unexpected texture view type"");
        VERIFY(Format >= TEX_FORMAT_UNKNOWN && Format < TEX_FORMAT_NUM_FORMATS, ""Unknown texture format"");
        switch (Format)
        {
            case TEX_FORMAT_R16_TYPELESS:
            {
                if (BindFlags & BIND_DEPTH_STENCIL)
                {
                    // clang-format off
                    static TEXTURE_FORMAT D16_ViewFmts[] = 
                    {
                        TEX_FORMAT_R16_UNORM, TEX_FORMAT_R16_UNORM, TEX_FORMAT_D16_UNORM, TEX_FORMAT_R16_UNORM
                    };
                    // clang-format on
                    return D16_ViewFmts[ViewType - 1];
                }
            }

            default: /*do nothing*/ break;
        }

        return m_ViewFormats[Format][ViewType - 1];
    }

private:
    TEXTURE_FORMAT m_ViewFormats[TEX_FORMAT_NUM_FORMATS][TEXTURE_VIEW_NUM_VIEWS - 1];
};

TEXTURE_FORMAT GetDefaultTextureViewFormat(TEXTURE_FORMAT TextureFormat, TEXTURE_VIEW_TYPE ViewType, Uint32 BindFlags)
{
    static TexFormatToViewFormatConverter FmtConverter;
    return FmtConverter.GetViewFormat(TextureFormat, ViewType, BindFlags);
}

const TextureFormatAttribs& GetTextureFormatAttribs(TEXTURE_FORMAT Format)
{
    static TextureFormatAttribs FmtAttribs[TEX_FORMAT_NUM_FORMATS];
    static bool                 bIsInit = false;
    // Note that this implementation is thread-safe
    // Even if two threads try to call the function at the same time,
    // the worst thing that might happen is that the array will be
    // initialized multiple times. But the result will always be correct.
    if (!bIsInit)
    {
        // clang-format off
#define INIT_TEX_FORMAT_INFO(TexFmt, ComponentSize, NumComponents, ComponentType, IsTypeless, BlockWidth, BlockHeight) \\
        FmtAttribs[ TexFmt ] = TextureFormatAttribs(#TexFmt, TexFmt, ComponentSize, NumComponents, ComponentType, IsTypeless, BlockWidth, BlockHeight);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA32_TYPELESS,         4, 4, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA32_FLOAT,            4, 4, COMPONENT_TYPE_FLOAT,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA32_UINT,             4, 4, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA32_SINT,             4, 4, COMPONENT_TYPE_SINT,      false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGB32_TYPELESS,          4, 3, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGB32_FLOAT,             4, 3, COMPONENT_TYPE_FLOAT,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGB32_UINT,              4, 3, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGB32_SINT,              4, 3, COMPONENT_TYPE_SINT,      false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA16_TYPELESS,         2, 4, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA16_FLOAT,            2, 4, COMPONENT_TYPE_FLOAT,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA16_UNORM,            2, 4, COMPONENT_TYPE_UNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA16_UINT,             2, 4, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA16_SNORM,            2, 4, COMPONENT_TYPE_SNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA16_SINT,             2, 4, COMPONENT_TYPE_SINT,      false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG32_TYPELESS,           4, 2, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG32_FLOAT,              4, 2, COMPONENT_TYPE_FLOAT,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG32_UINT,               4, 2, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG32_SINT,               4, 2, COMPONENT_TYPE_SINT,      false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R32G8X24_TYPELESS,       4, 2, COMPONENT_TYPE_DEPTH_STENCIL,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_D32_FLOAT_S8X24_UINT,    4, 2, COMPONENT_TYPE_DEPTH_STENCIL, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R32_FLOAT_X8X24_TYPELESS,4, 2, COMPONENT_TYPE_DEPTH_STENCIL, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_X32_TYPELESS_G8X24_UINT, 4, 2, COMPONENT_TYPE_DEPTH_STENCIL, false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGB10A2_TYPELESS,        4, 1, COMPONENT_TYPE_COMPOUND,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGB10A2_UNORM,           4, 1, COMPONENT_TYPE_COMPOUND, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGB10A2_UINT,            4, 1, COMPONENT_TYPE_COMPOUND, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R11G11B10_FLOAT,         4, 1, COMPONENT_TYPE_COMPOUND, false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA8_TYPELESS,          1, 4, COMPONENT_TYPE_UNDEFINED,   true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA8_UNORM,             1, 4, COMPONENT_TYPE_UNORM,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA8_UNORM_SRGB,        1, 4, COMPONENT_TYPE_UNORM_SRGB, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA8_UINT,              1, 4, COMPONENT_TYPE_UINT,       false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA8_SNORM,             1, 4, COMPONENT_TYPE_SNORM,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGBA8_SINT,              1, 4, COMPONENT_TYPE_SINT,       false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG16_TYPELESS,           2, 2, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG16_FLOAT,              2, 2, COMPONENT_TYPE_FLOAT,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG16_UNORM,              2, 2, COMPONENT_TYPE_UNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG16_UINT,               2, 2, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG16_SNORM,              2, 2, COMPONENT_TYPE_SNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG16_SINT,               2, 2, COMPONENT_TYPE_SINT,      false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R32_TYPELESS,            4, 1, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_D32_FLOAT,               4, 1, COMPONENT_TYPE_DEPTH,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R32_FLOAT,               4, 1, COMPONENT_TYPE_FLOAT,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R32_UINT,                4, 1, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R32_SINT,                4, 1, COMPONENT_TYPE_SINT,      false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R24G8_TYPELESS,          4, 1, COMPONENT_TYPE_DEPTH_STENCIL,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_D24_UNORM_S8_UINT,       4, 1, COMPONENT_TYPE_DEPTH_STENCIL, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R24_UNORM_X8_TYPELESS,   4, 1, COMPONENT_TYPE_DEPTH_STENCIL, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_X24_TYPELESS_G8_UINT,    4, 1, COMPONENT_TYPE_DEPTH_STENCIL, false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG8_TYPELESS,            1, 2, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG8_UNORM,               1, 2, COMPONENT_TYPE_UNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG8_UINT,                1, 2, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG8_SNORM,               1, 2, COMPONENT_TYPE_SNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG8_SINT,                1, 2, COMPONENT_TYPE_SINT,      false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R16_TYPELESS,            2, 1, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R16_FLOAT,               2, 1, COMPONENT_TYPE_FLOAT,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_D16_UNORM,               2, 1, COMPONENT_TYPE_DEPTH,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R16_UNORM,               2, 1, COMPONENT_TYPE_UNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R16_UINT,                2, 1, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R16_SNORM,               2, 1, COMPONENT_TYPE_SNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R16_SINT,                2, 1, COMPONENT_TYPE_SINT,      false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R8_TYPELESS,             1, 1, COMPONENT_TYPE_UNDEFINED,  true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R8_UNORM,                1, 1, COMPONENT_TYPE_UNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R8_UINT,                 1, 1, COMPONENT_TYPE_UINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R8_SNORM,                1, 1, COMPONENT_TYPE_SNORM,     false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R8_SINT,                 1, 1, COMPONENT_TYPE_SINT,      false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_A8_UNORM,                1, 1, COMPONENT_TYPE_UNORM,     false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R1_UNORM,                1, 1, COMPONENT_TYPE_UNORM,    false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RGB9E5_SHAREDEXP,        4, 1, COMPONENT_TYPE_COMPOUND, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_RG8_B8G8_UNORM,          1, 4, COMPONENT_TYPE_UNORM,    false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_G8R8_G8B8_UNORM,         1, 4, COMPONENT_TYPE_UNORM,    false, 1,1);

        // http://www.g-truc.net/post-0335.html
        // http://renderingpipeline.com/2012/07/texture-compression/
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC1_TYPELESS,            8,  3, COMPONENT_TYPE_COMPRESSED,  true, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC1_UNORM,               8,  3, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC1_UNORM_SRGB,          8,  3, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC2_TYPELESS,            16, 4, COMPONENT_TYPE_COMPRESSED,  true, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC2_UNORM,               16, 4, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC2_UNORM_SRGB,          16, 4, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC3_TYPELESS,            16, 4, COMPONENT_TYPE_COMPRESSED,  true, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC3_UNORM,               16, 4, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC3_UNORM_SRGB,          16, 4, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC4_TYPELESS,            8,  1, COMPONENT_TYPE_COMPRESSED,  true, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC4_UNORM,               8,  1, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC4_SNORM,               8,  1, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC5_TYPELESS,            16, 2, COMPONENT_TYPE_COMPRESSED,  true, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC5_UNORM,               16, 2, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC5_SNORM,               16, 2, COMPONENT_TYPE_COMPRESSED, false, 4,4);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_B5G6R5_UNORM,            2, 1, COMPONENT_TYPE_COMPOUND, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_B5G5R5A1_UNORM,          2, 1, COMPONENT_TYPE_COMPOUND, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BGRA8_UNORM,             1, 4, COMPONENT_TYPE_UNORM,    false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BGRX8_UNORM,             1, 4, COMPONENT_TYPE_UNORM,    false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_R10G10B10_XR_BIAS_A2_UNORM,  4, 1, COMPONENT_TYPE_COMPOUND, false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BGRA8_TYPELESS,          1, 4, COMPONENT_TYPE_UNDEFINED,     true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BGRA8_UNORM_SRGB,        1, 4, COMPONENT_TYPE_UNORM_SRGB,   false, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BGRX8_TYPELESS,          1, 4, COMPONENT_TYPE_UNDEFINED,     true, 1,1);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BGRX8_UNORM_SRGB,        1, 4, COMPONENT_TYPE_UNORM_SRGB,   false, 1,1);

        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC6H_TYPELESS,           16, 3, COMPONENT_TYPE_COMPRESSED,  true, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC6H_UF16,               16, 3, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC6H_SF16,               16, 3, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC7_TYPELESS,            16, 4, COMPONENT_TYPE_COMPRESSED,  true, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC7_UNORM,               16, 4, COMPONENT_TYPE_COMPRESSED, false, 4,4);
        INIT_TEX_FORMAT_INFO( TEX_FORMAT_BC7_UNORM_SRGB,          16, 4, COMPONENT_TYPE_COMPRESSED, false, 4,4);
#undef  INIT_TEX_FORMAT_INFO
        // clang-format on
        static_assert(TEX_FORMAT_NUM_FORMATS == TEX_FORMAT_BC7_UNORM_SRGB + 1, ""Not all texture formats initialized."");

#ifdef DILIGENT_DEBUG
        for (Uint32 Fmt = TEX_FORMAT_UNKNOWN; Fmt < TEX_FORMAT_NUM_FORMATS; ++Fmt)
            VERIFY(FmtAttribs[Fmt].Format == static_cast<TEXTURE_FORMAT>(Fmt), ""Uninitialized format"");
#endif

        bIsInit = true;
    }

    if (Format >= TEX_FORMAT_UNKNOWN && Format < TEX_FORMAT_NUM_FORMATS)
    {
        const auto& Attribs = FmtAttribs[Format];
        VERIFY(Attribs.Format == Format, ""Unexpected format"");
        return Attribs;
    }
    else
    {
        UNEXPECTED(""Texture format ("", int{Format}, "") is out of allowed range [0, "", int{TEX_FORMAT_NUM_FORMATS} - 1, ""]"");
        return FmtAttribs[0];
    }
}


const Char* GetTexViewTypeLiteralName(TEXTURE_VIEW_TYPE ViewType)
{
    static const Char* TexViewLiteralNames[TEXTURE_VIEW_NUM_VIEWS] = {};
    static bool        bIsInit                                     = false;
    // Note that this implementation is thread-safe
    // Even if two threads try to call the function at the same time,
    // the worst thing that might happen is that the array will be
    // initialized multiple times. But the result will always be correct.
    if (!bIsInit)
    {
        // clang-format off
#define INIT_TEX_VIEW_TYPE_NAME(ViewType)TexViewLiteralNames[ViewType] = #ViewType
        INIT_TEX_VIEW_TYPE_NAME( TEXTURE_VIEW_UNDEFINED );
        INIT_TEX_VIEW_TYPE_NAME( TEXTURE_VIEW_SHADER_RESOURCE );
        INIT_TEX_VIEW_TYPE_NAME( TEXTURE_VIEW_RENDER_TARGET );
        INIT_TEX_VIEW_TYPE_NAME( TEXTURE_VIEW_DEPTH_STENCIL );
        INIT_TEX_VIEW_TYPE_NAME( TEXTURE_VIEW_UNORDERED_ACCESS );
#undef  INIT_TEX_VIEW_TYPE_NAME
        // clang-format on
        static_assert(TEXTURE_VIEW_NUM_VIEWS == TEXTURE_VIEW_UNORDERED_ACCESS + 1, ""Not all texture views names initialized."");

        bIsInit = true;
    }

    if (ViewType >= TEXTURE_VIEW_UNDEFINED && ViewType < TEXTURE_VIEW_NUM_VIEWS)
    {
        return TexViewLiteralNames[ViewType];
    }
    else
    {
        UNEXPECTED(""Texture view type ("", ViewType, "") is out of allowed range [0, "", TEXTURE_VIEW_NUM_VIEWS - 1, ""]"");
        return ""<Unknown texture view type>"";
    }
}

const Char* GetBufferViewTypeLiteralName(BUFFER_VIEW_TYPE ViewType)
{
    static const Char* BuffViewLiteralNames[BUFFER_VIEW_NUM_VIEWS] = {};
    static bool        bIsInit                                     = false;
    // Note that this implementation is thread-safe
    // Even if two threads try to call the function at the same time,
    // the worst thing that might happen is that the array will be
    // initialized multiple times. But the result will always be correct.
    if (!bIsInit)
    {
        // clang-format off
#define INIT_BUFF_VIEW_TYPE_NAME(ViewType)BuffViewLiteralNames[ViewType] = #ViewType
        INIT_BUFF_VIEW_TYPE_NAME( BUFFER_VIEW_UNDEFINED );
        INIT_BUFF_VIEW_TYPE_NAME( BUFFER_VIEW_SHADER_RESOURCE );
        INIT_BUFF_VIEW_TYPE_NAME( BUFFER_VIEW_UNORDERED_ACCESS );
 #undef INIT_BUFF_VIEW_TYPE_NAME
        // clang-format on
        static_assert(BUFFER_VIEW_NUM_VIEWS == BUFFER_VIEW_UNORDERED_ACCESS + 1, ""Not all buffer views names initialized."");

        bIsInit = true;
    }

    if (ViewType >= BUFFER_VIEW_UNDEFINED && ViewType < BUFFER_VIEW_NUM_VIEWS)
    {
        return BuffViewLiteralNames[ViewType];
    }
    else
    {
        UNEXPECTED(""Buffer view type ("", ViewType, "") is out of allowed range [0, "", BUFFER_VIEW_NUM_VIEWS - 1, ""]"");
        return ""<Unknown buffer view type>"";
    }
}

const Char* GetShaderTypeLiteralName(SHADER_TYPE ShaderType)
{
    switch (ShaderType)
    {
        // clang-format off
#define RETURN_SHADER_TYPE_NAME(ShaderType)\\
        case ShaderType: return #ShaderType;

        RETURN_SHADER_TYPE_NAME( SHADER_TYPE_UNKNOWN )
        RETURN_SHADER_TYPE_NAME( SHADER_TYPE_VERTEX  )
        RETURN_SHADER_TYPE_NAME( SHADER_TYPE_PIXEL   )
        RETURN_SHADER_TYPE_NAME( SHADER_TYPE_GEOMETRY)
        RETURN_SHADER_TYPE_NAME( SHADER_TYPE_HULL    )
        RETURN_SHADER_TYPE_NAME( SHADER_TYPE_DOMAIN  )
        RETURN_SHADER_TYPE_NAME( SHADER_TYPE_COMPUTE )
#undef  RETURN_SHADER_TYPE_NAME
            // clang-format on

        default: UNEXPECTED(""Unknown shader type constant "", Uint32{ShaderType}); return ""<Unknown shader type>"";
    }
}

String GetShaderStagesString(SHADER_TYPE ShaderStages)
{
    String StagesStr;
    for (Uint32 Stage = SHADER_TYPE_VERTEX; ShaderStages != 0 && Stage <= SHADER_TYPE_COMPUTE; Stage <<= 1)
    {
        if (ShaderStages & Stage)
        {
            if (StagesStr.length())
                StagesStr += "", "";
            StagesStr += GetShaderTypeLiteralName(static_cast<SHADER_TYPE>(Stage));
            ShaderStages &= ~static_cast<SHADER_TYPE>(Stage);
        }
    }
    VERIFY_EXPR(ShaderStages == 0);
    return StagesStr;
}

const Char* GetShaderVariableTypeLiteralName(SHADER_RESOURCE_VARIABLE_TYPE VarType, bool bGetFullName)
{
    static const Char* ShortVarTypeNameStrings[SHADER_RESOURCE_VARIABLE_TYPE_NUM_TYPES];
    static const Char* FullVarTypeNameStrings[SHADER_RESOURCE_VARIABLE_TYPE_NUM_TYPES];
    static bool        bVarTypeStrsInit = false;
    if (!bVarTypeStrsInit)
    {
        ShortVarTypeNameStrings[SHADER_RESOURCE_VARIABLE_TYPE_STATIC]  = ""static"";
        ShortVarTypeNameStrings[SHADER_RESOURCE_VARIABLE_TYPE_MUTABLE] = ""mutable"";
        ShortVarTypeNameStrings[SHADER_RESOURCE_VARIABLE_TYPE_DYNAMIC] = ""dynamic"";
        FullVarTypeNameStrings[SHADER_RESOURCE_VARIABLE_TYPE_STATIC]   = ""SHADER_RESOURCE_VARIABLE_TYPE_STATIC"";
        FullVarTypeNameStrings[SHADER_RESOURCE_VARIABLE_TYPE_MUTABLE]  = ""SHADER_RESOURCE_VARIABLE_TYPE_MUTABLE"";
        FullVarTypeNameStrings[SHADER_RESOURCE_VARIABLE_TYPE_DYNAMIC]  = ""SHADER_RESOURCE_VARIABLE_TYPE_DYNAMIC"";

        static_assert(SHADER_RESOURCE_VARIABLE_TYPE_NUM_TYPES == SHADER_RESOURCE_VARIABLE_TYPE_DYNAMIC + 1, ""Not all shader variable types initialized."");

        bVarTypeStrsInit = true;
    }
    if (VarType >= SHADER_RESOURCE_VARIABLE_TYPE_STATIC && VarType < SHADER_RESOURCE_VARIABLE_TYPE_NUM_TYPES)
        return (bGetFullName ? FullVarTypeNameStrings : ShortVarTypeNameStrings)[VarType];
    else
    {
        UNEXPECTED(""Unknow shader variable type"");
        return ""unknow"";
    }
}


const Char* GetShaderResourceTypeLiteralName(SHADER_RESOURCE_TYPE ResourceType, bool bGetFullName)
{
    switch (ResourceType)
    {
        // clang-format off
        case SHADER_RESOURCE_TYPE_UNKNOWN:         return bGetFullName ?  ""SHADER_RESOURCE_TYPE_UNKNOWN""         : ""unknown"";
        case SHADER_RESOURCE_TYPE_CONSTANT_BUFFER: return bGetFullName ?  ""SHADER_RESOURCE_TYPE_CONSTANT_BUFFER"" : ""constant buffer"";
        case SHADER_RESOURCE_TYPE_TEXTURE_SRV:     return bGetFullName ?  ""SHADER_RESOURCE_TYPE_TEXTURE_SRV""     : ""texture SRV"";
        case SHADER_RESOURCE_TYPE_BUFFER_SRV:      return bGetFullName ?  ""SHADER_RESOURCE_TYPE_BUFFER_SRV""      : ""buffer SRV"";
        case SHADER_RESOURCE_TYPE_TEXTURE_UAV:     return bGetFullName ?  ""SHADER_RESOURCE_TYPE_TEXTURE_UAV""     : ""texture UAV"";
        case SHADER_RESOURCE_TYPE_BUFFER_UAV:      return bGetFullName ?  ""SHADER_RESOURCE_TYPE_BUFFER_UAV""      : ""buffer UAV"";
        case SHADER_RESOURCE_TYPE_SAMPLER:         return bGetFullName ?  ""SHADER_RESOURCE_TYPE_SAMPLER""         : ""sampler"";
        // clang-format on
        default:
            UNEXPECTED(""Unexepcted resource type ("", Uint32{ResourceType}, "")"");
            return ""UNKNOWN"";
    }
}

const Char* GetFilterTypeLiteralName(FILTER_TYPE FilterType, bool bGetFullName)
{
    switch (FilterType)
    {
        // clang-format off
        case FILTER_TYPE_UNKNOWN:                return bGetFullName ? ""FILTER_TYPE_UNKNOWN""                : ""unknown"";
        case FILTER_TYPE_POINT:                  return bGetFullName ? ""FILTER_TYPE_POINT""                  : ""point"";
        case FILTER_TYPE_LINEAR:                 return bGetFullName ? ""FILTER_TYPE_LINEAR""                 : ""linear"";
        case FILTER_TYPE_ANISOTROPIC:            return bGetFullName ? ""FILTER_TYPE_ANISOTROPIC""            : ""anisotropic"";
        case FILTER_TYPE_COMPARISON_POINT:       return bGetFullName ? ""FILTER_TYPE_COMPARISON_POINT""       : ""comparison point"";
        case FILTER_TYPE_COMPARISON_LINEAR:      return bGetFullName ? ""FILTER_TYPE_COMPARISON_LINEAR""      : ""comparison linear"";
        case FILTER_TYPE_COMPARISON_ANISOTROPIC: return bGetFullName ? ""FILTER_TYPE_COMPARISON_ANISOTROPIC"" : ""comparison anisotropic"";
        case FILTER_TYPE_MINIMUM_POINT:          return bGetFullName ? ""FILTER_TYPE_MINIMUM_POINT""          : ""minimum point"";
        case FILTER_TYPE_MINIMUM_LINEAR:         return bGetFullName ? ""FILTER_TYPE_MINIMUM_LINEAR""         : ""minimum linear"";
        case FILTER_TYPE_MINIMUM_ANISOTROPIC:    return bGetFullName ? ""FILTER_TYPE_MINIMUM_ANISOTROPIC""    : ""minimum anisotropic"";
        case FILTER_TYPE_MAXIMUM_POINT:          return bGetFullName ? ""FILTER_TYPE_MAXIMUM_POINT""          : ""maximum point"";
        case FILTER_TYPE_MAXIMUM_LINEAR:         return bGetFullName ? ""FILTER_TYPE_MAXIMUM_LINEAR""         : ""maximum linear"";
        case FILTER_TYPE_MAXIMUM_ANISOTROPIC:    return bGetFullName ? ""FILTER_TYPE_MAXIMUM_ANISOTROPIC""    : ""maximum anisotropic"";
        // clang-format on
        default:
            UNEXPECTED(""Unexepcted filter type ("", Uint32{FilterType}, "")"");
            return ""UNKNOWN"";
    }
}

const Char* GetTextureAddressModeLiteralName(TEXTURE_ADDRESS_MODE AddressMode, bool bGetFullName)
{
    switch (AddressMode)
    {
        // clang-format off
        case TEXTURE_ADDRESS_UNKNOWN:     return bGetFullName ? ""TEXTURE_ADDRESS_UNKNOWN""     : ""unknown"";
        case TEXTURE_ADDRESS_WRAP:        return bGetFullName ? ""TEXTURE_ADDRESS_WRAP""        : ""wrap"";
        case TEXTURE_ADDRESS_MIRROR:      return bGetFullName ? ""TEXTURE_ADDRESS_MIRROR""      : ""mirror"";
        case TEXTURE_ADDRESS_CLAMP:       return bGetFullName ? ""TEXTURE_ADDRESS_CLAMP""       : ""clamp"";
        case TEXTURE_ADDRESS_BORDER:      return bGetFullName ? ""TEXTURE_ADDRESS_BORDER""      : ""border"";
        case TEXTURE_ADDRESS_MIRROR_ONCE: return bGetFullName ? ""TEXTURE_ADDRESS_MIRROR_ONCE"" : ""mirror once"";
        // clang-format on
        default:
            UNEXPECTED(""Unexepcted texture address mode ("", Uint32{AddressMode}, "")"");
            return ""UNKNOWN"";
    }
}

const Char* GetComparisonFunctionLiteralName(COMPARISON_FUNCTION ComparisonFunc, bool bGetFullName)
{
    switch (ComparisonFunc)
    {
        // clang-format off
        case COMPARISON_FUNC_UNKNOWN:       return bGetFullName ? ""COMPARISON_FUNC_UNKNOWN""      : ""unknown"";
        case COMPARISON_FUNC_NEVER:         return bGetFullName ? ""COMPARISON_FUNC_NEVER""        : ""never"";
        case COMPARISON_FUNC_LESS:          return bGetFullName ? ""COMPARISON_FUNC_LESS""         : ""less"";
        case COMPARISON_FUNC_EQUAL:         return bGetFullName ? ""COMPARISON_FUNC_EQUAL""        : ""equal"";
        case COMPARISON_FUNC_LESS_EQUAL:    return bGetFullName ? ""COMPARISON_FUNC_LESS_EQUAL""   : ""less equal"";
        case COMPARISON_FUNC_GREATER:       return bGetFullName ? ""COMPARISON_FUNC_GREATER""      : ""greater"";
        case COMPARISON_FUNC_NOT_EQUAL:     return bGetFullName ? ""COMPARISON_FUNC_NOT_EQUAL""    : ""not equal"";
        case COMPARISON_FUNC_GREATER_EQUAL: return bGetFullName ? ""COMPARISON_FUNC_GREATER_EQUAL"": ""greater equal"";
        case COMPARISON_FUNC_ALWAYS:        return bGetFullName ? ""COMPARISON_FUNC_ALWAYS""       : ""always"";
        // clang-format on
        default:
            UNEXPECTED(""Unexepcted comparison function ("", Uint32{ComparisonFunc}, "")"");
            return ""UNKNOWN"";
    }
}

const Char* GetStencilOpLiteralName(STENCIL_OP StencilOp)
{
#define STENCIL_OP_TO_STR(Op) \\
    case Op: return #Op

    switch (StencilOp)
    {
        STENCIL_OP_TO_STR(STENCIL_OP_UNDEFINED);
        STENCIL_OP_TO_STR(STENCIL_OP_KEEP);
        STENCIL_OP_TO_STR(STENCIL_OP_ZERO);
        STENCIL_OP_TO_STR(STENCIL_OP_REPLACE);
        STENCIL_OP_TO_STR(STENCIL_OP_INCR_SAT);
        STENCIL_OP_TO_STR(STENCIL_OP_DECR_SAT);
        STENCIL_OP_TO_STR(STENCIL_OP_INVERT);
        STENCIL_OP_TO_STR(STENCIL_OP_INCR_WRAP);
        STENCIL_OP_TO_STR(STENCIL_OP_DECR_WRAP);

        default:
            UNEXPECTED(""Unexepcted stencil operation ("", static_cast<Uint32>(StencilOp), "")"");
            return ""UNKNOWN"";
    }
#undef STENCIL_OP_TO_STR
}

const Char* GetBlendFactorLiteralName(BLEND_FACTOR BlendFactor)
{
#define BLEND_FACTOR_TO_STR(Factor) \\
    case Factor: return #Factor

    switch (BlendFactor)
    {
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_UNDEFINED);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_ZERO);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_ONE);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_SRC_COLOR);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_INV_SRC_COLOR);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_SRC_ALPHA);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_INV_SRC_ALPHA);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_DEST_ALPHA);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_INV_DEST_ALPHA);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_DEST_COLOR);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_INV_DEST_COLOR);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_SRC_ALPHA_SAT);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_BLEND_FACTOR);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_INV_BLEND_FACTOR);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_SRC1_COLOR);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_INV_SRC1_COLOR);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_SRC1_ALPHA);
        BLEND_FACTOR_TO_STR(BLEND_FACTOR_INV_SRC1_ALPHA);

        default:
            UNEXPECTED(""Unexepcted blend factor ("", static_cast<int>(BlendFactor), "")"");
            return ""UNKNOWN"";
    }
#undef BLEND_FACTOR_TO_STR
}

const Char* GetBlendOperationLiteralName(BLEND_OPERATION BlendOp)
{
#define BLEND_OP_TO_STR(BlendOp) \\
    case BlendOp: return #BlendOp

    switch (BlendOp)
    {
        BLEND_OP_TO_STR(BLEND_OPERATION_UNDEFINED);
        BLEND_OP_TO_STR(BLEND_OPERATION_ADD);
        BLEND_OP_TO_STR(BLEND_OPERATION_SUBTRACT);
        BLEND_OP_TO_STR(BLEND_OPERATION_REV_SUBTRACT);
        BLEND_OP_TO_STR(BLEND_OPERATION_MIN);
        BLEND_OP_TO_STR(BLEND_OPERATION_MAX);

        default:
            UNEXPECTED(""Unexepcted blend operation ("", static_cast<int>(BlendOp), "")"");
            return ""UNKNOWN"";
    }
#undef BLEND_OP_TO_STR
}

const Char* GetFillModeLiteralName(FILL_MODE FillMode)
{
#define FILL_MODE_TO_STR(Mode) \\
    case Mode: return #Mode

    switch (FillMode)
    {
        FILL_MODE_TO_STR(FILL_MODE_UNDEFINED);
        FILL_MODE_TO_STR(FILL_MODE_WIREFRAME);
        FILL_MODE_TO_STR(FILL_MODE_SOLID);

        default:
            UNEXPECTED(""Unexepcted fill mode ("", static_cast<int>(FillMode), "")"");
            return ""UNKNOWN"";
    }
#undef FILL_MODE_TO_STR
}

const Char* GetCullModeLiteralName(CULL_MODE CullMode)
{
#define CULL_MODE_TO_STR(Mode) \\
    case Mode: return #Mode

    switch (CullMode)
    {
        CULL_MODE_TO_STR(CULL_MODE_UNDEFINED);
        CULL_MODE_TO_STR(CULL_MODE_NONE);
        CULL_MODE_TO_STR(CULL_MODE_FRONT);
        CULL_MODE_TO_STR(CULL_MODE_BACK);

        default:
            UNEXPECTED(""Unexepcted cull mode ("", static_cast<int>(CullMode), "")"");
            return ""UNKNOWN"";
    }
#undef CULL_MODE_TO_STR
}

const Char* GetMapTypeString(MAP_TYPE MapType)
{
    switch (MapType)
    {
        case MAP_READ: return ""MAP_READ"";
        case MAP_WRITE: return ""MAP_WRITE"";
        case MAP_READ_WRITE: return ""MAP_READ_WRITE"";

        default:
            UNEXPECTED(""Unexpected map type"");
            return ""Unknown map type"";
    }
}

/// Returns the string containing the usage
const Char* GetUsageString(USAGE Usage)
{
    static const Char* UsageStrings[4];
    static bool        bUsageStringsInit = false;
    if (!bUsageStringsInit)
    {
        // clang-format off
#define INIT_USGAGE_STR(Usage)UsageStrings[Usage] = #Usage
        INIT_USGAGE_STR( USAGE_STATIC );
        INIT_USGAGE_STR( USAGE_DEFAULT );
        INIT_USGAGE_STR( USAGE_DYNAMIC );
        INIT_USGAGE_STR( USAGE_STAGING );
#undef  INIT_USGAGE_STR
        // clang-format on
        bUsageStringsInit = true;
    }
    if (Usage >= USAGE_STATIC && Usage <= USAGE_STAGING)
        return UsageStrings[Usage];
    else
    {
        UNEXPECTED(""Unknow usage"");
        return ""Unknown usage"";
    }
}

const Char* GetResourceDimString(RESOURCE_DIMENSION TexType)
{
    static const Char* TexTypeStrings[RESOURCE_DIM_NUM_DIMENSIONS];
    static bool        bTexTypeStrsInit = false;
    if (!bTexTypeStrsInit)
    {
        TexTypeStrings[RESOURCE_DIM_UNDEFINED]      = ""Undefined"";
        TexTypeStrings[RESOURCE_DIM_BUFFER]         = ""Buffer"";
        TexTypeStrings[RESOURCE_DIM_TEX_1D]         = ""Tex 1D"";
        TexTypeStrings[RESOURCE_DIM_TEX_1D_ARRAY]   = ""Tex 1D Array"";
        TexTypeStrings[RESOURCE_DIM_TEX_2D]         = ""Tex 2D"";
        TexTypeStrings[RESOURCE_DIM_TEX_2D_ARRAY]   = ""Tex 2D Array"";
        TexTypeStrings[RESOURCE_DIM_TEX_3D]         = ""Tex 3D"";
        TexTypeStrings[RESOURCE_DIM_TEX_CUBE]       = ""Tex Cube"";
        TexTypeStrings[RESOURCE_DIM_TEX_CUBE_ARRAY] = ""Tex Cube Array"";
        static_assert(RESOURCE_DIM_NUM_DIMENSIONS == RESOURCE_DIM_TEX_CUBE_ARRAY + 1, ""Not all texture type strings initialized."");

        bTexTypeStrsInit = true;
    }
    if (TexType >= RESOURCE_DIM_UNDEFINED && TexType < RESOURCE_DIM_NUM_DIMENSIONS)
        return TexTypeStrings[TexType];
    else
    {
        UNEXPECTED(""Unknow texture type"");
        return ""Unknow texture type"";
    }
}

const Char* GetBindFlagString(Uint32 BindFlag)
{
    VERIFY((BindFlag & (BindFlag - 1)) == 0, ""More than one bind flag specified"");
    switch (BindFlag)
    {
        // clang-format off
#define BIND_FLAG_STR_CASE(Flag) case Flag: return #Flag;
        BIND_FLAG_STR_CASE( BIND_VERTEX_BUFFER )
	    BIND_FLAG_STR_CASE( BIND_INDEX_BUFFER  )
	    BIND_FLAG_STR_CASE( BIND_UNIFORM_BUFFER  )
	    BIND_FLAG_STR_CASE( BIND_SHADER_RESOURCE )
	    BIND_FLAG_STR_CASE( BIND_STREAM_OUTPUT )
	    BIND_FLAG_STR_CASE( BIND_RENDER_TARGET )
	    BIND_FLAG_STR_CASE( BIND_DEPTH_STENCIL )
	    BIND_FLAG_STR_CASE( BIND_UNORDERED_ACCESS )
        BIND_FLAG_STR_CASE( BIND_INDIRECT_DRAW_ARGS )
#undef  BIND_FLAG_STR_CASE
        // clang-format on
        default: UNEXPECTED(""Unexpected bind flag "", BindFlag); return """";
    }
}

String GetBindFlagsString(Uint32 BindFlags)
{
    if (BindFlags == 0)
        return ""0"";
    String Str;
    for (Uint32 Flag = BIND_VERTEX_BUFFER; BindFlags && Flag <= BIND_INDIRECT_DRAW_ARGS; Flag <<= 1)
    {
        if (BindFlags & Flag)
        {
            if (Str.length())
                Str += '|';
            Str += GetBindFlagString(Flag);
            BindFlags &= ~Flag;
        }
    }
    VERIFY(BindFlags == 0, ""Unknown bind flags left"");
    return Str;
}


static const Char* GetSingleCPUAccessFlagString(Uint32 CPUAccessFlag)
{
    VERIFY((CPUAccessFlag & (CPUAccessFlag - 1)) == 0, ""More than one access flag specified"");
    switch (CPUAccessFlag)
    {
        // clang-format off
#define CPU_ACCESS_FLAG_STR_CASE(Flag) case Flag: return #Flag;
        CPU_ACCESS_FLAG_STR_CASE( CPU_ACCESS_READ )
	    CPU_ACCESS_FLAG_STR_CASE( CPU_ACCESS_WRITE  )
#undef  CPU_ACCESS_FLAG_STR_CASE
        // clang-format on
        default: UNEXPECTED(""Unexpected CPU access flag "", CPUAccessFlag); return """";
    }
}

String GetCPUAccessFlagsString(Uint32 CpuAccessFlags)
{
    if (CpuAccessFlags == 0)
        return ""0"";
    String Str;
    for (Uint32 Flag = CPU_ACCESS_READ; CpuAccessFlags && Flag <= CPU_ACCESS_WRITE; Flag <<= 1)
    {
        if (CpuAccessFlags & Flag)
        {
            if (Str.length())
                Str += '|';
            Str += GetSingleCPUAccessFlagString(Flag);
            CpuAccessFlags &= ~Flag;
        }
    }
    VERIFY(CpuAccessFlags == 0, ""Unknown CPU access flags left"");
    return Str;
}

// There is a nice standard function to_string, but there is a bug on gcc
// and it does not work
template <typename T>
String ToString(T Val)
{
    std::stringstream ss;
    ss << Val;
    return ss.str();
}

String GetTextureDescString(const TextureDesc& Desc)
{
    String Str = ""Type: "";
    Str += GetResourceDimString(Desc.Type);
    Str += ""; size: "";
    Str += ToString(Desc.Width);
    if (Desc.Type == RESOURCE_DIM_TEX_2D || Desc.Type == RESOURCE_DIM_TEX_2D_ARRAY || Desc.Type == RESOURCE_DIM_TEX_3D || Desc.Type == RESOURCE_DIM_TEX_CUBE || Desc.Type == RESOURCE_DIM_TEX_CUBE_ARRAY)
    {
        Str += ""x"";
        Str += ToString(Desc.Height);
    }

    if (Desc.Type == RESOURCE_DIM_TEX_3D)
    {
        Str += ""x"";
        Str += ToString(Desc.Depth);
    }

    if (Desc.Type == RESOURCE_DIM_TEX_1D_ARRAY || Desc.Type == RESOURCE_DIM_TEX_2D_ARRAY || Desc.Type == RESOURCE_DIM_TEX_CUBE || Desc.Type == RESOURCE_DIM_TEX_CUBE_ARRAY)
    {
        Str += ""; Num Slices: "";
        Str += ToString(Desc.ArraySize);
    }

    auto FmtName = GetTextureFormatAttribs(Desc.Format).Name;
    Str += ""; Format: "";
    Str += FmtName;

    Str += ""; Mip levels: "";
    Str += ToString(Desc.MipLevels);

    Str += ""; Sample Count: "";
    Str += ToString(Desc.SampleCount);

    Str += ""; Usage: "";
    Str += GetUsageString(Desc.Usage);

    Str += ""; Bind Flags: "";
    Str += GetBindFlagsString(Desc.BindFlags);

    Str += ""; CPU access: "";
    Str += GetCPUAccessFlagsString(Desc.CPUAccessFlags);

    return Str;
}

const Char* GetBufferModeString(BUFFER_MODE Mode)
{
    static const Char* BufferModeStrings[BUFFER_MODE_NUM_MODES];
    static bool        bBuffModeStringsInit = false;
    if (!bBuffModeStringsInit)
    {
        // clang-format off
#define INIT_BUFF_MODE_STR(Mode)BufferModeStrings[Mode] = #Mode
        INIT_BUFF_MODE_STR( BUFFER_MODE_UNDEFINED );
        INIT_BUFF_MODE_STR( BUFFER_MODE_FORMATTED );
        INIT_BUFF_MODE_STR( BUFFER_MODE_STRUCTURED );
        INIT_BUFF_MODE_STR( BUFFER_MODE_RAW );
#undef  INIT_BUFF_MODE_STR
        // clang-format on
        static_assert(BUFFER_MODE_NUM_MODES == BUFFER_MODE_RAW + 1, ""Not all buffer mode strings initialized."");
        bBuffModeStringsInit = true;
    }
    if (Mode >= BUFFER_MODE_UNDEFINED && Mode < BUFFER_MODE_NUM_MODES)
        return BufferModeStrings[Mode];
    else
    {
        UNEXPECTED(""Unknown buffer mode"");
        return ""Unknown buffer mode"";
    }
}

String GetBufferFormatString(const BufferFormat& Fmt)
{
    String Str;
    Str += GetValueTypeString(Fmt.ValueType);
    if (Fmt.IsNormalized)
        Str += "" norm"";
    Str += "" x "";
    Str += ToString(Uint32{Fmt.NumComponents});
    return Str;
}

String GetBufferDescString(const BufferDesc& Desc)
{
    String Str;
    Str += ""Size: "";
    bool bIsLarge = false;
    if (Desc.uiSizeInBytes > (1 << 20))
    {
        Str += ToString(Desc.uiSizeInBytes / (1 << 20));
        Str += "" Mb ("";
        bIsLarge = true;
    }
    else if (Desc.uiSizeInBytes > (1 << 10))
    {
        Str += ToString(Desc.uiSizeInBytes / (1 << 10));
        Str += "" Kb ("";
        bIsLarge = true;
    }

    Str += ToString(Desc.uiSizeInBytes);
    Str += "" bytes"";
    if (bIsLarge)
        Str += ')';

    Str += ""; Mode: "";
    Str += GetBufferModeString(Desc.Mode);

    Str += ""; Usage: "";
    Str += GetUsageString(Desc.Usage);

    Str += ""; Bind Flags: "";
    Str += GetBindFlagsString(Desc.BindFlags);

    Str += ""; CPU access: "";
    Str += GetCPUAccessFlagsString(Desc.CPUAccessFlags);

    Str += ""; stride: "";
    Str += ToString(Desc.ElementByteStride);
    Str += "" bytes"";

    return Str;
}

const Char* GetResourceStateFlagString(RESOURCE_STATE State)
{
    VERIFY((State & (State - 1)) == 0, ""Single state is expected"");
    switch (State)
    {
        // clang-format off
        case RESOURCE_STATE_UNKNOWN:           return ""UNKNOWN"";
        case RESOURCE_STATE_UNDEFINED:         return ""UNDEFINED"";
        case RESOURCE_STATE_VERTEX_BUFFER:     return ""VERTEX_BUFFER"";
        case RESOURCE_STATE_CONSTANT_BUFFER:   return ""CONSTANT_BUFFER"";
        case RESOURCE_STATE_INDEX_BUFFER:      return ""INDEX_BUFFER"";
        case RESOURCE_STATE_RENDER_TARGET:     return ""RENDER_TARGET"";
        case RESOURCE_STATE_UNORDERED_ACCESS:  return ""UNORDERED_ACCESS"";
        case RESOURCE_STATE_DEPTH_WRITE:       return ""DEPTH_WRITE"";
        case RESOURCE_STATE_DEPTH_READ:        return ""DEPTH_READ"";
        case RESOURCE_STATE_SHADER_RESOURCE:   return ""SHADER_RESOURCE"";
        case RESOURCE_STATE_STREAM_OUT:        return ""STREAM_OUT"";
        case RESOURCE_STATE_INDIRECT_ARGUMENT: return ""INDIRECT_ARGUMENT"";
        case RESOURCE_STATE_COPY_DEST:         return ""COPY_DEST"";
        case RESOURCE_STATE_COPY_SOURCE:       return ""COPY_SOURCE"";
        case RESOURCE_STATE_RESOLVE_DEST:      return ""RESOLVE_DEST"";
        case RESOURCE_STATE_RESOLVE_SOURCE:    return ""RESOLVE_SOURCE"";
        case RESOURCE_STATE_PRESENT:           return ""PRESENT"";
        // clang-format on
        default:
            UNEXPECTED(""Unknown resource state"");
            return ""UNKNOWN"";
    }
}

String GetResourceStateString(RESOURCE_STATE State)
{
    if (State == RESOURCE_STATE_UNKNOWN)
        return ""UNKNOWN"";

    String str;
    while (State != 0)
    {
        if (!str.empty())
            str.push_back('|');

        auto lsb = State & ~(State - 1);

        const auto* StateFlagString = GetResourceStateFlagString(static_cast<RESOURCE_STATE>(lsb));
        str.append(StateFlagString);
        State = static_cast<RESOURCE_STATE>(State & ~lsb);
    }
    return str;
}

const char* GetQueryTypeString(QUERY_TYPE QueryType)
{
    // clang-format off
    switch(QueryType)
    {
        case QUERY_TYPE_UNDEFINED:           return ""QUERY_TYPE_UNDEFINED"";
        case QUERY_TYPE_OCCLUSION:           return ""QUERY_TYPE_OCCLUSION"";
        case QUERY_TYPE_BINARY_OCCLUSION:    return ""QUERY_TYPE_BINARY_OCCLUSION"";
        case QUERY_TYPE_TIMESTAMP:           return ""QUERY_TYPE_TIMESTAMP"";
        case QUERY_TYPE_PIPELINE_STATISTICS: return ""QUERY_TYPE_PIPELINE_STATISTICS"";
        default:
            UNEXPECTED(""Unepxected query type"");
            return ""Unknown"";
    }
    // clang-format on
}

const char* GetSurfaceTransformString(SURFACE_TRANSFORM SrfTransform)
{
    // clang-format off
    switch (SrfTransform)
    {
#define SRF_TRANSFORM_CASE(Transform) case Transform: return #Transform

        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_OPTIMAL);
        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_IDENTITY);
        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_ROTATE_90);
        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_ROTATE_180);
        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_ROTATE_270);
        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_HORIZONTAL_MIRROR);
        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_90);
        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_180);
        SRF_TRANSFORM_CASE(SURFACE_TRANSFORM_HORIZONTAL_MIRROR_ROTATE_270);

#undef SRF_TRANSFORM_CASE

        default:
            UNEXPECTED(""Unexpected surface transform"");
            return ""UNKNOWN"";
    }
    // clang-format on
}

Uint32 ComputeMipLevelsCount(Uint32 Width)
{
    if (Width == 0)
        return 0;

    Uint32 MipLevels = 0;
    while ((Width >> MipLevels) > 0)
        ++MipLevels;
    VERIFY(Width >= (1U << (MipLevels - 1)) && Width < (1U << MipLevels), ""Incorrect number of Mip levels"");
    return MipLevels;
}

Uint32 ComputeMipLevelsCount(Uint32 Width, Uint32 Height)
{
    return ComputeMipLevelsCount(std::max(Width, Height));
}

Uint32 ComputeMipLevelsCount(Uint32 Width, Uint32 Height, Uint32 Depth)
{
    return ComputeMipLevelsCount(std::max(std::max(Width, Height), Depth));
}

bool VerifyResourceStates(RESOURCE_STATE State, bool IsTexture)
{
    static_assert(RESOURCE_STATE_MAX_BIT == 0x8000, ""Please update this function to handle the new resource state"");

    // clang-format off
#define VERIFY_EXCLUSIVE_STATE(ExclusiveState)\\
if ( (State & ExclusiveState) != 0 && (State & ~ExclusiveState) != 0 )\\
{\\
    LOG_ERROR_MESSAGE(""State "", GetResourceStateString(State), "" is invalid: "" #ExclusiveState "" can't be combined with any other state"");\\
    return false;\\
}

    VERIFY_EXCLUSIVE_STATE(RESOURCE_STATE_UNDEFINED);
    VERIFY_EXCLUSIVE_STATE(RESOURCE_STATE_UNORDERED_ACCESS);
    VERIFY_EXCLUSIVE_STATE(RESOURCE_STATE_RENDER_TARGET);
    VERIFY_EXCLUSIVE_STATE(RESOURCE_STATE_DEPTH_WRITE);
    VERIFY_EXCLUSIVE_STATE(RESOURCE_STATE_COPY_DEST);
    VERIFY_EXCLUSIVE_STATE(RESOURCE_STATE_RESOLVE_DEST);
    VERIFY_EXCLUSIVE_STATE(RESOURCE_STATE_PRESENT);
#undef VERIFY_EXCLUSIVE_STATE
    // clang-format on

    if (IsTexture)
    {
        // clang-format off
        if (State &
            (RESOURCE_STATE_VERTEX_BUFFER   |
             RESOURCE_STATE_CONSTANT_BUFFER |
             RESOURCE_STATE_INDEX_BUFFER    |
             RESOURCE_STATE_STREAM_OUT      |
             RESOURCE_STATE_INDIRECT_ARGUMENT))
        {
            LOG_ERROR_MESSAGE(""State "", GetResourceStateString(State), "" is invalid: states RESOURCE_STATE_VERTEX_BUFFER, ""
                              ""RESOURCE_STATE_CONSTANT_BUFFER, RESOURCE_STATE_INDEX_BUFFER, RESOURCE_STATE_STREAM_OUT, ""
                              ""RESOURCE_STATE_INDIRECT_ARGUMENT are not applicable to a texture"");
            return false;
        }
        // clang-format on
    }
    else
    {
        // clang-format off
        if (State &
            (RESOURCE_STATE_RENDER_TARGET  |
             RESOURCE_STATE_DEPTH_WRITE    |
             RESOURCE_STATE_DEPTH_READ     |
             RESOURCE_STATE_RESOLVE_SOURCE |
             RESOURCE_STATE_RESOLVE_DEST   |
             RESOURCE_STATE_PRESENT))
        {
            LOG_ERROR_MESSAGE(""State "", GetResourceStateString(State), "" is invalid: states RESOURCE_STATE_RENDER_TARGET, ""
                              ""RESOURCE_STATE_DEPTH_WRITE, RESOURCE_STATE_DEPTH_READ, RESOURCE_STATE_RESOLVE_SOURCE, ""
                              ""RESOURCE_STATE_RESOLVE_DEST, RESOURCE_STATE_PRESENT are not applicable to a buffer"");
            return false;
        }
        // clang-format on
    }

    return true;
}

MipLevelProperties GetMipLevelProperties(const TextureDesc& TexDesc, Uint32 MipLevel)
{
    MipLevelProperties MipProps;
    const auto&        FmtAttribs = GetTextureFormatAttribs(TexDesc.Format);

    MipProps.LogicalWidth  = std::max(TexDesc.Width >> MipLevel, 1u);
    MipProps.LogicalHeight = std::max(TexDesc.Height >> MipLevel, 1u);
    MipProps.Depth         = (TexDesc.Type == RESOURCE_DIM_TEX_3D) ? std::max(TexDesc.Depth >> MipLevel, 1u) : 1u;
    if (FmtAttribs.ComponentType == COMPONENT_TYPE_COMPRESSED)
    {
        VERIFY_EXPR(FmtAttribs.BlockWidth > 1 && FmtAttribs.BlockHeight > 1);
        VERIFY((FmtAttribs.BlockWidth & (FmtAttribs.BlockWidth - 1)) == 0, ""Compressed block width is expected to be power of 2"");
        VERIFY((FmtAttribs.BlockHeight & (FmtAttribs.BlockHeight - 1)) == 0, ""Compressed block height is expected to be power of 2"");
        // For block-compression formats, all parameters are still specified in texels rather than compressed texel blocks (18.4.1)
        MipProps.StorageWidth   = Align(MipProps.LogicalWidth, Uint32{FmtAttribs.BlockWidth});
        MipProps.StorageHeight  = Align(MipProps.LogicalHeight, Uint32{FmtAttribs.BlockHeight});
        MipProps.RowSize        = MipProps.StorageWidth / Uint32{FmtAttribs.BlockWidth} * Uint32{FmtAttribs.ComponentSize}; // ComponentSize is the block size
        MipProps.DepthSliceSize = MipProps.StorageHeight / Uint32{FmtAttribs.BlockHeight} * MipProps.RowSize;
        MipProps.MipSize        = MipProps.DepthSliceSize * MipProps.Depth;
    }
    else
    {
        MipProps.StorageWidth   = MipProps.LogicalWidth;
        MipProps.StorageHeight  = MipProps.LogicalHeight;
        MipProps.RowSize        = MipProps.StorageWidth * Uint32{FmtAttribs.ComponentSize} * Uint32{FmtAttribs.NumComponents};
        MipProps.DepthSliceSize = MipProps.RowSize * MipProps.StorageHeight;
        MipProps.MipSize        = MipProps.DepthSliceSize * MipProps.Depth;
    }

    return MipProps;
}

} // namespace Diligent
",16228,True,2601.0994716529913,median
"/**********************************************************************
 *
 * Name:     mitab_miffile.cpp
 * Project:  MapInfo TAB Read/Write library
 * Language: C++
 * Purpose:  Implementation of the MIDFile class.
 *           To be used by external programs to handle reading/writing of
 *           features from/to MID/MIF datasets.
 * Author:   Stephane Villeneuve, stephane.v@videotron.ca
 *
 **********************************************************************
 * Copyright (c) 1999-2003, Stephane Villeneuve
 * Copyright (c) 2011-2013, Even Rouault <even dot rouault at mines-paris dot org>
 * Copyright (c) 2014, Even Rouault <even.rouault at spatialys.com>
 *
 * 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.
 **********************************************************************/

#include ""cpl_port.h""
#include ""mitab.h""

#include <cctype>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <algorithm>

#include ""cpl_conv.h""
#include ""cpl_error.h""
#include ""cpl_string.h""
#include ""mitab_priv.h""
#include ""mitab_utils.h""
#include ""ogr_core.h""
#include ""ogr_feature.h""
#include ""ogr_spatialref.h""
#include ""ogrsf_frmts.h""

CPL_CVSID(""$Id$"");

/*=====================================================================
 *                      class MIFFile
 *====================================================================*/

/**********************************************************************
 *                   MIFFile::MIFFile()
 *
 * Constructor.
 **********************************************************************/
MIFFile::MIFFile() :
    m_pszFname(NULL),
    m_eAccessMode(TABRead),
    m_nVersion(300),
    // Tab is default delimiter in MIF spec if not explicitly specified.  Use
    // that by default for read mode. In write mode, we will use "","" as
    // delimiter since it's more common than tab (we do this in Open())
    m_pszDelimiter(CPLStrdup(""\\t"")),
    m_pszUnique(NULL),
    m_pszIndex(NULL),
    m_pszCoordSys(NULL),
    m_paeFieldType(NULL),
    m_pabFieldIndexed(NULL),
    m_pabFieldUnique(NULL),
    m_dfXMultiplier(1.0),
    m_dfYMultiplier(1.0),
    m_dfXDisplacement(0.0),
    m_dfYDisplacement(0.0),
    m_dXMin(0),
    m_dYMin(0),
    m_dXMax(0),
    m_dYMax(0),
    m_bExtentsSet(FALSE),
    m_nPoints(0),
    m_nLines(0),
    m_nRegions(0),
    m_nTexts(0),
    m_nPreloadedId(0),
    m_poMIDFile(NULL),
    m_poMIFFile(NULL),
    m_poDefn(NULL),
    m_poSpatialRef(NULL),
    m_nFeatureCount(0),
    m_nWriteFeatureId(-1),
    m_nAttribute(0),
    m_bPreParsed(FALSE),
    m_bHeaderWrote(FALSE)
{
    m_nCurFeatureId = 0;
    m_poCurFeature = NULL;
}

/**********************************************************************
 *                   MIFFile::~MIFFile()
 *
 * Destructor.
 **********************************************************************/
MIFFile::~MIFFile()
{
    Close();
}

/**********************************************************************
 *                   MIFFile::Open()
 *
 * Returns 0 on success, -1 on error.
 **********************************************************************/
int MIFFile::Open(const char *pszFname, TABAccess eAccess,
                  GBool bTestOpenNoError /*=FALSE*/ )
{
    char *pszTmpFname = NULL;
    int nFnameLen = 0;

    CPLErrorReset();

    if (m_poMIFFile)
    {
        CPLError(CE_Failure, CPLE_FileIO,
                     ""Open() failed: object already contains an open file"");

        return -1;
    }

    /*-----------------------------------------------------------------
     * Validate access mode
     *----------------------------------------------------------------*/
    const char* pszAccess = NULL;
    if (eAccess == TABRead)
    {
        m_eAccessMode = TABRead;
        pszAccess = ""rt"";
    }
    else if (eAccess == TABWrite)
    {
        m_eAccessMode = TABWrite;
        pszAccess = ""wt"";

        // In write mode, use "","" as delimiter since it's more common than tab
        CPLFree(m_pszDelimiter);
        m_pszDelimiter = CPLStrdup("","");
    }
    else
    {
        if (!bTestOpenNoError)
            CPLError(CE_Failure, CPLE_FileIO,
                 ""Open() failed: access mode \\""%d\\"" not supported"", eAccess);
        else
            CPLErrorReset();

        return -1;
    }

    /*-----------------------------------------------------------------
     * Make sure filename has a .MIF or .MID extension...
     *----------------------------------------------------------------*/
    m_pszFname = CPLStrdup(pszFname);
    nFnameLen = static_cast<int>(strlen(m_pszFname));
    if (nFnameLen > 4 && (strcmp(m_pszFname+nFnameLen-4, "".MID"")==0 ||
                     strcmp(m_pszFname+nFnameLen-4, "".MIF"")==0 ) )
        strcpy(m_pszFname+nFnameLen-4, "".MIF"");
    else if (nFnameLen > 4 && (EQUAL(m_pszFname+nFnameLen-4, "".mid"") ||
                               EQUAL(m_pszFname+nFnameLen-4, "".mif"") ) )
        strcpy(m_pszFname+nFnameLen-4, "".mif"");
    else
    {
        if (!bTestOpenNoError)
            CPLError(CE_Failure, CPLE_FileIO,
                     ""Open() failed for %s: invalid filename extension"",
                     m_pszFname);
        else
            CPLErrorReset();

        return -1;
    }

    pszTmpFname = CPLStrdup(m_pszFname);

    /*-----------------------------------------------------------------
     * Open .MIF file
     *----------------------------------------------------------------*/

#ifndef _WIN32
    /*-----------------------------------------------------------------
     * On Unix, make sure extension uses the right cases
     * We do it even for write access because if a file with the same
     * extension already exists we want to overwrite it.
     *----------------------------------------------------------------*/
    TABAdjustFilenameExtension(pszTmpFname);
#endif

    m_poMIFFile = new MIDDATAFile;

    if (m_poMIFFile->Open(pszTmpFname, pszAccess) != 0)
    {
        if (!bTestOpenNoError)
            CPLError(CE_Failure, CPLE_NotSupported,
                     ""Unable to open %s."", pszTmpFname);
        else
            CPLErrorReset();

        CPLFree(pszTmpFname);
        Close();

        return -1;
    }

    /*-----------------------------------------------------------------
     * Read MIF File Header
     *----------------------------------------------------------------*/
    int bIsEmpty = FALSE;
    if (m_eAccessMode == TABRead && ParseMIFHeader(&bIsEmpty) != 0)
    {
        Close();

        if (!bTestOpenNoError)
            CPLError(CE_Failure, CPLE_NotSupported,
                     ""Failed parsing header in %s."", m_pszFname);
        else
            CPLErrorReset();

        CPLFree(pszTmpFname);

        return -1;
    }

    if ( m_nAttribute > 0 || m_eAccessMode == TABWrite )
    {
        /*-----------------------------------------------------------------
        * Open .MID file
        *----------------------------------------------------------------*/
        if (nFnameLen > 4 && strcmp(pszTmpFname+nFnameLen-4, "".MIF"")==0)
            strcpy(pszTmpFname+nFnameLen-4, "".MID"");
        else
            strcpy(pszTmpFname+nFnameLen-4, "".mid"");

#ifndef _WIN32
        TABAdjustFilenameExtension(pszTmpFname);
#endif

        m_poMIDFile = new MIDDATAFile;

        if (m_poMIDFile->Open(pszTmpFname, pszAccess) !=0)
        {
            if (m_eAccessMode == TABWrite)
            {
                if (!bTestOpenNoError)
                    CPLError(CE_Failure, CPLE_NotSupported,
                            ""Unable to open %s."", pszTmpFname);
                else
                    CPLErrorReset();

                CPLFree(pszTmpFname);
                Close();

                return -1;
            }
            else
            {
                CPLDebug(""MITAB"",
                         ""%s is not found, although %d attributes are declared"",
                         pszTmpFname, m_nAttribute);
                delete m_poMIDFile;
                m_poMIDFile = NULL;
            }
        }
    }

    CPLFree(pszTmpFname);
    pszTmpFname = NULL;

    /*-----------------------------------------------------------------
     * In write access, set some defaults
     *----------------------------------------------------------------*/
    if (m_eAccessMode == TABWrite)
    {
        m_nVersion = 300;
        m_pszCharset = CPLStrdup(""Neutral"");
    }

    /* Put the MID file at the correct location, on the first feature */
    if (m_eAccessMode == TABRead && (m_poMIDFile != NULL && !bIsEmpty && m_poMIDFile->GetLine() == NULL))
    {
        Close();

        if (bTestOpenNoError)
            CPLErrorReset();

        return -1;
    }

    m_poMIFFile->SetTranslation(m_dfXMultiplier,m_dfYMultiplier,
                                m_dfXDisplacement, m_dfYDisplacement);
    if( m_poMIDFile != NULL )
        m_poMIDFile->SetTranslation(m_dfXMultiplier,m_dfYMultiplier,
                                    m_dfXDisplacement, m_dfYDisplacement);
    m_poMIFFile->SetDelimiter(m_pszDelimiter);
    if( m_poMIDFile != NULL )
        m_poMIDFile->SetDelimiter(m_pszDelimiter);

    /*-------------------------------------------------------------
     * Set geometry type if the geometry objects are uniform.
     *------------------------------------------------------------*/
    int numPoints=0, numRegions=0, numTexts=0, numLines=0;

    if( GetFeatureCountByType( numPoints, numLines, numRegions, numTexts,
                               FALSE ) == 0 )
    {
        numPoints += numTexts;
        if( numPoints > 0 && numLines == 0 && numRegions == 0 )
            m_poDefn->SetGeomType( wkbPoint );
        else if( numPoints == 0 && numLines > 0 && numRegions == 0 )
            m_poDefn->SetGeomType( wkbLineString );
        else
        {
            /* we leave it unknown indicating a mixture */
        }
    }

    /* A newly created layer should have OGRFeatureDefn */
    if (m_poDefn == NULL)
    {
        char *pszFeatureClassName = TABGetBasename(m_pszFname);
        m_poDefn = new OGRFeatureDefn(pszFeatureClassName);
        CPLFree(pszFeatureClassName);
        // Ref count defaults to 0... set it to 1
        m_poDefn->Reference();
    }

    return 0;
}

/**********************************************************************
 *                   MIFFile::ParseMIFHeader()
 *
 * Scan the header of a MIF file, and store any useful information into
 * class members.  The main piece of information being the fields
 * definition that we use to build the OGRFeatureDefn for this file.
 *
 * This private method should be used only during the Open() call.
 *
 * Returns 0 on success, -1 on error.
 **********************************************************************/
int MIFFile::ParseMIFHeader(int* pbIsEmpty)
{
    *pbIsEmpty = FALSE;

    char *pszFeatureClassName = TABGetBasename(m_pszFname);
    m_poDefn = new OGRFeatureDefn(pszFeatureClassName);
    CPLFree(pszFeatureClassName);
    // Ref count defaults to 0... set it to 1
    m_poDefn->Reference();

    if (m_eAccessMode != TABRead)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""ParseMIDFile() can be used only with Read access."");
        return -1;
    }

    /*-----------------------------------------------------------------
     * Parse header until we find the ""Data"" line
     *----------------------------------------------------------------*/
    char **papszToken = NULL;
    GBool bColumns = FALSE;
    GBool bAllColumnsRead =  FALSE;
    int nColumns = 0;
    GBool bCoordSys = FALSE;

    const char *pszLine = NULL;
    while (((pszLine = m_poMIFFile->GetLine()) != NULL) &&
           ((bAllColumnsRead == FALSE) || !STARTS_WITH_CI(pszLine, ""Data"")))
    {
        if (bColumns == TRUE && nColumns >0)
        {
            if (AddFields(pszLine) == 0)
            {
                nColumns--;
                if (nColumns == 0)
                {
                  bAllColumnsRead = TRUE;
                  bColumns = FALSE;
                }
            }
            else
            {
                bColumns = FALSE;
            }
        }
        else if (STARTS_WITH_CI(pszLine, ""VERSION""))
        {
            papszToken = CSLTokenizeStringComplex(pszLine,"" ()\\t"",TRUE,FALSE);
            bColumns = FALSE; bCoordSys = FALSE;
            if (CSLCount(papszToken)  == 2)
              m_nVersion = atoi(papszToken[1]);

            CSLDestroy(papszToken);
        }
        else if (STARTS_WITH_CI(pszLine, ""CHARSET""))
        {
            papszToken = CSLTokenizeStringComplex(pszLine,"" ()\\t"",TRUE,FALSE);
            bColumns = FALSE; bCoordSys = FALSE;

            if (CSLCount(papszToken)  == 2)
            {
                CPLFree(m_pszCharset);
                m_pszCharset = CPLStrdup(papszToken[1]);
            }
            CSLDestroy(papszToken);
        }
        else if (STARTS_WITH_CI(pszLine, ""DELIMITER""))
        {
            papszToken = CSLTokenizeStringComplex(pszLine,"" ()\\t"",TRUE,FALSE);
             bColumns = FALSE; bCoordSys = FALSE;

           if (CSLCount(papszToken)  == 2)
           {
               CPLFree(m_pszDelimiter);
               m_pszDelimiter = CPLStrdup(papszToken[1]);
           }
          CSLDestroy(papszToken);
        }
        else if (m_pszUnique == NULL &&
                 STARTS_WITH_CI(pszLine, ""UNIQUE""))
        {
            bColumns = FALSE; bCoordSys = FALSE;

            m_pszUnique = CPLStrdup(pszLine + 6);
        }
        else if (m_pszIndex == NULL &&
                 STARTS_WITH_CI(pszLine, ""INDEX""))
        {
            bColumns = FALSE; bCoordSys = FALSE;

            m_pszIndex = CPLStrdup(pszLine + 5);
        }
        else if (m_pszCoordSys == NULL &&
                 STARTS_WITH_CI(pszLine, ""COORDSYS"") &&
                 CPLStrnlen(pszLine, 9) >= 9)
        {
            bCoordSys = TRUE;
            m_pszCoordSys = CPLStrdup(pszLine + 9);

            // Extract bounds if present
            char  **papszFields =
                CSLTokenizeStringComplex(m_pszCoordSys, "" ,()\\t"", TRUE, FALSE );
            int iBounds = CSLFindString( papszFields, ""Bounds"" );
            if (iBounds >= 0 && iBounds + 4 < CSLCount(papszFields))
            {
                m_dXMin = CPLAtof(papszFields[++iBounds]);
                m_dYMin = CPLAtof(papszFields[++iBounds]);
                m_dXMax = CPLAtof(papszFields[++iBounds]);
                m_dYMax = CPLAtof(papszFields[++iBounds]);
                m_bBoundsSet = TRUE;
            }
            CSLDestroy( papszFields );
        }
        else if (STARTS_WITH_CI(pszLine, ""TRANSFORM""))
        {
            papszToken = CSLTokenizeStringComplex(pszLine,"" ,\\t"",TRUE,FALSE);
            bColumns = FALSE; bCoordSys = FALSE;

            if (CSLCount(papszToken) == 5)
            {
                m_dfXMultiplier   = CPLAtof(papszToken[1]);
                m_dfYMultiplier   = CPLAtof(papszToken[2]);
                m_dfXDisplacement = CPLAtof(papszToken[3]);
                m_dfYDisplacement = CPLAtof(papszToken[4]);

                if (m_dfXMultiplier == 0.0)
                  m_dfXMultiplier = 1.0;
                if (m_dfYMultiplier == 0.0)
                  m_dfYMultiplier = 1.0;
            }
            CSLDestroy(papszToken);
        }
        else if (STARTS_WITH_CI(pszLine, ""COLUMNS""))
        {
            papszToken = CSLTokenizeStringComplex(pszLine,"" ()\\t"",TRUE,FALSE);
            bCoordSys = FALSE;
            bColumns = TRUE;
            if (CSLCount(papszToken) == 2)
            {
                nColumns = atoi(papszToken[1]);
                m_nAttribute = nColumns;
                if (nColumns == 0)
                {
                    // Permit to 0 columns
                    bAllColumnsRead = TRUE;
                    bColumns = FALSE;
                }
            }
            else
            {
                bColumns = FALSE;
                m_nAttribute = 0;
            }
            CSLDestroy(papszToken);
        }
        else if (bCoordSys == TRUE)
        {
            char *pszTmp = m_pszCoordSys;
            m_pszCoordSys = CPLStrdup(CPLSPrintf(""%s %s"",m_pszCoordSys,
                                                 pszLine));
            CPLFree(pszTmp);
            //printf(""Reading CoordSys\\n"");
            // Reading CoordSys
        }
    }

    if (!bAllColumnsRead)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""COLUMNS keyword not found or invalid number of columns read in %s.  File may be corrupt."",
                 m_pszFname);
        return -1;
    }

    if ((pszLine = m_poMIFFile->GetLastLine()) == NULL ||
        STARTS_WITH_CI(m_poMIFFile->GetLastLine(), ""DATA"") == FALSE)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""DATA keyword not found in %s.  File may be corrupt."",
                 m_pszFname);
        return -1;
    }

    /*-----------------------------------------------------------------
     * Move pointer to first line of first object
     *----------------------------------------------------------------*/
    while (((pszLine = m_poMIFFile->GetLine()) != NULL) &&
           m_poMIFFile->IsValidFeature(pszLine) == FALSE)
        ;

    *pbIsEmpty = (pszLine == NULL);

    /*-----------------------------------------------------------------
     * Check for Unique and Indexed flags
     *----------------------------------------------------------------*/
    if (m_pszIndex)
    {
        papszToken = CSLTokenizeStringComplex(m_pszIndex,"" ,\\t"",TRUE,FALSE);
        for(int i=0; papszToken && papszToken[i]; i++)
        {
            int nVal = atoi(papszToken[i]);
            if (nVal > 0 && nVal <= m_poDefn->GetFieldCount())
                m_pabFieldIndexed[nVal-1] = TRUE;
        }
        CSLDestroy(papszToken);
    }

    if (m_pszUnique)
    {
        papszToken = CSLTokenizeStringComplex(m_pszUnique,"" ,\\t"",TRUE,FALSE);
        for(int i=0; papszToken && papszToken[i]; i++)
        {
            int nVal = atoi(papszToken[i]);
            if (nVal > 0 && nVal <= m_poDefn->GetFieldCount())
                m_pabFieldUnique[nVal-1] = TRUE;
        }
        CSLDestroy(papszToken);
    }

    return 0;
}

/************************************************************************/
/*                             AddFields()                              */
/************************************************************************/

int  MIFFile::AddFields(const char *pszLine)
{
    int nStatus = 0;

    CPLAssert(m_bHeaderWrote == FALSE);
    char **papszToken =
        CSLTokenizeStringComplex(pszLine, "" (,)\\t"", TRUE, FALSE);
    int numTok = CSLCount(papszToken);

    if (numTok >= 3 && EQUAL(papszToken[1], ""char""))
    {
        /*-------------------------------------------------
         * CHAR type
         *------------------------------------------------*/
        nStatus = AddFieldNative(papszToken[0], TABFChar,
                                 atoi(papszToken[2]));
    }
    else if (numTok >= 2 && EQUAL(papszToken[1], ""integer""))
    {
        if (numTok == 2)
        {
            /*-------------------------------------------------
             * INTEGER type without a specified width
             *------------------------------------------------*/
            nStatus = AddFieldNative(papszToken[0], TABFInteger);
        }
        else if (numTok > 2)
        {
            /*-------------------------------------------------
             * INTEGER type with a specified width
             *------------------------------------------------*/
            nStatus = AddFieldNative(papszToken[0], TABFInteger, atoi(papszToken[2]));
        }
    }
    else if (numTok >= 2 && EQUAL(papszToken[1], ""smallint""))
    {
        if (numTok == 2)
        {
            /*-------------------------------------------------
             * SMALLINT type without a specified width
             *------------------------------------------------*/
            nStatus = AddFieldNative(papszToken[0], TABFSmallInt);
        }
        else if (numTok > 2)
        {
            /*-------------------------------------------------
             * SMALLINT type with a specified width
             *------------------------------------------------*/
            nStatus = AddFieldNative(papszToken[0], TABFSmallInt, atoi(papszToken[2]));
        }
    }
    else if (numTok >= 4 && EQUAL(papszToken[1], ""decimal""))
    {
        /*-------------------------------------------------
         * DECIMAL type
         *------------------------------------------------*/
        nStatus = AddFieldNative(papszToken[0], TABFDecimal,
                                 atoi(papszToken[2]), atoi(papszToken[3]));
    }
    else if (numTok >= 2 && EQUAL(papszToken[1], ""float""))
    {
        /*-------------------------------------------------
         * FLOAT type
         *------------------------------------------------*/
        nStatus = AddFieldNative(papszToken[0], TABFFloat);
    }
    else if (numTok >= 2 && EQUAL(papszToken[1], ""date""))
    {
        /*-------------------------------------------------
         * DATE type (returned as a string: ""DD/MM/YYYY"" or ""YYYYMMDD"")
         *------------------------------------------------*/
        nStatus = AddFieldNative(papszToken[0], TABFDate);
    }
    else if (numTok >= 2 && EQUAL(papszToken[1], ""time""))
    {
        /*-------------------------------------------------
         *  TIME type (v900, returned as a string: ""HH:MM:SS"" or ""HHMMSSmmm"")
         *------------------------------------------------*/
        nStatus = AddFieldNative(papszToken[0], TABFTime);
    }
    else if (numTok >= 2 && EQUAL(papszToken[1], ""datetime""))
    {
        /*-------------------------------------------------
         * DATETIME type (v900, returned as a string: ""DD/MM/YYYY HH:MM:SS"",
         * ""YYYY/MM/DD HH:MM:SS"" or ""YYYYMMDDHHMMSSmmm"")
         *------------------------------------------------*/
        nStatus = AddFieldNative(papszToken[0], TABFDateTime);
    }
    else if (numTok >= 2 && EQUAL(papszToken[1], ""logical""))
    {
        /*-------------------------------------------------
         * LOGICAL type (value ""T"" or ""F"")
         *------------------------------------------------*/
        nStatus = AddFieldNative(papszToken[0], TABFLogical);
    }
    else
      nStatus = -1; // Unrecognized field type or line corrupt

    CSLDestroy(papszToken);
    papszToken = NULL;

    if (nStatus != 0)
    {
        CPLError(CE_Failure, CPLE_FileIO,
                 ""Failed to parse field definition in file %s"", m_pszFname);
        return -1;
    }

    return 0;
}

/************************************************************************/
/*                          GetFeatureCount()                           */
/************************************************************************/

GIntBig MIFFile::GetFeatureCount (int bForce)
{

    if( m_poFilterGeom != NULL || m_poAttrQuery != NULL )
        return OGRLayer::GetFeatureCount( bForce );
    else
    {
        if (bForce == TRUE)
            PreParseFile();

        if (m_bPreParsed)
            return m_nFeatureCount;
        else
            return -1;
    }
}

/************************************************************************/
/*                            ResetReading()                            */
/************************************************************************/

void MIFFile::ResetReading()

{
    m_poMIFFile->Rewind();

    const char *pszLine = NULL;
    while ((pszLine = m_poMIFFile->GetLine()) != NULL)
      if (STARTS_WITH_CI(pszLine, ""DATA""))
        break;

    while ((pszLine = m_poMIFFile->GetLine()) != NULL)
    {
        if (m_poMIFFile->IsValidFeature(pszLine))
          break;
    }

    if( m_poMIDFile != NULL )
    {
        m_poMIDFile->Rewind();
        m_poMIDFile->GetLine();
    }

    // We're positioned on first feature.  Feature Ids start at 1.
    if (m_poCurFeature)
    {
        delete m_poCurFeature;
        m_poCurFeature = NULL;
    }

    m_nCurFeatureId = 0;
    m_nPreloadedId = 1;
}

/************************************************************************/
/*                            PreParseFile()                            */
/************************************************************************/

void MIFFile::PreParseFile()
{
    char **papszToken = NULL;

    GBool bPLine = FALSE;
    GBool bText = FALSE;

    if (m_bPreParsed == TRUE)
      return;

    m_poMIFFile->Rewind();

    const char *pszLine = NULL;
    while ((pszLine = m_poMIFFile->GetLine()) != NULL)
      if (STARTS_WITH_CI(pszLine, ""DATA""))
        break;

    m_nPoints = m_nLines = m_nRegions = m_nTexts = 0;

    while ((pszLine = m_poMIFFile->GetLine()) != NULL)
    {
        if (m_poMIFFile->IsValidFeature(pszLine))
        {
            bPLine = FALSE;
            bText = FALSE;
            m_nFeatureCount++;
        }

        CSLDestroy(papszToken);
        papszToken = CSLTokenizeString2(pszLine, "" \\t"", CSLT_HONOURSTRINGS);

        if (STARTS_WITH_CI(pszLine, ""POINT""))
        {
            m_nPoints++;
            if (CSLCount(papszToken) == 3)
            {
                UpdateExtents(m_poMIFFile->GetXTrans(CPLAtof(papszToken[1])),
                             m_poMIFFile->GetYTrans(CPLAtof(papszToken[2])));
            }
        }
        else if (STARTS_WITH_CI(pszLine, ""LINE"") ||
                 STARTS_WITH_CI(pszLine, ""RECT"") ||
                 STARTS_WITH_CI(pszLine, ""ROUNDRECT"") ||
                 STARTS_WITH_CI(pszLine, ""ARC"") ||
                 STARTS_WITH_CI(pszLine, ""ELLIPSE""))
        {
            if (CSLCount(papszToken) == 5)
            {
                m_nLines++;
                UpdateExtents(m_poMIFFile->GetXTrans(CPLAtof(papszToken[1])),
                             m_poMIFFile->GetYTrans(CPLAtof(papszToken[2])));
                UpdateExtents(m_poMIFFile->GetXTrans(CPLAtof(papszToken[3])),
                             m_poMIFFile->GetYTrans(CPLAtof(papszToken[4])));
            }
        }
        else if (STARTS_WITH_CI(pszLine, ""REGION"") )
        {
            m_nRegions++;
            bPLine = TRUE;
        }
        else if( STARTS_WITH_CI(pszLine, ""PLINE""))
        {
            m_nLines++;
            bPLine = TRUE;
        }
        else if (STARTS_WITH_CI(pszLine, ""TEXT""))
        {
            m_nTexts++;
            bText = TRUE;
        }
        else if (bPLine == TRUE)
        {
            if (CSLCount(papszToken) == 2 &&
                strchr(""-.0123456789"", papszToken[0][0]) != NULL)
            {
                UpdateExtents( m_poMIFFile->GetXTrans(CPLAtof(papszToken[0])),
                              m_poMIFFile->GetYTrans(CPLAtof(papszToken[1])));
            }
        }
        else if (bText == TRUE)
        {
           if (CSLCount(papszToken) == 4 &&
                strchr(""-.0123456789"", papszToken[0][0]) != NULL)
            {
                UpdateExtents(m_poMIFFile->GetXTrans(CPLAtof(papszToken[0])),
                             m_poMIFFile->GetYTrans(CPLAtof(papszToken[1])));
                UpdateExtents(m_poMIFFile->GetXTrans(CPLAtof(papszToken[2])),
                             m_poMIFFile->GetYTrans(CPLAtof(papszToken[3])));
            }
        }
      }

    CSLDestroy(papszToken);

    m_poMIFFile->Rewind();

    while ((pszLine = m_poMIFFile->GetLine()) != NULL)
      if (STARTS_WITH_CI(pszLine, ""DATA""))
        break;

    while ((pszLine = m_poMIFFile->GetLine()) != NULL)
    {
        if (m_poMIFFile->IsValidFeature(pszLine))
          break;
    }

    if( m_poMIDFile != NULL )
    {
        m_poMIDFile->Rewind();
        m_poMIDFile->GetLine();
    }

    m_bPreParsed = TRUE;
}

/**********************************************************************
 *                   MIFFile::WriteMIFHeader()
 *
 * Generate the .MIF header.
 *
 * Returns 0 on success, -1 on error.
 **********************************************************************/
int MIFFile::WriteMIFHeader()
{
    GBool bFound;

    if (m_eAccessMode != TABWrite)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""WriteMIFHeader() can be used only with Write access."");
        return -1;
    }

    if (m_poDefn==NULL || m_poDefn->GetFieldCount() == 0)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""File %s must contain at least 1 attribute field."",
                 m_pszFname);
        return -1;
    }

    /*-----------------------------------------------------------------
     * Start writing header.
     *----------------------------------------------------------------*/
    m_bHeaderWrote = TRUE;
    m_poMIFFile->WriteLine(""Version %d\\n"", m_nVersion);
    m_poMIFFile->WriteLine(""Charset \\""%s\\""\\n"", m_pszCharset);

    // Delimiter is not required if you use \\t as delimiter
    if ( !EQUAL(m_pszDelimiter, ""\\t"") )
        m_poMIFFile->WriteLine(""Delimiter \\""%s\\""\\n"", m_pszDelimiter);

    bFound = FALSE;

    for( int iField = 0; iField<m_poDefn->GetFieldCount(); iField++ )
    {
        if (m_pabFieldUnique[iField])
        {
            if (!bFound)
                m_poMIFFile->WriteLine(""Unique %d"", iField+1);
            else
                m_poMIFFile->WriteLine("",%d"", iField+1);
            bFound = TRUE;
        }
    }
    if (bFound)
        m_poMIFFile->WriteLine(""\\n"");

    bFound = FALSE;
    for( int iField = 0; iField < m_poDefn->GetFieldCount(); iField++ )
    {
        if (m_pabFieldIndexed[iField])
        {
            if (!bFound)
                m_poMIFFile->WriteLine(""Index  %d"", iField+1);
            else
                m_poMIFFile->WriteLine("",%d"", iField+1);
            bFound = TRUE;
        }
    }
    if (bFound)
        m_poMIFFile->WriteLine(""\\n"");

    if (m_pszCoordSys && m_bBoundsSet)
    {
        m_poMIFFile->WriteLine(""CoordSys %s ""
                               ""Bounds (%.15g, %.15g) (%.15g, %.15g)\\n"",
                               m_pszCoordSys,
                               m_dXMin, m_dYMin, m_dXMax, m_dYMax);
    }
    else if (m_pszCoordSys)
    {
        m_poMIFFile->WriteLine(""CoordSys %s\\n"",m_pszCoordSys);
    }

    /*-----------------------------------------------------------------
     * Column definitions
     *----------------------------------------------------------------*/
    CPLAssert(m_paeFieldType);

    m_poMIFFile->WriteLine(""Columns %d\\n"", m_poDefn->GetFieldCount());

    for( int iField = 0; iField < m_poDefn->GetFieldCount(); iField++ )
    {
        OGRFieldDefn *poFieldDefn = m_poDefn->GetFieldDefn(iField);

        switch(m_paeFieldType[iField])
        {
          case TABFInteger:
            m_poMIFFile->WriteLine(""  %s Integer\\n"",
                                poFieldDefn->GetNameRef());
            break;
          case TABFSmallInt:
            m_poMIFFile->WriteLine(""  %s SmallInt\\n"",
                                   poFieldDefn->GetNameRef());
            break;
          case TABFFloat:
            m_poMIFFile->WriteLine(""  %s Float\\n"",
                                   poFieldDefn->GetNameRef());
            break;
          case TABFDecimal:
            m_poMIFFile->WriteLine(""  %s Decimal(%d,%d)\\n"",
                                   poFieldDefn->GetNameRef(),
                                   poFieldDefn->GetWidth(),
                                   poFieldDefn->GetPrecision());
            break;
          case TABFLogical:
            m_poMIFFile->WriteLine(""  %s Logical\\n"",
                                   poFieldDefn->GetNameRef());
            break;
          case TABFDate:
            m_poMIFFile->WriteLine(""  %s Date\\n"",
                                   poFieldDefn->GetNameRef());
            break;
          case TABFTime:
            m_poMIFFile->WriteLine(""  %s Time\\n"",
                                   poFieldDefn->GetNameRef());
            break;
          case TABFDateTime:
            m_poMIFFile->WriteLine(""  %s DateTime\\n"",
                                   poFieldDefn->GetNameRef());
            break;
          case TABFChar:
          default:
            m_poMIFFile->WriteLine(""  %s Char(%d)\\n"",
                                   poFieldDefn->GetNameRef(),
                                   poFieldDefn->GetWidth());
        }
    }

    /*-----------------------------------------------------------------
     * Ready to write objects
     *----------------------------------------------------------------*/
    m_poMIFFile->WriteLine(""Data\\n\\n"");

    return 0;
}

/**********************************************************************
 *                   MIFFile::Close()
 *
 * Close current file, and release all memory used.
 *
 * Returns 0 on success, -1 on error.
 **********************************************************************/
int MIFFile::Close()
{
    /* flush .mif header if not already written */
    if ( m_poDefn != NULL && m_bHeaderWrote == FALSE
         && m_eAccessMode != TABRead )
    {
        WriteMIFHeader();
    }

    if (m_poMIDFile)
    {
        m_poMIDFile->Close();
        delete m_poMIDFile;
        m_poMIDFile = NULL;
    }

    if (m_poMIFFile)
    {
        m_poMIFFile->Close();
        delete m_poMIFFile;
        m_poMIFFile = NULL;
    }

    if (m_poCurFeature)
    {
        delete m_poCurFeature;
        m_poCurFeature = NULL;
    }

    /*-----------------------------------------------------------------
     * Note: we have to check the reference count before deleting
     * m_poSpatialRef and m_poDefn
     *----------------------------------------------------------------*/
    if (m_poDefn && m_poDefn->Dereference() == 0)
        delete m_poDefn;
    m_poDefn = NULL;

    if (m_poSpatialRef && m_poSpatialRef->Dereference() == 0)
        delete m_poSpatialRef;
    m_poSpatialRef = NULL;

    CPLFree(m_pszCoordSys);
    m_pszCoordSys = NULL;

    CPLFree(m_pszDelimiter);
    m_pszDelimiter = NULL;

    CPLFree(m_pszUnique);
    m_pszUnique = NULL;

    CPLFree(m_pszFname);
    m_pszFname = NULL;

    m_nVersion = 0;

    CPLFree(m_pszCharset);
    m_pszCharset = NULL;

    CPLFree(m_pabFieldIndexed);
    m_pabFieldIndexed = NULL;
    CPLFree(m_pabFieldUnique);
    m_pabFieldUnique = NULL;

    CPLFree( m_pszIndex );
    m_pszIndex = NULL;

    CPLFree(m_paeFieldType);
    m_paeFieldType = NULL;

    m_nCurFeatureId = 0;
    m_nPreloadedId = 0;
    m_nFeatureCount =0;

    m_bBoundsSet = FALSE;

    return 0;
}

/**********************************************************************
 *                   MIFFile::GetNextFeatureId()
 *
 * Returns feature id that follows nPrevId, or -1 if it is the
 * last feature id.  Pass nPrevId=-1 to fetch the first valid feature id.
 **********************************************************************/
GIntBig MIFFile::GetNextFeatureId(GIntBig nPrevId)
{
    if (m_eAccessMode != TABRead)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""GetNextFeatureId() can be used only with Read access."");
        return -1;
    }

    if (nPrevId <= 0 && m_poMIFFile->GetLastLine() != NULL)
        return 1;       // Feature Ids start at 1
    else if (nPrevId > 0 && m_poMIFFile->GetLastLine() != NULL)
        return nPrevId + 1;
    else
        return -1;
}

/**********************************************************************
 *                   MIFFile::GotoFeature()
 *
 * Private method to move MIF and MID pointers ready to read specified
 * feature.  Note that Feature Ids start at 1.
 *
 * Returns 0 on success, -1 on error (likely request for invalid feature id)
 **********************************************************************/
int MIFFile::GotoFeature(int nFeatureId)
{

    if (nFeatureId < 1)
      return -1;

    if (nFeatureId == m_nPreloadedId) // CorrectPosition
    {
        return 0;
    }
    else
    {
        if (nFeatureId < m_nPreloadedId || m_nCurFeatureId == 0)
            ResetReading();

        while(m_nPreloadedId < nFeatureId)
        {
            if (NextFeature() == FALSE)
              return -1;
        }

        CPLAssert(m_nPreloadedId == nFeatureId);

        return 0;
    }
}

/**********************************************************************
 *                   MIFFile::NextFeature()
 **********************************************************************/

GBool MIFFile::NextFeature()
{
    const char *pszLine = NULL;
    while ((pszLine = m_poMIFFile->GetLine()) != NULL)
    {
        if (m_poMIFFile->IsValidFeature(pszLine))
        {
            if( m_poMIDFile != NULL )
                m_poMIDFile->GetLine();
            m_nPreloadedId++;
            return TRUE;
        }
    }
    return FALSE;
}

/**********************************************************************
 *                   MIFFile::GetFeatureRef()
 *
 * Fill and return a TABFeature object for the specified feature id.
 *
 * The returned pointer is a reference to an object owned and maintained
 * by this MIFFile object.  It should not be altered or freed by the
 * caller and its contents is guaranteed to be valid only until the next
 * call to GetFeatureRef() or Close().
 *
 * Returns NULL if the specified feature id does not exist of if an
 * error happened.  In any case, CPLError() will have been called to
 * report the reason of the failure.
 **********************************************************************/
TABFeature *MIFFile::GetFeatureRef(GIntBig nFeatureId)
{
    if (m_eAccessMode != TABRead)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""GetFeatureRef() can be used only with Read access."");
        return NULL;
    }

    /*-----------------------------------------------------------------
     * Make sure file is opened and Validate feature id by positioning
     * the read pointers for the .MAP and .DAT files to this feature id.
     *----------------------------------------------------------------*/
    if (m_poMIFFile == NULL)
    {
        CPLError(CE_Failure, CPLE_IllegalArg,
                 ""GetFeatureRef() failed: file is not opened!"");
        return NULL;
    }

    if ( !CPL_INT64_FITS_ON_INT32(nFeatureId) || GotoFeature((int)nFeatureId)!= 0 )
    {
        CPLError(CE_Failure, CPLE_IllegalArg,
                 ""GetFeatureRef() failed: invalid feature id "" CPL_FRMT_GIB,
                 nFeatureId);
        return NULL;
    }

    /*-----------------------------------------------------------------
     * Create new feature object of the right type
     *----------------------------------------------------------------*/
    const char *pszLine = NULL;
    if ((pszLine = m_poMIFFile->GetLastLine()) != NULL)
    {
        // Delete previous feature... we'll start we a clean one.
        if (m_poCurFeature)
            delete m_poCurFeature;
        m_poCurFeature = NULL;

        m_nCurFeatureId = m_nPreloadedId;

        if (STARTS_WITH_CI(pszLine, ""NONE""))
        {
            m_poCurFeature = new TABFeature(m_poDefn);
        }
        else if (STARTS_WITH_CI(pszLine, ""POINT""))
        {
            // Special case, we need to know two lines to decide the type
            char **papszToken =
                CSLTokenizeString2(pszLine, "" \\t"", CSLT_HONOURSTRINGS);

            if (CSLCount(papszToken) !=3)
            {
                CSLDestroy(papszToken);
                CPLError(CE_Failure, CPLE_NotSupported,
                         ""GetFeatureRef() failed: invalid point line: '%s'"",
                         pszLine);
                return NULL;
            }

            m_poMIFFile->SaveLine(pszLine);

            if ((pszLine = m_poMIFFile->GetLine()) != NULL)
            {
                CSLDestroy(papszToken);
                papszToken = CSLTokenizeStringComplex(pszLine,"" ,()\\t"",
                                                      TRUE,FALSE);
                if (CSLCount(papszToken)> 0 &&STARTS_WITH_CI(papszToken[0], ""SYMBOL""))
                {
                    switch (CSLCount(papszToken))
                    {
                      case 4:
                        m_poCurFeature = new TABPoint(m_poDefn);
                        break;
                      case 7:
                        m_poCurFeature = new TABFontPoint(m_poDefn);
                        break;
                      case 5:
                        m_poCurFeature = new TABCustomPoint(m_poDefn);
                        break;
                      default:
                        CSLDestroy(papszToken);
                        CPLError(CE_Failure, CPLE_NotSupported,
                                 ""GetFeatureRef() failed: invalid symbol ""
                                 ""line: '%s'"", pszLine);
                        return NULL;
                        break;
                    }
                }
            }
            CSLDestroy(papszToken);

            if (m_poCurFeature == NULL)
            {
                // No symbol clause... default to TABPoint
                m_poCurFeature = new TABPoint(m_poDefn);
            }
        }
        else if (STARTS_WITH_CI(pszLine, ""LINE"") ||
                 STARTS_WITH_CI(pszLine, ""PLINE""))
        {
            m_poCurFeature = new TABPolyline(m_poDefn);
        }
        else if (STARTS_WITH_CI(pszLine, ""REGION""))
        {
            m_poCurFeature = new TABRegion(m_poDefn);
        }
        else if (STARTS_WITH_CI(pszLine, ""ARC""))
        {
            m_poCurFeature = new TABArc(m_poDefn);
        }
        else if (STARTS_WITH_CI(pszLine, ""TEXT""))
        {
            m_poCurFeature = new TABText(m_poDefn);
        }
        else if (STARTS_WITH_CI(pszLine, ""RECT"") ||
                 STARTS_WITH_CI(pszLine, ""ROUNDRECT""))
        {
            m_poCurFeature = new TABRectangle(m_poDefn);
        }
        else if (STARTS_WITH_CI(pszLine, ""ELLIPSE""))
        {
            m_poCurFeature = new TABEllipse(m_poDefn);
        }
        else if (STARTS_WITH_CI(pszLine, ""MULTIPOINT""))
        {
            m_poCurFeature = new TABMultiPoint(m_poDefn);
        }
        else if (STARTS_WITH_CI(pszLine, ""COLLECTION""))
        {
            m_poCurFeature = new TABCollection(m_poDefn);
        }
        else
        {
            if (!EQUAL(pszLine,""""))
               CPLError(CE_Failure, CPLE_NotSupported,
                   ""Error during reading, unknown type %s."",
                     pszLine);

            //m_poCurFeature = new TABDebugFeature(m_poDefn);
            return NULL;
        }
    }

    CPLAssert(m_poCurFeature);
    if (m_poCurFeature == NULL)
        return NULL;

   /*-----------------------------------------------------------------
     * Read fields from the .DAT file
     * GetRecordBlock() has already been called above...
     *----------------------------------------------------------------*/
    if (m_poMIDFile != NULL && m_poCurFeature->ReadRecordFromMIDFile(m_poMIDFile) != 0)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""Error during reading Record."");

        delete m_poCurFeature;
        m_poCurFeature = NULL;
        return NULL;
    }

    /*-----------------------------------------------------------------
     * Read geometry from the .MAP file
     * MoveToObjId() has already been called above...
     *----------------------------------------------------------------*/
    if (m_poCurFeature->ReadGeometryFromMIFFile(m_poMIFFile) != 0)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""Error during reading Geometry."");

        delete m_poCurFeature;
        m_poCurFeature = NULL;
        return NULL;
    }

    /* If the feature geometry is Text, and the value is empty(""""), transform
       it to a geometry none */
    if (m_poCurFeature->GetFeatureClass() == TABFCText)
    {
       TABText *poTextFeature = (TABText*)m_poCurFeature;
       if (strlen(poTextFeature->GetTextString()) == 0)
       {
           TABFeature *poTmpFeature = new TABFeature(m_poDefn);
           for( int i = 0; i < m_poDefn->GetFieldCount(); i++ )
           {
               poTmpFeature->SetField( i, m_poCurFeature->GetRawFieldRef( i ) );
           }
           delete m_poCurFeature;
           m_poCurFeature = poTmpFeature;
       }
    }

    /*---------------------------------------------------------------------
     * The act of reading the geometry causes the first line of the
     * next object to be preloaded.  Set the preloaded id appropriately.
     *--------------------------------------------------------------------- */
    if( m_poMIFFile->GetLastLine() != NULL )
        m_nPreloadedId++;
    else
        m_nPreloadedId = 0;

    /* Update the Current Feature ID */
    m_poCurFeature->SetFID(m_nCurFeatureId);

    return m_poCurFeature;
}

/**********************************************************************
 *                   MIFFile::CreateFeature()
 *
 * Write a new feature to this dataset. The passed in feature is updated
 * with the new feature id.
 *
 * Returns OGRERR_NONE on success, or an appropriate OGRERR_ code if an
 * error happened in which case, CPLError() will have been called to
 * report the reason of the failure.
 **********************************************************************/
OGRErr MIFFile::CreateFeature(TABFeature *poFeature)
{
    int nFeatureId = -1;

    if (m_eAccessMode != TABWrite)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""CreateFeature() can be used only with Write access."");
        return OGRERR_UNSUPPORTED_OPERATION;
    }

    /*-----------------------------------------------------------------
     * Make sure file is opened and establish new feature id.
     *----------------------------------------------------------------*/
    if (m_poMIDFile == NULL)
    {
        CPLError(CE_Failure, CPLE_IllegalArg,
                 ""CreateFeature() failed: file is not opened!"");
        return OGRERR_FAILURE;
    }

    if (m_bHeaderWrote == FALSE)
    {
        /*-------------------------------------------------------------
         * OK, this is the first feature in the dataset... make sure the
         * .MID schema has been initialized.
         *------------------------------------------------------------*/
        if (m_poDefn == NULL)
            SetFeatureDefn(poFeature->GetDefnRef(), NULL);

         WriteMIFHeader();
         nFeatureId = 1;
    }
    else
    {
        nFeatureId = ++ m_nWriteFeatureId;
    }

    /*-----------------------------------------------------------------
     * Write geometry to the .Mif file
     *----------------------------------------------------------------*/
    if (m_poMIFFile == NULL ||
        poFeature->WriteGeometryToMIFFile(m_poMIFFile) != 0)
    {
        CPLError(CE_Failure, CPLE_FileIO,
                 ""Failed writing geometry for feature id %d in %s"",
                 nFeatureId, m_pszFname);
        return OGRERR_FAILURE;
    }

    if (m_poMIDFile == NULL ||
        poFeature->WriteRecordToMIDFile(m_poMIDFile) != 0 )
    {
        CPLError(CE_Failure, CPLE_FileIO,
                 ""Failed writing attributes for feature id %d in %s"",
                 nFeatureId, m_pszFname);
        return OGRERR_FAILURE;
    }

    poFeature->SetFID(nFeatureId);

    return OGRERR_NONE;
}

/**********************************************************************
 *                   MIFFile::GetLayerDefn()
 *
 * Returns a reference to the OGRFeatureDefn that will be used to create
 * features in this dataset.
 *
 * Returns a reference to an object that is maintained by this MIFFile
 * object (and thus should not be modified or freed by the caller) or
 * NULL if the OGRFeatureDefn has not been initialized yet (i.e. no file
 * opened yet)
 **********************************************************************/
OGRFeatureDefn *MIFFile::GetLayerDefn()
{
    return m_poDefn;
}

/**********************************************************************
 *                   MIFFile::SetFeatureDefn()
 *
 * Pass a reference to the OGRFeatureDefn that will be used to create
 * features in this dataset.  This function should be called after
 * creating a new dataset, but before writing the first feature.
 * All features that will be written to this dataset must share this same
 * OGRFeatureDefn.
 *
 * This function will use poFeatureDefn to create a local copy that
 * will be used to build the .MID file, etc.
 *
 * Returns 0 on success, -1 on error.
 **********************************************************************/
int MIFFile::SetFeatureDefn(OGRFeatureDefn *poFeatureDefn,
                         TABFieldType *paeMapInfoNativeFieldTypes /* =NULL */)
{
    /*-----------------------------------------------------------------
     * Check that call happens at the right time in dataset's life.
     *----------------------------------------------------------------*/
    if ( m_eAccessMode == TABWrite && m_bHeaderWrote )
    {
        CPLError(CE_Failure, CPLE_AssertionFailed,
                 ""SetFeatureDefn() must be called after opening a new ""
                 ""dataset, but before writing the first feature to it."");
        return -1;
    }

    /*-----------------------------------------------------------------
     * Delete current feature defn if there is already one.
     * AddFieldNative() will take care of creating a new one for us.
     *----------------------------------------------------------------*/
    if (m_poDefn && m_poDefn->Dereference() == 0)
        delete m_poDefn;
    m_poDefn = NULL;

    /*-----------------------------------------------------------------
     * Copy field information
     *----------------------------------------------------------------*/
    const int numFields = poFeatureDefn->GetFieldCount();
    int nStatus = 0;

    for( int iField = 0; iField<numFields; iField++ )
    {
        TABFieldType eMapInfoType;
        OGRFieldDefn *poFieldDefn = poFeatureDefn->GetFieldDefn(iField);

        if (paeMapInfoNativeFieldTypes)
        {
            eMapInfoType = paeMapInfoNativeFieldTypes[iField];
        }
        else
        {
            /*---------------------------------------------------------
             * Map OGRFieldTypes to MapInfo native types
             *--------------------------------------------------------*/
            switch(poFieldDefn->GetType())
            {
              case OFTInteger:
                eMapInfoType = TABFInteger;
                break;
              case OFTReal:
                eMapInfoType = TABFFloat;
                break;
              case OFTDateTime:
                eMapInfoType = TABFDateTime;
                break;
              case OFTDate:
                eMapInfoType = TABFDate;
                break;
              case OFTTime:
                eMapInfoType = TABFTime;
                break;
              case OFTString:
              default:
                eMapInfoType = TABFChar;
            }
        }

        nStatus = AddFieldNative(poFieldDefn->GetNameRef(), eMapInfoType,
                                 poFieldDefn->GetWidth(),
                                 poFieldDefn->GetPrecision(), FALSE, FALSE);
    }

    return nStatus;
}

/**********************************************************************
 *                   MIFFile::AddFieldNative()
 *
 * Create a new field using a native mapinfo data type... this is an
 * alternative to defining fields through the OGR interface.
 * This function should be called after creating a new dataset, but before
 * writing the first feature.
 *
 * This function will build/update the OGRFeatureDefn that will have to be
 * used when writing features to this dataset.
 *
 * A reference to the OGRFeatureDefn can be obtained using GetLayerDefn().
 *
 * Returns 0 on success, -1 on error.
 **********************************************************************/
int MIFFile::AddFieldNative(const char *pszName, TABFieldType eMapInfoType,
                            int nWidth /*=0*/, int nPrecision /*=0*/,
                            GBool bIndexed /*=FALSE*/, GBool bUnique/*=FALSE*/, int bApproxOK )
{
    char *pszCleanName = NULL;
    int nStatus = 0;
    char szNewFieldName[31+1]; /* 31 is the max characters for a field name*/
    unsigned int nRenameNum = 1;

    /*-----------------------------------------------------------------
     * Check that call happens at the right time in dataset's life.
     *----------------------------------------------------------------*/
    if ( m_eAccessMode == TABWrite && m_bHeaderWrote )
    {
        CPLError(CE_Failure, CPLE_AssertionFailed,
                 ""AddFieldNative() must be called after opening a new ""
                 ""dataset, but before writing the first feature to it."");
        return -1;
    }

    /*-----------------------------------------------------------------
     * Validate field width... must be <= 254
     *----------------------------------------------------------------*/
    if (nWidth > 254)
    {
        CPLError(CE_Warning, CPLE_IllegalArg,
                 ""Invalid size (%d) for field '%s'.  ""
                 ""Size must be 254 or less."", nWidth, pszName);
        nWidth = 254;
    }

    /*-----------------------------------------------------------------
     * Map fields with width=0 (variable length in OGR) to a valid default
     *----------------------------------------------------------------*/
    if (eMapInfoType == TABFDecimal && nWidth == 0)
        nWidth=20;
    else if (eMapInfoType == TABFChar && nWidth == 0)
        nWidth=254; /* char fields */

    /*-----------------------------------------------------------------
     * Create new OGRFeatureDefn if not done yet...
     *----------------------------------------------------------------*/
    if (m_poDefn == NULL)
    {
        char *pszFeatureClassName = TABGetBasename(m_pszFname);
        m_poDefn = new OGRFeatureDefn(pszFeatureClassName);
        CPLFree(pszFeatureClassName);
        // Ref count defaults to 0... set it to 1
        m_poDefn->Reference();
    }

    /*-----------------------------------------------------------------
     * Make sure field name is valid... check for special chars, etc.
     * (pszCleanName will have to be freed.)
     *----------------------------------------------------------------*/
    pszCleanName = TABCleanFieldName(pszName);

    if( !bApproxOK &&
        ( m_poDefn->GetFieldIndex(pszCleanName) >= 0 ||
          !EQUAL(pszName, pszCleanName) ) )
    {
        CPLError( CE_Failure, CPLE_NotSupported,
                  ""Failed to add field named '%s'"",
                  pszName );
    }

    strncpy(szNewFieldName, pszCleanName, sizeof(szNewFieldName)-1);
    szNewFieldName[sizeof(szNewFieldName)-1] = '\\0';

    while (m_poDefn->GetFieldIndex(szNewFieldName) >= 0 && nRenameNum < 10)
    {
      CPLsnprintf( szNewFieldName, sizeof(szNewFieldName), ""%.29s_%.1u"", pszCleanName, nRenameNum );
      nRenameNum ++;
    }

    while (m_poDefn->GetFieldIndex(szNewFieldName) >= 0 && nRenameNum < 100)
    {
      CPLsnprintf( szNewFieldName, sizeof(szNewFieldName), ""%.29s%.2u"", pszCleanName, nRenameNum );
      nRenameNum ++;
    }

    if (m_poDefn->GetFieldIndex(szNewFieldName) >= 0)
    {
      CPLError( CE_Failure, CPLE_NotSupported,
                ""Too many field names like '%s' when truncated to 31 letters ""
                ""for MapInfo format."", pszCleanName );
    }

    if( !EQUAL(pszCleanName,szNewFieldName) )
    {
      CPLError( CE_Warning, CPLE_NotSupported,
                ""Normalized/laundered field name: '%s' to '%s'"",
                pszCleanName,
                szNewFieldName );
    }

    /*-----------------------------------------------------------------
     * Map MapInfo native types to OGR types
     *----------------------------------------------------------------*/
    OGRFieldDefn *poFieldDefn = NULL;

    switch(eMapInfoType)
    {
      case TABFChar:
        /*-------------------------------------------------
         * CHAR type
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName, OFTString);
        poFieldDefn->SetWidth(nWidth);
        break;
      case TABFInteger:
        /*-------------------------------------------------
         * INTEGER type
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName, OFTInteger);
        poFieldDefn->SetWidth(nWidth);
        break;
      case TABFSmallInt:
        /*-------------------------------------------------
         * SMALLINT type
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName, OFTInteger);
        poFieldDefn->SetWidth(nWidth);
        break;
      case TABFDecimal:
        /*-------------------------------------------------
         * DECIMAL type
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName, OFTReal);
        poFieldDefn->SetWidth(nWidth);
        poFieldDefn->SetPrecision(nPrecision);
        break;
      case TABFFloat:
        /*-------------------------------------------------
         * FLOAT type
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName, OFTReal);
        break;
      case TABFDate:
        /*-------------------------------------------------
         * DATE type (V450, returned as a string: ""DD/MM/YYYY"" or ""YYYYMMDD"")
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName,
#ifdef MITAB_USE_OFTDATETIME
                                                   OFTDate);
#else
                                                   OFTString);
#endif
        poFieldDefn->SetWidth(10);
        m_nVersion = std::max(m_nVersion, 450);
        break;
      case TABFTime:
        /*-------------------------------------------------
         * TIME type (v900, returned as a string: ""HH:MM:SS"" or ""HHMMSSmmm"")
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName,
#ifdef MITAB_USE_OFTDATETIME
                                                   OFTTime);
#else
                                                   OFTString);
#endif
        poFieldDefn->SetWidth(9);
        m_nVersion = std::max(m_nVersion, 900);
        break;
      case TABFDateTime:
        /*-------------------------------------------------
         * DATETIME type (v900, returned as a string: ""DD/MM/YYYY HH:MM:SS"",
         * ""YYYY/MM/DD HH:MM:SS"" or ""YYYYMMDDHHMMSSmmm"")
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName,
#ifdef MITAB_USE_OFTDATETIME
                                                   OFTDateTime);
#else
                                                   OFTString);
#endif
        poFieldDefn->SetWidth(19);
        m_nVersion = std::max(m_nVersion, 900);
        break;
      case TABFLogical:
        /*-------------------------------------------------
         * LOGICAL type (value ""T"" or ""F"")
         *------------------------------------------------*/
        poFieldDefn = new OGRFieldDefn(szNewFieldName, OFTString);
        poFieldDefn->SetWidth(1);
        break;
      default:
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""Unsupported type for field %s"", pszName);
        return -1;
    }

    /*-----------------------------------------------------
     * Add the FieldDefn to the FeatureDefn
     *----------------------------------------------------*/
    m_poDefn->AddFieldDefn(poFieldDefn);
    delete poFieldDefn;

    /*-----------------------------------------------------------------
     * Keep track of native field type
     *----------------------------------------------------------------*/
    m_paeFieldType = (TABFieldType *)CPLRealloc(m_paeFieldType,
                                                m_poDefn->GetFieldCount()*
                                                sizeof(TABFieldType));
    m_paeFieldType[m_poDefn->GetFieldCount()-1] = eMapInfoType;

    /*-----------------------------------------------------------------
     * Extend array of Indexed/Unique flags
     *----------------------------------------------------------------*/
    m_pabFieldIndexed = (GBool *)CPLRealloc(m_pabFieldIndexed,
                                            m_poDefn->GetFieldCount()*
                                            sizeof(GBool));
    m_pabFieldUnique  = (GBool *)CPLRealloc(m_pabFieldUnique,
                                            m_poDefn->GetFieldCount()*
                                            sizeof(GBool));
    m_pabFieldIndexed[m_poDefn->GetFieldCount()-1] = bIndexed;
    m_pabFieldUnique[m_poDefn->GetFieldCount()-1] = bUnique;

    CPLFree(pszCleanName);
    return nStatus;
}

/**********************************************************************
 *                   MIFFile::GetNativeFieldType()
 *
 * Returns the native MapInfo field type for the specified field.
 *
 * Returns TABFUnknown if file is not opened, or if specified field index is
 * invalid.
 **********************************************************************/
TABFieldType MIFFile::GetNativeFieldType(int nFieldId)
{
    if ( m_poDefn==NULL || m_paeFieldType==NULL ||
         nFieldId < 0 || nFieldId >= m_poDefn->GetFieldCount())
        return TABFUnknown;

    return m_paeFieldType[nFieldId];
}

/************************************************************************
 *                       MIFFile::SetFieldIndexed()
 ************************************************************************/

int MIFFile::SetFieldIndexed( int nFieldId )

{
    if ( m_poDefn==NULL || m_pabFieldIndexed==NULL ||
         nFieldId < 0 || nFieldId >= m_poDefn->GetFieldCount())
        return -1;

    m_pabFieldIndexed[nFieldId] = TRUE;

    return 0;
}

/************************************************************************
 *                       MIFFile::IsFieldIndexed()
 ************************************************************************/

GBool MIFFile::IsFieldIndexed( int nFieldId )

{
    if ( m_poDefn==NULL || m_pabFieldIndexed==NULL ||
         nFieldId < 0 || nFieldId >= m_poDefn->GetFieldCount())
        return FALSE;

    return m_pabFieldIndexed[nFieldId];
}

/************************************************************************
 *                       MIFFile::IsFieldUnique()
 ************************************************************************/

GBool MIFFile::IsFieldUnique( int nFieldId )

{
    if ( m_poDefn==NULL || m_pabFieldUnique==NULL ||
         nFieldId < 0 || nFieldId >= m_poDefn->GetFieldCount())
        return FALSE;

    return m_pabFieldUnique[nFieldId];
}

/************************************************************************/
/*                       MIFFile::SetSpatialRef()                       */
/************************************************************************/

int MIFFile::SetSpatialRef( OGRSpatialReference * poSpatialRef )

{
    CPLFree( m_pszCoordSys );

    char* pszCoordSys = MITABSpatialRef2CoordSys( poSpatialRef );
    if( pszCoordSys )
    {
        SetMIFCoordSys(pszCoordSys);
        CPLFree(pszCoordSys);
    }

    return m_pszCoordSys != NULL;
}

/************************************************************************/
/*                      MIFFile::SetMIFCoordSys()                       */
/************************************************************************/

int MIFFile::SetMIFCoordSys(const char * pszMIFCoordSys)

{
    char *pszCoordSys = NULL;

    // Extract the word 'COORDSYS' if present
    if (STARTS_WITH_CI(pszMIFCoordSys, ""COORDSYS"") )
    {
        pszCoordSys = CPLStrdup(pszMIFCoordSys + 9);
    }
    else
    {
        pszCoordSys = CPLStrdup(pszMIFCoordSys);
    }

    // Extract bounds if present
    char **papszFields =
        CSLTokenizeStringComplex(pszCoordSys, "" ,()\\t"", TRUE, FALSE );
    int iBounds = CSLFindString( papszFields, ""Bounds"" );
    if (iBounds >= 0 && iBounds + 4 < CSLCount(papszFields))
    {
        m_dXMin = CPLAtof(papszFields[++iBounds]);
        m_dYMin = CPLAtof(papszFields[++iBounds]);
        m_dXMax = CPLAtof(papszFields[++iBounds]);
        m_dYMax = CPLAtof(papszFields[++iBounds]);
        m_bBoundsSet = TRUE;

        char* pszBounds = strstr(pszCoordSys, "" Bounds"");
        if( pszBounds == NULL )
            pszBounds = strstr(pszCoordSys, ""Bounds"");
        pszCoordSys[pszBounds - pszCoordSys] = '\\0';
    }
    CSLDestroy( papszFields );

    // Assign the CoordSys
    CPLFree( m_pszCoordSys );

    m_pszCoordSys = CPLStrdup(pszCoordSys);
    CPLFree(pszCoordSys);

    return m_pszCoordSys != NULL;
}

/************************************************************************/
/*                       MIFFile::GetSpatialRef()                       */
/************************************************************************/

OGRSpatialReference *MIFFile::GetSpatialRef()

{
    if( m_poSpatialRef == NULL )
        m_poSpatialRef = MITABCoordSys2SpatialRef( m_pszCoordSys );

    return m_poSpatialRef;
}

/**********************************************************************
 *                   MIFFile::UpdateExtents()
 *
 * Private method used to update the dataset extents.
 **********************************************************************/
void MIFFile::UpdateExtents(double dfX, double dfY)
{
    if (m_bExtentsSet == FALSE)
    {
        m_bExtentsSet = TRUE;
        m_sExtents.MinX = m_sExtents.MaxX = dfX;
        m_sExtents.MinY = m_sExtents.MaxY = dfY;
    }
    else
    {
        if (dfX < m_sExtents.MinX)
            m_sExtents.MinX = dfX;
        if (dfX > m_sExtents.MaxX)
          m_sExtents.MaxX = dfX;
        if (dfY < m_sExtents.MinY)
          m_sExtents.MinY = dfY;
        if (dfY > m_sExtents.MaxY)
          m_sExtents.MaxY = dfY;
    }
}

/**********************************************************************
 *                   MIFFile::SetBounds()
 *
 * Set projection coordinates bounds of the newly created dataset.
 *
 * This function must be called after creating a new dataset and before any
 * feature can be written to it.
 *
 * Returns 0 on success, -1 on error.
 **********************************************************************/
int MIFFile::SetBounds( double dXMin, double dYMin,
                        double dXMax, double dYMax )
{
    if (m_eAccessMode != TABWrite)
    {
        CPLError(CE_Failure, CPLE_NotSupported,
                 ""SetBounds() can be used only with Write access."");
        return -1;
    }

    m_dXMin = dXMin;
    m_dXMax = dXMax;
    m_dYMin = dYMin;
    m_dYMax = dYMax;
    m_bBoundsSet = TRUE;

    return 0;
}

/**********************************************************************
 *                   MIFFile::GetFeatureCountByType()
 *
 * Return number of features of each type.
 *
 * NOTE: The current implementation always returns -1 for MIF files
 *       since this would require scanning the whole file.
 *
 * When properly implemented, the bForce flag will force scanning the
 * whole file by default.
 *
 * Returns 0 on success, or silently returns -1 (with no error) if this
 * information is not available.
 **********************************************************************/
int MIFFile::GetFeatureCountByType(int &numPoints, int &numLines,
                                   int &numRegions, int &numTexts,
                                   GBool bForce )
{
    if( m_bPreParsed || bForce )
    {
        PreParseFile();

        numPoints = m_nPoints;
        numLines = m_nLines;
        numRegions = m_nRegions;
        numTexts = m_nTexts;
        return 0;
    }
    else
    {
        numPoints = numLines = numRegions = numTexts = 0;
        return -1;
    }
}

/**********************************************************************
 *                   MIFFile::GetBounds()
 *
 * Fetch projection coordinates bounds of a dataset.
 *
 * Pass bForce=FALSE to avoid a scan of the whole file if the bounds
 * are not already available.
 *
 * Returns 0 on success, -1 on error or if bounds are not available and
 * bForce=FALSE.
 **********************************************************************/
int MIFFile::GetBounds(double &dXMin, double &dYMin,
                       double &dXMax, double &dYMax,
                       GBool bForce /*= TRUE*/ )
{
    if (m_bBoundsSet == FALSE && bForce == FALSE)
    {
        return -1;
    }
    else if (m_bBoundsSet == FALSE)
    {
        PreParseFile();
    }

    if (m_bBoundsSet == FALSE)
    {
        return -1;
    }

    dXMin = m_dXMin;
    dXMax = m_dXMax;
    dYMin = m_dYMin;
    dYMax = m_dYMax;

    return 0;
}

/**********************************************************************
 *                   MIFFile::GetExtent()
 *
 * Fetch extent of the data currently stored in the dataset.  We collect
 * this information while preparsing the file ... often already done for
 * other reasons, and if not it is still faster than fully reading all
 * the features just to count them.
 *
 * Returns OGRERR_NONE/OGRRERR_FAILURE.
 **********************************************************************/
OGRErr MIFFile::GetExtent (OGREnvelope *psExtent, int bForce)
{
    if (bForce == TRUE)
        PreParseFile();

    if (m_bPreParsed)
    {
        *psExtent = m_sExtents;
        return OGRERR_NONE;
    }
    else
        return OGRERR_FAILURE;
}

/************************************************************************/
/*                           TestCapability()                           */
/************************************************************************/

int MIFFile::TestCapability( const char * pszCap )

{
    if( EQUAL(pszCap,OLCRandomRead) )
        return TRUE;

    else if( EQUAL(pszCap,OLCSequentialWrite) )
        return TRUE;

    else if( EQUAL(pszCap,OLCFastFeatureCount) )
        return m_bPreParsed;

    else if( EQUAL(pszCap,OLCFastSpatialFilter) )
        return FALSE;

    else if( EQUAL(pszCap,OLCFastGetExtent) )
        return m_bPreParsed;

    else if( EQUAL(pszCap,OLCCreateField) )
        return TRUE;

    else
        return FALSE;
}
",16224,True,3076.206035987631,median
"// license:BSD-3-Clause
// copyright-holders:Ernesto Corvi, Aaron Giles, Mariusz Wojcieszek
/***************************************************************************

    Amiga Computer / Arcadia Game System

    Driver by:

    Aaron Giles, Ernesto Corvi & Mariusz Wojcieszek

***************************************************************************/

#include ""emu.h""
#include ""includes/amiga.h""
#include ""cpu/m68000/m68000.h""


/*************************************
 *
 *  Debugging
 *
 *************************************/

#define LOG_CUSTOM  0
#define LOG_CIA     0
#define LOG_BLITS   0
#define LOG_SERIAL  1



/*************************************
 *
 *  Constants
 *
 *************************************/

/* How many CPU cycles we delay until we fire a pending interrupt */
#define AMIGA_IRQ_DELAY_CYCLES      24

/* How many CPU cycles we wait until we process a blit when the blitter-nasty bit is set */
#define BLITTER_NASTY_DELAY         16



/*************************************
 *
 *  Globals
 *
 *************************************/

const char *const amiga_state::s_custom_reg_names[0x100] =
{
	/* 0x000 */
	""BLTDDAT"",      ""DMACONR"",      ""VPOSR"",        ""VHPOSR"",
	""DSKDATR"",      ""JOY0DAT"",      ""JOY1DAT"",      ""CLXDAT"",
	""ADKCONR"",      ""POT0DAT"",      ""POT1DAT"",      ""POTGOR"",
	""SERDATR"",      ""DSKBYTR"",      ""INTENAR"",      ""INTREQR"",
	/* 0x020 */
	""DSKPTH"",       ""DSKPTL"",       ""DSKLEN"",       ""DSKDAT"",
	""REFPTR"",       ""VPOSW"",        ""VHPOSW"",       ""COPCON"",
	""SERDAT"",       ""SERPER"",       ""POTGO"",        ""JOYTEST"",
	""STREQU"",       ""STRVBL"",       ""STRHOR"",       ""STRLONG"",
	/* 0x040 */
	""BLTCON0"",      ""BLTCON1"",      ""BLTAFWM"",      ""BLTALWM"",
	""BLTCPTH"",      ""BLTCPTL"",      ""BLTBPTH"",      ""BLTBPTL"",
	""BLTAPTH"",      ""BLTAPTL"",      ""BLTDPTH"",      ""BLTDPTL"",
	""BLTSIZE"",      ""BLTCON0L"",     ""BLTSIZV"",      ""BLTSIZH"",
	/* 0x060 */
	""BLTCMOD"",      ""BLTBMOD"",      ""BLTAMOD"",      ""BLTDMOD"",
	""UNK068"",       ""UNK06A"",       ""UNK06C"",       ""UNK06E"",
	""BLTCDAT"",      ""BLTBDAT"",      ""BLTADAT"",      ""UNK076"",
	""SPRHDAT"",      ""BPLHDAT"",      ""LISAID"",       ""DSRSYNC"",
	/* 0x080 */
	""COP1LCH"",      ""COP1LCL"",      ""COP2LCH"",      ""COP2LCL"",
	""COPJMP1"",      ""COPJMP2"",      ""COPINS"",       ""DIWSTRT"",
	""DIWSTOP"",      ""DDFSTRT"",      ""DDFSTOP"",      ""DMACON"",
	""CLXCON"",       ""INTENA"",       ""INTREQ"",       ""ADKCON"",
	/* 0x0A0 */
	""AUD0LCH"",      ""AUD0LCL"",      ""AUD0LEN"",      ""AUD0PER"",
	""AUD0VOL"",      ""AUD0DAT"",      ""UNK0AC"",       ""UNK0AE"",
	""AUD1LCH"",      ""AUD1LCL"",      ""AUD1LEN"",      ""AUD1PER"",
	""AUD1VOL"",      ""AUD1DAT"",      ""UNK0BC"",       ""UNK0BE"",
	/* 0x0C0 */
	""AUD2LCH"",      ""AUD2LCL"",      ""AUD2LEN"",      ""AUD2PER"",
	""AUD2VOL"",      ""AUD2DAT"",      ""UNK0CC"",       ""UNK0CE"",
	""AUD3LCH"",      ""AUD3LCL"",      ""AUD3LEN"",      ""AUD3PER"",
	""AUD3VOL"",      ""AUD3DAT"",      ""UNK0DC"",       ""UNK0DE"",
	/* 0x0E0 */
	""BPL1PTH"",      ""BPL1PTL"",      ""BPL2PTH"",      ""BPL2PTL"",
	""BPL3PTH"",      ""BPL3PTL"",      ""BPL4PTH"",      ""BPL4PTL"",
	""BPL5PTH"",      ""BPL5PTL"",      ""BPL6PTH"",      ""BPL6PTL"",
	""BPL7PTH"",      ""BPL7PTL"",      ""BPL8PTH"",      ""BPL8PTL"",
	/* 0x100 */
	""BPLCON0"",      ""BPLCON1"",      ""BPLCON2"",      ""BPLCON3"",
	""BPL1MOD"",      ""BPL2MOD"",      ""BPLCON4"",      ""CLXCON2"",
	""BPL1DAT"",      ""BPL2DAT"",      ""BPL3DAT"",      ""BPL4DAT"",
	""BPL5DAT"",      ""BPL6DAT"",      ""BPL7DAT"",      ""BPL8DAT"",
	/* 0x120 */
	""SPR0PTH"",      ""SPR0PTL"",      ""SPR1PTH"",      ""SPR1PTL"",
	""SPR2PTH"",      ""SPR2PTL"",      ""SPR3PTH"",      ""SPR3PTL"",
	""SPR4PTH"",      ""SPR4PTL"",      ""SPR5PTH"",      ""SPR5PTL"",
	""SPR6PTH"",      ""SPR6PTL"",      ""SPR7PTH"",      ""SPR7PTL"",
	/* 0x140 */
	""SPR0POS"",      ""SPR0CTL"",      ""SPR0DATA"",     ""SPR0DATB"",
	""SPR1POS"",      ""SPR1CTL"",      ""SPR1DATA"",     ""SPR1DATB"",
	""SPR2POS"",      ""SPR2CTL"",      ""SPR2DATA"",     ""SPR2DATB"",
	""SPR3POS"",      ""SPR3CTL"",      ""SPR3DATA"",     ""SPR3DATB"",
	/* 0x160 */
	""SPR4POS"",      ""SPR4CTL"",      ""SPR4DATA"",     ""SPR4DATB"",
	""SPR5POS"",      ""SPR5CTL"",      ""SPR5DATA"",     ""SPR5DATB"",
	""SPR6POS"",      ""SPR6CTL"",      ""SPR6DATA"",     ""SPR6DATB"",
	""SPR7POS"",      ""SPR7CTL"",      ""SPR7DATA"",     ""SPR7DATB"",
	/* 0x180 */
	""COLOR00"",      ""COLOR01"",      ""COLOR02"",      ""COLOR03"",
	""COLOR04"",      ""COLOR05"",      ""COLOR06"",      ""COLOR07"",
	""COLOR08"",      ""COLOR09"",      ""COLOR10"",      ""COLOR11"",
	""COLOR12"",      ""COLOR13"",      ""COLOR14"",      ""COLOR15"",
	/* 0x1A0 */
	""COLOR16"",      ""COLOR17"",      ""COLOR18"",      ""COLOR19"",
	""COLOR20"",      ""COLOR21"",      ""COLOR22"",      ""COLOR23"",
	""COLOR24"",      ""COLOR25"",      ""COLOR26"",      ""COLOR27"",
	""COLOR28"",      ""COLOR29"",      ""COLOR30"",      ""COLOR31"",
	/* 0x1C0 */
	""HTOTAL"",       ""HSSTOP"",       ""HBSTRT"",       ""HBSTOP"",
	""VTOTAL"",       ""VSSTOP"",       ""VBSTRT"",       ""VBSTOP"",
	""SPRHSTRT"",     ""SPRHSTOP"",     ""BPLHSTRT"",     ""BPLHSTOP"",
	""HHPOSW"",       ""HHPOSR"",       ""BEAMCON0"",     ""HSSTRT"",
	/* 0x1E0 */
	""VSSTRT"",       ""HCENTER"",      ""DIWHIGH"",      ""BPLHMOD"",
	""SPRHPTH"",      ""SPRHPTL"",      ""BPLHPTH"",      ""BPLHPTL"",
	""UNK1F0"",       ""UNK1F2"",       ""UNK1F4"",       ""UNK1F6"",
	""UNK1F8"",       ""UNK1FA"",       ""FMODE"",        ""UNK1FE""
};

constexpr XTAL amiga_state::CLK_28M_PAL;
constexpr XTAL amiga_state::CLK_7M_PAL;
constexpr XTAL amiga_state::CLK_C1_PAL;
constexpr XTAL amiga_state::CLK_E_PAL;

constexpr XTAL amiga_state::CLK_28M_NTSC;
constexpr XTAL amiga_state::CLK_7M_NTSC;
constexpr XTAL amiga_state::CLK_C1_NTSC;
constexpr XTAL amiga_state::CLK_E_NTSC;


/*************************************
 *
 *  Machine reset
 *
 *************************************/

void amiga_state::machine_start()
{
	// add callback for RESET instruction
	m_maincpu->set_reset_callback(write_line_delegate(FUNC(amiga_state::m68k_reset), this));

	// set up chip RAM access
	memory_share *share = memshare(""chip_ram"");
	if (share == nullptr)
		fatalerror(""Unable to find Amiga chip RAM\\n"");
	m_chip_ram.set(*share, 2);
	m_chip_ram_mask = (m_chip_ram.bytes() - 1) & ~1;

	// set up the timers
	m_irq_timer = timer_alloc(TIMER_AMIGA_IRQ);
	m_blitter_timer = timer_alloc(TIMER_AMIGA_BLITTER);
	m_serial_timer = timer_alloc(TIMER_SERIAL);
	m_scanline_timer = timer_alloc(TIMER_SCANLINE);

	// start the scanline timer
	m_scanline_timer->adjust(m_screen->time_until_pos(0));
}

WRITE_LINE_MEMBER( amiga_state::m68k_reset )
{
	logerror(""%s: Executed RESET\\n"", machine().describe_context());
	machine_reset();
}

void amiga_state::machine_reset()
{
	// reset cia chips
	m_cia_0->reset();
	m_cia_1->reset();

	// reset custom chip registers
	custom_chip_reset();

	// map kickstart rom to location 0
	// this either done by reseting the cia chips
	// or directly by gayle where available
	m_gayle_reset = true;
	m_overlay->set_bank(1);
}

WRITE_LINE_MEMBER(amiga_state::fdc_dskblk_w)
{
	set_interrupt(INTENA_SETCLR | INTENA_DSKBLK);
}

WRITE_LINE_MEMBER(amiga_state::fdc_dsksyn_w)
{
	set_interrupt(INTENA_SETCLR | INTENA_DSKSYN);
}

WRITE_LINE_MEMBER( amiga_state::kbreset_w )
{
	// this is connected to the gary chip, gary then resets the 68k, agnus, paula and the cias
	if (!state)
	{
		m_paula->reset();
		machine_reset();
		m_maincpu->reset();
	}
}

// simple mirror of region 0xf80000 to 0xfbffff
READ16_MEMBER( amiga_state::rom_mirror_r )
{
	return m_maincpu->space(AS_PROGRAM).read_word(offset + 0xf80000, mem_mask);
}

READ32_MEMBER( amiga_state::rom_mirror32_r )
{
	return m_maincpu->space(AS_PROGRAM).read_dword(offset + 0xf80000, mem_mask);
}

void amiga_state::device_timer(emu_timer &timer, device_timer_id id, int param, void *ptr)
{
	switch (id)
	{
	case TIMER_SCANLINE:
		scanline_callback(ptr, param);
		break;
	case TIMER_AMIGA_IRQ:
		amiga_irq_proc(ptr, param);
		break;
	case TIMER_AMIGA_BLITTER:
		amiga_blitter_proc(ptr, param);
		break;
	case TIMER_SERIAL:
		serial_shift();
		break;
	default:
		fatalerror(""Invalid timer: %d\\n"", id);
	}
}


/*************************************
 *
 *  Per scanline callback
 *
 *************************************/

void amiga_state::vblank()
{
}

// todo: cia a clock can be connected to either a fixed 50/60hz signal from the power supply, or the vblank
TIMER_CALLBACK_MEMBER( amiga_state::scanline_callback )
{
	int scanline = param;

	// vblank start
	if (scanline == 0)
	{
		// signal vblank irq
		set_interrupt(INTENA_SETCLR | INTENA_VERTB);

		// clock tod
		m_cia_0->tod_w(1);

		// additional bookkeeping by drivers
		vblank();
	}

	// vblank end
	if (scanline == m_screen->visible_area().min_y)
	{
		m_cia_0->tod_w(0);
	}

	if (m_potgo_port.found())
	{
		// pot counters (start counting at 7 (ntsc) or 8 (pal))
		if (BIT(CUSTOM_REG(REG_POTGO), 0) && (scanline /2 ) > 7)
		{
			m_pot0x += !(m_potgo_port->read() & 0x0100);
			m_pot0y += !(m_potgo_port->read() & 0x0400);
			m_pot1x += !(m_potgo_port->read() & 0x1000);
			m_pot1y += !(m_potgo_port->read() & 0x4000);
		}
	}

	// render up to this scanline
	if (!m_screen->update_partial(scanline))
	{
		if (IS_AGA())
		{
			bitmap_rgb32 dummy_bitmap;
			aga_render_scanline(dummy_bitmap, scanline);
		}
		else
		{
			bitmap_ind16 dummy_bitmap;
			render_scanline(dummy_bitmap, scanline);
		}
	}

	// clock tod (if we actually render this scanline)
	m_cia_1->tod_w((scanline & 1) ^ BIT(CUSTOM_REG(REG_VPOSR), 15));

	// force a sound update
	m_paula->update();

	// set timer for next line
	scanline = (scanline + 1) % m_screen->height();
	m_scanline_timer->adjust(m_screen->time_until_pos(scanline), scanline);
}



/*************************************
 *
 *  Interrupt management
 *
 *************************************/

void amiga_state::set_interrupt(int interrupt)
{
	custom_chip_w(m_maincpu->space(AS_PROGRAM), REG_INTREQ, interrupt, 0xffff);
}

bool amiga_state::int2_pending()
{
	return m_cia_0_irq;
}

bool amiga_state::int6_pending()
{
	return m_cia_1_irq;
}

void amiga_state::update_int2()
{
	set_interrupt((int2_pending() ? INTENA_SETCLR : 0x0000) | INTENA_PORTS);
}

void amiga_state::update_int6()
{
	set_interrupt((int6_pending() ? INTENA_SETCLR : 0x0000) | INTENA_EXTER);
}

void amiga_state::update_irqs()
{
	// if the external interrupt line is still active, set the interrupt request bit
	if (int2_pending())
		CUSTOM_REG(REG_INTREQ) |= INTENA_PORTS;

	if (int6_pending())
		CUSTOM_REG(REG_INTREQ) |= INTENA_EXTER;

	int ints = CUSTOM_REG(REG_INTENA) & CUSTOM_REG(REG_INTREQ);

	// master interrupt switch
	if (CUSTOM_REG(REG_INTENA) & INTENA_INTEN)
	{
		m_maincpu->set_input_line(1, ints & (INTENA_TBE | INTENA_DSKBLK | INTENA_SOFT) ? ASSERT_LINE : CLEAR_LINE);
		m_maincpu->set_input_line(2, ints & (INTENA_PORTS) ? ASSERT_LINE : CLEAR_LINE);
		m_maincpu->set_input_line(3, ints & (INTENA_COPER | INTENA_VERTB | INTENA_BLIT) ? ASSERT_LINE : CLEAR_LINE);
		m_maincpu->set_input_line(4, ints & (INTENA_AUD0 | INTENA_AUD1 | INTENA_AUD2 | INTENA_AUD3) ? ASSERT_LINE : CLEAR_LINE);
		m_maincpu->set_input_line(5, ints & (INTENA_RBF | INTENA_DSKSYN) ? ASSERT_LINE : CLEAR_LINE);
		m_maincpu->set_input_line(6, ints & (INTENA_EXTER) ? ASSERT_LINE : CLEAR_LINE);
	}
	else
	{
		m_maincpu->set_input_line(1, CLEAR_LINE);
		m_maincpu->set_input_line(2, CLEAR_LINE);
		m_maincpu->set_input_line(3, CLEAR_LINE);
		m_maincpu->set_input_line(4, CLEAR_LINE);
		m_maincpu->set_input_line(5, CLEAR_LINE);
		m_maincpu->set_input_line(6, CLEAR_LINE);
	}
}

TIMER_CALLBACK_MEMBER( amiga_state::amiga_irq_proc )
{
	update_irqs();
	m_irq_timer->reset();
}

WRITE_LINE_MEMBER( amiga_state::paula_int_w )
{
	set_interrupt(INTENA_SETCLR | (0x80 << state));
}


//**************************************************************************
//  INPUTS
//**************************************************************************

uint16_t amiga_state::joy0dat_r()
{
	if (!m_input_device.found() || (m_input_device->read() & 0x10))
		return m_joy0dat_port.read_safe(0xffff);
	else
		return (m_p1_mouse_y.read_safe(0xff) << 8) | m_p1_mouse_x.read_safe(0xff);
}

uint16_t amiga_state::joy1dat_r()
{
	if (!m_input_device.found() || m_input_device->read() & 0x20)
		return m_joy1dat_port.read_safe(0xffff);
	else
		return (m_p2_mouse_y.read_safe(0xff) << 8) | m_p2_mouse_x.read_safe(0xff);
}

CUSTOM_INPUT_MEMBER( amiga_state::amiga_joystick_convert )
{
	uint8_t bits = m_joy_ports[(int)(uintptr_t)param].read_safe(0xff);

	int up = (bits >> 0) & 1;
	int down = (bits >> 1) & 1;
	int left = (bits >> 2) & 1;
	int right = (bits >> 3) & 1;

	if (left) up ^= 1;
	if (right) down ^= 1;

	return down | (right << 1) | (up << 8) | (left << 9);
}



/*************************************
 *
 *  Ascending blitter variant
 *
 *************************************/

uint32_t amiga_state::blit_ascending()
{
	uint32_t shifta = (CUSTOM_REG(REG_BLTCON0) >> 12) & 0xf;
	uint32_t shiftb = (CUSTOM_REG(REG_BLTCON1) >> 12) & 0xf;
	uint32_t height = CUSTOM_REG(REG_BLTSIZV);
	uint32_t width = CUSTOM_REG(REG_BLTSIZH);
	uint32_t acca = 0, accb = 0;
	uint32_t blitsum = 0;
	uint32_t x, y;

	/* iterate over the height */
	for (y = 0; y < height; y++)
	{
		/* iterate over the width */
		for (x = 0; x < width; x++)
		{
			uint16_t abc0, abc1, abc2, abc3;
			uint32_t tempa, tempd = 0;
			uint32_t b;

			/* fetch data for A */
			if (CUSTOM_REG(REG_BLTCON0) & 0x0800)
			{
				//CUSTOM_REG(REG_BLTADAT) = m_maincpu->space(AS_PROGRAM).read_word(CUSTOM_REG_LONG(REG_BLTAPTH));
				CUSTOM_REG(REG_BLTADAT) = chip_ram_r(CUSTOM_REG_LONG(REG_BLTAPTH));
				CUSTOM_REG_LONG(REG_BLTAPTH) += 2;
			}

			/* fetch data for B */
			if (CUSTOM_REG(REG_BLTCON0) & 0x0400)
			{
				CUSTOM_REG(REG_BLTBDAT) = chip_ram_r(CUSTOM_REG_LONG(REG_BLTBPTH));
				CUSTOM_REG_LONG(REG_BLTBPTH) += 2;
			}

			/* fetch data for C */
			if (CUSTOM_REG(REG_BLTCON0) & 0x0200)
			{
				CUSTOM_REG(REG_BLTCDAT) = chip_ram_r(CUSTOM_REG_LONG(REG_BLTCPTH));
				CUSTOM_REG_LONG(REG_BLTCPTH) += 2;
			}

			/* apply start/end masks to the A data */
			tempa = CUSTOM_REG(REG_BLTADAT);
			if (x == 0)
				tempa &= CUSTOM_REG(REG_BLTAFWM);
			if (x == width - 1)
				tempa &= CUSTOM_REG(REG_BLTALWM);

			/* update the B accumulator applying shifts */
			acca = (acca << 16) | (tempa << (16 - shifta));
			accb = (accb << 16) | (CUSTOM_REG(REG_BLTBDAT) << (16 - shiftb));

			/* build up 4 16-bit words containing 4 pixels each in 0ABC bit order */
			abc0 = ((acca >> 17) & 0x4444) | ((accb >> 18) & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 3) & 0x1111);
			abc1 = ((acca >> 16) & 0x4444) | ((accb >> 17) & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 2) & 0x1111);
			abc2 = ((acca >> 15) & 0x4444) | ((accb >> 16) & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 1) & 0x1111);
			abc3 = ((acca >> 14) & 0x4444) | ((accb >> 15) & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 0) & 0x1111);

			/* now loop over bits and compute the destination value */
			for (b = 0; b < 4; b++)
			{
				uint32_t bit;

				/* shift previous data up 4 bits */
				tempd <<= 4;

				/* lookup first bit in series */
				bit = (CUSTOM_REG(REG_BLTCON0) >> (abc0 >> 12)) & 1;
				abc0 <<= 4;
				tempd |= bit << 3;

				/* lookup second bit in series */
				bit = (CUSTOM_REG(REG_BLTCON0) >> (abc1 >> 12)) & 1;
				abc1 <<= 4;
				tempd |= bit << 2;

				/* lookup third bit in series */
				bit = (CUSTOM_REG(REG_BLTCON0) >> (abc2 >> 12)) & 1;
				abc2 <<= 4;
				tempd |= bit << 1;

				/* lookup fourth bit in series */
				bit = (CUSTOM_REG(REG_BLTCON0) >> (abc3 >> 12)) & 1;
				abc3 <<= 4;
				tempd |= bit << 0;
			}

			/* accumulate the sum */
			blitsum |= tempd;

			/* write to the destination */
			if (CUSTOM_REG(REG_BLTCON0) & 0x0100)
			{
				chip_ram_w(CUSTOM_REG_LONG(REG_BLTDPTH), tempd);
				CUSTOM_REG_LONG(REG_BLTDPTH) += 2;
			}
		}

		/* apply end of line modulos */
		if (CUSTOM_REG(REG_BLTCON0) & 0x0800)
			CUSTOM_REG_LONG(REG_BLTAPTH) += CUSTOM_REG_SIGNED(REG_BLTAMOD) & ~1;
		if (CUSTOM_REG(REG_BLTCON0) & 0x0400)
			CUSTOM_REG_LONG(REG_BLTBPTH) += CUSTOM_REG_SIGNED(REG_BLTBMOD) & ~1;
		if (CUSTOM_REG(REG_BLTCON0) & 0x0200)
			CUSTOM_REG_LONG(REG_BLTCPTH) += CUSTOM_REG_SIGNED(REG_BLTCMOD) & ~1;
		if (CUSTOM_REG(REG_BLTCON0) & 0x0100)
			CUSTOM_REG_LONG(REG_BLTDPTH) += CUSTOM_REG_SIGNED(REG_BLTDMOD) & ~1;
	}

	/* return the blit sum */
	return blitsum;
}



/*************************************
 *
 *  Descending blitter variant
 *
 *************************************/

uint32_t amiga_state::blit_descending()
{
	uint32_t fill_exclusive = (CUSTOM_REG(REG_BLTCON1) >> 4);
	uint32_t fill_inclusive = (CUSTOM_REG(REG_BLTCON1) >> 3);
	uint32_t shifta = (CUSTOM_REG(REG_BLTCON0) >> 12) & 0xf;
	uint32_t shiftb = (CUSTOM_REG(REG_BLTCON1) >> 12) & 0xf;
	uint32_t height = CUSTOM_REG(REG_BLTSIZV);
	uint32_t width = CUSTOM_REG(REG_BLTSIZH);
	uint32_t acca = 0, accb = 0;
	uint32_t blitsum = 0;
	uint32_t x, y;

	/* iterate over the height */
	for (y = 0; y < height; y++)
	{
		uint32_t fill_state = (CUSTOM_REG(REG_BLTCON1) >> 2) & 1;

		/* iterate over the width */
		for (x = 0; x < width; x++)
		{
			uint16_t abc0, abc1, abc2, abc3;
			uint32_t tempa, tempd = 0;
			uint32_t b;

			/* fetch data for A */
			if (CUSTOM_REG(REG_BLTCON0) & 0x0800)
			{
				CUSTOM_REG(REG_BLTADAT) = chip_ram_r(CUSTOM_REG_LONG(REG_BLTAPTH));
				CUSTOM_REG_LONG(REG_BLTAPTH) -= 2;
			}

			/* fetch data for B */
			if (CUSTOM_REG(REG_BLTCON0) & 0x0400)
			{
				CUSTOM_REG(REG_BLTBDAT) = chip_ram_r(CUSTOM_REG_LONG(REG_BLTBPTH));
				CUSTOM_REG_LONG(REG_BLTBPTH) -= 2;
			}

			/* fetch data for C */
			if (CUSTOM_REG(REG_BLTCON0) & 0x0200)
			{
				CUSTOM_REG(REG_BLTCDAT) = chip_ram_r(CUSTOM_REG_LONG(REG_BLTCPTH));
				CUSTOM_REG_LONG(REG_BLTCPTH) -= 2;
			}

			/* apply start/end masks to the A data */
			tempa = CUSTOM_REG(REG_BLTADAT);
			if (x == 0)
				tempa &= CUSTOM_REG(REG_BLTAFWM);
			if (x == width - 1)
				tempa &= CUSTOM_REG(REG_BLTALWM);

			/* update the B accumulator applying shifts */
			acca = (acca >> 16) | (tempa << shifta);
			accb = (accb >> 16) | (CUSTOM_REG(REG_BLTBDAT) << shiftb);

			/* build up 4 16-bit words containing 4 pixels each in 0ABC bit order */
			abc0 = ((acca >> 1) & 0x4444) | ((accb >> 2) & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 3) & 0x1111);
			abc1 = ((acca >> 0) & 0x4444) | ((accb >> 1) & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 2) & 0x1111);
			abc2 = ((acca << 1) & 0x4444) | ((accb >> 0) & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 1) & 0x1111);
			abc3 = ((acca << 2) & 0x4444) | ((accb << 1) & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 0) & 0x1111);

			/* now loop over bits and compute the destination value */
			for (b = 0; b < 4; b++)
			{
				uint32_t prev_fill_state;
				uint32_t bit;

				/* shift previous data up 4 bits */
				tempd >>= 4;

				/* lookup fourth bit in series */
				bit = (CUSTOM_REG(REG_BLTCON0) >> (abc3 & 0xf)) & 1;
				abc3 >>= 4;
				prev_fill_state = fill_state;
				fill_state ^= bit;
				bit ^= prev_fill_state & fill_exclusive;
				bit |= prev_fill_state & fill_inclusive;
				tempd |= bit << 12;

				/* lookup third bit in series */
				bit = (CUSTOM_REG(REG_BLTCON0) >> (abc2 & 0xf)) & 1;
				abc2 >>= 4;
				prev_fill_state = fill_state;
				fill_state ^= bit;
				bit ^= prev_fill_state & fill_exclusive;
				bit |= prev_fill_state & fill_inclusive;
				tempd |= bit << 13;

				/* lookup second bit in series */
				bit = (CUSTOM_REG(REG_BLTCON0) >> (abc1 & 0xf)) & 1;
				abc1 >>= 4;
				prev_fill_state = fill_state;
				fill_state ^= bit;
				bit ^= prev_fill_state & fill_exclusive;
				bit |= prev_fill_state & fill_inclusive;
				tempd |= bit << 14;

				/* lookup first bit in series */
				bit = (CUSTOM_REG(REG_BLTCON0) >> (abc0 & 0xf)) & 1;
				abc0 >>= 4;
				prev_fill_state = fill_state;
				fill_state ^= bit;
				bit ^= prev_fill_state & fill_exclusive;
				bit |= prev_fill_state & fill_inclusive;
				tempd |= bit << 15;
			}

			/* accumulate the sum */
			blitsum |= tempd;

			/* write to the destination */
			if (CUSTOM_REG(REG_BLTCON0) & 0x0100)
			{
				chip_ram_w(CUSTOM_REG_LONG(REG_BLTDPTH), tempd);
				CUSTOM_REG_LONG(REG_BLTDPTH) -= 2;
			}
		}

		/* apply end of line modulos */
		if (CUSTOM_REG(REG_BLTCON0) & 0x0800)
			CUSTOM_REG_LONG(REG_BLTAPTH) -= CUSTOM_REG_SIGNED(REG_BLTAMOD) & ~1;
		if (CUSTOM_REG(REG_BLTCON0) & 0x0400)
			CUSTOM_REG_LONG(REG_BLTBPTH) -= CUSTOM_REG_SIGNED(REG_BLTBMOD) & ~1;
		if (CUSTOM_REG(REG_BLTCON0) & 0x0200)
			CUSTOM_REG_LONG(REG_BLTCPTH) -= CUSTOM_REG_SIGNED(REG_BLTCMOD) & ~1;
		if (CUSTOM_REG(REG_BLTCON0) & 0x0100)
			CUSTOM_REG_LONG(REG_BLTDPTH) -= CUSTOM_REG_SIGNED(REG_BLTDMOD) & ~1;
	}

	/* return the blit sum */
	return blitsum;
}



/*************************************
 *
 *  Line drawing blitter variant
 *
 *************************************/

/*
    The exact line drawing algorithm is not known, but based on the cryptic
    setup instructions, it is clear that it is a basic Bresenham line
    algorithm. A standard Bresenham algorithm looks like this:

    epsilon = 0;
    while (length--)
    {
        plot(x, y);
        x++;
        epsilon += dy;
        if ((2 * epsilon) >= dx)
        {
            y++;
            epsilon -= dx;
        }
    }

    If you multiply the epsilon term by 4 and shuffle the logic a bit, the
    equivalent logic is:

    epsilon = 4 * dy - 2 * dx;
    while (length--)
    {
        plot(x, y);
        x++;
        if (epsilon >= 0)
        {
            y++;
            epsilon += 4 * (dy - dx);
        }
        else
            epsilon += 4 * dy;
    }

    With this refactoring, you can see that BLTAPT = epsilon,
    BLTAMOD = 4 * (dy - dx) and BLTBMOD = 4 * dy.
*/

uint32_t amiga_state::blit_line()
{
	uint32_t singlemode = (CUSTOM_REG(REG_BLTCON1) & 0x0002) ? 0x0000 : 0xffff;
	uint32_t singlemask = 0xffff;
	uint32_t blitsum = 0;
	uint32_t height;

	/* see if folks are breaking the rules */
	if (CUSTOM_REG(REG_BLTSIZH) != 0x0002)
		logerror(""Blitter: Blit width != 2 in line mode!\\n"");
	if ((CUSTOM_REG(REG_BLTCON0) & 0x0a00) != 0x0a00)
		logerror(""Blitter: Channel selection incorrect in line mode!\\n"" );

	/* extract the length of the line */
	height = CUSTOM_REG(REG_BLTSIZV);

	/* iterate over the line height */
	while (height--)
	{
		uint16_t abc0, abc1, abc2, abc3;
		uint32_t tempa, tempb, tempd = 0;
		int b, dx, dy;

		/* fetch data for C */
		if (CUSTOM_REG(REG_BLTCON0) & 0x0200)
			CUSTOM_REG(REG_BLTCDAT) = chip_ram_r(CUSTOM_REG_LONG(REG_BLTCPTH));

		/* rotate the A data according to the shift */
		tempa = CUSTOM_REG(REG_BLTADAT) >> (CUSTOM_REG(REG_BLTCON0) >> 12);

		/* apply single bit mask */
		tempa &= singlemask;
		singlemask &= singlemode;

		/* rotate the B data according to the shift and expand to 16 bits */
		tempb = -((CUSTOM_REG(REG_BLTBDAT) >> (CUSTOM_REG(REG_BLTCON1) >> 12)) & 1);

		/* build up 4 16-bit words containing 4 pixels each in 0ABC bit order */
		abc0 = ((tempa >> 1) & 0x4444) | (tempb & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 3) & 0x1111);
		abc1 = ((tempa >> 0) & 0x4444) | (tempb & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 2) & 0x1111);
		abc2 = ((tempa << 1) & 0x4444) | (tempb & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 1) & 0x1111);
		abc3 = ((tempa << 2) & 0x4444) | (tempb & 0x2222) | ((CUSTOM_REG(REG_BLTCDAT) >> 0) & 0x1111);

		/* now loop over bits and compute the destination value */
		for (b = 0; b < 4; b++)
		{
			uint32_t bit;

			/* shift previous data up 4 bits */
			tempd <<= 4;

			/* lookup first bit in series */
			bit = (CUSTOM_REG(REG_BLTCON0) >> (abc0 >> 12)) & 1;
			abc0 <<= 4;
			tempd |= bit << 3;

			/* lookup second bit in series */
			bit = (CUSTOM_REG(REG_BLTCON0) >> (abc1 >> 12)) & 1;
			abc1 <<= 4;
			tempd |= bit << 2;

			/* lookup third bit in series */
			bit = (CUSTOM_REG(REG_BLTCON0) >> (abc2 >> 12)) & 1;
			abc2 <<= 4;
			tempd |= bit << 1;

			/* lookup fourth bit in series */
			bit = (CUSTOM_REG(REG_BLTCON0) >> (abc3 >> 12)) & 1;
			abc3 <<= 4;
			tempd |= bit << 0;
		}

		/* accumulate the sum */
		blitsum |= tempd;

		/* write to the destination */
		chip_ram_w(CUSTOM_REG_LONG(REG_BLTDPTH), tempd);

		/* always increment along the major axis */
		if (CUSTOM_REG(REG_BLTCON1) & 0x0010)
		{
			dx = (CUSTOM_REG(REG_BLTCON1) & 0x0004) ? -1 : 1;
			dy = 0;
		}
		else
		{
			dx = 0;
			dy = (CUSTOM_REG(REG_BLTCON1) & 0x0004) ? -1 : 1;
		}

		/* is the sign bit clear? */
		if (!(CUSTOM_REG(REG_BLTCON1) & 0x0040))
		{
			/* add 4 * (dy-dx) */
			CUSTOM_REG_LONG(REG_BLTAPTH) += CUSTOM_REG_SIGNED(REG_BLTAMOD) & ~1;

			/* increment along the minor axis */
			if (CUSTOM_REG(REG_BLTCON1) & 0x0010)
				dy = (CUSTOM_REG(REG_BLTCON1) & 0x0008) ? -1 : 1;
			else
				dx = (CUSTOM_REG(REG_BLTCON1) & 0x0008) ? -1 : 1;
		}

		/* else add 4 * dy and don't increment along the minor axis */
		else
			CUSTOM_REG_LONG(REG_BLTAPTH) += CUSTOM_REG_SIGNED(REG_BLTBMOD) & ~1;

		/* adjust X if necessary */
		if (dx)
		{
			/* adjust the A shift value */
			uint32_t temp = CUSTOM_REG(REG_BLTCON0) + (int32_t)(dx << 12);
			CUSTOM_REG(REG_BLTCON0) = temp;

			/* if we went from 0xf to 0x0 or vice-versa, adjust the actual pointers */
			if (temp & 0x10000)
			{
				CUSTOM_REG_LONG(REG_BLTCPTH) += 2 * dx;
				CUSTOM_REG_LONG(REG_BLTDPTH) += 2 * dx;
			}
		}

		/* adjust Y if necessary */
		if (dy)
		{
			/* BLTCMOD seems to be used for both C and D pointers */
			CUSTOM_REG_LONG(REG_BLTCPTH) += dy * (int16_t)(CUSTOM_REG_SIGNED(REG_BLTCMOD) & ~1);
			CUSTOM_REG_LONG(REG_BLTDPTH) += dy * (int16_t)(CUSTOM_REG_SIGNED(REG_BLTCMOD) & ~1);

			/* reset the single mask since we're on a new line */
			singlemask = 0xffff;
		}

		/* set the new sign bit value */
		CUSTOM_REG(REG_BLTCON1) = (CUSTOM_REG(REG_BLTCON1) & ~0x0040) | ((CUSTOM_REG(REG_BLTAPTL) >> 9) & 0x0040);

		/* increment texture shift on every pixel */
		CUSTOM_REG(REG_BLTCON1) += 0x1000;
	}

	return blitsum;
}



/*************************************
 *
 *  Blitter deferred callback
 *
 *************************************/

TIMER_CALLBACK_MEMBER( amiga_state::amiga_blitter_proc )
{
	uint32_t blitsum = 0;

	/* logging */
	if (LOG_BLITS)
	{
		static const char *const type[] = { ""ASCENDING"", ""LINE"", ""DESCENDING"", ""LINE"" };
		logerror(""BLIT %s: %dx%d  %04x %04x\\n"", type[CUSTOM_REG(REG_BLTCON1) & 0x0003], CUSTOM_REG(REG_BLTSIZH), CUSTOM_REG(REG_BLTSIZV), CUSTOM_REG(REG_BLTCON0), CUSTOM_REG(REG_BLTCON1));
		if (CUSTOM_REG(REG_BLTCON0) & 0x0800)
			logerror(""  A: addr=%06X mod=%3d shift=%2d maskl=%04x maskr=%04x\\n"", CUSTOM_REG_LONG(REG_BLTAPTH), CUSTOM_REG_SIGNED(REG_BLTAMOD), CUSTOM_REG(REG_BLTCON0) >> 12, CUSTOM_REG(REG_BLTAFWM), CUSTOM_REG(REG_BLTALWM));
		if (CUSTOM_REG(REG_BLTCON0) & 0x0400)
			logerror(""  B: addr=%06X mod=%3d shift=%2d\\n"", CUSTOM_REG_LONG(REG_BLTBPTH), CUSTOM_REG_SIGNED(REG_BLTBMOD), CUSTOM_REG(REG_BLTCON1) >> 12);
		if (CUSTOM_REG(REG_BLTCON0) & 0x0200)
			logerror(""  C: addr=%06X mod=%3d\\n"", CUSTOM_REG_LONG(REG_BLTCPTH), CUSTOM_REG_SIGNED(REG_BLTCMOD));
		if (CUSTOM_REG(REG_BLTCON0) & 0x0100)
			logerror(""  D: addr=%06X mod=%3d\\n"", CUSTOM_REG_LONG(REG_BLTDPTH), CUSTOM_REG_SIGNED(REG_BLTDMOD));
	}

	/* set the zero flag */
	CUSTOM_REG(REG_DMACON) |= 0x2000;

	/* switch off the type of blit */
	switch (CUSTOM_REG(REG_BLTCON1) & 0x0003)
	{
		case 0: /* ascending */
			blitsum = blit_ascending();
			break;

		case 2: /* descending */
			blitsum = blit_descending();
			break;

		case 1: /* line */
		case 3:
			blitsum = blit_line();
			break;
	}

	/* clear the zero flag if we actually wrote data */
	if (blitsum)
		CUSTOM_REG(REG_DMACON) &= ~0x2000;

	/* no longer busy */
	CUSTOM_REG(REG_DMACON) &= ~0x4000;

	// signal an interrupt
	set_interrupt(0x8000 | INTENA_BLIT);

	/* reset the blitter timer */
	m_blitter_timer->reset();
}



/*************************************
 *
 *  Blitter setup
 *
 *************************************/

void amiga_state::blitter_setup()
{
	int ticks, width, height, blittime;

	/* is there another blitting in progress? */
	if (CUSTOM_REG(REG_DMACON) & 0x4000)
	{
		logerror(""%s - This program is playing tricks with the blitter\\n"", machine().describe_context() );
		return;
	}

	/* line mode is 8 ticks/pixel */
	if (CUSTOM_REG(REG_BLTCON1) & 1)
		ticks = 8;

	/* standard mode is 4 ticks base */
	else
	{
		ticks = 4;

		/* plus 2 ticks if channel B is involved */
		if (CUSTOM_REG(REG_BLTCON0) & 0x0400)
			ticks += 2;

		/* plus 2 ticks if both channel C and D are involved */
		if ((CUSTOM_REG(REG_BLTCON0) & 0x0300) == 0x0300)
			ticks += 2;
	}

	/* extract height/width */
	width = CUSTOM_REG(REG_BLTSIZH);
	height = CUSTOM_REG(REG_BLTSIZV);

	/* compute the blit time */
	blittime = ticks * height * width;

	/* if 'blitter-nasty' is set, then the blitter takes over the bus. Make the blit semi-immediate */
	if ( CUSTOM_REG(REG_DMACON) & 0x0400 )
	{
		/* simulate the 68k not running while the blit is going */
		m_maincpu->adjust_icount(-(blittime/2) );

		blittime = BLITTER_NASTY_DELAY;
	}

	/* AGA has twice the bus bandwidth, so blits take half the time */
	if (IS_AGA())
		blittime /= 2;

	/* signal blitter busy */
	CUSTOM_REG(REG_DMACON) |= 0x4000;

	/* set a timer */
	m_blitter_timer->adjust( m_maincpu->cycles_to_attotime( blittime ));
}


//**************************************************************************
//  CENTRONICS
//**************************************************************************

WRITE_LINE_MEMBER( amiga_state::centronics_ack_w )
{
	m_cia_0->flag_w(state);
}

WRITE_LINE_MEMBER( amiga_state::centronics_busy_w )
{
	m_centronics_busy = state;
	m_cia_1->sp_w(state);
}

WRITE_LINE_MEMBER( amiga_state::centronics_perror_w )
{
	m_centronics_perror = state;
	m_cia_1->cnt_w(state);
}

WRITE_LINE_MEMBER( amiga_state::centronics_select_w )
{
	m_centronics_select = state;
}


//**************************************************************************
//  8520 CIA
//**************************************************************************

// CIA-A access: 101x xxxx xxx0 oooo xxxx xxx1
// CIA-B access: 101x xxxx xx0x oooo xxxx xxx0

READ16_MEMBER( amiga_state::cia_r )
{
	uint16_t data = 0;

	if ((offset & 0x1000/2) == 0 && ACCESSING_BITS_0_7)
		data |= m_cia_0->read(space, offset >> 7);

	if ((offset & 0x2000/2) == 0 && ACCESSING_BITS_8_15)
		data |= m_cia_1->read(space, offset >> 7) << 8;

	if (LOG_CIA)
		logerror(""%s: cia_r(%06x) = %04x & %04x\\n"", machine().describe_context(), offset, data, mem_mask);

	return data;
}

WRITE16_MEMBER( amiga_state::cia_w )
{
	if (LOG_CIA)
		logerror(""%s: cia_w(%06x) = %04x & %04x\\n"", machine().describe_context(), offset, data, mem_mask);

	if ((offset & 0x1000/2) == 0 && ACCESSING_BITS_0_7)
		m_cia_0->write(space, offset >> 7, data & 0xff);

	if ((offset & 0x2000/2) == 0 && ACCESSING_BITS_8_15)
		m_cia_1->write(space, offset >> 7, data >> 8);
}

WRITE16_MEMBER( amiga_state::gayle_cia_w )
{
	// the first write to cia 0 after a reset switches in chip ram
	if (m_gayle_reset && (offset & 0x1000/2) == 0 && ACCESSING_BITS_0_7)
	{
		m_gayle_reset = false;
		m_overlay->set_bank(0);
	}

	// hand down to the standard cia handler
	cia_w(space, offset, data, mem_mask);
}

CUSTOM_INPUT_MEMBER( amiga_state::floppy_drive_status )
{
	return m_fdc->ciaapra_r();
}

WRITE8_MEMBER( amiga_state::cia_0_port_a_write )
{
	// bit 0, kickstart overlay
	m_overlay->set_bank(BIT(data, 0));

	// bit 1, power led
	output().set_led_value(0, !BIT(data, 1));
	output().set_value(""power_led"", !BIT(data, 1));
}

WRITE_LINE_MEMBER( amiga_state::cia_0_irq )
{
	if (LOG_CIA)
		logerror(""%s: cia_0_irq: %d\\n"", machine().describe_context(), state);

	m_cia_0_irq = state;
	update_int2();
}

READ8_MEMBER( amiga_state::cia_1_port_a_read )
{
	uint8_t data = 0;

	// bit 0 to 2, centronics
	data |= m_centronics_busy << 0;
	data |= m_centronics_perror << 1;
	data |= m_centronics_select << 2;

	// bit 2 to 7, serial line
	data |= m_rs232_ri << 2;
	data |= m_rs232_dsr << 3;
	data |= m_rs232_cts << 4;
	data |= m_rs232_dcd << 5;

	return data;
}

WRITE8_MEMBER( amiga_state::cia_1_port_a_write )
{
	if (m_rs232)
	{
		m_rs232->write_rts(BIT(data, 6));
		m_rs232->write_dtr(BIT(data, 7));
	}
}

WRITE_LINE_MEMBER( amiga_state::cia_1_irq )
{
	if (LOG_CIA)
		logerror(""%s: cia_1_irq: %d\\n"", machine().describe_context(), state);

	m_cia_1_irq = state;
	update_int6();
}


//**************************************************************************
//  CUSTOM CHIPS
//**************************************************************************

void amiga_state::custom_chip_reset()
{
	CUSTOM_REG(REG_DENISEID) = m_denise_id;
	CUSTOM_REG(REG_VPOSR) = m_agnus_id << 8;
	CUSTOM_REG(REG_DDFSTRT) = 0x18;
	CUSTOM_REG(REG_DDFSTOP) = 0xd8;
	CUSTOM_REG(REG_INTENA) = 0x0000;
	CUSTOM_REG(REG_SERDATR) = SERDATR_RXD | SERDATR_TSRE | SERDATR_TBE;
	CUSTOM_REG(REG_BEAMCON0) = (m_agnus_id & 0x10) ? 0x0000 : 0x0020;
}

READ16_MEMBER( amiga_state::custom_chip_r )
{
	uint16_t temp;

	if (LOG_CUSTOM)
		logerror(""%06X:read from custom %s\\n"", m_maincpu->pc(), s_custom_reg_names[offset & 0xff]);

	switch (offset & 0xff)
	{
		case REG_BLTDDAT:
			return CUSTOM_REG(REG_BLTDDAT);

		case REG_DMACONR:
			return CUSTOM_REG(REG_DMACON);

		case REG_VPOSR:
			CUSTOM_REG(REG_VPOSR) &= 0xff00;
			CUSTOM_REG(REG_VPOSR) |= amiga_gethvpos() >> 16;

			return CUSTOM_REG(REG_VPOSR);

		case REG_VHPOSR:
			return amiga_gethvpos() & 0xffff;

		case REG_SERDATR:
			if (LOG_SERIAL)
				logerror(""r SERDATR: %04x\\n"", CUSTOM_REG(REG_SERDATR));

			return CUSTOM_REG(REG_SERDATR);

		case REG_JOY0DAT:
			if (m_joy0dat_port.found())
				return joy0dat_r();

		case REG_JOY1DAT:
			if (m_joy1dat_port.found())
				return joy1dat_r();

		case REG_POTGOR:
			return m_potgo_port.read_safe(0x5500);

		case REG_POT0DAT:
			if (m_pot0dat_port.found())
			{
				return m_pot0dat_port->read();
			}
			else
			{
				int scale = m_agnus_id & 0x10 ? 525 : 625;

				m_pot0dat  = (int) ((double) m_pot0x / scale) * 0xff;
				m_pot0dat |= (int)(((double) m_pot0y / scale) * 0xff) << 8;

				return m_pot0dat;
			}

		case REG_POT1DAT:
			if (m_pot1dat_port.found())
			{
				return m_pot1dat_port->read();
			}
			else
			{
				int scale = m_agnus_id & 0x10 ? 525 : 625;

				m_pot1dat  = (int) ((double) m_pot1x / scale) * 0xff;
				m_pot1dat |= (int)(((double) m_pot1y / scale) * 0xff) << 8;

				return m_pot1dat;
			}

		case REG_DSKBYTR:
			return m_fdc->dskbytr_r();

		case REG_INTENAR:
			return CUSTOM_REG(REG_INTENA);

		case REG_INTREQR:
			return CUSTOM_REG(REG_INTREQ);

		case REG_COPJMP1:
			copper_setpc(CUSTOM_REG_LONG(REG_COP1LCH));
			break;

		case REG_COPJMP2:
			copper_setpc(CUSTOM_REG_LONG(REG_COP2LCH));
			break;

		case REG_CLXDAT:
			temp = CUSTOM_REG(REG_CLXDAT);
			CUSTOM_REG(REG_CLXDAT) = 0;
			return temp;

		case REG_DENISEID:
			return CUSTOM_REG(REG_DENISEID);

		case REG_DSKPTH:
			return m_fdc->dskpth_r();

		case REG_DSKPTL:
			return m_fdc->dskptl_r();

		case REG_ADKCONR:
			return m_fdc->adkcon_r();

		case REG_DSKDATR:
			popmessage(""DSKDAT R, contact MESSdev"");
			break;
	}

	return 0xffff;
}

WRITE16_MEMBER( amiga_state::custom_chip_w )
{
	uint16_t temp;
	offset &= 0xff;

	if (LOG_CUSTOM)
		logerror(""%06X:write to custom %s = %04X\\n"", m_maincpu->pc(), s_custom_reg_names[offset & 0xff], data);

	// paula will handle some of those registers
	m_paula->reg_w(space, offset, data, mem_mask);

	switch (offset)
	{
		case REG_BLTDDAT:   case REG_DMACONR:   case REG_VPOSR:     case REG_VHPOSR:
		case REG_DSKDATR:   case REG_JOY0DAT:   case REG_JOY1DAT:   case REG_CLXDAT:
		case REG_ADKCONR:   case REG_POT0DAT:   case REG_POT1DAT:   case REG_POTGOR:
		case REG_SERDATR:   case REG_DSKBYTR:   case REG_INTENAR:   case REG_INTREQR:
			// read-only registers
			return;

		case REG_DSKDAT:
			popmessage(""DSKDAT W %04x, contact MESSdev"",data);
			break;

		case REG_DSKSYNC:
			m_fdc->dsksync_w(data);
			break;

		case REG_DSKPTH:
			m_fdc->dskpth_w(data);
			break;

		case REG_DSKPTL:
			m_fdc->dskptl_w(data);
			break;

		case REG_DSKLEN:
			m_fdc->dsklen_w(data);
			break;

		case REG_POTGO:
			if (BIT(data, 0))
			{
				// start counters
				m_pot0x = 0;
				m_pot0y = 0;
				m_pot1x = 0;
				m_pot1y = 0;
			}
			potgo_w(data);
			break;

		case REG_SERDAT:
			if (LOG_SERIAL)
				logerror(""w SERDAT: %04x\\n"", data);

			CUSTOM_REG(REG_SERDAT) = data;

			// transmit shift register currently empty?
			if (CUSTOM_REG(REG_SERDATR) & SERDATR_TSRE)
			{
				// transfer new data to shift register
				m_tx_shift = CUSTOM_REG(REG_SERDAT);
				CUSTOM_REG(REG_SERDAT) = 0;

				// and signal transmit buffer empty
				CUSTOM_REG(REG_SERDATR) &= ~SERDATR_TSRE;
				CUSTOM_REG(REG_SERDATR) |= SERDATR_TBE;
				set_interrupt(INTENA_SETCLR | INTENA_TBE);
			}
			else
			{
				// transmit buffer now full
				CUSTOM_REG(REG_SERDATR) &= ~SERDATR_TBE;
			}

			return;

		case REG_SERPER:
			if (LOG_SERIAL)
				logerror(""w SERPER: %04x\\n"", data);

			CUSTOM_REG(REG_SERPER) = data;
			serial_adjust();

			return;

		case REG_BLTSIZE:
			CUSTOM_REG(REG_BLTSIZE) = data;
			CUSTOM_REG(REG_BLTSIZV) = (data >> 6) & 0x3ff;
			CUSTOM_REG(REG_BLTSIZH) = data & 0x3f;
			if ( CUSTOM_REG(REG_BLTSIZV) == 0 ) CUSTOM_REG(REG_BLTSIZV) = 0x400;
			if ( CUSTOM_REG(REG_BLTSIZH) == 0 ) CUSTOM_REG(REG_BLTSIZH) = 0x40;
			blitter_setup();
			break;

		case REG_BLTSIZV:
			if (IS_ECS() || IS_AGA())
			{
				CUSTOM_REG(REG_BLTSIZV) = data & 0x7fff;
				if ( CUSTOM_REG(REG_BLTSIZV) == 0 ) CUSTOM_REG(REG_BLTSIZV) = 0x8000;
			}
			break;

		case REG_BLTSIZH:
			if (IS_ECS() || IS_AGA())
			{
				CUSTOM_REG(REG_BLTSIZH) = data & 0x7ff;
				if ( CUSTOM_REG(REG_BLTSIZH) == 0 ) CUSTOM_REG(REG_BLTSIZH) = 0x800;
				blitter_setup();
			}
			break;

		case REG_BLTCON0L:
			if (IS_ECS() || IS_AGA())
			{
				CUSTOM_REG(REG_BLTCON0) &= 0xff00;
				CUSTOM_REG(REG_BLTCON0) |= data & 0xff;
			}
			break;

		case REG_SPR0PTH:   case REG_SPR1PTH:   case REG_SPR2PTH:   case REG_SPR3PTH:
		case REG_SPR4PTH:   case REG_SPR5PTH:   case REG_SPR6PTH:   case REG_SPR7PTH:
			data &= ( m_chip_ram_mask >> 16 );
			break;

		case REG_SPR0PTL:   case REG_SPR1PTL:   case REG_SPR2PTL:   case REG_SPR3PTL:
		case REG_SPR4PTL:   case REG_SPR5PTL:   case REG_SPR6PTL:   case REG_SPR7PTL:
			sprite_dma_reset((offset - REG_SPR0PTL) / 2);
			break;

		case REG_SPR0CTL:   case REG_SPR1CTL:   case REG_SPR2CTL:   case REG_SPR3CTL:
		case REG_SPR4CTL:   case REG_SPR5CTL:   case REG_SPR6CTL:   case REG_SPR7CTL:
			/* disable comparitor on writes here */
			sprite_enable_comparitor((offset - REG_SPR0CTL) / 4, false);
			break;

		case REG_SPR0DATA:  case REG_SPR1DATA:  case REG_SPR2DATA:  case REG_SPR3DATA:
		case REG_SPR4DATA:  case REG_SPR5DATA:  case REG_SPR6DATA:  case REG_SPR7DATA:
			/* enable comparitor on writes here */
			sprite_enable_comparitor((offset - REG_SPR0DATA) / 4, true);
			break;

		case REG_COP1LCH:
		case REG_COP2LCH:
			data &= ( m_chip_ram_mask >> 16 );
			break;

		case REG_COPJMP1:
			copper_setpc(CUSTOM_REG_LONG(REG_COP1LCH));
			break;

		case REG_COPJMP2:
			copper_setpc(CUSTOM_REG_LONG(REG_COP2LCH));
			break;

		case REG_DDFSTRT:
			/* impose hardware limits ( HRM, page 75 ) */
			data &= 0xfe;
			if (data < 0x18)
				data = 0x18;
			break;

		case REG_DDFSTOP:
			/* impose hardware limits ( HRM, page 75 ) */
			data &= 0xfe;
			if (data > 0xd8)
				data = 0xd8;
			break;

		case REG_DMACON:
			/* bits BBUSY (14) and BZERO (13) are read-only */
			data &= 0x9fff;
			data = (data & 0x8000) ? (CUSTOM_REG(offset) | (data & 0x7fff)) : (CUSTOM_REG(offset) & ~(data & 0x7fff));
			m_fdc->dmacon_set(data);

			/* if 'blitter-nasty' has been turned on and we have a blit pending, reschedule it */
			if ( ( data & 0x400 ) && ( CUSTOM_REG(REG_DMACON) & 0x4000 ) )
				m_blitter_timer->adjust(m_maincpu->cycles_to_attotime(BLITTER_NASTY_DELAY));

			break;

		case REG_INTENA:
			temp = data;

			data = (data & INTENA_SETCLR) ? (CUSTOM_REG(offset) | (data & 0x7fff)) : (CUSTOM_REG(offset) & ~(data & 0x7fff));
			CUSTOM_REG(offset) = data;

			if (temp & INTENA_SETCLR)
				// if we're enabling irq's, delay a bit
				m_irq_timer->adjust(m_maincpu->cycles_to_attotime(AMIGA_IRQ_DELAY_CYCLES));
			else
				// if we're disabling irq's, process right away
				update_irqs();
			break;

		case REG_INTREQ:
			temp = data;

			// clear receive buffer full?
			if (!(data & INTENA_SETCLR) && (data & INTENA_RBF))
			{
				CUSTOM_REG(REG_SERDATR) &= ~SERDATR_OVRUN;
				CUSTOM_REG(REG_SERDATR) &= ~SERDATR_RBF;
			}

			// clear transmit buffer empty?
			if (!(data & INTENA_SETCLR) && (data & INTENA_TBE))
				CUSTOM_REG(REG_SERDATR) |= SERDATR_TBE;

			data = (data & INTENA_SETCLR) ? (CUSTOM_REG(offset) | (data & 0x7fff)) : (CUSTOM_REG(offset) & ~(data & 0x7fff));
			CUSTOM_REG(offset) = data;

			if (temp & INTENA_SETCLR)
				// if we're generating irq's, delay a bit
				m_irq_timer->adjust(m_maincpu->cycles_to_attotime(AMIGA_IRQ_DELAY_CYCLES));
			else
				// if we're clearing irq's, process right away
				update_irqs();
			break;

		case REG_ADKCON:
			data = (data & 0x8000) ? (CUSTOM_REG(offset) | (data & 0x7fff)) : (CUSTOM_REG(offset) & ~(data & 0x7fff));
			m_fdc->adkcon_set(data);
			break;

		case REG_BPL1PTH:   case REG_BPL2PTH:   case REG_BPL3PTH:   case REG_BPL4PTH:
		case REG_BPL5PTH:   case REG_BPL6PTH:
			data &= ( m_chip_ram_mask >> 16 );
			break;

		case REG_BPLCON0:
			if ((data & (BPLCON0_BPU0 | BPLCON0_BPU1 | BPLCON0_BPU2)) == (BPLCON0_BPU0 | BPLCON0_BPU1 | BPLCON0_BPU2))
			{
				/* planes go from 0 to 6, inclusive */
				logerror( ""This game is doing funky planes stuff. (planes > 6)\\n"" );
				data &= ~BPLCON0_BPU0;
			}
			CUSTOM_REG(offset) = data;
			break;

		case REG_COLOR00:   case REG_COLOR01:   case REG_COLOR02:   case REG_COLOR03:
		case REG_COLOR04:   case REG_COLOR05:   case REG_COLOR06:   case REG_COLOR07:
		case REG_COLOR08:   case REG_COLOR09:   case REG_COLOR10:   case REG_COLOR11:
		case REG_COLOR12:   case REG_COLOR13:   case REG_COLOR14:   case REG_COLOR15:
		case REG_COLOR16:   case REG_COLOR17:   case REG_COLOR18:   case REG_COLOR19:
		case REG_COLOR20:   case REG_COLOR21:   case REG_COLOR22:   case REG_COLOR23:
		case REG_COLOR24:   case REG_COLOR25:   case REG_COLOR26:   case REG_COLOR27:
		case REG_COLOR28:   case REG_COLOR29:   case REG_COLOR30:   case REG_COLOR31:
			if (IS_AGA())
			{
				aga_palette_write(offset - REG_COLOR00, data);
			}
			else
			{
				data &= 0xfff;
				CUSTOM_REG(offset + 32) = (data >> 1) & 0x777;
			}
			break;

		// display window start/stop
		case REG_DIWSTRT:
		case REG_DIWSTOP:
			m_diwhigh_valid = false;
			break;

		// display window high
		case REG_DIWHIGH:
			if (IS_ECS() || IS_AGA())
			{
				m_diwhigh_valid = true;
				CUSTOM_REG(REG_DIWHIGH) = data;
			}
			break;

		case REG_BEAMCON0:
			// only available on ecs agnus
			if (m_agnus_id >= AGNUS_HR_PAL)
			{
				CUSTOM_REG(REG_BEAMCON0) = data;
				update_screenmode();
			}
			break;

		default:
			break;
	}

	if (IS_AGA())
		CUSTOM_REG(offset) = data;
	else
		if (offset <= REG_COLOR31)
			CUSTOM_REG(offset) = data;
}


//**************************************************************************
//  SERIAL
//**************************************************************************

void amiga_state::serial_adjust()
{
	uint32_t divisor = (CUSTOM_REG(REG_SERPER) & 0x7fff) + 1;
	uint32_t baud = m_paula->clock() / divisor;

	m_serial_timer->adjust(attotime::from_hz(baud) / 2, 0, attotime::from_hz(baud));
}

void amiga_state::serial_shift()
{
	if (CUSTOM_REG(REG_ADKCON) & ADKCON_UARTBRK)
	{
		// break active, force low
		rs232_tx(0);
	}
	else
	{
		// transmit shift register not empty?
		if ((CUSTOM_REG(REG_SERDATR) & SERDATR_TSRE) == 0)
		{
			if (m_tx_state == 0)
			{
				// transmit start bit
				rs232_tx(0);
				m_tx_state++;
			}
			else if (m_tx_state <= 8 + BIT(CUSTOM_REG(REG_SERPER), 15))
			{
				// send data bits
				rs232_tx(m_tx_shift & 1);
				m_tx_shift >>= 1;
				m_tx_state++;
			}
			else
			{
				// send stop bits until we run out
				if (m_tx_shift & 1)
				{
					rs232_tx(m_tx_shift & 1);
					m_tx_shift >>= 1;
				}
				else
				{
					// more data?
					if (CUSTOM_REG(REG_SERDAT))
					{
						// transfer to shift register
						m_tx_shift = CUSTOM_REG(REG_SERDAT);
						CUSTOM_REG(REG_SERDAT) = 0;

						// signal buffer empty
						CUSTOM_REG(REG_SERDATR) |= SERDATR_TBE;
						set_interrupt(INTENA_SETCLR | INTENA_TBE);
					}
					else
					{
						// we're done
						CUSTOM_REG(REG_SERDATR) |= SERDATR_TSRE;
					}

					m_tx_state = 0;
				}
			}
		}
		else
		{
			// transmit register empty
			rs232_tx(1);
		}
	}

	// waiting for start bit?
	if (m_rx_state == 0)
	{
		// start bit seen (high to low transition)
		if (m_rx_previous && (CUSTOM_REG(REG_SERDATR) & SERDATR_RXD) == 0)
		{
			m_rx_state++;
		}
	}
	else if (m_rx_state <= 8 + BIT(CUSTOM_REG(REG_SERPER), 15))
	{
		// receive data
		m_rx_shift >>= 1;
		m_rx_shift = (m_rx_shift & 0x7fff) | (BIT(CUSTOM_REG(REG_SERDATR), 11) << 15);
		m_rx_state++;
	}
	else
	{
		// stop bit
		m_rx_shift >>= 1;
		m_rx_shift = (m_rx_shift & 0x7fff) | (BIT(CUSTOM_REG(REG_SERDATR), 11) << 15);

		// shift to start
		m_rx_shift >>= (15 - (8 + BIT(CUSTOM_REG(REG_SERPER), 15)));

		// save data
		CUSTOM_REG(REG_SERDATR) &= ~0x3ff;
		CUSTOM_REG(REG_SERDATR) |= m_rx_shift & 0x3ff;

		// overrun?
		if (CUSTOM_REG(REG_SERDATR) & SERDATR_RBF)
			CUSTOM_REG(REG_SERDATR) |= SERDATR_OVRUN;

		// set ready and signal interrupt
		CUSTOM_REG(REG_SERDATR) |= SERDATR_RBF;
		set_interrupt(INTENA_SETCLR | INTENA_RBF);

		m_rx_shift = 0;
		m_rx_state = 0;
	}
}

void amiga_state::rs232_tx(int state)
{
	if (m_rs232)
		m_rs232->write_txd(state);
}

void amiga_state::rx_write(int level)
{
	m_rx_previous = BIT(CUSTOM_REG(REG_SERDATR), 11);
	CUSTOM_REG(REG_SERDATR) &= ~SERDATR_RXD;
	CUSTOM_REG(REG_SERDATR) |= level << 11;
}

WRITE_LINE_MEMBER( amiga_state::rs232_rx_w )
{
	rx_write(state);

	// start bit received?
	if (m_rx_state == 1)
		serial_adjust();
}

WRITE_LINE_MEMBER( amiga_state::rs232_dcd_w )
{
	m_rs232_dcd = state;
}

WRITE_LINE_MEMBER( amiga_state::rs232_dsr_w )
{
	m_rs232_dsr = state;
}

WRITE_LINE_MEMBER( amiga_state::rs232_ri_w )
{
	m_rs232_ri = state;
}

WRITE_LINE_MEMBER( amiga_state::rs232_cts_w )
{
	m_rs232_cts = state;
}
",16372,True,2863.9862096133475,median
"[[scoreCalculation]]
= Score Calculation
:doctype: book
:sectnums:
:toc: left
:icons: font
:experimental:
:sourcedir: .


[[scoreTerminology]]
== Score Terminology


[[whatIsAScore]]
=== What is a Score?

Every `Solution` has a score.
The score is an objective way to compare two solutions.
The solution with the higher score is better.
The `Solver` aims to find the `Solution` with the highest `Score` of all possible solutions.
The _best solution_ is the `Solution` with the highest `Score` that `Solver` has encountered during solving,
which might be the __optimal solution__.

Planner cannot automatically know which `Solution` is best for your business, so you need to tell it how to calculate the score of a given `Solution` according to your business needs.
If you forget or are unable to implement an important business constraint, the solution is probably useless:

image::Chapter-Score_calculation/optimalWithIncompleteConstraints.png[align=""center""]


[[formalizeTheBusinessConstraints]]
=== Formalize the Business Constraints

To implement a verbal business constraint, it needs to be formalized as a score constraint.
Luckily, defining constraints in Planner is very flexible through the following score techniques:

* **Score signum (positive or negative)**: maximize or minimize a constraint type
* **Score weight**: put a cost/profit on a constraint type
* **Score level (hard, soft, ...)**: prioritize a group of constraint types
* *Pareto scoring* (rarely used)

Take the time to acquaint yourself with the first 3 techniques.
Once you understand them, formalizing most business constraints becomes straightforward.


[[scoreConstraintSignum]]
=== Score Constraint Signum (Positive or Negative)

All score techniques are based on constraints.
A constraint can be a simple pattern (such as __Maximize the apple harvest in the solution__) or a more complex pattern.
A positive constraint is a constraint you want to maximize.
A negative constraint is a constraint you want to minimize.

image::Chapter-Score_calculation/positiveAndNegativeConstraints.png[align=""center""]

The image above illustrates that **the optimal solution always has the highest score**,
regardless if the constraints are positive or negative.

Most planning problems have only negative constraints and therefore have a negative score.
In that case, the score is the sum of the weight of the negative constraints being broken, with a perfect score of 0.
This explains why the score of a solution of four queens is the negative of the number of queen pairs which can attack each other.

Negative and positive constraints can be combined, even in the same score level.

[NOTE]
====
Do not presume that your business knows all its score constraints in advance.
Expect score constraints to be added or changed after the first releases.
====

When a constraint activates (because the negative constraint is broken or the positive constraint is fulfilled) on a certain planning entity set, it is called a __constraint match__.


[[scoreConstraintWeight]]
=== Score Constraint Weight

Not all score constraints are equally important.
If breaking one constraint is equally bad as breaking another constraint x times, then those two constraints have a different weight (but they are in the same score level). For example in vehicle routing, you can make one ""unhappy driver"" constraint match count as much as two ""fuel tank usage"" constraint matches:

image::Chapter-Score_calculation/scoreWeighting.png[align=""center""]

Score weighting is easy in use cases where you can __put a price tag on everything__.
In that case, the positive constraints maximize revenue and the negative constraints minimize expenses, so together they maximize profit.
Alternatively, score weighting is also often used to create social <<fairnessScoreConstraints,fairness>>.
For example, a nurse, who requests a free day, pays a higher weight on New Years eve than on a normal day.

The weight of a constraint match can be dynamically based on the planning entities involved.
For example in cloud balance, the weight of the soft constraint match for an active `Computer` is the `cost` of that `Computer` (which differs per computer).

Putting a good weight on a constraint can be a difficult analytical decision, because it is about making choices and tradeoffs with other constraints.
Don't spend too much time on it at the start of an implementation.
A non-accurate weight is less damaging than mediocre algorithms:

image::Chapter-Score_calculation/scoreTradeoffInPerspective.png[align=""center""]


[NOTE]
====
When deciding the weights of some constraints is debatable, it's recommended to make them configurable at runtime, as demonstrated in the exam timetabling example with the `InstitutionParametrization` class.
This allow the end-user to recalibrate constraint weights in the user interface and immediately discover the impact of the new weights by running the solver again.
====

Most use cases use a `Score` with `int` weights, such as <<hardSoftScore,HardSoftScore>>.


[[scoreLevel]]
=== Score Constraint Level (hard, soft, ...)

Sometimes a score constraint outranks another score constraint, no matter how many times the other is broken.
In that case, those score constraints are in different levels.
For example, a nurse cannot do 2 shifts at the same time (due to the constraints of physical reality), this outranks all nurse happiness constraints.

Most use cases have only two score levels, hard and soft.
The levels of two scores are compared lexicographically.
The first score level gets compared first.
If those differ, the remaining score levels are ignored.
For example, a score that breaks `0` hard constraints and `1000000` soft constraints is better than a score that breaks `1` hard constraint and `0` soft constraints.

image::Chapter-Score_calculation/scoreLevels.png[align=""center""]

If there are two (or more) score levels, for example a hard and soft level, then a score is _feasible_ if no hard constraints are broken.

[NOTE]
====
By default, Planner will always assign all planning variables a planning value.
If there is no feasible solution, this means the best solution will be infeasible.
To instead leave some of the planning entities unassigned, apply <<overconstrainedPlanning,overconstrained planning>>.
====

For each constraint, you need to pick a score level, a score weight and a score signum.
For example: `-1soft` which has score level of ``soft``, a weight of `1` and a negative signum.
Do not use a big constraint weight when your business actually wants different score levels.
That hack, known as __score folding__, is broken:

image::Chapter-Score_calculation/scoreFoldingIsBroken.png[align=""center""]


[NOTE]
====
Your business might tell you that your hard constraints all have the same weight, because they cannot be broken (so the weight does not matter). This is not true because if no feasible solution exists for a specific dataset, the least infeasible solution allows the business to estimate how many business resources they are lacking.
For example in cloud balancing, how many new computers to buy.

Furthermore, it will likely create a <<scoreTrap,score trap>>.
For example in cloud balance if a `Computer` has seven CPU too little for its ``Process``es, then it must be weighted seven times as much as if it had only one CPU too little.
====

Three or more score levels are supported.
For example: a company might decide that profit outranks employee satisfaction (or vice versa), while both are outranked by the constraints of physical reality.

[NOTE]
====
To model fairness or load balancing, there is <<fairnessScoreConstraints,no need to use lots of score levels>>
(even though Planner can handle many score levels).
====

Most use cases use a `Score` with two weights, such as <<hardSoftScore,HardSoftScore>>.


[[paretoScoring]]
=== Pareto Scoring (AKA Multi-objective Optimization Scoring)

Far less common is the use case of pareto optimization, which is also known under the more confusing term multi-objective optimization.
In pareto scoring, score constraints are in the same score level, yet they are not weighted against each other.
When two scores are compared, each of the score constraints are compared individually and the score with the most dominating score constraints wins.
Pareto scoring can even be combined with score levels and score constraint weighting.

Consider this example with positive constraints, where we want to get the most apples and oranges.
Since it is impossible to compare apples and oranges, we can not weight them against each other.
Yet, despite that we can not compare them, we can state that two apples are better then one apple.
Similarly, we can state that two apples and one orange are better than just one orange.
So despite our inability to compare some Scores conclusively (at which point we declare them equal), we can find a set of optimal scores.
Those are called pareto optimal.

image::Chapter-Score_calculation/paretoOptimizationScoring.png[align=""center""]

Scores are considered equal far more often.
It is left up to a human to choose the better out of a set of best solutions (with equal scores) found by Planner.
In the example above, the user must choose between solution A (three apples and one orange) and solution B (one apple and six oranges). It is guaranteed that Planner has not found another solution which has more apples or more oranges or even a better combination of both (such as two apples and three oranges).

To implement pareto scoring in Planner, <<customScore,implement a custom `ScoreDefinition` and `Score`>> (and replace the ``BestSolutionRecaller``). Future versions will provide out-of-the-box support.

[NOTE]
====
A pareto ``Score``'s `compareTo` method is not transitive because it does a pareto comparison.
For example: having two apples is greater than one apple.
One apple is equal to One orange.
Yet, two apples are not greater than one orange (but actually equal). Pareto comparison violates the contract of the interface ``java.lang.Comparable``'s `compareTo` method, but Planners systems are __pareto comparison safe__, unless explicitly stated otherwise in this documentation.
====


[[combiningScoreTechniques]]
=== Combining Score Techniques

All the score techniques mentioned above, can be combined seamlessly:

image::Chapter-Score_calculation/scoreComposition.png[align=""center""]


[[scoreInterface]]
=== `Score` interface

A score is represented by the `Score` interface, which naturally extends ``Comparable``:

[source,java,options=""nowrap""]
----
public interface Score<...> extends Comparable<...> {
    ...
}
----

The `Score` implementation to use depends on your use case.
Your score might not efficiently fit in a single `long` value.
Planner has several built-in `Score` implementations, but you can implement a custom `Score` too.
Most use cases tend to use the built-in ``HardSoftScore``.

image::Chapter-Score_calculation/scoreClassDiagram.png[align=""center""]

All Score implementations also have an `initScore` (which is an ``int``). It is mostly intended for internal use in Planner: it is the negative number of uninitialized planning variables.
From a user's perspective this is ``0``, unless a Construction Heuristic is terminated before it could initialize all planning variables (in which case `Score.isSolutionInitialized()` returns ``false``).

The `Score` implementation (for example ``HardSoftScore``) must be the same throughout a `Solver` runtime.
The `Score` implementation is configured in the solution domain class:

[source,java,options=""nowrap""]
----
@PlanningSolution
public class CloudBalance {
    ...

    @PlanningScore
    private HardSoftScore score;

}
----


[[avoidFloatingPointNumbersInScoreCalculation]]
=== Avoid Floating Point Numbers in Score Calculation

Avoid the use of `float` or `double` in score calculation.
Use `BigDecimal` or scaled `long` instead.

Floating point numbers (``float`` and ``double``) cannot represent a decimal number correctly.
For example: a `double` cannot hold the value `0.05` correctly.
Instead, it holds the nearest representable value.
Arithmetic (including addition and subtraction) with floating point numbers, especially for planning problems, leads to incorrect decisions:

image::Chapter-Score_calculation/scoreWeightType.png[align=""center""]

Additionally, floating point number addition is not associative:

[source,java,options=""nowrap""]
----
System.out.println( ((0.01 + 0.02) + 0.03) == (0.01 + (0.02 + 0.03)) ); // returns false
----

This leads to __score corruption__.

Decimal numbers (``BigDecimal``) have none of these problems.

[NOTE]
====
BigDecimal arithmetic is considerably slower than ``int``, `long` or `double` arithmetic.
In experiments we have seen the score calculation take five times longer.

Therefore, in many cases, it can be worthwhile to multiply _all_ numbers for a single score weight by a plural of ten, so the score weight fits in a scaled `int` or ``long``.
For example, if we multiple all weights by ``1000``, a fuelCost of `0.07` becomes a fuelCostMillis of `70` and no longer uses a decimal score weight.
====


[[scoreType]]
== Choose a Score Type

Depending on the number of score levels and type of score weights you need, choose a `Score` type.
Most use cases use a ``HardSoftScore``.

[NOTE]
====
To properly write a `Score` to a database (with JPA/Hibernate) or to XML/JSON (with XStream/JAXB/Jackson), see <<integration,the integration chapter>>.
====


[[simpleScore]]
=== SimpleScore

A `SimpleScore` has a single `int` value, for example ``-123``.
It has a single score level.

[source,java,options=""nowrap""]
----
    @PlanningScore
    private SimpleScore score;
----

Variants of this `Score` type:

* `SimpleLongScore` uses a `long` value instead of an `int` value.
* `SimpleDoubleScore` uses a `double` value instead of an `int` value. <<avoidFloatingPointNumbersInScoreCalculation,Not recommended to use.>>
* `SimpleBigDecimalScore` uses a `BigDecimal` value instead of an `int` value.


[[hardSoftScore]]
=== HardSoftScore (Recommended)

A `HardSoftScore` has a hard `int` value and a soft `int` value, for example ``-123hard/-456soft``.
It has 2 score levels (hard and soft).

[source,java,options=""nowrap""]
----
    @PlanningScore
    private HardSoftScore score;
----

Variants of this `Score` type:

* `HardSoftLongScore` uses `long` values instead of `int` values.
* `HardSoftDoubleScore` uses `double` values instead of `int` values. <<avoidFloatingPointNumbersInScoreCalculation,Not recommended to use.>>
* `HardSoftBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[hardMediumSoftScore]]
=== HardMediumSoftScore

A `HardMediumSoftScore` which has a hard `int` value, a medium `int` value and a soft `int` value, for example ``-123hard/-456medium/-789soft``.
It has 3 score levels (hard, medium and soft).
The hard level determines if the solution is feasible,
and the medium level and soft level score values determine
how well the solution meets business goals.
Higher medium values take precedence over soft values irrespective of the soft value.

[source,java,options=""nowrap""]
----
    @PlanningScore
    private HardMediumSoftScore score;
----

Variants of this `Score` type:

* `HardMediumSoftLongScore` uses `long` values instead of `int` values.
* `HardMediumSoftBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[bendableScore]]
=== BendableScore

A `BendableScore` has a configurable number of score levels.
It has an array of hard `int` values and an array of soft `int` values,
for example with 2 hard levels and 3 soft levels, the score can be ``[-123/-456]hard/[-789/-012/-345]soft``.
In that case, it has 5 score levels.
A solution is feasible if all hard levels are at least zero.

A BendableScore with one hard level and one soft level is equivalent to a HardSoftScore,
while a BendableScore with one hard level and two soft levels is equivalent to a HardMediumSoftScore.

[source,java,options=""nowrap""]
----
    @PlanningScore(bendableHardLevelsSize = 2, bendableSoftLevelsSize = 3)
    private BendableScore score;
----

The number of hard and soft score levels need to be set at compilation time.
It is not flexible to change during solving.

[NOTE]
====
Don't use a `BendableScore` with 7 levels just because you have 7 constraints.
It's extremely rare to use a different score level for each constraint, because that means one constraint match on soft 0 outweighs even a million constraint matches of soft 1.

Usually, multiple constraints share the same level and are weighted against each other.
Use <<explainingTheScore,explaining the score>> to get the weight of individual constraints in the same level.
====

Variants of this `Score` type:

* `BendableLongScore` uses `long` values instead of `int` values.
* `BendableBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[customScore]]
=== Implementing a Custom Score

Internally, each `Score` implementation also has a `ScoreDefinition` implementation.
For example: `SimpleScore` is defined by ``SimpleScoreDefinition``.
The `ScoreDefinition` interface defines the score representation.

To implement a custom ``Score``, also implement such a custom ``ScoreDefinition``.
Extend `AbstractScoreDefinition` (preferably by copy pasting ``HardSoftScoreDefinition``) and start from there.
Then hook your custom `ScoreDefinition` in the domain:

[source,java,options=""nowrap""]
----
    @PlanningScore(scoreDefinitionClass = MyCustomScoreDefinition.class)
    private MyCustomScore score;
----

To have it integrate seamlessly with <<jpaAndHibernatePersistingAScore,JPA/Hibernate>>, <<integrationWithXStream,XStream>>, ..., you'll need to write some glue code.


[[calculateTheScore]]
== Calculate the `Score`


[[scoreCalculationTypes]]
=== Score Calculation Types

There are several ways to calculate the `Score` of a ``Solution``:

* **Easy Java score calculation**: implement a single Java method
* **Incremental Java score calculation**: implement multiple Java methods
* *Drools score calculation* (recommended): implement score rules

Every score calculation type can use any Score definition.
For example, easy Java score calculation can output a ``HardSoftScore``.

All score calculation types are Object Oriented and can reuse existing Java code.

[IMPORTANT]
====
The score calculation must be read-only.
It must not change the planning entities or the problem facts in any way.
For example, it must not call a setter method on a planning entity in a Drools score rule's RHS.
This does not apply to _logically inserted_ objects, which can be changed by the score rules that logically inserted them in the first place.

Planner will not recalculate the score of a `Solution` if it can predict it (unless an <<environmentMode,environmentMode assertion>> is enabled). For example, after a winning step is done, there is no need to calculate the score because that move was done and undone earlier.
As a result, there is no guarantee that such changes applied during score calculation are actually done.
====


[[easyJavaScoreCalculation]]
=== Easy Java Score Calculation

An easy way to implement your score calculation in Java.

* Advantages:
** Plain old Java: no learning curve
** Opportunity to delegate score calculation to an existing code base or legacy system
* Disadvantages:
** Slower and less scalable
*** Because there is no <<incrementalScoreCalculation,incremental score calculation>>

Just implement one method of the interface ``EasyScoreCalculator``:

[source,java,options=""nowrap""]
----
public interface EasyScoreCalculator<Solution_> {

    Score calculateScore(Solution_ solution);
   
}
----

For example in n queens:

[source,java,options=""nowrap""]
----
public class NQueensEasyScoreCalculator implements EasyScoreCalculator<NQueens> {

    public SimpleScore calculateScore(NQueens nQueens) {
        int n = nQueens.getN();
        List<Queen> queenList = nQueens.getQueenList();
        
        int score = 0;
        for (int i = 0; i < n; i++) {
            for (int j = i + 1; j < n; j++) {
                Queen leftQueen = queenList.get(i);
                Queen rightQueen = queenList.get(j);
                if (leftQueen.getRow() != null && rightQueen.getRow() != null) {
                    if (leftQueen.getRowIndex() == rightQueen.getRowIndex()) {
                        score--;
                    }
                    if (leftQueen.getAscendingDiagonalIndex() == rightQueen.getAscendingDiagonalIndex()) {
                        score--;
                    }
                    if (leftQueen.getDescendingDiagonalIndex() == rightQueen.getDescendingDiagonalIndex()) {
                        score--;
                    }
                }
            }
        }
        return SimpleScore.valueOf(score);
    }

}
----

Configure it in your solver configuration:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <easyScoreCalculatorClass>org.optaplanner.examples.nqueens.solver.score.NQueensEasyScoreCalculator</easyScoreCalculatorClass>
  </scoreDirectorFactory>
----

Alternatively, build a `EasyScoreCalculator` instance at runtime and set it with the programmatic API:

[source,java,options=""nowrap""]
----
    solverFactory.getSolverConfig().getScoreDirectorFactoryConfig.setEasyScoreCalculator(easyScoreCalculator);
----


[[incrementalJavaScoreCalculation]]
=== Incremental Java Score Calculation

A way to implement your score calculation incrementally in Java.

* Advantages:
** Very fast and scalable
*** Currently the fastest if implemented correctly
* Disadvantages:
** Hard to write
*** A scalable implementation heavily uses maps, indexes, ... (things the Drools rule engine can do for you)
*** You have to learn, design, write and improve all these performance optimizations yourself
** Hard to read
*** Regular score constraint changes can lead to a high maintenance cost

Implement all the methods of the interface `IncrementalScoreCalculator` and extend the class ``AbstractIncrementalScoreCalculator``:

[source,java,options=""nowrap""]
----
public interface IncrementalScoreCalculator<Solution_> {

    void resetWorkingSolution(Solution_ workingSolution);

    void beforeEntityAdded(Object entity);

    void afterEntityAdded(Object entity);

    void beforeVariableChanged(Object entity, String variableName);

    void afterVariableChanged(Object entity, String variableName);

    void beforeEntityRemoved(Object entity);

    void afterEntityRemoved(Object entity);

    Score calculateScore();
    
}
----

image::Chapter-Score_calculation/incrementalScoreCalculatorSequenceDiagram.png[align=""center""]

For example in n queens:

[source,java,options=""nowrap""]
----
public class NQueensAdvancedIncrementalScoreCalculator extends AbstractIncrementalScoreCalculator<NQueens> {

    private Map<Integer, List<Queen>> rowIndexMap;
    private Map<Integer, List<Queen>> ascendingDiagonalIndexMap;
    private Map<Integer, List<Queen>> descendingDiagonalIndexMap;

    private int score;

    public void resetWorkingSolution(NQueens nQueens) {
        int n = nQueens.getN();
        rowIndexMap = new HashMap<Integer, List<Queen>>(n);
        ascendingDiagonalIndexMap = new HashMap<Integer, List<Queen>>(n * 2);
        descendingDiagonalIndexMap = new HashMap<Integer, List<Queen>>(n * 2);
        for (int i = 0; i < n; i++) {
            rowIndexMap.put(i, new ArrayList<Queen>(n));
            ascendingDiagonalIndexMap.put(i, new ArrayList<Queen>(n));
            descendingDiagonalIndexMap.put(i, new ArrayList<Queen>(n));
            if (i != 0) {
                ascendingDiagonalIndexMap.put(n - 1 + i, new ArrayList<Queen>(n));
                descendingDiagonalIndexMap.put((-i), new ArrayList<Queen>(n));
            }
        }
        score = 0;
        for (Queen queen : nQueens.getQueenList()) {
            insert(queen);
        }
    }

    public void beforeEntityAdded(Object entity) {
        // Do nothing
    }

    public void afterEntityAdded(Object entity) {
        insert((Queen) entity);
    }

    public void beforeVariableChanged(Object entity, String variableName) {
        retract((Queen) entity);
    }

    public void afterVariableChanged(Object entity, String variableName) {
        insert((Queen) entity);
    }

    public void beforeEntityRemoved(Object entity) {
        retract((Queen) entity);
    }

    public void afterEntityRemoved(Object entity) {
        // Do nothing
    }

    private void insert(Queen queen) {
        Row row = queen.getRow();
        if (row != null) {
            int rowIndex = queen.getRowIndex();
            List<Queen> rowIndexList = rowIndexMap.get(rowIndex);
            score -= rowIndexList.size();
            rowIndexList.add(queen);
            List<Queen> ascendingDiagonalIndexList = ascendingDiagonalIndexMap.get(queen.getAscendingDiagonalIndex());
            score -= ascendingDiagonalIndexList.size();
            ascendingDiagonalIndexList.add(queen);
            List<Queen> descendingDiagonalIndexList = descendingDiagonalIndexMap.get(queen.getDescendingDiagonalIndex());
            score -= descendingDiagonalIndexList.size();
            descendingDiagonalIndexList.add(queen);
        }
    }

    private void retract(Queen queen) {
        Row row = queen.getRow();
        if (row != null) {
            List<Queen> rowIndexList = rowIndexMap.get(queen.getRowIndex());
            rowIndexList.remove(queen);
            score += rowIndexList.size();
            List<Queen> ascendingDiagonalIndexList = ascendingDiagonalIndexMap.get(queen.getAscendingDiagonalIndex());
            ascendingDiagonalIndexList.remove(queen);
            score += ascendingDiagonalIndexList.size();
            List<Queen> descendingDiagonalIndexList = descendingDiagonalIndexMap.get(queen.getDescendingDiagonalIndex());
            descendingDiagonalIndexList.remove(queen);
            score += descendingDiagonalIndexList.size();
        }
    }

    public SimpleScore calculateScore() {
        return SimpleScore.valueOf(score);
    }

}
----

Configure it in your solver configuration:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <incrementalScoreCalculatorClass>org.optaplanner.examples.nqueens.solver.score.NQueensAdvancedIncrementalScoreCalculator</incrementalScoreCalculatorClass>
  </scoreDirectorFactory>
----

[NOTE]
====
A piece of incremental score calculator code can be difficult to write and to review.
Assert its correctness by using <<invalidScoreDetection,an ``EasyScoreCalculator`` to do the assertions triggered by the ``environmentMode``>>.
====

Optionally, to explain a score with `ScoreDirector.getConstraintMatchTotals()`
or to get better output when the `IncrementalScoreCalculator` is corrupted in `FAST_ASSERT` or `FULL_ASSERT` `environmentMode`,
implement also the `ConstraintMatchAwareIncrementalScoreCalculator` interface:

[source,java,options=""nowrap""]
----
public interface ConstraintMatchAwareIncrementalScoreCalculator<Solution_> {

    void resetWorkingSolution(Solution_ workingSolution, boolean constraintMatchEnabled);

    Collection<ConstraintMatchTotal> getConstraintMatchTotals();
    
}
----


[[droolsScoreCalculation]]
=== Drools Score Calculation


[[droolsScoreCalculationOverview]]
==== Overview

Implement your score calculation using the Drools rule engine.
Every score constraint is written as one or more score rules.

* Advantages:
** Incremental score calculation for free
*** Because most DRL syntax uses forward chaining, it does incremental calculation without any extra code
** Score constraints are isolated as separate rules
*** Easy to add or edit existing score rules
** Flexibility to augment your score constraints by
*** Defining them in decision tables
**** Excel (XLS) spreadsheet
**** KIE Workbench WebUI
*** Translate them into natural language with DSL
*** Store and release in the KIE Workbench repository
** Performance optimizations in future versions for free
*** In every release, the Drools rule engine tends to become faster
* Disadvantages:
** DRL learning curve
** Usage of DRL
*** Polyglot fear can prohibit the use of a new language such as DRL in some organizations


[[droolsScoreRulesConfiguration]]
==== Drools Score Rules Configuration

There are several ways to define where your score rules live.


[[droolsScoreCalculationScoreDrl]]
===== A scoreDrl Resource on the Classpath

This is the easy way.
The score rules live in a DRL file which is provided as a classpath resource.
Just add the score rules DRL file in the solver configuration as a `<scoreDrl>` element:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <scoreDrl>org/optaplanner/examples/nqueens/solver/nQueensScoreRules.drl</scoreDrl>
  </scoreDirectorFactory>
----

In a typical project (following the Maven directory structure), that DRL file would be located at `$PROJECT_DIR/src/main/resources/org/optaplanner/examples/nqueens/solver/nQueensScoreRules.drl` (even for a war project).

[NOTE]
====
The `<scoreDrl>` element expects a classpath resource, as defined by ``ClassLoader.getResource(String)``, it does not accept a ``File``, nor an URL, nor a webapp resource.
See below to use a `File` instead.
====

Add multiple `<scoreDrl>` elements if the score rules are split across multiple DRL files.

Optionally, you can also set drools configuration properties (but be careful of backwards compatibility issues):

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <scoreDrl>org/optaplanner/examples/nqueens/solver/nQueensScoreRules.drl</scoreDrl>
    <kieBaseConfigurationProperties>
      <drools.equalityBehavior>...</drools.equalityBehavior>
    </kieBaseConfigurationProperties>
  </scoreDirectorFactory>
----


[[droolsScoreCalculationScoreDrlFile]]
===== A scoreDrlFile

To use `File` on the local file system, instead of a classpath resource, add the score rules DRL file in the solver configuration as a `<scoreDrlFile>` element:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <scoreDrlFile>/home/ge0ffrey/tmp/nQueensScoreRules.drl</scoreDrlFile>
  </scoreDirectorFactory>
----

[WARNING]
====
For portability reasons, a classpath resource is recommended over a File.
An application build on one computer, but used on another computer, might not find the file on the same location.
Worse, if they use a different Operating System, it is hard to choose a portable file path.
====

Add multiple `<scoreDrlFile>` elements if the score rules are split across multiple DRL files.


[[droolsScoreCalculationKsessionName]]
===== A ksessionName in a Kjar from a Maven repository

This way allows you to use score rules defined by the Workbench or build a kjar and deploy it to the Execution Server.
Both the score rules and the solver configuration are resources in a kjar.
Clients can obtain that kjar either from the local classpath, from a local Maven repository or even from a remote Maven repository.

The score rules still live in a DRL file, but the `KieContainer` finds that DRL file through the `META-INF/kmodule.xml` file:

[source,xml,options=""nowrap""]
----
<kmodule xmlns=""http://www.drools.org/xsd/kmodule"">
  <kbase name=""nQueensKbase"" packages=""org.optaplanner.examples.nqueens.solver"">
    <ksession name=""nQueensKsession""/>
  </kbase>
</kmodule>
----

The kmodule above will pick up all the DRL files in the package ``org.optaplanner.examples.nqueens.solver``.
A kbase can even extend another kbase.

Add the ksession name in the solver configuration as a `<ksessionName>` element:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <ksessionName>nQueensKsession</ksessionName>
  </scoreDirectorFactory>
----

In this approach, it's required to use a `SolverFactory.createFromKieContainerXmlResource(...)` method to <<solverConfigurationByXML,build the `SolverFactory`>>.
If no `<ksessionName>` element is specified, the default ksession of the `kmodule.xml` is used.


[[implementingAScoreRule]]
==== Implementing a Score Rule

Here is an example of a score constraint implemented as a score rule in a DRL file:

[source,options=""nowrap""]
----
rule ""multipleQueensHorizontal""
    when
        Queen($id : id, row != null, $i : rowIndex)
        Queen(id > $id, rowIndex == $i)
    then
        scoreHolder.addConstraintMatch(kcontext, -1);
end
----

This score rule will fire once for every 2 queens with the same ``rowIndex``.
The `(id > $id)` condition is needed to assure that for 2 queens A and B, it can only fire for (A, B) and not for (B, A), (A, A) or (B, B). Let us take a closer look at this score rule on this solution of 4 queens:

image::Chapter-Score_calculation/unsolvedNQueens04.png[align=""center""]

In this solution the multipleQueensHorizontal score rule will fire for 6 queen couples: (A, B), (A, C), (A, D), (B, C), (B, D) and (C, D). Because none of the queens are on the same vertical or diagonal line, this solution will have a score of ``-6``.
An optimal solution of 4 queens has a score of ``0``.

[NOTE]
====
Notice that every score rule will relate to at least one planning entity class (directly or indirectly through a logically inserted fact).

This is a normal case.
It would be a waste of time to write a score rule that only relates to problem facts, as the consequence will never change during planning, no matter what the possible solution.
====

[NOTE]
====
The `kcontext` variable is a magic variable in Drools Expert.
The ``scoreHolder``'s method uses it to do incremental score calculation correctly and to create a `ConstraintMatch` instance.
====


[[weighingScoreRules]]
==== Weighing Score Rules

A `ScoreHolder` instance is asserted into the `KieSession` as a global called ``scoreHolder``.
The score rules need to (directly or indirectly) update that instance.

[source,options=""nowrap""]
----
global SimpleScoreHolder scoreHolder;

rule ""multipleQueensHorizontal""
    when
        Queen($id : id, row != null, $i : rowIndex)
        Queen(id > $id, rowIndex == $i)
    then
        scoreHolder.addConstraintMatch(kcontext, -1);
end

// multipleQueensVertical is obsolete because it is always 0

rule ""multipleQueensAscendingDiagonal""
    when
        Queen($id : id, row != null, $i : ascendingDiagonalIndex)
        Queen(id > $id, ascendingDiagonalIndex == $i)
    then
        scoreHolder.addConstraintMatch(kcontext, -1);
end

rule ""multipleQueensDescendingDiagonal""
    when
        Queen($id : id, row != null, $i : descendingDiagonalIndex)
        Queen(id > $id, descendingDiagonalIndex == $i)
    then
        scoreHolder.addConstraintMatch(kcontext, -1);
end
----

[NOTE]
====
To learn more about the Drools rule language (DRL), consult https://drools.org/learn/documentation.html[the Drools documentation].
====

Most use cases also weigh their constraint types or even their matches differently, by using a specific weight for each constraint match.
For example in <<curriculumCourse,course scheduling>>, assigning a `Lecture` to a `Room` that is lacking two seats is weighted equally bad as having one isolated `Lecture` in a ``Curriculum``:

[source,options=""nowrap""]
----
global HardSoftScoreHolder scoreHolder;

// RoomCapacity: For each lecture, the number of students that attend the course must be less or equal
// than the number of seats of all the rooms that host its lectures.
rule ""roomCapacity""
    when
        $room : Room($capacity : capacity)
        $lecture : Lecture(room == $room, studentSize > $capacity, $studentSize : studentSize)
    then
        // Each student above the capacity counts as 1 point of penalty.
        scoreHolder.addSoftConstraintMatch(kcontext, ($capacity - $studentSize));
end

// CurriculumCompactness: Lectures belonging to a curriculum should be adjacent
// to each other (i.e., in consecutive periods).
// For a given curriculum we account for a violation every time there is one lecture not adjacent
// to any other lecture within the same day.
rule ""curriculumCompactness""
    when
        ...
    then
        // Each isolated lecture in a curriculum counts as 2 points of penalty.
        scoreHolder.addSoftConstraintMatch(kcontext, -2);
end
----


[[initializingScoreTrend]]
=== InitializingScoreTrend

The `InitializingScoreTrend` specifies how the Score will change as more and more variables are initialized (while the already initialized variables do not change). Some optimization algorithms (such Construction Heuristics and Exhaustive Search) run faster if they have such information.

For the Score (or each <<scoreLevel,score level>> separately), specify a trend:

* `ANY` (default): Initializing an extra variable can change the score positively or negatively. Gives no performance gain.
* `ONLY_UP` (rare): Initializing an extra variable can only change the score positively. Implies that:
** There are only positive constraints
** And initializing the next variable can not unmatch a positive constraint that was matched by a previous initialized variable.
* ``ONLY_DOWN``: Initializing an extra variable can only change the score negatively. Implies that:
** There are only negative constraints
** And initializing the next variable can not unmatch a negative constraint that was matched by a previous initialized variable.

Most use cases only have negative constraints.
Many of those have an `InitializingScoreTrend` that only goes down:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <scoreDrl>.../cloudBalancingScoreRules.drl</scoreDrl>
    <initializingScoreTrend>ONLY_DOWN</initializingScoreTrend>
  </scoreDirectorFactory>
----

Alternatively, you can also specify the trend for each score level separately:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <scoreDrl>.../cloudBalancingScoreRules.drl</scoreDrl>
    <initializingScoreTrend>ONLY_DOWN/ONLY_DOWN</initializingScoreTrend>
  </scoreDirectorFactory>
----


[[invalidScoreDetection]]
=== Invalid Score Detection

When you put <<environmentMode,the `environmentMode`>>in `FULL_ASSERT` (or ``FAST_ASSERT``),
it will detect score corruption in the <<incrementalScoreCalculation,incremental score calculation>>.
However, that will not verify that your score calculator actually implements your score constraints as your business desires.
For example, one score rule might consistently match the wrong pattern.
To verify the score rules against an independent implementation, configure a ``assertionScoreDirectorFactory``:

[source,xml,options=""nowrap""]
----
  <environmentMode>FAST_ASSERT</environmentMode>
  ...
  <scoreDirectorFactory>
    <scoreDrl>org/optaplanner/examples/nqueens/solver/nQueensScoreRules.drl</scoreDrl>
    <assertionScoreDirectorFactory>
      <easyScoreCalculatorClass>org.optaplanner.examples.nqueens.solver.score.NQueensEasyScoreCalculator</easyScoreCalculatorClass>
    </assertionScoreDirectorFactory>
  </scoreDirectorFactory>
----

This way, the `scoreDrl` will be validated by the ``EasyScoreCalculator``.

[NOTE]
====
This works well to isolate score corruption,
but to verify that the score rules implement the real business needs,
<<testingScoreConstraints, a unit test with a ScoreVerifier>> is usually better.
====


[[scoreCalculationPerformanceTricks]]
== Score Calculation Performance Tricks


[[scoreCalculationPerformanceTricksOverview]]
=== Overview

The `Solver` will normally spend most of its execution time running the score calculation (which is called in its deepest loops). Faster score calculation will return the same solution in less time with the same algorithm, which normally means a better solution in equal time.


[[scoreCalculationSpeed]]
=== Score Calculation Speed

After solving a problem, the `Solver` will log the __score calculation speed per second__.
This is a good measurement of Score calculation performance, despite that it is affected by non score calculation execution time.
It depends on the problem scale of the problem dataset.
Normally, even for high scale problems, it is higher than ``1000``, except when you are using an ``EasyScoreCalculator``.

[IMPORTANT]
====
When improving your score calculation, focus on maximizing the score calculation speed, instead of maximizing the best score.
A big improvement in score calculation can sometimes yield little or no best score improvement, for example when the algorithm is stuck in a local or global optima.
If you are watching the calculation speed instead, score calculation improvements are far more visible.

Furthermore, watching the calculation speed, allows you to remove or add score constraints, and still compare it with the original calculation speed.
Comparing the best score with the original would be wrong, because it is comparing apples and oranges.
====


[[incrementalScoreCalculation]]
=== Incremental Score Calculation (with Deltas)

When a `Solution` changes, incremental score calculation (AKA delta based score calculation), will calculate the delta with the previous state to find the new ``Score``, instead of recalculating the entire score on every solution evaluation.

For example, if a single queen A moves from row `1` to ``2``, it will not bother to check if queen B and C can attack each other, since neither of them changed.

.Incremental Score Calculation for the 4 Queens Puzzle
image::Chapter-Score_calculation/incrementalScoreCalculationNQueens04.png[align=""center""]

This is a huge performance and scalability gain.
*Drools score calculation gives you this huge scalability gain without forcing you to write a complicated incremental score calculation algorithm.*
Just let the Drools rule engine do the hard work.

Notice that the speedup is relative to the size of your planning problem (your __n__), making incremental score calculation far more scalable.


[[avoidCallingRemoteServicesDuringScoreCalculation]]
=== Avoid Calling Remote Services During Score Calculation

Do not call remote services in your score calculation (except if you are bridging `EasyScoreCalculator` to a legacy system). The network latency will kill your score calculation performance.
Cache the results of those remote services if possible.

If some parts of a constraint can be calculated once, when the `Solver` starts, and never change during solving, then turn them into <<cachedProblemFact,cached problem facts>>.


[[pointlessConstraints]]
=== Pointless Constraints

If you know a certain constraint can never be broken (or it is always broken), you need not write a score constraint for it.
For example in n queens, the score calculation does not check if multiple queens occupy the same column, because a ``Queen``'s `column` never changes and every `Solution` starts with each `Queen` on a different ``column``.

[NOTE]
====
Do not go overboard with this.
If some datasets do not use a specific constraint but others do, just return out of the constraint as soon as you can.
There is no need to dynamically change your score calculation based on the dataset.
====


[[buildInHardConstraint]]
=== Built-in Hard Constraint

Instead of implementing a hard constraint, it can sometimes be built in.
For example, If `Lecture` A should never be assigned to `Room` X, but it uses `ValueRangeProvider` on Solution, so the `Solver` will often try to assign it to `Room` X too (only to find out that it breaks a hard constraint). Use <<valueRangeProviderOnPlanningEntity,a ValueRangeProvider on the planning entity>> or <<filteredSelection,filtered selection>> to define that Course A should only be assigned a `Room` different than X.

This can give a good performance gain in some use cases, not just because the score calculation is faster, but mainly because most optimization algorithms will spend less time evaluating infeasible solutions.
However, usually this not a good idea because there is a real risk of trading short term benefits for long term harm:

* Many optimization algorithms rely on the freedom to break hard constraints when changing planning entities, to get out of local optima.
* Both implementation approaches have limitations (feature compatibility, disabling automatic performance optimizations), as explained in their documentation.


[[otherScoreCalculationPerformanceTricks]]
=== Other Score Calculation Performance Tricks

* Verify that your score calculation happens in the correct `Number` type. If you are making the sum of `int` values, do not let Drools sum it in a `double` which takes longer.
* For optimal performance, always use server mode (``java -server``). We have seen performance increases of 50% by turning on server mode.
* For optimal performance, use the latest Java version. For example, in the past we have seen performance increases of 30% by switching from java 1.5 to 1.6.
* Always remember that premature optimization is the root of all evil. Make sure your design is flexible enough to allow configuration based tweaking.


[[scoreTrap]]
=== Score Trap

Make sure that none of your score constraints cause a score trap.
A trapped score constraint uses the same weight for different constraint matches, when it could just as easily use a different weight.
It effectively lumps its constraint matches together, which creates a flatlined score function for that constraint.
This can cause a solution state in which several moves need to be done to resolve or lower the weight of that single constraint.
Some examples of score traps:

* You need two doctors at each table, but you are only moving one doctor at a time. So the solver has no incentive to move a doctor to a table with no doctors. Punish a table with no doctors more then a table with only one doctor in that score constraint in the score function.
* Two exams need to be conducted at the same time, but you are only moving one exam at a time. So the solver has to move one of those exams to another timeslot without moving the other in the same move. Add a coarse-grained move that moves both exams at the same time.

For example, consider this score trap.
If the blue item moves from an overloaded computer to an empty computer, the hard score should improve.
The trapped score implementation fails to do that:

image::Chapter-Score_calculation/scoreTrap.png[align=""center""]

The Solver should eventually get out of this trap, but it will take a lot of effort (especially if there are even more processes on the overloaded computer). Before they do that, they might actually start moving more processes into that overloaded computer, as there is no penalty for doing so.

[NOTE]
====
Avoiding score traps does not mean that your score function should be smart enough to avoid local optima.
Leave it to the optimization algorithms to deal with the local optima.

Avoiding score traps means to avoid, for each score constraint individually, a flatlined score function.
====

[IMPORTANT]
====
Always specify the degree of infeasibility.
The business will often say ""if the solution is infeasible, it does not matter how infeasible it is."" While that is true for the business, it is not true for score calculation as it benefits from knowing how infeasible it is.
In practice, soft constraints usually do this naturally and it is just a matter of doing it for the hard constraints too.
====

There are several ways to deal with a score trap:

* Improve the score constraint to make a distinction in the score weight. For example, penalize `-1hard` for every missing CPU, instead of just `-1hard` if any CPU is missing.
* If changing the score constraint is not allowed from the business perspective, add a lower score level with a score constraint that makes such a distinction. For example, penalize `-1subsoft` for every missing CPU, on top of `-1hard` if any CPU is missing. The business ignores the subsoft score level.
* Add coarse-grained moves and union select them with the existing fine-grained moves. A coarse-grained move effectively does multiple moves to directly get out of a score trap with a single move. For example, move multiple items from the same container to another container.


[[stepLimitBenchmark]]
=== stepLimit Benchmark

Not all score constraints have the same performance cost.
Sometimes one score constraint can kill the score calculation performance outright.
Use the <<benchmarker,Benchmarker>> to do a one minute run and check what happens to the score calculation speed if you comment out all but one of the score constraints.


[[fairnessScoreConstraints]]
=== Fairness Score Constraints

Some use cases have a business requirement to provide a fair schedule (usually as a soft score constraint), for example:

* Fairly distribute the workload amongst the employees, to avoid envy.
* Evenly distribute the workload amongst assets, to improve reliability.

Implementing such a constraint can seem difficult (especially because there are different ways to formalize fairness), but usually the _squared workload_ implementation behaves most desirable.
For each employee/asset, count the workload `w` and subtract `w²` from the score.

image::Chapter-Score_calculation/fairnessScoreConstraint.png[align=""center""]

As shown above, the _squared workload_ implementation guarantees that if you select two employees from a given solution and make their distribution between those two employees fairer, then the resulting new solution will have a better overall score.
Don not just use the difference from the average workload, as that can lead to unfairness, as demonstrated below.

image::Chapter-Score_calculation/fairnessScoreConstraintPitfall.png[align=""center""]


[NOTE]
====
Instead of the __squared workload__, it is also possible to use the http://en.wikipedia.org/wiki/Variance[variance] (squared difference to the average) or the http://en.wikipedia.org/wiki/Standard_deviation[standard deviation] (square root of the variance). This has no effect on the score comparison, because the average will not change during planning.
It is just more work to implement (because the average needs to be known) and trivially slower (because the calculation is a bit longer).
====

When the workload is perfect balanced, the user often likes to see a `0` score, instead of the distracting `-34soft` in the image above (for the last solution which is almost perfectly balanced). To nullify this, either add the average multiplied by the number of entities to the score or instead show the variance or standard deviation in the UI.


[[explainingTheScore]]
== Explaining the Score: Using Score Calculation Outside the `Solver`

If other parts of your application, for example your webUI, need to calculate the score of a solution
or they need to point out what's causing constraints to be broken/fulfilled,
reuse the `ScoreDirectorFactory` of the `Solver` to build a separate `ScoreDirector` for that webUI:

[source,java,options=""nowrap""]
----
ScoreDirectorFactory<CloudBalance> scoreDirectorFactory = solver.getScoreDirectorFactory();
ScoreDirector<CloudBalance> guiScoreDirector = scoreDirectorFactory.buildScoreDirector();
...
guiScoreDirector.dispose();
----

Then use it when you need to calculate the `Score` of a ``Solution``:

[source,java,options=""nowrap""]
----
guiScoreDirector.setWorkingSolution(cloudBalance);
Score score = guiScoreDirector.calculateScore();

----

[IMPORTANT]
====
Don't forget to call `ScoreDirector.dispose()` when the `ScoreDirector` becomes useless,
especially with <<droolsScoreCalculation,Drools score calculation>>, to avoid a memory leak.
====

To explain in the GUI which planning entities and problem facts are causing which part of the ``Score``,
get the `ConstraintMatch` objects from the ``ScoreDirector``:

[source,java,options=""nowrap""]
----
for (ConstraintMatchTotal constraintMatchTotal : guiScoreDirector.getConstraintMatchTotals()) {
    String constraintName = constraintMatchTotal.getConstraintName();
    Score scoreTotal = constraintMatchTotal.getScoreTotal();
    for (ConstraintMatch constraintMatch : constraintMatchTotal.getConstraintMatchSet()) {
        List<Object> justificationList = constraintMatch.getJustificationList();
        Score score = constraintMatch.getScore();
        ...
    }
}
----

[NOTE]
====
<<droolsScoreCalculation,Drools score calculation>> supports constraint matches automatically,
but <<incrementalJavaScoreCalculation,incremental Java score calculation>> requires requires implementing an extra interface (see that section).
====


[[testingScoreConstraints]]
== Testing score constraints with JUnit

It's recommended to write a unit test for each score constraint individually to check that it behaves correctly.

Add a test scoped dependency to the `optaplanner-test` jar to take advantage of the JUnit integration and use the `ScoreVerifier` classes to test score rules in DRL (or a constraint match aware incremental score calculator). For example, suppose we want to test these score rules:

[source,options=""nowrap""]
----
global HardSoftScoreHolder scoreHolder;

rule ""requiredCpuPowerTotal""
    when
        ...
    then
        scoreHolder.addHardConstraintMatch(...);
end

...

rule ""computerCost""
    when
        ...
    then
        scoreHolder.addSoftConstraintMatch(...);
end
----

For each score rule, we have a separate `@Test` that only tests the effect of that score rule on the score:

[source,java,options=""nowrap""]
----
public class CloudBalancingScoreConstraintTest {

    private HardSoftScoreVerifier<CloudBalance> scoreVerifier = new HardSoftScoreVerifier<>(
            SolverFactory.createFromXmlResource(
                    ""org/optaplanner/examples/cloudbalancing/solver/cloudBalancingSolverConfig.xml""));

    @Test
    public void requiredCpuPowerTotal() {
        CloudComputer c1 = new CloudComputer(1L, 1000, 1, 1, 1);
        CloudComputer c2 = new CloudComputer(2L, 200, 1, 1, 1);
        CloudProcess p1 = new CloudProcess(1L, 700, 0, 0);
        CloudProcess p2 = new CloudProcess(2L, 70, 0, 0);
        CloudBalance solution = new CloudBalance(0L,
                Arrays.asList(c1, c2),
                Arrays.asList(p1, p2));
        // Uninitialized
        scoreVerifier.assertHardWeight(""requiredCpuPowerTotal"", 0, solution);
        p1.setComputer(c1);
        p2.setComputer(c1);
        // Usage 700 + 70 is within capacity 1000 of c1
        scoreVerifier.assertHardWeight(""requiredCpuPowerTotal"", 0, solution);
        p1.setComputer(c2);
        p2.setComputer(c2);
        // Usage 700 + 70 is above capacity 200 of c2
        scoreVerifier.assertHardWeight(""requiredCpuPowerTotal"", -570, solution);
    }

    ...

    @Test
    public void computerCost() {
        CloudComputer c1 = new CloudComputer(1L, 1, 1, 1, 200);
        CloudComputer c2 = new CloudComputer(2L, 1, 1, 1, 30);
        CloudProcess p1 = new CloudProcess(1L, 0, 0, 0);
        CloudProcess p2 = new CloudProcess(2L, 0, 0, 0);
        CloudBalance solution = new CloudBalance(0L,
                Arrays.asList(c1, c2),
                Arrays.asList(p1, p2));
        // Uninitialized
        scoreVerifier.assertSoftWeight(""computerCost"", 0, solution);
        p1.setComputer(c1);
        p2.setComputer(c1);
        // Pay 200 for c1
        scoreVerifier.assertSoftWeight(""computerCost"", -200, solution);
        p2.setComputer(c2);
        // Pay 200 + 30 for c1 and c2
        scoreVerifier.assertSoftWeight(""computerCost"", -230, solution);
    }

}
----

There is a `ScoreVerifier` implementation for each `Score` implementation.
In the `assertHardWeight()` and `assertSoftWeight()` methods, the weight of the other score rules is ignored (even those of the same score level).

[NOTE]
====
A ScoreVerifier does not work well to isolate score corruption,
use <<invalidScoreDetection, an `assertionScoreDirectorFactory`>> instead.
====
",12230,False,1990.8879801760515,median
"[[debezium-mysql-component]]
= Debezium MySQL Connector Component
:docTitle: Debezium MySQL Connector
:artifactId: camel-debezium-mysql
:description: Capture changes from a MySQL database.
:since: 3.0
:supportLevel: Stable
:component-header: Only consumer is supported
include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/debezium-mysql.adoc[opts=optional]

*Since Camel {since}*

*{component-header}*

The Debezium MySQL component is wrapper around https://debezium.io/[Debezium] using https://debezium.io/documentation/reference/0.9/operations/embedded.html[Debezium Embedded], which enables Change Data Capture from MySQL database using Debezium without the need for Kafka or Kafka Connect.

*Note on handling failures:* Per https://debezium.io/documentation/reference/0.9/operations/embedded.html#_handling_failures[Debezium Embedded Engine] documentation, the engines is actively recording source offsets and periodically flushes these offsets to a persistent storage, so when the application is restarted or crashed, the engine will resume from the last recorded offset.
Thus, at normal operation, your downstream routes will receive each event exactly once, however in case of an application crash (not having a graceful shutdown), the application will resume from the last recorded offset,
which may result in receiving duplicate events immediately after the restart. Therefore, your downstream routes should be tolerant enough of such case and deduplicate events if needed.

*Note:* The Debezium MySQL component is currently not supported in OSGi

Maven users will need to add the following dependency to their `pom.xml`
for this component.

[source,xml]
----
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-debezium-mysql</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
----

== URI format

[source,text]
---------------------------
debezium-mysql:name[?options]
---------------------------

*Note:* Due to licensing issues, you will need to add the dependency for `mysql-conenctor-java` if you are using MySQL connector, just add the following to your POM file:
[source,xml]
----
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.15</version>
</dependency>
----

== Options


// component options: START
The Debezium MySQL Connector component supports 80 options, which are listed below.



[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *additionalProperties* (common) | Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\\http://localhost:8811/avro |  | Map
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *configuration* (consumer) | Allow pre-configured Configurations to be set. |  | MySqlConnectorEmbeddedDebeziumConfiguration
| *internalKeyConverter* (consumer) | The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. | org.apache.kafka.connect.json.JsonConverter | String
| *internalValueConverter* (consumer) | The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. | org.apache.kafka.connect.json.JsonConverter | String
| *offsetCommitPolicy* (consumer) | The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. | io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy | String
| *offsetCommitTimeoutMs* (consumer) | Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. | 5s | long
| *offsetFlushIntervalMs* (consumer) | Interval at which to try committing offsets. The default is 1 minute. | 60s | long
| *offsetStorage* (consumer) | The name of the Java class that is responsible for persistence of connector offsets. | org.apache.kafka.connect.storage.FileOffsetBackingStore | String
| *offsetStorageFileName* (consumer) | Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. |  | String
| *offsetStoragePartitions* (consumer) | The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. |  | int
| *offsetStorageReplicationFactor* (consumer) | Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore |  | int
| *offsetStorageTopic* (consumer) | The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. |  | String
| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean
| *bigintUnsignedHandlingMode* (mysql) | Specify how BIGINT UNSIGNED columns should be represented in change events, including:'precise' uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'long' (the default) represents values using Java's 'long', which may not offer the precision but will be far easier to use in consumers. | long | String
| *binaryHandlingMode* (mysql) | Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string'hex' represents binary data as hex-encoded (base16) string | bytes | String
| *binlogBufferSize* (mysql) | The size of a look-ahead buffer used by the binlog reader to decide whether the transaction in progress is going to be committed or rolled back. Use 0 to disable look-ahead buffering. Defaults to 0 (i.e. buffering is disabled). | 0 | int
| *columnBlacklist* (mysql) | Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead) |  | String
| *columnExcludeList* (mysql) | Regular expressions matching columns to exclude from change events |  | String
| *columnIncludeList* (mysql) | Regular expressions matching columns to include in change events |  | String
| *connectKeepAlive* (mysql) | Whether a separate thread should be used to ensure the connection is kept alive. | true | boolean
| *connectKeepAliveIntervalMs* (mysql) | Interval in milliseconds to wait for connection checking if keep alive thread is used. | 1m | long
| *connectTimeoutMs* (mysql) | Maximum time in milliseconds to wait after trying to connect to the database before timing out. | 30s | int
| *databaseExcludeList* (mysql) | A comma-separated list of regular expressions that match database names to be excluded from monitoring |  | String
| *databaseHistory* (mysql) | The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. | io.debezium.relational.history.FileDatabaseHistory | String
| *databaseHistoryFileFilename* (mysql) | The path to the file that will be used to record the database history |  | String
| *databaseHistoryKafkaBootstrap{zwsp}Servers* (mysql) | A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. |  | String
| *databaseHistoryKafkaRecovery{zwsp}Attempts* (mysql) | The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). | 100 | int
| *databaseHistoryKafkaRecovery{zwsp}PollIntervalMs* (mysql) | The number of milliseconds to wait while polling for persisted data during recovery. | 100ms | int
| *databaseHistoryKafkaTopic* (mysql) | The name of the topic for the database schema history |  | String
| *databaseHistorySkipUnparseable{zwsp}Ddl* (mysql) | Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes. | false | boolean
| *databaseHistoryStoreOnly{zwsp}MonitoredTablesDdl* (mysql) | Controls what DDL will Debezium store in database history.By default (false) Debezium will store all incoming DDL statements. If set to truethen only DDL that manipulates a monitored table will be stored. | false | boolean
| *databaseHostname* (mysql) | Resolvable hostname or IP address of the MySQL database server. |  | String
| *databaseIncludeList* (mysql) | The databases for which changes are to be captured |  | String
| *databaseInitialStatements* (mysql) | A semicolon separated list of SQL statements to be executed when a JDBC connection (not binlog reading connection) to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only,but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter. |  | String
| *databaseJdbcDriver* (mysql) | JDBC Driver class name used to connect to the MySQL database server. | class com.mysql.cj.jdbc.Driver | String
| *databasePassword* (mysql) | *Required* Password of the MySQL database user to be used when connecting to the database. |  | String
| *databasePort* (mysql) | Port of the MySQL database server. | 3306 | int
| *databaseServerId* (mysql) | A numeric ID of this database client, which must be unique across all currently-running database processes in the cluster. This connector joins the MySQL database cluster as another server (with this unique ID) so it can read the binlog. By default, a random number is generated between 5400 and 6400. |  | long
| *databaseServerIdOffset* (mysql) | Only relevant if parallel snapshotting is configured. During parallel snapshotting, multiple (4) connections open to the database client, and they each need their own unique connection ID. This offset is used to generate those IDs from the base configured cluster ID. | 10000 | long
| *databaseServerName* (mysql) | *Required* Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. |  | String
| *databaseSslKeystore* (mysql) | Location of the Java keystore file containing an application process's own certificate and private key. |  | String
| *databaseSslKeystorePassword* (mysql) | Password to access the private key from the keystore file specified by 'ssl.keystore' configuration property or the 'javax.net.ssl.keyStore' system or JVM property. This password is used to unlock the keystore file (store password), and to decrypt the private key stored in the keystore (key password). |  | String
| *databaseSslMode* (mysql) | Whether to use an encrypted connection to MySQL. Options include'disabled' (the default) to use an unencrypted connection; 'preferred' to establish a secure (encrypted) connection if the server supports secure connections, but fall back to an unencrypted connection otherwise; 'required' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify_ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or'verify_identity' like 'verify_ca' but additionally verify that the server certificate matches the host to which the connection is attempted. | disabled | String
| *databaseSslTruststore* (mysql) | Location of the Java truststore file containing the collection of CA certificates trusted by this application process (trust store). |  | String
| *databaseSslTruststorePassword* (mysql) | Password to unlock the keystore file (store password) specified by 'ssl.trustore' configuration property or the 'javax.net.ssl.trustStore' system or JVM property. |  | String
| *databaseUser* (mysql) | Name of the MySQL database user to be used when connecting to the database. |  | String
| *decimalHandlingMode* (mysql) | Specify how DECIMAL and NUMERIC columns should be represented in change events, including:'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers. | precise | String
| *enableTimeAdjuster* (mysql) | MySQL allows user to insert year value as either 2-digit or 4-digit. In case of two digit the value is automatically mapped into 1970 - 2069.false - delegates the implicit conversion to the databasetrue - (the default) Debezium makes the conversion | true | boolean
| *eventDeserializationFailure{zwsp}HandlingMode* (mysql) | Specify how failures during deserialization of binlog events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. | fail | String
| *eventProcessingFailureHandling{zwsp}Mode* (mysql) | Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. | fail | String
| *gtidNewChannelPosition* (mysql) | If set to 'latest', when connector sees new GTID, it will start consuming gtid channel from the server latest executed gtid position. If 'earliest' (the default) connector starts reading channel from first available (not purged) gtid position on the server. | earliest | String
| *gtidSourceExcludes* (mysql) | The source UUIDs used to exclude GTID ranges when determine the starting position in the MySQL server's binlog. |  | String
| *gtidSourceFilterDmlEvents* (mysql) | If set to true, we will only produce DML events into Kafka for transactions that were written on mysql servers with UUIDs matching the filters defined by the gtid.source.includes or gtid.source.excludes configuration options, if they are specified. | true | boolean
| *gtidSourceIncludes* (mysql) | The source UUIDs used to include GTID ranges when determine the starting position in the MySQL server's binlog. |  | String
| *heartbeatIntervalMs* (mysql) | Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. | 0ms | int
| *heartbeatTopicsPrefix* (mysql) | The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. | __debezium-heartbeat | String
| *includeQuery* (mysql) | Whether the connector should include the original SQL query that generated the change event. Note: This option requires MySQL be configured with the binlog_rows_query_log_events option set to ON. Query will not be present for events generated from snapshot. WARNING: Enabling this option may expose tables or fields explicitly blacklisted or masked by including the original SQL statement in the change event. For this reason the default value is 'false'. | false | boolean
| *includeSchemaChanges* (mysql) | Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. | true | boolean
| *inconsistentSchemaHandlingMode* (mysql) | Specify how binlog events that belong to a table missing from internal schema representation (i.e. internal representation is not consistent with database) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'skip' the problematic event will be skipped. | fail | String
| *maxBatchSize* (mysql) | Maximum size of each batch of source records. Defaults to 2048. | 2048 | int
| *maxQueueSize* (mysql) | Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. | 8192 | int
| *messageKeyColumns* (mysql) | A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':',where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector,and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key.Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id |  | String
| *pollIntervalMs* (mysql) | Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. | 500ms | long
| *skippedOperations* (mysql) | The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped. |  | String
| *snapshotDelayMs* (mysql) | The number of milliseconds to delay before a snapshot will begin. | 0ms | long
| *snapshotEventsAsInserts* (mysql) | Whether or not to mark snapshot events as normal inserts (op 'c'). If disabled, the standard functionality of emitting these records as reads (op 'r') will be used. | true | boolean
| *snapshotFetchSize* (mysql) | The maximum number of records that should be loaded into memory while performing a snapshot |  | int
| *snapshotLockingMode* (mysql) | Controls how long the connector holds onto the global read lock while it is performing a snapshot. The default is 'minimal', which means the connector holds the global read lock (and thus prevents any updates) for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this can be done using the snapshot process' REPEATABLE READ transaction even when the lock is no longer held and other operations are updating the database. However, in some cases it may be desirable to block all writes for the entire duration of the snapshot; in such cases set this property to 'extended'. Using a value of 'none' will prevent the connector from acquiring any table locks during the snapshot process. This mode can only be used in combination with snapshot.mode values of 'schema_only' or 'schema_only_recovery' and is only safe to use if no schema changes are happening while the snapshot is taken. | minimal | String
| *snapshotMode* (mysql) | The criteria for running a snapshot upon startup of the connector. Options include: 'when_needed' to specify that the connector run a snapshot upon startup whenever it deems it necessary; 'schema_only' to only take a snapshot of the schema (table structures) but no actual data; 'initial' (the default) to specify the connector can run a snapshot only when no offsets are available for the logical server name; 'initial_only' same as 'initial' except the connector should stop after completing the snapshot and before it would normally read the binlog; and'never' to specify the connector should never run a snapshot and that upon first startup the connector should read from the beginning of the binlog. The 'never' mode should be used with care, and only when the binlog is known to contain all history. | initial | String
| *snapshotNewTables* (mysql) | BETA FEATURE: On connector restart, the connector will check if there have been any new tables added to the configuration, and snapshot them. There is presently only two options:'off': Default behavior. Do not snapshot new tables.'parallel': The snapshot of the new tables will occur in parallel to the continued binlog reading of the old tables. When the snapshot completes, an independent binlog reader will begin reading the events for the new tables until it catches up to present time. At this point, both old and new binlog readers will be momentarily halted and new binlog reader will start that will read the binlog for all configured tables. The parallel binlog reader will have a configured server id of 10000 the primary binlog reader's server id. | off | String
| *snapshotSelectStatement{zwsp}Overrides* (mysql) | This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors . Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted. |  | String
| *sourceStructVersion* (mysql) | A version of the format of the publicly visible source part in the message | v2 | String
| *tableBlacklist* (mysql) | A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead) |  | String
| *tableExcludeList* (mysql) | A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring |  | String
| *tableIgnoreBuiltin* (mysql) | Flag specifying whether built-in tables should be ignored. | true | boolean
| *tableIncludeList* (mysql) | The tables for which changes are to be captured |  | String
| *tableWhitelist* (mysql) | The tables for which changes are to be captured (deprecated, use table.include.list instead) |  | String
| *timePrecisionMode* (mysql) | Time, date and timestamps can be represented with different kinds of precisions, including:'adaptive_time_microseconds': the precision of date and timestamp values is based the database column's precision; but time fields always use microseconds precision;'connect': always represents time, date and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision. | adaptive_time_microseconds | String
| *tombstonesOnDelete* (mysql) | Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. | false | boolean
|===
// component options: END


// endpoint options: START
The Debezium MySQL Connector endpoint is configured using URI syntax:

----
debezium-mysql:name
----

with the following path and query parameters:

=== Path Parameters (1 parameters):


[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *name* | *Required* Unique name for the connector. Attempting to register again with the same name will fail. |  | String
|===


=== Query Parameters (80 parameters):


[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *additionalProperties* (common) | Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\\http://localhost:8811/avro |  | Map
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *internalKeyConverter* (consumer) | The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. | org.apache.kafka.connect.json.JsonConverter | String
| *internalValueConverter* (consumer) | The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. | org.apache.kafka.connect.json.JsonConverter | String
| *offsetCommitPolicy* (consumer) | The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. | io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy | String
| *offsetCommitTimeoutMs* (consumer) | Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. | 5s | long
| *offsetFlushIntervalMs* (consumer) | Interval at which to try committing offsets. The default is 1 minute. | 60s | long
| *offsetStorage* (consumer) | The name of the Java class that is responsible for persistence of connector offsets. | org.apache.kafka.connect.storage.FileOffsetBackingStore | String
| *offsetStorageFileName* (consumer) | Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. |  | String
| *offsetStoragePartitions* (consumer) | The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. |  | int
| *offsetStorageReplicationFactor* (consumer) | Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore |  | int
| *offsetStorageTopic* (consumer) | The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. |  | String
| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |  | ExchangePattern
| *bigintUnsignedHandlingMode* (mysql) | Specify how BIGINT UNSIGNED columns should be represented in change events, including:'precise' uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'long' (the default) represents values using Java's 'long', which may not offer the precision but will be far easier to use in consumers. | long | String
| *binaryHandlingMode* (mysql) | Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string'hex' represents binary data as hex-encoded (base16) string | bytes | String
| *binlogBufferSize* (mysql) | The size of a look-ahead buffer used by the binlog reader to decide whether the transaction in progress is going to be committed or rolled back. Use 0 to disable look-ahead buffering. Defaults to 0 (i.e. buffering is disabled). | 0 | int
| *columnBlacklist* (mysql) | Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead) |  | String
| *columnExcludeList* (mysql) | Regular expressions matching columns to exclude from change events |  | String
| *columnIncludeList* (mysql) | Regular expressions matching columns to include in change events |  | String
| *connectKeepAlive* (mysql) | Whether a separate thread should be used to ensure the connection is kept alive. | true | boolean
| *connectKeepAliveIntervalMs* (mysql) | Interval in milliseconds to wait for connection checking if keep alive thread is used. | 1m | long
| *connectTimeoutMs* (mysql) | Maximum time in milliseconds to wait after trying to connect to the database before timing out. | 30s | int
| *databaseExcludeList* (mysql) | A comma-separated list of regular expressions that match database names to be excluded from monitoring |  | String
| *databaseHistory* (mysql) | The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. | io.debezium.relational.history.FileDatabaseHistory | String
| *databaseHistoryFileFilename* (mysql) | The path to the file that will be used to record the database history |  | String
| *databaseHistoryKafkaBootstrap{zwsp}Servers* (mysql) | A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. |  | String
| *databaseHistoryKafkaRecovery{zwsp}Attempts* (mysql) | The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). | 100 | int
| *databaseHistoryKafkaRecovery{zwsp}PollIntervalMs* (mysql) | The number of milliseconds to wait while polling for persisted data during recovery. | 100ms | int
| *databaseHistoryKafkaTopic* (mysql) | The name of the topic for the database schema history |  | String
| *databaseHistorySkipUnparseable{zwsp}Ddl* (mysql) | Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes. | false | boolean
| *databaseHistoryStoreOnly{zwsp}MonitoredTablesDdl* (mysql) | Controls what DDL will Debezium store in database history.By default (false) Debezium will store all incoming DDL statements. If set to truethen only DDL that manipulates a monitored table will be stored. | false | boolean
| *databaseHostname* (mysql) | Resolvable hostname or IP address of the MySQL database server. |  | String
| *databaseIncludeList* (mysql) | The databases for which changes are to be captured |  | String
| *databaseInitialStatements* (mysql) | A semicolon separated list of SQL statements to be executed when a JDBC connection (not binlog reading connection) to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only,but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter. |  | String
| *databaseJdbcDriver* (mysql) | JDBC Driver class name used to connect to the MySQL database server. | class com.mysql.cj.jdbc.Driver | String
| *databasePassword* (mysql) | *Required* Password of the MySQL database user to be used when connecting to the database. |  | String
| *databasePort* (mysql) | Port of the MySQL database server. | 3306 | int
| *databaseServerId* (mysql) | A numeric ID of this database client, which must be unique across all currently-running database processes in the cluster. This connector joins the MySQL database cluster as another server (with this unique ID) so it can read the binlog. By default, a random number is generated between 5400 and 6400. |  | long
| *databaseServerIdOffset* (mysql) | Only relevant if parallel snapshotting is configured. During parallel snapshotting, multiple (4) connections open to the database client, and they each need their own unique connection ID. This offset is used to generate those IDs from the base configured cluster ID. | 10000 | long
| *databaseServerName* (mysql) | *Required* Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. |  | String
| *databaseSslKeystore* (mysql) | Location of the Java keystore file containing an application process's own certificate and private key. |  | String
| *databaseSslKeystorePassword* (mysql) | Password to access the private key from the keystore file specified by 'ssl.keystore' configuration property or the 'javax.net.ssl.keyStore' system or JVM property. This password is used to unlock the keystore file (store password), and to decrypt the private key stored in the keystore (key password). |  | String
| *databaseSslMode* (mysql) | Whether to use an encrypted connection to MySQL. Options include'disabled' (the default) to use an unencrypted connection; 'preferred' to establish a secure (encrypted) connection if the server supports secure connections, but fall back to an unencrypted connection otherwise; 'required' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify_ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or'verify_identity' like 'verify_ca' but additionally verify that the server certificate matches the host to which the connection is attempted. | disabled | String
| *databaseSslTruststore* (mysql) | Location of the Java truststore file containing the collection of CA certificates trusted by this application process (trust store). |  | String
| *databaseSslTruststorePassword* (mysql) | Password to unlock the keystore file (store password) specified by 'ssl.trustore' configuration property or the 'javax.net.ssl.trustStore' system or JVM property. |  | String
| *databaseUser* (mysql) | Name of the MySQL database user to be used when connecting to the database. |  | String
| *decimalHandlingMode* (mysql) | Specify how DECIMAL and NUMERIC columns should be represented in change events, including:'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers. | precise | String
| *enableTimeAdjuster* (mysql) | MySQL allows user to insert year value as either 2-digit or 4-digit. In case of two digit the value is automatically mapped into 1970 - 2069.false - delegates the implicit conversion to the databasetrue - (the default) Debezium makes the conversion | true | boolean
| *eventDeserializationFailure{zwsp}HandlingMode* (mysql) | Specify how failures during deserialization of binlog events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. | fail | String
| *eventProcessingFailureHandling{zwsp}Mode* (mysql) | Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. | fail | String
| *gtidNewChannelPosition* (mysql) | If set to 'latest', when connector sees new GTID, it will start consuming gtid channel from the server latest executed gtid position. If 'earliest' (the default) connector starts reading channel from first available (not purged) gtid position on the server. | earliest | String
| *gtidSourceExcludes* (mysql) | The source UUIDs used to exclude GTID ranges when determine the starting position in the MySQL server's binlog. |  | String
| *gtidSourceFilterDmlEvents* (mysql) | If set to true, we will only produce DML events into Kafka for transactions that were written on mysql servers with UUIDs matching the filters defined by the gtid.source.includes or gtid.source.excludes configuration options, if they are specified. | true | boolean
| *gtidSourceIncludes* (mysql) | The source UUIDs used to include GTID ranges when determine the starting position in the MySQL server's binlog. |  | String
| *heartbeatIntervalMs* (mysql) | Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. | 0ms | int
| *heartbeatTopicsPrefix* (mysql) | The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. | __debezium-heartbeat | String
| *includeQuery* (mysql) | Whether the connector should include the original SQL query that generated the change event. Note: This option requires MySQL be configured with the binlog_rows_query_log_events option set to ON. Query will not be present for events generated from snapshot. WARNING: Enabling this option may expose tables or fields explicitly blacklisted or masked by including the original SQL statement in the change event. For this reason the default value is 'false'. | false | boolean
| *includeSchemaChanges* (mysql) | Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. | true | boolean
| *inconsistentSchemaHandlingMode* (mysql) | Specify how binlog events that belong to a table missing from internal schema representation (i.e. internal representation is not consistent with database) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'skip' the problematic event will be skipped. | fail | String
| *maxBatchSize* (mysql) | Maximum size of each batch of source records. Defaults to 2048. | 2048 | int
| *maxQueueSize* (mysql) | Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. | 8192 | int
| *messageKeyColumns* (mysql) | A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':',where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector,and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key.Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id |  | String
| *pollIntervalMs* (mysql) | Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. | 500ms | long
| *skippedOperations* (mysql) | The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped. |  | String
| *snapshotDelayMs* (mysql) | The number of milliseconds to delay before a snapshot will begin. | 0ms | long
| *snapshotEventsAsInserts* (mysql) | Whether or not to mark snapshot events as normal inserts (op 'c'). If disabled, the standard functionality of emitting these records as reads (op 'r') will be used. | true | boolean
| *snapshotFetchSize* (mysql) | The maximum number of records that should be loaded into memory while performing a snapshot |  | int
| *snapshotLockingMode* (mysql) | Controls how long the connector holds onto the global read lock while it is performing a snapshot. The default is 'minimal', which means the connector holds the global read lock (and thus prevents any updates) for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this can be done using the snapshot process' REPEATABLE READ transaction even when the lock is no longer held and other operations are updating the database. However, in some cases it may be desirable to block all writes for the entire duration of the snapshot; in such cases set this property to 'extended'. Using a value of 'none' will prevent the connector from acquiring any table locks during the snapshot process. This mode can only be used in combination with snapshot.mode values of 'schema_only' or 'schema_only_recovery' and is only safe to use if no schema changes are happening while the snapshot is taken. | minimal | String
| *snapshotMode* (mysql) | The criteria for running a snapshot upon startup of the connector. Options include: 'when_needed' to specify that the connector run a snapshot upon startup whenever it deems it necessary; 'schema_only' to only take a snapshot of the schema (table structures) but no actual data; 'initial' (the default) to specify the connector can run a snapshot only when no offsets are available for the logical server name; 'initial_only' same as 'initial' except the connector should stop after completing the snapshot and before it would normally read the binlog; and'never' to specify the connector should never run a snapshot and that upon first startup the connector should read from the beginning of the binlog. The 'never' mode should be used with care, and only when the binlog is known to contain all history. | initial | String
| *snapshotNewTables* (mysql) | BETA FEATURE: On connector restart, the connector will check if there have been any new tables added to the configuration, and snapshot them. There is presently only two options:'off': Default behavior. Do not snapshot new tables.'parallel': The snapshot of the new tables will occur in parallel to the continued binlog reading of the old tables. When the snapshot completes, an independent binlog reader will begin reading the events for the new tables until it catches up to present time. At this point, both old and new binlog readers will be momentarily halted and new binlog reader will start that will read the binlog for all configured tables. The parallel binlog reader will have a configured server id of 10000 the primary binlog reader's server id. | off | String
| *snapshotSelectStatement{zwsp}Overrides* (mysql) | This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors . Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted. |  | String
| *sourceStructVersion* (mysql) | A version of the format of the publicly visible source part in the message | v2 | String
| *tableBlacklist* (mysql) | A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead) |  | String
| *tableExcludeList* (mysql) | A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring |  | String
| *tableIgnoreBuiltin* (mysql) | Flag specifying whether built-in tables should be ignored. | true | boolean
| *tableIncludeList* (mysql) | The tables for which changes are to be captured |  | String
| *tableWhitelist* (mysql) | The tables for which changes are to be captured (deprecated, use table.include.list instead) |  | String
| *timePrecisionMode* (mysql) | Time, date and timestamps can be represented with different kinds of precisions, including:'adaptive_time_microseconds': the precision of date and timestamp values is based the database column's precision; but time fields always use microseconds precision;'connect': always represents time, date and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision. | adaptive_time_microseconds | String
| *tombstonesOnDelete* (mysql) | Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. | false | boolean
|===
// endpoint options: END

For more information about configuration:
https://debezium.io/documentation/reference/0.10/operations/embedded.html#engine-properties[https://debezium.io/documentation/reference/0.10/operations/embedded.html#engine-properties]
https://debezium.io/documentation/reference/0.10/connectors/mysql.html#connector-properties[https://debezium.io/documentation/reference/0.10/connectors/mysql.html#connector-properties]

== Message headers

=== Consumer headers

The following headers are available when consuming change events from Debezium.
[width=""100%"",cols=""2m,2m,1m,5"",options=""header""]
|===
| Header constant                           | Header value                                   | Type        | Description
| DebeziumConstants.HEADER_IDENTIFIER       | ""CamelDebeziumIdentifier""                      | String      | The identifier of the connector, normally is this format ""+++{server-name}.{database-name}.{table-name}+++"".
| DebeziumConstants.HEADER_KEY              | ""CamelDebeziumKey""                             | Struct      | The key of the event, normally is the table Primary Key.
| DebeziumConstants.HEADER_SOURCE_METADATA  | ""CamelDebeziumSourceMetadata""                  | Map         | The metadata about the source event, for example `table` name, database `name`, log position, etc, please refer to the Debezium documentation for more info.
| DebeziumConstants.HEADER_OPERATION        | ""CamelDebeziumOperation""                       | String      | If presents, the type of event operation. Values for the connector are `c` for create (or insert), `u` for update, `d` for delete or `r` in case of a snapshot event.
| DebeziumConstants.HEADER_TIMESTAMP        | ""CamelDebeziumTimestamp""                       | Long        | If presents, the time (using the system clock in the JVM) at which the connector processed the event.
| DebeziumConstants.HEADER_BEFORE           | ""CamelDebeziumBefore""                          | Struct     | If presents, contains the state of the row before the event occurred.
|===

== Message body
The message body if is not `null` (in case of tombstones), it contains the state of the row after the event occurred as `Struct` format or `Map` format if you use the included Type Converter from `Struct` to `Map` (please look below for more explanation).

== Samples

=== Consuming events

Here is a very simple route that you can use in order to listen to Debezium events from MySQL connector.
[source,java]
----
from(""debezium-mysql:dbz-test-1?offsetStorageFileName=/usr/offset-file-1.dat&databaseHostName=localhost&databaseUser=debezium&databasePassword=dbz&databaseServerName=my-app-connector&databaseHistoryFileName=/usr/history-file-1.dat"")
    .log(""Event received from Debezium : ${body}"")
    .log(""    with this identifier ${headers.CamelDebeziumIdentifier}"")
    .log(""    with these source metadata ${headers.CamelDebeziumSourceMetadata}"")
    .log(""    the event occured upon this operation '${headers.CamelDebeziumSourceOperation}'"")
    .log(""    on this database '${headers.CamelDebeziumSourceMetadata[db]}' and this table '${headers.CamelDebeziumSourceMetadata[table]}'"")
    .log(""    with the key ${headers.CamelDebeziumKey}"")
    .log(""    the previous value is ${headers.CamelDebeziumBefore}"")
----

By default, the component will emit the events in the body and `CamelDebeziumBefore` header as https://kafka.apache.org/22/javadoc/org/apache/kafka/connect/data/Struct.html[`Struct`] data type, the reasoning behind this, is to perceive the schema information in case is needed.
However, the component as well contains a xref:manual::type-converter.adoc[Type Converter] that converts
from default output type of https://kafka.apache.org/22/javadoc/org/apache/kafka/connect/data/Struct.html[`Struct`] to `Map` in order to leverage Camel's rich xref:manual::data-format.adoc[Data Format] types which many of them work out of box with `Map` data type.
To use it, you can either add `Map.class` type when you access the message e.g: `exchange.getIn().getBody(Map.class)`, or you can convert the body always to `Map` from the route builder by adding `.convertBodyTo(Map.class)` to your Camel Route DSL after `from` statement.

We mentioned above about the schema, which can be used in case you need to perform advance data transformation and the schema is needed for that. If you choose not to convert your body to `Map`,
you can obtain the schema information as https://kafka.apache.org/22/javadoc/org/apache/kafka/connect/data/Schema.html[`Schema`] type from `Struct` like this:
[source,java]
----
from(""debezium-mysql:[name]?[options]])
    .process(exchange -> {
        final Struct bodyValue = exchange.getIn().getBody(Struct.class);
        final Schema schemaValue = bodyValue.schema();

        log.info(""Body value is :"" + bodyValue);
        log.info(""With Schema : "" + schemaValue);
        log.info(""And fields of :"" + schemaValue.fields());
        log.info(""Field name has `"" + schemaValue.field(""name"").schema() + ""` type"");
    });
----

*Important Note:* This component is a thin wrapper around Debezium Engine as mentioned, therefore before using this component in production, you need to understand how Debezium works and how configurations can reflect the expected behavior, especially in regards to https://debezium.io/documentation/reference/0.9/operations/embedded.html#_handling_failures[handling failures].

include::camel-spring-boot::page$debezium-mysql-starter.adoc[]
",12106,True,3009.1787937151603,median
"
#include ""sMath.hpp""
//#include ""sAssert.hpp""

namespace SMOBA
{

	namespace sMath
	{
		vec3 triangle_closest_point(const vec3& u, const vec3& v, const vec3& w, const vec3& p) {
			vec3 edge0 = v - u;
			vec3 edge1 = w - u;
			vec3 v0 = u - p;

			r32 a = edge0.dot(edge0);
			r32 b = edge0.dot(edge1);
			r32 c = edge1.dot(edge1);
			r32 d = edge0.dot(v0);
			r32 e = edge1.dot(v0);

			r32 det = a*c - b*b;
			r32 s = b*e - c*d;
			r32 t = b*d;

			if (s + t < det) {
				if (s < 0.f) {
					if (t < 0.f) {
						if (d < 0.f) {
							s = clampf(-d / a, 0.f, 1.f);
							t = 0.f;
						}
						else {
							s = 0.f;
							t = clampf(-e / c, 0.f, 1.f);
						}
					}
					else {
						s = 0.f;
						t = clampf(-e / c, 0.f, 1.f);
					}
				}
				else if (t < 0.f) {
					s = clampf(-d / a, 0.f, 1.f);
					t = 0.f;
				}
				else {
					r32 invDet = 1.f / det;
					s *= invDet;
					t *= invDet;
				}
			}
			else {
				if (s < 0.f) {
					r32 tmp0 = b + d;
					r32 tmp1 = c + e;
					if (tmp1 > tmp0) {
						r32 numer = tmp1 - tmp0;
						r32 denom = a - 2 * b + c;
						s = clampf(numer / denom, 0.f, 1.f);
						t = 1 - s;
					}
					else {
						t = clampf(-e / c, 0.f, 1.f);
						s = 0.f;
					}
				}
				else if (t < 0.f) {
					if (a + d > b + e) {
						r32 numer = c + e - b - d;
						r32 denom = a - 2 * b + c;
						s = clampf(numer / denom, 0.f, 1.f);
						t = 1 - s;
					}
					else {
						s = clampf(-e / c, 0.f, 1.f);
						t = 0.f;
					}
				}
				else {
					r32 numer = c + e - b - d;
					r32 denom = a - 2 * b + c;
					s = clampf(numer / denom, 0.f, 1.f);
					t = 1.f - s;
				}
			}
			return u + s * edge0 + t * edge1;
		}

		b8 ray_sphere_intersect(const vec3& ray_start, const vec3& ray_end, const vec3& sphere_pos, r32 sphere_radius, vec3* intersection, RaySphereIntersection type) {
			vec3 ray = ray_end - ray_start;
			vec3 sphere_to_ray_start = ray_start - sphere_pos;
			r32 ray_start_distance_sq = sphere_to_ray_start.length_squared();
			r32 sphere_radius_sq = sphere_radius * sphere_radius;
			r32 dot = sphere_to_ray_start.dot(ray);

			if (type == RaySphereIntersection::FrontFace && ray_start_distance_sq < sphere_radius_sq) {
				// we're starting out inside the sphere; raycast hit will be behind ray_start
				ray *= -1.0f;
				dot = sphere_to_ray_start.dot(ray);
				type = RaySphereIntersection::BackFace;
			}

			r32 a = ray.length_squared();
			r32 b = 2.0f * dot;
			r32 c = ray_start_distance_sq - (sphere_radius * sphere_radius);

			r32 delta = (b * b) - 4.0f * a * c;

			if (delta > 0.0f) {
				r32 distance;
				if (type == RaySphereIntersection::BackFace)
					distance = (-b + sqrtf(delta)) / (2.0f * a);
				else
					distance = (-b - sqrtf(delta)) / (2.0f * a);

				if (distance >= 0.0f && distance < 1.0f) {
					if (intersection)
						*intersection = ray_start + ray * distance;
					return true;
				}
			}
			return false;
		}

		const r32 INTENSITY_COEFFICIENT = 0.2f;

		vec3 desaturate(const vec3& c) {
			r32 intensity = c.x * INTENSITY_COEFFICIENT + c.y * INTENSITY_COEFFICIENT + c.z * INTENSITY_COEFFICIENT;
			return vec3(intensity);
		}

		vec4 desaturate(const vec4& c) {
			r32 intensity = c.x * INTENSITY_COEFFICIENT + c.y * INTENSITY_COEFFICIENT + c.z * INTENSITY_COEFFICIENT;
			return vec4(intensity, intensity, intensity, c.w);
		}

	}

	const vec2 vec2::zero(0, 0);
	const vec3 vec3::zero(0, 0, 0);
	const vec4 vec4::zero(0, 0, 0, 0);

	rect rect::outset(r32 padding) const {
		vec2 p(padding, padding);
		return {
			pos - p,
			size + p * 2.0f,
		};
	}

	rect rect::pad(const rect& p) const {
		return {
			pos - p.pos,
			size + p.pos + p.size,
		};
	}

	b8 rect::contains(const vec2& p) const {
		return p.x > pos.x
			&& p.y > pos.y
			&& p.x < pos.x + size.x
			&& p.y < pos.y + size.y;
	}

	const iRect iRect::zero(0, 0, 0, 0);

	b8 iRect::contains(const vec2& point) const {
		return point.x > x
			&& point.y > y
			&& point.x < x + w
			&& point.y < y + h;
	}

	b8 iRect::intersects(const iRect& other) const {
		if (contains(vec2(other.x, other.y))) return true;
		if (contains(vec2(other.x + w, other.y))) return true;
		if (contains(vec2(other.x + w, other.y+h))) return true;
		if (contains(vec2(other.x, other.y+h))) return true;
		return false;
	}

	const quat quat::zero(0, 0, 0, 0);
	const quat quat::identity(1, 0, 0, 0);
	const r32 quat::epsilon = 1e-03f;

	const mat3 mat3::zero(
		0, 0, 0,
		0, 0, 0,
		0, 0, 0);

	const mat3 mat3::identity(
		1, 0, 0,
		0, 1, 0,
		0, 0, 1);

	const mat4 mat4::zero(
		0, 0, 0, 0,
		0, 0, 0, 0,
		0, 0, 0, 0,
		0, 0, 0, 0);

	const mat4 mat4::identity(
		1, 0, 0, 0,
		0, 1, 0, 0,
		0, 0, 1, 0,
		0, 0, 0, 1);

	plane::plane() : normal(vec3::zero), d() {}

	plane::plane(const plane& rhs) : normal(rhs.normal), d(rhs.d) {}

	plane::plane(const vec3& nNormal, r32 d) : normal(nNormal), d(d) {}

	plane::plane(r32 a, r32  b, r32 c, r32 d) : normal(a, b, c), d(d) {}

	plane::plane(const vec3& nNormal, const vec3& nPoint) {
		redefine(nNormal, nPoint);
	}

	plane::plane(const vec3& nPoint0, const vec3& nPoint1, const vec3& nPoint2) {
		redefine(nPoint0, nPoint1, nPoint2);
	}

	r32 plane::distance(const vec3& nPoint) const {
		return normal.dot(nPoint) + d;
	}

	void plane::redefine(const vec3& nPoint0, const vec3& nPoint1, const vec3& nPoint2) {
		vec3 nEdge1 = nPoint1 - nPoint0;
		vec3 nEdge2 = nPoint2 - nPoint0;
		normal = nEdge1.cross(nEdge2);
		normal.normalize();
		d = -(normal.dot(nPoint0));
	}

	void plane::redefine(const vec3& nNormal, const vec3& nPoint) {
		normal = nNormal;
		d = -(nNormal.dot(nPoint));
	}

	vec3 plane::project(const vec3& p) const {
		// We know plane normal is unit length, so use simple method
		mat3 xform;
		xform[0][0] = 1.0f - normal.x * normal.x;
		xform[0][1] = -normal.x * normal.y;
		xform[0][2] = -normal.x * normal.z;
		xform[1][0] = -normal.y * normal.x;
		xform[1][1] = 1.0f - normal.y * normal.y;
		xform[1][2] = -normal.y * normal.z;
		xform[2][0] = -normal.z * normal.x;
		xform[2][1] = -normal.z * normal.y;
		xform[2][2] = 1.0f - normal.z * normal.z;
		return xform * p;
	}

	r32 plane::normalize(void) {
		r32 fLength = normal.length();

		// Will also work for zero-sized vectors, but will change nothing
		// We're not using epsilons because we don't need to.
		//Read http://www.ogre3d.org/forums/viewtopic.php?f=4&t=61259

		if (fLength > r32(0.0f)) {
			r32 fInvLength = 1.0f / fLength;
			normal *= fInvLength;
			d *= fInvLength;
		}
		return fLength;
	}

	vec3 mat3::get_column(i32 iCol) const {
		return vec3(m[0][iCol], m[1][iCol], m[2][iCol]);
	}

	void mat3::set_column(i32 iCol, const vec3& vec) {
		m[0][iCol] = vec.x;
		m[1][iCol] = vec.y;
		m[2][iCol] = vec.z;
	}

	void mat3::from_axes(const vec3& xAxis, const vec3& yAxis, const vec3& zAxis) {
		set_column(0, xAxis);
		set_column(1, yAxis);
		set_column(2, zAxis);
	}

	b8 mat3::operator== (const mat3& nMatrix) const {
		for (i32 iRow = 0; iRow < 3; iRow++) {
			for (i32 iCol = 0; iCol < 3; iCol++) {
				if (m[iRow][iCol] != nMatrix.m[iRow][iCol])
					return false;
			}
		}
		return true;
	}

	mat3 mat3::operator+ (const mat3& rMatrix) const {
		mat3 kSum;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			for (i32 iCol = 0; iCol < 3; iCol++)
				kSum.m[iRow][iCol] = m[iRow][iCol] + rMatrix.m[iRow][iCol];
		}
		return kSum;
	}

	mat3 mat3::operator- (const mat3& rMatrix) const {
		mat3 kDiff;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			for (i32 iCol = 0; iCol < 3; iCol++)
				kDiff.m[iRow][iCol] = m[iRow][iCol] - rMatrix.m[iRow][iCol];
		}
		return kDiff;
	}

	mat3 mat3::operator* (const mat3& rMatrix) const {
		mat3 kProd;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			for (i32 iCol = 0; iCol < 3; iCol++) {
				kProd.m[iRow][iCol] =
					m[iRow][0] * rMatrix.m[0][iCol] +
					m[iRow][1] * rMatrix.m[1][iCol] +
					m[iRow][2] * rMatrix.m[2][iCol];
			}
		}
		return kProd;
	}

	vec3 mat3::operator* (const vec3& rPoint) const {
		vec3 kProd;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			kProd[iRow] =
				m[iRow][0] * rPoint[0] +
				m[iRow][1] * rPoint[1] +
				m[iRow][2] * rPoint[2];
		}
		return kProd;
	}

	vec3 operator* (const vec3& rPoint, const mat3& rMatrix) {
		vec3 kProd;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			kProd[iRow] =
				rPoint[0] * rMatrix.m[0][iRow] +
				rPoint[1] * rMatrix.m[1][iRow] +
				rPoint[2] * rMatrix.m[2][iRow];
		}
		return kProd;
	}

	mat3 mat3::operator- () const {
		mat3 kNeg;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			for (i32 iCol = 0; iCol < 3; iCol++) {
				kNeg[iRow][iCol] = -m[iRow][iCol];
			}
		}
		return kNeg;
	}

	mat3 mat3::operator* (r32 scalar) const {
		mat3 kProd;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			for (i32 iCol = 0; iCol < 3; iCol++) {
				kProd.m[iRow][iCol] = scalar*m[iRow][iCol];
			}
		}
		return kProd;
	}

	mat3 operator* (r32 scalar, const mat3& rMatrix) {
		mat3 kProd;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			for (i32 iCol = 0; iCol < 3; iCol++) {
				kProd.m[iRow][iCol] = scalar*rMatrix.m[iRow][iCol];
			}
		}
		return kProd;
	}

	mat3 mat3::transpose() const {
		mat3 kTranspose;
		for (i32 iRow = 0; iRow < 3; iRow++) {
			for (i32 iCol = 0; iCol < 3; iCol++)
				kTranspose[iRow][iCol] = m[iCol][iRow];
		}
		return kTranspose;
	}

	b8 mat3::inverse(mat3* out, r32 tolerance) const {
		// Invert a 3x3 using cofactors. This is about 8 times faster than
		// the Numerical Recipes code which uses Gaussian elimination.
		(*out)[0][0] = m[1][1] * m[2][2] - m[1][2] * m[2][1];
		(*out)[0][1] = m[0][2] * m[2][1] - m[0][1] * m[2][2];
		(*out)[0][2] = m[0][1] * m[1][2] - m[0][2] * m[1][1];
		(*out)[1][0] = m[1][2] * m[2][0] - m[1][0] * m[2][2];
		(*out)[1][1] = m[0][0] * m[2][2] - m[0][2] * m[2][0];
		(*out)[1][2] = m[0][2] * m[1][0] - m[0][0] * m[1][2];
		(*out)[2][0] = m[1][0] * m[2][1] - m[1][1] * m[2][0];
		(*out)[2][1] = m[0][1] * m[2][0] - m[0][0] * m[2][1];
		(*out)[2][2] = m[0][0] * m[1][1] - m[0][1] * m[1][0];

		r32 det = m[0][0] * (*out)[0][0]
			+ m[0][1] * (*out)[1][0]
			+ m[0][2] * (*out)[2][0];

		if (fabsf(det) <= tolerance)
			return false;

		r32 det_inv = 1.0f / det;
		for (i32 iRow = 0; iRow < 3; iRow++)
		{
			for (i32 iCol = 0; iCol < 3; iCol++)
				(*out)[iRow][iCol] *= det_inv;
		}

		return true;
	}

	mat3 mat3::inverse(r32 tolerance) const {
		mat3 out = mat3::zero;
		inverse(&out, tolerance);
		return out;
	}

	r32 mat3::determinant() const {
		r32 cofactor00 = m[1][1] * m[2][2] - m[1][2] * m[2][1];
		r32 cofactor10 = m[1][2] * m[2][0] - m[1][0] * m[2][2];
		r32 cofactor20 = m[1][0] * m[2][1] - m[1][1] * m[2][0];

		r32 det =
			m[0][0] * cofactor00 +
			m[0][1] * cofactor10 +
			m[0][2] * cofactor20;

		return det;
	}

	void mat3::orthonormalize() {
		// Algorithm uses Gram-Schmidt orthogonalization.  If 'this' matrix is
		// M = [m0|m1|m2], then orthonormal output matrix is Q = [q0|q1|q2],
		//
		//   q0 = m0/|m0|
		//   q1 = (m1-(q0*m1)q0)/|m1-(q0*m1)q0|
		//   q2 = (m2-(q0*m2)q0-(q1*m2)q1)/|m2-(q0*m2)q0-(q1*m2)q1|
		//
		// where |V| indicates length of vector V and A*B indicates dot
		// product of vectors A and B.

		// compute q0
		r32 fInvLength = 1.0f / sqrtf(m[0][0] * m[0][0]
			+ m[1][0] * m[1][0] +
			m[2][0] * m[2][0]);

		m[0][0] *= fInvLength;
		m[1][0] *= fInvLength;
		m[2][0] *= fInvLength;

		// compute q1
		r32 fDot0 =
			m[0][0] * m[0][1] +
			m[1][0] * m[1][1] +
			m[2][0] * m[2][1];

		m[0][1] -= fDot0*m[0][0];
		m[1][1] -= fDot0*m[1][0];
		m[2][1] -= fDot0*m[2][0];

		fInvLength = 1.0f / sqrtf(m[0][1] * m[0][1] +
			m[1][1] * m[1][1] +
			m[2][1] * m[2][1]);

		m[0][1] *= fInvLength;
		m[1][1] *= fInvLength;
		m[2][1] *= fInvLength;

		// compute q2
		r32 fDot1 =
			m[0][1] * m[0][2] +
			m[1][1] * m[1][2] +
			m[2][1] * m[2][2];

		fDot0 =
			m[0][0] * m[0][2] +
			m[1][0] * m[1][2] +
			m[2][0] * m[2][2];

		m[0][2] -= fDot0*m[0][0] + fDot1*m[0][1];
		m[1][2] -= fDot0*m[1][0] + fDot1*m[1][1];
		m[2][2] -= fDot0*m[2][0] + fDot1*m[2][1];

		fInvLength = 1.0f / sqrtf(m[0][2] * m[0][2] +
			m[1][2] * m[1][2] +
			m[2][2] * m[2][2]);

		m[0][2] *= fInvLength;
		m[1][2] *= fInvLength;
		m[2][2] *= fInvLength;
	}

	void mat3::qdu_decomposition(mat3* pq, vec3* pd, vec3* pu) const
	{
		// factor M = QR = QDU where Q is orthogonal, D is diagonal,
		// and U is upper triangular with ones on its diagonal.  Algorithm uses
		// Gram-Schmidt orthogonalization (the QR algorithm).
		//
		// If M = [ m0 | m1 | m2 ] and Q = [ q0 | q1 | q2 ], then
		//
		//   q0 = m0/|m0|
		//   q1 = (m1-(q0*m1)q0)/|m1-(q0*m1)q0|
		//   q2 = (m2-(q0*m2)q0-(q1*m2)q1)/|m2-(q0*m2)q0-(q1*m2)q1|
		//
		// where |V| indicates length of vector V and A*B indicates dot
		// product of vectors A and B.  The matrix R has entries
		//
		//   r00 = q0*m0  r01 = q0*m1  r02 = q0*m2
		//   r10 = 0      r11 = q1*m1  r12 = q1*m2
		//   r20 = 0      r21 = 0      r22 = q2*m2
		//
		// so D = diag(r00,r11,r22) and U has entries u01 = r01/r00,
		// u02 = r02/r00, and u12 = r12/r11.

		// Q = rotation
		// D = scaling
		// U = shear

		// D stores the three diagonal entries r00, r11, r22
		// U stores the entries U[0] = u01, U[1] = u02, U[2] = u12

		mat3& q = *pq;
		vec3& d = *pd;
		vec3& u = *pu;

		// build orthogonal matrix Q
		r32 fInvLength = 1.0f / sqrtf(m[0][0] * m[0][0] + m[1][0] * m[1][0] + m[2][0] * m[2][0]);

		q[0][0] = m[0][0] * fInvLength;
		q[1][0] = m[1][0] * fInvLength;
		q[2][0] = m[2][0] * fInvLength;

		r32 fDot = q[0][0] * m[0][1] + q[1][0] * m[1][1] +
			q[2][0] * m[2][1];
		q[0][1] = m[0][1] - fDot*q[0][0];
		q[1][1] = m[1][1] - fDot*q[1][0];
		q[2][1] = m[2][1] - fDot*q[2][0];
		fInvLength = 1.0f / sqrtf(q[0][1] * q[0][1] + q[1][1] * q[1][1] + q[2][1] * q[2][1]);

		q[0][1] *= fInvLength;
		q[1][1] *= fInvLength;
		q[2][1] *= fInvLength;

		fDot = q[0][0] * m[0][2] + q[1][0] * m[1][2] + q[2][0] * m[2][2];
		q[0][2] = m[0][2] - fDot*q[0][0];
		q[1][2] = m[1][2] - fDot*q[1][0];
		q[2][2] = m[2][2] - fDot*q[2][0];
		fDot = q[0][1] * m[0][2] + q[1][1] * m[1][2] + q[2][1] * m[2][2];
		q[0][2] -= fDot*q[0][1];
		q[1][2] -= fDot*q[1][1];
		q[2][2] -= fDot*q[2][1];
		fInvLength = 1 / sqrtf(q[0][2] * q[0][2] + q[1][2] * q[1][2] + q[2][2] * q[2][2]);

		q[0][2] *= fInvLength;
		q[1][2] *= fInvLength;
		q[2][2] *= fInvLength;

		// guarantee that orthogonal matrix has determinant 1 (no reflections)
		r32 fDet = q[0][0] * q[1][1] * q[2][2] + q[0][1] * q[1][2] * q[2][0] +
			q[0][2] * q[1][0] * q[2][1] - q[0][2] * q[1][1] * q[2][0] -
			q[0][1] * q[1][0] * q[2][2] - q[0][0] * q[1][2] * q[2][1];

		if (fDet < 0.0) {
			for (i32 iRow = 0; iRow < 3; iRow++)
				for (i32 iCol = 0; iCol < 3; iCol++)
					q[iRow][iCol] = -q[iRow][iCol];
		}

		// build ""right"" matrix R
		mat3 r;
		r[0][0] = q[0][0] * m[0][0] + q[1][0] * m[1][0] + q[2][0] * m[2][0];
		r[0][1] = q[0][0] * m[0][1] + q[1][0] * m[1][1] + q[2][0] * m[2][1];
		r[1][1] = q[0][1] * m[0][1] + q[1][1] * m[1][1] + q[2][1] * m[2][1];
		r[0][2] = q[0][0] * m[0][2] + q[1][0] * m[1][2] + q[2][0] * m[2][2];
		r[1][2] = q[0][1] * m[0][2] + q[1][1] * m[1][2] + q[2][1] * m[2][2];
		r[2][2] = q[0][2] * m[0][2] + q[1][2] * m[1][2] + q[2][2] * m[2][2];

		// the scaling component
		d[0] = r[0][0];
		d[1] = r[1][1];
		d[2] = r[2][2];

		// the shear component
		r32 fInvD0 = 1.0f / d[0];
		u[0] = r[0][1] * fInvD0;
		u[1] = r[0][2] * fInvD0;
		u[2] = r[1][2] / d[1];
	}

	void quat::from_rotation_matrix(const mat3& kRot) {
		// Algorithm in Ken Shoemake's article in 1987 SIGGRAPH course notes
		// article ""Quat Calculus and Fast Animation"".

		r32 fTrace = kRot[0][0] + kRot[1][1] + kRot[2][2];
		r32 fRoot;

		if (fTrace > 0.0) {
			// |w| > 1/2, may as well choose w > 1/2
			fRoot = sqrtf(fTrace + 1.0f);  // 2w
			w = 0.5f*fRoot;
			fRoot = 0.5f / fRoot;  // 1/(4w)
			x = (kRot[1][2] - kRot[2][1])*fRoot;
			y = (kRot[2][0] - kRot[0][2])*fRoot;
			z = (kRot[0][1] - kRot[1][0])*fRoot;
		}
		else {
			// |w| <= 1/2
			static i32 s_iNext[3] = { 1, 2, 0 };
			i32 i = 0;
			if (kRot[1][1] > kRot[0][0])
				i = 1;
			if (kRot[2][2] > kRot[i][i])
				i = 2;
			i32 j = s_iNext[i];
			i32 k = s_iNext[j];

			fRoot = sqrtf(kRot[i][i] - kRot[j][j] - kRot[k][k] + 1.0f);
			r32* apkQuat[3] = { &x, &y, &z };
			*apkQuat[i] = 0.5f*fRoot;
			fRoot = 0.5f / fRoot;
			w = (kRot[j][k] - kRot[k][j])*fRoot;
			*apkQuat[j] = (kRot[i][j] + kRot[j][i])*fRoot;
			*apkQuat[k] = (kRot[i][k] + kRot[k][i])*fRoot;
		}
	}

	void quat::to_rotation_matrix(mat3* out) const {
		r32 fTx = x + x;
		r32 fTy = y + y;
		r32 fTz = z + z;
		r32 fTwx = fTx*w;
		r32 fTwy = fTy*w;
		r32 fTwz = fTz*w;
		r32 fTxx = fTx*x;
		r32 fTxy = fTy*x;
		r32 fTxz = fTz*x;
		r32 fTyy = fTy*y;
		r32 fTyz = fTz*y;
		r32 fTzz = fTz*z;

		(*out)[0][0] = 1.0f - (fTyy + fTzz);
		(*out)[1][0] = fTxy - fTwz;
		(*out)[2][0] = fTxz + fTwy;
		(*out)[0][1] = fTxy + fTwz;
		(*out)[1][1] = 1.0f - (fTxx + fTzz);
		(*out)[2][1] = fTyz - fTwx;
		(*out)[0][2] = fTxz - fTwy;
		(*out)[1][2] = fTyz + fTwx;
		(*out)[2][2] = 1.0f - (fTxx + fTyy);
	}

	void quat::from_angle_axis(r32 angle, const vec3& axis) {
		// assert:  axis[] is unit length
		//
		// The Quat representing the rotation is
		//   q = cos(A/2)+sin(A/2)*(x*i+y*j+z*k)

		r32 half_angle = 0.5f * angle;
		r32 s = sinf(half_angle);
		w = cosf(half_angle);
		x = s * axis.x;
		y = s * axis.y;
		z = s * axis.z;
	}

	void quat::to_angle_axis(r32* angle, vec3* axis) const {
		// The Quat representing the rotation is
		// q = cos(A / 2) + sin(A / 2) * (x*i + y*j + z*k)

		r32 length = sqrtf(x * x + y * y + z * z);
		if (length > 0.0f) {
			*angle = 2.0f * acosf(w);
			r32 length_inv = 1.0f / length;
			axis->x = x * length_inv;
			axis->y = y * length_inv;
			axis->z = z * length_inv;
		}
		else {
			// angle is 0 (mod 2*pi), so any axis will do
			*angle = 0.0f;
			axis->x = 1.0;
			axis->y = 0.0;
			axis->z = 0.0;
		}
	}

	void quat::from_axes(const vec3 akAxis[3]) {
		mat3 kRot;

		for (i32 iCol = 0; iCol < 3; iCol++)
		{
			kRot[0][iCol] = akAxis[iCol].x;
			kRot[1][iCol] = akAxis[iCol].y;
			kRot[2][iCol] = akAxis[iCol].z;
		}

		from_rotation_matrix(kRot);
	}

	void quat::from_axes(const vec3& xaxis, const vec3& yaxis, const vec3& zaxis) {
		mat3 kRot;

		kRot[0][0] = xaxis.x;
		kRot[1][0] = xaxis.y;
		kRot[2][0] = xaxis.z;

		kRot[0][1] = yaxis.x;
		kRot[1][1] = yaxis.y;
		kRot[2][1] = yaxis.z;

		kRot[0][2] = zaxis.x;
		kRot[1][2] = zaxis.y;
		kRot[2][2] = zaxis.z;

		from_rotation_matrix(kRot);
	}

	void quat::to_axes(vec3* axes) const
	{
		mat3 mat;

		to_rotation_matrix(&mat);

		for (i32 iCol = 0; iCol < 3; iCol++)
		{
			axes[iCol].x = mat[0][iCol];
			axes[iCol].y = mat[1][iCol];
			axes[iCol].z = mat[2][iCol];
		}
	}

	vec3 quat::x_axis() const
	{
		//r32 fTx  = 2.0*x;
		r32 fTy = 2.0f*y;
		r32 fTz = 2.0f*z;
		r32 fTwy = fTy*w;
		r32 fTwz = fTz*w;
		r32 fTxy = fTy*x;
		r32 fTxz = fTz*x;
		r32 fTyy = fTy*y;
		r32 fTzz = fTz*z;

		return vec3(1.0f - (fTyy + fTzz), fTxy + fTwz, fTxz - fTwy);
	}

	vec3 quat::y_axis() const {
		r32 fTx = 2.0f*x;
		r32 fTy = 2.0f*y;
		r32 fTz = 2.0f*z;
		r32 fTwx = fTx*w;
		r32 fTwz = fTz*w;
		r32 fTxx = fTx*x;
		r32 fTxy = fTy*x;
		r32 fTyz = fTz*y;
		r32 fTzz = fTz*z;

		return vec3(fTxy - fTwz, 1.0f - (fTxx + fTzz), fTyz + fTwx);
	}

	vec3 quat::z_axis() const {
		r32 fTx = 2.0f*x;
		r32 fTy = 2.0f*y;
		r32 fTz = 2.0f*z;
		r32 fTwx = fTx*w;
		r32 fTwy = fTy*w;
		r32 fTxx = fTx*x;
		r32 fTxz = fTz*x;
		r32 fTyy = fTy*y;
		r32 fTyz = fTz*y;

		return vec3(fTxz + fTwy, fTyz - fTwx, 1.0f - (fTxx + fTyy));
	}

	void quat::to_axes(vec3* xaxis, vec3* yaxis, vec3* zaxis) const {
		mat3 mat;

		to_rotation_matrix(&mat);

		xaxis->x = mat[0][0];
		xaxis->y = mat[1][0];
		xaxis->z = mat[2][0];

		yaxis->x = mat[0][1];
		yaxis->y = mat[1][1];
		yaxis->z = mat[2][1];

		zaxis->x = mat[0][2];
		zaxis->y = mat[1][2];
		zaxis->z = mat[2][2];
	}

	quat quat::operator+ (const quat& rkQ) const {
		return quat(w + rkQ.w, x + rkQ.x, y + rkQ.y, z + rkQ.z);
	}

	quat quat::operator- (const quat& rkQ) const {
		return quat(w - rkQ.w, x - rkQ.x, y - rkQ.y, z - rkQ.z);
	}

	quat quat::operator* (const quat& rkQ) const {
		// NOTE:  Multiplication is not generally commutative, so in most
		// cases p*q != q*p.

		return quat
		(
			w * rkQ.w - x * rkQ.x - y * rkQ.y - z * rkQ.z,
			w * rkQ.x + x * rkQ.w + y * rkQ.z - z * rkQ.y,
			w * rkQ.y + y * rkQ.w + z * rkQ.x - x * rkQ.z,
			w * rkQ.z + z * rkQ.w + x * rkQ.y - y * rkQ.x
		);
	}

	quat& quat::operator*= (const quat& rkQ) {
		r32 _x = x;
		r32 _y = y;
		r32 _z = z;
		r32 _w = w;

		w = _w * rkQ.w - _x * rkQ.x - _y * rkQ.y - _z * rkQ.z;
		x = _w * rkQ.x + _x * rkQ.w + _y * rkQ.z - _z * rkQ.y;
		y = _w * rkQ.y + _y * rkQ.w + _z * rkQ.x - _x * rkQ.z;
		z = _w * rkQ.z + _z * rkQ.w + _x * rkQ.y - _y * rkQ.x;

		return *this;
	}

	quat quat::operator* (r32 fScalar) const {
		return quat(fScalar*w, fScalar*x, fScalar*y, fScalar*z);
	}

	quat operator* (r32 fScalar, const quat& rkQ) {
		return quat(fScalar*rkQ.w, fScalar*rkQ.x, fScalar*rkQ.y, fScalar*rkQ.z);
	}

	quat quat::operator- () const {
		return quat(-w, -x, -y, -z);
	}

	r32 quat::dot(const quat& rkQ) const {
		return w*rkQ.w + x * rkQ.x + y * rkQ.y + z * rkQ.z;
	}

	r32 quat::length() const {
		return sqrtf(w * w + x * x + y * y + z * z);
	}

	quat quat::inverse() const {
		r32 fNorm = w*w + x*x + y*y + z*z;
		if (fNorm > 0.0) {
			r32 fInvNorm = 1.0f / fNorm;
			return quat(w*fInvNorm, -x*fInvNorm, -y*fInvNorm, -z*fInvNorm);
		}
		else {
			// return an invalid result to flag the error
			return zero;
		}
	}

	quat quat::unit_inverse() const {
		return quat(w, -x, -y, -z);
	}

	quat quat::exp() const {
		// If q = A*(x*i+y*j+z*k) where (x,y,z) is unit length, then
		// exp(q) = cos(A)+sin(A)*(x*i+y*j+z*k).  If sin(A) is near zero,
		// use exp(q) = cos(A)+A*(x*i+y*j+z*k) since A/sin(A) has limit 1.

		r32 fAngle = sqrtf(x*x + y*y + z*z);
		r32 fSin = sinf(fAngle);

		quat kResult;
		kResult.w = cosf(fAngle);

		if (fabsf(fSin) >= epsilon) {
			r32 fCoeff = fSin / (fAngle);
			kResult.x = fCoeff*x;
			kResult.y = fCoeff*y;
			kResult.z = fCoeff*z;
		}
		else {
			kResult.x = x;
			kResult.y = y;
			kResult.z = z;
		}

		return kResult;
	}

	quat quat::log() const {
		// If q = cos(A)+sin(A)*(x*i+y*j+z*k) where (x,y,z) is unit length, then
		// log(q) = A*(x*i+y*j+z*k).  If sin(A) is near zero, use log(q) =
		// sin(A)*(x*i+y*j+z*k) since sin(A)/A has limit 1.

		quat kResult;
		kResult.w = 0.0;

		if (fabsf(w) < 1.0) {
			r32 fAngle = acosf(w);
			r32 fSin = sinf(fAngle);
			if (fabsf(fSin) >= epsilon) {
				r32 fCoeff = fAngle / fSin;
				kResult.x = fCoeff*x;
				kResult.y = fCoeff*y;
				kResult.z = fCoeff*z;
				return kResult;
			}
		}

		kResult.x = x;
		kResult.y = y;
		kResult.z = z;

		return kResult;
	}

	vec3 quat::operator* (const vec3& v) const {
		// nVidia SDK implementation
		vec3 uv, uuv;
		vec3 qvec(x, y, z);
		uv = qvec.cross(v);
		uuv = qvec.cross(uv);
		uv *= (2.0f * w);
		uuv *= 2.0f;

		return v + uv + uuv;
	}

	quat quat::euler(r32 roll, r32 yaw, r32 pitch) {
		// assuming the angles are in radians.
		r32 cy = cosf(yaw * 0.5f);
		r32 sy = sinf(yaw * 0.5f);
		r32 cr = cosf(roll * 0.5f);
		r32 sr = sinf(roll * 0.5f);
		r32 cp = cosf(pitch * 0.5f);
		r32 sp = sinf(pitch * 0.5f);
		r32 cycr = cy*cr;
		r32 sysr = sy*sr;

		// yaw, roll, pitch
		/*
		return Quat
		(
		cp*cycr  - sp*sysr,
		cp*sysr  + sp*cycr,
		cp*sy*cr + sp*cy*sr,
		cp*cy*sr - sp*sy*cr
		);
		*/

		// yaw, pitch, roll
		return quat
		(
			cp*cycr + sp*sysr,
			sp*cycr + cp*sysr,
			cp*sy*cr - sp*cy*sr,
			cp*cy*sr - sp*sy*cr
		);
	}

	r32 quat::angle(const quat& a, const quat& b) {
		quat c = a.inverse() * b;
		c.normalize();
		r32 angle;
		vec3 axis;
		c.to_angle_axis(&angle, &axis);
		if (angle > PI)
			angle = fabsf((angle - (PI * 2.0f)));
		return angle;
	}

	quat quat::look(const vec3& dir) {
		if (fabsf(dir.y - 1.0f) < epsilon)
			return quat::euler(0, 0, PI * -0.5f);
		else if (fabsf(dir.y + 1.0f) < epsilon)
			return quat::euler(0, 0, PI * 0.5f);
		else
			return quat::euler(0, atan2f(dir.x, dir.z), -asinf(dir.y));
	}

	quat quat::slerp(r32 amount, const quat& quaternion1, const quat& quaternion2) {
		r32 num = quaternion1.x * quaternion2.x + quaternion1.y * quaternion2.y + quaternion1.z * quaternion2.z + quaternion1.w * quaternion2.w;
		b8 flag = false;
		if (num < 0.0f) {
			flag = true;
			num = -num;
		}
		r32 num2;
		r32 num3;
		if (num > 0.999999f) {
			num2 = 1.0f - amount;
			num3 = (flag ? (-amount) : amount);
		}
		else {
			r32 num4 = acosf(num);
			r32 num5 = 1.0f / sinf(num4);
			num2 = sinf((1.0f - amount) * num4) * num5;
			num3 = flag ? (-sinf(amount * num4) * num5) : (sinf(amount * num4) * num5);
		}
		quat result;
		result.x = num2 * quaternion1.x + num3 * quaternion2.x;
		result.y = num2 * quaternion1.y + num3 * quaternion2.y;
		result.z = num2 * quaternion1.z + num3 * quaternion2.z;
		result.w = num2 * quaternion1.w + num3 * quaternion2.w;
		return result;
	}

	quat quat::slerp_extra_spins(r32 fT, const quat& rkP, const quat& rkQ, i32 iExtraSpins) {
		r32 fCos = rkP.dot(rkQ);
		r32 fAngle = acosf(fCos);

		if (fabsf(fAngle) < epsilon)
			return rkP;

		r32 fSin = sinf(fAngle);
		r32 fPhase = PI*iExtraSpins*fT;
		r32 fInvSin = 1.0f / fSin;
		r32 fCoeff0 = sinf((1.0f - fT)*fAngle - fPhase)*fInvSin;
		r32 fCoeff1 = sinf(fT*fAngle + fPhase)*fInvSin;
		return fCoeff0*rkP + fCoeff1*rkQ;
	}

	void quat::intermediate(const quat& rkQ0, const quat& rkQ1, const quat& rkQ2, quat& rkA, quat& rkB) {
		// assert:  q0, q1, q2 are unit Quats

		quat kQ0inv = rkQ0.unit_inverse();
		quat kQ1inv = rkQ1.unit_inverse();
		quat rkP0 = kQ0inv*rkQ1;
		quat rkP1 = kQ1inv*rkQ2;
		quat kArg = 0.25*(rkP0.log() - rkP1.log());
		quat kMinusArg = -kArg;

		rkA = rkQ1*kArg.exp();
		rkB = rkQ1*kMinusArg.exp();
	}

	quat quat::squad(r32 fT, const quat& rkP, const quat& rkA, const quat& rkB, const quat& rkQ) {
		r32 fSlerpT = 2.0f*fT*(1.0f - fT);
		quat kSlerpP = slerp(fT, rkP, rkQ);
		quat kSlerpQ = slerp(fT, rkA, rkB);
		return slerp(fSlerpT, kSlerpP, kSlerpQ);
	}

	r32 quat::normalize(void) {
		r32 len = length();
		*this = *this * (1.0f / len);
		return len;
	}

	quat quat::normalize(const quat& q) {
		r32 factor = 1.0f / q.length();
		return q * factor;
	}

	quat quat::nlerp(r32 fT, const quat& rkP, const quat& rkQ, b8 shortestPath) {
		quat result;
		r32 fCos = rkP.dot(rkQ);
		if (fCos < 0.0f && shortestPath) {
			result = rkP + fT * ((-rkQ) - rkP);
		}
		else {
			result = rkP + fT * (rkQ - rkP);
		}
		result.normalize();
		return result;
	}

	inline static r32 MINOR(const mat4& m, const i32 r0, const i32 r1, const i32 r2, const i32 c0, const i32 c1, const i32 c2) {
		return m[r0][c0] * (m[r1][c1] * m[r2][c2] - m[r2][c1] * m[r1][c2]) -
			m[r0][c1] * (m[r1][c0] * m[r2][c2] - m[r2][c0] * m[r1][c2]) +
			m[r0][c2] * (m[r1][c0] * m[r2][c1] - m[r2][c0] * m[r1][c1]);
	}

	mat4 mat4::adjoint() const {
		return mat4(MINOR(*this, 1, 2, 3, 1, 2, 3),
			-MINOR(*this, 0, 2, 3, 1, 2, 3),
			MINOR(*this, 0, 1, 3, 1, 2, 3),
			-MINOR(*this, 0, 1, 2, 1, 2, 3),

			-MINOR(*this, 1, 2, 3, 0, 2, 3),
			MINOR(*this, 0, 2, 3, 0, 2, 3),
			-MINOR(*this, 0, 1, 3, 0, 2, 3),
			MINOR(*this, 0, 1, 2, 0, 2, 3),

			MINOR(*this, 1, 2, 3, 0, 1, 3),
			-MINOR(*this, 0, 2, 3, 0, 1, 3),
			MINOR(*this, 0, 1, 3, 0, 1, 3),
			-MINOR(*this, 0, 1, 2, 0, 1, 3),

			-MINOR(*this, 1, 2, 3, 0, 1, 2),
			MINOR(*this, 0, 2, 3, 0, 1, 2),
			-MINOR(*this, 0, 1, 3, 0, 1, 2),
			MINOR(*this, 0, 1, 2, 0, 1, 2));
	}

	r32 mat4::determinant() const {
		return m[0][0] * MINOR(*this, 1, 2, 3, 1, 2, 3) -
			m[0][0] * MINOR(*this, 1, 2, 3, 0, 2, 3) +
			m[0][0] * MINOR(*this, 1, 2, 3, 0, 1, 3) -
			m[0][0] * MINOR(*this, 1, 2, 3, 0, 1, 2);
	}

	mat4 mat4::inverse() const {
		r32 m00 = m[0][0], m01 = m[0][1], m02 = m[0][2], m03 = m[0][3];
		r32 m10 = m[1][0], m11 = m[1][1], m12 = m[1][2], m13 = m[1][3];
		r32 m20 = m[2][0], m21 = m[2][1], m22 = m[2][2], m23 = m[2][3];
		r32 m30 = m[3][0], m31 = m[3][1], m32 = m[3][2], m33 = m[3][3];

		r32 v0 = m20 * m31 - m21 * m30;
		r32 v1 = m20 * m32 - m22 * m30;
		r32 v2 = m20 * m33 - m23 * m30;
		r32 v3 = m21 * m32 - m22 * m31;
		r32 v4 = m21 * m33 - m23 * m31;
		r32 v5 = m22 * m33 - m23 * m32;

		r32 t00 = +(v5 * m11 - v4 * m12 + v3 * m13);
		r32 t10 = -(v5 * m10 - v2 * m12 + v1 * m13);
		r32 t20 = +(v4 * m10 - v2 * m11 + v0 * m13);
		r32 t30 = -(v3 * m10 - v1 * m11 + v0 * m12);

		r32 invDet = 1 / (t00 * m00 + t10 * m01 + t20 * m02 + t30 * m03);

		r32 d00 = t00 * invDet;
		r32 d10 = t10 * invDet;
		r32 d20 = t20 * invDet;
		r32 d30 = t30 * invDet;

		r32 d01 = -(v5 * m01 - v4 * m02 + v3 * m03) * invDet;
		r32 d11 = +(v5 * m00 - v2 * m02 + v1 * m03) * invDet;
		r32 d21 = -(v4 * m00 - v2 * m01 + v0 * m03) * invDet;
		r32 d31 = +(v3 * m00 - v1 * m01 + v0 * m02) * invDet;

		v0 = m10 * m31 - m11 * m30;
		v1 = m10 * m32 - m12 * m30;
		v2 = m10 * m33 - m13 * m30;
		v3 = m11 * m32 - m12 * m31;
		v4 = m11 * m33 - m13 * m31;
		v5 = m12 * m33 - m13 * m32;

		r32 d02 = +(v5 * m01 - v4 * m02 + v3 * m03) * invDet;
		r32 d12 = -(v5 * m00 - v2 * m02 + v1 * m03) * invDet;
		r32 d22 = +(v4 * m00 - v2 * m01 + v0 * m03) * invDet;
		r32 d32 = -(v3 * m00 - v1 * m01 + v0 * m02) * invDet;

		v0 = m21 * m10 - m20 * m11;
		v1 = m22 * m10 - m20 * m12;
		v2 = m23 * m10 - m20 * m13;
		v3 = m22 * m11 - m21 * m12;
		v4 = m23 * m11 - m21 * m13;
		v5 = m23 * m12 - m22 * m13;

		r32 d03 = -(v5 * m01 - v4 * m02 + v3 * m03) * invDet;
		r32 d13 = +(v5 * m00 - v2 * m02 + v1 * m03) * invDet;
		r32 d23 = -(v4 * m00 - v2 * m01 + v0 * m03) * invDet;
		r32 d33 = +(v3 * m00 - v1 * m01 + v0 * m02) * invDet;

		return mat4(
			d00, d01, d02, d03,
			d10, d11, d12, d13,
			d20, d21, d22, d23,
			d30, d31, d32, d33);
	}

	mat4 mat4::inverse_affine(void) const {
		r32 m10 = m[1][0], m11 = m[1][1], m12 = m[1][2];
		r32 m20 = m[2][0], m21 = m[2][1], m22 = m[2][2];

		r32 t00 = m22 * m11 - m21 * m12;
		r32 t10 = m20 * m12 - m22 * m10;
		r32 t20 = m21 * m10 - m20 * m11;

		r32 m00 = m[0][0], m01 = m[0][1], m02 = m[0][2];

		r32 invDet = 1 / (m00 * t00 + m01 * t10 + m02 * t20);

		t00 *= invDet; t10 *= invDet; t20 *= invDet;

		m00 *= invDet; m01 *= invDet; m02 *= invDet;

		r32 r00 = t00;
		r32 r01 = m02 * m21 - m01 * m22;
		r32 r02 = m01 * m12 - m02 * m11;

		r32 r10 = t10;
		r32 r11 = m00 * m22 - m02 * m20;
		r32 r12 = m02 * m10 - m00 * m12;

		r32 r20 = t20;
		r32 r21 = m01 * m20 - m00 * m21;
		r32 r22 = m00 * m11 - m01 * m10;

		r32 m03 = m[0][3], m13 = m[1][3], m23 = m[2][3];

		r32 r03 = -(r00 * m03 + r01 * m13 + r02 * m23);
		r32 r13 = -(r10 * m03 + r11 * m13 + r12 * m23);
		r32 r23 = -(r20 * m03 + r21 * m13 + r22 * m23);

		return mat4(
			r00, r01, r02, r03,
			r10, r11, r12, r13,
			r20, r21, r22, r23,
			0, 0, 0, 1);
	}

	void mat4::make_transform(const vec3& position, const vec3& scale, const quat& orientation) {
		// ordering: scale, rotate, translate

		mat3 rot3x3;
		orientation.to_rotation_matrix(&rot3x3);

		// set up final matrix with scale, rotation and translation
		m[0][0] = scale.x * rot3x3[0][0]; m[1][0] = scale.y * rot3x3[1][0]; m[2][0] = scale.z * rot3x3[2][0]; m[3][0] = position.x;
		m[0][1] = scale.x * rot3x3[0][1]; m[1][1] = scale.y * rot3x3[1][1]; m[2][1] = scale.z * rot3x3[2][1]; m[3][1] = position.y;
		m[0][2] = scale.x * rot3x3[0][2]; m[1][2] = scale.y * rot3x3[1][2]; m[2][2] = scale.z * rot3x3[2][2]; m[3][2] = position.z;

		// no projection term
		m[0][3] = 0; m[1][3] = 0; m[2][3] = 0; m[3][3] = 1;
	}

	void mat4::make_inverse_transform(const vec3& position, const vec3& scale, const quat& orientation) {
		// invert the parameters
		vec3 invTranslate = -position;
		vec3 invScale(1 / scale.x, 1 / scale.y, 1 / scale.z);
		quat invRot = orientation.inverse();

		// because we're inverting, order is translation, rotation, scale
		// so make translation relative to scale & rotation
		invTranslate = invRot * invTranslate; // rotate
		invTranslate *= invScale; // scale

								  // next, make a 3x3 rotation matrix
		mat3 rot3x3;
		invRot.to_rotation_matrix(&rot3x3);

		// set up final matrix with scale, rotation and translation
		m[0][0] = invScale.x * rot3x3[0][0]; m[1][0] = invScale.x * rot3x3[1][0]; m[2][0] = invScale.x * rot3x3[2][0]; m[3][0] = invTranslate.x;
		m[0][1] = invScale.y * rot3x3[0][1]; m[1][1] = invScale.y * rot3x3[1][1]; m[2][1] = invScale.y * rot3x3[2][1]; m[3][1] = invTranslate.y;
		m[0][2] = invScale.z * rot3x3[0][2]; m[1][2] = invScale.z * rot3x3[1][2]; m[2][2] = invScale.z * rot3x3[2][2]; m[3][2] = invTranslate.z;

		// no projection term
		m[0][3] = 0; m[1][3] = 0; m[2][3] = 0; m[3][3] = 1;
	}

	void mat4::decomposition(vec3* position, vec3* scale, quat* orientation) const {
		mat3 m3x3;
		extract_mat3(m3x3);

		mat3 matQ;
		vec3 vecU;
		m3x3.qdu_decomposition(&matQ, scale, &vecU);

		*orientation = quat(matQ);
		*position = vec3(m[3][0], m[3][1], m[3][2]);
	}

	mat4 mat4::perspective(const r32 fov, const r32 aspect, const r32 near, const r32 far) {
		mat4 result = mat4::zero;

		r32 depth = far - near;
		r32 inverse_depth = 1.0f / depth;

		result[1][1] = 1.0f / tanf(fov);

		result[0][0] = -1.0f * result[1][1] / aspect;
		result[2][2] = far * inverse_depth;
		result[3][2] = (-far * near) * inverse_depth;
		result[2][3] = 1;

		return result;
	}

	mat4 mat4::orthographic(const r32 width, const r32 height, const r32 near, const r32 far) {
		mat4 result = mat4::zero;

		result[0][0] = 2.0f / width;
		result[1][1] = 2.0f / height;
		r32 inverse_depth = 1.0f / (near - far);
		result[2][2] = inverse_depth;
		result[3][2] = near * inverse_depth;
		result[3][3] = 1;

		return result;
	}

	mat4 mat4::look(const vec3& eye, const vec3& forward, const vec3& up) {
#if 1
		vec3 const f(vec3::normalize(forward));
		vec3 const s(-vec3::normalize(f.cross(up)));
		//vec3 u(vec3::normalize(up));
		vec3 u = f.cross(s);

		mat4 result = mat4::identity;
		result[0][0] = s.x;
		result[1][0] = s.y;
		result[2][0] = s.z;
		result[0][1] = u.x;
		result[1][1] = u.y;
		result[2][1] = u.z;
		result[0][2] = -f.x;
		result[1][2] = -f.y;
		result[2][2] = -f.z;
		result[3][0] = -s.dot(eye);
		result[3][1] = -u.dot(eye);
		result[3][2] = f.dot(eye);
		result[3][3] = 1.0f;
		return result;
#endif
#if 0
		vec3 f = vec3::normalize(eye - forward);
		vec3 r = vec3::normalize(up).cross(f);
		vec3 u = f.cross(r);

		mat4 result = mat4::identity;

		result[0][0] = r.x;
		result[0][1] = r.y;
		result[0][2] = r.z;
		result[1][0] = u.x;
		result[1][1] = u.y;
		result[1][2] = u.z;
		result[2][0] = f.x;
		result[2][1] = f.y;
		result[2][2] = f.z;

		result[3][0] = eye.x;
		result[3][1] = eye.y;
		result[3][2] = eye.z;

		return result;
#endif
	}

}


",16306,True,2750.893672835122,median
"[[analysis-lang-analyzer]]
=== Language Analyzers

A set of analyzers aimed at analyzing specific language text. The
following types are supported:
<<arabic-analyzer,`arabic`>>,
<<armenian-analyzer,`armenian`>>,
<<basque-analyzer,`basque`>>,
<<bengali-analyzer,`bengali`>>,
<<brazilian-analyzer,`brazilian`>>,
<<bulgarian-analyzer,`bulgarian`>>,
<<catalan-analyzer,`catalan`>>,
<<cjk-analyzer,`cjk`>>,
<<czech-analyzer,`czech`>>,
<<danish-analyzer,`danish`>>,
<<dutch-analyzer,`dutch`>>,
<<english-analyzer,`english`>>,
<<finnish-analyzer,`finnish`>>,
<<french-analyzer,`french`>>,
<<galician-analyzer,`galician`>>,
<<german-analyzer,`german`>>,
<<greek-analyzer,`greek`>>,
<<hindi-analyzer,`hindi`>>,
<<hungarian-analyzer,`hungarian`>>,
<<indonesian-analyzer,`indonesian`>>,
<<irish-analyzer,`irish`>>,
<<italian-analyzer,`italian`>>,
<<latvian-analyzer,`latvian`>>,
<<lithuanian-analyzer,`lithuanian`>>,
<<norwegian-analyzer,`norwegian`>>,
<<persian-analyzer,`persian`>>,
<<portuguese-analyzer,`portuguese`>>,
<<romanian-analyzer,`romanian`>>,
<<russian-analyzer,`russian`>>,
<<sorani-analyzer,`sorani`>>,
<<spanish-analyzer,`spanish`>>,
<<swedish-analyzer,`swedish`>>,
<<turkish-analyzer,`turkish`>>,
<<thai-analyzer,`thai`>>.

==== Configuring language analyzers

===== Stopwords

All analyzers support setting custom `stopwords` either internally in
the config, or by using an external stopwords file by setting
`stopwords_path`. Check <<analysis-stop-analyzer,Stop Analyzer>> for
more details.

===== Excluding words from stemming

The `stem_exclusion` parameter allows you to specify an array
of lowercase words that should not be stemmed.  Internally, this
functionality is implemented by adding the
<<analysis-keyword-marker-tokenfilter,`keyword_marker` token filter>>
with the `keywords` set to the value of the `stem_exclusion` parameter.

The following analyzers support setting custom `stem_exclusion` list:
`arabic`, `armenian`, `basque`, `bengali`, `bulgarian`, `catalan`, `czech`,
`dutch`, `english`, `finnish`, `french`, `galician`,
`german`, `hindi`, `hungarian`, `indonesian`, `irish`, `italian`, `latvian`,
`lithuanian`, `norwegian`, `portuguese`, `romanian`, `russian`, `sorani`,
`spanish`, `swedish`, `turkish`.

==== Reimplementing language analyzers

The built-in language analyzers can be reimplemented as `custom` analyzers
(as described below) in order to customize their behaviour.

NOTE: If you do not intend to exclude words from being stemmed (the
equivalent of the `stem_exclusion` parameter above), then you should remove
the `keyword_marker` token filter from the custom analyzer configuration.

[[arabic-analyzer]]
===== `arabic` analyzer

The `arabic` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /arabic_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""arabic_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_arabic_"" <1>
        },
        ""arabic_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""مثال""] <2>
        },
        ""arabic_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""arabic""
        }
      },
      ""analyzer"": {
        ""rebuilt_arabic"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""decimal_digit"",
            ""arabic_stop"",
            ""arabic_normalization"",
            ""arabic_keywords"",
            ""arabic_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""arabic_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: arabic_example, first: arabic, second: rebuilt_arabic}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[armenian-analyzer]]
===== `armenian` analyzer

The `armenian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /armenian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""armenian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_armenian_"" <1>
        },
        ""armenian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""օրինակ""] <2>
        },
        ""armenian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""armenian""
        }
      },
      ""analyzer"": {
        ""rebuilt_armenian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""armenian_stop"",
            ""armenian_keywords"",
            ""armenian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""armenian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: armenian_example, first: armenian, second: rebuilt_armenian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[basque-analyzer]]
===== `basque` analyzer

The `basque` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /basque_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""basque_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_basque_"" <1>
        },
        ""basque_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""Adibidez""] <2>
        },
        ""basque_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""basque""
        }
      },
      ""analyzer"": {
        ""rebuilt_basque"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""basque_stop"",
            ""basque_keywords"",
            ""basque_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""basque_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: basque_example, first: basque, second: rebuilt_basque}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[bengali-analyzer]]
===== `bengali` analyzer

The `bengali` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /bengali_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""bengali_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_bengali_"" <1>
        },
        ""bengali_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""উদাহরণ""] <2>
        },
        ""bengali_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""bengali""
        }
      },
      ""analyzer"": {
        ""rebuilt_bengali"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""decimal_digit"",
            ""bengali_keywords"",
            ""indic_normalization"",
            ""bengali_normalization"",
            ""bengali_stop"",
            ""bengali_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""bengali_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: bengali_example, first: bengali, second: rebuilt_bengali}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[brazilian-analyzer]]
===== `brazilian` analyzer

The `brazilian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /brazilian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""brazilian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_brazilian_"" <1>
        },
        ""brazilian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""exemplo""] <2>
        },
        ""brazilian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""brazilian""
        }
      },
      ""analyzer"": {
        ""rebuilt_brazilian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""brazilian_stop"",
            ""brazilian_keywords"",
            ""brazilian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""brazilian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: brazilian_example, first: brazilian, second: rebuilt_brazilian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[bulgarian-analyzer]]
===== `bulgarian` analyzer

The `bulgarian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /bulgarian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""bulgarian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_bulgarian_"" <1>
        },
        ""bulgarian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""пример""] <2>
        },
        ""bulgarian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""bulgarian""
        }
      },
      ""analyzer"": {
        ""rebuilt_bulgarian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""bulgarian_stop"",
            ""bulgarian_keywords"",
            ""bulgarian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""bulgarian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: bulgarian_example, first: bulgarian, second: rebuilt_bulgarian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[catalan-analyzer]]
===== `catalan` analyzer

The `catalan` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /catalan_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""catalan_elision"": {
          ""type"":       ""elision"",
          ""articles"":   [ ""d"", ""l"", ""m"", ""n"", ""s"", ""t""]
        },
        ""catalan_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_catalan_"" <1>
        },
        ""catalan_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""exemple""] <2>
        },
        ""catalan_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""catalan""
        }
      },
      ""analyzer"": {
        ""rebuilt_catalan"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""catalan_elision"",
            ""lowercase"",
            ""catalan_stop"",
            ""catalan_keywords"",
            ""catalan_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""catalan_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: catalan_example, first: catalan, second: rebuilt_catalan}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[cjk-analyzer]]
===== `cjk` analyzer

The `cjk` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /cjk_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""english_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  [ <1>
            ""a"", ""and"", ""are"", ""as"", ""at"", ""be"", ""but"", ""by"", ""for"",
            ""if"", ""in"", ""into"", ""is"", ""it"", ""no"", ""not"", ""of"", ""on"",
            ""or"", ""s"", ""such"", ""t"", ""that"", ""the"", ""their"", ""then"",
            ""there"", ""these"", ""they"", ""this"", ""to"", ""was"", ""will"",
            ""with"", ""www""
          ]
        }
      },
      ""analyzer"": {
        ""rebuilt_cjk"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""cjk_width"",
            ""lowercase"",
            ""cjk_bigram"",
            ""english_stop""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""cjk_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: cjk_example, first: cjk, second: rebuilt_cjk}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters. The default stop words are
    *almost* the same as the `_english_` set, but not exactly
    the same.

[[czech-analyzer]]
===== `czech` analyzer

The `czech` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /czech_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""czech_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_czech_"" <1>
        },
        ""czech_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""příklad""] <2>
        },
        ""czech_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""czech""
        }
      },
      ""analyzer"": {
        ""rebuilt_czech"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""czech_stop"",
            ""czech_keywords"",
            ""czech_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""czech_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: czech_example, first: czech, second: rebuilt_czech}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[danish-analyzer]]
===== `danish` analyzer

The `danish` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /danish_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""danish_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_danish_"" <1>
        },
        ""danish_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""eksempel""] <2>
        },
        ""danish_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""danish""
        }
      },
      ""analyzer"": {
        ""rebuilt_danish"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""danish_stop"",
            ""danish_keywords"",
            ""danish_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""danish_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: danish_example, first: danish, second: rebuilt_danish}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[dutch-analyzer]]
===== `dutch` analyzer

The `dutch` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /dutch_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""dutch_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_dutch_"" <1>
        },
        ""dutch_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""voorbeeld""] <2>
        },
        ""dutch_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""dutch""
        },
        ""dutch_override"": {
          ""type"":       ""stemmer_override"",
          ""rules"": [
            ""fiets=>fiets"",
            ""bromfiets=>bromfiets"",
            ""ei=>eier"",
            ""kind=>kinder""
          ]
        }
      },
      ""analyzer"": {
        ""rebuilt_dutch"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""dutch_stop"",
            ""dutch_keywords"",
            ""dutch_override"",
            ""dutch_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""dutch_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: dutch_example, first: dutch, second: rebuilt_dutch}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[english-analyzer]]
===== `english` analyzer

The `english` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /english_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""english_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_english_"" <1>
        },
        ""english_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""example""] <2>
        },
        ""english_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""english""
        },
        ""english_possessive_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""possessive_english""
        }
      },
      ""analyzer"": {
        ""rebuilt_english"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""english_possessive_stemmer"",
            ""lowercase"",
            ""english_stop"",
            ""english_keywords"",
            ""english_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""english_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: english_example, first: english, second: rebuilt_english}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[finnish-analyzer]]
===== `finnish` analyzer

The `finnish` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /finnish_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""finnish_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_finnish_"" <1>
        },
        ""finnish_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""esimerkki""] <2>
        },
        ""finnish_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""finnish""
        }
      },
      ""analyzer"": {
        ""rebuilt_finnish"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""finnish_stop"",
            ""finnish_keywords"",
            ""finnish_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""finnish_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: finnish_example, first: finnish, second: rebuilt_finnish}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[french-analyzer]]
===== `french` analyzer

The `french` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /french_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""french_elision"": {
          ""type"":         ""elision"",
          ""articles_case"": true,
          ""articles"": [
              ""l"", ""m"", ""t"", ""qu"", ""n"", ""s"",
              ""j"", ""d"", ""c"", ""jusqu"", ""quoiqu"",
              ""lorsqu"", ""puisqu""
            ]
        },
        ""french_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_french_"" <1>
        },
        ""french_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""Exemple""] <2>
        },
        ""french_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""light_french""
        }
      },
      ""analyzer"": {
        ""rebuilt_french"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""french_elision"",
            ""lowercase"",
            ""french_stop"",
            ""french_keywords"",
            ""french_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""french_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: french_example, first: french, second: rebuilt_french}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[galician-analyzer]]
===== `galician` analyzer

The `galician` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /galician_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""galician_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_galician_"" <1>
        },
        ""galician_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""exemplo""] <2>
        },
        ""galician_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""galician""
        }
      },
      ""analyzer"": {
        ""rebuilt_galician"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""galician_stop"",
            ""galician_keywords"",
            ""galician_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""galician_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: galician_example, first: galician, second: rebuilt_galician}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[german-analyzer]]
===== `german` analyzer

The `german` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /german_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""german_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_german_"" <1>
        },
        ""german_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""Beispiel""] <2>
        },
        ""german_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""light_german""
        }
      },
      ""analyzer"": {
        ""rebuilt_german"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""german_stop"",
            ""german_keywords"",
            ""german_normalization"",
            ""german_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""german_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: german_example, first: german, second: rebuilt_german}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[greek-analyzer]]
===== `greek` analyzer

The `greek` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /greek_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""greek_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_greek_"" <1>
        },
        ""greek_lowercase"": {
          ""type"":       ""lowercase"",
          ""language"":   ""greek""
        },
        ""greek_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""παράδειγμα""] <2>
        },
        ""greek_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""greek""
        }
      },
      ""analyzer"": {
        ""rebuilt_greek"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""greek_lowercase"",
            ""greek_stop"",
            ""greek_keywords"",
            ""greek_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""greek_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: greek_example, first: greek, second: rebuilt_greek}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[hindi-analyzer]]
===== `hindi` analyzer

The `hindi` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /hindi_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""hindi_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_hindi_"" <1>
        },
        ""hindi_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""उदाहरण""] <2>
        },
        ""hindi_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""hindi""
        }
      },
      ""analyzer"": {
        ""rebuilt_hindi"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""decimal_digit"",
            ""hindi_keywords"",
            ""indic_normalization"",
            ""hindi_normalization"",
            ""hindi_stop"",
            ""hindi_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""hindi_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: hindi_example, first: hindi, second: rebuilt_hindi}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[hungarian-analyzer]]
===== `hungarian` analyzer

The `hungarian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /hungarian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""hungarian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_hungarian_"" <1>
        },
        ""hungarian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""példa""] <2>
        },
        ""hungarian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""hungarian""
        }
      },
      ""analyzer"": {
        ""rebuilt_hungarian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""hungarian_stop"",
            ""hungarian_keywords"",
            ""hungarian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""hungarian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: hungarian_example, first: hungarian, second: rebuilt_hungarian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.


[[indonesian-analyzer]]
===== `indonesian` analyzer

The `indonesian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /indonesian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""indonesian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_indonesian_"" <1>
        },
        ""indonesian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""contoh""] <2>
        },
        ""indonesian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""indonesian""
        }
      },
      ""analyzer"": {
        ""rebuilt_indonesian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""indonesian_stop"",
            ""indonesian_keywords"",
            ""indonesian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""indonesian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: indonesian_example, first: indonesian, second: rebuilt_indonesian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[irish-analyzer]]
===== `irish` analyzer

The `irish` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /irish_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""irish_hyphenation"": {
          ""type"":       ""stop"",
          ""stopwords"":  [ ""h"", ""n"", ""t"" ],
          ""ignore_case"": true
        },
        ""irish_elision"": {
          ""type"":       ""elision"",
          ""articles"":   [ ""d"", ""m"", ""b"" ],
          ""articles_case"": true
        },
        ""irish_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_irish_"" <1>
        },
        ""irish_lowercase"": {
          ""type"":       ""lowercase"",
          ""language"":   ""irish""
        },
        ""irish_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""sampla""] <2>
        },
        ""irish_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""irish""
        }
      },
      ""analyzer"": {
        ""rebuilt_irish"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""irish_hyphenation"",
            ""irish_elision"",
            ""irish_lowercase"",
            ""irish_stop"",
            ""irish_keywords"",
            ""irish_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""irish_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: irish_example, first: irish, second: rebuilt_irish}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[italian-analyzer]]
===== `italian` analyzer

The `italian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /italian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""italian_elision"": {
          ""type"": ""elision"",
          ""articles"": [
                ""c"", ""l"", ""all"", ""dall"", ""dell"",
                ""nell"", ""sull"", ""coll"", ""pell"",
                ""gl"", ""agl"", ""dagl"", ""degl"", ""negl"",
                ""sugl"", ""un"", ""m"", ""t"", ""s"", ""v"", ""d""
          ]
        },
        ""italian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_italian_"" <1>
        },
        ""italian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""esempio""] <2>
        },
        ""italian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""light_italian""
        }
      },
      ""analyzer"": {
        ""rebuilt_italian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""italian_elision"",
            ""lowercase"",
            ""italian_stop"",
            ""italian_keywords"",
            ""italian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""italian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: italian_example, first: italian, second: rebuilt_italian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[latvian-analyzer]]
===== `latvian` analyzer

The `latvian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /latvian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""latvian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_latvian_"" <1>
        },
        ""latvian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""piemērs""] <2>
        },
        ""latvian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""latvian""
        }
      },
      ""analyzer"": {
        ""rebuilt_latvian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""latvian_stop"",
            ""latvian_keywords"",
            ""latvian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""latvian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: latvian_example, first: latvian, second: rebuilt_latvian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[lithuanian-analyzer]]
===== `lithuanian` analyzer

The `lithuanian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /lithuanian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""lithuanian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_lithuanian_"" <1>
        },
        ""lithuanian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""pavyzdys""] <2>
        },
        ""lithuanian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""lithuanian""
        }
      },
      ""analyzer"": {
        ""rebuilt_lithuanian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""lithuanian_stop"",
            ""lithuanian_keywords"",
            ""lithuanian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""lithuanian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: lithuanian_example, first: lithuanian, second: rebuilt_lithuanian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[norwegian-analyzer]]
===== `norwegian` analyzer

The `norwegian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /norwegian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""norwegian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_norwegian_"" <1>
        },
        ""norwegian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""eksempel""] <2>
        },
        ""norwegian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""norwegian""
        }
      },
      ""analyzer"": {
        ""rebuilt_norwegian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""norwegian_stop"",
            ""norwegian_keywords"",
            ""norwegian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""norwegian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: norwegian_example, first: norwegian, second: rebuilt_norwegian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[persian-analyzer]]
===== `persian` analyzer

The `persian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /persian_example
{
  ""settings"": {
    ""analysis"": {
      ""char_filter"": {
        ""zero_width_spaces"": {
            ""type"":       ""mapping"",
            ""mappings"": [ ""\\\\u200C=> ""] <1>
        }
      },
      ""filter"": {
        ""persian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_persian_"" <2>
        }
      },
      ""analyzer"": {
        ""rebuilt_persian"": {
          ""tokenizer"":     ""standard"",
          ""char_filter"": [ ""zero_width_spaces"" ],
          ""filter"": [
            ""lowercase"",
            ""decimal_digit"",
            ""arabic_normalization"",
            ""persian_normalization"",
            ""persian_stop""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: persian_example, first: persian, second: rebuilt_persian}\\nendyaml\\n/]
<1> Replaces zero-width non-joiners with an ASCII space.
<2> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.

[[portuguese-analyzer]]
===== `portuguese` analyzer

The `portuguese` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /portuguese_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""portuguese_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_portuguese_"" <1>
        },
        ""portuguese_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""exemplo""] <2>
        },
        ""portuguese_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""light_portuguese""
        }
      },
      ""analyzer"": {
        ""rebuilt_portuguese"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""portuguese_stop"",
            ""portuguese_keywords"",
            ""portuguese_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""portuguese_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: portuguese_example, first: portuguese, second: rebuilt_portuguese}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[romanian-analyzer]]
===== `romanian` analyzer

The `romanian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /romanian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""romanian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_romanian_"" <1>
        },
        ""romanian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""exemplu""] <2>
        },
        ""romanian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""romanian""
        }
      },
      ""analyzer"": {
        ""rebuilt_romanian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""romanian_stop"",
            ""romanian_keywords"",
            ""romanian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""romanian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: romanian_example, first: romanian, second: rebuilt_romanian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.


[[russian-analyzer]]
===== `russian` analyzer

The `russian` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /russian_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""russian_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_russian_"" <1>
        },
        ""russian_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""пример""] <2>
        },
        ""russian_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""russian""
        }
      },
      ""analyzer"": {
        ""rebuilt_russian"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""russian_stop"",
            ""russian_keywords"",
            ""russian_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""russian_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: russian_example, first: russian, second: rebuilt_russian}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[sorani-analyzer]]
===== `sorani` analyzer

The `sorani` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /sorani_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""sorani_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_sorani_"" <1>
        },
        ""sorani_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""mînak""] <2>
        },
        ""sorani_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""sorani""
        }
      },
      ""analyzer"": {
        ""rebuilt_sorani"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""sorani_normalization"",
            ""lowercase"",
            ""decimal_digit"",
            ""sorani_stop"",
            ""sorani_keywords"",
            ""sorani_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""sorani_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: sorani_example, first: sorani, second: rebuilt_sorani}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[spanish-analyzer]]
===== `spanish` analyzer

The `spanish` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /spanish_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""spanish_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_spanish_"" <1>
        },
        ""spanish_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""ejemplo""] <2>
        },
        ""spanish_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""light_spanish""
        }
      },
      ""analyzer"": {
        ""rebuilt_spanish"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""spanish_stop"",
            ""spanish_keywords"",
            ""spanish_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""spanish_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: spanish_example, first: spanish, second: rebuilt_spanish}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[swedish-analyzer]]
===== `swedish` analyzer

The `swedish` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /swedish_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""swedish_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_swedish_"" <1>
        },
        ""swedish_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""exempel""] <2>
        },
        ""swedish_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""swedish""
        }
      },
      ""analyzer"": {
        ""rebuilt_swedish"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""lowercase"",
            ""swedish_stop"",
            ""swedish_keywords"",
            ""swedish_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""swedish_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: swedish_example, first: swedish, second: rebuilt_swedish}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[turkish-analyzer]]
===== `turkish` analyzer

The `turkish` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /turkish_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""turkish_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_turkish_"" <1>
        },
        ""turkish_lowercase"": {
          ""type"":       ""lowercase"",
          ""language"":   ""turkish""
        },
        ""turkish_keywords"": {
          ""type"":       ""keyword_marker"",
          ""keywords"":   [""örnek""] <2>
        },
        ""turkish_stemmer"": {
          ""type"":       ""stemmer"",
          ""language"":   ""turkish""
        }
      },
      ""analyzer"": {
        ""rebuilt_turkish"": {
          ""tokenizer"":  ""standard"",
          ""filter"": [
            ""apostrophe"",
            ""turkish_lowercase"",
            ""turkish_stop"",
            ""turkish_keywords"",
            ""turkish_stemmer""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""turkish_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: turkish_example, first: turkish, second: rebuilt_turkish}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
<2> This filter should be removed unless there are words which should
    be excluded from stemming.

[[thai-analyzer]]
===== `thai` analyzer

The `thai` analyzer could be reimplemented as a `custom` analyzer as follows:

[source,js]
----------------------------------------------------
PUT /thai_example
{
  ""settings"": {
    ""analysis"": {
      ""filter"": {
        ""thai_stop"": {
          ""type"":       ""stop"",
          ""stopwords"":  ""_thai_"" <1>
        }
      },
      ""analyzer"": {
        ""rebuilt_thai"": {
          ""tokenizer"":  ""thai"",
          ""filter"": [
            ""lowercase"",
            ""decimal_digit"",
            ""thai_stop""
          ]
        }
      }
    }
  }
}
----------------------------------------------------
// CONSOLE
// TEST[s/""thai_keywords"",//]
// TEST[s/\\n$/\\nstartyaml\\n  - compare_analyzers: {index: thai_example, first: thai, second: rebuilt_thai}\\nendyaml\\n/]
<1> The default stopwords can be overridden with the `stopwords`
    or `stopwords_path` parameters.
",12343,True,4141.169126268125,median
"===  Using Hot Rod Server
The Infinispan Server distribution contains a server module that implements Infinispan's custom binary protocol called Hot Rod. The protocol was designed to enable faster client/server interactions compared to other existing text based protocols and to allow clients to make more intelligent decisions with regards to load balancing, failover and even data location operations. 
Please refer to Infinispan Server's link:$$../infinispan_server_guide/infinispan_server_guide.html$$[documentation] for instructions on how to configure and run a HotRod server.

include::chapter-64-Hot_Rod_Protocol.adoc[]

====  Java Hot Rod client
Hot Rod is a binary, language neutral protocol. This article explains how a Java client can interact with a server via the Hot Rod protocol. A reference implementation of the protocol written in Java can be found in all Infinispan distributions, and this article focuses on the capabilities of this java client.

TIP: Looking for more clients?  Visit link:$$http://infinispan.org/hotrod-clients$$[this website] for clients written in a variety of different languages.

===== Configuration
The Java Hot Rod client can be configured both programmatically and externally, through a configuration file.

The code snippet below illustrates the creation of a client instance using the available Java fluent API:

[source,java]
----
org.infinispan.client.hotrod.configuration.ConfigurationBuilder cb
      = new org.infinispan.client.hotrod.configuration.ConfigurationBuilder();
cb.tcpNoDelay(true)
  .connectionPool()
      .numTestsPerEvictionRun(3)
      .testOnBorrow(false)
      .testOnReturn(false)
      .testWhileIdle(true)
  .addServer()
      .host(""localhost"")
      .port(11222);
RemoteCacheManager rmc = new RemoteCacheManager(cb.build());

----

For a complete reference to the available configuration option please refer to the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/configuration/ConfigurationBuilder.html$$[ConfigurationBuilder]'s javadoc.

It is also possible to configure the Java Hot Rod client using an properties file, e.g.:

[source]
----
infinispan.client.hotrod.transport_factory = org.infinispan.client.hotrod.impl.transport.tcp.TcpTransportFactory
infinispan.client.hotrod.server_list = 127.0.0.1:11222
infinispan.client.hotrod.marshaller = org.infinispan.commons.marshall.jboss.GenericJBossMarshaller
infinispan.client.hotrod.async_executor_factory = org.infinispan.client.hotrod.impl.async.DefaultAsyncExecutorFactory
infinispan.client.hotrod.default_executor_factory.pool_size = 1
infinispan.client.hotrod.default_executor_factory.queue_size = 10000
infinispan.client.hotrod.hash_function_impl.1 = org.infinispan.client.hotrod.impl.consistenthash.ConsistentHashV1
infinispan.client.hotrod.tcp_no_delay = true
infinispan.client.hotrod.ping_on_startup = true
infinispan.client.hotrod.request_balancing_strategy = org.infinispan.client.hotrod.impl.transport.tcp.RoundRobinBalancingStrategy
infinispan.client.hotrod.key_size_estimate = 64
infinispan.client.hotrod.value_size_estimate = 512
infinispan.client.hotrod.force_return_values = false

## below is connection pooling config
maxActive=-1
maxTotal = -1
maxIdle = -1
whenExhaustedAction = 1
timeBetweenEvictionRunsMillis=120000
minEvictableIdleTimeMillis=300000
testWhileIdle = true
minIdle = 1

----

The properties file is then passed to one of constructors of link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCacheManager.html#RemoteCacheManager(java.net.URL)$$[RemoteCacheManager].
For a complete reference of the available configuration options for the properties file please refer to link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCacheManager.html$$[RemoteCacheManager]'s javadoc.

===== Basic API
Below is a sample code snippet on how the client API can be used to store or retrieve information from a Hot Rod server using the Java Hot Rod client. It assumes that a Hot Rod server has been started bound to the default location (localhost:11222) 

[source,java]
----
//API entry point, by default it connects to localhost:11222
CacheContainer cacheContainer = new RemoteCacheManager();

//obtain a handle to the remote default cache
Cache<String, String> cache = cacheContainer.getCache();

//now add something to the cache and make sure it is there
cache.put(""car"", ""ferrari"");
assert cache.get(""car"").equals(""ferrari"");

//remove the data
cache.remove(""car"");
assert !cache.containsKey(""car"") : ""Value must have been removed!"";

----

The client API maps the local API: link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCacheManager.html$$[RemoteCacheManager] corresponds to link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/manager/DefaultCacheManager.html$$[DefaultCacheManager] (both implement link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/manager/CacheContainer.html$$[CacheContainer] ). This common API facilitates an easy migration from local calls to remote calls through Hot Rod: all one needs to do is switch between link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/manager/DefaultCacheManager.html$$[DefaultCacheManager] and link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCacheManager.html$$[RemoteCacheManager] - which is further simplified by the common link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/manager/CacheContainer.html$$[CacheContainer] interface that both inherit.

Starting from Infinispan 5.2, all keys can be retrieved from the remote cache (whether it's local, replicated, or distributed) by using keySet() method. If the remote cache is a distributed cache, the server will start a map/reduce job to retrieve all keys from clustered nodes, and return all keys to the client.  Please use this method with care if there are large number of keys.

[source,java]
----
Set keys = remoteCache.keySet();

----

===== Versioned API
A RemoteCacheManager provides instances of link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCache.html$$[RemoteCache] interface that represents a handle to the named or default cache on the remote cluster. API wise, it extends the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/Cache.html$$[Cache] interface to which it also adds some new methods, including the so called versioned API. Please find below some examples of this API <<sid-68355052, but to understand the motivation behind it, make sure you read this section>>.

The code snippet bellow depicts the usage of these versioned methods: 

[source,java]
----
// To use the versioned API, remote classes are specifically needed
RemoteCacheManager remoteCacheManager = new RemoteCacheManager();
RemoteCache<String, String> cache = remoteCacheManager.getCache();

remoteCache.put(""car"", ""ferrari"");
RemoteCache.VersionedValue valueBinary = remoteCache.getVersioned(""car"");

// removal only takes place only if the version has not been changed
// in between. (a new version is associated with 'car' key on each change)
assert remoteCache.remove(""car"", valueBinary.getVersion());
assert !cache.containsKey(""car"");

----

In a similar way, for replace:

[source,java]
----
remoteCache.put(""car"", ""ferrari"");
RemoteCache.VersionedValue valueBinary = remoteCache.getVersioned(""car"");
assert remoteCache.replace(""car"", ""lamborghini"", valueBinary.getVersion());
----

For more details on versioned operations refer to link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCache.html$$[RemoteCache] 's javadoc.

===== Async API
This cool feature is ""borrowed"" from the Infinispan core and it is largely discussed <<_asynchronous_api, here>>

===== Client Event Listener API

Starting with Infinispan 7.0, Java Hot Rod clients can register listeners to
receive cache-entry level events. In 7.0, cache entry created, modified and
removed events are supported.

====== Creating a Client Event Listener

Creating a client listener is very similar to embedded listeners, except that
different annotations and event classes are used. Here's an example of a
client listener that prints out each event received:

[source,java]
----
import org.infinispan.client.hotrod.annotation.*;
import org.infinispan.client.hotrod.event.*;

@ClientListener
public class EventPrintListener {

   @ClientCacheEntryCreated
   public void handleCreatedEvent(ClientCacheEntryCreatedEvent e) {
      System.out.println(e);
   }

   @ClientCacheEntryModified
   public void handleModifiedEvent(ClientCacheEntryModifiedEvent e) {
      System.out.println(e);
   }

   @ClientCacheEntryRemoved
   public void handleRemovedEvent(ClientCacheEntryRemovedEvent e) {
      System.out.println(e);
   }

}
----

`ClientCacheEntryCreatedEvent` and `ClientCacheEntryModifiedEvent` instances
provide information on the affected key, and the version of the entry. This
version can be used to invoke conditional operations on the server, such as
`replaceWithVersion` or `removeWithVersion`.

Once the client listener implementation has been created, it needs to be
registered with the server. To do so, execute:

[source,java]
----
RemoteCache<?, ?> cache = ...
cache.addClientListener(new EventPrintListener());
----

====== Remove a Client Event Listener

When an client event listener is not needed any more, it can be removed:

[source,java]
----
EventPrintListener listener = ...
cache.removeClientListener(listener);
----

====== Filtering Client Events

In order to avoid inundating clients with events, users can provide filtering
functionality to limit the number of events fired by the server for a
particular client listener. To enable filtering, a key/value filter factory
needs to be created that produces filter instances:

[source,java]
----
import org.infinispan.notifications.KeyValueFilterFactory;

class StaticKeyValueFilterFactory implements KeyValueFilterFactory {
   @Override
   public KeyValueFilter<Integer, String> getKeyValueFilter(Object[] params) {
      return new StaticKeyValueFilter();
   }
}

class StaticKeyValueFilter implements KeyValueFilter<Integer, String> {
   @Override
   public boolean accept(Integer key, String value, Metadata metadata) {
      if (key.equals(1)) // static key
         return true;

      return false;
   }
}
----

The key/value filter factory instance defined above creates filter instances
which statically filter out all entries except the one whose key is `1`.

To be able to register a listener with this key/value filter factory,
the factory has to be given a unique name, and the Hot Rod server needs to be
plugged with the name and the key/value filter factory instance:

[source,java]
----
HotRodServerConfigurationBuilder builder = ...
builder.keyValueFilterFactory(""static-filter"", new StaticKeyValueFilterFactory());
----

On top of that, the client listener needs to be linked with this key/value
filter factory by adding the factory's name to the @ClientListener annotation:

[source,java]
----
@ClientListener(filterFactoryName = ""static-filter"")
public class EventPrintListener { ... }
----

And, register the listener with the server:

[source,java]
----
RemoteCache<?, ?> cache = ...
cache.addClientListener(new EventPrintListener());
----

Dynamic filter instances that filter based on parameters provided when the
listener is registered are also possible. Filters use the parameters received
by the filter factories to enable this option. For example:

[source,java]
----
import org.infinispan.notifications.KeyValueFilterFactory;
import org.infinispan.notifications.KeyValueFilter;

class DynamicKeyValueFilterFactory implements KeyValueFilterFactory {
   @Override
   public KeyValueFilter<Integer, String> getKeyValueFilter(Object[] params) {
      return new DynamicKeyValueFilter(params);
   }
}

class DynamicKeyValueFilter implements KeyValueFilter<Integer, String> {
   final Object[] params;

   DynamicKeyValueFilter(Object[] params) {
      this.params = params;
   }

   @Override
   public boolean accept(Integer key, String value, Metadata metadata) {
      if (key.equals(params[0])) // dynamic key
         return true;

      return false;
   }
}
----

The dynamic parameters required to do the filtering are provided when the
listener is registered:

[source,java]
----
RemoteCache<?, ?> cache = ...
cache.addClientListener(new EventPrintListener(), new Object[]{1}, null);
----

WARNING: Filter instances have to marshallable when they are deployed in a
cluster so that the filtering can happen right where the event is generated,
even if the even is generated in a different node to where the listener is
registered. To make them marshallable, either make them extend `Serializable`,
`Externalizable`, or provide a custom `Externalizer` for them.

NOTE: Hot Rod servers store data as byte arrays, but in spite of that,
Java Hot Rod client users can still develop `KeyValueFilter` instances that
worked on typed objects. The way this is done is by making the Hot Rod server
use the same marshaller as the one used by the Java Hot Rod client. This is
enabled by default.

====== Customizing Client Events contents

The events generated by default contain just enough information to make the
event relevant but they avoid cramming too much information in order to reduce
the cost of sending them. Optionally, the information shipped in the events
can be customised in order to contain more information, such as values, or to
contain even less information. This customization is done with `Converter`
instances generated by a `ConverterFactory`:

[source,java]
----
import org.infinispan.notifications.ConverterFactory;
import org.infinispan.notifications.Converter;

class StaticConverterFactory implements ConverterFactory {
   final Converter<Integer, String, CustomEvent> staticConverter = new StaticConverter();
   public Converter<Integer, String, CustomEvent> getConverter(final Object[] params) {
      return staticConverter;
   }
}

class StaticConverter implements Converter {
   public CustomEvent convert(Integer key, String value, Metadata metadata) {
      return new CustomEvent(key, value);
   }
}

// Needs to be Serializable or Externalizable!
static class CustomEvent implements Serializable {
   final Integer key;
   final String value;
   CustomEvent(Integer key, String value) {
      this.key = key;
      this.value = value;
   }
}
----

In the example above, the converter generates a new custom event which
includes the value as well as the key in the event. This will result in bigger
event payloads compared with default events, but if combined with filtering,
it can reduce its network bandwidth cost.

WARNING: The target type of the converter must be either `Serializable` or
`Externalizable`. In this particular case of converters, providing an
Externalizer will not work by default since the default Hot Rod client
marshaller does not support them.

Handlin custom events requires a slightly different client listener
implementation to the one demonstrated previously. To be more precise, it
needs to handle `ClientCacheEntryCustomEvent` instances:

[source,java]
----
import org.infinispan.client.hotrod.annotation.*;
import org.infinispan.client.hotrod.event.*;

@ClientListener
public class CustomEventPrintListener {

   @ClientCacheEntryCreated
   @ClientCacheEntryModified
   @ClientCacheEntryRemoved
   public void handleCustomEvent(ClientCacheEntryCustomEvent<CustomEvent> e) {
      System.out.println(e);
   }

}
----

The `ClientCacheEntryCustomEvent` received in the callback exposes the custom
event via `getEventData` method, and the `getType` method provides information
on whether the event generated was as a result of cache entry creation,
modification or removal.

Similar to filtering, to be able to register a listener with this converter factory,
the factory has to be given a unique name, and the Hot Rod server needs to be
plugged with the name and the converter factory instance:

[source,java]
----
HotRodServerConfigurationBuilder builder = ...
builder.converterFactory(""static-converter"", new StaticConverterFactory());
----

On top of that, the client listener needs to be linked with this converter
factory by adding the factory's name to the @ClientListener annotation:

[source,java]
----
@ClientListener(converterFactoryName = ""static-converter"")
public class CustomEventPrintListener { ... }
----

And, register the listener with the server:

[source,java]
----
RemoteCache<?, ?> cache = ...
cache.addClientListener(new CustomEventPrintListener());
----

Dynamic converter instances that convert based on parameters provided when the
listener is registered are also possible. Converters use the parameters received
by the converter factories to enable this option. For example:

[source,java]
----
import org.infinispan.notifications.ConverterFactory;
import org.infinispan.notifications.Converter;

class DynamicConverterFactory implements ConverterFactory {
   public Converter<Integer, String, CustomEvent> getConverter(final Object[] params) {
      return new DynamicConverter(params);
   }
}

class DynamicConverter implements Converter {
   final Object[] params;

   DynamicConverter(Object[] params) {
      this.params = params;
   }

   public CustomEvent convert(Integer key, String value, Metadata metadata) {
      // If the key matches a key given via parameter, only send the key information
      if (params[0].equals(key))
         return new CustomEvent(key, null);

      return new CustomEvent(key, value);
   }
}
----

The dynamic parameters required to do the conversion are provided when the
listener is registered:

[source,java]
----
RemoteCache<?, ?> cache = ...
cache.addClientListener(new EventPrintListener(), null, new Object[]{1});
----

WARNING: Converter instances have to marshallable when they are deployed in a
cluster, so that the conversion can happen right where the event is generated,
even if the even is generated in a different node to where the listener is
registered. To make them marshallable, either make them extend `Serializable`,
`Externalizable`, or provide a custom `Externalizer` for them.

NOTE: Hot Rod servers store data as byte arrays, but in spite of that,
Java Hot Rod client users can still develop `Converter` instances that
worked on typed objects. The way this is done is by making the Hot Rod server
use the same marshaller as the one used by the Java Hot Rod client. This is
enabled by default.

====== Client Event Listener State Consumption

If a client listener is added in a cache already containing data, the server
iterates over the cache contents and sends an event for each entry to the
client as a `ClientCacheEntryCreated` (or custom event if configured).
This allows clients to build some  local data structures based on the existing
content. Once the content has been iterated over, events are received as normal,
as cache updates are received. If the cache is clustered, the entire cluster
wide contents are iterated over.

====== Client Event Listener Failure Handling

When a Hot Rod client registers a client listener, it does so in a single
node in a cluster. If that node fails, the Java Hot Rod client detects that
transparently and fails over all listeners registered in the node that failed
to another node. During this fail over, the client might miss some events,
which is why when the listeners are registered in a new node, the cache
contents are iterated over and `ClientCacheEntryCreated` events (or custom
events if configured) are generated.

Java Hot Rod clients can be made aware of such fail over event by adding a
callback to handle it:

[source,java]
----
@ClientCacheFailover
public void handleFailover(ClientCacheFailoverEvent e) {
  ...
}
----

This is very useful in use cases where the client has cached some data, and
as a result of the fail over, taking in account that some events could be
missed, it could decide to clear any locally cached data when the fail over
event is received, with the knowledge that after the fail over event, it will
receive events for the contents of the entire cache.

===== Unsupported methods
Some of the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/Cache.html$$[Cache] methods are not being supported by the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCache.html$$[RemoteCache] . Calling one of these methods results in an link:$$http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html$$[UnsupportedOperationException] being thrown. Most of these methods do not make sense on the remote cache (e.g. listener management operations), or correspond to methods that are not supported by local cache as well (e.g. containsValue). Another set of unsupported operations are some of the atomic operations inherited from link:$$http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ConcurrentMap.html$$[ConcurrentMap] :

[source,java]
----
boolean remove(Object key, Object value);
boolean replace(Object key, Object value);
boolean replace(Object key, Object oldValue, Object value);

----

link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCache.html$$[RemoteCache] offers alternative versioned methods for these atomic operations, that are also network friendly, by not sending the whole value object over the network, but a version identifier. See the section on versioned API.

Each one of these unsupported operation is documented in the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCache.html$$[RemoteCache] javadoc.

==== Return values
There is a set of methods that alter a cached entry and return the previous existing value, e.g.: 

[source,java]
----
V remove(Object key);
V put(K key, V value);
----

By default on RemoteCache, these operations return null even if such a previous value exists. This approach reduces the amount of data sent over the network. However, if these return values are needed they can be enforced on a per invocation basis using flags: 

[source,java]
----
cache.put(""aKey"", ""initialValue"");
assert null == cache.put(""aKey"", ""aValue"");
assert ""aValue"".equals(cache.withFlags(Flag.FORCE_RETURN_VALUE).put(""aKey"",
   ""newValue""));

----

This default behavior can can be changed through force-return-value=true configuration parameter (see configuration section bellow).

==== Intelligence
HotRod defines three level of intelligence for the clients:

. basic client, interested in neither cluster nor hash information
. topology-aware client, interested in cluster information
. hash-distribution-aware client, that is interested in both cluster and hash information

The java client supports all 3 levels of intelligence. It is transparently notified whenever a new server is added/removed from the HotRod cluster. At startup it only needs to know the address of one HotRod server (ip:host). On connection to the server the cluster topology is piggybacked to the client, and all further requests are being dispatched to all available servers. Any further topology change is also piggybacked.

===== Distribution-aware client
Another aspect of the 3rd level of intelligence is the fact that it is hash-distribution-aware. This means that, for each operation, the client chooses the most appropriate remote server to go to: the data owner. As an example, for a put(k,v) operation, the client calculates k's hash value and knows exactly on which server the data resides on. Then it picks up a tcp connection to that particular server and dispatches the operation to it. This means less burden on the server side which would otherwise need to lookup the value based on the key's hash. It also results in a quicker response from the server, as an additional network roundtrip is skipped. This hash-distribution-aware aspect is only relevant to the distributed HotRod clusters and makes no difference for replicated server deployments.

==== Request Balancing
Request balancing is only relevant when the server side is configured with replicated infinispan cluster (on distributed clusters the hash-distribution-aware client logic is used, as discussed in the previos paragraph). Because the client is topology-aware, it knows the list of available servers at all the time. Request balancing has to do with how the client dispatches requests to the available servers.

The default strategy is round-robin: requests are being dispatched to all existing servers in a circular manner. E.g. given a cluster of servers {s1, s2, s3} here is how request will be dispatched: 

[source,java]
----
CacheContainer cacheContainer = new RemoteCacheManager();
Cache<String, String> cache = cacheContainer.getCache();

cache.put(""key1"", ""aValue""); //this goes to s1
cache.put(""key2"", ""aValue""); //this goes to s2
String value = cache.get(""key1""); //this goes to s3

cache.remove(""key2""); //this is dispatched to s1 again, and so on...

----

Custom types of balancing policies can defined by implementing the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/impl/transport/tcp/FailoverRequestBalancingStrategy.html$$[FailoverRequestBalancingStrategy] and by specifying it through the infinispan.client.hotrod.request-balancing-strategy configuration property. Please refer to configuration section for more details on this.

.WARNING: link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/impl/transport/tcp/FailoverRequestBalancingStrategy.html$$[FailoverRequestBalancingStrategy]
is a newly added interface in Infinispan 7.0. Previously, users had to provide
implementations of link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/impl/transport/tcp/FailoverRequestBalancingStrategy.html$$[FailoverRequestBalancingStrategy]
, which it has been deprecated starting with Infinispan 7.0.

===== Persistent connections
In order to avoid creating a TCP connection on each request (which is a costly operation), the client keeps a pool of persistent connections to all the available servers and it reuses these connections whenever it is possible. The validity of the connections is checked using an async thread that iterates over the connections in the pool and sends a HotRod ping command to the server. By using this connection validation process the client is being proactive: there's a hight chance for broken connections to be found while being idle in the pool and no on actual request from the application.

The number of connections per server, total number of connections, how long should a connection be kept idle in the pool before being closed - all these (and more) can be configured. Please refer to the javadoc of link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCacheManager.html$$[RemoteCacheManager] for a list of all possible configuration elements.

===== Marshalling data
The Hot Rod client allows one to plug in a custom marshaller for transforming user objects into byte arrays and the other way around. This transformation is needed because of Hot Rod's binary nature - it doesn't know about objects.

The marshaller can be plugged through the ""marshaller"" configuration element (see Configuration section): the value should be the fully qualified name of a class implementing the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/marshall/Marshaller.html$$[Marshaller] interface. This is a optional parameter, if not specified it defaults to the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/marshall/jboss/GenericJBossMarshaller.html$$[GenericJBossMarshaller] - a highly optimized implementation based on the link:$$http://www.jboss.org/jbossmarshalling$$[JBoss Marshalling] library.

Since version 5.0, there's a new marshaller available to Java Hot Rod clients based on Apache Avro which generates portable payloads. You can find more information about it <<sid-68355061,here>> 

===== Statistics
Various server usage statistics can be obtained through the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCache.html$$[RemoteCache] .stats() method. This returns a link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/ServerStatistics.html$$[ServerStatistics] object - please refer to javadoc for details on the available statistics.

===== Configuration
All the configurations are passed to the RemoteCacheManager's constructor as key-value pairs, through an instance of link:$$http://docs.oracle.com/javase/6/docs/api/java/util/Properties.html$$[java.util.Properties] or reference to a .properties file. Please refer to the javadoc of RemoteCacheManager for a exhaustive list of the possible configuration elements.

===== Multi-Get Operations
The Java Hot Rod client does not provide multi-get functionality out of the box but clients can build it themselves with the given APIs. 

===== More info
It is highly recommended to read the following Javadocs (this is pretty much all the public API of the client):

*  link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCacheManager.html$$[RemoteCacheManager]
*  link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/RemoteCache.html$$[RemoteCache]

[[sid-68355052]]

==== Failover capabilities

Hot Rod clients' capabilities to keep up with topology changes helps with request
balancing and more importantly, with the ability to failover operations
if one or several of the servers fail.

Some of the conditional operations mentioned above, including `putIfAbsent`,
`replace` with and without version, and conditional `remove` have strict method
return guarantees, as well as those operations where returning the previous
value is forced.

In spite of failures, these methods return values need to be guaranteed, and
in order to do so, it's necessary that these methods are not applied partially
in the cluster in the event of failure. For example, imagine a `replace()`
operation called in a server for key=k1 with `Flag.FORCE_RETURN_VALUE`, whose
current value is `A` and the replace wants to set it to `B`. If the replace
fails, it could happen that some servers contain `B` and others contain `A`,
and during the failover, the original `replace()` could end up returning `B`,
if the replace failovers to a node where `B` is set, or could end up returning
`A`.

To avoid this kind of situations, whenever Java Hot Rod client users want to
use conditional operations, or operations whose previous value is required,
it's important that the cache is configured to be transactional in order to
avoid incorrect conditional operations or return values.

====  Consistent Concurrent Updates With Hot Rod Versioned Operations
Data structures, such as Infinispan link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/Cache.html$$[Cache] , that are accessed and modified concurrently can suffer from data consistency issues unless there're mechanisms to guarantee data correctness. Infinispan Cache, since it implements link:$$http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ConcurrentMap.html$$[ConcurrentMap] , provides operations such as link:$$http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ConcurrentMap.html#replace(K, V, V)$$[conditional replace] , link:$$http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ConcurrentMap.html#putIfAbsent(K, V)$$[putIfAbsent] , and link:$$http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ConcurrentMap.html#remove(java.lang.Object, java.lang.Object)$$[conditional remove] to its clients in order to guarantee data correctness. It even allows clients to operate against cache instances within JTA transactions, hence providing the necessary data consistency guarantees.

However, when it comes to link:$$http://community.jboss.org/wiki/HotRodProtocol$$[Hot Rod protocol] backed servers, clients do not yet have the ability to start remote transactions but they can call instead versioned operations to mimic the conditional methods provided by the embedded Infinispan cache instance API.  Let's look at a real example to understand how it works. 

===== Data Consistency Problem
Imagine you have two ATMs that connect using Hot Rod to a bank where an account's balance is stored.  Two closely followed operations to retrieve the latest balance could return 500 CHF (swiss francs) as shown below:
 
image::images/server_modules_6.png[]

Next a customer connects to the first ATM and requests 400 CHF to be retrieved.  Based on the last value read, the ATM could calculate what the new balance is, which is 100 CHF, and request a put with this new value. Let's imagine now that around the same time another customer connects to the ATM and requests 200 CHF to be retrieved.  Let's assume that the ATM thinks it has the latest balance and based on its calculations it sets the new balance to 300 CHF:
 
image::images/server_modules_7.png[]

Obviously, this would be wrong.  Two concurrent updates have resulted in an incorrect account balance.  The second update should not have been allowed since the balance the second ATM had was incorrect. Even if the ATM would have retrieved the balance before calculating the new balance, someone could have updated between the new balance being retrieved and the update. Before finding out how to solve this issue in a client-server scenario with Hot Rod, let's look at how this is solved when Infinispan clients run in peer-to-peer mode where clients and Infinispan live within the same JVM.

====== Embedded-mode Solution

If the ATM and the Infinispan instance storing the bank account lived in the same JVM, the ATM could use the link:$$http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/ConcurrentMap.html#replace(K, V, V)$$[conditional replace API] referred at the beginning of this article.  So, it could send the previous known value to verify whether it has changed since it was last read.  By doing so, the first operation could double check that the balance is still 500 CHF when it was to update to 100 CHF.  Now, when the second operation comes, the current balance would not be 500 CHF any more and hence the conditional replace call would fail, hence avoiding data consistency issues:
 
image::images/server_modules_8.png[]

====== Client-Server Solution
In theory, Hot Rod could use the same p2p solution but sending the previous value would be not practical.  In this example, the previous value is just an integer but the value could be a lot bigger and hence forcing clients to send it to the server would be rather wasteful.  Instead, Hot Rod offers versioned operations to deal with this situation.

Basically, together with each key/value pair, Hot Rod stores a version number which uniquely identifies each modification. So, using an operation called link:$$http://community.jboss.org/wiki/HotRodProtocol#getWithVersion_response$$[getVersioned or getWithVersion] , clients can retrieve not only the value associated with a key, but also the current version. So, if we look at the previous example once again, the ATMs could call getVersioned and get the balance's version: 
 
image::images/server_modules_9.png[]

When the ATMs wanted to modify the balance, instead of just calling put, they could call link:$$http://community.jboss.org/wiki/HotRodProtocol#removeIfUnmodified_request$$[replaceIfUnmodified] operation passing the latest version number of which the clients are aware of.  The operation will only succeed if the version passed matches the version in the server.  So, the first modification by the ATM would be allowed since the client passes 1 as version and the server side version for the balance is also 1.  On the other hand, the second ATM would not be able to make the modification because after the first ATMs modification the version would have been incremented to 2, and now the passed version (1) and the server side version (2) would not match: 
 
image::images/server_modules_10.png[]

[[sid-68355104]]

====  Interacting With Hot Rod Server From Within Same JVM
Normally, a Hot Rod server is accessed via a Hot Rod protocol client such as the Java Hot Rod client. However, there might be situations where not only do you want to access the Hot Rod server remotely, you might also want to access it locally from within the same JVM that the Hot Rod server is running. For example, you might have an Infinispan cache pushing changes <<_remote_cache_loader, via the RemoteCacheStore to a Hot Rod server>>, and if the cache goes down, you might want to access the data directly from the Hot Rod server itself. 

In this situations, we have to remember that the Hot Rod protocol specifies that keys and values are stored as byte arrays. This means that if the client code, using an existing Hot Rod client, stored Strings or Integers, or any other complex serializable or externalizable object, you won't be able to retrieve these objects straight from the cache that the Hot Rod server uses. 

To actually get the fully constructed objects that you're after, you're gonna need to take the byte arrays stored within the Hot Rod server and unmarshall them into something that you can use. In the future, this is something that might be done for you, as suggested in link:$$https://jira.jboss.org/browse/ISPN-706$$[ISPN-706] (superseded by link:$$https://issues.jboss.org/browse/ISPN-2281$$[ISPN-2281] ), but for the time being, clients wanting to access Hot Rod server data will have to do it themselves. 

Two different use cases need to be differentiated at this stage and to explain how to transform the Hot Rod server data into something usable, we'll assume that the clients are java clients:

===== Data Stored Directly Via A Hot Rod Client
The most common case is for a client to use a Hot Rod client library directly to store data in the Hot Rod server. In this case, assuming that the client used the existing Java Hot Rod client, the default marshaller used to marshall objects into byte arrays is the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/marshall/jboss/GenericJBossMarshaller.html$$[GenericJBossMarshaller] . So, if a user wants to read data from the Hot Rod server directly, it would need to execute something along the lines of:

[source,java]
----
import org.infinispan.marshall.jboss.GenericJBossMarshaller;
import org.infinispan.util.ByteArrayKey;
import org.infinispan.server.core.CacheValue;
...

// Create a new instance of the marshaller:
GenericJBossMarshaller marshaller = new GenericJBossMarshaller();
Object key = ...

// Take the cache key and convert into a byte array,
// and wrap it with an instance of ByteArrayKey
ByteArrayKey bytesKey = new ByteArrayKey(marshaller.objectToByteBuffer(key));

// Internally, Hot Rod stores values wrapped in a CacheValue, so retrieve it
CacheValue cacheValue = (CacheValue) cache.get(bytesKey);

// Take the data part which is byte array and unmarshall it to retrieve the value
Object value = marshaller.objectFromByteBuffer(cacheValue.data());

----

If you want to store data directly in the HotRod server, you'd have to execute something like this:

[source,java]
----
import org.infinispan.marshall.jboss.GenericJBossMarshaller;
import org.infinispan.util.ByteArrayKey;
import org.infinispan.server.core.CacheValue;
...

// Create a new instance of the marshaller:
GenericJBossMarshaller marshaller = new GenericJBossMarshaller();
Object key = ...
Object value = ...

// Take the cache key and convert into a byte array,
// and wrap it with an instance of ByteArrayKey
ByteArrayKey bytesKey = new ByteArrayKey(marshaller.objectToByteBuffer(key));

// Internally, Hot Rod stores values wrapped in a CacheValue, so create instance
// Remember that you need to give it a version number, so either:
// 1. Increment previous value's version
// 2. Or generate a new version number that minimises potential clash
//    with a concurrent update to the same key in the cluster
CacheValue cacheValue = new CacheValue(marshaller.objectToByteBuffer(value), 1)

// Finally, store it in the cache
cache.put(bytesKey, cacheValue);

----

===== Data Stored Via Remote Cache Store
Other times, Hot Rod server might be storing data coming from a link:$$https://docs.jboss.org/author/pages/viewpage.action?pageId=3737163$$[RemoteCacheStore] , rather than user code. In this case, there're a couple of differences to the code above. First of all, the marshaller is slightly different. Instead, the RemoteCacheStore uses the link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/marshall/VersionAwareMarshaller.html$$[VersionAwareMarshaller] which all it does is add Infinispan version information to the byte array generated. The second difference is that RemoteCacheStore stores internal cache entry classes, which apart from the value part, they contain other extra information. So, any code trying to read these directly from the Hot Rod server would need to take in account. For example, to read data from such Hot Rod server:

[source,java]
----
import org.infinispan.marshall.VersionAwareMarshaller;
import org.infinispan.util.ByteArrayKey;
import org.infinispan.server.core.CacheValue;
import org.infinispan.container.entries.CacheEntry;
...

// Create a new instance of the marshaller
VersionAwareMarshaller marshaller = new VersionAwareMarshaller();
Object key = ...

// Take the cache key and convert into a byte array,
// and wrap it with an instance of ByteArrayKey
ByteArrayKey bytesKey = new ByteArrayKey(marshaller.objectToByteBuffer(key));

// Internally, Hot Rod stores values wrapped in a CacheValue, so retrieve it
CacheValue cacheValue = (CacheValue) cache.get(bytesKey);

// However, in this case the data part of CacheValue does not contain directly
// the value Instead, it contains an instance of CacheEntry, so we need to
// unmarshall that and then get the actual value
CacheEntry cacheEntry = (CacheEntry)
   marshaller.objectFromByteBuffer(cacheValue.data());
Object value = cacheEntry.getValue();

----

And to actually write data back into the Hot Rod server directly:

[source,java]
----
import org.infinispan.marshall.VersionAwareMarshaller;
import org.infinispan.util.ByteArrayKey;
import org.infinispan.server.core.CacheValue;
import org.infinispan.container.entries.CacheEntry;
import org.infinispan.container.entries.InternalEntryFactory;
...

// Create a new instance of the marshaller:
VersionAwareMarshaller marshaller = new VersionAwareMarshaller();
Object key = ...
Object value = ...

// Take the cache key and convert into a byte array
ByteArrayKey bytesKey = new ByteArrayKey(marshaller.objectToByteBuffer(key));

// With the value to store, a new CacheEntry instance needs to be created:
CacheEntry cacheEntry = InternalEntryFactory.create(bytesKey, value, ...)

// Internally, Hot Rod stores values wrapped in a CacheValue, so create instance
// Remember that you need to give it a version number, so either:
// 1. Increment previous value's version
// 2. Or generate a new version number that minimises potential clash
//    with a concurrent update to the same key in the cluster
CacheValue cacheValue = new CacheValue(
   marshaller.objectToByteBuffer(cacheEntry), 1)

// Finally, store it in the cache
cache.put(bytesKey, cacheValue);

----

===== Multiple Tiers of Caches
A combination of the Hot Rod protocol and link:$$http://community.jboss.org/docs/DOC-14893?uniqueTitle=false#Remote_cache_loader$$[RemoteCacheLoader] opened the way for a set of new architectures in Infinispan, where layers of caches can exists and interact. This article takes a look at such a layered architecture. 

====== Sample architecture/near caching

image::images/client_server.png[]

The diagram above shows an Infinispan server cluster running 3 hotrod servers. This cluster is accessed remotely, through HotRod, by another infinispan cluster:  client cluster (upper part of the image). All the nodes in the server cluster are configured to run HotRod servers, so requests from remote loader are being balanced between them. The client cluster is configured with invalidation as cluster mode and a RemoteCacheLoader to access data stored in the server cluster. Application data is held on the server cluster which runs in DIST mode for scalability. 

In this deployment the client code, running in same address space with the client cluster,  holds all its data in the server cluster. Client cluster acts as an _near-cache_ for frequently accessed entries. 

====  Querying via the Java Hot Rod client
While previous Infinispan versions were already providing link:$$#_querying_infinispan$$[indexing and searching] of Java
entities to embedded clients, starting with Infinispan 6.0 and the introduction of the new
link:$$#_hot_rod_protocol_1_3$$[Hot Rod protocol version 1.3] we add support for remote, language neutral, querying.

This leap required two major changes:


* Since non-JVM clients cannot benefit from directly using link:$$http://lucene.apache.org/$$[Apache Lucene]'s Java
API, Infinispan defines its own new link:$$#_infinispan_s_query_dsl$$[query language], based on an internal DSL that is easily
implementable in all languages for which we currently have an implementation of the Hot Rod client.
* In order to enable indexing, the entities put in the cache by clients can no longer be opaque binary blobs understood
solely by the client. Their structure has to be known to both server and client, so a common way of
encoding structured data had to be adopted. Furthermore, allowing multi-language clients to access the data requires a
language and platform-neutral encoding. Google's link:$$http://code.google.com/p/protobuf/$$[Protocol Buffers] was
elected as an encoding format for both over-the-wire and storage due to its efficiency, robustness, good multi-language
support and support for schema evolution.


NOTE: As of 6.0, only the Java implementation of the Hot Rod client was upgraded to support querying. Clients for other
languages will follow soon.

===== Storing Protobuf encoded entities
Remote clients that want to be able to index and query their stored entities must do so using the Protobuf encoding
format. This is _key_ for the search capability to work. But it's also possible to store Protobuf entities just for
gaining the benefit of platform independence and not enable indexing if you do not need it.

Protobuf is all about structured data, so first thing you do to use it is define the structure of your data. This is
accomplished by declaring protocol buffer message types in .proto files, like in the following example. Protobuf is a
broad subject, we will not detail it here, so please consult the Protobuf
link:$$https://developers.google.com/protocol-buffers/docs/overview$$[Developer Guide] for an in-depth
explanation. It suffices to say for now that our example defines an entity (message type in protobuf speak) named _Book_,
placed in a package named _book_sample_. Our entity declares several fields of primitive types and a repeatable field (an
array basically) named _authors_. The _Author_ message instances are embedded in the _Book_ message instance.

.library.proto
[source,proto]
----
package book_sample;

message Book {
  required string title = 1;
  required string description = 2;
  required int32 publicationYear = 3; // no native Date type available in Protobuf

  repeated Author authors = 4;
}

message Author {
  required string name = 1;
  required string surname = 2;
}
----

There are a few important notes we need to make about Protobuf messages:

* nesting of messages is possible, but the resulting structure is strictly a tree, never a graph
* there is no concept of type inheritance
* collections are not supported but arrays can be easily emulated using repeated fields

Using Protobuf with the Java Hot Rod client is a two step process. First, the client must be configured to use a
dedicated marshaller, link:$$http://docs.jboss.org/infinispan/7.0/apidocs/org/infinispan/client/hotrod/marshall/ProtoStreamMarshaller.html$$[_ProtoStreamMarshaller_].
This marshaller uses the link:$$https://github.com/infinispan/protostream$$[_ProtoStream_] library to assist you in
encoding your objects. The second step is instructing _ProtoStream_ library on how to marshall your message types. The
following example highlights this process.

[source,java,numbered]
----
import org.infinispan.client.hotrod.configuration.ConfigurationBuilder;
import org.infinispan.client.hotrod.marshall.ProtoStreamMarshaller;
import org.infinispan.protostream.SerializationContext;
...

ConfigurationBuilder clientBuilder = new ConfigurationBuilder();
clientBuilder.addServer()
    .host(""127.0.0.1"").port(11234)
    .marshaller(new ProtoStreamMarshaller());

RemoteCacheManager remoteCacheManager = new RemoteCacheManager(clientBuilder.build());

SerializationContext srcCtx = ProtoStreamMarshaller.getSerializationContext(remoteCacheManager);

serCtx.registerProtofiles(""/library.proto"");
serCtx.registerMarshaller(Book.class, new BookMarshaller());
serCtx.registerMarshaller(Author.class, new AuthorMarshaller());

// Book and Author classes omitted for brevity
----

The interesting part in this sample is obtaining the _SerializationContext_ associated to the _RemoteCacheManager_ and
then instructing ProtoStream about the protobuf types we want to marshall. The _SerializationContext_ is provided by the
library for this purpose. The `SerializationContext.registerProtoFiles` method receives the name of one or more 
classpath resources that is expected to be a protobuf definition containing our type declarations.

NOTE: A _RemoteCacheManager_ has no _SerializationContext_ associated with it unless it was configured to use
a _ProtoStreamMarshaller_.

The next relevant part is the registration of per entity marshallers for our domain model types. They must be
provided by the user for each type or marshalling will fail. Writing marshallers is a simple process. The
_BookMarshaller_ example should get you started. The most important thing you need to consider is they need to be
stateless and threadsafe as a single instance of them is being used.

.BookMarshaller.java
[source,java]
----
import org.infinispan.protostream.MessageMarshaller;
...

public class BookMarshaller implements MessageMarshaller<Book> {

   @Override
   public String getTypeName() {
      return ""book_sample.Book"";
   }

   @Override
   public Class<? extends Book> getJavaClass() {
      return Book.class;
   }

   @Override
   public void writeTo(ProtoStreamWriter writer, Book book) throws IOException {
      writer.writeString(""title"", book.getTitle());
      writer.writeString(""description"", book.getDescription());
      writer.writeCollection(""authors"", book.getAuthors(), Author.class);
   }

   @Override
   public Book readFrom(ProtoStreamReader reader) throws IOException {
      String title = reader.readString(""title"");
      String description = reader.readString(""description"");
      int publicationYear = reader.readInt(""publicationYear"");
      Set<Author> authors = reader.readCollection(""authors"", new HashSet<Author>(), Author.class);
      return new Book(title, description, publicationYear, authors);
   }
}
----

Once you've followed these steps to setup your client you can start reading and writing Java objects to the remote cache
and the actual data stored in the cache will be protobuf encoded provided that marshallers were registered with the
remote client for all involved types (_Book_ and _Author_ in our example). Keeping your objects stored in protobuf
format has the benefit of being able to consume them with compatible clients written in different languages.

TODO Add reference to sample in C++ client user guide

===== Indexing of Protobuf encoded entries
After configuring the client as described in the previous section you can start configuring indexing for your caches on
the server side. Activating indexing and the various indexing specific configurations is identical to embedded mode and
is detailed in the link:$$#_configuration_7$$[Querying Infinispan] chapter.

There is however an extra configuration step involved. While in embedded mode the indexing metadata is obtained via Java
reflection by analyzing the presence of various Hibernate Search annotations on the entry's class, this is obviously not
possible if the entry is protobuf encoded. The server needs to extract the relevant metadata from the same descriptor
(.proto file) as the client. The descriptor is currently supplied to the server by remotely invoking the
_ProtobufMetadataManager_ MBean via JMX. The _ProtobufMetadataManager_ is a cluster-wide replicated repository of
protobuf descriptors. For each running cache manager a separate _ProtobufMetadataManager_ MBean instance exists. Its
ObjectName follows this pattern:

 <jmx domain>:type=RemoteQuery,name=<cache manager name>,component=ProtobufMetadataManager

The method relevant for registering the protobuf descriptor file has the signature:

 void registerProtofile(String names[]. String contents[])

A detailed example for all the described steps can be seen in the Java Hot Rod client test suite, particularly in
link:$$https://github.com/infinispan/infinispan/blob/master/client/hotrod-client/src/test/java/org/infinispan/client/hotrod/query/HotRodQueryTest.java$$[HotRodQueryTest]

NOTE: Once indexing is enabled for a cache all fields of Protobuf encoded entries are going to be indexed. Future
versions will allow you to select which fields to index (see link:$$https://issues.jboss.org/browse/ISPN-3718$$[ISPN-3718]).

===== A remote query example
You've managed to configure both client and server to talk protobuf and you've enabled indexing. Let's put some data in
the cache and try to search for it then!

[source,java]
----
import org.infinispan.client.hotrod.*;
import org.infinispan.query.dsl.*;
...

RemoteCacheManager remoteCacheManager = ...;
RemoteCache<Integer, Book> remoteCache = remoteCacheManager.getCache();

Book book1 = new Book();
book1.setTitle(""Hibernate in Action"");
remoteCache.put(1, book1);

Book book2 = new Book();
book2.setTile(""Infinispan Data Grid Platform"");
remoteCache.put(2, book2);

QueryFactory qf = Search.getQueryFactory(remoteCache);
Query query = qf.from(Book.class)
            .having(""title"").like(""%Infinispan%"").toBuilder()
            .build();

List<Book> list = query.list(); // Voila! We have our book back from the cache!
----

The key part of creating a query is obtaining the _QueryFactory_ for the remote cache using the
_org.infinispan.client.hotrod.Search.getQueryFactory()_ method. Once you have this creating the query is similar to
embedded mode which is covered in link:$$#_infinispan_s_query_dsl$$[this] section.

===== Running in Compatibility Mode
TODO

",12210,False,2200.3979829322984,median
"// This file is auto-generated. Do not edit!

#include ""precomp.hpp""
#include ""cvconfig.h""
#include ""opencl_kernels_objdetect.hpp""

#ifdef HAVE_OPENCL

namespace cv
{
namespace ocl
{
namespace objdetect
{

static const char* const moduleName = ""objdetect"";

struct cv::ocl::internal::ProgramEntry cascadedetect_oclsrc={moduleName, ""cascadedetect"",
""#ifdef HAAR\\n""
""typedef struct __attribute__((aligned(4))) OptHaarFeature\\n""
""{\\n""
""int4 ofs[3] __attribute__((aligned (4)));\\n""
""float4 weight __attribute__((aligned (4)));\\n""
""}\\n""
""OptHaarFeature;\\n""
""#endif\\n""
""#ifdef LBP\\n""
""typedef struct __attribute__((aligned(4))) OptLBPFeature\\n""
""{\\n""
""int16 ofs __attribute__((aligned (4)));\\n""
""}\\n""
""OptLBPFeature;\\n""
""#endif\\n""
""typedef struct __attribute__((aligned(4))) Stump\\n""
""{\\n""
""float4 st __attribute__((aligned (4)));\\n""
""}\\n""
""Stump;\\n""
""typedef struct __attribute__((aligned(4))) Node\\n""
""{\\n""
""int4 n __attribute__((aligned (4)));\\n""
""}\\n""
""Node;\\n""
""typedef struct __attribute__((aligned (4))) Stage\\n""
""{\\n""
""int first __attribute__((aligned (4)));\\n""
""int ntrees __attribute__((aligned (4)));\\n""
""float threshold __attribute__((aligned (4)));\\n""
""}\\n""
""Stage;\\n""
""typedef struct __attribute__((aligned (4))) ScaleData\\n""
""{\\n""
""float scale __attribute__((aligned (4)));\\n""
""int szi_width __attribute__((aligned (4)));\\n""
""int szi_height __attribute__((aligned (4)));\\n""
""int layer_ofs __attribute__((aligned (4)));\\n""
""int ystep __attribute__((aligned (4)));\\n""
""}\\n""
""ScaleData;\\n""
""#ifndef SUM_BUF_SIZE\\n""
""#define SUM_BUF_SIZE 0\\n""
""#endif\\n""
""#ifndef NODE_COUNT\\n""
""#define NODE_COUNT 1\\n""
""#endif\\n""
""#ifdef HAAR\\n""
""__kernel __attribute__((reqd_work_group_size(LOCAL_SIZE_X,LOCAL_SIZE_Y,1)))\\n""
""void runHaarClassifier(\\n""
""int nscales, __global const ScaleData* scaleData,\\n""
""__global const int* sum,\\n""
""int _sumstep, int sumoffset,\\n""
""__global const OptHaarFeature* optfeatures,\\n""
""__global const Stage* stages,\\n""
""__global const Node* nodes,\\n""
""__global const float* leaves0,\\n""
""volatile __global int* facepos,\\n""
""int4 normrect, int sqofs, int2 windowsize)\\n""
""{\\n""
""int lx = get_local_id(0);\\n""
""int ly = get_local_id(1);\\n""
""int groupIdx = get_group_id(0);\\n""
""int i, ngroups = get_global_size(0)/LOCAL_SIZE_X;\\n""
""int scaleIdx, tileIdx, stageIdx;\\n""
""int sumstep = (int)(_sumstep/sizeof(int));\\n""
""int4 nofs0 = (int4)(mad24(normrect.y, sumstep, normrect.x),\\n""
""mad24(normrect.y, sumstep, normrect.x + normrect.z),\\n""
""mad24(normrect.y + normrect.w, sumstep, normrect.x),\\n""
""mad24(normrect.y + normrect.w, sumstep, normrect.x + normrect.z));\\n""
""int normarea = normrect.z * normrect.w;\\n""
""float invarea = 1.f/normarea;\\n""
""int lidx = ly*LOCAL_SIZE_X + lx;\\n""
""#if SUM_BUF_SIZE > 0\\n""
""int4 nofs = (int4)(mad24(normrect.y, SUM_BUF_STEP, normrect.x),\\n""
""mad24(normrect.y, SUM_BUF_STEP, normrect.x + normrect.z),\\n""
""mad24(normrect.y + normrect.w, SUM_BUF_STEP, normrect.x),\\n""
""mad24(normrect.y + normrect.w, SUM_BUF_STEP, normrect.x + normrect.z));\\n""
""#else\\n""
""int4 nofs = nofs0;\\n""
""#endif\\n""
""#define LOCAL_SIZE (LOCAL_SIZE_X*LOCAL_SIZE_Y)\\n""
""__local int lstore[SUM_BUF_SIZE + LOCAL_SIZE*5/2+1];\\n""
""#if SUM_BUF_SIZE > 0\\n""
""__local int* ibuf = lstore;\\n""
""__local int* lcount = ibuf + SUM_BUF_SIZE;\\n""
""#else\\n""
""__local int* lcount = lstore;\\n""
""#endif\\n""
""__local float* lnf = (__local float*)(lcount + 1);\\n""
""__local float* lpartsum = lnf + LOCAL_SIZE;\\n""
""__local short* lbuf = (__local short*)(lpartsum + LOCAL_SIZE);\\n""
""for( scaleIdx = nscales-1; scaleIdx >= 0; scaleIdx-- )\\n""
""{\\n""
""__global const ScaleData* s = scaleData + scaleIdx;\\n""
""int ystep = s->ystep;\\n""
""int2 worksize = (int2)(max(s->szi_width - windowsize.x, 0), max(s->szi_height - windowsize.y, 0));\\n""
""int2 ntiles = (int2)((worksize.x + LOCAL_SIZE_X-1)/LOCAL_SIZE_X,\\n""
""(worksize.y + LOCAL_SIZE_Y-1)/LOCAL_SIZE_Y);\\n""
""int totalTiles = ntiles.x*ntiles.y;\\n""
""for( tileIdx = groupIdx; tileIdx < totalTiles; tileIdx += ngroups )\\n""
""{\\n""
""int ix0 = (tileIdx % ntiles.x)*LOCAL_SIZE_X;\\n""
""int iy0 = (tileIdx / ntiles.x)*LOCAL_SIZE_Y;\\n""
""int ix = lx, iy = ly;\\n""
""__global const int* psum0 = sum + mad24(iy0, sumstep, ix0) + s->layer_ofs;\\n""
""__global const int* psum1 = psum0 + mad24(iy, sumstep, ix);\\n""
""if( ix0 >= worksize.x || iy0 >= worksize.y )\\n""
""continue;\\n""
""#if SUM_BUF_SIZE > 0\\n""
""for( i = lidx*4; i < SUM_BUF_SIZE; i += LOCAL_SIZE_X*LOCAL_SIZE_Y*4 )\\n""
""{\\n""
""int dy = i/SUM_BUF_STEP, dx = i - dy*SUM_BUF_STEP;\\n""
""vstore4(vload4(0, psum0 + mad24(dy, sumstep, dx)), 0, ibuf+i);\\n""
""}\\n""
""#endif\\n""
""if( lidx == 0 )\\n""
""lcount[0] = 0;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if( ix0 + ix < worksize.x && iy0 + iy < worksize.y )\\n""
""{\\n""
""#if NODE_COUNT==1\\n""
""__global const Stump* stump = (__global const Stump*)nodes;\\n""
""#else\\n""
""__global const Node* node = nodes;\\n""
""__global const float* leaves = leaves0;\\n""
""#endif\\n""
""#if SUM_BUF_SIZE > 0\\n""
""__local const int* psum = ibuf + mad24(iy, SUM_BUF_STEP, ix);\\n""
""#else\\n""
""__global const int* psum = psum1;\\n""
""#endif\\n""
""__global const int* psqsum = (__global const int*)(psum1 + sqofs);\\n""
""float sval = (psum[nofs.x] - psum[nofs.y] - psum[nofs.z] + psum[nofs.w])*invarea;\\n""
""float sqval = (psqsum[nofs0.x] - psqsum[nofs0.y] - psqsum[nofs0.z] + psqsum[nofs0.w])*invarea;\\n""
""float nf = (float)normarea * sqrt(max(sqval - sval * sval, 0.f));\\n""
""nf = nf > 0 ? nf : 1.f;\\n""
""for( stageIdx = 0; stageIdx < SPLIT_STAGE; stageIdx++ )\\n""
""{\\n""
""int ntrees = stages[stageIdx].ntrees;\\n""
""float s = 0.f;\\n""
""#if NODE_COUNT==1\\n""
""for( i = 0; i < ntrees; i++ )\\n""
""{\\n""
""float4 st = stump[i].st;\\n""
""__global const OptHaarFeature* f = optfeatures + as_int(st.x);\\n""
""float4 weight = f->weight;\\n""
""int4 ofs = f->ofs[0];\\n""
""sval = (psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w])*weight.x;\\n""
""ofs = f->ofs[1];\\n""
""sval = mad((float)(psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w]), weight.y, sval);\\n""
""if( weight.z > 0 )\\n""
""{\\n""
""ofs = f->ofs[2];\\n""
""sval = mad((float)(psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w]), weight.z, sval);\\n""
""}\\n""
""s += (sval < st.y*nf) ? st.z : st.w;\\n""
""}\\n""
""stump += ntrees;\\n""
""#else\\n""
""for( i = 0; i < ntrees; i++, node += NODE_COUNT, leaves += NODE_COUNT+1 )\\n""
""{\\n""
""int idx = 0;\\n""
""do\\n""
""{\\n""
""int4 n = node[idx].n;\\n""
""__global const OptHaarFeature* f = optfeatures + n.x;\\n""
""float4 weight = f->weight;\\n""
""int4 ofs = f->ofs[0];\\n""
""sval = (psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w])*weight.x;\\n""
""ofs = f->ofs[1];\\n""
""sval = mad((float)(psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w]), weight.y, sval);\\n""
""if( weight.z > 0 )\\n""
""{\\n""
""ofs = f->ofs[2];\\n""
""sval = mad((float)(psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w]), weight.z, sval);\\n""
""}\\n""
""idx = (sval < as_float(n.y)*nf) ? n.z : n.w;\\n""
""}\\n""
""while(idx > 0);\\n""
""s += leaves[-idx];\\n""
""}\\n""
""#endif\\n""
""if( s < stages[stageIdx].threshold )\\n""
""break;\\n""
""}\\n""
""if( stageIdx == SPLIT_STAGE && (ystep == 1 || ((ix | iy) & 1) == 0) )\\n""
""{\\n""
""int count = atomic_inc(lcount);\\n""
""lbuf[count] = (int)(ix | (iy << 8));\\n""
""lnf[count] = nf;\\n""
""}\\n""
""}\\n""
""for( stageIdx = SPLIT_STAGE; stageIdx < N_STAGES; stageIdx++ )\\n""
""{\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""int nrects = lcount[0];\\n""
""if( nrects == 0 )\\n""
""break;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if( lidx == 0 )\\n""
""lcount[0] = 0;\\n""
""{\\n""
""#if NODE_COUNT == 1\\n""
""__global const Stump* stump = (__global const Stump*)nodes + stages[stageIdx].first;\\n""
""#else\\n""
""__global const Node* node = nodes + stages[stageIdx].first*NODE_COUNT;\\n""
""__global const float* leaves = leaves0 + stages[stageIdx].first*(NODE_COUNT+1);\\n""
""#endif\\n""
""int nparts = LOCAL_SIZE / nrects;\\n""
""int ntrees = stages[stageIdx].ntrees;\\n""
""int ntrees_p = (ntrees + nparts - 1)/nparts;\\n""
""int nr = lidx / nparts;\\n""
""int partidx = -1, idxval = 0;\\n""
""float partsum = 0.f, nf = 0.f;\\n""
""if( nr < nrects )\\n""
""{\\n""
""partidx = lidx % nparts;\\n""
""idxval = lbuf[nr];\\n""
""nf = lnf[nr];\\n""
""{\\n""
""int ntrees0 = ntrees_p*partidx;\\n""
""int ntrees1 = min(ntrees0 + ntrees_p, ntrees);\\n""
""int ix1 = idxval & 255, iy1 = idxval >> 8;\\n""
""#if SUM_BUF_SIZE > 0\\n""
""__local const int* psum = ibuf + mad24(iy1, SUM_BUF_STEP, ix1);\\n""
""#else\\n""
""__global const int* psum = psum0 + mad24(iy1, sumstep, ix1);\\n""
""#endif\\n""
""#if NODE_COUNT == 1\\n""
""for( i = ntrees0; i < ntrees1; i++ )\\n""
""{\\n""
""float4 st = stump[i].st;\\n""
""__global const OptHaarFeature* f = optfeatures + as_int(st.x);\\n""
""float4 weight = f->weight;\\n""
""int4 ofs = f->ofs[0];\\n""
""float sval = (psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w])*weight.x;\\n""
""ofs = f->ofs[1];\\n""
""sval = mad((float)(psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w]), weight.y, sval);\\n""
""if( fabs(weight.z) > 0 )\\n""
""{\\n""
""ofs = f->ofs[2];\\n""
""sval = mad((float)(psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w]), weight.z, sval);\\n""
""}\\n""
""partsum += (sval < st.y*nf) ? st.z : st.w;\\n""
""}\\n""
""#else\\n""
""for( i = ntrees0; i < ntrees1; i++ )\\n""
""{\\n""
""int idx = 0;\\n""
""do\\n""
""{\\n""
""int4 n = node[i*2 + idx].n;\\n""
""__global const OptHaarFeature* f = optfeatures + n.x;\\n""
""float4 weight = f->weight;\\n""
""int4 ofs = f->ofs[0];\\n""
""float sval = (psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w])*weight.x;\\n""
""ofs = f->ofs[1];\\n""
""sval = mad((float)(psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w]), weight.y, sval);\\n""
""if( weight.z > 0 )\\n""
""{\\n""
""ofs = f->ofs[2];\\n""
""sval = mad((float)(psum[ofs.x] - psum[ofs.y] - psum[ofs.z] + psum[ofs.w]), weight.z, sval);\\n""
""}\\n""
""idx = (sval < as_float(n.y)*nf) ? n.z : n.w;\\n""
""}\\n""
""while(idx > 0);\\n""
""partsum += leaves[i*3-idx];\\n""
""}\\n""
""#endif\\n""
""}\\n""
""}\\n""
""lpartsum[lidx] = partsum;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if( partidx == 0 )\\n""
""{\\n""
""float s = lpartsum[nr*nparts];\\n""
""for( i = 1; i < nparts; i++ )\\n""
""s += lpartsum[i + nr*nparts];\\n""
""if( s >= stages[stageIdx].threshold )\\n""
""{\\n""
""int count = atomic_inc(lcount);\\n""
""lbuf[count] = idxval;\\n""
""lnf[count] = nf;\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if( stageIdx == N_STAGES )\\n""
""{\\n""
""int nrects = lcount[0];\\n""
""if( lidx < nrects )\\n""
""{\\n""
""int nfaces = atomic_inc(facepos);\\n""
""if( nfaces < MAX_FACES )\\n""
""{\\n""
""volatile __global int* face = facepos + 1 + nfaces*3;\\n""
""int val = lbuf[lidx];\\n""
""face[0] = scaleIdx;\\n""
""face[1] = ix0 + (val & 255);\\n""
""face[2] = iy0 + (val >> 8);\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""#endif\\n""
""#ifdef LBP\\n""
""#undef CALC_SUM_OFS_\\n""
""#define CALC_SUM_OFS_(p0, p1, p2, p3, ptr) \\\\\\n""
""((ptr)[p0] - (ptr)[p1] - (ptr)[p2] + (ptr)[p3])\\n""
""__kernel void runLBPClassifierStumpSimple(\\n""
""int nscales, __global const ScaleData* scaleData,\\n""
""__global const int* sum,\\n""
""int _sumstep, int sumoffset,\\n""
""__global const OptLBPFeature* optfeatures,\\n""
""__global const Stage* stages,\\n""
""__global const Stump* stumps,\\n""
""__global const int* bitsets,\\n""
""int bitsetSize,\\n""
""volatile __global int* facepos,\\n""
""int2 windowsize)\\n""
""{\\n""
""int lx = get_local_id(0);\\n""
""int ly = get_local_id(1);\\n""
""int local_size_x = get_local_size(0);\\n""
""int local_size_y = get_local_size(1);\\n""
""int groupIdx = get_group_id(1)*get_num_groups(0) + get_group_id(0);\\n""
""int ngroups = get_num_groups(0)*get_num_groups(1);\\n""
""int scaleIdx, tileIdx, stageIdx;\\n""
""int sumstep = (int)(_sumstep/sizeof(int));\\n""
""for( scaleIdx = nscales-1; scaleIdx >= 0; scaleIdx-- )\\n""
""{\\n""
""__global const ScaleData* s = scaleData + scaleIdx;\\n""
""int ystep = s->ystep;\\n""
""int2 worksize = (int2)(max(s->szi_width - windowsize.x, 0), max(s->szi_height - windowsize.y, 0));\\n""
""int2 ntiles = (int2)((worksize.x/ystep + local_size_x-1)/local_size_x,\\n""
""(worksize.y/ystep + local_size_y-1)/local_size_y);\\n""
""int totalTiles = ntiles.x*ntiles.y;\\n""
""for( tileIdx = groupIdx; tileIdx < totalTiles; tileIdx += ngroups )\\n""
""{\\n""
""int iy = mad24((tileIdx / ntiles.x), local_size_y, ly) * ystep;\\n""
""int ix = mad24((tileIdx % ntiles.x), local_size_x, lx) * ystep;\\n""
""if( ix < worksize.x && iy < worksize.y )\\n""
""{\\n""
""__global const int* p = sum + mad24(iy, sumstep, ix) + s->layer_ofs;\\n""
""__global const Stump* stump = stumps;\\n""
""__global const int* bitset = bitsets;\\n""
""for( stageIdx = 0; stageIdx < N_STAGES; stageIdx++ )\\n""
""{\\n""
""int i, ntrees = stages[stageIdx].ntrees;\\n""
""float s = 0.f;\\n""
""for( i = 0; i < ntrees; i++, stump++, bitset += bitsetSize )\\n""
""{\\n""
""float4 st = stump->st;\\n""
""__global const OptLBPFeature* f = optfeatures + as_int(st.x);\\n""
""int16 ofs = f->ofs;\\n""
""int cval = CALC_SUM_OFS_( ofs.s5, ofs.s6, ofs.s9, ofs.sa, p );\\n""
""int mask, idx = (CALC_SUM_OFS_( ofs.s0, ofs.s1, ofs.s4, ofs.s5, p ) >= cval ? 4 : 0);\\n""
""idx |= (CALC_SUM_OFS_( ofs.s1, ofs.s2, ofs.s5, ofs.s6, p ) >= cval ? 2 : 0);\\n""
""idx |= (CALC_SUM_OFS_( ofs.s2, ofs.s3, ofs.s6, ofs.s7, p ) >= cval ? 1 : 0);\\n""
""mask = (CALC_SUM_OFS_( ofs.s6, ofs.s7, ofs.sa, ofs.sb, p ) >= cval ? 16 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.sa, ofs.sb, ofs.se, ofs.sf, p ) >= cval ? 8 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s9, ofs.sa, ofs.sd, ofs.se, p ) >= cval ? 4 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s8, ofs.s9, ofs.sc, ofs.sd, p ) >= cval ? 2 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s4, ofs.s5, ofs.s8, ofs.s9, p ) >= cval ? 1 : 0);\\n""
""s += (bitset[idx] & (1 << mask)) ? st.z : st.w;\\n""
""}\\n""
""if( s < stages[stageIdx].threshold )\\n""
""break;\\n""
""}\\n""
""if( stageIdx == N_STAGES )\\n""
""{\\n""
""int nfaces = atomic_inc(facepos);\\n""
""if( nfaces < MAX_FACES )\\n""
""{\\n""
""volatile __global int* face = facepos + 1 + nfaces*3;\\n""
""face[0] = scaleIdx;\\n""
""face[1] = ix;\\n""
""face[2] = iy;\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""__kernel __attribute__((reqd_work_group_size(LOCAL_SIZE_X,LOCAL_SIZE_Y,1)))\\n""
""void runLBPClassifierStump(\\n""
""int nscales, __global const ScaleData* scaleData,\\n""
""__global const int* sum,\\n""
""int _sumstep, int sumoffset,\\n""
""__global const OptLBPFeature* optfeatures,\\n""
""__global const Stage* stages,\\n""
""__global const Stump* stumps,\\n""
""__global const int* bitsets,\\n""
""int bitsetSize,\\n""
""volatile __global int* facepos,\\n""
""int2 windowsize)\\n""
""{\\n""
""int lx = get_local_id(0);\\n""
""int ly = get_local_id(1);\\n""
""int groupIdx = get_group_id(0);\\n""
""int i, ngroups = get_global_size(0)/LOCAL_SIZE_X;\\n""
""int scaleIdx, tileIdx, stageIdx;\\n""
""int sumstep = (int)(_sumstep/sizeof(int));\\n""
""int lidx = ly*LOCAL_SIZE_X + lx;\\n""
""#define LOCAL_SIZE (LOCAL_SIZE_X*LOCAL_SIZE_Y)\\n""
""__local int lstore[SUM_BUF_SIZE + LOCAL_SIZE*3/2+1];\\n""
""#if SUM_BUF_SIZE > 0\\n""
""__local int* ibuf = lstore;\\n""
""__local int* lcount = ibuf + SUM_BUF_SIZE;\\n""
""#else\\n""
""__local int* lcount = lstore;\\n""
""#endif\\n""
""__local float* lpartsum = (__local float*)(lcount + 1);\\n""
""__local short* lbuf = (__local short*)(lpartsum + LOCAL_SIZE);\\n""
""for( scaleIdx = nscales-1; scaleIdx >= 0; scaleIdx-- )\\n""
""{\\n""
""__global const ScaleData* s = scaleData + scaleIdx;\\n""
""int ystep = s->ystep;\\n""
""int2 worksize = (int2)(max(s->szi_width - windowsize.x, 0), max(s->szi_height - windowsize.y, 0));\\n""
""int2 ntiles = (int2)((worksize.x + LOCAL_SIZE_X-1)/LOCAL_SIZE_X,\\n""
""(worksize.y + LOCAL_SIZE_Y-1)/LOCAL_SIZE_Y);\\n""
""int totalTiles = ntiles.x*ntiles.y;\\n""
""for( tileIdx = groupIdx; tileIdx < totalTiles; tileIdx += ngroups )\\n""
""{\\n""
""int ix0 = (tileIdx % ntiles.x)*LOCAL_SIZE_X;\\n""
""int iy0 = (tileIdx / ntiles.x)*LOCAL_SIZE_Y;\\n""
""int ix = lx, iy = ly;\\n""
""__global const int* psum0 = sum + mad24(iy0, sumstep, ix0) + s->layer_ofs;\\n""
""if( ix0 >= worksize.x || iy0 >= worksize.y )\\n""
""continue;\\n""
""#if SUM_BUF_SIZE > 0\\n""
""for( i = lidx*4; i < SUM_BUF_SIZE; i += LOCAL_SIZE_X*LOCAL_SIZE_Y*4 )\\n""
""{\\n""
""int dy = i/SUM_BUF_STEP, dx = i - dy*SUM_BUF_STEP;\\n""
""vstore4(vload4(0, psum0 + mad24(dy, sumstep, dx)), 0, ibuf+i);\\n""
""}\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""#endif\\n""
""if( lidx == 0 )\\n""
""lcount[0] = 0;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if( ix0 + ix < worksize.x && iy0 + iy < worksize.y )\\n""
""{\\n""
""__global const Stump* stump = stumps;\\n""
""__global const int* bitset = bitsets;\\n""
""#if SUM_BUF_SIZE > 0\\n""
""__local const int* p = ibuf + mad24(iy, SUM_BUF_STEP, ix);\\n""
""#else\\n""
""__global const int* p = psum0 + mad24(iy, sumstep, ix);\\n""
""#endif\\n""
""for( stageIdx = 0; stageIdx < SPLIT_STAGE; stageIdx++ )\\n""
""{\\n""
""int ntrees = stages[stageIdx].ntrees;\\n""
""float s = 0.f;\\n""
""for( i = 0; i < ntrees; i++, stump++, bitset += bitsetSize )\\n""
""{\\n""
""float4 st = stump->st;\\n""
""__global const OptLBPFeature* f = optfeatures + as_int(st.x);\\n""
""int16 ofs = f->ofs;\\n""
""int cval = CALC_SUM_OFS_( ofs.s5, ofs.s6, ofs.s9, ofs.sa, p );\\n""
""int mask, idx = (CALC_SUM_OFS_( ofs.s0, ofs.s1, ofs.s4, ofs.s5, p ) >= cval ? 4 : 0);\\n""
""idx |= (CALC_SUM_OFS_( ofs.s1, ofs.s2, ofs.s5, ofs.s6, p ) >= cval ? 2 : 0);\\n""
""idx |= (CALC_SUM_OFS_( ofs.s2, ofs.s3, ofs.s6, ofs.s7, p ) >= cval ? 1 : 0);\\n""
""mask = (CALC_SUM_OFS_( ofs.s6, ofs.s7, ofs.sa, ofs.sb, p ) >= cval ? 16 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.sa, ofs.sb, ofs.se, ofs.sf, p ) >= cval ? 8 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s9, ofs.sa, ofs.sd, ofs.se, p ) >= cval ? 4 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s8, ofs.s9, ofs.sc, ofs.sd, p ) >= cval ? 2 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s4, ofs.s5, ofs.s8, ofs.s9, p ) >= cval ? 1 : 0);\\n""
""s += (bitset[idx] & (1 << mask)) ? st.z : st.w;\\n""
""}\\n""
""if( s < stages[stageIdx].threshold )\\n""
""break;\\n""
""}\\n""
""if( stageIdx == SPLIT_STAGE && (ystep == 1 || ((ix | iy) & 1) == 0) )\\n""
""{\\n""
""int count = atomic_inc(lcount);\\n""
""lbuf[count] = (int)(ix | (iy << 8));\\n""
""}\\n""
""}\\n""
""for( stageIdx = SPLIT_STAGE; stageIdx < N_STAGES; stageIdx++ )\\n""
""{\\n""
""int nrects = lcount[0];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if( nrects == 0 )\\n""
""break;\\n""
""if( lidx == 0 )\\n""
""lcount[0] = 0;\\n""
""{\\n""
""__global const Stump* stump = stumps + stages[stageIdx].first;\\n""
""__global const int* bitset = bitsets + stages[stageIdx].first*bitsetSize;\\n""
""int nparts = LOCAL_SIZE / nrects;\\n""
""int ntrees = stages[stageIdx].ntrees;\\n""
""int ntrees_p = (ntrees + nparts - 1)/nparts;\\n""
""int nr = lidx / nparts;\\n""
""int partidx = -1, idxval = 0;\\n""
""float partsum = 0.f, nf = 0.f;\\n""
""if( nr < nrects )\\n""
""{\\n""
""partidx = lidx % nparts;\\n""
""idxval = lbuf[nr];\\n""
""{\\n""
""int ntrees0 = ntrees_p*partidx;\\n""
""int ntrees1 = min(ntrees0 + ntrees_p, ntrees);\\n""
""int ix1 = idxval & 255, iy1 = idxval >> 8;\\n""
""#if SUM_BUF_SIZE > 0\\n""
""__local const int* p = ibuf + mad24(iy1, SUM_BUF_STEP, ix1);\\n""
""#else\\n""
""__global const int* p = psum0 + mad24(iy1, sumstep, ix1);\\n""
""#endif\\n""
""for( i = ntrees0; i < ntrees1; i++ )\\n""
""{\\n""
""float4 st = stump[i].st;\\n""
""__global const OptLBPFeature* f = optfeatures + as_int(st.x);\\n""
""int16 ofs = f->ofs;\\n""
""#define CALC_SUM_OFS_(p0, p1, p2, p3, ptr) \\\\\\n""
""((ptr)[p0] - (ptr)[p1] - (ptr)[p2] + (ptr)[p3])\\n""
""int cval = CALC_SUM_OFS_( ofs.s5, ofs.s6, ofs.s9, ofs.sa, p );\\n""
""int mask, idx = (CALC_SUM_OFS_( ofs.s0, ofs.s1, ofs.s4, ofs.s5, p ) >= cval ? 4 : 0);\\n""
""idx |= (CALC_SUM_OFS_( ofs.s1, ofs.s2, ofs.s5, ofs.s6, p ) >= cval ? 2 : 0);\\n""
""idx |= (CALC_SUM_OFS_( ofs.s2, ofs.s3, ofs.s6, ofs.s7, p ) >= cval ? 1 : 0);\\n""
""mask = (CALC_SUM_OFS_( ofs.s6, ofs.s7, ofs.sa, ofs.sb, p ) >= cval ? 16 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.sa, ofs.sb, ofs.se, ofs.sf, p ) >= cval ? 8 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s9, ofs.sa, ofs.sd, ofs.se, p ) >= cval ? 4 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s8, ofs.s9, ofs.sc, ofs.sd, p ) >= cval ? 2 : 0);\\n""
""mask |= (CALC_SUM_OFS_( ofs.s4, ofs.s5, ofs.s8, ofs.s9, p ) >= cval ? 1 : 0);\\n""
""partsum += (bitset[i*bitsetSize + idx] & (1 << mask)) ? st.z : st.w;\\n""
""}\\n""
""}\\n""
""}\\n""
""lpartsum[lidx] = partsum;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if( partidx == 0 )\\n""
""{\\n""
""float s = lpartsum[nr*nparts];\\n""
""for( i = 1; i < nparts; i++ )\\n""
""s += lpartsum[i + nr*nparts];\\n""
""if( s >= stages[stageIdx].threshold )\\n""
""{\\n""
""int count = atomic_inc(lcount);\\n""
""lbuf[count] = idxval;\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if( stageIdx == N_STAGES )\\n""
""{\\n""
""int nrects = lcount[0];\\n""
""if( lidx < nrects )\\n""
""{\\n""
""int nfaces = atomic_inc(facepos);\\n""
""if( nfaces < MAX_FACES )\\n""
""{\\n""
""volatile __global int* face = facepos + 1 + nfaces*3;\\n""
""int val = lbuf[lidx];\\n""
""face[0] = scaleIdx;\\n""
""face[1] = ix0 + (val & 255);\\n""
""face[2] = iy0 + (val >> 8);\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""}\\n""
""#endif\\n""
, ""91af1bca5e8f46e8426e0f3a1eb8d1f2"", NULL};
struct cv::ocl::internal::ProgramEntry objdetect_hog_oclsrc={moduleName, ""objdetect_hog"",
""#define CELL_WIDTH 8\\n""
""#define CELL_HEIGHT 8\\n""
""#define CELLS_PER_BLOCK_X 2\\n""
""#define CELLS_PER_BLOCK_Y 2\\n""
""#define NTHREADS 256\\n""
""#define CV_PI_F M_PI_F\\n""
""#ifdef INTEL_DEVICE\\n""
""#define QANGLE_TYPE     int\\n""
""#define QANGLE_TYPE2    int2\\n""
""#else\\n""
""#define QANGLE_TYPE     uchar\\n""
""#define QANGLE_TYPE2    uchar2\\n""
""#endif\\n""
""__kernel void compute_hists_lut_kernel(\\n""
""const int cblock_stride_x, const int cblock_stride_y,\\n""
""const int cnbins, const int cblock_hist_size, const int img_block_width,\\n""
""const int blocks_in_group, const int blocks_total,\\n""
""const int grad_quadstep, const int qangle_step,\\n""
""__global const float* grad, __global const QANGLE_TYPE* qangle,\\n""
""__global const float* gauss_w_lut,\\n""
""__global float* block_hists, __local float* smem)\\n""
""{\\n""
""const int lx = get_local_id(0);\\n""
""const int lp = lx / 24; \\n""
""const int gid = get_group_id(0) * blocks_in_group + lp;\\n""
""const int gidY = gid / img_block_width;\\n""
""const int gidX = gid - gidY * img_block_width;\\n""
""const int lidX = lx - lp * 24;\\n""
""const int lidY = get_local_id(1);\\n""
""const int cell_x = lidX / 12;\\n""
""const int cell_y = lidY;\\n""
""const int cell_thread_x = lidX - cell_x * 12;\\n""
""__local float* hists = smem + lp * cnbins * (CELLS_PER_BLOCK_X *\\n""
""CELLS_PER_BLOCK_Y * 12 + CELLS_PER_BLOCK_X * CELLS_PER_BLOCK_Y);\\n""
""__local float* final_hist = hists + cnbins *\\n""
""(CELLS_PER_BLOCK_X * CELLS_PER_BLOCK_Y * 12);\\n""
""const int offset_x = gidX * cblock_stride_x + (cell_x << 2) + cell_thread_x;\\n""
""const int offset_y = gidY * cblock_stride_y + (cell_y << 2);\\n""
""__global const float* grad_ptr = (gid < blocks_total) ?\\n""
""grad + offset_y * grad_quadstep + (offset_x << 1) : grad;\\n""
""__global const QANGLE_TYPE* qangle_ptr = (gid < blocks_total) ?\\n""
""qangle + offset_y * qangle_step + (offset_x << 1) : qangle;\\n""
""__local float* hist = hists + 12 * (cell_y * CELLS_PER_BLOCK_Y + cell_x) +\\n""
""cell_thread_x;\\n""
""for (int bin_id = 0; bin_id < cnbins; ++bin_id)\\n""
""hist[bin_id * 48] = 0.f;\\n""
""const int dist_x = -4 + cell_thread_x - 4 * cell_x;\\n""
""const int dist_center_x = dist_x - 4 * (1 - 2 * cell_x);\\n""
""const int dist_y_begin = -4 - 4 * lidY;\\n""
""for (int dist_y = dist_y_begin; dist_y < dist_y_begin + 12; ++dist_y)\\n""
""{\\n""
""float2 vote = (float2) (grad_ptr[0], grad_ptr[1]);\\n""
""QANGLE_TYPE2 bin = (QANGLE_TYPE2) (qangle_ptr[0], qangle_ptr[1]);\\n""
""grad_ptr += grad_quadstep;\\n""
""qangle_ptr += qangle_step;\\n""
""int dist_center_y = dist_y - 4 * (1 - 2 * cell_y);\\n""
""int idx = (dist_center_y + 8) * 16 + (dist_center_x + 8);\\n""
""float gaussian = gauss_w_lut[idx];\\n""
""idx = (dist_y + 8) * 16 + (dist_x + 8);\\n""
""float interp_weight = gauss_w_lut[256+idx];\\n""
""hist[bin.x * 48] += gaussian * interp_weight * vote.x;\\n""
""hist[bin.y * 48] += gaussian * interp_weight * vote.y;\\n""
""}\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""volatile __local float* hist_ = hist;\\n""
""for (int bin_id = 0; bin_id < cnbins; ++bin_id, hist_ += 48)\\n""
""{\\n""
""if (cell_thread_x < 6)\\n""
""hist_[0] += hist_[6];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (cell_thread_x < 3)\\n""
""hist_[0] += hist_[3];\\n""
""#ifdef CPU\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""#endif\\n""
""if (cell_thread_x == 0)\\n""
""final_hist[(cell_x * 2 + cell_y) * cnbins + bin_id] =\\n""
""hist_[0] + hist_[1] + hist_[2];\\n""
""}\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""int tid = (cell_y * CELLS_PER_BLOCK_Y + cell_x) * 12 + cell_thread_x;\\n""
""if ((tid < cblock_hist_size) && (gid < blocks_total))\\n""
""{\\n""
""__global float* block_hist = block_hists +\\n""
""(gidY * img_block_width + gidX) * cblock_hist_size;\\n""
""block_hist[tid] = final_hist[tid];\\n""
""}\\n""
""}\\n""
""__kernel void normalize_hists_36_kernel(__global float* block_hists,\\n""
""const float threshold, __local float *squares)\\n""
""{\\n""
""const int tid = get_local_id(0);\\n""
""const int gid = get_global_id(0);\\n""
""const int bid = tid / 36;      \\n""
""const int boffset = bid * 36;  \\n""
""const int hid = tid - boffset; \\n""
""float elem = block_hists[gid];\\n""
""squares[tid] = elem * elem;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""__local float* smem = squares + boffset;\\n""
""float sum = smem[hid];\\n""
""if (hid < 18)\\n""
""smem[hid] = sum = sum + smem[hid + 18];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (hid < 9)\\n""
""smem[hid] = sum = sum + smem[hid + 9];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (hid < 4)\\n""
""smem[hid] = sum + smem[hid + 4];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""sum = smem[0] + smem[1] + smem[2] + smem[3] + smem[8];\\n""
""elem = elem / (sqrt(sum) + 3.6f);\\n""
""elem = min(elem, threshold);\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""squares[tid] = elem * elem;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""sum = smem[hid];\\n""
""if (hid < 18)\\n""
""smem[hid] = sum = sum + smem[hid + 18];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (hid < 9)\\n""
""smem[hid] = sum = sum + smem[hid + 9];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (hid < 4)\\n""
""smem[hid] = sum + smem[hid + 4];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""sum = smem[0] + smem[1] + smem[2] + smem[3] + smem[8];\\n""
""block_hists[gid] = elem / (sqrt(sum) + 1e-3f);\\n""
""}\\n""
""inline float reduce_smem(volatile __local float* smem, int size)\\n""
""{\\n""
""unsigned int tid = get_local_id(0);\\n""
""float sum = smem[tid];\\n""
""if (size >= 512) { if (tid < 256) smem[tid] = sum = sum + smem[tid + 256];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""if (size >= 256) { if (tid < 128) smem[tid] = sum = sum + smem[tid + 128];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""if (size >= 128) { if (tid < 64) smem[tid] = sum = sum + smem[tid + 64];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""#ifdef CPU\\n""
""if (size >= 64) { if (tid < 32) smem[tid] = sum = sum + smem[tid + 32];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""if (size >= 32) { if (tid < 16) smem[tid] = sum = sum + smem[tid + 16];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""if (size >= 16) { if (tid < 8) smem[tid] = sum = sum + smem[tid + 8];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""if (size >= 8) { if (tid < 4) smem[tid] = sum = sum + smem[tid + 4];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""if (size >= 4) { if (tid < 2) smem[tid] = sum = sum + smem[tid + 2];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""if (size >= 2) { if (tid < 1) smem[tid] = sum = sum + smem[tid + 1];\\n""
""barrier(CLK_LOCAL_MEM_FENCE); }\\n""
""#else\\n""
""if (tid < 32)\\n""
""{\\n""
""if (size >= 64) smem[tid] = sum = sum + smem[tid + 32];\\n""
""#if WAVE_SIZE < 32\\n""
""} barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 16) {\\n""
""#endif\\n""
""if (size >= 32) smem[tid] = sum = sum + smem[tid + 16];\\n""
""if (size >= 16) smem[tid] = sum = sum + smem[tid + 8];\\n""
""if (size >= 8) smem[tid] = sum = sum + smem[tid + 4];\\n""
""if (size >= 4) smem[tid] = sum = sum + smem[tid + 2];\\n""
""if (size >= 2) smem[tid] = sum = sum + smem[tid + 1];\\n""
""}\\n""
""#endif\\n""
""return sum;\\n""
""}\\n""
""__kernel void normalize_hists_kernel(\\n""
""const int nthreads, const int block_hist_size, const int img_block_width,\\n""
""__global float* block_hists, const float threshold, __local float *squares)\\n""
""{\\n""
""const int tid = get_local_id(0);\\n""
""const int gidX = get_group_id(0);\\n""
""const int gidY = get_group_id(1);\\n""
""__global float* hist = block_hists + (gidY * img_block_width + gidX) *\\n""
""block_hist_size + tid;\\n""
""float elem = 0.f;\\n""
""if (tid < block_hist_size)\\n""
""elem = hist[0];\\n""
""squares[tid] = elem * elem;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""float sum = reduce_smem(squares, nthreads);\\n""
""float scale = 1.0f / (sqrt(sum) + 0.1f * block_hist_size);\\n""
""elem = min(elem * scale, threshold);\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""squares[tid] = elem * elem;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""sum = reduce_smem(squares, nthreads);\\n""
""scale = 1.0f / (sqrt(sum) + 1e-3f);\\n""
""if (tid < block_hist_size)\\n""
""hist[0] = elem * scale;\\n""
""}\\n""
""__kernel void classify_hists_180_kernel(\\n""
""const int cdescr_width, const int cdescr_height, const int cblock_hist_size,\\n""
""const int img_win_width, const int img_block_width,\\n""
""const int win_block_stride_x, const int win_block_stride_y,\\n""
""__global const float * block_hists, __global const float* coefs,\\n""
""float free_coef, float threshold, __global uchar* labels)\\n""
""{\\n""
""const int tid = get_local_id(0);\\n""
""const int gidX = get_group_id(0);\\n""
""const int gidY = get_group_id(1);\\n""
""__global const float* hist = block_hists + (gidY * win_block_stride_y *\\n""
""img_block_width + gidX * win_block_stride_x) * cblock_hist_size;\\n""
""float product = 0.f;\\n""
""for (int i = 0; i < cdescr_height; i++)\\n""
""{\\n""
""product += coefs[i * cdescr_width + tid] *\\n""
""hist[i * img_block_width * cblock_hist_size + tid];\\n""
""}\\n""
""__local float products[180];\\n""
""products[tid] = product;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 90) products[tid] = product = product + products[tid + 90];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 45) products[tid] = product = product + products[tid + 45];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""volatile __local float* smem = products;\\n""
""#ifdef CPU\\n""
""if (tid < 13) smem[tid] = product = product + smem[tid + 32];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 16) smem[tid] = product = product + smem[tid + 16];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<8) smem[tid] = product = product + smem[tid + 8];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<4) smem[tid] = product = product + smem[tid + 4];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<2) smem[tid] = product = product + smem[tid + 2];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""#else\\n""
""if (tid < 13)\\n""
""{\\n""
""smem[tid] = product = product + smem[tid + 32];\\n""
""}\\n""
""#if WAVE_SIZE < 32\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""#endif\\n""
""if (tid < 16)\\n""
""{\\n""
""smem[tid] = product = product + smem[tid + 16];\\n""
""smem[tid] = product = product + smem[tid + 8];\\n""
""smem[tid] = product = product + smem[tid + 4];\\n""
""smem[tid] = product = product + smem[tid + 2];\\n""
""}\\n""
""#endif\\n""
""if (tid == 0){\\n""
""product = product + smem[tid + 1];\\n""
""labels[gidY * img_win_width + gidX] = (product + free_coef >= threshold);\\n""
""}\\n""
""}\\n""
""__kernel void classify_hists_252_kernel(\\n""
""const int cdescr_width, const int cdescr_height, const int cblock_hist_size,\\n""
""const int img_win_width, const int img_block_width,\\n""
""const int win_block_stride_x, const int win_block_stride_y,\\n""
""__global const float * block_hists, __global const float* coefs,\\n""
""float free_coef, float threshold, __global uchar* labels)\\n""
""{\\n""
""const int tid = get_local_id(0);\\n""
""const int gidX = get_group_id(0);\\n""
""const int gidY = get_group_id(1);\\n""
""__global const float* hist = block_hists + (gidY * win_block_stride_y *\\n""
""img_block_width + gidX * win_block_stride_x) * cblock_hist_size;\\n""
""float product = 0.f;\\n""
""if (tid < cdescr_width)\\n""
""{\\n""
""for (int i = 0; i < cdescr_height; i++)\\n""
""product += coefs[i * cdescr_width + tid] *\\n""
""hist[i * img_block_width * cblock_hist_size + tid];\\n""
""}\\n""
""__local float products[NTHREADS];\\n""
""products[tid] = product;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 128) products[tid] = product = product + products[tid + 128];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 64) products[tid] = product = product + products[tid + 64];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""volatile __local float* smem = products;\\n""
""#ifdef CPU\\n""
""if(tid<32) smem[tid] = product = product + smem[tid + 32];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<16) smem[tid] = product = product + smem[tid + 16];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<8) smem[tid] = product = product + smem[tid + 8];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<4) smem[tid] = product = product + smem[tid + 4];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<2) smem[tid] = product = product + smem[tid + 2];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""#else\\n""
""if (tid < 32)\\n""
""{\\n""
""smem[tid] = product = product + smem[tid + 32];\\n""
""#if WAVE_SIZE < 32\\n""
""} barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 16) {\\n""
""#endif\\n""
""smem[tid] = product = product + smem[tid + 16];\\n""
""smem[tid] = product = product + smem[tid + 8];\\n""
""smem[tid] = product = product + smem[tid + 4];\\n""
""smem[tid] = product = product + smem[tid + 2];\\n""
""}\\n""
""#endif\\n""
""if (tid == 0){\\n""
""product = product + smem[tid + 1];\\n""
""labels[gidY * img_win_width + gidX] = (product + free_coef >= threshold);\\n""
""}\\n""
""}\\n""
""__kernel void classify_hists_kernel(\\n""
""const int cdescr_size, const int cdescr_width, const int cblock_hist_size,\\n""
""const int img_win_width, const int img_block_width,\\n""
""const int win_block_stride_x, const int win_block_stride_y,\\n""
""__global const float * block_hists, __global const float* coefs,\\n""
""float free_coef, float threshold, __global uchar* labels)\\n""
""{\\n""
""const int tid = get_local_id(0);\\n""
""const int gidX = get_group_id(0);\\n""
""const int gidY = get_group_id(1);\\n""
""__global const float* hist = block_hists + (gidY * win_block_stride_y *\\n""
""img_block_width + gidX * win_block_stride_x) * cblock_hist_size;\\n""
""float product = 0.f;\\n""
""for (int i = tid; i < cdescr_size; i += NTHREADS)\\n""
""{\\n""
""int offset_y = i / cdescr_width;\\n""
""int offset_x = i - offset_y * cdescr_width;\\n""
""product += coefs[i] *\\n""
""hist[offset_y * img_block_width * cblock_hist_size + offset_x];\\n""
""}\\n""
""__local float products[NTHREADS];\\n""
""products[tid] = product;\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 128) products[tid] = product = product + products[tid + 128];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 64) products[tid] = product = product + products[tid + 64];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""volatile __local float* smem = products;\\n""
""#ifdef CPU\\n""
""if(tid<32) smem[tid] = product = product + smem[tid + 32];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<16) smem[tid] = product = product + smem[tid + 16];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<8) smem[tid] = product = product + smem[tid + 8];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<4) smem[tid] = product = product + smem[tid + 4];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if(tid<2) smem[tid] = product = product + smem[tid + 2];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""#else\\n""
""if (tid < 32)\\n""
""{\\n""
""smem[tid] = product = product + smem[tid + 32];\\n""
""#if WAVE_SIZE < 32\\n""
""} barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (tid < 16) {\\n""
""#endif\\n""
""smem[tid] = product = product + smem[tid + 16];\\n""
""smem[tid] = product = product + smem[tid + 8];\\n""
""smem[tid] = product = product + smem[tid + 4];\\n""
""smem[tid] = product = product + smem[tid + 2];\\n""
""}\\n""
""#endif\\n""
""if (tid == 0){\\n""
""smem[tid] = product = product + smem[tid + 1];\\n""
""labels[gidY * img_win_width + gidX] = (product + free_coef >= threshold);\\n""
""}\\n""
""}\\n""
""__kernel void extract_descrs_by_rows_kernel(\\n""
""const int cblock_hist_size, const int descriptors_quadstep,\\n""
""const int cdescr_size, const int cdescr_width, const int img_block_width,\\n""
""const int win_block_stride_x, const int win_block_stride_y,\\n""
""__global const float* block_hists, __global float* descriptors)\\n""
""{\\n""
""int tid = get_local_id(0);\\n""
""int gidX = get_group_id(0);\\n""
""int gidY = get_group_id(1);\\n""
""__global const float* hist = block_hists + (gidY * win_block_stride_y *\\n""
""img_block_width + gidX * win_block_stride_x) * cblock_hist_size;\\n""
""__global float* descriptor = descriptors +\\n""
""(gidY * get_num_groups(0) + gidX) * descriptors_quadstep;\\n""
""for (int i = tid; i < cdescr_size; i += NTHREADS)\\n""
""{\\n""
""int offset_y = i / cdescr_width;\\n""
""int offset_x = i - offset_y * cdescr_width;\\n""
""descriptor[i] = hist[offset_y * img_block_width * cblock_hist_size + offset_x];\\n""
""}\\n""
""}\\n""
""__kernel void extract_descrs_by_cols_kernel(\\n""
""const int cblock_hist_size, const int descriptors_quadstep, const int cdescr_size,\\n""
""const int cnblocks_win_x, const int cnblocks_win_y, const int img_block_width,\\n""
""const int win_block_stride_x, const int win_block_stride_y,\\n""
""__global const float* block_hists, __global float* descriptors)\\n""
""{\\n""
""int tid = get_local_id(0);\\n""
""int gidX = get_group_id(0);\\n""
""int gidY = get_group_id(1);\\n""
""__global const float* hist = block_hists +  (gidY * win_block_stride_y *\\n""
""img_block_width + gidX * win_block_stride_x) * cblock_hist_size;\\n""
""__global float* descriptor = descriptors +\\n""
""(gidY * get_num_groups(0) + gidX) * descriptors_quadstep;\\n""
""for (int i = tid; i < cdescr_size; i += NTHREADS)\\n""
""{\\n""
""int block_idx = i / cblock_hist_size;\\n""
""int idx_in_block = i - block_idx * cblock_hist_size;\\n""
""int y = block_idx / cnblocks_win_x;\\n""
""int x = block_idx - y * cnblocks_win_x;\\n""
""descriptor[(x * cnblocks_win_y + y) * cblock_hist_size + idx_in_block] =\\n""
""hist[(y * img_block_width  + x) * cblock_hist_size + idx_in_block];\\n""
""}\\n""
""}\\n""
""__kernel void compute_gradients_8UC4_kernel(\\n""
""const int height, const int width,\\n""
""const int img_step, const int grad_quadstep, const int qangle_step,\\n""
""const __global uchar4 * img, __global float * grad, __global QANGLE_TYPE * qangle,\\n""
""const float angle_scale, const char correct_gamma, const int cnbins)\\n""
""{\\n""
""const int x = get_global_id(0);\\n""
""const int tid = get_local_id(0);\\n""
""const int gSizeX = get_local_size(0);\\n""
""const int gidY = get_group_id(1);\\n""
""__global const uchar4* row = img + gidY * img_step;\\n""
""__local float sh_row[(NTHREADS + 2) * 3];\\n""
""uchar4 val;\\n""
""if (x < width)\\n""
""val = row[x];\\n""
""else\\n""
""val = row[width - 2];\\n""
""sh_row[tid + 1] = val.x;\\n""
""sh_row[tid + 1 + (NTHREADS + 2)] = val.y;\\n""
""sh_row[tid + 1 + 2 * (NTHREADS + 2)] = val.z;\\n""
""if (tid == 0)\\n""
""{\\n""
""val = row[max(x - 1, 1)];\\n""
""sh_row[0] = val.x;\\n""
""sh_row[(NTHREADS + 2)] = val.y;\\n""
""sh_row[2 * (NTHREADS + 2)] = val.z;\\n""
""}\\n""
""if (tid == gSizeX - 1)\\n""
""{\\n""
""val = row[min(x + 1, width - 2)];\\n""
""sh_row[gSizeX + 1] = val.x;\\n""
""sh_row[gSizeX + 1 + (NTHREADS + 2)] = val.y;\\n""
""sh_row[gSizeX + 1 + 2 * (NTHREADS + 2)] = val.z;\\n""
""}\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (x < width)\\n""
""{\\n""
""float4 a = (float4) (sh_row[tid], sh_row[tid + (NTHREADS + 2)],\\n""
""sh_row[tid + 2 * (NTHREADS + 2)], 0);\\n""
""float4 b = (float4) (sh_row[tid + 2], sh_row[tid + 2 + (NTHREADS + 2)],\\n""
""sh_row[tid + 2 + 2 * (NTHREADS + 2)], 0);\\n""
""float4 dx;\\n""
""if (correct_gamma == 1)\\n""
""dx = sqrt(b) - sqrt(a);\\n""
""else\\n""
""dx = b - a;\\n""
""float4 dy = (float4) 0.f;\\n""
""if (gidY > 0 && gidY < height - 1)\\n""
""{\\n""
""a = convert_float4(img[(gidY - 1) * img_step + x].xyzw);\\n""
""b = convert_float4(img[(gidY + 1) * img_step + x].xyzw);\\n""
""if (correct_gamma == 1)\\n""
""dy = sqrt(b) - sqrt(a);\\n""
""else\\n""
""dy = b - a;\\n""
""}\\n""
""float4 mag = hypot(dx, dy);\\n""
""float best_dx = dx.x;\\n""
""float best_dy = dy.x;\\n""
""float mag0 = mag.x;\\n""
""if (mag0 < mag.y)\\n""
""{\\n""
""best_dx = dx.y;\\n""
""best_dy = dy.y;\\n""
""mag0 = mag.y;\\n""
""}\\n""
""if (mag0 < mag.z)\\n""
""{\\n""
""best_dx = dx.z;\\n""
""best_dy = dy.z;\\n""
""mag0 = mag.z;\\n""
""}\\n""
""float ang = (atan2(best_dy, best_dx) + CV_PI_F) * angle_scale - 0.5f;\\n""
""int hidx = (int)floor(ang);\\n""
""ang -= hidx;\\n""
""hidx = (hidx + cnbins) % cnbins;\\n""
""qangle[(gidY * qangle_step + x) << 1] = hidx;\\n""
""qangle[((gidY * qangle_step + x) << 1) + 1] = (hidx + 1) % cnbins;\\n""
""grad[(gidY * grad_quadstep + x) << 1] = mag0 * (1.f - ang);\\n""
""grad[((gidY * grad_quadstep + x) << 1) + 1] = mag0 * ang;\\n""
""}\\n""
""}\\n""
""__kernel void compute_gradients_8UC1_kernel(\\n""
""const int height, const int width,\\n""
""const int img_step, const int grad_quadstep, const int qangle_step,\\n""
""__global const uchar * img, __global float * grad, __global QANGLE_TYPE * qangle,\\n""
""const float angle_scale, const char correct_gamma, const int cnbins)\\n""
""{\\n""
""const int x = get_global_id(0);\\n""
""const int tid = get_local_id(0);\\n""
""const int gSizeX = get_local_size(0);\\n""
""const int gidY = get_group_id(1);\\n""
""__global const uchar* row = img + gidY * img_step;\\n""
""__local float sh_row[NTHREADS + 2];\\n""
""if (x < width)\\n""
""sh_row[tid + 1] = row[x];\\n""
""else\\n""
""sh_row[tid + 1] = row[width - 2];\\n""
""if (tid == 0)\\n""
""sh_row[0] = row[max(x - 1, 1)];\\n""
""if (tid == gSizeX - 1)\\n""
""sh_row[gSizeX + 1] = row[min(x + 1, width - 2)];\\n""
""barrier(CLK_LOCAL_MEM_FENCE);\\n""
""if (x < width)\\n""
""{\\n""
""float dx;\\n""
""if (correct_gamma == 1)\\n""
""dx = sqrt(sh_row[tid + 2]) - sqrt(sh_row[tid]);\\n""
""else\\n""
""dx = sh_row[tid + 2] - sh_row[tid];\\n""
""float dy = 0.f;\\n""
""if (gidY > 0 && gidY < height - 1)\\n""
""{\\n""
""float a = (float) img[ (gidY + 1) * img_step + x ];\\n""
""float b = (float) img[ (gidY - 1) * img_step + x ];\\n""
""if (correct_gamma == 1)\\n""
""dy = sqrt(a) - sqrt(b);\\n""
""else\\n""
""dy = a - b;\\n""
""}\\n""
""float mag = hypot(dx, dy);\\n""
""float ang = (atan2(dy, dx) + CV_PI_F) * angle_scale - 0.5f;\\n""
""int hidx = (int)floor(ang);\\n""
""ang -= hidx;\\n""
""hidx = (hidx + cnbins) % cnbins;\\n""
""qangle[ (gidY * qangle_step + x) << 1 ]     = hidx;\\n""
""qangle[ ((gidY * qangle_step + x) << 1) + 1 ] = (hidx + 1) % cnbins;\\n""
""grad[ (gidY * grad_quadstep + x) << 1 ]       = mag * (1.f - ang);\\n""
""grad[ ((gidY * grad_quadstep + x) << 1) + 1 ]   = mag * ang;\\n""
""}\\n""
""}\\n""
, ""bc57f4f75fb81bae73bfe73cc4ca15e4"", NULL};

}}}
#endif
",16380,True,2940.4665054965344,median
"/*
 * Copyright (c) [2020] Huawei Technologies Co., Ltd. All rights reserved.
 *
 * OpenArkCompiler is licensed under the Mulan Permissive Software License v2.
 * You can use this software according to the terms and conditions of the MulanPSL - 2.0.
 * You may obtain a copy of MulanPSL - 2.0 at:
 *
 *   https://opensource.org/licenses/MulanPSL-2.0
 *
 * THIS SOFTWARE IS PROVIDED ON AN ""AS IS"" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR
 * FIT FOR A PARTICULAR PURPOSE.
 * See the MulanPSL - 2.0 for more details.
 */

#include ""mir_type.h""
#include <iostream>
#include <cstring>
#include ""mir_symbol.h""
#include ""printing.h""
#include ""name_mangler.h""
#include ""global_tables.h""
#include ""mir_builder.h""
#include ""cfg_primitive_types.h""
#if MIR_FEATURE_FULL

namespace maple {
#define LOAD_PRIMARY_TYPE_PROPERTY
#include ""prim_types.def""

#define LOAD_ALGO_PRIMARY_TYPE
const PrimitiveTypeProperty &GetPrimitiveTypeProperty(PrimType pType) {
  switch (pType) {
    case PTY_begin:
      return PTProperty_begin;
#define PRIMTYPE(P) \\
    case PTY_##P:   \\
      return PTProperty_##P;
#include ""prim_types.def""
#undef PRIMTYPE
    case PTY_end:
    default:
      return PTProperty_end;
  }
}

PrimType GetRegPrimType(PrimType primType) {
  switch (primType) {
    case PTY_i8:
    case PTY_i16:
      return PTY_i32;
    case PTY_u1:
    case PTY_u8:
    case PTY_u16:
      return PTY_u32;
    default:
      return primType;
  }
}

bool VerifyPrimType(PrimType pty1, PrimType pty2) {
  switch (pty1) {
    case PTY_u1:
    case PTY_u8:
    case PTY_u16:
    case PTY_u32:
    case PTY_a32:
      return IsUnsignedInteger(pty2);
    case PTY_i8:
    case PTY_i16:
    case PTY_i32:
      return IsSignedInteger(pty2);
    default:
      return pty1 == pty2;
  }
}

PrimType GetDynType(PrimType primType) {
#ifdef DYNAMICLANG
  switch (primType) {
    case PTY_u1:
      return PTY_dynbool;
    case PTY_i32:
      return PTY_dyni32;
    case PTY_simplestr:
      return PTY_dynstr;
    case PTY_simpleobj:
      return PTY_dynobj;
    case PTY_f32:
      return PTY_dynf32;
    case PTY_f64:
      return PTY_dynf64;
    default:
      return primType;
  }
#else
  return primType;
#endif
}

PrimType GetNonDynType(PrimType primType) {
#ifdef DYNAMICLANG
  switch (primType) {
    case PTY_dynbool:
      return PTY_u1;
    case PTY_dyni32:
      return PTY_i32;
    case PTY_dynstr:
      return PTY_simplestr;
    case PTY_dynobj:
      return PTY_simpleobj;
    case PTY_dynf32:
      return PTY_f32;
    case PTY_dynf64:
      return PTY_f64;
    default:
      return primType;
  }
#else
  return primType;
#endif
}

bool IsNoCvtNeeded(PrimType toType, PrimType fromType) {
  switch (toType) {
    case PTY_i32:
      return fromType == PTY_i16 || fromType == PTY_i8;
    case PTY_u32:
      return fromType == PTY_u16 || fromType == PTY_u8;
    case PTY_u1:
    case PTY_u8:
    case PTY_u16:
      return fromType == PTY_u32;
    case PTY_i8:
    case PTY_i16:
      return fromType == PTY_i32;
    case PTY_u64:
      return fromType == PTY_ptr;
    case PTY_ptr:
      return fromType == PTY_u64;
    default:
      return false;
  }
}

// answer in bytes; 0 if unknown
uint32 GetPrimTypeSize(PrimType pty) {
  switch (pty) {
    case PTY_void:
    case PTY_agg:
      return 0;
    case PTY_ptr:
    case PTY_ref:
      return POINTER_SIZE;
    case PTY_u1:
    case PTY_i8:
    case PTY_u8:
      return 1;
    case PTY_i16:
    case PTY_u16:
      return 2;
    case PTY_a32:
    case PTY_f32:
    case PTY_i32:
    case PTY_u32:
    case PTY_simplestr:
    case PTY_simpleobj:
      return 4;
    case PTY_a64:
    case PTY_c64:
    case PTY_f64:
    case PTY_i64:
    case PTY_u64:
      return 8;
    case PTY_v4i32:
    case PTY_v2i64:
    case PTY_v8i16:
    case PTY_v16i8:
    case PTY_v2f64:
    case PTY_v4f32:
      return 16;
    case PTY_c128:
    case PTY_f128:
      return 16;
#ifdef DYNAMICLANG
    case PTY_dynf32:
    case PTY_dyni32:
    case PTY_dynstr:
    case PTY_dynobj:
    case PTY_dynundef:
    case PTY_dynnull:
    case PTY_dynbool:
      return 8;
    case PTY_dynany:
    case PTY_dynf64:
      return 8;
#endif
    default:
      return 0;
  }
}

// answer is n if size in byte is (1<<n) (0: 1B; 1: 2B, 2: 4B, 3: 8B, 4:16B)
uint32 GetPrimTypeP2Size(PrimType pty) {
  switch (pty) {
    case PTY_ptr:
    case PTY_ref:
      return POINTER_P2SIZE;
    case PTY_u1:
    case PTY_i8:
    case PTY_u8:
      return 0;
    case PTY_i16:
    case PTY_u16:
      return 1;
    case PTY_a32:
    case PTY_f32:
    case PTY_i32:
    case PTY_u32:
    case PTY_simplestr:
    case PTY_simpleobj:
      return 2;
    case PTY_a64:
    case PTY_c64:
    case PTY_f64:
    case PTY_i64:
    case PTY_u64:
      return 3;
    case PTY_c128:
    case PTY_f128:
      return 4;
#ifdef DYNAMICLANG
    case PTY_dynf32:
    case PTY_dyni32:
    case PTY_dynstr:
    case PTY_dynobj:
    case PTY_dynundef:
    case PTY_dynnull:
    case PTY_dynbool:
      return 3;
    case PTY_dynany:
    case PTY_dynf64:
      return 3;
#endif
    default:
      CHECK_FATAL(false, ""Power-of-2 size only applicable to sizes of 1, 2, 4, 8 or 16 bytes."");
      return 10;
  }
}

const char *GetPrimTypeName(PrimType ty) {
#define LOAD_ALGO_PRIMARY_TYPE
  switch (ty) {
    case kPtyInvalid:
      return ""kPtyInvalid"";
#define PRIMTYPE(P) \\
  case PTY_##P:     \\
    return #P;
#include ""prim_types.def""
#undef PRIMTYPE
    case kPtyDerived:
      return ""derived"";  // just for test: no primitive type for derived
    default:
      return ""kPtyInvalid"";
  }
  // SIMD types to be defined
}

const char *GetPrimTypeJavaName(PrimType ty) {
  switch (ty) {
    default:
    case kPtyInvalid:  // ASSERT(false, ""wrong primitive type!"");
    case PTY_u1:
      return ""Z"";
    case PTY_i8:
      return ""B"";
    case PTY_i16:
      return ""S"";
    case PTY_u16:
      return ""C"";
    case PTY_i32:
      return ""I"";
    case PTY_i64:
      return ""J"";
    case PTY_f32:
      return ""F"";
    case PTY_f64:
      return ""D"";
    case PTY_void:
      return ""V"";
    case PTY_constStr:
      return JSTRTYPENAME;
  }
}

void TypeAttrs::DumpAttributes() const {
#define TYPE_ATTR
#define STRING(s) #s
#define ATTR(AT)          \\
  if (GetAttr(ATTR_##AT)) \\
    LogInfo::MapleLogger() << "" "" << STRING(AT);
#include ""all_attributes.def""
#undef ATTR
#undef TYPE_ATTR
  if (attrAlign) {
    LogInfo::MapleLogger() << "" align("" << GetAlign() << "")"";
  }
}

void FieldAttrs::DumpAttributes() const {
#define FIELD_ATTR
#define STRING(s) #s
#define ATTR(AT)             \\
  if (GetAttr(FLDATTR_##AT)) \\
    LogInfo::MapleLogger() << "" "" << STRING(AT);
#include ""all_attributes.def""
#undef ATTR
#undef FIELD_ATTR
  if (attrAlign) {
    LogInfo::MapleLogger() << "" align("" << GetAlign() << "")"";
  }
}

const std::string &MIRType::GetName(void) const {
  return GlobalTables::GetStrTable().GetStringFromStrIdx(nameStrIdx);
}

bool MIRType::ValidateClassOrInterface(const char *classname, bool noWarning) {
  if (primType == maple::PTY_agg && (typeKind == maple::kTypeClass || typeKind == maple::kTypeInterface) &&
      nameStrIdx.GetIdx()) {
    return true;
  } else {
    if (noWarning == false) {
      int len = strlen(classname);
      if (len > 4 && strncmp(classname + len - 3, ""_3B"", 3) == 0) {
        std::cerr << ""error: missing proper mplt file for "" << classname << std::endl;
      } else {
        std::cerr << ""internal error: type is not java class or interface "" << classname << std::endl;
      }
    }
    return false;
  }
}

bool MIRType::PointsToConstString() const {
  if (typeKind == kTypePointer) {
    return static_cast<const MIRPtrType *>(this)->PointsToConstString();
  }
  return false;
}

std::string MIRType::GetMplTypeName() const {
  if (typeKind == kTypeScalar) {
    return GetPrimTypeName(primType);
  }
  return """";
}

std::string MIRType::GetCompactMplTypeName() const {
  if (typeKind == kTypeScalar) {
    return GetPrimTypeJavaName(primType);
  }
  return """";
}

void MIRType::Dump(int indent, bool dontUseName) const {
  LogInfo::MapleLogger() << GetPrimTypeName(primType);
}

void MIRType::DumpAsCxx(int indent) const {
  switch (primType) {
    case PTY_void:
      LogInfo::MapleLogger() << ""void"";
      break;
    case PTY_i8:
      LogInfo::MapleLogger() << ""int8"";
      break;
    case PTY_i16:
      LogInfo::MapleLogger() << ""int16"";
      break;
    case PTY_i32:
      LogInfo::MapleLogger() << ""int32"";
      break;
    case PTY_i64:
      LogInfo::MapleLogger() << ""int64"";
      break;
    case PTY_u8:
      LogInfo::MapleLogger() << ""uint8"";
      break;
    case PTY_u16:
      LogInfo::MapleLogger() << ""uint16"";
      break;
    case PTY_u32:
      LogInfo::MapleLogger() << ""uint32"";
      break;
    case PTY_u64:
      LogInfo::MapleLogger() << ""uint64"";
      break;
    case PTY_u1:
      LogInfo::MapleLogger() << ""bool  "";
      break;
    case PTY_ptr:
      LogInfo::MapleLogger() << ""void* "";
      break;
    case PTY_ref:
      LogInfo::MapleLogger() << ""void* "";
      break;
    case PTY_a32:
      LogInfo::MapleLogger() << ""int32"";
      break;
    case PTY_a64:
      LogInfo::MapleLogger() << ""void* "";
      break;
    case PTY_f32:
      LogInfo::MapleLogger() << ""float "";
      break;
    case PTY_f64:
      LogInfo::MapleLogger() << ""double"";
      break;
    case PTY_c64:
      LogInfo::MapleLogger() << ""float complex"";
      break;
    case PTY_c128:
      LogInfo::MapleLogger() << ""double complex"";
      break;
    default:
      ASSERT(false, ""NYI"");
  }
}

bool MIRType::IsOfSameType(MIRType &type) {
  if (typeKind != type.typeKind) {
    return false;
  }

  if (typeKind == kTypePointer) {
    const auto &ptrType = static_cast<const MIRPtrType&>(*this);
    const auto &ptrTypeIt = static_cast<const MIRPtrType&>(type);
    if (ptrType.pointedTyIdx == ptrTypeIt.pointedTyIdx) {
      return true;
    } else {
      MIRType &mirTypeIt = *GlobalTables::GetTypeTable().GetTypeFromTyIdx(ptrTypeIt.pointedTyIdx);
      return GlobalTables::GetTypeTable().GetTypeFromTyIdx(ptrType.pointedTyIdx)->IsOfSameType(mirTypeIt);
    }
  } else if (typeKind == kTypeJArray) {
    auto &arrType1 = static_cast<MIRJarrayType&>(*this);
    auto &arrType2 = static_cast<MIRJarrayType&>(type);
    if (arrType1.GetDim() != arrType2.GetDim()) {
      return false;
    }
    return arrType1.GetElemType()->IsOfSameType(*arrType2.GetElemType());
  } else {
    return tyIdx == type.tyIdx;
  }
}

inline void DumpTypename(GStrIdx strIdx, bool isLocal) {
  LogInfo::MapleLogger() << ((isLocal) ? ""%"" : ""$"") << GlobalTables::GetStrTable().GetStringFromStrIdx(strIdx);
}

static bool CheckAndDumpTypeName(GStrIdx strIdx, bool isLocal) {
  if (strIdx == GStrIdx(0)) {
    return false;
  }
  LogInfo::MapleLogger() << ""<"";
  DumpTypename(strIdx, isLocal);
  LogInfo::MapleLogger() << "">"";
  return true;
}

void MIRFuncType::Dump(int indent, bool dontUseName) const {
  if (!dontUseName && CheckAndDumpTypeName(nameStrIdx, nameIsLocal)) {
    return;
  }
  LogInfo::MapleLogger() << ""<func("";
  int size = paramTypeList.size();
  for (int i = 0; i < size; i++) {
    GlobalTables::GetTypeTable().GetTypeFromTyIdx(paramTypeList[i])->Dump(indent + 1);
    if (size - 1 != i) {
      LogInfo::MapleLogger() << "","";
    }
  }
  if (isVarArgs) {
    LogInfo::MapleLogger() << "", ..."";
  }
  LogInfo::MapleLogger() << "") "";
  GlobalTables::GetTypeTable().GetTypeFromTyIdx(retTyIdx)->Dump(indent + 1);
  LogInfo::MapleLogger() << "">"";
}

static constexpr uint64 RoundUpConst(uint64 offset, uint8 align) {
  return (-align) & (offset + align - 1);
}

static inline uint64 RoundUp(uint64 offset, uint8 align) {
  if (align == 0) {
    return offset;
  }
  return RoundUpConst(offset, align);
}

static constexpr uint64 RoundDownConst(uint64 offset, uint8 align) {
  return (-align) & offset;
}

static inline uint64 RoundDown(uint64 offset, uint8 align) {
  if (align == 0) {
    return offset;
  }
  return RoundDownConst(offset, align);
}

size_t MIRArrayType::GetSize() const {
  size_t elemsize = GetElemType()->GetSize();
  if (elemsize == 0) {
    return 0;
  }
  elemsize = RoundUp(elemsize, typeAttrs.GetAlign());
  size_t numelems = sizeArray[0];
  for (int i = 1; i < dim; i++) {
    numelems *= sizeArray[i];
  }
  return elemsize * numelems;
}

uint32 MIRArrayType::GetAlign() const {
  return std::max(GetElemType()->GetAlign(), typeAttrs.GetAlign());
}

void MIRArrayType::Dump(int indent, bool dontUseName) const {
  if (!dontUseName && CheckAndDumpTypeName(nameStrIdx, nameIsLocal)) {
    return;
  }
  LogInfo::MapleLogger() << ""<"";
  for (int i = 0; i < dim; i++) {
    LogInfo::MapleLogger() << ""["" << sizeArray[i] << ""]"";
  }
  LogInfo::MapleLogger() << "" "";
  GlobalTables::GetTypeTable().GetTypeFromTyIdx(eTyIdx)->Dump(indent + 1);
  typeAttrs.DumpAttributes();
  LogInfo::MapleLogger() << "">"";
}

std::string MIRArrayType::GetCompactMplTypeName() const {
  std::stringstream ss;
  ss << ""A"";
  MIRType *elemType = GetElemType();
  ss << elemType->GetCompactMplTypeName();
  return ss.str();
}

void MIRFarrayType::Dump(int indent, bool dontUseName) const {
  if (!dontUseName && CheckAndDumpTypeName(nameStrIdx, nameIsLocal)) {
    return;
  }
  LogInfo::MapleLogger() << ""<[] "";
  GlobalTables::GetTypeTable().GetTypeFromTyIdx(elemTyIdx)->Dump(indent + 1);
  LogInfo::MapleLogger() << "">"";
}

std::string MIRFarrayType::GetCompactMplTypeName() const {
  std::stringstream ss;
  ss << ""A"";
  MIRType *elemType = GetElemType();
  ss << elemType->GetCompactMplTypeName();
  return ss.str();
}

const std::string &MIRJarrayType::GetJavaName(void) {
  if (javaNameStrIdx == GStrIdx(0)) {
    DetermineName();
  }
  return GlobalTables::GetStrTable().GetStringFromStrIdx(javaNameStrIdx);
}

MIRStructType *MIRJarrayType::GetParentType() {
  if (parentTyIdx == TyIdx(0)) {
    GStrIdx jloStridx = GlobalTables::GetStrTable().GetStrIdxFromName(NameMangler::kJavaLangObjectStr);
    parentTyIdx = GlobalTables::GetTypeNameTable().GetTyIdxFromGStrIdx(jloStridx);
    ASSERT((parentTyIdx != TyIdx(0)), ""cannot find type for java.lang.Object"");
  }

  return static_cast<MIRStructType *>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentTyIdx));
}

void MIRJarrayType::DetermineName() {
  if (javaNameStrIdx != GStrIdx(0)) {
    return;  // already determined
  }
  MIRType *elemtype = GlobalTables::GetTypeTable().GetTypeFromTyIdx(elemTyIdx);
  dim = 1;
  std::string basename;

  while (1) {
    if (elemtype->typeKind == kTypeScalar) {
      basename = GetPrimTypeJavaName(elemtype->primType);
      fromPrimitive = true;
      break;
    } else if (elemtype->typeKind == kTypePointer) {
      MIRType *ptype = static_cast<MIRPtrType *>(elemtype)->GetPointedType();
      ASSERT(ptype, ""ptype is null in MIRJarrayType::DetermineName"");
      if (ptype->typeKind == kTypeByName || ptype->typeKind == kTypeClass || ptype->typeKind == kTypeInterface ||
          ptype->typeKind == kTypeClassIncomplete || ptype->typeKind == kTypeInterfaceIncomplete) {
        basename = static_cast<MIRStructType *>(ptype)->GetName();
        fromPrimitive = false;
        break;
      } else if (ptype->typeKind == kTypeArray || ptype->typeKind == kTypeJArray) {
        elemtype = dynamic_cast<MIRJarrayType *>(ptype)->GetElemType();
        ASSERT(elemtype, ""elemtype is null in MIRJarrayType::DetermineName"");
        dim++;
      } else {
        ASSERT(false, ""unexpected type!"");
      }
    } else {
      ASSERT(false, ""unexpected type!"");
    }
  }
  std::string name;
  int i = dim;
  while (i-- > 0) {
    name += JARRAY_PREFIX_STR;
  }

  name += basename;

  javaNameStrIdx = GlobalTables::GetStrTable().GetOrCreateStrIdxFromName(name);
}

MIRType *MIRPtrType::GetPointedType() const {
  return GlobalTables::GetTypeTable().GetTypeFromTyIdx(pointedTyIdx);
}

bool MIRType::IsVolatile(int fieldID) {
  if (fieldID == 0) {
    return HasVolatileField();
  }
  return static_cast<const MIRStructType*>(this)->IsFieldVolatile(fieldID);
}

bool MIRPtrType::PointsToConstString() const {
  GStrIdx typenameIdx = GetPointedType()->nameStrIdx;
  std::string typeName = GlobalTables::GetStrTable().GetStringFromStrIdx(typenameIdx);
  return typeName == NameMangler::kJavaLangStringStr;
}

void MIRPtrType::Dump(int indent, bool dontUseName) const {
  if (!dontUseName && CheckAndDumpTypeName(nameStrIdx, nameIsLocal)) {
    return;
  }
  MIRType *pointedty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(pointedTyIdx);
  if (pointedty->typeKind == kTypeFunction) {  // no * for function pointer
    pointedty->Dump(indent);
  } else {
    LogInfo::MapleLogger() << ""<* "";
    pointedty->Dump(indent + 1);
    typeAttrs.DumpAttributes();
    LogInfo::MapleLogger() << "">"";
  }
}

void MIRBitfieldType::Dump(int indent, bool dontUseName) const {
  LogInfo::MapleLogger() << "":"" << static_cast<int>(fieldSize) << "" "" << GetPrimTypeName(primType);
}

size_t MIRClassType::GetSize() const {
  if (parentTyIdx == TyIdx(0)) {
    return MIRStructType::GetSize();
  }
  MIRClassType *parentType = static_cast<MIRClassType *>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentTyIdx));
  uint32 prntSize = parentType->GetSize();
  if (prntSize == 0) {
    return 0;
  }
  uint32 structSize = MIRStructType::GetSize();
  if (structSize == 0) {
    return 0;
  }
  return prntSize + structSize;
}

FieldID MIRClassType::GetFirstLocalFieldID() const {
  if (!IsLocal()) {
    return 0;
  }
  if (parentTyIdx == 0) {
    return 1;
  }

  constexpr uint8 lastFieldIDOffset = 2;
  constexpr uint8 firstLocalFieldIDOffset = 1;
  const auto *parentClassType =
      static_cast<const MIRClassType*>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentTyIdx));
  return !parentClassType->IsLocal() ? parentClassType->GetLastFieldID() + lastFieldIDOffset
                                     : parentClassType->GetFirstLocalFieldID() + firstLocalFieldIDOffset;
}

const MIRClassType *MIRClassType::GetExceptionRootType() const {
  GStrIdx ehtynameidx = GlobalTables::GetStrTable().GetStrIdxFromName(NameMangler::kJavaLangObjectStr);
  const MIRClassType *subclasstype = this;
  while (subclasstype != nullptr && subclasstype->nameStrIdx != ehtynameidx) {
    subclasstype = static_cast<const MIRClassType *>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(subclasstype->parentTyIdx));
  }
  return subclasstype;
}

MIRClassType *MIRClassType::GetExceptionRootType() {
  return const_cast<MIRClassType*>(const_cast<const MIRClassType*>(this)->GetExceptionRootType());
}

bool MIRClassType::IsExceptionType() const {
  GStrIdx ehtynameidx = GlobalTables::GetStrTable().GetStrIdxFromName(NameMangler::kThrowClassStr);
  const MIRClassType *parentclasstype = this;
  while (parentclasstype != nullptr && parentclasstype->nameStrIdx != ehtynameidx) {
    parentclasstype = static_cast<MIRClassType *>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentclasstype->parentTyIdx));
  }
  return parentclasstype != nullptr;
}

FieldID MIRClassType::GetLastFieldID() const {
  FieldID fieldID = fields.size();
  if (parentTyIdx != 0) {
    const auto *parentClassType =
        static_cast<const MIRClassType*>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentTyIdx));
    if (parentClassType != nullptr) {
      fieldID += parentClassType->GetLastFieldID() + 1;
    }
  }
  return fieldID;
}

static void DumpClassOrInterfaceInfo(const MIRStructType &type, int indent) {
  const std::vector<MIRInfoPair> &info = type.GetInfo();
  std::vector<bool> infoIsString = type.GetInfoIsString();
  size_t size = info.size();
  for (size_t i = 0; i < size; ++i) {
    LogInfo::MapleLogger() << '\\n';
    PrintIndentation(indent);
    LogInfo::MapleLogger() << ""@"" << GlobalTables::GetStrTable().GetStringFromStrIdx(info[i].first) << "" "";
    if (!infoIsString[i]) {
      LogInfo::MapleLogger() << info[i].second;
    } else {
      LogInfo::MapleLogger() << ""\\"""" << GlobalTables::GetStrTable().GetStringFromStrIdx(GStrIdx(info[i].second))
                             << ""\\"""";
    }
    if (i != size - 1) {
      LogInfo::MapleLogger() << "","";
    }
  }
}

static uint32 GetInfoFromStrIdx(const std::vector<MIRInfoPair> &info, const GStrIdx &strIdx) {
  for (MIRInfoPair infoPair : info) {
    if (infoPair.first == strIdx) {
      return infoPair.second;
    }
  }
  return 0;
}

uint32 MIRInterfaceType::GetInfo(GStrIdx strIdx) const {
  return GetInfoFromStrIdx(info, strIdx);
}

// return class id or superclass id accroding to input string
uint32 MIRInterfaceType::GetInfo(const std::string &infoStr) const {
  GStrIdx strIdx = GlobalTables::GetStrTable().GetStrIdxFromName(infoStr);
  return GetInfo(strIdx);
}

size_t MIRInterfaceType::GetSize() const {
  if (parentsTyIdx.size() == 0) {
    return MIRStructType::GetSize();
  }
  uint32 size = MIRStructType::GetSize();
  if (size == 0) {
    return 0;
  }
  for (uint32 i = 0; i < parentsTyIdx.size(); i++) {
    MIRInterfaceType *parentType = static_cast<MIRInterfaceType *>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentsTyIdx[i]));
    uint32 prntSize = parentType->GetSize();
    if (prntSize == 0) {
      return 0;
    }
    size += prntSize;
  }
  return size;
}

static void DumpStaticValue(MIREncodedArray staticValue, int indent) {
  if (staticValue.size() == 0) {
    return;
  }

  LogInfo::MapleLogger() << std::endl;
  PrintIndentation(indent);
  LogInfo::MapleLogger() << ""@""
            << ""staticValue"";
  for (uint32 j = 0; j < staticValue.size(); j++) {
    LogInfo::MapleLogger() << "" ["";
    uint8 valueArg = static_cast<uint32>(staticValue[j].encodedValue[0]) >> 5;
    uint8 valueType = static_cast<uint32>(staticValue[j].encodedValue[0]) & 0x1f;
    // kValueNull kValueBoolean
    if (valueType == 0x1e || valueType == 0x1f) {
      valueArg = 1;
    } else {
      valueArg += 2;
    }
    for (uint32 k = 0; k < valueArg; k++) {
      LogInfo::MapleLogger() << static_cast<uint32>(staticValue[j].encodedValue[k]);
      if (k != static_cast<uint32>(valueArg - 1)) {
        LogInfo::MapleLogger() << "" "";
      }
    }
    LogInfo::MapleLogger() << ""]"";
  }
}

static void DumpFields(FieldVector fields, int indent, bool otherfields = false) {
  uint32 size = fields.size();
  for (uint32 i = 0; i < size; i++) {
    LogInfo::MapleLogger() << std::endl;
    PrintIndentation(indent);
    if (!otherfields) {
      LogInfo::MapleLogger() << ""@"";
    } else {
      LogInfo::MapleLogger() << ""^"";
    }
    LogInfo::MapleLogger() << GlobalTables::GetStrTable().GetStringFromStrIdx(fields[i].first) << "" "";
    GlobalTables::GetTypeTable().GetTypeFromTyIdx(fields[i].second.first)->Dump(indent + 1);
    FieldAttrs &fa = fields[i].second.second;
    fa.DumpAttributes();
    if (fa.GetAttr(FLDATTR_static) && fa.GetAttr(FLDATTR_final) &&
        (fa.GetAttr(FLDATTR_public) || fa.GetAttr(FLDATTR_protected))) {
      const char *fieldname = (GlobalTables::GetStrTable().GetStringFromStrIdx(fields[i].first)).c_str();
      MIRSymbol *fieldVar = GlobalTables::GetGsymTable().GetSymbolFromStrIdx(GlobalTables::GetStrTable().GetStrIdxFromName(fieldname));
      if (fieldVar && dynamic_cast<MIRStr16Const *>(fieldVar->value.konst)) {
        LogInfo::MapleLogger() << "" = "";
        fieldVar->value.konst->Dump();
      }
    }
    if (i != size - 1) {
      LogInfo::MapleLogger() << "","";
    }
  }
  return;
}

static void DumpFieldsAsCxx(FieldVector fields, int indent) {
  for (auto &f : fields) {
    PrintIndentation(indent);

    FieldAttrs &fa = f.second.second;
    if (fa.GetAttr(FLDATTR_static)) {
      LogInfo::MapleLogger() << ""// "";
    }

    LogInfo::MapleLogger() << ""/* "";
    fa.DumpAttributes();
    GlobalTables::GetTypeTable().GetTypeFromTyIdx(f.second.first)->Dump(indent + 1);
    LogInfo::MapleLogger() << "" */ "";

    GlobalTables::GetTypeTable().GetTypeFromTyIdx(f.second.first)->DumpAsCxx(indent + 1);

    LogInfo::MapleLogger() << "" "" << GlobalTables::GetStrTable().GetStringFromStrIdx(f.first);
    LogInfo::MapleLogger() << "";"" << std::endl;
  }
}

static void DumpMethods(MethodVector methods, int indent) {
  int size = methods.size();
  for (int i = 0; i < size; i++) {
    LogInfo::MapleLogger() << std::endl;
    PrintIndentation(indent);
    LogInfo::MapleLogger() << ""&"" << GlobalTables::GetGsymTable().GetSymbolFromStIdx(methods[i].first.Idx())->GetName();
    methods[i].second.second.DumpAttributes();
    LogInfo::MapleLogger() << "" ("";
    MIRFuncType *functype = static_cast<MIRFuncType *>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(methods[i].second.first));
    int parmlistsize = functype->paramTypeList.size();
    for (int j = 0; j < parmlistsize; j++) {
      GlobalTables::GetTypeTable().GetTypeFromTyIdx(functype->paramTypeList[j])->Dump(indent + 1);
      if (parmlistsize - 1 != j) {
        LogInfo::MapleLogger() << "","";
      }
    }
    if (functype->isVarArgs) {
      LogInfo::MapleLogger() << "", ..."";
    }
    LogInfo::MapleLogger() << "") "";
    GlobalTables::GetTypeTable().GetTypeFromTyIdx(functype->retTyIdx)->Dump(indent + 1);
    if (i != size - 1) {
      LogInfo::MapleLogger() << "","";
    }
  }
}

static void DumpConstructorsAsCxx(MethodVector methods, int indent) {
  unsigned int i = 0;
  for (auto &m : methods) {
    FuncAttrs &fa = m.second.second;
    if (!fa.GetAttr(FUNCATTR_constructor) || !fa.GetAttr(FUNCATTR_public)) {
      continue;
    }

    MIRFuncType *functype = static_cast<MIRFuncType *>(GlobalTables::GetTypeTable().GetTypeFromTyIdx(m.second.first));

    PrintIndentation(indent);
    LogInfo::MapleLogger() << ""/* "";
    LogInfo::MapleLogger() << ""&"" << GlobalTables::GetGsymTable().GetSymbolFromStIdx(m.first.Idx())->GetName();
    fa.DumpAttributes();
    LogInfo::MapleLogger() << "" ("";
    unsigned int j = 0;
    for (auto &p : functype->paramTypeList) {
      GlobalTables::GetTypeTable().GetTypeFromTyIdx(p)->Dump(indent + 1);
      if (functype->paramTypeList.size() - 1 != j++) {
        LogInfo::MapleLogger() << "", "";
      }
    }
    if (functype->isVarArgs) {
      LogInfo::MapleLogger() << "", ..."";
    }
    LogInfo::MapleLogger() << "") "";
    GlobalTables::GetTypeTable().GetTypeFromTyIdx(functype->retTyIdx)->Dump(indent + 1);
    LogInfo::MapleLogger() << "" */"" << std::endl;

    PrintIndentation(indent);
    LogInfo::MapleLogger() << ""/* "";
    LogInfo::MapleLogger() << NameMangler::DecodeName(GlobalTables::GetGsymTable().GetSymbolFromStIdx(m.first.Idx())->GetName());
    LogInfo::MapleLogger() << "" */"" << std::endl;

    PrintIndentation(indent);
    LogInfo::MapleLogger() << ""extern \\""C\\"" "";
    // return type
    GlobalTables::GetTypeTable().GetTypeFromTyIdx(functype->retTyIdx)->DumpAsCxx(0);

    LogInfo::MapleLogger() << "" "" << GlobalTables::GetGsymTable().GetSymbolFromStIdx(m.first.Idx())->GetName() << ""( "";

    j = 0;
    for (auto &p : functype->paramTypeList) {
      GlobalTables::GetTypeTable().GetTypeFromTyIdx(p)->DumpAsCxx(indent + 1);
      if (functype->paramTypeList.size() - 1 != j++) {
        LogInfo::MapleLogger() << "", "";
      }
    }
    if (functype->isVarArgs) {
      LogInfo::MapleLogger() << "", ..."";
    }
    LogInfo::MapleLogger() << "")"";
    if (methods.size() - 1 != i++) {
      LogInfo::MapleLogger() << "";"" << std::endl;
    }
  }
}

static void DumpInterfaces(std::vector<TyIdx> interfaces, int indent) {
  uint32 size = interfaces.size();
  for (uint32 i = 0; i < size; i++) {
    LogInfo::MapleLogger() << std::endl;
    PrintIndentation(indent);
    GStrIdx strIdx = GlobalTables::GetTypeTable().GetTypeFromTyIdx(interfaces[i])->nameStrIdx;
    LogInfo::MapleLogger() << ""$"" << GlobalTables::GetStrTable().GetStringFromStrIdx(strIdx);
    if (i != size - 1) {
      LogInfo::MapleLogger() << "","";
    }
  }
}

size_t MIRStructType::GetSize() const {
  if (typeKind == kTypeUnion) {
    if (fields.size() == 0) {
      return isCPlusPlus ? 1 : 0;
    }
    size_t maxSize = 0;
    for (size_t i = 0; i < fields.size(); ++i) {
      TyidxFieldAttrPair tfap = GetTyidxFieldAttrPair(i);
      MIRType *fieldType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(tfap.first);
      size_t size = RoundUp(fieldType->GetSize(), tfap.second.GetAlign());
      if (maxSize < size) {
        maxSize = size;
      }
    }
    return maxSize;
  }
  // since there may be bitfields, perform a layout process for the fields
  size_t byteOfst = 0;
  size_t bitOfst = 0;
  for (size_t i = 0; i < fields.size(); ++i) {
    TyidxFieldAttrPair tfap = GetTyidxFieldAttrPair(i);
    MIRType *fieldType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(tfap.first);
    if (fieldType->typeKind != kTypeBitField) {
      if (byteOfst * 8 < bitOfst) {
        byteOfst = (bitOfst >> 3) + 1;
      }
      byteOfst = RoundUp(byteOfst, std::max(fieldType->GetAlign(), tfap.second.GetAlign()));
      byteOfst += fieldType->GetSize();
      bitOfst = byteOfst * 8;
    } else {
      MIRBitfieldType *bitfType = static_cast<MIRBitfieldType *>(fieldType);
      if (bitfType->fieldSize == 0) {  // special case, for aligning purpose
        bitOfst = RoundUp(bitOfst, GetPrimTypeBitSize(bitfType->primType));
        byteOfst = bitOfst >> 3;
      } else {
        if (RoundDown(bitOfst + bitfType->fieldSize - 1, GetPrimTypeBitSize(bitfType->primType)) !=
            RoundDown(bitOfst, GetPrimTypeBitSize(bitfType->primType))) {
          bitOfst = RoundUp(bitOfst, GetPrimTypeBitSize(bitfType->primType));
          byteOfst = bitOfst >> 3;
        }
        bitOfst += bitfType->fieldSize;
        byteOfst = bitOfst >> 3;
      }
    }
  }
  if (byteOfst * 8 < bitOfst) {
    byteOfst = (bitOfst >> 3) + 1;
  }
  byteOfst = RoundUp(byteOfst, GetAlign());
  if (byteOfst == 0 && isCPlusPlus) {
    return 1;  // empty struct in C++ has size 1
  }
  return byteOfst;
}

uint32 MIRStructType::GetAlign() const {
  if (fields.size() == 0) {
    return 0;
  }
  uint8 maxAlign = 1;
  for (size_t i = 0; i < fields.size(); ++i) {
    TyidxFieldAttrPair tfap = GetTyidxFieldAttrPair(i);
    MIRType *fieldType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(tfap.first);
    uint32 algn = fieldType->GetAlign();
    if (fieldType->typeKind == kTypeBitField) {
      algn = GetPrimTypeSize(fieldType->primType);
    } else {
      algn = std::max(algn, tfap.second.GetAlign());
    }
    if (maxAlign < algn) {
      maxAlign = algn;
    }
  }
  return maxAlign;
}

void MIRStructType::DumpFieldsAndMethods(int indent, bool hasMethod) const {
  DumpFields(fields, indent);
  bool hasField = !fields.empty();
  bool hasStaticField = !staticFields.empty();
  if (hasField && hasStaticField) {
    LogInfo::MapleLogger() << "","";
  }
  DumpFields(staticFields, indent, true);
  bool hasFieldOrStaticField = hasField || hasStaticField;
  bool hasParentField = !parentFields.empty();
  if (hasFieldOrStaticField && hasParentField) {
    LogInfo::MapleLogger() << "","";
  }
  DumpFields(parentFields, indent, true);
  if ((hasFieldOrStaticField || hasParentField) && hasMethod) {
    LogInfo::MapleLogger() << "","";
  }
  DumpMethods(methods, indent);
}

void MIRStructType::Dump(int indent, bool dontUseName) const {
  if (!dontUseName && CheckAndDumpTypeName(nameStrIdx, nameIsLocal)) {
    return;
  }
  LogInfo::MapleLogger() << ((typeKind == kTypeStruct) ? ""<struct {""
                                                       : ((typeKind == kTypeUnion) ? ""<union {""
                                                                                   : ""<structincomplete {""));
  DumpFieldsAndMethods(indent, !methods.empty());
  LogInfo::MapleLogger() << ""}>"";
}

uint32 MIRClassType::GetInfo(GStrIdx strIdx) const {
  return GetInfoFromStrIdx(info, strIdx);
}

// return class id or superclass id accroding to input string
uint32 MIRClassType::GetInfo(const std::string &infoStr) const {
  GStrIdx strIdx = GlobalTables::GetStrTable().GetStrIdxFromName(infoStr);
  return GetInfo(strIdx);
}

bool MIRClassType::IsFinal() const {
  uint32 attrstridx = GetInfo(GlobalTables::GetStrTable().GetOrCreateStrIdxFromName(""INFO_attribute_string""));
  CHECK(attrstridx < GlobalTables::GetStrTable().StringTableSize(), ""out of range of vector"");
  const std::string kAttrstring = GlobalTables::GetStrTable().GetStringFromStrIdx(attrstridx);
  return kAttrstring.find("" final "") != std::string::npos;
}

bool MIRClassType::IsAbstract() const {
  uint32 attrStrIdx = GetInfo(GlobalTables::GetStrTable().GetOrCreateStrIdxFromName(""INFO_attribute_string""));
  CHECK(attrStrIdx < GlobalTables::GetStrTable().StringTableSize(), ""out of range of vector"");
  const std::string &kAttrString = GlobalTables::GetStrTable().GetStringFromStrIdx(GStrIdx(attrStrIdx));
  return kAttrString.find("" abstract "") != std::string::npos;
}

bool MIRClassType::IsInner() const {
  const std::string kName = GetName();
  return kName.find(""_24"") != std::string::npos;
}

static void DumpInfoPragmaStaticValue(const std::vector<MIRInfoPair> &info, const std::vector<MIRPragma*> &pragmaVec,
                                      const MIREncodedArray &staticValue, int indent, bool hasFieldMethodOrInterface) {
  bool hasPragma = pragmaVec.size();
  bool hasStaticValue = staticValue.size();
  if (!info.empty() && (hasPragma || hasStaticValue || hasFieldMethodOrInterface)) {
    LogInfo::MapleLogger() << "","";
  }
  size_t size = pragmaVec.size();
  for (size_t i = 0; i < size; ++i) {
    pragmaVec[i]->Dump(indent);
    if (i != size - 1) {
      LogInfo::MapleLogger() << "","";
    }
  }
  if (hasPragma && (hasStaticValue || hasFieldMethodOrInterface)) {
    LogInfo::MapleLogger() << "","";
  }
  DumpStaticValue(staticValue, indent);
  if (hasStaticValue && hasFieldMethodOrInterface) {
    LogInfo::MapleLogger() << "","";
  }
}

void MIRClassType::Dump(int indent, bool dontUseName) const {
  if (!dontUseName && CheckAndDumpTypeName(nameStrIdx, nameIsLocal)) {
    return;
  }
  LogInfo::MapleLogger() << ((typeKind == kTypeClass) ? ""<class "" : ""<classincomplete "");
  if (parentTyIdx != 0) {
    GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentTyIdx)->Dump(indent + 1);
    LogInfo::MapleLogger() << "" "";
  }
  LogInfo::MapleLogger() << ""{"";
  DumpClassOrInterfaceInfo(*this, indent);
  bool hasFieldMethodOrInterface = !(fields.empty() && parentFields.empty() && staticFields.empty() &&
                                     methods.empty() && interfacesImplemented.empty());
  DumpInfoPragmaStaticValue(info, pragmaVec, staticValue, indent, hasFieldMethodOrInterface);

  bool hasMethod = !methods.empty();
  bool hasImplementedInterface = !interfacesImplemented.empty();
  DumpFieldsAndMethods(indent, hasMethod || hasImplementedInterface);
  if (hasMethod && hasImplementedInterface) {
    LogInfo::MapleLogger() << "","";
  }
  DumpInterfaces(interfacesImplemented, indent);
  LogInfo::MapleLogger() << ""}>"";
}

void MIRClassType::DumpAsCxx(int indent) const {
  LogInfo::MapleLogger() << ""{"" << std::endl;
  DumpFieldsAsCxx(fields, indent);
  LogInfo::MapleLogger() << ""};"" << std::endl;
  DumpConstructorsAsCxx(methods, 0);
}

void MIRInterfaceType::Dump(int indent, bool dontUseName) const {
  if (!dontUseName && CheckAndDumpTypeName(nameStrIdx, nameIsLocal)) {
    return;
  }
  LogInfo::MapleLogger() << ((typeKind == kTypeInterface) ? ""<interface "" : ""<interfaceincomplete "");
  for (TyIdx idx : parentsTyIdx) {
    GlobalTables::GetTypeTable().GetTypeFromTyIdx(idx)->Dump(0);
    LogInfo::MapleLogger() << "" "";
  }
  LogInfo::MapleLogger() << "" {"";
  DumpClassOrInterfaceInfo(*this, indent);
  bool hasFieldOrMethod = !(fields.empty() && staticFields.empty() && parentFields.empty() && methods.empty());
  DumpInfoPragmaStaticValue(info, pragmaVec, staticValue, indent, hasFieldOrMethod);
  DumpFieldsAndMethods(indent, !methods.empty());
  LogInfo::MapleLogger() << ""}>"";
}

void MIRTypeByName::Dump(int indent, bool dontUseName) const {
  const std::string &name = GlobalTables::GetStrTable().GetStringFromStrIdx(nameStrIdx);
  LogInfo::MapleLogger() << (nameIsLocal ? ""<%"" : ""<$"") << name << "">"";
}

void MIRTypeParam::Dump(int indent, bool dontUseName) const {
  LogInfo::MapleLogger() << ""<"";
  const std::string &name = GlobalTables::GetStrTable().GetStringFromStrIdx(nameStrIdx);
  LogInfo::MapleLogger() << ""!"" << name << "">"";
}

void MIRInstantVectorType::Dump(int indent, bool dontUseName) const {
  LogInfo::MapleLogger() << ""{"";
  for (uint32 i = 0; i < instantVec.size(); i++) {
    TypePair tpair = instantVec[i];
    if (i != 0) {
      LogInfo::MapleLogger() << "", "";
    }
    MIRType *typeparmty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(tpair.first);
    const std::string &name = GlobalTables::GetStrTable().GetStringFromStrIdx(typeparmty->nameStrIdx);
    LogInfo::MapleLogger() << ""!"" << name;
    LogInfo::MapleLogger() << ""="";
    MIRType *realty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(tpair.second);
    realty->Dump(0);
  }
  LogInfo::MapleLogger() << ""}"";
}

void MIRGenericInstantType::Dump(int indent, bool dontUseName) const {
  LogInfo::MapleLogger() << ""<"";
  MIRType *genericty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(genericTyIdx);
  DumpTypename(genericty->nameStrIdx, genericty->nameIsLocal);
  MIRInstantVectorType::Dump(indent, dontUseName);
  LogInfo::MapleLogger() << "">"";
}

bool MIRType::Equalto(const MIRType &mirType) const {
  return typeKind == mirType.typeKind && primType == mirType.primType;
}

bool MIRPtrType::Equalto(const MIRType &type) const {
  if (typeKind != type.GetKind() || GetPrimType() != type.GetPrimType()) {
    return false;
  }
  const auto &pType = static_cast<const MIRPtrType&>(type);
  return pointedTyIdx == pType.pointedTyIdx && typeAttrs == pType.typeAttrs;
}

bool MIRArrayType::Equalto(const MIRType &type) const {
  if (type.typeKind != typeKind) {
    return false;
  }
  const MIRArrayType *p = dynamic_cast<const MIRArrayType*>(&type);
  CHECK_FATAL(p != nullptr, ""null ptr check "");
  if (dim != p->dim || eTyIdx != p->eTyIdx || typeAttrs != p->typeAttrs) {
    return false;
  }

  for (int i = 0; i < dim; i++) {
    if (sizeArray[i] != p->sizeArray[i]) {
      return false;
    }
  }
  return true;
}

MIRType *MIRArrayType::GetElemType() const {
  return GlobalTables::GetTypeTable().GetTypeFromTyIdx(eTyIdx);
}

std::string MIRArrayType::GetMplTypeName() const {
  std::stringstream ss;
  ss << ""<[] "";
  MIRType *elemType = GetElemType();
  ss << elemType->GetMplTypeName();
  ss << "">"";
  return ss.str();
}

bool MIRArrayType::HasFields() const {
  MIRType *elemType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(eTyIdx);
  return elemType->HasFields();
}

size_t MIRArrayType::NumberOfFieldIDs() {
  MIRType *elemType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(eTyIdx);
  return elemType->NumberOfFieldIDs();
}

MIRStructType *MIRArrayType::EmbeddedStructType() {
  MIRType *elemType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(eTyIdx);
  return elemType->EmbeddedStructType();
}

MIRType *MIRFarrayType::GetElemType()  const {
  return GlobalTables::GetTypeTable().GetTypeFromTyIdx(elemTyIdx);
}

bool MIRFarrayType::Equalto(const MIRType &ty) const {
  if (ty.typeKind != typeKind) {
    return false;
  }
  const MIRFarrayType *pty = dynamic_cast<const MIRFarrayType*>(&ty);
  CHECK_FATAL(pty, ""make sure the elemTyIdx is not nullptr"");
  return elemTyIdx == pty->elemTyIdx;
}

std::string MIRFarrayType::GetMplTypeName() const {
  std::stringstream ss;
  ss << ""<[] "";
  MIRType *elemType = GetElemType();
  ss << elemType->GetMplTypeName();
  ss << "">"";
  return ss.str();
}

bool MIRFarrayType::HasFields() const {
  MIRType *elemType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(elemTyIdx);
  return elemType->HasFields();
}

size_t MIRFarrayType::NumberOfFieldIDs() {
  MIRType *elemType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(elemTyIdx);
  return elemType->NumberOfFieldIDs();
}

MIRStructType *MIRFarrayType::EmbeddedStructType() {
  MIRType *elemType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(elemTyIdx);
  return elemType->EmbeddedStructType();
}

bool MIRFuncType::Equalto(const MIRType &type) const {
  if (type.typeKind != typeKind) {
    return false;
  }
  const auto &pType = static_cast<const MIRFuncType&>(type);
  return (pType.retTyIdx == retTyIdx && pType.paramTypeList == paramTypeList &&
          pType.isVarArgs == isVarArgs && pType.paramAttrsList == paramAttrsList);
}

bool MIRBitfieldType::Equalto(const MIRType &ty) const {
  if (ty.typeKind != typeKind) {
    return false;
  }
  const MIRBitfieldType *p = dynamic_cast<const MIRBitfieldType*>(&ty);
  CHECK_FATAL(p != nullptr, "" null ptr check "");
  return p->primType == primType &&
         //  p->typeKind == typeKind &&
         p->fieldSize == fieldSize;
}

bool MIRStructType::Equalto(const MIRType &ty) const {
  if (ty.typeKind != typeKind) {
    return false;
  }
  const MIRStructType *p = dynamic_cast<const MIRStructType*>(&ty);
  CHECK_FATAL(p != nullptr, ""p is null in MIRStructType::Equalto"");
  if (fields != p->fields) {
    return false;
  }
  if (staticFields != p->staticFields) {
    return false;
  }
  if (parentFields != p->parentFields) {
    return false;
  }
  if (methods != p->methods) {
    return false;
  }
  return true;
}

std::string MIRStructType::GetCompactMplTypeName() const {
  return GlobalTables::GetStrTable().GetStringFromStrIdx(nameStrIdx);
}

MIRType *MIRStructType::GetElemType(uint32 n) const {
  return GlobalTables::GetTypeTable().GetTypeFromTyIdx(GetElemTyidx(n));
}

MIRType *MIRStructType::GetFieldType(FieldID fieldID) {
  if (fieldID == 0) {
    return this;
  }
  FieldPair fldpair = TraverseToField(fieldID);
  return GlobalTables::GetTypeTable().GetTypeFromTyIdx(fldpair.second.first);
}

bool MIRStructType::IsLocal() const {
  return GlobalTables::GetGsymTable().GetStIdxFromStrIdx(nameStrIdx).Idx() != 0;
}

std::string MIRStructType::GetMplTypeName() const {
  std::stringstream ss;
  ss << ""<$"";
  ss << GlobalTables::GetStrTable().GetStringFromStrIdx(nameStrIdx);
  ss << "">"";
  return ss.str();
}

bool MIRClassType::Equalto(const MIRType &ty) const {
  if (ty.typeKind != typeKind) {
    return false;
  }
  bool structeq = MIRStructType::Equalto(ty);
  if (!structeq) {
    return false;
  }

  const MIRClassType &classty = static_cast<const MIRClassType &>(ty);
  // classes have parent except empty/thirdparty classes
  if (parentTyIdx != classty.parentTyIdx) {
    return false;
  }

  if (interfacesImplemented != classty.interfacesImplemented) {
    return false;
  }
  if (info != classty.info) {
    return false;
  }
  if (infoIsString != classty.infoIsString) {
    return false;
  }
  return true;
}

bool MIRInterfaceType::Equalto(const MIRType &ty) const {
  if (ty.typeKind != typeKind) {
    return false;
  }
  bool structeq = MIRStructType::Equalto(ty);
  if (!structeq) {
    return false;
  }

  const MIRInterfaceType &interfacety = static_cast<const MIRInterfaceType &>(ty);
  if (parentsTyIdx != interfacety.parentsTyIdx) {
    return false;
  }
  if (info != interfacety.info) {
    return false;
  }
  if (infoIsString != interfacety.infoIsString) {
    return false;
  }
  return true;
}

bool MIRTypeByName::Equalto(const MIRType &ty) const {
  if (ty.typeKind != typeKind) {
    return false;
  }
  const MIRTypeByName *pty = dynamic_cast<const MIRTypeByName*>(&ty);
  CHECK_FATAL(pty != nullptr, ""null ptr check "");
  return nameStrIdx == pty->nameStrIdx && nameIsLocal == pty->nameIsLocal;
}

bool MIRTypeParam::Equalto(const MIRType &ty) const {
  if (ty.typeKind != typeKind) {
    return false;
  }
  const MIRTypeParam *pty = dynamic_cast<const MIRTypeParam*>(&ty);
  CHECK_FATAL(pty != nullptr, ""null ptr check"");
  return nameStrIdx == pty->nameStrIdx;
}

bool MIRInstantVectorType::Equalto(const MIRType &ty) const {
  if (ty.typeKind != typeKind) {
    return false;
  }
  const MIRInstantVectorType *p = dynamic_cast<const MIRInstantVectorType*>(&ty);
  CHECK_FATAL(p, ""null ptr check "");
  if (instantVec.size() != p->instantVec.size()) {
    return false;
  }
  for (uint32 i = 0; i < instantVec.size(); i++) {
    if (instantVec[i] != p->instantVec[i]) {
      return false;
    }
  }
  return true;
}

bool MIRGenericInstantType::Equalto(const MIRType &ty) const {
  if (!MIRInstantVectorType::Equalto(ty)) {
    return false;
  }
  const MIRGenericInstantType *p = dynamic_cast<const MIRGenericInstantType*>(&ty);
  CHECK_FATAL(p, ""null ptr check "");
  return genericTyIdx == p->genericTyIdx;
}

// in the search, curfieldid is being decremented until it reaches 1
FieldPair MIRStructType::TraverseToFieldRef(FieldID &fieldID) const {
  if (!fields.size()) {
    return FieldPair(GStrIdx(0), TyidxFieldAttrPair(TyIdx(0), FieldAttrs()));
  }

  uint32 fieldidx = 0;
  FieldPair curpair = fields[0];
  while (fieldID > 1) {
    fieldID--;
    MIRType *curfieldtype = GlobalTables::GetTypeTable().GetTypeFromTyIdx(curpair.second.first);
    MIRStructType *substructty = curfieldtype->EmbeddedStructType();
    if (substructty != nullptr) {
      curpair = substructty->TraverseToFieldRef(fieldID);
      if (fieldID == 1 && curpair.second.first != TyIdx(0)) {
        return curpair;
      }
    }
    fieldidx++;
    if (fieldidx == fields.size()) {
      return FieldPair(GStrIdx(0), TyidxFieldAttrPair(TyIdx(0), FieldAttrs()));
    }
    curpair = fields[fieldidx];
  }
  return curpair;
}

FieldPair MIRStructType::TraverseToField(FieldID fieldID) const {
  if (fieldID >= 0) {
    return TraverseToFieldRef(fieldID);
  }
  // in parentFields
  uint32 prntfieldidx = -fieldID;
  if (parentFields.size() == 0 || prntfieldidx > parentFields.size()) {
    return FieldPair(GStrIdx(0), TyidxFieldAttrPair(TyIdx(0), FieldAttrs()));
  }
  return parentFields[prntfieldidx - 1];
}

FieldPair MIRStructType::TraverseToField(GStrIdx fieldstridx) const {
  if (fields.size() == 0 && staticFields.size() == 0) {
    return FieldPair(GStrIdx(0), TyidxFieldAttrPair(TyIdx(0), FieldAttrs()));
  }
  if (fields.size() > 0) {
    for (FieldPair field : fields) {
      if (field.first == fieldstridx) {
        return field;
      }
    }
  }
  if (staticFields.size() > 0) {
    for (FieldPair field : staticFields) {
      if (field.first == fieldstridx) {
        return field;
      }
    }
  }
  if (parentFields.size() > 0) {
    for (FieldPair field : parentFields) {
      if (field.first == fieldstridx) {
        return field;
      }
    }
  }
  return FieldPair(GStrIdx(0), TyidxFieldAttrPair(TyIdx(0), FieldAttrs()));
}

// go through all the fields to check if there is volatile attribute set;
bool MIRStructType::HasVolatileField() {
  if (hasVolatileFieldSet) {
    return hasVolatileField;
  }
  hasVolatileFieldSet = true;
  for (uint32 i = 0; i < fields.size(); i++) {
    if (fields[i].second.second.GetAttr(FLDATTR_volatile)) {
      hasVolatileField = true;
      return true;
    }
    MIRType *fldty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(fields[i].second.first);
    MIRTypeKind fldknd = fldty->GetKind();
    if (fldknd == kTypeStruct || fldknd == kTypeStructIncomplete || fldknd == kTypeClass ||
        fldknd == kTypeClassIncomplete || fldknd == kTypeInterface || fldknd == kTypeInterfaceIncomplete) {
      if (static_cast<MIRStructType *>(fldty)->HasVolatileField()) {
        hasVolatileField = true;
        return true;
      }
    }
  }
  for (uint32 i = 0; i < parentFields.size(); i++) {
    if (parentFields[i].second.second.GetAttr(FLDATTR_volatile)) {
      hasVolatileField = true;
      return true;
    }
    MIRType *fldty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentFields[i].second.first);
    MIRTypeKind fldknd = fldty->GetKind();
    if (fldknd == kTypeStruct || fldknd == kTypeStructIncomplete || fldknd == kTypeClass ||
        fldknd == kTypeClassIncomplete || fldknd == kTypeInterface || fldknd == kTypeInterfaceIncomplete)
      if (static_cast<MIRStructType *>(fldty)->HasVolatileField()) {
        hasVolatileField = true;
        return true;
      }
  }
  if (GetKind() == kTypeClass || GetKind() == kTypeClassIncomplete) {
    MIRClassType *thisclassty = static_cast<MIRClassType *>(this);
    if (thisclassty->parentTyIdx != 0) {
      // check if parent class has volatile field
      MIRType *parentty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(thisclassty->parentTyIdx);
      if (static_cast<MIRStructType *>(parentty)->HasVolatileField()) {
        hasVolatileField = true;
        return true;
      }
    }
  } else if (GetKind() == kTypeInterface || GetKind() == kTypeInterfaceIncomplete) {
    MIRInterfaceType *thisinterfacety = static_cast<MIRInterfaceType *>(this);
    // check if the parent classes have volatile field
    for (uint32 i = 0; i < thisinterfacety->parentsTyIdx.size(); i++) {
      TyIdx prnttyidx = thisinterfacety->parentsTyIdx[i];
      MIRType *prntty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(prnttyidx);
      if (static_cast<MIRStructType *>(prntty)->HasVolatileField()) {
        hasVolatileField = true;
        return true;
      }
    }
  }
  hasVolatileField = false;
  return false;
}

// go through all the fields to check if there is generic attribute set;
bool MIRStructType::HasTypeParam() const {
  for (uint32 i = 0; i < fields.size(); i++)
    if (fields[i].second.second.GetAttr(FLDATTR_generic)) {
      return true;
    }
  for (uint32 i = 0; i < parentFields.size(); i++)
    if (parentFields[i].second.second.GetAttr(FLDATTR_generic)) {
      return true;
    }
  if (GetKind() == kTypeClass || GetKind() == kTypeClassIncomplete) {
    const MIRClassType *thisclassty = static_cast<const MIRClassType *>(this);
    if (thisclassty->parentTyIdx != 0) {
      // check if parent class has type parameter
      MIRType *parentty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(thisclassty->parentTyIdx);
      if (parentty->HasTypeParam()) {
        return true;
      }
    }
  } else if (GetKind() == kTypeInterface || GetKind() == kTypeInterfaceIncomplete) {
    const MIRInterfaceType *thisinterfacety = static_cast<const MIRInterfaceType *>(this);
    // check if the parent classes have type parameter
    for (uint32 i = 0; i < thisinterfacety->parentsTyIdx.size(); i++) {
      TyIdx prnttyidx = thisinterfacety->parentsTyIdx[i];
      MIRType *prntty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(prnttyidx);
      if (prntty->HasTypeParam()) {
        return true;
      }
    }
  }
  return false;
}

size_t MIRClassType::NumberOfFieldIDs() {
  size_t parentFieldIDs = 0;
  if (parentTyIdx != TyIdx(0)) {
    MIRType *parentty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentTyIdx);
    parentFieldIDs = parentty->NumberOfFieldIDs();
  }
  return parentFieldIDs + MIRStructType::NumberOfFieldIDs();
}

FieldPair MIRClassType::TraverseToFieldRef(FieldID &fieldID) const {
  if (parentTyIdx != TyIdx(0)) {
    MIRClassType *parentclassty = MIR_DYN_CAST(GlobalTables::GetTypeTable().GetTypeFromTyIdx(parentTyIdx), MIRClassType *);
    if (parentclassty) {
      fieldID--;
      FieldPair curpair = parentclassty->TraverseToFieldRef(fieldID);
      if (fieldID == 1 && curpair.second.first != TyIdx(0)) {
        return curpair;
      }
    }
  }
  return MIRStructType::TraverseToFieldRef(fieldID);
}

// fields in interface are all static and are global, won't be accessed through fields
FieldPair MIRInterfaceType::TraverseToFieldRef(FieldID &fieldID) const {
  return FieldPair(GStrIdx(0), TyidxFieldAttrPair(TyIdx(0), FieldAttrs()));
  ;
}

TyidxFieldAttrPair MIRPtrType::GetPointedTyidxFldAttrPairWithFieldId(FieldID fldid) const {
  if (fldid == 0) {
    return TyidxFieldAttrPair(pointedTyIdx, FieldAttrs());
  }
  MIRType *ty = GlobalTables::GetTypeTable().GetTypeFromTyIdx(pointedTyIdx);
  MIRStructType *structty = ty->EmbeddedStructType();
  CHECK_FATAL(structty,
         ""MIRPtrType::GetPointedTyidxWithFieldId(): cannot have non-zero fieldID for something other than a struct"");
  return structty->TraverseToField(fldid).second;
}

TyIdx MIRPtrType::GetPointedTyidxWithFieldId(FieldID fldid) const {
  return GetPointedTyidxFldAttrPairWithFieldId(fldid).first;
}

std::string MIRPtrType::GetMplTypeName() const {
  std::stringstream ss;
  ss << ""<* "";
  MIRType *pointedType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(pointedTyIdx);
  CHECK_FATAL(pointedType != nullptr, ""invalid ptr type"");
  ss << pointedType->GetMplTypeName();
  ss << "">"";
  return ss.str();
}

std::string MIRPtrType::GetCompactMplTypeName() const {
  MIRType *pointedType = GlobalTables::GetTypeTable().GetTypeFromTyIdx(pointedTyIdx);
  CHECK_FATAL(pointedType != nullptr, ""invalid ptr type"");
  return pointedType->GetCompactMplTypeName();
}

size_t MIRStructType::NumberOfFieldIDs() {
  size_t count = 0;
  for (FieldPair curpair : fields) {
    count++;
    MIRType *curfieldtype = GlobalTables::GetTypeTable().GetTypeFromTyIdx(curpair.second.first);
    count += curfieldtype->NumberOfFieldIDs();
  }
  return count;
}

TypeAttrs FieldAttrs::ConvertToTypeAttrs() {
  TypeAttrs attr;
  for (uint32 i = 0; i < 64; i++) {
    if ((attrFlag & (1ULL << i)) == 0) {
      continue;
    }
    FldAttrKind tA = static_cast<FldAttrKind>(i);
    switch (tA) {
#define FIELD_ATTR
#define ATTR(STR)               \\
    case FLDATTR_##STR:         \\
      attr.SetAttr(ATTR_##STR); \\
      break;
#include ""all_attributes.def""
#undef ATTR
#undef FIELD_ATTR
      default:
        CHECK_FATAL(false, ""unknown TypeAttrs"");
        break;
    }
  }
  return attr;
}

TypeAttrs GenericAttrs::ConvertToTypeAttrs() {
  TypeAttrs attr;
  for (uint32 i = 0; i < 64; i++) {
    if ((attrFlag & (1ULL << i)) == 0) {
      continue;
    }
    GenericAttrKind tA = static_cast<GenericAttrKind>(i);
    switch (tA) {
#define TYPE_ATTR
#define ATTR(STR)               \\
    case GENATTR_##STR:         \\
      attr.SetAttr(ATTR_##STR); \\
      break;
#include ""all_attributes.def""
#undef ATTR
#undef TYPE_ATTR
      default:
        CHECK_FATAL(false, ""unknown TypeAttrs"");
        break;
    }
  }
  return attr;
}

FuncAttrs GenericAttrs::ConvertToFuncAttrs() {
  FuncAttrs attr;
  for (uint32 i = 0; i < 64; i++) {
    if ((attrFlag & (1ULL << i)) == 0) {
      continue;
    }
    GenericAttrKind tA = static_cast<GenericAttrKind>(i);
    switch (tA) {
#define FUNC_ATTR
#define ATTR(STR)                   \\
    case GENATTR_##STR:             \\
      attr.SetAttr(FUNCATTR_##STR); \\
      break;
#include ""all_attributes.def""
#undef ATTR
#undef FUNC_ATTR
      default:
        CHECK_FATAL(false, ""unknown FuncAttrs"");
        break;
    }
  }
  return attr;
}

FieldAttrs GenericAttrs::ConvertToFieldAttrs() {
  FieldAttrs attr;
  for (uint32 i = 0; i < 64; i++) {
    if ((attrFlag & (1ULL << i)) == 0) {
      continue;
    }
    GenericAttrKind tA = static_cast<GenericAttrKind>(i);
    switch (tA) {
#define FIELD_ATTR
#define ATTR(STR)                  \\
    case GENATTR_##STR:            \\
      attr.SetAttr(FLDATTR_##STR); \\
      break;
#include ""all_attributes.def""
#undef ATTR
#undef FIELD_ATTR
      default:
        CHECK_FATAL(false, ""unknown FieldAttrs"");
        break;
    }
  }
  return attr;
}

}  // namespace maple
#endif  // MIR_FEATURE_FULL
",16143,True,3120.5417277496776,median
"
////
This file is generated! See _meta/fields.yml and scripts/generate_field_docs.py
////

[[exported-fields]]
= Exported fields

[partintro]

--
This document describes the fields that are exported by Heartbeat. They are
grouped in the following categories:

* <<exported-fields-beat>>
* <<exported-fields-cloud>>
* <<exported-fields-common>>
* <<exported-fields-docker-processor>>
* <<exported-fields-ecs>>
* <<exported-fields-host-processor>>
* <<exported-fields-http>>
* <<exported-fields-icmp>>
* <<exported-fields-kubernetes-processor>>
* <<exported-fields-resolve>>
* <<exported-fields-socks5>>
* <<exported-fields-tcp>>
* <<exported-fields-tls>>

--
[[exported-fields-beat]]
== Beat fields

Contains common beat fields available in all event types.



*`beat.timezone`*::
+
--
type: alias

alias to: event.timezone

--

*`@timestamp`*::
+
--
type: date

example: August 26th 2016, 12:35:53.332

format: date

required: True

The timestamp when the event log record was generated.


--

*`tags`*::
+
--
Arbitrary tags that can be set per Beat and per transaction type.


--

*`fields`*::
+
--
type: object

Contains user configurable fields.


--

[float]
== error fields

Error fields containing additional info in case of errors.



*`error.type`*::
+
--
type: keyword

Error type.


--

[[exported-fields-cloud]]
== Cloud provider metadata fields

Metadata from cloud providers added by the add_cloud_metadata processor.



*`cloud.project.id`*::
+
--
example: project-x

Name of the project in Google Cloud.


--

*`meta.cloud.provider`*::
+
--
type: alias

alias to: cloud.provider

--

*`meta.cloud.instance_id`*::
+
--
type: alias

alias to: cloud.instance.id

--

*`meta.cloud.instance_name`*::
+
--
type: alias

alias to: cloud.instance.name

--

*`meta.cloud.machine_type`*::
+
--
type: alias

alias to: cloud.machine.type

--

*`meta.cloud.availability_zone`*::
+
--
type: alias

alias to: cloud.availability_zone

--

*`meta.cloud.project_id`*::
+
--
type: alias

alias to: cloud.project.id

--

*`meta.cloud.region`*::
+
--
type: alias

alias to: cloud.region

--

[[exported-fields-common]]
== Common heartbeat monitor fields

None


[float]
== monitor fields

Common monitor fields.



*`monitor.type`*::
+
--
type: keyword

The monitor type.


--

*`monitor.name`*::
+
--
type: keyword

The monitors configured name


--

*`monitor.id`*::
+
--
type: keyword

The monitors full job ID as used by heartbeat.


--

[float]
== duration fields

Total monitoring test duration


*`monitor.duration.us`*::
+
--
type: long

Duration in microseconds

--

*`monitor.scheme`*::
+
--
type: keyword

Address url scheme. For example `tcp`, `tls`, `http`, and `https`.


--

*`monitor.host`*::
+
--
type: keyword

Hostname of service being monitored. Can be missing, if service is monitored by IP.


--

*`monitor.ip`*::
+
--
type: ip

IP of service being monitored. If service is monitored by hostname, the `ip` field contains the resolved ip address for the current host.


--

*`monitor.status`*::
+
--
type: keyword

required: True

Indicator if monitor could validate the service to be available.


--

[[exported-fields-docker-processor]]
== Docker fields

Docker stats collected from Docker.




*`docker.container.id`*::
+
--
type: keyword

Unique container id.


--

*`docker.container.image`*::
+
--
type: keyword

Name of the image the container was built on.


--

*`docker.container.name`*::
+
--
type: keyword

Container name.


--

*`docker.container.labels`*::
+
--
type: object

Image labels.


--

[[exported-fields-ecs]]
== ECS fields

ECS fields.



[float]
== agent fields

The agent fields contain the data about the software entity, if any, that collects, detects, or observes events on a host, or takes measurements on a host. Examples include Beats. Agents may also run on observers. ECS agent.* fields shall be populated with details of the agent running on the host or observer where the event happened or the measurement was taken.



*`agent.version`*::
+
--
type: keyword

example: 6.0.0-rc2

Version of the agent.


--

*`agent.name`*::
+
--
type: keyword

example: foo

Name of the agent.
This is a name that can be given to an agent. This can be helpful if for example two Filebeat instances are running on the same host but a human readable separation is needed on which Filebeat instance data is coming from.
If no name is given, the name is often left empty.


--

*`agent.type`*::
+
--
type: keyword

example: filebeat

Type of the agent.
The agent type stays always the same and should be given by the agent used. In case of Filebeat the agent would always be Filebeat also if two Filebeat instances are run on the same machine.


--

*`agent.id`*::
+
--
type: keyword

example: 8a4f500d

Unique identifier of this agent (if one exists).
Example: For Beats this would be beat.id.


--

*`agent.ephemeral_id`*::
+
--
type: keyword

example: 8a4f500f

Ephemeral identifier of this agent (if one exists).
This id normally changes across restarts, but `agent.id` does not.


--

[float]
== base fields

The base set contains all fields which are on the top level. These fields are common across all types of events.



*`base.@timestamp`*::
+
--
type: date

example: 2016-05-23T08:05:34.853Z

required: True

Date/time when the event originated.
For log events this is the date/time when the event was generated, and not when it was read.
Required field for all events.


--

*`base.tags`*::
+
--
type: keyword

example: [""production"", ""env2""]

List of keywords used to tag each event.


--

*`base.labels`*::
+
--
type: object

example: {'application': 'foo-bar', 'env': 'production'}

Key/value pairs.
Can be used to add meta information to events. Should not contain nested objects. All values are stored as keyword.
Example: `docker` and `k8s` labels.


--

*`base.message`*::
+
--
type: text

example: Hello World

For log events the message field contains the log message.
In other use cases the message field can be used to concatenate different values which are then freely searchable. If multiple messages exist, they can be combined into one message.


--

[float]
== client fields

A client is defined as the initiator of a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the client is the initiator of the TCP connection that sends the SYN packet(s). For other protocols, the client is generally the initiator or requestor in the network transaction. Some systems use the term ""originator"" to refer the client in TCP connections. The client fields describe details about the system acting as the client in the network event. Client fields are usually populated in conjuction with server fields.  Client fields are generally not populated for packet-level events. 



*`client.ip`*::
+
--
type: ip

IP address of the client.
Can be one or multiple IPv4 or IPv6 addresses.


--

*`client.port`*::
+
--
type: long

Port of the client.


--

*`client.mac`*::
+
--
type: keyword

MAC address of the client.


--

*`client.domain`*::
+
--
type: keyword

Client domain.


--

*`client.bytes`*::
+
--
type: long

example: 184

Bytes sent from the client to the server.


--

*`client.packets`*::
+
--
type: long

example: 12

Packets sent from the client to the server.


--

[float]
== geo fields

Geo fields can carry data about a specific location related to an event or geo information derived from an IP field.



*`client.geo.location`*::
+
--
type: geo_point

example: { ""lon"": -73.614830, ""lat"": 45.505918 }

Longitude and latitude.


--

*`client.geo.continent_name`*::
+
--
type: keyword

example: North America

Name of the continent.


--

*`client.geo.country_name`*::
+
--
type: keyword

example: Canada

Country name.


--

*`client.geo.region_name`*::
+
--
type: keyword

example: Quebec

Region name.


--

*`client.geo.city_name`*::
+
--
type: keyword

example: Montreal

City name.


--

*`client.geo.country_iso_code`*::
+
--
type: keyword

example: CA

Country ISO code.


--

*`client.geo.region_iso_code`*::
+
--
type: keyword

example: CA-QC

Region ISO code.


--

*`client.geo.name`*::
+
--
type: keyword

example: boston-dc

User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.


--

[float]
== cloud fields

Fields related to the cloud or infrastructure the events are coming from.



*`cloud.provider`*::
+
--
type: keyword

example: ec2

Name of the cloud provider. Example values are ec2, gce, or digitalocean.


--

*`cloud.availability_zone`*::
+
--
type: keyword

example: us-east-1c

Availability zone in which this host is running.


--

*`cloud.region`*::
+
--
type: keyword

example: us-east-1

Region in which this host is running.


--

*`cloud.instance.id`*::
+
--
type: keyword

example: i-1234567890abcdef0

Instance ID of the host machine.


--

*`cloud.instance.name`*::
+
--
type: keyword

Instance name of the host machine.


--

*`cloud.machine.type`*::
+
--
type: keyword

example: t2.medium

Machine type of the host machine.


--

*`cloud.account.id`*::
+
--
type: keyword

example: 666777888999

The cloud account or organization id used to identify different entities in a multi-tenant environment.
Examples: AWS account id, Google Cloud ORG Id, or other unique identifier.


--

[float]
== container fields

Container fields are used for meta information about the specific container that is the source of information. These fields help correlate data based containers from any runtime.



*`container.runtime`*::
+
--
type: keyword

example: docker

Runtime managing this container.


--

*`container.id`*::
+
--
type: keyword

Unique container id.


--

*`container.image.name`*::
+
--
type: keyword

Name of the image the container was built on.


--

*`container.image.tag`*::
+
--
type: keyword

Container image tag.


--

*`container.name`*::
+
--
type: keyword

Container name.


--

*`container.labels`*::
+
--
type: object

Image labels.


--

[float]
== destination fields

Destination fields describe details about the destination of a packet/event. Destination fields are usually populated in conjunction with source fields.



*`destination.ip`*::
+
--
type: ip

IP address of the destination.
Can be one or multiple IPv4 or IPv6 addresses.


--

*`destination.port`*::
+
--
type: long

Port of the destination.


--

*`destination.mac`*::
+
--
type: keyword

MAC address of the destination.


--

*`destination.domain`*::
+
--
type: keyword

Destination domain.


--

*`destination.bytes`*::
+
--
type: long

example: 184

Bytes sent from the destination to the source.


--

*`destination.packets`*::
+
--
type: long

example: 12

Packets sent from the destination to the source.


--

[float]
== geo fields

Geo fields can carry data about a specific location related to an event or geo information derived from an IP field.



*`destination.geo.location`*::
+
--
type: geo_point

example: { ""lon"": -73.614830, ""lat"": 45.505918 }

Longitude and latitude.


--

*`destination.geo.continent_name`*::
+
--
type: keyword

example: North America

Name of the continent.


--

*`destination.geo.country_name`*::
+
--
type: keyword

example: Canada

Country name.


--

*`destination.geo.region_name`*::
+
--
type: keyword

example: Quebec

Region name.


--

*`destination.geo.city_name`*::
+
--
type: keyword

example: Montreal

City name.


--

*`destination.geo.country_iso_code`*::
+
--
type: keyword

example: CA

Country ISO code.


--

*`destination.geo.region_iso_code`*::
+
--
type: keyword

example: CA-QC

Region ISO code.


--

*`destination.geo.name`*::
+
--
type: keyword

example: boston-dc

User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.


--

[float]
== ecs fields

Meta-information specific to ECS.



*`ecs.version`*::
+
--
type: keyword

example: 1.0.0-beta1

required: True

ECS version this event conforms to. `ecs.version` is a required field and must exist in all events.
When querying across multiple indices -- which may conform to slightly different ECS versions -- this field lets integrations adjust to the schema version of the events.
The current version is 1.0.0-beta1 .


--

[float]
== error fields

These fields can represent errors of any kind. Use them for errors that happen while fetching events or in cases where the event itself contains an error.



*`error.id`*::
+
--
type: keyword

Unique identifier for the error.


--

*`error.message`*::
+
--
type: text

Error message.


--

*`error.code`*::
+
--
type: keyword

Error code describing the error.


--

[float]
== event fields

The event fields are used for context information about the log or metric event itself. A log is defined as an event containing details of something that happened. Log events must include the time at which the thing happened. Examples of log events include a process starting on a host, a network packet being sent from a source to a destination, or a network connection between a client and a server being initiated or closed. A metric is defined as an event containing one or more numerical or categorical measurements and the time at which the measurement was taken. Examples of metric events include memory pressure measured on a host, or vulnerabilities measured on a scanned host.



*`event.id`*::
+
--
type: keyword

example: 8a4f500d

Unique ID to describe the event.


--

*`event.kind`*::
+
--
type: keyword

example: state

The kind of the event.
This gives information about what type of information the event contains, without being specific to the contents of the event.  Examples are `event`, `state`, `alarm`. Warning: In future versions of ECS, we plan to provide a list of acceptable values for this field, please use with caution.


--

*`event.category`*::
+
--
type: keyword

example: user-management

Event category.
This contains high-level information about the contents of the event. It is more generic than `event.action`, in the sense that typically a category contains multiple actions. Warning: In future versions of ECS, we plan to provide a list of acceptable values for this field, please use with caution.


--

*`event.action`*::
+
--
type: keyword

example: user-password-change

The action captured by the event.
This describes the information in the event. It is more specific than `event.category`. Examples are `group-add`, `process-started`, `file-created`. The value is normally defined by the implementer.


--

*`event.outcome`*::
+
--
type: keyword

example: success

The outcome of the event.
If the event describes an action, this fields contains the outcome of that action. Examples outcomes are `success` and `failure`. Warning: In future versions of ECS, we plan to provide a list of acceptable values for this field, please use with caution.


--

*`event.type`*::
+
--
type: keyword

Reserved for future usage.
Please avoid using this field for user data.


--

*`event.module`*::
+
--
type: keyword

example: mysql

Name of the module this data is coming from.
This information is coming from the modules used in Beats or Logstash.


--

*`event.dataset`*::
+
--
type: keyword

example: stats

Name of the dataset.
The concept of a `dataset` (fileset / metricset) is used in Beats as a subset of modules. It contains the information which is currently stored in metricset.name and metricset.module or fileset.name.


--

*`event.severity`*::
+
--
type: long

example: 7

Severity describes the severity of the event. What the different severity values mean can very different between use cases. It's up to the implementer to make sure severities are consistent across events.


--

*`event.original`*::
+
--
type: keyword

example: Sep 19 08:26:10 host CEF:0&#124;Security&#124; threatmanager&#124;1.0&#124;100&#124; worm successfully stopped&#124;10&#124;src=10.0.0.1 dst=2.1.2.2spt=1232

Raw text message of entire event. Used to demonstrate log integrity.
This field is not indexed and doc_values are disabled. It cannot be searched, but it can be retrieved from `_source`.


Field is not indexed.

--

*`event.hash`*::
+
--
type: keyword

example: 123456789012345678901234567890ABCD

Hash (perhaps logstash fingerprint) of raw field to be able to demonstrate log integrity.


--

*`event.duration`*::
+
--
type: long

Duration of the event in nanoseconds.
If event.start and event.end are known this value should be the difference between the end and start time.


--

*`event.timezone`*::
+
--
type: keyword

This field should be populated when the event's timestamp does not include timezone information already (e.g. default Syslog timestamps). It's optional otherwise.
Acceptable timezone formats are: a canonical ID (e.g. ""Europe/Amsterdam""), abbreviated (e.g. ""EST"") or an HH:mm differential (e.g. ""-05:00"").


--

*`event.created`*::
+
--
type: date

event.created contains the date when the event was created.
This timestamp is distinct from @timestamp in that @timestamp contains the processed timestamp. For logs these two timestamps can be different as the timestamp in the log line and when the event is read for example by Filebeat are not identical. `@timestamp` must contain the timestamp extracted from the log line, event.created when the log line is read. The same could apply to package capturing where @timestamp contains the timestamp extracted from the network package and event.created when the event was created.
In case the two timestamps are identical, @timestamp should be used.


--

*`event.start`*::
+
--
type: date

event.start contains the date when the event started or when the activity was first observed.


--

*`event.end`*::
+
--
type: date

event.end contains the date when the event ended or when the activity was last observed.


--

*`event.risk_score`*::
+
--
type: float

Risk score or priority of the event (e.g. security solutions). Use your system's original value here.


--

*`event.risk_score_norm`*::
+
--
type: float

Normalized risk score or priority of the event, on a scale of 0 to 100.
This is mainly useful if you use more than one system that assigns risk scores, and you want to see a normalized value across all systems.


--

[float]
== file fields

A file is defined as a set of information that has been created on, or has existed on a filesystem. File objects can be associated with host events, network events, and/or file events (e.g., those produced by File Integrity Monitoring [FIM] products or services). File fields provide details about the affected file associated with the event or metric.



*`file.path`*::
+
--
type: keyword

Path to the file.

--

*`file.target_path`*::
+
--
type: keyword

Target path for symlinks.

--

*`file.extension`*::
+
--
type: keyword

example: png

File extension.
This should allow easy filtering by file extensions.


--

*`file.type`*::
+
--
type: keyword

File type (file, dir, or symlink).

--

*`file.device`*::
+
--
type: keyword

Device that is the source of the file.

--

*`file.inode`*::
+
--
type: keyword

Inode representing the file in the filesystem.

--

*`file.uid`*::
+
--
type: keyword

The user ID (UID) or security identifier (SID) of the file owner.


--

*`file.owner`*::
+
--
type: keyword

File owner's username.

--

*`file.gid`*::
+
--
type: keyword

Primary group ID (GID) of the file.

--

*`file.group`*::
+
--
type: keyword

Primary group name of the file.

--

*`file.mode`*::
+
--
type: keyword

example: 416

Mode of the file in octal representation.

--

*`file.size`*::
+
--
type: long

File size in bytes (field is only added when `type` is `file`).

--

*`file.mtime`*::
+
--
type: date

Last time file content was modified.

--

*`file.ctime`*::
+
--
type: date

Last time file metadata changed.

--

[float]
== group fields

The group fields are meant to represent groups that are relevant to the event.



*`group.id`*::
+
--
type: keyword

Unique identifier for the group on the system/platform.


--

*`group.name`*::
+
--
type: keyword

Name of the group.


--

[float]
== host fields

A host is defined as a general computing instance. ECS host.* fields should be populated with details about the host on which the event happened, or on which the measurement was taken. Host types include hardware, virtual machines, Docker containers, and Kubernetes nodes.



*`host.hostname`*::
+
--
type: keyword

Hostname of the host.
It normally contains what the `hostname` command returns on the host machine.


--

*`host.name`*::
+
--
type: keyword

Name of the host.
It can contain what `hostname` returns on Unix systems, the fully qualified domain name, or a name specified by the user. The sender decides which value to use.


--

*`host.id`*::
+
--
type: keyword

Unique host id.
As hostname is not always unique, use values that are meaningful in your environment.
Example: The current usage of `beat.name`.


--

*`host.ip`*::
+
--
type: ip

Host ip address.


--

*`host.mac`*::
+
--
type: keyword

Host mac address.


--

*`host.type`*::
+
--
type: keyword

Type of host.
For Cloud providers this can be the machine type like `t2.medium`. If vm, this could be the container, for example, or other information meaningful in your environment.


--

*`host.architecture`*::
+
--
type: keyword

example: x86_64

Operating system architecture.


--

[float]
== os fields

The OS fields contain information about the operating system.



*`host.os.platform`*::
+
--
type: keyword

example: darwin

Operating system platform (such centos, ubuntu, windows).


--

*`host.os.name`*::
+
--
type: keyword

example: Mac OS X

Operating system name.


--

*`host.os.family`*::
+
--
type: keyword

example: debian

OS family (such as redhat, debian, freebsd, windows).


--

*`host.os.version`*::
+
--
type: keyword

example: 10.12.6-rc2

Operating system version as a raw string.


--

*`host.os.kernel`*::
+
--
type: keyword

example: 4.4.0-112-generic

Operating system kernel version as a raw string.


--

[float]
== geo fields

Geo fields can carry data about a specific location related to an event or geo information derived from an IP field.



*`host.geo.location`*::
+
--
type: geo_point

example: { ""lon"": -73.614830, ""lat"": 45.505918 }

Longitude and latitude.


--

*`host.geo.continent_name`*::
+
--
type: keyword

example: North America

Name of the continent.


--

*`host.geo.country_name`*::
+
--
type: keyword

example: Canada

Country name.


--

*`host.geo.region_name`*::
+
--
type: keyword

example: Quebec

Region name.


--

*`host.geo.city_name`*::
+
--
type: keyword

example: Montreal

City name.


--

*`host.geo.country_iso_code`*::
+
--
type: keyword

example: CA

Country ISO code.


--

*`host.geo.region_iso_code`*::
+
--
type: keyword

example: CA-QC

Region ISO code.


--

*`host.geo.name`*::
+
--
type: keyword

example: boston-dc

User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.


--

[float]
== http fields

Fields related to HTTP activity.



*`http.request.method`*::
+
--
type: keyword

example: GET, POST, PUT

Http request method.


--

*`http.request.referrer`*::
+
--
type: keyword

example: https://blog.example.com/

Referrer for this HTTP request.


--

*`http.response.status_code`*::
+
--
type: long

example: 404

Http response status code.


--

*`http.response.body`*::
+
--
type: keyword

example: Hello world

The full http response body.


--

*`http.version`*::
+
--
type: keyword

example: 1.1

Http version.


--

[float]
== log fields

Fields which are specific to log events.



*`log.level`*::
+
--
type: keyword

example: ERR

Log level of the log event.
Some examples are `WARN`, `ERR`, `INFO`.


--

*`log.original`*::
+
--
type: keyword

example: Sep 19 08:26:10 localhost My log


This is the original log message and contains the full log message before splitting it up in multiple parts.
In contrast to the `message` field which can contain an extracted part of the log message, this field contains the original, full log message. It can have already some modifications applied like encoding or new lines removed to clean up the log message.
This field is not indexed and doc_values are disabled so it can't be queried but the value can be retrieved from `_source`.


Field is not indexed.

--

[float]
== network fields

The network is defined as the communication path over which a host or network event happens. The network.* fields should be populated with details about the network activity associated with an event.



*`network.name`*::
+
--
type: keyword

example: Guest Wifi

Name given by operators to sections of their network.


--

*`network.type`*::
+
--
type: keyword

example: IPv4

In the OSI Model this would be the Network Layer. IPv4, IPv6, IPSec, PIM, etc


--

*`network.iana_number`*::
+
--
type: keyword

example: 6

IANA Protocol Number (https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Standardized list of protocols. This aligns well with NetFlow and sFlow related logs which use the IANA Protocol Number.


--

*`network.transport`*::
+
--
type: keyword

example: TCP

Same as network.iana_number, but instead using the Keyword name of the transport layer (UDP, TCP, IPv6-ICMP, etc.)


--

*`network.application`*::
+
--
type: keyword

example: AIM

A name given to an application. This can be arbitrarily assigned for things like microservices, but also apply to things like skype, icq, facebook, twitter. This would be used in situations where the vendor or service can be decoded such as from the source/dest IP owners, ports, or wire format.


--

*`network.protocol`*::
+
--
type: keyword

example: http

L7 Network protocol name. ex. http, lumberjack, transport protocol


--

*`network.direction`*::
+
--
type: keyword

example: inbound

Direction of the network traffic.
Recommended values are:
  * inbound
  * outbound
  * internal
  * external
  * unknown

When mapping events from a host-based monitoring context, populate this field from the host's point of view.
When mapping events from a network or perimeter-based monitoring context, populate this field from the point of view of your network perimeter.


--

*`network.forwarded_ip`*::
+
--
type: ip

example: 192.1.1.2

Host IP address when the source IP address is the proxy.


--

*`network.community_id`*::
+
--
type: keyword

example: 1:hO+sN4H+MG5MY/8hIrXPqc4ZQz0=

A hash of source and destination IPs and ports, as well as the protocol used in a communication. This is a tool-agnostic standard to identify flows.
Learn more at https://github.com/corelight/community-id-spec.


--

*`network.bytes`*::
+
--
type: long

example: 368

Total bytes transferred in both directions.
If `source.bytes` and `destination.bytes` are known, `network.bytes` is their sum.


--

*`network.packets`*::
+
--
type: long

example: 24

Total packets transferred in both directions.
If `source.packets` and `destination.packets` are known, `network.packets` is their sum.


--

[float]
== observer fields

An observer is defined as a special network, security, or application device used to detect, observe, or create network, security, or application-related events and metrics. This could be a custom hardware appliance or a server that has been configured to run special network, security, or application software. Examples include firewalls, intrusion detection/prevention systems, network monitoring sensors, web application firewalls, data loss prevention systems, and APM servers. The observer.* fields shall be populated with details of the system, if any, that detects, observes and/or creates a network, security, or application event or metric. Message queues and ETL components used in processing events or metrics are not considered observers in ECS.  



*`observer.mac`*::
+
--
type: keyword

MAC address of the observer


--

*`observer.ip`*::
+
--
type: ip

IP address of the observer.


--

*`observer.hostname`*::
+
--
type: keyword

Hostname of the observer.


--

*`observer.vendor`*::
+
--
type: keyword

observer vendor information.


--

*`observer.version`*::
+
--
type: keyword

Observer version.


--

*`observer.serial_number`*::
+
--
type: keyword

Observer serial number.


--

*`observer.type`*::
+
--
type: keyword

example: firewall

The type of the observer the data is coming from.
There is no predefined list of observer types. Some examples are `forwarder`, `firewall`, `ids`, `ips`, `proxy`, `poller`, `sensor`, `APM server`.


--

[float]
== os fields

The OS fields contain information about the operating system.



*`observer.os.platform`*::
+
--
type: keyword

example: darwin

Operating system platform (such centos, ubuntu, windows).


--

*`observer.os.name`*::
+
--
type: keyword

example: Mac OS X

Operating system name.


--

*`observer.os.family`*::
+
--
type: keyword

example: debian

OS family (such as redhat, debian, freebsd, windows).


--

*`observer.os.version`*::
+
--
type: keyword

example: 10.12.6-rc2

Operating system version as a raw string.


--

*`observer.os.kernel`*::
+
--
type: keyword

example: 4.4.0-112-generic

Operating system kernel version as a raw string.


--

[float]
== geo fields

Geo fields can carry data about a specific location related to an event or geo information derived from an IP field.



*`observer.geo.location`*::
+
--
type: geo_point

example: { ""lon"": -73.614830, ""lat"": 45.505918 }

Longitude and latitude.


--

*`observer.geo.continent_name`*::
+
--
type: keyword

example: North America

Name of the continent.


--

*`observer.geo.country_name`*::
+
--
type: keyword

example: Canada

Country name.


--

*`observer.geo.region_name`*::
+
--
type: keyword

example: Quebec

Region name.


--

*`observer.geo.city_name`*::
+
--
type: keyword

example: Montreal

City name.


--

*`observer.geo.country_iso_code`*::
+
--
type: keyword

example: CA

Country ISO code.


--

*`observer.geo.region_iso_code`*::
+
--
type: keyword

example: CA-QC

Region ISO code.


--

*`observer.geo.name`*::
+
--
type: keyword

example: boston-dc

User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.


--

[float]
== organization fields

The organization fields enrich data with information about the company or entity the data is associated with. These fields help you arrange or filter data stored in an index by one or multiple organizations.



*`organization.name`*::
+
--
type: keyword

Organization name.


--

*`organization.id`*::
+
--
type: keyword

Unique identifier for the organization.


--

[float]
== os fields

The OS fields contain information about the operating system.



*`os.platform`*::
+
--
type: keyword

example: darwin

Operating system platform (such centos, ubuntu, windows).


--

*`os.name`*::
+
--
type: keyword

example: Mac OS X

Operating system name.


--

*`os.family`*::
+
--
type: keyword

example: debian

OS family (such as redhat, debian, freebsd, windows).


--

*`os.version`*::
+
--
type: keyword

example: 10.12.6-rc2

Operating system version as a raw string.


--

*`os.kernel`*::
+
--
type: keyword

example: 4.4.0-112-generic

Operating system kernel version as a raw string.


--

[float]
== process fields

These fields contain information about a process. These fields can help you correlate metrics information with a process id/name from a log message.  The `process.pid` often stays in the metric itself and is copied to the global field for correlation.



*`process.pid`*::
+
--
type: long

Process id.


--

*`process.name`*::
+
--
type: keyword

example: ssh

Process name.
Sometimes called program name or similar.


--

*`process.ppid`*::
+
--
type: long

Process parent id.


--

*`process.args`*::
+
--
type: keyword

example: ['ssh', '-l', 'user', '10.0.0.16']

Process arguments.
May be filtered to protect sensitive information.


--

*`process.executable`*::
+
--
type: keyword

example: /usr/bin/ssh

Absolute path to the process executable.


--

*`process.title`*::
+
--
type: keyword

Process title.
The proctitle, some times the same as process name. Can also be different: for example a browser setting its title to the web page currently opened.


--

*`process.thread.id`*::
+
--
type: long

example: 4242

Thread ID.


--

*`process.start`*::
+
--
type: date

example: 2016-05-23T08:05:34.853Z

The time the process started.


--

*`process.working_directory`*::
+
--
type: keyword

example: /home/alice

The working directory of the process.


--

[float]
== related fields

This field set is meant to facilitate pivoting around a piece of data. Some pieces of information can be seen in many places in ECS. To facilitate searching for them, append values to their corresponding field in `related.`. A concrete example is IP addresses, which can be under host, observer, source, destination, client, server, and network.forwarded_ip. If you append all IPs to `related.ip`, you can then search for a given IP trivially, no matter where it appeared, by querying `related.ip:a.b.c.d`.



*`related.ip`*::
+
--
type: ip

All of the IPs seen on your event.


--

[float]
== server fields

A Server is defined as the responder in a network connection for events regarding sessions, connections, or bidirectional flow records. For TCP events, the server is the receiver of the initial SYN packet(s) of the TCP connection. For other protocols, the server is generally the responder in the network transaction. Some systems actually use the term ""responder"" to refer the server in TCP connections. The server fields describe details about the system acting as the server in the network event. Server fields are usually populated in conjunction with client fields. Server fields are generally not populated for packet-level events.



*`server.ip`*::
+
--
type: ip

IP address of the server.
Can be one or multiple IPv4 or IPv6 addresses.


--

*`server.port`*::
+
--
type: long

Port of the server.


--

*`server.mac`*::
+
--
type: keyword

MAC address of the server.


--

*`server.domain`*::
+
--
type: keyword

Server domain.


--

*`server.bytes`*::
+
--
type: long

example: 184

Bytes sent from the server to the client.


--

*`server.packets`*::
+
--
type: long

example: 12

Packets sent from the server to the client.


--

[float]
== geo fields

Geo fields can carry data about a specific location related to an event or geo information derived from an IP field.



*`server.geo.location`*::
+
--
type: geo_point

example: { ""lon"": -73.614830, ""lat"": 45.505918 }

Longitude and latitude.


--

*`server.geo.continent_name`*::
+
--
type: keyword

example: North America

Name of the continent.


--

*`server.geo.country_name`*::
+
--
type: keyword

example: Canada

Country name.


--

*`server.geo.region_name`*::
+
--
type: keyword

example: Quebec

Region name.


--

*`server.geo.city_name`*::
+
--
type: keyword

example: Montreal

City name.


--

*`server.geo.country_iso_code`*::
+
--
type: keyword

example: CA

Country ISO code.


--

*`server.geo.region_iso_code`*::
+
--
type: keyword

example: CA-QC

Region ISO code.


--

*`server.geo.name`*::
+
--
type: keyword

example: boston-dc

User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.


--

[float]
== service fields

The service fields describe the service for or from which the data was collected. These fields help you find and correlate logs for a specific service and version.



*`service.id`*::
+
--
type: keyword

example: d37e5ebfe0ae6c4972dbe9f0174a1637bb8247f6

Unique identifier of the running service.
This id should uniquely identify this service. This makes it possible to correlate logs and metrics for one specific service.
Example: If you are experiencing issues with one redis instance, you can filter on that id to see metrics and logs for that single instance.


--

*`service.name`*::
+
--
type: keyword

example: elasticsearch-metrics

Name of the service data is collected from.
The name of the service is normally user given. This allows if two instances of the same service are running on the same machine they can be differentiated by the `service.name`.
Also it allows for distributed services that run on multiple hosts to correlate the related instances based on the name.
In the case of Elasticsearch the service.name could contain the cluster name. For Beats the service.name is by default a copy of the `service.type` field if no name is specified.


--

*`service.type`*::
+
--
type: keyword

example: elasticsearch

The type of the service data is collected from.
The type can be used to group and correlate logs and metrics from one service type.
Example: If logs or metrics are collected from Elasticsearch, `service.type` would be `elasticsearch`.


--

*`service.state`*::
+
--
type: keyword

Current state of the service.


--

*`service.version`*::
+
--
type: keyword

example: 3.2.4

Version of the service the data was collected from.
This allows to look at a data set only for a specific version of a service.


--

*`service.ephemeral_id`*::
+
--
type: keyword

example: 8a4f500f

Ephemeral identifier of this service (if one exists).
This id normally changes across restarts, but `service.id` does not.


--

[float]
== source fields

Source fields describe details about the source of a packet/event. Source fields are usually populated in conjunction with destination fields.



*`source.ip`*::
+
--
type: ip

IP address of the source.
Can be one or multiple IPv4 or IPv6 addresses.


--

*`source.port`*::
+
--
type: long

Port of the source.


--

*`source.mac`*::
+
--
type: keyword

MAC address of the source.


--

*`source.domain`*::
+
--
type: keyword

Source domain.


--

*`source.bytes`*::
+
--
type: long

example: 184

Bytes sent from the source to the destination.


--

*`source.packets`*::
+
--
type: long

example: 12

Packets sent from the source to the destination.


--

[float]
== geo fields

Geo fields can carry data about a specific location related to an event or geo information derived from an IP field.



*`source.geo.location`*::
+
--
type: geo_point

example: { ""lon"": -73.614830, ""lat"": 45.505918 }

Longitude and latitude.


--

*`source.geo.continent_name`*::
+
--
type: keyword

example: North America

Name of the continent.


--

*`source.geo.country_name`*::
+
--
type: keyword

example: Canada

Country name.


--

*`source.geo.region_name`*::
+
--
type: keyword

example: Quebec

Region name.


--

*`source.geo.city_name`*::
+
--
type: keyword

example: Montreal

City name.


--

*`source.geo.country_iso_code`*::
+
--
type: keyword

example: CA

Country ISO code.


--

*`source.geo.region_iso_code`*::
+
--
type: keyword

example: CA-QC

Region ISO code.


--

*`source.geo.name`*::
+
--
type: keyword

example: boston-dc

User-defined description of a location, at the level of granularity they care about.
Could be the name of their data centers, the floor number, if this describes a local physical entity, city names.
Not typically used in automated geolocation.


--

[float]
== url fields

URL fields provide a complete URL, with scheme, host, and path.



*`url.original`*::
+
--
type: keyword

example: https://www.elastic.co:443/search?q=elasticsearch#top or /search?q=elasticsearch


Unmodified original url as seen in the event source.
Note that in network monitoring, the observed URL may be a full URL, whereas in access logs, the URL is often just represented as a path.
This field is meant to represent the URL as it was observed, complete or not.


--

*`url.full`*::
+
--
type: keyword

example: https://www.elastic.co:443/search?q=elasticsearch#top

If full URLs are important to your use case, they should be stored in `url.full`, whether this field is reconstructed or present in the event source.


--

*`url.scheme`*::
+
--
type: keyword

example: https

Scheme of the request, such as ""https"".
Note: The `:` is not part of the scheme.


--

*`url.domain`*::
+
--
type: keyword

example: www.elastic.co

Domain of the request, such as ""www.elastic.co"".
In some cases a URL may refer to an IP and/or port directly, without a domain name. In this case, the IP address would go to the `domain` field.


--

*`url.port`*::
+
--
type: integer

example: 443

Port of the request, such as 443.


--

*`url.path`*::
+
--
type: keyword

Path of the request, such as ""/search"".


--

*`url.query`*::
+
--
type: keyword

The query field describes the query string of the request, such as ""q=elasticsearch"".
The `?` is excluded from the query string. If a URL contains no `?`, there is no query field. If there is a `?` but no query, the query field exists with an empty string. The `exists` query can be used to differentiate between the two cases.


--

*`url.fragment`*::
+
--
type: keyword

Portion of the url after the `#`, such as ""top"".
The `#` is not part of the fragment.


--

*`url.username`*::
+
--
type: keyword

Username of the request.


--

*`url.password`*::
+
--
type: keyword

Password of the request.


--

[float]
== user fields

The user fields describe information about the user that is relevant to  the event. Fields can have one entry or multiple entries. If a user has more than one id, provide an array that includes all of them.



*`user.id`*::
+
--
type: keyword

One or multiple unique identifiers of the user.


--

*`user.name`*::
+
--
type: keyword

example: albert

Short name or login of the user.


--

*`user.full_name`*::
+
--
type: keyword

example: Albert Einstein

User's full name, if available.


--

*`user.email`*::
+
--
type: keyword

User email address.


--

*`user.hash`*::
+
--
type: keyword

Unique user hash to correlate information for a user in anonymized form.
Useful if `user.id` or `user.name` contain confidential information and cannot be used.


--

*`user.group`*::
+
--
type: keyword

Group the user is a part of. This field can contain a list of groups, if necessary.


--

[float]
== user_agent fields

The user_agent fields normally come from a browser request. They often show up in web service logs coming from the parsed user agent string.



*`user_agent.original`*::
+
--
type: keyword

example: Mozilla/5.0 (iPhone; CPU iPhone OS 12_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/12.0 Mobile/15E148 Safari/604.1

Unparsed version of the user_agent.


Field is not indexed.

--

*`user_agent.name`*::
+
--
type: keyword

example: Safari

Name of the user agent.


--

*`user_agent.version`*::
+
--
type: keyword

example: 12.0

Version of the user agent.


--

*`user_agent.device.name`*::
+
--
type: keyword

example: iPhone

Name of the device.


--

[float]
== os fields

The OS fields contain information about the operating system.



*`user_agent.os.platform`*::
+
--
type: keyword

example: darwin

Operating system platform (such centos, ubuntu, windows).


--

*`user_agent.os.name`*::
+
--
type: keyword

example: Mac OS X

Operating system name.


--

*`user_agent.os.family`*::
+
--
type: keyword

example: debian

OS family (such as redhat, debian, freebsd, windows).


--

*`user_agent.os.version`*::
+
--
type: keyword

example: 10.12.6-rc2

Operating system version as a raw string.


--

*`user_agent.os.kernel`*::
+
--
type: keyword

example: 4.4.0-112-generic

Operating system kernel version as a raw string.


--

*`beat.name`*::
+
--
type: alias

alias to: agent.type

--

*`beat.hostname`*::
+
--
type: alias

alias to: agent.hostname

--

*`agent.hostname`*::
+
--
type: keyword

Hostname of the agent.


--

*`user_agent.patch`*::
+
--
type: keyword

Patch version of the user agent.


--

*`user_agent.minor`*::
+
--
type: keyword

Minor version of the user agent.


--

*`user_agent.major`*::
+
--
type: keyword

Major version of the user agent.


--

*`user_agent.device`*::
+
--
type: keyword

Name of the physical device.


--

*`user_agent.os.major`*::
+
--
type: long

Major version of the operating system.


--

*`user_agent.os.minor`*::
+
--
type: long

Minor version of the operating system.


--

*`url.hostname`*::
+
--
type: keyword

Hostname of the request, such as ""elastic.co"".


--

[[exported-fields-host-processor]]
== Host fields

Info collected for the host machine.


[[exported-fields-http]]
== HTTP monitor fields

None


[float]
== http fields

HTTP related fields.



*`http.url`*::
+
--
type: text

Service url used by monitor.


*`http.url.raw`*::
+
--
type: keyword

The service url used by monitor. This is a non-analyzed field that is useful for aggregations.


--

--

[float]
== rtt fields

HTTP layer round trip times.



[float]
== validate fields

Duration between first byte of HTTP request being written and
response being processed by validator. Duration based on already
available network connection.

Note: if validator is not reading body or only a prefix, this
      number does not fully represent the total time needed
      to read the body.



*`http.rtt.validate.us`*::
+
--
type: long

Duration in microseconds

--

[float]
== validate_body fields

Duration of validator required to read and validate the response
body.

Note: if validator is not reading body or only a prefix, this
      number does not fully represent the total time needed
      to read the body.



*`http.rtt.validate_body.us`*::
+
--
type: long

Duration in microseconds

--

[float]
== write_request fields

Duration of sending the complete HTTP request. Duration based on already available network connection.


*`http.rtt.write_request.us`*::
+
--
type: long

Duration in microseconds

--

[float]
== response_header fields

Time required between sending the start of sending the HTTP request and first byte from HTTP response being read. Duration based on already available network connection.


*`http.rtt.response_header.us`*::
+
--
type: long

Duration in microseconds

--

*`http.rtt.content.us`*::
+
--
type: long

Time required to retrieved the content in micro seconds.

--

[float]
== total fields

Duration required to process the HTTP transaction. Starts with
the initial TCP connection attempt. Ends with after validator
did check the response.

Note: if validator is not reading body or only a prefix, this
      number does not fully represent the total time needed.



*`http.rtt.total.us`*::
+
--
type: long

Duration in microseconds

--

[[exported-fields-icmp]]
== ICMP fields

None


[float]
== icmp fields

IP ping fields.



*`icmp.requests`*::
+
--
type: integer

Number if ICMP EchoRequests send.


--

[float]
== rtt fields

ICMP Echo Request and Reply round trip time


*`icmp.rtt.us`*::
+
--
type: long

Duration in microseconds

--

[[exported-fields-kubernetes-processor]]
== Kubernetes fields

Kubernetes metadata added by the kubernetes processor




*`kubernetes.pod.name`*::
+
--
type: keyword

Kubernetes pod name


--

*`kubernetes.pod.uid`*::
+
--
type: keyword

Kubernetes Pod UID


--

*`kubernetes.namespace`*::
+
--
type: keyword

Kubernetes namespace


--

*`kubernetes.node.name`*::
+
--
type: keyword

Kubernetes node name


--

*`kubernetes.labels`*::
+
--
type: object

Kubernetes labels map


--

*`kubernetes.annotations`*::
+
--
type: object

Kubernetes annotations map


--

*`kubernetes.container.name`*::
+
--
type: keyword

Kubernetes container name


--

*`kubernetes.container.image`*::
+
--
type: keyword

Kubernetes container image


--

[[exported-fields-resolve]]
== Host lookup fields

None


[float]
== resolve fields

Host lookup fields.



*`resolve.host`*::
+
--
type: keyword

Hostname of service being monitored.


--

*`resolve.ip`*::
+
--
type: ip

IP address found for the given host.


--

[float]
== rtt fields

Duration required to resolve an IP from hostname.


*`resolve.rtt.us`*::
+
--
type: long

Duration in microseconds

--

[[exported-fields-socks5]]
== SOCKS5 proxy fields

None


[float]
== socks5 fields

SOCKS5 proxy related fields:



[float]
== rtt fields

TLS layer round trip times.



[float]
== connect fields

Time required to establish a connection via SOCKS5 to endpoint based on available connection to SOCKS5 proxy.



*`socks5.rtt.connect.us`*::
+
--
type: long

Duration in microseconds

--

[[exported-fields-tcp]]
== TCP layer fields

None


[float]
== tcp fields

TCP network layer related fields.



*`tcp.port`*::
+
--
type: integer

Service port number.


--

[float]
== rtt fields

TCP layer round trip times.



[float]
== connect fields

Duration required to establish a TCP connection based on already available IP address.



*`tcp.rtt.connect.us`*::
+
--
type: long

Duration in microseconds

--

[float]
== validate fields

Duration of validation step based on existing TCP connection.



*`tcp.rtt.validate.us`*::
+
--
type: long

Duration in microseconds

--

[[exported-fields-tls]]
== TLS encryption layer fields

None


[float]
== tls fields

TLS layer related fields.



*`tls.certificate_not_valid_before`*::
+
--
type: date

Earliest time at which the connection's certificates are valid.

--

*`tls.certificate_not_valid_after`*::
+
--
type: date

Latest time at which the connection's certificates are valid.

--

[float]
== rtt fields

TLS layer round trip times.



[float]
== handshake fields

Time required to finish TLS handshake based on already available network connection.



*`tls.rtt.handshake.us`*::
+
--
type: long

Duration in microseconds

--

",12470,True,2940.9690240970467,median
":spring-data-commons-ref: https://docs.spring.io/spring-data/data-commons/docs/current/reference/html

== Spring Data Cloud Spanner

https://projects.spring.io/spring-data/[Spring Data] is an abstraction for storing and retrieving POJOs in numerous storage technologies.
Spring Cloud GCP adds Spring Data support for https://cloud.google.com/spanner/[Google Cloud Spanner].

Maven coordinates for this module only, using <<getting-started.adoc#_bill_of_materials, Spring Cloud GCP BOM>>:

[source,xml]
----
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-gcp-data-spanner</artifactId>
</dependency>
----

Gradle coordinates:

[source]
----
dependencies {
    compile group: 'org.springframework.cloud', name: 'spring-cloud-gcp-data-spanner'
}
----

We provide a link:../spring-cloud-gcp-starters/spring-cloud-gcp-starter-data-spanner[Spring Boot Starter for Spring Data Spanner], with which you can leverage our recommended auto-configuration setup.
To use the starter, see the coordinates see below.


Maven:

[source,xml]
----
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-gcp-starter-data-spanner</artifactId>
</dependency>
----

Gradle:

[source,subs=""normal""]
----
dependencies {
    compile group: 'org.springframework.cloud', name: 'spring-cloud-gcp-starter-data-spanner'
}
----

This setup takes care of bringing in the latest compatible version of Cloud Java Cloud Spanner libraries as well.

=== Configuration

To setup Spring Data Cloud Spanner, you have to configure the following:

* Setup the connection details to Google Cloud Spanner.
* Enable Spring Data Repositories (optional).

==== Cloud Spanner settings

You can the use link:../spring-cloud-gcp-starters/spring-cloud-gcp-starter-data-spanner[Spring Boot Starter for Spring Data Spanner] to autoconfigure Google Cloud Spanner in your Spring application.
It contains all the necessary setup that makes it easy to authenticate with your Google Cloud project.
The following configuration options are available:

|===
| Name | Description | Required | Default value
| `spring.cloud.gcp.spanner.instance-id` | Cloud Spanner instance to use | Yes |
| `spring.cloud.gcp.spanner.database` |
Cloud Spanner database to use | Yes |
| `spring.cloud.gcp.spanner.project-id` | GCP project ID where the Google Cloud Spanner API is hosted, if different from the one in the <<spring-cloud-gcp-core,Spring Cloud GCP Core Module>>
| No |
| `spring.cloud.gcp.spanner.credentials.location` | OAuth2 credentials for authenticating with the
Google Cloud Spanner API, if different from the ones in the
<<spring-cloud-gcp-core,Spring Cloud GCP Core Module>> | No |
| `spring.cloud.gcp.spanner.credentials.encoded-key` | Base64-encoded OAuth2 credentials for authenticating with the
Google Cloud Spanner API, if different from the ones in the
<<spring-cloud-gcp-core,Spring Cloud GCP Core Module>> | No |
| `spring.cloud.gcp.spanner.credentials.scopes` |
https://developers.google.com/identity/protocols/googlescopes[OAuth2 scope] for Spring Cloud GCP
Cloud Spanner credentials | No | https://www.googleapis.com/auth/spanner.data
| `spring.cloud.gcp.spanner.createInterleavedTableDdlOnDeleteCascade` | If `true`, then schema statements generated by `SpannerSchemaUtils` for tables with interleaved parent-child relationships will be ""ON DELETE CASCADE"".
The schema for the tables will be ""ON DELETE NO ACTION"" if `false`. | No | `true`
| `spring.cloud.gcp.spanner.numRpcChannels` | Number of gRPC channels used to connect to Cloud Spanner | No | 4 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.prefetchChunks` | Number of chunks prefetched by Cloud Spanner for read and query | No | 4 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.minSessions` | Minimum number of sessions maintained in the session pool | No | 0 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.maxSessions` | Maximum number of sessions session pool can have | No | 400 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.maxIdleSessions` | Maximum number of idle sessions session pool will maintain | No | 0 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.writeSessionsFraction` | Fraction of sessions to be kept prepared for write transactions | No | 0.2 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.keepAliveIntervalMinutes` | How long to keep idle sessions alive | No | 30 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.failIfPoolExhausted` |  If all sessions are in use, fail the request by throwing an exception. Otherwise, by default, block until a session becomes available. | No | `false`
|===

==== Repository settings

Spring Data Repositories can be configured via the `@EnableSpannerRepositories` annotation on your main `@Configuration` class.
With our Spring Boot Starter for Spring Data Cloud Spanner, `@EnableSpannerRepositories` is automatically added.
It is not required to add it to any other class, unless there is a need to override finer grain configuration parameters provided by https://github.com/spring-cloud/spring-cloud-gcp/blob/master/spring-cloud-gcp-data-spanner/src/main/java/org/springframework/cloud/gcp/data/spanner/repository/config/EnableSpannerRepositories.java[`@EnableSpannerRepositories`].

==== Autoconfiguration

Our Spring Boot autoconfiguration creates the following beans available in the Spring application context:

- an instance of `SpannerTemplate`
- an instance of `SpannerDatabaseAdminTemplate` for generating table schemas from object hierarchies and creating and deleting tables and databases
- an instance of all user-defined repositories extending `SpannerRepository`, `CrudRepository`, `PagingAndSortingRepository`, when repositories are enabled
- an instance of `DatabaseClient` from the Google Cloud Java Client for Spanner, for convenience and lower level API access


=== Object Mapping

Spring Data Cloud Spanner allows you to map domain POJOs to Cloud Spanner tables via annotations:

[source,java]
----
@Table(name = ""traders"")
public class Trader {

	@PrimaryKey
	@Column(name = ""trader_id"")
	String traderId;

	String firstName;

	String lastName;

	@NotMapped
	Double temporaryNumber;
}
----

Spring Data Cloud Spanner will ignore any property annotated with `@NotMapped`.
These properties will not be written to or read from Spanner.

==== Constructors

Simple constructors are supported on POJOs.
The constructor arguments can be a subset of the persistent properties.
Every constructor argument needs to have the same name and type as a persistent property on the entity and the constructor should set the property from the given argument.
Arguments that are not directly set to properties are not supported.

[source,java]
----
@Table(name = ""traders"")
public class Trader {
	@PrimaryKey
	@Column(name = ""trader_id"")
	String traderId;

	String firstName;

	String lastName;

	@NotMapped
	Double temporaryNumber;

	public Trader(String traderId, String firstName) {
	    this.traderId = traderId;
	    this.firstName = firstName;
	}
}
----


==== Table

The `@Table` annotation can provide the name of the Cloud Spanner table that stores instances of the annotated class, one per row.
This annotation is optional, and if not given, the name of the table is inferred from the class name with the first character uncapitalized.

===== SpEL expressions for table names

In some cases, you might want the `@Table` table name to be determined dynamically.
To do that, you can use https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions[Spring Expression Language].

For example:

[source, java]
----

@Table(name = ""trades_#{tableNameSuffix}"")
public class Trade {
	// ...
}
----

The table name will be resolved only if the `tableNameSuffix` value/bean in the Spring application context is defined.
For example, if `tableNameSuffix` has the value ""123"", the table name will resolve to `trades_123`.

==== Primary Keys

For a simple table, you may only have a primary key consisting of a single column.
Even in that case, the `@PrimaryKey` annotation is required.
`@PrimaryKey` identifies the one or more ID properties corresponding to the primary key.

Spanner has first class support for composite primary keys of multiple columns.
You have to annotate all of your POJO's fields that the primary key consists of with `@PrimaryKey` as below:

[source,java]
----
@Table(name = ""trades"")
public class Trade {
	@PrimaryKey(keyOrder = 2)
	@Column(name = ""trade_id"")
	private String tradeId;

	@PrimaryKey(keyOrder = 1)
	@Column(name = ""trader_id"")
	private String traderId;

	private String action;

	private Double price;

	private Double shares;

	private String symbol;
}
----

The `keyOrder` parameter of `@PrimaryKey` identifies the properties corresponding to the primary key columns in order, starting with 1 and increasing consecutively.
Order is important and must reflect the order defined in the Cloud Spanner schema.
In our example the DDL to create the table and its primary key is as follows:

[source,sql]
----
CREATE TABLE trades (
    trader_id STRING(MAX),
    trade_id STRING(MAX),
    action STRING(15),
    symbol STRING(10),
    price FLOAT64,
    shares FLOAT64
) PRIMARY KEY (trader_id, trade_id)
----

Spanner does not have automatic ID generation.
For most use-cases, sequential IDs should be used with caution to avoid creating data hotspots in the system.
Read https://cloud.google.com/spanner/docs/schema-and-data-model#primary_keys[Spanner Primary Keys documentation] for a better understanding of primary keys and recommended practices.


==== Columns

All accessible properties on POJOs are automatically recognized as a Cloud Spanner column.
Column naming is generated by the `PropertyNameFieldNamingStrategy` by default defined on the `SpannerMappingContext` bean.
The `@Column` annotation optionally provides a different column name than that of the property and some other settings:

- `name` is the optional name of the column
- `spannerTypeMaxLength` specifies for `STRING` and `BYTES` columns the maximum length.
This setting is only used when generating DDL schema statements based on domain types.
- `nullable` specifies if the column is created as `NOT NULL`.
This setting is only used when generating DDL schema statements based on domain types.
- `spannerType` is the Cloud Spanner column type you can optionally specify.
If this is not specified then a compatible column type is inferred from the Java property type.
- `spannerCommitTimestamp` is a boolean specifying if this property corresponds to an auto-populated commit timestamp column.
Any value set in this property will be ignored when writing to Cloud Spanner.


==== Embedded Objects

If an object of type `B` is embedded as a property of `A`, then the columns of `B` will be saved in the same Cloud Spanner table as those of `A`.

If `B` has primary key columns, those columns will be included in the primary key of `A`. `B` can also have embedded properties.
Embedding allows reuse of columns between multiple entities, and can be useful for implementing parent-child situations, because Cloud Spanner requires child tables to include the key columns of their parents.

For example:

[source,java]
----
class X {
  @PrimaryKey
  String grandParentId;

  long age;
}

class A {
  @PrimaryKey
  @Embedded
  X grandParent;

  @PrimaryKey(keyOrder = 2)
  String parentId;

  String value;
}

@Table(name = ""items"")
class B {
  @PrimaryKey
  @Embedded
  A parent;

  @PrimaryKey(keyOrder = 2)
  String id;

  @Column(name = ""child_value"")
  String value;
}
----

Entities of `B` can be stored in a table defined as:

[source,sql]
----
CREATE TABLE items (
    grandParentId STRING(MAX),
    parentId STRING(MAX),
    id STRING(MAX),
    value STRING(MAX),
    child_value STRING(MAX),
    age INT64
) PRIMARY KEY (grandParentId, parentId, id)
----

Note that embedded properties' column names must all be unique.


==== Relationships

Spring Data Cloud Spanner supports parent-child relationships using the Cloud Spanner https://cloud.google.com/spanner/docs/schema-and-data-model#creating-interleaved-tables[parent-child interleaved table mechanism].
Cloud Spanner interleaved tables enforce the one-to-many relationship and provide efficient queries and operations on entities of a single domain parent entity.
These relationships can be up to 7 levels deep.
Cloud Spanner also provides automatic cascading delete or enforces the deletion of child entities before parents.

While one-to-one and many-to-many relationships can be implemented in Cloud Spanner and Spring Data Cloud Spanner using constructs of interleaved parent-child tables, only the parent-child relationship is natively supported.
Cloud Spanner does not support the foreign key constraint, though the parent-child key constraint enforces a similar requirement when used with interleaved tables.

For example, the following Java entities:

[source,java]
----
@Table(name = ""Singers"")
class Singer {
  @PrimaryKey
  long SingerId;

  String FirstName;

  String LastName;

  byte[] SingerInfo;

  @Interleaved
  List<Album> albums;
}

@Table(name = ""Albums"")
class Album {
  @PrimaryKey
  long SingerId;

  @PrimaryKey(keyOrder = 2)
  long AlbumId;

  String AlbumTitle;
}
----

These classes can correspond to an existing pair of interleaved tables.
The `@Interleaved` annotation may be applied to `Collection` properties and the inner type is resolved as the child entity type.
The schema needed to create them can also be generated using the `SpannerSchemaUtils` and executed using the `SpannerDatabaseAdminTemplate`:

[source,java]
----

@Autowired
SpannerSchemaUtils schemaUtils;

@Autowired
SpannerDatabaseAdminTemplate databaseAdmin;
...

// Get the create statmenets for all tables in the table structure rooted at Singer
List<String> createStrings = this.schemaUtils.getCreateTableDdlStringsForInterleavedHierarchy(Singer.class);

// Create the tables and also create the database if necessary
this.databaseAdmin.executeDdlStrings(createStrings, true);
----

The `createStrings` list contains table schema statements using column names and types compatible with the provided Java type and any resolved child relationship types contained within based on the configured custom converters.

[source,sql]
----
CREATE TABLE Singers (
  SingerId   INT64 NOT NULL,
  FirstName  STRING(1024),
  LastName   STRING(1024),
  SingerInfo BYTES(MAX),
) PRIMARY KEY (SingerId);

CREATE TABLE Albums (
  SingerId     INT64 NOT NULL,
  AlbumId      INT64 NOT NULL,
  AlbumTitle   STRING(MAX),
) PRIMARY KEY (SingerId, AlbumId),
  INTERLEAVE IN PARENT Singers ON DELETE CASCADE;
----

The `ON DELETE CASCADE` clause indicates that Cloud Spanner will delete all Albums of a singer if the Singer is deleted.
The alternative is `ON DELETE NO ACTION`, where a Singer cannot be deleted until all of its Albums have already been deleted.
When using `SpannerSchemaUtils` to generate the schema strings, the `spring.cloud.gcp.spanner.createInterleavedTableDdlOnDeleteCascade` boolean setting determines if these schema are generated as `ON DELETE CASCADE` for `true` and `ON DELETE NO ACTION` for `false`.

Cloud Spanner restricts these relationships to 7 child layers.
A table may have multiple child tables.

On updating or inserting an object to Cloud Spanner, all of its referenced children objects are also updated or inserted in the same request, respectively.
On read, all of the interleaved child rows are also all read.

===== Lazy Fetch

`@Interleaved` properties are retrieved eagerly by default, but can be fetched lazily for performance in both read and write:

[source,java]
----
@Interleaved(lazy = true)
List<Album> albums;
----

Lazily-fetched interleaved properties are retrieved upon the first interaction with the property.
If a property marked for lazy fetching is never retrieved, then it is also skipped when saving the parent entity.

If used inside a transaction, subsequent operations on lazily-fetched properties use the same transaction context as that of the original parent entity.

===== Declarative Filtering with `@Where`
The `@Where` annotation could be applied to an entity class or to an interleaved property.
This annotation provides an SQL where clause that will be applied at the fetching of interleaved collections or the entity itself.

Let's say we have an `Agreement` with a list of `Participants` which could be assigned to it.
We would like to fetch a list of currently active participants.
For security reasons, all records should remain in the database forever, even if participants become inactive.
That can be easily achieved with the `@Where` annotation, which is demonstrated by this example:

[source, java]
----
@Table(name = ""participants"")
public class Participant {
  //...
  boolean active;
  //...
}

@Table(name = ""agreements"")
public class Agreement {
  //...
  @Interleaved
  @Where(""active = true"")
  List<Participant> participants;
  Person person;
  //...
}
----

==== Supported Types

Spring Data Cloud Spanner natively supports the following types for regular fields but also utilizes custom converters (detailed in following sections) and dozens of pre-defined Spring Data custom converters to handle other common Java types.

Natively supported types:

* `com.google.cloud.ByteArray`
* `com.google.cloud.Date`
* `com.google.cloud.Timestamp`
* `java.lang.Boolean`, `boolean`
* `java.lang.Double`, `double`
* `java.lang.Long`, `long`
* `java.lang.Integer`, `int`
* `java.lang.String`
* `double[]`
* `long[]`
* `boolean[]`
* `java.util.Date`
* `java.util.Instant`
* `java.sql.Date`
* `java.time.LocalDate`
* `java.time.LocalDateTime`


==== Lists

Spanner supports `ARRAY` types for columns.
`ARRAY` columns are mapped to `List` fields in POJOS.

Example:

[source,java]
----
List<Double> curve;
----

The types inside the lists can be any singular property type.

==== Lists of Structs

Cloud Spanner queries can https://cloud.google.com/spanner/docs/query-syntax#using-structs-with-select[construct STRUCT values] that appear as columns in the result.
Cloud Spanner requires STRUCT values appear in ARRAYs at the root level: `SELECT ARRAY(SELECT STRUCT(1 as val1, 2 as val2)) as pair FROM Users`.

Spring Data Cloud Spanner will attempt to read the column STRUCT values into a property that is an `Iterable` of an entity type compatible with the schema of the column STRUCT value.


For the previous array-select example, the following property can be mapped with the constructed `ARRAY<STRUCT>` column: `List<TwoInts> pair;` where the `TwoInts` type is defined:

[source, java]
----
class TwoInts {

  int val1;

  int val2;
}
----

==== Custom types

Custom converters can be used to extend the type support for user defined types.

. Converters need to implement the `org.springframework.core.convert.converter.Converter` interface in both directions.
. The user defined type needs to be mapped to one of the basic types supported by Spanner:

* `com.google.cloud.ByteArray`
* `com.google.cloud.Date`
* `com.google.cloud.Timestamp`
* `java.lang.Boolean`, `boolean`
* `java.lang.Double`, `double`
* `java.lang.Long`, `long`
* `java.lang.String`
* `double[]`
* `long[]`
* `boolean[]`
* `enum` types

. An instance of both Converters needs to be passed to a `ConverterAwareMappingSpannerEntityProcessor`, which then has to be made available as a `@Bean` for `SpannerEntityProcessor`.

For example:

We would like to have a field of type `Person` on our `Trade` POJO:
[source, java]
----

@Table(name = ""trades"")
public class Trade {
  //...
  Person person;
  //...
}
----

Where Person is a simple class:

[source, java]
----
public class Person {

  public String firstName;
  public String lastName;

}
----

We have to define the two converters:

[source, java]
----
  public class PersonWriteConverter implements Converter<Person, String> {

    @Override
    public String convert(Person person) {
      return person.firstName + "" "" + person.lastName;
    }
  }

  public class PersonReadConverter implements Converter<String, Person> {

    @Override
    public Person convert(String s) {
      Person person = new Person();
      person.firstName = s.split("" "")[0];
      person.lastName = s.split("" "")[1];
      return person;
    }
  }
----

That will be configured in our `@Configuration` file:

[source, java]
----
@Configuration
public class ConverterConfiguration {

	@Bean
	public SpannerEntityProcessor spannerEntityProcessor(SpannerMappingContext spannerMappingContext) {
		return new ConverterAwareMappingSpannerEntityProcessor(spannerMappingContext,
				Arrays.asList(new PersonWriteConverter()),
				Arrays.asList(new PersonReadConverter()));
	}
}
----

==== Custom Converter for Struct Array Columns
If a `Converter<Struct, A>` is provided, then properties of type `List<A>` can be used in your entity types.


=== Spanner Operations & Template

`SpannerOperations` and its implementation, `SpannerTemplate`, provides the Template pattern familiar to Spring developers.
It provides:

 - Resource management
 - One-stop-shop to Spanner operations with the Spring Data POJO mapping and conversion features
 - Exception conversion

Using the `autoconfigure` provided by our Spring Boot Starter for Spanner, your Spring application context will contain a fully configured `SpannerTemplate` object that you can easily autowire in your application:

[source,java]
----
@SpringBootApplication
public class SpannerTemplateExample {

	@Autowired
	SpannerTemplate spannerTemplate;

	public void doSomething() {
		this.spannerTemplate.delete(Trade.class, KeySet.all());
		//...
		Trade t = new Trade();
		//...
		this.spannerTemplate.insert(t);
		//...
		List<Trade> tradesByAction = spannerTemplate.findAll(Trade.class);
		//...
	}
}
----

The Template API provides convenience methods for:

- https://cloud.google.com/spanner/docs/reads[Reads], and by providing SpannerReadOptions and
SpannerQueryOptions
   ** Stale read
   ** Read with secondary indices
   ** Read with limits and offsets
   ** Read with sorting
- https://cloud.google.com/spanner/docs/reads#execute_a_query[Queries]
- DML operations (delete, insert, update, upsert)
- Partial reads
   ** You can define a set of columns to be read into your entity
- Partial writes
   ** Persist only a few properties from your entity
- Read-only transactions
- Locking read-write transactions

==== SQL Query

Cloud Spanner has SQL support for running read-only queries.
All the query related methods start with `query` on `SpannerTemplate`.
Using `SpannerTemplate` you can execute SQL queries that map to POJOs:

[source,java]
----
List<Trade> trades = this.spannerTemplate.query(Trade.class, Statement.of(""SELECT * FROM trades""));
----

==== Read

Spanner exposes a https://cloud.google.com/spanner/docs/reads[Read API] for reading single row or multiple rows in a table or in a secondary index.

Using `SpannerTemplate` you can execute reads, for example:

[source,java]
----
List<Trade> trades = this.spannerTemplate.readAll(Trade.class);
----

Main benefit of reads over queries is reading multiple rows of a certain pattern of keys is much easier using the features of the https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/google-cloud-spanner/src/main/java/com/google/cloud/spanner/KeySet.java[`KeySet`] class.


==== Advanced reads

===== Stale read

All reads and queries are *strong reads* by default.
A *strong read* is a read at a current time and is guaranteed to see all data that has been committed up until the start of this read.
An *exact staleness read* is read at a timestamp in the past.
Cloud Spanner allows you to determine how current the data should be when you read data.
With `SpannerTemplate` you can specify the `Timestamp` by setting it on `SpannerQueryOptions` or `SpannerReadOptions` to the appropriate read or query methods:

Reads:

[source,java]
----
// a read with options:
SpannerReadOptions spannerReadOptions = new SpannerReadOptions().setTimestamp(myTimestamp);
List<Trade> trades = this.spannerTemplate.readAll(Trade.class, spannerReadOptions);
----

Queries:

[source,java]
----
// a query with options:
SpannerQueryOptions spannerQueryOptions = new SpannerQueryOptions().setTimestamp(myTimestamp);
List<Trade> trades = this.spannerTemplate.query(Trade.class, Statement.of(""SELECT * FROM trades""), spannerQueryOptions);
----

You can also read with https://cloud.google.com/spanner/docs/timestamp-bounds[*bounded staleness*] by setting `.setTimestampBound(TimestampBound.ofMinReadTimestamp(myTimestamp))` on the query and read options objects.
Bounded staleness lets Cloud Spanner choose any point in time later than or equal to the given timestampBound, but it cannot be used inside transactions.


===== Read from a secondary index

Using a https://cloud.google.com/spanner/docs/secondary-indexes[secondary index] is available for Reads via the Template API and it is also implicitly available via SQL for Queries.

The following shows how to read rows from a table using a https://cloud.google.com/spanner/docs/secondary-indexes[secondary index] simply by setting `index` on `SpannerReadOptions`:

[source,java]
----
SpannerReadOptions spannerReadOptions = new SpannerReadOptions().setIndex(""TradesByTrader"");
List<Trade> trades = this.spannerTemplate.readAll(Trade.class, spannerReadOptions);
----


===== Read with offsets and limits

Limits and offsets are only supported by Queries.
The following will get only the first two rows of the query:

[source,java]
----
SpannerQueryOptions spannerQueryOptions = new SpannerQueryOptions().setLimit(2).setOffset(3);
List<Trade> trades = this.spannerTemplate.query(Trade.class, Statement.of(""SELECT * FROM trades""), spannerQueryOptions);
----

Note that the above is equivalent of executing `SELECT * FROM trades LIMIT 2 OFFSET 3`.

===== Sorting

Reads by keys do not support sorting.
However, queries on the Template API support sorting through standard SQL and also via Spring Data Sort API:

[source,java]
----
List<Trade> trades = this.spannerTemplate.queryAll(Trade.class, Sort.by(""action""));
----

If the provided sorted field name is that of a property of the domain type, then the column name corresponding to that property will be used in the query.
Otherwise, the given field name is assumed to be the name of the column in the Cloud Spanner table.
Sorting on columns of Cloud Spanner types STRING and BYTES can be done while ignoring case:

[source,java]
----
Sort.by(Order.desc(""action"").ignoreCase())
----

===== Partial read

Partial read is only possible when using Queries.
In case the rows returned by the query have fewer columns than the entity that it will be mapped to, Spring Data will map the returned columns only.
This setting also applies to nested structs and their corresponding nested POJO properties.

[source,java]
----
List<Trade> trades = this.spannerTemplate.query(Trade.class, Statement.of(""SELECT action, symbol FROM trades""),
    new SpannerQueryOptions().setAllowMissingResultSetColumns(true));
----

If the setting is set to `false`, then an exception will be thrown if there are missing columns in the query result.

===== Summary of options for Query vs Read

|===
| Feature | Query supports it | Read supports it
| SQL  | yes | no
| Partial read | yes | no
| Limits | yes | no
| Offsets | yes | no
| Secondary index | yes | yes
| Read using index range | no | yes
| Sorting | yes | no
|===

==== Write / Update

The write methods of `SpannerOperations` accept a POJO and writes all of its properties to Spanner.
The corresponding Spanner table and entity metadata is obtained from the given object's actual type.

If a POJO was retrieved from Spanner and its primary key properties values were changed and then written or updated, the operation will occur as if against a row with the new primary key values.
The row with the original primary key values will not be affected.

===== Insert

The `insert` method of `SpannerOperations` accepts a POJO and writes all of its properties to Spanner, which means the operation will fail if a row with the POJO's primary key already exists in the table.

[source, java]
----
Trade t = new Trade();
this.spannerTemplate.insert(t);
----

===== Update

The `update` method of `SpannerOperations` accepts a POJO and writes all of its properties to Spanner, which means the operation will fail if the POJO's primary key does not already exist in the table.

[source, java]
----
// t was retrieved from a previous operation
this.spannerTemplate.update(t);
----

===== Upsert

The `upsert` method of `SpannerOperations` accepts a POJO and writes all of its properties to Spanner using update-or-insert.

[source, java]
----
// t was retrieved from a previous operation or it's new
this.spannerTemplate.upsert(t);
----

===== Partial Update

The update methods of `SpannerOperations` operate by default on all properties within the given object, but also accept `String[]` and `Optional<Set<String>>` of column names.
If the `Optional` of set of column names is empty, then all columns are written to Spanner.
However, if the Optional is occupied by an empty set, then no columns will be written.


[source, java]
----
// t was retrieved from a previous operation or it's new
this.spannerTemplate.update(t, ""symbol"", ""action"");
----

==== DML

DML statements can be executed using `SpannerOperations.executeDmlStatement`.
Inserts, updates, and deletions can affect any number of rows and entities.

You can execute https://cloud.google.com/spanner/docs/dml-partitioned[partitioned DML] updates by using the `executePartitionedDmlStatement` method.
Partitioned DML queries have performance benefits but also have restrictions and cannot be used inside transactions.

==== Transactions

`SpannerOperations` provides methods to run `java.util.Function` objects within a single transaction while making available the read and write methods from `SpannerOperations`.

===== Read/Write Transaction

Read and write transactions are provided by `SpannerOperations` via the `performReadWriteTransaction` method:

[source,java]
----

@Autowired
SpannerOperations mySpannerOperations;

public String doWorkInsideTransaction() {
  return mySpannerOperations.performReadWriteTransaction(
    transActionSpannerOperations -> {
      // Work with transActionSpannerOperations here.
      // It is also a SpannerOperations object.

      return ""transaction completed"";
    }
  );
}
----

The `performReadWriteTransaction` method accepts a `Function` that is provided an instance of a `SpannerOperations` object.
The final returned value and type of the function is determined by the user.
You can use this object just as you would a regular `SpannerOperations` with a few exceptions:

- Its read functionality cannot perform stale reads, because all reads and writes happen at the single point in time of the transaction.
- It cannot perform sub-transactions via `performReadWriteTransaction` or `performReadOnlyTransaction`.

As these read-write transactions are locking, it is recommended that you use the `performReadOnlyTransaction` if your function does not perform any writes.

===== Read-only Transaction

The `performReadOnlyTransaction` method is used to perform read-only transactions using a `SpannerOperations`:

[source,java]
----

@Autowired
SpannerOperations mySpannerOperations;

public String doWorkInsideTransaction() {
  return mySpannerOperations.performReadOnlyTransaction(
    transActionSpannerOperations -> {
      // Work with transActionSpannerOperations here.
      // It is also a SpannerOperations object.

      return ""transaction completed"";
    }
  );
}
----

The `performReadOnlyTransaction` method accepts a `Function` that is provided an instance of a
`SpannerOperations` object.
This method also accepts a `ReadOptions` object, but the only attribute used is the timestamp used to determine the snapshot in time to perform the reads in the transaction.
If the timestamp is not set in the read options the transaction is run against the current state of the database.
The final returned value and type of the function is determined by the user.
You can use this object just as you would a regular `SpannerOperations` with
a few exceptions:

- Its read functionality cannot perform stale reads (other than the staleness set on the entire transaction), because all reads happen at the single point in time of the transaction.
- It cannot perform sub-transactions via `performReadWriteTransaction` or `performReadOnlyTransaction`
- It cannot perform any write operations.

Because read-only transactions are non-locking and can be performed on points in time in the past, these are recommended for functions that do not perform write operations.

===== Declarative Transactions with @Transactional Annotation

This feature requires a bean of `SpannerTransactionManager`, which is provided when using `spring-cloud-gcp-starter-data-spanner`.

`SpannerTemplate` and `SpannerRepository` support running methods with the `@Transactional` https://docs.spring.io/spring/docs/current/spring-framework-reference/data-access.html#transaction-declarative[annotation] as transactions.
If a method annotated with `@Transactional` calls another method also annotated, then both methods will work within the same transaction.
`performReadOnlyTransaction` and `performReadWriteTransaction` cannot be used in `@Transactional` annotated methods because Cloud Spanner does not support transactions within transactions.

==== DML Statements

`SpannerTemplate` supports https://cloud.google.com/spanner/docs/dml-tasks:[DML] `Statements`.
DML statements can also be executed in transactions via `performReadWriteTransaction` or using the `@Transactional` annotation.

=== Repositories

{spring-data-commons-ref}/#repositories[Spring Data Repositories] are a powerful abstraction that can save you a lot of boilerplate code.

For example:

[source,java]
----
public interface TraderRepository extends SpannerRepository<Trader, String> {
}
----

Spring Data generates a working implementation of the specified interface, which can be conveniently autowired into an application.

The `Trader` type parameter to `SpannerRepository` refers to the underlying domain type.
The second type parameter, `String` in this case, refers to the type of the key of the domain type.


For POJOs with a composite primary key, this ID type parameter can be any descendant of `Object[]` compatible with all primary key properties, any descendant of `Iterable`, or `com.google.cloud.spanner.Key`.
If the domain POJO type only has a single primary key column, then the primary key property type can be used or the `Key` type.

For example in case of Trades, that belong to a Trader, `TradeRepository` would look like this:

[source,java]
----
public interface TradeRepository extends SpannerRepository<Trade, String[]> {

}
----

[source,java]
----
public class MyApplication {

	@Autowired
	SpannerTemplate spannerTemplate;

	@Autowired
	StudentRepository studentRepository;

	public void demo() {

		this.tradeRepository.deleteAll();
		String traderId = ""demo_trader"";
		Trade t = new Trade();
		t.symbol = stock;
		t.action = action;
		t.traderId = traderId;
		t.price = 100.0;
		t.shares = 12345.6;
		this.spannerTemplate.insert(t);

		Iterable<Trade> allTrades = this.tradeRepository.findAll();

		int count = this.tradeRepository.countByAction(""BUY"");

	}
}

----

==== CRUD Repository

`CrudRepository` methods work as expected, with one thing Spanner specific: the `save` and `saveAll` methods work as update-or-insert.

==== Paging and Sorting Repository

You can also use `PagingAndSortingRepository` with Spanner Spring Data.
The sorting and pageable `findAll` methods available from this interface operate on the current state of the Spanner database.
As a result, beware that the state of the database (and the results) might change when moving page to page.

==== Spanner Repository

The `SpannerRepository` extends the `PagingAndSortingRepository`, but adds the read-only and the read-write transaction functionality provided by Spanner.
These transactions work very similarly to those of `SpannerOperations`, but is specific to the repository's domain type and provides repository functions instead of template functions.

For example, this is a read-only transaction:

[source,java]
----

@Autowired
SpannerRepository myRepo;

public String doWorkInsideTransaction() {
  return myRepo.performReadOnlyTransaction(
    transactionSpannerRepo -> {
      // Work with the single-transaction transactionSpannerRepo here.
      // This is a SpannerRepository object.

      return ""transaction completed"";
    }
  );
}
----

When creating custom repositories for your own domain types and query methods, you can extend `SpannerRepository` to access Cloud Spanner-specific features as well as all features from `PagingAndSortingRepository` and `CrudRepository`.

=== Query Methods

`SpannerRepository` supports Query Methods.
Described in the following sections, these are methods residing in your custom repository interfaces of which implementations are generated based on their names and annotations.
Query Methods can read, write, and delete entities in Cloud Spanner.
Parameters to these methods can be any Cloud Spanner data type supported directly or via custom configured converters.
Parameters can also be of type `Struct` or POJOs.
If a POJO is given as a parameter, it will be converted to a `Struct` with the same type-conversion logic as used to create write mutations.
Comparisons using Struct parameters are limited to https://cloud.google.com/spanner/docs/data-types#limited-comparisons-for-struct[what is available with Cloud Spanner].


==== Query methods by convention

[source, java]
----
public interface TradeRepository extends SpannerRepository<Trade, String[]> {
    List<Trade> findByAction(String action);

	int countByAction(String action);

	// Named methods are powerful, but can get unwieldy
	List<Trade> findTop3DistinctByActionAndSymbolIgnoreCaseOrTraderIdOrderBySymbolDesc(
  			String action, String symbol, String traderId);
}
----

In the example above, the {spring-data-commons-ref}/#repositories.query-methods[query methods] in `TradeRepository` are generated based on the name of the methods, using the {spring-data-commons-ref}#repositories.query-methods.query-creation[Spring Data Query creation naming convention].

`List<Trade> findByAction(String action)` would translate to a `SELECT * FROM trades WHERE action = ?`.

The function `List<Trade> findTop3DistinctByActionAndSymbolIgnoreCaseOrTraderIdOrderBySymbolDesc(String action, String symbol, String traderId);` will be translated as the equivalent of this SQL query:

[source, sql]
----
SELECT DISTINCT * FROM trades
WHERE ACTION = ? AND LOWER(SYMBOL) = LOWER(?) AND TRADER_ID = ?
ORDER BY SYMBOL DESC
LIMIT 3
----

The following filter options are supported:

* Equality
* Greater than or equals
* Greater than
* Less than or equals
* Less than
* Is null
* Is not null
* Is true
* Is false
* Like a string
* Not like a string
* Contains a string
* Not contains a string
* In
* Not in

Note that the phrase `SymbolIgnoreCase` is translated to `LOWER(SYMBOL) = LOWER(?)` indicating a non-case-sensitive matching.
The `IgnoreCase` phrase may only be appended to fields that correspond to columns of type STRING or BYTES.
The Spring Data ""AllIgnoreCase"" phrase appended at the end of the method name is not supported.

The `Like` or `NotLike` naming conventions:
[source, java]
----
List<Trade> findBySymbolLike(String symbolFragment);
----
The param `symbolFragment` can contain https://cloud.google.com/spanner/docs/functions-and-operators#comparison-operators[wildcard characters] for string matching such as `_` and `%`.

The `Contains` and `NotContains` naming conventions:
[source, java]
----
List<Trade> findBySymbolContains(String symbolFragment);
----
The param `symbolFragment` is a https://cloud.google.com/spanner/docs/functions-and-operators#regexp_contains[regular expression] that is checked for occurrences.

The `In` and `NotIn` keywords must be used with `Iterable` corresponding parameters.

Delete queries are also supported.
For example, query methods such as `deleteByAction` or `removeByAction` delete entities found by `findByAction`.
The delete operation happens in a single transaction.

Delete queries can have the following return types:
* An integer type that is the number of entities deleted
* A collection of entities that were deleted
* `void`

==== Custom SQL/DML query methods

The example above for `List<Trade> fetchByActionNamedQuery(String action)` does not match the {spring-data-commons-ref}#repositories.query-methods.query-creation[Spring Data Query creation naming convention], so we have to map a parametrized Spanner SQL query to it.

The SQL query for the method can be mapped to repository methods in one of two ways:

 * `namedQueries` properties file
 * using the `@Query` annotation

The names of the tags of the SQL correspond to the `@Param` annotated names of the method parameters.

Interleaved properties are loaded eagerly, unless they are annotated with `@Interleaved(lazy = true)`.

Custom SQL query methods can accept a single `Sort` or `Pageable` parameter that is applied on top of the specified custom query.
It is the recommended way to control the sort order of the results, which is not guaranteed by the `ORDER BY` clause in the SQL query.
This is due to the fact that the user-provided query is used as a sub-query, and Cloud Spanner doesn't preserve order in subquery results.

You might want to use `ORDER BY` with `LIMIT` to obtain the top records, according to a specified order.
However, to ensure the correct sort order of the final result set, sort options have to be passed in with a `Pageable`.

[source, java]
----
	@Query(""SELECT * FROM trades"") 
	List<Trade> fetchTrades(Pageable pageable);

	@Query(""SELECT * FROM trades ORDER BY price DESC LIMIT 1"")
 	Trade topTrade(Pageable pageable);

----

This can be used:

[source, java]
----
	List<Trade> customSortedTrades = tradeRepository.fetchTrades(PageRequest
  				.of(2, 2, org.springframework.data.domain.Sort.by(Order.asc(""id""))));
----

The results would be sorted by ""id"" in ascending order.

Your query method can also return non-entity types:
[source, java]
----
  	@Query(""SELECT COUNT(1) FROM trades WHERE action = @action"")
  	int countByActionQuery(String action);

  	@Query(""SELECT EXISTS(SELECT COUNT(1) FROM trades WHERE action = @action)"")
  	boolean existsByActionQuery(String action);

  	@Query(""SELECT action FROM trades WHERE action = @action LIMIT 1"")
  	String getFirstString(@Param(""action"") String action);

  	@Query(""SELECT action FROM trades WHERE action = @action"")
  	List<String> getFirstStringList(@Param(""action"") String action);
----

DML statements can also be executed by query methods, but the only possible return value is a `long` representing the number of affected rows.
The `dmlStatement` boolean setting must be set on `@Query` to indicate that the query method is executed as a DML statement.

[source, java]
----
  	@Query(value = ""DELETE FROM trades WHERE action = @action"", dmlStatement = true)
  	long deleteByActionQuery(String action);
----

===== Query methods with named queries properties

By default, the `namedQueriesLocation` attribute on `@EnableSpannerRepositories` points to the `META-INF/spanner-named-queries.properties` file.
You can specify the query for a method in the properties file by providing the SQL as the value for the ""interface.method"" property:

[source, properties]
----
Trade.fetchByActionNamedQuery=SELECT * FROM trades WHERE trades.action = @tag0
----

[source, java]
----
public interface TradeRepository extends SpannerRepository<Trade, String[]> {
	// This method uses the query from the properties file instead of one generated based on name.
	List<Trade> fetchByActionNamedQuery(@Param(""tag0"") String action);
}
----
===== Query methods with annotation

Using the `@Query` annotation:

[source, java]
----
public interface TradeRepository extends SpannerRepository<Trade, String[]> {
    @Query(""SELECT * FROM trades WHERE trades.action = @tag0"")
    List<Trade> fetchByActionNamedQuery(@Param(""tag0"") String action);
}
----

Table names can be used directly.
For example, ""trades"" in the above example.
Alternatively, table names can be resolved from the `@Table` annotation on domain classes as well.
In this case, the query should refer to table names with fully qualified class names between `:`
characters: `:fully.qualified.ClassName:`.
A full example would look like:

[source, java]
----
@Query(""SELECT * FROM :com.example.Trade: WHERE trades.action = @tag0"")
List<Trade> fetchByActionNamedQuery(String action);
----

This allows table names evaluated with SpEL to be used in custom queries.

SpEL can also be used to provide SQL parameters:

[source, java]
----
@Query(""SELECT * FROM :com.example.Trade: WHERE trades.action = @tag0
  AND price > #{#priceRadius * -1} AND price < #{#priceRadius * 2}"")
List<Trade> fetchByActionNamedQuery(String action, Double priceRadius);
----

When using the `IN` SQL clause, remember to use `IN UNNEST(@iterableParam)` to specify a single `Iterable` parameter.
You can also use a fixed number of singular parameters such as `IN (@stringParam1, @stringParam2)`.

==== Projections
Spring Data Spanner supports {spring-data-commons-ref}/#projections[projections].
You can define projection interfaces based on domain types and add query methods that return them in your repository:

[source, java]
----
public interface TradeProjection {

	String getAction();

	@Value(""#{target.symbol + ' ' + target.action}"")
	String getSymbolAndAction();
}

public interface TradeRepository extends SpannerRepository<Trade, Key> {

	List<Trade> findByTraderId(String traderId);

	List<TradeProjection> findByAction(String action);

	@Query(""SELECT action, symbol FROM trades WHERE action = @action"")
	List<TradeProjection> findByQuery(String action);
}
----

Projections can be provided by name-convention-based query methods as well as by custom SQL queries.
If using custom SQL queries, you can further restrict the columns retrieved from Spanner to just those required by the projection to improve performance.

Properties of projection types defined using SpEL use the fixed name `target` for the underlying domain object.
As a result accessing underlying properties take the form `target.<property-name>`.

==== Empty result handling in repository methods
Java `java.util.Optional` can be used to indicate the potential absence of a return value.

Alternatively, query methods can return the result without a wrapper.
In that case the absence of a query result is indicated by returning `null`.
Repository methods returning collections are guaranteed never to return `null` but rather the corresponding empty collection.

NOTE: You can enable nullability checks. For more details please see https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#null-safety[Spring Framework’s nullability docs].

==== REST Repositories

When running with Spring Boot, repositories can be exposed as REST services by simply adding this dependency to your pom file:
[source,xml]
----
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>
----

If you prefer to configure parameters (such as path), you can use `@RepositoryRestResource` annotation:
[source,java]
----
@RepositoryRestResource(collectionResourceRel = ""trades"", path = ""trades"")
public interface TradeRepository extends SpannerRepository<Trade, Key> {
}
----

NOTE: For classes that have composite keys (multiple `@PrimaryKey` fields), only the `Key` type is supported for the repository ID type.

For example, you can retrieve all `Trade` objects in the repository by using `curl \\http://<server>:<port>/trades`, or any specific trade via `curl \\http://<server>:<port>/trades/<trader_id>,<trade_id>`.

The separator between your primary key components, `id` and `trader_id` in this case, is a comma by default, but can be configured to any string not found in your key values by extending the `SpannerKeyIdConverter` class:

[source,java]
----
@Component
class MySpecialIdConverter extends SpannerKeyIdConverter {

    @Override
    protected String getUrlIdSeparator() {
        return "":"";
    }
}
----

You can also write trades using `curl -XPOST -H""Content-Type: application/json"" -d@test.json \\http://<server>:<port>/trades/` where the file `test.json` holds the JSON representation of a `Trade` object.

=== Database and Schema Admin

Databases and tables inside Spanner instances can be created automatically from `SpannerPersistentEntity` objects:

[source,java]
----
@Autowired
private SpannerSchemaUtils spannerSchemaUtils;

@Autowired
private SpannerDatabaseAdminTemplate spannerDatabaseAdminTemplate;

public void createTable(SpannerPersistentEntity entity) {
	if(!spannerDatabaseAdminTemplate.tableExists(entity.tableName()){

	  // The boolean parameter indicates that the database will be created if it does not exist.
	  spannerDatabaseAdminTemplate.executeDdlStrings(Arrays.asList(
            spannerSchemaUtils.getCreateTableDDLString(entity.getType())), true);
	}
}
----

Schemas can be generated for entire object hierarchies with interleaved relationships and composite keys.

=== Events

Spring Data Cloud Spanner publishes events extending the Spring Framework's `ApplicationEvent` to the context that can be received by `ApplicationListener` beans you register.

[options=""header""]
|===
| Type| Description | Contents
| `AfterReadEvent`|Published immediately after entities are read by key from Cloud Spanner by `SpannerTemplate`| The entities loaded. The read options and key-set originally specified for the load operation.
| `AfterQueryEvent`|Published immediately after entities are read by query from Cloud Spanner by `SpannerTemplate`| The entities loaded. The query options and query statement originally specified for the load operation.
| `BeforeExecuteDmlEvent`|Published immediately before DML statements are executed by `SpannerTemplate`| The DML statement to execute.
| `AfterExecuteDmlEvent`|Published immediately after DML statements are executed by `SpannerTemplate`| The DML statement to execute and the number of rows affected by the operation as reported by Cloud Spanner.
| `BeforeSaveEvent`|Published immediately before upsert/update/insert operations are executed by `SpannerTemplate`| The mutations to be sent to Cloud Spanner, the entities to be saved, and optionally the properties in those entities to save.
| `AfterSaveEvent`|Published immediately after upsert/update/insert operations are executed by `SpannerTemplate`| The mutations sent to Cloud Spanner, the entities to be saved, and optionally the properties in those entities to save.
| `BeforeDeleteEvent`|Published immediately before delete operations are executed by `SpannerTemplate`| The mutations to be sent to Cloud Spanner. The target entities, keys, or entity type originally specified for the delete operation.
| `AfterDeleteEvent`|Published immediately after delete operations are executed by `SpannerTemplate`| The mutations sent to Cloud Spanner. The target entities, keys, or entity type originally specified for the delete operation.
|===


=== Auditing

Spring Data Cloud Spanner supports the `@LastModifiedDate` and `@LastModifiedBy` auditing annotations for properties:

[source,java]
----
@Table
public class SimpleEntity {
    @PrimaryKey
    String id;

    @LastModifiedBy
    String lastUser;

    @LastModifiedDate
    DateTime lastTouched;
}
----

Upon insert, update, or save, these properties will be set automatically by the framework before mutations are generated and saved to Cloud Spanner.

To take advantage of these features, add the `@EnableSpannerAuditing` annotation to your configuration class and provide a bean for an `AuditorAware<A>` implementation where the type `A` is the desired property type annotated by `@LastModifiedBy`:

[source,java]
----
@Configuration
@EnableSpannerAuditing
public class Config {

    @Bean
    public AuditorAware<String> auditorProvider() {
        return () -> Optional.of(""YOUR_USERNAME_HERE"");
    }
}
----

The `AuditorAware` interface contains a single method that supplies the value for fields annotated by `@LastModifiedBy` and can be of any type.
One alternative is to use Spring Security's `User` type:

[source,java]
----
class SpringSecurityAuditorAware implements AuditorAware<User> {

  public Optional<User> getCurrentAuditor() {

    return Optional.ofNullable(SecurityContextHolder.getContext())
			  .map(SecurityContext::getAuthentication)
			  .filter(Authentication::isAuthenticated)
			  .map(Authentication::getPrincipal)
			  .map(User.class::cast);
  }
}
----

You can also set a custom provider for properties annotated `@LastModifiedDate` by providing a bean for `DateTimeProvider` and providing the bean name to `@EnableSpannerAuditing(dateTimeProviderRef = ""customDateTimeProviderBean"")`.

=== Multi-Instance Usage

Your application can be configured to use multiple Cloud Spanner instances or databases by providing a custom bean for `DatabaseIdProvider`.
The default bean uses the instance ID, database name, and project ID options you configured in `application.properties`.

[source,java]
----
    @Bean
    public DatabaseIdProvider databaseIdProvider() {
        // return custom connection options provider
    }
----

The `DatabaseId` given by this provider is used as the target database name and instance of each operation Spring Data Cloud Spanner executes.
By providing a custom implementation of this bean (for example, supplying a thread-local `DatabaseId`), you can direct your application to use multiple instances or databases.

Database administrative operations, such as creating tables using `SpannerDatabaseAdminTemplate`, will also utilize the provided `DatabaseId`.

If you would like to configure every aspect of each connection (such as pool size and retry settings), you can supply a bean for `Supplier<DatabaseClient>`.


=== Cloud Spanner Emulator

The https://cloud.google.com/sdk[Cloud SDK] provides a local, in-memory emulator for Cloud Spanner, which you can use to develop and test your application. As the emulator stores data only in memory, it will not persist data across runs. It is intended to help you use Cloud Spanner for local development and testing, not for production deployments.

In order to set up and start the emulator, you can follow https://cloud.google.com/spanner/docs/emulator[these steps].

This command can be used to create Cloud Spanner instances:

----
$ gcloud spanner instances create <instance-name> --config=emulator-config --description=""<description>"" --nodes=1
----

Remember that you need to set the `SPANNER_EMULATOR_HOST` environment variable to use the emulator:

----
$ export SPANNER_EMULATOR_HOST=localhost:9010
----

=== Sample

A https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-data-spanner-sample[sample application] is available.
",12057,False,2001.527963169437,median
"// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#define _USE_MATH_DEFINES // For VC++ to get M_PI. This has to be first.

#include ""ui/views/view.h""

#include <algorithm>
#include <cmath>

#include ""base/debug/trace_event.h""
#include ""base/logging.h""
#include ""base/memory/scoped_ptr.h""
#include ""base/message_loop/message_loop.h""
#include ""base/strings/stringprintf.h""
#include ""base/strings/utf_string_conversions.h""
#include ""third_party/skia/include/core/SkRect.h""
#include ""ui/base/accessibility/accessibility_types.h""
#include ""ui/base/dragdrop/drag_drop_types.h""
#include ""ui/base/ui_base_switches_util.h""
#include ""ui/compositor/compositor.h""
#include ""ui/compositor/layer.h""
#include ""ui/compositor/layer_animator.h""
#include ""ui/gfx/canvas.h""
#include ""ui/gfx/interpolated_transform.h""
#include ""ui/gfx/path.h""
#include ""ui/gfx/point3_f.h""
#include ""ui/gfx/point_conversions.h""
#include ""ui/gfx/rect_conversions.h""
#include ""ui/gfx/screen.h""
#include ""ui/gfx/skia_util.h""
#include ""ui/gfx/transform.h""
#include ""ui/native_theme/native_theme.h""
#include ""ui/views/accessibility/native_view_accessibility.h""
#include ""ui/views/background.h""
#include ""ui/views/context_menu_controller.h""
#include ""ui/views/drag_controller.h""
#include ""ui/views/layout/layout_manager.h""
#include ""ui/views/views_delegate.h""
#include ""ui/views/widget/native_widget_private.h""
#include ""ui/views/widget/root_view.h""
#include ""ui/views/widget/tooltip_manager.h""
#include ""ui/views/widget/widget.h""

#if defined(OS_WIN)
#include ""base/win/scoped_gdi_object.h""
#endif

namespace {

// Whether to use accelerated compositing when necessary (e.g. when a view has a
// transformation).
#if defined(USE_AURA)
bool use_acceleration_when_possible = true;
#else
bool use_acceleration_when_possible = false;
#endif

#if defined(OS_WIN)
const bool kContextMenuOnMousePress = false;
#else
const bool kContextMenuOnMousePress = true;
#endif

// Saves the drawing state, and restores the state when going out of scope.
class ScopedCanvas {
 public:
  explicit ScopedCanvas(gfx::Canvas* canvas) : canvas_(canvas) {
    if (canvas_)
      canvas_->Save();
  }
  ~ScopedCanvas() {
    if (canvas_)
      canvas_->Restore();
  }
  void SetCanvas(gfx::Canvas* canvas) {
    if (canvas_)
      canvas_->Restore();
    canvas_ = canvas;
    canvas_->Save();
  }

 private:
  gfx::Canvas* canvas_;

  DISALLOW_COPY_AND_ASSIGN(ScopedCanvas);
};

// Returns the top view in |view|'s hierarchy.
const views::View* GetHierarchyRoot(const views::View* view) {
  const views::View* root = view;
  while (root && root->parent())
    root = root->parent();
  return root;
}

}  // namespace

namespace views {

namespace internal {

// This event handler receives events in the post-target phase and takes care of
// the following:
//   - Generates context menu, or initiates drag-and-drop, from gesture events.
class PostEventDispatchHandler : public ui::EventHandler {
 public:
  explicit PostEventDispatchHandler(View* owner)
      : owner_(owner),
        touch_dnd_enabled_(switches::IsTouchDragDropEnabled()) {
  }
  virtual ~PostEventDispatchHandler() {}

 private:
  // Overridden from ui::EventHandler:
  virtual void OnGestureEvent(ui::GestureEvent* event) OVERRIDE {
    DCHECK_EQ(ui::EP_POSTTARGET, event->phase());
    if (event->handled())
      return;

    if (touch_dnd_enabled_) {
      if (event->type() == ui::ET_GESTURE_LONG_PRESS &&
          (!owner_->drag_controller() ||
           owner_->drag_controller()->CanStartDragForView(
              owner_, event->location(), event->location()))) {
        if (owner_->DoDrag(*event, event->location(),
            ui::DragDropTypes::DRAG_EVENT_SOURCE_TOUCH)) {
          event->StopPropagation();
          return;
        }
      }
    }

    if (owner_->context_menu_controller() &&
        (event->type() == ui::ET_GESTURE_LONG_PRESS ||
         event->type() == ui::ET_GESTURE_LONG_TAP ||
         event->type() == ui::ET_GESTURE_TWO_FINGER_TAP)) {
      gfx::Point location(event->location());
      View::ConvertPointToScreen(owner_, &location);
      owner_->ShowContextMenu(location, ui::MENU_SOURCE_TOUCH);
      event->StopPropagation();
    }
  }

  View* owner_;
  bool touch_dnd_enabled_;

  DISALLOW_COPY_AND_ASSIGN(PostEventDispatchHandler);
};

}  // namespace internal

// static
ViewsDelegate* ViewsDelegate::views_delegate = NULL;

// static
const char View::kViewClassName[] = ""View"";

////////////////////////////////////////////////////////////////////////////////
// View, public:

// Creation and lifetime -------------------------------------------------------

View::View()
    : owned_by_client_(false),
      id_(0),
      group_(-1),
      parent_(NULL),
      visible_(true),
      enabled_(true),
      notify_enter_exit_on_child_(false),
      registered_for_visible_bounds_notification_(false),
      clip_insets_(0, 0, 0, 0),
      needs_layout_(true),
      focus_border_(FocusBorder::CreateDashedFocusBorder()),
      flip_canvas_on_paint_for_rtl_ui_(false),
      paint_to_layer_(false),
      accelerator_registration_delayed_(false),
      accelerator_focus_manager_(NULL),
      registered_accelerator_count_(0),
      next_focusable_view_(NULL),
      previous_focusable_view_(NULL),
      focusable_(false),
      accessibility_focusable_(false),
      context_menu_controller_(NULL),
      drag_controller_(NULL),
      post_dispatch_handler_(new internal::PostEventDispatchHandler(this)),
      native_view_accessibility_(NULL) {
  AddPostTargetHandler(post_dispatch_handler_.get());
}

View::~View() {
  if (parent_)
    parent_->RemoveChildView(this);

  for (Views::const_iterator i(children_.begin()); i != children_.end(); ++i) {
    (*i)->parent_ = NULL;
    if (!(*i)->owned_by_client_)
      delete *i;
  }

  // Release ownership of the native accessibility object, but it's
  // reference-counted on some platforms, so it may not be deleted right away.
  if (native_view_accessibility_)
    native_view_accessibility_->Destroy();
}

// Tree operations -------------------------------------------------------------

const Widget* View::GetWidget() const {
  // The root view holds a reference to this view hierarchy's Widget.
  return parent_ ? parent_->GetWidget() : NULL;
}

Widget* View::GetWidget() {
  return const_cast<Widget*>(const_cast<const View*>(this)->GetWidget());
}

void View::AddChildView(View* view) {
  if (view->parent_ == this)
    return;
  AddChildViewAt(view, child_count());
}

void View::AddChildViewAt(View* view, int index) {
  CHECK_NE(view, this) << ""You cannot add a view as its own child"";
  DCHECK_GE(index, 0);
  DCHECK_LE(index, child_count());

  // If |view| has a parent, remove it from its parent.
  View* parent = view->parent_;
  const ui::NativeTheme* old_theme = view->GetNativeTheme();
  if (parent) {
    if (parent == this) {
      ReorderChildView(view, index);
      return;
    }
    parent->DoRemoveChildView(view, true, true, false, this);
  }

  // Sets the prev/next focus views.
  InitFocusSiblings(view, index);

  // Let's insert the view.
  view->parent_ = this;
  children_.insert(children_.begin() + index, view);

  ViewHierarchyChangedDetails details(true, this, view, parent);

  for (View* v = this; v; v = v->parent_)
    v->ViewHierarchyChangedImpl(false, details);

  view->PropagateAddNotifications(details);
  UpdateTooltip();
  views::Widget* widget = GetWidget();
  if (widget) {
    RegisterChildrenForVisibleBoundsNotification(view);
    const ui::NativeTheme* new_theme = widget->GetNativeTheme();
    if (new_theme != old_theme)
      PropagateNativeThemeChanged(new_theme);
  }

  if (layout_manager_.get())
    layout_manager_->ViewAdded(this, view);

  if (use_acceleration_when_possible)
    ReorderLayers();

  // Make sure the visibility of the child layers are correct.
  // If any of the parent View is hidden, then the layers of the subtree
  // rooted at |this| should be hidden. Otherwise, all the child layers should
  // inherit the visibility of the owner View.
  UpdateLayerVisibility();
}

void View::ReorderChildView(View* view, int index) {
  DCHECK_EQ(view->parent_, this);
  if (index < 0)
    index = child_count() - 1;
  else if (index >= child_count())
    return;
  if (children_[index] == view)
    return;

  const Views::iterator i(std::find(children_.begin(), children_.end(), view));
  DCHECK(i != children_.end());
  children_.erase(i);

  // Unlink the view first
  View* next_focusable = view->next_focusable_view_;
  View* prev_focusable = view->previous_focusable_view_;
  if (prev_focusable)
    prev_focusable->next_focusable_view_ = next_focusable;
  if (next_focusable)
    next_focusable->previous_focusable_view_ = prev_focusable;

  // Add it in the specified index now.
  InitFocusSiblings(view, index);
  children_.insert(children_.begin() + index, view);

  if (use_acceleration_when_possible)
    ReorderLayers();
}

void View::RemoveChildView(View* view) {
  DoRemoveChildView(view, true, true, false, NULL);
}

void View::RemoveAllChildViews(bool delete_children) {
  while (!children_.empty())
    DoRemoveChildView(children_.front(), false, false, delete_children, NULL);
  UpdateTooltip();
}

bool View::Contains(const View* view) const {
  for (const View* v = view; v; v = v->parent_) {
    if (v == this)
      return true;
  }
  return false;
}

int View::GetIndexOf(const View* view) const {
  Views::const_iterator i(std::find(children_.begin(), children_.end(), view));
  return i != children_.end() ? static_cast<int>(i - children_.begin()) : -1;
}

// Size and disposition --------------------------------------------------------

void View::SetBounds(int x, int y, int width, int height) {
  SetBoundsRect(gfx::Rect(x, y, std::max(0, width), std::max(0, height)));
}

void View::SetBoundsRect(const gfx::Rect& bounds) {
  if (bounds == bounds_) {
    if (needs_layout_) {
      needs_layout_ = false;
      Layout();
      SchedulePaint();
    }
    return;
  }

  if (visible_) {
    // Paint where the view is currently.
    SchedulePaintBoundsChanged(
        bounds_.size() == bounds.size() ? SCHEDULE_PAINT_SIZE_SAME :
        SCHEDULE_PAINT_SIZE_CHANGED);
  }

  gfx::Rect prev = bounds_;
  bounds_ = bounds;
  BoundsChanged(prev);
}

void View::SetSize(const gfx::Size& size) {
  SetBounds(x(), y(), size.width(), size.height());
}

void View::SetPosition(const gfx::Point& position) {
  SetBounds(position.x(), position.y(), width(), height());
}

void View::SetX(int x) {
  SetBounds(x, y(), width(), height());
}

void View::SetY(int y) {
  SetBounds(x(), y, width(), height());
}

gfx::Rect View::GetContentsBounds() const {
  gfx::Rect contents_bounds(GetLocalBounds());
  if (border_.get())
    contents_bounds.Inset(border_->GetInsets());
  return contents_bounds;
}

gfx::Rect View::GetLocalBounds() const {
  return gfx::Rect(size());
}

gfx::Rect View::GetLayerBoundsInPixel() const {
  return layer()->GetTargetBounds();
}

gfx::Insets View::GetInsets() const {
  return border_.get() ? border_->GetInsets() : gfx::Insets();
}

gfx::Rect View::GetVisibleBounds() const {
  if (!IsDrawn())
    return gfx::Rect();
  gfx::Rect vis_bounds(GetLocalBounds());
  gfx::Rect ancestor_bounds;
  const View* view = this;
  gfx::Transform transform;

  while (view != NULL && !vis_bounds.IsEmpty()) {
    transform.ConcatTransform(view->GetTransform());
    gfx::Transform translation;
    translation.Translate(static_cast<float>(view->GetMirroredX()),
                          static_cast<float>(view->y()));
    transform.ConcatTransform(translation);

    vis_bounds = view->ConvertRectToParent(vis_bounds);
    const View* ancestor = view->parent_;
    if (ancestor != NULL) {
      ancestor_bounds.SetRect(0, 0, ancestor->width(), ancestor->height());
      vis_bounds.Intersect(ancestor_bounds);
    } else if (!view->GetWidget()) {
      // If the view has no Widget, we're not visible. Return an empty rect.
      return gfx::Rect();
    }
    view = ancestor;
  }
  if (vis_bounds.IsEmpty())
    return vis_bounds;
  // Convert back to this views coordinate system.
  gfx::RectF views_vis_bounds(vis_bounds);
  transform.TransformRectReverse(&views_vis_bounds);
  // Partially visible pixels should be considered visible.
  return gfx::ToEnclosingRect(views_vis_bounds);
}

gfx::Rect View::GetBoundsInScreen() const {
  gfx::Point origin;
  View::ConvertPointToScreen(this, &origin);
  return gfx::Rect(origin, size());
}

gfx::Size View::GetPreferredSize() {
  if (layout_manager_.get())
    return layout_manager_->GetPreferredSize(this);
  return gfx::Size();
}

int View::GetBaseline() const {
  return -1;
}

void View::SizeToPreferredSize() {
  gfx::Size prefsize = GetPreferredSize();
  if ((prefsize.width() != width()) || (prefsize.height() != height()))
    SetBounds(x(), y(), prefsize.width(), prefsize.height());
}

gfx::Size View::GetMinimumSize() {
  return GetPreferredSize();
}

gfx::Size View::GetMaximumSize() {
  return gfx::Size();
}

int View::GetHeightForWidth(int w) {
  if (layout_manager_.get())
    return layout_manager_->GetPreferredHeightForWidth(this, w);
  return GetPreferredSize().height();
}

void View::SetVisible(bool visible) {
  if (visible != visible_) {
    // If the View is currently visible, schedule paint to refresh parent.
    // TODO(beng): not sure we should be doing this if we have a layer.
    if (visible_)
      SchedulePaint();

    visible_ = visible;

    // Notify the parent.
    if (parent_)
      parent_->ChildVisibilityChanged(this);

    // This notifies all sub-views recursively.
    PropagateVisibilityNotifications(this, visible_);
    UpdateLayerVisibility();

    // If we are newly visible, schedule paint.
    if (visible_)
      SchedulePaint();
  }
}

bool View::IsDrawn() const {
  return visible_ && parent_ ? parent_->IsDrawn() : false;
}

void View::SetEnabled(bool enabled) {
  if (enabled != enabled_) {
    enabled_ = enabled;
    OnEnabledChanged();
  }
}

void View::OnEnabledChanged() {
  SchedulePaint();
}

// Transformations -------------------------------------------------------------

gfx::Transform View::GetTransform() const {
  return layer() ? layer()->transform() : gfx::Transform();
}

void View::SetTransform(const gfx::Transform& transform) {
  if (transform.IsIdentity()) {
    if (layer()) {
      layer()->SetTransform(transform);
      if (!paint_to_layer_)
        DestroyLayer();
    } else {
      // Nothing.
    }
  } else {
    if (!layer())
      CreateLayer();
    layer()->SetTransform(transform);
    layer()->ScheduleDraw();
  }
}

void View::SetPaintToLayer(bool paint_to_layer) {
  paint_to_layer_ = paint_to_layer;
  if (paint_to_layer_ && !layer()) {
    CreateLayer();
  } else if (!paint_to_layer_ && layer()) {
    DestroyLayer();
  }
}

ui::Layer* View::RecreateLayer() {
  ui::Layer* layer = AcquireLayer();
  if (!layer)
    return NULL;

  CreateLayer();
  layer_->set_scale_content(layer->scale_content());
  return layer;
}

// RTL positioning -------------------------------------------------------------

gfx::Rect View::GetMirroredBounds() const {
  gfx::Rect bounds(bounds_);
  bounds.set_x(GetMirroredX());
  return bounds;
}

gfx::Point View::GetMirroredPosition() const {
  return gfx::Point(GetMirroredX(), y());
}

int View::GetMirroredX() const {
  return parent_ ? parent_->GetMirroredXForRect(bounds_) : x();
}

int View::GetMirroredXForRect(const gfx::Rect& bounds) const {
  return base::i18n::IsRTL() ?
      (width() - bounds.x() - bounds.width()) : bounds.x();
}

int View::GetMirroredXInView(int x) const {
  return base::i18n::IsRTL() ? width() - x : x;
}

int View::GetMirroredXWithWidthInView(int x, int w) const {
  return base::i18n::IsRTL() ? width() - x - w : x;
}

// Layout ----------------------------------------------------------------------

void View::Layout() {
  needs_layout_ = false;

  // If we have a layout manager, let it handle the layout for us.
  if (layout_manager_.get())
    layout_manager_->Layout(this);

  // Make sure to propagate the Layout() call to any children that haven't
  // received it yet through the layout manager and need to be laid out. This
  // is needed for the case when the child requires a layout but its bounds
  // weren't changed by the layout manager. If there is no layout manager, we
  // just propagate the Layout() call down the hierarchy, so whoever receives
  // the call can take appropriate action.
  for (int i = 0, count = child_count(); i < count; ++i) {
    View* child = child_at(i);
    if (child->needs_layout_ || !layout_manager_.get()) {
      child->needs_layout_ = false;
      child->Layout();
    }
  }
}

void View::InvalidateLayout() {
  // Always invalidate up. This is needed to handle the case of us already being
  // valid, but not our parent.
  needs_layout_ = true;
  if (parent_)
    parent_->InvalidateLayout();
}

LayoutManager* View::GetLayoutManager() const {
  return layout_manager_.get();
}

void View::SetLayoutManager(LayoutManager* layout_manager) {
  if (layout_manager_.get())
    layout_manager_->Uninstalled(this);

  layout_manager_.reset(layout_manager);
  if (layout_manager_.get())
    layout_manager_->Installed(this);
}

// Attributes ------------------------------------------------------------------

const char* View::GetClassName() const {
  return kViewClassName;
}

View* View::GetAncestorWithClassName(const std::string& name) {
  for (View* view = this; view; view = view->parent_) {
    if (!strcmp(view->GetClassName(), name.c_str()))
      return view;
  }
  return NULL;
}

const View* View::GetViewByID(int id) const {
  if (id == id_)
    return const_cast<View*>(this);

  for (int i = 0, count = child_count(); i < count; ++i) {
    const View* view = child_at(i)->GetViewByID(id);
    if (view)
      return view;
  }
  return NULL;
}

View* View::GetViewByID(int id) {
  return const_cast<View*>(const_cast<const View*>(this)->GetViewByID(id));
}

void View::SetGroup(int gid) {
  // Don't change the group id once it's set.
  DCHECK(group_ == -1 || group_ == gid);
  group_ = gid;
}

int View::GetGroup() const {
  return group_;
}

bool View::IsGroupFocusTraversable() const {
  return true;
}

void View::GetViewsInGroup(int group, Views* views) {
  if (group_ == group)
    views->push_back(this);

  for (int i = 0, count = child_count(); i < count; ++i)
    child_at(i)->GetViewsInGroup(group, views);
}

View* View::GetSelectedViewForGroup(int group) {
  Views views;
  GetWidget()->GetRootView()->GetViewsInGroup(group, &views);
  return views.empty() ? NULL : views[0];
}

// Coordinate conversion -------------------------------------------------------

// static
void View::ConvertPointToTarget(const View* source,
                                const View* target,
                                gfx::Point* point) {
  if (source == target)
    return;

  // |source| can be NULL.
  const View* root = GetHierarchyRoot(target);
  if (source) {
    CHECK_EQ(GetHierarchyRoot(source), root);

    if (source != root)
      source->ConvertPointForAncestor(root, point);
  }

  if (target != root)
    target->ConvertPointFromAncestor(root, point);

  // API defines NULL |source| as returning the point in screen coordinates.
  if (!source) {
    *point -=
        root->GetWidget()->GetClientAreaBoundsInScreen().OffsetFromOrigin();
  }
}

// static
void View::ConvertPointToWidget(const View* src, gfx::Point* p) {
  DCHECK(src);
  DCHECK(p);

  src->ConvertPointForAncestor(NULL, p);
}

// static
void View::ConvertPointFromWidget(const View* dest, gfx::Point* p) {
  DCHECK(dest);
  DCHECK(p);

  dest->ConvertPointFromAncestor(NULL, p);
}

// static
void View::ConvertPointToScreen(const View* src, gfx::Point* p) {
  DCHECK(src);
  DCHECK(p);

  // If the view is not connected to a tree, there's nothing we can do.
  const Widget* widget = src->GetWidget();
  if (widget) {
    ConvertPointToWidget(src, p);
    *p += widget->GetClientAreaBoundsInScreen().OffsetFromOrigin();
  }
}

// static
void View::ConvertPointFromScreen(const View* dst, gfx::Point* p) {
  DCHECK(dst);
  DCHECK(p);

  const views::Widget* widget = dst->GetWidget();
  if (!widget)
    return;
  *p -= widget->GetClientAreaBoundsInScreen().OffsetFromOrigin();
  views::View::ConvertPointFromWidget(dst, p);
}

gfx::Rect View::ConvertRectToParent(const gfx::Rect& rect) const {
  gfx::RectF x_rect = rect;
  GetTransform().TransformRect(&x_rect);
  x_rect.Offset(GetMirroredPosition().OffsetFromOrigin());
  // Pixels we partially occupy in the parent should be included.
  return gfx::ToEnclosingRect(x_rect);
}

gfx::Rect View::ConvertRectToWidget(const gfx::Rect& rect) const {
  gfx::Rect x_rect = rect;
  for (const View* v = this; v; v = v->parent_)
    x_rect = v->ConvertRectToParent(x_rect);
  return x_rect;
}

// Painting --------------------------------------------------------------------

void View::SchedulePaint() {
  SchedulePaintInRect(GetLocalBounds());
}

void View::SchedulePaintInRect(const gfx::Rect& rect) {
  if (!visible_)
    return;

  if (layer()) {
    layer()->SchedulePaint(rect);
  } else if (parent_) {
    // Translate the requested paint rect to the parent's coordinate system
    // then pass this notification up to the parent.
    parent_->SchedulePaintInRect(ConvertRectToParent(rect));
  }
}

void View::Paint(gfx::Canvas* canvas) {
  TRACE_EVENT1(""views"", ""View::Paint"", ""class"", GetClassName());

  ScopedCanvas scoped_canvas(canvas);

  // Paint this View and its children, setting the clip rect to the bounds
  // of this View and translating the origin to the local bounds' top left
  // point.
  //
  // Note that the X (or left) position we pass to ClipRectInt takes into
  // consideration whether or not the view uses a right-to-left layout so that
  // we paint our view in its mirrored position if need be.
  gfx::Rect clip_rect = bounds();
  clip_rect.Inset(clip_insets_);
  if (parent_)
    clip_rect.set_x(parent_->GetMirroredXForRect(clip_rect));
  if (!canvas->ClipRect(clip_rect))
    return;

  // Non-empty clip, translate the graphics such that 0,0 corresponds to
  // where this view is located (related to its parent).
  canvas->Translate(GetMirroredPosition().OffsetFromOrigin());
  canvas->Transform(GetTransform());

  PaintCommon(canvas);
}

ui::ThemeProvider* View::GetThemeProvider() const {
  const Widget* widget = GetWidget();
  return widget ? widget->GetThemeProvider() : NULL;
}

const ui::NativeTheme* View::GetNativeTheme() const {
  const Widget* widget = GetWidget();
  return widget ? widget->GetNativeTheme() : ui::NativeTheme::instance();
}

// Accelerated Painting --------------------------------------------------------

// static
void View::set_use_acceleration_when_possible(bool use) {
  use_acceleration_when_possible = use;
}

// static
bool View::get_use_acceleration_when_possible() {
  return use_acceleration_when_possible;
}

// Input -----------------------------------------------------------------------

View* View::GetEventHandlerForPoint(const gfx::Point& point) {
  // Walk the child Views recursively looking for the View that most
  // tightly encloses the specified point.
  for (int i = child_count() - 1; i >= 0; --i) {
    View* child = child_at(i);
    if (!child->visible())
      continue;

    gfx::Point point_in_child_coords(point);
    ConvertPointToTarget(this, child, &point_in_child_coords);
    if (child->HitTestPoint(point_in_child_coords))
      return child->GetEventHandlerForPoint(point_in_child_coords);
  }
  return this;
}

View* View::GetTooltipHandlerForPoint(const gfx::Point& point) {
  if (!HitTestPoint(point))
    return NULL;

  // Walk the child Views recursively looking for the View that most
  // tightly encloses the specified point.
  for (int i = child_count() - 1; i >= 0; --i) {
    View* child = child_at(i);
    if (!child->visible())
      continue;

    gfx::Point point_in_child_coords(point);
    ConvertPointToTarget(this, child, &point_in_child_coords);
    View* handler = child->GetTooltipHandlerForPoint(point_in_child_coords);
    if (handler)
      return handler;
  }
  return this;
}

gfx::NativeCursor View::GetCursor(const ui::MouseEvent& event) {
#if defined(OS_WIN)
#if defined(USE_AURA)
  static ui::Cursor arrow;
  if (!arrow.platform())
    arrow.SetPlatformCursor(LoadCursor(NULL, IDC_ARROW));
  return arrow;
#else
  static HCURSOR arrow = LoadCursor(NULL, IDC_ARROW);
  return arrow;
#endif
#else
  return gfx::kNullCursor;
#endif
}

bool View::HitTestPoint(const gfx::Point& point) const {
  return HitTestRect(gfx::Rect(point, gfx::Size(1, 1)));
}

bool View::HitTestRect(const gfx::Rect& rect) const {
  if (GetLocalBounds().Intersects(rect)) {
    if (HasHitTestMask()) {
      gfx::Path mask;
      GetHitTestMask(&mask);
#if defined(USE_AURA)
      // TODO: should we use this every where?
      SkRegion clip_region;
      clip_region.setRect(0, 0, width(), height());
      SkRegion mask_region;
      return mask_region.setPath(mask, clip_region) &&
             mask_region.intersects(RectToSkIRect(rect));
#elif defined(OS_WIN)
      base::win::ScopedRegion rgn(mask.CreateNativeRegion());
      const RECT r(rect.ToRECT());
      return RectInRegion(rgn, &r) != 0;
#endif
    }
    // No mask, but inside our bounds.
    return true;
  }
  // Outside our bounds.
  return false;
}

bool View::IsMouseHovered() {
  // If we haven't yet been placed in an onscreen view hierarchy, we can't be
  // hovered.
  if (!GetWidget())
    return false;

  // If mouse events are disabled, then the mouse cursor is invisible and
  // is therefore not hovering over this button.
  if (!GetWidget()->IsMouseEventsEnabled())
    return false;

  gfx::Point cursor_pos(gfx::Screen::GetScreenFor(
      GetWidget()->GetNativeView())->GetCursorScreenPoint());
  ConvertPointToTarget(NULL, this, &cursor_pos);
  return HitTestPoint(cursor_pos);
}

bool View::OnMousePressed(const ui::MouseEvent& event) {
  return false;
}

bool View::OnMouseDragged(const ui::MouseEvent& event) {
  return false;
}

void View::OnMouseReleased(const ui::MouseEvent& event) {
}

void View::OnMouseCaptureLost() {
}

void View::OnMouseMoved(const ui::MouseEvent& event) {
}

void View::OnMouseEntered(const ui::MouseEvent& event) {
}

void View::OnMouseExited(const ui::MouseEvent& event) {
}

void View::SetMouseHandler(View* new_mouse_handler) {
  // |new_mouse_handler| may be NULL.
  if (parent_)
    parent_->SetMouseHandler(new_mouse_handler);
}

bool View::OnKeyPressed(const ui::KeyEvent& event) {
  return false;
}

bool View::OnKeyReleased(const ui::KeyEvent& event) {
  return false;
}

bool View::OnMouseWheel(const ui::MouseWheelEvent& event) {
  return false;
}

void View::OnKeyEvent(ui::KeyEvent* event) {
  bool consumed = (event->type() == ui::ET_KEY_PRESSED) ? OnKeyPressed(*event) :
                                                          OnKeyReleased(*event);
  if (consumed)
    event->StopPropagation();
}

void View::OnMouseEvent(ui::MouseEvent* event) {
  switch (event->type()) {
    case ui::ET_MOUSE_PRESSED:
      if (ProcessMousePressed(*event))
        event->SetHandled();
      return;

    case ui::ET_MOUSE_MOVED:
      if ((event->flags() & (ui::EF_LEFT_MOUSE_BUTTON |
                             ui::EF_RIGHT_MOUSE_BUTTON |
                             ui::EF_MIDDLE_MOUSE_BUTTON)) == 0) {
        OnMouseMoved(*event);
        return;
      }
      // FALL-THROUGH
    case ui::ET_MOUSE_DRAGGED:
      if (ProcessMouseDragged(*event))
        event->SetHandled();
      return;

    case ui::ET_MOUSE_RELEASED:
      ProcessMouseReleased(*event);
      return;

    case ui::ET_MOUSEWHEEL:
      if (OnMouseWheel(*static_cast<ui::MouseWheelEvent*>(event)))
        event->SetHandled();
      break;

    case ui::ET_MOUSE_ENTERED:
      OnMouseEntered(*event);
      break;

    case ui::ET_MOUSE_EXITED:
      OnMouseExited(*event);
      break;

    default:
      return;
  }
}

void View::OnScrollEvent(ui::ScrollEvent* event) {
}

void View::OnTouchEvent(ui::TouchEvent* event) {
}

void View::OnGestureEvent(ui::GestureEvent* event) {
}

ui::TextInputClient* View::GetTextInputClient() {
  return NULL;
}

InputMethod* View::GetInputMethod() {
  Widget* widget = GetWidget();
  return widget ? widget->GetInputMethod() : NULL;
}

const InputMethod* View::GetInputMethod() const {
  const Widget* widget = GetWidget();
  return widget ? widget->GetInputMethod() : NULL;
}

bool View::CanAcceptEvent(const ui::Event& event) {
  return event.dispatch_to_hidden_targets() || IsDrawn();
}

ui::EventTarget* View::GetParentTarget() {
  return parent_;
}

// Accelerators ----------------------------------------------------------------

void View::AddAccelerator(const ui::Accelerator& accelerator) {
  if (!accelerators_.get())
    accelerators_.reset(new std::vector<ui::Accelerator>());

  if (std::find(accelerators_->begin(), accelerators_->end(), accelerator) ==
      accelerators_->end()) {
    accelerators_->push_back(accelerator);
  }
  RegisterPendingAccelerators();
}

void View::RemoveAccelerator(const ui::Accelerator& accelerator) {
  if (!accelerators_.get()) {
    NOTREACHED() << ""Removing non-existing accelerator"";
    return;
  }

  std::vector<ui::Accelerator>::iterator i(
      std::find(accelerators_->begin(), accelerators_->end(), accelerator));
  if (i == accelerators_->end()) {
    NOTREACHED() << ""Removing non-existing accelerator"";
    return;
  }

  size_t index = i - accelerators_->begin();
  accelerators_->erase(i);
  if (index >= registered_accelerator_count_) {
    // The accelerator is not registered to FocusManager.
    return;
  }
  --registered_accelerator_count_;

  // Providing we are attached to a Widget and registered with a focus manager,
  // we should de-register from that focus manager now.
  if (GetWidget() && accelerator_focus_manager_)
    accelerator_focus_manager_->UnregisterAccelerator(accelerator, this);
}

void View::ResetAccelerators() {
  if (accelerators_.get())
    UnregisterAccelerators(false);
}

bool View::AcceleratorPressed(const ui::Accelerator& accelerator) {
  return false;
}

bool View::CanHandleAccelerators() const {
  return enabled() && IsDrawn() && GetWidget() && GetWidget()->IsVisible();
}

// Focus -----------------------------------------------------------------------

bool View::HasFocus() const {
  const FocusManager* focus_manager = GetFocusManager();
  return focus_manager && (focus_manager->GetFocusedView() == this);
}

View* View::GetNextFocusableView() {
  return next_focusable_view_;
}

const View* View::GetNextFocusableView() const {
  return next_focusable_view_;
}

View* View::GetPreviousFocusableView() {
  return previous_focusable_view_;
}

void View::SetNextFocusableView(View* view) {
  if (view)
    view->previous_focusable_view_ = this;
  next_focusable_view_ = view;
}

bool View::IsFocusable() const {
  return focusable_ && enabled_ && IsDrawn();
}

bool View::IsAccessibilityFocusable() const {
  return (focusable_ || accessibility_focusable_) && enabled_ && IsDrawn();
}

FocusManager* View::GetFocusManager() {
  Widget* widget = GetWidget();
  return widget ? widget->GetFocusManager() : NULL;
}

const FocusManager* View::GetFocusManager() const {
  const Widget* widget = GetWidget();
  return widget ? widget->GetFocusManager() : NULL;
}

void View::RequestFocus() {
  FocusManager* focus_manager = GetFocusManager();
  if (focus_manager && IsFocusable())
    focus_manager->SetFocusedView(this);
}

bool View::SkipDefaultKeyEventProcessing(const ui::KeyEvent& event) {
  return false;
}

FocusTraversable* View::GetFocusTraversable() {
  return NULL;
}

FocusTraversable* View::GetPaneFocusTraversable() {
  return NULL;
}

// Tooltips --------------------------------------------------------------------

bool View::GetTooltipText(const gfx::Point& p, string16* tooltip) const {
  return false;
}

bool View::GetTooltipTextOrigin(const gfx::Point& p, gfx::Point* loc) const {
  return false;
}

// Context menus ---------------------------------------------------------------

void View::ShowContextMenu(const gfx::Point& p,
                           ui::MenuSourceType source_type) {
  if (!context_menu_controller_)
    return;

  context_menu_controller_->ShowContextMenuForView(this, p, source_type);
}

// static
bool View::ShouldShowContextMenuOnMousePress() {
  return kContextMenuOnMousePress;
}

// Drag and drop ---------------------------------------------------------------

bool View::GetDropFormats(
      int* formats,
      std::set<OSExchangeData::CustomFormat>* custom_formats) {
  return false;
}

bool View::AreDropTypesRequired() {
  return false;
}

bool View::CanDrop(const OSExchangeData& data) {
  // TODO(sky): when I finish up migration, this should default to true.
  return false;
}

void View::OnDragEntered(const ui::DropTargetEvent& event) {
}

int View::OnDragUpdated(const ui::DropTargetEvent& event) {
  return ui::DragDropTypes::DRAG_NONE;
}

void View::OnDragExited() {
}

int View::OnPerformDrop(const ui::DropTargetEvent& event) {
  return ui::DragDropTypes::DRAG_NONE;
}

void View::OnDragDone() {
}

// static
bool View::ExceededDragThreshold(const gfx::Vector2d& delta) {
  return (abs(delta.x()) > GetHorizontalDragThreshold() ||
          abs(delta.y()) > GetVerticalDragThreshold());
}

// Accessibility----------------------------------------------------------------

gfx::NativeViewAccessible View::GetNativeViewAccessible() {
  if (!native_view_accessibility_)
    native_view_accessibility_ = NativeViewAccessibility::Create(this);
  if (native_view_accessibility_)
    return native_view_accessibility_->GetNativeObject();
  return NULL;
}

void View::NotifyAccessibilityEvent(
    ui::AccessibilityTypes::Event event_type,
    bool send_native_event) {
  if (ViewsDelegate::views_delegate)
    ViewsDelegate::views_delegate->NotifyAccessibilityEvent(this, event_type);

  if (send_native_event) {
    if (!native_view_accessibility_)
      native_view_accessibility_ = NativeViewAccessibility::Create(this);
    if (native_view_accessibility_)
      native_view_accessibility_->NotifyAccessibilityEvent(event_type);
  }
}

// Scrolling -------------------------------------------------------------------

void View::ScrollRectToVisible(const gfx::Rect& rect) {
  // We must take RTL UI mirroring into account when adjusting the position of
  // the region.
  if (parent_) {
    gfx::Rect scroll_rect(rect);
    scroll_rect.Offset(GetMirroredX(), y());
    parent_->ScrollRectToVisible(scroll_rect);
  }
}

int View::GetPageScrollIncrement(ScrollView* scroll_view,
                                 bool is_horizontal, bool is_positive) {
  return 0;
}

int View::GetLineScrollIncrement(ScrollView* scroll_view,
                                 bool is_horizontal, bool is_positive) {
  return 0;
}

////////////////////////////////////////////////////////////////////////////////
// View, protected:

// Size and disposition --------------------------------------------------------

void View::OnBoundsChanged(const gfx::Rect& previous_bounds) {
}

void View::PreferredSizeChanged() {
  InvalidateLayout();
  if (parent_)
    parent_->ChildPreferredSizeChanged(this);
}

bool View::NeedsNotificationWhenVisibleBoundsChange() const {
  return false;
}

void View::OnVisibleBoundsChanged() {
}

// Tree operations -------------------------------------------------------------

void View::ViewHierarchyChanged(const ViewHierarchyChangedDetails& details) {
}

void View::VisibilityChanged(View* starting_from, bool is_visible) {
}

void View::NativeViewHierarchyChanged(bool attached,
                                      gfx::NativeView native_view,
                                      internal::RootView* root_view) {
  FocusManager* focus_manager = GetFocusManager();
  if (!accelerator_registration_delayed_ &&
      accelerator_focus_manager_ &&
      accelerator_focus_manager_ != focus_manager) {
    UnregisterAccelerators(true);
    accelerator_registration_delayed_ = true;
  }
  if (accelerator_registration_delayed_ && attached) {
    if (focus_manager) {
      RegisterPendingAccelerators();
      accelerator_registration_delayed_ = false;
    }
  }
}

// Painting --------------------------------------------------------------------

void View::PaintChildren(gfx::Canvas* canvas) {
  TRACE_EVENT1(""views"", ""View::PaintChildren"", ""class"", GetClassName());
  for (int i = 0, count = child_count(); i < count; ++i)
    if (!child_at(i)->layer())
      child_at(i)->Paint(canvas);
}

void View::OnPaint(gfx::Canvas* canvas) {
  TRACE_EVENT1(""views"", ""View::OnPaint"", ""class"", GetClassName());
  OnPaintBackground(canvas);
  OnPaintFocusBorder(canvas);
  OnPaintBorder(canvas);
}

void View::OnPaintBackground(gfx::Canvas* canvas) {
  if (background_.get()) {
    TRACE_EVENT2(""views"", ""View::OnPaintBackground"",
                 ""width"", canvas->sk_canvas()->getDevice()->width(),
                 ""height"", canvas->sk_canvas()->getDevice()->height());
    background_->Paint(canvas, this);
  }
}

void View::OnPaintBorder(gfx::Canvas* canvas) {
  if (border_.get()) {
    TRACE_EVENT2(""views"", ""View::OnPaintBorder"",
                 ""width"", canvas->sk_canvas()->getDevice()->width(),
                 ""height"", canvas->sk_canvas()->getDevice()->height());
    border_->Paint(*this, canvas);
  }
}

void View::OnPaintFocusBorder(gfx::Canvas* canvas) {
  if (focus_border_.get() &&
      HasFocus() && (focusable() || IsAccessibilityFocusable())) {
    TRACE_EVENT2(""views"", ""views::OnPaintFocusBorder"",
                 ""width"", canvas->sk_canvas()->getDevice()->width(),
                 ""height"", canvas->sk_canvas()->getDevice()->height());
    focus_border_->Paint(*this, canvas);
  }
}

// Accelerated Painting --------------------------------------------------------

void View::SetFillsBoundsOpaquely(bool fills_bounds_opaquely) {
  // This method should not have the side-effect of creating the layer.
  if (layer())
    layer()->SetFillsBoundsOpaquely(fills_bounds_opaquely);
}

bool View::SetExternalTexture(ui::Texture* texture) {
  DCHECK(texture);
  SetPaintToLayer(true);

  layer()->SetExternalTexture(texture);

  // Child views must not paint into the external texture. So make sure each
  // child view has its own layer to paint into.
  for (Views::iterator i = children_.begin(); i != children_.end(); ++i)
    (*i)->SetPaintToLayer(true);

  SchedulePaintInRect(GetLocalBounds());
  return true;
}

gfx::Vector2d View::CalculateOffsetToAncestorWithLayer(
    ui::Layer** layer_parent) {
  if (layer()) {
    if (layer_parent)
      *layer_parent = layer();
    return gfx::Vector2d();
  }
  if (!parent_)
    return gfx::Vector2d();

  return gfx::Vector2d(GetMirroredX(), y()) +
      parent_->CalculateOffsetToAncestorWithLayer(layer_parent);
}

void View::UpdateParentLayer() {
  if (!layer())
    return;

  ui::Layer* parent_layer = NULL;
  gfx::Vector2d offset(GetMirroredX(), y());

  if (parent_)
    offset += parent_->CalculateOffsetToAncestorWithLayer(&parent_layer);

  ReparentLayer(offset, parent_layer);
}

void View::MoveLayerToParent(ui::Layer* parent_layer,
                             const gfx::Point& point) {
  gfx::Point local_point(point);
  if (parent_layer != layer())
    local_point.Offset(GetMirroredX(), y());
  if (layer() && parent_layer != layer()) {
    parent_layer->Add(layer());
    SetLayerBounds(gfx::Rect(local_point.x(), local_point.y(),
                             width(), height()));
  } else {
    for (int i = 0, count = child_count(); i < count; ++i)
      child_at(i)->MoveLayerToParent(parent_layer, local_point);
  }
}

void View::UpdateLayerVisibility() {
  if (!use_acceleration_when_possible)
    return;
  bool visible = visible_;
  for (const View* v = parent_; visible && v && !v->layer(); v = v->parent_)
    visible = v->visible();

  UpdateChildLayerVisibility(visible);
}

void View::UpdateChildLayerVisibility(bool ancestor_visible) {
  if (layer()) {
    layer()->SetVisible(ancestor_visible && visible_);
  } else {
    for (int i = 0, count = child_count(); i < count; ++i)
      child_at(i)->UpdateChildLayerVisibility(ancestor_visible && visible_);
  }
}

void View::UpdateChildLayerBounds(const gfx::Vector2d& offset) {
  if (layer()) {
    SetLayerBounds(GetLocalBounds() + offset);
  } else {
    for (int i = 0, count = child_count(); i < count; ++i) {
      View* child = child_at(i);
      child->UpdateChildLayerBounds(
          offset + gfx::Vector2d(child->GetMirroredX(), child->y()));
    }
  }
}

void View::OnPaintLayer(gfx::Canvas* canvas) {
  if (!layer() || !layer()->fills_bounds_opaquely())
    canvas->DrawColor(SK_ColorBLACK, SkXfermode::kClear_Mode);
  PaintCommon(canvas);
}

void View::OnDeviceScaleFactorChanged(float device_scale_factor) {
  // Repainting with new scale factor will paint the content at the right scale.
}

base::Closure View::PrepareForLayerBoundsChange() {
  return base::Closure();
}

void View::ReorderLayers() {
  View* v = this;
  while (v && !v->layer())
    v = v->parent();

  Widget* widget = GetWidget();
  if (!v) {
    if (widget) {
      ui::Layer* layer = widget->GetLayer();
      if (layer)
        widget->GetRootView()->ReorderChildLayers(layer);
    }
  } else {
    v->ReorderChildLayers(v->layer());
  }

  if (widget) {
    // Reorder the widget's child NativeViews in case a child NativeView is
    // associated with a view (eg via a NativeViewHost). Always do the
    // reordering because the associated NativeView's layer (if it has one)
    // is parented to the widget's layer regardless of whether the host view has
    // an ancestor with a layer.
    widget->ReorderNativeViews();
  }
}

void View::ReorderChildLayers(ui::Layer* parent_layer) {
  if (layer() && layer() != parent_layer) {
    DCHECK_EQ(parent_layer, layer()->parent());
    parent_layer->StackAtBottom(layer());
  } else {
    // Iterate backwards through the children so that a child with a layer
    // which is further to the back is stacked above one which is further to
    // the front.
    for (Views::const_reverse_iterator it(children_.rbegin());
         it != children_.rend(); ++it) {
      (*it)->ReorderChildLayers(parent_layer);
    }
  }
}

// Input -----------------------------------------------------------------------

bool View::HasHitTestMask() const {
  return false;
}

void View::GetHitTestMask(gfx::Path* mask) const {
  DCHECK(mask);
}

View::DragInfo* View::GetDragInfo() {
  return parent_ ? parent_->GetDragInfo() : NULL;
}

// Focus -----------------------------------------------------------------------

void View::OnFocus() {
  // TODO(beng): Investigate whether it's possible for us to move this to
  //             Focus().
  // By default, we clear the native focus. This ensures that no visible native
  // view as the focus and that we still receive keyboard inputs.
  FocusManager* focus_manager = GetFocusManager();
  if (focus_manager)
    focus_manager->ClearNativeFocus();

  // TODO(beng): Investigate whether it's possible for us to move this to
  //             Focus().
  // Notify assistive technologies of the focus change.
  NotifyAccessibilityEvent(ui::AccessibilityTypes::EVENT_FOCUS, true);
}

void View::OnBlur() {
}

void View::Focus() {
  SchedulePaint();
  OnFocus();
}

void View::Blur() {
  SchedulePaint();
  OnBlur();
}

// Tooltips --------------------------------------------------------------------

void View::TooltipTextChanged() {
  Widget* widget = GetWidget();
  // TooltipManager may be null if there is a problem creating it.
  if (widget && widget->native_widget_private()->GetTooltipManager()) {
    widget->native_widget_private()->GetTooltipManager()->
        TooltipTextChanged(this);
  }
}

// Context menus ---------------------------------------------------------------

gfx::Point View::GetKeyboardContextMenuLocation() {
  gfx::Rect vis_bounds = GetVisibleBounds();
  gfx::Point screen_point(vis_bounds.x() + vis_bounds.width() / 2,
                          vis_bounds.y() + vis_bounds.height() / 2);
  ConvertPointToScreen(this, &screen_point);
  return screen_point;
}

// Drag and drop ---------------------------------------------------------------

int View::GetDragOperations(const gfx::Point& press_pt) {
  return drag_controller_ ?
      drag_controller_->GetDragOperationsForView(this, press_pt) :
      ui::DragDropTypes::DRAG_NONE;
}

void View::WriteDragData(const gfx::Point& press_pt, OSExchangeData* data) {
  DCHECK(drag_controller_);
  drag_controller_->WriteDragDataForView(this, press_pt, data);
}

bool View::InDrag() {
  Widget* widget = GetWidget();
  return widget ? widget->dragged_view() == this : false;
}

// Debugging -------------------------------------------------------------------

#if !defined(NDEBUG)

std::string View::PrintViewGraph(bool first) {
  return DoPrintViewGraph(first, this);
}

std::string View::DoPrintViewGraph(bool first, View* view_with_children) {
  // 64-bit pointer = 16 bytes of hex + ""0x"" + '\\0' = 19.
  const size_t kMaxPointerStringLength = 19;

  std::string result;

  if (first)
    result.append(""digraph {\\n"");

  // Node characteristics.
  char p[kMaxPointerStringLength];

  const std::string class_name(GetClassName());
  size_t base_name_index = class_name.find_last_of('/');
  if (base_name_index == std::string::npos)
    base_name_index = 0;
  else
    base_name_index++;

  char bounds_buffer[512];

  // Information about current node.
  base::snprintf(p, arraysize(bounds_buffer), ""%p"", view_with_children);
  result.append(""  N"");
  result.append(p + 2);
  result.append("" [label=\\"""");

  result.append(class_name.substr(base_name_index).c_str());

  base::snprintf(bounds_buffer,
                 arraysize(bounds_buffer),
                 ""\\\\n bounds: (%d, %d), (%dx%d)"",
                 bounds().x(),
                 bounds().y(),
                 bounds().width(),
                 bounds().height());
  result.append(bounds_buffer);

  gfx::DecomposedTransform decomp;
  if (!GetTransform().IsIdentity() &&
      gfx::DecomposeTransform(&decomp, GetTransform())) {
    base::snprintf(bounds_buffer,
                   arraysize(bounds_buffer),
                   ""\\\\n translation: (%f, %f)"",
                   decomp.translate[0],
                   decomp.translate[1]);
    result.append(bounds_buffer);

    base::snprintf(bounds_buffer,
                   arraysize(bounds_buffer),
                   ""\\\\n rotation: %3.2f"",
                   std::acos(decomp.quaternion[3]) * 360.0 / M_PI);
    result.append(bounds_buffer);

    base::snprintf(bounds_buffer,
                   arraysize(bounds_buffer),
                   ""\\\\n scale: (%2.4f, %2.4f)"",
                   decomp.scale[0],
                   decomp.scale[1]);
    result.append(bounds_buffer);
  }

  result.append(""\\"""");
  if (!parent_)
    result.append("", shape=box"");
  if (layer()) {
    if (layer()->texture())
      result.append("", color=green"");
    else
      result.append("", color=red"");

    if (layer()->fills_bounds_opaquely())
      result.append("", style=filled"");
  }
  result.append(""]\\n"");

  // Link to parent.
  if (parent_) {
    char pp[kMaxPointerStringLength];

    base::snprintf(pp, kMaxPointerStringLength, ""%p"", parent_);
    result.append(""  N"");
    result.append(pp + 2);
    result.append("" -> N"");
    result.append(p + 2);
    result.append(""\\n"");
  }

  // Children.
  for (int i = 0, count = view_with_children->child_count(); i < count; ++i)
    result.append(view_with_children->child_at(i)->PrintViewGraph(false));

  if (first)
    result.append(""}\\n"");

  return result;
}

#endif

////////////////////////////////////////////////////////////////////////////////
// View, private:

// DropInfo --------------------------------------------------------------------

void View::DragInfo::Reset() {
  possible_drag = false;
  start_pt = gfx::Point();
}

void View::DragInfo::PossibleDrag(const gfx::Point& p) {
  possible_drag = true;
  start_pt = p;
}

// Painting --------------------------------------------------------------------

void View::SchedulePaintBoundsChanged(SchedulePaintType type) {
  // If we have a layer and the View's size did not change, we do not need to
  // schedule any paints since the layer will be redrawn at its new location
  // during the next Draw() cycle in the compositor.
  if (!layer() || type == SCHEDULE_PAINT_SIZE_CHANGED) {
    // Otherwise, if the size changes or we don't have a layer then we need to
    // use SchedulePaint to invalidate the area occupied by the View.
    SchedulePaint();
  } else if (parent_ && type == SCHEDULE_PAINT_SIZE_SAME) {
    // The compositor doesn't Draw() until something on screen changes, so
    // if our position changes but nothing is being animated on screen, then
    // tell the compositor to redraw the scene. We know layer() exists due to
    // the above if clause.
    layer()->ScheduleDraw();
  }
}

void View::PaintCommon(gfx::Canvas* canvas) {
  if (!visible_)
    return;

  {
    // If the View we are about to paint requested the canvas to be flipped, we
    // should change the transform appropriately.
    // The canvas mirroring is undone once the View is done painting so that we
    // don't pass the canvas with the mirrored transform to Views that didn't
    // request the canvas to be flipped.
    ScopedCanvas scoped(canvas);
    if (FlipCanvasOnPaintForRTLUI()) {
      canvas->Translate(gfx::Vector2d(width(), 0));
      canvas->Scale(-1, 1);
    }

    OnPaint(canvas);
  }

  PaintChildren(canvas);
}

// Tree operations -------------------------------------------------------------

void View::DoRemoveChildView(View* view,
                             bool update_focus_cycle,
                             bool update_tool_tip,
                             bool delete_removed_view,
                             View* new_parent) {
  DCHECK(view);
  const Views::iterator i(std::find(children_.begin(), children_.end(), view));
  scoped_ptr<View> view_to_be_deleted;
  if (i != children_.end()) {
    if (update_focus_cycle) {
      // Let's remove the view from the focus traversal.
      View* next_focusable = view->next_focusable_view_;
      View* prev_focusable = view->previous_focusable_view_;
      if (prev_focusable)
        prev_focusable->next_focusable_view_ = next_focusable;
      if (next_focusable)
        next_focusable->previous_focusable_view_ = prev_focusable;
    }

    if (GetWidget())
      UnregisterChildrenForVisibleBoundsNotification(view);
    view->PropagateRemoveNotifications(this, new_parent);
    view->parent_ = NULL;
    view->UpdateLayerVisibility();

    if (delete_removed_view && !view->owned_by_client_)
      view_to_be_deleted.reset(view);

    children_.erase(i);
  }

  if (update_tool_tip)
    UpdateTooltip();

  if (layout_manager_.get())
    layout_manager_->ViewRemoved(this, view);
}

void View::PropagateRemoveNotifications(View* old_parent, View* new_parent) {
  for (int i = 0, count = child_count(); i < count; ++i)
    child_at(i)->PropagateRemoveNotifications(old_parent, new_parent);

  ViewHierarchyChangedDetails details(false, old_parent, this, new_parent);
  for (View* v = this; v; v = v->parent_)
    v->ViewHierarchyChangedImpl(true, details);
}

void View::PropagateAddNotifications(
    const ViewHierarchyChangedDetails& details) {
  for (int i = 0, count = child_count(); i < count; ++i)
    child_at(i)->PropagateAddNotifications(details);
  ViewHierarchyChangedImpl(true, details);
}

void View::PropagateNativeViewHierarchyChanged(bool attached,
                                               gfx::NativeView native_view,
                                               internal::RootView* root_view) {
  for (int i = 0, count = child_count(); i < count; ++i)
    child_at(i)->PropagateNativeViewHierarchyChanged(attached,
                                                           native_view,
                                                           root_view);
  NativeViewHierarchyChanged(attached, native_view, root_view);
}

void View::ViewHierarchyChangedImpl(
    bool register_accelerators,
    const ViewHierarchyChangedDetails& details) {
  if (register_accelerators) {
    if (details.is_add) {
      // If you get this registration, you are part of a subtree that has been
      // added to the view hierarchy.
      if (GetFocusManager()) {
        RegisterPendingAccelerators();
      } else {
        // Delay accelerator registration until visible as we do not have
        // focus manager until then.
        accelerator_registration_delayed_ = true;
      }
    } else {
      if (details.child == this)
        UnregisterAccelerators(true);
    }
  }

  if (details.is_add && layer() && !layer()->parent()) {
    UpdateParentLayer();
    Widget* widget = GetWidget();
    if (widget)
      widget->UpdateRootLayers();
  } else if (!details.is_add && details.child == this) {
    // Make sure the layers beloning to the subtree rooted at |child| get
    // removed from layers that do not belong in the same subtree.
    OrphanLayers();
    if (use_acceleration_when_possible) {
      Widget* widget = GetWidget();
      if (widget)
        widget->UpdateRootLayers();
    }
  }

  ViewHierarchyChanged(details);
  details.parent->needs_layout_ = true;
}

void View::PropagateNativeThemeChanged(const ui::NativeTheme* theme) {
  for (int i = 0, count = child_count(); i < count; ++i)
    child_at(i)->PropagateNativeThemeChanged(theme);
  OnNativeThemeChanged(theme);
}

// Size and disposition --------------------------------------------------------

void View::PropagateVisibilityNotifications(View* start, bool is_visible) {
  for (int i = 0, count = child_count(); i < count; ++i)
    child_at(i)->PropagateVisibilityNotifications(start, is_visible);
  VisibilityChangedImpl(start, is_visible);
}

void View::VisibilityChangedImpl(View* starting_from, bool is_visible) {
  VisibilityChanged(starting_from, is_visible);
}

void View::BoundsChanged(const gfx::Rect& previous_bounds) {
  if (visible_) {
    // Paint the new bounds.
    SchedulePaintBoundsChanged(
        bounds_.size() == previous_bounds.size() ? SCHEDULE_PAINT_SIZE_SAME :
        SCHEDULE_PAINT_SIZE_CHANGED);
  }

  if (use_acceleration_when_possible) {
    if (layer()) {
      if (parent_) {
        SetLayerBounds(GetLocalBounds() +
                       gfx::Vector2d(GetMirroredX(), y()) +
                       parent_->CalculateOffsetToAncestorWithLayer(NULL));
      } else {
        SetLayerBounds(bounds_);
      }
      // TODO(beng): this seems redundant with the SchedulePaint at the top of
      //             this function. explore collapsing.
      if (previous_bounds.size() != bounds_.size() &&
          !layer()->layer_updated_externally()) {
        // If our bounds have changed then we need to update the complete
        // texture.
        layer()->SchedulePaint(GetLocalBounds());
      }
    } else {
      // If our bounds have changed, then any descendant layer bounds may
      // have changed. Update them accordingly.
      UpdateChildLayerBounds(CalculateOffsetToAncestorWithLayer(NULL));
    }
  }

  OnBoundsChanged(previous_bounds);

  if (previous_bounds.size() != size()) {
    needs_layout_ = false;
    Layout();
  }

  if (NeedsNotificationWhenVisibleBoundsChange())
    OnVisibleBoundsChanged();

  // Notify interested Views that visible bounds within the root view may have
  // changed.
  if (descendants_to_notify_.get()) {
    for (Views::iterator i(descendants_to_notify_->begin());
         i != descendants_to_notify_->end(); ++i) {
      (*i)->OnVisibleBoundsChanged();
    }
  }
}

// static
void View::RegisterChildrenForVisibleBoundsNotification(View* view) {
  if (view->NeedsNotificationWhenVisibleBoundsChange())
    view->RegisterForVisibleBoundsNotification();
  for (int i = 0; i < view->child_count(); ++i)
    RegisterChildrenForVisibleBoundsNotification(view->child_at(i));
}

// static
void View::UnregisterChildrenForVisibleBoundsNotification(View* view) {
  if (view->NeedsNotificationWhenVisibleBoundsChange())
    view->UnregisterForVisibleBoundsNotification();
  for (int i = 0; i < view->child_count(); ++i)
    UnregisterChildrenForVisibleBoundsNotification(view->child_at(i));
}

void View::RegisterForVisibleBoundsNotification() {
  if (registered_for_visible_bounds_notification_)
    return;

  registered_for_visible_bounds_notification_ = true;
  for (View* ancestor = parent_; ancestor; ancestor = ancestor->parent_)
    ancestor->AddDescendantToNotify(this);
}

void View::UnregisterForVisibleBoundsNotification() {
  if (!registered_for_visible_bounds_notification_)
    return;

  registered_for_visible_bounds_notification_ = false;
  for (View* ancestor = parent_; ancestor; ancestor = ancestor->parent_)
    ancestor->RemoveDescendantToNotify(this);
}

void View::AddDescendantToNotify(View* view) {
  DCHECK(view);
  if (!descendants_to_notify_.get())
    descendants_to_notify_.reset(new Views);
  descendants_to_notify_->push_back(view);
}

void View::RemoveDescendantToNotify(View* view) {
  DCHECK(view && descendants_to_notify_.get());
  Views::iterator i(std::find(
      descendants_to_notify_->begin(), descendants_to_notify_->end(), view));
  DCHECK(i != descendants_to_notify_->end());
  descendants_to_notify_->erase(i);
  if (descendants_to_notify_->empty())
    descendants_to_notify_.reset();
}

void View::SetLayerBounds(const gfx::Rect& bounds) {
  layer()->SetBounds(bounds);
}

// Transformations -------------------------------------------------------------

bool View::GetTransformRelativeTo(const View* ancestor,
                                  gfx::Transform* transform) const {
  const View* p = this;

  while (p && p != ancestor) {
    transform->ConcatTransform(p->GetTransform());
    gfx::Transform translation;
    translation.Translate(static_cast<float>(p->GetMirroredX()),
                          static_cast<float>(p->y()));
    transform->ConcatTransform(translation);

    p = p->parent_;
  }

  return p == ancestor;
}

// Coordinate conversion -------------------------------------------------------

bool View::ConvertPointForAncestor(const View* ancestor,
                                   gfx::Point* point) const {
  gfx::Transform trans;
  // TODO(sad): Have some way of caching the transformation results.
  bool result = GetTransformRelativeTo(ancestor, &trans);
  gfx::Point3F p(*point);
  trans.TransformPoint(p);
  *point = gfx::ToFlooredPoint(p.AsPointF());
  return result;
}

bool View::ConvertPointFromAncestor(const View* ancestor,
                                    gfx::Point* point) const {
  gfx::Transform trans;
  bool result = GetTransformRelativeTo(ancestor, &trans);
  gfx::Point3F p(*point);
  trans.TransformPointReverse(p);
  *point = gfx::ToFlooredPoint(p.AsPointF());
  return result;
}

// Accelerated painting --------------------------------------------------------

void View::CreateLayer() {
  // A new layer is being created for the view. So all the layers of the
  // sub-tree can inherit the visibility of the corresponding view.
  for (int i = 0, count = child_count(); i < count; ++i)
    child_at(i)->UpdateChildLayerVisibility(true);

  layer_ = new ui::Layer();
  layer_owner_.reset(layer_);
  layer_->set_delegate(this);
#if !defined(NDEBUG)
  layer_->set_name(GetClassName());
#endif

  UpdateParentLayers();
  UpdateLayerVisibility();

  // The new layer needs to be ordered in the layer tree according
  // to the view tree. Children of this layer were added in order
  // in UpdateParentLayers().
  if (parent())
    parent()->ReorderLayers();

  Widget* widget = GetWidget();
  if (widget)
    widget->UpdateRootLayers();
}

void View::UpdateParentLayers() {
  // Attach all top-level un-parented layers.
  if (layer() && !layer()->parent()) {
    UpdateParentLayer();
  } else {
    for (int i = 0, count = child_count(); i < count; ++i)
      child_at(i)->UpdateParentLayers();
  }
}

void View::OrphanLayers() {
  if (layer()) {
    if (layer()->parent())
      layer()->parent()->Remove(layer());

    // The layer belonging to this View has already been orphaned. It is not
    // necessary to orphan the child layers.
    return;
  }
  for (int i = 0, count = child_count(); i < count; ++i)
    child_at(i)->OrphanLayers();
}

void View::ReparentLayer(const gfx::Vector2d& offset, ui::Layer* parent_layer) {
  layer_->SetBounds(GetLocalBounds() + offset);
  DCHECK_NE(layer(), parent_layer);
  if (parent_layer)
    parent_layer->Add(layer());
  layer_->SchedulePaint(GetLocalBounds());
  MoveLayerToParent(layer(), gfx::Point());
}

void View::DestroyLayer() {
  ui::Layer* new_parent = layer()->parent();
  std::vector<ui::Layer*> children = layer()->children();
  for (size_t i = 0; i < children.size(); ++i) {
    layer()->Remove(children[i]);
    if (new_parent)
      new_parent->Add(children[i]);
  }

  layer_ = NULL;
  layer_owner_.reset();

  if (new_parent)
    ReorderLayers();

  UpdateChildLayerBounds(CalculateOffsetToAncestorWithLayer(NULL));

  SchedulePaint();

  Widget* widget = GetWidget();
  if (widget)
    widget->UpdateRootLayers();
}

// Input -----------------------------------------------------------------------

bool View::ProcessMousePressed(const ui::MouseEvent& event) {
  int drag_operations =
      (enabled_ && event.IsOnlyLeftMouseButton() &&
       HitTestPoint(event.location())) ?
       GetDragOperations(event.location()) : 0;
  ContextMenuController* context_menu_controller = event.IsRightMouseButton() ?
      context_menu_controller_ : 0;
  View::DragInfo* drag_info = GetDragInfo();

  const bool enabled = enabled_;
  const bool result = OnMousePressed(event);

  if (!enabled)
    return result;

  if (event.IsOnlyRightMouseButton() && context_menu_controller &&
      kContextMenuOnMousePress) {
    // Assume that if there is a context menu controller we won't be deleted
    // from mouse pressed.
    gfx::Point location(event.location());
    if (HitTestPoint(location)) {
      ConvertPointToScreen(this, &location);
      ShowContextMenu(location, ui::MENU_SOURCE_MOUSE);
      return true;
    }
  }

  // WARNING: we may have been deleted, don't use any View variables.
  if (drag_operations != ui::DragDropTypes::DRAG_NONE) {
    drag_info->PossibleDrag(event.location());
    return true;
  }
  return !!context_menu_controller || result;
}

bool View::ProcessMouseDragged(const ui::MouseEvent& event) {
  // Copy the field, that way if we're deleted after drag and drop no harm is
  // done.
  ContextMenuController* context_menu_controller = context_menu_controller_;
  const bool possible_drag = GetDragInfo()->possible_drag;
  if (possible_drag &&
      ExceededDragThreshold(GetDragInfo()->start_pt - event.location()) &&
      (!drag_controller_ ||
       drag_controller_->CanStartDragForView(
           this, GetDragInfo()->start_pt, event.location()))) {
    DoDrag(event, GetDragInfo()->start_pt,
           ui::DragDropTypes::DRAG_EVENT_SOURCE_MOUSE);
  } else {
    if (OnMouseDragged(event))
      return true;
    // Fall through to return value based on context menu controller.
  }
  // WARNING: we may have been deleted.
  return (context_menu_controller != NULL) || possible_drag;
}

void View::ProcessMouseReleased(const ui::MouseEvent& event) {
  if (!kContextMenuOnMousePress && context_menu_controller_ &&
      event.IsOnlyRightMouseButton()) {
    // Assume that if there is a context menu controller we won't be deleted
    // from mouse released.
    gfx::Point location(event.location());
    OnMouseReleased(event);
    if (HitTestPoint(location)) {
      ConvertPointToScreen(this, &location);
      ShowContextMenu(location, ui::MENU_SOURCE_MOUSE);
    }
  } else {
    OnMouseReleased(event);
  }
  // WARNING: we may have been deleted.
}

// Accelerators ----------------------------------------------------------------

void View::RegisterPendingAccelerators() {
  if (!accelerators_.get() ||
      registered_accelerator_count_ == accelerators_->size()) {
    // No accelerators are waiting for registration.
    return;
  }

  if (!GetWidget()) {
    // The view is not yet attached to a widget, defer registration until then.
    return;
  }

  accelerator_focus_manager_ = GetFocusManager();
  if (!accelerator_focus_manager_) {
    // Some crash reports seem to show that we may get cases where we have no
    // focus manager (see bug #1291225).  This should never be the case, just
    // making sure we don't crash.
    NOTREACHED();
    return;
  }
  for (std::vector<ui::Accelerator>::const_iterator i(
           accelerators_->begin() + registered_accelerator_count_);
       i != accelerators_->end(); ++i) {
    accelerator_focus_manager_->RegisterAccelerator(
        *i, ui::AcceleratorManager::kNormalPriority, this);
  }
  registered_accelerator_count_ = accelerators_->size();
}

void View::UnregisterAccelerators(bool leave_data_intact) {
  if (!accelerators_.get())
    return;

  if (GetWidget()) {
    if (accelerator_focus_manager_) {
      // We may not have a FocusManager if the window containing us is being
      // closed, in which case the FocusManager is being deleted so there is
      // nothing to unregister.
      accelerator_focus_manager_->UnregisterAccelerators(this);
      accelerator_focus_manager_ = NULL;
    }
    if (!leave_data_intact) {
      accelerators_->clear();
      accelerators_.reset();
    }
    registered_accelerator_count_ = 0;
  }
}

// Focus -----------------------------------------------------------------------

void View::InitFocusSiblings(View* v, int index) {
  int count = child_count();

  if (count == 0) {
    v->next_focusable_view_ = NULL;
    v->previous_focusable_view_ = NULL;
  } else {
    if (index == count) {
      // We are inserting at the end, but the end of the child list may not be
      // the last focusable element. Let's try to find an element with no next
      // focusable element to link to.
      View* last_focusable_view = NULL;
      for (Views::iterator i(children_.begin()); i != children_.end(); ++i) {
          if (!(*i)->next_focusable_view_) {
            last_focusable_view = *i;
            break;
          }
      }
      if (last_focusable_view == NULL) {
        // Hum... there is a cycle in the focus list. Let's just insert ourself
        // after the last child.
        View* prev = children_[index - 1];
        v->previous_focusable_view_ = prev;
        v->next_focusable_view_ = prev->next_focusable_view_;
        prev->next_focusable_view_->previous_focusable_view_ = v;
        prev->next_focusable_view_ = v;
      } else {
        last_focusable_view->next_focusable_view_ = v;
        v->next_focusable_view_ = NULL;
        v->previous_focusable_view_ = last_focusable_view;
      }
    } else {
      View* prev = children_[index]->GetPreviousFocusableView();
      v->previous_focusable_view_ = prev;
      v->next_focusable_view_ = children_[index];
      if (prev)
        prev->next_focusable_view_ = v;
      children_[index]->previous_focusable_view_ = v;
    }
  }
}

// System events ---------------------------------------------------------------

void View::PropagateThemeChanged() {
  for (int i = child_count() - 1; i >= 0; --i)
    child_at(i)->PropagateThemeChanged();
  OnThemeChanged();
}

void View::PropagateLocaleChanged() {
  for (int i = child_count() - 1; i >= 0; --i)
    child_at(i)->PropagateLocaleChanged();
  OnLocaleChanged();
}

// Tooltips --------------------------------------------------------------------

void View::UpdateTooltip() {
  Widget* widget = GetWidget();
  // TODO(beng): The TooltipManager NULL check can be removed when we
  //             consolidate Init() methods and make views_unittests Init() all
  //             Widgets that it uses.
  if (widget && widget->native_widget_private()->GetTooltipManager())
    widget->native_widget_private()->GetTooltipManager()->UpdateTooltip();
}

// Drag and drop ---------------------------------------------------------------

bool View::DoDrag(const ui::LocatedEvent& event,
                  const gfx::Point& press_pt,
                  ui::DragDropTypes::DragEventSource source) {
#if !defined(OS_MACOSX)
  int drag_operations = GetDragOperations(press_pt);
  if (drag_operations == ui::DragDropTypes::DRAG_NONE)
    return false;

  OSExchangeData data;
  WriteDragData(press_pt, &data);

  // Message the RootView to do the drag and drop. That way if we're removed
  // the RootView can detect it and avoid calling us back.
  gfx::Point widget_location(event.location());
  ConvertPointToWidget(this, &widget_location);
  GetWidget()->RunShellDrag(this, data, widget_location, drag_operations,
      source);
  return true;
#else
  return false;
#endif  // !defined(OS_MACOSX)
}

}  // namespace views
",16230,True,3183.479464071098,median
"= HealthyBaby - Developer Guide
:site-section: DeveloperGuide
:toc:
:toc-title:
:toc-placement: preamble
:sectnums:
:imagesDir: images
:stylesDir: stylesheets
:xrefstyle: full
ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:warning-caption: :warning:
endif::[]
:repoURL: https://github.com/AY1920S2-CS2103T-T10-1/main

end
By: `Team HYBB`      Since: `Mar 2020`      Licence: `MIT`

== Setting up

Refer to the guide <<SettingUp#, here>>.

== Design

[[Design-Architecture]]
=== Architecture

.Architecture Diagram
image::ArchitectureDiagram.png[]

The *_Architecture Diagram_* given above explains the high-level design of the App. Given below is a quick overview of each component.

[TIP]
The `.puml` files used to create diagrams in this document can be found in the link:{repoURL}/docs/diagrams/[diagrams] folder.
Refer to the <<UsingPlantUml#, Using PlantUML guide>> to learn how to create and edit diagrams.

`Main` has two classes called link:{repoURL}/src/main/java/seedu/recipe/Main.java[`Main`] and link:{repoURL}/src/main/java/seedu/recipe/MainApp.java[`MainApp`]. It is responsible for,

* At app launch: Initializes the components in the correct sequence, and connects them up with each other.
* At shut down: Shuts down the components and invokes cleanup method where necessary.

<<Design-Commons,*`Commons`*>> represents a collection of classes used by multiple other components.
The following class plays an important role at the architecture level:

* `LogsCenter` : Used by many classes to write log messages to the App's log file.

The rest of the App consists of four components.

* <<Design-Ui,*`UI`*>>: The UI of the App.
* <<Design-Logic,*`Logic`*>>: The command executor.
* <<Design-Model,*`Model`*>>: Holds the data of the App in-memory.
* <<Design-Storage,*`Storage`*>>: Reads data from, and writes data to, the hard disk.

Each of the four components

* Defines its _API_ in an `interface` with the same name as the Component.
* Exposes its functionality using a `{Component Name}Manager` class.

For example, the `Logic` component (see the class diagram given below) defines it's API in the `Logic.java` interface and exposes its functionality using the `LogicManager.java` class.

.Class Diagram of the Logic Component
image::LogicClassDiagram.png[]

[discrete]
==== How the architecture components interact with each other

The _Sequence Diagram_ below shows how the components interact with each other for the scenario where the user issues the command `delete 1`.

.Component interactions for `delete 1` command
image::ArchitectureSequenceDiagram.png[]

The sections below give more details of each component.

[[Design-Ui]]
=== UI component

.Structure of the UI Component
image::UiClassDiagram.png[]

*API* : link:{repoURL}/src/main/java/seedu/recipe/ui/Ui.java[`Ui.java`]

The UI consists of a `MainWindow` that is made up of parts e.g.`CommandBox`, `ResultDisplay`, `RecipeListPanel`, `StatusBarFooter` etc. All these, including the `MainWindow`, inherit from the abstract `UiPart` class.

The `UI` component uses JavaFx UI framework. The layout of these UI parts are defined in matching `.fxml` files that are in the `src/main/resources/view` folder. For example, the layout of the link:{repoURL}/src/main/java/seedu/recipe/ui/MainWindow.java[`MainWindow`] is specified in link:{repoURL}/src/main/resources/view/MainWindow.fxml[`MainWindow.fxml`]

The `UI` component,

* Executes user commands using the `Logic` component.
* Listens for changes to `Model` data so that the UI can be updated with the modified data.

[[Design-Logic]]
=== Logic component

[[fig-LogicClassDiagram]]
.Structure of the Logic Component
image::LogicClassDiagram.png[]

*API* :
link:{repoURL}/src/main/java/seedu/recipe/logic/Logic.java[`Logic.java`]

.  `Logic` uses the `RecipeBookParser` class to parse the user command.
.  This results in a `Command` object which is executed by the `LogicManager`.
.  The command execution can affect the `Model` (e.g. adding a recipe).
.  The result of the command execution is encapsulated as a `CommandResult` object which is passed git back to the `Ui`.
.  In addition, the `CommandResult` object can also instruct the `Ui` to perform certain actions, such as displaying help to the user.

Given below is the Sequence Diagram for interactions within the `Logic` component for the `execute(""delete 1"")` API call.

.Interactions Inside the Logic Component for the `delete 1` Command
image::DeleteSequenceDiagram.png[]

NOTE: The lifeline for `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.

[[Design-Model]]
=== Model component

.Simplified Structure of the Model Component
image::ModelClassDiagram.png[]

*API* : link:{repoURL}/src/main/java/seedu/recipe/model/Model.java[`Model.java`]

The diagram above has been simplified in order to provide a clearer Overview of the Model component. +
The `Model` consists of 4 main sections: recipe, plan, record and quote. +
For more details on each of the main sections of the `Model`, please refer to the corresponding models
illustrated in the next few sections of this document.

The `Model` component stores a,

* `UserPref` object that represents the user's preferences.
* `RecipeBook` object that stores all recipes.
* `PlannedBook` object that stores all plans.
* `CookedRecordBook` object that stores the records of all the cooked recipes.
* `QuoteBook` object that stores all quotes.

It also exposes five unmodifiable lists that can be 'observed' by the `UI`: +

* `ObservableList<Recipe>`
* `ObservableList<Plan>`
* `ObservableList<Record>`
* `ObservableList<GoalCount>`
* `ObservableList<Quote>` +
The `UI` can be bound to these lists so that the `UI` automatically updates when the data in the list changes. +

The `Model` does not depend on any of the other three components. +

==== Recipe Model
.Structure of the Recipe Model
image::ModelRecipeClassDiagram.png[]

The Recipe Model stores the `UniqueRecipeList` containing all recipes.

Each `Recipe` consists of,

* One `Name`
* One `Time`
* Any number of `Step`
* At least one `Ingredient`

For a more comprehensive description on the structure of a Recipe, please refer to
<<UserGuide#, The Anatomy of a Recipe>> in our User Guide.

==== Plan Model
.Structure of the Plan Model
image::ModelPlanClassDiagram.png[]

The Plan Model stores the,

* `UniquePlannedList` which contains all plans
* `PlannedRecipeMap` which  maintains the mapping from `Recipe` to all the plans that uses this `Recipe`

Each `Plan` consists of,

* One `Date`
* One `Recipe`

==== Record Model
.Structure of the Record Model
image::ModelRecordClassDiagram.png[]

The Record Model stores the `UniqueRecordList` which contains all records.

Each `Record` consists of,

* One `Date`
* One `Name` from a `Recipe`
* One set of `Goal` list

==== Quote Model
.Structure of the Quote Model
image::ModelQuoteClassDiagram.png[]

The Quote Model stores the `UniqueQuoteList` which contains all quotes.

Each `Quote` consists of one `Content`.

[[Design-Storage]]
=== Storage component

.Structure of the Storage Component
image::StorageClassDiagram.png[]

*API* : link:{repoURL}/src/main/java/seedu/recipe/storage/Storage.java[`Storage.java`]

In the figure above, we can see that we are maintaining 5 different storages. These storages aim to keep the memory of:

* `UserPrefs`
* `RecipeBook`
* `PlannedBook`
* `CookedRecords`
* `QuoteBook`

The `Storage` component,

* can save `UserPref` objects in json format and read it back.
* can save the HYBB data in json format and read it back.

[[Design-Commons]]
=== Common classes

Classes used by multiple components are in the `seedu.recipe.commons` package.

== Implementation

This section describes some noteworthy details on how certain features are implemented.

// tag::basic[]
=== Basic commands


==== Switch command (Harshita)
The `switch` command is facilitated by the `MainWindow`, `MainTabPanel`, `SwitchCommandParser` and `SwitchCommandParser`.

The following lists in sequential order the process of how `switch` behaves with user input.

*The user launches HYBB and the default start tab is set to the recipes tab.

*The user now executes `switch planning` to view the planning tab.

*`LogicManager` uses `RecipeBookParser#parseCommand()` to parse the input from the user upon execution of the `switch` command.

*`RecipeBookParser` determines which command is being used and creates `SwitchCommandParser` to parse the input
from the user to obtain the arguments.

*`SwitchCommandParser` parses the argument and checks its validity. If it is invalid,
`SwitchCommandParser` throws an exception and terminates. Else, it returns a `SwitchCommand` that contains a `Tab`.

* `LogicManager` uses `SwitchCommand#execute()` to switch to the planning tab.

* `SwitchCommand` returns a `CommandResult` to the `LogicManager` with the `Tab`. `LogicManager` then
returns the `CommandResult` to `MainWindow`.

* `MainWindow` checks if there is a change in state for `Tab` and if switching is needed. If there is, `MainWindow` uses
`MainWindow#handleSwitchTab()` to switch tab. Else, `MainWindow` does nothing.

The following activity diagram shows the flow of activites from when the `switch` command is executed.


image::SwitchActivityDiagram.png[]

==== Add command

==== Edit command (Beatrice)
The edit feature allows users to edit the properties of a Recipe with ease using the `edit` command. +

This feature is facilitated by the `EditCommand` class. +

The following activity diagram illustrates how the `EditCommand` is used. +

.Activity Diagram for edit command
image::EditActivityDiagram.png[]

===== Implementation
This section explains how the `edit` command is implemented.

1. User specified arguments are passed to the `EditCommandParser` and passed into `ArgumentTokenizer` and
`ArgumentMultimap`.

2. The arguments will then be parsed by `ParserUtil` and passed into `EditRecipeDescriptor`.
An error will be thrown if the inputs were invalid or if no properties of the Recipe were edited.

3. A new `EditCommand` object will be created containing the new properties of the `Recipe`.

4. `EditCommand#execute()` will then get the latest list of recipes from `Model` and obtain the `Recipe` that is
being edited.

5. This `Recipe` is passed into `EditCommand#createEditedRecipe()` which creates a new `Recipe` with the edited properties.

6. `Model#setRecipe()` will then replace the `Recipe` being edited with the new `Recipe` and update the list of recipes and plans.

The following sequence diagram summarizes the steps taken so far:

.Edit sequence diagram
image::EditSequenceDiagram.png[]

[NOTE]
The lifeline for EditCommandParser should end at the destroy marker (X) but due to a limitation of PlantUML,
the lifeline reaches the end of diagram.

[WARNING]
The details of some methods, like the the usage of `EditRecipeDecriptor`, was omitted to reduce clutter in the diagram.

The edited recipe will be updated in both the list of recipes and plans.
The following section explains in detail the implementation behind how each list is updated in the
`RecipeBook` and `PlannedBook` class.

1. Continuing off from Step 8, `ModelManager#setRecipe()` will be called to replace the target `Recipe` with the
edited `Recipe`. (`ModelManager` implements `Model`)

2. The target and edited `Recipe` is passed into `RecipeBook#setRecipe()` and `UniqueRecipeList#setRecipe()`, which
will replace the target with the edited `Recipe` in the recipe list.

3. The same arguments are then passed into `PlannedBook#setRecipe()` which will get a list of all the plans that uses
the target `Recipe` from `PlannedRecipeMap` and update each plan.


The following sequence diagram summarizes how the `Recipe` and all its related `Plan` are updated
when the `Recipe` is edited.

.Edit sequence diagram focusing on Model
image::EditModelSequenceDiagram.png[]

===== Design Considerations

====== Aspect: How recipes are edited

* **Alternative 1 (current choice):** The `EditRecipeDescriptor` class is used to make sense of user input and mimics
the `Recipe` class with the same properties.
** Pros: Multiple fields can be edited in one go.
** Cons: Might make testing harder since there are many properties in a Recipe and an edit command can take on any
combination of each property.

* **Alternative 2:** Allow each property in the `Recipe` to have its own `edit` command.
** Pros: Implementation of each command will be simpler.
** Cons: Editing a recipe will be harder and more troublesome for the user.

We decided to stick with alternative 1, which is the implementation inherited by AB3, as we believe that being able
to edit multiple fields in one go provides much more versatility and convenience to the user. Additionally, although
there are many properties to test, it is still a finite number and testing can be done with adequate time.

====== Aspect: Data structure to support the recipes and plans

* **Alternative 1 (current choice):** The recipes and plans are maintained in an `ObservableList` by the
`UniqueRecipeList` and `UniquePlannedList` class respectively. The lists are unmodifiable outside of these classes.
`PlannedRecipeMap` maintains the mapping from `Recipe` to all plans that use this `Recipe`.
** Pros: The `ObservableList` allows the UI to 'listen' in and be updated when the lists change. +
The unmodifiable property also safeguards the data in the lists from being corrupted. +
The `PlannedRecipeMap` eases the cost of iterating through the entire list of plans in the `UniquePlannedList` and
checking whether each plan uses the `Recipe` being edited.
** Cons: Performance might not be optimised by using a List instead of other data structures like a LinkedList or
HashMap for the `UniqueRecipeList` and `UniquePlannedList`.

* **Alternative 2:** Maintain the recipes and plans in an `ObservableMap` instead.
** Pros: Performance will be better by using a Map than a List.
** Cons: There are no official javafx classes that supports an sorted `ObservableMap` or a filtered `ObservableMap`.
We will have to write and maintain our own implementation or import from pre-existing libraries.

We decided to use alternative 1, as the cons of alternative 2 are too heavy. Many aspects of our program require
filtering and sorting to be supported. For example, plans need to be sorted in chronological order, and the advanced
recipe list needs to be filtered for our filter feature. +
Additionally, we would not have enough time in the scope of this project to write our own implementation, and importing from pre-existing
libraries gives the risk of running into bugs in the future if the the dependencies were not maintained.



==== Delete command


==== Favourite and Unfavourite commands (Brian)
===== Implementation
For brevity, we will only talk about the `favourite` command. Note that the `unfavourite` command is implemented in the
same way.

1. The user input received by `FavouriteCommandParser#parse` will pass on the user input to
`ParserUtil#parseMultipleIndex` to verify if the indexes keyed in are non-zero, unsigned integers. An error is thrown
if any of the indexes do not meet this requirement.
+
On top of verifying the validity of the indexes, `ParserUtil#parseMultipleIndex` will remove any duplicate indexes
and sort them. It returns a sorted array of one-based indexes.

2. A new `FavouriteCommand` object will be created with the array of indexes and returned to the `LogicManager`.

3. The `FavouriteCommand#execute` method is executed. First, the array of indexes will be checked against the
_currently displayed recipe list_ to ensure that there exists a corresponding recipe index. An error will be thrown if
a user specified recipe index is out of bounds.

4. Next, we check if the specified recipe(s) is already a favourite. If it is not a favourite yet, we use an
`EditRecipeDescriptor` to set the recipe's `isFavourite` to true.

5. Finally, we display the names of the recipes that have been newly made favourites, and the names of the recipes that
were already favourites.

Here is a sample sequence diagram that shows what happens when the user inputs `favourite 3`:

.Favourite command sequence diagram
image::FavouriteCommandSequenceDiagram.png[]

This operation favourites recipe 2 and 3.

==== Undo and Redo commands (Brian)
The implementation of undo and redo was adapted from AB3. However, HYBB requires more book-keeping because on top
of the `RecipeBook`, we have a `PlannedBook` and a `CookedRecordBook` to keep track of as well.

For brevity, we will only talk about the `undo` command. Note that the `redo` command is implemented in the same way.

===== Implementation (before undo is called)
1. Whenever a command that changes the state of any of the books (RecipeBook, PlannedBook, or CookedRecordBook) is
called, `Model#commitBook` is called as well.

2. `Model#commitBook` will first purge all redundant states in `MultipleBookStateManager` (ie. if the user called undo
before and is now committing a new book, he will not be able to redo the actions of those undos anymore). This is the
behavior that most modern desktop applications like Microsoft Word adopt.

3. `Model#commitBook` also saves the `CommandType` and `Tab` of the command in 2 separate stacks in
`MultipleBookStateManager`. Finally, it saves the new state of the affected book(s) in an ArrayList of that book type.

Note #1: `CommandType` tells you which book(s) the command affects, while `Tab` tells you which tab should be
displayed upon execution of the command.

Note #2: All 3 ArrayLists of the 3 book types have a ""current pointer"" each, which points to the respective states of
the books that the `Model` is currently using (ie. what the user is seeing).

The following diagram summarizes what happens when the user executes a command that changes the state of any book:

.Activity diagram when a command is executed
image::CommitActivityDiagram.png[]

===== Implementation (when undo is called)
1. `Model#canUndo` is called to check if there are sufficient actions to be undone. An error is thrown if there are
insufficient actions to be undone.

2. If able to undo, `Model#undoBook` is called. The `CommandType` stack is popped to know which book(s) need undoing.
At the same time, the ""current pointer"" of the corresponding book ArrayList(s) is/are shifted backwards. All 3 books
in `Model` are then set to the version of the book that each ""current pointer"" is pointing to.

This class diagram shows the components of `MultipleBookStateManager`:

.Class diagram for MultipleBookStateManager
image::MultipleBookStateManagerClassDiagram.png[]

The following diagrams show what happens after the execution of various commands:

.When the app is first opened
image::UndoRedoState0.png[]

.When ""delete 5"" is called, the state of RecipeBook is changed. This new state is added to ArrayList<RecipeBook>.
image::UndoRedoState1.png[]

.When ""favourite 3"" is called, the state of RecipeBook is changed. This new state is added to ArrayList<RecipeBook>.
image::UndoRedoState2.png[]

.When ""undo"" is called, the current state pointer of ArrayList<RecipeBook> is shifted back and the Model's RecipeBook is set to this version.
image::UndoRedoState3.png[]

.When a command like ""list"" (that does not change the state of any book) is called, the current state pointer remains where it is (ie. there is no change of states).
image::UndoRedoState4.png[]

.If a command like ""clear"" (that changes the state of a book) is called while the current pointer is not pointing to the latest version, all versions after the current pointer will be purged and the newest version will be added to the ArrayList.
image::UndoRedoState5.png[]

===== Design Considerations
====== Aspect: How undo and redo executes
One concern we had while choosing the design of the undo and redo features was the amount of memory that has to be used
to keep track of the different states of the 3 books.

On top of the ArrayLists of different book types, we also needed to have 2 additional stacks to keep track of the
corresponding `CommandType` and `Tab`.

We eventually decided on the current implementation because we do not expect the user to make that many changes to the
books in a single session. We also do not expect the size of any book to grow so huge that a single commit would take
up all the memory capacity. In other words, we foresee that the ""cons"" of our current choice will not happen (it would
take really abnormal user behavior for it to reach that stage).

* **Alternative 1 (current choice):** Saves the entire recipe book.
** Pros: Easy to implement.
** Cons: May use up a lot of memory space within a single session 1) if there is a large number of book commits
and/or 2) if the magnitude of a single commit is large (ie. the book being committed is huge just by itself).

* **Alternative 2:** Individual command knows how to undo/redo by itself.
** Pros: Will use less memory.
** Cons: Tedious to ensure the correctness of the implementation of each individual command. Furthermore, some commands
affect multiple books, making book-keeping even more complicated (and hence, susceptible to error).

===== Future plans
Currently, the undo and redo command is not compatible with the `quote` command and the QuoteBook. This will be a
feature that we plan to work on beyond v1.4 so that users will be able to undo and redo the action of adding a quote!

==== Clear command


==== Exit command


// end::basic[]

// tag::recipecustomisation[]
=== Recipe customisation commands (Brian)
The following commands: `addingredient`, `editingredient`, `deleteingredient`, `addstep`, `editstep`, and `deletestep`
were implemented to overcome the limitations of the `edit` command. These recipe customisation commands allow the user
to make targeted changes to the ingredient or step fields instead of having to rewrite the entire field using `edit`.

==== Implementation
1. The commands listed above make use of `EditRecipeDescriptor` (ERD) to add, edit, or delete ingredients or steps.
This is done by comparing the contents of the ERD to the contents of the field to be edited and making the necessary
changes described below (note that at this point of time, the ERD is already populated with the user's input):

* If the command is `addingredient` or `addstep`, the existing ingredients or steps from the recipe will be added to
the ERD.

* If the command is `editingredient` or `editstep`, the ERD will be checked against the recipe to see if the
ingredients or step exists in the recipe. If it exists, the remaining ingredients or steps that were not changed
will be added to the ERD. Otherwise, an exception is thrown.

* If the command is `deleteingredient` or `deletestep`, the ERD will be checked against the recipe to see if the
ingredients or step exists in the recipe. If it exists, the ERD will be re-populated with the existing ingredients or
steps from the recipe, less the ones that were specified by the user. Otherwise, an exception is thrown.

2. With the ERD fields set, the specified recipe is edited by `EditCommand#createEditedRecipe` using the ERD.

3. Finally, `Model#setRecipe` will replace the old version of the recipe in RecipeBook with the newly edited one.
`Model#commitBook` will commit the new state of the RecipeBook to the `MultipleBookStateManager` so that the user will
be able to undo this command if he wishes to.

.General activity diagram for recipe customisation commands
image::RecipeCustomisationCommandsActivityDiagram.png[]

// end::recipecustomisation[]

// tag::advancedfilter[]
=== Filter command (Brian)
The advanced filter feature uses the `filter` command to search for recipes according to the set of keywords provided
by the user. Think of it as a greatly enhanced and more robust version of the `find` command, which only allows the
user to find recipes by their name.

==== Implementation
This section explains how the `filter` command is implemented.

1. User specified keywords are directed to `FilterCommandParser#parse` where `ArgumentTokenizer` and
`ArgumentMultimap` are used to parse the user input. An exception will be thrown if no keywords are specified at all.

2. The parsed user input is then fed into `RecipeMatchesKeywordPredicate` where a `Predicate`, p, is created. This
predicate will subsequently be used as the filter to get all recipes that meet the user specified criteria.

3. A new `FilterCommand` object will be created with the predicate, p, and be returned to the `LogicManager`.

4. The `FilterCommand#execute` method is executed and `Model#updateFilteredRecipeList` is called. This tests
every recipe in the database against the predicate, p, and updates the filtered recipe list with recipes that meet the
user specified criteria.

5. Once complete, this filtered recipe list is displayed to the user.

Here is a sample sequence diagram that shows what happens when the user inputs `filter favourites t/20 ig/Pasta`:

.Advanced filter sequence diagram
image::AdvancedFilterSequenceDiagram.png[]

This operation displays all recipes that 1) are marked as favourites, 2) take 20 minutes or less to prepare,
and 3) contains pasta as an ingredient.

==== Design Considerations
===== Aspect: Consistency of user input format
One concern we had while implementing this feature was the sheer number of commands and prefixes that our app had.
Eventually, the current implementation was chosen because we didn't want to define a new format for `filter`
keywords which might potentially confuse our users.

* **Alternative 1 (current choice):** Use the existing prefixes and format in the user input.
** Pros: The existing `ArgumentTokenizer` and `ArgumentMultimap` classes already have capabilities to parse user input
that is in a certain format. Thus, using the same format saves us time and effort in implementing our own parser. It
also spares the user from having to remember multiple formats / keywords.
** Cons: The user has to be familiar with the prefixes and other special keywords in order to use this feature to its
fullest potential.

* **Alternative 2:** Define new keywords that the user can use. These keywords could be ""more english-like"" as opposed
to using shortened tags as prefixes.
** Pros: Easy to remember these keywords since they are more english-like.
** Cons: We must implement our own parser which is tedious. The user will also have to remember a new set of keywords
on top of the existing prefixes. This is double work for the user.
// end::advancedfilter[]

// tag::planning[]
=== Add plan command (Beatrice)
==== Implementation
The planning feature uses the `UniquePlannedList` to store and display all plans and the `PlannedRecipeMap` to
navigate between recipes and plans.

The `UniquePlannedList` provides the UI with an unmodifiable observable list that can be 'observed' and displayed.
Meanwhile, the `PlannedRecipeMap` maintains a mapping from `Recipe` to `Plan` so that a `Plan` can be easily
updated when a `Recipe` is changed.

Given below is a sequence diagram on how a `Plan` is updated when a `Recipe` is changed.

image::abc.png[]

==== Design Considerations

===== Aspect: How recipes are scheduled

* **Alternative 1 (current choice):** Scheduled recipes are saved in a separate data structure.
** Pros: Scheduled recipes can be easily obtained and sorted.
** Cons: May have performance issues in terms of memory usage if a large number of recipes are scheduled.

* **Alternative 2:** Store the date that the scheduled recipe is scheduled on as another attribute to the Recipe class.
** Pros: Easy to implement, no additional data structure added.
** Cons: All scheduled recipes can not be easily seen and sorted.

===== Aspect: Data structure to support the scheduled recipes

* **Alternative 1 (current choice):** Use a tree map to store the scheduled recipes in a <Date, List<Recipe>> key-value pair.
** Pros: Allows us to easily and intuitively access the list of recipes scheduled on a certain day.
** Cons: Obtaining all the recipes scheduled across a period of time will not be very efficient.

* **Alternative 2:** Use a List sorted by increasing time.
** Pros: Easy to implement, uncomplicated data structure.
** Cons: Hard to obtain the scheduled recipes on a certain date, as we do not know which index
corresponds to the date we are interested in.
// end::planning[]

// tag::goals[]
=== Goals feature (Harshita)
The main functionalities and commands associated with the entire goals feature are `add`, `addIngredient`, `edit`, `editIngredient`,
 `cooked`, `listGoals` and 'removeGoals'. Goals are auto-generated and added to a recipe every time `add`, `addIngredient`, `edit` or `editIngredient` is executed.

==== Details of Implementation (Auto-generation of goals)
The following sequence diagram shows how goals are generated through the example of `addIngredient` command execution

.Add command sequence diagram
image::AddSequenceDiagram.png[]
.Reference Frame for Add command sequence diagram
image::AddRefSequenceDiagram.png[]

A recipe is initially created with an empty goals set from parser and `calculateGoals()` is then called in the `AddCommand`.

Each ingredient type that is associated with a goal (`Vegetable`, `Protein`, `Fruit`, `Grain`) is listed as an enum type
in MainIngredientType. This ensures that invalid goals are not created and simplifies the mapping between `MainIngredientType`
and `Goal`.

The calculation of goals then occurs through looping through each ingredient type and executing the method call to
`Recipe#calculateIngredientQuantity()`.
This would obtain the total quantity for each ingredient, firstly by calling `Ingredient#getMainIngredientType()`
to ensure the validity of ingredients beings calculated (e.g. any instance of 'Other' ingredient would throw an `InvalidStateException`).
Secondly, by obtaining the quantity in grams through the method calls to `Ingredient#getQuantity()' and 'Quantity#convertToGram()`.

After the calculation for each main ingredient type is completed, an instance of `MainIngredientTypeMagnitude` is created.
It acts as a container to store the quantities and conduct the checks for whether these quantities meet the minimum quantity
requirement for their respective food group. This calculation and checks are done through the method call to
`MainIngredientTypeMagnitude#getMainTypes()` which would then return a set of `MainIngredientType` that successfully met the
minimum requirement.

Lastly, after looping through this set and creating each goal with the mapping from `MainIngredientType` to `Goal` done
(e.g. `MainIngredientType.FRUIT` leads to the creation of goal with goal name generated as ""Fruity Fiesta""), the goals will
be updated in the particular instance of `Recipe r` and `Model#addRecipe(r)` would then update `RecipeBook` in storage.

The immutability of each object is supported to ensure the correctness of undo and redo functionality.

==== Details of Implementation (Statistics of cooked recipes)

.Activity diagram when a cooked command is entered
image::CookedActivityDiagram.png[]

After `CookedCommand#execute(model)` is called, the series of checks shown in the above diagram is done to determine
if the recipe can be marked as cooked. With multiple recipes inputted (eg ""`cooked` 1 2 3"", the series of checks will
loop through for for each recipe.

The checks ensure that all the recipes inputted are valid, else the  `CookedCommand`
throws an exception and terminates. If successful, a new  `Record` containing the `Name`, current `Date` and set of `Goals`
associated with the recipe is created and `Model#addRecord(record)` would then update `CookedRecordBook` in storage.

Furthermore, if the recipe marked as cooked was included in the Planned Recipes for the day,
it will be removed from the planned list.

With reference to the structure of the CookedRecords Model,
.Class diagram of Record
image::ModelRecordClassDiagram.png[]

We can see above that once a record is added to the UniqueRecordList two Observable lists will be updated for each
addition of `Record`. Firstly, it is the `internalRecordsList` that stores unique `Record`. Secondly, based on this list,
an `internalGoalsTally` that stores `GoalCount` will be updated each time. This `GoalCount` consists of one of the four main goal
and its respective tally and this observable list is what the pie chart will be listening to for updates and will change
each time the `internalGoalsTally` has been updated as well.

Hence the `cooked` command is essential in not only archiving data, but also giving the user personalised statistics
on their overall goal distribution that resembles the Healthy Eating Plate. The immutability of each object is
supported to ensure the correctness of undo and redo functionality as well.


==== Design Considerations

===== Aspect: How goals are being tagged

* **Alternative 1 (current choice):** System generates tags for each recipe based on food algorithm.
** Pros: Higher accuracy and makes use of inputs of ingredients class.
** Cons: Would require several criteria checks that may not be intuitive and would require the use of artificial intelligence for the highest accuracy.

* **Alternative 2 :** User chooses from 4 given goals and user adds the tags to the recipes.
** Pros: Easy to implement. User can filter their preferred goals easily.
** Cons: Is dependant on user's understanding and not universal understanding of what may be deemed healthy.

Alternative 1 was chosen as standardising the goals give the recipes more meaning, especially when we are able
to calculate statistics and present in in an meaningful and appealing way for users when it models the Healthy eating Plate.
Furthermore, custom goals would not have checks would not have been implemented. for users to filter preferred recipes,
the command `favourite` as been implemented.

===== Aspect: How to determine the criteria for each goal

* **Alternative 1 (current choice):** Check by quantity
** Pros: More accurate and can be modelled against ideal ratio of a healthy meal.
** Cons: Harder to implement as we need to standardise the ingredient measurements, not as intuitive.

* **Alternative 2 :** Check by variety
** Pros: Easy to implement.
** Cons: Not as accurate as one grain of rice or 1 grape would still be counted as variety despite the small portion.

Alternative 1 was chosen because of its higher accuracy, although conversion between different measurement may be
overestimated. The command `deleteGoal` was then created in order to enable users to delete goals they deem inaccurate.

===== Aspect: How the check for goal is done

* **Alternative 1 (current choice):** Check every time a recipe is added or edited and store this data
** Pros: More consistent for the user in keeping track of their goals.
** Cons: Harder to implement as repetitive checks are needed every time ingredients are added or modified.
Will be more expensive to calculate with a larger database.

* **Alternative 2 :** Calculate the goals for each recipe every time it is retrieved from storage and set in RecipeList.
** Pros: Easier to implement as only one check is needed for when the recipes are set.
** Cons: Goals will reset each time the application is open. If goal has been deleted by user with `deleteGoal`, it will
not be updated the next time the user opens the application as the checks will be the same.

Alternative 1 was chosen as it optimizes the function of deleteGoal`, taking user preference into consideration.

===== Aspect: How to store data for records

* **Alternative 1 (current choice):** Store in a json file called records and calculate goal tally the first time
it is set and update accordingly
** Pros: A custom date can be set and it will be easier to iterate through the list to obtain goal tally.
** Cons: Duplicate data will be stored and is harder to implement.

* **Alternative 2 :** Use recipebook and add boolean attribute isCooked
** Pros: Easy to implement.
** Cons: Restricted usage, unable to implement date and do statistical analysis for the user.

* **Alternative 3 :** Store goal tally in a new json file.
** Pros: No need to iterate through recipe list each time and would be less expensive with a larger database.
** Cons: Only contains four values.

Alternative 1 was chosen as it optimizes the functions and uses of a Record and the scale for a personal data
base is smaller, storage would not be an issue. Records need to be iterated through when set initially anyway, hence
the association between GoalCount and Record makes the tally process more efficient.
end::goals[]

=== Quote Command (Yue Tong)
The quote command feature uses the `quote` command for users to input their own quotes to add on to the existing set of
quotes that is already in the database. This allows the users to add in customised quotes that would suit their preferance
more if the current list of quotes is not to their liking.

The following sequence diagram illustrates how the `QuoteCommand` is used.

.Quote command sequence diagram
image::QuoteSequenceDiagram.png[]
[NOTE]
The lifeline for EditCommandParser should end at the destroy marker (X) but due to a limitation of PlantUML,
the lifeline reaches the end of diagram.

[Note]
`Undo` button currently does not work for adding of quotes as there is no remove function currently implemented for quote
==== Implementation

This section explains how the `quote` command is implemented.

1. User specified arguments are passed to the `QuoteCommandParser#parse` which will then parse the user input to verify if the
quote field is empty. An error is thrown if the user had keyed in an empty field for quote.

2. A new `QuoteCommand` object will be created with a `Content` field to store the quote and returned to the `LogicManager`

3. The `QuoteCommand#execute` method is executed and `Model#addQuote` is called. This attempts to add the quote to the
database and verify if any duplicate quote exists in the database via `Model#hasQuote`. If a duplicate quote is detected
in the database, an error will be thrown to indicate that the quote already exists in the database.

4. Once the quote has been successfully updated to the database, the result window informs the user that the quote has
been successfully added.

The following activity diagram further illustrates how the `QuoteCommand` is used.

.Quote command activity diagram
image::QuoteActivityDiagram.png[]

==== Design Considerations
====== Aspect: How quote command executes

* **Alternative 1 (current choice):** The `QuoteCommand` only accepts adding of quotes

** Pros: Maintaining the database for quotes is easier
** Cons: Users will not be able to remove a quote if it is not to their liking and undo function does not work for quote command

* **Alternative 2:** The `QuoteCommand` accepts both adding and removal of quotes
** Pros: Users can customize whicher quotes they want to be displayed
** Cons: If they user deletes the quote that is on display for Quote of the Day in the Achievement tab, this could cause
display problems and as `UniqueQuotesList` is a hidden list, users will have to type out the quote completely similar in order to locate it

=== Streak feature(Yue Tong)

The Streak feature mainly deals with keeping track of the cooked meals that the user has logged into the system. The command
that Streak is associated with is `CookedCommand` as every user input of `cooked` will result in the streak log  to be reflected when `cooked` is executed. The changes are reflected in two main attributes, Current streak and
High streak.

The following sequence diagram illustrates how the `QuoteCommand` is used.

.Quote command sequence diagram
image::StreakActivityDiagram.png[]

==== Implementation

The streak feature uses data from the `UniqueRecordList` to parse through the recipes that the user has already cooked
and extract the dates from these recipes to determine the current streak for the user and the highest streak score the
user has attained as of yet.

The `UniqueRecordList` provides Streak with an observableList so that a listener could be added to it to make sure that
the streak always auto-updates whenever a new `CookedRecord` is added in to the database. Via the addListener, whenever
a new record is detected, the streaks are calculated again through parsing of the `CookedRecords` list and updated in
real time in the achievement tab.

==== Design Considerations
====== Aspect: How streak is stored

* **Alternative 1 (current choice):** Streak is calculated and updated via access to `UniqueRecordList`

** Pros: Easier to access `CookedRecord` list when there is direct access to `UniqueRecordList` and to update in real time
** Cons: There is more co-dependency among classes and there may be performance issues if `UniqueRecordList` is too large

* **Alternative 2:** Streak has its own database and json file to keep track of streaks
** Pros: Lesser time is required to re-calculate streaks every time a cookedRecord is updated as streak can just be
added and subtracted from its recorded data in the database
** Cons: A database section will be dedicated to just storing one number and without access to the `UniqueRecordsList`
it is harder for Streak to be updated realtime when cookedRecord is updated.

====== Aspect: How streak is calculated

* **Alternative 1 (current choice):** Accumulative streaks is calculated based on whether there is a 1-day difference
between 2 consecutive cooked recipes

** Pros: Easier to compute compared to implementing via a midnight deadline basis to calculate accumulative streaks
** Cons: Streaks are not necessarily accounted for within a 24-hour period

* **Alternative 2:** Accumulative streaks is calculated based on a stricter within 24-hour new logged cooked recipes
** Pros: The accountability is higher for users to actually accomplish their streaks by having to cook recipes within a
24-hour period and not be able to go for more than a day without cooking new recipes without having their streaks
jeopardised.
** Cons: It is easier for users to lose their streaks and more difficult for users to ascertain when is the deadline to
maintain their streaks

=== Logging

We are using `java.util.logging` package for logging. The `LogsCenter` class is used to manage the logging levels and logging destinations.

* The logging level can be controlled using the `logLevel` setting in the configuration file (See <<Implementation-Configuration>>)
* The `Logger` for a class can be obtained using `LogsCenter.getLogger(Class)` which will log messages according to the specified logging level
* Currently log messages are output through: `Console` and to a `.log` file.

*Logging Levels*

* `SEVERE` : Critical problem detected which may possibly cause the termination of the application
* `WARNING` : Can continue, but with caution
* `INFO` : Information showing the noteworthy actions by the App
* `FINE` : Details that is not usually noteworthy but may be useful in debugging e.g. print the actual list instead of just its size

[[Implementation-Configuration]]
=== Configuration

Certain properties of the application can be controlled (e.g user prefs file location, logging level) through the configuration file (default: `config.json`).

== Documentation

Refer to the guide <<Documentation#, here>>.

== Testing

Refer to the guide <<Testing#, here>>.

== Dev Ops

Refer to the guide <<DevOps#, here>>.

[appendix]
== Product Scope

*Target user profile*:

* wishes to lead a healthier lifestyle
* has trouble thinking about what to cook
* prefer desktop apps over other types
* can type fast
* prefers typing over mouse input
* is reasonably comfortable using CLI apps

*Value proposition*:

[appendix]
== User Stories

Priorities: High (must have) - `* * \\*`, Medium (nice to have) - `* \\*`, Low (unlikely to have) - `*`

[width=""59%"",cols=""22%,<23%,<25%,<30%"",options=""header"",]
|=======================================================================
|Priority |As a ... |I want to ... |So that I can...
|`* * *` |new user |see usage instructions |refer to instructions when I forget how to use the App

|`* * *` |picky eater |filter food preferences |cook food that matches my taste

|`* * *` |frugal user |easily search for recipes with the ingredients I already have |use up all the food in my fridge

|`* * *` |frequent user |save my favourite recipes |quickly navigate to them without having to search them up again

|`* * *` |goal-oriented student |track my progress |see how far I came and how much further I have to go to reach my goal

|`* * *` |user with many recipes in the recipe book |filter recipes by various criteria |locate a recipe easily

|`* * *` |user with allergies |exclude ingredients that I am allergic to |obtain recipes that are catered to me

|`* * *` |user struggling to eat healthier |receive motivation for eating healthy meals |stay motivated on my goal

|`* * *` |user who cooks regularly |add my own recipes with the goals they fall under |progress in my goals when I cook my own unique meals

|`* * *` |unmotivated user |choose a goal for myself |cook more meals and be motivated by my progress

|`* * *` |unmotivated user |track my streak of healthy meals |motivated to keep eating healthy

|`* * *` |user who loses motivation easily |look at daily quotes to remind myself |remember why I wanted to continue to be healthy

|`* *` |user who dislikes food wastage |see what ingredients I need to buy when I grocery shop |only buy ingredients that I will use

|`* *` |busy student |get a list of the ingredients I need for the week in one go |save time and not make wasted trips

|`* *` |busy student |pre-select meals for certain days |save time from ruminating over what to cook

|`* *` |bodybuilder |search for protein-rich recipes specifically |build my muscles

|`* *` |busy student |filter recipes by preparation time |choose meals that can be done quickly

|`* *` |avid planner |choose recipes and place them in a timetable for the week |plan my meals beforehand

|`*` |novice cook |filter recipes by difficulty level |select easier recipes

|`*` |user who is passionate about cooking |share the recipes on social media |show my friends what I have cooked today

|`*` |adventurous user |filter the recipes by cuisine |try a new cuisine every time

|`*` |user who prefers hard-copy materials |save my favourite recipes locally |print them out

|`*` |frequent party host |scale up the amount of ingredients needed |make the correct amount of food

|`*` |student on budget |choose recipes that require lower cost |save money

|`*` |adventurous user |ask for suggested recipes |choose a random recipe and start cooking

|`*` |adventurous user |mix up recipes |try something completely new

|`*` |motivational user |add custom quotes to app online |motivate other users with different quotes

|=======================================================================

_{More to be added}_

[appendix]
== Use Cases

(For all use cases below, the *System* is `HealthyBaby` and the *Actor* is the `user`, unless specified otherwise)

[discrete]
=== Use case: Add recipe

*MSS*

1.  User requests to add recipe
2.  HealthyBaby creates a new recipe with the specified name
+
Use case ends.

*Extensions*

[none]
* 2a. The name/time/ingredients fields are empty.
+
[none]
** 2a1. HealthyBaby shows an error message.
+
Use case resumes at step 1.

[none]
* 2b. The given name already exists.
+
[none]
** 2b1. HealthyBaby shows an error message.
+
Use case resumes at step 1.

* 2c. The user tries to add goals that do not exist in the goals list.
+
[none]
** 2c1. HealthyBaby shows an error message.
+
Use case resumes at step 1.

[discrete]
=== Use case: Delete recipe

*MSS*

1.  User requests to list recipes
2.  HealthyBaby shows a list of recipes
3.  User requests to delete a specific recipe in the list
4.  HealthyBaby deletes the recipe
+
Use case ends.

*Extensions*

[none]
* 2a. The list is empty.
+
Use case ends.

* 3a. The given index is invalid.
+
[none]
** 3a1. RecipeBook shows an error message.
+
Use case resumes at step 2.

[discrete]
=== Use case: Add goal

*MSS*

1.  User requests to see list of goals
2.  HealthyBaby shows a list of goals
3.  User requests to add a specific goal in the list
4.  HealthyBaby starts tracking the goal
+
Use case ends.

*Extensions*

[none]
* 2a. The list is empty.
+
Use case ends.

[none]
* 3a. The given goal is invalid.
+
[none]
** 3a1. HealthyBaby shows an error message.
+
Use case resumes at step 2.

* 3b. The given goal is already being tracked.
+
[none]
** 3b1. HealthyBaby shows an error message.
+
Use case resumes at step 2.

[discrete]
=== Use case: Find recipe

*MSS*

1.  User enters desired recipe name into CLI
2.  HealthyBaby shows the desired recipe
+
Use case ends.

*Extensions*

[none]
* 2a. The desired recipe name does not exist in the list.
+
[none]
** 2a1. HealthyBaby shows an error message.
+
Use case ends.

[discrete]
=== Use case: Schedule a recipe

*MSS*

1.  User enters which recipe index and date they would like to schedule
2.  HealthyBaby shows the recipe scheduled under the given date
+
Use case ends.

*Extensions*

[none]
* 2a. The given recipe index is invalid.
+
[none]
** 2a1. HealthyBaby shows an error message.
+
Use case ends.

[none]
* 2b. The given date is invalid.
+
[none]
** 2b1. HealthyBaby shows an error message.
+
Use case ends.

[discrete]
=== Use case: Clear entire recipe list

*MSS*

1.  User enters the clear command
2.  User will be prompted with a confirmation question
3.  User inputs ""Y"" (Yes) to confirm decision
4.  HealthyBaby clears the entire recipe list
+
Use case ends.

*Extensions*

[none]
* 3a. User inputs ""N"" (No) to cancel the clear command.
+
Use case ends.

[none]
* 3b. User inputs an invalid response to the confirmation question.
+
[none]
** 3b1. HealthyBaby shows an error message.
+
Use case resumes at step 2.

[discrete]
=== Use case: Compare prices

*MSS*

1.  User requests to compare prices
2.  HealthyBaby shows price of food delivery vs user cooking the food themselves with the specified name
+
Use case ends.

*Extensions*

[none]
* 2a. The name/time/ingredients fields are empty.
+
[none]
** 2a1. HealthyBaby shows an error message.
+
Use case resumes at step 2.


[none]
* 2b. The given food does not exists in database.
+
[none]
** 2b1. HealthyBaby shows an error message.
+
Use case resumes at step 2.

* 2c. The given food is not available in delivery services.
+
[none]
** 2c1. HealthyBaby shows an error message.
+
Use case resumes at step 1.


_{More to be added}_

[appendix]
== Non Functional Requirements

.  Should work on any <<mainstream-os,mainstream OS>> as long as it has Java `11` or above installed.
.  Should be able to hold up to 1000 recipes without a noticeable sluggishness in performance for typical usage.
.  A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
.  The software should be portable (i.e. works on and can be moved to different operating systems)

_{More to be added}_

[appendix]
== Glossary

[[mainstream-os]] Mainstream OS::
Windows, Linux, Unix, OS-X

[[private-contact-detail]] Private contact detail::
A contact detail that is not meant to be shared with others

[appendix]
== Product Survey

*Product Name*

Author: ...

Pros:

* ...
* ...

Cons:

* ...
* ...

[appendix]
== Instructions for Manual Testing

Given below are instructions to test the app manually.

[NOTE]
These instructions only provide a starting point for testers to work on; testers are expected to do more _exploratory_ testing.

=== Launch and Shutdown

. Initial launch

.. Download the jar file and copy into an empty folder
.. Double-click the jar file +
   Expected: Shows the GUI with a set of sample contacts. The window size may not be optimum.

. Saving window preferences

.. Resize the window to an optimum size. Move the window to a different location. Close the window.
.. Re-launch the app by double-clicking the jar file. +
   Expected: The most recent window size and location is retained.

_{ more test cases ... }_

=== Deleting a recipe

. Deleting a recipe while all recipes are listed

.. Prerequisites: List all recipes using the `list` command. Multiple recipes in the list.
.. Test case: `delete 1` +
   Expected: First contact is deleted from the list. Details of the deleted contact shown in the status message. Timestamp in the status bar is updated.
.. Test case: `delete 0` +
   Expected: No recipe is deleted. Error details shown in the status message. Status bar remains the same.
.. Other incorrect delete commands to try: `delete`, `delete x` (where x is larger than the list size) _{give more}_ +
   Expected: Similar to previous.

_{ more test cases ... }_

=== Saving data

. Dealing with missing/corrupted data files

.. _{explain how to simulate a missing/corrupted file and the expected behavior}_

_{ more test cases ... }_
",12180,False,1968.4148498812522,median
"// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_content-type: ASSEMBLY
[id=""daemonset-apps-v1""]
= DaemonSet [apps/v1]
ifdef::product-title[]
include::modules/common-attributes.adoc[]
endif::[]

toc::[]


Description::
+
--
DaemonSet represents the configuration of a daemon set.
--

Type::
  `object`



== Specification

[cols=""1,1,1"",options=""header""]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

| `kind`
| `string`
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

| `metadata`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| DaemonSetSpec is the specification of a daemon set.

| `status`
| `object`
| DaemonSetStatus represents the current status of a daemon set.

|===
=== .spec
Description::
+
--
DaemonSetSpec is the specification of a daemon set.
--

Type::
  `object`

Required::
  - `selector`
  - `template`



[cols=""1,1,1"",options=""header""]
|===
| Property | Type | Description

| `minReadySeconds`
| `integer`
| The minimum number of seconds for which a newly created DaemonSet pod should be ready without any of its container crashing, for it to be considered available. Defaults to 0 (pod will be considered available as soon as it is ready).

| `revisionHistoryLimit`
| `integer`
| The number of old history to retain to allow rollback. This is a pointer to distinguish between explicit zero and not specified. Defaults to 10.

| `selector`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector[`LabelSelector`]
| A label query over pods that are managed by the daemon set. Must match in order to be controlled. It must match the pod template's labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

| `template`
| xref:../objects/index.adoc#io.k8s.api.core.v1.PodTemplateSpec[`PodTemplateSpec`]
| An object that describes the pod that will be created. The DaemonSet will create exactly one copy of this pod on every node that matches the template's node selector (or on every node if no node selector is specified). More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template

| `updateStrategy`
| `object`
| DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.

|===
=== .spec.updateStrategy
Description::
+
--
DaemonSetUpdateStrategy is a struct used to control the update strategy for a DaemonSet.
--

Type::
  `object`




[cols=""1,1,1"",options=""header""]
|===
| Property | Type | Description

| `rollingUpdate`
| `object`
| Spec to control the desired behavior of daemon set rolling update.

| `type`
| `string`
| Type of daemon set update. Can be ""RollingUpdate"" or ""OnDelete"". Default is RollingUpdate.

|===
=== .spec.updateStrategy.rollingUpdate
Description::
+
--
Spec to control the desired behavior of daemon set rolling update.
--

Type::
  `object`




[cols=""1,1,1"",options=""header""]
|===
| Property | Type | Description

| `maxSurge`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`]
| The maximum number of nodes with an existing available DaemonSet pod that can have an updated DaemonSet pod during during an update. Value can be an absolute number (ex: 5) or a percentage of desired pods (ex: 10%). This can not be 0 if MaxUnavailable is 0. Absolute number is calculated from percentage by rounding up to a minimum of 1. Default value is 0. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their a new pod created before the old pod is marked as deleted. The update starts by launching new pods on 30% of nodes. Once an updated pod is available (Ready for at least minReadySeconds) the old DaemonSet pod on that node is marked deleted. If the old pod becomes unavailable for any reason (Ready transitions to false, is evicted, or is drained) an updated pod is immediatedly created on that node without considering surge limits. Allowing surge implies the possibility that the resources consumed by the daemonset on any given node can double if the readiness check fails, and so resource intensive daemonsets should take into account that they may cause evictions during disruption. This is beta field and enabled/disabled by DaemonSetUpdateSurge feature gate.

| `maxUnavailable`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.util.intstr.IntOrString[`IntOrString`]
| The maximum number of DaemonSet pods that can be unavailable during the update. Value can be an absolute number (ex: 5) or a percentage of total number of DaemonSet pods at the start of the update (ex: 10%). Absolute number is calculated from percentage by rounding up. This cannot be 0 if MaxSurge is 0 Default value is 1. Example: when this is set to 30%, at most 30% of the total number of nodes that should be running the daemon pod (i.e. status.desiredNumberScheduled) can have their pods stopped for an update at any given time. The update starts by stopping at most 30% of those DaemonSet pods and then brings up new DaemonSet pods in their place. Once the new pods are available, it then proceeds onto other DaemonSet pods, thus ensuring that at least 70% of original number of DaemonSet pods are available at all times during the update.

|===
=== .status
Description::
+
--
DaemonSetStatus represents the current status of a daemon set.
--

Type::
  `object`

Required::
  - `currentNumberScheduled`
  - `numberMisscheduled`
  - `desiredNumberScheduled`
  - `numberReady`



[cols=""1,1,1"",options=""header""]
|===
| Property | Type | Description

| `collisionCount`
| `integer`
| Count of hash collisions for the DaemonSet. The DaemonSet controller uses this field as a collision avoidance mechanism when it needs to create the name for the newest ControllerRevision.

| `conditions`
| `array`
| Represents the latest available observations of a DaemonSet's current state.

| `conditions[]`
| `object`
| DaemonSetCondition describes the state of a DaemonSet at a certain point.

| `currentNumberScheduled`
| `integer`
| The number of nodes that are running at least 1 daemon pod and are supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

| `desiredNumberScheduled`
| `integer`
| The total number of nodes that should be running the daemon pod (including nodes correctly running the daemon pod). More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

| `numberAvailable`
| `integer`
| The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and available (ready for at least spec.minReadySeconds)

| `numberMisscheduled`
| `integer`
| The number of nodes that are running the daemon pod, but are not supposed to run the daemon pod. More info: https://kubernetes.io/docs/concepts/workloads/controllers/daemonset/

| `numberReady`
| `integer`
| The number of nodes that should be running the daemon pod and have one or more of the daemon pod running and ready.

| `numberUnavailable`
| `integer`
| The number of nodes that should be running the daemon pod and have none of the daemon pod running and available (ready for at least spec.minReadySeconds)

| `observedGeneration`
| `integer`
| The most recent generation observed by the daemon set controller.

| `updatedNumberScheduled`
| `integer`
| The total number of nodes that are running updated daemon pod

|===
=== .status.conditions
Description::
+
--
Represents the latest available observations of a DaemonSet's current state.
--

Type::
  `array`




=== .status.conditions[]
Description::
+
--
DaemonSetCondition describes the state of a DaemonSet at a certain point.
--

Type::
  `object`

Required::
  - `type`
  - `status`



[cols=""1,1,1"",options=""header""]
|===
| Property | Type | Description

| `lastTransitionTime`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Time[`Time`]
| Last time the condition transitioned from one status to another.

| `message`
| `string`
| A human readable message indicating details about the transition.

| `reason`
| `string`
| The reason for the condition's last transition.

| `status`
| `string`
| Status of the condition, one of True, False, Unknown.

| `type`
| `string`
| Type of DaemonSet condition.

|===

== API endpoints

The following API endpoints are available:

* `/apis/apps/v1/daemonsets`
- `GET`: list or watch objects of kind DaemonSet
* `/apis/apps/v1/watch/daemonsets`
- `GET`: watch individual changes to a list of DaemonSet. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.
* `/apis/apps/v1/namespaces/{namespace}/daemonsets`
- `DELETE`: delete collection of DaemonSet
- `GET`: list or watch objects of kind DaemonSet
- `POST`: create a DaemonSet
* `/apis/apps/v1/watch/namespaces/{namespace}/daemonsets`
- `GET`: watch individual changes to a list of DaemonSet. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.
* `/apis/apps/v1/namespaces/{namespace}/daemonsets/{name}`
- `DELETE`: delete a DaemonSet
- `GET`: read the specified DaemonSet
- `PATCH`: partially update the specified DaemonSet
- `PUT`: replace the specified DaemonSet
* `/apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}`
- `GET`: watch changes to an object of kind DaemonSet. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead, filtered to a single item with the &#x27;fieldSelector&#x27; parameter.
* `/apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status`
- `GET`: read status of the specified DaemonSet
- `PATCH`: partially update status of the specified DaemonSet
- `PUT`: replace status of the specified DaemonSet


=== /apis/apps/v1/daemonsets


.Global query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `allowWatchBookmarks`
| `boolean`
| allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#x27;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
| `continue`
| `string`
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
| `fieldSelector`
| `string`
| A selector to restrict the list of returned objects by their fields. Defaults to everything.
| `labelSelector`
| `string`
| A selector to restrict the list of returned objects by their labels. Defaults to everything.
| `limit`
| `integer`
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
| `resourceVersion`
| `string`
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `resourceVersionMatch`
| `string`
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `timeoutSeconds`
| `integer`
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
| `watch`
| `boolean`
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

HTTP method::
  `GET`

Description::
  list or watch objects of kind DaemonSet


.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io.k8s.api.apps.v1.DaemonSetList[`DaemonSetList`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/apps/v1/watch/daemonsets


.Global query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `allowWatchBookmarks`
| `boolean`
| allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#x27;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
| `continue`
| `string`
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
| `fieldSelector`
| `string`
| A selector to restrict the list of returned objects by their fields. Defaults to everything.
| `labelSelector`
| `string`
| A selector to restrict the list of returned objects by their labels. Defaults to everything.
| `limit`
| `integer`
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
| `resourceVersion`
| `string`
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `resourceVersionMatch`
| `string`
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `timeoutSeconds`
| `integer`
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
| `watch`
| `boolean`
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

HTTP method::
  `GET`

Description::
  watch individual changes to a list of DaemonSet. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.


.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/apps/v1/namespaces/{namespace}/daemonsets

.Global path parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `namespace`
| `string`
| object name and auth scope, such as for teams and projects
|===

.Global query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
|===

HTTP method::
  `DELETE`

Description::
  delete collection of DaemonSet


.Query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `continue`
| `string`
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldSelector`
| `string`
| A selector to restrict the list of returned objects by their fields. Defaults to everything.
| `gracePeriodSeconds`
| `integer`
| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
| `labelSelector`
| `string`
| A selector to restrict the list of returned objects by their labels. Defaults to everything.
| `limit`
| `integer`
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
| `orphanDependents`
| `boolean`
| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#x27;s finalizers list. Either this field or PropagationPolicy may be set, but not both.
| `propagationPolicy`
| `string`
| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#x27;Orphan&#x27; - orphan the dependents; &#x27;Background&#x27; - allow the garbage collector to delete the dependents in the background; &#x27;Foreground&#x27; - a cascading policy that deletes all dependents in the foreground.
| `resourceVersion`
| `string`
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `resourceVersionMatch`
| `string`
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `timeoutSeconds`
| `integer`
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
|===

.Body parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `body`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema
| 
|===

.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  list or watch objects of kind DaemonSet


.Query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `allowWatchBookmarks`
| `boolean`
| allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#x27;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
| `continue`
| `string`
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
| `fieldSelector`
| `string`
| A selector to restrict the list of returned objects by their fields. Defaults to everything.
| `labelSelector`
| `string`
| A selector to restrict the list of returned objects by their labels. Defaults to everything.
| `limit`
| `integer`
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
| `resourceVersion`
| `string`
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `resourceVersionMatch`
| `string`
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `timeoutSeconds`
| `integer`
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
| `watch`
| `boolean`
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===


.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io.k8s.api.apps.v1.DaemonSetList[`DaemonSetList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a DaemonSet


.Query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldManager`
| `string`
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
|===

.Body parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `body`
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 
|===

.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 201 - Created
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 202 - Accepted
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/apps/v1/watch/namespaces/{namespace}/daemonsets

.Global path parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `namespace`
| `string`
| object name and auth scope, such as for teams and projects
|===

.Global query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `allowWatchBookmarks`
| `boolean`
| allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#x27;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
| `continue`
| `string`
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
| `fieldSelector`
| `string`
| A selector to restrict the list of returned objects by their fields. Defaults to everything.
| `labelSelector`
| `string`
| A selector to restrict the list of returned objects by their labels. Defaults to everything.
| `limit`
| `integer`
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
| `resourceVersion`
| `string`
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `resourceVersionMatch`
| `string`
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `timeoutSeconds`
| `integer`
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
| `watch`
| `boolean`
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

HTTP method::
  `GET`

Description::
  watch individual changes to a list of DaemonSet. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead.


.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}

.Global path parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the DaemonSet
| `namespace`
| `string`
| object name and auth scope, such as for teams and projects
|===

.Global query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
|===

HTTP method::
  `DELETE`

Description::
  delete a DaemonSet


.Query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `gracePeriodSeconds`
| `integer`
| The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
| `orphanDependents`
| `boolean`
| Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the &quot;orphan&quot; finalizer will be added to/removed from the object&#x27;s finalizers list. Either this field or PropagationPolicy may be set, but not both.
| `propagationPolicy`
| `string`
| Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: &#x27;Orphan&#x27; - orphan the dependents; &#x27;Background&#x27; - allow the garbage collector to delete the dependents in the background; &#x27;Foreground&#x27; - a cascading policy that deletes all dependents in the foreground.
|===

.Body parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `body`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.DeleteOptions[`DeleteOptions`] schema
| 
|===

.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified DaemonSet


.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified DaemonSet


.Query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldManager`
| `string`
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
| `force`
| `boolean`
| Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
|===

.Body parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `body`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema
| 
|===

.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 201 - Created
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified DaemonSet


.Query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldManager`
| `string`
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
|===

.Body parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `body`
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 
|===

.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 201 - Created
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/apps/v1/watch/namespaces/{namespace}/daemonsets/{name}

.Global path parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the DaemonSet
| `namespace`
| `string`
| object name and auth scope, such as for teams and projects
|===

.Global query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `allowWatchBookmarks`
| `boolean`
| allowWatchBookmarks requests watch events with type &quot;BOOKMARK&quot;. Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server&#x27;s discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.
| `continue`
| `string`
| The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the &quot;next key&quot;.

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
| `fieldSelector`
| `string`
| A selector to restrict the list of returned objects by their fields. Defaults to everything.
| `labelSelector`
| `string`
| A selector to restrict the list of returned objects by their labels. Defaults to everything.
| `limit`
| `integer`
| limit is a maximum number of responses to return for a list call. If more items exist, the server will set the &#x60;continue&#x60; field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
| `resourceVersion`
| `string`
| resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `resourceVersionMatch`
| `string`
| resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset
| `timeoutSeconds`
| `integer`
| Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.
| `watch`
| `boolean`
| Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

HTTP method::
  `GET`

Description::
  watch changes to an object of kind DaemonSet. deprecated: use the &#x27;watch&#x27; parameter with a list operation instead, filtered to a single item with the &#x27;fieldSelector&#x27; parameter.


.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.WatchEvent[`WatchEvent`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/apps/v1/namespaces/{namespace}/daemonsets/{name}/status

.Global path parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the DaemonSet
| `namespace`
| `string`
| object name and auth scope, such as for teams and projects
|===

.Global query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `pretty`
| `string`
| If &#x27;true&#x27;, then the output is pretty printed.
|===

HTTP method::
  `GET`

Description::
  read status of the specified DaemonSet


.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified DaemonSet


.Query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldManager`
| `string`
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint. This field is required for apply requests (application/apply-patch) but optional for non-apply patch types (JsonPatch, MergePatch, StrategicMergePatch).
| `force`
| `boolean`
| Force is going to &quot;force&quot; Apply requests. It means user will re-acquire conflicting fields owned by other people. Force flag must be unset for non-apply patch requests.
|===

.Body parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `body`
| xref:../objects/index.adoc#io.k8s.apimachinery.pkg.apis.meta.v1.Patch[`Patch`] schema
| 
|===

.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 201 - Created
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified DaemonSet


.Query parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldManager`
| `string`
| fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.
|===

.Body parameters
[cols=""1,1,2"",options=""header""]
|===
| Parameter | Type | Description
| `body`
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 
|===

.HTTP responses
[cols=""1,1"",options=""header""]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 201 - Created
| xref:../workloads_apis/daemonset-apps-v1.adoc#daemonset-apps-v1[`DaemonSet`] schema
| 401 - Unauthorized
| Empty
|===


",12174,True,2983.4593529065564,median
"[[documenting-your-api]]
== Documenting your API

This section provides more details about using Spring REST Docs to document your API.



[[documenting-your-api-hypermedia]]
=== Hypermedia

Spring REST Docs provides support for documenting the links in a
https://en.wikipedia.org/wiki/HATEOAS[hypermedia-based] API.
The following examples show how to use it:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Hypermedia.java[tag=links]
----
<1> Configure Spring REST docs to produce a snippet describing the response's links.
	Uses the static `links` method on
	`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.
<2> Expect a link whose `rel` is `alpha`. Uses the static `linkWithRel` method on
	`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.
<3> Expect a link whose `rel` is `bravo`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Hypermedia.java[tag=links]
----
<1> Configure Spring REST docs to produce a snippet describing the response's links.
	Uses the static `links` method on
	`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.
<2> Expect a link whose `rel` is `alpha`. Uses the static `linkWithRel` method on
	`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.
<3> Expect a link whose `rel` is `bravo`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Hypermedia.java[tag=links]
----
<1> Configure Spring REST docs to produce a snippet describing the response's links.
	Uses the static `links` method on
	`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.
<2> Expect a link whose `rel` is `alpha`. Uses the static `linkWithRel` method on
	`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.
<3> Expect a link whose `rel` is `bravo`.
====

The result is a snippet named `links.adoc` that contains a table describing the resource's
links.

TIP: If a link in the response has a `title`, you can omit the description from its
descriptor and the `title` is used. If you omit the description and the link does
not have a `title`, a failure occurs.

When documenting links, the test fails if an undocumented link is found in the
response. Similarly, the test also fails if a documented link is not found in the
response and the link has not been marked as optional.

If you do not want to document a link, you can mark it as ignored. Doing so prevents it
from appearing in the generated snippet while avoiding the failure described above.

You can also document links in a relaxed mode, where any undocumented links do not cause
a test failure. To do so, use the `relaxedLinks` method on
`org.springframework.restdocs.hypermedia.HypermediaDocumentation`. This can be useful when
documenting a particular scenario where you only want to focus on a subset of the links.



[[documenting-your-api-hypermedia-link-formats]]
==== Hypermedia Link Formats

Two link formats are understood by default:

* Atom: Links are expected to be in an array named `links`. This is used by default when
  the content type of the response is compatible with `application/json`.
* HAL: Links are expected to be in a map named `_links`. This is used by default when the
  content type of the response is compatible with `application/hal+json`.

If you use Atom- or HAL-format links but with a different content type, you can provide
one of the built-in `LinkExtractor` implementations to `links`. The following examples
show how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Hypermedia.java[tag=explicit-extractor]
----
<1> Indicate that the links are in HAL format. Uses the static `halLinks` method on
`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Hypermedia.java[tag=explicit-extractor]
----
<1> Indicate that the links are in HAL format. Uses the static `halLinks` method on
`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Hypermedia.java[tag=explicit-extractor]
----
<1> Indicate that the links are in HAL format. Uses the static `halLinks` method on
`org.springframework.restdocs.hypermedia.HypermediaDocumentation`.
====

If your API represents its links in a format other than Atom or HAL, you can provide your
own implementation of the `LinkExtractor` interface to extract the links from the
response.



[[documenting-your-api-hypermedia-ignoring-common-links]]
==== Ignoring Common Links

Rather than documenting links that are common to every response, such as `self` and
`curies` when using HAL, you may want to document them once in an overview section and
then ignore them in the rest of your API's documentation. To do so, you can build on the
<<documenting-your-api-reusing-snippets,support for reusing snippets>> to add link
descriptors to a snippet that is preconfigured to ignore certain links. The following
example shows how to do so:

====
[source,java,indent=0]
----
include::{examples-dir}/com/example/Hypermedia.java[tags=ignore-links]
----
====



[[documenting-your-api-request-response-payloads]]
=== Request and Response Payloads

In addition to the hypermedia-specific support <<documenting-your-api-hypermedia,described
earlier>>, support for general documentation of request and response payloads is also
provided.

By default, Spring REST Docs automatically generates snippets for the body of the request
and the body of the response. These snippets are named `request-body.adoc` and
`response-body.adoc` respectively.



[[documenting-your-api-request-response-payloads-fields]]
==== Request and Response Fields

To provide more detailed documentation of a request or response payload, support for
documenting the payload's fields is provided.

Consider the following payload:

====
[source,json,indent=0]
----
	{
		""contact"": {
			""name"": ""Jane Doe"",
			""email"": ""jane.doe@example.com""
		}
	}
----
====

You can document the previous example's fields as follows:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Payload.java[tags=response]
----
<1> Configure Spring REST docs to produce a snippet describing the fields in the response
	payload. To document a request, you can use `requestFields`. Both are static methods
	on `org.springframework.restdocs.payload.PayloadDocumentation`.
<2> Expect a field with the path `contact.email`. Uses the static `fieldWithPath` method
	on `org.springframework.restdocs.payload.PayloadDocumentation`.
<3> Expect a field with the path `contact.name`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Payload.java[tags=response]
----
<1> Configure Spring REST docs to produce a snippet describing the fields in the response
	payload. To document a request, you can use `requestFields`. Both are static methods
	on `org.springframework.restdocs.payload.PayloadDocumentation`.
<2> Expect a field with the path `contact.email`. Uses the static `fieldWithPath` method
	on `org.springframework.restdocs.payload.PayloadDocumentation`.
<3> Expect a field with the path `contact.name`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Payload.java[tags=response]
----
<1> Configure Spring REST docs to produce a snippet describing the fields in the response
	payload. To document a request, you can use `requestFields`. Both are static methods
	on `org.springframework.restdocs.payload.PayloadDocumentation`.
<2> Expect a field with the path `contact.email`. Uses the static `fieldWithPath` method
	on `org.springframework.restdocs.payload.PayloadDocumentation`.
<3> Expect a field with the path `contact.name`.
====

The result is a snippet that contains a table describing the fields. For requests, this
snippet is named `request-fields.adoc`. For responses, this snippet is named
`response-fields.adoc`.

When documenting fields, the test fails if an undocumented field is found in the payload.
Similarly, the test also fails if a documented field is not found in the payload and the
field has not been marked as optional.

If you do not want to provide detailed documentation for all of the fields, an entire
subsection of a payload can be documented. The following examples show how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Payload.java[tags=subsection]
----
<1> Document the subsection with the path `contact`. `contact.email` and `contact.name`
	are now seen as having also been documented. Uses the static `subsectionWithPath`
	method on `org.springframework.restdocs.payload.PayloadDocumentation`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Payload.java[tags=subsection]
----
<1> Document the subsection with the path `contact`. `contact.email` and `contact.name`
	are now seen as having also been documented. Uses the static `subsectionWithPath`
	method on `org.springframework.restdocs.payload.PayloadDocumentation`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Payload.java[tags=subsection]
----
<1> Document the subsection with the path `contact`. `contact.email` and `contact.name`
	are now seen as having also been documented. Uses the static `subsectionWithPath`
	method on `org.springframework.restdocs.payload.PayloadDocumentation`.
====

`subsectionWithPath` can be useful for providing a high-level overview of a particular
section of a payload. You can then produce separate, more detailed documentation for a
subsection. See <<documenting-your-api-request-response-payloads-subsections>>.

If you do not want to document a field or subsection at all, you can mark it as ignored.
This prevents it from appearing in the generated snippet while avoiding the failure
described earlier.

You can also document fields in a relaxed mode, where any undocumented fields do not
cause a test failure. To do so, use the `relaxedRequestFields` and `relaxedResponseFields`
methods on
`org.springframework.restdocs.payload.PayloadDocumentation`. This can be useful when
documenting a particular scenario where you want to focus only on a subset of the payload.

TIP: By default, Spring REST Docs assumes that the payload you are documenting is JSON.
If you want to document an XML payload, the content type of the request or response must
be compatible with `application/xml`.

[[documenting-your-api-request-response-payloads-fields-json]]
===== Fields in JSON Payloads

This section descries how to work with fields in JSON payloads.

[[documenting-your-api-request-response-payloads-fields-json-field-paths]]
====== JSON Field Paths

JSON field paths use either dot notation or bracket notation. Dot notation uses '.' to
separate each key in the path (for example, `a.b`). Bracket notation wraps each key in
square brackets and single quotation marks (for example, `['a']['b']`). In either case,
`[]` is used to identify an array. Dot notation is more concise, but using bracket
notation enables the use of `.` within a key name (for example, `['a.b']`). The two
different notations can be used in the same path (for example, `a['b']`).

Consider the following JSON payload:

====
[source,json,indent=0]
----
	{
		""a"":{
			""b"":[
				{
					""c"":""one""
				},
				{
					""c"":""two""
				},
				{
					""d"":""three""
				}
			],
			""e.dot"" : ""four""
		}
	}
----
====

In the preceding JSON payload, the following paths are all present:

[cols=""1,3""]
|===
|Path | Value

|`a`
|An object containing `b`

|`a.b`
|An array containing three objects

|`['a']['b']`
|An array containing three objects

|`a['b']`
|An array containing three objects

|`['a'].b`
|An array containing three objects

|`a.b[]`
|An array containing three objects

|`a.b[].c`
|An array containing the strings `one` and `two`

|`a.b[].d`
|The string `three`

|`a['e.dot']`
|The string `four`

|`['a']['e.dot']`
|The string `four`

|===

You can also document a payload that uses an array at its root. The path `[]` refers
to the entire array. You can then use bracket or dot notation to identify fields within
the array's entries. For example, `[].id` corresponds to the `id` field of every object
found in the following array:

====
[source,json,indent=0]
----
	[
		{
			""id"":1
		},
		{
			""id"":2
		}
	]
----
====

You can use `\\*` as a wildcard to match fields with different names. For example,
`users.*.role` could be used to document the role of every user in the following JSON:

====
[source,json,indent=0]
----
	{
		""users"":{
			""ab12cd34"":{
				""role"": ""Administrator""
			},
			""12ab34cd"":{
				""role"": ""Guest""
			}
		}
	}
----
====

[[documenting-your-api-request-response-payloads-fields-json-field-types]]
====== JSON Field Types

When a field is documented, Spring REST Docs tries to determine its type by examining the
payload. Seven different types are supported:

[cols=""1,3""]
|===
| Type | Description

| `array`
| The value of each occurrence of the field is an array.

| `boolean`
| The value of each occurrence of the field is a boolean (`true` or `false`).

| `object`
| The value of each occurrence of the field is an object.

| `number`
| The value of each occurrence of the field is a number.

| `null`
| The value of each occurrence of the field is `null`.

| `string`
| The value of each occurrence of the field is a string.

| `varies`
| The field occurs multiple times in the payload with a variety of different types.
|===

You can also explicitly set the type by using the `type(Object)` method on
`FieldDescriptor`. The result of the `toString` method of the supplied `Object` is used
in the documentation. Typically, one of the values enumerated by `JsonFieldType` is used.
The following examples show how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Payload.java[tags=explicit-type]
----
<1> Set the field's type to `String`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Payload.java[tags=explicit-type]
----
<1> Set the field's type to `String`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Payload.java[tags=explicit-type]
----
<1> Set the field's type to `String`.
====


[[documenting-your-api-request-response-payloads-fields-xml]]
===== XML payloads

This section describes how to work with XML payloads.

[[documenting-your-api-request-response-payloads-fields-xml-field-paths]]
====== XML Field Paths

XML field paths are described using XPath. `/` is used to descend into a child node.



[[documenting-your-api-request-response-payloads-fields-xml-field-types]]
====== XML Field Types

When documenting an XML payload, you must provide a type for the field by using the
`type(Object)` method on `FieldDescriptor`. The result of the supplied type's `toString`
method is used in the documentation.



[[documenting-your-api-request-response-payloads-fields-reusing-field-descriptors]]
===== Reusing Field Descriptors

In addition to the general support for <<documenting-your-api-reusing-snippets,reusing
snippets>>, the request and response snippets let additional descriptors be configured
with a path prefix. This lets the descriptors for a repeated portion of a request or
response payload be created once and then reused.

Consider an endpoint that returns a book:

====
[source,json,indent=0]
----
	{
		""title"": ""Pride and Prejudice"",
		""author"": ""Jane Austen""
	}
----
====

The paths for `title` and `author` are `title` and `author`, respectively.

Now consider an endpoint that returns an array of books:

====
[source,json,indent=0]
----
	[{
		""title"": ""Pride and Prejudice"",
		""author"": ""Jane Austen""
	},
	{
		""title"": ""To Kill a Mockingbird"",
		""author"": ""Harper Lee""
	}]
----
====

The paths for `title` and `author` are `[].title` and `[].author`, respectively. The only
difference between the single book and the array of books is that the fields' paths now
have a `[].` prefix.

You can create the descriptors that document a book as follows:

====
[source,java,indent=0]
----
include::{examples-dir}/com/example/Payload.java[tags=book-descriptors]
----
====

You can then use them to document a single book, as follows:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Payload.java[tags=single-book]
----
<1> Document `title` and `author` by using existing descriptors

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Payload.java[tags=single-book]
----
<1> Document `title` and `author` by using existing descriptors

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Payload.java[tags=single-book]
----
<1> Document `title` and `author` by using existing descriptors
====

You can also use the descriptors to document an array of books, as follows:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Payload.java[tags=book-array]
----
<1> Document the array.
<2> Document `[].title` and `[].author` by using the existing descriptors prefixed with
	`[].`

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Payload.java[tags=book-array]
----
<1> Document the array.
<2> Document `[].title` and `[].author` by using the existing descriptors prefixed with
	`[].`

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Payload.java[tags=book-array]
----
<1> Document the array.
<2> Document `[].title` and `[].author` by using the existing descriptors prefixed with
	`[].`
====

[[documenting-your-api-request-response-payloads-subsections]]
==== Documenting a Subsection of a Request or Response Payload

If a payload is large or structurally complex, it can be useful to document individual
sections of the payload. REST Docs let you do so by extracting a subsection of the
payload and then documenting it.

[[documenting-your-api-request-response-payloads-subsections-body]]
===== Documenting a Subsection of a Request or Response Body

Consider the following JSON response body:

====
[source,json,indent=0]
----
	{
		""weather"": {
			""wind"": {
				""speed"": 15.3,
				""direction"": 287.0
			},
			""temperature"": {
				""high"": 21.2,
				""low"": 14.8
			}
		}
	}
----
====

You can produce a snippet that documents the `temperature` object as follows:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Payload.java[tags=body-subsection]
----
<1> Produce a snippet containing a subsection of the response body. Uses the static
	`responseBody` and `beneathPath` methods on
	`org.springframework.restdocs.payload.PayloadDocumentation`. To produce a snippet for
	the request body, you can use `requestBody` in place of `responseBody`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Payload.java[tags=body-subsection]
----
<1> Produce a snippet containing a subsection of the response body. Uses the static
	`responseBody` and `beneathPath` methods on
	`org.springframework.restdocs.payload.PayloadDocumentation`. To produce a snippet for
	the request body, you can use `requestBody` in place of `responseBody`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Payload.java[tags=body-subsection]
----
<1> Produce a snippet containing a subsection of the response body. Uses the static
	`responseBody` and `beneathPath` methods on
	`org.springframework.restdocs.payload.PayloadDocumentation`. To produce a snippet for
	the request body, you can use `requestBody` in place of `responseBody`.
====

The result is a snippet with the following contents:

====
[source,json,indent=0]
----
	{
		""temperature"": {
			""high"": 21.2,
			""low"": 14.8
		}
	}
----
====

To make the snippet's name distinct, an identifier for the subsection is included. By
default, this identifier is `beneath-${path}`. For example, the preceding code results in
a snippet named `response-body-beneath-weather.temperature.adoc`. You can customized the
identifier by using the `withSubsectionId(String)` method, as follows:

====
[source,java,indent=0]
----
include::{examples-dir}/com/example/Payload.java[tags=custom-subsection-id]
----
====

The result is a snippet named `request-body-temp.adoc`.



[[documenting-your-api-request-response-payloads-subsections-fields]]
===== Documenting the Fields of a Subsection of a Request or Response

As well as documenting a subsection of a request or response body, you can also document
the fields in a particular subsection. You can produce a snippet that documents the
fields of the `temperature` object (`high` and `low`) as follows:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Payload.java[tags=fields-subsection]
----
<1> Produce a snippet describing the fields in the subsection of the response payload
	beneath the path `weather.temperature`. Uses the static `beneathPath` method on
	`org.springframework.restdocs.payload.PayloadDocumentation`.
<2> Document the `high` and `low` fields.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Payload.java[tags=fields-subsection]
----
<1> Produce a snippet describing the fields in the subsection of the response payload
	beneath the path `weather.temperature`. Uses the static `beneathPath` method on
	`org.springframework.restdocs.payload.PayloadDocumentation`.
<2> Document the `high` and `low` fields.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Payload.java[tags=fields-subsection]
----
<1> Produce a snippet describing the fields in the subsection of the response payload
	beneath the path `weather.temperature`. Uses the static `beneathPath` method on
	`org.springframework.restdocs.payload.PayloadDocumentation`.
<2> Document the `high` and `low` fields.
====

The result is a snippet that contains a table describing the `high` and `low` fields of
`weather.temperature`. To make the snippet's name distinct, an identifier for the
subsection is included. By default, this identifier is `beneath-${path}`. For example,
the preceding code results in a snippet named
`response-fields-beneath-weather.temperature.adoc`.



[[documenting-your-api-request-parameters]]
=== Request Parameters

You can document a request's parameters by using `requestParameters`. You can include
request parameters in a `GET` request's query string. The following examples show how to
do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/RequestParameters.java[tags=request-parameters-query-string]
----
<1> Perform a `GET` request with two parameters, `page` and `per_page`, in the query
	string.
<2> Configure Spring REST Docs to produce a snippet describing the request's parameters.
	Uses the static `requestParameters` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the `page` parameter. Uses the static `parameterWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<4> Document the `per_page` parameter.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/RequestParameters.java[tags=request-parameters-query-string]
----
<1> Perform a `GET` request with two parameters, `page` and `per_page`, in the query
	string.
<2> Configure Spring REST Docs to produce a snippet describing the request's parameters.
	Uses the static `requestParameters` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the `page` parameter. Uses the static `parameterWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<4> Document the `per_page` parameter.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/RequestParameters.java[tags=request-parameters-query-string]
----
<1> Configure Spring REST Docs to  produce a snippet describing the request's parameters.
	Uses the static `requestParameters` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<2> Document the `page` parameter. Uses the static `parameterWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the `per_page` parameter.
<4> Perform a `GET` request with two parameters, `page` and `per_page`, in the query
	string.
====

You can also include request parameters as form data in the body of a POST request. The
following examples show how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/RequestParameters.java[tags=request-parameters-form-data]
----
<1> Perform a `POST` request with a single parameter, `username`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/RequestParameters.java[tags=request-parameters-form-data]
----
<1> Perform a `POST` request with a single parameter, `username`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/RequestParameters.java[tags=request-parameters-form-data]
----
<1> Configure the `username` parameter.
<2> Perform the `POST` request.
====

In all cases, the result is a snippet named `request-parameters.adoc` that contains a
table describing the parameters that are supported by the resource.

When documenting request parameters, the test fails if an undocumented request parameter
is used in the request. Similarly, the test also fails if a documented request parameter
is not found in the request and the request parameter has not been marked as optional.

If you do not want to document a request parameter, you can mark it as ignored. This
prevents it from appearing in the generated snippet while avoiding the failure described
above.

You can also document request parameters in a relaxed mode where any undocumented
parameters do not cause a test failure. To do so, use the `relaxedRequestParameters`
method on `org.springframework.restdocs.request.RequestDocumentation`. This can be useful
when documenting a particular scenario where you only want to focus on a subset of the
request parameters.



[[documenting-your-api-path-parameters]]
=== Path Parameters

You can document a request's path parameters by using `pathParameters`. The following
examples show how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/PathParameters.java[tags=path-parameters]
----
<1> Perform a `GET` request with two path parameters, `latitude` and `longitude`.
<2> Configure Spring REST Docs to produce a snippet describing the request's path
	parameters. Uses the static `pathParameters` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the parameter named `latitude`. Uses the static `parameterWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<4> Document the parameter named `longitude`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/PathParameters.java[tags=path-parameters]
----
<1> Perform a `GET` request with two path parameters, `latitude` and `longitude`.
<2> Configure Spring REST Docs to produce a snippet describing the request's path
	parameters. Uses the static `pathParameters` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the parameter named `latitude`. Uses the static `parameterWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<4> Document the parameter named `longitude`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/PathParameters.java[tags=path-parameters]
----
<1> Configure Spring REST Docs to produce a snippet describing the request's path
	parameters. Uses the static `pathParameters` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<2> Document the parameter named `latitude`. Uses the static `parameterWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the parameter named `longitude`.
<4> Perform a `GET` request with two path parameters, `latitude` and `longitude`.
====

The result is a snippet named `path-parameters.adoc` that contains a table describing
the path parameters that are supported by the resource.

TIP: If you use MockMvc, to make the path parameters available for documentation,
you must build the request by using one of the methods on
`RestDocumentationRequestBuilders` rather than `MockMvcRequestBuilders`.

When documenting path parameters, the test fails if an undocumented path parameter is
used in the request. Similarly, the test also fails if a documented path parameter is not
found in the request and the path parameter has not been marked as optional.

You can also document path parameters in a relaxed mode, where any undocumented
parameters do not cause a test failure. To do so, use the `relaxedPathParameters` method
on `org.springframework.restdocs.request.RequestDocumentation`. This can be useful when
documenting a particular scenario where you only want to focus on a subset of the path
parameters.

If you do not want to document a path parameter, you can mark it as ignored. Doing so
prevents it from appearing in the generated snippet while avoiding the failure described
earlier.



[[documenting-your-api-request-parts]]
=== Request Parts

You can use `requestParts` to document the parts of a multipart request. The following
example shows how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/RequestParts.java[tags=request-parts]
----
<1> Perform a `POST` request with a single part named `file`.
<2> Configure Spring REST Docs to produce a snippet describing the request's parts. Uses
	the static `requestParts` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the part named `file`. Uses the static `partWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/RequestParts.java[tags=request-parts]
----
<1> Perform a `POST` request with a single part named `file`.
<2> Configure Spring REST Docs to produce a snippet describing the request's parts. Uses
	the static `requestParts` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Document the part named `file`. Uses the static `partWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/RequestParts.java[tags=request-parts]
----
<1> Configure Spring REST Docs to produce a snippet describing the request's parts. Uses
	the static `requestParts` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<2> Document the part named `file`. Uses the static `partWithName` method on
	`org.springframework.restdocs.request.RequestDocumentation`.
<3> Configure the request with the part named `file`.
<4> Perform the `POST` request to `/upload`.
====

The result is a snippet named `request-parts.adoc` that contains a table describing the
request parts that are supported by the resource.

When documenting request parts, the test fails if an undocumented part is used in the
request. Similarly, the test also fails if a documented part is not found in the request
and the part has not been marked as optional.

You can also document request parts in a relaxed mode where any undocumented parts do not
cause a test failure. To do so, use the `relaxedRequestParts` method on
`org.springframework.restdocs.request.RequestDocumentation`. This can be useful
when documenting a particular scenario where you only want to focus on a subset of the
request parts.

If you do not want to document a request part, you can mark it as ignored. This prevents
it from appearing in the generated snippet while avoiding the failure described earlier.


[[documenting-your-api-request-parts-payloads]]
=== Request Part Payloads

You can document the payload of a request part in much the same way as the
<<documenting-your-api-request-response-payloads,payload of a request>>, with support
for documenting a request part's body and its fields.



[[documenting-your-api-request-parts-payloads-body]]
==== Documenting a Request Part's Body

You can generate a snippet containing the body of a request part as follows:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/RequestPartPayload.java[tags=body]
----
<1> Configure Spring REST docs to produce a snippet containing the body of the request
	part named `metadata`. Uses the static `requestPartBody` method on
	`PayloadDocumentation`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/RequestPartPayload.java[tags=body]
----
<1> Configure Spring REST docs to produce a snippet containing the body of the request
	part named `metadata`. Uses the static `requestPartBody` method on
	`PayloadDocumentation`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/RequestPartPayload.java[tags=body]
----
<1> Configure Spring REST docs to produce a snippet containing the body of the request
	part named `metadata`. Uses the static `requestPartBody` method on
	`PayloadDocumentation`.
====

The result is a snippet named `request-part-${part-name}-body.adoc` that contains the
part's body. For example, documenting a part named `metadata` produces a snippet named
`request-part-metadata-body.adoc`.



[[documenting-your-api-request-parts-payloads-fields]]
==== Documenting a Request Part's Fields

You can document a request part's fields in much the same way as the fields of a request
or response, as follows:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/RequestPartPayload.java[tags=fields]
----
<1> Configure Spring REST docs to produce a snippet describing the fields in the payload
	of the request part named `metadata`. Uses the static `requestPartFields` method on
	`PayloadDocumentation`.
<2> Expect a field with the path `version`. Uses the static `fieldWithPath` method on
	`org.springframework.restdocs.payload.PayloadDocumentation`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/RequestPartPayload.java[tags=fields]
----
<1> Configure Spring REST docs to produce a snippet describing the fields in the payload
	of the request part named `metadata`. Uses the static `requestPartFields` method on
	`PayloadDocumentation`.
<2> Expect a field with the path `version`. Uses the static `fieldWithPath` method on
	`org.springframework.restdocs.payload.PayloadDocumentation`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/RequestPartPayload.java[tags=fields]
----
<1> Configure Spring REST docs to produce a snippet describing the fields in the payload
	of the request part named `metadata`. Uses the static `requestPartFields` method on
	`PayloadDocumentation`.
<2> Expect a field with the path `version`. Uses the static `fieldWithPath` method on
	`org.springframework.restdocs.payload.PayloadDocumentation`.
====

The result is a snippet that contains a table describing the part's fields. This snippet
is named `request-part-${part-name}-fields.adoc`. For example, documenting a part named
`metadata` produces a snippet named `request-part-metadata-fields.adoc`.

When documenting fields, the test fails if an undocumented field is found in the payload
of the part. Similarly, the test also fails if a documented field is not found in the
payload of the part and the field has not been marked as optional. For payloads with a
hierarchical structure, documenting a field is sufficient for all of its descendants to
also be treated as having been documented.

If you do not want to document a field, you can mark it as ignored. Doing so prevents it
from appearing in the generated snippet while avoiding the failure described above.

You can also document fields in a relaxed mode, where any undocumented fields do not
cause a test failure. To do so, use the `relaxedRequestPartFields` method on
`org.springframework.restdocs.payload.PayloadDocumentation`. This can be useful when
documenting a particular scenario where you only want to focus on a subset of the payload
of the part.

For further information on describing fields, documenting payloads that use XML, and
more, see the <<documenting-your-api-request-response-payloads,section on documenting
request and response payloads>>.

[[documenting-your-api-http-headers]]
=== HTTP Headers

You can document the headers in a request or response by using `requestHeaders` and
`responseHeaders`, respectively. The following examples show how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/HttpHeaders.java[tags=headers]
----
<1> Perform a `GET` request with an `Authorization` header that uses basic authentication.
<2> Configure Spring REST Docs to produce a snippet describing the request's headers.
	Uses the static `requestHeaders` method on
	`org.springframework.restdocs.headers.HeaderDocumentation`.
<3> Document the `Authorization` header. Uses the static `headerWithName` method on
	`org.springframework.restdocs.headers.HeaderDocumentation`.
<4> Produce a snippet describing the response's headers. Uses the static `responseHeaders`
	method on `org.springframework.restdocs.headers.HeaderDocumentation`.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/HttpHeaders.java[tags=headers]
----
<1> Perform a `GET` request with an `Authorization` header that uses basic authentication.
<2> Configure Spring REST Docs to produce a snippet describing the request's headers.
	Uses the static `requestHeaders` method on
	`org.springframework.restdocs.headers.HeaderDocumentation`.
<3> Document the `Authorization` header. Uses the static `headerWithName` method on
	`org.springframework.restdocs.headers.HeaderDocumentation`.
<4> Produce a snippet describing the response's headers. Uses the static `responseHeaders`
	method on `org.springframework.restdocs.headers.HeaderDocumentation`.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/HttpHeaders.java[tags=headers]
----
<1> Configure Spring REST Docs to produce a snippet describing the request's headers.
	Uses the static `requestHeaders` method on
	`org.springframework.restdocs.headers.HeaderDocumentation`.
<2> Document the `Authorization` header. Uses the static `headerWithName` method on
	`org.springframework.restdocs.headers.HeaderDocumentation.
<3> Produce a snippet describing the response's headers. Uses the static `responseHeaders`
	method on `org.springframework.restdocs.headers.HeaderDocumentation`.
<4> Configure the request with an `Authorization` header that uses basic authentication.
====

The result is a snippet named `request-headers.adoc` and a snippet named
`response-headers.adoc`. Each contains a table describing the headers.

When documenting HTTP Headers, the test fails if a documented header is not found in
the request or response.



[[documenting-your-api-reusing-snippets]]
=== Reusing Snippets

It is common for an API that is being documented to have some features that are common
across several of its resources. To avoid repetition when documenting such resources, you
can reuse a `Snippet` configured with the common elements.

First, create the `Snippet` that describes the common elements. The following example
shows how to do so:

====
[source,java,indent=0]
----
include::{examples-dir}/com/example/SnippetReuse.java[tags=field]
----
====

Second, use this snippet and add further descriptors that are resource-specific. The
following examples show how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/MockMvcSnippetReuse.java[tags=use]
----
<1> Reuse the `pagingLinks` `Snippet`, calling `and` to add descriptors that are specific
	to the resource that is being documented.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/WebTestClientSnippetReuse.java[tags=use]
----
<1> Reuse the `pagingLinks` `Snippet`, calling `and` to add descriptors that are specific
	to the resource that is being documented.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/RestAssuredSnippetReuse.java[tags=use]
----
<1> Reuse the `pagingLinks` `Snippet`, calling `and` to add descriptors that are specific
	to the resource that is being documented.
====

The result of the example is that links with `rel` values of `first`, `last`, `next`,
`previous`, `alpha`, and `bravo` are all documented.



[[documenting-your-api-constraints]]
=== Documenting Constraints

Spring REST Docs provides a number of classes that can help you to document constraints.
You can use an instance of `ConstraintDescriptions` to access descriptions of a class's
constraints. The following example shows how to do so:

====
[source,java,indent=0]
----
include::{examples-dir}/com/example/Constraints.java[tags=constraints]
----
<1> Create an instance of `ConstraintDescriptions` for the `UserInput` class.
<2> Get the descriptions of the `name` property's constraints. This list contains two
	descriptions: one for the `NotNull` constraint and one for the `Size` constraint.
====

The {samples}/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.java[`ApiDocumentation`]
class in the Spring HATEOAS sample shows this functionality in action.



[[documenting-your-api-constraints-finding]]
==== Finding Constraints

By default, constraints are found by using a Bean Validation `Validator`. Currently, only
property constraints are supported. You can customize the `Validator` that is used by
creating `ConstraintDescriptions` with a custom `ValidatorConstraintResolver` instance.
To take complete control of constraint resolution, you can use your own implementation of
`ConstraintResolver`.



[[documenting-your-api-constraints-describing]]
==== Describing Constraints

Default descriptions are provided for all of Bean Validation 2.0's constraints:

* `AssertFalse`
* `AssertTrue`
* `DecimalMax`
* `DecimalMin`
* `Digits`
* `Email`
* `Future`
* `FutureOrPresent`
* `Max`
* `Min`
* `Negative`
* `NegativeOrZero`
* `NotBlank`
* `NotEmpty`
* `NotNull`
* `Null`
* `Past`
* `PastOrPresent`
* `Pattern`
* `Positive`
* `PositiveOrZero`
* `Size`

Default descriptions are also provided for the following constraints from Hibernate
Validator:

* `CodePointLength`
* `CreditCardNumber`
* `Currency`
* `EAN`
* `Email`
* `Length`
* `LuhnCheck`
* `Mod10Check`
* `Mod11Check`
* `NotBlank`
* `NotEmpty`
* `Currency`
* `Range`
* `SafeHtml`
* `URL`

To override the default descriptions or to provide a new description, you can create a
resource bundle with a base name of
`org.springframework.restdocs.constraints.ConstraintDescriptions`.  The Spring
HATEOAS-based sample contains
{samples}/rest-notes-spring-hateoas/src/test/resources/org/springframework/restdocs/constraints/ConstraintDescriptions.properties[an
example of such a resource bundle].

Each key in the resource bundle is the fully-qualified name of a constraint plus a
`.description`. For example, the key for the standard `@NotNull` constraint is
`javax.validation.constraints.NotNull.description`.

You can use a property placeholder referring to a constraint's attributes in its
description. For example, the default description of the `@Min` constraint,
`Must be at least ${value}`, refers to the constraint's `value` attribute.

To take more control of constraint description resolution, you can create
`ConstraintDescriptions` with a custom `ResourceBundleConstraintDescriptionResolver`. To
take complete control, you can create `ConstraintDescriptions` with a custom
`ConstraintDescriptionResolver` implementation.



==== Using Constraint Descriptions in Generated Snippets

Once you have a constraint's descriptions, you are free to use them however you like in
the generated snippets. For example, you may want to include the constraint descriptions
as part of a field's description. Alternatively, you could include the constraints as
<<documenting-your-api-customizing-including-extra-information, extra information>> in
the request fields snippet. The
{samples}/rest-notes-spring-hateoas/src/test/java/com/example/notes/ApiDocumentation.java[`ApiDocumentation`]
class in the Spring HATEOAS-based sample illustrates the latter approach.



[[documenting-your-api-default-snippets]]
=== Default Snippets

A number of snippets are produced automatically when you document a request and response.

[cols=""1,3""]
|===
|Snippet | Description

| `curl-request.adoc`
| Contains the https://curl.haxx.se[`curl`] command that is equivalent to the `MockMvc`
call that is being documented.

| `httpie-request.adoc`
| Contains the https://httpie.org[`HTTPie`] command that is equivalent to the `MockMvc`
call that is being documented.

| `http-request.adoc`
| Contains the HTTP request that is equivalent to the `MockMvc` call that is being
documented.

| `http-response.adoc`
| Contains the HTTP response that was returned.

| `request-body.adoc`
| Contains the body of the request that was sent.

| `response-body.adoc`
| Contains the body of the response that was returned.

|===

You can configure which snippets are produced by default. See the
<<configuration, configuration section>> for more information.



[[documentating-your-api-parameterized-output-directories]]
=== Using Parameterized Output Directories

When using MockMvc or REST Assured, you can parameterize the output directory used by
`document`. You cannot parameterize the output directory when using `WebTestClient`.

The following parameters are supported:

[cols=""1,3""]
|===
| Parameter | Description

| {methodName}
| The unmodified name of the test method.

| {method-name}
| The name of the test method, formatted using kebab-case.

| {method_name}
| The name of the test method, formatted using snake_case.

| {ClassName}
| The unmodified simple name of the test class.

| {class-name}
| The simple name of the test class, formatted using kebab-case.

| {class_name}
| The simple name of the test class, formatted using snake_case.

| {step}
| The count of calls made to the service in the current test.
|===

For example, `document(""{class-name}/{method-name}"")` in a test method named
`creatingANote` on the test class `GettingStartedDocumentation` writes
snippets into a directory named `getting-started-documentation/creating-a-note`.

A parameterized output directory is particularly useful in combination with a `@Before`
method. It lets documentation be configured once in a setup method and then reused
in every test in the class. The following examples show how to do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/ParameterizedOutput.java[tags=parameterized-output]
----

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/ParameterizedOutput.java[tags=parameterized-output]
----
====

With this configuration in place, every call to the service you are testing produces
the <<documenting-your-api-default-snippets,default snippets>> without any further
configuration. Take a look at the `GettingStartedDocumentation` classes in each of the
sample applications to see this functionality in action.



[[documenting-your-api-customizing]]
=== Customizing the Output

This section describes how to customize the output of Spring REST Docs.

[[documenting-your-api-customizing-snippets]]
==== Customizing the Generated Snippets
Spring REST Docs uses https://mustache.github.io[Mustache] templates to produce the
generated snippets.
{source}/spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates[Default
templates] are provided for each of the snippets that Spring REST Docs can produce. To
customize a snippet's content, you can provide your own template.

Templates are loaded from the classpath from an `org.springframework.restdocs.templates`
subpackage. The name of the subpackage is determined by the ID of the template format
that is in use. The default template format, Asciidoctor, has an ID of `asciidoctor`, so
snippets are loaded from `org.springframework.restdocs.templates.asciidoctor`. Each
template is named after the snippet that it produces. For example, to override the
template for the `curl-request.adoc` snippet, create a template named
`curl-request.snippet` in
`src/test/resources/org/springframework/restdocs/templates/asciidoctor`.



[[documenting-your-api-customizing-including-extra-information]]
==== Including Extra Information

There are two ways to provide extra information for inclusion in a generated snippet:

* Use the `attributes` method on a descriptor to add one or more attributes to it.
* Pass in some attributes when calling `curlRequest`, `httpRequest`, `httpResponse`, and
  so on. Such attributes are associated with the snippet as a whole.

Any additional attributes are made available during the template rendering process.
Coupled with a custom snippet template, this makes it possible to include extra
information in a generated snippet.

A concrete example is the addition of a constraints column and a title when documenting
request fields. The first step is to provide a `constraints` attribute for each field
that you document and to provide a `title` attribute. The following examples show how to
do so:

====
[source,java,indent=0,role=""primary""]
.MockMvc
----
include::{examples-dir}/com/example/mockmvc/Payload.java[tags=constraints]
----
<1> Configure the `title` attribute for the request fields snippet.
<2> Set the `constraints` attribute for the `name` field.
<3> Set the `constraints` attribute for the `email` field.

[source,java,indent=0,role=""secondary""]
.WebTestClient
----
include::{examples-dir}/com/example/webtestclient/Payload.java[tags=constraints]
----
<1> Configure the `title` attribute for the request fields snippet.
<2> Set the `constraints` attribute for the `name` field.
<3> Set the `constraints` attribute for the `email` field.

[source,java,indent=0,role=""secondary""]
.REST Assured
----
include::{examples-dir}/com/example/restassured/Payload.java[tags=constraints]
----
<1> Configure the `title` attribute for the request fields snippet.
<2> Set the `constraints` attribute for the `name` field.
<3> Set the `constraints` attribute for the `email` field.
====

The second step is to provide a custom template named `request-fields.snippet` that
includes the information about the fields' constraints in the generated snippet's table
and adds a title. The following example shows how to do so:

====
[source,indent=0]
----
	.{{title}} <1>
	|===
	|Path|Type|Description|Constraints <2>

	{{#fields}}
	|{{path}}
	|{{type}}
	|{{description}}
	|{{constraints}} <3>

	{{/fields}}
	|===
----
<1> Add a title to the table.
<2> Add a new column named ""Constraints"".
<3> Include the descriptors' `constraints` attribute in each row of the table.
====
",12076,True,2658.762509350269,median
"#include ""VmJitX86.h""
#include <Lethe/Script/Program/CompiledProgram.h>
#include <Lethe/Script/Program/ConstPool.h>
#include ""../Builtin.h""

#if LETHE_CPU_X86 && (LETHE_OS_WINDOWS || LETHE_64BIT)

namespace lethe
{

#if !LETHE_32BIT
#	if LETHE_COMPILER_MSC_ONLY
extern ""C"" void VmJitX64_Stub(void *param);
#	endif

#endif

static bool hwPopCnt = false;

static void DetectHwPopCnt()
{
#ifdef _MSC_VER
	int id[4] = {0};
	__cpuid(id, 0);
	int nids = id[0];
	if ( nids >= 2 )
	{
		id[2] = 0;
		__cpuid(id, 1);
		hwPopCnt = (id[2] & 0x800000) != 0;
	}
#elif defined(__GNUC__) && !defined(__ANDROID__)
	int id[4] = {0};
	asm(
		""cpuid"":
		""=a"" (id[0]),
		""=b"" (id[1]),
		""=c"" (id[2]),
		""=d"" (id[3]) :
		""a"" (0)
	);
	int nids = id[0];
	if ( nids >= 2 )
	{
		id[2] = 0;
		asm(
			""cpuid"":
			""=a"" (id[0]),
			""=b"" (id[1]),
			""=c"" (id[2]),
			""=d"" (id[3]) :
			""a"" (1)
		);
		hwPopCnt = (id[2] & 0x800000) != 0;
	}
#endif
}

static bool IsNiceScale(Int scl)
{
	return scl == 1 || scl == 2 || scl == 4 || scl == 8;
}

static void NativeFToUI(Stack &stk)
{
	stk.SetInt(0, (UInt)stk.GetFloat(0));
}

void VmJitX86::FToUI()
{
	EmitNCall(-2, reinterpret_cast<void *>(NativeFToUI));
}

static void NativeDToUI(Stack &stk)
{
	auto val = (UInt)stk.GetDouble(0);
	stk.Pop(Stack::DOUBLE_WORDS);
	stk.PushInt(val);
}

void VmJitX86::DToUI()
{
	EmitNCall(-1, reinterpret_cast<void *>(NativeDToUI), true);
}

// templates

template< bool imm >
RegExpr VmJitX86::GetIndirectAdr(Int &scl, RegExpr &ofs)
{
	DontFlush _(*this);

	if (stackOpt == lastAdr)
	{
		if (imm)
		{
			lastAdr = INVALID_STACK_INDEX;
			return lastAdrExpr;
		}

		// FIXME: should never get there
		FlushLastAdr();
	}

	RegExpr reg = imm ? GetPtr(0) : GetInt(0);

	if (imm)
		return reg;

	if (!IsNiceScale(scl))
	{
		MulAccum(reg, scl, 1, 1);
		scl = 1;
	}

	// mov edx, [edi + 4]
	if (1+stackOpt == lastAdr)
	{
		ofs = lastAdrExpr;
		lastAdr = INVALID_STACK_INDEX;
	}
	else
	{
		ofs = AllocGprPtr(1 + stackOpt, 1).ToReg32();
		FlushLastAdr();
	}

	return reg.ToReg32();
}

template< bool imm >
void VmJitX86::GetIndirectSByte(Int scl, Int sofs)
{
	RegExpr ofs;
	RegExpr reg = GetIndirectAdr<imm>(scl, ofs);
	DontFlush _(*this);

	RegExpr dst = AllocGprWrite(stackOpt+sofs);
	// movsx eax,byte [eax]
	Movsx(dst, imm ? Mem8(reg + scl) : Mem8(reg*scl + ofs));
}

template< bool imm >
void VmJitX86::GetIndirectByte(Int scl, Int sofs)
{
	RegExpr ofs;
	RegExpr reg = GetIndirectAdr<imm>(scl, ofs);
	DontFlush _(*this);

	RegExpr dst = AllocGprWrite(stackOpt+sofs);
	// movzx eax,byte [eax]
	Movzx(dst, imm ? Mem8(reg + scl) : Mem8(reg*scl + ofs));
}

template< bool imm >
void VmJitX86::GetIndirectShort(Int scl, Int sofs)
{
	RegExpr ofs;
	RegExpr reg = GetIndirectAdr<imm>(scl, ofs);
	DontFlush _(*this);

	RegExpr dst = AllocGprWrite(stackOpt+sofs);
	// movsx eax,word [eax]
	Movsx(dst, imm ? Mem16(reg + scl) : Mem16(reg*scl + ofs));
}

template< bool imm >
void VmJitX86::GetIndirectUShort(Int scl, Int sofs)
{
	RegExpr ofs;
	RegExpr reg = GetIndirectAdr<imm>(scl, ofs);
	DontFlush _(*this);

	RegExpr dst = AllocGprWrite(stackOpt+sofs);
	// movzx eax,word [eax]
	Movzx(dst, imm ? Mem16(reg + scl) : Mem16(reg*scl + ofs));
}

template< bool imm >
void VmJitX86::GetIndirectInt(Int scl, Int sofs, bool isPtr)
{
	RegExpr ofs;
	RegExpr reg = GetIndirectAdr<imm>(scl, ofs);
	DontFlush _(*this);

	RegExpr dst = isPtr ? AllocGprWritePtr(stackOpt+sofs) : AllocGprWrite(stackOpt+sofs);

	// mov eax,[eax*n+edx]
	Mov(dst, imm ? Mem32(reg + scl) : Mem32(reg*scl + ofs));
}

template< bool imm >
void VmJitX86::GetIndirectFloat(Int scl, Int sofs)
{
	RegExpr ofs;
	RegExpr reg = GetIndirectAdr<imm>(scl, ofs);
	DontFlush _(*this);

	RegExpr dst = AllocSseWrite(stackOpt+sofs);
	// mov eax,[eax*n+edx]
	Movd(dst, imm ? Mem32(reg + scl) : Mem32(reg*scl + ofs));
}

template< bool imm >
void VmJitX86::GetIndirectDouble(Int scl, Int sofs)
{
	RegExpr ofs;
	RegExpr reg = GetIndirectAdr<imm>(scl, ofs);
	DontFlush _(*this);

	RegExpr dst = AllocSseWriteDouble(stackOpt + sofs);
	// mov eax,[eax*n+edx]
	Movq(dst, imm ? Mem32(reg + scl) : Mem32(reg*scl + ofs));
}

template< bool imm >
void VmJitX86::GetIndirectPtr(Int scale, Int sofs)
{
	GetIndirectInt<imm>(scale, sofs, 1);
}

template<int size, bool uns>
void VmJitX86::PInc(Int ofs)
{
	DontFlush _(*this);
	RegExpr reg;

	if (stackOpt == lastAdr)
	{
		reg = lastAdrExpr;
		lastAdr = INVALID_STACK_INDEX;
	}
	else
		reg = GetPtr(0);

	// add [eax], const
	if (size == 1)
		Add(Mem8(reg), ofs);
	else if (size == 2)
		Add(Mem16(reg), ofs);
	else if (size == 4)
		Add(Mem32(reg), ofs);
	else
		Add(Mem64(reg), ofs);

	gprCache.reserved = reg.GetRegMask();
	RegExpr dst = size > 4 ? AllocGprWritePtr(stackOpt) : AllocGprWrite(stackOpt);
	gprCache.reserved = 0;

	// mov eax,[eax]
	if (size == 1)
		uns ? Movzx(dst, Mem8(reg)) : Movsx(dst, Mem8(reg));
	else if (size == 2)
		uns ? Movzx(dst, Mem16(reg)) : Movsx(dst, Mem16(reg));
	else
		Mov(dst, Mem32(reg));
}

template<int size, bool uns>
void VmJitX86::PIncPost(Int ofs)
{
	PInc<size, uns>(ofs);
	DontFlush _(*this);

	RegExpr dst = size > 4 ? AllocGprWritePtr(stackOpt) : AllocGprWrite(stackOpt);

	LETHE_ASSERT(dst.IsRegister());
	Add(dst, -ofs);
}

// edi  = stack ptr
// esi  = Stack object ptr (x86/global data x64; for x64 stack object ptr is r12)
// ebp  = this ptr
// r13  = (x64 only) code base ptr
// r14  = (x64 only) temporary rsp storage

#define VMJITX86_CAN_CHAIN_AADD() \\
	bool canChain = canFuseNext; \\
	if (canChain) { \\
		UInt nextOp = prog.instructions[i+1] & 255u; \\
		/* FIXME: better! */ \\
		canChain = nextOp >= OPC_PSTORE8_IMM && nextOp <= OPC_PSTOREPTR_IMM_NP; \\
	}

void VmJitX86::AlignCode(Int align, bool dumb)
{
	const Int mask = align-1;
	Int calign = (align - (code.GetSize() & mask)) & mask;

	if (dumb)
	{
		for (Int j = 0; j < calign; j++)
			code.Add(0x90);

		return;
	}

	while (calign >= 9)
	{
		code.Add(0x66);
		code.Add(0xf);
		code.Add(0x1f);
		code.Add(0x84);
		code.Add(0);
		code.Add(0);
		code.Add(0);
		code.Add(0);
		code.Add(0);
		calign -= 9;
		continue;
	}

	switch(calign)
	{
	case 2:
		code.Add(0x66);
		// fall through
	case 1:
		code.Add(0x90);
		break;

	case 3:
		code.Add(0x0f);
		code.Add(0x1f);
		code.Add(0);
		break;

	case 4:
		code.Add(0x0f);
		code.Add(0x1f);
		code.Add(0x40);
		code.Add(0);
		break;

	case 6:
		code.Add(0x66);
		// fall through
	case 5:
		code.Add(0x0f);
		code.Add(0x1f);
		code.Add(0x44);
		code.Add(0);
		code.Add(0);
		break;

	case 7:
		code.Add(0x0f);
		code.Add(0x1f);
		code.Add(0x80);
		code.Add(0);
		code.Add(0);
		code.Add(0);
		code.Add(0);
		break;

	case 8:
		code.Add(0x0f);
		code.Add(0x1f);
		code.Add(0x84);
		code.Add(0);
		code.Add(0);
		code.Add(0);
		code.Add(0);
		code.Add(0);
		break;
	}
}

bool VmJitX86::CodeGen(CompiledProgram &prog)
{
#define VMJITX86_OPT_CMP_JMP_FLOAT(cond) VMJITX86_OPT_CMP_JMP_FLOAT_CUSTOM(FCmp, FBx2, cond)
#define VMJITX86_OPT_CMP_JMP_DOUBLE(cond) VMJITX86_OPT_CMP_JMP_FLOAT_CUSTOM(DCmp, DBx2, cond)
#define VMJITX86_OPT_CMP_JMP_FLOAT_CUSTOM(fcmp, fbx2, cond) \\
	do { \\
		if (canFuseNext && (Byte)prog.instructions[i+1] == OPC_IBNZ_P) \\
		{ \\
			fbx2(cond, i+2+DecodeImm24(prog.instructions[i+1])); \\
			i++; \\
		} \\
		else \\
			fcmp(cond); \\
	} while(false)

	DetectHwPopCnt();

	for (Int i=0; i<1; i++)
	{
		LETHE_RET_FALSE(CodeGenPass(prog, i));
/*		File f;
		f.Create(String::Printf(""$pass%d.bin"", i));
		f.Write(code.GetData(), code.GetSize());*/
	}

	prevPcToCode.Reset();
	jumpSource.Reset();
	prevJumpSource.Reset();

	// finalize funcCodeOfs

	funcCodeToPC.Clear();

	for (Int i=0; i<funcCodeOfs.GetSize(); i++)
		funcCodeToPC[code.GetData() + funcCodeOfs[i]] = funcOfs[i];

	funcCodeOfs.Reset();
	funcOfs.Reset();

	return true;
}

bool VmJitX86::CodeGenPass(CompiledProgram &prog, Int pass)
{
	prevJumpSource = jumpSource;
	jumpSource.Clear();

	lastIns = -1;
	lastRex = -1;
	stackOpt = 0;
	dontFlush = 0;
	preserveFlags = 0;
	code.Clear();
	fixups.Clear();
	pcToCode.Clear();
	pcToCode.Resize(prog.instructions.GetSize(), -1);

	gprCache = RegCache();
	sseCache = RegCache();

	if (pass == 0)
		BuildFuncOffsets(prog);

	if (IsX64)
		gprCache.Init(4, Eax, 4, R8d);
	else
		gprCache.Init(4, Eax);

	sseCache.Init(8, Xmm0);

	lastAdrExpr = RegExpr();
	lastAdr = INVALID_STACK_INDEX;

	QDataType qdt;

	if (pass == 0)
	{
		prog.cpool.Align(8);

		qdt = QDataType::MakeConstType(prog.elemTypes[DT_FLOAT]);
		uiConvTable = prog.cpool.AllocGlobal(qdt);
		prog.cpool.AllocGlobal(qdt);

		qdt = QDataType::MakeConstType(prog.elemTypes[DT_DOUBLE]);
		prog.cpool.AllocGlobal(qdt);
		prog.cpool.AllocGlobal(qdt);
	}

	if (IsX64)
	{
#if LETHE_OS_WINDOWS
		firstArgReg = Rcx;
#else
		firstArgReg = Rdi;
#endif

		if (pass == 0)
		{
			// initialize native func ptrs
			qdt = QDataType::MakeConstType(prog.elemTypes[DT_FUNC_PTR]);
			auto &cpool = prog.cpool;

			Int ofs = cpool.AllocGlobal(qdt);
			nativeFuncPtr = Esi + ofs;
			auto fptr = NativeFToUI;
			MemCpy(&cpool.data[ofs], &fptr, sizeof(void *));

			ofs = cpool.AllocGlobal(qdt);
			fptr = NativeDToUI;
			MemCpy(&cpool.data[ofs], &fptr, sizeof(void *));

			for (Int i=0; i<cpool.nFunc.GetSize(); i++)
			{
				ofs = cpool.AllocGlobal(qdt);
				MemCpy(&cpool.data[ofs], &cpool.nFunc[i], sizeof(ConstPool::NativeCallback));
			}
		}
	}

	if (pass == 0)
	{
		auto uiConv = reinterpret_cast<Float *>(prog.cpool.data.GetData() + uiConvTable);
		uiConv[0] = 0.0f;
		uiConv[1] = 2147483648.0f*2.0f;

		auto uiConvd = reinterpret_cast<Double *>(prog.cpool.data.GetData() + uiConvTable + 8);
		uiConvd[0] = 0.0;
		uiConvd[1] = 2147483648.0*2.0;

		// build float masks
		prog.cpool.Align(16);
		qdt = QDataType::MakeConstType(prog.elemTypes[DT_FLOAT]);

		fxorBase = prog.cpool.data.GetSize();

		// xor mask (flip sign)
		for (Int i=0; i<4; i++)
		{
			auto ofs = prog.cpool.AllocGlobal(qdt);
			auto xorMask = 0x80000000u;
			MemCpy(&prog.cpool.data[ofs], &xorMask, sizeof(Float));
		}

		// xor mask (flip sign, double)
		for (Int i = 0; i<4; i++)
		{
			auto ofs = prog.cpool.AllocGlobal(qdt);
			auto xorMask = (i & 1) ? 0x80000000u : 0u;
			MemCpy(&prog.cpool.data[ofs], &xorMask, sizeof(Float));
		}

		// bake float constants
		for (Int i=0; i<prog.cpool.fPool.GetSize(); i++)
		{
			auto ofs = prog.cpool.AllocGlobal(qdt);

			if (!i)
				fconstBase = ofs;

			*reinterpret_cast<Float *>(prog.cpool.data.GetData() + ofs) = prog.cpool.fPool[i];
		}

		prog.cpool.Align(8);

		// bake double constants
		qdt = QDataType::MakeConstType(prog.elemTypes[DT_DOUBLE]);

		for (Int i = 0; i<prog.cpool.dPool.GetSize(); i++)
		{
			auto ofs = prog.cpool.AllocGlobal(qdt);

			if (!i)
				dconstBase = ofs;

			*reinterpret_cast<Double *>(prog.cpool.data.GetData() + ofs) = prog.cpool.dPool[i];
		}
	}

	fixups.Clear();

	if (IsX64)
	{
		globalBase = Esi;
		stackObjectPtr = R12d;
	}
	else
	{
		globalBase = (UInt)(UIntPtr)prog.cpool.data.GetData();
		stackObjectPtr = Esi;
	}

	Int nextBarrierIndex = 0;
	Int nextBarrier = prog.barriers[0];

	Int nextLoopIndex = 0;
	Int nextLoop = prog.loops[0];

	Int nextFuncIndex = 0;
	Int nextFunc = funcOfs[0];

	bool lastConst = 0;
	Int lastIntConst = 0;

	funcCodeOfs.Clear();

	for (Int i=0; i<prog.instructions.GetSize(); i++)
	{
		const ConstPool &cpool = prog.cpool;
		Int ins = prog.instructions[i];

		/*printf(""pc=%08x, gpr:\\n"", i);
		gprCache.Dump();
		printf(""sse:\\n"");
		sseCache.Dump();*/

		if (i == nextFunc)
		{
			nextFunc = funcOfs[++nextFuncIndex];
			// note: must align functions to at least 2 bytes because of fcall_dg!!!
			AlignCode(16, true);
			funcCodeOfs.Add(code.GetSize());
		}

		if (i == nextBarrier)
		{
			lastIns = -1;
			lastConst = 0;
			FlushStackOpt();
			nextBarrier = prog.barriers[++nextBarrierIndex];

			//AlignCode(16);
		}

		if (i == nextLoop)
		{
			nextLoop = prog.loops[++nextLoopIndex];
			// unfortunately we can't align loop starts due to the way we ""optimize"" short jumps
			// hmm, loop alignment seems to actually hurt a bit on Ryzen in some cases => removed
			// but: gcc seems to align to 8 bytes, clang does unroll + 16-byte align; I guess it depends on how long the loop actually is?
			//AlignCode(32);
		}

		pcToCode[i] = code.GetSize();

		RegExpr reg;

		const bool canFuseNext = nextBarrier != i+1 && i+1 < prog.instructions.GetSize();

		switch((Byte)ins)
		{
		case OPC_PUSH_ICONST:
			lastIntConst = DecodeImm24(ins);
			PushInt(lastIntConst);
			lastConst = 1;
			continue;

		case OPC_PUSHC_ICONST:
			lastIntConst = cpool.iPool[DecodeUImm24(ins)];
			PushInt(lastIntConst);
			lastConst = 1;
			continue;

		case OPC_PUSH_FCONST:
			PushFloat(prog, cpool.fPool[cpool.fPoolMap[(Float)DecodeImm24(ins)]]);
			break;

		case OPC_PUSHC_FCONST:
			PushFloat(prog, cpool.fPool[DecodeUImm24(ins)]);
			break;

		case OPC_PUSH_DCONST:
			PushDouble(prog, cpool.dPool[cpool.dPoolMap[(Double)DecodeImm24(ins)]]);
			break;

		case OPC_PUSHC_DCONST:
			PushDouble(prog, cpool.dPool[DecodeUImm24(ins)]);
			break;

		case OPC_LPUSH32:
		{
			Int tofs = DecodeUImm24(ins);
			reg = GetInt(tofs);
			Push(1, 0);
			TrackGpr(stackOpt, stackOpt + 1 + tofs);
		}
		break;

		case OPC_LPUSH32F:
		{
			Int tofs = DecodeUImm24(ins);
			reg = GetFloat(tofs);
			Push(1, 0);
			TrackSse(stackOpt, stackOpt + 1 + tofs);
		}
		break;

		case OPC_LPUSH64D:
		{
			Int tofs = DecodeUImm24(ins);
			reg = GetDouble(tofs);
			Push(Stack::DOUBLE_WORDS, 0);
			TrackSse(stackOpt, stackOpt + Stack::DOUBLE_WORDS + tofs);
		}
		break;

		case OPC_LPUSHADR:
		{
			// note: flushing here seems necessary (related to delegates) if we do pushthis/lpushadr 0
			FlushLastAdr();
			Int tofs = DecodeUImm24(ins);
			bool doSpill = true;

			if (canFuseNext)
			{
				const auto nins = prog.instructions[i+1];
				const auto nopc = nins & 255u;

				if ((nopc >= OPC_PLOAD8 && nopc < OPC_PSTORE8_IMM) || nins == OPC_PLOAD64)
					doSpill = false;
			}

			// TODO: verify that spill really works
			// because of aliasing, we have to spill everything above tofs!
			// but this is stupid as it does unnecessary spills
			if (doSpill)
			{
				gprCache.SpillAbove(stackOpt + tofs, *this);
				sseCache.SpillAbove(stackOpt + tofs, *this);
			}
			else
			{
				gprCache.Spill(stackOpt + tofs, *this);
				sseCache.Spill(stackOpt + tofs, *this);
			}

			/*reg = GetStackAdr( DecodeUImm24(ins) );
			PushPtrAccum(reg);*/
			Push(1, 0);

			SetLastAdr(Edi + (stackOpt + 1 + tofs)*Stack::WORD_SIZE);
		}
		break;

		case OPC_LPUSHPTR:
			if (canFuseNext)
			{
				auto nextOpc = prog.instructions[i+1] & 255;
				if (nextOpc >= OPC_PLOAD8_IMM && nextOpc <= OPC_PSTOREPTR_IMM_NP/*OPC_PLOADPTR_IMM*/)
				{
					// FIXME!!! crashes... something's wrong... => yes, if we lose the cached register! [BUT that didn't happen actually!]
					Int tofs = DecodeUImm24(ins);
					reg = GetPtr(tofs);
					Push(1, 0);
					TrackGpr(stackOpt, stackOpt + 1 + tofs);
					SetLastAdr(reg);
					break;
				}
			}
			reg = GetPtr(DecodeUImm24(ins));
			PushPtrAccum(reg);
			break;

		case OPC_LPUSH32_ICONST:
		{
			Int tofs = DecodeUImm8(ins, 0);
			reg = GetInt(tofs);
			Push(1, 0);
			TrackGpr(stackOpt, stackOpt + 1 + tofs);
			////PushIntAccum(reg);
			lastIntConst = DecodeImm16Top(ins);
			PushInt(lastIntConst);
			lastConst = true;
		}
		break;

		case OPC_LPUSH32_CICONST:
		{
			Int tofs = DecodeUImm8(ins, 0);
			reg = GetInt(tofs);
			Push(1, 0);
			TrackGpr(stackOpt, stackOpt + 1 + tofs);
			////PushIntAccum(reg);
			lastIntConst = Int(cpool.iPool[DecodeUImm16Top(ins)]);
			PushInt(lastIntConst);
			lastConst = true;
		}
		break;

		case OPC_GLOAD32:
			reg = GetGlobalInt(DecodeUImm24(ins));
			////PushIntAccum(reg);
			break;

		case OPC_GLOAD32F:
			reg = GetGlobalFloat(DecodeUImm24(ins));
			////PushIntAccum(reg);
			break;

		case OPC_GLOAD64D:
			reg = GetGlobalDouble(DecodeUImm24(ins));
			////PushIntAccum(reg);
			break;

		case OPC_GLOADPTR:
			reg = GetGlobalPtr(DecodeUImm24(ins));
			////PushPtrAccum(reg);
			break;

		case OPC_GSTORE32:
			reg = GetInt(0);
			SetGlobalInt(DecodeUImm24(ins), reg);
			Pop(1);
			break;

		case OPC_GSTORE32F:
			reg = GetFloat(0);
			SetGlobalFloat(DecodeUImm24(ins), reg);
			Pop(1);
			break;

		case OPC_GSTORE64D:
			reg = GetDouble(0);
			SetGlobalDouble(DecodeUImm24(ins), reg);
			Pop(Stack::DOUBLE_WORDS);
			break;

		case OPC_GSTORE32_NP:
			reg = GetInt(0);
			SetGlobalInt(DecodeUImm24(ins), reg);
			break;

		case OPC_GSTORE32F_NP:
			reg = GetFloat(0);
			SetGlobalFloat(DecodeUImm24(ins), reg);
			break;

		case OPC_GSTORE64D_NP:
			reg = GetDouble(0);
			SetGlobalDouble(DecodeUImm24(ins), reg);
			break;

		case OPC_GSTOREPTR:
			reg = GetPtr(0);
			SetGlobalPtr(DecodeUImm24(ins), reg);
			Pop(1);
			break;

		case OPC_GSTOREPTR_NP:
			reg = GetPtr(0);
			SetGlobalPtr(DecodeUImm24(ins), reg);
			break;

		case OPC_GLOAD8:
			reg = GetGlobalSByte(DecodeUImm24(ins));
			PushIntAccum(reg);
			break;

		case OPC_GLOAD8U:
			reg = GetGlobalByte(DecodeUImm24(ins));
			PushIntAccum(reg);
			break;

		case OPC_GLOAD16:
			reg = GetGlobalShort(DecodeUImm24(ins));
			PushIntAccum(reg);
			break;

		case OPC_GLOAD16U:
			reg = GetGlobalUShort(DecodeUImm24(ins));
			PushIntAccum(reg);
			break;

		case OPC_GSTORE8:
			reg = GetInt(0);
			SetGlobalByte(DecodeUImm24(ins), reg);
			Pop(1);
			break;

		case OPC_GSTORE8_NP:
			reg = GetInt(0);
			SetGlobalByte(DecodeUImm24(ins), reg);
			break;

		case OPC_GSTORE16:
			reg = GetInt(0);
			SetGlobalUShort(DecodeUImm24(ins), reg);
			Pop(1);
			break;

		case OPC_GSTORE16_NP:
			reg = GetInt(0);
			SetGlobalUShort(DecodeUImm24(ins), reg);
			break;

		case OPC_GLOADADR:
			Push(1, 0);

			SetLastAdr(GlobalBase() + DecodeUImm24(ins));
			//reg = GetGlobalAdr( DecodeUImm24(ins) );
			break;

		case OPC_PUSH_FUNC:
			PushFuncPtr(i + 1 + DecodeImm24(ins));
			break;

		case OPC_POP:
			Pop(DecodeUImm24(ins));
			break;

		case OPC_LPUSH8:
			reg = GetLocalSByte(DecodeUImm24(ins));
			PushIntAccum(reg);
			break;

		case OPC_LPUSH8U:
			reg = GetLocalByte(DecodeUImm24(ins));
			PushIntAccum(reg);
			break;

		case OPC_LPUSH16:
			reg = GetLocalShort(DecodeUImm24(ins));
			PushIntAccum(reg);
			break;

		case OPC_LPUSH16U:
			reg = GetLocalUShort(DecodeUImm24(ins));
			PushIntAccum(reg);
			break;

		case OPC_LSTORE8:
			reg = GetInt(0);
			SetLocalByte(DecodeUImm24(ins), reg);
			Pop(1);
			break;

		case OPC_LSTORE8_NP:
			reg = GetInt(0);
			SetLocalByte(DecodeUImm24(ins), reg);
			break;

		case OPC_LSTORE16:
			reg = GetInt(0);
			SetLocalUShort(DecodeUImm24(ins), reg);
			Pop(1);
			break;

		case OPC_LSTORE16_NP:
			reg = GetInt(0);
			SetLocalUShort(DecodeUImm24(ins), reg);
			break;

		case OPC_LSTORE32:
			reg = GetInt(0);
			SetLocalInt(DecodeUImm24(ins), reg, 1);
			Pop(1);
			break;

		case OPC_LSTORE32F:
			reg = GetFloat(0);
			SetLocalFloat(DecodeUImm24(ins), reg, 1);
			Pop(1);
			break;

		case OPC_LSTORE64D:
			reg = GetDouble(0);
			SetLocalDouble(DecodeUImm24(ins), reg, 1);
			Pop(Stack::DOUBLE_WORDS);
			break;

		case OPC_LSTORE32_NP:
			reg = GetInt(0);
			SetLocalInt(DecodeUImm24(ins), reg);
			break;

		case OPC_LSTORE32F_NP:
			reg = GetFloat(0);
			SetLocalFloat(DecodeUImm24(ins), reg);
			break;

		case OPC_LSTORE64D_NP:
			reg = GetDouble(0);
			SetLocalDouble(DecodeUImm24(ins), reg);
			break;

		case OPC_LSTOREPTR:
			reg = GetPtr(0);
			SetLocalPtr(DecodeUImm24(ins), reg, 1);
			Pop(1);
			break;

		case OPC_LSTOREPTR_NP:
			reg = GetPtr(0);
			SetLocalPtr(DecodeUImm24(ins), reg);
			break;

		case OPC_LMOVE32:
			reg = GetInt(DecodeUImm8(ins, 1));
			SetLocalInt(DecodeUImm8(ins, 0), reg);
			break;

		case OPC_LMOVEPTR:
			reg = GetPtr(DecodeUImm8(ins, 1));
			SetLocalPtr(DecodeUImm8(ins, 0), reg);
			break;

		case OPC_LSWAPPTR:
		{
			reg = GetPtr(0);
			PushPtrAccum(reg);
			RegExpr reg1 = GetPtr(2);
			SetLocalPtr(1, reg1);
			SetLocalPtr(2, GetPtr(0));
			Pop(1);
		}
		break;

		case OPC_RANGE_ICONST:
			GetInt(0);
			RangeCheck(DecodeUImm24(ins));
			break;

		case OPC_RANGE_CICONST:
			GetInt(0);
			RangeCheck(cpool.iPool[DecodeUImm24(ins)]);
			break;

		case OPC_RANGE:
			GetInt(0);
			RangeCheck();
			break;

		case OPC_PLOAD8:
			GetIndirectSByte<0>(DecodeUImm24(ins), 1);
			Pop(1);
			break;

		case OPC_PLOAD8U:
			GetIndirectByte<0>(DecodeUImm24(ins), 1);
			Pop(1);
			break;

		case OPC_PLOAD16:
			GetIndirectShort<0>(DecodeUImm24(ins), 1);
			Pop(1);
			break;

		case OPC_PLOAD16U:
			GetIndirectUShort<0>(DecodeUImm24(ins), 1);
			Pop(1);
			break;

		case OPC_PLOAD32:
			GetIndirectInt<0>(DecodeUImm24(ins), 1);
			Pop(1);
			break;

		case OPC_PLOAD32F:
			GetIndirectFloat<0>(DecodeUImm24(ins), 1);
			Pop(1);
			break;

		case OPC_PLOAD64D:
		{
			auto sofs = 2-Stack::DOUBLE_WORDS;
			GetIndirectDouble<0>(DecodeUImm24(ins), sofs);
			gprCache.Free(stackOpt+1, *this, true);
			gprCache.Free(stackOpt, *this, true);
			Pop(sofs);
			break;
		}

		case OPC_PLOADPTR:
			GetIndirectPtr<0>(DecodeUImm24(ins), 1);
			Pop(1);
			break;

		case OPC_PLOAD8_IMM:
			GetIndirectSByte<1>(DecodeImm24(ins), 0);
			break;

		case OPC_PLOAD8U_IMM:
			GetIndirectByte<1>(DecodeImm24(ins), 0);
			break;

		case OPC_PLOAD16_IMM:
			GetIndirectShort<1>(DecodeImm24(ins), 0);
			break;

		case OPC_PLOAD16U_IMM:
			GetIndirectUShort<1>(DecodeImm24(ins), 0);
			break;

		case OPC_PLOAD32_IMM:
			GetIndirectInt<1>(DecodeImm24(ins), 0);
			break;

		case OPC_PLOAD32F_IMM:
			GetIndirectFloat<1>(DecodeImm24(ins), 0);
			break;

		case OPC_PLOAD64D_IMM:
		{
			Int sofs = 1 - Stack::DOUBLE_WORDS;
			GetIndirectDouble<1>(DecodeImm24(ins), sofs);
			gprCache.Free(stackOpt, *this, true);

			if (sofs < 0)
				Push(-sofs, false);
			break;
		}

		case OPC_PLOADPTR_IMM:
			GetIndirectPtr<1>(DecodeImm24(ins), 0);
			break;

		case OPC_PSTORE8_IMM:
			StoreIndirectImmByte(DecodeImm24(ins));
			Pop(2);
			break;

		case OPC_PSTORE8_IMM_NP:
			StoreIndirectImmByte(DecodeImm24(ins));
			Pop(1);
			break;

		case OPC_PSTORE16_IMM:
			StoreIndirectImmUShort(DecodeImm24(ins));
			Pop(2);
			break;

		case OPC_PSTORE16_IMM_NP:
			StoreIndirectImmUShort(DecodeImm24(ins));
			Pop(1);
			break;

		case OPC_PSTORE32_IMM:
			StoreIndirectImmInt(DecodeImm24(ins));
			Pop(2);
			break;

		case OPC_PSTORE32_IMM_NP:
			StoreIndirectImmInt(DecodeImm24(ins));
			Pop(1);
			break;

		case OPC_PSTORE32F_IMM:
			StoreIndirectImmFloat(DecodeImm24(ins));
			Pop(2);
			break;

		case OPC_PSTORE32F_IMM_NP:
			StoreIndirectImmFloat(DecodeImm24(ins));
			Pop(1);
			break;

		case OPC_PSTORE64D_IMM:
			StoreIndirectImmDouble(DecodeImm24(ins));
			Pop(1 + Stack::DOUBLE_WORDS);
			break;

		case OPC_PSTORE64D_IMM_NP:
			StoreIndirectImmDouble(DecodeImm24(ins));
			Pop(1);
			break;

		case OPC_PSTOREPTR_IMM:
			StoreIndirectImmPtr(DecodeImm24(ins));
			Pop(2);
			break;

		case OPC_PSTOREPTR_IMM_NP:
			StoreIndirectImmPtr(DecodeImm24(ins));
			Pop(1);
			break;

		case OPC_PINC8:
			PInc<1, 0>(DecodeImm24(ins));
			break;

		case OPC_PINC8U:
			PInc<1, 1>(DecodeImm24(ins));
			break;

		case OPC_PINC16:
			PInc<2, 0>(DecodeImm24(ins));
			break;

		case OPC_PINC16U:
			PInc<2, 1>(DecodeImm24(ins));
			break;

		case OPC_PINC32:
			PInc<4, 0>(DecodeImm24(ins));
			break;

		case OPC_PINC8_POST:
			PIncPost<1, 0>(DecodeImm24(ins));
			break;

		case OPC_PINC8U_POST:
			PIncPost<1, 1>(DecodeImm24(ins));
			break;

		case OPC_PINC16_POST:
			PIncPost<2, 0>(DecodeImm24(ins));
			break;

		case OPC_PINC16U_POST:
			PIncPost<2, 1>(DecodeImm24(ins));
			break;

		case OPC_PINC32_POST:
			PIncPost<4, 0>(DecodeImm24(ins));
			break;

		case OPC_PCOPY:
			PCopy(DecodeUImm24(ins));
			Pop(2);
			break;

		case OPC_PCOPY_REV:
			PCopy(DecodeUImm24(ins), 1);
			Pop(2);
			break;

		case OPC_PCOPY_NP:
			PCopy(DecodeUImm24(ins));
			Pop(1);
			break;

		case OPC_PSWAP:
			PSwap(DecodeUImm24(ins));
			Pop(2);
			break;

		case OPC_PUSH_RAW:
			Push(DecodeUImm24(ins), 0);
			break;

		case OPC_PUSHZ_RAW:
			Push(DecodeUImm24(ins), 1);
			break;

		case OPC_AADD:
		{
			VMJITX86_CAN_CHAIN_AADD();
			reg = GetInt(0);
			Int scl = DecodeUImm24(ins);

			if (!IsNiceScale(scl))
				MulAccum(reg, scl);
			else
				reg = reg * scl;

			AddLocalPtrAccum(reg, 1, canChain);
		}

		Pop(1);
		break;

		case OPC_LAADD:
		{
			VMJITX86_CAN_CHAIN_AADD();
			Int ofs = DecodeUImm16Top(ins);
			reg = GetInt(ofs);
			Int scl = DecodeUImm8(ins, 0);

			if (!IsNiceScale(scl))
				MulAccum(reg, scl);
			else
				reg = reg * scl;

			AddLocalPtrAccum(reg, 0, canChain);
		}
		break;

		case OPC_AADD_ICONST:
			PtrAddIConst(DecodeImm24(ins));
			break;

		case OPC_AADDH_ICONST:
			PtrAddIConst(DecodeImm24(ins) << 16);
			break;

		case OPC_IADD:
			IAdd();
			break;

		case OPC_ISUB:
			ISub();
			break;

		case OPC_IMUL:
			IMul();
			break;

		case OPC_IMUL_ICONST:
			reg = AllocGprWrite(stackOpt, 1);
			MulAccum(reg, DecodeImm24(ins), 0);
			break;

		case OPC_IDIV:
			IDiv();
			break;

		case OPC_UIDIV:
			UIDiv();
			break;

		case OPC_IMOD:
			IMod();
			break;

		case OPC_UIMOD:
			UIMod();
			break;

		case OPC_IAND:
			IAnd();
			break;

		case OPC_IAND_ICONST:
			IAnd(DecodeImm24(ins));
			break;

		case OPC_IOR:
			IOr();
			break;

		case OPC_IOR_ICONST:
			IOr(DecodeImm24(ins));
			break;

		case OPC_IXOR:
			IXor();
			break;

		case OPC_IXOR_ICONST:
			IXor(DecodeImm24(ins));
			break;

		case OPC_ISHL:
			IShl();
			break;

		case OPC_ISHL_ICONST:
			IShl(DecodeImm24(ins));
			break;

		case OPC_ISHR:
			IShr();
			break;

		case OPC_ISHR_ICONST:
			IShr(DecodeImm24(ins));
			break;

		case OPC_ISAR:
			ISar();
			break;

		case OPC_ISAR_ICONST:
			ISar(DecodeImm24(ins));
			break;

		case OPC_FADD:
			FAdd();
			break;

		case OPC_DADD:
			DAdd();
			break;

		case OPC_FADD_ICONST:
			PushFloat(prog, (Float)DecodeImm24(ins));
			FAdd();
			break;

		case OPC_LFADD_ICONST:
			PushFloat(prog, (Float)DecodeImm8Top(ins));
			reg = GetFloat(DecodeUImm8(ins, 1)+1);
			FAddTop(DecodeUImm8(ins, 0)+1, reg);
			Pop(1);
			break;

		case OPC_LFADD:
			reg = GetFloat(DecodeUImm8(ins, 1));
			FAddTop(DecodeUImm8(ins, 0), reg);
			Pop(1);
			break;

		case OPC_FSUB:
			FSub();
			break;

		case OPC_DSUB:
			DSub();
			break;

		case OPC_LFSUB:
			reg = GetFloat(DecodeUImm8(ins, 1));
			FSubTop(DecodeUImm8(ins, 0), reg);
			Pop(1);
			break;

		case OPC_FMUL:
			FMul();
			break;

		case OPC_DMUL:
			DMul();
			break;

		case OPC_LFMUL:
			reg = GetFloat(DecodeUImm8(ins, 1));
			FMulTop(DecodeUImm8(ins, 0), reg);
			Pop(1);
			break;

		case OPC_FDIV:
			FDiv();
			break;

		case OPC_DDIV:
			DDiv();
			break;

		case OPC_LFDIV:
			reg = GetFloat(DecodeUImm8(ins, 1));
			FDivTop(DecodeUImm8(ins, 0), reg);
			Pop(1);
			break;

		case OPC_ICMPZ:
			ICmpZ();
			break;

		case OPC_ICMPNZ:
			ICmpNZ();
			break;

		case OPC_FCMPZ:
			FCmpZ();
			break;

		case OPC_FCMPNZ:
			FCmpNZ();
			break;

		case OPC_DCMPZ:
			DCmpZ();
			break;

		case OPC_DCMPNZ:
			DCmpNZ();
			break;

		case OPC_ICMPNZ_BZ:
			ICmpNzBX(0, i+1+DecodeImm24(ins));
			break;

		case OPC_ICMPNZ_BNZ:
			ICmpNzBX(1, i+1+DecodeImm24(ins));
			break;

		case OPC_FCMPNZ_BZ:
			FCmpNzBX(0, i+1+DecodeImm24(ins));
			break;

		case OPC_FCMPNZ_BNZ:
			FCmpNzBX(1, i+1+DecodeImm24(ins));
			break;

		case OPC_DCMPNZ_BZ:
			DCmpNzBX(false, i + 1 + DecodeImm24(ins));
			break;

		case OPC_DCMPNZ_BNZ:
			DCmpNzBX(true, i + 1 + DecodeImm24(ins));
			break;

		case OPC_ICMPEQ:
			ICmp(COND_Z);
			break;

		case OPC_ICMPNE:
			ICmp(COND_NZ);
			break;

		case OPC_ICMPLT:
			ICmp(COND_LT);
			break;

		case OPC_ICMPLE:
			ICmp(COND_LE);
			break;

		case OPC_ICMPGT:
			ICmp(COND_GT);
			break;

		case OPC_ICMPGE:
			ICmp(COND_GE);
			break;

		case OPC_UICMPLT:
			ICmp(COND_ULT);
			break;

		case OPC_UICMPLE:
			ICmp(COND_ULE);
			break;

		case OPC_UICMPGT:
			ICmp(COND_UGT);
			break;

		case OPC_UICMPGE:
			ICmp(COND_UGE);
			break;

		case OPC_FCMPEQ:
			VMJITX86_OPT_CMP_JMP_FLOAT(COND_Z);
			break;

		case OPC_FCMPNE:
			VMJITX86_OPT_CMP_JMP_FLOAT(COND_NZ);
			break;

		case OPC_FCMPLT:
			VMJITX86_OPT_CMP_JMP_FLOAT(COND_ULT);
			break;

		case OPC_FCMPLE:
			VMJITX86_OPT_CMP_JMP_FLOAT(COND_ULE);
			break;

		case OPC_FCMPGT:
			VMJITX86_OPT_CMP_JMP_FLOAT(COND_UGT);
			break;

		case OPC_FCMPGE:
			VMJITX86_OPT_CMP_JMP_FLOAT(COND_UGE);
			break;

		case OPC_DCMPEQ:
			VMJITX86_OPT_CMP_JMP_DOUBLE(COND_Z);
			break;

		case OPC_DCMPNE:
			VMJITX86_OPT_CMP_JMP_DOUBLE(COND_NZ);
			break;

		case OPC_DCMPLT:
			VMJITX86_OPT_CMP_JMP_DOUBLE(COND_ULT);
			break;

		case OPC_DCMPLE:
			VMJITX86_OPT_CMP_JMP_DOUBLE(COND_ULE);
			break;

		case OPC_DCMPGT:
			VMJITX86_OPT_CMP_JMP_DOUBLE(COND_UGT);
			break;

		case OPC_DCMPGE:
			VMJITX86_OPT_CMP_JMP_DOUBLE(COND_UGE);
			break;

		case OPC_BR:
			EmitJump(COND_ALWAYS, i+1+DecodeImm24(ins));
			break;

		case OPC_IBZ_P:
			IBx(COND_Z, i+1+DecodeImm24(ins), 1);
			break;

		case OPC_IBNZ_P:
			IBx(COND_NZ, i+1+DecodeImm24(ins), 1);
			break;

		case OPC_IBZ:
			ICmpNzBX(false, i + 1 + DecodeImm24(ins), true);
			break;

		case OPC_IBNZ:
			ICmpNzBX(true, i + 1 + DecodeImm24(ins), true);
			break;

		case OPC_FBZ_P:
			FBxP(COND_Z, i+1+DecodeImm24(ins));
			break;

		case OPC_FBNZ_P:
			FBxP(COND_NZ, i+1+DecodeImm24(ins));
			break;

		case OPC_DBZ_P:
			DBxP(COND_Z, i + 1 + DecodeImm24(ins));
			break;

		case OPC_DBNZ_P:
			DBxP(COND_NZ, i + 1 + DecodeImm24(ins));
			break;

		case OPC_IBEQ:
			IBx2(COND_Z, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_IBNE:
			IBx2(COND_NZ, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_IBLT:
			IBx2(COND_LT, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_IBLE:
			IBx2(COND_LE, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_IBGT:
			IBx2(COND_GT, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_IBGE:
			IBx2(COND_GE, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_UIBLT:
			IBx2(COND_ULT, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_UIBLE:
			IBx2(COND_ULE, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_UIBGT:
			IBx2(COND_UGT, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_UIBGE:
			IBx2(COND_UGE, i+1+DecodeImm24(ins), lastIntConst, lastConst);
			break;

		case OPC_FBEQ:
			FBx2(COND_Z, i+1+DecodeImm24(ins));
			break;

		case OPC_FBNE:
			FBx2(COND_NZ, i+1+DecodeImm24(ins));
			break;

		case OPC_FBLT:
			FBx2(COND_ULT, i+1+DecodeImm24(ins));
			break;

		case OPC_FBLE:
			FBx2(COND_ULE, i+1+DecodeImm24(ins));
			break;

		case OPC_FBGT:
			FBx2(COND_UGT, i+1+DecodeImm24(ins));
			break;

		case OPC_FBGE:
			FBx2(COND_UGE, i+1+DecodeImm24(ins));
			break;

		case OPC_DBEQ:
			DBx2(COND_Z, i + 1 + DecodeImm24(ins));
			break;

		case OPC_DBNE:
			DBx2(COND_NZ, i + 1 + DecodeImm24(ins));
			break;

		case OPC_DBLT:
			DBx2(COND_ULT, i + 1 + DecodeImm24(ins));
			break;

		case OPC_DBLE:
			DBx2(COND_ULE, i + 1 + DecodeImm24(ins));
			break;

		case OPC_DBGT:
			DBx2(COND_UGT, i + 1 + DecodeImm24(ins));
			break;

		case OPC_DBGE:
			DBx2(COND_UGE, i + 1 + DecodeImm24(ins));
			break;

		case OPC_PCMPEQ:
			PCx2(COND_Z);
			break;

		case OPC_PCMPNE:
			PCx2(COND_NZ);
			break;

		case OPC_PCMPZ:
			PCx(COND_Z);
			break;

		case OPC_PCMPNZ:
			PCx(COND_NZ);
			break;

		case OPC_IADD_ICONST:
			IAddIConst(DecodeImm24(ins));
			break;

		case OPC_LIADD_ICONST:
		{
			Int src = DecodeUImm8(ins, 1);
			Int dst = DecodeUImm8(ins, 0);

			if (src == dst)
			{
				// optimize special case...
				if (src == 0)
					IAddIConst(DecodeImm8Top(ins));
				else
					AddLocal(src, DecodeImm8Top(ins));
			}
			else
			{
				RegExpr dreg = AllocGprWrite(stackOpt + dst);
				reg = AllocGpr(stackOpt + src, 1);
				{
					DontFlush _(*this);
					Mov(dreg, reg);
				}
				AddAccum(DecodeImm8Top(ins), dreg);
			}
		}
		break;

		case OPC_LIADD:
			AddInt(DecodeUImm8(ins, 0), DecodeUImm8(ins, 1), &VmJitX86::Add);
			break;

		case OPC_LISUB:
			AddInt(DecodeUImm8(ins, 0), DecodeUImm8(ins, 1), &VmJitX86::Sub);
			break;

		case OPC_CALL:
			EmitCall(i+1+DecodeImm24(ins));
			break;

		case OPC_FCALL:
			EmitFCall();
			break;

		case OPC_FCALL_DG:
			EmitFCallDg();
			break;

		case OPC_NCALL:
		case OPC_NMCALL:
		{
			Int nofs = DecodeUImm24(ins);
			EmitNCall(nofs, reinterpret_cast<void *>(cpool.nFunc[nofs]), false, (Byte)ins == OPC_NMCALL);
		}
		break;

		case OPC_BCALL:
		case OPC_BCALL_TRAP:
		case OPC_BMCALL:
		{
			Int nofs = DecodeUImm24(ins);

			if (nofs == BUILTIN_ADD_STRONG)
			{
				// we can do better here!
				AddStrong();
				break;
			}

#if LETHE_64BIT
			do {
#define VMJITX86_POPCONST \\
					LETHE_ASSERT(lastConst); \\
					code.Resize(lastIns); \\
					pcToCode.Back() = pcToCode[pcToCode.GetSize()-2]; \\
					Pop(1);

				// time to inline 64-bit builtins!
				switch(nofs)
				{
				case BUILTIN_PUSH_LCONST:
					{
						VMJITX86_POPCONST

						PushPtrAccum(lastIntConst);
						nofs = -1;
						break;
					}
				case BUILTIN_PUSHC_LCONST:
					{
						VMJITX86_POPCONST

						PushPtrAccum(cpool.lPool[lastIntConst]);
						nofs = -1;
						break;
					}
				case BUILTIN_LPUSH64:
					{
						VMJITX86_POPCONST

						reg = GetPtrNoAdr(lastIntConst);
						Push(1, 0);
						TrackGpr(stackOpt, stackOpt + 1 + lastIntConst);
						nofs = -1;
						break;
					}
				case BUILTIN_LSTORE64:
					{
						VMJITX86_POPCONST

						reg = GetPtrNoAdr(0);
						SetLocalPtr(lastIntConst, reg, 1);
						Pop(1);
						nofs = -1;
						break;
					}
				case BUILTIN_LSTORE64_NP:
					{
						VMJITX86_POPCONST

						reg = GetPtrNoAdr(0);
						SetLocalPtr(lastIntConst, reg, 1);
						nofs = -1;
						break;
					}
				case BUILTIN_LMUL:
					{
						LMul();
						nofs = -1;
						break;
					}
				case BUILTIN_LADD:
					{
						LAdd();
						nofs = -1;
						break;
					}
				case BUILTIN_LSUB:
					{
						LSub();
						nofs = -1;
						break;
					}
				case BUILTIN_LAND:
					{
						LAnd();
						nofs = -1;
						break;
					}
				case BUILTIN_LOR:
					{
						LOr();
						nofs = -1;
						break;
					}
				case BUILTIN_LXOR:
					{
						LXor();
						nofs = -1;
						break;
					}
				case BUILTIN_LSHL:
					{
						LShl();
						nofs = -1;
						break;
					}
				case BUILTIN_LSHR:
					{
						LShr();
						nofs = -1;
						break;
					}
				case BUILTIN_LSAR:
					{
						LSar();
						nofs = -1;
						break;
					}
				case BUILTIN_CONV_LTOI:
					{
						SetLocalInt(0, GetInt(0));
						nofs = -1;
						break;
					}
				case BUILTIN_CONV_ITOL:
					{
						DontFlush _(*this);
						reg = GetPtrNoAdr(0);
						SetLocalPtr(0, reg, 1);
						Movsxd(reg.ToRegPtr(), reg.ToReg32());
						nofs = -1;
						break;
					}
				case BUILTIN_CONV_UITOL:
					// this should be a nop, hopefully
					// but we won't risk it
					{
						DontFlush _(*this);
						reg = GetPtrNoAdr(0);
						SetLocalPtr(0, reg, 1);
						Mov(reg.ToReg32(), reg.ToReg32());
						nofs = -1;
						break;
					}
				case BUILTIN_PLOAD64:
					{
						VMJITX86_POPCONST

						GetIndirectPtr<0>(lastIntConst, 1);
						Pop(1);

						nofs = -1;
						break;
					}
				case BUILTIN_PSTORE64_IMM0:
				case BUILTIN_PSTORE64_IMM0_NP:
					{
						// note: offset is zero!
						StoreIndirectImmPtr(0);
						Pop(2 - (nofs == BUILTIN_PSTORE64_IMM0_NP));
						nofs = -1;
						break;
					}
				case BUILTIN_LNEG:
					{
						LNeg();
						nofs = -1;
						break;
					}
				case BUILTIN_LNOT:
					{
						LNot();
						nofs = -1;
						break;
					}
				case BUILTIN_LCMPNZ:
					{
						PCx(COND_NZ, true);
						nofs = -1;
						break;
					}
				case BUILTIN_LCMPZ:
					{
						PCx(COND_Z, true);
						nofs = -1;
						break;
					}
				case BUILTIN_LCMPEQ:
					{
						PCx2(COND_Z, true);
						nofs = -1;
						break;
					}
				case BUILTIN_LCMPNE:
					{
						PCx2(COND_NZ, true);
						nofs = -1;
						break;
					}
				case BUILTIN_INTRIN_BSFL:
					{
						LBsf();
						nofs = -1;
						break;
					}
				case BUILTIN_INTRIN_BSRL:
					{
						LBsr();
						nofs = -1;
						break;
					}
				case BUILTIN_INTRIN_POPCNTL:
					if (hwPopCnt)
					{
						LPopCnt();
						nofs = -1;
					}
					break;
				case BUILTIN_INTRIN_BSWAPL:
					{
						LBswap();
						nofs = -1;
						break;
					}
				case BUILTIN_GLOAD64:
					{
						VMJITX86_POPCONST

						reg = GetGlobalPtr(lastIntConst);
						nofs = -1;
						break;
					}
				case BUILTIN_GSTORE64:
					{
						VMJITX86_POPCONST

						reg = GetPtrNoAdr(0);
						SetGlobalPtr(lastIntConst, reg);
						Pop(1);
						nofs = -1;
						break;
					}
				case BUILTIN_PINC64:
					{
						VMJITX86_POPCONST
						PInc<8, 0>(lastIntConst);
						nofs = -1;
						break;
					}
				case BUILTIN_PINC64_POST:
					{
						VMJITX86_POPCONST

						PIncPost<8, 0>(lastIntConst);
						nofs = -1;
						break;
					}
				case BUILTIN_LCMPLT:
					{
						LCmp(COND_LT);
						nofs = -1;
						break;
					}
				case BUILTIN_LCMPLE:
					{
						LCmp(COND_LE);
						nofs = -1;
						break;
					}
				case BUILTIN_LCMPGT:
					{
						LCmp(COND_GT);
						nofs = -1;
						break;
					}
				case BUILTIN_LCMPGE:
					{
						LCmp(COND_GE);
						nofs = -1;
						break;
					}
				case BUILTIN_ULCMPLT:
					{
						LCmp(COND_ULT);
						nofs = -1;
						break;
					}
				case BUILTIN_ULCMPLE:
					{
						LCmp(COND_ULE);
						nofs = -1;
						break;
					}
				case BUILTIN_ULCMPGT:
					{
						LCmp(COND_UGT);
						nofs = -1;
						break;
					}
				case BUILTIN_ULCMPGE:
					{
						LCmp(COND_UGE);
						nofs = -1;
						break;
					}
				}
#undef VMJITX86_POPCONST
			} while(false);
#endif

			switch(nofs)
			{
			case BUILTIN_INTRIN_BSF:
				{
					UBsf();
					nofs = -1;
					break;
				}
			case BUILTIN_INTRIN_BSR:
				{
					UBsr();
					nofs = -1;
					break;
				}
			case BUILTIN_INTRIN_POPCNT:
				if (hwPopCnt)
				{
					UPopCnt();
					nofs = -1;
				}
				break;
			case BUILTIN_INTRIN_BSWAP:
				{
					UBswap();
					nofs = -1;
					break;
				}
			default:;
			}

			if (nofs != -1)
				EmitNCall(nofs, reinterpret_cast<void *>(cpool.nFunc[nofs]), true, (Byte)ins == OPC_BMCALL);
		}
		break;

		case OPC_VCALL:
			EmitVCall(DecodeImm24(ins));
			break;

		case OPC_RET:
			if (fastCall)
			{
				Pop(DecodeUImm24(ins));
				Retn();
			}
			else
			{
				Pop(DecodeUImm24(ins) + 1);
				// jmp dword [edi-4]
				EmitNew(0xff);
				Emit(0x67);
				Emit(0xfc);
			}

			break;

		case OPC_LOADTHIS:
			LoadThis(0, 0);
			break;

		case OPC_LOADTHIS_IMM:
			LoadThis(1, DecodeImm24(ins));
			break;

		case OPC_PUSHTHIS:
		case OPC_PUSHTHIS_TEMP:
			PushThis();
			break;

		case OPC_POPTHIS:
			PopThis();
			break;

		case OPC_CONV_ITOF:
			IToF();
			break;

		case OPC_CONV_UITOF:
			UIToF();
			break;

		case OPC_CONV_FTOI:
			FToI();
			break;

		case OPC_CONV_FTOUI:
			FToUI();
			break;

		case OPC_CONV_FTOD:
			FToD();
			break;

		case OPC_CONV_DTOF:
			DToF();
			break;

		case OPC_CONV_ITOD:
			IToD();
			break;

		case OPC_CONV_UITOD:
			UIToD();
			break;

		case OPC_CONV_DTOI:
			DToI();
			break;

		case OPC_CONV_DTOUI:
			DToUI();
			break;

		case OPC_CONV_ITOS:
			IToS();
			break;

		case OPC_CONV_ITOSB:
			IToSB();
			break;

		case OPC_CONV_PTOB:
			PToB();
			break;

		case OPC_INEG:
			INeg();
			break;

		case OPC_INOT:
			INot();
			break;

		case OPC_FNEG:
			FNeg();
			break;

		case OPC_DNEG:
			DNeg();
			break;

		case OPC_HALT:
		case OPC_BREAK:

			// plain ret
			if (fastCall)
				Int3();
			else
				Retn();

			break;

		case OPC_CHKSTK:
		{
			Int limit = DecodeUImm24(ins);
			limit *= Stack::WORD_SIZE;

			// lea eax, [edi+const]
			Lea(Eax.ToRegPtr(), MemPtr(Edi - limit));
			// [esi] = stack bottom
			// sub eax,[esi + ...]
			Sub(Eax.ToRegPtr(), MemPtr(StackObjectPtr() + 2*Stack::WORD_SIZE));
			// jae $+1
			EmitNew(0x73);
			Emit(0x01);
			// int 3
			Int3();
		}
		break;

		case OPC_SWITCH:
		{
			Int range = DecodeUImm24(ins);
			SwitchTable(prog, range, i);
			i += range + 1;
			nextBarrier = prog.barriers[++nextBarrierIndex];
		}
		break;

		case OPC_FSQRT:
			FSqrt();
			break;

		case OPC_DSQRT:
			DSqrt();
			break;

		default:
			LETHE_ASSERT(false && ""opcode not handled!"");
		}

		// silence clang analyzer
		(void)lastConst;

		lastConst = 0;
	}

	prevPcToCode = pcToCode;

	DoFixups(prog, pass);

	prog.jitRef = this;
	return 1;

#undef VMJITX86_OPT_CMP_JMP_FLOAT
#undef VMJITX86_OPT_CMP_JMP_DOUBLE
#undef VMJITX86_OPT_CMP_JMP_FLOAT_CUSTOM
}

const void *VmJitX86::GetCodePtr(Int pc) const
{
	if (pc < 0 || pc >= pcToCode.GetSize())
		return nullptr;

	return code.GetData() + pcToCode[pc];
}

Int VmJitX86::FindFunctionPC(const void *address) const
{
	auto ci = funcCodeToPC.Find(address);
	return ci == funcCodeToPC.End() ? -1 : ci->value;
}

#undef VMJITX86_CAN_CHAIN_AADD

#if LETHE_COMPILER_MSC_ONLY
#	pragma warning(push)
#	pragma warning(disable:4740)
#	pragma warning(disable:4731)
#endif

ExecResult VmJitX86::ExecScriptFunc(Vm &vm, Int scriptPC)
{
	return ExecScriptFuncPtr(vm, code.GetData() + pcToCode[scriptPC]);
}

ExecResult VmJitX86::ExecScriptFuncPtr(Vm &vm, const void *codeadr)
{
	// edi  = stack ptr
	// esi  = Stack object ptr
	// ebp  = this ptr

	// x64:
	// REX prefix comes after word-size prefixes (66/67)
	// r12..r15 preserved across calls by both Win/Unix ABI
	// first arg passed in: rcx for Win, rdi for Unix
	//
	// rsi = global ptr (because we want short encoding)
	// r12 = stack object ptr
	//
	// => need to rename a bit...
	// stkPtrReg = Edi
	// stkObjReg = R12d
	// thisPtrReg = Ebp
	// globalBaseReg = 0/Esi => will be used for native calls

	Stack &stk = *vm.stack;
	void *stkadr = &stk;
	void *stktop = stk.GetTop();
	const void *thisadr = stk.GetThis();

	stk.cpool = &vm.prog->cpool;

#if LETHE_32BIT

	if (fastCall)
	{
#if LETHE_COMPILER_MSC_ONLY
		__asm
		{
			pushad
			mov edi, [stktop]
			mov esi, [stkadr]
			mov eax,[codeadr]
			mov ebp, [thisadr]
			call eax
			mov [esi+0], edi
			popad
		}
#else
		asm(
			""movl %0, %%edi;""
			""movl %1, %%esi;""
			""movl %2, %%eax;""
			""movl %3, %%ecx;""
			""pushl %%ebp;""
			""movl %%ecx, %%ebp;""
			""call *%%eax;""
			""popl %%ebp;""
			""movl %%edi, 0(%%esi);""
			: : ""m""(stktop), ""m""(stkadr), ""m""(codeadr), ""m""(thisadr) :
			""cc"", ""eax"", ""ebx"", ""ecx"", ""edx"", ""esi"", ""edi""
		);
#endif
		return EXEC_OK;
	}

	// FIXME: doesn't set/restore ebp (thisPtr)

#if LETHE_COMPILER_MSC_ONLY
	__asm
	{
		pushad
		mov edi,[stktop]
		mov esi,[stkadr]
		mov ecx, [codeadr]
		mov ebp,[thisadr]
		sub edi,4
		lea eax,[_retadr]
		mov dword ptr [edi],eax
		jmp dword ptr [ecx]
		_retadr:
		mov [esi+0],edi
		popad
	}
#else
	asm(
		""movl %0, %%edi;""
		""movl %1, %%esi;""
		""subl $4, %%edi;""
		""leal (_retadr), %%eax;""
		""movl %%eax, (%%edi);""
		""movl %3, %%ecx;""
		""movl %2, %%eax;""
		""pushl %%ebp;""
		""movl %%ecx,%%ebp;""
		""jmp *%%eax;""
		""_retadr:;""
		""popl %%ebp;""
		""movl %%edi, 0(%%esi);""
		: : ""m""(stktop), ""m""(stkadr), ""m""(codeadr), ""m""(thisadr) :
		""cc"", ""eax"", ""ebx"", ""ecx"", ""edx"", ""esi"", ""edi""
	);
#endif

#else
	// TODO: 64-bit stub...
	LETHE_ASSERT(fastCall);

#	if LETHE_COMPILER_MSC_ONLY
	const void *param[] =
	{
		stktop,
		stkadr,
		codeadr,
		thisadr,
		stk.GetConstantPool().GetGlobalData(),
		code.GetData()
	};
	VmJitX64_Stub(param);
#	else
	auto gdata = stk.cpool->data.GetData();
	auto gcode = code.GetData();
	// the rest of the world (gcc/clang) having inline assembly
	asm(
		""movq %0, %%rdi;""
		""movq %1, %%r12;""
		""movq %2, %%rax;""
		""movq %3, %%rcx;""
		""movq %4, %%rsi;""
		""movq %5, %%r13;""
		""pushq %%rbp;""
		""movq %%rcx, %%rbp;""
		""call *%%rax;""
		""popq %%rbp;""
		""movq %%rdi, 0(%%r12);""
		: : ""m""(stktop), ""m""(stkadr), ""m""(codeadr), ""m""(thisadr), ""m""(gdata), ""m""(gcode) :
		""cc"", ""rax"", ""rbx"", ""rcx"", ""rdx"", ""rsi"", ""rdi"", ""r12"", ""r13"", ""r14"",
		""xmm0"", ""xmm1"", ""xmm2"", ""xmm3"", ""xmm4"", ""xmm5"", ""xmm6"", ""xmm7""
	);
#	endif

#endif

	return EXEC_OK;
}


}

#if LETHE_COMPILER_MSC_ONLY
#	pragma warning(pop)
#endif

#endif
",16300,True,3520.880656965102,median
"[[netty-component]]
= Netty Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: components/camel-netty/src/main/docs/netty-component.adoc
:docTitle: Netty
:artifactId: camel-netty
:description: Socket level networking using TCP or UDP with the Netty 4.x.
:since: 2.14
:supportLevel: Stable
:component-header: Both producer and consumer are supported
include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/netty.adoc[]

*Since Camel {since}*

*{component-header}*

The Netty component in Camel is a socket communication component,
based on the http://netty.io/[Netty] project version 4. +
 Netty is a NIO client server framework which enables quick and easy
development of networkServerInitializerFactory applications such as
protocol servers and clients. +
 Netty greatly simplifies and streamlines network programming such as
TCP and UDP socket server.

This camel component supports both producer and consumer endpoints.

The Netty component has several options and allows fine-grained control
of a number of TCP/UDP communication parameters (buffer sizes,
keepAlives, tcpNoDelay, etc) and facilitates both In-Only and In-Out
communication on a Camel route.

Maven users will need to add the following dependency to their `pom.xml`
for this component:

[source,xml]
----
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-netty</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
----

== URI format

The URI scheme for a netty component is as follows

[source,text]
----
netty:tcp://0.0.0.0:99999[?options]
netty:udp://remotehost:99999/[?options]
----

This component supports producer and consumer endpoints for both TCP and
UDP.

You can append query options to the URI in the following format,
`?option=value&option=value&...`

== Options

// component options: START
The Netty component supports 72 options, which are listed below.



[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *configuration* (common) | To use the NettyConfiguration as configuration when creating endpoints. |  | NettyConfiguration
| *disconnect* (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean
| *keepAlive* (common) | Setting to ensure socket is not closed due to inactivity | true | boolean
| *reuseAddress* (common) | Setting to facilitate socket multiplexing | true | boolean
| *reuseChannel* (common) | This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. | false | boolean
| *sync* (common) | Setting to set endpoint as one-way or request-response | true | boolean
| *tcpNoDelay* (common) | Setting to improve TCP protocol performance | true | boolean
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *broadcast* (consumer) | Setting to choose Multicast over UDP | false | boolean
| *clientMode* (consumer) | If the clientMode is true, netty consumer will connect the address as a TCP client. | false | boolean
| *reconnect* (consumer) | Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled | true | boolean
| *reconnectInterval* (consumer) | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection | 10000 | int
| *backlog* (consumer) | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the accept queue can be If this option is not configured, then the backlog depends on OS setting. |  | int
| *bossCount* (consumer) | When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty | 1 | int
| *bossGroup* (consumer) | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint |  | EventLoopGroup
| *disconnectOnNoReply* (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean
| *executorService* (consumer) | To use the given EventExecutorGroup. |  | EventExecutorGroup
| *maximumPoolSize* (consumer) | Sets a maximum thread pool size for the netty consumer ordered thread pool. The default size is 2 x cpu_core plus 1. Setting this value to eg 10 will then use 10 threads unless 2 x cpu_core plus 1 is a higher value, which then will override and be used. For example if there are 8 cores, then the consumer thread pool will be 17. This thread pool is used to route messages received from Netty by Camel. We use a separate thread pool to ensure ordering of messages and also in case some messages will block, then nettys worker threads (event loop) wont be affected. |  | int
| *nettyServerBootstrapFactory* (consumer) | To use a custom NettyServerBootstrapFactory |  | NettyServerBootstrapFactory
| *networkInterface* (consumer) | When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group. |  | String
| *noReplyLogLevel* (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | WARN | LoggingLevel
| *serverClosedChannelException{zwsp}CaughtLogLevel* (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | DEBUG | LoggingLevel
| *serverExceptionCaughtLogLevel* (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | WARN | LoggingLevel
| *serverInitializerFactory* (consumer) | To use a custom ServerInitializerFactory |  | ServerInitializerFactory
| *usingExecutorService* (consumer) | Whether to use ordered thread pool, to ensure events are processed orderly on the same channel. | true | boolean
| *connectTimeout* (producer) | Time to wait for a socket connection to be available. Value is in milliseconds. | 10000 | int
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *requestTimeout* (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. |  | long
| *clientInitializerFactory* (producer) | To use a custom ClientInitializerFactory |  | ClientInitializerFactory
| *correlationManager* (producer) | To use a custom correlation manager to manage how request and reply messages are mapped when using request/reply with the netty producer. This should only be used if you have a way to map requests together with replies such as if there is correlation ids in both the request and reply messages. This can be used if you want to multiplex concurrent messages on the same channel (aka connection) in netty. When doing this you must have a way to correlate the request and reply messages so you can store the right reply on the inflight Camel Exchange before its continued routed. We recommend extending the TimeoutCorrelationManagerSupport when you build custom correlation managers. This provides support for timeout and other complexities you otherwise would need to implement as well. See also the producerPoolEnabled option for more details. |  | NettyCamelStateCorrelationManager
| *lazyChannelCreation* (producer) | Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started. | true | boolean
| *producerPoolEnabled* (producer) | Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details. | true | boolean
| *producerPoolMaxActive* (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int
| *producerPoolMaxIdle* (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int
| *producerPoolMinEvictableIdle* (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long
| *producerPoolMinIdle* (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. |  | int
| *udpConnectionlessSending* (producer) | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. | false | boolean
| *useByteBuf* (producer) | If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out. | false | boolean
| *allowSerializedHeaders* (advanced) | Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean
| *basicPropertyBinding* (advanced) | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *channelGroup* (advanced) | To use a explicit ChannelGroup. |  | ChannelGroup
| *nativeTransport* (advanced) | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: \\http://netty.io/wiki/native-transports.html | false | boolean
| *options* (advanced) | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. |  | Map
| *receiveBufferSize* (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | int
| *receiveBufferSizePredictor* (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. |  | int
| *sendBufferSize* (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | int
| *transferExchange* (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean
| *udpByteArrayCodec* (advanced) | For UDP only. If enabled the using byte array codec instead of Java serialization protocol. | false | boolean
| *workerCount* (advanced) | When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty. |  | int
| *workerGroup* (advanced) | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. |  | EventLoopGroup
| *allowDefaultCodec* (codec) | The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. | true | boolean
| *autoAppendDelimiter* (codec) | Whether or not to auto append missing end delimiter when sending using the textline codec. | true | boolean
| *decoderMaxLineLength* (codec) | The max line length to use for the textline codec. | 1024 | int
| *decoders* (codec) | A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. |  | List
| *delimiter* (codec) | The delimiter to use for the textline codec. Possible values are LINE and NULL. There are 2 enums and the value can be one of: LINE, NULL | LINE | TextLineDelimiter
| *encoders* (codec) | A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. |  | List
| *encoding* (codec) | The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset. |  | String
| *textline* (codec) | Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default. | false | boolean
| *enabledProtocols* (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String
| *keyStoreFile* (security) | Client side certificate keystore to be used for encryption |  | File
| *keyStoreFormat* (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set |  | String
| *keyStoreResource* (security) | Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. |  | String
| *needClientAuth* (security) | Configures whether the server needs client authentication when using SSL. | false | boolean
| *passphrase* (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH |  | String
| *securityProvider* (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. |  | String
| *ssl* (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean
| *sslClientCertHeaders* (security) | When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range. | false | boolean
| *sslContextParameters* (security) | To configure security using SSLContextParameters |  | SSLContextParameters
| *sslHandler* (security) | Reference to a class that could be used to return an SSL Handler |  | SslHandler
| *trustStoreFile* (security) | Server side certificate keystore to be used for encryption |  | File
| *trustStoreResource* (security) | Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. |  | String
| *useGlobalSslContextParameters* (security) | Enable usage of global SSL context parameters. | false | boolean
|===
// component options: END


// endpoint options: START
The Netty endpoint is configured using URI syntax:

----
netty:protocol:host:port
----

with the following path and query parameters:

=== Path Parameters (3 parameters):


[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *protocol* | *Required* The protocol to use which can be tcp or udp. There are 2 enums and the value can be one of: tcp, udp |  | String
| *host* | *Required* The hostname. For the consumer the hostname is localhost or 0.0.0.0. For the producer the hostname is the remote host to connect to |  | String
| *port* | *Required* The host port number |  | int
|===


=== Query Parameters (71 parameters):


[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *disconnect* (common) | Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. | false | boolean
| *keepAlive* (common) | Setting to ensure socket is not closed due to inactivity | true | boolean
| *reuseAddress* (common) | Setting to facilitate socket multiplexing | true | boolean
| *reuseChannel* (common) | This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well. | false | boolean
| *sync* (common) | Setting to set endpoint as one-way or request-response | true | boolean
| *tcpNoDelay* (common) | Setting to improve TCP protocol performance | true | boolean
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *broadcast* (consumer) | Setting to choose Multicast over UDP | false | boolean
| *clientMode* (consumer) | If the clientMode is true, netty consumer will connect the address as a TCP client. | false | boolean
| *reconnect* (consumer) | Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled | true | boolean
| *reconnectInterval* (consumer) | Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection | 10000 | int
| *backlog* (consumer) | Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the accept queue can be If this option is not configured, then the backlog depends on OS setting. |  | int
| *bossCount* (consumer) | When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty | 1 | int
| *bossGroup* (consumer) | Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint |  | EventLoopGroup
| *disconnectOnNoReply* (consumer) | If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back. | true | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |  | ExchangePattern
| *nettyServerBootstrapFactory* (consumer) | To use a custom NettyServerBootstrapFactory |  | NettyServerBootstrapFactory
| *networkInterface* (consumer) | When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group. |  | String
| *noReplyLogLevel* (consumer) | If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | WARN | LoggingLevel
| *serverClosedChannelException{zwsp}CaughtLogLevel* (consumer) | If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | DEBUG | LoggingLevel
| *serverExceptionCaughtLogLevel* (consumer) | If the server (NettyConsumer) catches an exception then its logged using this logging level. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | WARN | LoggingLevel
| *serverInitializerFactory* (consumer) | To use a custom ServerInitializerFactory |  | ServerInitializerFactory
| *usingExecutorService* (consumer) | Whether to use ordered thread pool, to ensure events are processed orderly on the same channel. | true | boolean
| *connectTimeout* (producer) | Time to wait for a socket connection to be available. Value is in milliseconds. | 10000 | int
| *lazyStartProducer* (producer) | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. | false | boolean
| *requestTimeout* (producer) | Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout. |  | long
| *clientInitializerFactory* (producer) | To use a custom ClientInitializerFactory |  | ClientInitializerFactory
| *correlationManager* (producer) | To use a custom correlation manager to manage how request and reply messages are mapped when using request/reply with the netty producer. This should only be used if you have a way to map requests together with replies such as if there is correlation ids in both the request and reply messages. This can be used if you want to multiplex concurrent messages on the same channel (aka connection) in netty. When doing this you must have a way to correlate the request and reply messages so you can store the right reply on the inflight Camel Exchange before its continued routed. We recommend extending the TimeoutCorrelationManagerSupport when you build custom correlation managers. This provides support for timeout and other complexities you otherwise would need to implement as well. See also the producerPoolEnabled option for more details. |  | NettyCamelStateCorrelationManager
| *lazyChannelCreation* (producer) | Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started. | true | boolean
| *producerPoolEnabled* (producer) | Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details. | true | boolean
| *producerPoolMaxActive* (producer) | Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit. | -1 | int
| *producerPoolMaxIdle* (producer) | Sets the cap on the number of idle instances in the pool. | 100 | int
| *producerPoolMinEvictableIdle* (producer) | Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor. | 300000 | long
| *producerPoolMinIdle* (producer) | Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects. |  | int
| *udpConnectionlessSending* (producer) | This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port. | false | boolean
| *useByteBuf* (producer) | If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out. | false | boolean
| *allowSerializedHeaders* (advanced) | Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean
| *basicPropertyBinding* (advanced) | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | boolean
| *channelGroup* (advanced) | To use a explicit ChannelGroup. |  | ChannelGroup
| *nativeTransport* (advanced) | Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: \\http://netty.io/wiki/native-transports.html | false | boolean
| *options* (advanced) | Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used. |  | Map
| *receiveBufferSize* (advanced) | The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes. | 65536 | int
| *receiveBufferSizePredictor* (advanced) | Configures the buffer size predictor. See details at Jetty documentation and this mail thread. |  | int
| *sendBufferSize* (advanced) | The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes. | 65536 | int
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean
| *transferExchange* (advanced) | Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level. | false | boolean
| *udpByteArrayCodec* (advanced) | For UDP only. If enabled the using byte array codec instead of Java serialization protocol. | false | boolean
| *workerCount* (advanced) | When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty. |  | int
| *workerGroup* (advanced) | To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads. |  | EventLoopGroup
| *allowDefaultCodec* (codec) | The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain. | true | boolean
| *autoAppendDelimiter* (codec) | Whether or not to auto append missing end delimiter when sending using the textline codec. | true | boolean
| *decoderMaxLineLength* (codec) | The max line length to use for the textline codec. | 1024 | int
| *decoders* (codec) | A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. |  | List
| *delimiter* (codec) | The delimiter to use for the textline codec. Possible values are LINE and NULL. There are 2 enums and the value can be one of: LINE, NULL | LINE | TextLineDelimiter
| *encoders* (codec) | A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup. |  | List
| *encoding* (codec) | The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset. |  | String
| *textline* (codec) | Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default. | false | boolean
| *enabledProtocols* (security) | Which protocols to enable when using SSL | TLSv1,TLSv1.1,TLSv1.2 | String
| *keyStoreFile* (security) | Client side certificate keystore to be used for encryption |  | File
| *keyStoreFormat* (security) | Keystore format to be used for payload encryption. Defaults to JKS if not set |  | String
| *keyStoreResource* (security) | Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. |  | String
| *needClientAuth* (security) | Configures whether the server needs client authentication when using SSL. | false | boolean
| *passphrase* (security) | Password setting to use in order to encrypt/decrypt payloads sent using SSH |  | String
| *securityProvider* (security) | Security provider to be used for payload encryption. Defaults to SunX509 if not set. |  | String
| *ssl* (security) | Setting to specify whether SSL encryption is applied to this endpoint | false | boolean
| *sslClientCertHeaders* (security) | When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range. | false | boolean
| *sslContextParameters* (security) | To configure security using SSLContextParameters |  | SSLContextParameters
| *sslHandler* (security) | Reference to a class that could be used to return an SSL Handler |  | SslHandler
| *trustStoreFile* (security) | Server side certificate keystore to be used for encryption |  | File
| *trustStoreResource* (security) | Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems. |  | String
|===
// endpoint options: END



== Registry based Options

Codec Handlers and SSL Keystores can be enlisted in the Registry, such as in the Spring XML file.
The values that could be passed in, are the following:

[width=""100%"",cols=""10%,90%"",options=""header"",]
|===
|Name |Description

|`passphrase` |password setting to use in order to encrypt/decrypt payloads sent using
SSH

|`keyStoreFormat` |keystore format to be used for payload encryption. Defaults to ""JKS"" if
not set

|`securityProvider` |Security provider to be used for payload encryption. Defaults to
""SunX509"" if not set.

|`keyStoreFile` |*deprecated:* Client side certificate keystore to be used for encryption

|`trustStoreFile` |*deprecated:* Server side certificate keystore to be used for encryption

|`keyStoreResource` |Client side certificate keystore to be used for
encryption. Is loaded by default from classpath, but you can prefix with
`""classpath:""`, `""file:""`, or `""http:""` to load the resource from
different systems.

|`trustStoreResource` |Server side certificate keystore to be used for
encryption. Is loaded by default from classpath, but you can prefix with
`""classpath:""`, `""file:""`, or `""http:""` to load the resource from
different systems.

|`sslHandler` |Reference to a class that could be used to return an SSL Handler

|`encoder` |A custom `ChannelHandler` class that can be used to perform special
marshalling of outbound payloads. Must override
io.netty.channel.ChannelInboundHandlerAdapter.

|`encoders` |A list of encoders to be used. You can use a String which have values
separated by comma, and have the values be looked up in the
Registry. Just remember to prefix the value with #
so Camel knows it should lookup.

|`decoder` |A custom `ChannelHandler` class that can be used to perform special
marshalling of inbound payloads. Must override
io.netty.channel.ChannelOutboundHandlerAdapter.

|`decoders` |A list of decoders to be used. You can use a String which have values
separated by comma, and have the values be looked up in the
Registry. Just remember to prefix the value with #
so Camel knows it should lookup.
|===

[NOTE]
====
Read below about using non shareable encoders/decoders.
====

=== Using non shareable encoders or decoders

If your encoders or decoders are not shareable (e.g. they don't have the
@Shareable class annotation), then your encoder/decoder must implement
the `org.apache.camel.component.netty.ChannelHandlerFactory` interface,
and return a new instance in the `newChannelHandler` method. This is to
ensure the encoder/decoder can safely be used. If this is not the case,
then the Netty component will log a WARN when an endpoint is created.

The Netty component offers a
`org.apache.camel.component.netty.ChannelHandlerFactories` factory
class, that has a number of commonly used methods.

== Sending Messages to/from a Netty endpoint

=== Netty Producer

In Producer mode, the component provides the ability to send payloads to
a socket endpoint using either TCP or UDP protocols (with optional SSL support).

The producer mode supports both one-way and request-response based operations.

=== Netty Consumer

In Consumer mode, the component provides the ability to:

* listen on a specified socket using either TCP or UDP protocols (with
optional SSL support),
* receive requests on the socket using text/xml, binary and serialized
object based payloads and
* send them along on a route as message exchanges.

The consumer mode supports both one-way and request-response based
operations.

== Examples

=== A UDP Netty endpoint using Request-Reply and serialized object payload

Note that Object serialization is not allowed by default, and so a decoder must be configured.

[source,java]
----
@BindToRegistry(""decoder"")
public ChannelHandler getDecoder() throws Exception {
    return new DefaultChannelHandlerFactory() {
        @Override
        public ChannelHandler newChannelHandler() {
            return new DatagramPacketObjectDecoder(ClassResolvers.weakCachingResolver(null));
        }
    };
}

RouteBuilder builder = new RouteBuilder() {
  public void configure() {
    from(""netty:udp://0.0.0.0:5155?sync=true&decoders=#decoder"")
      .process(new Processor() {
         public void process(Exchange exchange) throws Exception {
           Poetry poetry = (Poetry) exchange.getIn().getBody();
           // Process poetry in some way
           exchange.getOut().setBody(""Message received);
         }
       }
    }
};
----

=== A TCP based Netty consumer endpoint using One-way communication

[source,java]
----
RouteBuilder builder = new RouteBuilder() {
  public void configure() {
       from(""netty:tcp://0.0.0.0:5150"")
           .to(""mock:result"");
  }
};
----

=== An SSL/TCP based Netty consumer endpoint using Request-Reply communication

[[Netty-UsingtheJSSEConfigurationUtility]]
Using the JSSE Configuration Utility

The Netty component supports SSL/TLS configuration
through the xref:manual::camel-configuration-utilities.adoc[Camel JSSE
Configuration Utility].  This utility greatly decreases the amount of
component specific code you need to write and is configurable at the
endpoint and component levels.  The following examples demonstrate how
to use the utility with the Netty component.

[[Netty-Programmaticconfigurationofthecomponent]]
Programmatic configuration of the component

[source,java]
----
KeyStoreParameters ksp = new KeyStoreParameters();
ksp.setResource(""/users/home/server/keystore.jks"");
ksp.setPassword(""keystorePassword"");

KeyManagersParameters kmp = new KeyManagersParameters();
kmp.setKeyStore(ksp);
kmp.setKeyPassword(""keyPassword"");

SSLContextParameters scp = new SSLContextParameters();
scp.setKeyManagers(kmp);

NettyComponent nettyComponent = getContext().getComponent(""netty"", NettyComponent.class);
nettyComponent.setSslContextParameters(scp);
----

[[Netty-SpringDSLbasedconfigurationofendpoint]]
Spring DSL based configuration of endpoint

[source,xml]
----
...
  <camel:sslContextParameters
      id=""sslContextParameters"">
    <camel:keyManagers
        keyPassword=""keyPassword"">
      <camel:keyStore
          resource=""/users/home/server/keystore.jks""
          password=""keystorePassword""/>
    </camel:keyManagers>
  </camel:sslContextParameters>...
...
  <to uri=""netty:tcp://0.0.0.0:5150?sync=true&ssl=true&sslContextParameters=#sslContextParameters""/>
...
----

[[Netty-UsingBasicSSLTLSconfigurationontheJettyComponent]]
Using Basic SSL/TLS configuration on the Jetty Component

[source,java]
----
Registry registry = context.getRegistry();
registry.bind(""password"", ""changeit"");
registry.bind(""ksf"", new File(""src/test/resources/keystore.jks""));
registry.bind(""tsf"", new File(""src/test/resources/keystore.jks""));

context.addRoutes(new RouteBuilder() {
  public void configure() {
      String netty_ssl_endpoint =
         ""netty:tcp://0.0.0.0:5150?sync=true&ssl=true&passphrase=#password""
         + ""&keyStoreFile=#ksf&trustStoreFile=#tsf"";
      String return_string =
         ""When You Go Home, Tell Them Of Us And Say,""
         + ""For Your Tomorrow, We Gave Our Today."";

      from(netty_ssl_endpoint)
       .process(new Processor() {
          public void process(Exchange exchange) throws Exception {
            exchange.getOut().setBody(return_string);
          }
       }
  }
});
----

[[Netty-GettingaccesstoSSLSessionandtheclientcertificate]]
Getting access to SSLSession and the client certificate

You can get access to the `javax.net.ssl.SSLSession` if you eg need to
get details about the client certificate. When `ssl=true` then the
xref:netty-component.adoc[Netty] component will store the `SSLSession` as a
header on the Camel Message as shown below:

[source,java]
----
SSLSession session = exchange.getIn().getHeader(NettyConstants.NETTY_SSL_SESSION, SSLSession.class);
// get the first certificate which is client certificate
javax.security.cert.X509Certificate cert = session.getPeerCertificateChain()[0];
Principal principal = cert.getSubjectDN();
----

Remember to set `needClientAuth=true` to authenticate the client,
otherwise `SSLSession` cannot access information about the client
certificate, and you may get an exception
`javax.net.ssl.SSLPeerUnverifiedException: peer not authenticated`. You
may also get this exception if the client certificate is expired or not
valid etc.

[TIP]
====
The option `sslClientCertHeaders` can be set to `true` which then
enriches the Camel Message with headers having
details about the client certificate. For example the subject name is
readily available in the header `CamelNettySSLClientCertSubjectName`.
====

=== Using Multiple Codecs

In certain cases it may be necessary to add chains of encoders and
decoders to the netty pipeline. To add multpile codecs to a camel netty
endpoint the 'encoders' and 'decoders' uri parameters should be used.
Like the 'encoder' and 'decoder' parameters they are used to supply
references (lists of ChannelUpstreamHandlers and
ChannelDownstreamHandlers) that should be added to the pipeline. Note
that if encoders is specified then the encoder param will be ignored,
similarly for decoders and the decoder param.

[NOTE]
====
Read further above about using non shareable encoders/decoders.
====

The lists of codecs need to be added to the Camel's registry so they can
be resolved when the endpoint is created.

[source,java]
----
ChannelHandlerFactory lengthDecoder = ChannelHandlerFactories.newLengthFieldBasedFrameDecoder(1048576, 0, 4, 0, 4);

StringDecoder stringDecoder = new StringDecoder();
registry.bind(""length-decoder"", lengthDecoder);
registry.bind(""string-decoder"", stringDecoder);

LengthFieldPrepender lengthEncoder = new LengthFieldPrepender(4);
StringEncoder stringEncoder = new StringEncoder();
registry.bind(""length-encoder"", lengthEncoder);
registry.bind(""string-encoder"", stringEncoder);

List<ChannelHandler> decoders = new ArrayList<ChannelHandler>();
decoders.add(lengthDecoder);
decoders.add(stringDecoder);

List<ChannelHandler> encoders = new ArrayList<ChannelHandler>();
encoders.add(lengthEncoder);
encoders.add(stringEncoder);

registry.bind(""encoders"", encoders);
registry.bind(""decoders"", decoders);
----

Spring's native collections support can be used to specify the codec
lists in an application context

[source,xml]
----
<util:list id=""decoders"" list-class=""java.util.LinkedList"">
        <bean class=""org.apache.camel.component.netty.ChannelHandlerFactories"" factory-method=""newLengthFieldBasedFrameDecoder"">
            <constructor-arg value=""1048576""/>
            <constructor-arg value=""0""/>
            <constructor-arg value=""4""/>
            <constructor-arg value=""0""/>
            <constructor-arg value=""4""/>
        </bean>
        <bean class=""io.netty.handler.codec.string.StringDecoder""/>
    </util:list>

    <util:list id=""encoders"" list-class=""java.util.LinkedList"">
        <bean class=""io.netty.handler.codec.LengthFieldPrepender"">
            <constructor-arg value=""4""/>
        </bean>
        <bean class=""io.netty.handler.codec.string.StringEncoder""/>
    </util:list>

    <bean id=""length-encoder"" class=""io.netty.handler.codec.LengthFieldPrepender"">
        <constructor-arg value=""4""/>
    </bean>
    <bean id=""string-encoder"" class=""io.netty.handler.codec.string.StringEncoder""/>

    <bean id=""length-decoder"" class=""org.apache.camel.component.netty.ChannelHandlerFactories"" factory-method=""newLengthFieldBasedFrameDecoder"">
        <constructor-arg value=""1048576""/>
        <constructor-arg value=""0""/>
        <constructor-arg value=""4""/>
        <constructor-arg value=""0""/>
        <constructor-arg value=""4""/>
    </bean>
    <bean id=""string-decoder"" class=""io.netty.handler.codec.string.StringDecoder""/>
----

The bean names can then be used in netty endpoint definitions either as
a comma separated list or contained in a List e.g.

[source,java]
----
 from(""direct:multiple-codec"").to(""netty:tcp://0.0.0.0:{{port}}?encoders=#encoders&sync=false"");

 from(""netty:tcp://0.0.0.0:{{port}}?decoders=#length-decoder,#string-decoder&sync=false"").to(""mock:multiple-codec"");
----

or via XML.

[source,xml]
----
<camelContext id=""multiple-netty-codecs-context"" xmlns=""http://camel.apache.org/schema/spring"">
    <route>
        <from uri=""direct:multiple-codec""/>
        <to uri=""netty:tcp://0.0.0.0:5150?encoders=#encoders&amp;sync=false""/>
    </route>
    <route>
        <from uri=""netty:tcp://0.0.0.0:5150?decoders=#length-decoder,#string-decoder&amp;sync=false""/>
        <to uri=""mock:multiple-codec""/>
    </route>
</camelContext>
----

== Closing Channel When Complete

When acting as a server you sometimes want to close the channel when,
for example, a client conversion is finished. +
 You can do this by simply setting the endpoint option
`disconnect=true`.

However you can also instruct Camel on a per message basis as follows. +
 To instruct Camel to close the channel, you should add a header with
the key `CamelNettyCloseChannelWhenComplete` set to a boolean `true`
value. +
 For instance, the example below will close the channel after it has
written the bye message back to the client:

[source,java]
----
from(""netty:tcp://0.0.0.0:8080"").process(new Processor() {
    public void process(Exchange exchange) throws Exception {
        String body = exchange.getIn().getBody(String.class);
        exchange.getOut().setBody(""Bye "" + body);
        // some condition which determines if we should close
        if (close) {
            exchange.getOut().setHeader(NettyConstants.NETTY_CLOSE_CHANNEL_WHEN_COMPLETE, true);
        }
    }
});
----

[[Netty-Addingcustomchannelpipelinefactoriestogaincompletecontroloveracreatedpipeline]]
Adding custom channel pipeline factories to gain complete control over a created pipeline

== Custom pipeline

Custom channel pipelines provide complete control to the user over the
handler/interceptor chain by inserting custom handler(s), encoder(s) &
decoder(s) without having to specify them in the Netty Endpoint URL in a
very simple way.

In order to add a custom pipeline, a custom channel pipeline factory
must be created and registered with the context via the context registry
(Registry, or the camel-spring ApplicationContextRegistry etc).

A custom pipeline factory must be constructed as follows

* A Producer linked channel pipeline factory must extend the abstract
class `ClientPipelineFactory`.
* A Consumer linked channel pipeline factory must extend the abstract
class `ServerInitializerFactory`.
* The classes should override the initChannel() method in order to
insert custom handler(s), encoder(s) and decoder(s). Not overriding the
`initChannel()` method creates a pipeline with no handlers, encoders or
decoders wired to the pipeline.

The example below shows how ServerInitializerFactory factory may be
created

=== Using custom pipeline factory

[source,java]
----
public class SampleServerInitializerFactory extends ServerInitializerFactory {
    private int maxLineSize = 1024;

    protected void initChannel(Channel ch) throws Exception {
        ChannelPipeline channelPipeline = ch.pipeline();

        channelPipeline.addLast(""encoder-SD"", new StringEncoder(CharsetUtil.UTF_8));
        channelPipeline.addLast(""decoder-DELIM"", new DelimiterBasedFrameDecoder(maxLineSize, true, Delimiters.lineDelimiter()));
        channelPipeline.addLast(""decoder-SD"", new StringDecoder(CharsetUtil.UTF_8));
        // here we add the default Camel ServerChannelHandler for the consumer, to allow Camel to route the message etc.
        channelPipeline.addLast(""handler"", new ServerChannelHandler(consumer));
    }
}
----

The custom channel pipeline factory can then be added to the registry
and instantiated/utilized on a camel route in the following way

[source,java]
----
Registry registry = camelContext.getRegistry();
ServerInitializerFactory factory = new TestServerInitializerFactory();
registry.bind(""spf"", factory);
context.addRoutes(new RouteBuilder() {
  public void configure() {
      String netty_ssl_endpoint =
         ""netty:tcp://0.0.0.0:5150?serverInitializerFactory=#spf""
      String return_string =
         ""When You Go Home, Tell Them Of Us And Say,""
         + ""For Your Tomorrow, We Gave Our Today."";

      from(netty_ssl_endpoint)
       .process(new Processor() {
          public void process(Exchange exchange) throws Exception {
            exchange.getOut().setBody(return_string);
          }
       }
  }
});
----

== Reusing Netty boss and worker thread pools

Netty has two kind of thread pools: boss and worker. By default each
Netty consumer and producer has their private thread pools. If you want
to reuse these thread pools among multiple consumers or producers then
the thread pools must be created and enlisted in the
Registry.

For example using Spring XML we can create a shared worker thread pool
using the `NettyWorkerPoolBuilder` with 2 worker threads as shown below:

[source,xml]
----
<!-- use the worker pool builder to help create the shared thread pool -->
<bean id=""poolBuilder"" class=""org.apache.camel.component.netty.NettyWorkerPoolBuilder"">
  <property name=""workerCount"" value=""2""/>
</bean>

<!-- the shared worker thread pool -->
<bean id=""sharedPool"" class=""org.jboss.netty.channel.socket.nio.WorkerPool""
      factory-bean=""poolBuilder"" factory-method=""build"" destroy-method=""shutdown"">
</bean>
----

[TIP]
====
For boss thread pool there is a
`org.apache.camel.component.netty.NettyServerBossPoolBuilder` builder
for Netty consumers, and a
`org.apache.camel.component.netty.NettyClientBossPoolBuilder` for the
Netty producers.
====

Then in the Camel routes we can refer to this worker pools by
configuring the `workerPool` option in the URI as shown below:

[source,xml]
----
<route>
  <from uri=""netty:tcp://0.0.0.0:5021?textline=true&amp;sync=true&amp;workerPool=#sharedPool&amp;usingExecutorService=false""/>
  <to uri=""log:result""/>
  ...
</route>
----

And if we have another route we can refer to the shared worker pool:

[source,xml]
----
<route>
  <from uri=""netty:tcp://0.0.0.0:5022?textline=true&amp;sync=true&amp;workerPool=#sharedPool&amp;usingExecutorService=false""/>
  <to uri=""log:result""/>
  ...
</route>
----

and so forth.

== Multiplexing concurrent messages over a single connection with request/reply

When using Netty for request/reply messaging via the netty producer then by default each
message is sent via a non-shared connection (pooled). This ensures that replies are
automatic being able to map to the correct request thread for further routing in Camel.
In other words correlation between request/reply messages happens out-of-the-box because
the replies comes back on the same connection that was used for sending the request;
and this connection is not shared with others. When the response comes back, the connection
is returned back to the connection pool, where it can be reused by others.

However if you want to multiplex concurrent request/responses on a single shared connection,
then you need to turn off the connection pooling by setting `producerPoolEnabled=false`.
Now this means there is a potential issue with interleaved responses if replies comes back out-of-order.
Therefore you need to have a correlation id in both the request and reply messages so you can properly
correlate the replies to the Camel callback that is responsible for continue processing the message in Camel.
To do this you need to implement `NettyCamelStateCorrelationManager` as correlation manager and configure
it via the `correlationManager=#myManager` option.

[NOTE]
====
We recommend extending the `TimeoutCorrelationManagerSupport` when you build custom correlation managers.
This provides support for timeout and other complexities you otherwise would need to implement as well.
====

You can find an example with the Apache Camel source code in the examples directory
under the `camel-example-netty-custom-correlation` directory.


include::camel-spring-boot::page$netty-starter.adoc[]
",12460,False,2332.703476029511,median
"[[spring-cloud-dataflow-task]]
= Tasks

[partintro]
--
This section goes into more detail about how you can work with http://cloud.spring.io/spring-cloud-task/[Spring Cloud Task].
It covers topics such as creating and running task applications.

If you are just starting out with Spring Cloud Data Flow, you should probably read the ""`<<getting-started.adoc#getting-started, Getting Started>>`"" guide before diving into this section.
--

[[spring-cloud-dataflow-task-intro]]
== Introduction

A task executes a process on demand.
In the case of Spring Cloud Task, a task is a http://projects.spring.io/spring-boot/[Spring Boot] application that is annotated with `@EnableTask`.
A user launches a task that performs a certain process, and, once complete, the task ends.  Unlike a stream where a stream definition can have at most one deployment a single task definition can be launched multiple times simultaneously.
An example of a task would be a Spring Boot application that exports data from a JDBC repository to an HDFS instance.
Tasks record the start time and the end time as well as the boot exit code in a relational database.
The task implementation is based on the http://cloud.spring.io/spring-cloud-task/[Spring Cloud Task] project.

=== Application properties

Each application takes properties to customize its behavior.  As an example, the `timestamp` task `format` setting establishes a output format that is different from the default value.

`dataflow:> task create --definition ""timestamp --format=\\""yyyy\\"""" --name printTimeStamp`

This `timestamp` property is actually the same as the `timestamp.format` property specified by the timestamp application.
Data Flow adds the ability to use the shorthand form `format` instead of `timestamp.format`.
One may also specify the longhand version as well, as shown in the following example:

`dataflow:> task create --definition ""timestamp --timestamp.format=\\""yyyy\\"""" --name printTimeStamp`

This shorthand behavior is discussed more in the section on <<spring-cloud-dataflow-stream-app-whitelisting>>.
If you have <<spring-cloud-dataflow-stream-app-metadata-artifact, registered application property metadata>> you can use tab completion in the shell after typing `--` to get a list of candidate property names.

The shell provides tab completion for application properties. The shell command `app info --name <appName> --type <appType>` provides additional documentation for all the supported properties.

NOTE: The supported Task `<appType>` is task.


== The Lifecycle of a Task

Before we dive deeper into the details of creating Tasks, we need to understand the typical lifecycle for tasks in the context of Spring Cloud Data Flow:

. <<spring-cloud-dataflow-create-task-apps>>
. <<spring-cloud-dataflow-register-task-apps>>
. <<spring-cloud-dataflow-create-task-definition>>
. <<spring-cloud-dataflow-task-launch>>
. <<spring-cloud-dataflow-task-review-executions>>
. <<spring-cloud-dataflow-task-definition-destroying>>

[[spring-cloud-dataflow-create-task-apps]]
=== Creating a Task Application

While Spring Cloud Task does provide a number of out-of-the-box applications (at https://github.com/spring-cloud-task-app-starters[spring-cloud-task-app-starters]), most task applications require custom development.
  To create a custom task application:

.  Use the http://start.spring.io[Spring Initializer] to create a new project, making sure to select the following starters:
.. `Cloud Task`: This dependency is the `spring-cloud-starter-task`.
.. `JDBC`: This dependency is the `spring-jdbc` starter.
. Within your new project, create a new class to serve as your main class, as follows:
+
[source,java]
----
@EnableTask
@SpringBootApplication
public class MyTask {

    public static void main(String[] args) {
		SpringApplication.run(MyTask.class, args);
	}
}
----
+
. With this class, you need one or more `CommandLineRunner` or `ApplicationRunner` implementations within your application.  You can either implement your own or use the ones provided by Spring Boot (there is one for running batch jobs, for example).
. Packaging your application with Spring Boot into an über jar is done through the standard {spring-boot-docs-reference}/html/getting-started-first-application.html#getting-started-first-application-executable-jar[Spring Boot conventions].
The packaged application can be registered and deployed as noted below.



==== Task Database Configuration

CAUTION: When launching a task application, be sure that the database driver that is being used by Spring Cloud Data Flow is also a dependency on the task application.
For example, if your Spring Cloud Data Flow is set to use Postgresql, be sure that the task application also has Postgresql as a dependency.

TIP: When you run tasks externally (that is, from the command line) and you want Spring Cloud Data Flow to show the TaskExecutions in its UI, be sure that common datasource settings are shared among the both.
By default, Spring Cloud Task uses a local H2 instance, and the execution is recorded to the database used by Spring Cloud Data Flow.



[[spring-cloud-dataflow-register-task-apps]]
=== Registering a Task Application

You can register a Task App with the App Registry by using the Spring Cloud Data Flow Shell `app register` command.
You must provide a unique name and a URI that can be resolved to the app artifact. For the type, specify ""task"".
The following listing shows three examples:

[source,bash]
----
dataflow:>app register --name task1 --type task --uri maven://com.example:mytask:1.0.2

dataflow:>app register --name task2 --type task --uri file:///Users/example/mytask-1.0.2.jar

dataflow:>app register --name task3 --type task --uri http://example.com/mytask-1.0.2.jar
----

When providing a URI with the `maven` scheme, the format should conform to the following:

`maven://<groupId>:<artifactId>[:<extension>[:<classifier>]]:<version>`

If you would like to register multiple apps at one time, you can store them in a properties file where the keys are formatted as `<type>.<name>` and the values are the URIs.
For example, the followinng listing would be a valid properties file:

[source]
task.foo=file:///tmp/foo.jar
task.bar=file:///tmp/bar.jar


Then you can use the `app import` command and provide the location of the properties file by using the  `--uri` option, as follows:

`app import --uri file:///tmp/task-apps.properties`

For convenience, we have the static files with application-URIs (for both maven and docker) available for all the out-of-the-box Task app-starters.
You can point to this file and import all the application-URIs in bulk.
Otherwise, as explained earlier in this chapter, you can register them individually or have your own custom property file with only the required application-URIs in it.
It is recommended, however, to have a ""`focused`"" list of desired application-URIs in a custom property file.

The following table lists the available static property files:

[width=""100%"",frame=""topbot"",options=""header""]
|======================
|Artifact Type |Stable Release |SNAPSHOT Release
|Maven   | http://bit.ly/Clark-GA-task-applications-maven | http://bit.ly/Clark-BUILD-SNAPSHOT-task-applications-maven
|Docker  | http://bit.ly/Clark-GA-task-applications-docker | http://bit.ly/Clark-BUILD-SNAPSHOT-task-applications-docker
|======================

For example, if you would like to register all out-of-the-box task applications in bulk, you can do so with the following command:

`dataflow:>app import --uri http://bit.ly/Clark-GA-task-applications-maven`

You can also pass the `--local` option (which is `TRUE` by default) to indicate whether the properties file location should be resolved within the shell process itself.
If the location should be resolved from the Data Flow Server process, specify `--local false`.

When using either `app register` or `app import`, if a task app is already registered with
the provided name, it is not overridden by default. If you would like to override the
pre-existing task app, then include the `--force` option.

[NOTE]
In some cases, the Resource is resolved on the server side.
In other cases, the URI is passed to a runtime container instance where it is resolved.
Consult the specific documentation of each Data Flow Server for more detail.



[[spring-cloud-dataflow-create-task-definition]]
=== Creating a Task Definition

You can create a task Definition from a task app by providing a definition name as well as
properties that apply to the task execution.  Creating a task definition can be done through
the RESTful API or the shell.  To create a task definition by using the shell, use the
`task create` command to create the task definition, as shown in the following example:

[source]
dataflow:>task create mytask --definition ""timestamp --format=\\""yyyy\\""""
Created new task 'mytask'

A listing of the current task definitions can be obtained through the RESTful API or the shell.
To get the task definition list by using the shell, use the `task list` command.

[[spring-cloud-dataflow-task-launch]]
=== Launching a Task
An adhoc task can be launched through the RESTful API or the shell.
To launch an ad-hoc task through the shell, use the `task launch` command, as shown in the following example:

[source]
dataflow:>task launch mytask
 Launched task 'mytask'

When a task is launched, any properties that need to be passed as command line arguments to the task application can be set when launching the task, as follows:
[source]
dataflow:>task launch mytask --arguments ""--server.port=8080 --custom=value""

[NOTE]
The arguments need to be passed as `space` delimited values.

Additional properties meant for a `TaskLauncher` itself can be passed in by using a `--properties` option.
The format of this option is a comma-separated string of properties prefixed with `app.<task definition name>.<property>`.
Properties are passed to `TaskLauncher` as application properties.
It is up to an implementation to choose how those are passed into an actual task application.
If the property is prefixed with `deployer` instead of `app`, it is passed to `TaskLauncher` as a deployment property and its meaning may be `TaskLauncher` implementation specific.

`dataflow:>task launch mytask --properties ""deployer.timestamp.custom1=value1,app.timestamp.custom2=value2""`

==== Common application properties

In addition to configuration through DSL, Spring Cloud Data Flow provides a mechanism for setting common properties to all the task applications that are launched by it.
This can be done by adding properties prefixed with `spring.cloud.dataflow.applicationProperties.task` when starting the server.
When doing so, the server passes all the properties, without the prefix, to the instances it launches.

For example, all the launched applications can be configured to use the properties `prop1` and `prop2` by launching the Data Flow server with the following options:

[source]
--spring.cloud.dataflow.applicationProperties.task.prop1=value1
--spring.cloud.dataflow.applicationProperties.task.prop2=value2

This causes the properties, `prop1=value1` and `prop2=value2`, to be passed to all the launched applications.

[NOTE]
Properties configured by using this mechanism have lower precedence than task deployment properties.
They are overridden if a property with the same key is specified at task launch time (for example, `app.trigger.prop2`
overrides the common property).

[[spring-cloud-dataflow-task-limit-concurrent-executions]]
=== Limit the number concurrent task launches
Spring Cloud Data Flow allows a user establish the maximum number of concurrently running tasks to prevent the saturation of IaaS/hardware resources.
This limit can be configured by setting the `spring.cloud.dataflow.task.maximum-concurrent-tasks` property.   By default it is set to `20`.
If the number of concurrently running tasks is equal or greater than the value set by `spring.cloud.dataflow.task.maximum-concurrent-tasks` the next
task launch request will be declined and a warning message will be returned via the RESTful API, Shell or UI.


[[spring-cloud-dataflow-task-review-executions]]
=== Reviewing Task Executions
Once the task is launched, the state of the task is stored in a relational DB.  The state
includes:

* Task Name
* Start Time
* End Time
* Exit Code
* Exit Message
* Last Updated Time
* Parameters

A user can check the status of their task executions through the RESTful API or the shell.
To display the latest task executions through the shell, use the `task execution list` command.

To get a list of task executions for just one task definition, add `--name` and
the task definition name, for example `task execution list --name foo`.  To retrieve full
details for a task execution use the `task execution status` command with the id of the task execution,
for example `task execution status --id 549`.



[[spring-cloud-dataflow-task-definition-destroying]]
=== Destroying a Task Definition
Destroying a Task Definition removes the definition from the definition repository.
This can be done through the RESTful API or the shell.
To destroy a task through the shell, use the `task destroy` command, as shown in the following example:

[source]
dataflow:>task destroy mytask
 Destroyed task 'mytask'

The task execution information for previously launched tasks for the definition remains in the task repository.

NOTE: This does not stop any currently executing tasks for this definition. Instead, it removes the task definition from the database.



[[spring-cloud-dataflow-task-events]]
== Subscribing to Task/Batch Events

You can also tap into various task and batch events when the task is launched.
If the task is enabled to generate task or batch events (with the additional dependencies `spring-cloud-task-stream` and, in the case of Kafka as the binder, `spring-cloud-stream-binder-kafka`), those events are published during the task lifecycle.
By default, the destination names for those published events on the broker (Rabbit, Kafka, and others) are the event names themselves (for instance: `task-events`, `job-execution-events`, and so on).

[source]
dataflow:>task create myTask --definition “myBatchJob""
dataflow:>task launch myTask
dataflow:>stream create task-event-subscriber1 --definition "":task-events > log"" --deploy

You can control the destination name for those events by specifying explicit names when launching the task, as follows:

[source]
dataflow:>task launch myTask --properties ""spring.cloud.stream.bindings.task-events.destination=myTaskEvents""
dataflow:>stream create task-event-subscriber2 --definition "":myTaskEvents > log"" --deploy

The following table lists the default task and batch event and destination names on the broker:

.Task and Batch Event Destinations

[cols=""2*""]
|===

|*Event*|*Destination*

|Task events
|`task-events`
|Job Execution events  |`job-execution-events`
|Step Execution events|`step-execution-events`
|Item Read events|`item-read-events`
|Item Process events|`item-process-events`
|Item Write events|`item-write-events`
|Skip events|`skip-events`
|===

[[spring-cloud-dataflow-composed-tasks]]
== Composed Tasks

Spring Cloud Data Flow lets a user create a directed graph where each node of the graph is a task application.
This is done by using the DSL for composed tasks.
A composed task can be created through the RESTful API, the Spring Cloud Data Flow Shell, or the Spring Cloud Data Flow UI.

=== Configuring the Composed Task Runner

Composed tasks are executed through a task application called the https://github.com/spring-cloud-task-app-starters/composed-task-runner[Composed Task Runner].



==== Registering the Composed Task Runner

By default, the Composed Task Runner application is not registered with Spring Cloud Data Flow.
Consequently, to launch composed tasks, we must first register the Composed
Task Runner as an application with Spring Cloud Data Flow, as follows:

`app register --name composed-task-runner --type task --uri maven://org.springframework.cloud.task.app:composedtaskrunner-task:<DESIRED_VERSION>`

You can also configure Spring Cloud Data Flow to use a different task definition name for the composed task runner.
This can be done by setting the `spring.cloud.dataflow.task.composedTaskRunnerName` property to the name of your choice.
You can then register the composed task runner application with the name you set by using that property.



==== Configuring the Composed Task Runner

The Composed Task Runner application has a `dataflow.server.uri` property that is used for validation and for launching child tasks.
This defaults to `http://localhost:9393`. If you run a distributed Spring Cloud Data Flow server, as you would if you deploy the server on Cloud Foundry, YARN, or Kubernetes, you need to provide the URI that can be used to access the server.
You can either provide this `dataflow.server.uri` property for the Composed Task Runner application when launching a composed task or you can provide a `spring.cloud.dataflow.server.uri` property for the Spring Cloud Data Flow server when it is started.
For the latter case, the `dataflow.server.uri` Composed Task Runner application property is automatically set when a composed task is launched.

In some cases, you may wish to execute an instance of the Composed Task Runner through the Task Launcher sink.
In that case, you must configure the Composed Task Runner to use the same datasource that the Spring Cloud Data Flow instance is using.
The datasource properties are set with the `TaskLaunchRequest` through the use of the `commandlineArguments` or the `environmentProperties` switches.
This is because the Composed Task Runner monitors the `task_executions` table to check the status of the tasks that it is running.
Using information from the table, it determines how it should navigate the graph.

===== Configuration Options

The ComposedTaskRunner task has the following options:

* *increment-instance-enabled*
Allows a single ComposedTaskRunner instance to be re-executed without changing the parameters. Default is false which means a ComposedTaskRunner instance can only be executed once with a given set of parameters, if true it can be re-executed. (Boolean, default: false).
ComposedTaskRunner is built using https://github.com/spring-projects/spring-batch[Spring Batch] and thus upon a successful execution the batch job is considered complete.
To launch the same ComposedTaskRunner definition multiple times you must set the `increment-instance-enabled` property to true or change the parameters for the definition for each launch.

* *interval-time-between-checks*
The amount of time in millis that the ComposedTaskRunner will wait between checks of the database to see if a task has completed. (Integer, default: 10000).
ComposedTaskRunner uses the datastore to determine the status of each child tasks.  This interval indicates to ComposedTaskRunner how often it should check the status its child tasks.

* *max-wait-time*
The maximum amount of time in millis that a individual step can run before the execution of the Composed task is failed (Integer, default: 0).
Determines the maximum time each child task is allowed to run before the CTR will terminate with a failure.  The default of `0` indicates no timeout.

* *split-thread-allow-core-thread-timeout*
Specifies whether to allow split core threads to timeout. Default is false; (Boolean, default: false)
Sets the policy governing whether core threads may timeout and terminate if no tasks arrive within the keep-alive time, being replaced if needed when new tasks arrive.

* *split-thread-core-pool-size*
Split's core pool size. Default is 1; (Integer, default: 1)
Each child task contained in a split requires a thread in order to execute.   So for example a definition like: `<AAA || BBB || CCC> && <DDD || EEE>` would require a split-thread-core-pool-size of 3.
This is because the largest split contains 3 child tasks.   A count of 2 would mean that `AAA` and `BBB` would run in parallel but CCC would wait until either `AAA` or `BBB` to finish in order to run.
Then `DDD` and `EEE` would run in parallel.

* *split-thread-keep-alive-seconds*
Split's thread keep alive seconds. Default is 60. (Integer, default: 60)
If the pool currently has more than corePoolSize threads, excess threads will be terminated if they have been idle for more than the keepAliveTime.

* *split-thread-max-pool-size*
Split's maximum pool size. Default is {@code Integer.MAX_VALUE} (Integer, default: <none>).
Establish the maximum number of threads allowed for the thread pool.

* *split-thread-queue-capacity*
Capacity for Split's BlockingQueue. Default is {@code Integer.MAX_VALUE}. (Integer, default: <none>)
** If fewer than corePoolSize threads are running, the Executor always prefers adding a new thread rather than queuing.
** If corePoolSize or more threads are running, the Executor always prefers queuing a request rather than adding a new thread.
** If a request cannot be queued, a new thread is created unless this would exceed maximumPoolSize, in which case, the task will be rejected.

* *split-thread-wait-for-tasks-to-complete-on-shutdown*
Whether to wait for scheduled tasks to complete on shutdown, not interrupting running tasks and executing all tasks in the queue. Default is false; (Boolean, default: false)

Note
when using the options above as environment variables, convert to uppercase, remove the dash character and replace with the underscore character. For example: increment-instance-enabled would be INCREMENT_INSTANCE_ENABLED.


=== The Lifecycle of a Composed Task

The lifecycle of a composed task has three parts:

* <<spring-cloud-data-flow-composed-task-creating>>
* <<spring-cloud-data-flow-composed-task-stopping>>
* <<spring-cloud-data-flow-composed-task-restarting>>



[[spring-cloud-data-flow-composed-task-creating]]
==== Creating a Composed Task

The DSL for the composed tasks is used when creating a task definition through the task create command, as shown in the following example:

[source]
dataflow:> app register --name timestamp --type task --uri maven://org.springframework.cloud.task.app:timestamp-task:<DESIRED_VERSION>
dataflow:> app register --name mytaskapp --type task --uri file:///home/tasks/mytask.jar
dataflow:> task create my-composed-task --definition ""mytaskapp && timestamp""
dataflow:> task launch my-composed-task

In the preceding example, we assume that the applications to be used by our composed task have not been registered yet.
Consequently, in the first two steps, we register two task applications.
We then create our composed task definition by using the `task create` command.
The composed task DSL in the preceding example, when launched, runs mytaskapp and then runs the timestamp application.

But before we launch the `my-composed-task` definition, we can view what Spring Cloud Data Flow generated for us.
This can be done by executing the task list command, as shown (including its output) in the following example:

[source,bash,options=""nowrap""]
----
dataflow:>task list
╔══════════════════════════╤══════════════════════╤═══════════╗
║        Task Name         │   Task Definition    │Task Status║
╠══════════════════════════╪══════════════════════╪═══════════╣
║my-composed-task          │mytaskapp && timestamp│unknown    ║
║my-composed-task-mytaskapp│mytaskapp             │unknown    ║
║my-composed-task-timestamp│timestamp             │unknown    ║
╚══════════════════════════╧══════════════════════╧═══════════╝
----

In the example, Spring Cloud Data Flow created three task definitions, one for each of the applications that makes up our composed task (`my-composed-task-mytaskapp` and `my-composed-task-timestamp`) as well as the composed task (`my-composed-task`) definition.
We also see that each of the generated names for the child tasks is made up of the name of the composed task and the name of the application, separated by a dash `-` (as in _my-composed-task_ `-` _mytaskapp_).



===== Task Application Parameters

The task applications that make up the composed task definition can also contain parameters, as shown in the following example:

`dataflow:> task create my-composed-task --definition ""mytaskapp --displayMessage=hello && timestamp --format=YYYY""`



==== Launching a Composed Task
Launching a composed task is done the same way as launching a stand-alone task, as follows:

`task launch my-composed-task`

Once the task is launched, and assuming all the tasks complete successfully, you can see three task executions when executing a `task execution list`, as shown in the following example:

[source,bash,options=""nowrap""]
----
dataflow:>task execution list
╔══════════════════════════╤═══╤════════════════════════════╤════════════════════════════╤═════════╗
║        Task Name         │ID │         Start Time         │          End Time          │Exit Code║
╠══════════════════════════╪═══╪════════════════════════════╪════════════════════════════╪═════════╣
║my-composed-task-timestamp│713│Wed Apr 12 16:43:07 EDT 2017│Wed Apr 12 16:43:07 EDT 2017│0        ║
║my-composed-task-mytaskapp│712│Wed Apr 12 16:42:57 EDT 2017│Wed Apr 12 16:42:57 EDT 2017│0        ║
║my-composed-task          │711│Wed Apr 12 16:42:55 EDT 2017│Wed Apr 12 16:43:15 EDT 2017│0        ║
╚══════════════════════════╧═══╧════════════════════════════╧════════════════════════════╧═════════╝
----

In the preceding example, we see that `my-compose-task` launched and that it also launched the other tasks in sequential order.
All of them executed successfully with `Exit Code` as `0`.

===== Passing properties to the child tasks

To set the properties for child tasks in a composed task graph at task launch time,
you would use the following format of `app.<composed task definition name>.<child task app name>.<property>`.
Using the following Composed Task definition as an example:

[source,bash]
----
dataflow:> task create my-composed-task --definition ""mytaskapp  && mytimestamp""
----
To have mytaskapp display 'HELLO' and set the mytimestamp timestamp format to 'YYYY' for the Composed Task definition, you would use the following task launch format:
[source,bash]
----
task launch my-composed-task --properties ""app.my-composed-task.mytaskapp.displayMessage=HELLO,app.my-composed-task.mytimestamp.timestamp.format=YYYY""
----

Similar to application properties, the `deployer` properties can also be set for child tasks using the format format of `deployer.<composed task definition name>.<child task app name>.<deployer-property>`.

[source,bash]
----
task launch my-composed-task --properties ""deployer.my-composed-task.mytaskapp.memory=2048m,app.my-composed-task.mytimestamp.timestamp.format=HH:mm:ss""
Launched task 'a1'
----

===== Passing arguments to the composed task runner

Command line arguments for the composed task runner can be passed using `--arguments` option.

For example:

[source,bash]
----
dataflow:>task create my-composed-task --definition ""<aaa: timestamp || bbb: timestamp>""
Created new task 'my-composed-task'

dataflow:>task launch my-composed-task --arguments ""--increment-instance-enabled=true --max-wait-time=50000 --split-thread-core-pool-size=4"" --properties ""app.my-composed-task.bbb.timestamp.format=dd/MM/yyyy HH:mm:ss""
Launched task 'my-composed-task'
----

===== Exit Statuses

The following list shows how the Exit Status is set for each step (task) contained in the composed task following each step execution:

* If the `TaskExecution` has an `ExitMessage`, that is used as the `ExitStatus`.
* If no `ExitMessage` is present and the `ExitCode` is set to zero, then the `ExitStatus` for the step is `COMPLETED`.
* If no `ExitMessage` is present and the `ExitCode` is set to any non-zero number, the `ExitStatus` for the step is `FAILED`.



==== Destroying a Composed Task

The command used to destroy a stand-alone task is the same as the command used to destroy a composed task.
The only difference is that destroying a composed task also destroys the child tasks associated with it.
The following example shows the task list before and after using the `destroy` command:

[source,bash,options=""nowrap""]
----
dataflow:>task list
╔══════════════════════════╤══════════════════════╤═══════════╗
║        Task Name         │   Task Definition    │Task Status║
╠══════════════════════════╪══════════════════════╪═══════════╣
║my-composed-task          │mytaskapp && timestamp│COMPLETED  ║
║my-composed-task-mytaskapp│mytaskapp             │COMPLETED  ║
║my-composed-task-timestamp│timestamp             │COMPLETED  ║
╚══════════════════════════╧══════════════════════╧═══════════╝
...
dataflow:>task destroy my-composed-task
dataflow:>task list
╔═════════╤═══════════════╤═══════════╗
║Task Name│Task Definition│Task Status║
╚═════════╧═══════════════╧═══════════╝
----



[[spring-cloud-data-flow-composed-task-stopping]]
==== Stopping a Composed Task
In cases where a composed task execution needs to be stopped, you can do so through the:

* RESTful API
* Spring Cloud Data Flow Dashboard

To stop a composed task through the dashboard, select the Jobs tab and click the Stop button next to the job execution that you want to stop.

The composed task run is stopped when the currently running child task completes.
The step associated with the child task that was running at the time that the composed task was stopped is marked as `STOPPED` as well as the composed task job execution.



[[spring-cloud-data-flow-composed-task-restarting]]
==== Restarting a Composed Task
In cases where a composed task fails during execution and the status of the composed task is `FAILED`, the task can be restarted.
You can do so through the:

* RESTful API
* The shell
* Spring Cloud Data Flow Dashboard


To restart a composed task through the shell, launch the task with the same parameters.
To restart a composed task through the dashboard, select the Jobs tab and click the Restart button next to the job execution that you want to restart.

NOTE: Restarting a Composed Task job that has been stopped (through the Spring Cloud Data Flow Dashboard or RESTful API) relaunches the `STOPPED` child task and then launches the remaining (unlaunched) child tasks in the specified order.



== Composed Tasks DSL

Composed tasks can be run in three ways:

* <<spring-cloud-data-flow-conditional-execution>>
* <<spring-cloud-data-flow-transitional-execution>>
* <<spring-cloud-data-flow-split-execution>>



[[spring-cloud-data-flow-conditional-execution]]
=== Conditional Execution

Conditional execution is expressed by using a double ampersand symbol (`&&`).
This lets each task in the sequence be launched only if the previous task
successfully completed, as shown in the following example:

`task create my-composed-task --definition ""task1 && task2""`

When the composed task called `my-composed-task` is launched, it launches the task called `task1` and, if it completes successfully, then the task called `task2` is launched.
If `task1` fails, then `task2` does not launch.

You can also use the Spring Cloud Data Flow Dashboard to create your conditional execution, by using the designer to drag and drop applications that are required and connecting them together to create your directed graph, as shown in the following image:

.Conditional Execution
image::{dataflow-asciidoc}/images/dataflow-ctr-conditional-execution.png[Composed Task Conditional Execution, scaledwidth=""50%""]

The preceding diagram is a screen capture of the directed graph as it being created by using the Spring Cloud Data Flow Dashboard.
You can see that are four components in the diagram that comprise a conditional execution:

* Start icon: All directed graphs start from this symbol.
There is only one.
* Task icon: Represents each task in the directed graph.
* End icon: Represents the termination of a directed graph.
* Solid line arrow: Represents the flow conditional execution flow between:
** Two applications.
** The start control node and an application.
** An application and the end control node.
* End icon: All directed graphs end at this symbol.

TIP: You can view a diagram of your directed graph by clicking the Detail button next to the composed task definition on the Definitions tab.



[[spring-cloud-data-flow-transitional-execution]]
=== Transitional Execution

The DSL supports fine- grained control over the transitions taken during the execution of the directed graph.
Transitions are specified by providing a condition for equality based on the exit status of the previous task.
A task transition is represented by the following symbol `-&gt;`.


==== Basic Transition

A basic transition would look like the following:

`task create my-transition-composed-task --definition ""foo 'FAILED' -> bar 'COMPLETED' -> baz""`

In the preceding example, `foo` would launch, and, if it had an exit status of `FAILED`, the `bar` task would launch.
If the exit status of `foo` was `COMPLETED`, `baz` would launch.
All other statuses returned by `foo` have no effect, and the task would terminate normally.

Using the Spring Cloud Data Flow Dashboard to create the same "" `basic transition` "" would resemble the following image:

.Basic Transition
image::{dataflow-asciidoc}/images/dataflow-ctr-transition-basic.png[Composed Task Basic Transition, scaledwidth=""50%""]

The preceding diagram is a screen capture of the directed graph as it being created in the Spring Cloud Data Flow Dashboard.
Notice that there are two different types of connectors:

* Dashed line: Represents transitions from the application to one of the possible destination applications.
* Solid line: Connects applications in a conditional execution or a connection between the application and a control node (start or end).

To create a transitional connector:

. When creating a transition, link the application to each possible destination by using the connector.
. Once complete, go to each connection and select it by clicking it.
. A bolt icon appears.
. Click that icon.
. Enter the exit status required for that connector.
. The solid line for that connector turns to a dashed line.



==== Transition With a Wildcard

Wildcards are supported for transitions by the DSL, as shown in the following:

`task create my-transition-composed-task --definition ""foo 'FAILED' -> bar '*' -> baz""`

In the preceding example, `foo` would launch, and, if it had an exit status of `FAILED`, the `bar` task would launch.
For any exit status of `foo` other than `FAILED`, `baz` would launch.

Using the Spring Cloud Data Flow Dashboard to create the same ""`transition with wildcard`"" would resemble the following image:

.Basic Transition With Wildcard
image::{dataflow-asciidoc}/images/dataflow-ctr-transition-basic-wildcard.png[Composed Task Basic Transition with Wildcard, scaledwidth=""50%""]



==== Transition With a Following Conditional Execution

A transition can be followed by a conditional execution so long as the wildcard
is not used, as shown in the following example:

`task create my-transition-conditional-execution-task --definition ""foo 'FAILED' -> bar 'UNKNOWN' -> baz && qux && quux""`

In the preceding example, `foo` would launch, and, if it had an exit status of `FAILED`, the `bar` task would launch.
If `foo` had an exit status of `UNKNOWN`, `baz` would launch.
For any exit status of `foo` other than `FAILED` or `UNKNOWN`, `qux` would launch and, upon successful completion, `quux` would launch.

Using the Spring Cloud Data Flow Dashboard to create the same ""`transition with conditional execution`"" would resemble the following image:

.Transition With Conditional Execution
image::{dataflow-asciidoc}/images/dataflow-ctr-transition-conditional-execution.png[Composed Task Transition with Conditional Execution, scaledwidth=""50%""]

NOTE: In this diagram we see the dashed line (transition) connecting the `foo` application to the target applications, but a solid line connecting the conditional executions between `foo`, `qux`, and  `quux`.



[[spring-cloud-data-flow-split-execution]]
=== Split Execution

Splits allow multiple tasks within a composed task to be run in parallel.
It is denoted by using angle brackets (`<>`) to group tasks and flows that are to be run in parallel.
These tasks and flows are separated by the double pipe `||` symbol, as shown in the following example:

`task create my-split-task --definition ""<foo || bar || baz>""`

The preceding example above launches tasks `foo`, `bar` and `baz` in parallel.

Using the Spring Cloud Data Flow Dashboard to create the same ""`split execution`"" would resemble the following image:

.Split
image::{dataflow-asciidoc}/images/dataflow-ctr-split.png[Composed Task Split, scaledwidth=""50%""]

With the task DSL, a user may also execute multiple split groups in succession, as shown in the following example:

`task create my-split-task --definition ""<foo || bar || baz> && <qux || quux>""'

In the preceding example, tasks `foo`, `bar`, and `baz` are launched in parallel.
Once they all complete, then tasks `qux` and `quux` are launched in parallel.
Once they complete, the composed task ends.
However, if `foo`, `bar`, or `baz` fails, the split containing `qux` and `quux` does not launch.

Using the Spring Cloud Data Flow Dashboard to create the same ""`split with multiple groups`"" would resemble the following image:

.Split as a part of a conditional execution
image::{dataflow-asciidoc}/images/dataflow-ctr-multiple-splits.png[Composed Task Split, scaledwidth=""50%""]

Notice that there is a `SYNC` control node that is inserted by the designer when
connecting two consecutive splits.

==== Split Containing Conditional Execution

A split can also have a conditional execution within the angle brackets, as shown in the following example:

`task create my-split-task --definition ""<foo && bar || baz>""`

In the preceding example, we see that `foo` and `baz` are launched in parallel.
However, `bar` does not launch until `foo` completes successfully.

Using the Spring Cloud Data Flow Dashboard to create the same "" `split containing conditional execution` "" resembles the following image:

.Split with conditional execution
image::{dataflow-asciidoc}/images/dataflow-ctr-split-contains-conditional.png[Composed Task Split With Conditional Execution, scaledwidth=""50%""]

==== Establishing the proper thread count for splits

Each child task contained in a split requires a thread in order to execute.  To set this properly you want to look at your graph and count the split that has the largest number of child tasks, this will be the number of threads you will need to utilize.
To set the thread count use the split-thread-core-pool-size property (defaults to 1).   So for example a definition like: `<AAA || BBB || CCC> && <DDD || EEE>` would require a split-thread-core-pool-size of 3.
This is because the largest split contains 3 child tasks.   A count of 2 would mean that `AAA` and `BBB` would run in parallel but CCC would wait until either `AAA` or `BBB` to finish in order to run.
Then `DDD` and `EEE` would run in parallel.

[[spring-cloud-dataflow-launch-tasks-from-stream]]
== Launching Tasks from a Stream

You can launch a task from a stream by using one of the available `task-launcher` sinks. Currently the platforms supported by the `task-launcher` sinks are:

* https://github.com/spring-cloud-stream-app-starters/tasklauncher-local[local],
* https://github.com/spring-cloud-stream-app-starters/tasklauncher-cloudfoundry[Cloud Foundry]
* https://github.com/spring-cloud-stream-app-starters/tasklauncher-kubernetes[Kubernetes]
* https://github.com/spring-cloud-stream-app-starters/tasklauncher-yarn[Yarn]

CAUTION: `task-launcher-local` is meant for development purposes only.

A `task-launcher` sink expects a message containing a https://github.com/spring-cloud/spring-cloud-task/blob/master/spring-cloud-task-stream/src/main/java/org/springframework/cloud/task/launcher/TaskLaunchRequest.java[TaskLaunchRequest] object in its payload.
From the `TaskLaunchRequest` object, the `task-launcher` obtains the URI of the artifact to be launched, as well as the environment properties, command line arguments, deployment properties, and application name to be used by the task.

The https://github.com/spring-cloud-stream-app-starters/tasklauncher-local/blob/v1.2.0.RELEASE/spring-cloud-starter-stream-sink-task-launcher-local/README.adoc[task-launcher-local] can be added to the available sinks by executing the app register command, as follows (for the Rabbit Binder, in this case):

`app register --name task-launcher-local --type sink --uri maven://org.springframework.cloud.stream.app:task-launcher-local-sink-rabbit:jar:1.2.0.RELEASE`

In the case of a Maven-based task that is to be launched, the `task-launcher` application is responsible for downloading the artifact.
You *must* configure the `task-launcher` with the appropriate configuration of https://github.com/spring-cloud/spring-cloud-deployer/blob/master/spring-cloud-deployer-resource-maven/src/main/java/org/springframework/cloud/deployer/resource/maven/MavenProperties.java[Maven Properties], such as `--maven.remote-repositories.repo1.url=http://repo.spring.io/libs-milestone""` to resolve artifacts (in this case against a milestone repo).  Note that this repostory can be different than the one used to register the `task-launcher` application itself.



=== TriggerTask

One way to launch a task with the `task-launcher` is to use the https://github.com/spring-cloud-stream-app-starters/triggertask/blob/v1.2.0.RELEASE/spring-cloud-starter-stream-source-triggertask/README.adoc[triggertask] source.
The `triggertask` source emits a message with a `TaskLaunchRequest` object that contains the required launch information.
The `triggertask` can be added to the available sources by running the app register command, as follows (for the Rabbit Binder, in this case):

`app register --type source --name triggertask --uri maven://org.springframework.cloud.stream.app:triggertask-source-rabbit:1.2.0.RELEASE`

For example, to launch the timestamp task once every 60 seconds, the stream implementation would be as follows:

[source]
stream create foo --definition ""triggertask --triggertask.uri=maven://org.springframework.cloud.task.app:timestamp-task:jar:1.2.0.RELEASE --trigger.fixed-delay=60 --triggertask.environment-properties=spring.datasource.url=jdbc:h2:tcp://localhost:19092/mem:dataflow,spring.datasource.username=sa | task-launcher-local --maven.remote-repositories.repo1.url=http://repo.spring.io/libs-release"" --deploy

If you run `runtime apps`, you can find the log file for the task launcher sink.
By using the `tail` command on that file, you can find the log file for the launched tasks.
Setting of `triggertask.environment-properties` establishes the Data Flow Server's H2 Database as the database where the task executions will be recorded.
You can then see the list of task executions by using the shell command `task execution list`, as shown (with its output) in the following example:

[source,bash,options=""nowrap""]
----
dataflow:>task execution list
╔════════════════════╤══╤════════════════════════════╤════════════════════════════╤═════════╗
║     Task Name      │ID│         Start Time         │          End Time          │Exit Code║
╠════════════════════╪══╪════════════════════════════╪════════════════════════════╪═════════╣
║timestamp-task_26176│4 │Tue May 02 12:13:49 EDT 2017│Tue May 02 12:13:49 EDT 2017│0        ║
║timestamp-task_32996│3 │Tue May 02 12:12:49 EDT 2017│Tue May 02 12:12:49 EDT 2017│0        ║
║timestamp-task_58971│2 │Tue May 02 12:11:50 EDT 2017│Tue May 02 12:11:50 EDT 2017│0        ║
║timestamp-task_13467│1 │Tue May 02 12:10:50 EDT 2017│Tue May 02 12:10:50 EDT 2017│0        ║
╚════════════════════╧══╧════════════════════════════╧════════════════════════════╧═════════╝
----



=== TaskLaunchRequest-transform

Another way to start a task with the `task-launcher` would be to create a stream by using the
https://github.com/spring-cloud-stream-app-starters/tasklaunchrequest-transform[Tasklaunchrequest-transform] processor to translate a message payload to a `TaskLaunchRequest`.

The `tasklaunchrequest-transform` can be added to the available processors by executing the app register command, as follows (for the Rabbit Binder, in this case):

`app register --type processor --name tasklaunchrequest-transform --uri maven://org.springframework.cloud.stream.app:tasklaunchrequest-transform-processor-rabbit:1.2.0.RELEASE`

The following example shows the creation of a task that includes the `tasklaunchrequest-transform`:

`stream create task-stream --definition ""http --port=9000 | tasklaunchrequest-transform --uri=maven://org.springframework.cloud.task.app:timestamp-task:jar:1.2.0.RELEASE | task-launcher-local --maven.remote-repositories.repo1.url=http://repo.spring.io/libs-release""`



=== Launching a Composed Task From a Stream

A composed task can be launched with one of the `task-launcher` sinks as discussed <<spring-cloud-dataflow-launch-tasks-from-stream, here>>.
Since we use the `ComposedTaskRunner` directly, we need to set up the task definitions it uses prior to the creation of the composed task launching stream.
Suppose we wanted to create the following composed task definition: `AAA && BBB`.
The first step would be to create the task definitions, as shown in the following example:

[source]
----
task create AAA --definition ""timestamp""
task create BBB --definition ""timestamp""
----
Now that the task definitions we need for composed task definition are ready, we need to create a stream that launches `ComposedTaskRunner`.
So, in this case, we create a stream with

* A trigger that emits a message once every 30 seconds
* A transformer that creates a `TaskLaunchRequest` for each message received
* A `task-launcher-local` sink that launches a the `ComposedTaskRunner` on our local machine

The stream should resemble the following:

[source]
----
stream create ctr-stream --definition ""time --fixed-delay=30 | tasklaunchrequest-transform --uri=maven://org.springframework.cloud.task.app:composedtaskrunner-task:<current release> --command-line-arguments='--graph=AAA&&BBB --increment-instance-enabled=true --spring.datasource.url=...' | task-launcher-local""
----
In the preceding example, we see that the `tasklaunchrequest-transform` is establishing two primary components:

* *uri*: The URI of the `ComposedTaskRunner` that is used
* *command-line-arguments*: To configure the `ComposedTaskRunner`

For now, we focus on the configuration that is required to launch the `ComposedTaskRunner`:

* *graph*: this is the graph that is to be executed by the `ComposedTaskRunner`.
In this case it is `AAA&&BBB`.
* *increment-instance-enabled*: This lets each execution of `ComposedTaskRunner` be unique.
`ComposedTaskRunner` is built by using http://projects.spring.io/spring-batch/[Spring Batch].
Thus, we want a new Job Instance for each launch of the `ComposedTaskRunner`.
To do this, we set `increment-instance-enabled` to be `true`.
* *spring.datasource.**: The datasource that is used by Spring Cloud
Data Flow, which lets the user track the tasks launched by the
`ComposedTaskRunner` and the state of the job execution.
Also, this is so that the `ComposedTaskRunner` can track the state of the tasks it launched and update its state.

NOTE: Releases of `ComposedTaskRunner` can be found
https://github.com/spring-cloud-task-app-starters/composed-task-runner/releases[here].

[[sharing-spring-cloud-dataflows-datastore-with-tasks]]
== Sharing Spring Cloud Data Flow's Datastore with Tasks
As discussed in the <<spring-cloud-dataflow-task, Tasks>> documentation Spring
Cloud Data Flow allows a user to view Spring Cloud Task App executions. So in
this section we will discuss what is required by a Task Application and Spring
Cloud Data Flow to share the task execution information.

[a-common-datastore-dependency]
=== A Common DataStore Dependency
Spring Cloud Data Flow supports many database <<appendix-migration-guide.adoc#rdbms, types>> out-of-the-box,
so all the user typically has to do is declare the `spring_datasource_*` environment variables
to establish what data store Spring Cloud Data Flow will need.
So whatever database you decide to use for Spring Cloud Data Flow make sure that the your task also
includes that database dependency in its `pom.xml` or `gradle.build` file.  If the database dependency
that is used by Spring Cloud Data Flow is not present in the Task Application, the task will fail
and the task execution will not be recorded.

[a-common-datastore]
=== A Common Data Store
Spring Cloud Data Flow and your task application must access the same datastore instance.
This is so that the task executions recorded by the task application can be read by Spring Cloud Data Flow to list them in the Shell and Dashboard views.
Also the task app must have read  & write privileges to the task data tables that are used by Spring Cloud Data Flow.

Given the understanding of Datasource dependency between Task apps and Spring Cloud Data Flow, let's review how to apply them in various Task orchestration scenarios.

[datasource-simple-task-launch]
==== Simple Task Launch
When launching a task from Spring Cloud Data Flow, Data Flow adds its datasource
properties (`spring.datasource.url`, `spring.datasource.driverClassName`, `spring.datasource.username`, `spring.datasource.password`)
to the app properties of the task being launched.  Thus a task application
will record its task execution information to the Spring Cloud Data Flow repository.

[datasource-task-launcher-sink]
==== Task Launcher Sink
The https://github.com/spring-cloud-stream-app-starters/tasklauncher-local[Task Launcher Sink] allows tasks to be launched via a stream as discussed <<spring-cloud-dataflow-launch-tasks-from-stream, here>>.
Since tasks launched by the Task Launcher Sink may not want their task executions
recorded to the same datastore as Spring Cloud Data Flow,
each https://docs.spring.io/spring-cloud-task/docs/current/apidocs/org/springframework/cloud/task/launcher/TaskLaunchRequest.html[TaskLaunchRequest]
received by the Task Launcher Sink must have the required datasource information established as app properties or command line arguments.
Both https://github.com/spring-cloud-stream-app-starters/tasklaunchrequest-transform/blob/master/spring-cloud-starter-stream-processor-tasklaunchrequest-transform/README.adoc[TaskLaunchRequest-Transform]
and https://github.com/spring-cloud-stream-app-starters/triggertask/blob/master/spring-cloud-starter-stream-source-triggertask/README.adoc[TriggerTask Source] are examples
of how a source and a processor allow a user to set the datasource properties via the app properties or command line arguments.

==== Composed Task Runner
Spring Cloud Data Flow allows a user to create a directed graph where each node
of the graph is a task application and this is done via the
https://github.com/spring-cloud-task-app-starters/composed-task-runner/blob/master/spring-cloud-starter-task-composedtaskrunner/README.adoc[Composed Task Runner].
In this case the rules that applied to a <<datasource-simple-task-launch, Simple Task Launch>>
or <<datasource-task-launcher-sink, Task Launcher Sink>> apply to the composed task runner as well.
All child apps must also have access to the datastore that is being used by the composed task runner
Also, All child apps must have the same database dependency as the composed task runner enumerated in their `pom.xml` or `gradle.build` file.

==== Launching a task externally from Spring Cloud Data Flow
Users may wish to launch Spring Cloud Task applications via another method (scheduler for example) but still track the task execution via Spring Cloud Data Flow.
This can be done so long as the task applications observe the rules specified <<a-common-datastore-dependency, here>> and <<a-common-datastore, here>>.

NOTE: If a user wishes to use Spring Cloud Data Flow to view their
https://projects.spring.io/spring-batch/[Spring Batch] jobs, the user must make sure that
their batch application use the `@EnableTask` annotation and follow the rules enumerated <<a-common-datastore-dependency, here>> and <<a-common-datastore, here>>.
More information is available https://github.com/spring-projects/spring-batch-admin/blob/master/MIGRATION.md[here].

[[spring-cloud-dataflow-schedule-launch-tasks]]
== Scheduling Tasks

Spring Cloud Data Flow lets a user schedule the execution of tasks via a cron expression.
A schedule can be created through the RESTful API or the Spring Cloud Data Flow UI.

=== The Scheduler

Spring Cloud Data Flow will schedule the execution of its tasks via a scheduling agent that is available on the cloud platform.
For example: on the Cloud Foundry platform Spring Cloud Data Flow will use the https://www.cloudfoundry.org/the-foundry/scheduler/[PCF Scheduler].

.Architectural Overview
image::{dataflow-asciidoc}/images/dataflow-scheduling-architecture.png[Scheduler Architecture Overview, scaledwidth=""50%""]

=== Enabling Scheduling

By default the Spring Cloud Data Flow leaves the scheduling feature disabled.  To enable the scheduling feature the following feature properties must be set to `true`:

* `spring.cloud.dataflow.features.schedules-enabled`
* `spring.cloud.dataflow.features.tasks-enabled`

=== The Lifecycle of a Schedule

The lifecycle of a schedule has 2 parts:

* <<spring-cloud-data-flow-schedule-scheduling>>
* <<spring-cloud-data-flow-schedule-unscheduling>>

[[spring-cloud-data-flow-schedule-scheduling]]
==== Scheduling a Task Execution

You can schedule a task execution via the:

* RESTful API
* Spring Cloud Data Flow Dashboard

To schedule a task from the UI click the Tasks tab at the top of the screen, this will take you to the Task Definitions screen.   Then from the Task Definition that you wish to schedule click the ""clock"" icon associated with task definition you wish to schedule.
This will lead you to a `Create Schedule(s)` screen, where you will create a unique name for the schedule and enter the associated cron expression.
Keep in mind you can always create multiple schedules for a single task definition.

[[spring-cloud-data-flow-schedule-unscheduling]]
==== Deleting a Schedule

You can delete a schedule via the:

* RESTful API
* Spring Cloud Data Flow Dashboard

To delete a schedule through the dashboard, select the Schedule tab under Tasks tab and click the `garbage can` icon next to the schedule you wish to delete.

NOTE: Any currently running tasks that were run by the scheduling agent will not be stopped if the schedule is deleted.   It only prevents future executions.
",12519,False,2318.1819097362004,median
"// 
//     Licensed to the Apache Software Foundation (ASF) under one
//     or more contributor license agreements.  See the NOTICE file
//     distributed with this work for additional information
//     regarding copyright ownership.  The ASF licenses this file
//     to you under the Apache License, Version 2.0 (the
//     ""License""); you may not use this file except in compliance
//     with the License.  You may obtain a copy of the License at
// 
//       http://www.apache.org/licenses/LICENSE-2.0
// 
//     Unless required by applicable law or agreed to in writing,
//     software distributed under the License is distributed on an
//     ""AS IS"" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
//     KIND, either express or implied.  See the License for the
//     specific language governing permissions and limitations
//     under the License.
//

= 通过数据库生成 JavaServer Faces 2.x CRUD 应用程序
:jbake-type: tutorial
:jbake-tags: tutorials 
:jbake-status: published
:icons: font
:syntax: true
:source-highlighter: pygments
:toc: left
:toc-title:
:description: 通过数据库生成 JavaServer Faces 2.x CRUD 应用程序 - Apache NetBeans
:keywords: Apache NetBeans, Tutorials, 通过数据库生成 JavaServer Faces 2.x CRUD 应用程序

在本教程中，您将使用 NetBeans IDE 来创建一个与后端数据库进行交互的 Web 应用程序。使用该应用程序可以查看和修改数据库中包含的数据，也称为 _CRUD_（创建、读取、更新和删除）功能。您将开发的应用程序依赖于以下技术。

* *JavaServer Faces (JSF) 2.x*，用于前端 Web 页、验证处理和请求-响应周期的管理。
* *Java Persistence API (JPA) 2.0*，通过 EclipseLink 从数据库中生成实体类，并管理事务。（EclipseLink 是 JPA 的引用实现，也是 GlassFish Server 的默认持久性提供器。）
* *Enterprise JavaBeans (EJB) 3.1*，提供了用于访问实体类的无状态 EJB，并且包含了应用程序的业务逻辑。

此 IDE 提供了两种可为应用程序生成所有代码的向导。一种是 <<generateEntity,""Entity Classes from Database""（通过数据库生成实体类）向导>>，您可以通过所提供的数据库来生成实体类。在创建实体类之后，可使用<<jsfPagesEntityClasses,“通过实体类创建 JSF 页”向导>>为实体类创建 JSF 受管 Bean 和 EJB，以及一组用于处理实体类数据视图的 Facelets 页。本教程的最后部分<<explore,了解应用程序>>为可选章节，其中提供了大量练习有助于您更好地理解应用程序并进一步熟悉此 IDE。

image::images/netbeans-stamp-80-74-73.png[title=""此页上的内容适用于 NetBeans IDE 7.2、7.3、7.4 和 8.0""]




要学完本教程，您需要具备以下软件和资源。

|===
|软件或资源 |要求的版本 

|link:https://netbeans.org/downloads/index.html[+NetBeans IDE+] |7.2、7.3、7.4、8.0、Java EE 包 

|link:http://www.oracle.com/technetwork/java/javase/downloads/index.html[+Java 开发工具包 (JDK)+] |7 或 8 

|link:http://glassfish.dev.java.net/[+GlassFish Server 开源版+] |3.x、4.x 

|link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fmysql-consult.zip[+mysql-consult.zip+] (MySQL) 
_或_
link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fjavadb-consult.zip[+javadb-consult.zip+] (JavaDB) |N/A 
|===

*注：*

* NetBeans IDE Java EE 包还包括本教程所需的 GlassFish Server（一种 Java EE 兼容的服务器）。
* 要获取本教程的解决方案项目，请下载 link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252FConsultingAgencyJSF20.zip[+ConsultingAgencyJSF20.zip+]。



[[createDB]]
== 创建数据库

本教程使用了一个名为 `consult` 的咨询代理数据库。安装 IDE 时，该数据库并未包括在其中，因此需要首先创建该数据库以按照本教程完成后续的学习。

`consult` 数据库旨在演示 IDE 对处理各种数据库结构所提供的支持范围。因此，该数据库不应作为数据库设计的推荐范例或最佳做法。相反，它尝试将可能会在数据库设计中遇到的许多相关功能包含了进来。例如，`consult` 数据库包含了所有可能的关系类型、复合主键和许多不同的数据类型。有关此数据库结构的更详细概览，请参见下表。

*注：*

* 本教程使用 MySQL 数据库服务器，但也可使用 JavaDB 数据库服务器来完成本教程的学习。要在 JavaDB 中创建该数据库，请下载并解压缩 link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fjavadb-consult.zip[+javadb-consult.zip+] 档案文件。此档案文件包含用于创建、放置和填充 `consult` 数据库的 SQL 脚本。
* 有关配置 IDE 使用 MySQL 的详细信息，请参见link:../ide/mysql.html[+连接 MySQL 数据库+]教程。
* 有关配置 IDE 以使用 JavaDB 的详细信息，请参见link:../ide/java-db.html[+使用 Java DB (Derby) 数据库+]教程。

*MySQL 和 GlassFish 组合：*

如果在使用 MySQL 的同时使用 GlassFish v3 或 Open Source Edition 3.0.1，则必须确保数据库受口令保护。（有关详细信息，请参见 GlassFish link:https://java.net/jira/browse/GLASSFISH-12221[+问题 12221+]。）如果您使用的是默认 MySQL `root` 帐户和空口令，则可以通过命令行提示符设置口令。

例如，要将口令设置为 `_nbuser_`，请在命令行提示符下输入以下命令。


[source,java]
----

shell> mysql -u root
mysql> UPDATE mysql.user SET Password = PASSWORD('_nbuser_') WHERE User = 'root';
mysql> FLUSH PRIVILEGES;
----

如果收到 '`mysql: command not found`' 错误，则说明尚未将 `mysql` 命令添加到 `PATH` 环境变量中。可以改为通过输入 MySQL 安装的 `bin` 目录的完整路径来调用该命令。例如，如果 `mysql` 命令位于计算机上的 `/usr/local/mysql/bin` 中，请输入以下内容：


[source,java]
----

shell> /usr/local/mysql/bin/mysql -u root
----

有关详细信息，请参见正式的 MySQL 参考手册：

* 《link:http://dev.mysql.com/doc/refman/5.1/en/default-privileges.html[+确保初始 MySQL 帐户安全+]》
* 《link:http://dev.mysql.com/doc/refman/5.1/en/invoking-programs.html[+4.2.1. 调用 MySQL 程序+]》
* 《link:http://dev.mysql.com/doc/refman/5.1/en/setting-environment-variables.html[+4.2.4. 设置环境变量+]》



执行以下步骤以创建数据库并通过 IDE 与其进行连接。

1. 下载 link:https://netbeans.org/projects/samples/downloads/download/Samples%252FJavaEE%252Fmysql-consult.zip[+mysql-consult.zip+] 并将此档案解压缩到本地系统。在解压缩档案时您将看到用于创建和填充数据库的 SQL 脚本。档案中还包含了用于拖放表的脚本。
2. 在 ""Services""（服务）窗口中，展开 ""Databases""（数据库）节点，右键单击 ""MySQL"" 节点并选择 ""Start Server""（启动服务器）。
3. 右键单击 MySQL 服务器节点并选择 ""Create Database""（创建数据库）。
4. 在 ""Create MySQL Database""（创建 MySQL 数据库）对话框中键入 *consult* 作为数据库名称。单击 ""OK""（确定）。""Databases""（数据库）节点 (`jdbc:mysql://localhost:3306/consult [root on Default schema]`) 下随即出现一个新的节点。
5. 右键单击新节点并选择 ""Connect""（连接）。
6. 从主菜单中选择 ""File""（文件）> ""Open File""（打开文件）并导航至解压缩的文件 `mysql_create_consult.sql`。单击 ""Open""（打开）。该文件会自动在 SQL 编辑器中打开。 

image::images/run-sql-script.png[title=""在 IDE 的编辑器中打开 SQL 文件""]


. 确保在 SQL 编辑器工具栏的 ""Connection""（连接）下拉列表中选择了 `consult` 数据库，然后单击 ""Run SQL""（运行 SQL）(image:images/run-sql-btn.png[]) 按钮。

单击 ""Run SQL""（运行 SQL）时，""Output""（输出）窗口中出现以下输出内容。

image::images/run-sql-output.png[title=""""Output""（输出）窗口提供有关 SQL 执行的信息""]



[[examineDB]]
== 检查数据库结构

要确认已正确创建了表，请展开数据库连接节点下的 ""Tables""（表）节点。您可以展开表节点来查看表的列、索引和任意外键。可以右键单击列并选择 ""Properties""（属性）来查看有关该列的其他信息。

image::images/services-window-tables.png[title=""""Services""（服务）窗口将显示数据库连接、表、表列、索引和外键""]

*注：*如果在 ""Tables""（表）节点下未看到任何表，右键单击 ""Tables""（表）节点并选择 ""Refresh""（刷新）。

从 `consult` 数据库的结构可看出该数据库包含了具有多种关系和各种字段类型的表。通过数据库创建实体类时，IDE 会为各种字段类型自动生成相应的代码。

image::images/diagram_consult.png[title=""consult 数据库的实体关系图""]

下表描述了 `consult` 数据库中的表。

|===
|数据库表 |描述 |设计功能 

|CLIENT |咨询机构的客户 |非生成的复合主键（其字段不构成外键） 

|CONSULTANT |咨询机构的员工，客户可基于合同对其进行聘用 |包括一个 LONG VARCHAR 类型的简历字段 

|CONSULTANT_STATUS |顾问在咨询机构的状态（例如，可能为活动和非活动的状态） |CHAR 类型的非生成主键 

|RECRUITER |负责联络客户和顾问的咨询机构的员工 |  

|PROJECT |客户配有咨询机构顾问的项目 |包含了构成 CLIENT 表的外键的两个字段的非生成复合主键 

|BILLABLE |顾问在某个项目中工作的小时数，咨询机构据其向相关客户收费 |包括一个 CLOB 类型的工件字段 

|ADDRESS |客户账单地址 |  

|PROJECT_CONSULTANT |一个连接表，表示当前为哪些项目指派了哪些顾问 |交叉引用了 PROJECT 和 CONSULTANT，其中前者有一个复合主键 
|===


`consult` 数据库包含了多种关系。在通过数据库创建实体类时，IDE 将基于列的 SQL 类型自动生成相应的 Java 类型的属性。下表描述了 `consult` 数据库的实体关系。（未显示反向关系。）

|===
|实体 |相关实体 |关系信息 |描述 

|CLIENT |RECRUITER |进行手动编辑，允许为空值的一对一关系；如果不进行手动编辑，允许为空值的一对多关系 |一个 CLIENT 有多个 RECRUITER，而一个 RECRUITER 没有或有一个 CLIENT（如果不进行手动编辑） 

|CLIENT |ADDRESS |不允许为空值的一对一关系 |一个 CLIENT 有一个 ADDRESS，而一个 ADDRESS 没有或有一个 CLIENT 

|CLIENT |PROJECT |不允许为空值的一对多关系；在 ""Project"" 实体中，客户字段的值是 ""Project"" 主键的一部分 |一个 CLIENT 有多个 PROJECT，而一个 PROJECT 只有一个 CLIENT 

|CONSULTANT |PROJECT |多对多关系 |一个 CONSULTANT 有多个 PROJECT，而一个 PROJECT 也有多个 CONSULTANT 

|CONSULTANT |BILLABLE |不允许为空值的一对多关系 |一个 CONSULTANT 有多个 BILLABLE，而一个 BILLABLE 有一个 CONSULTANT 

|CONSULTANT_STATUS |CONSULTANT |不允许为空值的一对多关系 |一个 CONSULTANT_STATUS 有多个 CONSULTANT，而一个 CONSULTANT 有一个 CONSULTANT_STATUS 

|CONSULTANT |RECRUITER |允许为空值的一对多关系 |一个 CONSULTANT 没有或有一个 RECRUITER，而一个 RECRUITER 有多个 CONSULTANT 

|BILLABLE |PROJECT |不允许为空值的一对多关系 |一个 BILLABLE 有一个 PROJECT，而一个 PROJECT 有多个 BILLABLE 
|===

既然已经创建了数据库，那么就可以创建 Web 应用程序，并使用 ""Entity Classes from Database""（通过数据库生成实体类）向导基于数据库表生成实体类。


[[createProject]]
== 创建 Web 应用程序项目

在本练习中，您将创建一个 Web 项目并将 JavaServer Faces 框架添加到该项目中。在创建项目时，需要在新建项目向导的 ""Frameworks""（框架）面板中选择 ""JavaServer Faces""。

1. 从主菜单中，选择 ""File""（文件）> ""New Project""（新建项目）（Ctrl-Shift-N 组合键；在 Mac 上为 ⌘-Shift-N 组合键）。
2. 从 ""Java Web"" 类别中选择 ""Web Application""（Web 应用程序）。单击 ""Next""（下一步）。
3. 键入 `ConsultingAgency` 作为项目名称，并设置项目位置。单击 ""Next""（下一步）。
4. 将服务器设置为 ""GlassFish""，并将 Java EE 版本设置为 ""Java EE 6 Web"" 或 ""Java EE 7 Web""。单击 ""Next""（下一步）。
5. 在 ""Frameworks""（框架）面板中，选择 ""JavaServer Faces"" 选项。单击 ""Finish""（完成）。

单击 ""Finish""（完成），此时 IDE 生成 Web 应用程序项目并在编辑器中打开 `index.xhtml`。


[[generateEntity]]
== 通过数据库生成实体类

在 IDE 中连接到数据库后，可以使用 ""Entity Classes from Database""（通过数据库生成实体类）向导基于数据库中的表快速生成实体类。IDE 可以为所选的每个表生成实体类，也可以为相关表生成任何需要的实体类。

1. 在 ""Projects""（项目）窗口中，右键单击 `ConsultingAgency` 项目节点，并选择 ""New""（新建）> ""Entity Classes from Database""（通过数据库生成实体类）。（如果未列出此选项，请选择 ""Other""（其他）。然后，在文件向导中，选择 ""Persistence""（持久性）类别，再选择 ""Entity Classes from Database""（通过数据库生成实体类）。）
2. 从 ""Data Source""（数据源）下拉列表中选择 ""New Data Source""（新建数据源）以打开 ""Create Data Source""（创建数据源）对话框。
3. 键入 `jdbc/consult` 作为 JNDI 名称，并选择 `jdbc:mysql://localhost:3306/consult` 连接作为数据库连接。

image::images/create-datasource.png[title=""指定 JNDI 名称和数据库连接以创建数据源""]


. 单击 ""OK""（确定）以关闭对话框并返回到向导。`consult` 数据库中的表出现在 ""Available Tables""（可用表）列表框中。


. 单击 ""Add All""（全部添加）按钮以选择数据库中包含的所有表。单击 ""Next""（下一步）。 

image::images/new-entities-wizard.png[]


. 键入 `jpa.entities` 作为包名称。


. 确认已选中用于生成命名查询和创建持久性单元的复选框。单击 ""Finish""（完成）。

单击 ""Finish""（完成），此时 IDE 将在项目的 `jpa.entities` 包中生成实体类。

使用向导通过数据库创建实体类时，IDE 会检查数据库表之间的关系。在 ""Projects""（项目）窗口中，如果展开 `jpa.entities` 包节点，则可以看到 IDE 为每个表（`PROJECT_CONSULTANT` 表除外）生成了一个实体类。因为 `PROJECT_CONSULTANT` 是一个连接表，所以 IDE 没有为其创建实体类。

image::images/projects-window-entities.png[title=""显示所生成实体类的 ""Projects""（项目）窗口的屏幕快照""]

IDE 还为带有复合主键的表生成了两个额外的类：`CLIENT` 和 `PROJECT`。这些表的主键类（`ClientPK.java` 和 `ProjectPK.java`）在其名称后附加了 `PK`。

如果查看为实体类生成的代码，可以发现向导为自动生成的 ID 字段添加了 `@GeneratedValue` 标注，还为实体类中的某些字段添加了 `@Basic(optional = ""false"")` 标注。基于 `@Basic(optional = ""false"")` 标注，“通过实体类创建 JSF 页”向导可以生成包含检查的代码，这些检查可防止那些字段出现不允许为空值的列违规。



[[jsfPagesEntityClasses]]
== 通过实体类生成 JSF 页

创建了实体类之后，便可以创建用于显示和修改数据的 Web 接口。您将使用“通过实体类创建 JSF 页”向导来生成 JavaServer Faces 页。向导生成的代码将基于实体类中包含的持久性标注。

对于每个实体类，向导都会生成以下文件。

* 扩展  ``AbstractFacade.java``  的无状态会话 Bean
* JSF 会话范围的受管 Bean
* 包含 CRUD 功能的四个 Facelets 文件（`Create.xhtml`、`Edit.xhtml`、`List.xhtml` 和 `View.xhtml`）的目录

向导还会生成以下文件。

* 包含实体实例的创建、检索、修改和删除业务逻辑的  ``AbstractFacade.java``  类
* JSF 受管 Bean 所使用的实用程序类（`JsfUtil` 和 `PaginationHelper`）
* 本地化消息的属性包，以及项目的 Faces 配置文件（如果不存在 `faces-config.xml` 文件，则会创建一个）中的相应条目
* 辅助 Web 文件（包括所呈现组件的默认样式表）和一个 Facelets 模板文件

生成 JSF 页：

1. 在 ""Projects""（项目）窗口中，右键单击项目节点，然后选择 ""New""（新建）> ""JSF Pages from Entity Classes""（通过实体类创建 JSF 页）打开该向导。（如果未列出此选项，请选择 ""Other""（其他）。然后，在文件向导中，选择 ""JavaServer Faces"" 类别，然后选择 ""JSF Pages from Entity Classes""（通过实体类创建 JSF 页）。）

""Available Entity Classes""（可用的实体类）框列出了项目中所包含的七个实体类。该框并未列出可嵌入类（`ClientPK.java` 和 `ProjectPK.java`）。



. 单击 ""Add All""（全部添加）以将所有类移动到 ""Selected Entity Classes""（选定的实体类）框中。

image::images/newjsf-wizard.png[title=""""New JSF Pages from Entity Classes""（通过实体类新建 JSF 页）向导显示项目中包含的所有实体类""] 

单击 ""Next""（下一步）。


. 在向导的“步骤 3”即 ""Generate JSF Pages and Classes""（生成 JSF 页和类）中，键入 `jpa.session` 作为 JPA 会话 Bean 包。


. 键入 `jsf` 作为 JSF 类包。


. 在 ""Localization Bundle Name""（本地化包名称）字段中输入 ""`/resources/Bundle`""。这样将生成一个名为 `resources` 的包，其中将包含 `Bundle.properties` 文件。（如果将此字段保留为空，则在项目的默认包中将创建属性包。） 

image::images/newjsf-wizard2.png[title=""为生成的文件指定包名称和文件夹名称""]

要使 IDE 能更好地适应您的项目约定，可以定制由向导生成的任何文件。单击 ""Customize Template""（定制模板）链接以修改向导所使用的文件模板。

image::images/customize-template.png[title=""为向导所生成的文件定制模板""] 

通常，可以使用 ""Template Manager""（模板管理器）（""Tools""（工具）> ""Templates""（模板））来访问和更改 IDE 维护的所有模板。



. 单击 ""Finish""（完成）。IDE 在 `jpa.session` 包中生成无状态会话 Bean，并在 `jsf` 包中生成 JSF 会话范围的受管 Bean。每个无状态会话 Bean 用于处理相应实体类的操作，其中包括通过 Java 持久性 API 创建、编辑和销毁实体类的实例。每个 JSF 受管 Bean 用于实现 `javax.faces.convert.Converter` 接口，并执行将相应实体类的实例转换为 `String` 对象的操作，反之亦然。

如果展开 ""Web Pages""（Web 页）节点，则可以看到 IDE 为每个实体类生成了一个文件夹。每个文件夹都包含 `Create.xhtml`、`Edit.xhtml`、`List.xhtml` 和 `View.xhtml` 文件。IDE 还通过向每个 `List.xhtml` 页中插入链接来修改 `index.xhtml` 文件。

image::images/projects-jsfpages.png[title=""向导为每个实体类生成 Facelets 页""]

每个 JSF 受管 Bean 都对应四个相应的 Facelets 文件，并且包含调用相应会话 Bean 中的方法的代码。

展开 `resources` 文件夹节点以查找由向导生成的 `jsfcrud.css` 默认样式表。如果在编辑器中打开应用程序欢迎页面 (`index.xhtml`) 或 Facelets 模板文件 (`template.xhtml`)，将会看到该文件包含了对样式表的引用。


[source,java]
----

<h:outputStylesheet name=""css/jsfcrud.css""/>
----

每个实体类所对应的四个 Facelets 文件中的每个文件都使用 Facelets 模板文件。

如果展开 ""Source Packages""（源包）节点，则可以看到向导生成的会话 Bean、JSF 受管 Bean、实用程序类和属性包。

image::images/projects-generated-classes70.png[title=""""Projects""（项目）窗口中显示向导所生成类的 ""Source Packages""（源包）目录的屏幕快照""]

为了注册属性包的位置，向导还生成了一个 Faces 配置文件 (`faces-config.xml`)。如果展开 ""Configuration File""（配置文件）节点并在 XML 编辑器中打开 `faces-config.xml`，则可以看到该文件包含了以下条目。


[source,xml]
----

<application>
    <resource-bundle>
        <base-name>/resources/Bundle</base-name>
        <var>bundle</var>
    </resource-bundle>
</application>
----

此外，如果展开新的 `resources` 包，则会发现 `Bundle.properties` 文件，该文件包含了客户端默认语言的消息。这些消息是由实体类属性派生而来的。

要添加新的属性包，请右键单击 `Bundle.properties` 文件并选择 ""Customize""（定制）。使用 ""Customizer""（定制器）对话框可以将新的语言环境添加到您的应用程序中。



[[explore]]
== 了解应用程序

既然您的项目已包含了实体类、用于控制实体类的 EJB 会话 Bean 和 JSF 驱动的用于显示和修改数据库的前端，那么请尝试运行该项目以查看结果。

以下是一系列可选的小练习，可用来进一步熟悉应用程序，以及 IDE 所提供的功能。

* <<completedProject,检查已完成的项目>>
* <<populateDB,使用 SQL 脚本填充数据库>>
* <<editorSupport,了解 Facelets 页中的编辑器支持>>
* <<dbIntegrity,通过字段验证来了解数据库完整性>>
* <<editEntity,编辑实体类>>


[[completedProject]]
=== 检查已完成的项目

1. 要运行项目，请在 ""Projects""（项目）窗口中右键单击项目节点并选择 ""Run""（运行），或单击主工具栏中的 ""Run Project""（运行项目）(image:images/run-project-btn.png[]) 按钮。

当显示应用程序的欢迎页面时，将提供一个链接列表，用于查看包含在每个数据库表中的条目。

image::images/welcome-page-links.png[title=""用于显示每个表的数据库内容的链接""]

当完成了 ""JSF Pages from Entity Classes""（通过实体类创建 JSF 页）向导时，链接将添加到欢迎页面 (`index.xhtml`)。这些链接将作为 Facelets 页（为“咨询机构”数据库提供 CRUD 功能）的入口点。


[source,xml]
----

<h:body>
    Hello from Facelets
    <h:form>
        <h:commandLink action=""/address/List"" value=""Show All Address Items""/>
    </h:form>
    <h:form>
        <h:commandLink action=""/billable/List"" value=""Show All Billable Items""/>
    </h:form>
    <h:form>
        <h:commandLink action=""/client/List"" value=""Show All Client Items""/>
    </h:form>
    <h:form>
        <h:commandLink action=""/consultant/List"" value=""Show All Consultant Items""/>
    </h:form>
    <h:form>
        <h:commandLink action=""/consultantStatus/List"" value=""Show All ConsultantStatus Items""/>
    </h:form>
    <h:form>
        <h:commandLink action=""/project/List"" value=""Show All Project Items""/>
    </h:form>
    <h:form>
        <h:commandLink action=""/recruiter/List"" value=""Show All Recruiter Items""/>
    </h:form>
</h:body>
----


. 单击 ""`Show All Consultant Items`"" 链接。查看上面的代码，则可以看到目标页为 `/consultant/List.xhtml`。（在 JSF 2.x 中，由于隐式导航所以文件扩展名是推断出来的。）

image::images/empty-consultants-list.png[title=""Consultants 表当前为空""] 

数据库目前不包含任何样例数据。可以通过单击 ""`Create New Consultant`"" 链接和使用提供的 Web 窗体手动添加数据。此操作将触发 `/consultant/Create.xhtml` 页进行显示。还在 IDE 中运行 SQL 脚本以使用样例数据填充表。以下子部分对这两个选项进行了说明。

您可以单击索引链接返回到欢迎页面列出的链接。这些链接提供了保存在每个数据库表中数据的视图，并触发了每个实体文件夹中 `List.xhtml` 文件的显示。稍后会有说明，在将数据添加到表之后，会显示其他链接，其中每个条目都允许您查看 (`View.xhtml`)、编辑 (`Edit.xhmtl`) 和销毁单个表记录的数据。

*注：*如果应用程序部署失败，请参见下面的<<troubleshooting,疑难解答>>部分。（另请参见link:mysql-webapp.html#troubleshoot[+使用 MySQL 数据库创建简单的 Web 应用程序+]的“疑难解答”部分。）


[[populateDB]]
=== 使用 SQL 脚本填充数据库

运行提供的脚本，该脚本会生成数据库表的样例数据。脚本 (`mysql_insert_data_consult.sql`) 包含在咨询机构数据库 zip 文件中，该文件可从<<requiredSoftware,所需软件表>>中下载。

根据所使用的数据库服务器（MySQL 或 JavaDB），您可以运行提供的脚本，该脚本会为数据库表生成样例数据。对于 MySQL，该脚本为 `mysql_insert_data_consult.sql`。对于 JavaDB，该脚本为 `javadb_insert_data_consult.sql`。两个脚本分别包含在各自的档案文件中，可以通过<<requiredSoftware,所需软件表>>进行下载。

1. 从主菜单中选择 ""File""（文件）> ""Open File""（打开文件），然后导航到脚本在您的计算机上的位置。单击 ""Open""（打开）。文件会自动在 IDE 的 SQL 编辑器中打开。
2. 确保在 SQL 编辑器工具栏的 ""Connection""（连接）下拉列表中选择了 `consult` 数据库。 

image::images/run-sql-insert.png[title=""在 IDE 的 SQL 编辑器中打开脚本""]

在编辑器中右键单击并选择 ""Run Statement""（运行语句），或单击 ""Run SQL""（运行 SQL）(image:images/run-sql-btn.png[]) 按钮。您可以在 ""Output""（输出）窗口中查看脚本运行的结果。



. 重新启动 GlassFish Server。这是使服务器可以重新加载和缓存 `consult` 数据库中包含的新数据所必需的步骤。为此，请在 ""Output"" 窗口中单击 ""GlassFish Server"" 标签（""GlassFish Server"" 标签显示服务器日志。），然后单击左旁注中的 ""Restart Server""（重新启动服务器）(image:images/glassfish-restart.png[]) 按钮。服务器即会停止，然后重新启动。


. 重新运行项目，然后单击 ""`Show All Consultant Items`"" 链接。将看到该列表不再为空。 
[.feature]
--

image::images/consultants-list-small.png[role=""left"", link=""images/consultants-list.png""]

--


=== NetBeans 数据库支持

可以使用 IDE 的数据库表查看器来显示和修改直接在数据库中维护的表数据。例如，右键单击 ""Services""（服务）窗口中的 `consultant` 表，然后选择 ""View Data""（查看数据）。

image::images/view-data.png[title=""从数据库表的右键单击菜单中选择 ""View Data""（查看数据）""]

在编辑器的顶部将显示用于执行操作的 SQL 查询，下面则显示表的图形视图。

[.feature]
--

image::images/view-data-table-small.png[role=""left"", link=""images/view-data-table.png""]

--

在窗体元格内双击以对数据进行内联修改。单击 ""Commit Records""（提交记录）(image:images/commit-records-icon.png[]) 图标以提交对数据库的更改。

图形视图提供了更多的功能。有关详细信息，请参见 link:../../docs/ide/database-improvements-screencast.html[+NetBeans IDE 中的数据库支持+]。



[[editorSupport]]
=== 了解 Facelets 页中的编辑器支持

1. 在编辑器中打开 `/consultant/List.xhtml` 页。第 8 行表明该页的呈现依赖于 Facelets `template.xhtml` 文件。

[source,java]
----

<ui:composition template=""/template.xhtml"">
----

要显示行号，请右键单击编辑器的左旁注，然后选择 "" Show Line""（显示行号）。



. 使用 IDE 的 ""Go to File""（转至文件）对话框来打开 `template.xhtml`。按 Alt-Shift-O 组合键（在 Mac 上为 Ctrl-Shift-O 组合键），然后开始键入 `template`。 

image::images/go-to-file.png[title=""使用 ""Go to File""（转至文件）对话框快速打开项目文件""]

单击 ""OK""（确定）（或按 Enter 键）。



. 模板将使用 `<ui:insert>` 标记将其他文件的内容插入到其标题和正文中。将光标置于 `<ui:insert>` 标记上，然后按 Ctrl-空格键调用文档弹出式窗口。 

image::images/doc-popup.png[title=""在 Facelets 标记上按 Ctrl-空格键调用文档弹出式窗口""]

可以在 JSF 标记及其属性上按 Ctrl-空格键调用文档弹出式窗口。您查看的文档是从正式的 link:http://javaserverfaces.java.net/nonav/docs/2.1/vdldocs/facelets/index.html[+JSF 标记库文档+]所提供的描述中获取的。



. 切换回 `List.xhtml` 文件（按 Ctrl-Tab 组合键）。`<ui:define>` 标记用来定义将应用于模板标题和正文的内容。为每个实体类生成的所有 4 个 Facelets 文件（`Create.xhtml`、`Edit.xhtml`、`List.xhtml` 和 `View.xhtml`）都使用了此模式。


. 将您的光标置于任何 EL 表达式（用于包含在 `Bundle.properties` 文件中的本地化消息）上。按 Ctrl-空格键查看本地化消息。 
[.feature]
--

image::images/localized-messages-small.png[role=""left"", link=""images/localized-messages.png""]

--

在上图上，可以看到 EL 表达式解析为 ""`List`""，该表达式将应用到模板标题，并且可以从呈现在浏览器中的页面得到验证。



. 滚动到文件底部并找到 `Create New Consultant` 链接的代码（第 92 行）。如下所示：

[source,java]
----

<h:commandLink action=""#{consultantController.prepareCreate}"" value=""#{bundle.ListConsultantCreateLink}""/>
----


. 在 `commandLink` 的 `action` 属性上按 Ctrl-空格键以调用文档弹出式窗口。

`action` 属性表示在浏览器中单击链接时处理请求的方法。将提供以下文档： 

_方法表达式，用于表示在用户激活此组件时要调用的应用程序操作。该表达式的值必须为一个没有参数且返回对象（调用其 toString() 以派生逻辑结果）的公共方法，该对象将被传递到此应用程序的 NavigationHandler。_
换句话说，`action` 值通常是指 JSF 受管 Bean 中的一个方法，其值为 `String`。然后 JSF 的 `NavigationHandler` 会使用该字符串将请求转发到相应的视图中。可通过以下步骤来验证这一点。


. 将光标置于 `consultantController` 上，然后按 Ctrl-空格组合键。编辑器的代码完成表明 `consultantController` 是一个 JSF 受管 Bean。 

image::images/code-completion-managed-bean.png[title=""为 JSF 受管 Bean 提供代码完成""]


. 将光标移动到 `prepareCreate`，然后按 Ctrl-空格组合键。代码完成列出了包含在 `ConsultantController` 受管 Bean 中的方法。 

image::images/code-completion-properties.png[title=""为类方法提供代码完成""]


. 按 Ctrl 键（在 Mac 上为 ⌘ 键），然后将鼠标悬停在 `prepareCreate` 上。形成了一个链接，您可以直接导航至 `ConsultantController` 受管 Bean 中的 `prepareCreate()` 方法。 

image::images/editor-navigation.png[title=""使用编辑器导航快速导航源代码""]


. 单击链接并查看 `prepareCreate()` 方法（如下所示）。

[source,java]
----

public String prepareCreate() {
    current = new Consultant();
    selectedItemIndex = -1;
    return ""Create"";
}
----
该方法将返回 `Create`。`NavigationHandler` 在后台收集信息，并将 `Create` 字符串应用于以视图（为响应请求而发送）为目标的路径：`/consultant/*Create*.xhtml`。（在 JSF 2.x 中，由于隐式导航所以文件扩展名是推断出来的。）


[[dbIntegrity]]
=== 通过字段验证来了解数据库完整性

1. 在浏览器的 <<consultantsList,Consultants List 页>>中，单击 ""`Create New Consultant`"" 链接。正如之前子部分中的说明，此操作将触发呈现 `/consultant/Create.xhtml` 页。
2. 在窗体中输入以下详细信息。目前，将 `RecruiterId` 和 `StatusId` 字段保留为空。 

|===
|字段 |值 

|ConsultantId |2 

|Email |jack.smart@jsfcrudconsultants.com 

|Password |jack.smart 

|HourlyRate |75 

|BillableHourlyRate |110 

|HireDate |07/22/2008 

|Resume |I'm a great consultant.Hire me - You won't be disappointed! 

|RecruiterId |--- 

|StatusId |--- 
|===


. 单击 ""Save""（保存）。当您执行此操作后，将对 `StatusId` 字段标记一个验证错误。

image::images/create-new-consultant.png[title=""在窗体中输入样例数据""] 

为什么会出现这种情况？重新检查<<er-diagram,“咨询机构”数据库的实体关系图>>。如上面的<<relationships,关系表>>中所述，`CONSULTANT` 和 `CONSULTANT_STATUS` 表共享一个不允许为空值的一对多的关系。所以，`CONSULTANT` 表中的每一个条目都必须包含对 `CONSULTANT_STATUS` 表中条目的引用。这将通过链接这两个表的 `consultant_fk_consultant_status` 外键来表示。

可以通过在 ""Services""（服务）窗口中展开一个表的 ""Foreign Keys""（外键）节点（Ctrl-5 组合键；在 Mac 上为 ⌘-5 组合键）来查看表中保存的外键。

image::images/consultant-fk.png[title=""在 ""Services""（服务）窗口中检查外键属性""]


. 要解决验证错误，请从 `StatusId` 下拉列表中选择 `entity.ConsultantStatus[statusId=A]`。

*注：*`RecruiterId` 字段可保留为空。正如<<er-diagram,数据库实体关系图>>中所示，在 `CONSULTANT` 和 `RECRUITER` 表之间存在一个允许为空值的一对多的关系，这就意味着 `CONSULTANT` 中的条目不需要与一个 `RECRUITER` 条目相关联。


. 单击 ""Save""（保存）。将显示一条消息，表明顾问条目已成功保存。如果单击 `Show All Consultant Items`，将看到新条目列在表中。

通常，生成的 Facelets 页会为产生下列问题的用户输入提供出错信息：

* 不允许为空值的表单元格中出现了空字段。
* 对不可更改的数据（例如主键）进行了修改。
* 插入数据的类型不正确。
* 当用户视图与数据库不再同步时对数据进行了修改。


[[editEntity]]
=== 编辑实体类

在前面的子部分中，您看到了 `StatusId` 下拉列表是如何为您提供不那么容易使用的 `entity.ConsultantStatus[statusId=A]` 选项。您可能已经注意到：此下拉列表中针对每一项显示的文本都是每个遇到的 `ConsultantStatus` 实体（即，调用了实体类的 `toString()` 方法）的字符串表示。

该子部分将演示您可以使用编辑器的代码完成、文档和导航支持作此结论的方式。此外，还教您为下拉列表准备更加易于使用的消息。

1. 在编辑器中打开 `/consultant/Create.xhtml` 文件。这是您刚在浏览器中看到的 ""Create New Consultant"" 窗体。向下滚动到 `StatusId` 下拉列表的代码处（如下面*粗体*所示）。

[source,xml]
----

    <h:outputLabel value=""#{bundle.CreateConsultantLabel_resume}"" for=""resume"" />
    <h:inputTextarea rows=""4"" cols=""30"" id=""resume"" value=""#{consultantController.selected.resume}"" title=""#{bundle.CreateConsultantTitle_resume}"" />
    *<h:outputLabel value=""#{bundle.CreateConsultantLabel_statusId}"" for=""statusId"" />
    <h:selectOneMenu id=""statusId"" value=""#{consultantController.selected.statusId}"" title=""#{bundle.CreateConsultantTitle_statusId}"" required=""true"" requiredMessage=""#{bundle.CreateConsultantRequiredMessage_statusId}"">
        <f:selectItems value=""#{consultantStatusController.itemsAvailableSelectOne}""/>
    </h:selectOneMenu>*
    <h:outputLabel value=""#{bundle.CreateConsultantLabel_recruiterId}"" for=""recruiterId"" />
    <h:selectOneMenu id=""recruiterId"" value=""#{consultantController.selected.recruiterId}"" title=""#{bundle.CreateConsultantTitle_recruiterId}"" >
        <f:selectItems value=""#{recruiterController.itemsAvailableSelectOne}""/>
    </h:selectOneMenu>
</h:panelGrid>
----


. 检查应用于 `<f:selectItems>` 标记的 `value`。`value` 属性决定了为下拉列表中每项显示的文本。

在 `itemsAvailableSelectOne` 上按 Ctrl-空格组合键。编辑器的代码完成表示 `ConsultantStatusController` 的 `getItemsAvailableSelectOne()` 方法返回了 `SelectItem` 对象的数组。 

image::images/code-completion-returned-object.png[title=""代码完成显示方法的返回类""]


. 按 Ctrl 键（在 Mac 上为 ⌘ 键），然后将鼠标悬停在 `itemsAvailableSelectOne` 上。形成了一个链接，您可以直接导航至 `ConsultantStatus` 实体源代码中的 `getItemsAvailableSelectOne()` 方法。单击该链接。


. 将光标置于方法签名中的 `SelectItem[]` 返回值上，然后按 Ctrl-空格键调用文档弹出式窗口。 

image::images/documentation-select-item.png[title=""按 Ctrl-空格键调用文档支持""]

单击 ""documentation""（文档）窗口中的 ""web browser""（Web 浏览器）(image:images/web-browser-icon.png[]) 图标以在外部 Web 浏览器中打开 Javadoc。

正如您所看到的，`SelectItem` 类属于 JSF 框架。文档中提到的 `UISelectOne` 组件使用您在上述<<markup,步骤 1>> 中检查的标记中的 `<h:selectOneMenu>` 标记来表示。


. 按 Ctrl 键（在 Mac 上为 ⌘ 键），然后将鼠标悬停在 `findAll()` 上。随即出现一个弹出式窗口，显示方法签名。

image::images/method-signature.png[title=""在编辑器中查看方法签名的弹出式窗口""] 

可以看到此处的 `ejbFacade.findAll()` 返回了 `ConsultantStatus` 对象的 `List`。


. 导航至 `JsfUtil.getSelectItems`。将鼠标悬停在 `getSelectItems` 上并按 Ctrl 键（在 Mac 上为 ⌘），然后单击显示的链接。

*注：*回想一下，`JsfUtil` 是在您完成<<jsfPagesEntityClasses,“通过实体类创建 JSF 页”向导>>时生成的一个实用程序类。

该方法对实体列表（即 `ConsultantStatus` 对象的 `List`）执行循环操作，为每个实体创建 `SelectItem`。如下面*粗体*所示，每个 `SelectItem` 都是使用实体对象和对象的_标签_来创建的。

[source,java]
----

public static SelectItem[] getSelectItems(List<?> entities, boolean selectOne) {
    int size = selectOne ? entities.size() + 1 : entities.size();
    SelectItem[] items = new SelectItem[size];
    int i = 0;
    if (selectOne) {
        items[0] = new SelectItem("""", ""---"");
        i++;
    }
    *for (Object x : entities) {
        items[i++] = new SelectItem(x, x.toString());
    }*
    return items;
}
----

该标签使用实体的 `toString()` 方法来创建，并且在响应中呈现对象时是对象的表示。（请参见 `SelectItem(java.lang.Object value, java.lang.String label)` 构造函数的 Javadoc 定义。）

既然您已在查看下拉列表中的项时，验证了实体 `toString()` 方法正是浏览器中所呈现的内容，那么请修改 `ConsultantStatus` `toString()` 方法。



. 在编辑器中打开 `ConsultantStatus` 实体类。修改 `toString` 方法以返回 `statusId` 和 `description`。这些是对应于 `CONSULTANT_STATUS` 表的两列的实体属性。

[source,java]
----

public String toString() {
    return *statusId + "", "" + description;*
}
----


. 重新运行项目。当浏览器显示欢迎页面时，单击 `Show All Consultant Items` 链接，然后单击 `Create New Consultant`。

检查 `StatusId` 下拉列表。将看到现在显示的是数据库的 `CONSULTANT_STATUS` 表中所包含的一个记录的状态 ID 和描述。

image::images/drop-down.png[title=""""StatusId"" 下拉列表根据 ConsultantStatus 实体的 toString() 方法显示各项""]


[[troubleshooting]]
== 疑难解答

根据您的配置不同，将应用程序部署到服务器可能会失败，您可能会在 ""Output""（输出）窗口中看到以下消息。


[source,java]
----

GlassFish Server 4 is running.
In-place deployment at /MyDocuments/ConsultingAgency/build/web
GlassFish Server 4, deploy, null, false
/MyDocuments/ConsultingAgency/nbproject/build-impl.xml:1045: The module has not been deployed.
See the server log for details.
----

最常见的失败原因是，在服务器上生成 JDBC 资源时出现问题。如果是这样，您可能会在 ""Output""（输出）窗口的 ""server log""（服务器日志）标签中看到类似于以下内容的消息。


[source,java]
----

Severe:   Exception while preparing the app : Invalid resource : jdbc/consult__pm
com.sun.appserv.connectors.internal.api.ConnectorRuntimeException: Invalid resource : jdbc/consult__pm
----

如果 ""server log""（服务器日志）标签未打开，您可以通过在 ""Services""（服务）窗口中右键单击 ""GlassFish Server"" 节点并选择 ""View Domain Server Log""（查看域服务器日志）来打开此标签。

此应用程序需要两个 JDBC 资源：

* JDBC 资源或数据源。此应用程序使用 JNDI 查找来定位 JDBC 资源。如果在持久性单元 (`persistence.xml`) 中查找，您可以看到此应用程序的 JTA 数据源的 JNDI 名称为 `jdbc/consult`。

JDBC 资源标识当前由此应用程序使用的连接池。

* JDBC 连接池。连接池指定数据库的连接详细信息，包括位置、用户名、口令。用于此应用程序的连接池为 `consultPool`。

在 `glassfish-resources.xml` 文件中指定 JDBC 资源和连接池。通过在 ""Projects""（项目）窗口中展开 ""Server Resources""（服务器资源）节点并双击 `glassfish-resources.xml` 文件，可以在编辑器中打开此文件。此文件看起来类似于以下内容。


[source,xml]
----

<?xml version=""1.0"" encoding=""UTF-8""?>
<!DOCTYPE resources PUBLIC ""-//GlassFish.org//DTD GlassFish Application Server 3.1 Resource Definitions//EN"" ""http://glassfish.org/dtds/glassfish-resources_1_5.dtd"">
<resources>
  <jdbc-connection-pool allow-non-component-callers=""false"" associate-with-thread=""false"" connection-creation-retry-attempts=""0"" connection-creation-retry-interval-in-seconds=""10"" connection-leak-reclaim=""false"" connection-leak-timeout-in-seconds=""0"" connection-validation-method=""auto-commit"" datasource-classname=""com.mysql.jdbc.jdbc2.optional.MysqlDataSource"" fail-all-connections=""false"" idle-timeout-in-seconds=""300"" is-connection-validation-required=""false"" is-isolation-level-guaranteed=""true"" lazy-connection-association=""false"" lazy-connection-enlistment=""false"" match-connections=""false"" max-connection-usage-count=""0"" max-pool-size=""32"" max-wait-time-in-millis=""60000"" name=""consultPool"" non-transactional-connections=""false"" ping=""false"" pool-resize-quantity=""2"" pooling=""true"" res-type=""javax.sql.DataSource"" statement-cache-size=""0"" statement-leak-reclaim=""false"" statement-leak-timeout-in-seconds=""0"" statement-timeout-in-seconds=""-1"" steady-pool-size=""8"" validate-atmost-once-period-in-seconds=""0"" wrap-jdbc-objects=""false"">
    <property name=""serverName"" value=""localhost""/>
    <property name=""portNumber"" value=""3306""/>
    <property name=""databaseName"" value=""consult""/>
    <property name=""User"" value=""root""/>
    <property name=""Password"" value=""nb""/>
    <property name=""URL"" value=""jdbc:mysql://localhost:3306/consult?zeroDateTimeBehavior=convertToNull""/>
    <property name=""driverClass"" value=""com.mysql.jdbc.Driver""/>
  /<jdbc-connection-pool>
  <jdbc-resource enabled=""true"" jndi-name=""jdbc/consult"" object-type=""user"" pool-name=""consultPool""/>
/<resources>
----

在 `glassfish-resources.xml` 中，您可以看到 JDBC 资源 `jdbc/consult` 将 `consultPool` 标识为连接池的名称。您还可以看到 `consultPool` 的属性。在此应用程序中，只在 `glassfish-resources.xml` 中定义一个数据源和一个连接池。在某些情况下，您可能需要指定其他资源，例如，用于标识仅用于开发或测试的临时数据存储。

如果在运行应用程序时未自动在服务器上生成 JDBC 资源和连接池，您可以执行以下步骤在 GlassFish 管理控制台中手动创建这些资源。

1. 如果尚未打开 `glassfish-resources.xml`，请在编辑器中打开它。

创建 JDBC 资源和连接池时，将使用在 `glassfish-resources.xml` 中指定的属性值。



. 在 ""Services""（服务）窗口中右键单击 ""GlassFish Server"" 节点，然后在弹出式菜单中选择 ""Open Domain Admin Console""（打开域管理控制台）在浏览器中打开 GlassFish 控制台。


. 在 GlassFish 控制台的 ""Common Tasks""（常见任务）导航面板中，展开 *JDBC* 节点以及 *JDBC Resources*（JDBC 资源）和 *JDBC Connection Pools*（JDBC 连接池）节点。
[.feature]
--

image::images/gf-admin-console-sm.png[role=""left"", link=""images/gf-admin-console-lg.png""]

--

您可以看到当前注册到服务器的 JDBC 资源。如果在 ""Common Tasks""（常见任务）导航面板中的 ""JDBC"" 节点下未列出 `jdbc/consult` 和 `consultPool`，则您将需要创建它们。在安装服务器时，默认情况下创建了一些 JDBC 资源并且这些资源显示为子节点。



. 单击 *JDBC Connection Pools*（JDBC 连接池）节点，然后在 ""New JDBC Connection Pool""（新建 JDBC 连接池）窗格中单击 ""New""（新建）。

image::images/gf-new-jdbc-pool1.png[title=""GlassFish 管理控制台中的 &quot;New JDBC Connection Pool&quot;（新建 JDBC 连接池）窗格""]


. 键入 *consultPool* 作为池名称，选择 *javax.sql.ConnectionPoolDataSource* 作为资源类型并选择 *MySql* 作为数据库驱动程序供应商。单击 ""Next""（下一步）。


. 在步骤 2 中，定位并指定 *URL*、*username* 和 *password* 属性的值。单击 ""Finish""（完成）。

image::images/gf-new-jdbc-pool2.png[title=""GlassFish 管理控制台中的 &quot;New JDBC Connection Pool&quot;（新建 JDBC 连接池）面板""]

可以在 `glassfish-resources.xml` 中查找这些属性的值。

单击 ""Finish""（完成）时，将在服务器上创建新的连接池，并在 ""JDBC Connection Pools""（JDBC 连接池）节点下显示此连接池的节点。



. 在 ""Common Tasks""（常见任务）导航面板中单击 *JDBC Resources*（JDBC 资源）节点并单击 ""New""（新建）。


. 为 ""JNDI Name""（JNDI 名称）键入 *jdbc/consult*，并在 ""Pool Name""（池名称）下拉列表中选择 *consultPool*。单击 ""OK""（确定）。

image::images/gf-new-jdbc-resource.png[title=""GlassFish 管理控制台中的 &quot;New JDBC Resource&quot;（新建 JDBC 资源）窗格""]

单击 ""OK""（确定）时，将在服务器上创建新的 JDBC 资源，并在 ""JDBC Resources""（JDBC 资源）节点下显示此资源的节点。

在 IDE 的 ""Service""（服务）窗口中，可以在 ""GlassFish Server"" 下展开 ""Resources""（资源）节点，您会看到 IDE 已添加新资源。您可能需要刷新视图（右键单击 ""Resources""（资源）并选择 ""Refresh""（刷新））来查看更改。

image::images/gf-services-jdbc-resources.png[title=""在 IDE 的 &quot;Service&quot;（服务）窗口中显示的 JDBC 资源""]

有关使用 MySQL 和 IDE 时的问题疑难解答的更多提示，请参见以下文档：

* link:../ide/mysql.html[+连接 MySQL 数据库+]教程。
* link:mysql-webapp.html#troubleshoot[+使用 MySQL 数据库创建简单的 Web 应用程序+]的“疑难解答”部分
link:/about/contact_form.html?to=3&subject=Feedback:%20Creating%20a%20JSF%202.0%20CRUD%20Application[+发送有关此教程的反馈意见+]



[[seealso]]
== 另请参见

有关 JSF 2.x 的详细信息，请参见以下资源。


=== NetBeans 文章和教程

* link:jsf20-intro.html[+NetBeans IDE 中的 JavaServer Faces 2.x 简介+]
* link:jsf20-support.html[+NetBeans IDE 中的 JSF 2.x 支持+]
* link:../../samples/scrum-toys.html[+Scrum 玩具 - JSF 2.0 完整样例应用程序+]
* link:../javaee/javaee-gettingstarted.html[+Java EE 应用程序入门指南+]
* link:../../trails/java-ee.html[+Java EE 和 Java Web 学习资源+]


=== 外部资源

* link:http://www.oracle.com/technetwork/java/javaee/javaserverfaces-139869.html[+JavaServer Faces 技术+]（官方主页）
* link:http://jcp.org/aboutJava/communityprocess/final/jsr314/index.html[+JSR 314：JavaServer Faces 2.0 的规范+]
* Java EE 7 教程中的 link:http://docs.oracle.com/javaee/7/tutorial/doc/jsf-intro.htm[+JavaServer Faces 技术+]一章
* link:http://javaserverfaces.dev.java.net/[+GlassFish 项目 Mojarra+]（JSF 2.x 的正式引用实现）
* link:http://forums.oracle.com/forums/forum.jspa?forumID=982[+OTN 论坛：JavaServer Faces+]
* link:http://www.jsfcentral.com/[+JSF 中心+]


=== 博客

* link:http://www.java.net/blogs/edburns/[+Ed Burns+]
* link:http://www.java.net/blogs/driscoll/[+Jim Driscoll+]
",12520,False,2137.6650539826583,median
"// Copyright 2017 the original author or authors.
//
// Licensed under the Apache License, Version 2.0 (the ""License"");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ""AS IS"" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

[[native_software]]
= Building native software


[CAUTION]
====
The https://blog.gradle.org/state-and-future-of-the-gradle-software-model[software model] is being retired and the plugins mentioned in this chapter will eventually be deprecated and removed.
We recommend new projects looking to build C++ applications and libraries use the newer <<building_cpp_projects.adoc#,replacement plugins>>.
====

The native software plugins add support for building native software components, such as executables or shared libraries, from code written in C++, C and other languages. While many excellent build tools exist for this space of software development, Gradle offers developers its trademark power and flexibility together with dependency management practices more traditionally found in the JVM development space.

The native software plugins make use of the Gradle <<software_model.adoc#software_model,software model>>.


[[sec:native_features]]
== Features

The native software plugins provide:

* Support for building native libraries and applications on Windows, Linux, macOS and other platforms.
* Support for several source languages.
* Support for building different variants of the same software, for different architectures, operating systems, or for any purpose.
* Incremental parallel compilation, precompiled headers.
* Dependency management between native software components.
* Unit test execution.
* Generate Visual studio solution and project files.
* Deep integration with various tool chain, including discovery of installed tool chains.


[[sec:supported_languages]]
== Supported languages

The following source languages are currently supported:

* C
* C++
* Objective-C
* Objective-C++
* Assembly
* Windows resources


[[native-binaries:tool-chain-support]]
== Tool chain support

Gradle offers the ability to execute the same build using different tool chains. When you build a native binary, Gradle will attempt to locate a tool chain installed on your machine that can build the binary. You can fine tune exactly how this works, see <<#native_binaries:tool_chain,Tool chain support>> for details.

The following tool chains are supported:

[%header%autowidth,compact]
|===
| Operating System | Tool Chain | Notes

| Linux
| http://gcc.gnu.org/[GCC]
|

| Linux
| http://clang.llvm.org[Clang]
|

| macOS
| XCode
| Uses the Clang tool chain bundled with XCode.

| Windows
| https://visualstudio.microsoft.com/[Visual C++]
| Windows XP and later, Visual C++ 2010/2012/2013/2015/2017/2019.

| Windows
| http://gcc.gnu.org/[GCC] with http://cygwin.com[Cygwin 32 and Cygwin 64]
| Windows XP and later.

| Windows
| http://gcc.gnu.org/[GCC] with http://www.mingw.org/[MinGW] and https://mingw-w64.org/doku.php[MinGW64]
| Windows XP and later.
|===

The following tool chains are unofficially supported. They generally work fine, but are not tested continuously:

[%header%autowidth,compact]
|===
| Operating System | Tool Chain | Notes

| macOS
| http://gcc.gnu.org/[GCC] from Macports
|

| macOS
| http://clang.llvm.org[Clang] from Macports
|

| UNIX-like
| http://gcc.gnu.org/[GCC]
|

| UNIX-like
| http://clang.llvm.org[Clang]
|
|===


[[sec:tool_chain_installation]]
== Tool chain installation


[NOTE]
====

Note that if you are using GCC then you currently need to install support for C+\\+, even if you are not building from C++ source. This restriction will be removed in a future Gradle version.

====

To build native software, you will need to have a compatible tool chain installed:


[[sec:windows]]
=== Windows

To build on Windows, install a compatible version of Visual Studio. The native plugins will discover the Visual Studio installations and select the latest version. There is no need to mess around with environment variables or batch scripts. This works fine from a Cygwin shell or the Windows command-line.

Alternatively, you can install Cygwin with GCC or MinGW. Clang is currently not supported.

[[sec:macOS]]
=== macOS

To build on macOS, you should install XCode. The native plugins will discover the XCode installation using the system PATH.

The native plugins also work with GCC and Clang bundled with Macports. To use one of the Macports tool chains, you will need to make the tool chain the default using the `port select` command and add Macports to the system PATH.

[[sec:linux]]
=== Linux

To build on Linux, install a compatible version of GCC or Clang. The native plugins will discover GCC or Clang using the system PATH.

[[sec:native_software_model]]
== Native software model

The native software model builds on the base Gradle <<software_model_concepts.adoc#software_model_concepts,software model>>.

To build native software using Gradle, your project should define one or more _native components_. Each component represents either an executable or a library that Gradle should build. A project can define any number of components. Gradle does not define any components by default.

For each component, Gradle defines a _source set_ for each language that the component can be built from. A source set is essentially just a set of source directories containing source files. For example, when you apply the `c` plugin and define a library called `helloworld`, Gradle will define, by default, a source set containing the C source files in the `src/helloworld/c` directory. It will use these source files to build the `helloworld` library. This is described in more detail below.

For each component, Gradle defines one or more _binaries_ as output. To build a binary, Gradle will take the source files defined for the component, compile them as appropriate for the source language, and link the result into a binary file. For an executable component, Gradle can produce executable binary files. For a library component, Gradle can produce both static and shared library binary files. For example, when you define a library called `helloworld` and build on Linux, Gradle will, by default, produce `libhelloworld.so` and `libhelloworld.a` binaries.

In many cases, more than one binary can be produced for a component. These binaries may vary based on the tool chain used to build, the compiler/linker flags supplied, the dependencies provided, or additional source files provided. Each native binary produced for a component is referred to as a _variant_. Binary variants are discussed in detail below.

[[sec:parallel_compilation]]
== Parallel Compilation

Gradle uses the single build worker pool to concurrently compile and link native components, by default. No special configuration is required to enable concurrent building.

By default, the worker pool size is determined by the number of available processors on the build machine (as reported to the build JVM). To explicitly set the number of workers use the `--max-workers` command-line option or `org.gradle.workers.max` system property. There is generally no need to change this setting from its default.

The build worker pool is shared across all build tasks. This means that when using <<multi_project_builds.adoc#sec:parallel_execution,parallel project execution>>, the maximum number of concurrent individual compilation operations does not increase. For example, if the build machine has 4 processing cores and 10 projects are compiling in parallel, Gradle will only use 4 total workers, not 40.

[[sec:building_a_library]]
== Building a library

To build either a static or shared native library, you define a library component in the `components` container. The following sample defines a library called `hello`:

=== Example: Defining a library component

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/c/build.gradle[tag=libraries]
----

A library component is represented using link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]. Each library component can produce at least one shared library binary (link:{javadocPath}/org/gradle/nativeplatform/SharedLibraryBinarySpec.html[SharedLibraryBinarySpec]) and at least one static library binary (link:{javadocPath}/org/gradle/nativeplatform/StaticLibraryBinarySpec.html[StaticLibraryBinarySpec]).

[[sec:building_an_executable]]
== Building an executable

To build a native executable, you define an executable component in the `components` container. The following sample defines an executable called `main`:

=== Example: Defining executable components

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/c/build.gradle[tag=executables]
----

An executable component is represented using link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec]. Each executable component can produce at least one executable binary (link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableBinarySpec.html[NativeExecutableBinarySpec]).

For each component defined, Gradle adds a link:{javadocPath}/org/gradle/language/base/FunctionalSourceSet.html[FunctionalSourceSet] with the same name. Each of these functional source sets will contain a language-specific source set for each of the languages supported by the project.

[[sec:dependents]]
== Assembling or building dependents

Sometimes, you may need to _assemble_ (compile and link) or _build_ (compile, link and test) a component or binary and its _dependents_ (things that depend upon the component or binary). The native software model provides tasks that enable this capability. First, the _dependent components_ report gives insight about the relationships between each component. Second, the _build and assemble dependents_ tasks allow you to assemble or build a component and its dependents in one step.

In the following example, the build file defines `OpenSSL` as a dependency of `libUtil` and `libUtil` as a dependency of `LinuxApp` and `WindowsApp`. Test suites are treated similarly. Dependents can be thought of as reverse dependencies.

.Dependent Components Example
image::nativeDependents.png[]

[NOTE]
====
By following the dependencies backwards, you can see `LinuxApp` and `WindowsApp` are _dependents_ of `libUtil`. When `libUtil` is changed, Gradle will need to recompile or relink `LinuxApp` and `WindowsApp`.
====


When you _assemble_ dependents of a component, the component and all of its dependents are compiled and linked, including any test suite binaries. Gradle's up-to-date checks are used to only compile or link if something has changed. For instance, if you have changed source files in a way that do not affect the headers of your project, Gradle will be able to skip compilation for dependent components and only need to re-link with the new library. Tests are not run when assembling a component.

When you _build_ dependents of a component, the component and all of its dependent binaries are compiled, linked _and checked_. Checking components means running any <<#sec:check_tasks,check task>> including executing any test suites, so tests _are_ run when building a component.

In the following sections, we will demonstrate the usage of the `assembleDependents\\*`, `buildDependents*` and `dependentComponents` tasks with a sample build that contains a CUnit test suite. The build script for the sample is the following:

=== Example: Sample build

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/cunit/build.gradle[tag=terse-example]
----

NOTE: The code for this example can be found at **`samples/native-binaries/cunit`** in the ‘-all’ distribution of Gradle.


[[sec:dependents_report]]
=== Dependent components report

Gradle provides a report that you can run from the command-line that shows a graph of components in your project and components that depend upon them. The following is an example of running `gradle dependentComponents` on the sample project:

=== Example: Dependent components report

.Output of **`gradle dependentComponents`**
----
> gradle dependentComponents
include::{samplesPath}/native-binaries/cunit/dependentComponentsReport.out[]
----

[NOTE]
====
See link:{groovyDslPath}/org.gradle.api.reporting.dependents.DependentComponentsReport.html[DependentComponentsReport] API documentation for more details.
====

By default, non-buildable binaries and test suites are hidden from the report. The `dependentComponents` task provides options that allow you to see all dependents by using the `--all` option:

=== Example: Dependent components report

.Output of **`gradle dependentComponents --all`**
----
> gradle dependentComponents --all
include::{samplesPath}/native-binaries/cunit/dependentComponentsReportAll.out[]
----

Here is the corresponding report for the `operators` component, showing dependents of all its binaries:

=== Example: Report of components that depends on the operators component

.Output of **`gradle dependentComponents --component operators`**
----
> gradle dependentComponents --component operators
include::{samplesPath}/native-binaries/cunit/assembleDependentComponentsReport.out[]
----

Here is the corresponding report for the `operators` component, showing dependents of all its binaries, including test suites:

=== Example: Report of components that depends on the operators component, including test suites

.Output of **`gradle dependentComponents --test-suites --component operators`**
----
> gradle dependentComponents --test-suites --component operators
include::{samplesPath}/native-binaries/cunit/buildDependentComponentsReport.out[]
----


[[sec:assemble_dependents]]
=== Assembling dependents

For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec], Gradle will create a task named `assembleDependents__${component.name}${binary.variant}__` that _assembles_ (compile and link) the binary and all of its dependent binaries.

For each link:{javadocPath}/org/gradle/nativeplatform/NativeComponentSpec.html[NativeComponentSpec], Gradle will create a task named `assembleDependents__${component.name}__` that _assembles_ all the binaries of the component and all of their dependent binaries.

For example, to assemble the dependents of the ""passing"" flavor of the ""static"" library binary of the ""operators"" component, you would run the `assembleDependentsOperatorsPassingStaticLibrary` task:

=== Example: Assemble components that depends on the passing/static binary of the operators component

.Output of **`gradle assembleDependentsOperatorsPassingStaticLibrary --max-workers=1`**
----
> gradle assembleDependentsOperatorsPassingStaticLibrary --max-workers=1
include::{samplesPath}/native-binaries/cunit/assembleDependentComponents.out[]
----

In the output above, the targeted binary gets assembled as well as the test suite binary that depends on it.

You can also assemble _all_ of the dependents of a component (i.e. of all its binaries/variants) using the corresponding component task, e.g. `assembleDependentsOperators`. This is useful if you have many combinations of build types, flavors and platforms and want to assemble all of them.

[[sec:build_dependents]]
=== Building dependents

For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec], Gradle will create a task named `buildDependents__${component.name}${binary.variant}__` that _builds_ (compile, link and check) the binary and all of its dependent binaries.

For each link:{javadocPath}/org/gradle/nativeplatform/NativeComponentSpec.html[NativeComponentSpec], Gradle will create a task named `buildDependents__${component.name}__` that _builds_ all the binaries of the component and all of their dependent binaries.

For example, to build the dependents of the ""passing"" flavor of the ""static"" library binary of the ""operators"" component, you would run the `buildDependentsOperatorsPassingStaticLibrary` task:

=== Example: Build components that depends on the passing/static binary of the operators component

.Output of **`gradle buildDependentsOperatorsPassingStaticLibrary --max-workers=1`**
----
> gradle buildDependentsOperatorsPassingStaticLibrary --max-workers=1
include::{samplesPath}/native-binaries/cunit/buildDependentComponents.out[]
----

In the output above, the targeted binary as well as the test suite binary that depends on it are built and the test suite has run.

You can also build _all_ of the dependents of a component (i.e. of all its binaries/variants) using the corresponding component task, e.g. `buildDependentsOperators`.

[[sec:native_tasks]]
== Tasks

For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] that can be produced by a build, a single _lifecycle task_ is constructed that can be used to create that binary, together with a set of other tasks that do the actual work of compiling, linking or assembling the binary.


`__${component.name}__Executable`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableBinarySpec.html[NativeExecutableBinarySpec]
  Location of created binary;;
    `__${project.buildDir}__/exe/__${component.name}__/__${component.name}__`

`__${component.name}__SharedLibrary`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/SharedLibraryBinarySpec.html[SharedLibraryBinarySpec]
  Location of created binary;;
    `__${project.buildDir}__/libs/__${component.name}__/shared/lib__${component.name}__.so`

`__${component.name}__StaticLibrary`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/StaticLibraryBinarySpec.html[StaticLibraryBinarySpec]
  Location of created binary;;
    `__${project.buildDir}__/libs/__${component.name}__/static/__${component.name}__.a`


[[sec:check_tasks]]
=== Check tasks

For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] that can be produced by a build, a single _check task_ is constructed that can be used to assemble and check that binary.

`check__${component.name}__Executable`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableBinarySpec.html[NativeExecutableBinarySpec]

`check__${component.name}__SharedLibrary`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/SharedLibraryBinarySpec.html[SharedLibraryBinarySpec]

`check__${component.name}__StaticLibrary`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/SharedLibraryBinarySpec.html[SharedLibraryBinarySpec]

The built-in `check` task depends on all the _check tasks_ for binaries in the project. Without either <<#native_binaries:cunit,CUnit>> or <<#native_binaries:google_test,GoogleTest>> plugins, the binary check task only depends on the _lifecycle task_ that assembles the binary, see <<#sec:native_tasks,Native tasks>>.

When the <<#native_binaries:cunit,CUnit>> or <<#native_binaries:google_test,GoogleTest>> plugins are applied, the task that executes the test suites for a component are automatically wired to the appropriate _check task_.

You can also add custom check tasks as follows:

=== Example: Adding a custom check task

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/custom-check/build.gradle[tag=custom-check]
----

NOTE: The code for this example can be found at **`samples/native-binaries/custom-check`** in the ‘-all’ distribution of Gradle.


Now, running `check` or any of the _check tasks_ for the `hello` binaries will run the custom check task:

=== Example: Running checks for a given binary

.Output of **`gradle checkHelloSharedLibrary`**
----
> gradle checkHelloSharedLibrary
include::{samplesPath}/native-binaries/custom-check/nativeComponentCustomCheckOutput.out[]
----


[[sec:working_with_shared_libraries]]
=== Working with shared libraries

For each executable binary produced, the `cpp` plugin provides an `install${binary.name}` task, which creates a development install of the executable, along with the shared libraries it requires. This allows you to run the executable without needing to install the shared libraries in their final locations.

[[sec:finding_out_more_about_your_project]]
== Finding out more about your project

Gradle provides a report that you can run from the command-line that shows some details about the components and binaries that your project produces. To use this report, just run `gradle components`. Below is an example of running this report for one of the sample projects:

=== Example: The components report

.Output of **`gradle components`**
----
> gradle components
include::{samplesPath}/native-binaries/cpp/nativeComponentReport.out[]
----


[[native_binaries:languages]]
== Language support

Presently, Gradle supports building native software from any combination of source languages listed below. A native binary project will contain one or more named `FunctionalSourceSet` instances (e.g. 'main', 'test', etc), each of which can contain ``LanguageSourceSet``s containing source files, one for each language.

* C
* C++
* Objective-C
* Objective-C++
* Assembly
* Windows resources


[[sec:cpp_sources]]
=== C++ sources

C++ language support is provided by means of the `'cpp'` plugin.

=== Example: The 'cpp' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/cpp/build.gradle[tag=apply-plugin]
----

$$C++$$ sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.cpp.CppSourceSet.html[CppSourceSet], which defines a set of C++ source files and optionally a set of exported header files (for a library). By default, for any named component the link:{groovyDslPath}/org.gradle.language.cpp.CppSourceSet.html[CppSourceSet] contains `.cpp` source files in `src/${name}/cpp`, and header files in `src/${name}/headers`.

While the `cpp` plugin defines these default locations for each link:{groovyDslPath}/org.gradle.language.cpp.CppSourceSet.html[CppSourceSet], it is possible to extend or override these defaults to allow for a different project layout.

=== Example: C++ source set

[source.multi-language-sample,groovy,indent=0]
.build.gradle
----
include::{samplesPath}/native-binaries/custom-layout/build.gradle[tag=cpp-sources]
----

For a library named 'main', header files in `src/main/headers` are considered the ""public"" or ""exported"" headers. Header files that should not be exported should be placed inside the `src/main/cpp` directory (though be aware that such header files should always be referenced in a manner relative to the file including them).

[[sec:c_sources]]
=== C sources

C language support is provided by means of the `'c'` plugin.

=== Example: The 'c' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/c/build.gradle[tag=apply-plugin]
----

C sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.c.CSourceSet.html[CSourceSet], which defines a set of C source files and optionally a set of exported header files (for a library). By default, for any named component the link:{groovyDslPath}/org.gradle.language.c.CSourceSet.html[CSourceSet] contains `.c` source files in `src/${name}/c`, and header files in `src/${name}/headers`.

While the `c` plugin defines these default locations for each link:{groovyDslPath}/org.gradle.language.c.CSourceSet.html[CSourceSet], it is possible to extend or override these defaults to allow for a different project layout.

=== Example: C source set

[source.multi-language-sample,groovy,indent=0]
.build.gradle
----
include::{samplesPath}/native-binaries/custom-layout/build.gradle[tag=c-sources]
----

For a library named 'main', header files in `src/main/headers` are considered the ""public"" or ""exported"" headers. Header files that should not be exported should be placed inside the `src/main/c` directory (though be aware that such header files should always be referenced in a manner relative to the file including them).

[[sec:assembler_sources]]
=== Assembler sources

Assembly language support is provided by means of the `'assembler'` plugin.

=== Example: The 'assembler' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/assembler/build.gradle[tag=apply-plugin]
----

Assembler sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.assembler.AssemblerSourceSet.html[AssemblerSourceSet], which defines a set of Assembler source files. By default, for any named component the link:{groovyDslPath}/org.gradle.language.assembler.AssemblerSourceSet.html[AssemblerSourceSet] contains `.s` source files under `src/${name}/asm`.

[[sec:objectivec_sources]]
=== Objective-C sources

Objective-C language support is provided by means of the `'objective-c'` plugin.

=== Example: The 'objective-c' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/objective-c/build.gradle[tag=apply-plugin]
----

Objective-C sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.objectivec.ObjectiveCSourceSet.html[ObjectiveCSourceSet], which defines a set of Objective-C source files. By default, for any named component the link:{groovyDslPath}/org.gradle.language.objectivec.ObjectiveCSourceSet.html[ObjectiveCSourceSet] contains `.m` source files under `src/${name}/objectiveC`.

[[sec:objectivecpp_sources]]
=== Objective-C++ sources

Objective-C++ language support is provided by means of the `'objective-cpp'` plugin.

=== Example: The 'objective-cpp' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/objective-cpp/build.gradle[tag=apply-plugin]
----

Objective-C$$++$$ sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.objectivecpp.ObjectiveCppSourceSet.html[ObjectiveCppSourceSet], which defines a set of Objective-C++ source files. By default, for any named component the link:{groovyDslPath}/org.gradle.language.objectivecpp.ObjectiveCppSourceSet.html[ObjectiveCppSourceSet] contains `.mm` source files under `src/${name}/objectiveCpp`.

[[sec:configuring_the_compiler_assembler_and_linker]]
== Configuring the compiler, assembler and linker

Each binary to be produced is associated with a set of compiler and linker settings, which include command-line arguments as well as macro definitions. These settings can be applied to all binaries, an individual binary, or selectively to a group of binaries based on some criteria.

=== Example: Settings that apply to all binaries

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/cpp/build.gradle[tag=all-binaries]
----

Each binary is associated with a particular link:{javadocPath}/org/gradle/nativeplatform/toolchain/NativeToolChain.html[NativeToolChain], allowing settings to be targeted based on this value.

It is easy to apply settings to all binaries of a particular type:

=== Example: Settings that apply to all shared libraries

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/c/build.gradle[tag=all-shared-libraries]
----

Furthermore, it is possible to specify settings that apply to all binaries produced for a particular `executable` or `library` component:

=== Example: Settings that apply to all binaries produced for the 'main' executable component

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/assembler/build.gradle[tag=assembler-args]
----

The example above will apply the supplied configuration to all `executable` binaries built.

Similarly, settings can be specified to target binaries for a component that are of a particular type: e.g. all shared libraries for the main library component.

=== Example: Settings that apply only to shared libraries produced for the 'main' library component

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/cpp-lib/build.gradle[tag=args]
----


[[native_binaries:windows-resources]]
== Windows Resources

When using the link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.VisualCpp.html[VisualCpp] tool chain, Gradle is able to compile Window Resource (`rc`) files and link them into a native binary. This functionality is provided by the `'windows-resources'` plugin.

=== Example: The 'windows-resources' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/windows-resources/build.gradle[tag=apply-plugin]
----

Windows resources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.rc.WindowsResourceSet.html[WindowsResourceSet], which defines a set of Windows Resource source files. By default, for any named component the link:{groovyDslPath}/org.gradle.language.rc.WindowsResourceSet.html[WindowsResourceSet] contains `.rc` source files under `src/${name}/rc`.

As with other source types, you can configure the location of the windows resources that should be included in the binary.

=== Example: Configuring the location of Windows resource sources

[source.multi-language-sample,groovy,indent=0]
.build-resource-only-dll.gradle
----
include::{samplesPath}/native-binaries/windows-resources/build-resource-only-dll.gradle[tag=windows-resource-set]
----

You are able to construct a resource-only library by providing Windows Resource sources with no other language sources, and configure the linker as appropriate:

=== Example: Building a resource-only dll

[source.multi-language-sample,groovy]
.build-resource-only-dll.gradle
----
include::{samplesPath}/native-binaries/windows-resources/build-resource-only-dll.gradle[tag=resource-only-library]
----

The example above also demonstrates the mechanism of passing extra command-line arguments to the resource compiler. The `rcCompiler` extension is of type link:{javadocPath}/org/gradle/nativeplatform/PreprocessingTool.html[PreprocessingTool].

[[sec:library_dependencies]]
== Library Dependencies

Dependencies for native components are binary libraries that export header files. The header files are used during compilation, with the compiled binary dependency being used during linking and execution. Header files should be organized into subdirectories to prevent clashes of commonly named headers. For instance, if your `mylib` project has a `logging.h` header, it will make it less likely the wrong header is used if you include it as `""mylib/logging.h""` instead of `""logging.h""`.


[[sec:dependencies_within_the_same_project]]
=== Dependencies within the same project

A set of sources may depend on header files provided by another binary component within the same project. A common example is a native executable component that uses functions provided by a separate native library component.

Such a library dependency can be added to a source set associated with the `executable` component:

=== Example: Providing a library dependency to the source set

[source.multi-language-sample,groovy,indent=0]
.build.gradle
----
include::{samplesPath}/native-binaries/cpp/build.gradle[tag=source-library]
----

Alternatively, a library dependency can be provided directly to the `NativeExecutableBinarySpec` for the `executable`.

=== Example: Providing a library dependency to the binary

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/custom-layout/build.gradle[tag=binary-library]
----


[[sec:project_dependencies]]
=== Project Dependencies

For a component produced in a different Gradle project, the notation is similar.

=== Example: Declaring project dependencies

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/multi-project/build.gradle[tag=project-dependencies]
----


[[native_binaries:preCompiledHeaders]]
== Precompiled Headers

Precompiled headers are a performance optimization that reduces the cost of compiling widely used headers multiple times. This feature _precompiles_ a header such that the compiled object file can be reused when compiling each source file rather than recompiling the header each time. This support is available for C, C+\\+, Objective-C, and Objective-C++ builds.

To configure a precompiled header, first a header file needs to be defined that includes all of the headers that should be precompiled. It must be specified as the first included header in every source file where the precompiled header should be used. It is assumed that this header file, and any headers it contains, make use of header guards so that they can be included in an idempotent manner. If header guards are not used in a header file, it is possible the header could be compiled more than once and could potentially lead to a broken build.

=== Example: Creating a precompiled header file

[source.multi-language-sample,c]
.src/hello/headers/pch.h
----
include::{samplesPath}/native-binaries/pre-compiled-headers/src/hello/headers/pch.h[]
----

=== Example: Including a precompiled header file in a source file

[source.multi-language-sample,cpp]
.src/hello/cpp/hello.cpp
----
include::{samplesPath}/native-binaries/pre-compiled-headers/src/hello/cpp/hello.cpp[]
----

Precompiled headers are specified on a source set. Only one precompiled header file can be specified on a given source set and will be applied to all source files that declare it as the first include. If a source files does not include this header file as the first header, the file will be compiled in the normal manner (without making use of the precompiled header object file). The string provided should be the same as that which is used in the ""#include"" directive in the source files.

=== Example: Configuring a precompiled header

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/pre-compiled-headers/build.gradle[tag=libraries]
----

A precompiled header must be included in the same way for all files that use it. Usually, this means the header file should exist in the source set ""headers"" directory or in a directory included on the compiler include path.

[[native_binaries:variants]]
== Native Binary Variants

For each executable or library defined, Gradle is able to build a number of different native binary variants. Examples of different variants include debug vs release binaries, 32-bit vs 64-bit binaries, and binaries produced with different custom preprocessor flags.

Binaries produced by Gradle can be differentiated on <<#native_binaries:build_type,build type>>, <<#native_binaries:platform,platform>>, and <<#native_binaries:flavor,flavor>>. For each of these 'variant dimensions', it is possible to specify a set of available values as well as target each component at one, some or all of these. For example, a plugin may define a range of support platforms, but you may choose to only target Windows-x86 for a particular component.


[[native_binaries:build_type]]
=== Build types

A `build type` determines various non-functional aspects of a binary, such as whether debug information is included, or what optimisation level the binary is compiled with. Typical build types are 'debug' and 'release', but a project is free to define any set of build types.

=== Example: Defining build types

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/variants/build.gradle[tag=build-types]
----

If no build types are defined in a project, then a single, default build type called 'debug' is added.

For a build type, a Gradle project will typically define a set of compiler/linker flags per tool chain.

=== Example: Configuring debug binaries

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/variants/build.gradle[tag=build-type-config]
----

[NOTE]
====
At this stage, it is completely up to the build script to configure the relevant compiler/linker flags for each build type. Future versions of Gradle will automatically include the appropriate debug flags for any 'debug' build type, and may be aware of various levels of optimisation as well.
====


[[native_binaries:platform]]
=== Platform

An executable or library can be built to run on different operating systems and cpu architectures, with a variant being produced for each platform. Gradle defines each OS/architecture combination as a link:{groovyDslPath}/org.gradle.nativeplatform.platform.NativePlatform.html[NativePlatform], and a project may define any number of platforms. If no platforms are defined in a project, then a single, default platform 'current' is added.

[NOTE]
====
Presently, a `Platform` consists of a defined operating system and architecture. As we continue to develop the native binary support in Gradle, the concept of Platform will be extended to include things like C-runtime version, Windows SDK, ABI, etc. Sophisticated builds may use the extensibility of Gradle to apply additional attributes to each platform, which can then be queried to specify particular includes, preprocessor macros or compiler arguments for a native binary.
====

=== Example: Defining platforms

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/variants/build.gradle[tag=platforms]
----

For a given variant, Gradle will attempt to find a link:{javadocPath}/org/gradle/nativeplatform/toolchain/NativeToolChain.html[NativeToolChain] that is able to build for the target platform. Available tool chains are searched in the order defined. See the <<#native_binaries:tool_chain,tool chains>> section below for more details.

[[native_binaries:flavor]]
=== Flavor

Each component can have a set of named `flavors`, and a separate binary variant can be produced for each flavor. While the `build type` and `target platform` variant dimensions have a defined meaning in Gradle, each project is free to define any number of flavors and apply meaning to them in any way.

An example of component flavors might differentiate between 'demo', 'paid' and 'enterprise' editions of the component, where the same set of sources is used to produce binaries with different functions.

=== Example: Defining flavors

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/flavors/build.gradle[tag=flavors]
----

In the example above, a library is defined with a 'english' and 'french' flavor. When compiling the 'french' variant, a separate macro is defined which leads to a different binary being produced.

If no flavor is defined for a component, then a single default flavor named 'default' is used.

[[sec:selecting_the_build_types_platforms_and_flavors_for_a_component]]
=== Selecting the build types, platforms and flavors for a component

For a default component, Gradle will attempt to create a native binary variant for each and every combination of `buildType` and `flavor` defined for the project. It is possible to override this on a per-component basis, by specifying the set of `targetBuildTypes` and/or `targetFlavors`. By default, Gradle will build for the default platform, see <<#native_binaries:platform,above>>, unless specified explicitly on a per-component basis by specifying a set of `targetPlatforms`.

=== Example: Targeting a component at particular platforms

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/variants/build.gradle[tag=target-platforms]
----

Here you can see that the link:{groovyDslPath}/org.gradle.nativeplatform.TargetedNativeComponent.html#org.gradle.nativeplatform.TargetedNativeComponent:targetPlatform(java.lang.String)[TargetedNativeComponent.targetPlatform(java.lang.String)] method is used to specify a platform that the `NativeExecutableSpec` named `main` should be built for.

A similar mechanism exists for selecting link:{groovyDslPath}/org.gradle.nativeplatform.TargetedNativeComponent.html#org.gradle.nativeplatform.TargetedNativeComponent:targetBuildTypes(java.lang.String++[]++)[TargetedNativeComponent.targetBuildTypes(java.lang.String...)] and link:{groovyDslPath}/org.gradle.nativeplatform.TargetedNativeComponent.html#org.gradle.nativeplatform.TargetedNativeComponent:targetFlavors(java.lang.String++[]++)[TargetedNativeComponent.targetFlavors(java.lang.String...)].

[[sec:building_all_possible_variants]]
=== Building all possible variants

When a set of build types, target platforms, and flavors is defined for a component, a link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] model element is created for every possible combination of these. However, in many cases it is not possible to build a particular variant, perhaps because no tool chain is available to build for a particular platform.

If a binary variant cannot be built for any reason, then the link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] associated with that variant will not be `buildable`. It is possible to use this property to create a task to generate all possible variants on a particular machine.

=== Example: Building all possible variants

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/tool-chains/build.gradle[tag=buildable]
----


[[native_binaries:tool_chain]]
== Tool chains

A single build may utilize different tool chains to build variants for different platforms. To this end, the core 'native-binary' plugins will attempt to locate and make available supported tool chains. However, the set of tool chains for a project may also be explicitly defined, allowing additional cross-compilers to be configured as well as allowing the install directories to be specified.


[[sec:defining_tool_chains]]
=== Defining tool chains

The supported tool chain types are:

* link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.Gcc.html[Gcc]
* link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.Clang.html[Clang]
* link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.VisualCpp.html[VisualCpp]

=== Example: Defining tool chains

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/tool-chains/build.gradle[tag=toolChains]
----

Each tool chain implementation allows for a certain degree of configuration (see the API documentation for more details).

[[sec:using_tool_chains]]
=== Using tool chains

It is not necessary or possible to specify the tool chain that should be used to build. For a given variant, Gradle will attempt to locate a link:{javadocPath}/org/gradle/nativeplatform/toolchain/NativeToolChain.html[NativeToolChain] that is able to build for the target platform. Available tool chains are searched in the order defined.

[NOTE]
====
When a platform does not define an architecture or operating system, the default target of the tool chain is assumed. So if a platform does not define a value for `operatingSystem`, Gradle will find the first available tool chain that can build for the specified `architecture`.
====

The core Gradle tool chains are able to target the following architectures out of the box. In each case, the tool chain will target the current operating system. See the next section for information on cross-compiling for other operating systems.

[cols=""a,a"", options=""header""]
|===
| Tool Chain
| Architectures

| GCC
| x86, x86_64

| Clang
| x86, x86_64

| Visual C++
| x86, x86_64, ia-64
|===

So for GCC running on linux, the supported target platforms are 'linux/x86' and 'linux/x86_64'. For GCC running on Windows via Cygwin, platforms 'windows/x86' and 'windows/x86_64' are supported. (The Cygwin POSIX runtime is not yet modelled as part of the platform, but will be in the future.)

If no target platforms are defined for a project, then all binaries are built to target a default platform named 'current'. This default platform does not specify any `architecture` or `operatingSystem` value, hence using the default values of the first available tool chain.

Gradle provides a _hook_ that allows the build author to control the exact set of arguments passed to a tool chain executable. This enables the build author to work around any limitations in Gradle, or assumptions that Gradle makes. The arguments hook should be seen as a 'last-resort' mechanism, with preference given to truly modelling the underlying domain.

=== Example: Reconfigure tool arguments

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/tool-chains/build.gradle[tag=withArguments]
----


[[sec:crosscompiling_with_gcc]]
=== Cross-compiling with GCC

Cross-compiling is possible with the link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.Gcc.html[Gcc] and link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.Clang.html[Clang] tool chains, by adding support for additional target platforms. This is done by specifying a target platform for a toolchain. For each target platform a custom configuration can be specified.

=== Example: Defining target platforms

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/target-platforms/build.gradle[tag=targetplatforms]
----


[[native_binaries:visual_studio]]
== Visual Studio IDE integration

Gradle has the ability to generate Visual Studio project and solution files for the native components defined in your build. This ability is added by the `visual-studio` plugin. For a multi-project build, all projects with native components (and the root project) should have this plugin applied.

When the `visual-studio` plugin is applied to the root project, a task named `visualStudio` is created, which will generate a Visual Studio solution file containing all components in the build. This solution will include a Visual Studio project for each component, as well as configuring each component to build using Gradle.

A task named `openVisualStudio` is also created by the `visual-studio` plugin when the project is the root project. This task generates the Visual Studio solution and then opens the solution in Visual Studio. This means you can simply run `gradlew openVisualStudio` from the root project to generate and open the Visual Studio solution in one convenient step.

The content of the generated visual studio files can be modified via API hooks, provided by the `visualStudio` extension. Take a look at the 'visual-studio' sample, or see link:{groovyDslPath}/org.gradle.ide.visualstudio.VisualStudioExtension.html#org.gradle.ide.visualstudio.VisualStudioExtension:projects[VisualStudioExtension.getProjects()] and link:{groovyDslPath}/org.gradle.ide.visualstudio.VisualStudioRootExtension.html#org.gradle.ide.visualstudio.VisualStudioRootExtension:solution[VisualStudioRootExtension.getSolution()] in the API documentation for more details.

[[native_binaries:cunit]]
== CUnit support

The Gradle `cunit` plugin provides support for compiling and executing CUnit tests in your native-binary project. For each link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec] and link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec] defined in your project, Gradle will create a matching link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteSpec.html[CUnitTestSuiteSpec] component, named `${component.name}Test`.


[[sec:cunit_sources]]
=== CUnit sources

Gradle will create a link:{groovyDslPath}/org.gradle.language.c.CSourceSet.html[CSourceSet] named 'cunit' for each link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteSpec.html[CUnitTestSuiteSpec] component in the project. This source set should contain the cunit test files for the component under test. Source files can be located in the conventional location (`src/${component.name}Test/cunit`) or can be configured like any other source set.

Gradle initialises the CUnit test registry and executes the tests, utilising some generated CUnit launcher sources. Gradle will expect and call a function with the signature `void gradle_cunit_register()` that you can use to configure the actual CUnit suites and tests to execute.

=== Example: Registering CUnit tests

[source.multi-language-sample,c]
.suite_operators.c
----
include::{samplesPath}/native-binaries/cunit/src/operatorsTest/c/suite_operators.c[]
----

[NOTE]
====
Due to this mechanism, your CUnit sources may not contain a `main` method since this will clash with the method provided by Gradle.
====


[[sec:building_cunit_executables]]
=== Building CUnit executables

A link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteSpec.html[CUnitTestSuiteSpec] component has an associated link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec] or link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec] component. For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] configured for the main component, a matching link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteBinarySpec.html[CUnitTestSuiteBinarySpec] will be configured on the test suite component. These test suite binaries can be configured in a similar way to any other binary instance:

=== Example: Configuring CUnit tests

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/cunit/build.gradle[tag=configure-test-binary]
----

[NOTE]
====
Both the CUnit sources provided by your project and the generated launcher require the core CUnit headers and libraries. Presently, this library dependency must be provided by your project for each link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteBinarySpec.html[CUnitTestSuiteBinarySpec].
====


[[sec:running_cunit_tests]]
=== Running CUnit tests

For each link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteBinarySpec.html[CUnitTestSuiteBinarySpec], Gradle will create a task to execute this binary, which will run all of the registered CUnit tests. Test results will be found in the `__${build.dir}__/test-results` directory.

=== Example: Running CUnit tests

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/cunit/build.gradle[tag=complete-example]
----

.Output of `gradle -q runOperatorsTestFailingCUnitExe`
----
> gradle -q runOperatorsTestFailingCUnitExe
include::{samplesPath}/native-binaries/cunit/completeCUnitExample.out[]
----

NOTE: The code for this example can be found at **`samples/native-binaries/cunit`** in the ‘-all’ distribution of Gradle.


[NOTE]
====

The current support for CUnit is quite rudimentary. Plans for future integration include:

* Allow tests to be declared with Javadoc-style annotations.
* Improved HTML reporting, similar to that available for JUnit.
* Real-time feedback for test execution.
* Support for additional test frameworks.

====


[[native_binaries:google_test]]
== GoogleTest support

The Gradle `google-test` plugin provides support for compiling and executing GoogleTest tests in your native-binary project. For each link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec] and link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec] defined in your project, Gradle will create a matching link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteSpec.html[GoogleTestTestSuiteSpec] component, named `${component.name}Test`.


[[sec:googletest_sources]]
=== GoogleTest sources

Gradle will create a link:{groovyDslPath}/org.gradle.language.cpp.CppSourceSet.html[CppSourceSet] named 'cpp' for each link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteSpec.html[GoogleTestTestSuiteSpec] component in the project. This source set should contain the GoogleTest test files for the component under test. Source files can be located in the conventional location (`src/${component.name}Test/cpp`) or can be configured like any other source set.

[[sec:building_googletest_executables]]
=== Building GoogleTest executables

A link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteSpec.html[GoogleTestTestSuiteSpec] component has an associated link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec] or link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec] component. For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] configured for the main component, a matching link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteBinarySpec.html[GoogleTestTestSuiteBinarySpec] will be configured on the test suite component. These test suite binaries can be configured in a similar way to any other binary instance:

=== Example: Registering GoogleTest tests

[source.multi-language-sample,groovy]
.build.gradle
----
include::{samplesPath}/native-binaries/google-test/build.gradle[tag=configure-test-binary]
----

NOTE: The code for this example can be found at **`samples/native-binaries/google-test`** in the ‘-all’ distribution of Gradle.

[NOTE]
====
The GoogleTest sources provided by your project require the core GoogleTest headers and libraries. Presently, this library dependency must be provided by your project for each link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteBinarySpec.html[GoogleTestTestSuiteBinarySpec].
====


[[sec:running_googletest_tests]]
=== Running GoogleTest tests

For each link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteBinarySpec.html[GoogleTestTestSuiteBinarySpec], Gradle will create a task to execute this binary, which will run all of the registered GoogleTest tests. Test results will be found in the `__${build.dir}__/test-results` directory.
[NOTE]
====

The current support for GoogleTest is quite rudimentary. Plans for future integration include:

* Improved HTML reporting, similar to that available for JUnit.
* Real-time feedback for test execution.
* Support for additional test frameworks.

====
",12122,False,2320.837475098922,median
"[[scoreCalculation]]
= Score calculation
:doctype: book
:imagesdir: ..
:sectnums:
:toc: left
:icons: font
:experimental:


[[scoreTerminology]]
== Score terminology


[[whatIsAScore]]
=== What is a score?

Every `@PlanningSolution` class has a score.
The score is an objective way to compare two solutions.
The solution with the higher score is better.
The `Solver` aims to find the solution with the highest `Score` of all possible solutions.
The _best solution_ is the solution with the highest `Score` that `Solver` has encountered during solving,
which might be the __optimal solution__.

OptaPlanner cannot automatically know which solution is best for your business,
so you need to tell it how to calculate the score of a given `@PlanningSolution` instance according to your business needs.
If you forget or are unable to implement an important business constraint, the solution is probably useless:

image::ScoreCalculation/optimalWithIncompleteConstraints.png[align=""center""]


[[formalizeTheBusinessConstraints]]
=== Formalize the business constraints

To implement a verbal business constraint, it needs to be formalized as a score constraint.
Luckily, defining constraints in OptaPlanner is very flexible through the following score techniques:

* **Score signum (positive or negative)**: maximize or minimize a constraint type
* **Score weight**: put a cost/profit on a constraint type
* **Score level (hard, soft, ...)**: prioritize a group of constraint types
* *Pareto scoring* (rarely used)

Take the time to acquaint yourself with the first three techniques.
Once you understand them, formalizing most business constraints becomes straightforward.

[NOTE]
====
Do not presume that your business knows all its score constraints in advance.
Expect score constraints to be added, changed or removed after the first releases.
====


[[scoreConstraintSignum]]
=== Score constraint signum (positive or negative)

All score techniques are based on constraints.
A constraint can be a simple pattern (such as __Maximize the apple harvest in the solution__) or a more complex pattern.
A positive constraint is a constraint you want to maximize.
A negative constraint is a constraint you want to minimize

image::ScoreCalculation/positiveAndNegativeConstraints.png[align=""center""]

The image above illustrates that **the optimal solution always has the highest score**,
regardless if the constraints are positive or negative.

Most planning problems have only negative constraints and therefore have a negative score.
In that case, the score is the sum of the weight of the negative constraints being broken, with a perfect score of 0.
For example in n queens, the score is the negative of the number of queen pairs which can attack each other.

Negative and positive constraints can be combined, even in the same score level.

When a constraint activates (because the negative constraint is broken or the positive constraint is fulfilled)
on a certain planning entity set, it is called a __constraint match__.


[[scoreConstraintWeight]]
=== Score constraint weight

Not all score constraints are equally important.
If breaking one constraint is equally bad as breaking another constraint x times,
then those two constraints have a different weight (but they are in the same score level).
For example in vehicle routing, you can make one _unhappy driver_ constraint match count
as much as two _fuel tank usage_ constraint matches:

image::ScoreCalculation/scoreWeighting.png[align=""center""]

Score weighting is easy in use cases where you can __put a price tag on everything__.
In that case, the positive constraints maximize revenue and the negative constraints minimize expenses, so together they maximize profit.
Alternatively, score weighting is also often used to create social <<fairnessScoreConstraints,fairness>>.
For example, a nurse, who requests a free day, pays a higher weight on New Years eve than on a normal day.

The weight of a constraint match can depend on the planning entities involved.
For example in cloud balancing, the weight of the soft constraint match for an active `Computer`
is the maintenance `cost` of that `Computer` (which differs per computer).

Putting a good weight on a constraint is often a difficult analytical decision,
because it is about making choices and trade-offs against other constraints.
Different stakeholders have different priorities.
*Don't waste time with constraint weight discussions at the start of an implementation,
instead add a <<constraintConfiguration, constraint configuration>>
and  allow users to change them through a UI.*
A non-accurate weight is less damaging than mediocre algorithms:

image::ScoreCalculation/scoreTradeoffInPerspective.png[align=""center""]

Most use cases use a `Score` with `int` weights, such as <<hardSoftScore,HardSoftScore>>.


[[scoreLevel]]
=== Score constraint level (hard, soft, ...)

Sometimes a score constraint outranks another score constraint, no matter how many times the latter is broken.
In that case, those score constraints are in different levels.
For example, a nurse cannot do two shifts at the same time (due to the constraints of physical reality),
so this outranks all nurse happiness constraints.

Most use cases have only two score levels, hard and soft.
The levels of two scores are compared lexicographically.
The first score level gets compared first.
If those differ, the remaining score levels are ignored.
For example, a score that breaks `0` hard constraints and `1000000` soft constraints is better
than a score that breaks `1` hard constraint and `0` soft constraints.

image::ScoreCalculation/scoreLevels.png[align=""center""]

If there are two (or more) score levels, for example <<hardSoftScore,HardSoftScore>>,
then a score is _feasible_ if no hard constraints are broken.

[NOTE]
====
By default, OptaPlanner will always assign all planning variables a planning value.
If there is no feasible solution, this means the best solution will be infeasible.
To instead leave some of the planning entities unassigned, apply <<overconstrainedPlanning,overconstrained planning>>.
====

For each constraint, you need to pick a score level, a score weight and a score signum.
For example: `-1soft` which has score level of ``soft``, a weight of `1` and a negative signum.
Do not use a big constraint weight when your business actually wants different score levels.
That hack, known as __score folding__, is broken:

image::ScoreCalculation/scoreFoldingIsBroken.png[align=""center""]


[NOTE]
====
Your business might tell you that your hard constraints all have the same weight, because they cannot be broken (so the weight does not matter). This is not true because if no feasible solution exists for a specific dataset, the least infeasible solution allows the business to estimate how many business resources they are lacking.
For example in cloud balancing, how many new computers to buy.

Furthermore, it will likely create a <<scoreTrap,score trap>>.
For example in cloud balance if a `Computer` has seven CPU too little for its ``Process``es, then it must be weighted seven times as much as if it had only one CPU too little.
====

Three or more score levels are also supported.
For example: a company might decide that profit outranks employee satisfaction (or vice versa),
while both are outranked by the constraints of physical reality.

[NOTE]
====
To model <<fairnessScoreConstraints,fairness or load balancing>>, there is no need to use lots of score levels
(even though OptaPlanner can handle many score levels).
====

Most use cases use a `Score` with two or three weights,
such as <<hardSoftScore,HardSoftScore>> and <<hardMediumSoftScore,HardMediumSoftScore>>.


[[paretoScoring]]
=== Pareto scoring (AKA multi-objective optimization scoring)

Far less common is the use case of pareto optimization, which is also known as _multi-objective optimization_.
In pareto scoring, score constraints are in the same score level, yet they are not weighted against each other.
When two scores are compared, each of the score constraints are compared individually and the score with the most dominating score constraints wins.
Pareto scoring can even be combined with score levels and score constraint weighting.

Consider this example with positive constraints, where we want to get the most apples and oranges.
Since it is impossible to compare apples and oranges, we cannot weigh them against each other.
Yet, despite that we cannot compare them, we can state that two apples are better than one apple.
Similarly, we can state that two apples and one orange are better than just one orange.
So despite our inability to compare some Scores conclusively (at which point we declare them equal), we can find a set of optimal scores.
Those are called pareto optimal.

image::ScoreCalculation/paretoOptimizationScoring.png[align=""center""]

Scores are considered equal far more often.
It is left up to a human to choose the better out of a set of best solutions (with equal scores) found by OptaPlanner.
In the example above, the user must choose between solution A (three apples and one orange) and solution B (one apple and six oranges). It is guaranteed that OptaPlanner has not found another solution which has more apples or more oranges or even a better combination of both (such as two apples and three oranges).

To implement pareto scoring in OptaPlanner, <<customScore,implement a custom `ScoreDefinition` and `Score`>> (and replace the ``BestSolutionRecaller``). Future versions will provide out-of-the-box support.

[NOTE]
====
A pareto ``Score``'s `compareTo` method is not transitive because it does a pareto comparison.
For example: having two apples is greater than one apple.
One apple is equal to One orange.
Yet, two apples are not greater than one orange (but actually equal). Pareto comparison violates the contract of the interface ``java.lang.Comparable``'s `compareTo` method, but Planners systems are __pareto comparison safe__, unless explicitly stated otherwise in this documentation.
====


[[combiningScoreTechniques]]
=== Combining score techniques

All the score techniques mentioned above, can be combined seamlessly:

image::ScoreCalculation/scoreComposition.png[align=""center""]


[[scoreInterface]]
=== `Score` interface

A score is represented by the `Score` interface, which naturally extends ``Comparable``:

[source,java,options=""nowrap""]
----
public interface Score<...> extends Comparable<...> {
    ...
}
----

The `Score` implementation to use depends on your use case.
Your score might not efficiently fit in a single `long` value.
OptaPlanner has several built-in `Score` implementations, but you can implement a custom `Score` too.
Most use cases tend to use the built-in ``HardSoftScore``.

image::ScoreCalculation/scoreClassDiagram.png[align=""center""]

All Score implementations also have an `initScore` (which is an ``int``).It is mostly intended for internal use in OptaPlanner: it is the negative number of uninitialized planning variables.
From a user's perspective this is ``0``, unless a Construction Heuristic is terminated before it could initialize all planning variables (in which case `Score.isSolutionInitialized()` returns ``false``).

The `Score` implementation (for example ``HardSoftScore``) must be the same throughout a `Solver` runtime.
The `Score` implementation is configured in the solution domain class:

[source,java,options=""nowrap""]
----
@PlanningSolution
public class CloudBalance {
    ...

    @PlanningScore
    private HardSoftScore score;

}
----

[[avoidFloatingPointNumbersInScoreCalculation]]
=== Avoid floating point numbers in score calculation

Avoid the use of `float` or `double` in score calculation.
Use `BigDecimal` or scaled `long` instead.

Floating point numbers (``float`` and ``double``) cannot represent a decimal number correctly.
For example: a `double` cannot hold the value `0.05` correctly.
Instead, it holds the nearest representable value.
Arithmetic (including addition and subtraction) with floating point numbers, especially for planning problems, leads to incorrect decisions:

image::ScoreCalculation/scoreWeightType.png[align=""center""]

Additionally, floating point number addition is not associative:

[source,java,options=""nowrap""]
----
System.out.println( ((0.01 + 0.02) + 0.03) == (0.01 + (0.02 + 0.03)) ); // returns false
----

This leads to __score corruption__.

Decimal numbers (``BigDecimal``) have none of these problems.

[NOTE]
====
BigDecimal arithmetic is considerably slower than ``int``, `long` or `double` arithmetic.
In experiments we have seen the score calculation take five times longer.

Therefore, in many cases, it can be worthwhile to multiply _all_ numbers for a single score weight by a plural of ten, so the score weight fits in a scaled `int` or ``long``.
For example, if we multiply all weights by ``1000``, a fuelCost of `0.07` becomes a fuelCostMillis of `70` and no longer uses a decimal score weight.
====


[[scoreType]]
== Choose a score type

Depending on the number of score levels and type of score weights you need, choose a `Score` type.
Most use cases use a ``HardSoftScore``.

[NOTE]
====
To properly write a `Score` to a database (with JPA/Hibernate) or to XML/JSON (with XStream/JAXB/Jackson),
see <<integration,the integration chapter>>.
====


[[simpleScore]]
=== `SimpleScore`

A `SimpleScore` has a single `int` value, for example ``-123``.
It has a single score level.

[source,java,options=""nowrap""]
----
    @PlanningScore
    private SimpleScore score;
----

Variants of this `Score` type:

* `SimpleLongScore` uses a `long` value instead of an `int` value.
* `SimpleBigDecimalScore` uses a `BigDecimal` value instead of an `int` value.


[[hardSoftScore]]
=== `HardSoftScore` (Recommended)

A `HardSoftScore` has a hard `int` value and a soft `int` value, for example ``-123hard/-456soft``.
It has two score levels (hard and soft).

[source,java,options=""nowrap""]
----
    @PlanningScore
    private HardSoftScore score;
----

Variants of this `Score` type:

* `HardSoftLongScore` uses `long` values instead of `int` values.
* `HardSoftBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[hardMediumSoftScore]]
=== `HardMediumSoftScore`

A `HardMediumSoftScore` which has a hard `int` value, a medium `int` value and a soft `int` value, for example ``-123hard/-456medium/-789soft``.
It has three score levels (hard, medium and soft).
The hard level determines if the solution is feasible,
and the medium level and soft level score values determine
how well the solution meets business goals.
Higher medium values take precedence over soft values irrespective of the soft value.

[source,java,options=""nowrap""]
----
    @PlanningScore
    private HardMediumSoftScore score;
----

Variants of this `Score` type:

* `HardMediumSoftLongScore` uses `long` values instead of `int` values.
* `HardMediumSoftBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[bendableScore]]
=== `BendableScore`

A `BendableScore` has a configurable number of score levels.
It has an array of hard `int` values and an array of soft `int` values,
for example with two hard levels and three soft levels, the score can be ``[-123/-456]hard/[-789/-012/-345]soft``.
In that case, it has five score levels.
A solution is feasible if all hard levels are at least zero.

A BendableScore with one hard level and one soft level is equivalent to a HardSoftScore,
while a BendableScore with one hard level and two soft levels is equivalent to a HardMediumSoftScore.

[source,java,options=""nowrap""]
----
    @PlanningScore(bendableHardLevelsSize = 2, bendableSoftLevelsSize = 3)
    private BendableScore score;
----

The number of hard and soft score levels need to be set at compilation time.
It is not flexible to change during solving.

[NOTE]
====
Do not use a `BendableScore` with seven levels just because you have seven constraints.
It is extremely rare to use a different score level for each constraint, because that means one constraint match on soft 0 outweighs even a million constraint matches of soft 1.

Usually, multiple constraints share the same level and are weighted against each other.
Use <<explainingTheScore,explaining the score>> to get the weight of individual constraints in the same level.
====

Variants of this `Score` type:

* `BendableLongScore` uses `long` values instead of `int` values.
* `BendableBigDecimalScore` uses `BigDecimal` values instead of `int` values.


[[customScore]]
=== Implementing a custom score

Internally, each `Score` implementation also has a `ScoreDefinition` implementation.
For example: `SimpleScore` is defined by ``SimpleScoreDefinition``.
The `ScoreDefinition` interface defines the score representation.

To implement a custom ``Score``, also implement such a custom ``ScoreDefinition``.
Extend `AbstractScoreDefinition` (preferably by copy pasting ``HardSoftScoreDefinition``) and start from there.
Then hook your custom `ScoreDefinition` in the domain:

[source,java,options=""nowrap""]
----
    @PlanningScore(scoreDefinitionClass = MyCustomScoreDefinition.class)
    private MyCustomScore score;
----

To have it integrate seamlessly with <<jpaAndHibernatePersistingAScore,JPA/Hibernate>>,
<<integrationWithXStream,XStream>>, <<integrationWithJackson,Jackson>>, ...,
you'll need to write custom glue code too.


[[calculateTheScore]]
== Calculate the `Score`


[[scoreCalculationTypes]]
=== Score calculation types

There are several ways to calculate the `Score` of a solution:

* **<<easyJavaScoreCalculation,Easy Java score calculation>>**: Implement all constraints together in a single method in Java (or another JVM language). Does not scale.
* **<<constraintStreams,Constraint streams score calculation>>**: Implement each constraint as a separate Constraint Stream in Java (or another JVM language). Fast and scalable.
* **<<incrementalJavaScoreCalculation,Incremental Java score calculation>>** (not recommended): Implement multiple low-level methods in Java (or another JVM language). Fast and scalable. Very difficult to implement and maintain.
* **<<droolsScoreCalculation,Drools score calculation>>**: Implement each constraint as a separate score rule in DRL. Scalable.

Every score calculation type can work with any Score definition (such as ``HardSoftScore`` or ``HardMediumSoftScore``).
All score calculation types are Object Oriented and can reuse existing Java code.

[IMPORTANT]
====
The score calculation must be read-only.
It must not change the planning entities or the problem facts in any way.
For example, it must not call a setter method on a planning entity in the score calculation.

OptaPlanner does not recalculate the score of a solution if it can predict it (unless an <<environmentMode,environmentMode assertion>> is enabled).
For example, after a winning step is done, there is no need to calculate the score because that move was done and undone earlier.
As a result, there is no guarantee that changes applied during score calculation actually happen.

To update planning entities when the planning variable change, use <<shadowVariable,shadow variables>> instead.
====


[[easyJavaScoreCalculation]]
=== Easy Java score calculation

An easy way to implement your score calculation in Java.

* Advantages:
** Plain old Java: no learning curve
** Opportunity to delegate score calculation to an existing code base or legacy system
* Disadvantages:
** Slower
** Does not scale because there is no <<incrementalScoreCalculation,incremental score calculation>>

Implement the one method of the interface ``EasyScoreCalculator``:

[source,java,options=""nowrap""]
----
public interface EasyScoreCalculator<Solution_, Score_ extends Score<Score_>> {

    Score_ calculateScore(Solution_ solution);

}
----

For example in n queens:

[source,java,options=""nowrap""]
----
public class NQueensEasyScoreCalculator
    implements EasyScoreCalculator<NQueens, SimpleScore> {

    @Override
    public SimpleScore calculateScore(NQueens nQueens) {
        int n = nQueens.getN();
        List<Queen> queenList = nQueens.getQueenList();

        int score = 0;
        for (int i = 0; i < n; i++) {
            for (int j = i + 1; j < n; j++) {
                Queen leftQueen = queenList.get(i);
                Queen rightQueen = queenList.get(j);
                if (leftQueen.getRow() != null && rightQueen.getRow() != null) {
                    if (leftQueen.getRowIndex() == rightQueen.getRowIndex()) {
                        score--;
                    }
                    if (leftQueen.getAscendingDiagonalIndex() == rightQueen.getAscendingDiagonalIndex()) {
                        score--;
                    }
                    if (leftQueen.getDescendingDiagonalIndex() == rightQueen.getDescendingDiagonalIndex()) {
                        score--;
                    }
                }
            }
        }
        return SimpleScore.valueOf(score);
    }

}
----

Configure it in the solver configuration:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <easyScoreCalculatorClass>org.optaplanner.examples.nqueens.optional.score.NQueensEasyScoreCalculator</easyScoreCalculatorClass>
  </scoreDirectorFactory>
----

To configure values of an `EasyScoreCalculator` dynamically in the solver configuration
(so the <<benchmarker,Benchmarker>> can tweak those parameters),
add the `easyScoreCalculatorCustomProperties` element and use <<customPropertiesConfiguration,custom properties>>:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <easyScoreCalculatorClass>...MyEasyScoreCalculator</easyScoreCalculatorClass>
    <easyScoreCalculatorCustomProperties>
      <property name=""myCacheSize"" value=""1000"" />
    </easyScoreCalculatorCustomProperties>
  </scoreDirectorFactory>
----


[[incrementalJavaScoreCalculation]]
=== Incremental Java score calculation

A way to implement your score calculation incrementally in Java.

* Advantages:
** Very fast and scalable
*** Currently the fastest if implemented correctly
* Disadvantages:
** Hard to write
*** A scalable implementation heavily uses maps, indexes, ... (things the Drools rule engine can do for you)
*** You have to learn, design, write and improve all these performance optimizations yourself
** Hard to read
*** Regular score constraint changes can lead to a high maintenance cost

Implement all the methods of the interface `IncrementalScoreCalculator`:

[source,java,options=""nowrap""]
----
public interface IncrementalScoreCalculator<Solution_, Score_ extends Score<Score_>> {

    void resetWorkingSolution(Solution_ workingSolution);

    void beforeEntityAdded(Object entity);

    void afterEntityAdded(Object entity);

    void beforeVariableChanged(Object entity, String variableName);

    void afterVariableChanged(Object entity, String variableName);

    void beforeEntityRemoved(Object entity);

    void afterEntityRemoved(Object entity);

    Score_ calculateScore();

}
----

image::ScoreCalculation/incrementalScoreCalculatorSequenceDiagram.png[align=""center""]

For example in n queens:

[source,java,options=""nowrap""]
----
public class NQueensAdvancedIncrementalScoreCalculator
    extends IncrementalScoreCalculator<NQueens, SimpleScore> {

    private Map<Integer, List<Queen>> rowIndexMap;
    private Map<Integer, List<Queen>> ascendingDiagonalIndexMap;
    private Map<Integer, List<Queen>> descendingDiagonalIndexMap;

    private int score;

    public void resetWorkingSolution(NQueens nQueens) {
        int n = nQueens.getN();
        rowIndexMap = new HashMap<Integer, List<Queen>>(n);
        ascendingDiagonalIndexMap = new HashMap<Integer, List<Queen>>(n * 2);
        descendingDiagonalIndexMap = new HashMap<Integer, List<Queen>>(n * 2);
        for (int i = 0; i < n; i++) {
            rowIndexMap.put(i, new ArrayList<Queen>(n));
            ascendingDiagonalIndexMap.put(i, new ArrayList<Queen>(n));
            descendingDiagonalIndexMap.put(i, new ArrayList<Queen>(n));
            if (i != 0) {
                ascendingDiagonalIndexMap.put(n - 1 + i, new ArrayList<Queen>(n));
                descendingDiagonalIndexMap.put((-i), new ArrayList<Queen>(n));
            }
        }
        score = 0;
        for (Queen queen : nQueens.getQueenList()) {
            insert(queen);
        }
    }

    public void beforeEntityAdded(Object entity) {
        // Do nothing
    }

    public void afterEntityAdded(Object entity) {
        insert((Queen) entity);
    }

    public void beforeVariableChanged(Object entity, String variableName) {
        retract((Queen) entity);
    }

    public void afterVariableChanged(Object entity, String variableName) {
        insert((Queen) entity);
    }

    public void beforeEntityRemoved(Object entity) {
        retract((Queen) entity);
    }

    public void afterEntityRemoved(Object entity) {
        // Do nothing
    }

    private void insert(Queen queen) {
        Row row = queen.getRow();
        if (row != null) {
            int rowIndex = queen.getRowIndex();
            List<Queen> rowIndexList = rowIndexMap.get(rowIndex);
            score -= rowIndexList.size();
            rowIndexList.add(queen);
            List<Queen> ascendingDiagonalIndexList = ascendingDiagonalIndexMap.get(queen.getAscendingDiagonalIndex());
            score -= ascendingDiagonalIndexList.size();
            ascendingDiagonalIndexList.add(queen);
            List<Queen> descendingDiagonalIndexList = descendingDiagonalIndexMap.get(queen.getDescendingDiagonalIndex());
            score -= descendingDiagonalIndexList.size();
            descendingDiagonalIndexList.add(queen);
        }
    }

    private void retract(Queen queen) {
        Row row = queen.getRow();
        if (row != null) {
            List<Queen> rowIndexList = rowIndexMap.get(queen.getRowIndex());
            rowIndexList.remove(queen);
            score += rowIndexList.size();
            List<Queen> ascendingDiagonalIndexList = ascendingDiagonalIndexMap.get(queen.getAscendingDiagonalIndex());
            ascendingDiagonalIndexList.remove(queen);
            score += ascendingDiagonalIndexList.size();
            List<Queen> descendingDiagonalIndexList = descendingDiagonalIndexMap.get(queen.getDescendingDiagonalIndex());
            descendingDiagonalIndexList.remove(queen);
            score += descendingDiagonalIndexList.size();
        }
    }

    public SimpleScore calculateScore() {
        return SimpleScore.valueOf(score);
    }

}
----

Configure it in the solver configuration:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <incrementalScoreCalculatorClass>org.optaplanner.examples.nqueens.optional.score.NQueensAdvancedIncrementalScoreCalculator</incrementalScoreCalculatorClass>
  </scoreDirectorFactory>
----

[IMPORTANT]
====
A piece of incremental score calculator code can be difficult to write and to review.
<<invalidScoreDetection,Assert its correctness>> by using an ``EasyScoreCalculator`` to fulfill
the assertions triggered by the ``environmentMode``.
====

To configure values of an `IncrementalScoreCalculator` dynamically in the solver configuration
(so the <<benchmarker,Benchmarker>> can tweak those parameters),
add the `incrementalScoreCalculatorCustomProperties` element and use <<customPropertiesConfiguration,custom properties>>:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <incrementalScoreCalculatorClass>...MyIncrementalScoreCalculator</incrementalScoreCalculatorClass>
    <incrementalScoreCalculatorCustomProperties>
      <property name=""myCacheSize"" value=""1000""/>
    </incrementalScoreCalculatorCustomProperties>
  </scoreDirectorFactory>
----


[[constraintMatchAwareIncrementalScoreCalculator]]
==== `ConstraintMatchAwareIncrementalScoreCalculator`

Optionally, also implement the `ConstraintMatchAwareIncrementalScoreCalculator` interface to:

* Explain a score by splitting it up per score constraint with `ScoreExplanation.getConstraintMatchTotalMap()`.
* Visualize or sort planning entities by how many constraints each one breaks with `ScoreExplanation.getIndictmentMap()`.
* Receive a detailed analysis if the `IncrementalScoreCalculator` is corrupted in `FAST_ASSERT` or `FULL_ASSERT` `environmentMode`,

[source,java,options=""nowrap""]
----
public interface ConstraintMatchAwareIncrementalScoreCalculator<Solution_, Score_ extends Score<Score_>> {

    void resetWorkingSolution(Solution_ workingSolution, boolean constraintMatchEnabled);

    Collection<ConstraintMatchTotal<Score_>> getConstraintMatchTotals();

    Map<Object, Indictment<Score_>> getIndictmentMap();
}
----

For example in machine reassignment, create one `ConstraintMatchTotal` per constraint type and call `addConstraintMatch()` for each constraint match:

[source,java,options=""nowrap""]
----
public class MachineReassignmentIncrementalScoreCalculator
        implements ConstraintMatchAwareIncrementalScoreCalculator<MachineReassignment, HardSoftLongScore> {
    ...

    @Override
    public void resetWorkingSolution(MachineReassignment workingSolution, boolean constraintMatchEnabled) {
        resetWorkingSolution(workingSolution);
        // ignore constraintMatchEnabled, it is always presumed enabled
    }

    @Override
    public Collection<ConstraintMatchTotal<HardSoftLongScore>> getConstraintMatchTotals() {
        ConstraintMatchTotal<HardSoftLongScore> maximumCapacityMatchTotal = new DefaultConstraintMatchTotal<>(CONSTRAINT_PACKAGE,
            ""maximumCapacity"", HardSoftLongScore.ZERO);
        ...
        for (MrMachineScorePart machineScorePart : machineScorePartMap.values()) {
            for (MrMachineCapacityScorePart machineCapacityScorePart : machineScorePart.machineCapacityScorePartList) {
                if (machineCapacityScorePart.maximumAvailable < 0L) {
                    maximumCapacityMatchTotal.addConstraintMatch(
                            Arrays.asList(machineCapacityScorePart.machineCapacity),
                            HardSoftLongScore.valueOf(machineCapacityScorePart.maximumAvailable, 0));
                }
            }
        }
        ...
        List<ConstraintMatchTotal<HardSoftLongScore>> constraintMatchTotalList = new ArrayList<>(4);
        constraintMatchTotalList.add(maximumCapacityMatchTotal);
        ...
        return constraintMatchTotalList;
    }

    @Override
    public Map<Object, Indictment<HardSoftLongScore>> getIndictmentMap() {
        return null; // Calculate it non-incrementally from getConstraintMatchTotals()
    }
}
----

That `getConstraintMatchTotals()` code often duplicates some of the logic of the normal `IncrementalScoreCalculator` methods.
Constraint Streams and Drools Score Calculation don't have this disadvantage, because they are constraint match aware automatically when needed,
without any extra domain-specific code.


[[initializingScoreTrend]]
=== `InitializingScoreTrend`

The `InitializingScoreTrend` specifies how the Score will change as more and more variables are initialized (while the already initialized variables do not change). Some optimization algorithms (such Construction Heuristics and Exhaustive Search) run faster if they have such information.

For the Score (or each <<scoreLevel,score level>> separately), specify a trend:

* `ANY` (default): Initializing an extra variable can change the score positively or negatively. Gives no performance gain.
* `ONLY_UP` (rare): Initializing an extra variable can only change the score positively. Implies that:
** There are only positive constraints
** And initializing the next variable cannot unmatch a positive constraint that was matched by a previous initialized variable.
* ``ONLY_DOWN``: Initializing an extra variable can only change the score negatively. Implies that:
** There are only negative constraints
** And initializing the next variable cannot unmatch a negative constraint that was matched by a previous initialized variable.

Most use cases only have negative constraints.
Many of those have an `InitializingScoreTrend` that only goes down:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <constraintProviderClass>org.optaplanner.examples.cloudbalancing.score.CloudBalancingConstraintProvider</constraintProviderClass>
    <initializingScoreTrend>ONLY_DOWN</initializingScoreTrend>
  </scoreDirectorFactory>
----

Alternatively, you can also specify the trend for each score level separately:

[source,xml,options=""nowrap""]
----
  <scoreDirectorFactory>
    <constraintProviderClass>org.optaplanner.examples.cloudbalancing.score.CloudBalancingConstraintProvider</constraintProviderClass>
    <initializingScoreTrend>ONLY_DOWN/ONLY_DOWN</initializingScoreTrend>
  </scoreDirectorFactory>
----


[[invalidScoreDetection]]
=== Invalid score detection

When you put the <<environmentMode,`environmentMode`>> in `FULL_ASSERT` (or ``FAST_ASSERT``),
it will detect score corruption in the <<incrementalScoreCalculation,incremental score calculation>>.
However, that will not verify that your score calculator actually implements your score constraints as your business desires.
For example, one constraint might consistently match the wrong pattern.
To verify the constraints against an independent implementation, configure a ``assertionScoreDirectorFactory``:

[source,xml,options=""nowrap""]
----
  <environmentMode>FAST_ASSERT</environmentMode>
  ...
  <scoreDirectorFactory>
    <constraintProviderClass>org.optaplanner.examples.nqueens.optional.score.NQueensConstraintProviderorg.optaplanner.examples.nqueens.optional.score.NQueensConstraintProvider</constraintProviderClass>
    <assertionScoreDirectorFactory>
      <easyScoreCalculatorClass>org.optaplanner.examples.nqueens.optional.score.NQueensEasyScoreCalculator</easyScoreCalculatorClass>
    </assertionScoreDirectorFactory>
  </scoreDirectorFactory>
----

This way, the `NQueensConstraintProvider` implementation is validated by the ``EasyScoreCalculator``.

[NOTE]
====
This works well to isolate score corruption,
but to verify that the constraint implement the real business needs,
<<constraintStreamsTesting, a unit test with a ConstraintVerifier>> is usually better.
====


[[scoreCalculationPerformanceTricks]]
== Score calculation performance tricks


[[scoreCalculationPerformanceTricksOverview]]
=== Overview

The `Solver` will normally spend most of its execution time running the score calculation
(which is called in its deepest loops).
Faster score calculation will return the same solution in less time with the same algorithm,
which normally means a better solution in equal time.


[[scoreCalculationSpeed]]
=== Score calculation speed

After solving a problem, the `Solver` will log the __score calculation speed per second__.
This is a good measurement of Score calculation performance,
despite that it is affected by non score calculation execution time.
It depends on the problem scale of the problem dataset.
Normally, even for high scale problems, it is higher than ``1000``, except if you are using an ``EasyScoreCalculator``.

[IMPORTANT]
====
When improving your score calculation, focus on maximizing the score calculation speed, instead of maximizing the best score.
A big improvement in score calculation can sometimes yield little or no best score improvement, for example when the algorithm is stuck in a local or global optima.
If you are watching the calculation speed instead, score calculation improvements are far more visible.

Furthermore, watching the calculation speed allows you to remove or add score constraints,
and still compare it with the original's calculation speed.
Comparing the best score with the original's best score is pointless: it's comparing apples and oranges.
====


[[incrementalScoreCalculation]]
=== Incremental score calculation (with deltas)

When a solution changes, incremental score calculation (AKA delta based score calculation)
calculates the delta with the previous state to find the new ``Score``,
instead of recalculating the entire score on every solution evaluation.

For example, when a single queen A moves from row `1` to ``2``,
it will not bother to check if queen B and C can attack each other, since neither of them changed:

image::ScoreCalculation/incrementalScoreCalculationNQueens04.png[align=""center""]

Similarly in employee rostering:

image::ScoreCalculation/incrementalScoreCalculationEmployeeRostering.png[align=""center""]

This is a huge performance and scalability gain.
*<<constraintStreams,Constraint Streams>> or <<droolsScoreCalculation,Drools score calculation>> give you this huge scalability gain without forcing you to write a complicated incremental score calculation algorithm.*
Just let the rule engine do the hard work.

Notice that the speedup is relative to the size of your planning problem (your __n__), making incremental score calculation far more scalable.


[[avoidCallingRemoteServicesDuringScoreCalculation]]
=== Avoid calling remote services during score calculation

Do not call remote services in your score calculation (except if you are bridging `EasyScoreCalculator` to a legacy system). The network latency will kill your score calculation performance.
Cache the results of those remote services if possible.

If some parts of a constraint can be calculated once, when the `Solver` starts, and never change during solving,
then turn them into <<cachedProblemFact,cached problem facts>>.


[[pointlessConstraints]]
=== Pointless constraints

If you know a certain constraint can never be broken (or it is always broken), do not write a score constraint for it.
For example in n queens, the score calculation does not check if multiple queens occupy the same column,
because a ``Queen``'s `column` never changes and every solution starts with each `Queen` on a different ``column``.

[NOTE]
====
Do not go overboard with this.
If some datasets do not use a specific constraint but others do, just return out of the constraint as soon as you can.
There is no need to dynamically change your score calculation based on the dataset.
====


[[buildInHardConstraint]]
=== Built-in hard constraint

Instead of implementing a hard constraint, it can sometimes be built in.
For example, if `Lecture` A should never be assigned to `Room` X, but it uses `ValueRangeProvider` on Solution,
so the `Solver` will often try to assign it to `Room` X too (only to find out that it breaks a hard constraint).
Use <<valueRangeProviderOnPlanningEntity,a ValueRangeProvider on the planning entity>> or <<filteredSelection,filtered selection>> to define that Course A should only be assigned a `Room` different than X.

This can give a good performance gain in some use cases, not just because the score calculation is faster,
but mainly because most optimization algorithms will spend less time evaluating infeasible solutions.
However, usually this is not a good idea because there is a real risk of trading short term benefits for long term harm:

* Many optimization algorithms rely on the freedom to break hard constraints when changing planning entities,
to get out of local optima.
* Both implementation approaches have limitations (feature compatibility, disabling automatic performance optimizations),
as explained in their documentation.


[[otherScoreCalculationPerformanceTricks]]
=== Other score calculation performance tricks

* Verify that your score calculation happens in the correct `Number` type.
If you are making the sum of `int` values, do not sum it in a `double` which takes longer.
* For optimal performance, always use server mode (``java -server``).
We have seen performance increases of 50% by turning on server mode.
* For optimal performance, use the latest Java version.
For example, in the past we have seen performance increases of 30% by switching from java 1.5 to 1.6.
* Always remember that premature optimization is the root of all evil.
Make sure your design is flexible enough to allow configuration based tweaking.


[[scoreTrap]]
=== Score trap

Make sure that none of your score constraints cause a score trap.
A trapped score constraint uses the same weight for different constraint matches, when it could just as easily use a different weight.
It effectively lumps its constraint matches together, which creates a flatlined score function for that constraint.
This can cause a solution state in which several moves need to be done to resolve or lower the weight of that single constraint.
Some examples of score traps:

* You need two doctors at each table, but you are only moving one doctor at a time. So the solver has no incentive to move a doctor to a table with no doctors. Punish a table with no doctors more than a table with only one doctor in that score constraint in the score function.
* Two exams need to be conducted at the same time, but you are only moving one exam at a time. So the solver has to move one of those exams to another timeslot without moving the other in the same move. Add a coarse-grained move that moves both exams at the same time.

For example, consider this score trap.
If the blue item moves from an overloaded computer to an empty computer, the hard score should improve.
The trapped score implementation fails to do that:

image::ScoreCalculation/scoreTrap.png[align=""center""]

The Solver should eventually get out of this trap, but it will take a lot of effort (especially if there are even more processes on the overloaded computer). Before they do that, they might actually start moving more processes into that overloaded computer, as there is no penalty for doing so.

[NOTE]
====
Avoiding score traps does not mean that your score function should be smart enough to avoid local optima.
Leave it to the optimization algorithms to deal with the local optima.

Avoiding score traps means to avoid, for each score constraint individually, a flatlined score function.
====

[IMPORTANT]
====
Always specify the degree of infeasibility.
The business will often say ""if the solution is infeasible, it does not matter how infeasible it is."" While that is true for the business, it is not true for score calculation as it benefits from knowing how infeasible it is.
In practice, soft constraints usually do this naturally and it is just a matter of doing it for the hard constraints too.
====

There are several ways to deal with a score trap:

* Improve the score constraint to make a distinction in the score weight. For example, penalize `-1hard` for every missing CPU, instead of just `-1hard` if any CPU is missing.
* If changing the score constraint is not allowed from the business perspective, add a lower score level with a score constraint that makes such a distinction. For example, penalize `-1subsoft` for every missing CPU, on top of `-1hard` if any CPU is missing. The business ignores the subsoft score level.
* Add coarse-grained moves and union select them with the existing fine-grained moves. A coarse-grained move effectively does multiple moves to directly get out of a score trap with a single move. For example, move multiple items from the same container to another container.


[[stepLimitBenchmark]]
=== `stepLimit` benchmark

Not all score constraints have the same performance cost.
Sometimes one score constraint can kill the score calculation performance outright.
Use the <<benchmarker,Benchmarker>> to do a one minute run and check what happens to the score calculation speed if you comment out all but one of the score constraints.


[[fairnessScoreConstraints]]
=== Fairness score constraints

Some use cases have a business requirement to provide a fair schedule (usually as a soft score constraint), for example:

* Fairly distribute the workload amongst the employees, to avoid envy.
* Evenly distribute the workload amongst assets, to improve reliability.

Implementing such a constraint can seem difficult (especially because there are different ways to formalize fairness), but usually the _squared workload_ implementation behaves most desirable.
For each employee/asset, count the workload `w` and subtract `w²` from the score.

image::ScoreCalculation/fairnessScoreConstraint.png[align=""center""]

As shown above, the _squared workload_ implementation guarantees that if you select two employees from a given solution and make their distribution between those two employees fairer, then the resulting new solution will have a better overall score.
Do not just use the difference from the average workload, as that can lead to unfairness, as demonstrated below.

image::ScoreCalculation/fairnessScoreConstraintPitfall.png[align=""center""]


[NOTE]
====
Instead of the _squared workload_, it is also possible to use the https://en.wikipedia.org/wiki/Variance[variance]
(squared difference to the average) or the http://en.wikipedia.org/wiki/Standard_deviation[standard deviation]
(square root of the variance).
This has no effect on the score comparison, because the average will not change during planning.
It is just more work to implement (because the average needs to be known) and trivially slower (because the calculation is a bit longer).
====

When the workload is perfectly balanced, the user often likes to see a `0` score, instead of the distracting `-34soft` in the image above (for the last solution which is almost perfectly balanced).
To nullify this, either add the average multiplied by the number of entities to the score or instead show the variance or standard deviation in the UI.

[[constraintConfiguration]]
== Constraint configuration: adjust constraint weights dynamically

Deciding the correct <<scoreConstraintWeight,weight>> and <<scoreLevel,level>> for each constraint is not easy.
It often involves negotiating with different stakeholders and their priorities.
Furthermore, quantifying the impact of soft constraints is often a new experience for business managers, so they'll need a number of iterations to get it right.

Don't get stuck between a rock and a hard place.
Provide a UI to adjust the constraint weights and visualize the resulting solution, so the business managers can tweak the constraint weights themselves:

image::ScoreCalculation/parameterizeTheScoreWeights.png[align=""center""]

[[createAConstraintConfiguration]]
=== Create a constraint configuration

First, create a new class to hold the constraint weights and other constraint parameters.
Annotate it with `@ConstraintConfiguration`:

[source,java,options=""nowrap""]
----
@ConstraintConfiguration
public class ConferenceConstraintConfiguration {
    ...
}
----

There will be exactly one instance of this class per planning solution.
The planning solution and the constraint configuration have a one to one relationship,
but they serve a different purpose, so they aren't merged into a single class.
A `@ConstraintConfiguration` class can extend a parent `@ConstraintConfiguration` class,
which can be useful in international use cases with many regional constraints.

Add the constraint configuration on the planning solution
and annotate that field or property with `@ConstraintConfigurationProvider`:

[source,java,options=""nowrap""]
----
@PlanningSolution
public class ConferenceSolution {

    @ConstraintConfigurationProvider
    private ConferenceConstraintConfiguration constraintConfiguration;

    ...
}
----

The `@ConstraintConfigurationProvider` annotation automatically exposes the constraint configuration
as a <<problemFacts,problem fact>>, there is no need to add a `@ProblemFactProperty` annotation.

The constraint configuration class holds the <<constraintWeight, constraint weights>>,
but it can also hold constraint parameters.
For example in conference scheduling, the minimum pause constraint has a constraint weight (like any other constraint),
but it also has a constraint parameter that defines the length of the minimum pause between two talks of the same speaker.
That pause length depends on the conference (= the planning problem):
in some big conferences 20 minutes isn't enough to go from one room to the other.
That pause length is a field in the constraint configuration without a `@ConstraintWeight` annotation.


[[constraintWeight]]
=== Add a constraint weight for each constraint

In the constraint configuration class, add a `@ConstraintWeight` field or property for each constraint:

[source,java,options=""nowrap""]
----
@ConstraintConfiguration(constraintPackage = ""...conferencescheduling.score"")
public class ConferenceConstraintConfiguration {

    @ConstraintWeight(""Speaker conflict"")
    private HardMediumSoftScore speakerConflict = HardMediumSoftScore.ofHard(10);

    @ConstraintWeight(""Theme track conflict"")
    private HardMediumSoftScore themeTrackConflict = HardMediumSoftScore.ofSoft(10);
    @ConstraintWeight(""Content conflict"")
    private HardMediumSoftScore contentConflict = HardMediumSoftScore.ofSoft(100);

    ...
}
----

The type of the constraint weights must be the same score class as <<scoreOfASolution,the planning solution's score member>>.
For example in conference scheduling, `ConferenceSolution.getScore()` and `ConferenceConstraintConfiguration.getSpeakerConflict()`
both return a `HardMediumSoftScore`.

A constraint weight cannot be null.
Give each constraint weight a default value, but expose them in a UI so the business users can tweak them.
The example above uses the `ofHard()`, `ofMedium()` and `ofSoft()` methods to do that.
Notice how it defaults the _content conflict_ constraint as ten times more important than the _theme track conflict_ constraint.
Normally, a constraint weight only uses one score level,
but it's possible to use multiple score levels (at a small performance cost).

Each constraint has a constraint package and a constraint name, together they form the constraint id.
These connect the constraint weight with the constraint implementation.
*For each constraint weight, there must be a constraint implementation with the same package and the same name.*

* The `@ConstraintConfiguration` annotation has a `constraintPackage` property that defaults to the package of the constraint configuration class.
Most cases with <<droolsScoreCalculation,Drools score calculation>>, need to override that because the DRLs use another package.
For example, the DRL below uses the package `...conferencescheduling.score`,
so the constraint configuration above specifies a `constraintPackage`.
Cases with <<constraintStreams,Constraint streams>>, normally don't need to specify it.

* The `@ConstraintWeight` annotation has a `value` which is the constraint name (for example ""Speaker conflict"").
It inherits the constraint package from the `@ConstraintConfiguration`,
but it can override that, for example `@ConstraintWeight(constraintPackage = ""...region.france"", ...)`
to use a different constraint package than some of the other weights.

So every constraint weight ends up with a constraint package and a constraint name.
Each constraint weight links with a constraint implementation,
for example in <<droolsScoreCalculation,Drools score calculation>>:

[source,options=""nowrap""]
----
package ...conferencescheduling.solver;

rule ""Speaker conflict""
    when
        ...
    then
        scoreHolder.penalize(kcontext);
end

rule ""Theme track conflict""
    when
        ...
    then
        scoreHolder.penalize(kcontext, ...);
end

rule ""Content conflict""
    when
        ...
    then
        scoreHolder.penalize(kcontext, ...);
end
----

Each of the constraint weights defines the score level and score weight of their constraint.
The constraint implementation calls `reward()` or `penalize()` and the constraint weight is automatically applied.

If the constraint implementation provides a match weight, that *match weight is multiplied with the constraint weight*.
For example, the _content conflict_ constraint weight defaults to `100soft`
and the constraint implementation penalizes each match based on the number of shared content tags:

[source,java,options=""nowrap""]
----
    @ConstraintWeight(""Content conflict"")
    private HardMediumSoftScore contentConflict = HardMediumSoftScore.ofSoft(100);
----

[source,options=""nowrap""]
----
rule ""Content conflict""
    when
        $talk1 : Talk(...)
        $talk2 : Talk(...)
    then
        scoreHolder.penalize(kcontext,
                $talk2.overlappingContentCount($talk1));
end
----

So when 2 overlapping talks share only 1 content tag, the score is impacted by `-100soft`.
But when 2 overlapping talks share 3 content tags, the match weight is `3`, so the score is impacted by `-300soft`.

[[explainingTheScore]]
== Explaining the score: which constraints are broken?

The easiest way to explain the score during development is to print the return value of `explainScore()`, but only use that method for diagnostic purposes:

[source,java,options=""nowrap""]
----
System.out.println(scoreManager.explainScore(solution));
----

For example in conference scheduling, this prints that talk `S51` is responsible for breaking the hard constraint `Speaker required room tag`:

----
Explanation of score (-1hard/-806soft):
    Constraint match totals:
        -1hard: constraint (Speaker required room tag) has 1 matches:
            -1hard: justifications ([S51])
        -340soft: constraint (Theme track conflict) has 32 matches:
            -20soft: justifications ([S68, S66])
            -20soft: justifications ([S61, S44])
            ...
        ...
    Indictments (top 5 of 72):
        -1hard/-22soft: justification (S51) has 12 matches:
            -1hard: constraint (Speaker required room tag)
            -10soft: constraint (Theme track conflict)
            ...
        ...
----

[IMPORTANT]
====
Do not attempt to parse this string or use it in your UI or exposed services.
Instead use the ConstraintMatch API below and do it properly.
====

[[usingScoreCalculationOutsideTheSolver]]
=== Using score calculation outside the `Solver`

If other parts of your application, for example your webUI, need to calculate the score of a solution, use the `ScoreManager` API:

[source,java,options=""nowrap""]
----
ScoreManager<CloudBalance, HardSoftScore> scoreManager = ScoreManager.create(solverFactory);
ScoreExplanation<CloudBalance, HardSoftScore> scoreExplanation = scoreManager.explain(cloudBalance);
----

Then use it when you need to calculate the `Score` of a solution:

[source,java,options=""nowrap""]
----
HardSoftScore score = scoreExplanation.getScore();
----

Furthermore, the `ScoreExplanation` can help explain the score through constraint match totals and/or indictments:

image::ScoreCalculation/scoreVisualization.png[align=""center""]

[[constraintMatchTotal]]
=== Constraint match total: break down the score by constraint

To break down the score per constraint, get the ``ConstraintMatchTotal``s from the ``ScoreExplanation``:

[source,java,options=""nowrap""]
----
Collection<ConstraintMatchTotal<HardSoftScore>> constraintMatchTotals = scoreExplanation.getConstraintMatchTotalMap().values();
for (ConstraintMatchTotal<HardSoftScore> constraintMatchTotal : constraintMatchTotals) {
    String constraintName = constraintMatchTotal.getConstraintName();
    // The score impact of that constraint
    HardSoftScore totalScore = constraintMatchTotal.getScore();

    for (ConstraintMatch<HardSoftScore> constraintMatch : constraintMatchTotal.getConstraintMatchSet()) {
        List<Object> justificationList = constraintMatch.getJustificationList();
        HardSoftScore score = constraintMatch.getScore();
        ...
    }
}
----

Each `ConstraintMatchTotal` represents one constraint and has a part of the overall score.
The sum of all the `ConstraintMatchTotal.getScore()` equals the overall score.

[NOTE]
====
<<constraintStreams,Constraint streams>> and <<droolsScoreCalculation,Drools score calculation>> supports constraint matches automatically, but <<incrementalJavaScoreCalculation,incremental Java score calculation>> requires
<<constraintMatchAwareIncrementalScoreCalculator,implementing an extra interface>>.
====

[[indictmentHeatMap]]
=== Indictment heat map: visualize the hot planning entities

To show a heat map in the UI that highlights the planning entities and problem facts have an impact on the ``Score``, get the `Indictment` map from the ``ScoreExplanation``:

[source,java,options=""nowrap""]
----
Map<Object, Indictment<HardSoftScore>> indictmentMap = scoreExplanation.getIndictmentMap();
for (CloudProcess process : cloudBalance.getProcessList()) {
    Indictment<HardSoftScore> indictment = indictmentMap.get(process);
    if (indictment == null) {
        continue;
    }
    // The score impact of that planning entity
    HardSoftScore totalScore = indictment.getScore();

    for (ConstraintMatch<HardSoftScore> constraintMatch : indictment.getConstraintMatchSet()) {
        String constraintName = constraintMatch.getConstraintName();
        HardSoftScore score = constraintMatch.getScore();
        ...
    }
}
----

Each `Indictment` is the sum of all constraints where that justification object is involved with.
The sum of all the `Indictment.getScoreTotal()` differs from the overall score, because multiple ``Indictment``s can share the same `ConstraintMatch`.

[NOTE]
====
<<constraintStreams,Constraint streams>> and <<droolsScoreCalculation,Drools score calculation>> supports constraint matches automatically, but <<incrementalJavaScoreCalculation,incremental Java score calculation>> requires
<<constraintMatchAwareIncrementalScoreCalculator,implementing an extra interface>>.
====


[[testingScoreConstraints]]
== Testing score constraints

It's recommended to write a unit test for each score constraint individually to check that it behaves correctly.
Different score calculation types come with different tools for testing.
For more, see <<constraintStreamsTesting,testing Constraint Streams>> or
<<testingDroolsConstraints,testing Drools constraints>>.
",12092,False,2112.035659422586,median
"/*
 MCH DA for online BP occupancy evolution

 Contact: Laurent Aphecetche <laurent.aphecetche@subatech.in2p3.fr>
 Link: 
 Run Type: PHYSICS STANDALONE
 DA Type: MON
 Inputs files: mchbpevo.conf
 Number of events needed: all (or at least as much as possible...)
 Reference Run: 233721
 Link: 15000233721019.1104.root
 Output Files: mchbpevo.root, to be exported to the DAQ FXS
 Trigger types used: PHYSICS_EVENT
 */

/**************************************************************************
 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 *                                                                        *
 * Author: The ALICE Off-line Project.                                    *
 * Contributors are mentioned in the code where appropriate.              *
 *                                                                        *
 * Permission to use, copy, modify and distribute this software and its   *
 * documentation strictly for non-commercial purposes is hereby granted   *
 * without fee, provided that the above copyright notice appears in all   *
 * copies and that both the copyright notice and this permission notice   *
 * appear in the supporting documentation. The authors make no claims     *
 * about the suitability of this software for any purpose. It is          *
 * provided ""as is"" without express or implied warranty.                  *
 **************************************************************************/

///
/// MUON TRACKER DA to compute the evolution of the bus patches
/// hit count, which can be used to alert in case of high occupancy
///
/// In the end, this DA produces a Root file containing
/// histograms with the hit count all the buspatches (that were seen in the data flow)
/// of MCH as a function of time
/// (and the number of events seen, so we can later on compute the occupancy)
///
/// The time resolutions used are defined in the detDB configuration file mchbpevo.conf
/// if it exists or otherwise defaults to 60s
///
/// Note that, to avoid having to access the mapping (from the OCDB) of MCH, we
/// do rely on some mapping information (list of bus patch ids and their number of
/// pads) to be present in the configuration file for this DA.
/// We also provide defaults in this code in case the configuration is not properly setup.
///
/// $Id$

#include ""AliDAQ.h""
#include ""AliMergeableCollection.h""
#include ""AliMpConstants.h""
#include ""AliMUONBusPatchEvolution.h""
#include ""AliMUONRawStreamTrackerHP.h""
#include ""AliRawEventHeaderBase.h""
#include ""AliRawReaderDate.h""
#include ""daqDA.h""
#include ""event.h""
#include ""monitor.h""
#include ""Riostream.h""
#include ""signal.h""
#include ""TDatime.h""
#include ""TEnv.h""
#include ""TFile.h""
#include ""TH1.h""
#include ""TMath.h""
#include ""TObjString.h""
#include ""TPluginManager.h""
#include ""TROOT.h""
#include ""TStopwatch.h""
#include ""TString.h""
#include ""TTimeStamp.h""

const char* OUTPUT_FILE = ""mchbpevo.root"";
const char* DAVERSION = ""MCHPBEVOda v0.2 ($Id$)"";
const char* CONFIG_FILE = ""mchbpevo.conf"";
int DEFAULT_MAX_DURATION = 5*60*60; // 5 hours, in seconds
int DEFAULT_TIME_RESOLUTION = 60; // seconds
int DEFAULT_NOF_EVENTS_REQUIRED_FOR_DECISION = 10000; // ten thousand events needed before any decision can be taken
float DEFAULT_OCCUPANCY_THRESHOLD = 0.30; // by default a bus patch with more than 30% occupancy for the last 1000 is declared suspicious ;-)

//_________________________________________________________________________________________________
Int_t AssertHistogramsRange(AliMergeableCollection& hc, Int_t timeFromRef,
													  const std::vector<int>& timeResolutions,
													  const std::map<int,int>& busPatches)
{
	/// Insure the histograms in hc are big enough to accomodate timeFromRef
	/// timeFromRef can be negative or positive
	/// Return 1 if a re-allocation has been performed, 0 otherwise

	assert(timeResolutions.size()>=1);
	assert(busPatches.size()==888);

	TH1* htest = hc.Histo(Form(""/BUSPATCH/HITS/%ds/BP%04d"",timeResolutions[0],1));

	assert(htest!=0x0);

	TAxis* axis = htest->GetXaxis();

	Int_t expansionTime(0);

	if ( timeFromRef < axis->GetXmin() )
	{
		expansionTime = timeFromRef - axis->GetXmin();
	}

	if ( timeFromRef > axis->GetXmax() )
	{
		expansionTime = timeFromRef - axis->GetXmax();
	}

	if ( TMath::Abs(expansionTime) < timeResolutions[0] )
	{
		// current binning is OK. Nothing to do.
		return 0;
	}

	if ( TMath::Abs(expansionTime) > 12*3600 )
	{
		std::cout << DAVERSION << "" ERROR : Time range expansion bigger than 12 hours. Not doing it."" << std::endl;
		return 0;
	}

	Int_t currentDuration = TMath::Nint(axis->GetXmax()-axis->GetXmin());

	std::cout << Form(""%s INFO : I will expand my time range by %10d s (current duration %10d s, new one %10d s)"",
			DAVERSION,expansionTime,currentDuration,currentDuration+TMath::Abs(expansionTime))<< std::endl;

	// increase the time range by expansionTime, for all histograms

	for ( std::vector<int>::size_type itr = 0; itr < timeResolutions.size(); ++itr )
	{
		int timeReso = timeResolutions[itr];

		std::map<int,int>::const_iterator it;

		for ( it = busPatches.begin(); it != busPatches.end(); ++it )
		{
			int busPatchId = it->first;

			TString path;

			path.Form(""/BUSPATCH/HITS/%ds/BP%04d"",timeReso,busPatchId);

			TH1* h = hc.Histo(path.Data());

			assert(h!=0x0);

			TH1* hnew = AliMUONBusPatchEvolution::ExpandTimeAxis(*h,  expansionTime,  timeReso);

			hc.Remove(path.Data());

			hc.Adopt(hc.GetIdentifier(path),hnew);
		}
	}


	if  ( expansionTime < 0 )
	{
		TTimeStamp origin;

		htest = hc.Histo(Form(""/BUSPATCH/HITS/%ds/BP%04d"",timeResolutions[0],1));

		AliMUONBusPatchEvolution::GetTimeOffset(*htest,origin);

		std::cout << DAVERSION << "" INFO : New refTime = "" << origin.AsString() << std::endl;
	}

	return 1;
}

//_________________________________________________________________________________________________
void FillBusPatchesMap(std::map<int,int>& buspatches)
{
	/// Fill the map of buspatches, giving the relation between the bus patch id and
	/// the number of pads readout by this bus patch.
	///
	/// In principle (for maximum flexibility) that information should come from
	/// the configuration file. But the mapping of the detector is not a thing
	/// that is changing often, if ever, so we provide a very sensible default here.
	///
	/// Ain't pretty, but the code below can be cut and paste from the
	/// execution of the MakeConfigCodeForBPEVOda function in
	/// $ALICE_ROOT/../src/MUON/DA/MCHBPEVOdaUtils.C macro
	///
	buspatches[1236]=992;
	buspatches[1]=1272;
	buspatches[1237]=1184;
	buspatches[2]=1336;
	buspatches[3]=1528;
	buspatches[4]=1656;
	buspatches[5]=1592;
	buspatches[6]=1528;
	buspatches[7]=1528;
	buspatches[8]=1152;
	buspatches[9]=808;
	buspatches[10]=704;
	buspatches[11]=512;
	buspatches[13]=1280;
	buspatches[12]=664;
	buspatches[14]=1344;
	buspatches[15]=1536;
	buspatches[16]=1664;
	buspatches[17]=1664;
	buspatches[18]=1536;
	buspatches[19]=1536;
	buspatches[20]=1152;
	buspatches[21]=800;
	buspatches[22]=624;
	buspatches[23]=512;
	buspatches[24]=744;
	buspatches[25]=1272;
	buspatches[26]=1336;
	buspatches[27]=1528;
	buspatches[28]=1656;
	buspatches[29]=1592;
	buspatches[30]=1528;
	buspatches[31]=1528;
	buspatches[32]=1152;
	buspatches[33]=808;
	buspatches[34]=704;
	buspatches[35]=512;
	buspatches[37]=1280;
	buspatches[36]=664;
	buspatches[38]=1344;
	buspatches[39]=1536;
	buspatches[40]=1664;
	buspatches[41]=1664;
	buspatches[42]=1536;
	buspatches[43]=1536;
	buspatches[44]=1152;
	buspatches[45]=800;
	buspatches[46]=624;
	buspatches[47]=512;
	buspatches[48]=744;
	buspatches[1238]=1024;
	buspatches[1239]=576;
	buspatches[1240]=992;
	buspatches[1241]=1184;
	buspatches[1242]=512;
	buspatches[1243]=720;
	buspatches[1244]=912;
	buspatches[1245]=480;
	buspatches[1246]=608;
	buspatches[1301]=480;
	buspatches[1303]=720;
	buspatches[1302]=608;
	buspatches[1305]=576;
	buspatches[1304]=912;
	buspatches[1306]=992;
	buspatches[1307]=1184;
	buspatches[1309]=1152;
	buspatches[1308]=512;
	buspatches[1310]=992;
	buspatches[1311]=1184;
	buspatches[1313]=2176;
	buspatches[1312]=1024;
	buspatches[1314]=1264;
	buspatches[1315]=1456;
	buspatches[1317]=1664;
	buspatches[1316]=2176;
	buspatches[1318]=1184;
	buspatches[1319]=992;
	buspatches[1320]=2304;
	buspatches[1321]=832;
	buspatches[1322]=1664;
	buspatches[1323]=992;
	buspatches[1324]=1184;
	buspatches[1325]=1600;
	buspatches[1326]=1664;
	buspatches[1327]=1184;
	buspatches[1328]=992;
	buspatches[1329]=2304;
	buspatches[1331]=2176;
	buspatches[1330]=832;
	buspatches[1332]=1264;
	buspatches[1333]=1456;
	buspatches[1335]=1152;
	buspatches[1334]=2176;
	buspatches[1336]=992;
	buspatches[101]=1272;
	buspatches[1339]=576;
	buspatches[102]=1336;
	buspatches[103]=1528;
	buspatches[104]=1656;
	buspatches[105]=1592;
	buspatches[106]=1528;
	buspatches[107]=1528;
	buspatches[108]=1152;
	buspatches[109]=808;
	buspatches[110]=704;
	buspatches[111]=512;
	buspatches[113]=1280;
	buspatches[112]=664;
	buspatches[114]=1344;
	buspatches[115]=1536;
	buspatches[116]=1664;
	buspatches[117]=1664;
	buspatches[118]=1536;
	buspatches[119]=1536;
	buspatches[120]=1152;
	buspatches[121]=800;
	buspatches[122]=624;
	buspatches[123]=512;
	buspatches[124]=744;
	buspatches[125]=1272;
	buspatches[126]=1336;
	buspatches[127]=1528;
	buspatches[128]=1656;
	buspatches[129]=1592;
	buspatches[130]=1528;
	buspatches[131]=1528;
	buspatches[132]=1152;
	buspatches[133]=808;
	buspatches[134]=704;
	buspatches[135]=512;
	buspatches[137]=1280;
	buspatches[136]=664;
	buspatches[138]=1344;
	buspatches[139]=1536;
	buspatches[140]=1664;
	buspatches[141]=1664;
	buspatches[142]=1536;
	buspatches[143]=1536;
	buspatches[144]=1152;
	buspatches[145]=800;
	buspatches[146]=624;
	buspatches[147]=512;
	buspatches[148]=744;
	buspatches[1345]=480;
	buspatches[1346]=608;
	buspatches[1343]=720;
	buspatches[1344]=912;
	buspatches[1340]=992;
	buspatches[1341]=1184;
	buspatches[1342]=512;
	buspatches[1337]=1184;
	buspatches[1338]=1024;
	buspatches[1401]=480;
	buspatches[1402]=608;
	buspatches[1403]=720;
	buspatches[1404]=912;
	buspatches[1405]=576;
	buspatches[1406]=992;
	buspatches[1407]=1184;
	buspatches[1408]=512;
	buspatches[1409]=1152;
	buspatches[1410]=992;
	buspatches[1411]=1184;
	buspatches[1412]=1024;
	buspatches[1413]=2176;
	buspatches[1414]=1264;
	buspatches[1415]=1456;
	buspatches[1416]=2176;
	buspatches[1417]=1664;
	buspatches[1418]=1184;
	buspatches[1419]=992;
	buspatches[1420]=2304;
	buspatches[1421]=832;
	buspatches[1422]=1664;
	buspatches[1423]=992;
	buspatches[1424]=1184;
	buspatches[1425]=1600;
	buspatches[1426]=1664;
	buspatches[1427]=1184;
	buspatches[1428]=992;
	buspatches[1429]=2304;
	buspatches[1430]=832;
	buspatches[1431]=2176;
	buspatches[1432]=1264;
	buspatches[1433]=1456;
	buspatches[1434]=2176;
	buspatches[1435]=1152;
	buspatches[1436]=992;
	buspatches[201]=1272;
	buspatches[1437]=1184;
	buspatches[202]=1336;
	buspatches[203]=1528;
	buspatches[204]=1656;
	buspatches[205]=1592;
	buspatches[206]=1528;
	buspatches[207]=1528;
	buspatches[208]=1152;
	buspatches[209]=808;
	buspatches[210]=704;
	buspatches[211]=512;
	buspatches[213]=1280;
	buspatches[212]=664;
	buspatches[214]=1344;
	buspatches[215]=1536;
	buspatches[216]=1664;
	buspatches[217]=1664;
	buspatches[218]=1536;
	buspatches[219]=1536;
	buspatches[220]=1152;
	buspatches[221]=800;
	buspatches[222]=624;
	buspatches[223]=512;
	buspatches[224]=744;
	buspatches[225]=1272;
	buspatches[226]=1336;
	buspatches[227]=1528;
	buspatches[228]=1656;
	buspatches[229]=1592;
	buspatches[230]=1528;
	buspatches[231]=1528;
	buspatches[232]=1152;
	buspatches[233]=808;
	buspatches[234]=704;
	buspatches[235]=512;
	buspatches[237]=1280;
	buspatches[236]=664;
	buspatches[238]=1344;
	buspatches[239]=1536;
	buspatches[240]=1664;
	buspatches[241]=1664;
	buspatches[242]=1536;
	buspatches[243]=1536;
	buspatches[244]=1152;
	buspatches[245]=800;
	buspatches[246]=624;
	buspatches[247]=512;
	buspatches[248]=744;
	buspatches[1438]=1024;
	buspatches[1439]=576;
	buspatches[1440]=992;
	buspatches[1441]=1184;
	buspatches[1442]=512;
	buspatches[1443]=720;
	buspatches[1444]=912;
	buspatches[1445]=480;
	buspatches[1446]=608;
	buspatches[1501]=480;
	buspatches[1503]=720;
	buspatches[1502]=608;
	buspatches[1505]=576;
	buspatches[1504]=912;
	buspatches[1506]=992;
	buspatches[1507]=1184;
	buspatches[1509]=1152;
	buspatches[1508]=512;
	buspatches[1510]=992;
	buspatches[1511]=1184;
	buspatches[1513]=2176;
	buspatches[1512]=1024;
	buspatches[1514]=1264;
	buspatches[1515]=1456;
	buspatches[1517]=1664;
	buspatches[1516]=2176;
	buspatches[1518]=1184;
	buspatches[1519]=992;
	buspatches[1520]=2304;
	buspatches[1521]=832;
	buspatches[1522]=1664;
	buspatches[1523]=992;
	buspatches[1524]=1184;
	buspatches[1525]=1600;
	buspatches[1526]=1664;
	buspatches[1527]=1184;
	buspatches[1528]=992;
	buspatches[1529]=2304;
	buspatches[1531]=2176;
	buspatches[1530]=832;
	buspatches[1532]=1264;
	buspatches[1533]=1456;
	buspatches[1535]=1152;
	buspatches[1534]=2176;
	buspatches[1536]=992;
	buspatches[301]=1272;
	buspatches[1539]=576;
	buspatches[302]=1336;
	buspatches[303]=1528;
	buspatches[304]=1656;
	buspatches[305]=1592;
	buspatches[306]=1528;
	buspatches[307]=1528;
	buspatches[308]=1152;
	buspatches[309]=808;
	buspatches[310]=704;
	buspatches[311]=512;
	buspatches[313]=1280;
	buspatches[312]=664;
	buspatches[314]=1344;
	buspatches[315]=1536;
	buspatches[316]=1664;
	buspatches[317]=1664;
	buspatches[318]=1536;
	buspatches[319]=1536;
	buspatches[320]=1152;
	buspatches[321]=800;
	buspatches[322]=624;
	buspatches[323]=512;
	buspatches[324]=744;
	buspatches[325]=1272;
	buspatches[326]=1336;
	buspatches[327]=1528;
	buspatches[328]=1656;
	buspatches[329]=1592;
	buspatches[330]=1528;
	buspatches[331]=1528;
	buspatches[332]=1152;
	buspatches[333]=808;
	buspatches[334]=704;
	buspatches[335]=512;
	buspatches[337]=1280;
	buspatches[336]=664;
	buspatches[338]=1344;
	buspatches[339]=1536;
	buspatches[340]=1664;
	buspatches[341]=1664;
	buspatches[342]=1536;
	buspatches[343]=1536;
	buspatches[344]=1152;
	buspatches[345]=800;
	buspatches[346]=624;
	buspatches[347]=512;
	buspatches[348]=744;
	buspatches[1545]=480;
	buspatches[1546]=608;
	buspatches[1543]=720;
	buspatches[1544]=912;
	buspatches[1540]=992;
	buspatches[1541]=1184;
	buspatches[1542]=512;
	buspatches[1537]=1184;
	buspatches[1538]=1024;
	buspatches[1601]=720;
	buspatches[1602]=912;
	buspatches[1603]=304;
	buspatches[1604]=720;
	buspatches[1605]=912;
	buspatches[1606]=240;
	buspatches[1607]=1152;
	buspatches[1608]=720;
	buspatches[1609]=912;
	buspatches[1610]=1024;
	buspatches[1611]=1728;
	buspatches[1612]=720;
	buspatches[1613]=912;
	buspatches[1614]=1536;
	buspatches[1615]=2752;
	buspatches[1616]=992;
	buspatches[1617]=1184;
	buspatches[1618]=2688;
	buspatches[1619]=1664;
	buspatches[1620]=1184;
	buspatches[1621]=992;
	buspatches[1622]=2304;
	buspatches[1623]=832;
	buspatches[1624]=1664;
	buspatches[1625]=992;
	buspatches[1626]=1184;
	buspatches[1627]=1600;
	buspatches[1628]=1664;
	buspatches[1629]=1184;
	buspatches[1630]=992;
	buspatches[1631]=2304;
	buspatches[1632]=832;
	buspatches[1633]=2752;
	buspatches[1634]=992;
	buspatches[1635]=1184;
	buspatches[1636]=2688;
	buspatches[401]=1196;
	buspatches[1637]=1728;
	buspatches[402]=1260;
	buspatches[403]=1446;
	buspatches[404]=1594;
	buspatches[405]=1472;
	buspatches[406]=1404;
	buspatches[407]=1275;
	buspatches[408]=938;
	buspatches[409]=832;
	buspatches[410]=799;
	buspatches[411]=1145;
	buspatches[413]=1200;
	buspatches[412]=625;
	buspatches[414]=1264;
	buspatches[415]=1450;
	buspatches[416]=1594;
	buspatches[417]=1472;
	buspatches[418]=1408;
	buspatches[419]=1265;
	buspatches[420]=935;
	buspatches[421]=832;
	buspatches[422]=736;
	buspatches[423]=1247;
	buspatches[424]=544;
	buspatches[425]=1196;
	buspatches[426]=1260;
	buspatches[427]=1446;
	buspatches[428]=1594;
	buspatches[429]=1472;
	buspatches[430]=1404;
	buspatches[431]=1275;
	buspatches[432]=938;
	buspatches[433]=832;
	buspatches[434]=799;
	buspatches[435]=1145;
	buspatches[437]=1200;
	buspatches[436]=625;
	buspatches[438]=1264;
	buspatches[439]=1450;
	buspatches[440]=1594;
	buspatches[441]=1472;
	buspatches[442]=1408;
	buspatches[443]=1265;
	buspatches[444]=935;
	buspatches[445]=832;
	buspatches[446]=736;
	buspatches[447]=1247;
	buspatches[448]=544;
	buspatches[1638]=720;
	buspatches[1639]=912;
	buspatches[1640]=1536;
	buspatches[1641]=1152;
	buspatches[1642]=720;
	buspatches[1643]=912;
	buspatches[1644]=1024;
	buspatches[1645]=304;
	buspatches[1646]=720;
	buspatches[1647]=912;
	buspatches[1648]=240;
	buspatches[1649]=720;
	buspatches[1650]=912;
	buspatches[1701]=720;
	buspatches[1703]=304;
	buspatches[1702]=912;
	buspatches[1704]=720;
	buspatches[1705]=912;
	buspatches[1707]=1152;
	buspatches[1706]=240;
	buspatches[1708]=720;
	buspatches[1709]=912;
	buspatches[1711]=1728;
	buspatches[1710]=1024;
	buspatches[1712]=720;
	buspatches[1713]=912;
	buspatches[1715]=2752;
	buspatches[1714]=1536;
	buspatches[1716]=992;
	buspatches[1717]=1184;
	buspatches[1719]=1664;
	buspatches[1718]=2688;
	buspatches[1720]=1184;
	buspatches[1721]=992;
	buspatches[1722]=2304;
	buspatches[1723]=832;
	buspatches[1724]=1664;
	buspatches[1725]=992;
	buspatches[1726]=1184;
	buspatches[1727]=1600;
	buspatches[1728]=1664;
	buspatches[1729]=1184;
	buspatches[1730]=992;
	buspatches[1731]=2304;
	buspatches[1733]=2752;
	buspatches[1732]=832;
	buspatches[1734]=992;
	buspatches[1735]=1184;
	buspatches[1737]=1728;
	buspatches[501]=1196;
	buspatches[1738]=720;
	buspatches[502]=1260;
	buspatches[503]=1446;
	buspatches[504]=1594;
	buspatches[505]=1472;
	buspatches[506]=1404;
	buspatches[507]=1275;
	buspatches[508]=938;
	buspatches[509]=832;
	buspatches[510]=799;
	buspatches[511]=1145;
	buspatches[513]=1200;
	buspatches[512]=625;
	buspatches[514]=1264;
	buspatches[515]=1450;
	buspatches[516]=1594;
	buspatches[517]=1472;
	buspatches[518]=1408;
	buspatches[519]=1265;
	buspatches[520]=935;
	buspatches[521]=832;
	buspatches[522]=736;
	buspatches[523]=1247;
	buspatches[524]=544;
	buspatches[525]=1196;
	buspatches[526]=1260;
	buspatches[527]=1446;
	buspatches[528]=1594;
	buspatches[529]=1472;
	buspatches[530]=1404;
	buspatches[531]=1275;
	buspatches[532]=938;
	buspatches[533]=832;
	buspatches[534]=799;
	buspatches[535]=1145;
	buspatches[537]=1200;
	buspatches[536]=625;
	buspatches[538]=1264;
	buspatches[539]=1450;
	buspatches[540]=1594;
	buspatches[541]=1472;
	buspatches[542]=1408;
	buspatches[543]=1265;
	buspatches[544]=935;
	buspatches[545]=832;
	buspatches[546]=736;
	buspatches[547]=1247;
	buspatches[548]=544;
	buspatches[1749]=720;
	buspatches[1750]=912;
	buspatches[1745]=304;
	buspatches[1746]=720;
	buspatches[1747]=912;
	buspatches[1748]=240;
	buspatches[1741]=1152;
	buspatches[1742]=720;
	buspatches[1743]=912;
	buspatches[1744]=1024;
	buspatches[1739]=912;
	buspatches[1740]=1536;
	buspatches[1736]=2688;
	buspatches[1801]=720;
	buspatches[1802]=912;
	buspatches[1803]=304;
	buspatches[1804]=720;
	buspatches[1805]=912;
	buspatches[1806]=240;
	buspatches[1807]=1152;
	buspatches[1808]=720;
	buspatches[1809]=912;
	buspatches[1810]=1024;
	buspatches[1811]=1728;
	buspatches[1812]=720;
	buspatches[1813]=912;
	buspatches[1814]=1536;
	buspatches[1815]=2752;
	buspatches[1816]=992;
	buspatches[1817]=1184;
	buspatches[1818]=2688;
	buspatches[1819]=1664;
	buspatches[1820]=1184;
	buspatches[1821]=992;
	buspatches[1822]=2304;
	buspatches[1823]=832;
	buspatches[1824]=1664;
	buspatches[1825]=992;
	buspatches[1826]=1184;
	buspatches[1827]=1600;
	buspatches[1828]=1664;
	buspatches[1829]=1184;
	buspatches[1830]=992;
	buspatches[1831]=2304;
	buspatches[1832]=832;
	buspatches[1833]=2752;
	buspatches[1834]=992;
	buspatches[1835]=1184;
	buspatches[1836]=2688;
	buspatches[601]=1196;
	buspatches[1837]=1728;
	buspatches[602]=1260;
	buspatches[603]=1446;
	buspatches[604]=1594;
	buspatches[605]=1472;
	buspatches[606]=1404;
	buspatches[607]=1275;
	buspatches[608]=938;
	buspatches[609]=832;
	buspatches[610]=799;
	buspatches[611]=1145;
	buspatches[613]=1200;
	buspatches[612]=625;
	buspatches[614]=1264;
	buspatches[615]=1450;
	buspatches[616]=1594;
	buspatches[617]=1472;
	buspatches[618]=1408;
	buspatches[619]=1265;
	buspatches[620]=935;
	buspatches[621]=832;
	buspatches[622]=736;
	buspatches[623]=1247;
	buspatches[624]=544;
	buspatches[625]=1196;
	buspatches[626]=1260;
	buspatches[627]=1446;
	buspatches[628]=1594;
	buspatches[629]=1472;
	buspatches[630]=1404;
	buspatches[631]=1275;
	buspatches[632]=938;
	buspatches[633]=832;
	buspatches[634]=799;
	buspatches[635]=1145;
	buspatches[637]=1200;
	buspatches[636]=625;
	buspatches[638]=1264;
	buspatches[639]=1450;
	buspatches[640]=1594;
	buspatches[641]=1472;
	buspatches[642]=1408;
	buspatches[643]=1265;
	buspatches[644]=935;
	buspatches[645]=832;
	buspatches[646]=736;
	buspatches[647]=1247;
	buspatches[648]=544;
	buspatches[1838]=720;
	buspatches[1839]=912;
	buspatches[1840]=1536;
	buspatches[1841]=1152;
	buspatches[1842]=720;
	buspatches[1843]=912;
	buspatches[1844]=1024;
	buspatches[1845]=304;
	buspatches[1846]=720;
	buspatches[1847]=912;
	buspatches[1848]=240;
	buspatches[1849]=720;
	buspatches[1850]=912;
	buspatches[1901]=720;
	buspatches[1903]=304;
	buspatches[1902]=912;
	buspatches[1904]=720;
	buspatches[1905]=912;
	buspatches[1907]=1152;
	buspatches[1906]=240;
	buspatches[1908]=720;
	buspatches[1909]=912;
	buspatches[1911]=1728;
	buspatches[1910]=1024;
	buspatches[1912]=720;
	buspatches[1913]=912;
	buspatches[1915]=2752;
	buspatches[1914]=1536;
	buspatches[1916]=992;
	buspatches[1917]=1184;
	buspatches[1919]=1664;
	buspatches[1918]=2688;
	buspatches[1920]=1184;
	buspatches[1921]=992;
	buspatches[1922]=2304;
	buspatches[1923]=832;
	buspatches[1924]=1664;
	buspatches[1925]=992;
	buspatches[1926]=1184;
	buspatches[1927]=1600;
	buspatches[1928]=1664;
	buspatches[1929]=1184;
	buspatches[1930]=992;
	buspatches[1931]=2304;
	buspatches[1933]=2752;
	buspatches[1932]=832;
	buspatches[1934]=992;
	buspatches[1935]=1184;
	buspatches[1937]=1728;
	buspatches[701]=1196;
	buspatches[1938]=720;
	buspatches[702]=1260;
	buspatches[703]=1446;
	buspatches[704]=1594;
	buspatches[705]=1472;
	buspatches[706]=1404;
	buspatches[707]=1275;
	buspatches[708]=938;
	buspatches[709]=832;
	buspatches[710]=799;
	buspatches[711]=1145;
	buspatches[713]=1200;
	buspatches[712]=625;
	buspatches[714]=1264;
	buspatches[715]=1450;
	buspatches[716]=1594;
	buspatches[717]=1472;
	buspatches[718]=1408;
	buspatches[719]=1265;
	buspatches[720]=935;
	buspatches[721]=832;
	buspatches[722]=736;
	buspatches[723]=1247;
	buspatches[724]=544;
	buspatches[725]=1196;
	buspatches[726]=1260;
	buspatches[727]=1446;
	buspatches[728]=1594;
	buspatches[729]=1472;
	buspatches[730]=1404;
	buspatches[731]=1275;
	buspatches[732]=938;
	buspatches[733]=832;
	buspatches[734]=799;
	buspatches[735]=1145;
	buspatches[737]=1200;
	buspatches[736]=625;
	buspatches[738]=1264;
	buspatches[739]=1450;
	buspatches[740]=1594;
	buspatches[741]=1472;
	buspatches[742]=1408;
	buspatches[743]=1265;
	buspatches[744]=935;
	buspatches[745]=832;
	buspatches[746]=736;
	buspatches[747]=1247;
	buspatches[748]=544;
	buspatches[1949]=720;
	buspatches[1950]=912;
	buspatches[1945]=304;
	buspatches[1946]=720;
	buspatches[1947]=912;
	buspatches[1948]=240;
	buspatches[1941]=1152;
	buspatches[1942]=720;
	buspatches[1943]=912;
	buspatches[1944]=1024;
	buspatches[1939]=912;
	buspatches[1940]=1536;
	buspatches[1936]=2688;
	buspatches[801]=1024;
	buspatches[802]=1152;
	buspatches[803]=1536;
	buspatches[804]=1728;
	buspatches[805]=1088;
	buspatches[806]=1472;
	buspatches[807]=1648;
	buspatches[808]=1088;
	buspatches[809]=448;
	buspatches[810]=2160;
	buspatches[811]=2048;
	buspatches[812]=576;
	buspatches[813]=832;
	buspatches[814]=1408;
	buspatches[815]=960;
	buspatches[816]=1072;
	buspatches[817]=1536;
	buspatches[818]=1024;
	buspatches[819]=1152;
	buspatches[820]=1536;
	buspatches[821]=1728;
	buspatches[822]=1088;
	buspatches[823]=1536;
	buspatches[824]=1728;
	buspatches[825]=1088;
	buspatches[826]=448;
	buspatches[827]=2240;
	buspatches[828]=2112;
	buspatches[829]=576;
	buspatches[830]=832;
	buspatches[901]=1024;
	buspatches[903]=1536;
	buspatches[902]=1152;
	buspatches[905]=1088;
	buspatches[904]=1728;
	buspatches[906]=1472;
	buspatches[907]=1648;
	buspatches[909]=448;
	buspatches[908]=1088;
	buspatches[910]=2160;
	buspatches[911]=2048;
	buspatches[912]=576;
	buspatches[913]=832;
	buspatches[914]=1024;
	buspatches[915]=1152;
	buspatches[916]=1536;
	buspatches[917]=1728;
	buspatches[918]=1088;
	buspatches[919]=1536;
	buspatches[920]=1728;
	buspatches[921]=1088;
	buspatches[922]=448;
	buspatches[923]=2240;
	buspatches[924]=2112;
	buspatches[925]=576;
	buspatches[927]=1408;
	buspatches[926]=832;
	buspatches[928]=1024;
	buspatches[929]=1152;
	buspatches[930]=1536;
	buspatches[1001]=448;
	buspatches[1002]=2160;
	buspatches[1003]=2048;
	buspatches[1004]=576;
	buspatches[1005]=832;
	buspatches[1006]=1088;
	buspatches[1007]=1472;
	buspatches[1008]=1648;
	buspatches[1009]=1088;
	buspatches[1010]=1536;
	buspatches[1011]=1728;
	buspatches[1012]=1024;
	buspatches[1013]=1152;
	buspatches[1014]=1408;
	buspatches[1015]=1024;
	buspatches[1016]=1152;
	buspatches[1017]=1536;
	buspatches[1018]=448;
	buspatches[1019]=2240;
	buspatches[1020]=2112;
	buspatches[1021]=576;
	buspatches[1022]=832;
	buspatches[1023]=1088;
	buspatches[1024]=1536;
	buspatches[1025]=1728;
	buspatches[1026]=1088;
	buspatches[1027]=1536;
	buspatches[1028]=1728;
	buspatches[1029]=1024;
	buspatches[1030]=1152;
	buspatches[1101]=1408;
	buspatches[1102]=960;
	buspatches[1103]=1072;
	buspatches[1104]=1536;
	buspatches[1105]=448;
	buspatches[1106]=2160;
	buspatches[1107]=2048;
	buspatches[1108]=576;
	buspatches[1109]=832;
	buspatches[1110]=1088;
	buspatches[1111]=1472;
	buspatches[1112]=1648;
	buspatches[1113]=1088;
	buspatches[1114]=1536;
	buspatches[1115]=1728;
	buspatches[1116]=1024;
	buspatches[1117]=1152;
	buspatches[1118]=448;
	buspatches[1119]=2240;
	buspatches[1120]=2112;
	buspatches[1121]=576;
	buspatches[1123]=1088;
	buspatches[1122]=832;
	buspatches[1124]=1536;
	buspatches[1125]=1728;
	buspatches[1127]=1536;
	buspatches[1126]=1088;
	buspatches[1129]=1024;
	buspatches[1128]=1728;
	buspatches[1130]=1152;
	buspatches[1201]=480;
	buspatches[1202]=608;
	buspatches[1203]=720;
	buspatches[1204]=912;
	buspatches[1205]=576;
	buspatches[1206]=992;
	buspatches[1207]=1184;
	buspatches[1208]=512;
	buspatches[1209]=1152;
	buspatches[1210]=992;
	buspatches[1211]=1184;
	buspatches[1212]=1024;
	buspatches[1213]=2176;
	buspatches[1214]=1264;
	buspatches[1215]=1456;
	buspatches[1216]=2176;
	buspatches[1217]=1664;
	buspatches[1218]=1184;
	buspatches[1219]=992;
	buspatches[1220]=2304;
	buspatches[1221]=832;
	buspatches[1222]=1664;
	buspatches[1223]=992;
	buspatches[1224]=1184;
	buspatches[1225]=1600;
	buspatches[1226]=1664;
	buspatches[1227]=1184;
	buspatches[1228]=992;
	buspatches[1229]=2304;
	buspatches[1230]=832;
	buspatches[1231]=2176;
	buspatches[1232]=1264;
	buspatches[1233]=1456;
	buspatches[1234]=2176;
	buspatches[1235]=1152;
}

//_________________________________________________________________________________________________
void FillCollection(AliMergeableCollection& hc, UInt_t timeOrigin, int maxDuration, int timeResolution, const std::map<int,int>& buspatches)
{
	/// Create the BusPatch and Event histograms
	///

	assert(buspatches.size()==888);

	TTimeStamp origin(static_cast<time_t>(timeOrigin),0);

	std::cout << DAVERSION << "" INFO : Using refTime = "" << origin.AsString() << std::endl;

	Double_t xmin =  0;
	Double_t xmax = xmin + maxDuration*1.0;

	int nbins = TMath::Nint((xmax-xmin)/timeResolution);

	// basis for all plot = per buspatch

	std::map<int,int>::const_iterator it;

	for ( it = buspatches.begin(); it != buspatches.end(); ++it)
	{
		int busPatchId = it->first;
		int nofPads = it->second;

		TH1* h = new TH1F(Form(""BP%04d"",busPatchId),Form(""Number of hits in %d s bins"",timeResolution),nbins,xmin,xmax);

		h->GetXaxis()->SetTimeDisplay(1);
		h->GetXaxis()->SetTimeFormat(""%d/%m/%y %H:%M"");
		h->GetXaxis()->SetTimeOffset(timeOrigin,""gmt"");
		hc.Adopt(Form(""/BUSPATCH/HITS/%ds"",timeResolution),h);
	}

	// number of events needed for normalization

	TH1* h = new TH1F(Form(""Nevents%ds"",timeResolution),Form(""Number of events %d s bins"",timeResolution),nbins,xmin,xmax);

	h->GetXaxis()->SetTimeDisplay(1);
	h->GetXaxis()->SetTimeFormat(""%d/%m/%y %H:%M"");
	h->GetXaxis()->SetTimeOffset(timeOrigin,""gmt"");

	hc.Adopt("""",h);
}

//______________________________________________________________________________
void ReportFaultyBusPatches(AliMergeableCollection& hc,
		const std::map<int,int>& buspatches,
		int timeResolution,
		int requiredEvents,
		float occupancyThreshold)
{
	/// Loop over all bus patches and compute their occupancy in the last nevents

	// find how many bins should be considered, by finding in the Nevents histogram
	// how many of the latest bins are required to get an integral >= requiredEvents

	AliMUONBusPatchEvolution bpevo(hc,buspatches);

	std::map<int,double> faultyBP;

	Bool_t ok = bpevo.GetFaultyBusPatches(timeResolution,requiredEvents,occupancyThreshold,faultyBP);

	if (!ok) return;

	std::map<int,double>::const_iterator it;

	if ( faultyBP.empty() ) return;

	std::cout << Form(""%s WARNING : %3d bus patches above occupancy threshold (of %7.2f %%) : "",DAVERSION,(int)faultyBP.size(),occupancyThreshold*100.0);

	for ( it = faultyBP.begin(); it != faultyBP.end(); ++it )
	{
		int busPatchId = it->first;
		std::cout << Form(""%4d "",busPatchId);
	}

	std::cout << std::endl;
	std::cout << Form(""%s INFO : Faulty bus patches occupancies : "",DAVERSION);


	for ( it = faultyBP.begin(); it != faultyBP.end(); ++it )
	{
		int busPatchId = it->first;
		double busPatchOccupancy = it->second;
		std::cout << Form(""%4d (%7.2f %%) "",busPatchId,busPatchOccupancy*100.0);
	}

	std::cout << std::endl;
}

//______________________________________________________________________________
int main(int argc, char **argv) 
{
	/// Main method.

	signal(SIGSEGV,SIG_DFL); // to be able to get core dumps...

	TStopwatch timers;
	timers.Start(kTRUE);

	ios::sync_with_stdio();

	std::cout << ""Running "" << DAVERSION << std::endl;

	if ( argc != 2 )
	{
		std::cout << ""Wrong number of arguments"" << std::endl;
		std::cout << ""Usage : "" << argv[0] << "" datasource"" << std::endl;
		return -1;
	}

	TString dataSource=argv[1];

	UInt_t refTime = 0;
	TString outputFileName = OUTPUT_FILE;

	// needed for streamer application
	gROOT->GetPluginManager()->AddHandler(""TVirtualStreamerInfo"",
			""*"",
			""TStreamerInfo"",
			""RIO"",
			""TStreamerInfo()"");

	Int_t numberOfEvents(0);
	Int_t numberOfPhysicsEvent(0);
	Int_t numberOfBadEvents(0);
	Int_t numberOfUsedEvents(0);
	Int_t numberOfIncompleteEvents(0);
	Int_t numberOfFlushedEvents(0);
	Int_t numberOfEventsWithMCH(0);
	Int_t numberOfEventsSinceLastDecision(0);

	UInt_t runNumber(0);

	std::vector<int> timeResolutions;
	std::map<int,int> busPatches;
	int maxDuration;
	int nofEventsRequiredForDecision;
	float occupancyThreshold;

	int status=daqDA_DB_getFile(CONFIG_FILE,CONFIG_FILE);

	if (status)
	{
		std::cout << DAVERSION << "" WARNING: Could not get configuration file "" << CONFIG_FILE
				<< "" from DAQ detector database. Will use (hopefully sensible) defaults"" << std::endl;

		timeResolutions.push_back(DEFAULT_TIME_RESOLUTION);
		maxDuration = DEFAULT_MAX_DURATION;
		nofEventsRequiredForDecision = DEFAULT_NOF_EVENTS_REQUIRED_FOR_DECISION;
		occupancyThreshold = DEFAULT_OCCUPANCY_THRESHOLD;
		FillBusPatchesMap(busPatches);
	}
	else
	{
		TEnv env(CONFIG_FILE);

		occupancyThreshold = env.GetValue(""occupancyThreshold"",DEFAULT_OCCUPANCY_THRESHOLD);
		nofEventsRequiredForDecision = env.GetValue(""nofEventsRequiredForDecision"",DEFAULT_NOF_EVENTS_REQUIRED_FOR_DECISION);

		TString tr = env.GetValue(""timeResolutions"","""");
		TObjArray* a = tr.Tokenize("" "");
		TObjString* s;
		TIter next(a);
		while ( ( s = static_cast<TObjString*>(next())))
		{
			if (s->String().Atoi())
			{
				timeResolutions.push_back(s->String().Atoi());
			}
		}
		delete a;

		if ( timeResolutions.size() == 0 )
		{
			std::cout << DAVERSION << "" WARNING : Configuration file "" << CONFIG_FILE << "" contains an incorrect timeResolutions setting. ""
					<< "" Using default of "" << DEFAULT_TIME_RESOLUTION << "" s instead""
					<< std::endl;
			timeResolutions.push_back(DEFAULT_TIME_RESOLUTION);
		}

		maxDuration = env.GetValue(""maxDuration"",DEFAULT_MAX_DURATION);

		TString sbp = env.GetValue(""bp"","""");

		TObjArray* b = sbp.Tokenize("" "");
		TIter nextBP(b);

		int total(0);

		while ( ( s = static_cast<TObjString*>(nextBP())))
		{
			TString bpinfo = s->String();
			int ix = bpinfo.Index(':');
			if (ix<=0) continue;
			int bpid = TString(bpinfo(0,ix)).Atoi();
			int npads = TString(bpinfo(ix+1,bpinfo.Length()-ix)).Atoi();
			total += npads;
			busPatches[bpid]=npads;
		}

		delete b;

		if (busPatches.size() != 888)
		{
			std::cout << DAVERSION << "" ERROR : Configuration file is incorrect : wrong number of bus patches : ""
					<< "" got "" << busPatches.size() << "" but expected 888. Cannot work like that."" << std::endl;
			return -3;
		}

		if (busPatches.size() > 0 && total != 1064008)
		{
			std::cout << DAVERSION << "" ERROR : Configuration file is incorrect : wrong total number of pads ! Got "" << total
					<< "" but expected 1064008. Cannot work like that."" << std::endl;
			return -2;
		}

		if ( busPatches.size() == 0 )
		{
			std::cout << DAVERSION << "" WARNING : Configuration file "" << CONFIG_FILE << "" does not contain the list of buspath ids (and their ""
					"" corresponding number of pads). Using default values instead""
					<< std::endl;
			FillBusPatchesMap(busPatches);
		}
	}

	/// We sort the time resolutions so the finer one will be used in AssertHistogramsRange
	std::sort(timeResolutions.begin(),timeResolutions.end());

	AliMergeableCollection* hc(0x0);

	AliRawReaderDate* rawReader(0x0);

	// define data source :
	status=monitorSetDataSource(dataSource.Data());
	if (status!=0)
	{
		std::cout << DAVERSION << "" ERROR : monitorSetDataSource() failed: "" << monitorDecodeError(status) << endl;
		return -1;
	}

	// Declare monitoring program
	status=monitorDeclareMp(""MUON_TRK_BPEVO"");
	if (status!=0)
	{
		std::cout << DAVERSION << "" ERROR : monitorDeclareMp() failed: "" << monitorDecodeError(status) << endl;
		return -1;
	}

	// Define wait event timeout - 1s max
	monitorSetNowait();
	monitorSetNoWaitNetworkTimeout(1000);

	int nofRealloc(0);

	for(;;)
	{
		struct eventHeaderStruct *event(0x0);
		eventTypeType eventT;

		status=monitorGetEventDynamic((void **)&event);
		if (status!=0)
		{
			std::cout << DAVERSION << "" ERROR : "" << monitorDecodeError(status) << std::endl;
			delete event;
			break;
		}

		/* check shutdown condition */
		if (daqDA_checkShutdown())
		{
			std::cout << DAVERSION << "" WARNING : I am requested to stop, so I will stop..."" << std::endl;
			delete event;
			break;
		}

		/* retry if got no event */
		if (event==NULL) continue;

		++numberOfEvents;

		eventT=event->eventType;

		if ((eventT == END_OF_RUN)||(eventT == END_OF_RUN_FILES))
		{
			delete event;
			break;
		}

		if (eventT != PHYSICS_EVENT)
		{
			delete event;
			continue;
		}

		if( TEST_SYSTEM_ATTRIBUTE(event->eventTypeAttribute, ATTR_INCOMPLETE_EVENT))
		{
			delete event;
			++numberOfIncompleteEvents;
			continue;
		}

		if( TEST_SYSTEM_ATTRIBUTE(event->eventTypeAttribute, ATTR_FLUSHED_EVENT))
		{
			delete event;
			++numberOfFlushedEvents;
			continue;
		}

		++numberOfPhysicsEvent;

		rawReader = new AliRawReaderDate((void*)event);

		if ( rawReader->GetRunNumber() != runNumber )
		{
			if ( runNumber != 0 )
			{
				std::cout << DAVERSION << "" ERROR : Uh oh. That's bad... Changing of run number ???"" << std::endl;
				delete event;
				delete rawReader;
				return -9999;
			}

			runNumber = rawReader->GetRunNumber();
		}

		// *without* using the MUONTRK event decoder, we update the number
		// of events where we have information about MUONTRK.
		// this should be what is called subevents in the logbook
		// we do *not* use the MCH decoder on purpose, to not mistakenly
		// believe there's no event if the data is corrupted (and thus the decoder
		// ""sees"" nothing).

		Bool_t mchThere(kFALSE);

		for ( int iDDL = 0; iDDL < AliDAQ::NumberOfDdls(""MUONTRK"") && !mchThere; ++iDDL )
		{
			rawReader->Reset();
			rawReader->Select(""MUONTRK"",iDDL,iDDL);
			if (rawReader->ReadHeader() )
			{
				if (rawReader->GetEquipmentSize() ) mchThere = kTRUE;
			}
		}

		if ( mchThere )
		{
			++numberOfEventsWithMCH;
		}
		else
		{
			delete event;
			delete rawReader;
			continue;
		}

		rawReader->Reset();

		// now do our real work with the MCH decoder

		AliMUONRawStreamTrackerHP stream(rawReader);

		stream.DisableWarnings();
		stream.First();

		Int_t buspatchId;
		UShort_t  manuId;
		UChar_t manuChannel;
		UShort_t adc;

		std::map<int,int> bpValues;

		while ( stream.Next(buspatchId,manuId,manuChannel,adc,kTRUE) )
		{
			bpValues[buspatchId]++;
		}

		if ( bpValues.empty() )
		{
			static int emptyevent(0);

			emptyevent++;

			std::cout << DAVERSION << "" WARNING : Empty event"" << emptyevent << std::endl;
		}

		Bool_t badEvent = stream.HasPaddingError() || stream.HasGlitchError();

		if ( !badEvent )
		{
			if (!hc)
			{
				hc = new AliMergeableCollection(""bpevo"");

				assert(refTime==0);

				refTime = rawReader->GetTimestamp();

				for ( std::vector<int>::size_type is = 0; is < timeResolutions.size(); ++is )
				{
					FillCollection(*hc, refTime,maxDuration,timeResolutions[is],busPatches);
				}
			}
			else
			{
				assert(refTime>0);
				nofRealloc += AssertHistogramsRange(*hc,rawReader->GetTimestamp()-refTime,timeResolutions,busPatches);
			}

			++numberOfUsedEvents;

			++numberOfEventsSinceLastDecision;

			if ( numberOfEventsSinceLastDecision > nofEventsRequiredForDecision )
			{
				ReportFaultyBusPatches(*hc,busPatches,timeResolutions[timeResolutions.size()-1],nofEventsRequiredForDecision,occupancyThreshold);
				numberOfEventsSinceLastDecision=0;
			}

			for ( std::map<int,int>::const_iterator it = bpValues.begin(); it != bpValues.end(); ++it )
			{
				const int& buspatchId = it->first;
				const int& bpvalue = it->second;

				TString bpName = Form(""BP%04d"",buspatchId);

				for ( std::vector<int>::size_type is = 0; is < timeResolutions.size(); ++is )
				{
					TString hname;

					hname.Form(""/BUSPATCH/HITS/%ds/%s"",timeResolutions[is],bpName.Data());
					TH1* h = hc->Histo(hname.Data());

					if (!h)
					{
						std::cout << DAVERSION << "" ERROR : histogram "" << hname.Data() << "" not found"" << std::endl;
						continue;
					}

					h->Fill(rawReader->GetTimestamp()-refTime,bpvalue);
				}
			}

			for ( std::vector<int>::size_type is = 0; is < timeResolutions.size(); ++is )
			{
				TString hname;

				hname.Form(""Nevents%ds"",timeResolutions[is]);
				TH1* h = hc->Histo(hname.Data());

				if (!h)
				{
					std::cout << DAVERSION << "" ERROR : histogram "" << hname.Data() << "" not found"" << std::endl;
					continue;
				}

				h->Fill(rawReader->GetTimestamp()-refTime);
			}

		}
		else
		{
			++numberOfBadEvents;
		}

		delete event;

		delete rawReader;
	}


	std::cout << DAVERSION << Form("" INFO : %12d events processed : %12d physics %d used ones %d bad ones [ %d with MCH information ] [ %d incomplet %d flushed ]"",
			numberOfEvents,numberOfPhysicsEvent,numberOfUsedEvents,numberOfBadEvents,numberOfEventsWithMCH,
			numberOfIncompleteEvents,numberOfFlushedEvents) << std::endl;

	std::cout << DAVERSION << "" INFO : Number of histogram re-allocation : "" << nofRealloc << std::endl;

	if ( hc )
	{
		TFile* f = TFile::Open(outputFileName,""RECREATE"");
		hc->Write();
		delete f;
	}

  /* store the result file on FXS */
  if (daqDA_FES_storeFile(outputFileName,""BPEVO"")) return -9;

	timers.Stop();

	std::cout << DAVERSION <<  Form("" INFO : Execution time : R:%7.2fs C:%7.2fs\\n"", timers.RealTime(), timers.CpuTime()) << std::endl;

	return 0;
}
",16140,True,3863.488849425629,median
"= v1.Role
{product-author}
{product-version}
:data-uri:
:icons:
:toc: macro
:toc-title:
:toclevels: 2

toc::[]

== Description
[%hardbreaks]
Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding.

== Object Schema
Expand or mouse-over a field for more information about it.

++++
<pre>
<div style=""margin-left:13px;""><span title=""(string) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"">apiVersion</span>:
</div><div style=""margin-left:13px;""><span title=""(string) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">kind</span>:
</div><details open><summary><span title=""(v1.ObjectMeta) Standard object&#39;s metadata."">metadata</span>:
</summary><details><summary>  <span title=""(object) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"">annotations</span>:
</summary><div style=""margin-left:13px;"">    <span title=""(string)"">[string]</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(string) The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."">clusterName</span>:
</div><div style=""margin-left:13px;"">  <span title=""(v1.Time) CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"">creationTimestamp</span>:
</div><div style=""margin-left:13px;"">  <span title=""(integer) Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."">deletionGracePeriodSeconds</span>:
</div><div style=""margin-left:13px;"">  <span title=""(v1.Time) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata"">deletionTimestamp</span>:
</div><details><summary>  <span title=""(array) Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed."">finalizers</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(string) GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency"">generateName</span>:
</div><div style=""margin-left:13px;"">  <span title=""(integer) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."">generation</span>:
</div><details><summary>  <span title=""(v1.Initializers) An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven&#39;t explicitly asked to observe uninitialized objects.

When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user."">initializers</span>:
</summary><details><summary>    <span title=""(array) Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients."">pending</span>:
</summary><div style=""margin-left:13px;"">    - <span title=""(string) name of the process that is responsible for initializing this object."">name</span>:
</div></details><details><summary>    <span title=""(v1.Status) If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion."">result</span>:
</summary><div style=""margin-left:13px;"">      <span title=""(string) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources"">apiVersion</span>:
</div><div style=""margin-left:13px;"">      <span title=""(integer) Suggested HTTP return code for this status, 0 if not set."">code</span>:
</div><details><summary>      <span title=""(v1.StatusDetails) Extended data associated with the reason.  Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type."">details</span>:
</summary><details><summary>        <span title=""(array) The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes."">causes</span>:
</summary><div style=""margin-left:13px;"">        - <span title=""(string) The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed.  Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.

Examples:
  &#34;name&#34; - the field &#34;name&#34; on the current resource
  &#34;items[0].name&#34; - the field &#34;name&#34; on the first array entry in &#34;items&#34;"">field</span>:
</div><div style=""margin-left:13px;"">          <span title=""(string) A human-readable description of the cause of the error.  This field may be presented as-is to a reader."">message</span>:
</div><div style=""margin-left:13px;"">          <span title=""(string) A machine-readable description of the cause of the error. If this value is empty there is no information available."">reason</span>:
</div></details><div style=""margin-left:13px;"">        <span title=""(string) The group attribute of the resource associated with the status StatusReason."">group</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">kind</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described)."">name</span>:
</div><div style=""margin-left:13px;"">        <span title=""(integer) If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action."">retryAfterSeconds</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids"">uid</span>:
</div></details><div style=""margin-left:13px;"">      <span title=""(string) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">kind</span>:
</div><div style=""margin-left:13px;"">      <span title=""(string) A human-readable description of the status of this operation."">message</span>:
</div><details><summary>      <span title=""(v1.ListMeta) Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">metadata</span>:
</summary><div style=""margin-left:13px;"">        <span title=""(string) continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response."">continue</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) String that identifies the server&#39;s internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"">resourceVersion</span>:
</div><div style=""margin-left:13px;"">        <span title=""(string) selfLink is a URL representing this object. Populated by the system. Read-only."">selfLink</span>:
</div></details><div style=""margin-left:13px;"">      <span title=""(string) A machine-readable description of why this operation is in the &#34;Failure&#34; status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it."">reason</span>:
</div><div style=""margin-left:13px;"">      <span title=""(string) Status of the operation. One of: &#34;Success&#34; or &#34;Failure&#34;. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status"">status</span>:
</div></details></details><details><summary>  <span title=""(object) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"">labels</span>:
</summary><div style=""margin-left:13px;"">    <span title=""(string)"">[string]</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(string) Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"">name</span>:
</div><div style=""margin-left:13px;"">  <span title=""(string) Namespace defines the space within each name must be unique. An empty namespace is equivalent to the &#34;default&#34; namespace, but &#34;default&#34; is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"">namespace</span>:
</div><details><summary>  <span title=""(array) List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."">ownerReferences</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string) API version of the referent."">apiVersion</span>:
</div><div style=""margin-left:13px;"">    <span title=""(boolean) If true, AND if the owner has the &#34;foregroundDeletion&#34; finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs &#34;delete&#34; permission of the owner, otherwise 422 (Unprocessable Entity) will be returned."">blockOwnerDeletion</span>:
</div><div style=""margin-left:13px;"">    <span title=""(boolean) If true, this reference points to the managing controller."">controller</span>:
</div><div style=""margin-left:13px;"">    <span title=""(string) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds"">kind</span>:
</div><div style=""margin-left:13px;"">    <span title=""(string) Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names"">name</span>:
</div><div style=""margin-left:13px;"">    <span title=""(string) UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"">uid</span>:
</div></details><div style=""margin-left:13px;"">  <span title=""(string) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency"">resourceVersion</span>:
</div><div style=""margin-left:13px;"">  <span title=""(string) SelfLink is a URL representing this object. Populated by the system. Read-only."">selfLink</span>:
</div><div style=""margin-left:13px;"">  <span title=""(string) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"">uid</span>:
</div></details><details><summary><span title=""(array) Rules holds all the PolicyRules for this Role"">rules</span>:
</summary><details><summary>- <span title=""(array) APIGroups is the name of the APIGroup that contains the resources.  If multiple API groups are specified, any action requested against one of the enumerated resources in any API group will be allowed."">apiGroups</span>:
</summary><div style=""margin-left:13px;"">- - <span title=""(string)"">[string]</span>:
</div></details><details><summary>  <span title=""(array) NonResourceURLs is a set of partial urls that a user should have access to.  *s are allowed, but only as the full, final step in the path Since non-resource URLs are not namespaced, this field is only applicable for ClusterRoles referenced from a ClusterRoleBinding. Rules can either apply to API resources (such as &#34;pods&#34; or &#34;secrets&#34;) or non-resource URL paths (such as &#34;/api&#34;),  but not both."">nonResourceURLs</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><details><summary>  <span title=""(array) ResourceNames is an optional white list of names that the rule applies to.  An empty set means that everything is allowed."">resourceNames</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><details><summary>  <span title=""(array) Resources is a list of resources this rule applies to.  ResourceAll represents all resources."">resources</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details><details><summary>  <span title=""(array) Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule.  VerbAll represents all kinds."">verbs</span>:
</summary><div style=""margin-left:13px;"">  - <span title=""(string)"">[string]</span>:
</div></details></details>
</pre>
++++

== Operations

[[Post-apis-rbac.authorization.k8s.io-v1-roles]]
=== Create a Role
Create a Role

==== HTTP request
----
POST /apis/rbac.authorization.k8s.io/v1/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ""kind"": ""Role"",
  ""apiVersion"": ""rbac.authorization.k8s.io/v1"",
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X POST \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/roles <<'EOF'
{
  ""kind"": ""Role"",
  ""apiVersion"": ""rbac.authorization.k8s.io/v1"",
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1.Role
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Role
|201 Created|v1.Role
|202 Accepted|v1.Role
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Post-apis-rbac.authorization.k8s.io-v1-namespaces-namespace-roles]]
=== Create a Role in a namespace
Create a Role

==== HTTP request
----
POST /apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ""kind"": ""Role"",
  ""apiVersion"": ""rbac.authorization.k8s.io/v1"",
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X POST \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles <<'EOF'
{
  ""kind"": ""Role"",
  ""apiVersion"": ""rbac.authorization.k8s.io/v1"",
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1.Role
|===

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Role
|201 Created|v1.Role
|202 Accepted|v1.Role
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Get-apis-rbac.authorization.k8s.io-v1-namespaces-namespace-roles-name]]
=== Get a Role in a namespace
Read the specified Role

==== HTTP request
----
GET /apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles/$NAME
----

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the Role
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Role
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Get-apis-rbac.authorization.k8s.io-v1-roles]]
=== Get all Roles
List or watch objects of kind Role

==== HTTP request
----
GET /apis/rbac.authorization.k8s.io/v1/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/roles
----

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.RoleList
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf
* application/json;stream=watch
* application/vnd.kubernetes.protobuf;stream=watch


[[Get-apis-rbac.authorization.k8s.io-v1-namespaces-namespace-roles]]
=== Get all Roles in a namespace
List or watch objects of kind Role

==== HTTP request
----
GET /apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles
----

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.RoleList
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf
* application/json;stream=watch
* application/vnd.kubernetes.protobuf;stream=watch


[[Get-apis-rbac.authorization.k8s.io-v1-watch-namespaces-namespace-roles-name]]
=== Watch a Role in a namespace
Watch changes to an object of kind Role

==== HTTP request
----
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/watch/namespaces/$NAMESPACE/roles/$NAME
----

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the Role
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|pretty|If 'true', then the output is pretty printed.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.WatchEvent
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf
* application/json;stream=watch
* application/vnd.kubernetes.protobuf;stream=watch


[[Get-apis-rbac.authorization.k8s.io-v1-watch-roles]]
=== Watch all Roles
Watch individual changes to a list of Role

==== HTTP request
----
GET /apis/rbac.authorization.k8s.io/v1/watch/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/watch/roles
----

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|pretty|If 'true', then the output is pretty printed.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.WatchEvent
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf
* application/json;stream=watch
* application/vnd.kubernetes.protobuf;stream=watch


[[Get-apis-rbac.authorization.k8s.io-v1-watch-namespaces-namespace-roles]]
=== Watch all Roles in a namespace
Watch individual changes to a list of Role

==== HTTP request
----
GET /apis/rbac.authorization.k8s.io/v1/watch/namespaces/$NAMESPACE/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/watch/namespaces/$NAMESPACE/roles
----

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|pretty|If 'true', then the output is pretty printed.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.WatchEvent
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf
* application/json;stream=watch
* application/vnd.kubernetes.protobuf;stream=watch


[[Put-apis-rbac.authorization.k8s.io-v1-namespaces-namespace-roles-name]]
=== Update a Role in a namespace
Replace the specified Role

==== HTTP request
----
PUT /apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ""kind"": ""Role"",
  ""apiVersion"": ""rbac.authorization.k8s.io/v1"",
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X PUT \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
{
  ""kind"": ""Role"",
  ""apiVersion"": ""rbac.authorization.k8s.io/v1"",
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1.Role
|===

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the Role
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Role
|201 Created|v1.Role
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Patch-apis-rbac.authorization.k8s.io-v1-namespaces-namespace-roles-name]]
=== Patch a Role in a namespace
Partially update the specified Role

==== HTTP request
----
PATCH /apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json-patch+json'

{
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X PATCH \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json-patch+json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
{
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1.Patch
|===

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the Role
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Role
|401 Unauthorized|
|===

==== Consumes

* application/json-patch+json
* application/merge-patch+json
* application/strategic-merge-patch+json

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Delete-apis-rbac.authorization.k8s.io-v1-namespaces-namespace-roles-name]]
=== Delete a Role in a namespace
Delete a Role

==== HTTP request
----
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles/$NAME HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
Content-Type: application/json'

{
  ...
}

----

==== Curl request
----
$ curl -k \\
    -X DELETE \\
    -d @- \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    -H 'Content-Type: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles/$NAME <<'EOF'
{
  ...
}
EOF
----

==== HTTP body
[cols=""1,5"", options=""header""]
|===
|Parameter|Schema
|body|v1.DeleteOptions
|===

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|name|name of the Role
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|gracePeriodSeconds|The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
|orphanDependents|Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the ""orphan"" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
|propagationPolicy|Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Status
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf


[[Delete-apis-rbac.authorization.k8s.io-v1-namespaces-namespace-roles]]
=== Delete all Roles in a namespace
Delete collection of Role

==== HTTP request
----
DELETE /apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles HTTP/1.1
Authorization: Bearer $TOKEN
Accept: application/json
Connection: close
----

==== Curl request
----
$ curl -k \\
    -X DELETE \\
    -H ""Authorization: Bearer $TOKEN"" \\
    -H 'Accept: application/json' \\
    https://$ENDPOINT/apis/rbac.authorization.k8s.io/v1/namespaces/$NAMESPACE/roles
----

==== Path parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|namespace|object name and auth scope, such as for teams and projects
|===

==== Query parameters
[cols=""1,5"", options=""header""]
|===
|Parameter|Description
|pretty|If 'true', then the output is pretty printed.
|continue|The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.
|fieldSelector|A selector to restrict the list of returned objects by their fields. Defaults to everything.
|includeUninitialized|If true, partially initialized resources are included in the response.
|labelSelector|A selector to restrict the list of returned objects by their labels. Defaults to everything.
|limit|limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.
|resourceVersion|When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.
|timeoutSeconds|Timeout for the list/watch call.
|watch|Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.
|===

==== Responses
[cols=""1,5"", options=""header""]
|===
|HTTP Code|Schema
|200 OK|v1.Status
|401 Unauthorized|
|===

==== Consumes

* \\*/*

==== Produces

* application/json
* application/yaml
* application/vnd.kubernetes.protobuf



",12447,False,2393.1197142156243,median
"// Copyright 2002 - 2008, 2010, 2011 National Technology Engineering
// Solutions of Sandia, LLC (NTESS). Under the terms of Contract
// DE-NA0003525 with NTESS, the U.S. Government retains certain rights
// in this software.
//
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.


#include <percept/Util.hpp>
#include <percept/mesh/geometry/stk_geom/SplineFit.hpp>
#include <percept/mesh/geometry/stk_geom/LocalCubicSplineFit.hpp>
#include <gtest/gtest.h>

#include <fstream>
#include <stdexcept>
#include <algorithm>
#include <sstream>
#include <vector>
#include <cmath>
#include <iostream>
#include <string>
#include <typeinfo>
#include <math.h>

  namespace geom
  {
    namespace unit_tests
    {


      //=============================================================================
      //=============================================================================
      //=============================================================================

#if !defined(NO_GEOM_SUPPORT)
      TEST(unit_stk_geom, test_1)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        /// fit a quadratic
        LocalCubicSplineFit cf;
        int n = 11;
        Vectors2D Q(n);
        for (int i=0; i < n; i++)
          {
            double x = double(i)/double(n-1);
            double y = x*x;
            Q[i] = Vector2D(x,y);
          }
        if (debug_print) std::cout << ""Fitting quadratic with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);
        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        double t0=0,t1=1;
        curve->GetDomain( &t0, &t1);
        DPRINTLN2(t0,t1);
        DPRINTLN(curve->SpanCount());
        std::vector<double> spanKnots(curve->SpanCount()+1);
        curve->GetSpanVector(&spanKnots[0]);
        DPRINTLN(spanKnots);
        DPRINTLN(curve->HasNurbForm());
        DPRINTLN(curve->PointAtStart());
        DPRINTLN(curve->PointAtEnd());
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->PointAt(cf.U()[i]));
          }

        double tol = 1.e-5;
        int kk=0;
        // can't expect this type of curve to intepolate the knots - see below - must use
        // GetClosestPoint
        if (0)
          {
            for (size_t i=1; i < cf.U().size()-1; i += 2)
              {
                Point3D pt = curve->PointAt(cf.U()[i]);
                Point3D Qkk = Q[kk++];
                DPRINTLN2(pt, Qkk);
                double dist = pt.DistanceTo(Qkk);
                EXPECT_NEAR(dist, 0, tol);
              }
          }
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->DerivativeAt(cf.U()[i]));
          }
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->CurvatureAt(cf.U()[i]));
          }

        for (size_t i=0; i < cf.U().size(); i++)
          {
            ON_3dPoint point;
            ON_3dVector first_derivative;
            ON_3dVector second_derivative;
            curve->Ev2Der(cf.U()[i], point, first_derivative, second_derivative);
            if (debug_print)
              std::cout << PR(i) << PR(cf.U()[i]) << PR(point)
                        << PR(first_derivative) << PR(second_derivative) << std::endl;
          }

        ((ON_NurbsCurve *)curve)->SetProjectionTolerance(1.e-8);
        for (size_t i = 0; i < Q.size(); i++)
        {
          Point3D p = Q[i];
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN(closest_point);
          double dist = closest_point.DistanceTo(p);
          DPRINTLN(dist);
          EXPECT_NEAR(dist, 0.0, tol);
        }

        {
          Point3D p(0.1,.01,0);
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN2(u,closest_point);
          double dist = closest_point.DistanceTo(p);
          EXPECT_NEAR(dist, 0.0, tol);
          EXPECT_NEAR(closest_point[0], 0.1, tol);
          EXPECT_NEAR(closest_point[1], 0.01, tol);
        }

        {
          Point3D p(0.5,0.25,0);
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN2(u,closest_point);
          double dist = closest_point.DistanceTo(p);
          EXPECT_NEAR(dist, 0, tol);
        }

        {
          Point3D p(1,1,0);
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN2(u,closest_point);
          double dist = closest_point.DistanceTo(p);
          EXPECT_NEAR(dist, 0,tol);
        }

        delete curve;
      }

      //=============================================================================
      //=============================================================================
      //=============================================================================

      TEST(unit_stk_geom, test_five_point)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        /// fit a quadratic
        LocalCubicSplineFit cf(BSplineFit::FivePoint);
        int n = 14;
        Vectors2D Q(3);
        Q[0] = Vector2D(-2,0);
        Q[1] = Vector2D(-1,0);
        Q[2] = Vector2D(-.5,0);
        for (int i=0; i < n; i++)
          {
            double x = double(i)/double(n-1);
            double y = x*x;
            Q.push_back( Vector2D(x,y) );
          }
        if (debug_print) std::cout << ""Fitting quadratic with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);
        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        delete curve;
      }

      //=============================================================================
      //=============================================================================
      //=============================================================================

      TEST(unit_stk_geom, test_five_point_1)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        /// fit a quadratic
        LocalCubicSplineFit cf (BSplineFit::FivePoint);
        int n = 7;
        Vectors2D Q(n);
        Q[0] = Vector2D(-2,0);
        Q[1] = Vector2D(-1,0);
        Q[2] = Vector2D(-.5,0);
        Q[3] = Vector2D(0,0);
        Q[4] = Vector2D(1,1);
        Q[5] = Vector2D(2,2);
        Q[6] = Vector2D(2.5,2.5);
        if (debug_print) std::cout << ""Fitting quadratic with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);
        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        delete curve;
      }

      //=============================================================================
      //=============================================================================
      //=============================================================================

      TEST(unit_stk_geom, test_five_point_2)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        /// fit a quadratic
        LocalCubicSplineFit cf (BSplineFit::ThreePoint);
        int n = 7;
        Vectors2D Q(n);
        Q[0] = Vector2D(-3,0);
        Q[1] = Vector2D(-2,0.3);
        Q[2] = Vector2D(-1,0.3);
        Q[3] = Vector2D(0,0);
        Q[4] = Vector2D(1,1);
        Q[5] = Vector2D(2,2);
        Q[6] = Vector2D(2.5,2.5);
        if (debug_print) std::cout << ""Fitting quadratic with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);
        std::vector<int> isCorner(n, 0);
        isCorner[3] = 1;
        cf.setIsCorner(isCorner);
        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        delete curve;
      }

      //=============================================================================
      //=============================================================================
      //=============================================================================

      TEST(unit_stk_geom, test_corner)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        /// fit a quadratic
        LocalCubicSplineFit cf (BSplineFit::ThreePoint);
        int n = 8;
        Vectors2D Q(n);
        Q[0] = Vector2D(-3.2,3);
        Q[1] = Vector2D(-2.2,2);
        Q[2] = Vector2D(-1.2,1);
        Q[3] = Vector2D(-.2,0);
        Q[4] = Vector2D(.2,0);
        Q[5] = Vector2D(1.2,1);
        Q[6] = Vector2D(2.2,2);
        Q[7] = Vector2D(3.2,3);

        int offset=0;
        if (1)
          {
            Q.insert(Q.begin()+4, Vector2D(0,0));
            ++n;
            offset=1;
          }
        if (debug_print) std::cout << ""Fitting quadratic with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);
        std::vector<int> isCorner(n, 0);
        isCorner[3] = 1;
        isCorner[4+offset] = 1;
        cf.setIsCorner(isCorner);
        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        delete curve;
      }

      //=============================================================================
      //=============================================================================
      //=============================================================================

      TEST(unit_stk_geom, test_periodic)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        /// fit a circle
        LocalCubicSplineFit cf;
        cf.setIsPeriodic(true);
        int n = 13;
        Vectors2D Q(n);
        const double r = 1.0;
        for (int i=0; i < n; i++)
          {
            double theta = 2.0*M_PI*double(i)/double(n-1);
            double x = r*std::cos(theta);
            double y = r*std::sin(theta);
            Q[i] = Vector2D(x,y);
          }
        if (debug_print) std::cout << ""Fitting circle with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);
        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        double t0=0,t1=1;
        curve->GetDomain( &t0, &t1);
        DPRINTLN2(t0,t1);
        DPRINTLN(curve->SpanCount());
        std::vector<double> spanKnots(curve->SpanCount()+1);
        curve->GetSpanVector(&spanKnots[0]);
        DPRINTLN(spanKnots);
        DPRINTLN(curve->HasNurbForm());
        DPRINTLN(curve->PointAtStart());
        DPRINTLN(curve->PointAtEnd());
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->PointAt(cf.U()[i]));
          }

        double tol = 1.e-5;
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->DerivativeAt(cf.U()[i]));
          }
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->CurvatureAt(cf.U()[i]));
          }

        for (size_t i=0; i < cf.U().size(); i++)
          {
            ON_3dPoint point;
            ON_3dVector first_derivative;
            ON_3dVector second_derivative;
            curve->Ev2Der(cf.U()[i], point, first_derivative, second_derivative);
            if (debug_print)
              std::cout << PR(i) << PR(cf.U()[i]) << PR(point)
                        << PR(first_derivative) << PR(second_derivative) << std::endl;
          }

        ((ON_NurbsCurve *)curve)->SetProjectionTolerance(1.e-8);
        for (size_t i = 0; i < Q.size(); i++)
        {
          Point3D p = Q[i];
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN(closest_point);
          double dist = closest_point.DistanceTo(p);
          DPRINTLN(dist);
          EXPECT_NEAR(dist, 0.0, tol);
        }

        {
          Point3D p(1.01,0.0,0);
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN2(u,closest_point);
          double dist = closest_point.DistanceTo(p);
          EXPECT_NEAR(dist, 0.01, tol);
          EXPECT_NEAR(closest_point[0], 1.0, tol);
          EXPECT_NEAR(closest_point[1], 0.0, tol);
        }

        {
          Point3D p(0,1.1,0);
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN2(u,closest_point);
          double dist = closest_point.DistanceTo(p);
          EXPECT_NEAR(dist, 0.1, tol);
        }

        delete curve;
      }

      //=============================================================================
      //=============================================================================
      //=============================================================================

      TEST(unit_stk_geom, test_closed)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        double naca_0012_21pts[][2] =
          {{1,  0},
           {0.97552826,  0.00341331},
           {0.9045085, 0.01277464},
           {0.79389263,  0.02590486},
           {0.6545085, 0.04009273},
           {0.5, 0.05231025},
           {0.3454915, 0.0591394},
           {0.20610737,  0.05745444},
           {0.0954915, 0.04592861},
           {0.02447174,  0.02586248},
           {0, 0},
           {0.02447174,  -0.02586248},
           {0.0954915, -0.04592861},
           {0.20610737,  -0.05745443},
           {0.3454915, -0.0591394},
           {0.5, -0.05231025},
           {0.6545085, -0.04009273},
           {0.79389263,  -0.02590486},
           {0.9045085, -0.01277464},
           {0.97552826,  -0.00341331},
           {1, 0}};

        /// fit a circle
        LocalCubicSplineFit cf;
        cf.setIsPeriodic(false);
        int n = 21;
        Vectors2D Q(n);
        for (int i=0; i < n; i++)
          {
            Q[i] = Vector2D(naca_0012_21pts[i][0], naca_0012_21pts[i][1]);
          }
        if (debug_print) std::cout << ""Fitting naca_0012_21pts with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);
        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        double t0=0,t1=1;
        curve->GetDomain( &t0, &t1);
        DPRINTLN2(t0,t1);
        DPRINTLN(curve->SpanCount());
        std::vector<double> spanKnots(curve->SpanCount()+1);
        curve->GetSpanVector(&spanKnots[0]);
        DPRINTLN(spanKnots);
        DPRINTLN(curve->HasNurbForm());
        DPRINTLN(curve->PointAtStart());
        DPRINTLN(curve->PointAtEnd());
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->PointAt(cf.U()[i]));
          }

        double tol = 1.e-4;
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->DerivativeAt(cf.U()[i]));
          }
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->CurvatureAt(cf.U()[i]));
          }

        for (size_t i=0; i < cf.U().size(); i++)
          {
            ON_3dPoint point;
            ON_3dVector first_derivative;
            ON_3dVector second_derivative;
            curve->Ev2Der(cf.U()[i], point, first_derivative, second_derivative);
            if (debug_print)
              std::cout << PR(i) << PR(cf.U()[i]) << PR(point)
                        << PR(first_derivative) << PR(second_derivative) << std::endl;
          }

        ((ON_NurbsCurve *)curve)->SetProjectionTolerance(1.e-8);
        for (size_t i = 0; i < Q.size(); i++)
        {
          Point3D p = Q[i];
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN(closest_point);
          double dist = closest_point.DistanceTo(p);
          DPRINTLN(dist);
          EXPECT_NEAR(dist, 0.0, tol);
        }

        {
          Point3D p(1.01,0.0,0);
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN2(u,closest_point);
          double dist = closest_point.DistanceTo(p);
          EXPECT_NEAR(dist, 0.01, tol);
          EXPECT_NEAR(closest_point[0], 1.0, tol);
          EXPECT_NEAR(closest_point[1], 0.0, tol);
        }

        {
          Point3D p(-0.01,0.,0);
          double u=0;
          bool success = curve->GetClosestPoint(p, &u);
          EXPECT_TRUE(success);
          Point3D closest_point = curve->PointAt(u);
          DPRINTLN2(u,closest_point);
          double dist = closest_point.DistanceTo(p);
          EXPECT_NEAR(dist, 0.01, tol);
        }

        delete curve;
      }

      void test_it(double points[][2], int npts, std::vector<int>& corners, const bool debug_print = false)
      {

        SplineFit::s_debug_print = debug_print;

        LocalCubicSplineFit cf;
        cf.setIsPeriodic(false);
        int n = npts;
        Vectors2D Q(n);
        for (int i=0; i < n; i++)
          {
            Q[i] = Vector2D(points[i][0], points[i][1]);
          }
        if (debug_print) std::cout << ""Fitting airfoil with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);

        cf.setIsCorner(corners);

        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        double t0=0,t1=1;
        curve->GetDomain( &t0, &t1);
        int ndiv = 10;
        Vectors2D Qref;
        std::vector<double> tv;
        for (size_t i=0; i < cf.U().size()-1; i++)
          {
            tv.push_back(cf.U()[i]);
            for (int id=1; id <= ndiv-1; ++id)
              {
                double t = cf.U()[i] + double(id)/double(ndiv)*(cf.U()[i+1] - cf.U()[i]);
                tv.push_back(t);
              }
          }
        tv.push_back(t1);
        percept::Util::makeUnique(tv);
        if (debug_print) std::cout << ""tv= "" << tv << std::endl;
        for (unsigned ii=0; ii < tv.size(); ++ii)
          {
            ON_3dPoint point;
            ON_3dVector first_derivative;
            ON_3dVector second_derivative;
            curve->Ev2Der(tv[ii], point, first_derivative, second_derivative);
            Vector2D v(point.x, point.y);
            Qref.push_back(v);
          }
        if (debug_print) std::cout << ""Fitting airfoil with cubic spline - refined = "" << std::endl;
        DPRINTLN(Qref);
#if 1
            std::ofstream ff(""/ascldap/users/srkenno/xfer/scraps.txt"");
            ff  << ""Q= "" << Q << std::endl;
            ff  << ""Qref2= "" << Qref << std::endl;
#endif
        if (debug_print)
          {
            std::cout  << ""Qref2= "" << Qref << std::endl;
          }

        DPRINTLN2(t0,t1);
        DPRINTLN(curve->SpanCount());
        std::vector<double> spanKnots(curve->SpanCount()+1);
        curve->GetSpanVector(&spanKnots[0]);
        DPRINTLN(spanKnots);
        DPRINTLN(curve->HasNurbForm());
        DPRINTLN(curve->PointAtStart());
        DPRINTLN(curve->PointAtEnd());
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->PointAt(cf.U()[i]));
          }

        double tol = 1.e-4;
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->DerivativeAt(cf.U()[i]));
          }
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->CurvatureAt(cf.U()[i]));
          }

        for (size_t i=0; i < cf.U().size(); i++)
          {
            ON_3dPoint point;
            ON_3dVector first_derivative;
            ON_3dVector second_derivative;
            curve->Ev2Der(cf.U()[i], point, first_derivative, second_derivative);
            if (debug_print)
              std::cout << PR(i) << PR(cf.U()[i]) << PR(point)
                        << PR(first_derivative) << PR(second_derivative) << std::endl;
          }

        ((ON_NurbsCurve *)curve)->SetProjectionTolerance(1.e-8);
        for (size_t i = 0; i < Q.size(); i++)
          {
            Point3D p = Q[i];
            double u=0;
            bool success = curve->GetClosestPoint(p, &u);
            EXPECT_TRUE(success);
            Point3D closest_point = curve->PointAt(u);
            DPRINTLN(closest_point);
            double dist = closest_point.DistanceTo(p);
            DPRINTLN(dist);
            EXPECT_NEAR(dist, 0.0, tol);
          }

        if (0)
          {
            Point3D topTE(1, 0.00025, 0);
            Point3D topTEm(0.990190797590092, 0.00219410540613287, 0);
            Point3D p = 0.5*(topTE+topTEm);
            std::cout << ""point being projected = "" << p << std::endl;
            double u=0;
            bool success = curve->GetClosestPoint(p, &u);
            EXPECT_TRUE(success);
            Point3D closest_point = curve->PointAt(u);
            DPRINTLN2(u,closest_point);
            double dist = closest_point.DistanceTo(p);
            DPRINTLN(dist);
          }

        delete curve;

      }

      TEST(unit_stk_geom, test_closed2)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        double points[][2] =
          {  {-8.6688924, -5.0029264},   {-8.660254, -5},   {-8.6534005, -4.9939822},   {-8.6488179, -4.9860635},   {-8.6460052, -4.9773397},
             {-8.6446617, -4.9703024},   {-8.6444374, -4.9631208},   {-8.6446886, -4.9559395},
             {-8.645216, -4.9487721},   {-8.6459287, -4.9416206},   {-8.6467765, -4.9344837},   {-8.6483853, -4.9259673},   {-8.6501983, -4.9174934},
             {-8.6522198, -4.909066},   {-8.6544529, -4.9006923},   {-8.6569007, -4.8923789},
             {-8.6595656, -4.8841325},   {-8.665133, -4.868257},   {-8.6710449, -4.8525063},   {-8.6773016, -4.8368908},   {-8.683904, -4.8214174},
             {-8.6908518, -4.8060952},   {-8.6981427, -4.7909349},   {-8.7055575, -4.7759944},
             {-8.7131503, -4.7611436},   {-8.7209204, -4.7463848},   {-8.7288668, -4.7317202},   {-8.7369886, -4.717152},   {-8.7452848, -4.7026824},
             {-8.7623129, -4.6739792},   {-8.7797119, -4.6454994},   {-8.7974787, -4.6172475},
             {-8.8156097, -4.5892278},   {-8.8341012, -4.5614448},   {-8.8529491, -4.5339023},   {-8.8720808, -4.5063929},   {-8.8914044, -4.4790178},
             {-8.9109184, -4.4517782},   {-8.9306217, -4.424675},   {-8.9505127, -4.3977094},
             {-8.9705901, -4.3708822},   {-8.9908884, -4.3440402},   {-9.0113346, -4.3173105},   {-9.0319277, -4.2906938},   {-9.0526668, -4.2641907},
             {-9.0735509, -4.2378016},   {-9.094579, -4.2115271},   {-9.1051948, -4.1983867},
             {-9.1158516, -4.1852795},   {-9.1265493, -4.1722057},   {-9.1372877, -4.1591651},   {-9.1480665, -4.1461581},   {-9.1588857, -4.1331846},
             {-9.1616224, -4.1347646},   {-9.1557966, -4.150621},   {-9.1499216, -4.1664593},
             {-9.1439973, -4.1822793},   {-9.1380239, -4.1980807},   {-9.1320011, -4.2138634},   {-9.1259291, -4.2296271},   {-9.1136888, -4.2609752},
             {-9.1012772, -4.2922559},   {-9.0886943, -4.323468},   {-9.0759402, -4.3546106},
             {-9.0630147, -4.3856823},   {-9.049918, -4.4166822},   {-9.0367237, -4.4474833},   {-9.0233163, -4.4781923},   {-9.0096959, -4.5088074},
             {-8.9958627, -4.5393269},   {-8.9818169, -4.5697491},   {-8.9675589, -4.6000723},
             {-8.9531304, -4.6301663},   {-8.9383153, -4.6600719},   {-8.9231151, -4.6897837},   {-8.9075316, -4.7192961},   {-8.8915669, -4.7486041},
             {-8.8752233, -4.7777024},   {-8.8668403, -4.7921219},   {-8.8582848, -4.8064397},
             {-8.8495581, -4.8206538},   {-8.8406616, -4.8347623},   {-8.8315968, -4.8487633},   {-8.8223654, -4.8626549},   {-8.8128816, -4.8765492},
             {-8.8030861, -4.8902272},   {-8.792987, -4.9036818},   {-8.7825919, -4.916908},
             {-8.7719073, -4.9299032},   {-8.7609425, -4.9426625},   {-8.7551333, -4.9490935},   {-8.7491576, -4.9553701},   {-8.7430223, -4.9614909},
             {-8.7367348, -4.9674552},   {-8.7303026, -4.9732623},   {-8.7237315, -4.9789137},
             {-8.7179747, -4.9832164},   {-8.7121377, -4.9874094},   {-8.7061943, -4.9914499},   {-8.7001006, -4.995258},   {-8.6937691, -4.9986546},
             {-8.6870029, -5.0010097},   {-8.6780415, -5.0029358},   {-8.6688924, -5.0029264}
          };

        int n = sizeof(points)/(2*sizeof(double));

        std::vector<int> corners(n,0);
        corners[52] = 1;
        corners[53] = 1;
        test_it(points, n, corners, debug_print);
      }

      TEST(unit_stk_geom, test_closed1)
      {
        const bool debug_print = false;
        SplineFit::s_debug_print = debug_print;

        double naca64418[][2] =
{  {0.99002628828708583164, 0.00047397265058935026403},   {1, -0.0002500000000000000052},   {1, -0.00021000000000000000871},   {1, -0.00012717143142914233596},   {1, 0},   {1, 0.00012717143142914233596},   {1, 0.00021000000000000000871},   {1, 0.0002500000000000000052},
  {0.99019079759009220876, 0.0021941054061328656329},   {0.97939672348457318396, 0.0043456828769943721055},   {0.96754799652658007858, 0.006738140551001466777},   {0.95457740200951124443, 0.0094148844216804614821},   {0.94042220338285342773, 0.012429663166003478841},   {0.92502003395103205019, 0.015817681683521832986},   {0.90830984484028376436, 0.01959191961047875713},   {0.89023626787365739421, 0.023753451853701704893},
  {0.87075460505293444946, 0.02830161685569335811},   {0.84983396894195406546, 0.033234802411729415239},   {0.82745831813032222346, 0.038542107530149104233},   {0.80363057603858389921, 0.044208562324423494871},   {0.77837265041734315929, 0.050203999904281197686},   {0.75172087002855070281, 0.056453948516654445244},   {0.72373225546400277164, 0.062857167391083906827},   {0.69449509754184657329, 0.069325707963627816732},
  {0.66412361369131334143, 0.075761518303150560127},   {0.6327543626068404814, 0.082042775691104977143},   {0.60054920175778159219, 0.088045607110938214901},   {0.56769284071806480618, 0.09364737841273459984},   {0.53438703852640079273, 0.098715779356176425186},   {0.5008456368711438067, 0.10309988954840600128},   {0.46729422943978454752, 0.10665655576324731268},   {0.43397194987540377298, 0.10933287316996238847},
  {0.40110407853824148194, 0.11087708945996455068},   {0.36892533482516109977, 0.11095875686748987721},   {0.33767022574360006093, 0.10991989995920561918},   {0.3075221641753079771, 0.10808763563184944911},   {0.27863797169662024578, 0.10551679761701227012},   {0.25114270211111250353, 0.10230043857842227584},   {0.22512691322579930775, 0.098561404261393162352},   {0.20065073074612110871, 0.094412461356085150554},
  {0.17774665516336701776, 0.089954064851589854435},   {0.15642853707453546752, 0.085247405797907363501},   {0.13668950157889939168, 0.08034743959251201828},   {0.11850438567566352888, 0.075305807121968007523},   {0.10183232476853765203, 0.070171277722418878842},   {0.086617038650746991379, 0.064997167293847066261},   {0.072798753498379831228, 0.059813935349415842113},   {0.060314165470808228653, 0.054641543390762013777},
  {0.049102264687040486635, 0.049485014440722036033},   {0.039096363517174340108, 0.044359183588986307589},   {0.030236433423895866385, 0.039267147284332462598},   {0.022458938379117655143, 0.034222952210548600316},   {0.015707084232797447615, 0.029236942065808409208},   {0.010019635813366760055, 0.024217173961720041969},   {0.005431695309709636682, 0.019136007698792076304},   {0.0020489450882541786376, 0.013984042174987025217},
  {0.00020410562666559633918, 0.0087534448761868235978},   {-0.00035033511722699597251, 0.0037944450508796629187},   {0.00025537761657368971942, -0.0011558285011150260142},   {0.0022877633538304483971, -0.0063092248219418691629},   {0.0057895193014080286592, -0.011365340644720967403},   {0.01072332838221700009, -0.016071223344123291427},   {0.016967754358253032965, -0.020318052163419461631},   {0.024339606193296229458, -0.02423550027702111101},
  {0.03277017241382997742, -0.027947367318039997852},   {0.042254174541994933556, -0.031546730447824189447},   {0.052843416550667987597, -0.035033235712240373694},   {0.064586014642605479863, -0.038434124382554238353},   {0.077540000101318395931, -0.041756746999623367556},   {0.09176294717196496753, -0.045011355006699879655},   {0.10731466659203625635, -0.048186887993079074999},   {0.12425068037641283369, -0.051263190485404348806},
  {0.14261827452153957863, -0.054215638720243236603},   {0.16245145914992878411, -0.057031129744904179857},   {0.18377167556204154764, -0.059687102101209338345},   {0.20658629441019629724, -0.062135616702981809334},   {0.2308823038757764623, -0.064326275993137352338},   {0.25662423684751717312, -0.066201828967897308198},   {0.28375207116483019965, -0.06769416328162937424},   {0.31218001097248571085, -0.068701775916454793647},
  {0.34179248829714869995, -0.069148527608371451736},   {0.37244604063915648373, -0.068998069262887540276},   {0.40396431936271415264, -0.067948207091934914592},   {0.43612842972917137407, -0.065698082345921879344},   {0.46873781798448782565, -0.062593365483713553354},   {0.50159300286180530382, -0.058887398385269650036},   {0.5344760369259542454, -0.05464349647854067904},   {0.56717863440844307199, -0.049996226620562016218},
  {0.5995018446399557055, -0.045093793935311494991},   {0.63125613583719863975, -0.040067491105955144182},   {0.66226103687797865938, -0.035007022126730548417},   {0.69235692013529193112, -0.030012728031143430518},   {0.72140845019166544017, -0.025197638094096464628},   {0.74929776419191285175, -0.02063500784971983304},   {0.77593045418062112084, -0.016388829465100260979},   {0.80124300331585196489, -0.012562565185579830512},
  {0.82518508874050966462, -0.0091930936548549838788},   {0.84771037950456895604, -0.0061791789085143822291},   {0.86880158240480642728, -0.00346332249124713153},   {0.88848382018411453664, -0.0011748376029786177475},   {0.90679174274713503223, 0.00057067652435943455776},   {0.92376005610720912653, 0.0017232011544815475056},   {0.93942514503353724553, 0.0022826905047788406677},   {0.95382757744262558486, 0.0022866684086450535067},
  {0.96701657450649303183, 0.0018611136536592579743},   {0.97905764462256894554, 0.0012085019055270856698},   {0.99002628828708583164, 0.00047397265058935026403}};

        LocalCubicSplineFit cf;
        cf.setIsPeriodic(false);
        int n = 107;
        int n1 = sizeof(naca64418)/(2*sizeof(double));
        VERIFY_OP_ON(n, ==, n1, ""bad"");
        Vectors2D Q(n);
        for (int i=0; i < n; i++)
          {
            Q[i] = Vector2D(naca64418[i][0], naca64418[i][1]);
          }
        if (debug_print) std::cout << ""Fitting airfoil with cubic spline - points = "" << std::endl;
        DPRINTLN(Q);

        std::vector<int> corners(n,0);
        corners[1] = 1;
        corners[7] = 1;
        cf.setIsCorner(corners);

        ON_Curve *curve = cf.fit(Q);
        if (debug_print)
          cf.print();

        double t0=0,t1=1;
        curve->GetDomain( &t0, &t1);
        int ndiv = 10;
        Vectors2D Qref;
        std::vector<double> tv;
        for (size_t i=0; i < cf.U().size()-1; i++)
          {
            tv.push_back(cf.U()[i]);
            for (int id=1; id <= ndiv-1; ++id)
              {
                double t = cf.U()[i] + double(id)/double(ndiv)*(cf.U()[i+1] - cf.U()[i]);
                tv.push_back(t);
              }
          }
        tv.push_back(t1);
        percept::Util::makeUnique(tv);
        if (debug_print) std::cout << ""tv= "" << tv << std::endl;
        for (unsigned ii=0; ii < tv.size(); ++ii)
          {
            ON_3dPoint point;
            ON_3dVector first_derivative;
            ON_3dVector second_derivative;
            curve->Ev2Der(tv[ii], point, first_derivative, second_derivative);
            Vector2D v(point.x, point.y);
            Qref.push_back(v);
          }
        if (debug_print) std::cout << ""Fitting airfoil with cubic spline - refined = "" << std::endl;
        DPRINTLN(Qref);
#if 1
            std::ofstream ff(""/ascldap/users/srkenno/xfer/scraps.txt"");
            ff  << ""Q= "" << Q << std::endl;
            ff  << ""Qref2= "" << Qref << std::endl;
#endif
        if (debug_print)
          {
            std::cout  << ""Qref2= "" << Qref << std::endl;
          }

        DPRINTLN2(t0,t1);
        DPRINTLN(curve->SpanCount());
        std::vector<double> spanKnots(curve->SpanCount()+1);
        curve->GetSpanVector(&spanKnots[0]);
        DPRINTLN(spanKnots);
        DPRINTLN(curve->HasNurbForm());
        DPRINTLN(curve->PointAtStart());
        DPRINTLN(curve->PointAtEnd());
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->PointAt(cf.U()[i]));
          }

        double tol = 1.e-4;
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->DerivativeAt(cf.U()[i]));
          }
        for (size_t i=0; i < cf.U().size(); i++)
          {
            DPRINTLN2(i, curve->CurvatureAt(cf.U()[i]));
          }

        for (size_t i=0; i < cf.U().size(); i++)
          {
            ON_3dPoint point;
            ON_3dVector first_derivative;
            ON_3dVector second_derivative;
            curve->Ev2Der(cf.U()[i], point, first_derivative, second_derivative);
            if (debug_print)
              std::cout << PR(i) << PR(cf.U()[i]) << PR(point)
                        << PR(first_derivative) << PR(second_derivative) << std::endl;
          }

        ((ON_NurbsCurve *)curve)->SetProjectionTolerance(1.e-8);
        for (size_t i = 0; i < Q.size(); i++)
          {
            Point3D p = Q[i];
            double u=0;
            bool success = curve->GetClosestPoint(p, &u);
            EXPECT_TRUE(success);
            Point3D closest_point = curve->PointAt(u);
            DPRINTLN(closest_point);
            double dist = closest_point.DistanceTo(p);
            DPRINTLN(dist);
            EXPECT_NEAR(dist, 0.0, tol);
          }

        if (1)
          {
            Point3D topTE(1, 0.00025, 0);
            Point3D topTEm(0.990190797590092, 0.00219410540613287, 0);
            Point3D p = 0.5*(topTE+topTEm);
            //std::cout << ""point being projected = "" << p << std::endl;
            double u=0;
            bool success = curve->GetClosestPoint(p, &u);
            EXPECT_TRUE(success);
            Point3D closest_point = curve->PointAt(u);
            DPRINTLN2(u,closest_point);
            double dist = closest_point.DistanceTo(p);
            DPRINTLN(dist);
            //EXPECT_NEAR(dist, 0.01, tol);
            //EXPECT_NEAR(closest_point[0], 1.01, tol);
            //EXPECT_NEAR(closest_point[1], -2.50000e-04, tol);
          }


        if (0)
          {
            Point3D p(1.01000e+00, -2.50000e-04, 0);
            double u=0;
            bool success = curve->GetClosestPoint(p, &u);
            EXPECT_TRUE(success);
            Point3D closest_point = curve->PointAt(u);
            DPRINTLN2(u,closest_point);
            double dist = closest_point.DistanceTo(p);

            EXPECT_NEAR(dist, 0.01, tol);
            EXPECT_NEAR(closest_point[0], 1.01, tol);
            EXPECT_NEAR(closest_point[1], -2.50000e-04, tol);
          }

        if (0)
          {
            Point3D p(-0.01,0.,0);
            double u=0;
            bool success = curve->GetClosestPoint(p, &u);
            EXPECT_TRUE(success);
            Point3D closest_point = curve->PointAt(u);
            DPRINTLN2(u,closest_point);
            double dist = closest_point.DistanceTo(p);
            EXPECT_NEAR(dist, 0.01, tol);
          }

        delete curve;

      }


      //=============================================================================
      //=============================================================================
      //=============================================================================

      TEST(unit_stk_geom, test_2)
      {
        const bool debug_print = false;
        if (1)
          {
            // write a wiggly cubic curve on the ""green NURBS wiggle"" layer
            ON_NurbsCurve* wiggle = new ON_NurbsCurve(
                                                      3, // dimension
                                                      false, // true if rational
                                                      4,     // order = degree+1
                                                      6      // number of control vertices
                                                      );
            int i;
            Points3D pts;
            for ( i = 0; i < wiggle->CVCount(); i++ ) {
              Point3D pt( 2*i, -i, (i-3)*(i-3) ); // pt = some 3d point
              DPRINTLN2(i,pt);
              wiggle->SetCV( i, pt );
              pts.push_back(pt);
            }

            // ON_NurbsCurve's have order+cv_count-2 knots.
            wiggle->SetKnot(0, 0.0);
            wiggle->SetKnot(1, 0.0);
            wiggle->SetKnot(2, 0.0);
            wiggle->SetKnot(3, 1.5);
            wiggle->SetKnot(4, 2.3);
            wiggle->SetKnot(5, 4.0);
            wiggle->SetKnot(6, 4.0);
            wiggle->SetKnot(7, 4.0);

            DPRINTLN(wiggle->IsValid());
            DPRINTLN(wiggle->IsRational());
            DPRINTLN(wiggle->CVCount());
            DPRINTLN(wiggle->CVSize());
            DPRINTLN(wiggle->Order());
            DPRINTLN(wiggle->KnotCount());

            DPRINTLN(wiggle->HasNurbForm());
            DPRINTLN(wiggle->PointAtStart());
            DPRINTLN(wiggle->PointAtEnd());

            int kn=wiggle->KnotCount();
            std::vector<double> knots;
            for (int k = 0; k < kn; k++)
              {
                DPRINTLN2(k, wiggle->PointAt(wiggle->Knot(k)));
                knots.push_back(wiggle->Knot(k));
              }
            if (debug_print)
              {
                ON_TextLog log;
                wiggle->Dump(log);
              }

            DPRINTLN(pts);
            DPRINTLN(knots);

            delete wiggle;
          }

        if (1)
          {
            double pts[][2] = {{0, 1},     {0.2, 1.3}, {1.5, 2},
                               {1.75, 2},  {2, 2}, {2.1, 0.5},
                               {2.5, .5},  {2.9, .5}, {3.3, .9},
                               {4, 2}};
            //  Piegl & Tiller convention - start/end with order number of repeated knots
            //double[] knots =  {0, 0, 0, 0, 1, 2, 3, 4, 5, 6, 7, 7, 7, 7};
            // OpenNURBS convention - start/end with (order-1) repeated knots
            //double knots[] =  {0, 0,   0, 1, 2, 3, 4, 5, 6, 7,   7, 7 };
            double knots[] =  {0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 4 };

            // n = 3, Q[0]..Q[n] --> n = 3;
            int np=10;
            //int nk=12;

            ON_NurbsCurve* wiggle = new ON_NurbsCurve(
                                                      2, // dimension
                                                      false, // true if rational
                                                      4,     // order = degree+1
                                                      np      // number of control vertices
                                                      );
            int i;
            for ( i = 0; i < wiggle->CVCount(); i++ ) {
              Point3D pt( pts[i][0], pts[i][1], 0);
              DPRINTLN2(i,pt);
              wiggle->SetCV( i, pt );
            }

            // ON_NurbsCurve's have order+cv_count-2 knots.
            int kn=wiggle->KnotCount();
            for (int k = 0; k < kn; k++)
              {
                wiggle->SetKnot(k, knots[k]);
              }

            DPRINTLN(wiggle->IsValid());
            DPRINTLN(wiggle->IsRational());
            DPRINTLN(wiggle->CVCount());
            DPRINTLN(wiggle->CVSize());
            DPRINTLN(wiggle->Order());
            DPRINTLN(wiggle->KnotCount());

            DPRINTLN(wiggle->HasNurbForm());
            DPRINTLN(wiggle->PointAtStart());
            DPRINTLN(wiggle->PointAtEnd());

            for (int k = 0; k < kn; k++)
              {
                DPRINTLN2(k, wiggle->PointAt(wiggle->Knot(k)));
              }
            delete wiggle;
          }

      }
#endif

    }
  }
",16361,True,3933.0750089624044,median
"[[install-config-syncing-groups-with-ldap]]
= Syncing Groups With LDAP
{product-author}
{product-version}
:data-uri:
:icons:
:experimental:
:toc: macro
:toc-title:

toc::[]

== Overview
As an {product-title} administrator, you can use groups to manage users, change
their permissions, and enhance collaboration. Your organization may have already
created user groups and stored them in an LDAP server. {product-title} can sync
those LDAP records with internal {product-title} records, enabling you to manage
your groups in one place. {product-title} currently supports group sync with
LDAP servers using three common schemas for defining group membership: RFC 2307,
Active Directory, and augmented Active Directory.

[NOTE]
====
You must have
xref:../architecture/additional_concepts/authorization.adoc#roles[`cluster-admin`
privileges] to sync groups.
====

[[configuring-ldap-sync]]
== Configuring LDAP Sync

Before you can xref:running-ldap-sync[run LDAP sync], you need a sync
configuration file. This file contains LDAP client configuration details:

* Configuration for connecting to your LDAP server.
* Sync configuration options that are dependent on the schema used in your LDAP
server.

A sync configuration file can also contain an administrator-defined list of name
mappings that maps {product-title} Group names to groups in your LDAP server.

[[ldap-client-configuration]]
=== LDAP Client Configuration

.LDAP Client Configuration
====
[source,yaml]
----
url: ldap://10.0.0.0:389 <1>
bindDN: cn=admin,dc=example,dc=com <2>
bindPassword: password <3>
insecure: false <4>
ca: my-ldap-ca-bundle.crt <5>
----
<1> The connection protocol, IP address of the LDAP server hosting your
database, and the port to connect to, formatted as `scheme://host:port`.
<2> Optional distinguished name (DN) to use as the Bind DN.
{product-title} uses this if elevated privilege is required to retrieve entries for
the sync operation.
<3> Optional password to use to bind. {product-title} uses this if elevated privilege is
necessary to retrieve entries for the sync operation. This value may also be
provided in an
xref:../install_config/master_node_configuration.adoc#master-node-configuration-passwords-and-other-data[environment
variable, external file, or encrypted file].
<4> When `true`, no TLS connection is made to the server. When `false`, secure
LDAP (`ldaps://`) URLs connect using TLS, and insecure LDAP (`ldap://`) URLs are
upgraded to TLS.
<5> The certificate bundle to use for validating server certificates for the
configured URL. If empty, {product-title} uses system-trusted roots. This only applies
if `insecure` is set to `false`.
====

[[ldap-query-definition]]
=== LDAP Query Definition

Sync configurations consist of LDAP query definitions for the entries that are
required for synchronization. The specific definition of an LDAP query depends
on the schema used to store membership information in the LDAP server.

.LDAP Query Definition
====
[source,yaml]
----
baseDN: ou=users,dc=example,dc=com <1>
scope: sub <2>
derefAliases: never <3>
timeout: 0 <4>
filter: (objectClass=inetOrgPerson) <5>
pageSize: 0 <6>
----
<1> The distinguished name (DN) of the branch of the directory where all
searches will start from. It is required that you specify the top of your
directory tree, but you can also specify a subtree in the directory.
<2> The scope of the search. Valid values are `base`, `one`, or `sub`. If this
is left undefined, then a scope of `sub` is assumed. Descriptions of the scope
options can be found in the xref:ldap-search[table below].
<3> The behavior of the search with respect to aliases in the LDAP tree. Valid
values are `never`, `search`, `base`, or `always`. If this is left undefined,
then the default is to `always` dereference aliases. Descriptions of the
dereferencing behaviors can be found in the xref:deref-aliases[table below].
<4> The time limit allowed for the search by the client, in seconds. A value of
0 imposes no client-side limit.
<5> A valid LDAP search filter. If this is left undefined, then the default is
`(objectClass=*)`.
<6> The optional maximum size of response pages from the server, measured in LDAP
entries. If set to 0, no size restrictions will be made on pages of responses.
Setting paging sizes is necessary when queries return more entries than the
client or server allow by default.
====

[[ldap-search]]
.LDAP Search Scope Options
[cols=""2a,8a"",options=""header""]
|===
|LDAP Search Scope | Description
.^|`base`          | Only consider the object specified by the base DN given for the query.
.^|`one`           | Consider all of the objects on the same level in the tree as the base DN for
the query.
.^|`sub`           | Consider the entire subtree rooted at the base DN given for the query.
|===

[[deref-aliases]]
.LDAP Dereferencing Behaviors
[cols=""2a,8a"",options=""header""]
|===
|Dereferencing Behavior | Description
.^|`never`              | Never dereference any aliases found in the LDAP tree.
.^|`search`             | Only dereference aliases found while searching.
.^|`base`               | Only dereference aliases while finding the base object.
.^|`always`             | Always dereference all aliases found in the LDAP tree.
|===

[[user-defined-name-mapping]]
=== User-Defined Name Mapping

A user-defined name mapping explicitly maps the names of {product-title} Groups to
unique identifiers that find groups on your LDAP server. The mapping uses normal
YAML syntax. A user-defined mapping can contain an entry for every group in your
LDAP server or only a subset of those groups. If there are groups on the LDAP
server that do not have a user-defined name mapping, the default behavior during
sync is to use the attribute specified as the Group's name.

.User-Defined Name Mapping
====
[source,yaml]
----
groupUIDNameMapping:
  ""cn=group1,ou=groups,dc=example,dc=com"": firstgroup
  ""cn=group2,ou=groups,dc=example,dc=com"": secondgroup
  ""cn=group3,ou=groups,dc=example,dc=com"": thirdgroup
----
====

[[running-ldap-sync]]
== Running LDAP Sync

Once you have created a xref:configuring-ldap-sync[sync configuration file],
then sync can begin. {product-title} allows administrators to perform a number of
different sync types with the same server.

[NOTE]
====
By default, all group synchronization or pruning operations are dry-run, so you
must set the `--confirm` flag on the `oc adm groups sync` command in order to make
changes to {product-title} group records.
====

To sync all groups from the LDAP server with {product-title}:

----
$ oc adm groups sync --sync-config=config.yaml --confirm
----

To sync all Groups already in {product-title} that correspond to groups in the
LDAP server specified in the configuration file:

----
$ oc adm groups sync --type=openshift --sync-config=config.yaml --confirm
----

To sync a subset of LDAP groups with {product-title}, you can use whitelist files,
blacklist files, or both:

[NOTE]
====
Any combination of blacklist files, whitelist files, or whitelist literals will
work; whitelist literals can be included directly in the command itself. This
applies to groups found on LDAP servers, as well as Groups already present in
{product-title}. Your files must contain one unique group identifier per line.
====

----
$ oc adm groups sync --whitelist=<whitelist_file> \\
                   --sync-config=config.yaml    \\
                   --confirm
$ oc adm groups sync --blacklist=<blacklist_file> \\
                   --sync-config=config.yaml    \\
                   --confirm
$ oc adm groups sync <group_unique_identifier>    \\
                   --sync-config=config.yaml    \\
                   --confirm
$ oc adm groups sync <group_unique_identifier>    \\
                   --whitelist=<whitelist_file> \\
                   --blacklist=<blacklist_file> \\
                   --sync-config=config.yaml    \\
                   --confirm
$ oc adm groups sync --type=openshift             \\
                   --whitelist=<whitelist_file> \\
                   --sync-config=config.yaml    \\
                   --confirm
----

[[running-a-group-pruning-job]]
== Running a Group Pruning Job

An administrator can also choose to remove groups from {product-title} records
if the records on the LDAP server that created them are no longer present. The
prune job will accept the same sync configuration file and white- or black-lists
as used for the sync job.

For example, if groups had previously been synchronized from LDAP using some
*_config.yaml_* file, and some of those groups no longer existed on the LDAP
server, the following command would determine which Groups in {product-title}
corresponded to the deleted groups in LDAP and then remove them from
{product-title}:

----
$ oc adm groups prune --sync-config=config.yaml --confirm
----

[[sync-examples]]
== Sync Examples

This section contains examples for the xref:sync-ldap-rfc-2307[RFC 2307],
xref:sync-ldap-active-directory[Active Directory], and
xref:sync-ldap-augmented-active-directory[augmented Active Directory] schemas.
All of the following examples synchronize a group named `admins` that has two
members: `Jane` and `Jim`. Each example explains:

* How the group and users are added to the LDAP server.
* What the LDAP sync configuration file looks like.
* What the resulting Group record in {product-title} will be after synchronization.

[NOTE]
====
These examples assume that all users are direct members of their respective
groups. Specifically, no groups have other groups as members. See
xref:sync-ldap-nested-example[Nested Membership Sync Example] for information on
how to sync nested groups.
====

[[sync-ldap-rfc-2307]]
=== RFC 2307

In the RFC 2307 schema, both users (Jane and Jim) and groups exist on the LDAP
server as first-class entries, and group membership is stored in attributes on
the group. The following snippet of `ldif` defines the users and group for this
schema:

.LDAP Entries Using RFC 2307 Schema: *_rfc2307.ldif_*
====
[source,ldif]
----
  dn: ou=users,dc=example,dc=com
  objectClass: organizationalUnit
  ou: users

  dn: cn=Jane,ou=users,dc=example,dc=com
  objectClass: person
  objectClass: organizationalPerson
  objectClass: inetOrgPerson
  cn: Jane
  sn: Smith
  displayName: Jane Smith
  mail: jane.smith@example.com

  dn: cn=Jim,ou=users,dc=example,dc=com
  objectClass: person
  objectClass: organizationalPerson
  objectClass: inetOrgPerson
  cn: Jim
  sn: Adams
  displayName: Jim Adams
  mail: jim.adams@example.com

  dn: ou=groups,dc=example,dc=com
  objectClass: organizationalUnit
  ou: groups

  dn: cn=admins,ou=groups,dc=example,dc=com <1>
  objectClass: groupOfNames
  cn: admins
  owner: cn=admin,dc=example,dc=com
  description: System Administrators
  member: cn=Jane,ou=users,dc=example,dc=com <2>
  member: cn=Jim,ou=users,dc=example,dc=com
----
<1> The group is a first-class entry in the LDAP server.
<2> Members of a group are listed with an identifying reference as attributes on
the group.
====

To sync this group, you must first create the configuration file. The
RFC 2307 schema requires you to provide an LDAP query definition for both user
and group entries, as well as the attributes with which to represent them in the
internal {product-title} records.

For clarity, the Group you create in {product-title} should use attributes other
than the distinguished name whenever possible for user- or administrator-facing
fields. For example, identify the users of a Group by their e-mail, and use the
name of the group as the common name. The following configuration file creates
these relationships:

[NOTE]
====
If using user-defined name mappings, your
xref:rfc2307-with-user-defined-name-mappings[configuration file] will differ.
====

.LDAP Sync Configuration Using RFC 2307 Schema: *_rfc2307_config.yaml_*
====
[source,yaml]
----
kind: LDAPSyncConfig
apiVersion: v1
url: ldap://LDAP_SERVICE_IP:389 <1>
insecure: false <2>
rfc2307:
    groupsQuery:
        baseDN: ""ou=groups,dc=example,dc=com""
        scope: sub
        derefAliases: never
        pageSize: 0
    groupUIDAttribute: dn <3>
    groupNameAttributes: [ cn ] <4>
    groupMembershipAttributes: [ member ] <5>
    usersQuery:
        baseDN: ""ou=users,dc=example,dc=com""
        scope: sub
        derefAliases: never
        pageSize: 0
    userUIDAttribute: dn <6>
    userNameAttributes: [ mail ] <7>
    tolerateMemberNotFoundErrors: false
    tolerateMemberOutOfScopeErrors: false
----
<1> The IP address and host of the LDAP server where this group's record is
stored.
<2> When `true`, no TLS connection is made to the server. When `false`, secure
LDAP (`ldaps://`) URLs connect using TLS, and insecure LDAP (`ldap://`) URLs are
upgraded to TLS.
<3> The attribute that uniquely identifies a group on the LDAP server.
You cannot specify `groupsQuery` filters when using DN for groupUIDAttribute.
For fine-grained filtering, use the
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelist / blacklist method].
<4> The attribute to use as the name of the Group.
<5> The attribute on the group that stores the membership information.
<6> The attribute that uniquely identifies a user on the LDAP server. You
cannot specify `usersQuery` filters when using DN for userUIDAttribute. For
fine-grained  filtering, use the
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelist / blacklist method].
<7> The attribute to use as the name of the user in the {product-title} Group record.
====

To run sync with the *_rfc2307_config.yaml_* file:

----
$ oc adm groups sync --sync-config=rfc2307_config.yaml --confirm
----

{product-title} creates the following Group record as a result of the above sync
operation:

.{product-title} Group Created Using *_rfc2307_config.yaml_*
====
[source,yaml]
----
apiVersion: user.openshift.io/v1
kind: Group
metadata:
  annotations:
    openshift.io/ldap.sync-time: 2015-10-13T10:08:38-0400 <1>
    openshift.io/ldap.uid: cn=admins,ou=groups,dc=example,dc=com <2>
    openshift.io/ldap.url: LDAP_SERVER_IP:389 <3>
  creationTimestamp:
  name: admins <4>
users: <5>
- jane.smith@example.com
- jim.adams@example.com
----
<1> The last time this Group was synchronized with the LDAP server, in ISO 6801
format.
<2> The unique identifier for the group on the LDAP server.
<3> The IP address and host of the LDAP server where this Group's record is
stored.
<4> The name of the Group as specified by the sync file.
<5> The users that are members of the Group, named as specified by the sync file.
====

[[rfc2307-with-user-defined-name-mappings]]
==== RFC2307 with User-Defined Name Mappings

When syncing groups with user-defined name mappings, the configuration file
changes to contain these mappings as shown below.

.LDAP Sync Configuration Using RFC 2307 Schema With User-Defined Name Mappings: *_rfc2307_config_user_defined.yaml_*
====
[source,yaml]
----
kind: LDAPSyncConfig
apiVersion: v1
groupUIDNameMapping:
  ""cn=admins,ou=groups,dc=example,dc=com"": Administrators <1>
rfc2307:
    groupsQuery:
        baseDN: ""ou=groups,dc=example,dc=com""
        scope: sub
        derefAliases: never
        pageSize: 0
    groupUIDAttribute: dn <2>
    groupNameAttributes: [ cn ] <3>
    groupMembershipAttributes: [ member ]
    usersQuery:
        baseDN: ""ou=users,dc=example,dc=com""
        scope: sub
        derefAliases: never
        pageSize: 0
    userUIDAttribute: dn <4>
    userNameAttributes: [ mail ]
    tolerateMemberNotFoundErrors: false
    tolerateMemberOutOfScopeErrors: false
----
<1> The user-defined name mapping.
<2> The unique identifier attribute that is used for the keys in the
user-defined name mapping. You cannot specify `groupsQuery` filters when using
DN for groupUIDAttribute. For fine-grained filtering, use the
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelist / blacklist method].
<3> The attribute to name {product-title} Groups with if their unique identifier is
not in the user-defined name mapping.
<4> The attribute that uniquely identifies a user on the LDAP server. You
cannot specify `usersQuery` filters when using DN for userUIDAttribute. For
fine-grained  filtering, use the
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelist / blacklist method].
====

To run sync with the *_rfc2307_config_user_defined.yaml_* file:

----
$ oc adm groups sync --sync-config=rfc2307_config_user_defined.yaml --confirm
----

{product-title} creates the following Group record as a result of the above sync
operation:

.{product-title} Group Created Using *_rfc2307_config_user_defined.yaml_*
====
[source,yaml]
----
apiVersion: user.openshift.io/v1
kind: Group
metadata:
  annotations:
    openshift.io/ldap.sync-time: 2015-10-13T10:08:38-0400
    openshift.io/ldap.uid: cn=admins,ou=groups,dc=example,dc=com
    openshift.io/ldap.url: LDAP_SERVER_IP:389
  creationTimestamp:
  name: Administrators <1>
users:
- jane.smith@example.com
- jim.adams@example.com
----
<1> The name of the Group as specified by the user-defined name mapping.
====

[[rfc2307-with-error-tolerances]]
=== RFC 2307 with User-Defined Error Tolerances

By default, if the groups being synced contain members whose entries are outside
of the scope defined in the member query, the group sync fails with an error:

----
Error determining LDAP group membership for ""<group>"": membership lookup for user ""<user>"" in group ""<group>"" failed because of ""search for entry with dn=""<user-dn>"" would search outside of the base dn specified (dn=""<base-dn>"")"".
----

This often indicates a mis-configured `baseDN` in the `usersQuery` field.
However, in cases where the `baseDN` intentionally does not contain some of the
members of the group, setting `tolerateMemberOutOfScopeErrors: true` allows
the group sync to continue. Out of scope members will be ignored.

Similarly, when the group sync process fails to locate a member for a group, it
fails outright with errors:

----
Error determining LDAP group membership for ""<group>"": membership lookup for user ""<user>"" in group ""<group>"" failed because of ""search for entry with base dn=""<user-dn>"" refers to a non-existent entry"".

Error determining LDAP group membership for ""<group>"": membership lookup for user ""<user>"" in group ""<group>"" failed because of ""search for entry with base dn=""<user-dn>"" and filter ""<filter>"" did not return any results"".
----

This often indicates a mis-configured `usersQuery` field. However, in cases
where the group contains member entries that are known to be missing, setting
`tolerateMemberNotFoundErrors: true` allows the group sync to continue.
Problematic members will be ignored.

[WARNING]
====
Enabling error tolerances for the LDAP group sync causes the sync process to
ignore problematic member entries. If the LDAP group sync is not configured
correctly, this could result in synced {product-title} groups missing members.
====

.LDAP Entries Using RFC 2307 Schema With Problematic Group Membership: *_rfc2307_problematic_users.ldif_*
====
[source,ldif]
----
  dn: ou=users,dc=example,dc=com
  objectClass: organizationalUnit
  ou: users

  dn: cn=Jane,ou=users,dc=example,dc=com
  objectClass: person
  objectClass: organizationalPerson
  objectClass: inetOrgPerson
  cn: Jane
  sn: Smith
  displayName: Jane Smith
  mail: jane.smith@example.com

  dn: cn=Jim,ou=users,dc=example,dc=com
  objectClass: person
  objectClass: organizationalPerson
  objectClass: inetOrgPerson
  cn: Jim
  sn: Adams
  displayName: Jim Adams
  mail: jim.adams@example.com

  dn: ou=groups,dc=example,dc=com
  objectClass: organizationalUnit
  ou: groups

  dn: cn=admins,ou=groups,dc=example,dc=com
  objectClass: groupOfNames
  cn: admins
  owner: cn=admin,dc=example,dc=com
  description: System Administrators
  member: cn=Jane,ou=users,dc=example,dc=com
  member: cn=Jim,ou=users,dc=example,dc=com
  member: cn=INVALID,ou=users,dc=example,dc=com <1>
  member: cn=Jim,ou=OUTOFSCOPE,dc=example,dc=com <2>
----
<1> A member that does not exist on the LDAP server.
<2> A member that may exist, but is not under the `baseDN` in the
user query for the sync job.
====

In order to tolerate the errors in the above example, the following additions to
your sync configuration file must be made:

.LDAP Sync Configuration Using RFC 2307 Schema Tolerating Errors: *_rfc2307_config_tolerating.yaml_*
====
[source,yaml]
----
kind: LDAPSyncConfig
apiVersion: v1
url: ldap://LDAP_SERVICE_IP:389
rfc2307:
    groupsQuery:
        baseDN: ""ou=groups,dc=example,dc=com""
        scope: sub
        derefAliases: never
    groupUIDAttribute: dn
    groupNameAttributes: [ cn ]
    groupMembershipAttributes: [ member ]
    usersQuery:
        baseDN: ""ou=users,dc=example,dc=com""
        scope: sub
        derefAliases: never
    userUIDAttribute: dn <3>
    userNameAttributes: [ mail ]
    tolerateMemberNotFoundErrors: true <1>
    tolerateMemberOutOfScopeErrors: true <2>
----
<1> When `true`, the sync job tolerates groups for which some members were not
found, and members whose LDAP entries are not found are ignored. The
default behavior for the sync job is to fail if a member of a group is not
found.
<2> When `true`, the sync job tolerates groups for which some members are outside
the user scope given in the `usersQuery` base DN, and members outside the member
query scope are ignored. The default behavior for the sync job is to fail if a
member of a group is out of scope.
<3> The attribute that uniquely identifies a user on the LDAP server. You
cannot specify `usersQuery` filters when using DN for userUIDAttribute. For
fine-grained  filtering, use the
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelist / blacklist method].
====

To run sync with the *_rfc2307_config_tolerating.yaml_* file:

----
$ oc adm groups sync --sync-config=rfc2307_config_tolerating.yaml --confirm
----

{product-title} creates the following group record as a result of the above sync
operation:

.{product-title} Group Created Using *_rfc2307_config.yaml_*
====
[source,yaml]
----
apiVersion: user.openshift.io/v1
kind: Group
metadata:
  annotations:
    openshift.io/ldap.sync-time: 2015-10-13T10:08:38-0400
    openshift.io/ldap.uid: cn=admins,ou=groups,dc=example,dc=com
    openshift.io/ldap.url: LDAP_SERVER_IP:389
  creationTimestamp:
  name: admins
users: <1>
- jane.smith@example.com
- jim.adams@example.com
----
<1> The users that are members of the group, as specified by the sync file.
Members for which lookup encountered tolerated errors are absent.
====

[[sync-ldap-active-directory]]
=== Active Directory

In the Active Directory schema, both users (Jane and Jim) exist in the LDAP
server as first-class entries, and group membership is stored in attributes on
the user. The following snippet of `ldif` defines the users and group for this
schema:

.LDAP Entries Using Active Directory Schema: *_active_directory.ldif_*
====
[source,ldif]
----
dn: ou=users,dc=example,dc=com
objectClass: organizationalUnit
ou: users

dn: cn=Jane,ou=users,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: testPerson
cn: Jane
sn: Smith
displayName: Jane Smith
mail: jane.smith@example.com
memberOf: admins <1>

dn: cn=Jim,ou=users,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: testPerson
cn: Jim
sn: Adams
displayName: Jim Adams
mail: jim.adams@example.com
memberOf: admins
----
<1> The user's group memberships are listed as attributes on the user, and the
group does not exist as an entry on the server. The `memberOf` attribute does
not have to be a literal attribute on the user; in some LDAP servers, it is created
during search and returned to the client, but not committed to the database.
====

To sync this group, you must first create the configuration file. The
Active Directory schema requires you to provide an LDAP query definition for
user entries, as well as the attributes to represent them with in the internal
{product-title} Group records.

For clarity, the Group you create in {product-title} should use attributes other
than the distinguished name whenever possible for user- or administrator-facing
fields. For example, identify the users of a Group by their e-mail, but define
the name of the Group by the name of the group on the LDAP server.
The following configuration file creates these relationships:

.LDAP Sync Configuration Using Active Directory Schema: *_active_directory_config.yaml_*
====
[source,yaml]
----
kind: LDAPSyncConfig
apiVersion: v1
url: ldap://LDAP_SERVICE_IP:389
activeDirectory:
    usersQuery:
        baseDN: ""ou=users,dc=example,dc=com""
        scope: sub
        derefAliases: never
        filter: (objectclass=inetOrgPerson)
        pageSize: 0
    userNameAttributes: [ mail ] <1>
    groupMembershipAttributes: [ memberOf ] <2>
----
<1> The attribute to use as the name of the user in the {product-title} Group record.
<2> The attribute on the user that stores the membership information.
====

To run sync with the *_active_directory_config.yaml_* file:

----
$ oc adm groups sync --sync-config=active_directory_config.yaml --confirm
----

{product-title} creates the following Group record as a result of the above sync
operation:

.{product-title} Group Created Using *_active_directory_config.yaml_*
====
[source,yaml]
----
apiVersion: user.openshift.io/v1
kind: Group
metadata:
  annotations:
    openshift.io/ldap.sync-time: 2015-10-13T10:08:38-0400 <1>
    openshift.io/ldap.uid: admins <2>
    openshift.io/ldap.url: LDAP_SERVER_IP:389 <3>
  creationTimestamp:
  name: admins <4>
users: <5>
- jane.smith@example.com
- jim.adams@example.com
----
<1> The last time this Group was synchronized with the LDAP server, in ISO 6801
format.
<2> The unique identifier for the group on the LDAP server.
<3> The IP address and host of the LDAP server where this Group's record is
stored.
<4> The name of the group as listed in the LDAP server.
<5> The users that are members of the Group, named as specified by the sync
file.
====

[[sync-ldap-augmented-active-directory]]
=== Augmented Active Directory

In the augmented Active Directory schema, both users (Jane and Jim) and groups
exist in the LDAP server as first-class entries, and group membership is stored
in attributes on the user. The following snippet of `ldif` defines the users and
group for this schema:

.LDAP Entries Using Augmented Active Directory Schema: *_augmented_active_directory.ldif_*
====
[source,ldif]
----
dn: ou=users,dc=example,dc=com
objectClass: organizationalUnit
ou: users

dn: cn=Jane,ou=users,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: testPerson
cn: Jane
sn: Smith
displayName: Jane Smith
mail: jane.smith@example.com
memberOf: cn=admins,ou=groups,dc=example,dc=com <1>

dn: cn=Jim,ou=users,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: testPerson
cn: Jim
sn: Adams
displayName: Jim Adams
mail: jim.adams@example.com
memberOf: cn=admins,ou=groups,dc=example,dc=com

dn: ou=groups,dc=example,dc=com
objectClass: organizationalUnit
ou: groups

dn: cn=admins,ou=groups,dc=example,dc=com <2>
objectClass: groupOfNames
cn: admins
owner: cn=admin,dc=example,dc=com
description: System Administrators
member: cn=Jane,ou=users,dc=example,dc=com
member: cn=Jim,ou=users,dc=example,dc=com
----
<1> The user's group memberships are listed as attributes on the user.
<2> The group is a first-class entry on the LDAP server.
====

To sync this group, you must first create the configuration file. The
augmented Active Directory schema requires you to provide an LDAP query
definition for both user entries and group entries, as well as the attributes
with which to represent them in the internal {product-title} Group records.

For clarity, the Group you create in {product-title} should use attributes other
than the distinguished name whenever possible for user- or administrator-facing
fields. For example, identify the users of a Group by their e-mail,
and use the name of the Group as the common name. The following configuration
file creates these relationships.

.LDAP Sync Configuration Using Augmented Active Directory Schema: *_augmented_active_directory_config.yaml_*
====
[source,yaml]
----
kind: LDAPSyncConfig
apiVersion: v1
url: ldap://LDAP_SERVICE_IP:389
augmentedActiveDirectory:
    groupsQuery:
        baseDN: ""ou=groups,dc=example,dc=com""
        scope: sub
        derefAliases: never
        pageSize: 0
    groupUIDAttribute: dn <1>
    groupNameAttributes: [ cn ] <2>
    usersQuery:
        baseDN: ""ou=users,dc=example,dc=com""
        scope: sub
        derefAliases: never
        pageSize: 0
    userNameAttributes: [ mail ] <3>
    groupMembershipAttributes: [ memberOf ] <4>
----
<1> The attribute that uniquely identifies a group on the LDAP server. You
cannot specify `groupsQuery` filters when using DN for groupUIDAttribute. For
fine-grained filtering, use the
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelist / blacklist method].
<2> The attribute to use as the name of the Group.
<3> The attribute to use as the name of the user in the {product-title} Group record.
<4> The attribute on the user that stores the membership information.
====

To run sync with the *_augmented_active_directory_config.yaml_* file:

----
$ oc adm groups sync --sync-config=augmented_active_directory_config.yaml --confirm
----

{product-title} creates the following Group record as a result of the above sync
operation:

.OpenShift Group Created Using *_augmented_active_directory_config.yaml_*
====
[source,yaml]
----
apiVersion: user.openshift.io/v1
kind: Group
metadata:
  annotations:
    openshift.io/ldap.sync-time: 2015-10-13T10:08:38-0400 <1>
    openshift.io/ldap.uid: cn=admins,ou=groups,dc=example,dc=com <2>
    openshift.io/ldap.url: LDAP_SERVER_IP:389 <3>
  creationTimestamp:
  name: admins <4>
users: <5>
- jane.smith@example.com
- jim.adams@example.com
----
<1> The last time this Group was synchronized with the LDAP server, in ISO 6801 format.
<2> The unique identifier for the group on the LDAP server.
<3> The IP address and host of the LDAP server where this Group's record is stored.
<4> The name of the Group as specified by the sync file.
<5> The users that are members of the Group, named as specified by the sync file.
====

[[sync-ldap-nested-example]]
== Nested Membership Sync Example

Groups in {product-title} do not nest. The LDAP server must flatten group
membership before the data can be consumed. Microsoft's Active Directory Server
supports this feature via the
link:https://msdn.microsoft.com/en-us/library/aa746475(v=vs.85).aspx[`LDAP_MATCHING_RULE_IN_CHAIN`]
rule, which has the OID `1.2.840.113556.1.4.1941`. Furthermore, only explicitly
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelisted]
groups can be synced when using this matching rule.

This section has an example for the augmented Active Directory schema, which
synchronizes a group named `admins` that has one user `Jane` and one group
`otheradmins` as members. The `otheradmins` group has one user member: `Jim`.
This example explains:

* How the group and users are added to the LDAP server.
* What the LDAP sync configuration file looks like.
* What the resulting Group record in {product-title} will be after synchronization.

In the augmented Active Directory schema, both users (`Jane` and `Jim`) and
groups exist in the LDAP server as first-class entries, and group membership is
stored in attributes on the user or the group. The following snippet of `ldif`
defines the users and groups for this schema:

.LDAP Entries Using Augmented Active Directory Schema With Nested Members: *_augmented_active_directory_nested.ldif_*
[source,ldif]
----
dn: ou=users,dc=example,dc=com
objectClass: organizationalUnit
ou: users

dn: cn=Jane,ou=users,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: testPerson
cn: Jane
sn: Smith
displayName: Jane Smith
mail: jane.smith@example.com
memberOf: cn=admins,ou=groups,dc=example,dc=com <1>

dn: cn=Jim,ou=users,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: testPerson
cn: Jim
sn: Adams
displayName: Jim Adams
mail: jim.adams@example.com
memberOf: cn=otheradmins,ou=groups,dc=example,dc=com <1>

dn: ou=groups,dc=example,dc=com
objectClass: organizationalUnit
ou: groups

dn: cn=admins,ou=groups,dc=example,dc=com <2>
objectClass: group
cn: admins
owner: cn=admin,dc=example,dc=com
description: System Administrators
member: cn=Jane,ou=users,dc=example,dc=com
member: cn=otheradmins,ou=groups,dc=example,dc=com

dn: cn=otheradmins,ou=groups,dc=example,dc=com <2>
objectClass: group
cn: otheradmins
owner: cn=admin,dc=example,dc=com
description: Other System Administrators
memberOf: cn=admins,ou=groups,dc=example,dc=com <1> <3>
member: cn=Jim,ou=users,dc=example,dc=com
----
<1> The user's and group's memberships are listed as attributes on the object.
<2> The groups are first-class entries on the LDAP server.
<3> The `otheradmins` group is a member of the `admins` group.

To sync nested groups with Active Directory, you must provide an LDAP query
definition for both user entries and group entries, as well as the attributes
with which to represent them in the internal {product-title} Group records.
Furthermore, certain changes are required in this configuration:

- The `oc adm groups sync` command must explicitly
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelist]
groups.
- The user's `groupMembershipAttributes` must include
`""memberOf:1.2.840.113556.1.4.1941:""` to comply with the
https://msdn.microsoft.com/en-us/library/aa746475(v=vs.85).aspx[`LDAP_MATCHING_RULE_IN_CHAIN`]
rule.
- The `groupUIDAttribute` must be set to `dn`.
- The `groupsQuery`:
  * Must not set `filter`.
  * Must set a valid `derefAliases`.
  * Should not set `baseDN` as that value is ignored.
  * Should not set `scope` as that value is ignored.

For clarity, the Group you create in {product-title} should use attributes other
than the distinguished name whenever possible for user- or administrator-facing
fields. For example, identify the users of a Group by their e-mail, and use the
name of the Group as the common name. The following configuration file creates
these relationships:

.LDAP Sync Configuration Using Augmented Active Directory Schema With Nested Members: *_augmented_active_directory_config_nested.yaml_*
[source,yaml]
----
kind: LDAPSyncConfig
apiVersion: v1
url: ldap://LDAP_SERVICE_IP:389
augmentedActiveDirectory:
    groupsQuery: <1>
        derefAliases: never
        pageSize: 0
    groupUIDAttribute: dn <2>
    groupNameAttributes: [ cn ] <3>
    usersQuery:
        baseDN: ""ou=users,dc=example,dc=com""
        scope: sub
        derefAliases: never
        filter: (objectclass=inetOrgPerson)
        pageSize: 0
    userNameAttributes: [ mail ] <4>
    groupMembershipAttributes: [ ""memberOf:1.2.840.113556.1.4.1941:"" ] <5>
----
<1> `groupsQuery` filters cannot be specified. The `groupsQuery` base DN and scope
values are ignored. `groupsQuery` must set a valid `derefAliases`.
<2> The attribute that uniquely identifies a group on the LDAP server. It must be set to `dn`.
<3> The attribute to use as the name of the Group.
<4> The attribute to use as the name of the user in the {product-title} Group
record. `mail` or `sAMAccountName` are preferred choices in most installations.
<5> The attribute on the user that stores the membership information. Note the use
of https://msdn.microsoft.com/en-us/library/aa746475(v=vs.85).aspx[`LDAP_MATCHING_RULE_IN_CHAIN`].

To run sync with the *_augmented_active_directory_config_nested.yaml_* file:

----
$ oc adm groups sync \\
    'cn=admins,ou=groups,dc=example,dc=com' \\
    --sync-config=augmented_active_directory_config_nested.yaml \\
    --confirm
----

[NOTE]
====
You must explicitly
xref:../install_config/syncing_groups_with_ldap.adoc#running-ldap-sync[whitelist]
the `cn=admins,ou=groups,dc=example,dc=com` group.
====

{product-title} creates the following Group record as a result of the above sync
operation:

.OpenShift Group Created Using *_augmented_active_directory_config_nested.yaml_*
[source,yaml]
----
apiVersion: user.openshift.io/v1
kind: Group
metadata:
  annotations:
    openshift.io/ldap.sync-time: 2015-10-13T10:08:38-0400 <1>
    openshift.io/ldap.uid: cn=admins,ou=groups,dc=example,dc=com <2>
    openshift.io/ldap.url: LDAP_SERVER_IP:389 <3>
  creationTimestamp:
  name: admins <4>
users: <5>
- jane.smith@example.com
- jim.adams@example.com
----
<1> The last time this Group was synchronized with the LDAP server, in ISO 6801 format.
<2> The unique identifier for the group on the LDAP server.
<3> The IP address and host of the LDAP server where this Group's record is stored.
<4> The name of the Group as specified by the sync file.
<5> The users that are members of the Group, named as specified by the sync file.
Note that members of nested groups are included since the group membership was
flattened by the Microsoft Active Directory Server.

[[sync-ldap-configuration]]
== LDAP Sync Configuration Specification

The object specification for the configuration file is below.  Note that the different schema
objects have different fields.  For example, xref:sync-ldap-v1-activedirectoryconfig[v1.ActiveDirectoryConfig] has no `groupsQuery`
field whereas xref:sync-ldap-v1-rfc2307config[v1.RFC2307Config] and xref:sync-ldap-v1-augmentedactivedirectoryconfig[v1.AugmentedActiveDirectoryConfig] both do.

[IMPORTANT]
====
There is no support for binary attributes. All attribute data coming from the
LDAP server must be in the format of a UTF-8 encoded string. For example, never
use a binary attribute, such as `objectGUID`, as an ID attribute. You must use
string attributes, such as `sAMAccountName` or `userPrincipalName`, instead.
====

[[sync-ldap-v1-ldapsyncconfig]]
=== v1.LDAPSyncConfig

`LDAPSyncConfig` holds the necessary configuration options to define an LDAP
group sync.

[options=""header""]
|===
|Name |Description |Schema

|`kind`
|String value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: link:https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#types-kinds[]
|string

|`apiVersion`
|Defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: link:https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#resources[]
|string

|`url`
|Host is the scheme, host and port of the LDAP server to connect to: `scheme://host:port`
|string

|`bindDN`
|Optional DN to bind to the LDAP server with.
|string

|`bindPassword`
|Optional password to bind with during the search phase. |xref:sync-ldap-v1-stringsource[v1.StringSource]

|`insecure`
|If `true`, indicates the connection should not use TLS. Cannot be set to true with a URL scheme of `ldaps://` If `false`, `ldaps://` URLs connect using TLS, and `ldap://` URLs are upgraded to a TLS connection using StartTLS as specified in link:https://tools.ietf.org/html/rfc2830[].
|boolean

|`ca`
|Optional trusted certificate authority bundle to use when making requests to the server. If empty, the default system roots are used.
|string

|`groupUIDNameMapping`
|Optional direct mapping of LDAP group UIDs to {product-title} Group names.
|object

|`rfc2307`
|Holds the configuration for extracting data from an LDAP server set up in a fashion similar to RFC2307: first-class group and user entries, with group membership determined by a multi-valued attribute on the group entry listing its members.
|xref:sync-ldap-v1-rfc2307config[v1.RFC2307Config]

|`activeDirectory`
|Holds the configuration for extracting data from an LDAP server set up in a fashion similar to that used in Active Directory: first-class user entries, with group membership determined by a multi-valued attribute on members listing groups they are a member of.
|xref:sync-ldap-v1-activedirectoryconfig[v1.ActiveDirectoryConfig]

|`augmentedActiveDirectory`
|Holds the configuration for extracting data from an LDAP server set up in a fashion similar to that used in Active Directory as described above, with one addition: first-class group entries exist and are used to hold metadata but not group membership.
|xref:sync-ldap-v1-augmentedactivedirectoryconfig[v1.AugmentedActiveDirectoryConfig]
|===

[[sync-ldap-v1-stringsource]]
=== v1.StringSource

`StringSource` allows specifying a string inline, or externally via environment
variable or file. When it contains only a string value, it marshals to a simple
JSON string.

[options=""header""]
|===
|Name |Description |Schema

|`value`
|Specifies the cleartext value, or an encrypted value if `keyFile` is specified.
|string

|`env`
|Specifies an environment variable containing the cleartext value, or an
encrypted value if the `keyFile` is specified.
|string

|`file`
|References a file containing the cleartext value, or an encrypted value if a `keyFile` is specified.
|string

|`keyFile`
|References a file containing the key to use to decrypt the value.
|string
|===

[[sync-ldap-v1-ldapquery]]
=== v1.LDAPQuery

`LDAPQuery` holds the options necessary to build an LDAP query.

[options=""header""]
|===
|Name |Description |Schema

|`baseDN`
|DN of the branch of the directory where all searches should start from.
|string

|`scope`
|The (optional) scope of the search. Can be `base` (only the base object), `one`
(all objects on the base level), `sub` (the entire subtree). Defaults to `sub`
if not set.
|string

|`derefAliases`
|The (optional) behavior of the search with regards to alisases. Can be `never`
(never dereference aliases), `search` (only dereference in searching), `base`
(only dereference in finding the base object), `always` (always dereference).
Defaults to `always` if not set.
|string

|`timeout`
|Holds the limit of time in seconds that any request to the server can remain outstanding before the wait for a response is given up. If this is `0`, no client-side limit is imposed.
|integer

|`filter`
|A valid LDAP search filter that retrieves all relevant entries from the LDAP server with the base DN.
|string

|`pageSize`
|Maximum preferred page size, measured in LDAP entries. A page size of `0` means no paging will be done.
|integer
|===

[[sync-ldap-v1-rfc2307config]]
=== v1.RFC2307Config

`RFC2307Config` holds the necessary configuration options to define how an LDAP
group sync interacts with an LDAP server using the RFC2307 schema.

[options=""header""]
|===
|Name |Description |Schema

|`groupsQuery`
|Holds the template for an LDAP query that returns group entries.
|xref:sync-ldap-v1-ldapquery[v1.LDAPQuery]

|`groupUIDAttribute`
|Defines which attribute on an LDAP group entry will be interpreted as its unique identifier. (`ldapGroupUID`)
|string

|`groupNameAttributes`
|Defines which attributes on an LDAP group entry will be interpreted as its name to use for an {product-title} group.
|string array

|`groupMembershipAttributes`
|Defines which attributes on an LDAP group entry will be interpreted as its members. The values contained in those attributes must be queryable by your `UserUIDAttribute`.
|string array

|`usersQuery`
|Holds the template for an LDAP query that returns user entries.
|xref:sync-ldap-v1-ldapquery[v1.LDAPQuery]

|`userUIDAttribute`
|Defines which attribute on an LDAP user entry will be interpreted as its unique identifier. It must correspond to values that will be found from the `GroupMembershipAttributes`.
|string

|`userNameAttributes`
|Defines which attributes on an LDAP user entry will be used, in order, as its {product-title} user name. The first attribute with a non-empty value is used. This should match your `PreferredUsername` setting for your `LDAPPasswordIdentityProvider`. The attribute to use as the name of the user in the {product-title} Group
record. `mail` or `sAMAccountName` are preferred choices in most installations.
|string array

|`tolerateMemberNotFoundErrors`
|Determines the behavior of the LDAP sync job when missing user entries are encountered. If `true`, an LDAP query for users that does not find any will be tolerated and an only and error will be logged. If `false`, the LDAP sync job will fail if a query for users doesn't find any. The default value is 'false'. Misconfigured LDAP sync jobs with this flag set to 'true' can cause group membership to be removed, so it is recommended to use this flag with caution.
|boolean

|`tolerateMemberOutOfScopeErrors`
|Determines the behavior of the LDAP sync job when out-of-scope user entries are encountered. If `true`, an LDAP query for a user that falls outside of the base DN given for the all user query will be tolerated and only an error will be logged. If `false`, the LDAP sync job will fail if a user query would search outside of the base DN specified by the all user query. Misconfigured LDAP sync jobs with this flag set to `true` can result in groups missing users, so it is recommended to use this flag with caution.
|boolean
|===

[[sync-ldap-v1-activedirectoryconfig]]
=== v1.ActiveDirectoryConfig

`ActiveDirectoryConfig` holds the necessary configuration options to define how
an LDAP group sync interacts with an LDAP server using the Active Directory
schema.

[options=""header""]
|===
|Name |Description |Schema

|`usersQuery`
|Holds the template for an LDAP query that returns user entries.
|xref:sync-ldap-v1-ldapquery[v1.LDAPQuery]

|`userNameAttributes`
|Defines which attributes on an LDAP user entry will be interpreted as its {product-title} user name. The attribute to use as the name of the user in the {product-title} Group
record. `mail` or `sAMAccountName` are preferred choices in most installations.
|string array

|`groupMembershipAttributes`
|Defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of.
|string array
|===

[[sync-ldap-v1-augmentedactivedirectoryconfig]]
=== v1.AugmentedActiveDirectoryConfig

`AugmentedActiveDirectoryConfig` holds the necessary configuration options to
define how an LDAP group sync interacts with an LDAP server using the augmented
Active Directory schema.

[options=""header""]
|===
|Name |Description |Schema

|`usersQuery`
|Holds the template for an LDAP query that returns user entries.
|xref:sync-ldap-v1-ldapquery[v1.LDAPQuery]

|`userNameAttributes`
|Defines which attributes on an LDAP user entry will be interpreted as its {product-title} user name. The attribute to use as the name of the user in the {product-title} Group
record. `mail` or `sAMAccountName` are preferred choices in most installations.
|string array

|`groupMembershipAttributes`
|Defines which attributes on an LDAP user entry will be interpreted as the groups it is a member of.
|string array

|`groupsQuery`
|Holds the template for an LDAP query that returns group entries.
|xref:sync-ldap-v1-ldapquery[v1.LDAPQuery]

|`groupUIDAttribute`
|Defines which attribute on an LDAP group entry will be interpreted as its unique identifier. (`ldapGroupUID`)
|string

|`groupNameAttributes`
|Defines which attributes on an LDAP group entry will be interpreted as its name to use for an {product-title} group.
|string array
|===
",12071,True,2598.4704312154895,median
"/*
   +----------------------------------------------------------------------+
   | HipHop for PHP                                                       |
   +----------------------------------------------------------------------+
   | Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com)  |
   | Copyright (c) 1997-2010 The PHP Group                                |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | http://www.php.net/license/3_01.txt                                  |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
*/

#include ""hphp/runtime/ext/std/ext_std_file.h""

#include ""hphp/util/hphp-config.h""
#include ""hphp/runtime/base/array-init.h""
#include ""hphp/runtime/base/array-util.h""
#include ""hphp/runtime/base/comparisons.h""
#include ""hphp/runtime/base/directory.h""
#include ""hphp/runtime/base/file-stream-wrapper.h""
#include ""hphp/runtime/base/file-util.h""
#include ""hphp/runtime/base/http-client.h""
#include ""hphp/runtime/base/http-stream-wrapper.h""
#include ""hphp/runtime/base/ini-setting.h""
#include ""hphp/runtime/base/actrec-args.h""
#include ""hphp/runtime/base/pipe.h""
#include ""hphp/runtime/base/plain-file.h""
#include ""hphp/runtime/base/temp-file.h""
#include ""hphp/runtime/base/request-local.h""
#include ""hphp/runtime/base/runtime-error.h""
#include ""hphp/runtime/base/runtime-option.h""
#include ""hphp/runtime/base/stat-cache.h""
#include ""hphp/runtime/base/stream-wrapper-registry.h""
#include ""hphp/runtime/base/string-util.h""
#include ""hphp/runtime/base/thread-info.h""
#include ""hphp/runtime/base/user-stream-wrapper.h""
#include ""hphp/runtime/base/zend-scanf.h""
#include ""hphp/runtime/ext/hash/ext_hash.h""
#if ENABLE_EXTENSION_POSIX
#include ""hphp/runtime/ext/posix/ext_posix.h""
#endif
#include ""hphp/runtime/ext/std/ext_std_options.h""
#include ""hphp/runtime/ext/string/ext_string.h""
#include ""hphp/runtime/server/cli-server.h""
#include ""hphp/runtime/server/static-content-cache.h""
#include ""hphp/system/systemlib.h""
#include ""hphp/util/logger.h""
#include ""hphp/util/process.h""

#include <folly/String.h>
#include <folly/portability/Dirent.h>
#include <folly/portability/SysFile.h>

#include <sys/types.h>

#ifndef _MSC_VER
#include <glob.h>
#if defined(__FreeBSD__) || defined(__APPLE__)
# include <sys/mount.h>
#else
# include <sys/vfs.h>
#endif
#include <utime.h>
#include <grp.h>
#include <pwd.h>
#include <fnmatch.h>
#endif

#include <boost/algorithm/string/predicate.hpp>
#include <boost/filesystem.hpp>
#include <vector>

namespace fs = boost::filesystem;

#define CHECK_HANDLE_BASE(handle, f, ret)               \\
  auto f = dyn_cast_or_null<File>(handle);              \\
  if (f == nullptr || f->isClosed()) {                  \\
    raise_warning(""Not a valid stream resource"");       \\
    return (ret);                                       \\
  }                                                     \\

#define CHECK_HANDLE(handle, f) \\
  CHECK_HANDLE_BASE(handle, f, false)
#define CHECK_HANDLE_RET_NULL(handle, f) \\
  CHECK_HANDLE_BASE(handle, f, uninit_variant)

#define CHECK_PATH_BASE(p, i, ret) \\
  if (p.size() != strlen(p.data())) { \\
    raise_warning( \\
      ""%s() expects parameter %d to be a valid path, string given"", \\
      __FUNCTION__ + 2, i \\
    ); \\
    return (ret); \\
  }

#define CHECK_PATH(p, i) \\
  CHECK_PATH_BASE(p, i, uninit_variant)
#define CHECK_PATH_FALSE(p, i) \\
  CHECK_PATH_BASE(p, i, false)

#define CHECK_SYSTEM(exp)                                 \\
  if ((exp) != 0) {                                       \\
    raise_warning(                                        \\
      ""%s(): %s"",                                         \\
       __FUNCTION__ + 2,                                  \\
       folly::errnoStr(errno).c_str()                     \\
    );                                                    \\
    return false;                                         \\
  }                                                       \\

#define CHECK_SYSTEM_SILENT(exp)                          \\
  if ((exp) != 0) {                                       \\
    Logger::Verbose(""%s/%d: %s"", __FUNCTION__, __LINE__,  \\
                    folly::errnoStr(errno).c_str());      \\
    return false;                                         \\
  }                                                       \\

#define CHECK_BOOST(dest, func, path)                     \\
  boost::system::error_code ec;                           \\
  dest = func(path.toCppString(), ec);                    \\
  if (ec) {                                               \\
    raise_warning(                                        \\
      ""%s(): %s"",                                         \\
      __FUNCTION__ + 2,                                   \\
      ec.message().c_str()                                \\
    );                                                    \\
    return false;                                         \\
  }                                                       \\

#define CHECK_BOOST_SILENT(dest, func, path)              \\
  boost::system::error_code ec;                           \\
  dest = func(path.toCppString(), ec);                    \\
  if (ec) {                                               \\
    Logger::Verbose(""%s/%d: %s"", __FUNCTION__, __LINE__,  \\
      ec.message().c_str()                                \\
    );                                                    \\
    return false;                                         \\
  }                                                       \\

#define CHECK_BOOST_ASSIGN(func, path, arg)               \\
  boost::system::error_code ec;                           \\
  func(path.toCppString(), arg, ec);                      \\
  if (ec) {                                               \\
    raise_warning(                                        \\
      ""%s(): %s"",                                         \\
      __FUNCTION__ + 2,                                   \\
      ec.message().c_str()                                \\
    );                                                    \\
    return false;                                         \\
  }                                                       \\

// libxml/xpathInternals.h defines CHECK_ERROR,
// we need to undef it first
#ifdef CHECK_ERROR
#undef CHECK_ERROR
#endif
#define CHECK_ERROR(ret)                                 \\
  check_error(__FUNCTION__, __LINE__, (ret))

namespace HPHP {

static const StaticString s_STREAM_URL_STAT_LINK(""STREAM_URL_STAT_LINK"");
static const StaticString s_STREAM_URL_STAT_QUIET(""STREAM_URL_STAT_QUIET"");

///////////////////////////////////////////////////////////////////////////////
// helpers

static bool check_error(const char *function, int line, bool ret) {
  if (!ret) {
    Logger::Verbose(""%s/%d: %s"", function, line,
                    folly::errnoStr(errno).c_str());
  }
  return ret;
}

static int accessSyscall(
    const String& uri_or_path,
    int mode,
    bool useFileCache = false) {
  Stream::Wrapper* w = Stream::getWrapperFromURI(uri_or_path);
  if (!w) return -1;

  if (useFileCache && dynamic_cast<FileStreamWrapper*>(w)) {
    String path(uri_or_path);
    if (UNLIKELY(StringUtil::IsFileUrl(uri_or_path.data()))) {
      path = StringUtil::DecodeFileUrl(uri_or_path);
      if (path.empty()) {
        return -1;
      }
    }
    return ::access(File::TranslatePathWithFileCache(path).data(), mode);
  }
  return w->access(uri_or_path, mode);
}

static int statSyscall(
    const String& path,
    struct stat* buf,
    bool useFileCache = false) {
  bool isRelative = !FileUtil::isAbsolutePath(path.slice());
  int pathIndex = 0;
  Stream::Wrapper* w = Stream::getWrapperFromURI(path, &pathIndex);
  if (!w) return -1;
  bool isFileStream = dynamic_cast<FileStreamWrapper*>(w);
  auto canUseFileCache = useFileCache && isFileStream;
  if (isRelative && !pathIndex) {
    auto fullpath = g_context->getCwd() + String::FromChar('/') + path;
    if (!RID().hasSafeFileAccess() && !canUseFileCache) {
      if (strlen(fullpath.data()) != fullpath.size()) return ENOENT;
      if (!isFileStream && w->isNormalFileStream()) {
        return w->stat(fullpath.data(), buf);
      }
      return ::stat(fullpath.data(), buf);
    }
    std::string realpath = StatCache::realpath(fullpath.data());
    // realpath will return an empty string for nonexistent files
    if (realpath.empty()) {
      return ENOENT;
    }
    auto translatedPath = canUseFileCache ?
      File::TranslatePathWithFileCache(realpath) :
      File::TranslatePath(realpath);
    if (!isFileStream && w->isNormalFileStream()) {
      return w->stat(translatedPath.data(), buf);
    }
    return ::stat(translatedPath.data(), buf);
  }

  auto properPath = w->isNormalFileStream() ? path.substr(pathIndex) : path;
  if (canUseFileCache) {
    return ::stat(File::TranslatePathWithFileCache(properPath).data(), buf);
  }
  return w->stat(properPath, buf);
}

static int lstatSyscall(
    const String& path,
    struct stat* buf,
    bool useFileCache = false) {
  Stream::Wrapper* w = Stream::getWrapperFromURI(path);
  if (!w) return -1;
  if (useFileCache && dynamic_cast<FileStreamWrapper*>(w)) {
    return ::lstat(File::TranslatePathWithFileCache(path).data(), buf);
  }
  return w->lstat(path, buf);
}

const StaticString
  s_dev(""dev""),
  s_ino(""ino""),
  s_mode(""mode""),
  s_nlink(""nlink""),
  s_uid(""uid""),
  s_gid(""gid""),
  s_rdev(""rdev""),
  s_size(""size""),
  s_atime(""atime""),
  s_mtime(""mtime""),
  s_ctime(""ctime""),
  s_blksize(""blksize""),
  s_blocks(""blocks"");

Array stat_impl(struct stat *stat_sb) {
  ArrayInit ret(26, ArrayInit::Mixed{});
  ret.append((int64_t)stat_sb->st_dev);
  ret.append((int64_t)stat_sb->st_ino);
  ret.append((int64_t)stat_sb->st_mode);
  ret.append((int64_t)stat_sb->st_nlink);
  ret.append((int64_t)stat_sb->st_uid);
  ret.append((int64_t)stat_sb->st_gid);
  ret.append((int64_t)stat_sb->st_rdev);
  ret.append((int64_t)stat_sb->st_size);
  ret.append((int64_t)stat_sb->st_atime);
  ret.append((int64_t)stat_sb->st_mtime);
  ret.append((int64_t)stat_sb->st_ctime);
#ifndef _MSC_VER
  ret.append((int64_t)stat_sb->st_blksize);
  ret.append((int64_t)stat_sb->st_blocks);
#endif
  ret.set(s_dev,     (int64_t)stat_sb->st_dev);
  ret.set(s_ino,     (int64_t)stat_sb->st_ino);
  ret.set(s_mode,    (int64_t)stat_sb->st_mode);
  ret.set(s_nlink,   (int64_t)stat_sb->st_nlink);
  ret.set(s_uid,     (int64_t)stat_sb->st_uid);
  ret.set(s_gid,     (int64_t)stat_sb->st_gid);
  ret.set(s_rdev,    (int64_t)stat_sb->st_rdev);
  ret.set(s_size,    (int64_t)stat_sb->st_size);
  ret.set(s_atime,   (int64_t)stat_sb->st_atime);
  ret.set(s_mtime,   (int64_t)stat_sb->st_mtime);
  ret.set(s_ctime,   (int64_t)stat_sb->st_ctime);
#ifndef _MSC_VER
  ret.set(s_blksize, (int64_t)stat_sb->st_blksize);
  ret.set(s_blocks,  (int64_t)stat_sb->st_blocks);
#endif
  return ret.toArray();
}

///////////////////////////////////////////////////////////////////////////////

Variant HHVM_FUNCTION(fopen,
                      const String& filename,
                      const String& mode,
                      bool use_include_path /* = false */,
                      const Variant& context /* = null */) {
  CHECK_PATH_FALSE(filename, 1);
  if (!context.isNull() && dyn_cast<StreamContext>(context) == nullptr) {
    raise_warning(""$context must be a valid Stream Context or NULL"");
    return false;
  }
  if (filename.empty()) {
    raise_warning(""Filename cannot be empty"");
    return false;
  }

  auto file = File::Open(filename, mode,
                         use_include_path ? File::USE_INCLUDE_PATH : 0,
                         cast_or_null<StreamContext>(context));
  if (!file) {
    return false;
  }
  return Variant(file);
}

Variant HHVM_FUNCTION(popen,
                      const String& command,
                      const String& mode) {
  CHECK_PATH_FALSE(command, 1);
  auto file = req::make<Pipe>();
  bool ret = CHECK_ERROR(file->open(File::TranslateCommand(command), mode));
  if (!ret) {
    raise_warning(""popen(%s,%s): Invalid argument"",
                  command.data(), mode.data());
    return false;
  }
  return Variant(std::move(file));
}

bool HHVM_FUNCTION(fclose,
                   const Resource& handle) {
  CHECK_HANDLE(handle, f);
  return CHECK_ERROR(f->close());
}

Variant HHVM_FUNCTION(pclose,
                      const Variant& handle) {
  CHECK_HANDLE(handle.toResource(), f);
  CHECK_ERROR(f->close());
  return s_pcloseRet;
}

Variant HHVM_FUNCTION(fseek,
                      const Resource& handle,
                      int64_t offset,
                      int64_t whence /* = SEEK_SET */) {
  CHECK_HANDLE(handle, f);
  return CHECK_ERROR(f->seek(offset, whence)) ? 0 : -1;
}

bool HHVM_FUNCTION(rewind,
                   const Resource& handle) {
  CHECK_HANDLE(handle, f);
  return CHECK_ERROR(f->rewind());
}

Variant HHVM_FUNCTION(ftell,
                      const Resource& handle) {
  CHECK_HANDLE(handle, f);
  int64_t ret = f->tell();
  if (!CHECK_ERROR(ret != -1)) {
    return false;
  }
  return ret;
}

bool HHVM_FUNCTION(feof,
                   const Resource& handle) {
  CHECK_HANDLE(handle, f);
  return f->eof();
}

Variant HHVM_FUNCTION(fstat,
                      const Resource& handle) {
  CHECK_HANDLE(handle, f);
  struct stat sb;
  if (!CHECK_ERROR(f->stat(&sb)))
    return false;
  return stat_impl(&sb);
}

Variant HHVM_FUNCTION(fread,
                      const Resource& handle,
                      int64_t length) {
  CHECK_HANDLE(handle, f);
  if (length < 1) {
    raise_warning(
      ""fread(): Length parameter must be greater than 0""
    );
    return false;
  }
  return f->read(length);
}

Variant HHVM_FUNCTION(fgetc,
                      const Resource& handle) {
  CHECK_HANDLE(handle, f);
  int result = f->getc();
  if (result == EOF) {
    return false;
  }
  return String::FromChar(result);
}

Variant HHVM_FUNCTION(fgets,
                      const Resource& handle,
                      int64_t length /* = 0 */) {
  if (length < 0) {
    throw_invalid_argument(""length (negative): %"" PRId64, length);
    return false;
  }
  CHECK_HANDLE(handle, f);
  String line = f->readLine(length - 1);
  if (!line.isNull()) {
    return line;
  }
  return false;
}

Variant HHVM_FUNCTION(fgetss,
                      const Resource& handle,
                      int64_t length /* = 0 */,
                      const String& allowable_tags /* = null_string */) {
  Variant ret = HHVM_FN(fgets)(handle, length);
  if (!same(ret, false)) {
    return StringUtil::StripHTMLTags(ret.toString(), allowable_tags);
  }
  return ret;
}

Variant fscanfImpl(const Resource& handle,
                   const String& format,
                   const req::vector<Variant*>& args) {
  CHECK_HANDLE(handle, f);
  String line = f->readLine();
  if (line.length() == 0) {
    return false;
  }
  return sscanfImpl(line, format, args);
}

TypedValue* HHVM_FN(fscanf)(ActRec* ar) {
  Resource handle{getArg<KindOfResource>(ar, 0)};
  if (ar->numArgs() < 1) {
    return arReturn(ar, init_null());
  }
  String format{getArg<KindOfString>(ar, 1)};
  if (ar->numArgs() < 2) {
    return arReturn(ar, false);
  }
  req::vector<Variant*> args;
  args.reserve(ar->numArgs() - 2);
  for (int i = 2; i < ar->numArgs(); ++i) {
    args.push_back(getArg<KindOfRef>(ar, i));
  }
  return arReturn(ar, fscanfImpl(handle, format, args));
}

Variant HHVM_FUNCTION(fpassthru,
                      const Resource& handle) {
  CHECK_HANDLE(handle, f);
  return f->print();
}

Variant HHVM_FUNCTION(fwrite,
                      const Resource& handle,
                      const String& data,
                      int64_t length /* = 0 */) {
  CHECK_HANDLE(handle, f);
  int64_t ret = f->write(data, length);
  if (ret < 0) {
    raise_notice(""fwrite(): send of %d bytes failed with errno=%d %s"",
                 data.size(), errno, folly::errnoStr(errno).c_str());
    ret = 0;
  }
  return ret;
}

Variant HHVM_FUNCTION(fputs,
                      const Resource& handle,
                      const String& data,
                      int64_t length /* = 0 */) {
  CHECK_HANDLE(handle, f);
  int64_t ret = f->write(data, length);
  if (ret < 0) ret = 0;
  return ret;
}

Variant HHVM_FUNCTION(fprintf,
                      const Variant& handle,
                      const String& format,
                      const Array& args /* = null_array */) {
  if (!handle.isResource()) {
    raise_param_type_warning(""fprintf"", 1, KindOfResource,
                             handle.getType());
    return false;
  }
  const Resource res = handle.toResource();
  CHECK_HANDLE(res, f);
  return f->printf(format, args);
}

Variant HHVM_FUNCTION(vfprintf,
                      const Variant& handle,
                      const Variant& format,
                      const Variant& args) {
  CHECK_HANDLE(handle.toResource(), f);
  return f->printf(format.toString(), args.toArray());
}

bool HHVM_FUNCTION(fflush,
                   const Resource& handle) {
  CHECK_HANDLE(handle, f);
  return CHECK_ERROR(f->flush());
}

bool HHVM_FUNCTION(ftruncate,
                   const Resource& handle,
                   int64_t size) {
  CHECK_HANDLE(handle, f);
  return CHECK_ERROR(f->truncate(size));
}

static int flock_values[] = { LOCK_SH, LOCK_EX, LOCK_UN };

bool HHVM_FUNCTION(flock,
                   const Resource& handle,
                   int operation,
                   VRefParam wouldblock /* = null */) {
  CHECK_HANDLE(handle, f);
  bool block = false;
  int act;

  act = operation & 3;
  if (act < 1 || act > 3) {
    throw_invalid_argument(""operation: %d"", operation);
    return false;
  }
  act = flock_values[act - 1] | (operation & 4 ? LOCK_NB : 0);
  bool ret = f->lock(act, block);
  wouldblock.assignIfRef(block);
  return ret;
}

// match the behavior of PHP5
#define FCSV_CHECK_ARG(NAME)                            \\
  if (NAME.size() == 0) {                               \\
    throw_invalid_argument(#NAME "": %s"", NAME.data());  \\
    return false;                                       \\
  } else if (NAME.size() > 1) {                         \\
    raise_notice(#NAME "" must be a single character"");  \\
  }                                                     \\
  char NAME ## _char = NAME.charAt(0);                  \\

Variant HHVM_FUNCTION(fputcsv,
                      const Resource& handle,
                      const Array& fields,
                      const String& delimiter /* = "","" */,
                      const String& enclosure /* = ""\\"""" */,
                      const String& escape /* = ""\\\\"" */) {
  FCSV_CHECK_ARG(delimiter);
  FCSV_CHECK_ARG(enclosure);
  FCSV_CHECK_ARG(escape);

  CHECK_HANDLE_RET_NULL(handle, f);
  return f->writeCSV(fields, delimiter_char, enclosure_char, escape_char);
}

Variant HHVM_FUNCTION(fgetcsv,
                      const Resource& handle,
                      int64_t length /* = 0 */,
                      const String& delimiter /* = "","" */,
                      const String& enclosure /* = ""\\"""" */,
                      const String& escape /* = ""\\\\"" */) {
  if (length < 0) {
    throw_invalid_argument(""Length parameter may not be negative"");
    return false;
  }

  FCSV_CHECK_ARG(delimiter);
  FCSV_CHECK_ARG(enclosure);
  FCSV_CHECK_ARG(escape);

  CHECK_HANDLE_RET_NULL(handle, f);
  Array ret = f->readCSV(length, delimiter_char, enclosure_char, escape_char);
  if (!ret.isNull()) {
    return ret;
  }
  return false;
}

///////////////////////////////////////////////////////////////////////////////

Variant HHVM_FUNCTION(file_get_contents,
                      const String& filename,
                      bool use_include_path /* = false */,
                      const Variant& context /* = null */,
                      int64_t offset /* = -1 */,
                      int64_t maxlen /* = -1 */) {
  CHECK_PATH(filename, 1);
  Variant stream = HHVM_FN(fopen)(filename, ""rb"", use_include_path, context);
  if (same(stream, false)) return false;
  return HHVM_FN(stream_get_contents)(stream.toResource(), maxlen, offset);
}

Variant HHVM_FUNCTION(file_put_contents,
                      const String& filename,
                      const Variant& data,
                      int flags /* = 0 */,
                      const Variant& context /* = null */) {
  CHECK_PATH(filename, 1);

  char mode[3] = ""wb"";
  if (flags & PHP_FILE_APPEND) {
    mode[0] = 'a';
  } else if (flags & LOCK_EX) {
    // Open in ""create"" mode (writing only, create if needed, no truncate)
    // so that the file is not modified before we attempt to aquire the
    // requested lock.
    mode[0] = 'c';
  }
  mode[2] = '\\0';

  auto file = File::Open(
    filename,
    mode,
    flags,
    dyn_cast_or_null<StreamContext>(context)
  );

  if (!file) {
    return false;
  }

  if (flags & LOCK_EX) {
    // Check to make sure we are dealing with a regular file
    if (!isa<PlainFile>(file)) {
      raise_warning(
        ""%s(): Exclusive locks may only be set for regular files"",
        __FUNCTION__ + 2);
      return false;
    }

    if (!file->lock(LOCK_EX)) {
      return false;
    }
  }

  if (mode[0] == 'c') {
    file->truncate(0);
  }

  int numbytes = 0;

  switch (data.getType()) {
    case KindOfResource: {
      auto fsrc = dyn_cast_or_null<File>(data);
      if (!fsrc) {
        raise_warning(""Not a valid stream resource"");
        return false;
      }
      while (true) {
        char buffer[1024];
        int len = fsrc->readImpl(buffer, sizeof(buffer));
        if (len == 0) break;
        numbytes += len;
        int written = file->writeImpl(buffer, len);
        if (written != len) {
          numbytes = -1;
          break;
        }
      }
      break;
    }

    case KindOfPersistentVec:
    case KindOfVec:
    case KindOfPersistentDict:
    case KindOfDict:
    case KindOfPersistentKeyset:
    case KindOfKeyset:
    case KindOfPersistentArray:
    case KindOfArray: {
      Array arr = data.toArray();
      for (ArrayIter iter(arr); iter; ++iter) {
        auto const value = iter.second().toString();
        if (!value.empty()) {
          numbytes += value.size();
          int written = file->writeImpl(value.data(), value.size());
          if (written != value.size()) {
            numbytes = -1;
            break;
          }
        }
      }
      break;
    }

    case KindOfObject:
      if (!data.getObjectData()->hasToString()) {
        raise_warning(""Not a valid stream resource"");
        return false;
      }
      // fallthrough
    case KindOfUninit:
    case KindOfNull:
    case KindOfBoolean:
    case KindOfInt64:
    case KindOfDouble:
    case KindOfPersistentString:
    case KindOfString:
    case KindOfRef: {
      String value = data.toString();
      if (!value.empty()) {
        numbytes += value.size();
        int written = file->writeImpl(value.data(), value.size());
        if (written != value.size()) {
          numbytes = -1;
        }
      }
      break;
    }
    case KindOfFunc:
    case KindOfClass:
      raise_warning(""Not a valid stream resource"");
      return false;
  }

  // like fwrite(), fclose() can error when fflush()ing
  if (numbytes < 0 || !file->close()) {
    return false;
  }

  return numbytes;
}

Variant HHVM_FUNCTION(file,
                      const String& filename,
                      int flags /* = 0 */,
                      const Variant& context /* = null */) {
  CHECK_PATH(filename, 1);
  Variant contents = HHVM_FN(file_get_contents)(filename,
                                         flags & PHP_FILE_USE_INCLUDE_PATH,
                                         context);
  if (same(contents, false)) {
    return false;
  }
  String content = contents.toString();
  Array ret = Array::Create();
  if (content.empty()) {
    return ret;
  }

  char eol_marker = '\\n';
  bool include_new_line = !(flags & PHP_FILE_IGNORE_NEW_LINES);
  bool skip_blank_lines = flags & PHP_FILE_SKIP_EMPTY_LINES;
  const char *s = content.data();
  const char *e = s + content.size();

  int i = 0;
  const char *p = (const char *)memchr(s, '\\n', content.size());
  if (!p) {
    p = e;
    goto parse_eol;
  }

  if (include_new_line) {
    do {
      p++;
    parse_eol:
      ret.set(i++, String(s, p-s, CopyString));
      s = p;
    } while ((p = (const char *)memchr(p, eol_marker, (e-p))));
  } else {
    do {
      int windows_eol = 0;
      if (p != content.data() && eol_marker == '\\n' && *(p - 1) == '\\r') {
        windows_eol++;
      }

      if (skip_blank_lines && !(p-s-windows_eol)) {
        s = ++p;
        continue;
      }
      ret.set(i++, String(s, p-s-windows_eol, CopyString));
      s = ++p;
    } while ((p = (const char *)memchr(p, eol_marker, (e-p))));
  }

  /* handle any left overs of files without new lines */
  if (s != e) {
    p = e;
    goto parse_eol;
  }
  return ret;
}

Variant HHVM_FUNCTION(readfile,
                      const String& filename,
                      bool use_include_path /* = false */,
                      const Variant& context /* = null */) {
  CHECK_PATH_FALSE(filename, 1);
  Variant f = HHVM_FN(fopen)(filename, ""rb"", use_include_path, context);
  if (same(f, false)) {
    Logger::Verbose(""%s/%d: %s"", __FUNCTION__, __LINE__,
                    folly::errnoStr(errno).c_str());
    return false;
  }
  Variant ret = HHVM_FN(fpassthru)(f.toResource());
  return ret;
}

bool HHVM_FUNCTION(move_uploaded_file,
                   const String& filename,
                   const String& destination) {
  Transport *transport = g_context->getTransport();
  if (!transport || !transport->isUploadedFile(filename)) {
    return false;
  }

  CHECK_PATH_FALSE(destination, 2);

  if (HHVM_FN(rename)(filename, destination)) {
    return true;
  }

  // If rename didn't work, fall back to copy followed by unlink
  if (!HHVM_FN(copy)(filename, destination)) {
    return false;
  }
  HHVM_FN(unlink)(filename);

  return true;
}

namespace {

String resolve_parse_ini_filename(const String& filename) {
  // Try cleaning up the path. Use file_exists to avoid a warning
  // that get_contents generates
  String resolved = File::TranslatePath(filename);
  if (!resolved.empty() && HHVM_FN(file_exists)(resolved)) {
    return resolved;
  }

  if (FileUtil::isAbsolutePath(filename.data())) {
    return null_string;
  }

  // Still no go, and not an absolute path, try to resolve based
  // on containing file name.
  auto const cfd = String::attach(g_context->getContainingFileName());
  if (!cfd.empty()) {
    int npos = cfd.rfind('/');
    if (npos >= 0) {
      resolved = cfd.substr(0, npos + 1) + filename;
      if (!resolved.empty() && HHVM_FN(file_exists)(resolved)) {
        return resolved;
      }
    }
  }

  // Next, see if include path was set in the ini settings.
  auto const& includePaths = RID().getIncludePaths();

  for (auto const& path : includePaths) {
    resolved = path + FileUtil::getDirSeparator() + filename;
    if (HHVM_FN(file_exists)(resolved)) {
      return resolved;
    }
  }

  return null_string;
}
}

Variant HHVM_FUNCTION(parse_ini_file,
                      const String& filename,
                      bool process_sections /* = false */,
                      int scanner_mode /* = k_INI_SCANNER_NORMAL */) {
  CHECK_PATH_FALSE(filename, 1);
  if (filename.empty()) {
    throw_invalid_argument(""Filename cannot be empty!"");
    return false;
  }

  // Block ability to load ini files via http (eg., remotely)
  int oFilename = 0;
  Stream::Wrapper* w = Stream::getWrapperFromURI(filename, &oFilename);
  if (nullptr != dynamic_cast<HttpStreamWrapper*>(w)) {
    raise_warning(""remote access to ini files is not allowed"");
    return false;
  }

  // Extract the (local) filename
  String wrapperPrefix = filename.substr(0, oFilename);
  String path = resolve_parse_ini_filename(filename.substr(oFilename));

  if (path.empty()) {
    // At this point, we were unable to find the file.
    raise_warning(""No such file or directory"");
    return false;
  }

  Variant content = HHVM_FN(file_get_contents)(wrapperPrefix + path);
  if (same(content, false)) {
    // Don't generate a warning, as they have already been generated.
    return false;
  }

  return IniSetting::FromString(content.toString(), filename, process_sections,
                                scanner_mode);
}

Variant HHVM_FUNCTION(parse_ini_string,
                      const String& ini,
                      bool process_sections /* = false */,
                      int scanner_mode /* = k_INI_SCANNER_NORMAL */) {
  return IniSetting::FromString(ini, """", process_sections, scanner_mode);
}

Variant HHVM_FUNCTION(md5_file,
                      const String& filename,
                      bool raw_output /* = false */) {
  CHECK_PATH(filename, 1);
  return HHVM_FN(hash_file)(""md5"", filename, raw_output);
}

Variant HHVM_FUNCTION(sha1_file,
                      const String& filename,
                      bool raw_output /* = false */) {
  CHECK_PATH(filename, 1);
  return HHVM_FN(hash_file)(""sha1"", filename, raw_output);
}

///////////////////////////////////////////////////////////////////////////////
// stats functions

Variant HHVM_FUNCTION(fileperms,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb, true));
  return (int64_t)sb.st_mode;
}

Variant HHVM_FUNCTION(fileinode,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb));
  return (int64_t)sb.st_ino;
}

Variant HHVM_FUNCTION(filesize,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  if (filename.empty()) {
    return false;
  }
  if (StaticContentCache::TheFileCache) {
    int64_t size =
      StaticContentCache::TheFileCache->fileSize(filename.data(),
        filename.data()[0] != '/');
    if (size >= 0) return size;
  }
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb, true));
  return (int64_t)sb.st_size;
}

Variant HHVM_FUNCTION(fileowner,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb, true));
  return (int64_t)sb.st_uid;
}

Variant HHVM_FUNCTION(filegroup,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb, true));
  return (int64_t)sb.st_gid;
}

Variant HHVM_FUNCTION(fileatime,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb, true));
  return (int64_t)sb.st_atime;
}

Variant HHVM_FUNCTION(filemtime,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb, true));
  return (int64_t)sb.st_mtime;
}

Variant HHVM_FUNCTION(filectime,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb, true));
  return (int64_t)sb.st_ctime;
}

Variant HHVM_FUNCTION(filetype,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(lstatSyscall(filename, &sb));

  switch (sb.st_mode & S_IFMT) {
  case S_IFLNK:  return ""link"";
  case S_IFIFO:  return ""fifo"";
  case S_IFCHR:  return ""char"";
  case S_IFDIR:  return ""dir"";
  case S_IFBLK:  return ""block"";
  case S_IFREG:  return ""file"";
  case S_IFSOCK: return ""socket"";
  }
  return ""unknown"";
}

Variant HHVM_FUNCTION(linkinfo,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  struct stat sb;
  CHECK_SYSTEM(statSyscall(filename, &sb));
  return (int64_t)sb.st_dev;
}

bool HHVM_FUNCTION(is_writable,
                   const String& filename) {
  CHECK_PATH_FALSE(filename, 1);
  if (filename.empty()) {
    return false;
  }
  CHECK_SYSTEM_SILENT(accessSyscall(filename, W_OK));
  return true;
  /*
  int mask = S_IWOTH;
  if (sb.st_uid == getuid()) {
    mask = S_IWUSR;
  } else if (sb.st_gid == getgid()) {
    mask = S_IWGRP;
  } else {
    int groups = getgroups(0, NULL);
    if (groups > 0) {
      gid_t *gids = (gid_t *)malloc(groups * sizeof(gid_t));
      int n = getgroups(groups, gids);
      for (int i = 0; i < n; i++) {
        if (sb.st_gid == gids[i]) {
          mask = S_IWGRP;
          break;
        }
      }
      free(gids);
    }
  }
  return sb.st_mode & mask;
  */
}

bool HHVM_FUNCTION(is_writeable,
                   const String& filename) {
  CHECK_PATH_FALSE(filename, 1);
  return HHVM_FN(is_writable)(filename);
}

bool HHVM_FUNCTION(is_readable,
                   const String& filename) {
  CHECK_PATH_FALSE(filename, 1);
  if (filename.empty()) {
    return false;
  }
  CHECK_SYSTEM_SILENT(accessSyscall(filename, R_OK, true));
  return true;
  /*
  int mask = S_IROTH;
  if (sb.st_uid == getuid()) {
    mask = S_IRUSR;
  } else if (sb.st_gid == getgid()) {
    mask = S_IRGRP;
  } else {
    int groups = getgroups(0, NULL);
    if (groups > 0) {
      gid_t *gids = (gid_t *)malloc(groups * sizeof(gid_t));
      int n = getgroups(groups, gids);
      for (int i = 0; i < n; i++) {
        if (sb.st_gid == gids[i]) {
          mask = S_IRGRP;
          break;
        }
      }
      free(gids);
    }
  }
  return sb.st_mode & mask;
  */
}

bool HHVM_FUNCTION(is_executable,
                   const String& filename) {
  CHECK_PATH_FALSE(filename, 1);
  if (filename.empty()) {
    return false;
  }
  CHECK_SYSTEM_SILENT(accessSyscall(filename, X_OK));
  return true;
  /*
  int mask = S_IXOTH;
  if (sb.st_uid == getuid()) {
    mask = S_IXUSR;
  } else if (sb.st_gid == getgid()) {
    mask = S_IXGRP;
  } else {
    int groups = getgroups(0, NULL);
    if (groups > 0) {
      gid_t *gids = (gid_t *)malloc(groups * sizeof(gid_t));
      int n = getgroups(groups, gids);
      for (int i = 0; i < n; i++) {
        if (sb.st_gid == gids[i]) {
          mask = S_IXGRP;
          break;
        }
      }
      free(gids);
    }
  }
  return (sb.st_mode & mask) && (sb.st_mode & S_IFMT) != S_IFDIR;
  */
}

static VFileType lookupVirtualFile(const String& filename) {
  if (filename.empty() || !StaticContentCache::TheFileCache) {
    return VFileType::NotFound;
  }

  String cwd;
  std::string root;
  bool isRelative = !FileUtil::isAbsolutePath(filename.slice());
  if (isRelative) {
    cwd = g_context->getCwd();
    root = RuntimeOption::SourceRoot;
    if (cwd.empty() || FileUtil::isDirSeparator(cwd[cwd.size() - 1])) {
      root.pop_back();
    }
  }

  if (!isRelative || !root.compare(cwd.data())) {
    return StaticContentCache::TheFileCache->getFileType(filename.data());
  }

  return VFileType::NotFound;
}

bool HHVM_FUNCTION(is_file,
                   const String& filename) {
  CHECK_PATH_FALSE(filename, 1);
  if (filename.empty()) {
    return false;
  }
  auto vtype = lookupVirtualFile(filename);
  if (vtype != VFileType::NotFound) {
    return vtype == VFileType::PlainFile;
  }

  struct stat sb;
  CHECK_SYSTEM_SILENT(statSyscall(filename, &sb, true));
  return (sb.st_mode & S_IFMT) == S_IFREG;
}

bool HHVM_FUNCTION(is_dir,
                   const String& filename) {
  CHECK_PATH_FALSE(filename, 1);
  if (filename.empty()) {
    return false;
  }
  auto vtype = lookupVirtualFile(filename);
  if (vtype != VFileType::NotFound) {
    return vtype == VFileType::Directory;
  }

  struct stat sb;
  CHECK_SYSTEM_SILENT(statSyscall(filename, &sb, false));
  return (sb.st_mode & S_IFMT) == S_IFDIR;
}

bool HHVM_FUNCTION(is_link,
                   const String& filename) {
  CHECK_PATH_FALSE(filename, 1);
  struct stat sb;
  CHECK_SYSTEM_SILENT(lstatSyscall(filename, &sb));
  return (sb.st_mode & S_IFMT) == S_IFLNK;
}

bool HHVM_FUNCTION(is_uploaded_file,
                   const String& filename) {
  Transport *transport = g_context->getTransport();
  if (transport) {
    return transport->isUploadedFile(filename);
  }
  return false;
}

bool HHVM_FUNCTION(file_exists,
                   const String& filename) {
  CHECK_PATH_FALSE(filename, 1);
  auto vtype = lookupVirtualFile(filename);
  if (vtype != VFileType::NotFound) {
    return true;
  }

  if (filename.empty() ||
      (accessSyscall(filename, F_OK, true)) < 0) {
    return false;
  }
  return true;
}

Variant HHVM_FUNCTION(stat,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  if (filename.empty()) {
    return false;
  }

  struct stat sb;
  if (statSyscall(filename, &sb, true) != 0) {
    raise_warning(
      ""stat(): stat failed for %s"",
       filename.c_str()
    );
    return false;
  }
  return stat_impl(&sb);
}

Variant HHVM_FUNCTION(lstat,
                      const String& filename) {
  CHECK_PATH(filename, 1);
  if (filename.empty()) {
    return false;
  }

  struct stat sb;
  CHECK_SYSTEM(lstatSyscall(filename, &sb, true));
  return stat_impl(&sb);
}

void HHVM_FUNCTION(clearstatcache, bool /*clear_realpath_cache*/ /* = false */,
                   const Variant& /*filename*/ /* = uninit_variant */) {
  // we are not having a cache for file stats, so do nothing here
}

Variant HHVM_FUNCTION(readlink_internal,
                      const String& path,
                      bool warning_compliance) {
  char buff[PATH_MAX];
  int ret = readlink(File::TranslatePath(path).data(), buff, PATH_MAX-1);
  if (ret < 0) {
    Logger::Verbose(""%s/%d: %s"", __FUNCTION__, __LINE__,
                    folly::errnoStr(errno).c_str());
    if (warning_compliance) {
      raise_warning(""readlink(): No such file or directory %s"",path.c_str());
    }
    return false;
  }
  buff[ret] = '\\0';
  return String(buff, ret, CopyString);
}

Variant HHVM_FUNCTION(readlink,
                      const String& path) {
  CHECK_PATH(path, 1);
  return HHVM_FN(readlink_internal)(path, true);
}

Variant HHVM_FUNCTION(realpath,
                      const String& path) {
  CHECK_PATH(path, 1);

  String translated;
  if (path.empty()) {
    translated = File::TranslatePath(g_context->getCwd());
  } else {
    translated = File::TranslatePath(path);
  }

  if (translated.empty()) {
    return false;
  }
  if (StaticContentCache::TheFileCache &&
      StaticContentCache::TheFileCache->exists(translated.data(), false)) {
    return translated;
  }
  // Zend doesn't support streams in realpath
  Stream::Wrapper* w = Stream::getWrapperFromURI(path);
  if (!w || !w->isNormalFileStream()) {
    return false;
  }
  if (!dynamic_cast<FileStreamWrapper*>(w)) {
    auto str = w->realpath(translated);
    if (str.isNull()) return false;
    return str;
  }
  char resolved_path[PATH_MAX];
  if (!realpath(translated.c_str(), resolved_path)) {
    return false;
  }
  return String(resolved_path, CopyString);
}

#define PHP_PATHINFO_DIRNAME    1
#define PHP_PATHINFO_BASENAME   2
#define PHP_PATHINFO_EXTENSION  4
#define PHP_PATHINFO_FILENAME   8

const StaticString
  s_dirname(""dirname""),
  s_basename(""basename""),
  s_extension(""extension""),
  s_filename(""filename"");

Variant HHVM_FUNCTION(pathinfo,
                      const String& path,
                      int opt /* = 15 */) {
  ArrayInit ret(4, ArrayInit::Map{});

  if (opt == 0) {
    return empty_string_variant();
  }

  if ((opt & PHP_PATHINFO_DIRNAME) == PHP_PATHINFO_DIRNAME) {
    String dirname = HHVM_FN(dirname)(path);
    if (opt == PHP_PATHINFO_DIRNAME) {
      return dirname;
    }
    if (!dirname.equal(staticEmptyString())) {
      ret.set(s_dirname, dirname);
    }
  }

  String basename = HHVM_FN(basename)(path);
  if ((opt & PHP_PATHINFO_BASENAME) == PHP_PATHINFO_BASENAME) {
    if (opt == PHP_PATHINFO_BASENAME) {
      return basename;
    }
    ret.set(s_basename, basename);
  }

  if ((opt & PHP_PATHINFO_EXTENSION) == PHP_PATHINFO_EXTENSION) {
    int pos = basename.rfind('.');
    String extension(empty_string());
    if (pos >= 0) {
      extension = basename.substr(pos + 1);
      ret.set(s_extension, extension);
    }
    if (opt == PHP_PATHINFO_EXTENSION) {
      return extension;
    }
  }

  if ((opt & PHP_PATHINFO_FILENAME) == PHP_PATHINFO_FILENAME) {
    int pos = basename.rfind('.');
    String filename(empty_string());
    if (pos >= 0) {
      filename = basename.substr(0, pos);
    } else {
      filename = basename;
    }
    if (opt == PHP_PATHINFO_FILENAME) {
      return filename;
    }
    ret.set(s_filename, filename);
  }

  return ret.toVariant();
}

Variant HHVM_FUNCTION(disk_free_space,
                      const String& directory) {
  CHECK_PATH(directory, 1);
  fs::space_info sb;
  String translated = File::TranslatePath(directory);
  CHECK_BOOST(sb, fs::space, translated);
  return (double)sb.free;
}

Variant HHVM_FUNCTION(diskfreespace,
                      const String& directory) {
  CHECK_PATH(directory, 1);
  return HHVM_FN(disk_free_space)(directory);
}

Variant HHVM_FUNCTION(disk_total_space,
                      const String& directory) {
  CHECK_PATH(directory, 1);
  fs::space_info sb;
  String translated = File::TranslatePath(directory);
  CHECK_BOOST(sb, fs::space, translated);
  return (double)sb.capacity;
}

///////////////////////////////////////////////////////////////////////////////
// system wrappers

bool HHVM_FUNCTION(chmod,
                   const String& filename,
                   int64_t mode) {
  CHECK_PATH_FALSE(filename, 1);
  String translated = File::TranslatePath(filename);

  // If filename points to a user file, invoke ExtendedWrapper::chmod(..)
  Stream::Wrapper* w = Stream::getWrapperFromURI(filename);
  auto usw = dynamic_cast<Stream::ExtendedWrapper*>(w);
  if (usw != nullptr) {
    return usw->chmod(filename, mode);
  }

  CHECK_SYSTEM(chmod(translated.c_str(), mode));
  return true;
}

static bool do_chown(const String& filename,
                     const Variant& user,
                     bool islChown,
                     const char* funcName) {
  // If filename points to a user file, invoke ExtendedWrapper::chown(..)
  Stream::Wrapper* w = Stream::getWrapperFromURI(filename);
  auto usw = dynamic_cast<Stream::ExtendedWrapper*>(w);
  if (usw != nullptr) {
    if (user.isInteger()) {
      return usw->chown(filename, user.toInt64());
    } else if (user.isString()) {
      return usw->chown(filename, user.toString());
    }
    raise_warning(""%s(): parameter 2 should be string or integer, %s given"",
      funcName, getDataTypeString(user.getType()).c_str());
    return false;
  }

#ifdef WIN32
  return false;
#else
  int uid;
  if (user.isString()) {
    String suser = user.toString();
    struct passwd *pw = getpwnam(suser.data());
    if (!pw) {
      Logger::Verbose(""%s/%d: Unable to find uid for %s"",
        __FUNCTION__, __LINE__, suser.data());
      raise_warning(""%s(): Unable to find uid for %s"", funcName,
        user.toString().c_str());
      return false;
    }
    uid = pw->pw_uid;
  } else {
    uid = user.toInt32();
  }

  if (islChown) {
    CHECK_SYSTEM(lchown(File::TranslatePath(filename).data(), uid, (gid_t)-1));
  } else {
    CHECK_SYSTEM(chown(File::TranslatePath(filename).data(), uid, (gid_t)-1));
  }
  return true;
#endif
}

bool HHVM_FUNCTION(chown,
                   const String& filename,
                   const Variant& user) {
  CHECK_PATH_FALSE(filename, 1);
  return do_chown(filename, user, false, ""chown"");
}

bool HHVM_FUNCTION(lchown,
                   const String& filename,
                   const Variant& user) {
#ifdef WIN32
  return false;
#else
  CHECK_PATH_FALSE(filename, 1);
  return do_chown(filename, user, true, ""lchown"");
#endif
}

static bool do_chgrp(const String& filename,
                     const Variant& group,
                     bool islChgrp,
                     const char* funcName) {
  // If filename points to a user file, invoke ExtendedWrapper::chgrp(..)
  Stream::Wrapper* w = Stream::getWrapperFromURI(filename);
  auto usw = dynamic_cast<Stream::ExtendedWrapper*>(w);
  if (usw != nullptr) {
    if (group.isInteger()) {
      return usw->chgrp(filename, group.toInt64());
    } else if (group.isString()) {
      return usw->chgrp(filename, group.toString());
    }
    raise_warning(""%s(): parameter 2 should be string or integer, %s given"",
      funcName, getDataTypeString(group.getType()).c_str());
    return false;
  }

#ifdef WIN32
  return false;
#else
  int gid;
  if (group.isString()) {
    String sgroup = group.toString();
    struct group *gr = getgrnam(sgroup.data());
    if (!gr) {
      Logger::Verbose(""%s/%d: Unable to find gid for %s"",
        __FUNCTION__, __LINE__, sgroup.data());
      raise_warning(""%s(): Unable to find gid for %s"", funcName,
        group.toString().c_str());
      return false;
    }
    gid = gr->gr_gid;
  } else {
    gid = group.toInt32();
  }

  if (islChgrp) {
    CHECK_SYSTEM(lchown(File::TranslatePath(filename).data(), (uid_t)-1, gid));
  } else {
    CHECK_SYSTEM(chown(File::TranslatePath(filename).data(), (uid_t)-1, gid));
  }
  return true;
#endif
}

bool HHVM_FUNCTION(chgrp,
                   const String& filename,
                   const Variant& group) {
  CHECK_PATH_FALSE(filename, 1);
  return do_chgrp(filename, group, false, ""chgrp"");
}

bool HHVM_FUNCTION(lchgrp,
                   const String& filename,
                   const Variant& group) {
#ifdef WIN32
  return false;
#else
  CHECK_PATH_FALSE(filename, 1);
  return do_chgrp(filename, group, true, ""lchgrp"");
#endif
}

bool HHVM_FUNCTION(touch,
                   const String& filename,
                   int64_t mtime /* = 0 */,
                   int64_t atime /* = 0 */) {
  CHECK_PATH_FALSE(filename, 1);

  if (filename.empty()) {
    return false;
  }

  // If filename points to a user file, invoke ExtendedWrapper::touch(..)
  Stream::Wrapper* w = Stream::getWrapperFromURI(filename);
  auto usw = dynamic_cast<Stream::ExtendedWrapper*>(w);
  if (usw != nullptr) {
    return usw->touch(filename, mtime, atime);
  }

  String translated = File::TranslatePath(filename);

  /* create the file if it doesn't exist already */
  if (accessSyscall(translated, F_OK)) {
    FILE *f = fopen(translated.data(), ""w"");
    if (!f) {
      raise_warning(
        ""touch(): Unable to create file %s because %s"",
        translated.data(), folly::errnoStr(errno).c_str()
      );
      return false;
    }
    fclose(f);
  }

#ifdef _MSC_VER
  CHECK_BOOST_ASSIGN(fs::last_write_time, translated, mtime);
  // Windows doesn't have an access time to set.
#else
  if (mtime == 0 && atime == 0) {
    // It is important to pass nullptr so that the OS sets mtime and atime
    // to the current time with maximum precision (more precise then seconds)
    CHECK_SYSTEM(utime(translated.data(), nullptr));
  } else {
    struct utimbuf newtime;
    newtime.actime = atime ? atime : mtime;
    newtime.modtime = mtime;
    CHECK_SYSTEM(utime(translated.data(), &newtime));
  }
#endif

  return true;
}

bool HHVM_FUNCTION(copy,
                   const String& source,
                   const String& dest,
                   const Variant& context /* = null */) {
  CHECK_PATH_FALSE(source, 1);
  CHECK_PATH_FALSE(dest, 2);
  if (!context.isNull() || !File::IsPlainFilePath(source) ||
      !File::IsPlainFilePath(dest) || is_cli_mode()) {
    Variant sfile = HHVM_FN(fopen)(source, ""r"", false, context);
    if (same(sfile, false)) {
      return false;
    }
    Variant dfile = HHVM_FN(fopen)(dest, ""w"", false, context);
    if (same(dfile, false)) {
      return false;
    }

    if (!HHVM_FN(stream_copy_to_stream)(sfile.toResource(),
                                        dfile.toResource()).toBoolean() &&
        HHVM_FN(filesize)(source).toBoolean()) {
      return false;
    }

    return HHVM_FN(fclose)(dfile.toResource());
  } else {
    int ret =
      RuntimeOption::UseDirectCopy ?
      FileUtil::directCopy(File::TranslatePath(source).data(),
          File::TranslatePath(dest).data())
      :
      FileUtil::copy(File::TranslatePath(source).data(),
          File::TranslatePath(dest).data());
    return (ret == 0);
  }
}

bool HHVM_FUNCTION(rename, const String& oldname, const String& newname,
                   const Variant& /*context*/ /* = null */) {
  CHECK_PATH_FALSE(oldname, 1);
  CHECK_PATH_FALSE(newname, 2);
  Stream::Wrapper* w = Stream::getWrapperFromURI(oldname);
  if (!w) return false;
  if (w != Stream::getWrapperFromURI(newname)) {
    raise_warning(""Can't rename a file on different streams"");
    return false;
  }
  CHECK_SYSTEM(w->rename(oldname, newname));
  return true;
}

int64_t HHVM_FUNCTION(umask,
                      const Variant& mask /* = uninit_variant */) {
  int oldumask = umask(077);
  if (mask.isNull()) {
    umask(oldumask);
  } else {
    umask(mask.toInt32());
  }
  return oldumask;
}

bool HHVM_FUNCTION(unlink, const String& filename,
                   const Variant& /*context*/ /* = null */) {
  CHECK_PATH_FALSE(filename, 1);
  Stream::Wrapper* w = Stream::getWrapperFromURI(filename);
  if (!w) return false;
  CHECK_SYSTEM_SILENT(w->unlink(filename));
  return true;
}

bool HHVM_FUNCTION(link,
                   const String& target,
                   const String& link) {
  CHECK_PATH_FALSE(target, 1);
  CHECK_PATH_FALSE(link, 2);
  CHECK_BOOST_ASSIGN(fs::create_hard_link, File::TranslatePath(target),
                     File::TranslatePath(link).toCppString());
  return true;
}

bool HHVM_FUNCTION(symlink,
                   const String& target,
                   const String& link) {
  CHECK_PATH_FALSE(target, 1);
  CHECK_PATH_FALSE(link, 2);
  if (HHVM_FN(is_dir)(target)) {
    CHECK_BOOST_ASSIGN(fs::create_directory_symlink,
                       File::TranslatePathKeepRelative(target),
                       File::TranslatePath(link).toCppString());
  } else {
    CHECK_BOOST_ASSIGN(fs::create_symlink,
                       File::TranslatePathKeepRelative(target),
                       File::TranslatePath(link).toCppString());
  }
  return true;
}

String HHVM_FUNCTION(basename,
                     const String& path,
                     const String& suffix /* = null_string */) {
  int state = 0;
  const char *c = path.data();
  const char *comp, *cend;
  comp = cend = c;
  for (int cnt = path.size(); cnt > 0; --cnt, ++c) {
    if (FileUtil::isDirSeparator(*c)) {
      if (state == 1) {
        state = 0;
        cend = c;
      }
    } else if (state == 0) {
      comp = c;
      state = 1;
    }
  }

  if (state == 1) {
    cend = c;
  }
  int sufflen = suffix.size();
  if (!suffix.empty() && sufflen < (int)(cend - comp) &&
      memcmp(cend - sufflen, suffix.data(), sufflen) == 0) {
    cend -= sufflen;
  }
  return String(comp, cend - comp, CopyString);
}

bool HHVM_FUNCTION(fnmatch,
                   const String& pattern,
                   const String& filename, int flags /* = 0 */) {
  CHECK_PATH_FALSE(pattern, 1);
  CHECK_PATH_FALSE(filename, 2);
  if (filename.size() >= PATH_MAX) {
    raise_warning(
      ""Filename exceeds the maximum allowed length of %d characters"",
      PATH_MAX);
    return false;
  }
  if (pattern.size() >= PATH_MAX) {
    raise_warning(""Path exceeds the maximum allowed length of %d characters"",
                  PATH_MAX);
    return false;
  }

  return fnmatch(pattern.data(), filename.data(), flags) == 0;
}

Variant HHVM_FUNCTION(glob,
                      const String& pattern,
                      int flags /* = 0 */) {
  CHECK_PATH(pattern, 1);
  glob_t globbuf;
  int cwd_skip = 0;
  memset(&globbuf, 0, sizeof(glob_t));
  globbuf.gl_offs = 0;
  String work_pattern;

  if (pattern.size() >= PATH_MAX) {
    raise_warning(""Pattern exceeds the maximum allowed length of %d characters"",
                  PATH_MAX);
    return false;
  }

  if (pattern.charAt(0) == '/') {
    work_pattern = pattern;
  } else {
    String cwd = g_context->getCwd();
    if (!cwd.empty() && cwd[cwd.length() - 1] == '/') {
      work_pattern = cwd + pattern;
      cwd_skip = cwd.length();
    } else {
      work_pattern = cwd + ""/"" + pattern;
      cwd_skip = cwd.length() + 1;
    }
  }
  int nret = glob(work_pattern.data(),
                  flags & PHP_GLOB_FLAGMASK,
                  nullptr,
                  &globbuf);
  if (nret == GLOB_NOMATCH) {
    globfree(&globbuf);
    return empty_array();
  }

  if (!globbuf.gl_pathc || !globbuf.gl_pathv) {
    if (RID().hasSafeFileAccess()) {
      if (!HHVM_FN(is_dir)(work_pattern)) {
        globfree(&globbuf);
        return false;
      }
    }
    globfree(&globbuf);
    return empty_array();
  }

  if (nret) {
    globfree(&globbuf);
    return false;
  }

  Array ret;
  bool basedir_limit = false;
  for (int n = 0; n < (int)globbuf.gl_pathc; n++) {
    String translated = File::TranslatePath(globbuf.gl_pathv[n]);
    if (translated.empty()) {
      basedir_limit = true;
      continue;
    }
    /* we need to do this everytime since GLOB_ONLYDIR does not guarantee that
     * all directories will be filtered. GNU libc documentation states the
     * following:
     * If the information about the type of the file is easily available
     * non-directories will be rejected but no extra work will be done to
     * determine the information for each file. I.e., the caller must still be
     * able to filter directories out.
     */
    if ((flags & GLOB_ONLYDIR) && !HHVM_FN(is_dir)(globbuf.gl_pathv[n])) {
      continue;
    }
    ret.append(String(globbuf.gl_pathv[n] + cwd_skip, CopyString));
  }

  globfree(&globbuf);

  if (basedir_limit && ret.empty()) {
    return false;
  }
  // php's glob always produces an array, but Variant::Variant(CArrRef)
  // will produce KindOfNull if given a req::ptr wrapped around null.
  if (ret.isNull()) {
    return empty_array();
  }
  return ret;
}

Variant HHVM_FUNCTION(tempnam,
                      const String& dir,
                      const String& prefix) {
  CHECK_PATH(dir, 1);
  CHECK_PATH(prefix, 2);
  String tmpdir = dir, trailing_slash = ""/"";
  if (tmpdir.empty() || !HHVM_FN(is_dir)(tmpdir) ||
      !HHVM_FN(is_writable)(tmpdir)) {
    tmpdir = HHVM_FN(sys_get_temp_dir)();
  }
  tmpdir = File::TranslatePath(tmpdir);
  String pbase = HHVM_FN(basename)(prefix);
  if (pbase.size() > 64) pbase = pbase.substr(0, 63);
  if ((tmpdir.length() > 0) && (tmpdir[tmpdir.length() - 1] == '/')) {
    trailing_slash = """";
  }
  String templ = tmpdir + trailing_slash + pbase + ""XXXXXX"";
  auto buf = templ.get()->mutableData();
  if (UNLIKELY(is_cli_mode())) {
    if (!cli_mkstemp(buf)) return false;
  } else {
    int fd = mkstemp(buf);
    if (fd < 0) {
      Logger::Verbose(""%s/%d: %s"", __FUNCTION__, __LINE__,
                      folly::errnoStr(errno).c_str());
      return false;
    }

    close(fd);
  }
  return templ.setSize(strlen(buf));
}

Variant HHVM_FUNCTION(tmpfile) {
  auto file = req::make<TempFile>(true);
  if (!file->valid()) {
    return false;
  }
  return Variant(file);
}

///////////////////////////////////////////////////////////////////////////////
// directory functions

bool HHVM_FUNCTION(mkdir, const String& pathname, int64_t mode /* = 0777 */,
                   bool recursive /* = false */,
                   const Variant& /*context*/ /* = null */) {
  CHECK_PATH_FALSE(pathname, 1);
  Stream::Wrapper* w = Stream::getWrapperFromURI(pathname);
  if (!w) return false;
  int options = recursive ? k_STREAM_MKDIR_RECURSIVE : 0;
  CHECK_SYSTEM_SILENT(w->mkdir(pathname, mode, options));
  return true;
}

bool HHVM_FUNCTION(rmdir, const String& dirname,
                   const Variant& /*context*/ /* = null */) {
  CHECK_PATH_FALSE(dirname, 1);
  Stream::Wrapper* w = Stream::getWrapperFromURI(dirname);
  if (!w) return false;
  int options = 0;
  CHECK_SYSTEM_SILENT(w->rmdir(dirname, options));
  return true;
}

String HHVM_FUNCTION(dirname,
                     const String& path) {
  return FileUtil::dirname(path);
}

Variant HHVM_FUNCTION(getcwd) {
  return g_context->getCwd();
}

bool HHVM_FUNCTION(chdir,
                   const String& directory) {
  CHECK_PATH_FALSE(directory, 1);
  if (!HHVM_FN(is_dir)(directory)) {
    raise_warning(""chdir(): No such file or directory (errno 2)"");
    return false;
  }

#if ENABLE_EXTENSION_POSIX
  if (!HHVM_FN(posix_access)(directory, X_OK)) {
    raise_warning(""chdir(): Permission denied (errno 13)"");
    return false;
  }
#endif

  g_context->setCwd(HHVM_FN(realpath)(directory).toString());
  return true;
}

#ifndef WIN32
bool HHVM_FUNCTION(chroot,
                   const String& directory) {
  CHECK_PATH_FALSE(directory, 1);
  CHECK_SYSTEM(chroot(File::TranslatePath(directory).data()));
  CHECK_SYSTEM(chdir(""/""));
  return true;
}
#endif

///////////////////////////////////////////////////////////////////////////////

/**
 * A stack maintains the states of nested structures.
 */

struct DirectoryData final : RequestEventHandler {
  void requestInit() override {
    assertx(!defaultDirectory);
  }
  void requestShutdown() override {
    defaultDirectory = nullptr;
  }
  req::ptr<Directory> defaultDirectory;
};

namespace {

IMPLEMENT_STATIC_REQUEST_LOCAL(DirectoryData, s_directory_data);

const StaticString
  s_handle(""handle""),
  s_path(""path"");

req::ptr<Directory> get_dir(const Resource& dir_handle) {
  if (dir_handle.isNull()) {
    auto defaultDir = s_directory_data->defaultDirectory;
    if (!defaultDir) {
      raise_warning(""no Directory resource supplied"");
      return nullptr;
    }
    return defaultDir;
  }

  auto d = dyn_cast_or_null<Directory>(dir_handle);
  if (!d) {
    raise_warning(""Not a valid directory resource"");
    return nullptr;
  }
  return d;
}

bool StringDescending(const String& s1, const String& s2) {
  return s1.more(s2);
}

bool StringAscending(const String& s1, const String& s2) {
  return s1.less(s2);
}

}

Variant HHVM_FUNCTION(dir,
                      const String& directory) {
  CHECK_PATH(directory, 1);
  Variant dir = HHVM_FN(opendir)(directory);
  if (same(dir, false)) {
    return false;
  }
  auto d = SystemLib::AllocDirectoryObject();
  d->setProp(nullptr, s_path.get(), directory.asCell());
  d->setProp(nullptr, s_handle.get(), *dir.asCell());
  return d;
}

Variant HHVM_FUNCTION(opendir, const String& path,
                      const Variant& /*context*/ /* = null */) {
  CHECK_PATH(path, 1);
  Stream::Wrapper* w = Stream::getWrapperFromURI(path);
  if (!w) return false;
  auto p = w->opendir(path);
  if (!p) {
    return false;
  }
  s_directory_data->defaultDirectory = p;
  return Variant(p);
}

Variant HHVM_FUNCTION(readdir,
                      const Variant& dir_handle /* = null */) {
  const Resource& res_dir_handle = dir_handle.isNull()
                                 ? null_resource
                                 : dir_handle.toResource();
  auto dir = get_dir(res_dir_handle);
  if (!dir) {
    return false;
  }
  return dir->read();
}

void HHVM_FUNCTION(rewinddir,
                   const Variant& dir_handle /* = null */) {
  const Resource& res_dir_handle = dir_handle.isNull()
                                 ? null_resource
                                 : dir_handle.toResource();
  auto dir = get_dir(res_dir_handle);
  if (!dir) {
    return;
  }
  dir->rewind();
}

Variant
HHVM_FUNCTION(scandir, const String& directory, bool descending /* = false */,
              const Variant& /*context*/ /* = null */) {
  if (directory.empty()) {
    raise_warning(""scandir(): Directory name cannot be empty"");
    return false;
  }

  CHECK_PATH(directory, 1);
  Stream::Wrapper* w = Stream::getWrapperFromURI(directory);
  if (!w) return false;
  auto dir = w->opendir(directory);
  if (!dir) {
    return false;
  }

  std::vector<String> names;
  while (true) {
    auto name = dir->read();
    if (same(name, false)) {
      break;
    }
    names.push_back(name.toString());
  }
  dir->close();

  if (descending) {
    sort(names.begin(), names.end(), StringDescending);
  } else {
    sort(names.begin(), names.end(), StringAscending);
  }

  Array ret;
  for (unsigned int i = 0; i < names.size(); i++) {
    ret.append(names[i]);
  }
  return ret;
}

void HHVM_FUNCTION(closedir,
                   const Variant& dir_handle /* = null */) {
  const Resource& res_dir_handle = dir_handle.isNull()
                                 ? null_resource
                                 : dir_handle.toResource();
  auto d = get_dir(res_dir_handle);
  if (!d) {
    return;
  }
  if (s_directory_data->defaultDirectory == d) {
    s_directory_data->defaultDirectory = nullptr;
  }
  d->close();
}

///////////////////////////////////////////////////////////////////////////////

const StaticString
  s_STDIN(""STDIN""),
  s_STDOUT(""STDOUT""),
  s_STDERR(""STDERR"");

void StandardExtension::initFile() {
  HHVM_RC_STR(DIRECTORY_SEPARATOR, s_DIRECTORY_SEPARATOR);
  HHVM_RC_STR(PATH_SEPARATOR, s_PATH_SEPARATOR);

  HHVM_RC_INT(FILE_USE_INCLUDE_PATH, PHP_FILE_USE_INCLUDE_PATH);
  HHVM_RC_INT(FILE_IGNORE_NEW_LINES, PHP_FILE_IGNORE_NEW_LINES);
  HHVM_RC_INT(FILE_SKIP_EMPTY_LINES, PHP_FILE_SKIP_EMPTY_LINES);
  HHVM_RC_INT(FILE_APPEND, PHP_FILE_APPEND);
  HHVM_RC_INT(FILE_NO_DEFAULT_CONTEXT, PHP_FILE_NO_DEFAULT_CONTEXT);
  HHVM_RC_INT(FILE_TEXT, 0);
  HHVM_RC_INT(FILE_BINARY, 0);
  HHVM_RC_INT_SAME(FNM_NOESCAPE);
  HHVM_RC_INT_SAME(FNM_CASEFOLD);
  HHVM_RC_INT_SAME(FNM_PERIOD);
  HHVM_RC_INT_SAME(FNM_PATHNAME);
  HHVM_RC_INT(GLOB_AVAILABLE_FLAGS, PHP_GLOB_FLAGS);
  HHVM_RC_INT_SAME(GLOB_BRACE);
  HHVM_RC_INT_SAME(GLOB_ERR);
  HHVM_RC_INT_SAME(GLOB_MARK);
  HHVM_RC_INT_SAME(GLOB_NOCHECK);
  HHVM_RC_INT_SAME(GLOB_NOESCAPE);
  HHVM_RC_INT_SAME(GLOB_NOSORT);
  HHVM_RC_INT_SAME(GLOB_ONLYDIR);
  HHVM_RC_INT(LOCK_SH, k_LOCK_SH);
  HHVM_RC_INT(LOCK_EX, k_LOCK_EX);
  HHVM_RC_INT(LOCK_UN, k_LOCK_UN);
  HHVM_RC_INT(LOCK_NB, k_LOCK_NB);

  HHVM_RC_INT(SCANDIR_SORT_ASCENDING, k_SCANDIR_SORT_ASCENDING);
  HHVM_RC_INT(SCANDIR_SORT_DESCENDING, k_SCANDIR_SORT_DESCENDING);
  HHVM_RC_INT(SCANDIR_SORT_NONE, k_SCANDIR_SORT_NONE);
  HHVM_RC_INT_SAME(SEEK_SET);
  HHVM_RC_INT_SAME(SEEK_CUR);
  HHVM_RC_INT_SAME(SEEK_END);

  Native::registerConstant(s_STDIN.get(),  BuiltinFiles::GetSTDIN);
  Native::registerConstant(s_STDOUT.get(), BuiltinFiles::GetSTDOUT);
  Native::registerConstant(s_STDERR.get(), BuiltinFiles::GetSTDERR);

  HHVM_RC_INT(INI_SCANNER_NORMAL, k_INI_SCANNER_NORMAL);
  HHVM_RC_INT(INI_SCANNER_RAW,    k_INI_SCANNER_RAW);

  HHVM_RC_INT(PATHINFO_BASENAME,  PHP_PATHINFO_BASENAME);
  HHVM_RC_INT(PATHINFO_DIRNAME,   PHP_PATHINFO_DIRNAME);
  HHVM_RC_INT(PATHINFO_EXTENSION, PHP_PATHINFO_EXTENSION);
  HHVM_RC_INT(PATHINFO_FILENAME,  PHP_PATHINFO_FILENAME);

  HHVM_FE(fopen);
  HHVM_FE(popen);
  HHVM_FE(fclose);
  HHVM_FE(pclose);
  HHVM_FE(fseek);
  HHVM_FE(rewind);
  HHVM_FE(ftell);
  HHVM_FE(feof);
  HHVM_FE(fstat);
  HHVM_FE(fread);
  HHVM_FE(fgetc);
  HHVM_FE(fgets);
  HHVM_FE(fgetss);
  HHVM_FE(fscanf);
  HHVM_FE(fpassthru);
  HHVM_FE(fwrite);
  HHVM_FE(fputs);
  HHVM_FE(fprintf);
  HHVM_FE(vfprintf);
  HHVM_FE(fflush);
  HHVM_FE(ftruncate);
  HHVM_FE(flock);
  HHVM_FE(fputcsv);
  HHVM_FE(fgetcsv);
  HHVM_FE(file_get_contents);
  HHVM_FE(file_put_contents);
  HHVM_FE(file);
  HHVM_FE(readfile);
  HHVM_FE(move_uploaded_file);
  HHVM_FE(parse_ini_file);
  HHVM_FE(parse_ini_string);
  HHVM_FE(md5_file);
  HHVM_FE(sha1_file);
  HHVM_FE(chmod);
  HHVM_FE(chown);
  HHVM_FE(lchown);
  HHVM_FE(chgrp);
  HHVM_FE(lchgrp);
  HHVM_FE(touch);
  HHVM_FE(copy);
  HHVM_FE(rename);
  HHVM_FE(umask);
  HHVM_FE(unlink);
  HHVM_FE(link);
  HHVM_FE(symlink);
  HHVM_FE(basename);
  HHVM_FE(fnmatch);
  HHVM_FE(glob);
  HHVM_FE(tempnam);
  HHVM_FE(tmpfile);
  HHVM_FE(fileperms);
  HHVM_FE(fileinode);
  HHVM_FE(filesize);
  HHVM_FE(fileowner);
  HHVM_FE(filegroup);
  HHVM_FE(fileatime);
  HHVM_FE(filemtime);
  HHVM_FE(filectime);
  HHVM_FE(filetype);
  HHVM_FE(linkinfo);
  HHVM_FE(is_writable);
  HHVM_FE(is_writeable);
  HHVM_FE(is_readable);
  HHVM_FE(is_executable);
  HHVM_FE(is_file);
  HHVM_FE(is_dir);
  HHVM_FE(is_link);
  HHVM_FE(is_uploaded_file);
  HHVM_FE(file_exists);
  HHVM_FE(stat);
  HHVM_FE(lstat);
  HHVM_FE(clearstatcache);
  HHVM_FE(readlink_internal);
  HHVM_FE(readlink);
  HHVM_FE(realpath);
  HHVM_FE(pathinfo);
  HHVM_FE(disk_free_space);
  HHVM_FE(diskfreespace);
  HHVM_FE(disk_total_space);
  HHVM_FE(mkdir);
  HHVM_FE(rmdir);
  HHVM_FE(dirname);
  HHVM_FE(getcwd);
  HHVM_FE(chdir);
#ifndef WIN32
  HHVM_FE(chroot);
#endif
  HHVM_FE(dir);
  HHVM_FE(opendir);
  HHVM_FE(readdir);
  HHVM_FE(rewinddir);
  HHVM_FE(scandir);
  HHVM_FE(closedir);

  loadSystemlib(""std_file"");
}

///////////////////////////////////////////////////////////////////////////////
}
",16318,True,2991.657971093451,median
"/*
 * Copyright (c) Contributors to the Open 3D Engine Project.
 * For complete copyright and license terms please see the LICENSE at the root of this distribution.
 *
 * SPDX-License-Identifier: Apache-2.0 OR MIT
 *
 */
#include ""MainWindow.h""

#include ""AssetTreeFilterModel.h""
#include ""AssetTreeItem.h""
#include ""ConnectionEditDialog.h""
#include ""ProductAssetTreeItemData.h""
#include ""ProductAssetTreeModel.h""
#include ""SourceAssetTreeItemData.h""
#include ""SourceAssetTreeModel.h""

#include <AzFramework/Asset/AssetSystemBus.h>


#include <AzQtComponents/AzQtComponentsAPI.h>
#include <AzQtComponents/Components/ConfigHelpers.h>
#include <AzQtComponents/Components/Style.h>
#include <AzQtComponents/Components/StyleManager.h>
#include <AzQtComponents/Components/Widgets/LineEdit.h>
#include <AzQtComponents/Utilities/QtWindowUtilities.h>
#include <AzQtComponents/Utilities/DesktopUtilities.h>

#include <native/resourcecompiler/JobsModel.h>
#include ""native/ui/ui_MainWindow.h""
#include ""native/ui/JobTreeViewItemDelegate.h""


#include ""../utilities/GUIApplicationManager.h""
#include ""../utilities/ApplicationServer.h""
#include ""../connection/connectionManager.h""
#include ""../connection/connection.h""
#include ""../resourcecompiler/rccontroller.h""
#include ""../resourcecompiler/RCJobSortFilterProxyModel.h""


#include <QClipboard>
#include <QDesktopServices>
#include <QMessageBox>
#include <QUrl>
#include <QKeyEvent>

static const char* g_showContextDetailsKey = ""ShowContextDetailsTable"";
static const QString g_jobFilteredSearchWidgetState = QStringLiteral(""jobFilteredSearchWidget"");
static const qint64 AssetTabFilterUpdateIntervalMs = 5000;

MainWindow::Config MainWindow::loadConfig(QSettings& settings)
{
    using namespace AzQtComponents;

    Config config = defaultConfig();

    // Asset Status
    {
        ConfigHelpers::GroupGuard assetStatus(&settings, QStringLiteral(""AssetStatus""));
        ConfigHelpers::read<int>(settings, QStringLiteral(""JobStatusColumnWidth""), config.jobStatusColumnWidth);
        ConfigHelpers::read<int>(settings, QStringLiteral(""JobSourceColumnWidth""), config.jobSourceColumnWidth);
        ConfigHelpers::read<int>(settings, QStringLiteral(""JobPlatformColumnWidth""), config.jobPlatformColumnWidth);
        ConfigHelpers::read<int>(settings, QStringLiteral(""JobKeyColumnWidth""), config.jobKeyColumnWidth);
        ConfigHelpers::read<int>(settings, QStringLiteral(""JobCompletedColumnWidth""), config.jobCompletedColumnWidth);
    }

    // Event Log Details
    {
        ConfigHelpers::GroupGuard eventLogDetails(&settings, QStringLiteral(""EventLogDetails""));
        ConfigHelpers::read<int>(settings, QStringLiteral(""LogTypeColumnWidth""), config.logTypeColumnWidth);
    }

    return config;
}

MainWindow::Config MainWindow::defaultConfig()
{
    // These are used if the values can't be read from AssetProcessorConfig.ini.
    Config config;

    config.jobStatusColumnWidth = 100;
    config.jobSourceColumnWidth = 160;
    config.jobPlatformColumnWidth = 100;
    config.jobKeyColumnWidth = 120;
    config.jobCompletedColumnWidth = 160;

    config.logTypeColumnWidth = 150;

    return config;
}

MainWindow::MainWindow(GUIApplicationManager* guiApplicationManager, QWidget* parent)
    : QMainWindow(parent)
    , m_guiApplicationManager(guiApplicationManager)
    , m_jobSortFilterProxy(new AssetProcessor::JobSortFilterProxyModel(this))
    , m_logSortFilterProxy(new LogSortFilterProxy(this))
    , m_jobsModel(new AssetProcessor::JobsModel(this))
    , m_logsModel(new AzToolsFramework::Logging::LogTableModel(this))
    , ui(new Ui::MainWindow)
    , m_loggingPanel(nullptr)
    , m_fileSystemWatcher(new QFileSystemWatcher(this))
{
    ui->setupUi(this);

    // Don't show the ""Filter by:"" text on this filter widget
    ui->jobFilteredSearchWidget->clearLabelText();
    ui->detailsFilterWidget->clearLabelText();
    ui->timerContainerWidget->setVisible(false);
}

bool MainWindow::eventFilter(QObject* /*obj*/, QEvent* event)
{
    if (event->type() == QEvent::KeyPress)
    {
        QKeyEvent* keyEvent = static_cast<QKeyEvent*>(event);
        if (keyEvent->key() == Qt::Key::Key_Space)
        {
            // Stop space key from opening filter list.
            return true;
        }
    }
    return false;
}

void MainWindow::Activate()
{
    using namespace AssetProcessor;

    m_sharedDbConnection = AZStd::shared_ptr<AzToolsFramework::AssetDatabase::AssetDatabaseConnection>(aznew AzToolsFramework::AssetDatabase::AssetDatabaseConnection());
    m_sharedDbConnection->OpenDatabase();

    ui->projectLabel->setText(QStringLiteral(""%1: %2"")
        .arg(tr(""Project""))
        .arg(QDir{m_guiApplicationManager->GetProjectPath()}.absolutePath()));

    ui->rootLabel->setText(QStringLiteral(""%1: %2"")
        .arg(tr(""Root""))
        .arg(m_guiApplicationManager->GetSystemRoot().absolutePath()));

    ui->portLabel->setText(QStringLiteral(""%1: %2"")
        .arg(tr(""Processor port""))
        .arg(m_guiApplicationManager->GetApplicationServer()->GetServerListeningPort()));

    connect(ui->supportButton, &QPushButton::clicked, this, &MainWindow::OnSupportClicked);

    ui->buttonList->addTab(QStringLiteral(""Jobs""));
    ui->buttonList->addTab(QStringLiteral(""Assets""));
    ui->buttonList->addTab(QStringLiteral(""Logs""));
    ui->buttonList->addTab(QStringLiteral(""Connections""));
    ui->buttonList->addTab(QStringLiteral(""Tools""));

    connect(ui->buttonList, &AzQtComponents::SegmentBar::currentChanged, ui->dialogStack, &QStackedWidget::setCurrentIndex);
    const int startIndex = static_cast<int>(DialogStackIndex::Jobs);
    ui->dialogStack->setCurrentIndex(startIndex);
    ui->buttonList->setCurrentIndex(startIndex);

    //Connection view
    ui->connectionTreeView->setModel(m_guiApplicationManager->GetConnectionManager());
    ui->connectionTreeView->setEditTriggers(QAbstractItemView::CurrentChanged);
    ui->connectionTreeView->header()->setSectionResizeMode(ConnectionManager::IdColumn, QHeaderView::Stretch);
    ui->connectionTreeView->header()->setSectionResizeMode(ConnectionManager::AutoConnectColumn, QHeaderView::Fixed);
    ui->connectionTreeView->header()->resizeSection(ConnectionManager::StatusColumn, 160);
    ui->connectionTreeView->header()->resizeSection(ConnectionManager::IpColumn, 150);
    ui->connectionTreeView->header()->resizeSection(ConnectionManager::PortColumn, 60);
    ui->connectionTreeView->header()->resizeSection(ConnectionManager::PlatformColumn, 60);
    ui->connectionTreeView->header()->resizeSection(ConnectionManager::AutoConnectColumn, 60);

    ui->connectionTreeView->header()->setStretchLastSection(false);
    connect(ui->connectionTreeView->selectionModel(), &QItemSelectionModel::selectionChanged, this, &MainWindow::OnConnectionSelectionChanged);


    ui->editConnectionButton->setEnabled(false);
    ui->removeConnectionButton->setEnabled(false);
    connect(ui->editConnectionButton, &QPushButton::clicked, this, &MainWindow::OnEditConnection);
    connect(ui->addConnectionButton, &QPushButton::clicked, this, &MainWindow::OnAddConnection);
    connect(ui->removeConnectionButton, &QPushButton::clicked, this, &MainWindow::OnRemoveConnection);
    connect(ui->connectionTreeView, &QTreeView::doubleClicked, this, [this](const QModelIndex& index) {
        EditConnection(index);
    });

    ui->connectionTreeView->setContextMenuPolicy(Qt::CustomContextMenu);
    connect(ui->connectionTreeView, &QTreeView::customContextMenuRequested, this, &MainWindow::OnConnectionContextMenu);

    //allowed list connections
    connect(m_guiApplicationManager->GetConnectionManager(), &ConnectionManager::FirstTimeAddedToRejctedList, this, &MainWindow::FirstTimeAddedToRejctedList);
    connect(m_guiApplicationManager->GetConnectionManager(), &ConnectionManager::SyncAllowedListAndRejectedList, this, &MainWindow::SyncAllowedListAndRejectedList);
    connect(ui->allowListAllowedListConnectionsListView, &QListView::clicked, this, &MainWindow::OnAllowedListConnectionsListViewClicked);
    ui->allowListAllowedListConnectionsListView->setModel(&m_allowedListAddresses);
    connect(ui->allowedListRejectedConnectionsListView, &QListView::clicked, this, &MainWindow::OnRejectedConnectionsListViewClicked);
    ui->allowedListRejectedConnectionsListView->setModel(&m_rejectedAddresses);

    connect(ui->allowedListEnableCheckBox, &QCheckBox::toggled, this, &MainWindow::OnAllowedListCheckBoxToggled);

    connect(ui->allowedListAddHostNameToolButton, &QToolButton::clicked, this, &MainWindow::OnAddHostNameAllowedListButtonClicked);
    connect(ui->allowedListAddIPToolButton, &QPushButton::clicked, this, &MainWindow::OnAddIPAllowedListButtonClicked);

    connect(ui->allowedListToAllowedListToolButton, &QPushButton::clicked, this, &MainWindow::OnToAllowedListButtonClicked);
    connect(ui->allowedListToRejectedListToolButton, &QToolButton::clicked, this, &MainWindow::OnToRejectedListButtonClicked);

    //set the input validator for ip addresses on the add address line edit
    QRegExp validHostName(""^((?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|\\\\b-){0,61}[0-9A-Za-z])?(?:\\\\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|\\\\b-){0,61}[0-9A-Za-z])?)*\\\\.?)$"");
    QRegExp validIP(""^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\\\/([0-9]|[1-2][0-9]|3[0-2]))?$|^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*(\\\\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8]))?$"");

    QRegExpValidator* hostNameValidator = new QRegExpValidator(validHostName, this);
    ui->allowedListAddHostNameLineEdit->setValidator(hostNameValidator);

    QRegExpValidator* ipValidator = new QRegExpValidator(validIP, this);
    ui->allowedListAddIPLineEdit->setValidator(ipValidator);

    //Job view
    m_jobSortFilterProxy->setSourceModel(m_jobsModel);
    m_jobSortFilterProxy->setDynamicSortFilter(true);
    m_jobSortFilterProxy->setFilterKeyColumn(JobsModel::ColumnSource);

    ui->jobTreeView->setModel(m_jobSortFilterProxy);
    ui->jobTreeView->setSortingEnabled(true);
    ui->jobTreeView->header()->setDefaultAlignment(Qt::AlignVCenter | Qt::AlignHCenter);
    ui->jobTreeView->setItemDelegate(new AssetProcessor::JobTreeViewItemDelegate(ui->jobTreeView));

    ui->jobTreeView->setToolTip(tr(""Click to view Job Log""));

    ui->detailsFilterWidget->SetTypeFilterVisible(true);
    connect(ui->detailsFilterWidget, &AzQtComponents::FilteredSearchWidget::TextFilterChanged, m_logSortFilterProxy,
        static_cast<void (QSortFilterProxyModel::*)(const QString&)>(&LogSortFilterProxy::setFilterRegExp));
    connect(ui->detailsFilterWidget, &AzQtComponents::FilteredSearchWidget::TypeFilterChanged, m_logSortFilterProxy, &LogSortFilterProxy::onTypeFilterChanged);

    // add filters for each logging type
    ui->detailsFilterWidget->AddTypeFilter(""Status"", ""Debug"", AzToolsFramework::Logging::LogLine::TYPE_DEBUG);
    ui->detailsFilterWidget->AddTypeFilter(""Status"", ""Message"", AzToolsFramework::Logging::LogLine::TYPE_MESSAGE);
    ui->detailsFilterWidget->AddTypeFilter(""Status"", ""Warning"", AzToolsFramework::Logging::LogLine::TYPE_WARNING);
    ui->detailsFilterWidget->AddTypeFilter(""Status"", ""Error"", AzToolsFramework::Logging::LogLine::TYPE_ERROR);

    m_logSortFilterProxy->setDynamicSortFilter(true);
    m_logSortFilterProxy->setSourceModel(m_logsModel);
    m_logSortFilterProxy->setFilterKeyColumn(AzToolsFramework::Logging::LogTableModel::ColumnMessage);
    m_logSortFilterProxy->setFilterCaseSensitivity(Qt::CaseInsensitive);

    ui->jobLogTableView->setModel(m_logSortFilterProxy);
    ui->jobLogTableView->setItemDelegate(new AzToolsFramework::Logging::LogTableItemDelegate(ui->jobLogTableView));
    ui->jobLogTableView->setExpandOnSelection();

    connect(ui->jobTreeView->header(), &QHeaderView::sortIndicatorChanged, m_jobSortFilterProxy, &AssetProcessor::JobSortFilterProxyModel::sort);
    connect(ui->jobTreeView->selectionModel(), &QItemSelectionModel::selectionChanged, this, &MainWindow::JobSelectionChanged);
    ui->jobFilteredSearchWidget->SetTypeFilterVisible(true);
    ui->jobFilteredSearchWidget->assetTypeSelectorButton()->installEventFilter(this);

    // listen for job status changes in order to update the log view with the latest log data
    connect(m_guiApplicationManager->GetRCController(), &AssetProcessor::RCController::JobStatusChanged, this, &MainWindow::JobStatusChanged);

    ui->jobContextLogTableView->setModel(new AzToolsFramework::Logging::ContextDetailsLogTableModel(ui->jobContextLogTableView));
    ui->jobContextLogTableView->setItemDelegate(new AzQtComponents::TableViewItemDelegate(ui->jobContextLogTableView));
    ui->jobContextLogTableView->setExpandOnSelection();

    // Don't collapse the jobContextContainer
    ui->jobDialogSplitter->setCollapsible(2, false);

    // Note: the settings can't be used in ::MainWindow(), because the application name
    // hasn't been set up and therefore the settings will load from somewhere different than later
    // on.
    QSettings settings;
    bool showContextDetails = settings.value(g_showContextDetailsKey, false).toBool();
    ui->jobContextLogDetails->setChecked(showContextDetails);

    // The context log details are shown by default, so only do anything with them on startup
    // if they should be hidden based on the loaded settings
    if (!showContextDetails)
    {
        SetContextLogDetailsVisible(showContextDetails);
    }

    connect(ui->jobContextLogDetails, &QCheckBox::toggled, this, [this](bool visible) {
        SetContextLogDetailsVisible(visible);

        QSettings settingsObj;
        settingsObj.setValue(g_showContextDetailsKey, visible);
    });

    connect(ui->jobLogTableView->selectionModel(), &QItemSelectionModel::selectionChanged, this, &MainWindow::JobLogSelectionChanged);

    const auto statuses =
    {
        AzToolsFramework::AssetSystem::JobStatus::Failed,
        AzToolsFramework::AssetSystem::JobStatus::Completed,
        AzToolsFramework::AssetSystem::JobStatus::Queued,
        AzToolsFramework::AssetSystem::JobStatus::InProgress
    };

    const auto category = tr(""Status"");
    for (const auto& status : statuses)
    {
        ui->jobFilteredSearchWidget->AddTypeFilter(category, JobsModel::GetStatusInString(status, 0, 0),
            QVariant::fromValue(status));
    }

    AssetProcessor::CustomJobStatusFilter customFilter{ true };
    ui->jobFilteredSearchWidget->AddTypeFilter(category, ""Completed w/ Warnings"", QVariant::fromValue(customFilter));

    connect(ui->jobFilteredSearchWidget, &AzQtComponents::FilteredSearchWidget::TypeFilterChanged,
        m_jobSortFilterProxy, &AssetProcessor::JobSortFilterProxyModel::OnJobStatusFilterChanged);
    connect(ui->jobFilteredSearchWidget, &AzQtComponents::FilteredSearchWidget::TextFilterChanged,
        m_jobSortFilterProxy,
        static_cast<void (QSortFilterProxyModel::*)(const QString&)>(&AssetProcessor::JobSortFilterProxyModel::setFilterRegExp));
    {
        QSettings settingsObj(this);
        ui->jobFilteredSearchWidget->readSettings(settingsObj, g_jobFilteredSearchWidgetState);
    }
    auto writeJobFilterSettings = [this]()
    {
        QSettings settingsObj(this);
        ui->jobFilteredSearchWidget->writeSettings(settingsObj, g_jobFilteredSearchWidgetState);
    };
    connect(ui->jobFilteredSearchWidget, &AzQtComponents::FilteredSearchWidget::TypeFilterChanged,
        this, writeJobFilterSettings);
    connect(ui->jobFilteredSearchWidget, &AzQtComponents::FilteredSearchWidget::TextFilterChanged,
        this, writeJobFilterSettings);

    // Asset view
    m_sourceAssetTreeFilterModel = new AssetProcessor::AssetTreeFilterModel(this);
    m_sourceModel = new AssetProcessor::SourceAssetTreeModel(m_sharedDbConnection, this);
    m_sourceModel->Reset();
    m_sourceAssetTreeFilterModel->setSourceModel(m_sourceModel);
    ui->SourceAssetsTreeView->setModel(m_sourceAssetTreeFilterModel);
    connect(ui->assetDataFilteredSearchWidget, &AzQtComponents::FilteredSearchWidget::TextFilterChanged,
        m_sourceAssetTreeFilterModel, static_cast<void (QSortFilterProxyModel::*)(const QString&)>(&AssetTreeFilterModel::FilterChanged));

    m_productAssetTreeFilterModel = new AssetProcessor::AssetTreeFilterModel(this);
    m_productModel = new AssetProcessor::ProductAssetTreeModel(m_sharedDbConnection, this);
    m_productModel->Reset();
    m_productAssetTreeFilterModel->setSourceModel(m_productModel);
    ui->ProductAssetsTreeView->setModel(m_productAssetTreeFilterModel);
    connect(ui->assetDataFilteredSearchWidget, &AzQtComponents::FilteredSearchWidget::TextFilterChanged,
        m_productAssetTreeFilterModel, static_cast<void (QSortFilterProxyModel::*)(const QString&)>(&AssetTreeFilterModel::FilterChanged));

    AzQtComponents::StyleManager::setStyleSheet(ui->sourceAssetDetailsPanel, QStringLiteral(""style:AssetProcessor.qss""));
    AzQtComponents::StyleManager::setStyleSheet(ui->productAssetDetailsPanel, QStringLiteral(""style:AssetProcessor.qss""));

    ui->sourceAssetDetailsPanel->RegisterAssociatedWidgets(
        ui->SourceAssetsTreeView,
        m_sourceModel,
        m_sourceAssetTreeFilterModel,
        ui->ProductAssetsTreeView,
        m_productModel,
        m_productAssetTreeFilterModel,
        ui->assetsTabWidget);
    ui->productAssetDetailsPanel->RegisterAssociatedWidgets(
        ui->SourceAssetsTreeView,
        m_sourceModel,
        m_sourceAssetTreeFilterModel,
        ui->ProductAssetsTreeView,
        m_productModel,
        m_productAssetTreeFilterModel,
        ui->assetsTabWidget);
    ui->productAssetDetailsPanel->SetScannerInformation(ui->missingDependencyScanResults, m_guiApplicationManager->GetAssetProcessorManager()->GetDatabaseConnection());
    ui->productAssetDetailsPanel->SetScanQueueEnabled(false);

    connect(ui->SourceAssetsTreeView->selectionModel(), &QItemSelectionModel::selectionChanged, ui->sourceAssetDetailsPanel, &SourceAssetDetailsPanel::AssetDataSelectionChanged);
    connect(ui->ProductAssetsTreeView->selectionModel(), &QItemSelectionModel::selectionChanged, ui->productAssetDetailsPanel, &ProductAssetDetailsPanel::AssetDataSelectionChanged);
    connect(ui->assetsTabWidget, &QTabWidget::currentChanged, this, &MainWindow::OnAssetTabChange);

    ui->ProductAssetsTreeView->setContextMenuPolicy(Qt::CustomContextMenu);
    connect(ui->ProductAssetsTreeView, &QWidget::customContextMenuRequested, this, &MainWindow::ShowProductAssetContextMenu);

    ui->SourceAssetsTreeView->setContextMenuPolicy(Qt::CustomContextMenu);
    connect(ui->SourceAssetsTreeView, &QWidget::customContextMenuRequested, this, &MainWindow::ShowSourceAssetContextMenu);

    SetupAssetSelectionCaching();

    //Log View
    m_loggingPanel = ui->LoggingPanel;
    m_loggingPanel->SetStorageID(AZ_CRC(""AssetProcessor::LogPanel"", 0x75baa468));

    connect(ui->logButton, &QPushButton::clicked, this, &MainWindow::DesktopOpenJobLogs);

    if (!m_loggingPanel->LoadState())
    {
        // if unable to load state then show the default tabs
        ResetLoggingPanel();
    }

    AzQtComponents::ConfigHelpers::loadConfig<Config, MainWindow>(m_fileSystemWatcher, &m_config, QStringLiteral(""style:AssetProcessorConfig.ini""), this, std::bind(&MainWindow::ApplyConfig, this));
    ApplyConfig();

    connect(m_loggingPanel, &AzToolsFramework::LogPanel::StyledLogPanel::TabsReset, this, &MainWindow::ResetLoggingPanel);
    connect(m_guiApplicationManager->GetRCController(), &AssetProcessor::RCController::JobStatusChanged, m_jobsModel, &AssetProcessor::JobsModel::OnJobStatusChanged);
    connect(m_guiApplicationManager->GetAssetProcessorManager(), &AssetProcessor::AssetProcessorManager::JobRemoved, m_jobsModel, &AssetProcessor::JobsModel::OnJobRemoved);
    connect(m_guiApplicationManager->GetAssetProcessorManager(), &AssetProcessor::AssetProcessorManager::SourceDeleted, m_jobsModel, &AssetProcessor::JobsModel::OnSourceRemoved);
    connect(m_guiApplicationManager->GetAssetProcessorManager(), &AssetProcessor::AssetProcessorManager::SourceFolderDeleted, m_jobsModel, &AssetProcessor::JobsModel::OnFolderRemoved);

    connect(ui->jobTreeView, &AzQtComponents::TableView::customContextMenuRequested, this, &MainWindow::ShowJobViewContextMenu);
    connect(ui->jobContextLogTableView, &AzQtComponents::TableView::customContextMenuRequested, this, &MainWindow::ShowLogLineContextMenu);
    connect(ui->jobLogTableView, &AzQtComponents::TableView::customContextMenuRequested, this, &MainWindow::ShowJobLogContextMenu);

    m_jobsModel->PopulateJobsFromDatabase();

    // Tools tab:
    connect(ui->fullScanButton, &QPushButton::clicked, this, &MainWindow::OnRescanButtonClicked);

    settings.beginGroup(""Options"");
    bool zeroAnalysisModeFromSettings = settings.value(""EnableZeroAnalysis"", QVariant(true)).toBool();
    settings.endGroup();

    QObject::connect(ui->modtimeSkippingCheckBox, &QCheckBox::stateChanged, this,
        [this](int newCheckState)
    {
        bool newOption = newCheckState == Qt::Checked ? true : false;
        m_guiApplicationManager->GetAssetProcessorManager()->SetEnableModtimeSkippingFeature(newOption);
        QSettings settingsInCallback;
        settingsInCallback.beginGroup(""Options"");
        settingsInCallback.setValue(""EnableZeroAnalysis"", QVariant(newOption));
        settingsInCallback.endGroup();
    });

    m_guiApplicationManager->GetAssetProcessorManager()->SetEnableModtimeSkippingFeature(zeroAnalysisModeFromSettings);
    ui->modtimeSkippingCheckBox->setCheckState(zeroAnalysisModeFromSettings ? Qt::Checked : Qt::Unchecked);
}

void MainWindow::SetupAssetSelectionCaching()
{
    // Connect the source model resetting to preserve selection and restore it after the model is reset.
    connect(m_sourceModel, &QAbstractItemModel::modelAboutToBeReset, [&]()
    {
        QItemSelection sourceSelection = m_sourceAssetTreeFilterModel->mapSelectionToSource(ui->SourceAssetsTreeView->selectionModel()->selection());

        if (sourceSelection.indexes().count() == 0 || !sourceSelection.indexes()[0].isValid())
        {
            return;
        }
        QModelIndex sourceModelIndex = sourceSelection.indexes()[0];
        AssetProcessor::AssetTreeItem* childItem = static_cast<AssetProcessor::AssetTreeItem*>(sourceModelIndex.internalPointer());
        m_cachedSourceAssetSelection = childItem->GetData()->m_assetDbName;
    });

    connect(m_sourceModel, &QAbstractItemModel::modelReset, [&]()
    {
        if (m_cachedSourceAssetSelection.empty())
        {
            return;
        }
        QModelIndex goToIndex = m_sourceModel->GetIndexForSource(m_cachedSourceAssetSelection);
        // If the cached selection was deleted or is no longer available, clear the selection.
        if (!goToIndex.isValid())
        {
            m_cachedSourceAssetSelection.clear();
            ui->ProductAssetsTreeView->selectionModel()->clearSelection();
            // ClearSelection says in the Qt docs that the selectionChange signal will be sent, but that wasn't happening,
            // so force the details panel to refresh.
            ui->sourceAssetDetailsPanel->AssetDataSelectionChanged(QItemSelection(), QItemSelection());
            return;
        }
        m_sourceAssetTreeFilterModel->ForceModelIndexVisible(goToIndex);
        QModelIndex filterIndex = m_sourceAssetTreeFilterModel->mapFromSource(goToIndex);
        ui->SourceAssetsTreeView->scrollTo(filterIndex, QAbstractItemView::ScrollHint::EnsureVisible);
        ui->SourceAssetsTreeView->selectionModel()->select(filterIndex, AssetProcessor::AssetTreeModel::GetAssetTreeSelectionFlags());
    });

    // Connect the product model resetting to preserve selection and restore it after the model is reset.
    connect(m_productModel, &QAbstractItemModel::modelAboutToBeReset, [&]()
    {
        QItemSelection productSelection = m_productAssetTreeFilterModel->mapSelectionToSource(ui->ProductAssetsTreeView->selectionModel()->selection());

        if (productSelection.indexes().count() == 0 || !productSelection.indexes()[0].isValid())
        {
            return;
        }
        QModelIndex productModelIndex = productSelection.indexes()[0];
        AssetProcessor::AssetTreeItem* childItem = static_cast<AssetProcessor::AssetTreeItem*>(productModelIndex.internalPointer());
        m_cachedProductAssetSelection = childItem->GetData()->m_assetDbName;
    });

    connect(m_productModel, &QAbstractItemModel::modelReset, [&]()
    {
        if (m_cachedProductAssetSelection.empty())
        {
            return;
        }
        QModelIndex goToIndex = m_productModel->GetIndexForProduct(m_cachedProductAssetSelection);
        // If the cached selection was deleted or is no longer available, clear the selection.
        if (!goToIndex.isValid())
        {
            m_cachedProductAssetSelection.clear();
            ui->ProductAssetsTreeView->selectionModel()->clearSelection();
            // ClearSelection says in the Qt docs that the selectionChange signal will be sent, but that wasn't happening,
            // so force the details panel to refresh.
            ui->productAssetDetailsPanel->AssetDataSelectionChanged(QItemSelection(), QItemSelection());
            return;
        }
        m_productAssetTreeFilterModel->ForceModelIndexVisible(goToIndex);
        QModelIndex filterIndex = m_productAssetTreeFilterModel->mapFromSource(goToIndex);
        ui->ProductAssetsTreeView->scrollTo(filterIndex, QAbstractItemView::ScrollHint::EnsureVisible);
        ui->ProductAssetsTreeView->selectionModel()->select(filterIndex, AssetProcessor::AssetTreeModel::GetAssetTreeSelectionFlags());
    });
}

void MainWindow::OnRescanButtonClicked()
{
    m_guiApplicationManager->Rescan();
}

void MainWindow::OnSupportClicked(bool /*checked*/)
{
    QDesktopServices::openUrl(
        QStringLiteral(""https://o3de.org/docs/user-guide/assets/pipeline/""));
}

void MainWindow::EditConnection(const QModelIndex& index)
{
    if (index.data(ConnectionManager::UserConnectionRole).toBool())
    {
        ConnectionEditDialog dialog(m_guiApplicationManager->GetConnectionManager(), index, this);

        dialog.exec();
    }
}

void MainWindow::OnConnectionContextMenu(const QPoint& point)
{
    QPersistentModelIndex index = ui->connectionTreeView->indexAt(point);

    bool isUserConnection = index.isValid() && index.data(ConnectionManager::UserConnectionRole).toBool();
    QMenu menu(this);

    QAction* editConnectionAction = menu.addAction(""&Edit connection..."");
    editConnectionAction->setEnabled(isUserConnection);
    connect(editConnectionAction, &QAction::triggered, this, [index, this] {
        EditConnection(index);
    });

    menu.exec(ui->connectionTreeView->viewport()->mapToGlobal(point));
}

void MainWindow::OnEditConnection(bool /*checked*/)
{
    auto selectedIndices = ui->connectionTreeView->selectionModel()->selectedRows();
    Q_ASSERT(selectedIndices.count() > 0);

    // Only edit the first connection. Guaranteed above by the edit connection button only being enabled if one connection is selected
    EditConnection(selectedIndices[0]);
}

void MainWindow::OnAddConnection(bool /*checked*/)
{
    m_guiApplicationManager->GetConnectionManager()->addUserConnection();
}

void MainWindow::OnAllowedListConnectionsListViewClicked()
{
    ui->allowedListRejectedConnectionsListView->clearSelection();
}

void MainWindow::OnRejectedConnectionsListViewClicked()
{
    ui->allowListAllowedListConnectionsListView->clearSelection();
}

void MainWindow::OnAllowedListCheckBoxToggled()
{
    if (!ui->allowedListEnableCheckBox->isChecked())
    {
        //warn this is not safe
        if(QMessageBox::Ok == QMessageBox::warning(this, tr(""!!!WARNING!!!""), tr(""Turning off allowed listing poses a significant security risk as it would allow any device to connect to your asset processor and that device will have READ/WRITE access to the Asset Processors file system. Only do this if you sure you know what you are doing and accept the risks.""),
            QMessageBox::Ok | QMessageBox::Cancel, QMessageBox::Cancel))
        {
            ui->allowedListRejectedConnectionsListView->clearSelection();
            ui->allowListAllowedListConnectionsListView->clearSelection();
            ui->allowedListAddHostNameLineEdit->setEnabled(false);
            ui->allowedListAddHostNameToolButton->setEnabled(false);
            ui->allowedListAddIPLineEdit->setEnabled(false);
            ui->allowedListAddIPToolButton->setEnabled(false);
            ui->allowListAllowedListConnectionsListView->setEnabled(false);
            ui->allowedListRejectedConnectionsListView->setEnabled(false);
            ui->allowedListToAllowedListToolButton->setEnabled(false);
            ui->allowedListToRejectedListToolButton->setEnabled(false);
        }
        else
        {
            ui->allowedListEnableCheckBox->setChecked(true);
        }
    }
    else
    {
        ui->allowedListAddHostNameLineEdit->setEnabled(true);
        ui->allowedListAddHostNameToolButton->setEnabled(true);
        ui->allowedListAddIPLineEdit->setEnabled(true);
        ui->allowedListAddIPToolButton->setEnabled(true);
        ui->allowListAllowedListConnectionsListView->setEnabled(true);
        ui->allowedListRejectedConnectionsListView->setEnabled(true);
        ui->allowedListToAllowedListToolButton->setEnabled(true);
        ui->allowedListToRejectedListToolButton->setEnabled(true);
    }

    m_guiApplicationManager->GetConnectionManager()->AllowedListingEnabled(ui->allowedListEnableCheckBox->isChecked());
}

void MainWindow::OnAddHostNameAllowedListButtonClicked()
{
    QString text = ui->allowedListAddHostNameLineEdit->text();
    const QRegExpValidator *hostnameValidator = static_cast<const QRegExpValidator *>(ui->allowedListAddHostNameLineEdit->validator());
    int pos;
    QValidator::State state = hostnameValidator->validate(text, pos);
    if (state == QValidator::Acceptable)
    {
        auto lineEdit = ui->allowedListAddHostNameLineEdit;
        m_guiApplicationManager->GetConnectionManager()->AddAddressToAllowedList(text);
        lineEdit->clear();
        // Clear error state set in LineEdit.
        lineEdit->setProperty(AzQtComponents::HasError, false);
        auto errorToolButton = lineEdit->findChild<QToolButton*>(AzQtComponents::ErrorToolButton);
        if (errorToolButton && AzQtComponents::LineEdit::errorIconEnabled(lineEdit))
        {
            errorToolButton->setVisible(false);
        }
    }
}

void MainWindow::OnAddIPAllowedListButtonClicked()
{
    QString text = ui->allowedListAddIPLineEdit->text();
    const QRegExpValidator *ipValidator = static_cast<const QRegExpValidator *>(ui->allowedListAddIPLineEdit->validator());
    int pos;
    QValidator::State state = ipValidator->validate(text, pos);
    if (state== QValidator::Acceptable)
    {
        auto lineEdit = ui->allowedListAddIPLineEdit;
        m_guiApplicationManager->GetConnectionManager()->AddAddressToAllowedList(text);
        lineEdit->clear();
        // Clear error state set in LineEdit.
        lineEdit->setProperty(AzQtComponents::HasError, false);
        auto errorToolButton = lineEdit->findChild<QToolButton*>(AzQtComponents::ErrorToolButton);
        if (errorToolButton && AzQtComponents::LineEdit::errorIconEnabled(lineEdit))
        {
            errorToolButton->setVisible(false);
        }
    }
}

void MainWindow::OnToRejectedListButtonClicked()
{
    QModelIndexList indices = ui->allowListAllowedListConnectionsListView->selectionModel()->selectedIndexes();
    if(!indices.isEmpty() && indices.first().isValid())
    {
        QString itemText = indices.first().data(Qt::DisplayRole).toString();
        m_guiApplicationManager->GetConnectionManager()->RemoveAddressFromAllowedList(itemText);
        m_guiApplicationManager->GetConnectionManager()->AddRejectedAddress(itemText, true);
    }
}

void MainWindow::OnToAllowedListButtonClicked()
{
    QModelIndexList indices = ui->allowedListRejectedConnectionsListView->selectionModel()->selectedIndexes();
    if (!indices.isEmpty() && indices.first().isValid())
    {
        QString itemText = indices.front().data(Qt::DisplayRole).toString();
        m_guiApplicationManager->GetConnectionManager()->RemoveRejectedAddress(itemText);
        m_guiApplicationManager->GetConnectionManager()->AddAddressToAllowedList(itemText);
    }
}

void MainWindow::OnRemoveConnection(bool /*checked*/)
{
    ConnectionManager* manager = m_guiApplicationManager->GetConnectionManager();

    QModelIndexList list = ui->connectionTreeView->selectionModel()->selectedRows();
    for (QModelIndex index: list)
    {
        manager->removeConnection(index);
    }
}

void MainWindow::OnConnectionSelectionChanged(const QItemSelection& /*selected*/, const QItemSelection& /*deselected*/)
{
    auto selectedIndices = ui->connectionTreeView->selectionModel()->selectedRows();
    int selectionCount = selectedIndices.count();

    bool anyUserConnectionsSelected = false;
    for (int i = 0; i < selectionCount; i++)
    {
        QModelIndex selectedIndex = selectedIndices[i];
        if (selectedIndex.data(ConnectionManager::UserConnectionRole).toBool())
        {
            anyUserConnectionsSelected = true;
            break;
        }
    }

    ui->removeConnectionButton->setEnabled(anyUserConnectionsSelected);
    ui->editConnectionButton->setEnabled(anyUserConnectionsSelected && (selectionCount == 1));
}


MainWindow::~MainWindow()
{
    m_guiApplicationManager = nullptr;
    delete ui;
}



void MainWindow::ShowWindow()
{
    show();
    AzQtComponents::bringWindowToTop(this);
}


void MainWindow::SyncAllowedListAndRejectedList(QStringList allowedList, QStringList rejectedList)
{
    m_allowedListAddresses.setStringList(allowedList);
    m_rejectedAddresses.setStringList(rejectedList);
}

void MainWindow::FirstTimeAddedToRejctedList(QString ipAddress)
{
    QMessageBox* msgBox = new QMessageBox(this);
    msgBox->setText(tr(""!!!Rejected Connection!!!""));
    msgBox->setInformativeText(ipAddress + tr("" tried to connect and was rejected because it was not on the allowed list. If you want this connection to be allowed go to connections tab and add it to allowed list.""));
    msgBox->setStandardButtons(QMessageBox::Ok);
    msgBox->setDefaultButton(QMessageBox::Ok);
    msgBox->setWindowModality(Qt::NonModal);
    msgBox->setModal(false);
    msgBox->show();
}

void MainWindow::SaveLogPanelState()
{
    if (m_loggingPanel)
    {
        m_loggingPanel->SaveState();
    }
}

void MainWindow::ResetTimers()
{
    m_scanTime = m_analysisTime = m_processTime = 0;
    m_scanTimer.restart();
    m_analysisTimer.invalidate();
    m_processTimer.invalidate();
}

void MainWindow::CheckStartAnalysisTimers()
{
    if (m_scanTimer.isValid())
    {
        m_scanTime = m_scanTimer.elapsed();
        m_scanTimer.invalidate();
    }
    if (!m_analysisTimer.isValid() && !m_analysisTime)
    {
        m_analysisTimer.start();
    }
}

void MainWindow::CheckStartProcessTimers()
{
    if (m_analysisTimer.isValid())
    {
        m_analysisTime = m_analysisTimer.restart();
        m_analysisTimer.invalidate();
    }

    if (!m_processTimer.isValid() && !m_processTime)
    {
        m_processTimer.start();
    }
}

void MainWindow::CheckEndAnalysisTimer()
{
    if (m_analysisTimer.isValid() && !m_analysisTime)
    {
        m_analysisTime = m_analysisTimer.elapsed();
        m_analysisTimer.invalidate();
    }
}

void MainWindow::CheckEndProcessTimer()
{
    if (m_processTimer.isValid() && !m_processTime)
    {
        m_processTime = m_processTimer.elapsed();
        m_processTimer.invalidate();
    }
}

QString MainWindow::FormatStringTime(qint64 msTime) const
{
    int msecInt{ static_cast<int>(msTime) };
    int timeHrs{ msecInt / (1000 * 60 * 60) };
    msecInt = msecInt % (1000 * 60 * 60);

    int timeMins{ msecInt / (1000 * 60) };
    msecInt = msecInt % (1000 * 60 );

    int timeSecs{ msecInt / 1000 };
    int timeMsec{ msecInt % 1000 };

    QTime timeVal{ timeHrs, timeMins, timeSecs, timeMsec };

    if (timeHrs)
    {
        return timeVal.toString(""h:mm:ss.z"");
    }
    return timeVal.toString(""mm:ss.z"");
}

void MainWindow::IntervalAssetTabFilterRefresh()
{
    if (ui->buttonList->currentIndex() != static_cast<int>(DialogStackIndex::Assets)
        || !ui->assetDataFilteredSearchWidget->hasStringFilter())
    {
        return;
    }

    if (!m_filterRefreshTimer.isValid())
    {
        m_filterRefreshTimer.start();
    }

    if (m_filterRefreshTimer.elapsed() >= AssetTabFilterUpdateIntervalMs)
    {
        emit ui->assetDataFilteredSearchWidget->TextFilterChanged(ui->assetDataFilteredSearchWidget->textFilter());
        m_filterRefreshTimer.restart();
    }
}

void MainWindow::ShutdownAssetTabFilterRefresh()
{
    if (m_filterRefreshTimer.isValid())
    {
        emit ui->assetDataFilteredSearchWidget->TextFilterChanged(ui->assetDataFilteredSearchWidget->textFilter());
    }

    m_filterRefreshTimer.invalidate();
}

void MainWindow::OnAssetProcessorStatusChanged(const AssetProcessor::AssetProcessorStatusEntry entry)
{
    using namespace AssetProcessor;
    QString text;
    switch (entry.m_status)
    {
    case AssetProcessorStatus::Initializing_Gems:
        text = tr(""Initializing Gem...%1"").arg(entry.m_extraInfo);
        break;
    case AssetProcessorStatus::Initializing_Builders:
        text = tr(""Initializing Builders..."");
        break;
    case AssetProcessorStatus::Scanning_Started:
        ResetTimers();
        text = tr(""Scanning..."");
        break;
    case AssetProcessorStatus::Analyzing_Jobs:
        CheckStartAnalysisTimers();
        m_createJobCount = entry.m_count;

        if (m_processJobsCount + m_createJobCount > 0)
        {
            text = tr(""Working, analyzing jobs remaining %1, processing jobs remaining %2..."").arg(m_createJobCount).arg(m_processJobsCount);
            ui->timerContainerWidget->setVisible(false);
            ui->productAssetDetailsPanel->SetScanQueueEnabled(false);

            IntervalAssetTabFilterRefresh();
        }
        else
        {
            CheckEndAnalysisTimer();
            text = tr(""Idle..."");
            ui->timerContainerWidget->setVisible(true);
            m_guiApplicationManager->RemoveOldTempFolders();
            // Once the asset processor goes idle, enable the scan queue.
            // This minimizes the potential for over-reporting missing dependencies (if a queued job would resolve them)
            // and prevents running too many threads with too much work (scanning + processing jobs both take time).
            ui->productAssetDetailsPanel->SetScanQueueEnabled(true);

            ShutdownAssetTabFilterRefresh();
        }
        break;
    case AssetProcessorStatus::Processing_Jobs:
        CheckStartProcessTimers();
        m_processJobsCount = entry.m_count;

        if (m_processJobsCount + m_createJobCount > 0)
        {
            text = tr(""Working, analyzing jobs remaining %1, processing jobs remaining %2..."").arg(m_createJobCount).arg(m_processJobsCount);
            ui->timerContainerWidget->setVisible(false);
            ui->productAssetDetailsPanel->SetScanQueueEnabled(false);

            IntervalAssetTabFilterRefresh();
        }
        else
        {
            CheckEndProcessTimer();
            text = tr(""Idle..."");
            ui->timerContainerWidget->setVisible(true);
            m_guiApplicationManager->RemoveOldTempFolders();
            // Once the asset processor goes idle, enable the scan queue.
            // This minimizes the potential for over-reporting missing dependencies (if a queued job would resolve them)
            // and prevents running too many threads with too much work (scanning + processing jobs both take time).
            ui->productAssetDetailsPanel->SetScanQueueEnabled(true);
            AZ_TracePrintf(
                AssetProcessor::ConsoleChannel,
                ""Job processing completed. Asset Processor is currently idle. Process time: %s\\n"",
                FormatStringTime(m_processTime).toUtf8().constData());
            ShutdownAssetTabFilterRefresh();
        }
        break;
    default:
        text = QString();
        break;
    }

    ui->APStatusValueLabel->setText(QStringLiteral(""%1: %2"")
        .arg(tr(""Status""))
        .arg(text));

    ui->lastScanTimer->setText(FormatStringTime(m_scanTime));
    ui->analysisTimer->setText(FormatStringTime(m_analysisTime));
    ui->processingTimer->setText(FormatStringTime(m_processTime));
}

void MainWindow::HighlightAsset(QString assetPath)
{
    // Make sure that the currently active tab is the job list
    ui->buttonList->setCurrentIndex(static_cast<int>(DialogStackIndex::Jobs));

    // clear all filters
    ui->jobFilteredSearchWidget->ClearTextFilter();
    ui->jobFilteredSearchWidget->ClearTypeFilter();

    // jobs are listed with relative source asset paths, so we need to remove
    // the scan folder prefix from the absolute path
    bool success = true;
    AZStd::vector<AZStd::string> scanFolders;
    AzToolsFramework::AssetSystemRequestBus::BroadcastResult(success, &AzToolsFramework::AssetSystemRequestBus::Events::GetScanFolders, scanFolders);
    if (success)
    {
        for (auto& scanFolder : scanFolders)
        {
            if (assetPath.startsWith(scanFolder.c_str(), Qt::CaseInsensitive))
            {
                // + 1 for the path separator
                assetPath = assetPath.mid(static_cast<int>(scanFolder.size() + 1));
                break;
            }
        }
    }

    // apply the filter for our asset path
    ui->jobFilteredSearchWidget->SetTextFilter(assetPath);

    // select the first item in the list
    ui->jobTreeView->setCurrentIndex(m_jobSortFilterProxy->index(0, 0));
}

void MainWindow::OnAssetTabChange(int index)
{
    AssetTabIndex tabIndex = static_cast<AssetTabIndex>(index);
    switch (tabIndex)
    {
    case AssetTabIndex::Source:
        ui->sourceAssetDetailsPanel->setVisible(true);
        ui->productAssetDetailsPanel->setVisible(false);
        break;
    case AssetTabIndex::Product:
        ui->sourceAssetDetailsPanel->setVisible(false);
        ui->productAssetDetailsPanel->setVisible(true);
        break;
    }
}

void MainWindow::ApplyConfig()
{
    using namespace AssetProcessor;

    // Asset Status
    ui->jobTreeView->header()->resizeSection(JobsModel::ColumnStatus, m_config.jobStatusColumnWidth);
    ui->jobTreeView->header()->resizeSection(JobsModel::ColumnSource, m_config.jobSourceColumnWidth);
    ui->jobTreeView->header()->resizeSection(JobsModel::ColumnPlatform, m_config.jobPlatformColumnWidth);
    ui->jobTreeView->header()->resizeSection(JobsModel::ColumnJobKey, m_config.jobKeyColumnWidth);
    ui->jobTreeView->header()->resizeSection(JobsModel::ColumnCompleted, m_config.jobCompletedColumnWidth);

    // Event Log Details
    ui->jobLogTableView->header()->resizeSection(AzToolsFramework::Logging::LogTableModel::ColumnType, m_config.logTypeColumnWidth);
}

MainWindow::LogSortFilterProxy::LogSortFilterProxy(QObject* parentOjbect) : QSortFilterProxyModel(parentOjbect)
{
}

bool MainWindow::LogSortFilterProxy::filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const
{
    if (!m_logTypes.empty())
    {
        QModelIndex testIndex = sourceModel()->index(sourceRow, 0, sourceParent);
        Q_ASSERT(testIndex.isValid());
        auto indexLogType = static_cast<AzToolsFramework::Logging::LogLine::LogType>(testIndex.data(AzToolsFramework::Logging::LogTableModel::LogTypeRole).toInt());
        if (!m_logTypes.contains(indexLogType))
        {
            return false;
        }
    }
    return QSortFilterProxyModel::filterAcceptsRow(sourceRow, sourceParent);
}

void MainWindow::LogSortFilterProxy::onTypeFilterChanged(const AzQtComponents::SearchTypeFilterList& activeTypeFilters)
{
    beginResetModel();
    m_logTypes.clear();

    for (auto typeIter = activeTypeFilters.begin(), endIter = activeTypeFilters.end(); typeIter != endIter; ++typeIter)
    {
        m_logTypes.insert(static_cast<AzToolsFramework::Logging::LogLine::LogType>(typeIter->metadata.toInt()));
    }
    endResetModel();
}

void MainWindow::SetContextLogDetailsVisible(bool visible)
{
    using namespace AzQtComponents;

    const char* soloClass = ""solo""; // see AssetsTab.qss; this is what provides the right margin around the widgets for the context details

    if (visible)
    {
        Style::removeClass(ui->jobContextLogDetails, soloClass);

        ui->jobLogLayout->removeWidget(ui->jobContextLogBar);
        ui->jobContextLayout->insertWidget(0, ui->jobContextLogBar);
    }
    else
    {
        Style::addClass(ui->jobContextLogDetails, soloClass);

        ui->jobContextLayout->removeWidget(ui->jobContextLogBar);
        ui->jobLogLayout->addWidget(ui->jobContextLogBar);
    }
    ui->jobContextContainer->setVisible(visible);
    ui->jobContextLogLabel->setVisible(visible);
}

void MainWindow::SetContextLogDetails(const QMap<QString, QString>& details)
{
    auto model = qobject_cast<AzToolsFramework::Logging::ContextDetailsLogTableModel*>(ui->jobContextLogTableView->model());

    if (details.isEmpty())
    {
        ui->jobContextLogStackedWidget->setCurrentWidget(ui->jobContextLogPlaceholderLabel);
    }
    else
    {
        ui->jobContextLogStackedWidget->setCurrentWidget(ui->jobContextLogTableView);
    }

    model->SetDetails(details);
}

void MainWindow::ClearContextLogDetails()
{
    SetContextLogDetails({});
}

void MainWindow::UpdateJobLogView(QModelIndex selectedIndex)
{
    if (!m_logsModel)
    {
        return;
    }

    // SelectionMode is set to QAbstractItemView::SingleSelection so there is only one selected item at a time
    AZStd::string jobLog = m_jobSortFilterProxy->data(selectedIndex, AssetProcessor::JobsModel::DataRoles::logRole).toString().toUtf8().data();

    m_logsModel->Clear();
    AzToolsFramework::Logging::LogLine::ParseLog(jobLog.c_str(), jobLog.length() + 1,
        AZStd::bind(&AzToolsFramework::Logging::LogTableModel::AppendLineAsync, m_logsModel, AZStd::placeholders::_1));
    m_logsModel->CommitLines();
    ui->jobLogTableView->scrollToBottom();
    ui->jobLogStackedWidget->setCurrentWidget(ui->jobLogTableView);
}

void MainWindow::JobSelectionChanged(const QItemSelection& selected, const QItemSelection& /*deselected*/)
{
    if (selected.indexes().length() != 0)
    {
        UpdateJobLogView(selected.indexes()[0]);
    }
    // The only alternative is that there has been only a deselection, as otherwise both selected and deselected would be empty
    else
    {
        ui->jobLogStackedWidget->setCurrentWidget(ui->jobLogPlaceholderLabel);
    }

    ClearContextLogDetails();
}

void MainWindow::JobStatusChanged([[maybe_unused]] AssetProcessor::JobEntry entry, [[maybe_unused]] AzToolsFramework::AssetSystem::JobStatus status)
{
    QModelIndexList selectedIndexList = ui->jobTreeView->selectionModel()->selectedIndexes();
    if (selectedIndexList.empty())
    {
        return;
    }

    QModelIndex selectedIndex = selectedIndexList.at(0);

    // retrieve cachedJobInfo for the selected entry
    const QModelIndex sourceIndex = m_jobSortFilterProxy->mapToSource(selectedIndex);
    AssetProcessor::CachedJobInfo* cachedJobInfo = m_jobsModel->getItem(sourceIndex.row());
    AZ_Assert(cachedJobInfo, ""Failed to find cached job info"");
    if (!cachedJobInfo)
    {
        return;
    }

    // ignore the notification if it's not for the selected entry
    if (cachedJobInfo->m_elementId.GetInputAssetName() != entry.m_databaseSourceName)
    {
        return;
    }

    UpdateJobLogView(selectedIndex);
}

void MainWindow::JobLogSelectionChanged(const QItemSelection& selected, const QItemSelection& /*deselected*/)
{
    if (selected.count() == 1)
    {
        const QMap<QString, QString> details = selected.indexes().first().data(AzToolsFramework::Logging::LogTableModel::DetailsRole).value<QMap<QString, QString>>();
        SetContextLogDetails(details);
    }
    else
    {
        ClearContextLogDetails();
    }
}

void MainWindow::DesktopOpenJobLogs()
{
    char resolvedDir[AZ_MAX_PATH_LEN * 2];
    QString currentDir;
    AZ::IO::FileIOBase::GetInstance()->ResolvePath(AssetUtilities::ComputeJobLogFolder().c_str(), resolvedDir, sizeof(resolvedDir));

    currentDir = QString::fromUtf8(resolvedDir);

    if (QFile::exists(currentDir))
    {
        QDesktopServices::openUrl(QUrl::fromLocalFile(currentDir));
    }
    else
    {
        AZ_TracePrintf(AssetProcessor::ConsoleChannel, ""[Error] Logs folder (%s) does not exists.\\n"", currentDir.toUtf8().constData());
    }
}

void MainWindow::ResetLoggingPanel()
{
    if (m_loggingPanel)
    {
        m_loggingPanel->AddLogTab(AzToolsFramework::LogPanel::TabSettings(""Debug"", """", """"));
        m_loggingPanel->AddLogTab(AzToolsFramework::LogPanel::TabSettings(""Messages"", """", """", true, true, true, false));
        m_loggingPanel->AddLogTab(AzToolsFramework::LogPanel::TabSettings(""Warnings/Errors Only"", """", """", false, true, true, false));
    }
}

void MainWindow::ShowJobLogContextMenu(const QPoint& pos)
{
    using namespace AzToolsFramework::Logging;
    QModelIndex sourceIndex = ui->jobLogTableView->indexAt(pos);

    // If there is no index under the mouse cursor, let check the selected index of the view
    if (!sourceIndex.isValid())
    {
        const auto indexes = ui->jobLogTableView->selectionModel()->selectedIndexes();

        if (!indexes.isEmpty())
        {
            sourceIndex = indexes.first();
        }
    }

    QMenu menu;
    QAction* line = menu.addAction(tr(""Copy line""), this, [&]()
    {
        QGuiApplication::clipboard()->setText(sourceIndex.data(LogTableModel::LogLineTextRole).toString());
    });
    QAction* lineDetails = menu.addAction(tr(""Copy line with details""), this, [&]()
    {
        QGuiApplication::clipboard()->setText(sourceIndex.data(LogTableModel::CompleteLogLineTextRole).toString());
    });
    menu.addAction(tr(""Copy all""), this, [&]()
    {
        QGuiApplication::clipboard()->setText(m_logsModel->toString(true));
    });

    if (!sourceIndex.isValid())
    {
        line->setEnabled(false);
        lineDetails->setEnabled(false);
    }

    menu.exec(ui->jobLogTableView->viewport()->mapToGlobal(pos));
}

static QString FindAbsoluteFilePath(const AssetProcessor::CachedJobInfo* cachedJobInfo)
{
    using namespace AzToolsFramework;

    bool result = false;
    AZ::Data::AssetInfo info;
    AZStd::string watchFolder;
    QByteArray assetNameUtf8 = cachedJobInfo->m_elementId.GetInputAssetName().toUtf8();
    AssetSystemRequestBus::BroadcastResult(result, &AssetSystemRequestBus::Events::GetSourceInfoBySourcePath, assetNameUtf8.constData(), info, watchFolder);
    if (!result)
    {
        AZ_Error(""AssetProvider"", false, ""Failed to locate asset info for '%s'."", assetNameUtf8.constData());
    }

    return result
        ? QDir(watchFolder.c_str()).absoluteFilePath(info.m_relativePath.c_str())
        : QString();
};

static void SendShowInAssetBrowserResponse(const QString& filePath, ConnectionManager* connectionManager, unsigned int connectionId, QByteArray data)
{
    Connection* connection = connectionManager->getConnection(connectionId);
    if (!connection)
    {
        return;
    }

    AzToolsFramework::AssetSystem::WantAssetBrowserShowResponse response;
    bool readFromStream = AZ::Utils::LoadObjectFromBufferInPlace(data.data(), data.size(), response);
    AZ_Assert(readFromStream, ""AssetProcessor failed to deserialize from stream"");
    if (!readFromStream)
    {
        return;
    }

#ifdef AZ_PLATFORM_WINDOWS
    // Required on Windows to allow the other process to come to the foreground
    AllowSetForegroundWindow(response.m_processId);
#endif // #ifdef AZ_PLATFORM_WINDOWS

    AzToolsFramework::AssetSystem::AssetBrowserShowRequest message;
    message.m_filePath = filePath.toUtf8().data();
    connection->Send(AzFramework::AssetSystem::DEFAULT_SERIAL, message);
}

void MainWindow::ShowJobViewContextMenu(const QPoint& pos)
{
    using namespace AssetProcessor;

    auto cachedJobInfoAt = [this](const QPoint& pos)
    {
        const QModelIndex proxyIndex = ui->jobTreeView->indexAt(pos);
        const QModelIndex sourceIndex = m_jobSortFilterProxy->mapToSource(proxyIndex);
        return m_jobsModel->getItem(sourceIndex.row());
    };

    const CachedJobInfo* item = cachedJobInfoAt(pos);

    if (!item)
    {
        return;
    }
    QMenu menu;
    menu.setToolTipsVisible(true);

    menu.addAction(""Show in Asset Browser"", this, [&]()
    {
        ConnectionManager* connectionManager = m_guiApplicationManager->GetConnectionManager();

        QString filePath = FindAbsoluteFilePath(item);

        AzToolsFramework::AssetSystem::WantAssetBrowserShowRequest requestMessage;

        auto& connectionMap = connectionManager->getConnectionMap();
        auto connections = connectionMap.values();
        for (auto connection : connections)
        {
            using namespace AzFramework::AssetSystem;

            // Ask the Editor, and only the Editor, if it wants to receive
            // the message for showing an asset in the AssetBrowser.
            // This also allows the Editor to send back it's Process ID, which
            // allows the Windows platform to call AllowSetForegroundWindow()
            // which is required to bring the Editor window to the foreground
            if (connection->Identifier() == ConnectionIdentifiers::Editor)
            {
                unsigned int connectionId = connection->ConnectionId();
                connection->SendRequest(requestMessage, [connectionManager, connectionId, filePath](AZ::u32 /*type*/, QByteArray callbackData) {
                    SendShowInAssetBrowserResponse(filePath, connectionManager, connectionId, callbackData);
                });
            }
        }
    });

    // Only completed items will be available in the assets tab.
    QAction* assetTabSourceAction = menu.addAction(tr(""View source asset""), this, [&]()
    {
        ui->dialogStack->setCurrentIndex(static_cast<int>(DialogStackIndex::Assets));
        ui->buttonList->setCurrentIndex(static_cast<int>(DialogStackIndex::Assets));
        ui->sourceAssetDetailsPanel->GoToSource(item->m_elementId.GetInputAssetName().toUtf8().constData());
    });

    QString productMenuTitle(tr(""View product asset...""));
    if (item->m_jobState != AzToolsFramework::AssetSystem::JobStatus::Completed)
    {
        QString disabledActionTooltip(tr(""Only completed jobs are available in the Assets tab.""));
        assetTabSourceAction->setToolTip(disabledActionTooltip);
        assetTabSourceAction->setDisabled(true);

        // Disabled menus don't support tooltips, so add it as an action, instead.
        QAction* productMenuAction = menu.addAction(productMenuTitle);
        productMenuAction->setToolTip(disabledActionTooltip);
        productMenuAction->setDisabled(true);
    }
    else
    {
        assetTabSourceAction->setToolTip(tr(""Show the source asset for this job in the Assets tab.""));

        QMenu* productMenu = menu.addMenu(productMenuTitle);
        productMenu->setToolTipsVisible(true);

        bool anyProductsAvailableForJob = false;
        m_sharedDbConnection->QueryJobByJobRunKey(
            item->m_jobRunKey,
            [&](AzToolsFramework::AssetDatabase::JobDatabaseEntry& jobEntry)
        {
            m_sharedDbConnection->QueryProductByJobID(
                jobEntry.m_jobID,
                [&](AzToolsFramework::AssetDatabase::ProductDatabaseEntry& productEntry)
            {
                if (productEntry.m_productName.empty())
                {
                    return true;
                }
                anyProductsAvailableForJob = true;
                QAction* assetTabProductAction = productMenu->addAction(productEntry.m_productName.c_str(), this, [&, productEntry]()
                {
                    ui->dialogStack->setCurrentIndex(static_cast<int>(DialogStackIndex::Assets));
                    ui->buttonList->setCurrentIndex(static_cast<int>(DialogStackIndex::Assets));
                    ui->sourceAssetDetailsPanel->GoToProduct(productEntry.m_productName);
                });
                assetTabProductAction->setToolTip(""Shows this product asset in the Product Assets tab."");
                return true; // Keep iterating, add all products.
            });
            return false; // Stop iterating, there should only be one job with this run key.
        });

        if (!anyProductsAvailableForJob)
        {
            // If there were no products, then show a disabled action with a tooltip.
            // Disabled menus don't support tooltips, so remove the menu first.
            menu.removeAction(productMenu->menuAction());
            productMenu->deleteLater();
            productMenu = nullptr;

            QAction* productMenuAction = menu.addAction(productMenuTitle);
            productMenuAction->setToolTip(tr(""This job created no products.""));
            productMenuAction->setDisabled(true);
        }
    }

    QAction* fileBrowserAction = menu.addAction(AzQtComponents::fileBrowserActionName(), this, [&]()
    {
        AzQtComponents::ShowFileOnDesktop(FindAbsoluteFilePath(item));
    });
    fileBrowserAction->setToolTip(tr(""Opens a window in your operating system's file explorer to view the source asset for this job.""));

    menu.addAction(tr(""Open""), this, [&]()
    {
        QDesktopServices::openUrl(QUrl::fromLocalFile(FindAbsoluteFilePath(item)));
    });

    menu.addAction(tr(""Copy""), this, [&]()
    {
        QGuiApplication::clipboard()->setText(FindAbsoluteFilePath(item));
    });

    // Get the internal path to the log file
    const QModelIndex proxyIndex = ui->jobTreeView->indexAt(pos);
    const QModelIndex sourceIndex = m_jobSortFilterProxy->mapToSource(proxyIndex);
    QVariant pathVariant = m_jobsModel->data(sourceIndex, JobsModel::logFileRole);

    // Get the absolute path of the log file
    AZ::IO::FileIOBase* fileIO = AZ::IO::FileIOBase::GetInstance();
    char resolvedPath[AZ_MAX_PATH_LEN];
    fileIO->ResolvePath(pathVariant.toByteArray().constData(), resolvedPath, AZ_MAX_PATH_LEN);

    QFileInfo fileInfo(resolvedPath);
    auto openLogFile = menu.addAction(tr(""Open log file""), this, [&]()
    {
        QDesktopServices::openUrl(QUrl::fromLocalFile(fileInfo.absoluteFilePath()));
    });
    openLogFile->setEnabled(fileInfo.exists());

    auto logDir = fileInfo.absoluteDir();
    auto openLogFolder = menu.addAction(tr(""Open folder with log file""), this, [&]()
    {
        if (fileInfo.exists())
        {
            AzQtComponents::ShowFileOnDesktop(fileInfo.absoluteFilePath());
        }
        else
        {
            // If the file doesn't exist, but the directory does, just open the directory
            AzQtComponents::ShowFileOnDesktop(logDir.absolutePath());
        }
    });
    // Only open and show the folder if the file actually exists, otherwise it's confusing
    openLogFolder->setEnabled(fileInfo.exists());

    menu.exec(ui->jobTreeView->viewport()->mapToGlobal(pos));
}

void MainWindow::SelectJobAndMakeVisible(const QModelIndex& index)
{
    if (!index.isValid())
    {
        return;
    }
    // Make sure the job is visible, clear any existing filters.
    // This has to be done before getting the filter index, because it will change.
    ui->jobFilteredSearchWidget->ClearTextFilter();
    ui->jobFilteredSearchWidget->ClearTypeFilter();

    ui->dialogStack->setCurrentIndex(static_cast<int>(DialogStackIndex::Jobs));
    ui->buttonList->setCurrentIndex(static_cast<int>(DialogStackIndex::Jobs));
    QModelIndex proxyIndex = m_jobSortFilterProxy->mapFromSource(index);
    ui->jobTreeView->scrollTo(proxyIndex, QAbstractItemView::ScrollHint::EnsureVisible);
    // This isn't an asset tree, but use the same selection mode when selecting this row.
    // Setting the current index works a bit better than just selecting, because the item will be treated as
    // active for purposes of keyboard navigation and additional row highlighting (if the tree view itself gains focus)
    ui->jobTreeView->selectionModel()->setCurrentIndex(proxyIndex, AssetProcessor::AssetTreeModel::GetAssetTreeSelectionFlags());
}

void MainWindow::ShowSourceAssetContextMenu(const QPoint& pos)
{
    using namespace AssetProcessor;
    auto sourceAt = [this](const QPoint& pos)
    {
        const QModelIndex proxyIndex = ui->SourceAssetsTreeView->indexAt(pos);
        const QModelIndex sourceIndex = m_sourceAssetTreeFilterModel->mapToSource(proxyIndex);
        return static_cast<AssetTreeItem*>(sourceIndex.internalPointer());
    };

    const AssetTreeItem* cachedAsset = sourceAt(pos);

    if (!cachedAsset)
    {
        return;
    }
    QMenu menu(this);
    menu.setToolTipsVisible(true);
    const AZStd::shared_ptr<const SourceAssetTreeItemData> sourceItemData = AZStd::rtti_pointer_cast<const SourceAssetTreeItemData>(cachedAsset->GetData());


    QString jobMenuText(tr(""View job...""));
    QString productMenuText(tr(""View product asset...""));
    if (cachedAsset->getChildCount() > 0)
    {
        // Tooltips don't appear for disabled menus, so if this is a folder, create it as an action instead.
        QAction* jobAction = menu.addAction(jobMenuText);
        jobAction->setDisabled(true);
        jobAction->setToolTip(tr(""Folders do not have associated jobs.""));

        QAction* productAction = menu.addAction(productMenuText);
        productAction->setDisabled(true);
        productAction->setToolTip(tr(""Folders do not have associated products.""));
    }
    else
    {
        QMenu* jobMenu = menu.addMenu(jobMenuText);
        jobMenu->setToolTipsVisible(true);
        QMenu* productMenu = menu.addMenu(productMenuText);
        productMenu->setToolTipsVisible(true);

        m_sharedDbConnection->QueryJobBySourceID(sourceItemData->m_sourceInfo.m_sourceID,
            [&](AzToolsFramework::AssetDatabase::JobDatabaseEntry& jobEntry)
        {
            QAction* jobAction = jobMenu->addAction(tr(""with key %1 for platform %2"").arg(jobEntry.m_jobKey.c_str(), jobEntry.m_platform.c_str()), this, [&, jobEntry]()
            {
                QModelIndex jobIndex = m_jobsModel->GetJobFromSourceAndJobInfo(sourceItemData->m_assetDbName, jobEntry.m_platform, jobEntry.m_jobKey);
                SelectJobAndMakeVisible(jobIndex);
            });
            jobAction->setToolTip(tr(""Show this job in the Jobs tab.""));

            m_sharedDbConnection->QueryProductByJobID(
                jobEntry.m_jobID,
                [&](AzToolsFramework::AssetDatabase::ProductDatabaseEntry& productEntry)
            {
                if (productEntry.m_productName.empty())
                {
                    return true;
                }
                QAction* productAction = productMenu->addAction(productEntry.m_productName.c_str(), this, [&, productEntry]()
                {
                    ui->sourceAssetDetailsPanel->GoToProduct(productEntry.m_productName);
                });
                productAction->setToolTip(""Show this product in the product assets tab."");
                return true; // Keep iterating, add all products.
            });
            return true; // Stop iterating, there should only be one job with this run key.
        });
    }

    QAction* fileBrowserAction = menu.addAction(AzQtComponents::fileBrowserActionName(), this, [&]()
    {
        AZ::Outcome<QString> pathToSource = GetAbsolutePathToSource(*cachedAsset);
        if (pathToSource.IsSuccess())
        {
            AzQtComponents::ShowFileOnDesktop(pathToSource.GetValue());
        }
    });
    QString fileOrFolder(cachedAsset->getChildCount() > 0 ? tr(""folder"") : tr(""file""));
    fileBrowserAction->setToolTip(tr(""Opens a window in your operating system's file explorer to view this %1."").arg(fileOrFolder));

    QAction* copyFullPathAction = menu.addAction(tr(""Copy full path""), this, [&]()
    {
        AZ::Outcome<QString> pathToSource = GetAbsolutePathToSource(*cachedAsset);
        if (pathToSource.IsSuccess())
        {
            QGuiApplication::clipboard()->setText(pathToSource.GetValue());
        }
    });

    copyFullPathAction->setToolTip(tr(""Copies the full path to this file to your clipboard.""));

    QString reprocessFolder{ tr(""Reprocess Folder"") };
    QString reprocessFile{ tr(""Reprocess File"") };

    QAction* reprocessAssetAction = menu.addAction(cachedAsset->getChildCount() ? reprocessFolder : reprocessFile, this, [&]()
    {
        AZ::Outcome<QString> pathToSource = GetAbsolutePathToSource(*cachedAsset);
        m_guiApplicationManager->GetAssetProcessorManager()->RequestReprocess(pathToSource.GetValue());
    });

    QString reprocessFolderTip{ tr(""Put the source assets in the selected folder back in the processing queue"") };
    QString reprocessFileTip{ tr(""Put the source asset back in the processing queue"") };

    reprocessAssetAction->setToolTip(cachedAsset->getChildCount() ? reprocessFolderTip : reprocessFileTip);

    menu.exec(ui->SourceAssetsTreeView->viewport()->mapToGlobal(pos));
}

void MainWindow::ShowProductAssetContextMenu(const QPoint& pos)
{
    using namespace AssetProcessor;
    auto productAt = [this](const QPoint& pos)
    {
        const QModelIndex proxyIndex = ui->ProductAssetsTreeView->indexAt(pos);
        const QModelIndex sourceIndex = m_productAssetTreeFilterModel->mapToSource(proxyIndex);
        return static_cast<AssetTreeItem*>(sourceIndex.internalPointer());
    };

    const AssetTreeItem* cachedAsset = productAt(pos);

    if (!cachedAsset)
    {
        return;
    }

    QMenu menu(this);
    menu.setToolTipsVisible(true);
    const AZStd::shared_ptr<const ProductAssetTreeItemData> productItemData = AZStd::rtti_pointer_cast<const ProductAssetTreeItemData>(cachedAsset->GetData());

    QAction* jobAction = menu.addAction(""View job"", this, [&]()
    {
        if (!productItemData)
        {
            return;
        }

        QModelIndex jobIndex = m_jobsModel->GetJobFromProduct(productItemData->m_databaseInfo, *m_sharedDbConnection);
        SelectJobAndMakeVisible(jobIndex);
    });

    QAction* sourceAssetAction = menu.addAction(""View source asset"", this, [&]()
    {
        if (!productItemData)
        {
            return;
        }
        m_sharedDbConnection->QuerySourceByProductID(
            productItemData->m_databaseInfo.m_productID,
            [&](AzToolsFramework::AssetDatabase::SourceDatabaseEntry& sourceEntry)
        {
            ui->sourceAssetDetailsPanel->GoToSource(sourceEntry.m_sourceName);
            return false; // Don't keep iterating
        });
    });

    if (cachedAsset->getChildCount() > 0)
    {
        sourceAssetAction->setDisabled(true);
        sourceAssetAction->setToolTip(tr(""Folders do not have source assets.""));
        jobAction->setDisabled(true);
        jobAction->setToolTip(tr(""Folders do not have associated jobs.""));
    }
    else
    {
        sourceAssetAction->setToolTip(tr(""Selects the source asset associated with this product asset.""));
        jobAction->setToolTip(tr(""Selects the job that created this product asset in the Jobs tab.""));
    }

    QAction* fileBrowserAction = menu.addAction(AzQtComponents::fileBrowserActionName(), this, [&]()
    {
        AZ::Outcome<QString> pathToProduct = GetAbsolutePathToProduct(*cachedAsset);
        if (pathToProduct.IsSuccess())
        {
            AzQtComponents::ShowFileOnDesktop(pathToProduct.GetValue());
        }

    });

    QString fileOrFolder(cachedAsset->getChildCount() > 0 ? tr(""folder"") : tr(""file""));
    fileBrowserAction->setToolTip(tr(""Opens a window in your operating system's file explorer to view this %1."").arg(fileOrFolder));

    QAction* copyFullPathAction = menu.addAction(tr(""Copy full path""), this, [&]()
    {
        AZ::Outcome<QString> pathToProduct = GetAbsolutePathToProduct(*cachedAsset);
        if (pathToProduct.IsSuccess())
        {
            QGuiApplication::clipboard()->setText(pathToProduct.GetValue());
        }
    });

    copyFullPathAction->setToolTip(tr(""Copies the full path for this %1 to your clipboard."").arg(fileOrFolder));

    QAction* sourceAssetReprocessAction = menu.addAction(""Reprocess source asset"", this, [&]()
    {
        if (!productItemData )
        {
            return;
        }
        m_sharedDbConnection->QuerySourceByProductID(
            productItemData->m_databaseInfo.m_productID,
            [&](AzToolsFramework::AssetDatabase::SourceDatabaseEntry& sourceEntry)
        {
            m_sharedDbConnection->QueryScanFolderByScanFolderID(sourceEntry.m_scanFolderPK,[&] (AzToolsFramework::AssetDatabase::ScanFolderDatabaseEntry scanfolder)
            {
                QString reprocessSource{ scanfolder.m_scanFolder.c_str() };
                reprocessSource.append(""/"");
                reprocessSource.append(sourceEntry.m_sourceName.c_str());
                m_guiApplicationManager->GetAssetProcessorManager()->RequestReprocess(reprocessSource);
                return false; // Don't keep iterating
            });
            return false; // Don't keep iterating
        });
    });
    if (cachedAsset->getChildCount() > 0)
    {
        sourceAssetReprocessAction->setDisabled(true);
    }
    sourceAssetReprocessAction->setToolTip(tr(""Reprocess the source asset which created this product""));

    menu.exec(ui->ProductAssetsTreeView->viewport()->mapToGlobal(pos));
}

void MainWindow::ShowLogLineContextMenu(const QPoint& pos)
{
    using namespace AzToolsFramework::Logging;
    QModelIndex sourceIndex = ui->jobContextLogTableView->indexAt(pos);

    // If there is no index under the mouse cursor, let check the selected index of the view
    if (!sourceIndex.isValid())
    {
        const auto indexes = ui->jobContextLogTableView->selectionModel()->selectedIndexes();

        if (!indexes.isEmpty())
        {
            sourceIndex = indexes.first();
        }
    }

    QMenu menu;
    QAction* key = menu.addAction(tr(""Copy selected key""), this, [&]()
    {
        QGuiApplication::clipboard()->setText(sourceIndex.sibling(sourceIndex.row(), ContextDetailsLogTableModel::ColumnKey).data().toString());
    });
    QAction* value = menu.addAction(tr(""Copy selected value""), this, [&]()
    {
        QGuiApplication::clipboard()->setText(sourceIndex.sibling(sourceIndex.row(), ContextDetailsLogTableModel::ColumnValue).data().toString());
    });
    menu.addAction(tr(""Copy all values""), this, [&]()
    {
        auto model = qobject_cast<ContextDetailsLogTableModel*>(ui->jobContextLogTableView->model());
        QGuiApplication::clipboard()->setText(model->toString());
    });

    if (!sourceIndex.isValid())
    {
        key->setEnabled(false);
        value->setEnabled(false);
    }

    menu.exec(ui->jobContextLogTableView->viewport()->mapToGlobal(pos));
}

",16371,True,2758.3782485549928,median
"[[features.testing]]
== Testing
Spring Boot provides a number of utilities and annotations to help when testing your application.
Test support is provided by two modules: `spring-boot-test` contains core items, and `spring-boot-test-autoconfigure` supports auto-configuration for tests.

Most developers use the `spring-boot-starter-test` ""`Starter`"", which imports both Spring Boot test modules as well as JUnit Jupiter, AssertJ, Hamcrest, and a number of other useful libraries.

[TIP]
====
If you have tests that use JUnit 4, JUnit 5's vintage engine can be used to run them.
To use the vintage engine, add a dependency on `junit-vintage-engine`, as shown in the following example:

[source,xml,indent=0,subs=""verbatim""]
----
	<dependency>
		<groupId>org.junit.vintage</groupId>
		<artifactId>junit-vintage-engine</artifactId>
		<scope>test</scope>
		<exclusions>
			<exclusion>
				<groupId>org.hamcrest</groupId>
				<artifactId>hamcrest-core</artifactId>
			</exclusion>
		</exclusions>
	</dependency>
----
====

`hamcrest-core` is excluded in favor of `org.hamcrest:hamcrest` that is part of `spring-boot-starter-test`.



[[features.testing.test-scope-dependencies]]
=== Test Scope Dependencies
The `spring-boot-starter-test` ""`Starter`"" (in the `test` `scope`) contains the following provided libraries:

* https://junit.org/junit5/[JUnit 5]: The de-facto standard for unit testing Java applications.
* {spring-framework-docs}/testing.html#integration-testing[Spring Test] & Spring Boot Test: Utilities and integration test support for Spring Boot applications.
* https://assertj.github.io/doc/[AssertJ]: A fluent assertion library.
* https://github.com/hamcrest/JavaHamcrest[Hamcrest]: A library of matcher objects (also known as constraints or predicates).
* https://site.mockito.org/[Mockito]: A Java mocking framework.
* https://github.com/skyscreamer/JSONassert[JSONassert]: An assertion library for JSON.
* https://github.com/jayway/JsonPath[JsonPath]: XPath for JSON.

We generally find these common libraries to be useful when writing tests.
If these libraries do not suit your needs, you can add additional test dependencies of your own.



[[features.testing.spring-applications]]
=== Testing Spring Applications
One of the major advantages of dependency injection is that it should make your code easier to unit test.
You can instantiate objects by using the `new` operator without even involving Spring.
You can also use _mock objects_ instead of real dependencies.

Often, you need to move beyond unit testing and start integration testing (with a Spring `ApplicationContext`).
It is useful to be able to perform integration testing without requiring deployment of your application or needing to connect to other infrastructure.

The Spring Framework includes a dedicated test module for such integration testing.
You can declare a dependency directly to `org.springframework:spring-test` or use the `spring-boot-starter-test` ""`Starter`"" to pull it in transitively.

If you have not used the `spring-test` module before, you should start by reading the {spring-framework-docs}/testing.html#testing[relevant section] of the Spring Framework reference documentation.



[[features.testing.spring-boot-applications]]
=== Testing Spring Boot Applications
A Spring Boot application is a Spring `ApplicationContext`, so nothing very special has to be done to test it beyond what you would normally do with a vanilla Spring context.

NOTE: External properties, logging, and other features of Spring Boot are installed in the context by default only if you use `SpringApplication` to create it.

Spring Boot provides a `@SpringBootTest` annotation, which can be used as an alternative to the standard `spring-test` `@ContextConfiguration` annotation when you need Spring Boot features.
The annotation works by <<features#features.testing.spring-boot-applications.detecting-configuration,creating the `ApplicationContext` used in your tests through `SpringApplication`>>.
In addition to `@SpringBootTest` a number of other annotations are also provided for <<features#features.testing.spring-boot-applications.autoconfigured-tests,testing more specific slices>> of an application.

TIP: If you are using JUnit 4, don't forget to also add `@RunWith(SpringRunner.class)` to your test, otherwise the annotations will be ignored.
If you are using JUnit 5, there's no need to add the equivalent `@ExtendWith(SpringExtension.class)` as `@SpringBootTest` and the other `@...Test` annotations are already annotated with it.

By default, `@SpringBootTest` will not start a server.
You can use the `webEnvironment` attribute of `@SpringBootTest` to further refine how your tests run:

* `MOCK`(Default) : Loads a web `ApplicationContext` and provides a mock web environment.
  Embedded servers are not started when using this annotation.
	If a web environment is not available on your classpath, this mode transparently falls back to creating a regular non-web `ApplicationContext`.
	It can be used in conjunction with <<features#features.testing.spring-boot-applications.with-mock-environment, `@AutoConfigureMockMvc` or `@AutoConfigureWebTestClient`>> for mock-based testing of your web application.
* `RANDOM_PORT`: Loads a `WebServerApplicationContext` and provides a real web environment.
  Embedded servers are started and listen on a random port.
* `DEFINED_PORT`: Loads a `WebServerApplicationContext` and provides a real web environment.
  Embedded servers are started and listen on a defined port (from your `application.properties`) or on the default port of `8080`.
* `NONE`: Loads an `ApplicationContext` by using `SpringApplication` but does not provide _any_ web environment (mock or otherwise).

NOTE: If your test is `@Transactional`, it rolls back the transaction at the end of each test method by default.
However, as using this arrangement with either `RANDOM_PORT` or `DEFINED_PORT` implicitly provides a real servlet environment, the HTTP client and server run in separate threads and, thus, in separate transactions.
Any transaction initiated on the server does not roll back in this case.

NOTE: `@SpringBootTest` with `webEnvironment = WebEnvironment.RANDOM_PORT` will also start the management server on a separate random port if your application uses a different port for the management server.



[[features.testing.spring-boot-applications.detecting-web-app-type]]
==== Detecting Web Application Type
If Spring MVC is available, a regular MVC-based application context is configured.
If you have only Spring WebFlux, we'll detect that and configure a WebFlux-based application context instead.

If both are present, Spring MVC takes precedence.
If you want to test a reactive web application in this scenario, you must set the configprop:spring.main.web-application-type[] property:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/detectingwebapptype/MyWebFluxTests.java[]
----



[[features.testing.spring-boot-applications.detecting-configuration]]
==== Detecting Test Configuration
If you are familiar with the Spring Test Framework, you may be used to using `@ContextConfiguration(classes=...)` in order to specify which Spring `@Configuration` to load.
Alternatively, you might have often used nested `@Configuration` classes within your test.

When testing Spring Boot applications, this is often not required.
Spring Boot's `@*Test` annotations search for your primary configuration automatically whenever you do not explicitly define one.

The search algorithm works up from the package that contains the test until it finds a class annotated with `@SpringBootApplication` or `@SpringBootConfiguration`.
As long as you <<using#using.structuring-your-code, structured your code>> in a sensible way, your main configuration is usually found.

[NOTE]
====
If you use a <<features#features.testing.spring-boot-applications.autoconfigured-tests, test annotation to test a more specific slice of your application>>, you should avoid adding configuration settings that are specific to a particular area on the <<features#features.testing.spring-boot-applications.user-configuration-and-slicing, main method's application class>>.

The underlying component scan configuration of `@SpringBootApplication` defines exclude filters that are used to make sure slicing works as expected.
If you are using an explicit `@ComponentScan` directive on your `@SpringBootApplication`-annotated class, be aware that those filters will be disabled.
If you are using slicing, you should define them again.
====

If you want to customize the primary configuration, you can use a nested `@TestConfiguration` class.
Unlike a nested `@Configuration` class, which would be used instead of your application's primary configuration, a nested `@TestConfiguration` class is used in addition to your application's primary configuration.

NOTE: Spring's test framework caches application contexts between tests.
Therefore, as long as your tests share the same configuration (no matter how it is discovered), the potentially time-consuming process of loading the context happens only once.



[[features.testing.spring-boot-applications.excluding-configuration]]
==== Excluding Test Configuration
If your application uses component scanning (for example, if you use `@SpringBootApplication` or `@ComponentScan`), you may find top-level configuration classes that you created only for specific tests accidentally get picked up everywhere.

As we <<features#features.testing.spring-boot-applications.detecting-configuration,have seen earlier>>, `@TestConfiguration` can be used on an inner class of a test to customize the primary configuration.
When placed on a top-level class, `@TestConfiguration` indicates that classes in `src/test/java` should not be picked up by scanning.
You can then import that class explicitly where it is required, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/excludingconfiguration/MyTests.java[]
----

NOTE: If you directly use `@ComponentScan` (that is, not through `@SpringBootApplication`) you need to register the `TypeExcludeFilter` with it.
See {spring-boot-module-api}/context/TypeExcludeFilter.html[the Javadoc] for details.



[[features.testing.spring-boot-applications.using-application-arguments]]
==== Using Application Arguments
If your application expects <<features#features.spring-application.application-arguments,arguments>>, you can
have `@SpringBootTest` inject them using the `args` attribute.

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/usingapplicationarguments/MyApplicationArgumentTests.java[]
----



[[features.testing.spring-boot-applications.with-mock-environment]]
==== Testing with a mock environment
By default, `@SpringBootTest` does not start the server.
If you have web endpoints that you want to test against this mock environment, you can additionally configure {spring-framework-docs}/testing.html#spring-mvc-test-framework[`MockMvc`] as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/withmockenvironment/MyMockMvcTests.java[]
----

TIP: If you want to focus only on the web layer and not start a complete `ApplicationContext`, consider <<features#features.testing.spring-boot-applications.spring-mvc-tests,using `@WebMvcTest` instead>>.

Alternatively, you can configure a {spring-framework-docs}/testing.html#webtestclient-tests[`WebTestClient`] as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/withmockenvironment/MyMockWebTestClientTests.java[]
----

[TIP]
====
Testing within a mocked environment is usually faster than running with a full Servlet container.
However, since mocking occurs at the Spring MVC layer, code that relies on lower-level Servlet container behavior cannot be directly tested with MockMvc.

For example, Spring Boot's error handling is based on the ""`error page`"" support provided by the Servlet container.
This means that, whilst you can test your MVC layer throws and handles exceptions as expected, you cannot directly test that a specific <<features#features.developing-web-applications.spring-mvc.error-handling.error-pages, custom error page>> is rendered.
If you need to test these lower-level concerns, you can start a fully running server as described in the next section.
====



[[features.testing.spring-boot-applications.with-running-server]]
==== Testing with a running server
If you need to start a full running server, we recommend that you use random ports.
If you use `@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)`, an available port is picked at random each time your test runs.

The `@LocalServerPort` annotation can be used to <<howto#howto.webserver.discover-port,inject the actual port used>> into your test.
For convenience, tests that need to make REST calls to the started server can additionally `@Autowire` a {spring-framework-docs}/testing.html#webtestclient-tests[`WebTestClient`], which resolves relative links to the running server and comes with a dedicated API for verifying responses, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/withrunningserver/MyRandomPortWebTestClientTests.java[]
----

This setup requires `spring-webflux` on the classpath.
If you can't or won't add webflux, Spring Boot also provides a `TestRestTemplate` facility:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/withrunningserver/MyRandomPortTestRestTemplateTests.java[]
----



[[features.testing.spring-boot-applications.customizing-web-test-client]]
==== Customizing WebTestClient
To customize the `WebTestClient` bean, configure a `WebTestClientBuilderCustomizer` bean.
Any such beans are called with the `WebTestClient.Builder` that is used to create the `WebTestClient`.



[[features.testing.spring-boot-applications.jmx]]
==== Using JMX
As the test context framework caches context, JMX is disabled by default to prevent identical components to register on the same domain.
If such test needs access to an `MBeanServer`, consider marking it dirty as well:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/jmx/MyJmxTests.java[]
----



[[features.testing.spring-boot-applications.metrics]]
==== Using Metrics
Regardless of your classpath, meter registries, except the in-memory backed, are not auto-configured when using `@SpringBootTest`.

If you need to export metrics to a different backend as part of an integration test, annotate it with `@AutoConfigureMetrics`.



[[features.testing.spring-boot-applications.mocking-beans]]
==== Mocking and Spying Beans
When running tests, it is sometimes necessary to mock certain components within your application context.
For example, you may have a facade over some remote service that is unavailable during development.
Mocking can also be useful when you want to simulate failures that might be hard to trigger in a real environment.

Spring Boot includes a `@MockBean` annotation that can be used to define a Mockito mock for a bean inside your `ApplicationContext`.
You can use the annotation to add new beans or replace a single existing bean definition.
The annotation can be used directly on test classes, on fields within your test, or on `@Configuration` classes and fields.
When used on a field, the instance of the created mock is also injected.
Mock beans are automatically reset after each test method.

[NOTE]
====
If your test uses one of Spring Boot's test annotations (such as `@SpringBootTest`), this feature is automatically enabled.
To use this feature with a different arrangement, listeners must be explicitly added, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/mockingbeans/listener/MyTests.java[]
----

====

The following example replaces an existing `RemoteService` bean with a mock implementation:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/mockingbeans/bean/MyTests.java[]
----

NOTE: `@MockBean` cannot be used to mock the behavior of a bean that's exercised during application context refresh.
By the time the test is executed, the application context refresh has completed and it is too late to configure the mocked behavior.
We recommend using a `@Bean` method to create and configure the mock in this situation.

Additionally, you can use `@SpyBean` to wrap any existing bean with a Mockito `spy`.
See the {spring-boot-test-module-api}/mock/mockito/SpyBean.html[Javadoc] for full details.

NOTE: CGLib proxies, such as those created for scoped beans, declare the proxied methods as `final`.
This stops Mockito from functioning correctly as it cannot mock or spy on `final` methods in its default configuration.
If you want to mock or spy on such a bean, configure Mockito to use its inline mock maker by adding `org.mockito:mockito-inline` to your application's test dependencies.
This allows Mockito to mock and spy on `final` methods.

NOTE: While Spring's test framework caches application contexts between tests and reuses a context for tests sharing the same configuration, the use of `@MockBean` or `@SpyBean` influences the cache key, which will most likely increase the number of contexts.

TIP: If you are using `@SpyBean` to spy on a bean with `@Cacheable` methods that refer to parameters by name, your application must be compiled with `-parameters`.
This ensures that the parameter names are available to the caching infrastructure once the bean has been spied upon.

TIP: When you are using `@SpyBean` to spy on a bean that is proxied by Spring, you may need to remove Spring's proxy in some situations, for example when setting expectations using `given` or `when`.
Use `AopTestUtils.getTargetObject(yourProxiedSpy)` to do so.



[[features.testing.spring-boot-applications.autoconfigured-tests]]
==== Auto-configured Tests
Spring Boot's auto-configuration system works well for applications but can sometimes be a little too much for tests.
It often helps to load only the parts of the configuration that are required to test a ""`slice`"" of your application.
For example, you might want to test that Spring MVC controllers are mapping URLs correctly, and you do not want to involve database calls in those tests, or you might want to test JPA entities, and you are not interested in the web layer when those tests run.

The `spring-boot-test-autoconfigure` module includes a number of annotations that can be used to automatically configure such ""`slices`"".
Each of them works in a similar way, providing a `@...Test` annotation that loads the `ApplicationContext` and one or more `@AutoConfigure...` annotations that can be used to customize auto-configuration settings.

NOTE: Each slice restricts component scan to appropriate components and loads a very restricted set of auto-configuration classes.
If you need to exclude one of them, most `@...Test` annotations provide an `excludeAutoConfiguration` attribute.
Alternatively, you can use `@ImportAutoConfiguration#exclude`.

NOTE: Including multiple ""`slices`"" by using several `@...Test` annotations in one test is not supported.
If you need multiple ""`slices`"", pick one of the `@...Test` annotations and include the `@AutoConfigure...` annotations of the other ""`slices`"" by hand.

TIP: It is also possible to use the `@AutoConfigure...` annotations with the standard `@SpringBootTest` annotation.
You can use this combination if you are not interested in ""`slicing`"" your application but you want some of the auto-configured test beans.



[[features.testing.spring-boot-applications.json-tests]]
==== Auto-configured JSON Tests
To test that object JSON serialization and deserialization is working as expected, you can use the `@JsonTest` annotation.
`@JsonTest` auto-configures the available supported JSON mapper, which can be one of the following libraries:

* Jackson `ObjectMapper`, any `@JsonComponent` beans and any Jackson ``Module``s
* `Gson`
* `Jsonb`

TIP: A list of the auto-configurations that are enabled by `@JsonTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

If you need to configure elements of the auto-configuration, you can use the `@AutoConfigureJsonTesters` annotation.

Spring Boot includes AssertJ-based helpers that work with the JSONAssert and JsonPath libraries to check that JSON appears as expected.
The `JacksonTester`, `GsonTester`, `JsonbTester`, and `BasicJsonTester` classes can be used for Jackson, Gson, Jsonb, and Strings respectively.
Any helper fields on the test class can be `@Autowired` when using `@JsonTest`.
The following example shows a test class for Jackson:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/jsontests/MyJsonTests.java[]
----

NOTE: JSON helper classes can also be used directly in standard unit tests.
To do so, call the `initFields` method of the helper in your `@Before` method if you do not use `@JsonTest`.

If you're using Spring Boot's AssertJ-based helpers to assert on a number value at a given JSON path, you might not be able to use `isEqualTo` depending on the type.
Instead, you can use AssertJ's `satisfies` to assert that the value matches the given condition.
For instance, the following example asserts that the actual number is a float value close to `0.15` within an offset of `0.01`.

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/jsontests/MyJsonAssertJTests.java[tag=*]
----



[[features.testing.spring-boot-applications.spring-mvc-tests]]
==== Auto-configured Spring MVC Tests
To test whether Spring MVC controllers are working as expected, use the `@WebMvcTest` annotation.
`@WebMvcTest` auto-configures the Spring MVC infrastructure and limits scanned beans to `@Controller`, `@ControllerAdvice`, `@JsonComponent`, `Converter`, `GenericConverter`, `Filter`, `HandlerInterceptor`, `WebMvcConfigurer`, and `HandlerMethodArgumentResolver`.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@WebMvcTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.

TIP: A list of the auto-configuration settings that are enabled by `@WebMvcTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

TIP: If you need to register extra components, such as the Jackson `Module`, you can import additional configuration classes by using `@Import` on your test.

Often, `@WebMvcTest` is limited to a single controller and is used in combination with `@MockBean` to provide mock implementations for required collaborators.

`@WebMvcTest` also auto-configures `MockMvc`.
Mock MVC offers a powerful way to quickly test MVC controllers without needing to start a full HTTP server.

TIP: You can also auto-configure `MockMvc` in a non-`@WebMvcTest` (such as `@SpringBootTest`) by annotating it with `@AutoConfigureMockMvc`.
The following example uses `MockMvc`:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/springmvctests/MyControllerTests.java[]
----

TIP: If you need to configure elements of the auto-configuration (for example, when servlet filters should be applied) you can use attributes in the `@AutoConfigureMockMvc` annotation.

If you use HtmlUnit and Selenium, auto-configuration also provides an HtmlUnit `WebClient` bean and/or a Selenium `WebDriver` bean.
The following example uses HtmlUnit:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/springmvctests/MyHtmlUnitTests.java[]
----

NOTE: By default, Spring Boot puts `WebDriver` beans in a special ""`scope`"" to ensure that the driver exits after each test and that a new instance is injected.
If you do not want this behavior, you can add `@Scope(""singleton"")` to your `WebDriver` `@Bean` definition.

WARNING: The `webDriver` scope created by Spring Boot will replace any user defined scope of the same name.
If you define your own `webDriver` scope you may find it stops working when you use `@WebMvcTest`.

If you have Spring Security on the classpath, `@WebMvcTest` will also scan `WebSecurityConfigurer` beans.
Instead of disabling security completely for such tests, you can use Spring Security's test support.
More details on how to use Spring Security's `MockMvc` support can be found in this _<<howto#howto.testing.with-spring-security>>_ how-to section.

TIP: Sometimes writing Spring MVC tests is not enough; Spring Boot can help you run <<features#features.testing.spring-boot-applications.with-running-server, full end-to-end tests with an actual server>>.



[[features.testing.spring-boot-applications.spring-webflux-tests]]
==== Auto-configured Spring WebFlux Tests
To test that {spring-framework-docs}/web-reactive.html[Spring WebFlux] controllers are working as expected, you can use the `@WebFluxTest` annotation.
`@WebFluxTest` auto-configures the Spring WebFlux infrastructure and limits scanned beans to `@Controller`, `@ControllerAdvice`, `@JsonComponent`, `Converter`, `GenericConverter`, `WebFilter`, and `WebFluxConfigurer`.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@WebFluxTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.

TIP: A list of the auto-configurations that are enabled by `@WebFluxTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

TIP: If you need to register extra components, such as Jackson `Module`, you can import additional configuration classes using `@Import` on your test.

Often, `@WebFluxTest` is limited to a single controller and used in combination with the `@MockBean` annotation to provide mock implementations for required collaborators.

`@WebFluxTest` also auto-configures {spring-framework-docs}/testing.html#webtestclient[`WebTestClient`], which offers a powerful way to quickly test WebFlux controllers without needing to start a full HTTP server.

TIP: You can also auto-configure `WebTestClient` in a non-`@WebFluxTest` (such as `@SpringBootTest`) by annotating it with `@AutoConfigureWebTestClient`.
The following example shows a class that uses both `@WebFluxTest` and a `WebTestClient`:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/springwebfluxtests/MyControllerTests.java[]
----

TIP: This setup is only supported by WebFlux applications as using `WebTestClient` in a mocked web application only works with WebFlux at the moment.

NOTE: `@WebFluxTest` cannot detect routes registered via the functional web framework.
For testing `RouterFunction` beans in the context, consider importing your `RouterFunction` yourself via `@Import` or using `@SpringBootTest`.

NOTE: `@WebFluxTest` cannot detect custom security configuration registered via a `@Bean` of type `SecurityWebFilterChain`.
To include that in your test, you will need to import the configuration that registers the bean via `@Import` or use `@SpringBootTest`.

TIP: Sometimes writing Spring WebFlux tests is not enough; Spring Boot can help you run <<features#features.testing.spring-boot-applications.with-running-server, full end-to-end tests with an actual server>>.



[[features.testing.spring-boot-applications.autoconfigured-spring-data-cassandra]]
==== Auto-configured Data Cassandra Tests
You can use `@DataCassandraTest` to test Cassandra applications.
By default, it configures a `CassandraTemplate`, scans for `@Table` classes, and configures Spring Data Cassandra repositories.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@DataCassandraTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.
(For more about using Cassandra with Spring Boot, see ""<<features#features.nosql.cassandra>>"", earlier in this chapter.)

TIP: A list of the auto-configuration settings that are enabled by `@DataCassandraTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

The following example shows a typical setup for using Cassandra tests in Spring Boot:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdatacassandra/MyDataCassandraTests.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-spring-data-jpa]]
==== Auto-configured Data JPA Tests
You can use the `@DataJpaTest` annotation to test JPA applications.
By default, it scans for `@Entity` classes and configures Spring Data JPA repositories.
If an embedded database is available on the classpath, it configures one as well.
SQL queries are logged by default by setting the `spring.jpa.show-sql` property to `true`.
This can be disabled using the `showSql()` attribute of the annotation.

Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@DataJpaTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.

TIP: A list of the auto-configuration settings that are enabled by `@DataJpaTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

By default, data JPA tests are transactional and roll back at the end of each test.
See the {spring-framework-docs}/testing.html#testcontext-tx-enabling-transactions[relevant section] in the Spring Framework Reference Documentation for more details.
If that is not what you want, you can disable transaction management for a test or for the whole class as follows:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdatajpa/MyNonTransactionalTests.java[]
----

Data JPA tests may also inject a {spring-boot-test-autoconfigure-module-code}/orm/jpa/TestEntityManager.java[`TestEntityManager`] bean, which provides an alternative to the standard JPA `EntityManager` that is specifically designed for tests.
If you want to use `TestEntityManager` outside of `@DataJpaTest` instances, you can also use the `@AutoConfigureTestEntityManager` annotation.
A `JdbcTemplate` is also available if you need that.
The following example shows the `@DataJpaTest` annotation in use:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdatajpa/withoutdb/MyRepositoryTests.java[]
----

In-memory embedded databases generally work well for tests, since they are fast and do not require any installation.
If, however, you prefer to run tests against a real database you can use the `@AutoConfigureTestDatabase` annotation, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdatajpa/withdb/MyRepositoryTests.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-jdbc]]
==== Auto-configured JDBC Tests
`@JdbcTest` is similar to `@DataJpaTest` but is for tests that only require a `DataSource` and do not use Spring Data JDBC.
By default, it configures an in-memory embedded database and a `JdbcTemplate`.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@JdbcTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.

TIP: A list of the auto-configurations that are enabled by `@JdbcTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

By default, JDBC tests are transactional and roll back at the end of each test.
See the {spring-framework-docs}/testing.html#testcontext-tx-enabling-transactions[relevant section] in the Spring Framework Reference Documentation for more details.
If that is not what you want, you can disable transaction management for a test or for the whole class, as follows:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredjdbc/MyTransactionalTests.java[]
----

If you prefer your test to run against a real database, you can use the `@AutoConfigureTestDatabase` annotation in the same way as for `DataJpaTest`.
(See ""<<features#features.testing.spring-boot-applications.autoconfigured-spring-data-jpa>>"".)



[[features.testing.spring-boot-applications.autoconfigured-spring-data-jdbc]]
==== Auto-configured Data JDBC Tests
`@DataJdbcTest` is similar to `@JdbcTest` but is for tests that use Spring Data JDBC repositories.
By default, it configures an in-memory embedded database, a `JdbcTemplate`, and Spring Data JDBC repositories.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@DataJdbcTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.

TIP: A list of the auto-configurations that are enabled by `@DataJdbcTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

By default, Data JDBC tests are transactional and roll back at the end of each test.
See the {spring-framework-docs}/testing.html#testcontext-tx-enabling-transactions[relevant section] in the Spring Framework Reference Documentation for more details.
If that is not what you want, you can disable transaction management for a test or for the whole test class as <<features#features.testing.spring-boot-applications.autoconfigured-jdbc,shown in the JDBC example>>.

If you prefer your test to run against a real database, you can use the `@AutoConfigureTestDatabase` annotation in the same way as for `DataJpaTest`.
(See ""<<features#features.testing.spring-boot-applications.autoconfigured-spring-data-jpa>>"".)



[[features.testing.spring-boot-applications.autoconfigured-jooq]]
==== Auto-configured jOOQ Tests
You can use `@JooqTest` in a similar fashion as `@JdbcTest` but for jOOQ-related tests.
As jOOQ relies heavily on a Java-based schema that corresponds with the database schema, the existing `DataSource` is used.
If you want to replace it with an in-memory database, you can use `@AutoConfigureTestDatabase` to override those settings.
(For more about using jOOQ with Spring Boot, see ""<<features#features.sql.jooq>>"", earlier in this chapter.)
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@JooqTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.

TIP: A list of the auto-configurations that are enabled by `@JooqTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

`@JooqTest` configures a `DSLContext`.
The following example shows the `@JooqTest` annotation in use:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredjooq/MyJooqTests.java[]
----

JOOQ tests are transactional and roll back at the end of each test by default.
If that is not what you want, you can disable transaction management for a test or for the whole test class as <<features#features.testing.spring-boot-applications.autoconfigured-jdbc,shown in the JDBC example>>.



[[features.testing.spring-boot-applications.autoconfigured-spring-data-mongodb]]
==== Auto-configured Data MongoDB Tests
You can use `@DataMongoTest` to test MongoDB applications.
By default, it configures an in-memory embedded MongoDB (if available), configures a `MongoTemplate`, scans for `@Document` classes, and configures Spring Data MongoDB repositories.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@DataMongoTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.
(For more about using MongoDB with Spring Boot, see ""<<features#features.nosql.mongodb>>"", earlier in this chapter.)

TIP: A list of the auto-configuration settings that are enabled by `@DataMongoTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

The following class shows the `@DataMongoTest` annotation in use:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdatamongodb/withoutdb/MyDataMongoDbTests.java[]
----

In-memory embedded MongoDB generally works well for tests, since it is fast and does not require any developer installation.
If, however, you prefer to run tests against a real MongoDB server, you should exclude the embedded MongoDB auto-configuration, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdatamongodb/withdb/MyDataMongoDbTests.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-spring-data-neo4j]]
==== Auto-configured Data Neo4j Tests
You can use `@DataNeo4jTest` to test Neo4j applications.
By default, it scans for `@Node` classes, and configures Spring Data Neo4j repositories.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@DataNeo4jTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.
(For more about using Neo4J with Spring Boot, see ""<<features#features.nosql.neo4j>>"", earlier in this chapter.)

TIP: A list of the auto-configuration settings that are enabled by `@DataNeo4jTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

The following example shows a typical setup for using Neo4J tests in Spring Boot:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdataneo4j/propagation/MyDataNeo4jTests.java[]
----

By default, Data Neo4j tests are transactional and roll back at the end of each test.
See the {spring-framework-docs}/testing.html#testcontext-tx-enabling-transactions[relevant section] in the Spring Framework Reference Documentation for more details.
If that is not what you want, you can disable transaction management for a test or for the whole class, as follows:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdataneo4j/nopropagation/MyDataNeo4jTests.java[]
----

NOTE: Transactional tests are not supported with reactive access.
If you are using this style, you must configure `@DataNeo4jTest` tests as described above.



[[features.testing.spring-boot-applications.autoconfigured-spring-data-redis]]
==== Auto-configured Data Redis Tests
You can use `@DataRedisTest` to test Redis applications.
By default, it scans for `@RedisHash` classes and configures Spring Data Redis repositories.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@DataRedisTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.
(For more about using Redis with Spring Boot, see ""<<features#features.nosql.redis>>"", earlier in this chapter.)

TIP: A list of the auto-configuration settings that are enabled by `@DataRedisTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

The following example shows the `@DataRedisTest` annotation in use:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdataredis/MyDataRedisTests.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-spring-data-ldap]]
==== Auto-configured Data LDAP Tests
You can use `@DataLdapTest` to test LDAP applications.
By default, it configures an in-memory embedded LDAP (if available), configures an `LdapTemplate`, scans for `@Entry` classes, and configures Spring Data LDAP repositories.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@DataLdapTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.
(For more about using LDAP with Spring Boot, see ""<<features#features.nosql.ldap>>"", earlier in this chapter.)

TIP: A list of the auto-configuration settings that are enabled by `@DataLdapTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

The following example shows the `@DataLdapTest` annotation in use:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdataldap/inmemory/MyDataLdapTests.java[]
----

In-memory embedded LDAP generally works well for tests, since it is fast and does not require any developer installation.
If, however, you prefer to run tests against a real LDAP server, you should exclude the embedded LDAP auto-configuration, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringdataldap/server/MyDataLdapTests.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-rest-client]]
==== Auto-configured REST Clients
You can use the `@RestClientTest` annotation to test REST clients.
By default, it auto-configures Jackson, GSON, and Jsonb support, configures a `RestTemplateBuilder`, and adds support for `MockRestServiceServer`.
Regular `@Component` and `@ConfigurationProperties` beans are not scanned when the `@RestClientTest` annotation is used.
`@EnableConfigurationProperties` can be used to include `@ConfigurationProperties` beans.

TIP: A list of the auto-configuration settings that are enabled by `@RestClientTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

The specific beans that you want to test should be specified by using the `value` or `components` attribute of `@RestClientTest`, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredrestclient/MyRestClientTests.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-spring-restdocs]]
==== Auto-configured Spring REST Docs Tests
You can use the `@AutoConfigureRestDocs` annotation to use {spring-restdocs}[Spring REST Docs] in your tests with Mock MVC, REST Assured, or WebTestClient.
It removes the need for the JUnit extension in Spring REST Docs.

`@AutoConfigureRestDocs` can be used to override the default output directory (`target/generated-snippets` if you are using Maven or `build/generated-snippets` if you are using Gradle).
It can also be used to configure the host, scheme, and port that appears in any documented URIs.



[[features.testing.spring-boot-applications.autoconfigured-spring-restdocs.with-mock-mvc]]
===== Auto-configured Spring REST Docs Tests with Mock MVC
`@AutoConfigureRestDocs` customizes the `MockMvc` bean to use Spring REST Docs when testing Servlet-based web applications.
You can inject it by using `@Autowired` and use it in your tests as you normally would when using Mock MVC and Spring REST Docs, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringrestdocs/withmockmvc/MyUserDocumentationTests.java[]
----

If you require more control over Spring REST Docs configuration than offered by the attributes of `@AutoConfigureRestDocs`, you can use a `RestDocsMockMvcConfigurationCustomizer` bean, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringrestdocs/withmockmvc/MyRestDocsConfiguration.java[]
----

If you want to make use of Spring REST Docs support for a parameterized output directory, you can create a `RestDocumentationResultHandler` bean.
The auto-configuration calls `alwaysDo` with this result handler, thereby causing each `MockMvc` call to automatically generate the default snippets.
The following example shows a `RestDocumentationResultHandler` being defined:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringrestdocs/withmockmvc/MyResultHandlerConfiguration.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-spring-restdocs.with-web-test-client]]
===== Auto-configured Spring REST Docs Tests with WebTestClient
`@AutoConfigureRestDocs` can also be used with `WebTestClient` when testing reactive web applications.
You can inject it by using `@Autowired` and use it in your tests as you normally would when using `@WebFluxTest` and Spring REST Docs, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringrestdocs/withwebtestclient/MyUsersDocumentationTests.java[]
----

If you require more control over Spring REST Docs configuration than offered by the attributes of `@AutoConfigureRestDocs`, you can use a `RestDocsWebTestClientConfigurationCustomizer` bean, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringrestdocs/withwebtestclient/MyRestDocsConfiguration.java[]
----

If you want to make use of Spring REST Docs support for a parameterized output directory, you can use a `WebTestClientBuilderCustomizer` to configure a consumer for every entity exchange result.
The following example shows such a `WebTestClientBuilderCustomizer` being defined:

[source,java,indent=0]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringrestdocs/withwebtestclient/MyWebTestClientBuilderCustomizerConfiguration.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-spring-restdocs.with-rest-assured]]
===== Auto-configured Spring REST Docs Tests with REST Assured
`@AutoConfigureRestDocs` makes a `RequestSpecification` bean, preconfigured to use Spring REST Docs, available to your tests.
You can inject it by using `@Autowired` and use it in your tests as you normally would when using REST Assured and Spring REST Docs, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringrestdocs/withrestassured/MyUserDocumentationTests.java[]
----

If you require more control over Spring REST Docs configuration than offered by the attributes of `@AutoConfigureRestDocs`, a `RestDocsRestAssuredConfigurationCustomizer` bean can be used, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredspringrestdocs/withrestassured/MyRestDocsConfiguration.java[]
----



[[features.testing.spring-boot-applications.autoconfigured-webservices]]
==== Auto-configured Spring Web Services Tests
You can use `@WebServiceClientTest` to test applications that use call web services using the Spring Web Services project.
By default, it configures a mock `WebServiceServer` bean and automatically customizes your `WebServiceTemplateBuilder`.
(For more about using Web Services with Spring Boot, see ""<<features#features.webservices>>"", earlier in this chapter.)


TIP: A list of the auto-configuration settings that are enabled by `@WebServiceClientTest` can be <<test-auto-configuration#test-auto-configuration,found in the appendix>>.

The following example shows the `@WebServiceClientTest` annotation in use:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/autoconfiguredwebservices/MyWebServiceClientTests.java[]
----



[[features.testing.spring-boot-applications.additional-autoconfiguration-and-slicing]]
==== Additional Auto-configuration and Slicing
Each slice provides one or more `@AutoConfigure...` annotations that namely defines the auto-configurations that should be included as part of a slice.
Additional auto-configurations can be added on a test-by-test basis by creating a custom `@AutoConfigure...` annotation or by adding `@ImportAutoConfiguration` to the test as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/additionalautoconfigurationandslicing/MyJdbcTests.java[]
----

NOTE: Make sure to not use the regular `@Import` annotation to import auto-configurations as they are handled in a specific way by Spring Boot.

Alternatively, additional auto-configurations can be added for any use of a slice annotation by registering them in `META-INF/spring.factories` as shown in the following example:

[indent=0]
----
	org.springframework.boot.test.autoconfigure.jdbc.JdbcTest=com.example.IntegrationAutoConfiguration
----

TIP: A slice or `@AutoConfigure...` annotation can be customized this way as long as it is meta-annotated with `@ImportAutoConfiguration`.



[[features.testing.spring-boot-applications.user-configuration-and-slicing]]
==== User Configuration and Slicing
If you <<using#using.structuring-your-code, structure your code>> in a sensible way, your `@SpringBootApplication` class is <<features#features.testing.spring-boot-applications.detecting-configuration, used by default>> as the configuration of your tests.

It then becomes important not to litter the application's main class with configuration settings that are specific to a particular area of its functionality.

Assume that you are using Spring Batch and you rely on the auto-configuration for it.
You could define your `@SpringBootApplication` as follows:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/userconfigurationandslicing/MyApplication.java[]
----

Because this class is the source configuration for the test, any slice test actually tries to start Spring Batch, which is definitely not what you want to do.
A recommended approach is to move that area-specific configuration to a separate `@Configuration` class at the same level as your application, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/userconfigurationandslicing/MyBatchConfiguration.java[]
----

NOTE: Depending on the complexity of your application, you may either have a single `@Configuration` class for your customizations or one class per domain area.
The latter approach lets you enable it in one of your tests, if necessary, with the `@Import` annotation.

Test slices exclude `@Configuration` classes from scanning.
For example, for a `@WebMvcTest`, the following configuration will not include the given `WebMvcConfigurer` bean in the application context loaded by the test slice:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/userconfigurationandslicing/MyWebConfiguration.java[]
----

The configuration below will, however, cause the custom `WebMvcConfigurer` to be loaded by the test slice.

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/userconfigurationandslicing/MyWebMvcConfigurer.java[]
----

Another source of confusion is classpath scanning.
Assume that, while you structured your code in a sensible way, you need to scan an additional package.
Your application may resemble the following code:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/springbootapplications/userconfigurationandslicing/scan/MyApplication.java[]
----

Doing so effectively overrides the default component scan directive with the side effect of scanning those two packages regardless of the slice that you chose.
For instance, a `@DataJpaTest` seems to suddenly scan components and user configurations of your application.
Again, moving the custom directive to a separate class is a good way to fix this issue.

TIP: If this is not an option for you, you can create a `@SpringBootConfiguration` somewhere in the hierarchy of your test so that it is used instead.
Alternatively, you can specify a source for your test, which disables the behavior of finding a default one.



[[features.testing.spring-boot-applications.spock]]
==== Using Spock to Test Spring Boot Applications
Spock 2.x can be used to test a Spring Boot application.
To do so, add a dependency on Spock's `spock-spring` module to your application's build.
`spock-spring` integrates Spring's test framework into Spock.
See https://spockframework.org/spock/docs/2.0/modules.html#_spring_module[the documentation for Spock's Spring module] for further details.



[[features.testing.utilities]]
=== Test Utilities
A few test utility classes that are generally useful when testing your application are packaged as part of `spring-boot`.



[[features.testing.utilities.config-data-application-context-initializer]]
==== ConfigDataApplicationContextInitializer
`ConfigDataApplicationContextInitializer` is an `ApplicationContextInitializer` that you can apply to your tests to load Spring Boot `application.properties` files.
You can use it when you do not need the full set of features provided by `@SpringBootTest`, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/utilities/configdataapplicationcontextinitializer/MyConfigFileTests.java[]
----

NOTE: Using `ConfigDataApplicationContextInitializer` alone does not provide support for `@Value(""${...}"")` injection.
Its only job is to ensure that `application.properties` files are loaded into Spring's `Environment`.
For `@Value` support, you need to either additionally configure a `PropertySourcesPlaceholderConfigurer` or use `@SpringBootTest`, which auto-configures one for you.



[[features.testing.utilities.test-property-values]]
==== TestPropertyValues
`TestPropertyValues` lets you quickly add properties to a `ConfigurableEnvironment` or `ConfigurableApplicationContext`.
You can call it with `key=value` strings, as follows:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/utilities/testpropertyvalues/MyEnvironmentTests.java[]
----



[[features.testing.utilities.output-capture]]
==== OutputCapture
`OutputCapture` is a JUnit `Extension` that you can use to capture `System.out` and `System.err` output.
To use add `@ExtendWith(OutputCaptureExtension.class)` and inject `CapturedOutput` as an argument to your test class constructor or test method as follows:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/utilities/outputcapture/MyOutputCaptureTests.java[]
----



[[features.testing.utilities.test-rest-template]]
==== TestRestTemplate
`TestRestTemplate` is a convenience alternative to Spring's `RestTemplate` that is useful in integration tests.
You can get a vanilla template or one that sends Basic HTTP authentication (with a username and password).
In either case, the template is fault tolerant.
This means that it behaves in a test-friendly way by not throwing exceptions on 4xx and 5xx errors.
Instead, such errors can be detected via the returned `ResponseEntity` and its status code.

TIP: Spring Framework 5.0 provides a new `WebTestClient` that works for <<features#features.testing.spring-boot-applications.spring-webflux-tests, WebFlux integration tests>> and both <<features#features.testing.spring-boot-applications.with-running-server, WebFlux and MVC end-to-end testing>>.
It provides a fluent API for assertions, unlike `TestRestTemplate`.

It is recommended, but not mandatory, to use the Apache HTTP Client (version 4.3.2 or better).
If you have that on your classpath, the `TestRestTemplate` responds by configuring the client appropriately.
If you do use Apache's HTTP client, some additional test-friendly features are enabled:

* Redirects are not followed (so you can assert the response location).
* Cookies are ignored (so the template is stateless).

`TestRestTemplate` can be instantiated directly in your integration tests, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/utilities/testresttemplate/MyTests.java[]
----

Alternatively, if you use the `@SpringBootTest` annotation with `WebEnvironment.RANDOM_PORT` or `WebEnvironment.DEFINED_PORT`, you can inject a fully configured `TestRestTemplate` and start using it.
If necessary, additional customizations can be applied through the `RestTemplateBuilder` bean.
Any URLs that do not specify a host and port automatically connect to the embedded server, as shown in the following example:

[source,java,indent=0,subs=""verbatim""]
----
include::{docs-java}/features/testing/utilities/testresttemplate/MySpringBootTests.java[]
----
",12445,True,2638.000930711123,median
"////
This guide is maintained in the main Quarkus repository
and pull requests should be submitted there:
https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc
////
= Building applications with Maven

include::./attributes.adoc[]
:devtools-no-gradle:

[[project-creation]]
== Creating a new project

You can scaffold a new Maven project with:

:create-app-group-id: my-groupId
:create-app-artifact-id: my-artifactId
:create-app-code:
:create-app-post-command:
include::includes/devtools/create-app.adoc[]

If you are using the CLI, you can get the list of available options with:

[source,bash]
----
quarkus create app --help
----

If you are using the Maven command, the following table lists the attributes you can pass to the `create` command:

[cols=3*,options=""header""]
|===
| Attribute
| Default Value
| Description

| `projectGroupId`
| `org.acme.sample`
| The group id of the created project

| `projectArtifactId`
| _mandatory_
| The artifact id of the created project. Not passing it triggers the interactive mode.

| `projectVersion`
| `1.0.0-SNAPSHOT`
| The version of the created project

| `platformGroupId`
| `io.quarkus.platform`
| The group id of the target platform.

| `platformArtifactId`
| `quarkus-bom`
| The artifact id of the target platform BOM.

| `platformVersion`
| The version currently recommended by the https://quarkus.io/guides/extension-registry-user[Quarkus Extension Registry]
| The version of the platform you want the project to use. It can also accept a version range, in which case the latest from the specified range will be used.

| `className`
| _Not created if omitted_
| The fully qualified name of the generated resource

| `path`
| `/hello`
| The resource path, only relevant if `className` is set.

| `extensions`
| _[]_
| The list of extensions to add to the project (comma-separated)

| `quarkusRegistryClient`
| `true`
| Whether or not Quarkus should use the online registry to resolve extension catalogs. If this is set to false, the extension catalog will be narrowed to the defined (or default) platform BOM.

|===

By default, the command will target the `io.quarkus.platform:quarkus-bom:{quarkus-version}` platform release (unless the coordinates of the desired platform release have been specified).

The project is generated in a directory named after the passed artifactId.
If the directory already exists, the generation fails.

A pair of Dockerfiles for native and jvm mode are also generated in `src/main/docker`.
Instructions to build the image and run the container are written in those Dockerfiles.

== Dealing with extensions

From inside a Quarkus project, you can obtain a list of the available extensions with:

include::includes/devtools/extension-list.adoc[]

You can add an extension using:

:add-extension-extensions: hibernate-validator
include::includes/devtools/extension-add.adoc[]

Extensions are passed using a comma-separated list.

The extension name is the GAV name of the extension: e.g. `io.quarkus:quarkus-agroal`.
But you can pass a partial name and Quarkus will do its best to find the right extension.
For example, `agroal`, `Agroal` or `agro`  will expand to `io.quarkus:quarkus-agroal`.
If no extension is found or if more than one extensions match, you will see a red check mark  ❌ in the command result.

[source,shell]
----
$ ./mvnw quarkus:add-extensions -Dextensions=jdbc,agroal,non-exist-ent
[...]
❌ Multiple extensions matching 'jdbc'
     * io.quarkus:quarkus-jdbc-h2
     * io.quarkus:quarkus-jdbc-mariadb
     * io.quarkus:quarkus-jdbc-postgresql
     Be more specific e.g using the exact name or the full gav.
✅ Adding extension io.quarkus:quarkus-agroal
❌ Cannot find a dependency matching 'non-exist-ent', maybe a typo?
[...]
----

You can install all extensions which match a globbing pattern :

:add-extension-extensions: smallrye-*
include::includes/devtools/extension-add.adoc[]

[[dev-mode]]
== Development mode

Quarkus comes with a built-in development mode.
Run your application with:

include::includes/devtools/dev.adoc[]

You can then update the application sources, resources and configurations.
The changes are automatically reflected in your running application.
This is great to do development spanning UI and database as you see changes reflected immediately.

Dev mode enables hot deployment with background compilation, which means
that when you modify your Java files or your resource files and refresh your browser these changes will automatically take effect.
This works too for resource files like the configuration property file.
The act of
refreshing the browser triggers a scan of the workspace, and if any changes are detected the Java files are compiled,
and the application is redeployed, then your request is serviced by the redeployed application. If there are any issues
with compilation or deployment an error page will let you know.

Hit `CTRL+C` to stop the application.

[NOTE]
====
By default, `quarkus:dev` sets the debug host to `localhost` (for security reasons). If you need to change this, for example to enable debugging on all hosts, you can use the `-DdebugHost` option like so:

:dev-additional-parameters: -DdebugHost=0.0.0.0
include::includes/devtools/dev-parameters.adoc[]
:!dev-additional-parameters:
====

=== Remote Development Mode

It is possible to use development mode remotely, so that you can run Quarkus in a container environment (such as OpenShift)
and have changes made to your local files become immediately visible.

This allows you to develop in the same environment you will actually run your app in, and with access to the same services.

WARNING: Do not use this in production. This should only be used in a development environment. You should not run production application in dev mode.

To do this you must build a mutable application, using the `mutable-jar` format. Set the following properties in `application.properties`:

[source,properties]
----
quarkus.package.type=mutable-jar <1>
quarkus.live-reload.password=changeit <2>
quarkus.live-reload.url=http://my.cluster.host.com:8080 <3>
----
<1> This tells Quarkus to use the mutable-jar format. Mutable applications also include the deployment time parts of Quarkus,
so they take up a bit more disk space. If run normally they start just as fast and use the same memory as an immutable application,
however they can also be started in dev mode.
<2> The password that is used to secure communication between the remote side and the local side.
<3> The URL that your app is going to be running in dev mode at. This is only needed on the local side, so you
may want to leave it out of the properties file and specify it as a system property on the command line.

The `mutable-jar` is then built in the same way that a regular Quarkus jar is built, i.e. by issuing:

include::includes/devtools/build.adoc[]

Before you start Quarkus on the remote host set the environment variable `QUARKUS_LAUNCH_DEVMODE=true`. If you are
on bare metal you can set it via the `export QUARKUS_LAUNCH_DEVMODE=true` command and then run the application with the proper `java -jar ...` command to run the application.

If you plan on running the application via Docker, then you'll need to add `-e QUARKUS_LAUNCH_DEVMODE=true` to the `docker run` command.
When the application starts you should now see the following line in the logs: `Profile dev activated. Live Coding activated`.

NOTE: The remote side does not need to include Maven or any other development tools. The normal `fast-jar` Dockerfile
that is generated with a new Quarkus application is all you need. If you are using bare metal launch the Quarkus runner
jar, do not attempt to run normal devmode.

Now you need to connect your local agent to the remote host, using the `remote-dev` command:

[source,bash]
----
./mvnw quarkus:remote-dev -Dquarkus.live-reload.url=http://my-remote-host:8080
----

Now every time you refresh the browser you should see any changes you have made locally immediately visible in the remote
app. This is done via a HTTP based long polling transport, that will synchronize your local workspace and the remote
application via HTTP calls.

If you do not want to use the HTTP feature then you can simply run the `remote-dev` command without specifying the URL.
In this mode the command will continuously rebuild the local application, so you can use an external tool such as odo or
rsync to sync to the remote application.

All the config options are shown below:

include::{generated-dir}/config/quarkus-live-reload-live-reload-config.adoc[opts=optional, leveloffset=+1]

NOTE: It is recommended you use SSL when using remote dev mode, however even if you are using an unencrypted connection
your password is never sent directly over the wire. For the initial connection request the password is hashed with the
initial state data, and subsequent requests hash it with a random session id generated by the server and any body contents
for POST requests, and the path for DELETE requests, as well as an incrementing counter to prevent replay attacks.

=== Configuring Development Mode

By default, the Maven plugin picks up compiler flags to pass to
`javac` from `maven-compiler-plugin`.

If you need to customize the compiler flags used in development mode,
add a `configuration` section to the `plugin` block and set the
`compilerArgs` property just as you would when configuring
`maven-compiler-plugin`.  You can also set `source`, `target`, and
`jvmArgs`.  For example, to pass `--enable-preview` to both the JVM
and `javac`:

[source,xml]
----
<plugin>
  <groupId>${quarkus.platform.group-id}</groupId>
  <artifactId>quarkus-maven-plugin</artifactId>
  <version>${quarkus.platform.version}</version>

  <configuration>
    <source>${maven.compiler.source}</source>
    <target>${maven.compiler.target}</target>
    <compilerArgs>
      <arg>--enable-preview</arg>
    </compilerArgs>
    <jvmArgs>--enable-preview</jvmArgs>
  </configuration>

  ...
</plugin>
----


== Debugging

In development mode, Quarkus starts by default with debug mode enabled, listening to port `5005` without suspending the JVM.

This behavior can be changed by giving the `debug` system property one of the following values:

* `false` - the JVM will start with debug mode disabled
* `true` - The JVM is started in debug mode and will be listening on port `5005`
* `client` - the JVM will start in client mode and attempt to connect to `localhost:5005`
* `{port}` - The JVM is started in debug mode and will be listening on `{port}`

An additional system property `suspend` can be used to suspend the JVM, when launched in debug mode. `suspend` supports the following values:

* `y` or `true` - The debug mode JVM launch is suspended
* `n` or `false` - The debug mode JVM is started without suspending


[TIP]
====
You can also run a Quarkus application in debug mode with a suspended JVM using:

:dev-additional-parameters: -Dsuspend -Ddebug
include::includes/devtools/dev-parameters.adoc[]
:!dev-additional-parameters:

Then, attach your debugger to `localhost:5005`.
====

== Import in your IDE

Once you have a <<project-creation, project generated>>, you can import it in your favorite IDE.
The only requirement is the ability to import a Maven project.

**Eclipse**

In Eclipse, click on: `File -> Import`.
In the wizard, select: `Maven -> Existing Maven Project`.
On the next screen, select the root location of the project.
The next screen list the found modules; select the generated project and click on `Finish`. Done!

In a separated terminal, run:

include::includes/devtools/dev.adoc[]

and enjoy a highly productive environment.

**IntelliJ**

In IntelliJ:

1. From inside IntelliJ select `File -> New -> Project From Existing Sources...` or, if you are on the welcome dialog, select `Import project`.
2. Select the project root
3. Select `Import project from external model` and `Maven`
4. Next a few times (review the different options if needed)
5. On the last screen click on Finish

In a separated terminal or in the embedded terminal, run:

include::includes/devtools/dev.adoc[]

Enjoy!

**Apache NetBeans**

In NetBeans:

1. Select `File -> Open Project`
2. Select the project root
3. Click on `Open Project`

In a separated terminal or the embedded terminal, go to the project root and run:

include::includes/devtools/dev.adoc[]

Enjoy!

**Visual Studio Code**

Open the project directory in VS Code. If you have installed the Java Extension Pack (grouping a set of Java extensions), the project is loaded as a Maven project.

== Logging Quarkus application build classpath tree

Usually, dependencies of an application (which is a Maven project) could be displayed using `mvn dependency:tree` command. In case of a Quarkus application, however, this command will list only the runtime dependencies of the application.
Given that the Quarkus build process adds deployment dependencies of the extensions used in the application to the original application classpath, it could be useful to know which dependencies and which versions end up on the build classpath.
Luckily, the `quarkus` Maven plugin includes the `dependency-tree` goal which displays the build dependency tree for the application.

Executing `./mvnw quarkus:dependency-tree` on your project should result in an output similar to:

[source,text,subs=attributes+]
----
[INFO] --- quarkus-maven-plugin:{quarkus-version}:dependency-tree (default-cli) @ getting-started ---
[INFO] org.acme:getting-started:jar:1.0.0-SNAPSHOT
[INFO] └─ io.quarkus:quarkus-resteasy-deployment:jar:{quarkus-version} (compile)
[INFO]    ├─ io.quarkus:quarkus-resteasy-server-common-deployment:jar:{quarkus-version} (compile)
[INFO]    │  ├─ io.quarkus:quarkus-core-deployment:jar:{quarkus-version} (compile)
[INFO]    │  │  ├─ commons-beanutils:commons-beanutils:jar:1.9.3 (compile)
[INFO]    │  │  │  ├─ commons-logging:commons-logging:jar:1.2 (compile)
[INFO]    │  │  │  └─ commons-collections:commons-collections:jar:3.2.2 (compile)
...
----

The goal accepts the following optional parameters:

* `mode` - the default value is `prod`, i.e. the production build dependency tree. Alternatively, it accepts values `test` to display the test dependency tree and `dev` to display the dev mode dependency tree;
* `outputFile` - specifies the file to persist the dependency tree to;
* `appendOutput` - the default value is `false`, indicates whether the output to the command should be appended to the file specified with the `outputFile` parameter or it should be overriden.

== Downloading Maven artifact dependencies for offline development and testing

Quarkus extension dependencies are divided into the runtime extension dependencies that end up on the application runtime classpath and the deployment (or build time) extension dependencies that are resolved by Quarkus only at application build time to create
the build classpath. Application developers are expected to express dependencies only on the runtime artifacts of Quarkus extensions. As a consequence, the deployment extension dependencies aren't visible to Maven plugins that aren't aware of the Quarkus
extension dependency model, such as the `maven-dependency-plugin`, `go-offline-maven-plugin`, etc. That means those plugins can not be used to pre-download all the application dependencies to be able to build and test the application later in offline mode.

To enable the use-case of building and testing a Quarkus application offline, the `quarkus-maven-plugin` includes the `go-offline` goal that could be called from the command line like this:

[source,bash]
----
./mvnw quarkus:go-offline
----

This goal will resolve all the runtime, build time, test and dev mode dependencies of the application downloading them to the configured local Maven repository.

== Building a native executable

Native executables make Quarkus applications ideal for containers and serverless workloads.

Make sure to have `GRAALVM_HOME` configured and pointing to GraalVM version {graalvm-version} (Make sure to use a Java 11 version of GraalVM).
Verify that your `pom.xml` has the proper `native` profile (see <<build-tool-maven>>).

Create a native executable using:

include::includes/devtools/build-native.adoc[]

A native executable will be present in `target/`.

To run Integration Tests on the native executable, make sure to have the proper Maven plugin configured (see <<build-tool-maven>>) and launch the `verify` goal.

[source,shell]
----
$ ./mvnw verify -Pnative
...
[quarkus-quickstart-runner:50955]     universe:     391.96 ms
[quarkus-quickstart-runner:50955]      (parse):     904.37 ms
[quarkus-quickstart-runner:50955]     (inline):   1,143.32 ms
[quarkus-quickstart-runner:50955]    (compile):   6,228.44 ms
[quarkus-quickstart-runner:50955]      compile:   9,130.58 ms
[quarkus-quickstart-runner:50955]        image:   2,101.42 ms
[quarkus-quickstart-runner:50955]        write:     803.18 ms
[quarkus-quickstart-runner:50955]      [total]:  33,520.15 ms
[INFO]
[INFO] --- maven-failsafe-plugin:2.22.0:integration-test (default) @ quarkus-quickstart-native ---
[INFO]
[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running org.acme.quickstart.GreetingResourceIT
Executing [/Users/starksm/Dev/JBoss/Quarkus/starksm64-quarkus-quickstarts/getting-started-native/target/quarkus-quickstart-runner, -Dquarkus.http.port=8081, -Dtest.url=http://localhost:8081, -Dquarkus.log.file.path=target/quarkus.log]
2019-02-28 16:52:42,020 INFO  [io.quarkus] (main) Quarkus started in 0.007s. Listening on: http://localhost:8080
2019-02-28 16:52:42,021 INFO  [io.quarkus] (main) Installed features: [cdi, resteasy-reactive]
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.081 s - in org.acme.quickstart.GreetingResourceIT
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 2, Failures: 0, Errors: 0, Skipped: 0

...
----

=== Build a container friendly executable

The native executable will be specific to your operating system.
To create an executable that will run in a container, use the following:

:build-additional-parameters: -Dquarkus.native.container-build=true
include::includes/devtools/build-native.adoc[]
:!build-additional-parameters:

The produced executable will be a 64 bit Linux executable, so depending on your operating system it may no longer be runnable.
However, it's not an issue as we are going to copy it to a Docker container.
Note that in this case the build itself runs in a Docker container too, so you don't need to have GraalVM installed locally.

[TIP]
====
By default, the native executable will be generated using the `quay.io/quarkus/ubi-quarkus-native-image:{graalvm-flavor}` Docker image.

If you want to build a native executable with a different Docker image (for instance to use a different GraalVM version),
use the `-Dquarkus.native.builder-image=<image name>` build argument.

The list of the available Docker images can be found on https://quay.io/repository/quarkus/ubi-quarkus-native-image?tab=tags[quay.io].
Be aware that a given Quarkus version might not be compatible with all the images available.
====

You can follow the xref:building-native-image.adoc[Build a native executable guide] as well as xref:deploying-to-kubernetes.adoc[Deploying Application to Kubernetes and OpenShift] for more information.

[[build-tool-maven]]
== Maven configuration

If you have not used <<project-creation,project scaffolding>>, add the following elements in your `pom.xml`

[source,xml,subs=attributes+]
----
<dependencyManagement>
    <dependencies>
        <dependency> <1>
            <groupId>${quarkus.platform.group-id}</groupId>
            <artifactId>quarkus-bom</artifactId>
            <version>${quarkus.platform.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<build>
    <plugins>
        <plugin> <2>
            <groupId>${quarkus.platform.group-id}</groupId>
            <artifactId>quarkus-maven-plugin</artifactId>
            <version>${quarkus.platform.version}</version>
            <extensions>true</extensions> <3>
            <executions>
                <execution>
                    <goals>
                        <goal>build</goal>
                        <goal>generate-code</goal>
                        <goal>generate-code-tests</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
        <plugin> <4>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <version>${surefire-plugin.version}</version>
            <configuration>
                <systemPropertyVariables>
                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                    <maven.home>${maven.home}</maven.home>
                </systemPropertyVariables>
            </configuration>
        </plugin>
    </plugins>
</build>

<profiles>
    <profile> <5>
        <id>native</id>
        <properties> <6>
            <quarkus.package.type>native</quarkus.package.type>
        </properties>
        <build>
            <plugins>
                <plugin> <7>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-failsafe-plugin</artifactId>
                    <version>${surefire-plugin.version}</version>
                    <executions>
                        <execution>
                            <goals>
                                <goal>integration-test</goal>
                                <goal>verify</goal>
                            </goals>
                            <configuration>
                                <systemPropertyVariables>
                                    <native.image.path>${project.build.directory}/${project.build.finalName}-runner</native.image.path>
                                    <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
                                    <maven.home>${maven.home}</maven.home>
                                </systemPropertyVariables>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    </profile>
</profiles>
----

<1> Optionally use a BOM file to omit the version of the different Quarkus dependencies.
<2> Use the Quarkus Maven plugin that will hook into the build process.
<3> Enabling Maven plugin extensions will register a Quarkus `MavenLifecycleParticipant` which will make sure the Quarkus classloaders used during the build are properly closed. During the `generate-code` and `generate-code-tests` goals the Quarkus application bootstrap is initialized and re-used in the `build` goal (which actually builds and packages a production application). The Quarkus classloaders will be properly closed in the `build` goal of the `quarkus-maven-plugin`. However, if the build fails in between the `generate-code` or `generate-code-tests` and `build` then the Quarkus augmentation classloader won't be properly closed, which may lead to locking of JAR files that happened to be on the classpath on Windows OS.
<4> Add system properties to `maven-surefire-plugin`. +
`maven.home` is only required if you have custom configuration in `${maven.home}/conf/settings.xml`.
<5> Use a specific `native` profile for native executable building.
<6> Enable the `native` package type. The build will therefore produce a native executable.
<7> If you want to test your native executable with Integration Tests, add the following plugin configuration. Test names `*IT` and annotated `@NativeImageTest` or `@QuarkusIntegrationTest` will be run against the native executable. See the xref:building-native-image.adoc[Native executable guide] for more info.

[[fast-jar]]
=== Using fast-jar

`fast-jar` is the default quarkus package type.

The result of the build is a directory under `target` named `quarkus-app`.

You can run the application using: `java -jar target/quarkus-app/quarkus-run.jar`.

WARNING: In order to successfully run the produced jar, you need to have the entire contents of the `quarkus-app` directory. If any of the files are missing, the application will not start or
might not function correctly.

TIP: The `fast-jar` packaging results in creating an artifact that starts a little faster and consumes slightly less memory than a legacy Quarkus jar
because it has indexed information about which dependency jar contains classes and resources. It can thus avoid the lookup into potentially every jar
on the classpath that the legacy jar necessitates, when loading a class or resource.

[[uber-jar-maven]]
=== Uber-Jar Creation

Quarkus Maven plugin supports the generation of Uber-Jars by specifying a `quarkus.package.type=uber-jar` configuration option in your `application.properties`
(or `<quarkus.package.type>uber-jar</quarkus.package.type>` in your `pom.xml`).

The original jar will still be present in the `target` directory but it will be renamed to contain the `.original` suffix.

When building an Uber-Jar you can specify entries that you want to exclude from the generated jar by using the `quarkus.package.ignored-entries` configuration
option, this takes a comma separated list of entries to ignore.

Uber-Jar creation by default excludes link:https://docs.oracle.com/javase/tutorial/deployment/jar/intro.html[signature files] that might be present in the dependencies of the application.

Uber-Jar's final name is configurable via a Maven's build settings `finalName` option.

[[multi-module-maven]]
=== Working with multi-module projects

By default, Quarkus will not discover CDI beans inside another module.

The best way to enable CDI bean discovery for a module in a multi-module project would be to include the `jandex-maven-plugin`,
unless it is the main application module already configured with the quarkus-maven-plugin, in which case it will indexed automatically.

[source,xml,subs=""attributes+""]
----
<build>
  <plugins>
    <plugin>
      <groupId>org.jboss.jandex</groupId>
      <artifactId>jandex-maven-plugin</artifactId>
      <version>{jandex-maven-plugin-version}</version>
      <executions>
        <execution>
          <id>make-index</id>
          <goals>
            <goal>jandex</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>
----

More information on this topic can be found on the xref:cdi-reference.adoc#bean_discovery[Bean Discovery] section of the CDI guide.

[[maven-configuration-profile]]
=== Building with a specific configuration profile

Quarkus supports xref:config-reference.adoc#profiles[configuration profiles] in order to provide a specific configuration according to the target environment.

The profile can be provided directly in the Maven build's command thanks to the system property `quarkus.profile` with a command of type:

// TODO switch to <profile-name-here> once escaping issue is fixed in Asciidoctor
:build-additional-parameters: -Dquarkus.profile=profile-name-here
include::includes/devtools/build.adoc[]
:!build-additional-parameters:

However it is also possible to specify the profile directly in the POM file of the project using project properties, the Quarkus Maven plugin configuration properties or system properties set in the Quarkus Maven plugin configuration.

In order of precedence (greater precedence first):

.1. System properties set in the Quarkus Maven plugin configuration

[source,xml]
----
<project xsi:schemaLocation=""http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"" xmlns=""http://maven.apache.org/POM/4.0.0""
    xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"">
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>${quarkus.platform.group-id}</groupId>
        <artifactId>quarkus-maven-plugin</artifactId>
        <version>${quarkus.platform.version}</version>
        <extensions>true</extensions>
        <configuration>
          <systemProperties>
            <quarkus.profile>prod-aws</quarkus.profile> <1>
          </systemProperties>
        </configuration>
     </plugin>
     ...
    </plugins>
  </build>
...
</project>
----
<1> The default configuration profile of this project is `prod-aws`.

.2. Quarkus Maven plugin configuration properties

[source,xml]
----
<project xsi:schemaLocation=""http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"" xmlns=""http://maven.apache.org/POM/4.0.0""
    xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"">
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>${quarkus.platform.group-id}</groupId>
        <artifactId>quarkus-maven-plugin</artifactId>
        <version>${quarkus.platform.version}</version>
        <extensions>true</extensions>
        <configuration>
          <properties>
            <quarkus.profile>prod-aws</quarkus.profile> <1>
          </properties>
        </configuration>
     </plugin>
     ...
    </plugins>
  </build>
...
</project>
----
<1> The default configuration profile of this project is `prod-aws`.

.3. Project properties

[source,xml]
----
<project xsi:schemaLocation=""http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"" xmlns=""http://maven.apache.org/POM/4.0.0""
    xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"">
  ...
  <properties>
    <quarkus.profile>prod-aws</quarkus.profile> <1>
    ...
  </properties>
...
</project>
----
<1> The default configuration profile of this project is `prod-aws`.

NOTE: Whatever the approach is chosen, the profile can still be overridden with the `quarkus.profile` system property or the `QUARKUS_PROFILE` environment variable.

[[maven-multi-build]]
=== Building several artifacts from a single module

In some particular use cases, it can be interesting to build several artifacts of your application from the same module.
A typical example is when you want to build your application with different configuration profiles.

In that case, it is possible to add as many executions as needed to the Quarkus Maven plugin configuration.

Below is an example of a Quarkus Maven plugin configuration that will produce two builds of the same application: one using the `prod-oracle` profile and the other one using the `prod-postgresql` profile.

[source,xml]
----
<project xsi:schemaLocation=""http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"" xmlns=""http://maven.apache.org/POM/4.0.0""
    xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"">
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>${quarkus.platform.group-id}</groupId>
        <artifactId>quarkus-maven-plugin</artifactId>
        <version>${quarkus.platform.version}</version>
        <extensions>true</extensions>
        <executions>
          <execution>
            <id>oracle</id>
            <goals>
              <goal>build</goal>
            </goals>
            <configuration>
              <properties>
                <quarkus.profile>prod-oracle</quarkus.profile> <1>
                <quarkus.package.output-directory>oracle-quarkus-app</quarkus.package.output-directory> <2>
              </properties>
            </configuration>
          </execution>
          <execution>
            <id>postgresql</id>
            <goals>
              <goal>build</goal>
            </goals>
            <configuration>
              <properties>
                <quarkus.profile>prod-postgresql</quarkus.profile> <3>
                <quarkus.package.output-directory>postgresql-quarkus-app</quarkus.package.output-directory> <4>
              </properties>
            </configuration>
          </execution>
        </executions>
     </plugin>
     ...
    </plugins>
  </build>
...
</project>
----
<1> The default configuration profile of the first execution of the plugin is `prod-oracle`.
<2> The output directory of the first execution of the plugin is set to `oracle-quarkus-app` instead of `quarkus-app` to have a dedicated directory.
<3> The default configuration profile of the second execution of the plugin is `prod-postgresql`.
<4> The output directory of the second execution of the plugin is set to `postgresql-quarkus-app` instead of `quarkus-app` to have a dedicated directory.

NOTE: With the configuration above, both profile builds will be using the same dependencies, so if we added dependencies on the Oracle and PostgreSQL drivers to the application, both of the drivers will appear in both builds.


To isolate profile-specific dependencies from other profiles, the JDBC drivers could be added as optional dependencies to the application but configured to be included in each profile that requires them, e.g.:

[source,xml]
----
<project xsi:schemaLocation=""http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"" xmlns=""http://maven.apache.org/POM/4.0.0""
    xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"">
  ...
  <dependencies>
    ...
    <dependency>
      <groupId>org.postgresql</groupId>
      <artifactId>postgresql</artifactId>
      <version>${postgresql.driver.version}</version>
      <optional>true</optional> <1>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>${quarkus.platform.group-id}</groupId>
        <artifactId>quarkus-maven-plugin</artifactId>
        <version>${quarkus.platform.version}</version>
        <extensions>true</extensions>
        <executions>
          ...
          <execution>
            <id>postgresql</id>
            <goals>
              <goal>build</goal>
            </goals>
            <configuration>
              <properties>
                <quarkus.profile>prod-postgresql</quarkus.profile>
                <quarkus.package.output-directory>postgresql-quarkus-app</quarkus.package.output-directory>
                <quarkus.package.filter-optional-dependencies>true</quarkus.package.filter-optional-dependencies> <2>
                <quarkus.package.included-optional-dependencies>org.postgresql:postgresql::jar</quarkus.package.included-optional-dependencies> <3>
              </properties>
            </configuration>
          </execution>
        </executions>
     </plugin>
     ...
    </plugins>
  </build>
...
</project>
----
<1> The JDBC driver of PostgreSQL is defined as an optional dependency
<2> For backward compatibility reasons, it is necessary to explicitly indicate that the optional dependencies need to be filtered.
<3> Only the optional dependency corresponding to the JDBC driver of PostgreSQL is expected in the final artifact.

[[configuration-reference]]
== Configuring the Project Output

There are a several configuration options that will define what the output of your project build will be.
These are provided in `application.properties` the same as any other config property.

The properties are shown below:

include::{generated-dir}/config/quarkus-package-pkg-package-config.adoc[opts=optional]

[[custom-test-configuration-profile]]
=== Custom test configuration profile in JVM mode

By default, Quarkus tests in JVM mode are run using the `test` configuration profile. If you are not familiar with Quarkus
configuration profiles, everything you need to know is explained in the
xref:config.adoc#configuration-profiles[Configuration Profiles Documentation].

It is however possible to use a custom configuration profile for your tests with the Maven Surefire and Maven Failsafe
configurations shown below. This can be useful if you need for example to run some tests using a specific database which is not
your default testing database.

[source,xml,subs=attributes+]
----
<project>
  [...]
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>${surefire-plugin.version}</version>
        <configuration>
          <systemPropertyVariables>
            <quarkus.test.profile>foo</quarkus.test.profile> <1>
            <buildDirectory>${project.build.directory}</buildDirectory>
            [...]
          </systemPropertyVariables>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-failsafe-plugin</artifactId>
        <version>${failsafe-plugin.version}</version>
        <configuration>
          <systemPropertyVariables>
            <quarkus.test.profile>foo</quarkus.test.profile> <1>
            <buildDirectory>${project.build.directory}</buildDirectory>
            [...]
          </systemPropertyVariables>
        </configuration>
      </plugin>
    </plugins>
  </build>
  [...]
</project>
----

<1> The `foo` configuration profile will be used to run the tests.

[WARNING]
====
It is not possible to use a custom test configuration profile in native mode for now. Native tests are always run using the
`prod` profile.
====

[[bootstrap-maven-properties]]
=== Bootstrap Maven properties

Quarkus bootstrap includes a Maven resolver implementation that is used to resolve application runtime and build time dependencies. The Quarkus Maven resolver is initialized from the same Maven command line that launched the build, test or dev mode. Typically, there is no need to add any extra configuration for it. However, there could be cases where an extra configuration option may be necessary to properly resolve application dependencies in test or dev modes, or IDEs.

Maven test plugins (such as `surefire` and `failsafe`), for example, are not propagating build system properties to the running tests by default. Which means some of the system properties set by the Maven CLI aren't available for the Quarkus Maven resolver initialized for the tests, which may result in test dependencies being resolved using different settings than the main Maven build.

Here is a list of system properties the Quarkus bootstrap Maven resolver checks during its initialization.

[cols=3*,options=""header""]
|===
| Property name
| Default Value
| Description

| `maven.home`
| `MAVEN_HOME` envvar
| The Maven home dir is used to resolve the global settings file unless it was explicitly provided on the command line with the `-gs` argument

| `maven.settings`
| `~/m2/settings.xml`
| Unless the custom settings file has been provided with the `-s` argument, this property can be used to point the resolver to a custom Maven settings file

| `maven.repo.local`
| `~/m2/repository`
| This property could be used to configure a custom local Maven repository directory, if it is different from the default one and the one specified in the `settings.xml`

| `maven.top-level-basedir`
| none
| This property may be useful to help the Maven resolver identify the top-level Maven project in the workspace. By default, the Maven resolver will be discovering a project's workspace by navigating the parent-module POM relationship. However there could be project layouts that are using an aggregator module which isn't appearing as the parent for its modules. In this case, this property will help the Quarkus Maven resolver to properly discover the workspace.

| `quarkus.bootstrap.effective-model-builder`
| `false`
| By default, the Quarkus Maven resolver is reading project's POMs directly when discovering the project's layout. While in most cases it works well enough and relatively fast, reading raw POMs has its limitation. E.g. if a POM includes modules in a profile, these modules will not be discovered. This system property enables project's layout discovery based on the effective POM models, that are properly interpolated, instead of the raw ones. The reason this option is not enabled by default is it may appear to be significantly more time consuming that could increase, e.g. CI testing times. Until there is a better approach found that could be used by default, projects that require it should enable this option.

|===

These system properties above could be added to, e.g., a `surefire` and/or `failsafe` plugin configuration as
[source,xml,subs=attributes+]
----
<project>
  [...]
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
        <version>${surefire-plugin.version}</version>
        <configuration>
          <systemPropertyVariables>
            <maven.home>${maven.hom}</maven.home> <1>
            <maven.repo.local>${settings.localRepository}</maven.repo.local> <2>
            <maven.settings>${session.request.userSettingsFile.path}</maven.settings> <3>
            <maven.top-level-basedir>${session.topLevelProject.basedir.absolutePath}</maven.top-level-basedir> <4>
            <quarkus.bootstrap.effective-model-builder>true</quarkus.bootstrap.effective-model-builder> <5>
          </systemPropertyVariables>
        </configuration>
      </plugin>
    </plugins>
  </build>
  [...]
</project>
----

<1> Propagate `maven.home` system property set by the Maven CLI to the tests
<2> Set the Maven local repository directory for the tests
<3> Set the Maven settings file the tests
<4> Point to the top-level project directory for the tests
<5> Enable effective POM-based project layout discovery

==== Top-level vs Multi-module project directory

In Maven there appears to be a notion of the top-level project (that is exposed as a project property `${session.topLevelProject.basedir.absolutePath}`)
and the multi-module project directory (that is available as property `${maven.multiModuleProjectDirectory}`). These directories might not always match!

IMPORTANT: `maven.multiModuleProjectDirectory` is meant to be consulted by the Maven code itself and not something to be relied upon by user code. So, if you find it useful, use it at your own risk!

The `${maven.multiModuleProjectDirectory}` will be resolved to the first directory that contains `.mvn` directory as its child going up the workspace file system tree
starting from the current directory (or the one specified with the `-f` argument) from which the `mvn` command was launched. If the `.mvn` directory was not found, however,
the `${maven.multiModuleProjectDirectory}` will be pointing to the directory from which the `mvn` command was launched (or the one targeted with the `-f` argument).

The `${session.topLevelProject.basedir.absolutePath}` will be pointing either to the directory from which the `mvn` command was launched or to the directory targeted with
the `-f` argument, if it was specified.

[[project-info]]
== Quarkus project info

The Quarkus Maven plugin includes a goal called `info` (currently marked as 'experimental') that logs Quarkus-specific information about the project, such as: the imported Quarkus platform BOMs and the Quarkus extensions found among the project dependencies.
In a multi-module project `quarkus:info` will assume that the current module, in which it is executed, is the main module of the application.

NOTE: The report generated by `quarkus:info` is not currently including the Quarkus Maven plugin information, however it's planned to be added in the future releases.

Here is an example `info` output for a simple project:
[source,text,subs=attributes+]
----
[aloubyansky@localhost code-with-quarkus]$ mvn quarkus:info
[INFO] Scanning for projects...
[INFO] 
[INFO] ---------------------< org.acme:code-with-quarkus >---------------------
[INFO] Building code-with-quarkus 1.0.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- quarkus-maven-plugin:{quarkus-version}:info (default-cli) @ code-with-quarkus ---
[WARNING] quarkus:info goal is experimental, its options and output may change in future versions
[INFO] Quarkus platform BOMs: <1>
[INFO]   io.quarkus.platform:quarkus-bom:pom:{quarkus-version}
[INFO]   io.quarkus.platform:quarkus-kogito-bom:pom:{quarkus-version}
[INFO]   io.quarkus.platform:quarkus-camel-bom:pom:{quarkus-version}
[INFO] 
[INFO] Extensions from io.quarkus.platform:quarkus-bom: <2>
[INFO]   io.quarkus:quarkus-resteasy-reactive
[INFO] 
[INFO] Extensions from io.quarkus.platform:quarkus-kogito-bom: <3>
[INFO]   org.kie.kogito:kogito-quarkus-decisions
[INFO] 
[INFO] Extensions from io.quarkus.platform:quarkus-camel-bom: <4>
[INFO]   org.apache.camel.quarkus:camel-quarkus-rabbitmq
[INFO] 
[INFO] Extensions from registry.quarkus.io: <5>
[INFO]   io.quarkiverse.prettytime:quarkus-prettytime:0.2.1
----

<1> Quarkus platform BOMs imported in the project (BOMs imported by parent POMs will also be reported)
<2> Direct Quarkus extension dependencies managed by the `quarkus-bom`
<3> Direct Quarkus extension dependencies managed by the `quarkus-kogito-bom`
<4> Direct Quarkus extension dependencies managed by the `quarkus-camel-bom`
<5> Direct Quarkus extensions dependencies that aren't managed by Quarkus BOMs but found in the Quarkus extension registry

NOTE: `quarkus:info` will also report Quarkus extensions that aren't found in the Quarkus extension registries if those are present among the project dependencies, indicating they have an 'unknown origin'.

[[project-info-misaligned]]
=== Highlighing misaligned versions

`quarkus:info` will also highlight basic Quarkus dependency version misalignments, in case they are detected. For example, if we modify the project mentioned above by removing the `kogito-quarkus-decisions` extension from the dependencies and adding a `2.6.3.Final` `<version>` element to the `quarkus-resteasy-reactive` dependency that is managed by the `quarkus-bom` and then run `quarkus:info` again, we'll see something like:

[source,text,subs=attributes+]
----
[INFO] --- quarkus-maven-plugin:{quarkus-version}:info (default-cli) @ code-with-quarkus ---
[WARNING] quarkus:info goal is experimental, its options and output may change in future versions
[INFO] Quarkus platform BOMs:
[INFO]   io.quarkus.platform:quarkus-bom:pom:{quarkus-version}
[INFO]   io.quarkus.platform:quarkus-kogito-bom:pom:{quarkus-version} | unnecessary <1>
[INFO]   io.quarkus.platform:quarkus-camel-bom:pom:{quarkus-version}
[INFO] 
[INFO] Extensions from io.quarkus.platform:quarkus-bom:
[INFO]   io.quarkus:quarkus-resteasy-reactive:2.6.3.Final | misaligned <2>
[INFO] 
[INFO] Extensions from io.quarkus.platform:quarkus-camel-bom:
[INFO]   org.apache.camel.quarkus:camel-quarkus-rabbitmq
[INFO] 
[INFO] Extensions from registry.quarkus.io:
[INFO]   io.quarkiverse.prettytime:quarkus-prettytime:0.2.1
[INFO]
[WARNING] Non-recommended Quarkus platform BOM and/or extension versions were found. For more details, please, execute 'mvn quarkus:update -Drectify'
----

<1> The `quarkus-kogito-bom` import is now reported as 'unnecessary' since none of the Quarkus extensions it includes are found among the project dependencies
<2> The version `2.6.3.Final` of the `quarkus-resteasy-reactive` is now reported as being misaligned with the version managed by the Quarkus platform BOM imported in the project, which is {quarkus-version}

[[project-update]]
== Quarkus project update

The `quarkus:update` goal (currently marked as 'experimental') provided by the Quarkus Maven plugin can be used to check whether there are Quarkus-related updates available for a project, such as: new releases of the relevant Quarkus platform BOMs and non-platform Quarkus extensions present in the project. In a multi-module project the `update` goal is meant to be executed from the main Quarkus application module.

IMPORTANT: At this point, the `quarkus:update` goal does not actually apply the recommended updates but simply reports what they are and how to apply them manually.

NOTE: The Quarkus Maven plugin version isn't currently included in the update report, however it's planned to be added in the future releases.

The way `quarkus:update` works, first, all the direct Quarkus extension dependencies of the project are collected (those that are managed by the Quarkus platform BOMs and those that aren't but found in the Quarkus extension registries). Then the configured Quarkus extension registries (typically the `registry.quarkus.io`) will be queried for the latest recommended/supported Quarkus platform versions and non-platform Quarkus extensions compatible with them. The algorithm will then select the latest compatible combination of all the extensions found in the project, assuming such a combination actually exists. Otherwise, no updates will be suggested.

Assuming we have a project including Kogito, Camel and core Quarkus extensions available in the Quarkus platform based on Quarkus `2.7.1.Final`, the output of the `quarkus:update` would look like:
[source,text,subs=attributes+]
----
[aloubyansky@localhost code-with-quarkus]$ mvn quarkus:update
[INFO] Scanning for projects...
[INFO] 
[INFO] ---------------------< org.acme:code-with-quarkus >---------------------
[INFO] Building code-with-quarkus 1.0.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- quarkus-maven-plugin:{quarkus-version}:update (default-cli) @ code-with-quarkus ---
[WARNING] quarkus:update goal is experimental, its options and output might change in future versions
[INFO] 
[INFO] Recommended Quarkus platform BOM updates: <1>
[INFO] Update: io.quarkus.platform:quarkus-bom:pom:2.7.1.Final -> {quarkus-version}
[INFO] Update: io.quarkus.platform:quarkus-kogito-bom:pom:2.7.1.Final -> {quarkus-version}
[INFO] Update: io.quarkus.platform:quarkus-camel-bom:pom:2.7.1.Final -> {quarkus-version}
----

<1> A list of currently recommended Quarkus platform BOM updates

NOTE: Typically, a single project property will be used to manage all the Quarkus platform BOMs but the implementation isn't currently smart enough to point that out and will report updates for each BOM individually.

If we modify the project to remove all the Kogito extensions from the project, change the version of the `quarkus-resteasy-reactive` extension to `2.6.3.Final` and downgrade `quarkus-prettytime` which is not included in the Quarkus platform BOMs to `0.2.0`, `quarkus:update` will report something like:

[source,text,subs=attributes+]
----
[INFO] Recommended Quarkus platform BOM updates: <1>
[INFO] Update: io.quarkus.platform:quarkus-bom:pom:2.7.1.Final -> {quarkus-version}
[INFO] Update: io.quarkus.platform:quarkus-camel-bom:pom:2.7.1.Final -> {quarkus-version}
[INFO] Remove: io.quarkus.platform:quarkus-kogito-bom:pom:2.7.1.Final <2>
[INFO] 
[INFO] Extensions from io.quarkus.platform:quarkus-bom:
[INFO] Update: io.quarkus:quarkus-resteasy-reactive:2.6.3.Final -> remove version (managed) <3>
[INFO] 
[INFO] Extensions from registry.quarkus.io:
[INFO] Update: io.quarkiverse.prettytime:quarkus-prettytime:0.2.0 -> 0.2.1 <4>
----

<1> A list of the currently recommended Quarkus platform BOM updates for the project
<2> Given that the project does not include any Kogito extensions, the BOM import is recommended to be removed
<3> An outdated version of the `quarkus-resteasy-reactive` is recommended to be removed in favor of the one managed by the `quarkus-bom`
<4> The latest compatible version of the `quarkus-prettytime` extension

=== Quarkus project rectify

As was mentioned above, `quarkus:info`, besides reporting Quarkus platform and extension versions, performs a quick version alignment check, to make sure the extension versions used in the project are compatible with the imported Quarkus platform BOMs. If misalignments are detected, the following warning message will be logged:

[source,text,subs=attributes+]
----
[WARNING] Non-recommended Quarkus platform BOM and/or extension versions were found. For more details, please, execute 'mvn quarkus:update -Drectify'
----

When the `rectify` option is enabled, `quarkus:update`, instead of suggesting the latest recommended Quarkus version updates, will log update instructions to simply align the extension dependency versions found in the project with the currently imported Quarkus platform BOMs.
",12488,False,2211.309614048782,median
"// license:BSD-3-Clause
// copyright-holders:Zsolt Vasvari
/***************************************************************************

    Epos games

    driver by Zsolt Vasvari


    Notes:

    - To walk in IGMO, hold down button 2.
    - Super Glob seems like a later revision of The Glob, the most obvious
      difference being an updated service mode.
    - These games don't have cocktail mode.
    - The CPU clock divisor 4 was derived using the timing loop used to split
      the screen in the middle.  This loop takes roughly 24200 cycles, giving
      2500 + (24200 - 2500) * 2 * 60 = 2754000 = 2.75MHz for the CPU speed,
      assuming 60 fps and a 2500 cycle VBLANK period.
      This also matches the IGMO schematic, as it is the /CLK signal, which is
      derived from the 11MHz xtal by dividing it down by two 74LS193 chips, one
      (U92) dividing the clock by 2, and another (U91) having 3 taps, further
      dividing the already divided clock by 2 (/CLK), 4 (/PLOAD) and 8 (CLOCK).
      The CLOCK signal drives the AY.
    - I think theglob2 is earlier than theglob.  They only differ in one routine,
      but it appears to be a bug fix.  Also, theglob3 appears to be even older.

    To Do:

    - Super Blob uses a busy loop during the color test to split the screen
      between the two palettes.  This effect is not emulated, but since both
      halves of the palette are identical, this is not an issue.  See $039c.
      The other games have a different color test, not using the busy loop.

    - dealer/beastf/revngr84: ""PSG registers not OK"" in service mode thru
      sound menu, internal ay8910 not right?

***************************************************************************/

#include ""emu.h""
#include ""includes/epos.h""

#include ""cpu/z80/z80.h""
#include ""machine/i8255.h""
#include ""machine/watchdog.h""
#include ""machine/nvram.h""
#include ""sound/ay8910.h""
#include ""screen.h""
#include ""speaker.h""


WRITE8_MEMBER(epos_state::dealer_decrypt_rom)
{
	if (offset & 0x04)
		m_counter = (m_counter + 1) & 0x03;
	else
		m_counter = (m_counter - 1) & 0x03;

//  logerror(""PC %08x: ctr=%04x\\n"",m_maincpu->pc(), m_counter);

	membank(""bank1"")->set_entry(m_counter);

	// is the 2nd bank changed by the counter or it always uses the 1st key?
}


/*************************************
 *
 *  Main CPU memory handlers
 *
 *************************************/

void epos_state::epos_map(address_map &map)
{
	map(0x0000, 0x77ff).rom();
	map(0x7800, 0x7fff).ram();
	map(0x8000, 0xffff).ram().share(""videoram"");
}

void epos_state::dealer_map(address_map &map)
{
	map(0x0000, 0x5fff).bankr(""bank1"");
	map(0x6000, 0x6fff).bankr(""bank2"");
	map(0x7000, 0x7fff).ram().share(""nvram"");
	map(0x8000, 0xffff).ram().share(""videoram"");
}

/*************************************
 *
 *  Main CPU port handlers
 *
 *************************************/

void epos_state::epos_io_map(address_map &map)
{
	map.global_mask(0xff);
	map(0x00, 0x00).portr(""DSW"").w(""watchdog"", FUNC(watchdog_timer_device::reset_w));
	map(0x01, 0x01).portr(""SYSTEM"").w(this, FUNC(epos_state::port_1_w));
	map(0x02, 0x02).portr(""INPUTS"").w(""aysnd"", FUNC(ay8910_device::data_w));
	map(0x03, 0x03).portr(""UNK"");
	map(0x06, 0x06).w(""aysnd"", FUNC(ay8910_device::address_w));
}

void epos_state::dealer_io_map(address_map &map)
{
	map.global_mask(0xff);
	map(0x00, 0x0f).w(this, FUNC(epos_state::dealer_pal_w));
	map(0x10, 0x13).rw(""ppi8255"", FUNC(i8255_device::read), FUNC(i8255_device::write));
	map(0x20, 0x24).w(this, FUNC(epos_state::dealer_decrypt_rom));
	map(0x34, 0x34).w(""aysnd"", FUNC(ay8910_device::data_w));
	map(0x38, 0x38).r(""aysnd"", FUNC(ay8910_device::data_r));
	map(0x3c, 0x3c).w(""aysnd"", FUNC(ay8910_device::address_w));
	map(0x40, 0x40).w(""watchdog"", FUNC(watchdog_timer_device::reset_w));
}

READ8_MEMBER(epos_state::i8255_porta_r)
{
	uint8_t data = 0xff;

	if (!BIT(m_input_multiplex, 0))
		data &= m_inputs[0]->read();

	if (!BIT(m_input_multiplex, 1))
		data &= m_inputs[1]->read();

	return data;
}

/*
   ROMs U01-U03 are checked with the same code in a loop.
   There's a separate ROM check for banked U04 at 30F3.
   It looks like dealer/revenger uses ppi8255 to control bankswitching.
*/
WRITE8_MEMBER(epos_state::i8255_portc_w)
{
	membank(""bank2"")->set_entry(data & 0x01);
	m_input_multiplex = (data >> 5) & 3;
}

READ8_MEMBER(epos_state::ay_porta_mpx_r)
{
	return (m_ay_porta_multiplex ? 0xFF : ioport(""DSW"")->read());
}

WRITE8_MEMBER(epos_state::flip_screen_w)
{
	flip_screen_set(BIT(data, 7));
	// bit 6: ay8910 port A/B multiplexer read
	m_ay_porta_multiplex = BIT(data, 6);
}

/*************************************
 *
 *  Port definitions
 *
 *************************************/

/* I think the upper two bits of port 1 are used as a simple form of protection,
   so that ROMs couldn't be simply swapped.  Each game checks these bits and halts
   the processor if an unexpected value is read. */

static INPUT_PORTS_START( megadon )
	PORT_START(""DSW"")

// There are odd port mappings (old=new)
// 02=10, 04=40, 08=02, 10=20, 20=04, 40=08

	PORT_DIPNAME( 0x01, 0x00, DEF_STR( Coinage ) ) PORT_DIPLOCATION(""SW1:1"")
	PORT_DIPSETTING(    0x00, DEF_STR( 1C_1C ) )
	PORT_DIPSETTING(    0x01, DEF_STR( 1C_2C ) )
	PORT_DIPNAME( 0x50, 0x00, DEF_STR( Lives ) ) PORT_DIPLOCATION(""SW1:2,3"")
	PORT_DIPSETTING(    0x00, ""3"" )
	PORT_DIPSETTING(    0x10, ""4"" )
	PORT_DIPSETTING(    0x40, ""5"" )
	PORT_DIPSETTING(    0x50, ""6"" )
	PORT_DIPNAME( 0x02, 0x00, ""Fuel Consumption"" ) PORT_DIPLOCATION(""SW1:4"")
	PORT_DIPSETTING(    0x00, ""Slow"" )
	PORT_DIPSETTING(    0x02, ""Fast"" )
	PORT_DIPNAME( 0x20, 0x20, ""Enemy Fire Rate"" ) PORT_DIPLOCATION(""SW1:5"")
	PORT_DIPSETTING(    0x20, ""Slow"" )
	PORT_DIPSETTING(    0x00, ""Fast"" )
	PORT_DIPNAME( 0x04, 0x00, ""Rotation"" ) PORT_DIPLOCATION(""SW1:6"")
	PORT_DIPSETTING(    0x04, ""Slow"" )
	PORT_DIPSETTING(    0x00, ""Fast"" )
	PORT_DIPNAME( 0x08, 0x08, ""ERG"" ) PORT_DIPLOCATION(""SW1:7"")
	PORT_DIPSETTING(    0x08, DEF_STR( Easy ) )
	PORT_DIPSETTING(    0x00, DEF_STR( Hard ) )
	PORT_DIPNAME( 0x80, 0x00, ""Game Mode"" ) PORT_DIPLOCATION(""SW1:8"")
	PORT_DIPSETTING(    0x00, ""Arcade"" )
	PORT_DIPSETTING(    0x80, ""Contest"" )

	PORT_START(""SYSTEM"")
	PORT_BIT( 0x01, IP_ACTIVE_HIGH, IPT_COIN1 )
	PORT_BIT( 0x02, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x04, IP_ACTIVE_LOW,  IPT_START1 )
	PORT_BIT( 0x08, IP_ACTIVE_LOW,  IPT_START2 )
	PORT_SERVICE_NO_TOGGLE(0x10, IP_ACTIVE_LOW)
	PORT_BIT( 0x20, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x40, IP_ACTIVE_LOW,  IPT_SPECIAL )   /* this has to be HI */
	PORT_BIT( 0x80, IP_ACTIVE_LOW,  IPT_SPECIAL )   /* this has to be HI */

	PORT_START(""INPUTS"")
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_JOYSTICK_RIGHT )
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_JOYSTICK_LEFT )
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_BUTTON1 )
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_BUTTON2 )
	PORT_BIT( 0xf0, IP_ACTIVE_LOW, IPT_UNKNOWN )

	PORT_START(""UNK"")
	PORT_BIT( 0xff, IP_ACTIVE_HIGH, IPT_UNKNOWN )
INPUT_PORTS_END


static INPUT_PORTS_START( suprglob )
	PORT_START(""DSW"")

// There are odd port mappings (old=new)
// 02=10, 04=40, 08=20, 10=02, 20=04, 40=08

	PORT_DIPNAME( 0x01, 0x00, DEF_STR( Coinage ) ) PORT_DIPLOCATION(""SW1:1"")
	PORT_DIPSETTING(    0x00, DEF_STR( 1C_1C ) )
	PORT_DIPSETTING(    0x01, DEF_STR( 1C_2C ) )
	PORT_DIPNAME( 0x50, 0x00, DEF_STR( Lives ) ) PORT_DIPLOCATION(""SW1:2,3"")
	PORT_DIPSETTING(    0x00, ""3"" )
	PORT_DIPSETTING(    0x10, ""4"" )
	PORT_DIPSETTING(    0x40, ""5"" )
	PORT_DIPSETTING(    0x50, ""6"" )
	PORT_DIPNAME( 0x26, 0x00, DEF_STR( Difficulty ) ) PORT_DIPLOCATION(""SW1:4,5,6"")
	PORT_DIPSETTING(    0x00, ""1"" )
	PORT_DIPSETTING(    0x02, ""2"" )
	PORT_DIPSETTING(    0x20, ""3"" )
	PORT_DIPSETTING(    0x22, ""4"" )
	PORT_DIPSETTING(    0x04, ""5"" )
	PORT_DIPSETTING(    0x06, ""6"" )
	PORT_DIPSETTING(    0x24, ""7"" )
	PORT_DIPSETTING(    0x26, ""8"" )
	PORT_DIPNAME( 0x08, 0x00, DEF_STR( Bonus_Life ) ) PORT_DIPLOCATION(""SW1:7"")
	PORT_DIPSETTING(    0x00, ""10000 + Difficulty * 10000"" )
	PORT_DIPSETTING(    0x08, ""90000 + Difficulty * 10000"" )
	PORT_DIPNAME( 0x80, 0x00, DEF_STR( Demo_Sounds ) ) PORT_DIPLOCATION(""SW1:8"")
	PORT_DIPSETTING(    0x80, DEF_STR( Off ) )
	PORT_DIPSETTING(    0x00, DEF_STR( On ) )

	PORT_START(""SYSTEM"")
	PORT_BIT( 0x01, IP_ACTIVE_HIGH, IPT_COIN1 )
	PORT_BIT( 0x02, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x04, IP_ACTIVE_LOW,  IPT_START1 )
	PORT_BIT( 0x08, IP_ACTIVE_LOW,  IPT_START2 )
	PORT_SERVICE_NO_TOGGLE(0x10, IP_ACTIVE_LOW)
	PORT_BIT( 0x20, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x40, IP_ACTIVE_HIGH, IPT_SPECIAL )   /* this has to be LO */
	PORT_BIT( 0x80, IP_ACTIVE_LOW,  IPT_SPECIAL )   /* this has to be HI */

	PORT_START(""INPUTS"")
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_JOYSTICK_RIGHT )
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_JOYSTICK_LEFT )
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_BUTTON1 )
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_BUTTON2 )
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_JOYSTICK_UP )
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_JOYSTICK_DOWN )
	PORT_BIT( 0x40, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x80, IP_ACTIVE_LOW, IPT_UNKNOWN )

	PORT_START(""UNK"")
	PORT_BIT( 0xff, IP_ACTIVE_HIGH, IPT_UNKNOWN )
INPUT_PORTS_END


static INPUT_PORTS_START( igmo )
	PORT_START(""DSW"")

// There are odd port mappings (old=new)
// 02=10, 04=40, 08=20, 10=02, 20=04, 40=08

	PORT_DIPNAME( 0x01, 0x00, DEF_STR( Coinage ) ) PORT_DIPLOCATION(""SW1:1"")
	PORT_DIPSETTING(    0x00, DEF_STR( 1C_1C ) )
	PORT_DIPSETTING(    0x01, DEF_STR( 1C_2C ) )
	PORT_DIPNAME( 0x50, 0x00, DEF_STR( Lives ) ) PORT_DIPLOCATION(""SW1:2,3"")
	PORT_DIPSETTING(    0x00, ""3"" )
	PORT_DIPSETTING(    0x10, ""4"" )
	PORT_DIPSETTING(    0x40, ""5"" )
	PORT_DIPSETTING(    0x50, ""6"" )
	PORT_DIPNAME( 0x22, 0x00, DEF_STR( Bonus_Life ) ) PORT_DIPLOCATION(""SW1:4,5"")
	PORT_DIPSETTING(    0x00, ""20000"" )
	PORT_DIPSETTING(    0x02, ""40000"" )
	PORT_DIPSETTING(    0x20, ""60000"" )
	PORT_DIPSETTING(    0x22, ""80000"" )
	PORT_DIPNAME( 0x8c, 0x00, DEF_STR( Difficulty ) ) PORT_DIPLOCATION(""SW1:6,7,8"")
	PORT_DIPSETTING(    0x00, ""1"" )
	PORT_DIPSETTING(    0x04, ""2"" )
	PORT_DIPSETTING(    0x08, ""3"" )
	PORT_DIPSETTING(    0x0c, ""4"" )
	PORT_DIPSETTING(    0x80, ""5"" )
	PORT_DIPSETTING(    0x84, ""6"" )
	PORT_DIPSETTING(    0x88, ""7"" )
	PORT_DIPSETTING(    0x8c, ""8"" )

	PORT_START(""SYSTEM"")
	PORT_BIT( 0x01, IP_ACTIVE_HIGH, IPT_COIN1 )
	PORT_BIT( 0x02, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x04, IP_ACTIVE_LOW,  IPT_START1 )
	PORT_BIT( 0x08, IP_ACTIVE_LOW,  IPT_START2 )
	PORT_SERVICE_NO_TOGGLE(0x10, IP_ACTIVE_LOW)
	PORT_BIT( 0x20, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x40, IP_ACTIVE_LOW,  IPT_SPECIAL )   /* this has to be HI */
	PORT_BIT( 0x80, IP_ACTIVE_LOW,  IPT_SPECIAL )   /* this has to be HI */

	PORT_START(""INPUTS"")
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_JOYSTICK_RIGHT )
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_JOYSTICK_LEFT )
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_BUTTON1 )
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_BUTTON2 )
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_JOYSTICK_UP )
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_JOYSTICK_DOWN )
	PORT_BIT( 0xc0, IP_ACTIVE_LOW, IPT_UNKNOWN )

	PORT_START(""UNK"")
	PORT_BIT( 0xff, IP_ACTIVE_HIGH, IPT_UNKNOWN )
INPUT_PORTS_END


static INPUT_PORTS_START( catapult )
	PORT_INCLUDE(igmo)
		PORT_MODIFY(""DSW"")

// There are odd port mappings (old=new)
// 02=08, 04=20, 08=40, 10=02, 20=10, 40=04

	PORT_DIPNAME( 0x01, 0x00, DEF_STR( Coinage ) ) PORT_DIPLOCATION(""SW1:1"")
	PORT_DIPSETTING(    0x00, DEF_STR( 1C_1C ) )
	PORT_DIPSETTING(    0x01, DEF_STR( 1C_2C ) )
	PORT_DIPNAME( 0x50, 0x00, DEF_STR( Lives ) ) PORT_DIPLOCATION(""SW1:2,3"")
	PORT_DIPSETTING(    0x00, ""3"" )
	PORT_DIPSETTING(    0x10, ""4"" )
	PORT_DIPSETTING(    0x40, ""5"" )
	PORT_DIPSETTING(    0x50, ""6"" )
	PORT_DIPNAME( 0x22, 0x00, DEF_STR( Difficulty ) ) PORT_DIPLOCATION(""SW1:4,5"")
	PORT_DIPSETTING(    0x00, ""1"" )
	PORT_DIPSETTING(    0x02, ""2"" )
	PORT_DIPSETTING(    0x20, ""3"" )
	PORT_DIPSETTING(    0x22, ""4"" )
	PORT_DIPNAME( 0x0c, 0x00, DEF_STR( Bonus_Life ) ) PORT_DIPLOCATION(""SW1:6,7"")
	PORT_DIPSETTING(    0x00, ""20000"" )
	PORT_DIPSETTING(    0x04, ""40000"" )
	PORT_DIPSETTING(    0x08, ""60000"" )
	PORT_DIPSETTING(    0x0c, ""80000"" )
	PORT_DIPNAME( 0x80, 0x00, DEF_STR( Demo_Sounds ) ) PORT_DIPLOCATION(""SW1:8"")
	PORT_DIPSETTING(    0x80, DEF_STR( Off ) )
	PORT_DIPSETTING(    0x00, DEF_STR( On ) )
INPUT_PORTS_END


static INPUT_PORTS_START( dealer )
	PORT_START(""DSW"")
	PORT_DIPNAME( 0x01, 0x00, DEF_STR( Demo_Sounds ) ) PORT_DIPLOCATION(""SW1:1"")
	PORT_DIPSETTING(    0x01, DEF_STR( Off ) )
	PORT_DIPSETTING(    0x00, DEF_STR( On ) )
	PORT_DIPNAME( 0x02, 0x02, DEF_STR( Free_Play ) ) PORT_DIPLOCATION(""SW1:2"")
	PORT_DIPSETTING(    0x02, DEF_STR( Off ) )
	PORT_DIPSETTING(    0x00, DEF_STR( On ) )
	PORT_DIPUNUSED_DIPLOC( 0x04, 0x04, ""SW1:3"" )
	PORT_DIPUNUSED_DIPLOC( 0x08, 0x08, ""SW1:4"" )
	PORT_DIPUNUSED_DIPLOC( 0x10, 0x10, ""SW1:5"" )
	PORT_DIPUNUSED_DIPLOC( 0x20, 0x20, ""SW1:6"" )
	PORT_DIPNAME( 0x40, 0x40, DEF_STR( Cabinet ) ) PORT_DIPLOCATION(""SW1:7"")
	PORT_DIPSETTING(    0x40, DEF_STR( Upright ) )
	PORT_DIPSETTING(    0x00, DEF_STR( Cocktail ) )
	PORT_DIPNAME( 0x80, 0x80, DEF_STR( Flip_Screen ) ) PORT_DIPLOCATION(""SW1:8"")
	PORT_DIPSETTING(    0x80, DEF_STR( Off ) )
	PORT_DIPSETTING(    0x00, DEF_STR( On ) )

	PORT_START(""SYSTEM"")
	PORT_BIT( 0x01, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x02, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x04, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x08, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x10, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x20, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x40, IP_ACTIVE_LOW,  IPT_UNKNOWN )
	PORT_BIT( 0x80, IP_ACTIVE_LOW,  IPT_UNKNOWN )

	PORT_START(""INPUTS"")
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_POKER_HOLD1 )
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_POKER_HOLD2 )
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_POKER_HOLD3 )
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_POKER_HOLD4 )
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_POKER_HOLD5 )
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x40, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x80, IP_ACTIVE_LOW, IPT_UNKNOWN )

	PORT_START(""INPUTS2"")
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_POKER_CANCEL )
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_GAMBLE_DEAL ) PORT_NAME( ""Draw"" )
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_GAMBLE_STAND )
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_GAMBLE_BET ) PORT_NAME( ""Play"" )
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_UNKNOWN )
	PORT_BIT( 0x40, IP_ACTIVE_LOW, IPT_COIN1 )
	PORT_BIT( 0x80, IP_ACTIVE_LOW, IPT_SERVICE )
INPUT_PORTS_END

static INPUT_PORTS_START( beastf )
	PORT_INCLUDE(dealer)

	PORT_MODIFY(""INPUTS"")
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_JOYSTICK_LEFT ) PORT_4WAY
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_JOYSTICK_RIGHT ) PORT_4WAY
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_JOYSTICK_DOWN ) PORT_4WAY
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_JOYSTICK_UP ) PORT_4WAY
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_BUTTON1 )
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_BUTTON2 )
	PORT_BIT( 0x40, IP_ACTIVE_LOW, IPT_START1 )
	PORT_BIT( 0x80, IP_ACTIVE_LOW, IPT_START2 )

	PORT_MODIFY(""INPUTS2"")
	PORT_BIT( 0x01, IP_ACTIVE_LOW, IPT_JOYSTICK_LEFT ) PORT_4WAY PORT_PLAYER(2)
	PORT_BIT( 0x02, IP_ACTIVE_LOW, IPT_JOYSTICK_RIGHT ) PORT_4WAY PORT_PLAYER(2)
	PORT_BIT( 0x04, IP_ACTIVE_LOW, IPT_JOYSTICK_DOWN ) PORT_4WAY PORT_PLAYER(2)
	PORT_BIT( 0x08, IP_ACTIVE_LOW, IPT_JOYSTICK_UP ) PORT_4WAY PORT_PLAYER(2)
	PORT_BIT( 0x10, IP_ACTIVE_LOW, IPT_BUTTON1 ) PORT_PLAYER(2)
	PORT_BIT( 0x20, IP_ACTIVE_LOW, IPT_BUTTON2 ) PORT_PLAYER(2)
INPUT_PORTS_END

/*************************************
 *
 *  Machine drivers
 *
 *************************************/

MACHINE_START_MEMBER(epos_state,epos)
{
	save_item(NAME(m_palette_bank));
	save_item(NAME(m_counter));
	save_item(NAME(m_input_multiplex));
	save_item(NAME(m_ay_porta_multiplex));
}

void epos_state::machine_reset()
{
	m_palette_bank = 0;
	m_counter = 0;
	m_input_multiplex = 3;
	m_ay_porta_multiplex = 0;
}


MACHINE_START_MEMBER(epos_state,dealer)
{
	uint8_t *ROM = memregion(""maincpu"")->base();
	membank(""bank1"")->configure_entries(0, 4, &ROM[0x0000], 0x10000);
	membank(""bank2"")->configure_entries(0, 2, &ROM[0x6000], 0x1000);

	membank(""bank1"")->set_entry(0);
	membank(""bank2"")->set_entry(0);

	MACHINE_START_CALL_MEMBER(epos);
}

MACHINE_CONFIG_START(epos_state::epos) /* EPOS TRISTAR 8000 PCB */

	/* basic machine hardware */
	MCFG_CPU_ADD(""maincpu"", Z80, XTAL(11'000'000)/4)    /* 2.75 MHz schematics confirm 11MHz XTAL (see notes) */
	MCFG_CPU_PROGRAM_MAP(epos_map)
	MCFG_CPU_IO_MAP(epos_io_map)
	MCFG_CPU_VBLANK_INT_DRIVER(""screen"", epos_state,  irq0_line_hold)

	MCFG_WATCHDOG_ADD(""watchdog"")

	/* video hardware */
	MCFG_SCREEN_ADD(""screen"", RASTER)
	MCFG_SCREEN_REFRESH_RATE(60)
	MCFG_SCREEN_VBLANK_TIME(ATTOSECONDS_IN_USEC(2500) /* not accurate */)
	MCFG_SCREEN_SIZE(272, 241)
	MCFG_SCREEN_VISIBLE_AREA(0, 271, 0, 235)
	MCFG_SCREEN_UPDATE_DRIVER(epos_state, screen_update)

	MCFG_PALETTE_ADD(""palette"", 32)
	MCFG_PALETTE_INIT_OWNER(epos_state, epos)

	/* sound hardware */
	MCFG_SPEAKER_STANDARD_MONO(""mono"")
	MCFG_SOUND_ADD(""aysnd"", AY8912, XTAL(11'000'000)/16) /*  0.6875 MHz, confirmed from schematics */
	MCFG_SOUND_ROUTE(ALL_OUTPUTS, ""mono"", 1.0)
MACHINE_CONFIG_END


MACHINE_CONFIG_START(epos_state::dealer) /* EPOS TRISTAR 9000 PCB */

	/* basic machine hardware */
	MCFG_CPU_ADD(""maincpu"", Z80, XTAL(22'118'400)/8)    /* 2.7648 MHz (measured) */
	MCFG_CPU_PROGRAM_MAP(dealer_map)
	MCFG_CPU_IO_MAP(dealer_io_map)
	MCFG_CPU_VBLANK_INT_DRIVER(""screen"", epos_state,  irq0_line_hold)

	MCFG_DEVICE_ADD(""ppi8255"", I8255A, 0)
	MCFG_I8255_IN_PORTA_CB(READ8(epos_state, i8255_porta_r))
	MCFG_I8255_OUT_PORTC_CB(WRITE8(epos_state, i8255_portc_w))

	MCFG_NVRAM_ADD_0FILL(""nvram"")

	MCFG_MACHINE_START_OVERRIDE(epos_state,dealer)

	// RAM-based palette instead of prom
	MCFG_PALETTE_ADD_INIT_BLACK(""palette"", 32)
//  MCFG_PALETTE_INIT_OWNER(epos_state, epos)

	MCFG_WATCHDOG_ADD(""watchdog"")

	/* video hardware */
	MCFG_SCREEN_ADD(""screen"", RASTER)
	MCFG_SCREEN_REFRESH_RATE(60)
	MCFG_SCREEN_VBLANK_TIME(ATTOSECONDS_IN_USEC(2500) /* not accurate */)
	MCFG_SCREEN_SIZE(272, 241)
	MCFG_SCREEN_VISIBLE_AREA(0, 271, 0, 235)
	MCFG_SCREEN_UPDATE_DRIVER(epos_state, screen_update)

	/* sound hardware */
	MCFG_SPEAKER_STANDARD_MONO(""mono"")
	MCFG_SOUND_ADD(""aysnd"", AY8910, XTAL(22'118'400)/32)    /* 0.6912 MHz (measured) */
	MCFG_SOUND_ROUTE(ALL_OUTPUTS, ""mono"", 1.0)
	MCFG_AY8910_PORT_A_READ_CB(READ8(epos_state, ay_porta_mpx_r))
	// port a writes?
	MCFG_AY8910_PORT_B_WRITE_CB(WRITE8(epos_state, flip_screen_w)) // flipscreen and ay port a multiplex control
MACHINE_CONFIG_END


/*************************************
 *
 *  ROM definitions
 *
 *************************************/

// Tristar 8000 boards:
ROM_START( megadon )
	ROM_REGION( 0x10000, ""maincpu"", 0 )
	ROM_LOAD( ""2732u10b.bin"",   0x0000, 0x1000, CRC(af8fbe80) SHA1(2d7857616462112fe17343a9357ee51d8f965a0f) )
	ROM_LOAD( ""2732u09b.bin"",   0x1000, 0x1000, CRC(097d1e73) SHA1(b6141155b2c63c33a367dd18fe53ff9f01b99380) )
	ROM_LOAD( ""2732u08b.bin"",   0x2000, 0x1000, CRC(526784da) SHA1(7d9f43dc6975a018bec95982029ce7ac9f675869) )
	ROM_LOAD( ""2732u07b.bin"",   0x3000, 0x1000, CRC(5b060910) SHA1(98a719bf0ffe8010437565de681aaefa647d9a6c) )
	ROM_LOAD( ""2732u06b.bin"",   0x4000, 0x1000, CRC(8ac8af6d) SHA1(53c123f0e9f0443737c39c01dbdb685189cffa92) )
	ROM_LOAD( ""2732u05b.bin"",   0x5000, 0x1000, CRC(052bb603) SHA1(eb74a9563f44cca50dc2c475e4a376ed14e4f56f) )
	ROM_LOAD( ""2732u04b.bin"",   0x6000, 0x1000, CRC(9b8b7e92) SHA1(051ad9a8ba51740a865e3c95a738658b30bbbe60) )
	ROM_LOAD( ""2716u11b.bin"",   0x7000, 0x0800, CRC(599b8b61) SHA1(e687c6f475a0fead3e47f05b1d1b3b29cf4a83a1) )

	ROM_REGION( 0x0020, ""proms"", 0 )
	ROM_LOAD( ""74s288.bin"",     0x0000, 0x0020, CRC(c779ea99) SHA1(7702ae3684579950b36274ea91d4267c96faeeb8) )
ROM_END


ROM_START( catapult )
	ROM_REGION( 0x10000, ""maincpu"", 0 )
	ROM_LOAD( ""co3223.u10"",     0x0000, 0x1000, CRC(50abcfd2) SHA1(13ce04addc7bcaa1ec6659da26b1c13ed9dc28f9) )
	ROM_LOAD( ""co3223.u09"",     0x1000, 0x1000, CRC(fd5a9a1c) SHA1(512374e8450459537ba2cc41e7d0178052445316) )
	ROM_LOAD( ""co3223.u08"",     0x2000, 0x1000, BAD_DUMP CRC(4bfc36f3) SHA1(b916805eed40cfeff0c1b0cb3cdcbcc6e362a236)  ) /* BADADDR xxxx-xxxxxxx */
	ROM_LOAD( ""co3223.u07"",     0x3000, 0x1000, CRC(4113bb99) SHA1(3cebb874dae211d75082209e913d4afa4f621de1) )
	ROM_LOAD( ""co3223.u06"",     0x4000, 0x1000, CRC(966bb9f5) SHA1(1a217c6f7a88c58e0deae0290bc5ddd2789d18eb) )
	ROM_LOAD( ""co3223.u05"",     0x5000, 0x1000, CRC(65f9fb9a) SHA1(63b616a736d9e39a8f2f76889fd7c5fe4128a966) )
	ROM_LOAD( ""co3223.u04"",     0x6000, 0x1000, CRC(648453bc) SHA1(8e4538aedad4d32bd046aad474dbcc689ee8fe53) )
	ROM_LOAD( ""co3223.u11"",     0x7000, 0x0800, CRC(08fb8c28) SHA1(0b08cc2727a54e0ad7472234be0f637b46bc3253) )

	ROM_REGION( 0x0020, ""proms"", 0 )
	ROM_LOAD( ""co3223.u66"",     0x0000, 0x0020, CRC(e7de76a7) SHA1(101ce85459a59c0d01ce3ea96480f1f8413a788e) )
ROM_END


ROM_START( suprglob )
	ROM_REGION( 0x10000, ""maincpu"", 0 )
	ROM_LOAD( ""u10"",            0x0000, 0x1000, CRC(c0141324) SHA1(a54bd71da233eb22f45da630693fddd5a0bcf25b) )
	ROM_LOAD( ""u9"",             0x1000, 0x1000, CRC(58be8128) SHA1(534f0a093b3ff577a2a5461498bc11ce14dc6d97) )
	ROM_LOAD( ""u8"",             0x2000, 0x1000, CRC(6d088c16) SHA1(0929ea1b58eab997b5d9c9642f8b47557a4045f1) )
	ROM_LOAD( ""u7"",             0x3000, 0x1000, CRC(b2768203) SHA1(9de52f4dbe6a46ea1b9b7f9cf70378211d372353) )
	ROM_LOAD( ""u6"",             0x4000, 0x1000, CRC(976c8f46) SHA1(120c76eff8c04ccb5ad945c4333e8c9de0cbc3af) )
	ROM_LOAD( ""u5"",             0x5000, 0x1000, CRC(340f5290) SHA1(2e5fa0c41d1626e5a435f2c55eec0bcdcb004223) )
	ROM_LOAD( ""u4"",             0x6000, 0x1000, CRC(173bd589) SHA1(25690a0c3cd0e017f8d220d8fbf2eaeb86f05fc5) )
	ROM_LOAD( ""u11"",            0x7000, 0x0800, CRC(d45b740d) SHA1(54c15f378b6d91ea1aba0a51921178bb15854079) )

	ROM_REGION( 0x0020, ""proms"", 0 )
	ROM_LOAD( ""82s123.u66"",     0x0000, 0x0020, CRC(f4f6ddc5) SHA1(cab915acbefb5f451f538dd538bf9b3dd14bb1f5) )
ROM_END


ROM_START( theglob )
	ROM_REGION( 0x10000, ""maincpu"", 0 )
	ROM_LOAD( ""globu10.bin"",    0x0000, 0x1000, CRC(08fdb495) SHA1(739efa676b5a3df36a6061382aeb8c2d495ba23f) )
	ROM_LOAD( ""globu9.bin"",     0x1000, 0x1000, CRC(827cd56c) SHA1(3aedc1cefb463cf6b31befb33e50c832dc2e3941) )
	ROM_LOAD( ""globu8.bin"",     0x2000, 0x1000, CRC(d1219966) SHA1(571349f9c978fdcf826a0c66c3fb11a9e27b240a) )
	ROM_LOAD( ""globu7.bin"",     0x3000, 0x1000, CRC(b1649da7) SHA1(1509d48a72e545195e45d1170cdb113c6aecc8d9) )
	ROM_LOAD( ""globu6.bin"",     0x4000, 0x1000, CRC(b3457e67) SHA1(1347bdf085ad69879f9a9e7e4ed1ca4869e8e8cd) )
	ROM_LOAD( ""globu5.bin"",     0x5000, 0x1000, CRC(89d582cd) SHA1(f331c7a2fce606153992abb312c5406251a7fb3b) )
	ROM_LOAD( ""globu4.bin"",     0x6000, 0x1000, CRC(7ee9fdeb) SHA1(a8e0dd5d1cdcff132edc0eb182b66656ce244fa1) )
	ROM_LOAD( ""globu11.bin"",    0x7000, 0x0800, CRC(9e05dee3) SHA1(751799b23f0e664f59d3785b438ec3ae9f5bab2c) )

	ROM_REGION( 0x0020, ""proms"", 0 )
	ROM_LOAD( ""82s123.u66"",     0x0000, 0x0020, CRC(f4f6ddc5) SHA1(cab915acbefb5f451f538dd538bf9b3dd14bb1f5) )
ROM_END


ROM_START( theglob2 )
	ROM_REGION( 0x10000, ""maincpu"", 0 )
	ROM_LOAD( ""611293.u10"",     0x0000, 0x1000, CRC(870af7ce) SHA1(f901619663313a72997f30ccecdeac8294fe200e) )
	ROM_LOAD( ""611293.u9"",      0x1000, 0x1000, CRC(a3679782) SHA1(fbc26ae98e2bf10272d61159b084d78a6f410374) )
	ROM_LOAD( ""611293.u8"",      0x2000, 0x1000, CRC(67499d1a) SHA1(dce7041df5ed1847e0ffc82672d09e00b16de3a9) )
	ROM_LOAD( ""611293.u7"",      0x3000, 0x1000, CRC(55e53aac) SHA1(20a428db287e8b7fb55cb9fe1a1ed0196481114c) )
	ROM_LOAD( ""611293.u6"",      0x4000, 0x1000, CRC(c64ad743) SHA1(572ff6acb9b2281581974646e96699d7d2388aff) )
	ROM_LOAD( ""611293.u5"",      0x5000, 0x1000, CRC(f93c3203) SHA1(8cb88b5202e99d206eccf7d25e168cf23acee19b) )
	ROM_LOAD( ""611293.u4"",      0x6000, 0x1000, CRC(ceea0018) SHA1(511430539429ef0e5368f7b605f2e680ca9038bc) )
	ROM_LOAD( ""611293.u11"",     0x7000, 0x0800, CRC(6ac83f9b) SHA1(b1e8482ec04107f0e595a714b7c0f70571aca6e5) )

	ROM_REGION( 0x0020, ""proms"", 0 )
	ROM_LOAD( ""82s123.u66"",     0x0000, 0x0020, CRC(f4f6ddc5) SHA1(cab915acbefb5f451f538dd538bf9b3dd14bb1f5) )
ROM_END


ROM_START( theglob3 )
	ROM_REGION( 0x10000, ""maincpu"", 0 )
	ROM_LOAD( ""theglob3.u10"",   0x0000, 0x1000, CRC(969cfaf6) SHA1(b63226b8694640d6452bca12755780d1b52d1d3c) )
	ROM_LOAD( ""theglob3.u9"",    0x1000, 0x1000, CRC(8e6c010a) SHA1(ec9627742ce52eb29bbafc9d0555d16ac7146f2e) )
	ROM_LOAD( ""theglob3.u8"",    0x2000, 0x1000, CRC(1c1ca5c8) SHA1(6e5f9d7f9f016a72003433375c806c5f921ed423) )
	ROM_LOAD( ""theglob3.u7"",    0x3000, 0x1000, CRC(a54b9d22) SHA1(3db96d1f55642ecf1ebc76387cac76e8f9721919) )
	ROM_LOAD( ""theglob3.u6"",    0x4000, 0x1000, CRC(5a6f82a9) SHA1(ea92ad949373e8b1f06c65f243ceedad2fdcd934) )
	ROM_LOAD( ""theglob3.u5"",    0x5000, 0x1000, CRC(72f935db) SHA1(d7023cf5f16a77a42590a9c97c2690ac0e3d282a) )
	ROM_LOAD( ""theglob3.u4"",    0x6000, 0x1000, CRC(81db53ad) SHA1(a1e4aa8e08ca0f585b3638a3849a465977d44af0) )
	ROM_LOAD( ""theglob3.u11"",   0x7000, 0x0800, CRC(0e2e6359) SHA1(f231637ad4c997406989cf5a701d26c95e69171e) )

	ROM_REGION( 0x0020, ""proms"", 0 )
	ROM_LOAD( ""82s123.u66"",     0x0000, 0x0020, CRC(f4f6ddc5) SHA1(cab915acbefb5f451f538dd538bf9b3dd14bb1f5) )
ROM_END


ROM_START( igmo )
	ROM_REGION( 0x10000, ""maincpu"", 0 )
	ROM_LOAD( ""igmo-u10.732"",   0x0000, 0x1000, CRC(a9f691a4) SHA1(e3f2dc41bd8760fc52e99b7e9faa12c7cf51ffe0) )
	ROM_LOAD( ""igmo-u9.732"",    0x1000, 0x1000, CRC(3c133c97) SHA1(002b5aff6b947b6a9cbabeed5be798c1ddf2bda1) )
	ROM_LOAD( ""igmo-u8.732"",    0x2000, 0x1000, CRC(5692f8d8) SHA1(6ab50775dff49330a85fbfb2d4d4c3a2e54df3d1) )
	ROM_LOAD( ""igmo-u7.732"",    0x3000, 0x1000, CRC(630ae2ed) SHA1(0c293b6192e703b16ed20c277c706ae90773f477) )
	ROM_LOAD( ""igmo-u6.732"",    0x4000, 0x1000, CRC(d3f20e1d) SHA1(c0e0b542ac020adc085ec90c2462c6544098447e) )
	ROM_LOAD( ""igmo-u5.732"",    0x5000, 0x1000, CRC(e26bb391) SHA1(ba0e44c02fbb36e18e0d779d46bb992e6aba6cf1) )
	ROM_LOAD( ""igmo-u4.732"",    0x6000, 0x1000, CRC(762a4417) SHA1(7fed5221950e3e1ce41c0b4ded44597a242a0177) )
	ROM_LOAD( ""igmo-u11.716"",   0x7000, 0x0800, CRC(8c675837) SHA1(2725729693960b53ea01ebffa0a81df2cd425890) )

	ROM_REGION( 0x0020, ""proms"", 0 )
	ROM_LOAD( ""82s123.u66"",     0x0000, 0x0020, NO_DUMP )   /* missing */
ROM_END


// Tristar 9000 boards:
ROM_START( dealer )
	ROM_REGION( 0x40000, ""maincpu"", 0 )
	ROM_LOAD( ""u1.bin"",         0x0000, 0x2000, CRC(e06f3563) SHA1(0d58cd1f2e1ca89adb9c64d7dd520bb1f2d50f1a) )
	ROM_LOAD( ""u2.bin"",         0x2000, 0x2000, CRC(726bbbd6) SHA1(3538f3d655899c2a0f984c43fb7545ea4be1b231) )
	ROM_LOAD( ""u3.bin"",         0x4000, 0x2000, CRC(ab721455) SHA1(a477da0590e0431172baae972e765473e19dcbff) )
	ROM_LOAD( ""u4.bin"",         0x6000, 0x2000, CRC(ddb903e4) SHA1(4c06a2048b1c6989c363b110a17c33180025b9c8) )

	ROM_REGION( 0x1000, ""nvram"", 0)
	ROM_LOAD( ""dealer.nv"", 0, 0x1000, CRC(a6f88459) SHA1(1deda2a71433c97fe3e5cb39defc285f4fa9c9b8) )
ROM_END

/*

Revenger 84 - EPOS

EPOS TRISTAR 9000
+-------------------------------+
|                               |
|  DSW                          |
|             4116 4116         |
| 8910  Z80A  4116 4116         |
|             4116 4116         |
|  6116  BAT  4116 4116         |
|  6116       4116 4116         |
|  U4         4116 4116  74S189 |
|  U3         4116 4116  74S189 |
|  U2 PAL.U13 4116 4116         |
|  U1 PAL10L8 8255  DM74S288N   |
|                     22.1184MHz|
|                               |
|                      LM384N   |
|                        VOL    |
+--|28 pin Connector|-----------+

  CPU: Z80A        2.764800 MHz [22.1184MHz/8]
Sound: AY-3-8910   0.691200 MHz [22.1184MHz/32]
 XTAL: 22.1184MHz
  DSW: 8 position dipswitch bank
  BAT: Battery (battery backed up RAM for high scores)
  VOL: Volume Pot

28 Pin non-JAMMA connector

 4 ROMs at U1 through U4 are 2764 type
 BPROM at U60 is a DM74S288N
 2 pals, U12 is a PAL10L8, U13 PAL type is unknown (markings scrubbed off)

4116 RAS is = 2.764800 MHz [22.1184MHz/8]
4116 CAS is = 1.382400 MHz [22.1184MHz/16]

*/

ROM_START( revngr84 )
	ROM_REGION( 0x40000, ""maincpu"", 0 )
	ROM_LOAD( ""u_1__revenger__r06254__=c=_epos_corp.m5l2764k.u1"",  0x0000, 0x2000, CRC(308f231f) SHA1(cf06695601bd0387e4fcb64d9b34143323e98b07) ) /* labeled as ""U 1 // REVENGER // R06254 // (C) EPOS CORP"" (hand written R06254 over R06124) */
	ROM_LOAD( ""u_2__revenger__r06254__=c=_epos_corp.m5l2764k.u2"",  0x2000, 0x2000, CRC(e80bbfb4) SHA1(9302beaef8bbb7376b6a20e9ee5adbcf60d66dd8) ) /* labeled as ""U 2 // REVENGER // R06254 // (C) EPOS CORP"" (hand written R06254 over R06124) */
	ROM_LOAD( ""u_3__revenger__r06254__=c=_epos_corp.m5l2764k.u3"",  0x4000, 0x2000, CRC(d9270929) SHA1(a95034b5387a40e02f04bdfa79e1d8e65dad30fe) ) /* labeled as ""U 3 // REVENGER // R06254 // (C) EPOS CORP"" (hand written R06254 over R06124) */
	ROM_LOAD( ""u_4__revenger__r06254__=c=_epos_corp.m5l2764k.u4"",  0x6000, 0x2000, CRC(d6e6cfa8) SHA1(f10131bb2e9d088c7b6d6a5d5520073d78ad69cc) ) /* labeled as ""U 4 // REVENGER // R06254 // (C) EPOS CORP"" (hand written R06254 over R06124) */

	ROM_REGION( 0x0020, ""proms"", 0 )
	ROM_LOAD( ""dm74s288n.u60"", 0x0000, 0x0020, CRC(be2b0641) SHA1(26982903b6d942af8e0a526412d8e01978d76420) ) // unknown purpose

	ROM_REGION( 0x1000, ""nvram"", 0)
	ROM_LOAD( ""revngr84.nv"", 0, 0x1000, CRC(a4417770) SHA1(92eded82db0810e7818d2f52a0497032f390fcc1) )
ROM_END

ROM_START( revenger )
	ROM_REGION( 0x40000, ""maincpu"", 0 )
	// these roms probably had the same ""U x // REVENGER // R06124 // (C) EPOS CORP"" printed labels as the newer set above, but without the hand-penned ""25"" in r06254 written over the printed ""12"" of r06124 as above
	ROM_LOAD( ""r06124.u1"",    0x0000, 0x2000, BAD_DUMP CRC(fad1a2a5) SHA1(a31052c91fe67e2e90441abc40b6483f921ecfe3) )
	ROM_LOAD( ""r06124.u2"",    0x2000, 0x2000, BAD_DUMP CRC(a8e0ee7b) SHA1(f6f78e8ce40eab07de461b364876c1eb4a78d96e) )
	ROM_LOAD( ""r06124.u3"",    0x4000, 0x2000, BAD_DUMP CRC(cca414a5) SHA1(1c9dd3ff63d57e9452e63083cdbd7f5d693bb686) )
	ROM_LOAD( ""r06124.u4"",    0x6000, 0x2000, BAD_DUMP CRC(0b81c303) SHA1(9022d18dec11312eb4bb471c22b563f5f897b4f7) )

	ROM_REGION( 0x0020, ""proms"", 0 ) /* this PROM not included in this dump, but assumed to be the same as above set */
	ROM_LOAD( ""dm74s288n.u60"", 0x0000, 0x0020, CRC(be2b0641) SHA1(26982903b6d942af8e0a526412d8e01978d76420) ) // unknown purpose

	ROM_REGION( 0x1000, ""nvram"", 0)
	ROM_LOAD( ""revngr84.nv"", 0, 0x1000, CRC(a4417770) SHA1(92eded82db0810e7818d2f52a0497032f390fcc1) )
ROM_END

ROM_START( beastf )
	ROM_REGION( 0x40000, ""maincpu"", 0 )
	ROM_LOAD( ""u_1__beastie__feastie__b09084.m5l2764k.u1"",  0x0000, 0x2000, CRC(820d4019) SHA1(e953aaeeb626776dd86c521066b553d054ae4422) ) /* labeled as ""U 1 // BEASTIE // FEASTIE // B09084"" */
	ROM_LOAD( ""u_2__beastie__feastie__b09084.m5l2764k.u2"",  0x2000, 0x2000, CRC(967405d8) SHA1(dd763be909e6966521b01ee878df9cef865c3b30) ) /* labeled as ""U 2 // BEASTIE // FEASTIE // B09084"" */
	ROM_LOAD( ""u_3__beastie__feastie__b09084.m5l2764k.u3"",  0x4000, 0x2000, CRC(3edb5381) SHA1(14c236045e6df7a475c32222652860689d4f68ce) ) /* labeled as ""U 3 // BEASTIE // FEASTIE // B09084"" */
	ROM_LOAD( ""u_4__beastie__feastie__b09084.m5l2764k.u4"",  0x6000, 0x2000, CRC(c8cd9640) SHA1(72da881b903ead873cc3f4df27646d1ffdd63c1c) ) /* labeled as ""U 4 // BEASTIE // FEASTIE // B09084"" */

	ROM_REGION( 0x1000, ""nvram"", 0)
	ROM_LOAD( ""beastf.nv"", 0, 0x1000, CRC(98017b09) SHA1(0e2b2071bb47fc179d5bc36ef9431a9d2727d36a) )
ROM_END

DRIVER_INIT_MEMBER(epos_state,dealer)
{
	uint8_t *rom = memregion(""maincpu"")->base();
	int A;

	/* Key 0 */
	for (A = 0; A < 0x8000; A++)
		rom[A] = bitswap<8>(rom[A] ^ 0xbd, 2,6,4,0,5,7,1,3 );

	/* Key 1 */
	for (A = 0; A < 0x8000; A++)
		rom[A + 0x10000] = bitswap<8>(rom[A], 7,5,4,6,3,2,1,0 );

	/* Key 2 */
	for (A = 0; A < 0x8000; A++)
		rom[A + 0x20000] = bitswap<8>(rom[A] ^ 1, 7,6,5,4,3,0,2,1 );

	/* Key 3 */
	for (A = 0; A < 0x8000; A++)
		rom[A + 0x30000] = bitswap<8>(rom[A] ^ 1, 7,5,4,6,3,0,2,1 );

	/*
	    there is not enough data to determine key 3.
	    the code in question is this:

	    [this is the data as decrypted by Key 1]
	    2F58: 55 5C 79
	    2F5B: 55 F7 79
	    2F5E: 55 CD 79

	    it must become

	    2F58: 32 3e 78  ld (793e),a
	    2F5B: 32 xx 78  ld (79xx),a
	    2F5E: 32 xx 78  ld (79xx),a

	    the obvious solution is a combination of key 1 and key 2.
	*/
}


/*************************************
 *
 *  Game drivers
 *
 *************************************/

/* EPOS TRISTAR 8000 PCB based */
GAME( 1982, megadon,  0,        epos,   megadon,  epos_state,    0,       ROT270, ""Epos Corporation (Photar Industries license)"", ""Megadon"", MACHINE_SUPPORTS_SAVE )
GAME( 1982, catapult, 0,        epos,   catapult, epos_state,    0,       ROT270, ""Epos Corporation"", ""Catapult"",           MACHINE_NOT_WORKING | MACHINE_SUPPORTS_SAVE ) /* bad rom, hold f2 for test mode */
GAME( 1983, suprglob, 0,        epos,   suprglob, epos_state,    0,       ROT270, ""Epos Corporation"", ""Super Glob"",         MACHINE_SUPPORTS_SAVE )
GAME( 1983, theglob,  suprglob, epos,   suprglob, epos_state,    0,       ROT270, ""Epos Corporation"", ""The Glob"",           MACHINE_SUPPORTS_SAVE )
GAME( 1983, theglob2, suprglob, epos,   suprglob, epos_state,    0,       ROT270, ""Epos Corporation"", ""The Glob (earlier)"", MACHINE_SUPPORTS_SAVE )
GAME( 1983, theglob3, suprglob, epos,   suprglob, epos_state,    0,       ROT270, ""Epos Corporation"", ""The Glob (set 3)"",   MACHINE_SUPPORTS_SAVE )
GAME( 1984, igmo,     0,        epos,   igmo,     epos_state,    0,       ROT270, ""Epos Corporation"", ""IGMO"",               MACHINE_WRONG_COLORS | MACHINE_SUPPORTS_SAVE )

/* EPOS TRISTAR 9000 PCB based */
GAME( 1984, dealer,   0,        dealer, dealer,   epos_state,    dealer,  ROT270, ""Epos Corporation"", ""The Dealer"",           MACHINE_SUPPORTS_SAVE )
GAME( 1984, revngr84, 0,        dealer, beastf,   epos_state,    dealer,  ROT270, ""Epos Corporation"", ""Revenger '84 (newer)"", MACHINE_SUPPORTS_SAVE )
GAME( 1984, revenger, revngr84, dealer, beastf,   epos_state,    dealer,  ROT270, ""Epos Corporation"", ""Revenger '84 (older)"", MACHINE_NOT_WORKING | MACHINE_SUPPORTS_SAVE )
GAME( 1984, beastf,   suprglob, dealer, beastf,   epos_state,    dealer,  ROT270, ""Epos Corporation"", ""Beastie Feastie"",      MACHINE_SUPPORTS_SAVE )
",16155,True,3055.131720084533,median
"#include ""CellLoader_BloodMap.h""
#include ""../world/WorldCell.h""
#include ""../world/Sector_2_5D.h""
#include ""../world/ObjectManager.h""
#include ""../world/Object.h""
#include ""../world/OrientedSprite.h""
#include ""../world/Sprite_ZAxis.h""
#include ""../world/LevelFuncMgr.h""
#include ""../render/TextureCache.h""
#include ""../fileformats/TextureTypes.h""
#include ""../fileformats/ArchiveTypes.h""
#include ""../math/Math.h""
#include ""../ui/XL_Console.h""
#include ""../EngineSettings.h""

#include <string>
#include <cstdio>
#include <cassert>

#define MAX_TILES 9216

const float m_fWorldToTexel_X = 8.0f;
const float m_fWorldToTexel_Z = 8.0f;

CellLoader_BloodMap::CellLoader_BloodMap() : CellLoader()
{
    m_pBloodSectors = nullptr;
    m_pBloodWalls = nullptr;
    m_pBloodSprites = nullptr;
}

CellLoader_BloodMap::~CellLoader_BloodMap()
{
}

void CellLoader_BloodMap::DecryptBuffer(uint8_t *pBuffer, const uint32_t uDataSize, uint8_t uDecryptKey)
{
    // Variables
    assert(pBuffer != nullptr);

    // If the map isn't encrypted
    if (!m_bIsEncrypted)
        return;

    // Decryption
    for (uint16_t i = 0; i < uDataSize; i++)
    {
        pBuffer[i] ^= (uint8_t)(uDecryptKey + i);
    }
}

bool CellLoader_BloodMap::ParseHeader(char *pData, int32_t& index)
{
    // Variables
    HeaderPart1 header1;
    HeaderPart3 header3;

    char *pMapSignature;
    MapVersion *pMapVersion;

    pMapSignature = &pData[index]; index += 4;
    pMapVersion = (MapVersion *)&pData[index]; index += sizeof(MapVersion);

    if (pMapSignature[0] != 'B' || pMapSignature[1] != 'L' || pMapSignature[2] != 'M' || pMapSignature[3] != 0x1A )
    {
        XL_Console::PrintF(""^1Error: The file's signature does not match the blood map signature."");
        return false;
    }

    XL_Console::PrintF(""^8Info: Map version %u.%u"", pMapVersion->Major, pMapVersion->Minor);

    if (pMapVersion->Major == 6 && pMapVersion->Minor == 3)
    {
        m_bIsEncrypted = false;
    }
    else if (pMapVersion->Major == 7 && pMapVersion->Minor == 0)
    {
        m_bIsEncrypted = true;
    }
    else
    {
        XL_Console::PrintF(""^1Error: The XL Engine can only handle Blood maps version 6.3 and 7.0."");
        XL_Console::PrintF(""^1Try bringing the map up in the latest version of mapedit, then save it."");
        XL_Console::PrintF(""^1This should produce a 7.0 version map, which the XL Engine CAN load."");
        return false;
    }

    // Load and decrypt the first part of the header
    memcpy(&header1, &pData[index], sizeof(HeaderPart1)); index += sizeof(HeaderPart1);
    DecryptBuffer((uint8_t*)&header1, sizeof(HeaderPart1), 0x4D);

    // Store the info
    m_bloodData.pos[0]   = header1.startX;
    m_bloodData.pos[1]   = header1.startY;
    m_bloodData.pos[2]   = header1.startZ;
    m_bloodData.angle    = header1.startAngle;
    m_bloodData.startSec = header1.sectorNum;

    // Skip the part 2 of the header, since we don't know what it is. Investigate later.
    index += 11;

    // Load and decrypt the third part of the header
    memcpy(&header3, &pData[index], sizeof(HeaderPart3)); index += sizeof(HeaderPart3);
    DecryptBuffer((uint8_t*)&header3, sizeof(HeaderPart3), 0x68);

    // Store the map info.
    m_bloodData.revisions = header3.mapRevisions;
    m_bloodData.secCnt    = header3.numSectors;
    m_bloodData.wallCnt   = header3.numWalls;
    m_bloodData.spriteCnt = header3.numSprites;

    return true;
}

int32_t CellLoader_BloodMap::FindFirstSector(char *pData, int32_t& index)
{
    // Variables
    uint16_t uBuffer;

    if (!m_bIsEncrypted)
        return 75;

    index = 171;
    uBuffer = *((uint16_t *)&pData[index]);

    switch (uBuffer)
    {
        case 0x2120:
            return 203;

        case 0x0302:
            return 173;

        case 0x1110:   // E2M7
            return 187; // Try every 40 against Matt S. key if it doesn't work

        default:
            XL_Console::PrintF(""^1Error: Unknown map format: %u"", uBuffer);
            return -3;
    }
    return -1;
}

bool CellLoader_BloodMap::ExtractSectors(char *pData, int32_t& index)
{
    // Variables
    uint8_t Buffer[128];
    uint8_t uDecryptKey;

    uDecryptKey = ((m_bloodData.revisions * sizeof(BloodSector)) & 0xFF);
    m_pBloodSectors = xlNew BloodSector_Xtra[m_bloodData.secCnt];

    for (int32_t nInd = 0; nInd < m_bloodData.secCnt; nInd++)
    {
        memcpy(Buffer, &pData[index], sizeof(BloodSector));
        DecryptBuffer(Buffer, sizeof(BloodSector), uDecryptKey);

        memset( &m_pBloodSectors[nInd], 0, sizeof(BloodSector_Xtra) );
        memcpy( &m_pBloodSectors[nInd], Buffer, sizeof(BloodSector) );
        index += sizeof(BloodSector);

        // If extra data follow
        if (m_pBloodSectors[nInd].extra > 0) // offset to extra array
        {
            if ( nInd == 133 )
            {
                static int _x=0;
                _x++;
            }
            uint8_t *pExtData = (uint8_t *)&pData[index];

            m_pBloodSectors[nInd].startState = (pExtData[1]&64) ? 1 : 0;
            m_pBloodSectors[nInd].cmd  = (pExtData[9]>>2) + (pExtData[10]&63)*64;
            m_pBloodSectors[nInd].rxID = pExtData[8];
            m_pBloodSectors[nInd].txID = pExtData[6];

            m_pBloodSectors[nInd].triggerFlags = 0;
            if ( pExtData[22]&16 )
                m_pBloodSectors[nInd].triggerFlags |= TRIGGER_DECOUPLED;
            if ( pExtData[22]&32 )
                m_pBloodSectors[nInd].triggerFlags |= TRIGGER_ONE_SHOT;
            if ( pExtData[53]&1 )
                m_pBloodSectors[nInd].triggerFlags |= TRIGGER_LOCKED;
            if ( pExtData[13]&1 )
                m_pBloodSectors[nInd].triggerFlags |= TRIGGER_INTERRUPTABLE;
            if ( pExtData[55]&128 )
                m_pBloodSectors[nInd].triggerFlags |= TRIGGER_DUDE_LOCKOUT;
            
            m_pBloodSectors[nInd].bSendAtOn      = (pExtData[10]&4) ? 1 : 0;
            m_pBloodSectors[nInd].offOn_busyTime = pExtData[10]/16;
            m_pBloodSectors[nInd].offOn_wave     = pExtData[7]/4;
            m_pBloodSectors[nInd].offOn_waitTime = pExtData[12];
            //make sure some wait time if flagged... (?)
            if ( pExtData[15]&64 )
                m_pBloodSectors[nInd].offOn_waitTime = MAX(1, m_pBloodSectors[nInd].offOn_waitTime);

            m_pBloodSectors[nInd].bSendAtOff     = (pExtData[10]&8) ? 1 : 0;
            m_pBloodSectors[nInd].onOff_busyTime = pExtData[24]/4;
            m_pBloodSectors[nInd].onOff_wave     = pExtData[7]/32;
            m_pBloodSectors[nInd].onOff_waitTime = pExtData[25]/64 + pExtData[26]*4;
            //make sure some wait time if flagged... (?)
            if ( pExtData[15]&128 )
                m_pBloodSectors[nInd].onOff_waitTime = MAX(1, m_pBloodSectors[nInd].onOff_waitTime);

            m_pBloodSectors[nInd].triggerOnEvent = pExtData[23];
            m_pBloodSectors[nInd].exData         = pExtData[4];
            m_pBloodSectors[nInd].key            = (pExtData[22]>>7) + pExtData[23]*2;
            m_pBloodSectors[nInd].depth          = (pExtData[19]>>5);

            m_pBloodSectors[nInd].bUnderwater    = (pExtData[19]&16) ? 1 : 0;
            m_pBloodSectors[nInd].bCrushing      = (pExtData[48]&1)  ? 1 : 0;

            m_pBloodSectors[nInd].floorStates[0] = *((int32_t *)&pExtData[36]);
            m_pBloodSectors[nInd].floorStates[1] = *((int32_t *)&pExtData[40]);

            m_pBloodSectors[nInd].ceilStates[0] = *((int32_t *)&pExtData[28]);
            m_pBloodSectors[nInd].ceilStates[1] = *((int32_t *)&pExtData[32]);

            m_pBloodSectors[nInd].lightFX_wave = pExtData[17];
            uint8_t a0 = pExtData[14]&63;
            m_pBloodSectors[nInd].lightFX_amp = a0 < 32 ? (pExtData[13]>>6) + a0*4 : (pExtData[13]>>6) + (a0-32)*4 - 128;
            m_pBloodSectors[nInd].lightFX_freq = (pExtData[14]>>6) + (pExtData[15]&63)*4;
            m_pBloodSectors[nInd].lightFX_phase = pExtData[16];
            m_pBloodSectors[nInd].lightFX_flags = pExtData[17]&0xf0;
            if ( pExtData[24]&1 ) m_pBloodSectors[nInd].lightFX_flags |= LIGHTFX_COLORED_LIGHTS;
            m_pBloodSectors[nInd].lightFX_ceilPal2  = pExtData[27]>>4;
            m_pBloodSectors[nInd].lightFX_floorPal2 = pExtData[51]>>4;

            m_pBloodSectors[nInd].motionFX_speed = pExtData[20];
            m_pBloodSectors[nInd].motionFX_angle = *((uint16_t *)&pExtData[21]);
            m_pBloodSectors[nInd].motionFX_flags = pExtData[19]&0x0f;

            m_pBloodSectors[nInd].wind_vel = ( *((uint16_t *)&pExtData[53]) )>>1;
            m_pBloodSectors[nInd].wind_vel &= 1023;

            m_pBloodSectors[nInd].wind_ang = ( *((uint16_t *)&pExtData[54]) )>>3;
            m_pBloodSectors[nInd].wind_ang &= 2047;
            m_pBloodSectors[nInd].bWindAlways = (pExtData[55]&64) ? true : false;

            index += 60;
        }
        else 
        {
            m_pBloodSectors[nInd].lightFX_wave = 0;
            switch (m_pBloodSectors[nInd].extra)
            {
                case 0:
                case -1:
                    break;
                default:
                    XL_Console::PrintF(""^1Error: Unknown extra data value (%hd)."", m_pBloodSectors[nInd].extra);
                    return false;
            }
        }
    }

    return true;
}

bool CellLoader_BloodMap::ExtractWalls(char *pData, int32_t& index)
{
    // Variables
    uint8_t Buffer[128];
    uint8_t uDecryptKey;

    assert( m_bloodData.wallCnt > 0 );
    uDecryptKey = (((m_bloodData.revisions * sizeof (BloodSector)) | 0x4d) & 0xFF);

    m_pBloodWalls = xlNew BloodWall_Xtra[m_bloodData.wallCnt];
    
    for (int32_t nInd = 0; nInd < m_bloodData.wallCnt; nInd++)
    {
        memcpy(Buffer, &pData[index], sizeof(BloodWall));
        DecryptBuffer(Buffer, sizeof(BloodWall), uDecryptKey);

        memcpy(&m_pBloodWalls[nInd], Buffer, sizeof(BloodWall));
        index += sizeof(BloodWall);

        // If extra data follow
        if (m_pBloodWalls[nInd].extra > 0) // TESTME: <= 511 && WallPtr->extra >= 256
        {
            uint8_t *pExtData = (uint8_t *)&pData[index];

            m_pBloodWalls[nInd].rxID = 0;
            m_pBloodWalls[nInd].txID = pExtData[6];

            // skip the next 24 bytes
            index += 24;
        }
        else
        {
            switch (m_pBloodWalls[nInd].extra)
            {
                case 0:
                case -1:
                    break;
                default:
                    XL_Console::PrintF(""^1Error: Unknown extra data value (%hd)"", m_pBloodWalls[nInd].extra);
                    return false;
            }
        }
    }

    return true;
}

bool CellLoader_BloodMap::ExtractSprites(char *pData, int32_t& index)
{
    // Variables
    uint8_t Buffer[128];
    uint8_t uDecryptKey;

    uDecryptKey = (((m_bloodData.revisions * sizeof(BloodSprite)) | 0x4d) & 0xFF);
    m_pBloodSprites = xlNew BloodSprite_Xtra[m_bloodData.spriteCnt];

    for (int32_t nInd = 0; nInd < m_bloodData.spriteCnt; nInd++)
    {
        memcpy(Buffer, &pData[index], sizeof(BloodSprite));
        DecryptBuffer(Buffer, sizeof(BloodSprite), uDecryptKey);

        memcpy(&m_pBloodSprites[nInd], Buffer, sizeof(BloodSprite));
        index += sizeof(BloodSprite);

        // If extra data follow
        if (m_pBloodSprites[nInd].extra > 0) //<= 2047 && SpritePtr->extra >= 1024)
        {
            if ( nInd == 152 )
            {
                static int _x=0;
                _x++;
            }

            m_pBloodSprites[nInd].data[0] = ((uint8_t *)&pData[index])[16];
            m_pBloodSprites[nInd].data[1] = ((uint8_t *)&pData[index])[17];
            m_pBloodSprites[nInd].data[2] = ((uint8_t *)&pData[index])[18];
            m_pBloodSprites[nInd].data[3] = ((uint8_t *)&pData[index])[19];

            m_pBloodSprites[nInd].txID    = ((uint8_t *)&pData[index])[4];
            // skip the next 56 bytes
            index += 56;
        }
        else 
        {
            m_pBloodSprites[nInd].data[0] = 0;
            m_pBloodSprites[nInd].data[1] = 0;
            m_pBloodSprites[nInd].data[2] = 0;
            m_pBloodSprites[nInd].data[3] = 0;

            switch (m_pBloodSprites[nInd].extra)
            {
                case -1: // The end ?
                    break;
                default:
                    XL_Console::PrintF(""^1Error: Unknown extra data value (%hd)"", m_pBloodSprites[nInd].extra);
                    return false;
            }
        }
    }

    return true;
}

TextureHandle CellLoader_BloodMap::AddBloodTile(int32_t picnum, uint32_t uPalIdx, uint32_t& uWidth, uint32_t& uHeight, bool bMip)
{
    int32_t nArtIndex = picnum / 256;
    char szTileArchive[64];
    char szTileName[32];

    if ( picnum >= MAX_TILES )
         picnum = 0;

    if ( uPalIdx > 14 )
        uPalIdx = 0;

    sprintf(szTileArchive, ""TILES%03d.ART"", nArtIndex);
    sprintf(szTileName, ""%d"", picnum);

    TextureHandle hTex = TextureCache::GameFile_LoadTexture(TEXTURETYPE_ART, uPalIdx, ARCHIVETYPE_ART, szTileArchive, szTileName, bMip);
    if ( hTex != XL_INVALID_TEXTURE )
    {
        float fRelSizeX, fRelSizeY;
        int32_t nOffsX, nOffsY;
        TextureCache::GetTextureSize(nOffsX, nOffsY, uWidth, uHeight, fRelSizeX, fRelSizeY);
    }

    return hTex;
}

WorldCell *CellLoader_BloodMap::Load( IDriver3D *pDriver, World *pWorld, uint8_t *pData, uint32_t uLen, const std::string& sFile, int32_t worldX, int32_t worldY )
{
    WorldCell *pCell = nullptr;
    ObjectManager::FreeAllObjects();
    if ( uLen )
    {
        int32_t index = 0;
        ParseHeader((char *)pData, index);
        int32_t offset = FindFirstSector((char *)pData, index);
        if ( offset < 0 )
        {
            return nullptr;
        }
        index = offset;
        if ( ExtractSectors((char *)pData, index) == false )
        {
            return nullptr;
        }
        if ( ExtractWalls((char *)pData, index) == false )
        {
            return nullptr;
        }
        if ( ExtractSprites((char *)pData, index) == false )
        {
            return nullptr;
        }

        pCell = xlNew WorldCell();
        LevelFuncMgr::SetWorldCell( pCell );

        const float fHorizScale = (256.0f*0.75f);
        const float fVertScale = (2048.0f*1.5f);
        const float fFloorTexScale = fHorizScale*128.0f/2048.0f;

        int32_t secLink = -1;
        int32_t secLinkBase = -1;

        for (int32_t i=0; i<m_bloodData.secCnt; i++)
        {
            Sector_2_5D *pSector = xlNew Sector_2_5D();
            uint32_t uWidth, uHeight;
            if ( EngineSettings::get().IsServer() == false )
            {
                pSector->m_hFloorTex = AddBloodTile( m_pBloodSectors[i].floorpicnum, m_pBloodSectors[i].floorpal, uWidth, uHeight );
                pSector->m_FloorTexScale.Set( fFloorTexScale / (float)uWidth, fFloorTexScale / (float)uHeight );

                pSector->m_hCeilTex  = AddBloodTile( m_pBloodSectors[i].ceilingpicnum, m_pBloodSectors[i].ceilingpal, uWidth, uHeight );
                pSector->m_CeilTexScale.Set( fFloorTexScale / (float)uWidth, fFloorTexScale / (float)uHeight );

                pSector->m_texOffset[0].x = (float)m_pBloodSectors[i].floorxpanning / (float)uWidth;
                pSector->m_texOffset[0].y = (float)m_pBloodSectors[i].floorypanning / (float)uHeight;
                pSector->m_texOffset[1].x = (float)m_pBloodSectors[i].ceilingxpanning / (float)uWidth;
                pSector->m_texOffset[1].y = (float)m_pBloodSectors[i].ceilingypanning / (float)uHeight;
            }
            else
            {   //We don't load textures when running as a server.
                pSector->m_hFloorTex = XL_INVALID_TEXTURE;
                pSector->m_hCeilTex  = XL_INVALID_TEXTURE;
                pSector->m_FloorTexScale.Set( fFloorTexScale / 64.0f, fFloorTexScale / 64.0f );
                pSector->m_CeilTexScale.Set( fFloorTexScale / 64.0f, fFloorTexScale / 64.0f );

                pSector->m_texOffset[0].Set(0,0);
                pSector->m_texOffset[1].Set(0,0);
            }

            pSector->m_uVertexCount = m_pBloodSectors[i].wallnum;
            pSector->m_uWallCount   = m_pBloodSectors[i].wallnum; 
            pSector->m_ZRangeBase.x = -(float)m_pBloodSectors[i].floorz   / fVertScale;
            pSector->m_ZRangeBase.y = -(float)m_pBloodSectors[i].ceilingz / fVertScale;
            pSector->m_ZRangeCur = pSector->m_ZRangeBase;

            pSector->m_uFlags = Sector_2_5D::SEC_FLAGS_NONE;
            if ( m_pBloodSectors[i].floorstat&1 )   pSector->m_uFlags |= Sector_2_5D::SEC_FLAGS_SKYFLOOR;
            if ( m_pBloodSectors[i].ceilingstat&1 ) pSector->m_uFlags |= Sector_2_5D::SEC_FLAGS_EXTERIOR;
            if ( m_pBloodSectors[i].floorstat&2 )   pSector->m_uFlags |= Sector_2_5D::SEC_FLAGS_FLOOR_SLOPE;
            if ( m_pBloodSectors[i].ceilingstat&2 ) pSector->m_uFlags |= Sector_2_5D::SEC_FLAGS_CEIL_SLOPE;

            if ( EngineSettings::get().IsServer() == false )
            {
                if ( pSector->m_uFlags&Sector_2_5D::SEC_FLAGS_EXTERIOR )
                {
                    for (uint32_t s=0; s<16; s++)
                    {
                        pCell->SetSkyTex( s, AddBloodTile( m_pBloodSectors[i].ceilingpicnum+s, 0, uWidth, uHeight ), uWidth, uHeight );
                    }
                    pCell->SetSkyTexCount(16);
                }
            }

            if ( m_pBloodSectors[i].floorstat&0x40 )   
                pSector->m_uFlags |= Sector_2_5D::SEC_FLAGS_FLOOR_FLIP;

            const float fSlopeScale = 0.75f;
            pSector->m_fFloorSlope = -(float)m_pBloodSectors[i].floorheinum   / fVertScale * fSlopeScale;
            pSector->m_fCeilSlope  = -(float)m_pBloodSectors[i].ceilingheinum / fVertScale * fSlopeScale;
            pSector->m_auSlopeAnchor[0] = 0;
            pSector->m_auSlopeAnchor[1] = 0;
            pSector->m_auSlopeSector[0] = i;
            pSector->m_auSlopeSector[1] = i;

            int32_t nAmbient = 255 - m_pBloodSectors[i].floorshade*4;
            if ( nAmbient < 0 ) nAmbient = 0;
            if ( nAmbient > 255 ) nAmbient = 255;
            pSector->m_uAmbientFloor = (uint8_t)nAmbient;

            nAmbient = 255 - m_pBloodSectors[i].ceilingshade*4;
            if ( nAmbient < 0 ) nAmbient = 0;
            if ( nAmbient > 255 ) nAmbient = 255;
            pSector->m_uAmbientCeil = (uint8_t)nAmbient;

            int32_t w;
            //extract vertices.
            pSector->m_pVertexBase = xlNew Vector2[pSector->m_uVertexCount];
            pSector->m_pVertexCur  = xlNew Vector2[pSector->m_uVertexCount];
            for (w=0; w<m_pBloodSectors[i].wallnum; w++)
            {
                int32_t ww = m_pBloodSectors[i].wallptr + w;
                pSector->m_pVertexBase[w].x =  (float)m_pBloodWalls[ww].x / fHorizScale;
                pSector->m_pVertexBase[w].y = -(float)m_pBloodWalls[ww].y / fHorizScale;
                pSector->m_pVertexCur[w] = pSector->m_pVertexBase[w];
            }

            /****************** Setup LevelFunc ****************/
            //is this a sliding door sector?
            pSector->m_pFunc = nullptr;
            int16_t rxID = -1;
            int16_t waitTime = 0;
            bool bLink = false;
            bool bTriggerAllWalls = false;
            if ( m_pBloodSectors[i].lotag == 600 )  //Z-Motion
            {
                //z-motion - like an elevator.
                pSector->m_pFunc = nullptr;

                //floor or ceiling, add for both?
                if ( m_pBloodSectors[i].floorStates[0] != m_pBloodSectors[i].floorStates[1] )
                {
                    pSector->m_pFunc = LevelFuncMgr::CreateLevelFunc(""Elevator_MoveFloor"", i, -1);
                    pSector->m_pFunc->SetSpeed( 0.1f );
                    pSector->m_pFunc->SetAccel( 0.025f );
                    if ( m_pBloodSectors[i].startState == 0 )
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( -(float)m_pBloodSectors[i].floorStates[0] / fVertScale, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( -(float)m_pBloodSectors[i].floorStates[1] / fVertScale, m_pBloodSectors[i].offOn_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[i].offOn_waitTime * 4.5f );
                    }
                    else    //do this or just change the initial state?
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( -(float)m_pBloodSectors[i].floorStates[1] / fVertScale, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( -(float)m_pBloodSectors[i].floorStates[0] / fVertScale, m_pBloodSectors[i].onOff_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[i].onOff_waitTime * 4.5f );
                    }
                }
                else if ( m_pBloodSectors[i].ceilStates[0] != m_pBloodSectors[i].ceilStates[1] )
                {
                    pSector->m_pFunc = LevelFuncMgr::CreateLevelFunc(""Elevator_MoveCeil"", i, -1);
                    pSector->m_pFunc->SetSpeed( 0.1f );
                    pSector->m_pFunc->SetAccel( 0.025f );
                    if ( m_pBloodSectors[i].startState == 0 )
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( -(float)m_pBloodSectors[i].ceilStates[0] / fVertScale, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( -(float)m_pBloodSectors[i].ceilStates[1] / fVertScale, m_pBloodSectors[i].offOn_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[i].offOn_waitTime * 4.5f );
                    }
                    else    //do this or just change the initial state?
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( -(float)m_pBloodSectors[i].ceilStates[1] / fVertScale, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( -(float)m_pBloodSectors[i].ceilStates[0] / fVertScale, m_pBloodSectors[i].onOff_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[i].onOff_waitTime * 4.5f );
                    }
                }
                //else
                //{
                    //what are we supposed to do now?
                    //assert(0);
                //}

                if ( pSector->m_pFunc && (m_pBloodSectors[i].triggerOnEvent&TRIGGERON_WALLPUSH) )
                {
                    bTriggerAllWalls = true;
                }
            }
            else if ( m_pBloodSectors[i].lotag == 614 ) //Sliding Marked
            {
                //ok now which walls and sprites are we going to look at?
                rxID = m_pBloodSectors[i].rxID;
                //get the wait time.
                waitTime = m_pBloodSectors[i].offOn_waitTime;

                pSector->m_pFunc = LevelFuncMgr::CreateLevelFunc(""SlidingDoor"", i, -1);

                //now we have to find the appropriate sprites to set this up...
                int32_t onMarker = -1, offMarker = -1;
                for (int32_t s=0; s<m_bloodData.spriteCnt; s++)
                {
                    if ( m_pBloodSprites[s].sectnum != i && m_pBloodSprites[s].owner != i )
                        continue;

                    if ( m_pBloodSprites[s].lotag == 3 )    //Off Marker
                    {
                        offMarker = s;
                    }
                    else if ( m_pBloodSprites[s].lotag == 4 ) //On Marker.
                    {
                        onMarker = s;
                    }

                    if ( offMarker > -1 && onMarker > -1 )
                        break;
                }

                if ( offMarker > -1 && onMarker > -1 )
                {
                    Vector3 vDir;
                    Vector3 A, B;
                    A.x =  (float)m_pBloodSprites[onMarker].x / fHorizScale;
                    A.y = -(float)m_pBloodSprites[onMarker].y / fHorizScale;
                    A.z = -(float)m_pBloodSprites[onMarker].z / fVertScale;

                    B.x =  (float)m_pBloodSprites[offMarker].x / fHorizScale;
                    B.y = -(float)m_pBloodSprites[offMarker].y / fHorizScale;
                    B.z = -(float)m_pBloodSprites[offMarker].z / fVertScale;

                    vDir = B - A;
                    float m = vDir.Normalize();

                    //set the speed and direction.
                    pSector->m_pFunc->SetSpeed( (float)(m_pBloodSprites[offMarker].xvel) / (fHorizScale*10.0f) );
                    pSector->m_pFunc->SetAccel( 0.025f );
                    pSector->m_pFunc->SetDirection( vDir );
                    if ( m_pBloodSectors[i].startState == 0 )
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( m, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( 0.0f, m_pBloodSectors[i].offOn_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[i].offOn_waitTime * 4.5f );
                    }
                    else    //do this or just change the initial state?
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( 0.0f, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( m, m_pBloodSectors[i].onOff_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[i].onOff_waitTime * 4.5f );
                    }
                }
            }
            else if ( m_pBloodSectors[i].lotag == 616 ) //Sliding
            {
                //ok now which walls and sprites are we going to look at?
                rxID = m_pBloodSectors[i].rxID;
                //get the wait time.
                waitTime = m_pBloodSectors[i].offOn_waitTime;

                pSector->m_pFunc = LevelFuncMgr::CreateLevelFunc(""Slide"", i, -1);

                //now we have to find the appropriate sprites to set this up...
                int32_t onMarker = -1, offMarker = -1;
                for (int32_t s=0; s<m_bloodData.spriteCnt; s++)
                {
                    if ( m_pBloodSprites[s].sectnum != i && m_pBloodSprites[s].owner != i )
                        continue;

                    if ( m_pBloodSprites[s].lotag == 3 )    //Off Marker
                    {
                        offMarker = s;
                    }
                    else if ( m_pBloodSprites[s].lotag == 4 ) //On Marker.
                    {
                        onMarker = s;
                    }

                    if ( offMarker > -1 && onMarker > -1 )
                        break;
                }

                if ( offMarker > -1 && onMarker > -1 )
                {
                    Vector3 vDir;
                    Vector3 A, B;
                    A.x =  (float)m_pBloodSprites[onMarker].x / fHorizScale;
                    A.y = -(float)m_pBloodSprites[onMarker].y / fHorizScale;
                    A.z = -(float)m_pBloodSprites[onMarker].z / fVertScale;

                    B.x =  (float)m_pBloodSprites[offMarker].x / fHorizScale;
                    B.y = -(float)m_pBloodSprites[offMarker].y / fHorizScale;
                    B.z = -(float)m_pBloodSprites[offMarker].z / fVertScale;

                    vDir = B - A;
                    float m = vDir.Normalize();

                    //set the speed and direction.
                    pSector->m_pFunc->SetSpeed( (float)(m_pBloodSprites[offMarker].xvel) / (fHorizScale*10.0f) );
                    pSector->m_pFunc->SetAccel( 0.025f );
                    pSector->m_pFunc->SetDirection( vDir );

                    if ( m_pBloodSectors[i].startState == 0 )
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( m, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( 0.0f, m_pBloodSectors[i].offOn_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[i].offOn_waitTime * 4.5f );
                    }
                    else    //do this or just change the initial state?
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( 0.0f, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( m, m_pBloodSectors[i].onOff_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[i].onOff_waitTime * 4.5f );
                    }
                }
            }
            else if ( m_pBloodSectors[i].lotag == 617 ) //Rotate
            {
                pSector->m_pFunc = LevelFuncMgr::CreateLevelFunc(""Rotate"", i, -1);

                bLink = false;
                if ( m_pBloodSectors[i].cmd == 5 ) //LINK
                {
                    secLink = m_pBloodSectors[i].txID;
                    secLinkBase = i;
                }
                else if ( m_pBloodSectors[i].rxID == secLink )
                {
                    bLink = true;
                    Sector_2_5D *pLink = (Sector_2_5D *)pCell->GetSector( secLinkBase );
                    //we have to add this as a client to the previous sector's walls...
                    for (w=0; w<m_pBloodSectors[secLinkBase].wallnum; w++)
                    {
                        if ( pLink->m_Walls[w].m_pFunc )
                        {
                            pLink->m_Walls[w].m_pFunc->AddClient( pSector->m_pFunc );
                        }
                    }
                }

                //now we have to find the appropriate sprites to set this up...
                int32_t pivot = -1;
                for (int32_t s=0; s<m_bloodData.spriteCnt; s++)
                {
                    if ( m_pBloodSprites[s].sectnum != i && m_pBloodSprites[s].owner != i )
                        continue;

                    if ( m_pBloodSprites[s].lotag == 5 )    //Pivot
                    {
                        pivot = s;
                        break;
                    }
                }

                if ( pivot > -1 )
                {
                    float angle = -(float)m_pBloodSprites[pivot].ang/2048.0f * MATH_TWO_PI;
                    pSector->m_pFunc->SetAccel( 0.0125f );

                    Vector3 pivotPos;
                    pivotPos.x =  (float)m_pBloodSprites[pivot].x / fHorizScale;
                    pivotPos.y = -(float)m_pBloodSprites[pivot].y / fHorizScale;
                    pivotPos.z = -(float)m_pBloodSprites[pivot].z / fVertScale;

                    pSector->m_pFunc->SetPivot( pivotPos );
                    //use the linked stats...
                    int32_t nSec = i;
                    if ( bLink )
                    {
                        nSec = secLinkBase;
                    }

                    if ( m_pBloodSectors[nSec].startState == 0 )
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( angle, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( 0.0f, m_pBloodSectors[nSec].offOn_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[nSec].offOn_waitTime * 4.5f );

                        pSector->m_pFunc->SetSpeed( fabsf(angle)*0.5f/(float)m_pBloodSectors[nSec].offOn_busyTime );
                    }
                    else    //do this or just change the initial state?
                    {
                        //this is the start location.
                        pSector->m_pFunc->AddState( 0.0f, LevelFunc::ST_HOLD, 0 );
                        //this is the end location.
                        pSector->m_pFunc->AddState( angle, m_pBloodSectors[nSec].onOff_waitTime == 0 ? LevelFunc::ST_TERMINATE : LevelFunc::ST_TIME, (float)m_pBloodSectors[nSec].onOff_waitTime * 4.5f );

                        pSector->m_pFunc->SetSpeed( fabsf(angle)*0.5f/(float)m_pBloodSectors[nSec].onOff_busyTime );
                    }
                }

                if ( bLink || m_pBloodSectors[i].cmd == 5 || (m_pBloodSectors[i].triggerOnEvent&TRIGGERON_WALLPUSH) )
                {
                    bTriggerAllWalls = true;
                }
            }

            if ( /*pSector->m_pFunc == nullptr && */(m_pBloodSectors[i].motionFX_flags&MOTIONFX_PANALWAYS) )
            {
                pSector->m_pFunc = LevelFuncMgr::CreateLevelFunc(""MotionFX"", i, -1);
                pSector->m_pFunc->SetSpeed( (float)m_pBloodSectors[i].motionFX_speed/(64.0f*30.0f) );

                float angle = (float)m_pBloodSectors[i].motionFX_angle/2048.0f * MATH_TWO_PI;

                Vector3 dir;
                dir.x = -cosf(angle);
                dir.y =  sinf(angle);
                dir.z = 0.0f;
                dir.Normalize();

                pSector->m_pFunc->SetDirection(dir);
            }
            else if ( pSector->m_pFunc == nullptr && m_pBloodSectors[i].lightFX_wave > 0 )
            {
                pSector->m_pFunc = LevelFuncMgr::CreateLevelFunc(""LightFX"", i, -1);
                pSector->m_pFunc->SetSpeed( 0.33f/60.0f );
                pSector->m_pFunc->AddState( 0.0f, LevelFunc::ST_TIME, 0 );
                pSector->m_pFunc->AddState( 1.0f, LevelFunc::ST_TIME, 0 );
            }

            /************** Setup walls *******************/
            //extract walls.
            float dz = pSector->m_ZRangeBase.y - pSector->m_ZRangeBase.x;
            pSector->m_Walls = xlNew Wall[pSector->m_uWallCount];
            for (w=0; w<m_pBloodSectors[i].wallnum; w++)
            {
                int32_t ww = m_pBloodSectors[i].wallptr + w;

                pSector->m_Walls[w].m_pFunc = nullptr;
                if ( (rxID > -1 && m_pBloodWalls[ww].txID == rxID) || bTriggerAllWalls )
                {
                    pSector->m_Walls[w].m_pFunc = LevelFuncMgr::CreateLevelFunc(""TriggerToggle"", i, w);
                    pSector->m_Walls[w].m_pFunc->AddClient( pSector->m_pFunc );

                    if ( bLink )
                    {
                        Sector_2_5D *pLink = (Sector_2_5D *)pCell->GetSector( secLinkBase );
                        pSector->m_Walls[w].m_pFunc->AddClient( pLink->m_pFunc );
                    }
                }

                //compute the wall length.
                pSector->m_Walls[w].m_idx[0] = w;
                pSector->m_Walls[w].m_idx[1] = m_pBloodWalls[ww].point2 - m_pBloodSectors[i].wallptr;
                Vector2 delta = pSector->m_pVertexBase[ pSector->m_Walls[w].m_idx[1] ] - pSector->m_pVertexBase[ pSector->m_Walls[w].m_idx[0] ];
                float m2 = delta.Dot(delta);

                if ( m2 > 0.0001f )
                    pSector->m_Walls[w].m_wallLen = sqrtf( m2 );
                else
                    pSector->m_Walls[w].m_wallLen = 1.0f;

                //compute texture scale.
                pSector->m_Walls[w].m_flags = 0;
                TextureHandle hTex = XL_INVALID_TEXTURE;
                float dx = 0.0f, dy = 0.0f, sx = 1.0f, sy = 1.0f;
                if ( EngineSettings::get().IsServer() == false )
                {
                    hTex = AddBloodTile( m_pBloodWalls[ww].picnum, m_pBloodWalls[ww].pal, uWidth, uHeight );

                    dx =  (float)m_pBloodWalls[ww].xpanning / (float)uWidth;
                    dy =  -2.0f*(float)m_pBloodWalls[ww].ypanning / (float)uHeight;

                    sx = (float)m_pBloodWalls[ww].xrepeat * 8.0f / (pSector->m_Walls[w].m_wallLen * (float)uWidth);
                    sy = 12.0f * (float)m_pBloodWalls[ww].yrepeat / (float)(uHeight*8);

                    pSector->m_Walls[w].m_textures[Wall::WALL_TEX_TOP] = hTex;
                    pSector->m_Walls[w].m_texOffset[Wall::WALL_TEX_TOP].Set(dx, dy);
                    pSector->m_Walls[w].m_texScale[Wall::WALL_TEX_TOP].Set(sx, sy);
                    pSector->m_Walls[w].m_textures[Wall::WALL_TEX_BOT] = hTex;
                    pSector->m_Walls[w].m_texOffset[Wall::WALL_TEX_BOT].Set(dx, dy);
                    pSector->m_Walls[w].m_texScale[Wall::WALL_TEX_BOT].Set(sx, sy);
                    pSector->m_Walls[w].m_textures[Wall::WALL_TEX_SIGN] = XL_INVALID_TEXTURE;
                    pSector->m_Walls[w].m_texOffset[Wall::WALL_TEX_SIGN].Set(0.0f, 0.0f);
                    pSector->m_Walls[w].m_texScale[Wall::WALL_TEX_SIGN].Set(1.0f, 1.0f);
                }

                if ( m_pBloodWalls[ww].nextsector > -1 )
                {
                    pSector->m_Walls[w].m_adjoin[0] = m_pBloodWalls[ww].nextsector;
                    pSector->m_Walls[w].m_mirror[0] = m_pBloodWalls[ww].nextwall - m_pBloodSectors[ m_pBloodWalls[ww].nextsector ].wallptr;

                    //is this a maskwall?
                    if ( m_pBloodWalls[ww].cstat&16 )
                    {
                        pSector->m_Walls[w].m_flags |= Wall::WALL_FLAGS_MASKWALL;
                        if ( m_pBloodWalls[ww].cstat&128 )
                        {
                            pSector->m_Walls[w].m_flags |= Wall::WALL_FLAGS_TRANS;
                        }

                        if ( EngineSettings::get().IsServer() == false )
                        {
                            pSector->m_Walls[w].m_textures[Wall::WALL_TEX_MID] = AddBloodTile( m_pBloodWalls[ww].overpicnum, m_pBloodWalls[ww].pal, uWidth, uHeight );;

                            dx =  (float)m_pBloodWalls[ww].xpanning / (float)uWidth;
                            dy =  -2.0f*(float)m_pBloodWalls[ww].ypanning / (float)uHeight;

                            sx = (float)m_pBloodWalls[ww].xrepeat * 8.0f / (pSector->m_Walls[w].m_wallLen * (float)uWidth);
                            sy = 12.0f * (float)m_pBloodWalls[ww].yrepeat / (float)(uHeight*8);

                            pSector->m_Walls[w].m_texOffset[Wall::WALL_TEX_MID].Set(dx, dy);
                            pSector->m_Walls[w].m_texScale[Wall::WALL_TEX_MID].Set(sx, sy);
                        }
                    }
                    else
                    {
                        pSector->m_Walls[w].m_textures[Wall::WALL_TEX_MID] = hTex;
                        pSector->m_Walls[w].m_texOffset[Wall::WALL_TEX_MID].Set(dx, dy);
                        pSector->m_Walls[w].m_texScale[Wall::WALL_TEX_MID].Set(sx, sy);
                    }
                }
                else
                {
                    pSector->m_Walls[w].m_adjoin[0] = SOLID_WALL;
                    pSector->m_Walls[w].m_mirror[0] = SOLID_WALL;

                    pSector->m_Walls[w].m_textures[Wall::WALL_TEX_MID] = hTex;
                    pSector->m_Walls[w].m_texOffset[Wall::WALL_TEX_MID].Set(dx, dy);
                    pSector->m_Walls[w].m_texScale[Wall::WALL_TEX_MID].Set(sx, sy);
                }

                pSector->m_Walls[w].m_adjoin[1] = SOLID_WALL;
                pSector->m_Walls[w].m_mirror[1] = SOLID_WALL;

                if ( pSector->m_Walls[w].m_idx[0] >= m_pBloodSectors[i].wallnum )
                {
                    assert(0);
                }
                nAmbient = 255 - m_pBloodWalls[ww].shade*4;
                if ( nAmbient < 0 ) nAmbient = 0;
                if ( nAmbient > 255 ) nAmbient = 255;
                pSector->m_Walls[w].m_lightDelta = nAmbient;
                
                pSector->m_Walls[w].m_adjoin[1] = SOLID_WALL;
                pSector->m_Walls[w].m_mirror[1] = SOLID_WALL;

                if ( m_pBloodWalls[ww].cstat&8 )
                {
                    pSector->m_Walls[w].m_flags |= Wall::WALL_FLAGS_XFLIP;
                }
                if ( m_pBloodWalls[ww].cstat&32 )
                {
                    pSector->m_Walls[w].m_flags |= Wall::WALL_FLAGS_SOLIDTEX;
                }
                if ( m_pBloodWalls[ww].cstat&256 )
                {
                    pSector->m_Walls[w].m_flags |= Wall::WALL_FLAGS_YFLIP;
                }
                if ( m_pBloodWalls[ww].cstat&16384 )
                {
                    pSector->m_Walls[w].m_flags |= Wall::WALL_FLAGS_MORPH;
                }
                if ( m_pBloodWalls[ww].cstat&32768 )
                {
                    pSector->m_Walls[w].m_flags |= Wall::WALL_FLAGS_INV_MORPH;
                }
            }

            pCell->AddSector( pSector );
        }

        int32_t _nPlayerStart = -1;
        for (int32_t i=0; i<m_bloodData.spriteCnt; i++)
        {
            //let's make a unique list of lotags for this level...
            int32_t lotag = m_pBloodSprites[i].lotag;

            if ( (m_pBloodSprites[i].cstat&0x8000) == 0 )
            {
                //floor oriented sprite.
                if ( m_pBloodSprites[i].cstat&0x20 )
                {
                    if ( m_pBloodSprites[i].picnum == 0 || m_pBloodSprites[i].lotag == 408 || EngineSettings::get().IsServer() )
                        continue;

                    uint32_t uWidth, uHeight;
                    TextureHandle hTex = AddBloodTile( m_pBloodSprites[i].picnum, m_pBloodSprites[i].pal, uWidth, uHeight, false );

                    Object *pObj = ObjectManager::CreateObject(""OrientedSprite"");
                    if ( pObj )
                    {
                        Sector_2_5D *pSector = (Sector_2_5D *)pCell->GetSector( m_pBloodSprites[i].sectnum );
                        float fSpriteIntens = 1.0f - ((float)m_pBloodSprites[i].shade/63.0f);

                        uint32_t uObjID = pObj->GetID();
                        pObj->SetSector( m_pBloodSprites[i].sectnum );
                        
                        Vector3 vLoc;
                        vLoc.x =  (float)m_pBloodSprites[i].x / fHorizScale;
                        vLoc.y = -(float)m_pBloodSprites[i].y / fHorizScale;
                        vLoc.z = -(float)m_pBloodSprites[i].z / fVertScale;

                        Vector3 vDir = Vector3::UnitZ;

                        float yaw = (float)m_pBloodSprites[i].ang/2048.0f * MATH_TWO_PI + MATH_PI;
                        Vector3 vUp;
                        vUp.x =  cosf(yaw);
                        vUp.y = -sinf(yaw);
                        vUp.z = 0.0f;
                        vUp.Normalize();
                        pObj->SetUp(vUp);
                        pObj->SetDir(vDir);

                        //
                        Vector3 vScale;
                        vScale.x = (float)uWidth*m_pBloodSprites[i].xrepeat * 0.125f*0.33f/64.0f;
                        vScale.z = (float)uWidth*m_pBloodSprites[i].xrepeat * 0.125f*0.33f/64.0f;
                        vScale.y = (float)uHeight*m_pBloodSprites[i].yrepeat * 0.125f*0.33f/64.0f;

                        float vx = vScale.x*vUp.y + vScale.y*vUp.x;
                        float vy = vScale.x*vUp.x + vScale.y*vUp.y;
                        vScale.x = vx; vScale.y = vy;

                        pObj->SetScale(vScale);

                        //offset...
                        float cz = (pSector->m_ZRangeCur.y + pSector->m_ZRangeCur.x) * 0.5f;
                        if ( vLoc.z < cz )
                            vLoc.z += 0.1f;
                        else
                            vLoc.z -= 0.1f;
                        pObj->SetLoc(vLoc);

                        OrientedSprite *pSprite = xlNew OrientedSprite();
                        pSprite->SetTextureHandle( hTex );
                        pSprite->SetBaseIntensity( fSpriteIntens );

                        bool bFlipX=false, bFlipY=false;
                        if ( m_pBloodSprites[i].cstat&4 )
                            bFlipX = true;
                        if ( m_pBloodSprites[i].cstat&8 ) 
                            bFlipY = true;

                        bool bFlipAxis = false;
                        if ( fabsf(vUp.x) > fabsf(vUp.y) )
                            bFlipAxis = true;

                        pSprite->SetUV_Flip(bFlipX, bFlipY, bFlipAxis);
                        pSprite->SetAlpha( (m_pBloodSprites[i].cstat&2) ? 0.5f : 1.0f );

                        pObj->SetRenderComponent( pSprite );

                        pSector->AddObject( uObjID );
                    }
                }
                else if ( m_pBloodSprites[i].cstat&0x10 )   //wall oriented sprite.
                {
                    if ( m_pBloodSprites[i].picnum == 0 || m_pBloodSprites[i].lotag == 408 || EngineSettings::get().IsServer() )
                        continue;

                    uint32_t uWidth, uHeight;
                    TextureHandle hTex = AddBloodTile( m_pBloodSprites[i].picnum, m_pBloodSprites[i].pal, uWidth, uHeight, false);

                    Object *pObj = ObjectManager::CreateObject(""OrientedSprite"");
                    if ( pObj )
                    {
                        uint32_t uObjID = pObj->GetID();
                        Sector_2_5D *pSector = (Sector_2_5D *)pCell->GetSector( m_pBloodSprites[i].sectnum );
                        pObj->SetSector( m_pBloodSprites[i].sectnum );
                        
                        Vector3 vLoc;
                        vLoc.x =  (float)m_pBloodSprites[i].x / fHorizScale;
                        vLoc.y = -(float)m_pBloodSprites[i].y / fHorizScale;
                        vLoc.z = -(float)m_pBloodSprites[i].z / fVertScale;

                        float yaw = (float)m_pBloodSprites[i].ang/2048.0f * MATH_TWO_PI + MATH_PI;
                        Vector3 vDir;
                        vDir.x =  cosf(yaw);
                        vDir.y = -sinf(yaw);
                        vDir.z = 0.0f;
                        vDir.Normalize();
                        pObj->SetDir(vDir);

                        //slight offset to avoid z-fighting....
                        //
                        Vector3 vScale;
                        vScale.x = (float)uWidth *m_pBloodSprites[i].xrepeat * 0.125f*0.33f/64.0f;
                        vScale.y = (float)uWidth *m_pBloodSprites[i].xrepeat * 0.125f*0.33f/64.0f;
                        vScale.z = (float)uHeight*m_pBloodSprites[i].yrepeat * 0.125f*0.33f/64.0f;
                        pObj->SetScale(vScale);

                        //this should be 128 but that doesn't always work. Must look at this later.
                        if ( m_pBloodSprites[i].cstat&2 )
                        {
                            vLoc.z = vLoc.z - vScale.z;
                        }
                        vLoc = vLoc - vDir*0.1f;
                        pObj->SetLoc(vLoc);

                        OrientedSprite *pSprite = xlNew OrientedSprite();
                        pSprite->SetTextureHandle( hTex );

                        bool bFlipX=false, bFlipY=false, bInvMorph=false;
                        if ( m_pBloodSprites[i].cstat&4 )
                            bFlipX = true;
                        if ( m_pBloodSprites[i].cstat&8 ) 
                            bFlipY = true;
                        if ( m_pBloodSprites[i].cstat&16384 )
                            bInvMorph = true;

                        pSprite->SetUV_Flip(bFlipX, bFlipY);
                        pSprite->SetAlpha( (m_pBloodSprites[i].cstat&2) ? 0.5f : 1.0f );
                        pObj->SetRenderComponent( pSprite );

                        //does this sprite match the sector ID?
                        if ( pSector->m_pFunc && m_pBloodSectors[m_pBloodSprites[i].sectnum].rxID == m_pBloodSprites[i].txID )
                        {
                            pSector->m_pFunc->AddClientObj( pObj, bInvMorph ? Wall::WALL_FLAGS_INV_MORPH : 0 );

                            //right now there is no raycast collision against oriented sprites, so we can find the closest adjoin wall of the parent sector
                            //and give it a trigger...
                            int32_t nClosest = -1;
                            float fClosest = 1000000.0f;
                            Vector3 vObjLoc3;
                            pObj->GetLoc(vObjLoc3);
                            Vector2 vObjLoc( vObjLoc3.x, vObjLoc3.y );
                            for (uint32_t w=0; w<pSector->m_uWallCount; w++)
                            {
                                if ( pSector->m_Walls[w].m_adjoin[0] != 0xffff )
                                {
                                    Vector2 offs = pSector->m_pVertexBase[ pSector->m_Walls[w].m_idx[0] ] - vObjLoc;
                                    float dist = offs.Dot(offs);
                                    if ( dist < fClosest )
                                    {
                                        fClosest = dist;
                                        nClosest = w;
                                    }
                                }
                            }
                            if ( nClosest > -1 && pSector->m_Walls[nClosest].m_pFunc == nullptr )
                            {
                                pSector->m_Walls[nClosest].m_pFunc = LevelFuncMgr::CreateLevelFunc(""TriggerToggle"", pSector->m_uID, nClosest);
                                pSector->m_Walls[nClosest].m_pFunc->AddClient( pSector->m_pFunc );
                                pSector->m_uFlags |= Sector_2_5D::SEC_FLAGS_ALLOW_NONSOLID_ACTIVATE;
                            }
                        }

                        pSector->AddObject( uObjID );
                    }
                }
                else if ( (m_pBloodSprites[i].cstat&48) == 0 )
                {
                    //verify that this object is visible...
                    if ( lotag == 408 || lotag == 459 || lotag >= 701 || lotag == 145 || lotag == 146 )
                        continue;

                    //enemy spawns...
                    if ( lotag >= 200 && lotag <= 220 )
                        continue;

                    //keys...
                    if ( lotag >= 100 && lotag <= 106 )
                        continue;

                    //weapons and ammo...
                    //if ( lotag >= 41 && lotag <= 79 )
                    //  continue;

                    //powerups...
                    //if ( lotag >= 107 && lotag <= 142 )
                    //  continue;

                    //need to control explode and gib objects as well... later?

                    if ( (lotag < 1 || lotag > 19) && m_pBloodSprites[i].picnum != 0 && m_pBloodSprites[i].picnum != 3566 && m_pBloodSprites[i].xrepeat > 0 && m_pBloodSprites[i].yrepeat > 0 )
                    {
                        uint32_t uWidth, uHeight;
                        TextureHandle hTex = XL_INVALID_TEXTURE;
                        TextureHandle ahAnimTex[32];
                        uint32_t auAnimWidth[32];
                        uint32_t auAnimHeight[32];
                        uint32_t uFrameCnt = 0;
                        if ( EngineSettings::get().IsServer() == false )
                        {
                            hTex = AddBloodTile( m_pBloodSprites[i].picnum, m_pBloodSprites[i].pal, uWidth, uHeight, false);
                            if ( m_pBloodSprites[i].picnum == 570 )
                            {
                                //This is a torch... it's special...
                                for (uint32_t pn = 2101; pn <= 2114; pn++)
                                {
                                    ahAnimTex[uFrameCnt] = AddBloodTile( pn, m_pBloodSprites[i].pal, auAnimWidth[uFrameCnt], auAnimHeight[uFrameCnt], false);
                                    uFrameCnt++;
                                }
                            }
                        }

                        Object *pObj = ObjectManager::CreateObject(""Sprite_ZAxis"");
                        if ( pObj )
                        {
                            uint32_t uObjID = pObj->GetID();
                            Sector_2_5D *pSector = (Sector_2_5D *)pCell->GetSector( m_pBloodSprites[i].sectnum );
                            pObj->SetSector( m_pBloodSprites[i].sectnum );
                            
                            Vector3 vLoc;
                            vLoc.x =  (float)m_pBloodSprites[i].x / fHorizScale;
                            vLoc.y = -(float)m_pBloodSprites[i].y / fHorizScale;
                            vLoc.z = -(float)m_pBloodSprites[i].z / fVertScale;

                            Vector3 vScale;
                            if ( EngineSettings::get().IsServer() == false )
                            {
                                vScale.x = (float)uWidth *m_pBloodSprites[i].xrepeat * 0.125f*0.33f/64.0f;
                                vScale.y = (float)uWidth *m_pBloodSprites[i].xrepeat * 0.125f*0.33f/64.0f;
                                vScale.z = (float)uHeight*m_pBloodSprites[i].yrepeat * 0.125f*0.33f/64.0f;
                            }
                            else
                            {
                                //a default scale for the server.
                                vScale.x = 64.0f * 0.125f*0.33f;
                                vScale.y = 64.0f * 0.125f*0.33f;
                                vScale.z = 64.0f * 0.125f*0.33f;
                            }
                            pObj->SetScale(vScale);

                            //this should be 128 but that doesn't always work. Must look at this later.
                            float sz = pSector->GetZ_Floor(vLoc.x, vLoc.y, pCell->GetSectors());
                            if ( (m_pBloodSprites[i].cstat&128) && vLoc.z < sz+vScale.z )
                            {
                                vLoc.z = sz + vScale.z;
                            }
                            pObj->SetLoc(vLoc);

                            if ( EngineSettings::get().IsServer() == false )  //There's no render component when running a server.
                            {
                                Sprite_ZAxis *pSprite = xlNew Sprite_ZAxis();
                                pSprite->SetTextureHandle( hTex );

                                bool bFlipX=false, bFlipY=false;
                                if ( m_pBloodSprites[i].cstat&4 )
                                    bFlipX = true;
                                if ( m_pBloodSprites[i].cstat&8 ) 
                                    bFlipY = true;

                                pSprite->SetUV_Flip(bFlipX, bFlipY);
                                pSprite->SetAlpha( (m_pBloodSprites[i].cstat&2) ? 0.5f : 1.0f );

                                for (uint32_t f=0; f<uFrameCnt; f++)
                                {
                                    pSprite->AddFX_Frame(ahAnimTex[f], auAnimWidth[f], auAnimHeight[f]);
                                }

                                pObj->SetRenderComponent( pSprite );
                            }

                            pSector->AddObject( uObjID );
                        }
                    }
                }
            }

            //lotag = 2, data = player
            if ( m_pBloodSprites[i].picnum >= 2522 && m_pBloodSprites[i].picnum <= 2529 && m_pBloodSprites[i].lotag == 2 )
            {
                int32_t player = m_pBloodSprites[i].data[0];

                //Add a MP start point to the object list.
                //The game can then find it later when it's time to spawn players.
                char szMP_Name[32];
                sprintf(szMP_Name, ""mp0_start%d"", player);
                Object *pObj = ObjectManager::CreateObject(szMP_Name);
                if ( pObj )
                {
                    uint32_t uObjID = pObj->GetID();
                    Sector_2_5D *pSector = (Sector_2_5D *)pCell->GetSector( m_pBloodSprites[i].sectnum );
                    pObj->SetSector( m_pBloodSprites[i].sectnum );
                    
                    Vector3 vLoc;
                    vLoc.x =  (float)m_pBloodSprites[i].x / fHorizScale;
                    vLoc.y = -(float)m_pBloodSprites[i].y / fHorizScale;
                    vLoc.z = -(float)m_pBloodSprites[i].z / fVertScale;

                    pObj->SetLoc(vLoc);
                    pSector->AddObject( uObjID );
                }
            }

            if ( m_pBloodSprites[i].picnum == 2529 && m_pBloodSprites[i].lotag == 1 )
            {
                _nPlayerStart = i;
            }
            if ( m_pBloodSprites[i].picnum == 2332 )
            {
                uint32_t idUpper = m_pBloodSprites[i].data[0];
                //we must look for a lower match...
                int32_t nMatchID = -1;
                for (int32_t ii=0; ii<m_bloodData.spriteCnt; ii++)
                {
                    if ( m_pBloodSprites[ii].picnum != 2331 )
                        continue;

                    uint32_t idLower = m_pBloodSprites[ii].data[0];
                    if ( idUpper != idLower )
                        continue;

                    //found match!
                    nMatchID = ii;
                    break;
                }
                assert( nMatchID>-1 );
                if ( nMatchID > -1 )
                {
                    Vector3 vLocUpper, vLocLower;
                    vLocUpper.x =  (float)m_pBloodSprites[i].x / fHorizScale;
                    vLocUpper.y = -(float)m_pBloodSprites[i].y / fHorizScale;
                    vLocUpper.z = -(float)m_pBloodSprites[i].z / fVertScale;

                    vLocLower.x =  (float)m_pBloodSprites[nMatchID].x / fHorizScale;
                    vLocLower.y = -(float)m_pBloodSprites[nMatchID].y / fHorizScale;
                    vLocLower.z = -(float)m_pBloodSprites[nMatchID].z / fVertScale;

                    //for now just shove it in the second adjoin...
                    int32_t secUpper = m_pBloodSprites[i].sectnum;
                    int32_t secLower = m_pBloodSprites[nMatchID].sectnum;

                    Sector_2_5D *pUpper = (Sector_2_5D *)pCell->GetSector(secUpper);
                    Sector_2_5D *pLower = (Sector_2_5D *)pCell->GetSector(secLower);

                    pUpper->m_vAdjoin[0] = secLower;
                    pUpper->m_vAdjOffset[0] = vLocUpper - vLocLower;
                    pUpper->m_vAdjOffset[0].z = pUpper->m_ZRangeBase.x - pLower->m_ZRangeBase.y;
                    pLower->m_vAdjoin[1] = secUpper;
                    pLower->m_vAdjOffset[1] = vLocLower - vLocUpper;
                    pLower->m_vAdjOffset[1].z = pLower->m_ZRangeBase.y - pUpper->m_ZRangeBase.x;

                    //is this water...
                    bool bIsWater = false;
                    if ( m_pBloodSprites[i].lotag == 9 )
                    {
                        pUpper->m_uFlags |= Sector_2_5D::SEC_FLAGS_FLOORWATER;
                        pLower->m_uFlags |= Sector_2_5D::SEC_FLAGS_UNDERWATER;
                    }
                }
            }
        }

        //now go through the sectors and setup any LevelFuncs
        uint32_t uSecCnt = pCell->GetSectorCount();
        for (uint32_t s=0; s<uSecCnt; s++)
        {
            Sector_2_5D *pSector = (Sector_2_5D *)pCell->GetSector(s);
            if ( pSector->m_pFunc )
            {
                pSector->m_pFunc->SetInitialState(0, m_pBloodSectors[s].cmd == 1 ? true : false);
            }
        }

        //start the player in the correct place.
        Object *player = ObjectManager::FindObject(""PLAYER"");
        if ( player && _nPlayerStart > -1 )
        {
            Vector3 vStartLoc;
            int32_t sectnum = -1;
            if ( !EngineSettings::get().GetStartPos(vStartLoc, sectnum) )
            {
                int32_t startID = _nPlayerStart;

                vStartLoc.x =  (float)m_pBloodSprites[startID].x / fHorizScale;
                vStartLoc.y = -(float)m_pBloodSprites[startID].y / fHorizScale;
                vStartLoc.z = -(float)m_pBloodSprites[startID].z / fVertScale;

                sectnum = m_pBloodSprites[startID].sectnum;
            }

            player->SetLoc(vStartLoc);
            player->SetSector( sectnum );
        }

        //now clean up memory.
        if ( m_pBloodSectors )
        {
            xlDelete [] m_pBloodSectors;
            m_pBloodSectors = nullptr;
        }
        if ( m_pBloodWalls )
        {
            xlDelete [] m_pBloodWalls;
            m_pBloodWalls = nullptr;
        }
        if ( m_pBloodSprites )
        {
            xlDelete [] m_pBloodSprites;
            m_pBloodSprites = nullptr;
        }
    }

    return pCell;
}
",16290,True,3305.514457415788,median
"
[[springSpringBoot]]


=== Spring Boot

Spring Boot is an application framework which, according to link:$$http://projects.spring.io/spring-boot/$$[its website], _makes it easy to create stand-alone, production-grade Spring based Applications that you can ""just run"". It takes an opinionated view of the Spring platform and third-party libraries so you can get started with minimum fuss. Most Spring Boot applications need very little Spring configuration_.

For more information on Spring Boot, see link:$$http://projects.spring.io/spring-boot/$$[http://projects.spring.io/spring-boot/]

The Spring Boot - Flowable integration has been developed together with Spring committers. 

==== Compatibility

Flowable supports both Spring Boot 2.0 and 1.5 with the same starters. The base support is for Spring Boot 2.0, which means that the actuator endpoints are only supported on 2.0.
The Flowable starters are also puling spring boot starter transitively, which means that users will have to define the 1.5 version of the spring boot starters in their own build files.

[[springSpringBootGettingStarted]]
==== Getting started

Spring Boot is all about convention over configuration.
To get started, you would need to create a Spring Boot project.
The easiest way to do this would be to create a project via link:$$https://start.spring.io/$$[start.spring.io].
For example create a project with web and h2 dependencies.
Then in the created project simply add the _flowable-spring-boot-starter_ or _flowable-spring-boot-starter-rest_ dependency.
In case you don't need all the engines see the other <<springBootFlowableStarter, Flowable starters>>.
For example for Maven:


[source,xml,linenums]
----
<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-spring-boot-starter</artifactId>
    <version>${flowable.version}</version>
</dependency>
----

That's all that's needed. This dependency will transitively add the correct Flowable dependencies to the classpath.
You can now run your Spring Boot application:

[source,java,,linenums]
----
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication(proxyBeanMethods = false)
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

}
----


You will see an output like this:

----
  .   ____          _            __ _ _
 /\\\\ / ___'_ __ _ _(_)_ __  __ _ \\ \\ \\ \\
( ( )\\___ | '_ | '_| | '_ \\/ _` | \\ \\ \\ \\
 \\\\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.0.0.RELEASE)

MyApplication                            : Starting MyApplication on ...
MyApplication                            : No active profile set, falling back to default profiles: default
ConfigServletWebServerApplicationContext : Refreshing org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@4fdfa676: startup date [Wed Mar 28 12:04:00 CEST 2018]; root of context hierarchy
o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
o.apache.catalina.core.StandardService   : Starting service [Tomcat]
org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/8.5.28
o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 3085 ms
o.s.b.w.servlet.ServletRegistrationBean  : Servlet dispatcherServlet mapped to [/]
o.s.b.w.servlet.ServletRegistrationBean  : Servlet Flowable IDM Rest API mapped to [/idm-api/*]
o.s.b.w.servlet.ServletRegistrationBean  : Servlet Flowable Form Rest API mapped to [/form-api/*]
o.s.b.w.servlet.ServletRegistrationBean  : Servlet Flowable DMN Rest API mapped to [/dmn-api/*]
o.s.b.w.servlet.ServletRegistrationBean  : Servlet Flowable Content Rest API mapped to [/content-api/*]
o.s.b.w.servlet.ServletRegistrationBean  : Servlet Flowable CMMN Rest API mapped to [/cmmn-api/*]
o.s.b.w.servlet.ServletRegistrationBean  : Servlet Flowable BPMN Rest API mapped to [/process-api/*]
o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'characterEncodingFilter' to: [/*]
o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'httpPutFormContentFilter' to: [/*]
o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'requestContextFilter' to: [/*]
uration$$EnhancerBySpringCGLIB$$3d0c70ac : No deployment resources were found for autodeployment
uration$$EnhancerBySpringCGLIB$$8131eb1a : No deployment resources were found for autodeployment
o.f.e.i.c.ProcessEngineConfigurationImpl : Found 5 Engine Configurators in total:
o.f.e.i.c.ProcessEngineConfigurationImpl : class org.flowable.idm.spring.configurator.SpringIdmEngineConfigurator (priority:100000)
o.f.e.i.c.ProcessEngineConfigurationImpl : class org.flowable.dmn.spring.configurator.SpringDmnEngineConfigurator (priority:200000)
o.f.e.i.c.ProcessEngineConfigurationImpl : class org.flowable.form.spring.configurator.SpringFormEngineConfigurator (priority:300000)
o.f.e.i.c.ProcessEngineConfigurationImpl : class org.flowable.content.spring.configurator.SpringContentEngineConfigurator (priority:400000)
o.f.e.i.c.ProcessEngineConfigurationImpl : class org.flowable.cmmn.spring.configurator.SpringCmmnEngineConfigurator (priority:500000)
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing beforeInit() of class org.flowable.idm.spring.configurator.SpringIdmEngineConfigurator (priority:100000)
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing beforeInit() of class org.flowable.dmn.spring.configurator.SpringDmnEngineConfigurator (priority:200000)
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing beforeInit() of class org.flowable.form.spring.configurator.SpringFormEngineConfigurator (priority:300000)
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing beforeInit() of class org.flowable.content.spring.configurator.SpringContentEngineConfigurator (priority:400000)
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing beforeInit() of class org.flowable.cmmn.spring.configurator.SpringCmmnEngineConfigurator (priority:500000)
com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing configure() of class org.flowable.idm.spring.configurator.SpringIdmEngineConfigurator (priority:100000)
.d.AbstractSqlScriptBasedDbSchemaManager : performing create on identity with resource org/flowable/idm/db/create/flowable.h2.create.identity.sql
o.f.idm.engine.impl.IdmEngineImpl        : IdmEngine default created
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing configure() of class org.flowable.dmn.spring.configurator.SpringDmnEngineConfigurator (priority:200000)
o.f.dmn.engine.impl.DmnEngineImpl        : DmnEngine default created
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing configure() of class org.flowable.form.spring.configurator.SpringFormEngineConfigurator (priority:300000)
o.f.form.engine.impl.FormEngineImpl      : FormEngine default created
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing configure() of class org.flowable.content.spring.configurator.SpringContentEngineConfigurator (priority:400000)
o.f.c.engine.ContentEngineConfiguration  : Content file system root : ...
o.f.c.engine.impl.ContentEngineImpl      : ContentEngine default created
o.f.e.i.c.ProcessEngineConfigurationImpl : Executing configure() of class org.flowable.cmmn.spring.configurator.SpringCmmnEngineConfigurator (priority:500000)
o.f.cmmn.engine.CmmnEngineConfiguration  : Found 1 Engine Configurators in total:
o.f.cmmn.engine.CmmnEngineConfiguration  : class org.flowable.idm.engine.configurator.IdmEngineConfigurator (priority:100000)
o.f.cmmn.engine.CmmnEngineConfiguration  : Executing beforeInit() of class org.flowable.idm.engine.configurator.IdmEngineConfigurator (priority:100000)
o.f.cmmn.engine.CmmnEngineConfiguration  : Executing configure() of class org.flowable.idm.engine.configurator.IdmEngineConfigurator (priority:100000)
o.f.idm.engine.impl.IdmEngineImpl        : IdmEngine default created
o.f.cmmn.engine.impl.CmmnEngineImpl      : CmmnEngine default created
o.f.engine.impl.ProcessEngineImpl        : ProcessEngine default created
o.f.j.s.i.a.AbstractAsyncExecutor        : Starting up the async job executor [org.flowable.spring.job.service.SpringAsyncExecutor].
o.f.j.s.i.a.AcquireAsyncJobsDueRunnable  : starting to acquire async jobs due
o.f.j.s.i.a.AcquireTimerJobsRunnable     : starting to acquire async jobs due
o.f.j.s.i.a.ResetExpiredJobsRunnable     : starting to reset expired jobs
o.f.e.impl.cmd.ValidateV5EntitiesCmd     : Total of v5 deployments found: 0
s.w.s.m.m.a.RequestMappingHandlerAdapter : Looking for @ControllerAdvice: org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@4fdfa676: startup date [Wed Mar 28 12:04:00 CEST 2018]; root of context hierarchy
s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped ""{[/error]}"" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController.error(javax.servlet.http.HttpServletRequest)
s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped ""{[/error],produces=[text/html]}"" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup
o.s.j.e.a.AnnotationMBeanExporter        : Bean with name 'dataSource' has been autodetected for JMX exposure
o.s.j.e.a.AnnotationMBeanExporter        : Located MBean 'dataSource': registering with JMX server as MBean [com.zaxxer.hikari:name=dataSource,type=HikariDataSource]
o.s.c.support.DefaultLifecycleProcessor  : Starting beans in phase -20
o.s.c.support.DefaultLifecycleProcessor  : Starting beans in phase 0
o.s.c.support.DefaultLifecycleProcessor  : Starting beans in phase 20
o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
flowable.Application                     : Started Application in 18.235 seconds (JVM running for 19.661)
----

So, by just adding the dependency to the classpath and using the _@SpringBootAplication_ annotation a lot has happened behind the scenes:

* An in-memory datasource is created automatically (because the H2 driver is on the classpath) and passed to the Flowable process engine configuration
* A Flowable ProcessEngine, CmmnEngine, DmnEngine, FormEngine, ContentEngine and IdmEngine beans have been created and exposed
* All the Flowable services are exposed as Spring beans
* The Spring Job Executor is created

Also:

* Any BPMN 2.0 process definitions in the _processes_ folder will be automatically deployed. Create a folder _processes_ and add a dummy process definition (named _one-task-process.bpmn20.xml_) to this folder. The content of this file is shown below.
* Any CMMN 1.1 case definitions in the _cases_ folder will be automatically deployed.
* Any DMN 1.1 dmn definitions in the _dmn_ folder will be automatically deployed.
* Any Form definitions in the _forms_ folder will be automatically deployed.

The XML content of the process definition is shown below. Notice that, for the moment, we are hard-coding an assignee called ""kermit"" to the user task. We'll come back to this later.

[source,xml,linenums]
----
<?xml version=""1.0"" encoding=""UTF-8""?>
<definitions
        xmlns=""http://www.omg.org/spec/BPMN/20100524/MODEL""
        xmlns:flowable=""http://flowable.org/bpmn""
        targetNamespace=""Examples"">

    <process id=""oneTaskProcess"" name=""The One Task Process"">
        <startEvent id=""theStart"" />
        <sequenceFlow id=""flow1"" sourceRef=""theStart"" targetRef=""theTask"" />
        <userTask id=""theTask"" name=""my task"" flowable:assignee=""kermit"" />
        <sequenceFlow id=""flow2"" sourceRef=""theTask"" targetRef=""theEnd"" />
        <endEvent id=""theEnd"" />
    </process>

</definitions>
----

Also, add following code lines to test if the deployment actually worked. The _CommandLineRunner_ is a special kind of Spring bean that is executed when the application boots:

[source,java,linenums]
----
@SpringBootApplication(proxyBeanMethods = false)
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

    @Bean
    public CommandLineRunner init(final RepositoryService repositoryService,
                                  final RuntimeService runtimeService,
                                  final TaskService taskService) {

        return new CommandLineRunner() {
            @Override
            public void run(String... strings) throws Exception {
                System.out.println(""Number of process definitions : "" 
                	+ repositoryService.createProcessDefinitionQuery().count());
                System.out.println(""Number of tasks : "" + taskService.createTaskQuery().count());
                runtimeService.startProcessInstanceByKey(""oneTaskProcess"");
                System.out.println(""Number of tasks after process start: "" 
                    + taskService.createTaskQuery().count());
            }
        };
    }
}
----

The output expected will be:

----
Number of process definitions : 1
Number of tasks : 0
Number of tasks after process start : 1
----


==== Changing the database and connection pool

As stated above, Spring Boot is about convention over configuration. By default, by having only H2 on the classpath, it created an in-memory datasource and passed that to the Flowable process engine configuration.

To change the datasource, simply add the database driver dependencies and provide the URL to the database.
For example, to switch to a MySQL database:

[source,linenums]
----
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/flowable-spring-boot?characterEncoding=UTF-8
spring.datasource.username=flowable
spring.datasource.password=flowable
----

Remove H2 from the Maven dependencies and add the MySQL driver to the classpath:

[source,xml,linenums]
----
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>5.1.45</version>
</dependency>
----

When the app is now booted up, you'll see it uses MySQL as database (and the HikariCP connection pooling framework):

----
org.flowable.engine.impl.db.DbSqlSession   : performing create on engine with resource org/flowable/db/create/flowable.mysql.create.engine.sql
org.flowable.engine.impl.db.DbSqlSession   : performing create on history with resource org/flowable/db/create/flowable.mysql.create.history.sql
org.flowable.engine.impl.db.DbSqlSession   : performing create on identity with resource org/flowable/db/create/flowable.mysql.create.identity.sql
----

When you reboot the application multiple times, you'll see the number of tasks go up (the H2 in-memory database does not survive a shutdown, MySQL does).

For more information about how to configure the datasource have a look in link:$$https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-sql.html#boot-features-configure-datasource$$[Configure a DataSource] in the Spring Boot reference guide.

==== REST support

Often, a REST API is used on top of the embedded Flowable engine (interacting with the different services in a company). Spring Boot makes this really easy. Add following dependency to the classpath:

[source,xml,linenums]
----
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>${spring.boot.version}</version>
</dependency>
----

Create a new class, a Spring service and create two methods: one to start our process and one to get a task list for a given assignee. We simply wrap Flowable calls here, but in real-life scenarios this will be more complex.

[source,java,linenums]
----
@Service
public class MyService {

    @Autowired
    private RuntimeService runtimeService;

    @Autowired
    private TaskService taskService;

    @Transactional
    public void startProcess() {
        runtimeService.startProcessInstanceByKey(""oneTaskProcess"");
    }

    @Transactional
    public List<Task> getTasks(String assignee) {
        return taskService.createTaskQuery().taskAssignee(assignee).list();
    }

}
----

We can now create a REST endpoint by annotating a class with _@RestController_. Here, we simply delegate to the service defined above.

[source,java,linenums]
----
@RestController
public class MyRestController {

    @Autowired
    private MyService myService;

    @PostMapping(value=""/process"")
    public void startProcessInstance() {
        myService.startProcess();
    }

    @RequestMapping(value=""/tasks"", method= RequestMethod.GET, produces=MediaType.APPLICATION_JSON_VALUE)
    public List<TaskRepresentation> getTasks(@RequestParam String assignee) {
        List<Task> tasks = myService.getTasks(assignee);
        List<TaskRepresentation> dtos = new ArrayList<TaskRepresentation>();
        for (Task task : tasks) {
            dtos.add(new TaskRepresentation(task.getId(), task.getName()));
        }
        return dtos;
    }

    static class TaskRepresentation {

        private String id;
        private String name;

        public TaskRepresentation(String id, String name) {
            this.id = id;
            this.name = name;
        }
        
        public String getId() {
            return id;
        }
        public void setId(String id) {
            this.id = id;
        }
        public String getName() {
            return name;
        }
        public void setName(String name) {
            this.name = name;
        }

    }

}
----

Both the _@Service_ and the _@RestController_ will be found by the automatic component scan for a Spring Boot application.
Run the application class again. We can now interact with the REST API, for example, by using cURL:

----
curl http://localhost:8080/tasks?assignee=kermit
[]

curl -X POST  http://localhost:8080/process
curl http://localhost:8080/tasks?assignee=kermit
[{""id"":""10004"",""name"":""my task""}]
----

As can be seen, we are referring to the assignee, ""kermit"", which was hard-coded into the process definition XML earlier. We'll change this later on to allow the assignee to be set when the workflow instance is started.

==== JPA support

To add JPA support for Flowable in Spring Boot, add following dependency:

[source,xml,linenums]
----
<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-spring-boot-starter</artifactId>
    <version>${flowable.version}</version>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
    <version>${spring-boot.version}</version>
</dependency>
----

This will add in the Spring configuration and beans for using JPA. By default, the JPA provider will be Hibernate.

Let's create a simple Entity class:

[source,java,linenums]
----
@Entity
class Person {

    @Id
    @GeneratedValue
    private Long id;

    private String username;

    private String firstName;

    private String lastName;

    private Date birthDate;

    public Person() {
    }

    public Person(String username, String firstName, String lastName, Date birthDate) {
        this.username = username;
        this.firstName = firstName;
        this.lastName = lastName;
        this.birthDate = birthDate;
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Date getBirthDate() {
        return birthDate;
    }

    public void setBirthDate(Date birthDate) {
        this.birthDate = birthDate;
    }
}
----

By default, when not using an in-memory database, the tables won't be created automatically. Create a file _application.properties_ on the classpath and add following property:

----
spring.jpa.hibernate.ddl-auto=update
----

Add following class:

[source,java,linenums]
----
@Repository
public interface PersonRepository extends JpaRepository<Person, Long> {

    Person findByUsername(String username);
}
----

This is a Spring repository, which offers CRUD out of the box. We add the method to find a Person by username. Spring will automatically implement this based on conventions (typically, the property names used).

We now enhance our service further:

* by adding _@Transactional_ to the class. Note that by adding the JPA dependency above, the DataSourceTransactionManager which we were using before is now automatically swapped out by a JpaTransactionManager. 
* The _startProcess_ now gets an assignee username passed in, which is used to look up the Person, and put the Person JPA object as a process variable in the process instance.
* A method to create Dummy users is added. This is used in the CommandLineRunner to populate the database.

[source,java,linenums]
----
@Service
@Transactional
public class MyService {

    @Autowired
    private RuntimeService runtimeService;

    @Autowired
    private TaskService taskService;

    @Autowired
    private PersonRepository personRepository;

    public void startProcess(String assignee) {

        Person person = personRepository.findByUsername(assignee);

        Map<String, Object> variables = new HashMap<String, Object>();
        variables.put(""person"", person);
        runtimeService.startProcessInstanceByKey(""oneTaskProcess"", variables);
    }

    public List<Task> getTasks(String assignee) {
        return taskService.createTaskQuery().taskAssignee(assignee).list();
    }

    public void createDemoUsers() {
        if (personRepository.findAll().size() == 0) {
            personRepository.save(new Person(""jbarrez"", ""Joram"", ""Barrez"", new Date()));
            personRepository.save(new Person(""trademakers"", ""Tijs"", ""Rademakers"", new Date()));
        }
    }

}
----

The CommandLineRunner now looks like:

[source,java,linenums]
----
@Bean
public CommandLineRunner init(final MyService myService) {

    return new CommandLineRunner() {
    	public void run(String... strings) throws Exception {
        	myService.createDemoUsers();
        }
    };
}
----

The RestController is also modified slightly to incorporate the changes above (only showing new methods) and the HTTP POST now has a body that contains the assignee username:

----
@RestController
public class MyRestController {

    @Autowired
    private MyService myService;

    @PostMapping(value=""/process"")
    public void startProcessInstance(@RequestBody StartProcessRepresentation startProcessRepresentation) {
        myService.startProcess(startProcessRepresentation.getAssignee());
    }

   ...

    static class StartProcessRepresentation {

        private String assignee;

        public String getAssignee() {
            return assignee;
        }

        public void setAssignee(String assignee) {
            this.assignee = assignee;
        }
    }
----

And finally, to try out the Spring-JPA-Flowable integration, we assign the task using the ID of the Person JPA object in the process definition:

[source,xml,linenums]
----
<userTask id=""theTask"" name=""my task"" flowable:assignee=""${person.id}""/>
----

This replaces the hard-coded recipient, ""kermit"", which we had initially set.

We can now start a new process instance, providing the user name in the POST body:

----
curl -H ""Content-Type: application/json"" -d '{""assignee"" : ""jbarrez""}' http://localhost:8080/process
----

And the task list is now fetched using the person ID:

----
curl http://localhost:8080/tasks?assignee=1

[{""id"":""12505"",""name"":""my task""}]
----

[[springBootActuatorEndpoint]]
==== Flowable Actuator Endpoints

Flowable provides a Spring Boot Actuator Endpoint that exposes information for the Processes that are running.
By default the `flowable` endpoint is mapped to `/actuator/flowable`.
Spring Boot by default only exposes the `info` and `health` endpoints. In order to enable the `flowable` endpoint you need to add `management.endpoint.flowable.enabled=true` to your `application.properties`.

In order to make enable Actuator endpoints you need to add a dependency on Actuator, e.g. by using {sc-flowable-starter}/flowable-spring-boot-starter-actuator/pom.xml[flowable-spring-boot-starter-actuator].

`curl http://localhost:8080/actuator/flowable`

[source,json]
----

{
  ""completedTaskCountToday"": 0,
  ""deployedProcessDefinitions"": [
    ""oneTaskProcess (v1)""
  ],
  ""processDefinitionCount"": 1,
  ""cachedProcessDefinitionCount"": 0,
  ""runningProcessInstanceCount"": {
    ""oneTaskProcess (v1)"": 0
  },
  ""completedTaskCount"": 2,
  ""completedActivities"": 3,
  ""completedProcessInstanceCount"": {
    ""oneTaskProcess (v1)"": 0
  },
  ""openTaskCount"": 0
}
----

For more information about Spring Boot Actuator see link:$$https://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-endpoints.html$$[Production Ready Endpoint] in the Spring Boot reference documentation.

[[springBootInfoContributor]]
==== Flowable Info Contributor

Flowable also provides a Spring Boot `InfoContributor` which looks like:

`curl http://localhost:8080/actuator/info`

[source,json]
----
{
  ""flowable"": {
    ""version"": ""6.5.0.event-SNAPSHOT""
  }
}
----

[[springBootFlowableProperties]]
==== Flowable Application Properties

The Flowable auto configuration is leveraging the Spring Boot properties and configuration mechanism.
See link:$$https://docs.spring.io/spring-boot/docs/current/reference/html/howto-properties-and-configuration.html$$[Properties and Configuration] in the Spring Boot reference guide.

Here is a list of configuration properties that the Flowable Spring Boot support consumes.

[source,properties,indent=0,subs=""verbatim,attributes,macros""]
----

# ===================================================================
# Common Flowable Spring Boot Properties
#
# This sample file is provided as a guideline. Do NOT copy it in its
# entirety to your own application.	           ^^^
# ===================================================================

# Core (Process) {sc-flowable-boot}/FlowableProperties.java[FlowableProperties]
flowable.check-process-definitions=true # Whether process definitions need to be auto deployed.
flowable.custom-mybatis-mappers= # The FQN of custom Mybatis mappers that need to be added to the engine.
flowable.custom-mybatis-x-m-l-mappers= # The location of the custom Mybatis XML Mappers that need to be added to the engine.
flowable.database-schema= # In some situations you want to set the schema to use for table checks / generation if the database metadata doesn't return that correctly.
flowable.database-schema-update=true # The strategy that should be used for the database schema.
flowable.db-history-used=true # Whether db history should be used.
flowable.deployment-name=SpringBootAutoDeployment # The name of the auto deployment.
flowable.history-level=audit # The history level that needs to be used.
flowable.process-definition-location-prefix=classpath*:/processes/ # The folder in which processes need to be searched for auto deployment.
flowable.process-definition-location-suffixes=**.bpmn20.xml,**.bpmn # The suffixes (extensions) of the files that needs to be deployed from the 'processDefinitionLocationPrefix' location.

# Process {sc-flowable-boot}/process/FlowableProcessProperties.java[FlowableProcessProperties]
flowable.process.definition-cache-limit=-1 # The maximum amount of process definitions available in the process definition cache. Per default it is -1 (all process definitions).
flowable.process.enable-safe-xml=true # Enables extra checks on the BPMN xml that is parsed. See https://www.flowable.org/docs/userguide/index.html#advanced.safe.bpmn.xml. Unfortunately, this feature is not available on some platforms (JDK 6, JBoss), hence you need to disable if your platform does not allow the use of StaxSource during XML parsing.
flowable.process.servlet.load-on-startup=-1 # Load on startup of the Process dispatcher servlet.
flowable.process.servlet.name=Flowable BPMN Rest API # The name of the Process servlet.
flowable.process.servlet.path=/process-api # The context path for the Process rest servlet.

# Process Async Executor
flowable.process.async-executor-activate=true # Whether the async executor should be activated.
flowable.process.async.executor.async-job-lock-time-in-millis=300000 # The amount of time (in milliseconds) an async job is locked when acquired by the async executor. During this period of time, no other async executor will try to acquire and lock this job.
flowable.process.async.executor.default-async-job-acquire-wait-time-in-millis=10000 # The time (in milliseconds) the async job acquisition thread will wait to execute the next acquirement query. This happens when no new async jobs were found or when less async jobs have been fetched. Default value = 10 seconds.
flowable.process.async.executor.default-queue-size-full-wait-time-in-millis=0 # The time (in milliseconds) the async job (both timer and async continuations) acquisition thread will wait when the queue is full to execute the next query. By default set to 0 (for backwards compatibility)
flowable.process.async.executor.default-timer-job-acquire-wait-time-in-millis=10000 # The time (in milliseconds) the timer job acquisition thread will wait to execute the next acquirement query. This happens when no new timer jobs were found or when less async jobs have been fetched. Default value = 10 seconds.
flowable.process.async.executor.max-async-jobs-due-per-acquisition=1 # ???
flowable.process.async.executor.retry-wait-time-in-millis=500 # ???
flowable.process.async.executor.timer-lock-time-in-millis=300000 # The amount of time (in milliseconds) a timer job is locked when acquired by the async executor. During this period of time, no other async executor will try to acquire and lock this job.


# CMMN {sc-flowable-boot}/cmmn/FlowableCmmnProperties.java[FlowableCmmnProperties]
flowable.cmmn.deploy-resources=true # Whether to perform deployment of resources, default is 'true'.
flowable.cmmn.deployment-name=SpringBootAutoDeployment # The name of the deployment for the CMMN resources.
flowable.cmmn.enable-safe-xml=true # Enables extra checks on the DMN xml that is parsed. See https://www.flowable.org/docs/userguide/index.html#advanced.safe.bpmn.xml. Unfortunately, this feature is not available on some platforms (JDK 6, JBoss), hence you need to disable if your platform does not allow the use of StaxSource during XML parsing.
flowable.cmmn.enabled=true # Whether the CMMN engine needs to be started.
flowable.cmmn.resource-location=classpath*:/cases/ # The location where the CMMN resources are located.
flowable.cmmn.resource-suffixes=**.cmmn,**.cmmn11,**.cmmn.xml,**.cmmn11.xml # The suffixes for the resources that need to be scanned.
flowable.cmmn.servlet.load-on-startup=-1 # Load on startup of the CMMN dispatcher servlet.
flowable.cmmn.servlet.name=Flowable CMMN Rest API # The name of the CMMN servlet.
flowable.cmmn.servlet.path=/cmmn-api # The context path for the CMMN rest servlet.

# CMMN Async Executor
flowable.cmmn.async-executor-activate=true # Whether the async executor should be activated.
flowable.cmmn.async.executor.async-job-lock-time-in-millis=300000 # The amount of time (in milliseconds) an async job is locked when acquired by the async executor. During this period of time, no other async executor will try to acquire and lock this job.
flowable.cmmn.async.executor.default-async-job-acquire-wait-time-in-millis=10000 # The time (in milliseconds) the async job acquisition thread will wait to execute the next acquirement query. This happens when no new async jobs were found or when less async jobs have been fetched. Default value = 10 seconds.
flowable.cmmn.async.executor.default-queue-size-full-wait-time-in-millis=0 # The time (in milliseconds) the async job (both timer and async continuations) acquisition thread will wait when the queue is full to execute the next query. By default set to 0 (for backwards compatibility)
flowable.cmmn.async.executor.default-timer-job-acquire-wait-time-in-millis=10000 # The time (in milliseconds) the timer job acquisition thread will wait to execute the next acquirement query. This happens when no new timer jobs were found or when less async jobs have been fetched. Default value = 10 seconds.
flowable.cmmn.async.executor.max-async-jobs-due-per-acquisition=1 # ???
flowable.cmmn.async.executor.retry-wait-time-in-millis=500 # ???
flowable.cmmn.async.executor.timer-lock-time-in-millis=300000 # The amount of time (in milliseconds) a timer job is locked when acquired by the async executor. During this period of time, no other async executor will try to acquire and lock this job.

# Content {sc-flowable-boot}/content/FlowableContentProperties.java[FlowableContentProperties]
flowable.content.enabled=true # Whether the content engine needs to be started.
flowable.content.servlet.load-on-startup=-1 # Load on startup of the Content dispatcher servlet.
flowable.content.servlet.name=Flowable Content Rest API # The name of the Content servlet.
flowable.content.servlet.path=/content-api # The context path for the Content rest servlet.
flowable.content.storage.create-root=true # If the root folder doesn't exist, should it be created?
flowable.content.storage.root-folder= # Root folder location where content files will be stored, for example, task attachments or form file uploads.

# DMN {sc-flowable-boot}/dmn/FlowableDmnProperties.java[FlowableDmnProperties]
flowable.dmn.deploy-resources=true # Whether to perform deployment of resources, default is 'true'.
flowable.dmn.deployment-name=SpringBootAutoDeployment # The name of the deployment for the dmn resources.
flowable.dmn.enable-safe-xml=true # Enables extra checks on the DMN xml that is parsed. See https://www.flowable.org/docs/userguide/index.html#advanced.safe.bpmn.xml. Unfortunately, this feature is not available on some platforms (JDK 6, JBoss), hence you need to disable if your platform does not allow the use of StaxSource during XML parsing.
flowable.dmn.enabled=true # Whether the dmn engine needs to be started.
flowable.dmn.history-enabled=true # Whether the history for the DMN engine should be enabled.
flowable.dmn.resource-location=classpath*:/dmn/ # The location where the dmn resources are located.
flowable.dmn.resource-suffixes=**.dmn,**.dmn.xml,**.dmn11,**.dmn11.xml # The suffixes for the resources that need to be scanned.
flowable.dmn.servlet.load-on-startup=-1 # Load on startup of the DMN dispatcher servlet.
flowable.dmn.servlet.name=Flowable DMN Rest API # The name of the DMN servlet.
flowable.dmn.servlet.path=/dmn-api # The context path for the DMN rest servlet.
flowable.dmn.strict-mode=true # Set this to false if you want to ignore the decision table hit policy validity checks to result in an failed decision table state. A result is that intermediate results created up to the point the validation error occurs are returned.

# Form {sc-flowable-boot}/form/FlowableFormProperties.java[FlowableFormProperties]
flowable.form.deploy-resources=true # Whether to perform deployment of resources, default is true.
flowable.form.deployment-name=SpringBootAutoDeployment # The name of the deployment for the form resources.
flowable.form.enabled=true # Whether the form engine needs to be started.
flowable.form.resource-location=classpath*:/forms/ # The location where the form resources are located.
flowable.form.resource-suffixes=**.form # The suffixes for the resources that need to be scanned.
flowable.form.servlet.load-on-startup=-1 # Load on startup of the Form dispatcher servlet.
flowable.form.servlet.name=Flowable Form Rest API # The name of the Form servlet.
flowable.form.servlet.path=/form-api # The context path for the Form rest servlet.

# IDM {sc-flowable-boot}/idm/FlowableIdmProperties.java[FlowableIdmProperties]
flowable.idm.enabled=true # Whether the idm engine needs to be started.
flowable.idm.password-encoder= # The type of the password encoder that needs to be used.
flowable.idm.servlet.load-on-startup=-1 # Load on startup of the IDM dispatcher servlet.
flowable.idm.servlet.name=Flowable IDM Rest API # The name of the IDM servlet.
flowable.idm.servlet.path=/idm-api # The context path for the IDM rest servlet.

# IDM Ldap {sc-flowable-boot}/ldap/FlowableLdapProperties.java[FlowableLdapProperties]
flowable.idm.ldap.attribute.email= # Name of the attribute that matches the user email.
flowable.idm.ldap.attribute.first-name= # Name of the attribute that matches the user first name.
flowable.idm.ldap.attribute.group-id= # Name of the attribute that matches the group id.
flowable.idm.ldap.attribute.group-name= # Name of the attribute that matches the group name.
flowable.idm.ldap.attribute.group-type= # Name of the attribute that matches the group type.
flowable.idm.ldap.attribute.last-name= # Name of the attribute that matches the user last name.
flowable.idm.ldap.attribute.user-id= # Name of the attribute that matches the user id.
flowable.idm.ldap.base-dn= # The base 'distinguished name' (DN) from which the searches for users and groups are started.
flowable.idm.ldap.cache.group-size=-1 # Allows to set the size of the {@link org.flowable.ldap.LDAPGroupCache}. This is an LRU cache that caches groups for users and thus avoids hitting the LDAP system each time the groups of a user needs to be known.
flowable.idm.ldap.custom-connection-parameters= # Allows to set all LDAP connection parameters which do not have a dedicated setter. See for example http://docs.oracle.com/javase/tutorial/jndi/ldap/jndi.html for custom properties. Such properties are for example to configure connection pooling, specific security settings, etc.
flowable.idm.ldap.enabled=false # Whether to enable LDAP IDM Service.
flowable.idm.ldap.group-base-dn= # The base 'distinguished name' (DN) from which the searches for groups are started.
flowable.idm.ldap.initial-context-factory=com.sun.jndi.ldap.LdapCtxFactory # The class name for the initial context factory.
flowable.idm.ldap.password= # The password that is used to connect to the LDAP system.
flowable.idm.ldap.port=-1 # The port on which the LDAP system is running.
flowable.idm.ldap.query.all-groups= # The query that is executed when searching for all groups.
flowable.idm.ldap.query.all-users= # The query that is executed when searching for all users.
flowable.idm.ldap.query.groups-for-user= # The query that is executed when searching for the groups of a specific user.
flowable.idm.ldap.query.user-by-full-name-like= # The query that is executed when searching for a user by full name.
flowable.idm.ldap.query.user-by-id= # The query that is executed when searching for a user by userId.
flowable.idm.ldap.query.group-by-id= # The query that is executed when searching for a specific group by groupId.
flowable.idm.ldap.search-time-limit=0 # The timeout (in milliseconds) that is used when doing a search in LDAP. By default set to '0', which means 'wait forever'.
flowable.idm.ldap.security-authentication=simple # The value that is used for the 'java.naming.security.authentication' property used to connect to the LDAP system.
flowable.idm.ldap.server= # The server host on which the LDAP system can be reached. For example 'ldap://localhost'.
flowable.idm.ldap.user= # The user id that is used to connect to the LDAP system.
flowable.idm.ldap.user-base-dn= # The base 'distinguished name' (DN) from which the searches for users are started.

# Flowable Mail {sc-flowable-boot}/FlowableMailProperties.java[FlowableMailProperties]
flowable.mail.server.default-from=flowable@localhost # The default from address that needs to be used when sending emails.
flowable.mail.server.force-to= # The force to address(es) that would be used when sending out emails. IMPORTANT: If this is set then all emails will be send to defined address(es) instead of the address configured in the MailActivity.
flowable.mail.server.host=localhost # The host of the mail server.
flowable.mail.server.password= # The password for the mail server authentication.
flowable.mail.server.port=1025 # The port of the mail server.
flowable.mail.server.use-ssl=false # Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).
flowable.mail.server.use-tls=false # Set or disable the STARTTLS encryption.
flowable.mail.server.username= # The username that needs to be used for the mail server authentication. If empty no authentication would be used.

# Flowable Http {sc-flowable-boot}/FlowableHttpProperties.java[FlowableHttpProperties]
flowable.http.user-system-properties=false # Whether to use system properties (e.g. http.proxyPort).
flowable.http.connect-timeout=5s # Connect timeout for the http client
flowable.http.socket-timeout=5s # Socket timeout for the http client
flowable.http.connection-request-timeout=5s # Connection Request Timeout for the http client
flowable.http.request-retry-limit=3 # Request retry limit for the http client
flowable.http.disable-cert-verify=false # Whether to disable certificate validation for the http client

# Flowable REST
flowable.rest.app.cors.enabled=true # Whether to enable CORS requests at all. If false, the other properties have no effect
flowable.rest.app.cors.allow-credentials=true # Whether to include credentials in a CORS request
flowable.rest.app.cors.allowed-origins=* # Comma-separated URLs to accept CORS requests from
flowable.rest.app.cors.allowed-headers=* # Comma-separated HTTP headers to allow in a CORS request
flowable.rest.app.cors.allowed-methods=DELETE,GET,PATCH,POST,PUT # Comma-separated HTTP verbs to allow in a CORS request
flowable.rest.app.cors.exposed-headers=* # Comma-separated list of headers to expose in CORS response

# Actuator
management.endpoint.flowable.cache.time-to-live=0ms # Maximum time that a response can be cached.
management.endpoint.flowable.enabled=true # Whether to enable the flowable endpoint.

----

.Deprecated properties
[cols=""4*"",options=""header""]
|===============
|Property name
|Old Property
|Default value
|Description

|flowable.process.servlet.name
|flowable.rest-api-servlet-name
|Flowable BPMN Rest API
|The name of the Process servlet.

|flowable.process.servlet.path
|flowable.rest-api-mapping
|/process-api
|The context path for the Process rest servlet.

|flowable.mail.server.host
|flowable.mail-server-host
|localhost
|The host of the mail server.

|flowable.mail.server.password
|flowable.mail-server-password
|-
|The password for the mail server authentication.

|flowable.mail.server.port
|flowable.mail-server-port
|1025
|The port of the mail server.

|flowable.mail.server.use-ssl
|flowable.mail-server-use-ssl
|false
|Sets whether SSL/TLS encryption should be enabled for the SMTP transport upon connection (SMTPS/POPS).

|flowable.mail.server.use-tls
|flowable.mail-server-use-tls
|false
|Set or disable the STARTTLS encryption.

|flowable.mail.server.username
|flowable.mail-server-user-name
|-
|The username that needs to be used for the mail server authentication.
If empty no authentication would be used.

|flowable.process.definition-cache-limit
|flowable.process-definitions.cache.max
|-1
|The maximum amount of process definitions available in the process definition cache.
 Per default it is -1 (all process definitions)
|===============

[[springBootFlowableAutoConfiguration]]
==== Flowable Auto-configuration classes

Here is a list of all auto-configuration classes provided by Flowable, with links to documentation and source code.
Remember to also look at the conditions report in your application for more details of which features are switched on.
(To do so, start the app with --debug or -Ddebug or, in an Actuator application, use the conditions endpoint).

[cols=*,options=""header""]
|===
|Configuration Class

|{sc-flowable-boot}/content/ContentEngineAutoConfiguration.java[ContentEngineAutoConfiguration]
|{sc-flowable-boot}/content/ContentEngineServicesAutoConfiguration.java[ContentEngineServicesAutoConfiguration]
|{sc-flowable-boot}/cmmn/CmmnEngineAutoConfiguration.java[CmmnEngineAutoConfiguration]
|{sc-flowable-boot}/cmmn/CmmnEngineServicesAutoConfiguration.java[CmmnEngineServicesAutoConfiguration]
|{sc-flowable-boot}/dmn/DmnEngineAutoConfiguration.java[DmnEngineAutoConfiguration]
|{sc-flowable-boot}/dmn/DmnEngineServicesAutoConfiguration.java[DmnEngineServicesAutoConfiguration]
|{sc-flowable-boot}/EndpointAutoConfiguration.java[EndpointAutoConfiguration]
|{sc-flowable-boot}/actuate/info/FlowableInfoAutoConfiguration.java[FlowableInfoAutoConfiguration]
|{sc-flowable-boot}/ldap/FlowableLdapAutoConfiguration.java[FlowableLdapAutoConfiguration]
|{sc-flowable-boot}/FlowableTransactionAutoConfiguration.java[FlowableTransactionAutoConfiguration]
|{sc-flowable-boot}/form/FormEngineAutoConfiguration.java[FormEngineAutoConfiguration]
|{sc-flowable-boot}/form/FormEngineServicesAutoConfiguration.java[FormEngineServicesAutoConfiguration]
|{sc-flowable-boot}/idm/IdmEngineAutoConfiguration.java[IdmEngineAutoConfiguration]
|{sc-flowable-boot}/idm/IdmEngineServicesAutoConfiguration.java[IdmEngineServicesAutoConfiguration]
|{sc-flowable-boot}/ProcessEngineAutoConfiguration.java[ProcessEngineAutoConfiguration]
|{sc-flowable-boot}/RestApiAutoConfiguration.java[RestApiAutoConfiguration]
|{sc-flowable-boot}/SecurityAutoConfiguration.java[SecurityAutoConfiguration]

|===

[[springBootFlowableStarter]]
==== Flowable Starters

Here is a list of the flowable spring boot starters.

[cols=2*,options=""header""]
|===
|Starter
|Description

|{sc-flowable-starter}/flowable-spring-boot-starter-cmmn/pom.xml[flowable-spring-boot-starter-cmmn]
|Contains the dependencies for booting the CMMN Engine in Standalone mode

|{sc-flowable-starter}/flowable-spring-boot-starter-cmmn-rest/pom.xml[flowable-spring-boot-starter-cmmn-rest]
|Contains the dependencies for booting the CMMN Engine in Standalone mode and starts its REST API

|{sc-flowable-starter}/flowable-spring-boot-starter-dmn/pom.xml[flowable-spring-boot-starter-dmn]
|Contains the dependencies for booting the DMN Engine in Standalone mode

|{sc-flowable-starter}/flowable-spring-boot-starter-dmn-rest/pom.xml[flowable-spring-boot-starter-dmn-rest]
|Contains the dependencies for booting the DMN Engine in Standalone mode and starts its REST API

|{sc-flowable-starter}/flowable-spring-boot-starter-process/pom.xml[flowable-spring-boot-starter-process]
|Contains the dependencies for booting the Process Engine in Standalone mode

|{sc-flowable-starter}/flowable-spring-boot-starter-process-rest/pom.xml[flowable-spring-boot-starter-process-rest]
|Contains the dependencies for booting the Process Engine in Standalone mode and starts its REST API

|{sc-flowable-starter}/flowable-spring-boot-starter/pom.xml[flowable-spring-boot-starter]
|Contains the dependencies for booting all Flowable Engines (Process, CMMN, DMN, Form, Content and IDM)

|{sc-flowable-starter}/flowable-spring-boot-starter-rest/pom.xml[flowable-spring-boot-starter-rest]
|Contains the dependencies for booting all Flowable Engines and their respective REST API

|{sc-flowable-starter}/flowable-spring-boot-starter-actuator/pom.xml[flowable-spring-boot-starter-actuator]
|Contains the required dependencies for Spring Boot

|===

==== Using Liquibase

The Flowable engines are using Liquibase to manage the versioning of it's tables.
This means that the `LiquibaseAutoConfiguration` from Spring Boot would automatically kick in.
However, if you are not using Liquibase then the application will not start and would throw an exception.
For this reason Flowable is setting `spring.liquibase.enabled` to `false`, which means that if you need to use Liquibase you have to explicitly enable it.

==== Further Reading

Obviously, there is a lot about Spring Boot that hasn't been touched upon yet, like very easy JTA integration or building a WAR file that can be run on major application servers. And there is a lot more to the Spring Boot integration: 

* Actuator support
* Spring Integration support
* Rest API integration: boot up the Flowable Rest API embedded within the Spring application
* Spring Security support

==== Advanced Configuration

===== Customizing Engine Configuration

It's possible to get a hold of the engine configuration by implementing the _org.flowable.spring.boot.EngineConfigurationConfigurer<T>_ interface.
Where _T_ is the Spring Type of the particular Engine Configuration.
This can be useful for advanced configuration settings or simply because a property has not been exposed (yet).
For example:

[source, java, linenums]
----
public class MyConfigurer implements EngineConfigurationConfigurer<SpringProcessEngineConfiguration> {

    public void configure(SpringProcessEngineConfiguration processEngineConfiguration) {
        // advanced configuration
    }
    
}
----

By exposing an instance of this class as an _@Bean_ in the Spring Boot configuration, the instance will be called before the process engine is fully created.

[TIP]
====
You can provide a custom implementation of a Flowable Service by using this. See {sc-flowable-boot}/ldap/FlowableLdapAutoConfiguration.java[FlowableLdapAutoConfiguration]
====

===== Combining starters

In case you need only a combination of the engines then you can add only the required dependencies.
For example to use the Process, CMMN, Form and IDM engine and use LDAP you need to add the following dependencies:

[source,xml,linenums]
----
<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-spring-boot-starter-process</artifactId>
    <version>${flowable.version}</version>
</dependency>
<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-spring-boot-starter-cmmn</artifactId>
    <version>${flowable.version}</version>
</dependency>
<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-content-spring-configurator</artifactId>
    <version>${flowable.version}</version>
</dependency>
<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-form-spring-configurator</artifactId>
    <version>${flowable.version}</version>
</dependency>
<dependency>
    <groupId>org.flowable</groupId>
    <artifactId>flowable-ldap</artifactId>
    <version>${flowable.version}</version>
</dependency>
----

===== Configuring Async Executors

The Process and CMMN engines have dedicated `AsyncExecutor`(s) and they can be configured with the `flowable.{engine}.async.executor` property group.
Where `engine` is either `process` or `cmmn`.

The `AsyncExecutor`(s) per default share the same Spring `TaskExecutor` and `SpringRejectedJobsHandler`.
In case you want to provide a dedicated executor for each of the engines you need define a qualified bean with `@Process` and `@Cmmn`.

You can configure custom executors in the following way:

[source,java,linenums]
----
@Configuration
public class MyConfiguration {

    @Process <1>
    @Bean
    public TaskExecutor processTaskExecutor() {
        return new SimpleAsyncTaskExecutor();
    }

    @Cmmn <2>
    @Bean
    public TaskExecutor cmmnTaskExecutor() {
        return new SyncTaskExecutor();
    }
}
----
<1> The Async Executor for the Process Engine would use a `SimpleAsyncTaskExecutor`
<2> The Async Executor for the CMMN Engine would use a `SyncTaskExecutor`

[IMPORTANT]
======
If you define a custom `TaskExecutor` bean the Flowable creation of the bean is not triggered.
Which means that if you define a bean qualified with `@Process` you have to define one with `@Cmmn` or `@Primary`, otherwise the Cmmn Async Executor will use the one for the Process
======

",12203,False,1843.4303382145179,median
"[[features.external-config]]
== Externalized Configuration
Spring Boot lets you externalize your configuration so that you can work with the same application code in different environments.
You can use a variety of external configuration sources, include Java properties files, YAML files, environment variables, and command-line arguments.

Property values can be injected directly into your beans by using the `@Value` annotation, accessed through Spring's `Environment` abstraction, or be <<features#features.external-config.typesafe-configuration-properties,bound to structured objects>> through `@ConfigurationProperties`.

Spring Boot uses a very particular `PropertySource` order that is designed to allow sensible overriding of values.
Properties are considered in the following order (with values from lower items overriding earlier ones):

. Default properties (specified by setting `SpringApplication.setDefaultProperties`).
. {spring-framework-api}/context/annotation/PropertySource.html[`@PropertySource`] annotations on your `@Configuration` classes.
  Please note that such property sources are not added to the `Environment` until the application context is being refreshed.
  This is too late to configure certain properties such as `+logging.*+` and `+spring.main.*+` which are read before refresh begins.
. Config data (such as `application.properties` files).
. A `RandomValuePropertySource` that has properties only in `+random.*+`.
. OS environment variables.
. Java System properties (`System.getProperties()`).
. JNDI attributes from `java:comp/env`.
. `ServletContext` init parameters.
. `ServletConfig` init parameters.
. Properties from `SPRING_APPLICATION_JSON` (inline JSON embedded in an environment variable or system property).
. Command line arguments.
. `properties` attribute on your tests.
  Available on {spring-boot-test-module-api}/context/SpringBootTest.html[`@SpringBootTest`] and the <<features#features.testing.spring-boot-applications.autoconfigured-tests,test annotations for testing a particular slice of your application>>.
. {spring-framework-api}/test/context/TestPropertySource.html[`@TestPropertySource`] annotations on your tests.
. <<using#using.devtools.globalsettings,Devtools global settings properties>> in the `$HOME/.config/spring-boot` directory when devtools is active.

Config data files are considered in the following order:

. <<features#features.external-config.files,Application properties>> packaged inside your jar (`application.properties` and YAML variants).
. <<features#features.external-config.files.profile-specific,Profile-specific application properties>> packaged inside your jar (`application-\\{profile}.properties` and YAML variants).
. <<features#features.external-config.files,Application properties>> outside of your packaged jar (`application.properties` and YAML variants).
. <<features#features.external-config.files.profile-specific,Profile-specific application properties>> outside of your packaged jar (`application-\\{profile}.properties` and YAML variants).

NOTE: It is recommended to stick with one format for your entire application.
If you have configuration files with both `.properties` and `.yml` format in the same location, `.properties` takes precedence.

To provide a concrete example, suppose you develop a `@Component` that uses a `name` property, as shown in the following example:

include::code:MyBean[]

On your application classpath (for example, inside your jar) you can have an `application.properties` file that provides a sensible default property value for `name`.
When running in a new environment, an `application.properties` file can be provided outside of your jar that overrides the `name`.
For one-off testing, you can launch with a specific command line switch (for example, `java -jar app.jar --name=""Spring""`).

TIP: The `env` and `configprops` endpoints can be useful in determining why a property has a particular value.
You can use these two endpoints to diagnose unexpected property values.
See the ""<<actuator#actuator.endpoints, Production ready features>>"" section for details.



[[features.external-config.command-line-args]]
=== Accessing Command Line Properties
By default, `SpringApplication` converts any command line option arguments (that is, arguments starting with `--`, such as `--server.port=9000`) to a `property` and adds them to the Spring `Environment`.
As mentioned previously, command line properties always take precedence over file-based property sources.

If you do not want command line properties to be added to the `Environment`, you can disable them by using `SpringApplication.setAddCommandLineProperties(false)`.



[[features.external-config.application-json]]
=== JSON Application Properties
Environment variables and system properties often have restrictions that mean some property names cannot be used.
To help with this, Spring Boot allows you to encode a block of properties into a single JSON structure.

When your application starts, any `spring.application.json` or `SPRING_APPLICATION_JSON` properties will be parsed and added to the `Environment`.

For example, the `SPRING_APPLICATION_JSON` property can be supplied on the command line in a UN{asterisk}X shell as an environment variable:

[source,shell,indent=0,subs=""verbatim""]
----
	$ SPRING_APPLICATION_JSON='{""my"":{""name"":""test""}}' java -jar myapp.jar
----

In the preceding example, you end up with `my.name=test` in the Spring `Environment`.

The same JSON can also be provided as a system property:

[source,shell,indent=0,subs=""verbatim""]
----
	$ java -Dspring.application.json='{""my"":{""name"":""test""}}' -jar myapp.jar
----

Or you could supply the JSON by using a command line argument:

[source,shell,indent=0,subs=""verbatim""]
----
	$ java -jar myapp.jar --spring.application.json='{""my"":{""name"":""test""}}'
----

If you are deploying to a classic Application Server, you could also use a JNDI variable named `java:comp/env/spring.application.json`.

NOTE: Although `null` values from the JSON will be added to the resulting property source, the `PropertySourcesPropertyResolver` treats `null` properties as missing values.
This means that the JSON cannot override properties from lower order property sources with a `null` value.



[[features.external-config.files]]
=== External Application Properties [[features.external-config.files]]
Spring Boot will automatically find and load `application.properties` and `application.yaml` files from the following locations when your application starts:

. From the classpath
.. The classpath root
.. The classpath `/config` package
. From the current directory
.. The current directory
.. The `/config` subdirectory in the current directory
.. Immediate child directories of the `/config` subdirectory

The list is ordered by precedence (with values from lower items overriding earlier ones).
Documents from the loaded files are added as `PropertySources` to the Spring `Environment`.

If you do not like `application` as the configuration file name, you can switch to another file name by specifying a configprop:spring.config.name[] environment property.
For example, to look for `myproject.properties` and `myproject.yaml` files you can run your application as follows:

[source,shell,indent=0,subs=""verbatim""]
----
	$ java -jar myproject.jar --spring.config.name=myproject
----

You can also refer to an explicit location by using the configprop:spring.config.location[] environment property.
This properties accepts a comma-separated list of one or more locations to check.

The following example shows how to specify two distinct files:

[source,shell,indent=0,subs=""verbatim""]
----
	$ java -jar myproject.jar --spring.config.location=\\
		optional:classpath:/default.properties,\\
		optional:classpath:/override.properties
----

TIP: Use the prefix `optional:` if the <<features#features.external-config.files.optional-prefix,locations are optional>> and you do not mind if they do not exist.

WARNING: `spring.config.name`, `spring.config.location`, and `spring.config.additional-location` are used very early to determine which files have to be loaded.
They must be defined as an environment property (typically an OS environment variable, a system property, or a command-line argument).

If `spring.config.location` contains directories (as opposed to files), they should end in `/`.
At runtime they will be appended with the names generated from `spring.config.name` before being loaded.
Files specified in `spring.config.location` are imported directly.

NOTE: Both directory and file location values are also expanded to check for <<features#features.external-config.files.profile-specific,profile-specific files>>.
For example, if you have a `spring.config.location` of `classpath:myconfig.properties`, you will also find appropriate `classpath:myconfig-<profile>.properties` files are loaded.

In most situations, each configprop:spring.config.location[] item you add will reference a single file or directory.
Locations are processed in the order that they are defined and later ones can override the values of earlier ones.

[[features.external-config.files.location-groups]]
If you have a complex location setup, and you use profile-specific configuration files, you may need to provide further hints so that Spring Boot knows how they should be grouped.
A location group is a collection of locations that are all considered at the same level.
For example, you might want to group all classpath locations, then all external locations.
Items within a location group should be separated with `;`.
See the example in the ""`<<features#features.external-config.files.profile-specific>>`"" section for more details.

Locations configured by using `spring.config.location` replace the default locations.
For example, if `spring.config.location` is configured with the value `optional:classpath:/custom-config/,optional:file:./custom-config/`, the complete set of locations considered is:

. `optional:classpath:custom-config/`
. `optional:file:./custom-config/`

If you prefer to add additional locations, rather than replacing them, you can use `spring.config.additional-location`.
Properties loaded from additional locations can override those in the default locations.
For example, if `spring.config.additional-location` is configured with the value `optional:classpath:/custom-config/,optional:file:./custom-config/`, the complete set of locations considered is:

. `optional:classpath:/;optional:classpath:/config/`
. `optional:file:./;optional:file:./config/;optional:file:./config/*/`
. `optional:classpath:custom-config/`
. `optional:file:./custom-config/`

This search ordering lets you specify default values in one configuration file and then selectively override those values in another.
You can provide default values for your application in `application.properties` (or whatever other basename you choose with `spring.config.name`) in one of the default locations.
These default values can then be overridden at runtime with a different file located in one of the custom locations.

NOTE: If you use environment variables rather than system properties, most operating systems disallow period-separated key names, but you can use underscores instead (for example, configprop:spring.config.name[format=envvar] instead of configprop:spring.config.name[]).
See <<features#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables>> for details.

NOTE: If your application runs in a servlet container or application server, then JNDI properties (in `java:comp/env`) or servlet context initialization parameters can be used instead of, or as well as, environment variables or system properties.



[[features.external-config.files.optional-prefix]]
==== Optional Locations
By default, when a specified config data location does not exist, Spring Boot will throw a `ConfigDataLocationNotFoundException` and your application will not start.

If you want to specify a location, but you do not mind if it does not always exist, you can use the `optional:` prefix.
You can use this prefix with the `spring.config.location` and `spring.config.additional-location` properties, as well as with <<features#features.external-config.files.importing, `spring.config.import`>> declarations.

For example, a `spring.config.import` value of `optional:file:./myconfig.properties` allows your application to start, even if the `myconfig.properties` file is missing.

If you want to ignore all `ConfigDataLocationNotFoundExceptions` and always continue to start your application, you can use the `spring.config.on-not-found` property.
Set the value to `ignore` using `SpringApplication.setDefaultProperties(...)` or with a system/environment variable.



[[features.external-config.files.wildcard-locations]]
==== Wildcard Locations
If a config file location includes the `{asterisk}` character for the last path segment, it is considered a wildcard location.
Wildcards are expanded when the config is loaded so that immediate subdirectories are also checked.
Wildcard locations are particularly useful in an environment such as Kubernetes when there are multiple sources of config properties.

For example, if you have some Redis configuration and some MySQL configuration, you might want to keep those two pieces of configuration separate, while requiring that both those are present in an `application.properties` file.
This might result in two separate `application.properties` files mounted at different locations such as `/config/redis/application.properties` and `/config/mysql/application.properties`.
In such a case, having a wildcard location of `config/*/`, will result in both files being processed.

By default, Spring Boot includes `config/*/` in the default search locations.
It means that all subdirectories of the `/config` directory outside of your jar will be searched.

You can use wildcard locations yourself with the `spring.config.location` and `spring.config.additional-location` properties.

NOTE: A wildcard location must contain only one `{asterisk}` and end with `{asterisk}/` for search locations that are directories or `*/<filename>` for search locations that are files.
Locations with wildcards are sorted alphabetically based on the absolute path of the file names.

TIP: Wildcard locations only work with external directories.
You cannot use a wildcard in a `classpath:` location.



[[features.external-config.files.profile-specific]]
==== Profile Specific Files
As well as `application` property files, Spring Boot will also attempt to load profile-specific files using the naming convention `application-\\{profile}`.
For example, if your application activates a profile named `prod` and uses YAML files, then both `application.yml` and `application-prod.yml` will be considered.

Profile-specific properties are loaded from the same locations as standard `application.properties`, with profile-specific files always overriding the non-specific ones.
If several profiles are specified, a last-wins strategy applies.
For example, if profiles `prod,live` are specified by the configprop:spring.profiles.active[] property, values in `application-prod.properties` can be overridden by those in `application-live.properties`.

[NOTE]
====
The last-wins strategy applies at the <<features#features.external-config.files.location-groups,location group>> level.
A configprop:spring.config.location[] of `classpath:/cfg/,classpath:/ext/` will not have the same override rules as `classpath:/cfg/;classpath:/ext/`.

For example, continuing our `prod,live` example above, we might have the following files:

----
/cfg
  application-live.properties
/ext
  application-live.properties
  application-prod.properties
----

When we have a configprop:spring.config.location[] of `classpath:/cfg/,classpath:/ext/` we process all `/cfg` files before all `/ext` files:

. `/cfg/application-live.properties`
. `/ext/application-prod.properties`
. `/ext/application-live.properties`


When we have `classpath:/cfg/;classpath:/ext/` instead (with a `;` delimiter) we process `/cfg` and `/ext` at the same level:

. `/ext/application-prod.properties`
. `/cfg/application-live.properties`
. `/ext/application-live.properties`
====

The `Environment` has a set of default profiles (by default, `[default]`) that are used if no active profiles are set.
In other words, if no profiles are explicitly activated, then properties from `application-default` are considered.

NOTE: Properties files are only ever loaded once.
If you have already directly <<features#features.external-config.files.importing,imported>> a profile specific property files then it will not be imported a second time.



[[features.external-config.files.importing]]
==== Importing Additional Data
Application properties may import further config data from other locations using the `spring.config.import` property.
Imports are processed as they are discovered, and are treated as additional documents inserted immediately below the one that declares the import.

For example, you might have the following in your classpath `application.properties` file:

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	spring:
	  application:
	    name: ""myapp""
	  config:
	    import: ""optional:file:./dev.properties""
----

This will trigger the import of a `dev.properties` file in current directory (if such a file exists).
Values from the imported `dev.properties` will take precedence over the file that triggered the import.
In the above example, the `dev.properties` could redefine `spring.application.name` to a different value.

An import will only be imported once no matter how many times it is declared.
The order an import is defined inside a single document within the properties/yaml file does not matter.
For instance, the two examples below produce the same result:

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	spring:
	  config:
	    import: ""my.properties""
	my:
	  property: ""value""
----

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	my:
	  property: ""value""
	spring:
	  config:
	    import: ""my.properties""
----

In both of the above examples, the values from the `my.properties` file will take precedence over the file that triggered its import.

Several locations can be specified under a single `spring.config.import` key.
Locations will be processed in the order that they are defined, with later imports taking precedence.

NOTE: When appropriate, <<features#features.external-config.files.profile-specific, Profile-specific variants>> are also considered for import.
The example above would import both `my.properties` as well as any `my-<profile>.properties` variants.

[TIP]
====
Spring Boot includes pluggable API that allows various different location addresses to be supported.
By default you can import Java Properties, YAML and ""`<<features#features.external-config.files.configtree, configuration trees>>`"".

Third-party jars can offer support for additional technologies (there is no requirement for files to be local).
For example, you can imagine config data being from external stores such as Consul, Apache ZooKeeper or Netflix Archaius.

If you want to support your own locations, see the `ConfigDataLocationResolver` and `ConfigDataLoader` classes in the `org.springframework.boot.context.config` package.
====



[[features.external-config.files.importing-extensionless]]
==== Importing Extensionless Files
Some cloud platforms cannot add a file extension to volume mounted files.
To import these extensionless files, you need to give Spring Boot a hint so that it knows how to load them.
You can do this by putting an extension hint in square brackets.

For example, suppose you have a `/etc/config/myconfig` file that you wish to import as yaml.
You can import it from your `application.properties` using the following:

[source,yaml,indent=0,subs=""verbatim"",configprops,configblocks]
----
	spring:
	  config:
	    import: ""file:/etc/config/myconfig[.yaml]""
----



[[features.external-config.files.configtree]]
==== Using Configuration Trees
When running applications on a cloud platform (such as Kubernetes) you often need to read config values that the platform supplies.
It is not uncommon to use environment variables for such purposes, but this can have drawbacks, especially if the value is supposed to be kept secret.

As an alternative to environment variables, many cloud platforms now allow you to map configuration into mounted data volumes.
For example, Kubernetes can volume mount both https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/#populate-a-volume-with-data-stored-in-a-configmap[`ConfigMaps`] and https://kubernetes.io/docs/concepts/configuration/secret/#using-secrets-as-files-from-a-pod[`Secrets`].

There are two common volume mount patterns that can be used:

. A single file contains a complete set of properties (usually written as YAML).
. Multiple files are written to a directory tree, with the filename becoming the '`key`' and the contents becoming the '`value`'.

For the first case, you can import the YAML or Properties file directly using `spring.config.import` as described <<features#features.external-config.files.importing,above>>.
For the second case, you need to use the `configtree:` prefix so that Spring Boot knows it needs to expose all the files as properties.

As an example, let's imagine that Kubernetes has mounted the following volume:

[indent=0]
----
	etc/
	  config/
	    myapp/
	      username
	      password
----

The contents of the `username` file would be a config value, and the contents of `password` would be a secret.

To import these properties, you can add the following to your `application.properties` or `application.yaml` file:

[source,yaml,indent=0,subs=""verbatim"",configprops,configblocks]
----
	spring:
	  config:
	    import: ""optional:configtree:/etc/config/""
----

You can then access or inject `myapp.username` and `myapp.password` properties from the `Environment` in the usual way.

NOTE: Filenames with dot notation are also correctly mapped.
For example, in the above example, a file named `myapp.username` in `/etc/config` would result in a `myapp.username` property in the `Environment`.

TIP: Configuration tree values can be bound to both string `String` and `byte[]` types depending on the contents expected.

If you have multiple config trees to import from the same parent folder you can use a wildcard shortcut.
Any `configtree:` location that ends with `/*/` will import all immediate children as config trees.

For example, given the following volume:

[indent=0]
----
	etc/
	  config/
	    dbconfig/
	      db/
	        username
	        password
	    mqconfig/
	      mq/
	        username
	        password
----

You can use `configtree:/etc/config/*/` as the import location:

[source,yaml,indent=0,subs=""verbatim"",configprops,configblocks]
----
	spring:
	  config:
	    import: ""optional:configtree:/etc/config/*/""
----

This will add `db.username`, `db.password`, `mq.username` and `mq.password` properties.

NOTE: Directories loaded using a wildcard are sorted alphabetically.
If you need a different order, then you should list each location as a separate import


Configuration trees can also be used for Docker secrets.
When a Docker swarm service is granted access to a secret, the secret gets mounted into the container.
For example, if a secret named `db.password` is mounted at location `/run/secrets/`, you can make `db.password` available to the Spring environment using the following:

[source,yaml,indent=0,subs=""verbatim"",configprops,configblocks]
----
	spring:
	  config:
	    import: ""optional:configtree:/run/secrets/""
----



[[features.external-config.files.property-placeholders]]
==== Property Placeholders
The values in `application.properties` and `application.yml` are filtered through the existing `Environment` when they are used, so you can refer back to previously defined values (for example, from System properties).
The standard `$\\{name}` property-placeholder syntax can be used anywhere within a value.

For example, the following file will set `app.description` to ""`MyApp is a Spring Boot application`"":

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	app:
	  name: ""MyApp""
	  description: ""${app.name} is a Spring Boot application""
----

TIP: You can also use this technique to create ""`short`"" variants of existing Spring Boot properties.
See the _<<howto#howto.properties-and-configuration.short-command-line-arguments>>_ how-to for details.



[[features.external-config.files.multi-document]]
==== Working with Multi-Document Files
Spring Boot allows you to split a single physical file into multiple logical documents which are each added independently.
Documents are processed in order, from top to bottom.
Later documents can override the properties defined in earlier ones.

For `application.yml` files, the standard YAML multi-document syntax is used.
Three consecutive hyphens represent the end of one document, and the start of the next.

For example, the following file has two logical documents:

[source,yaml,indent=0,subs=""verbatim""]
----
	spring:
	  application:
	    name: ""MyApp""
	---
	spring:
	  application:
	    name: ""MyCloudApp""
	  config:
	    activate:
	      on-cloud-platform: ""kubernetes""
----

For `application.properties` files a special `#---` comment is used to mark the document splits:

[source,properties,indent=0,subs=""verbatim""]
----
	spring.application.name=MyApp
	#---
	spring.application.name=MyCloudApp
	spring.config.activate.on-cloud-platform=kubernetes
----

NOTE: Property file separators must not have any leading whitespace and must have exactly three hyphen characters.
The lines immediately before and after the separator must not be comments.

TIP: Multi-document property files are often used in conjunction with activation properties such as `spring.config.activate.on-profile`.
See the <<features#features.external-config.files.activation-properties, next section>> for details.

WARNING: Multi-document property files cannot be loaded by using the `@PropertySource` or `@TestPropertySource` annotations.



[[features.external-config.files.activation-properties]]
==== Activation Properties
It is sometimes useful to only activate a given set of properties when certain conditions are met.
For example, you might have properties that are only relevant when a specific profile is active.

You can conditionally activate a properties document using `spring.config.activate.*`.

The following activation properties are available:

.activation properties
[cols=""1,4""]
|===
| Property | Note

| `on-profile`
| A profile expression that must match for the document to be active.

| `on-cloud-platform`
| The `CloudPlatform` that must be detected for the document to be active.
|===

For example, the following specifies that the second document is only active when running on Kubernetes, and only when either the ""`prod`"" or ""`staging`"" profiles are active:

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	myprop:
	  ""always-set""
	---
	spring:
	  config:
	    activate:
	      on-cloud-platform: ""kubernetes""
	      on-profile: ""prod | staging""
	myotherprop: ""sometimes-set""
----



[[features.external-config.encrypting]]
=== Encrypting Properties
Spring Boot does not provide any built in support for encrypting property values, however, it does provide the hook points necessary to modify values contained in the Spring `Environment`.
The `EnvironmentPostProcessor` interface allows you to manipulate the `Environment` before the application starts.
See <<howto#howto.application.customize-the-environment-or-application-context>> for details.

If you need a secure way to store credentials and passwords, the https://cloud.spring.io/spring-cloud-vault/[Spring Cloud Vault] project provides support for storing externalized configuration in https://www.vaultproject.io/[HashiCorp Vault].



[[features.external-config.yaml]]
=== Working with YAML
https://yaml.org[YAML] is a superset of JSON and, as such, is a convenient format for specifying hierarchical configuration data.
The `SpringApplication` class automatically supports YAML as an alternative to properties whenever you have the https://bitbucket.org/asomov/snakeyaml[SnakeYAML] library on your classpath.

NOTE: If you use ""`Starters`"", SnakeYAML is automatically provided by `spring-boot-starter`.



[[features.external-config.yaml.mapping-to-properties]]
==== Mapping YAML to Properties
YAML documents need to be converted from their hierarchical format to a flat structure that can be used with the Spring `Environment`.
For example, consider the following YAML document:

[source,yaml,indent=0,subs=""verbatim""]
----
	environments:
	  dev:
	    url: ""https://dev.example.com""
	    name: ""Developer Setup""
	  prod:
	    url: ""https://another.example.com""
	    name: ""My Cool App""
----

In order to access these properties from the `Environment`, they would be flattened as follows:

[source,properties,indent=0,subs=""verbatim""]
----
	environments.dev.url=https://dev.example.com
	environments.dev.name=Developer Setup
	environments.prod.url=https://another.example.com
	environments.prod.name=My Cool App
----

Likewise, YAML lists also need to be flattened.
They are represented as property keys with `[index]` dereferencers.
For example, consider the following YAML:

[source,yaml,indent=0,subs=""verbatim""]
----
	 my:
	  servers:
	  - ""dev.example.com""
	  - ""another.example.com""
----

The preceding example would be transformed into these properties:

[source,properties,indent=0,subs=""verbatim""]
----
	my.servers[0]=dev.example.com
	my.servers[1]=another.example.com
----

TIP: Properties that use the `[index]` notation can be bound to Java `List` or `Set` objects using Spring Boot's `Binder` class.
For more details see the ""`<<features#features.external-config.typesafe-configuration-properties>>`"" section below.

WARNING: YAML files cannot be loaded by using the `@PropertySource` or `@TestPropertySource` annotations.
So, in the case that you need to load values that way, you need to use a properties file.



[[features.external-config.yaml.directly-loading]]
[[features.external-config.yaml.directly-loading]]
==== Directly Loading YAML
Spring Framework provides two convenient classes that can be used to load YAML documents.
The `YamlPropertiesFactoryBean` loads YAML as `Properties` and the `YamlMapFactoryBean` loads YAML as a `Map`.

You can also use the `YamlPropertySourceLoader` class if you want to load YAML as a Spring `PropertySource`.



[[features.external-config.random-values]]
=== Configuring Random Values
The `RandomValuePropertySource` is useful for injecting random values (for example, into secrets or test cases).
It can produce integers, longs, uuids, or strings, as shown in the following example:

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	my:
	  secret: ""${random.value}""
	  number: ""${random.int}""
	  bignumber: ""${random.long}""
	  uuid: ""${random.uuid}""
	  number-less-than-ten: ""${random.int(10)}""
	  number-in-range: ""${random.int[1024,65536]}""
----

The `+random.int*+` syntax is `OPEN value (,max) CLOSE` where the `OPEN,CLOSE` are any character and `value,max` are integers.
If `max` is provided, then `value` is the minimum value and `max` is the maximum value (exclusive).



[[features.external-config.system-environment]]
=== Configuring System Environment Properties
Spring Boot supports setting a prefix for environment properties.
This is useful if the system environment is shared by multiple Spring Boot applications with different configuration requirements.
The prefix for system environment properties can be set directly on `SpringApplication`.

For example, if you set the prefix to `input`, a property such as `remote.timeout` will also be resolved as `input.remote.timeout` in the system environment.



[[features.external-config.typesafe-configuration-properties]]
=== Type-safe Configuration Properties
Using the `@Value(""$\\{property}"")` annotation to inject configuration properties can sometimes be cumbersome, especially if you are working with multiple properties or your data is hierarchical in nature.
Spring Boot provides an alternative method of working with properties that lets strongly typed beans govern and validate the configuration of your application.

TIP: See also the <<features#features.external-config.typesafe-configuration-properties.vs-value-annotation,differences between `@Value` and type-safe configuration properties>>.



[[features.external-config.typesafe-configuration-properties.java-bean-binding]]
==== JavaBean properties binding
It is possible to bind a bean declaring standard JavaBean properties as shown in the following example:

include::code:MyProperties[]

The preceding POJO defines the following properties:

* `my.service.enabled`, with a value of `false` by default.
* `my.service.remote-address`, with a type that can be coerced from `String`.
* `my.service.security.username`, with a nested ""security"" object whose name is determined by the name of the property.
  In particular, the type is not used at all there and could have been `SecurityProperties`.
* `my.service.security.password`.
* `my.service.security.roles`, with a collection of `String` that defaults to `USER`.

NOTE: The properties that map to `@ConfigurationProperties` classes available in Spring Boot, which are configured through properties files, YAML files, environment variables, and other mechanisms, are public API but the accessors (getters/setters) of the class itself are not meant to be used directly.

[NOTE]
====
Such arrangement relies on a default empty constructor and getters and setters are usually mandatory, since binding is through standard Java Beans property descriptors, just like in Spring MVC.
A setter may be omitted in the following cases:

* Maps, as long as they are initialized, need a getter but not necessarily a setter, since they can be mutated by the binder.
* Collections and arrays can be accessed either through an index (typically with YAML) or by using a single comma-separated value (properties).
  In the latter case, a setter is mandatory.
  We recommend to always add a setter for such types.
  If you initialize a collection, make sure it is not immutable (as in the preceding example).
* If nested POJO properties are initialized (like the `Security` field in the preceding example), a setter is not required.
  If you want the binder to create the instance on the fly by using its default constructor, you need a setter.

Some people use Project Lombok to add getters and setters automatically.
Make sure that Lombok does not generate any particular constructor for such a type, as it is used automatically by the container to instantiate the object.

Finally, only standard Java Bean properties are considered and binding on static properties is not supported.
====



[[features.external-config.typesafe-configuration-properties.constructor-binding]]
==== Constructor binding
The example in the previous section can be rewritten in an immutable fashion as shown in the following example:

include::code:MyProperties[]

In this setup, the `@ConstructorBinding` annotation is used to indicate that constructor binding should be used.
This means that the binder will expect to find a constructor with the parameters that you wish to have bound.
If you are using Java 16 or later, constructor binding can be used with records.
In this case, unless your record has multiple constructors, there is no need to use `@ConstructorBinding`.

Nested members of a `@ConstructorBinding` class (such as `Security` in the example above) will also be bound through their constructor.

Default values can be specified using `@DefaultValue` and the same conversion service will be applied to coerce the `String` value to the target type of a missing property.
By default, if no properties are bound to `Security`, the `MyProperties` instance will contain a `null` value for `security`.
If you wish you return a non-null instance of `Security` even when no properties are bound to it, you can use an empty `@DefaultValue` annotation to do so:

include::code:nonnull/MyProperties[tag=*]


NOTE: To use constructor binding the class must be enabled using `@EnableConfigurationProperties` or configuration property scanning.
You cannot use constructor binding with beans that are created by the regular Spring mechanisms (for example `@Component` beans, beans created by using `@Bean` methods or beans loaded by using `@Import`)

TIP: If you have more than one constructor for your class you can also use `@ConstructorBinding` directly on the constructor that should be bound.

NOTE: The use of `java.util.Optional` with `@ConfigurationProperties` is not recommended as it is primarily intended for use as a return type.
As such, it is not well-suited to configuration property injection.
For consistency with properties of other types, if you do declare an `Optional` property and it has no value, `null` rather than an empty `Optional` will be bound.



[[features.external-config.typesafe-configuration-properties.enabling-annotated-types]]
==== Enabling @ConfigurationProperties-annotated types
Spring Boot provides infrastructure to bind `@ConfigurationProperties` types and register them as beans.
You can either enable configuration properties on a class-by-class basis or enable configuration property scanning that works in a similar manner to component scanning.

Sometimes, classes annotated with `@ConfigurationProperties` might not be suitable for scanning, for example, if you're developing your own auto-configuration or you want to enable them conditionally.
In these cases, specify the list of types to process using the `@EnableConfigurationProperties` annotation.
This can be done on any `@Configuration` class, as shown in the following example:

include::code:MyConfiguration[]

To use configuration property scanning, add the `@ConfigurationPropertiesScan` annotation to your application.
Typically, it is added to the main application class that is annotated with `@SpringBootApplication` but it can be added to any `@Configuration` class.
By default, scanning will occur from the package of the class that declares the annotation.
If you want to define specific packages to scan, you can do so as shown in the following example:

include::code:MyApplication[]

[NOTE]
====
When the `@ConfigurationProperties` bean is registered using configuration property scanning or through `@EnableConfigurationProperties`, the bean has a conventional name: `<prefix>-<fqn>`, where `<prefix>` is the environment key prefix specified in the `@ConfigurationProperties` annotation and `<fqn>` is the fully qualified name of the bean.
If the annotation does not provide any prefix, only the fully qualified name of the bean is used.

The bean name in the example above is `com.example.app-com.example.app.SomeProperties`.
====

We recommend that `@ConfigurationProperties` only deal with the environment and, in particular, does not inject other beans from the context.
For corner cases, setter injection can be used or any of the `*Aware` interfaces provided by the framework (such as `EnvironmentAware` if you need access to the `Environment`).
If you still want to inject other beans using the constructor, the configuration properties bean must be annotated with `@Component` and use JavaBean-based property binding.



[[features.external-config.typesafe-configuration-properties.using-annotated-types]]
==== Using @ConfigurationProperties-annotated types
This style of configuration works particularly well with the `SpringApplication` external YAML configuration, as shown in the following example:

[source,yaml,indent=0,subs=""verbatim""]
----
	my:
	  service:
	    remote-address: 192.168.1.1
	    security:
	      username: ""admin""
	      roles:
	      - ""USER""
	      - ""ADMIN""
----

To work with `@ConfigurationProperties` beans, you can inject them in the same way as any other bean, as shown in the following example:

include::code:MyService[]

TIP: Using `@ConfigurationProperties` also lets you generate metadata files that can be used by IDEs to offer auto-completion for your own keys.
See the <<configuration-metadata#appendix.configuration-metadata,appendix>> for details.



[[features.external-config.typesafe-configuration-properties.third-party-configuration]]
==== Third-party Configuration
As well as using `@ConfigurationProperties` to annotate a class, you can also use it on public `@Bean` methods.
Doing so can be particularly useful when you want to bind properties to third-party components that are outside of your control.

To configure a bean from the `Environment` properties, add `@ConfigurationProperties` to its bean registration, as shown in the following example:

include::code:ThirdPartyConfiguration[]

Any JavaBean property defined with the `another` prefix is mapped onto that `AnotherComponent` bean in manner similar to the preceding `SomeProperties` example.



[[features.external-config.typesafe-configuration-properties.relaxed-binding]]
==== Relaxed Binding
Spring Boot uses some relaxed rules for binding `Environment` properties to `@ConfigurationProperties` beans, so there does not need to be an exact match between the `Environment` property name and the bean property name.
Common examples where this is useful include dash-separated environment properties (for example, `context-path` binds to `contextPath`), and capitalized environment properties (for example, `PORT` binds to `port`).

As an example, consider the following `@ConfigurationProperties` class:

include::code:MyPersonProperties[]

With the preceding code, the following properties names can all be used:

.relaxed binding
[cols=""1,4""]
|===
| Property | Note

| `my.main-project.person.first-name`
| Kebab case, which is recommended for use in `.properties` and `.yml` files.

| `my.main-project.person.firstName`
| Standard camel case syntax.

| `my.main-project.person.first_name`
| Underscore notation, which is an alternative format for use in `.properties` and `.yml` files.

| `MY_MAINPROJECT_PERSON_FIRSTNAME`
| Upper case format, which is recommended when using system environment variables.
|===

NOTE: The `prefix` value for the annotation _must_ be in kebab case (lowercase and separated by `-`, such as `my.main-project.person`).

.relaxed binding rules per property source
[cols=""2,4,4""]
|===
| Property Source | Simple | List

| Properties Files
| Camel case, kebab case, or underscore notation
| Standard list syntax using `[ ]` or comma-separated values

| YAML Files
| Camel case, kebab case, or underscore notation
| Standard YAML list syntax or comma-separated values

| Environment Variables
| Upper case format with underscore as the delimiter (see <<features#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables>>).
| Numeric values surrounded by underscores (see <<features#features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables>>)

| System properties
| Camel case, kebab case, or underscore notation
| Standard list syntax using `[ ]` or comma-separated values
|===

TIP: We recommend that, when possible, properties are stored in lower-case kebab format, such as `my.person.first-name=Rod`.



[[features.external-config.typesafe-configuration-properties.relaxed-binding.maps]]
===== Binding Maps
When binding to `Map` properties you may need to use a special bracket notation so that the original `key` value is preserved.
If the key is not surrounded by `[]`, any characters that are not alpha-numeric, `-` or `.` are removed.

For example, consider binding the following properties to a `Map<String,String>`:


[source,properties,indent=0,subs=""verbatim"",role=""primary""]
.Properties
----
	my.map.[/key1]=value1
	my.map.[/key2]=value2
	my.map./key3=value3
----

[source,yaml,indent=0,subs=""verbatim"",role=""secondary""]
.Yaml
----
	my:
	  map:
	    ""[/key1]"": ""value1""
	    ""[/key2]"": ""value2""
	    ""/key3"": ""value3""
----

NOTE: For YAML files, the brackets need to be surrounded by quotes for the keys to be parsed properly.

The properties above will bind to a `Map` with `/key1`, `/key2` and `key3` as the keys in the map.
The slash has been removed from `key3` because it was not surrounded by square brackets.

You may also occasionally need to use the bracket notation if your `key` contains a `.` and you are binding to non-scalar value.
For example, binding `a.b=c` to `Map<String, Object>` will return a Map with the entry `{""a""={""b""=""c""}}` whereas `[a.b]=c` will return a Map with the entry `{""a.b""=""c""}`.



[[features.external-config.typesafe-configuration-properties.relaxed-binding.environment-variables]]
===== Binding from Environment Variables
Most operating systems impose strict rules around the names that can be used for environment variables.
For example, Linux shell variables can contain only letters (`a` to `z` or `A` to `Z`), numbers (`0` to `9`) or the underscore character (`_`).
By convention, Unix shell variables will also have their names in UPPERCASE.

Spring Boot's relaxed binding rules are, as much as possible, designed to be compatible with these naming restrictions.

To convert a property name in the canonical-form to an environment variable name you can follow these rules:

* Replace dots (`.`) with underscores (`_`).
* Remove any dashes (`-`).
* Convert to uppercase.

For example, the configuration property `spring.main.log-startup-info` would be an environment variable named `SPRING_MAIN_LOGSTARTUPINFO`.

Environment variables can also be used when binding to object lists.
To bind to a `List`, the element number should be surrounded with underscores in the variable name.

For example, the configuration property `my.service[0].other` would use an environment variable named `MY_SERVICE_0_OTHER`.



[[features.external-config.typesafe-configuration-properties.merging-complex-types]]
==== Merging Complex Types
When lists are configured in more than one place, overriding works by replacing the entire list.

For example, assume a `MyPojo` object with `name` and `description` attributes that are `null` by default.
The following example exposes a list of `MyPojo` objects from `MyProperties`:

include::code:list/MyProperties[]

Consider the following configuration:

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	my:
	  list:
	  - name: ""my name""
	    description: ""my description""
	---
	spring:
	  config:
	    activate:
	      on-profile: ""dev""
	my:
	  list:
	  - name: ""my another name""
----

If the `dev` profile is not active, `MyProperties.list` contains one `MyPojo` entry, as previously defined.
If the `dev` profile is enabled, however, the `list` _still_ contains only one entry (with a name of `my another name` and a description of `null`).
This configuration _does not_ add a second `MyPojo` instance to the list, and it does not merge the items.

When a `List` is specified in multiple profiles, the one with the highest priority (and only that one) is used.
Consider the following example:

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	my:
	  list:
	  - name: ""my name""
	    description: ""my description""
	  - name: ""another name""
	    description: ""another description""
	---
	spring:
	  config:
	    activate:
	      on-profile: ""dev""
	my:
	  list:
	  - name: ""my another name""
----

In the preceding example, if the `dev` profile is active, `MyProperties.list` contains _one_ `MyPojo` entry (with a name of `my another name` and a description of `null`).
For YAML, both comma-separated lists and YAML lists can be used for completely overriding the contents of the list.

For `Map` properties, you can bind with property values drawn from multiple sources.
However, for the same property in multiple sources, the one with the highest priority is used.
The following example exposes a `Map<String, MyPojo>` from `MyProperties`:

include::code:map/MyProperties[]

Consider the following configuration:

[source,yaml,indent=0,subs=""verbatim"",configblocks]
----
	my:
	  map:
	    key1:
	      name: ""my name 1""
	      description: ""my description 1""
	---
	spring:
	  config:
	    activate:
	      on-profile: ""dev""
	my:
	  map:
	    key1:
	      name: ""dev name 1""
	    key2:
	      name: ""dev name 2""
	      description: ""dev description 2""
----

If the `dev` profile is not active, `MyProperties.map` contains one entry with key `key1` (with a name of `my name 1` and a description of `my description 1`).
If the `dev` profile is enabled, however, `map` contains two entries with keys `key1` (with a name of `dev name 1` and a description of `my description 1`) and `key2` (with a name of `dev name 2` and a description of `dev description 2`).

NOTE: The preceding merging rules apply to properties from all property sources, and not just files.



[[features.external-config.typesafe-configuration-properties.conversion]]
==== Properties Conversion
Spring Boot attempts to coerce the external application properties to the right type when it binds to the `@ConfigurationProperties` beans.
If you need custom type conversion, you can provide a `ConversionService` bean (with a bean named `conversionService`) or custom property editors (through a `CustomEditorConfigurer` bean) or custom `Converters` (with bean definitions annotated as `@ConfigurationPropertiesBinding`).

NOTE: As this bean is requested very early during the application lifecycle, make sure to limit the dependencies that your `ConversionService` is using.
Typically, any dependency that you require may not be fully initialized at creation time.
You may want to rename your custom `ConversionService` if it is not required for configuration keys coercion and only rely on custom converters qualified with `@ConfigurationPropertiesBinding`.



[[features.external-config.typesafe-configuration-properties.conversion.durations]]
===== Converting Durations
Spring Boot has dedicated support for expressing durations.
If you expose a `java.time.Duration` property, the following formats in application properties are available:

* A regular `long` representation (using milliseconds as the default unit unless a `@DurationUnit` has been specified)
* The standard ISO-8601 format {java-api}/java/time/Duration.html#parse-java.lang.CharSequence-[used by `java.time.Duration`]
* A more readable format where the value and the unit are coupled (`10s` means 10 seconds)

Consider the following example:

include::code:javabeanbinding/MyProperties[]

To specify a session timeout of 30 seconds, `30`, `PT30S` and `30s` are all equivalent.
A read timeout of 500ms can be specified in any of the following form: `500`, `PT0.5S` and `500ms`.

You can also use any of the supported units.
These are:

* `ns` for nanoseconds
* `us` for microseconds
* `ms` for milliseconds
* `s` for seconds
* `m` for minutes
* `h` for hours
* `d` for days

The default unit is milliseconds and can be overridden using `@DurationUnit` as illustrated in the sample above.

If you prefer to use constructor binding, the same properties can be exposed, as shown in the following example:

include::code:constructorbinding/MyProperties[]


TIP: If you are upgrading a `Long` property, make sure to define the unit (using `@DurationUnit`) if it is not milliseconds.
Doing so gives a transparent upgrade path while supporting a much richer format.



[[features.external-config.typesafe-configuration-properties.conversion.periods]]
===== Converting periods
In addition to durations, Spring Boot can also work with `java.time.Period` type.
The following formats can be used in application properties:

* An regular `int` representation (using days as the default unit unless a `@PeriodUnit` has been specified)
* The standard ISO-8601 format {java-api}/java/time/Period.html#parse-java.lang.CharSequence-[used by `java.time.Period`]
* A simpler format where the value and the unit pairs are coupled (`1y3d` means 1 year and 3 days)

The following units are supported with the simple format:

* `y` for years
* `m` for months
* `w` for weeks
* `d` for days

NOTE: The `java.time.Period` type never actually stores the number of weeks, it is a shortcut that means ""`7 days`"".



[[features.external-config.typesafe-configuration-properties.conversion.data-sizes]]
===== Converting Data Sizes
Spring Framework has a `DataSize` value type that expresses a size in bytes.
If you expose a `DataSize` property, the following formats in application properties are available:

* A regular `long` representation (using bytes as the default unit unless a `@DataSizeUnit` has been specified)
* A more readable format where the value and the unit are coupled (`10MB` means 10 megabytes)

Consider the following example:

include::code:javabeanbinding/MyProperties[]

To specify a buffer size of 10 megabytes, `10` and `10MB` are equivalent.
A size threshold of 256 bytes can be specified as `256` or `256B`.

You can also use any of the supported units.
These are:

* `B` for bytes
* `KB` for kilobytes
* `MB` for megabytes
* `GB` for gigabytes
* `TB` for terabytes

The default unit is bytes and can be overridden using `@DataSizeUnit` as illustrated in the sample above.

If you prefer to use constructor binding, the same properties can be exposed, as shown in the following example:

include::code:constructorbinding/MyProperties[]

TIP: If you are upgrading a `Long` property, make sure to define the unit (using `@DataSizeUnit`) if it is not bytes.
Doing so gives a transparent upgrade path while supporting a much richer format.



[[features.external-config.typesafe-configuration-properties.validation]]
==== @ConfigurationProperties Validation
Spring Boot attempts to validate `@ConfigurationProperties` classes whenever they are annotated with Spring's `@Validated` annotation.
You can use JSR-303 `javax.validation` constraint annotations directly on your configuration class.
To do so, ensure that a compliant JSR-303 implementation is on your classpath and then add constraint annotations to your fields, as shown in the following example:

include::code:MyProperties[]

TIP: You can also trigger validation by annotating the `@Bean` method that creates the configuration properties with `@Validated`.

To ensure that validation is always triggered for nested properties, even when no properties are found, the associated field must be annotated with `@Valid`.
The following example builds on the preceding `MyProperties` example:

include::code:nested/MyProperties[]

You can also add a custom Spring `Validator` by creating a bean definition called `configurationPropertiesValidator`.
The `@Bean` method should be declared `static`.
The configuration properties validator is created very early in the application's lifecycle, and declaring the `@Bean` method as static lets the bean be created without having to instantiate the `@Configuration` class.
Doing so avoids any problems that may be caused by early instantiation.

TIP: The `spring-boot-actuator` module includes an endpoint that exposes all `@ConfigurationProperties` beans.
Point your web browser to `/actuator/configprops` or use the equivalent JMX endpoint.
See the ""<<actuator#actuator.endpoints, Production ready features>>"" section for details.



[[features.external-config.typesafe-configuration-properties.vs-value-annotation]]
==== @ConfigurationProperties vs. @Value
The `@Value` annotation is a core container feature, and it does not provide the same features as type-safe configuration properties.
The following table summarizes the features that are supported by `@ConfigurationProperties` and `@Value`:

[cols=""4,2,2""]
|===
| Feature |`@ConfigurationProperties` |`@Value`

| <<features#features.external-config.typesafe-configuration-properties.relaxed-binding,Relaxed binding>>
| Yes
| Limited (see <<features#features.external-config.typesafe-configuration-properties.vs-value-annotation.note,note below>>)

| <<configuration-metadata#appendix.configuration-metadata,Meta-data support>>
| Yes
| No

| `SpEL` evaluation
| No
| Yes
|===

[[features.external-config.typesafe-configuration-properties.vs-value-annotation.note]]
NOTE: If you do want to use `@Value`, we recommend that you refer to property names using their canonical form (kebab-case using only lowercase letters).
This will allow Spring Boot to use the same logic as it does when relaxed binding `@ConfigurationProperties`.
For example, `@Value(""{demo.item-price}"")` will pick up `demo.item-price` and `demo.itemPrice` forms from the `application.properties` file, as well as `DEMO_ITEMPRICE` from the system environment.
If you used `@Value(""{demo.itemPrice}"")` instead, `demo.item-price` and `DEMO_ITEMPRICE` would not be considered.

If you define a set of configuration keys for your own components, we recommend you group them in a POJO annotated with `@ConfigurationProperties`.
Doing so will provide you with structured, type-safe object that you can inject into your own beans.

`SpEL` expressions from  <<features#features.external-config.files,application property files>> are not processed at time of parsing these files and populating the environment.
However, it is possible to write a `SpEL` expression in `@Value`.
If the value of a property from an application property file is a `SpEL` expression, it will be evaluated when consumed through `@Value`.
",12220,False,2140.9302931183956,median
":spring-data-commons-ref: https://docs.spring.io/spring-data/data-commons/docs/current/reference/html

== Spring Data Cloud Spanner

https://projects.spring.io/spring-data/[Spring Data] is an abstraction for storing and retrieving POJOs in numerous storage technologies.
Spring Cloud GCP adds Spring Data support for https://cloud.google.com/spanner/[Google Cloud Spanner].

Maven coordinates for this module only, using <<getting-started.adoc#_bill_of_materials, Spring Cloud GCP BOM>>:

[source,xml]
----
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-gcp-data-spanner</artifactId>
</dependency>
----

Gradle coordinates:

[source]
----
dependencies {
    compile group: 'org.springframework.cloud', name: 'spring-cloud-gcp-data-spanner'
}
----

We provide a link:../spring-cloud-gcp-starters/spring-cloud-gcp-starter-data-spanner[Spring Boot Starter for Spring Data Spanner], with which you can leverage our recommended auto-configuration setup.
To use the starter, see the coordinates see below.


Maven:

[source,xml]
----
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-gcp-starter-data-spanner</artifactId>
</dependency>
----

Gradle:

[source,subs=""normal""]
----
dependencies {
    compile group: 'org.springframework.cloud', name: 'spring-cloud-gcp-starter-data-spanner'
}
----

This setup takes care of bringing in the latest compatible version of Cloud Java Cloud Spanner libraries as well.

=== Configuration

To setup Spring Data Cloud Spanner, you have to configure the following:

* Setup the connection details to Google Cloud Spanner.
* Enable Spring Data Repositories (optional).

==== Cloud Spanner settings

You can the use link:../spring-cloud-gcp-starters/spring-cloud-gcp-starter-data-spanner[Spring Boot Starter for Spring Data Spanner] to autoconfigure Google Cloud Spanner in your Spring application.
It contains all the necessary setup that makes it easy to authenticate with your Google Cloud project.
The following configuration options are available:

|===
| Name | Description | Required | Default value
| `spring.cloud.gcp.spanner.instance-id` | Cloud Spanner instance to use | Yes |
| `spring.cloud.gcp.spanner.database` |
Cloud Spanner database to use | Yes |
| `spring.cloud.gcp.spanner.project-id` | GCP project ID where the Google Cloud Spanner API is hosted, if different from the one in the <<spring-cloud-gcp-core,Spring Cloud GCP Core Module>>
| No |
| `spring.cloud.gcp.spanner.credentials.location` | OAuth2 credentials for authenticating with the
Google Cloud Spanner API, if different from the ones in the
<<spring-cloud-gcp-core,Spring Cloud GCP Core Module>> | No |
| `spring.cloud.gcp.spanner.credentials.encoded-key` | Base64-encoded OAuth2 credentials for authenticating with the
Google Cloud Spanner API, if different from the ones in the
<<spring-cloud-gcp-core,Spring Cloud GCP Core Module>> | No |
| `spring.cloud.gcp.spanner.credentials.scopes` |
https://developers.google.com/identity/protocols/googlescopes[OAuth2 scope] for Spring Cloud GCP
Cloud Spanner credentials | No | https://www.googleapis.com/auth/spanner.data
| `spring.cloud.gcp.spanner.createInterleavedTableDdlOnDeleteCascade` | If `true`, then schema statements generated by `SpannerSchemaUtils` for tables with interleaved parent-child relationships will be ""ON DELETE CASCADE"".
The schema for the tables will be ""ON DELETE NO ACTION"" if `false`. | No | `true`
| `spring.cloud.gcp.spanner.numRpcChannels` | Number of gRPC channels used to connect to Cloud Spanner | No | 4 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.prefetchChunks` | Number of chunks prefetched by Cloud Spanner for read and query | No | 4 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.minSessions` | Minimum number of sessions maintained in the session pool | No | 0 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.maxSessions` | Maximum number of sessions session pool can have | No | 400 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.maxIdleSessions` | Maximum number of idle sessions session pool will maintain | No | 0 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.writeSessionsFraction` | Fraction of sessions to be kept prepared for write transactions | No | 0.2 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.keepAliveIntervalMinutes` | How long to keep idle sessions alive | No | 30 - Determined by Cloud Spanner client library
| `spring.cloud.gcp.spanner.failIfPoolExhausted` |  If all sessions are in use, fail the request by throwing an exception. Otherwise, by default, block until a session becomes available. | No | `false`
| `spring.cloud.gcp.spanner.emulator.enabled` |  Enables the usage of an emulator. If this is set to true, then you should set the `spring.cloud.gcp.spanner.emulator-host` to the host:port of your locally running emulator instance. | No | `false`
| `spring.cloud.gcp.spanner.emulator-host` |  The host and port of the Spanner emulator; can be overridden to specify connecting to an already-running https://cloud.google.com/spanner/docs/emulator#installing_and_running_the_emulator[Spanner emulator] instance. | No | `localhost:9010`
|===

==== Repository settings

Spring Data Repositories can be configured via the `@EnableSpannerRepositories` annotation on your main `@Configuration` class.
With our Spring Boot Starter for Spring Data Cloud Spanner, `@EnableSpannerRepositories` is automatically added.
It is not required to add it to any other class, unless there is a need to override finer grain configuration parameters provided by https://github.com/spring-cloud/spring-cloud-gcp/blob/master/spring-cloud-gcp-data-spanner/src/main/java/org/springframework/cloud/gcp/data/spanner/repository/config/EnableSpannerRepositories.java[`@EnableSpannerRepositories`].

==== Autoconfiguration

Our Spring Boot autoconfiguration creates the following beans available in the Spring application context:

- an instance of `SpannerTemplate`
- an instance of `SpannerDatabaseAdminTemplate` for generating table schemas from object hierarchies and creating and deleting tables and databases
- an instance of all user-defined repositories extending `SpannerRepository`, `CrudRepository`, `PagingAndSortingRepository`, when repositories are enabled
- an instance of `DatabaseClient` from the Google Cloud Java Client for Spanner, for convenience and lower level API access


=== Object Mapping

Spring Data Cloud Spanner allows you to map domain POJOs to Cloud Spanner tables via annotations:

[source,java]
----
@Table(name = ""traders"")
public class Trader {

	@PrimaryKey
	@Column(name = ""trader_id"")
	String traderId;

	String firstName;

	String lastName;

	@NotMapped
	Double temporaryNumber;
}
----

Spring Data Cloud Spanner will ignore any property annotated with `@NotMapped`.
These properties will not be written to or read from Spanner.

==== Constructors

Simple constructors are supported on POJOs.
The constructor arguments can be a subset of the persistent properties.
Every constructor argument needs to have the same name and type as a persistent property on the entity and the constructor should set the property from the given argument.
Arguments that are not directly set to properties are not supported.

[source,java]
----
@Table(name = ""traders"")
public class Trader {
	@PrimaryKey
	@Column(name = ""trader_id"")
	String traderId;

	String firstName;

	String lastName;

	@NotMapped
	Double temporaryNumber;

	public Trader(String traderId, String firstName) {
	    this.traderId = traderId;
	    this.firstName = firstName;
	}
}
----


==== Table

The `@Table` annotation can provide the name of the Cloud Spanner table that stores instances of the annotated class, one per row.
This annotation is optional, and if not given, the name of the table is inferred from the class name with the first character uncapitalized.

===== SpEL expressions for table names

In some cases, you might want the `@Table` table name to be determined dynamically.
To do that, you can use https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions[Spring Expression Language].

For example:

[source, java]
----

@Table(name = ""trades_#{tableNameSuffix}"")
public class Trade {
	// ...
}
----

The table name will be resolved only if the `tableNameSuffix` value/bean in the Spring application context is defined.
For example, if `tableNameSuffix` has the value ""123"", the table name will resolve to `trades_123`.

==== Primary Keys

For a simple table, you may only have a primary key consisting of a single column.
Even in that case, the `@PrimaryKey` annotation is required.
`@PrimaryKey` identifies the one or more ID properties corresponding to the primary key.

Spanner has first class support for composite primary keys of multiple columns.
You have to annotate all of your POJO's fields that the primary key consists of with `@PrimaryKey` as below:

[source,java]
----
@Table(name = ""trades"")
public class Trade {
	@PrimaryKey(keyOrder = 2)
	@Column(name = ""trade_id"")
	private String tradeId;

	@PrimaryKey(keyOrder = 1)
	@Column(name = ""trader_id"")
	private String traderId;

	private String action;

	private Double price;

	private Double shares;

	private String symbol;
}
----

The `keyOrder` parameter of `@PrimaryKey` identifies the properties corresponding to the primary key columns in order, starting with 1 and increasing consecutively.
Order is important and must reflect the order defined in the Cloud Spanner schema.
In our example the DDL to create the table and its primary key is as follows:

[source,sql]
----
CREATE TABLE trades (
    trader_id STRING(MAX),
    trade_id STRING(MAX),
    action STRING(15),
    symbol STRING(10),
    price FLOAT64,
    shares FLOAT64
) PRIMARY KEY (trader_id, trade_id)
----

Spanner does not have automatic ID generation.
For most use-cases, sequential IDs should be used with caution to avoid creating data hotspots in the system.
Read https://cloud.google.com/spanner/docs/schema-and-data-model#primary_keys[Spanner Primary Keys documentation] for a better understanding of primary keys and recommended practices.


==== Columns

All accessible properties on POJOs are automatically recognized as a Cloud Spanner column.
Column naming is generated by the `PropertyNameFieldNamingStrategy` by default defined on the `SpannerMappingContext` bean.
The `@Column` annotation optionally provides a different column name than that of the property and some other settings:

- `name` is the optional name of the column
- `spannerTypeMaxLength` specifies for `STRING` and `BYTES` columns the maximum length.
This setting is only used when generating DDL schema statements based on domain types.
- `nullable` specifies if the column is created as `NOT NULL`.
This setting is only used when generating DDL schema statements based on domain types.
- `spannerType` is the Cloud Spanner column type you can optionally specify.
If this is not specified then a compatible column type is inferred from the Java property type.
- `spannerCommitTimestamp` is a boolean specifying if this property corresponds to an auto-populated commit timestamp column.
Any value set in this property will be ignored when writing to Cloud Spanner.


==== Embedded Objects

If an object of type `B` is embedded as a property of `A`, then the columns of `B` will be saved in the same Cloud Spanner table as those of `A`.

If `B` has primary key columns, those columns will be included in the primary key of `A`. `B` can also have embedded properties.
Embedding allows reuse of columns between multiple entities, and can be useful for implementing parent-child situations, because Cloud Spanner requires child tables to include the key columns of their parents.

For example:

[source,java]
----
class X {
  @PrimaryKey
  String grandParentId;

  long age;
}

class A {
  @PrimaryKey
  @Embedded
  X grandParent;

  @PrimaryKey(keyOrder = 2)
  String parentId;

  String value;
}

@Table(name = ""items"")
class B {
  @PrimaryKey
  @Embedded
  A parent;

  @PrimaryKey(keyOrder = 2)
  String id;

  @Column(name = ""child_value"")
  String value;
}
----

Entities of `B` can be stored in a table defined as:

[source,sql]
----
CREATE TABLE items (
    grandParentId STRING(MAX),
    parentId STRING(MAX),
    id STRING(MAX),
    value STRING(MAX),
    child_value STRING(MAX),
    age INT64
) PRIMARY KEY (grandParentId, parentId, id)
----

Note that embedded properties' column names must all be unique.


==== Relationships

Spring Data Cloud Spanner supports parent-child relationships using the Cloud Spanner https://cloud.google.com/spanner/docs/schema-and-data-model#creating-interleaved-tables[parent-child interleaved table mechanism].
Cloud Spanner interleaved tables enforce the one-to-many relationship and provide efficient queries and operations on entities of a single domain parent entity.
These relationships can be up to 7 levels deep.
Cloud Spanner also provides automatic cascading delete or enforces the deletion of child entities before parents.

While one-to-one and many-to-many relationships can be implemented in Cloud Spanner and Spring Data Cloud Spanner using constructs of interleaved parent-child tables, only the parent-child relationship is natively supported.
Cloud Spanner does not support the foreign key constraint, though the parent-child key constraint enforces a similar requirement when used with interleaved tables.

For example, the following Java entities:

[source,java]
----
@Table(name = ""Singers"")
class Singer {
  @PrimaryKey
  long SingerId;

  String FirstName;

  String LastName;

  byte[] SingerInfo;

  @Interleaved
  List<Album> albums;
}

@Table(name = ""Albums"")
class Album {
  @PrimaryKey
  long SingerId;

  @PrimaryKey(keyOrder = 2)
  long AlbumId;

  String AlbumTitle;
}
----

These classes can correspond to an existing pair of interleaved tables.
The `@Interleaved` annotation may be applied to `Collection` properties and the inner type is resolved as the child entity type.
The schema needed to create them can also be generated using the `SpannerSchemaUtils` and executed using the `SpannerDatabaseAdminTemplate`:

[source,java]
----

@Autowired
SpannerSchemaUtils schemaUtils;

@Autowired
SpannerDatabaseAdminTemplate databaseAdmin;
...

// Get the create statmenets for all tables in the table structure rooted at Singer
List<String> createStrings = this.schemaUtils.getCreateTableDdlStringsForInterleavedHierarchy(Singer.class);

// Create the tables and also create the database if necessary
this.databaseAdmin.executeDdlStrings(createStrings, true);
----

The `createStrings` list contains table schema statements using column names and types compatible with the provided Java type and any resolved child relationship types contained within based on the configured custom converters.

[source,sql]
----
CREATE TABLE Singers (
  SingerId   INT64 NOT NULL,
  FirstName  STRING(1024),
  LastName   STRING(1024),
  SingerInfo BYTES(MAX),
) PRIMARY KEY (SingerId);

CREATE TABLE Albums (
  SingerId     INT64 NOT NULL,
  AlbumId      INT64 NOT NULL,
  AlbumTitle   STRING(MAX),
) PRIMARY KEY (SingerId, AlbumId),
  INTERLEAVE IN PARENT Singers ON DELETE CASCADE;
----

The `ON DELETE CASCADE` clause indicates that Cloud Spanner will delete all Albums of a singer if the Singer is deleted.
The alternative is `ON DELETE NO ACTION`, where a Singer cannot be deleted until all of its Albums have already been deleted.
When using `SpannerSchemaUtils` to generate the schema strings, the `spring.cloud.gcp.spanner.createInterleavedTableDdlOnDeleteCascade` boolean setting determines if these schema are generated as `ON DELETE CASCADE` for `true` and `ON DELETE NO ACTION` for `false`.

Cloud Spanner restricts these relationships to 7 child layers.
A table may have multiple child tables.

On updating or inserting an object to Cloud Spanner, all of its referenced children objects are also updated or inserted in the same request, respectively.
On read, all of the interleaved child rows are also all read.

===== Lazy Fetch

`@Interleaved` properties are retrieved eagerly by default, but can be fetched lazily for performance in both read and write:

[source,java]
----
@Interleaved(lazy = true)
List<Album> albums;
----

Lazily-fetched interleaved properties are retrieved upon the first interaction with the property.
If a property marked for lazy fetching is never retrieved, then it is also skipped when saving the parent entity.

If used inside a transaction, subsequent operations on lazily-fetched properties use the same transaction context as that of the original parent entity.

===== Declarative Filtering with `@Where`
The `@Where` annotation could be applied to an entity class or to an interleaved property.
This annotation provides an SQL where clause that will be applied at the fetching of interleaved collections or the entity itself.

Let's say we have an `Agreement` with a list of `Participants` which could be assigned to it.
We would like to fetch a list of currently active participants.
For security reasons, all records should remain in the database forever, even if participants become inactive.
That can be easily achieved with the `@Where` annotation, which is demonstrated by this example:

[source, java]
----
@Table(name = ""participants"")
public class Participant {
  //...
  boolean active;
  //...
}

@Table(name = ""agreements"")
public class Agreement {
  //...
  @Interleaved
  @Where(""active = true"")
  List<Participant> participants;
  Person person;
  //...
}
----

==== Supported Types

Spring Data Cloud Spanner natively supports the following types for regular fields but also utilizes custom converters (detailed in following sections) and dozens of pre-defined Spring Data custom converters to handle other common Java types.

Natively supported types:

* `com.google.cloud.ByteArray`
* `com.google.cloud.Date`
* `com.google.cloud.Timestamp`
* `java.lang.Boolean`, `boolean`
* `java.lang.Double`, `double`
* `java.lang.Long`, `long`
* `java.lang.Integer`, `int`
* `java.lang.String`
* `double[]`
* `long[]`
* `boolean[]`
* `java.util.Date`
* `java.util.Instant`
* `java.sql.Date`
* `java.time.LocalDate`
* `java.time.LocalDateTime`


==== Lists

Spanner supports `ARRAY` types for columns.
`ARRAY` columns are mapped to `List` fields in POJOS.

Example:

[source,java]
----
List<Double> curve;
----

The types inside the lists can be any singular property type.

==== Lists of Structs

Cloud Spanner queries can https://cloud.google.com/spanner/docs/query-syntax#using-structs-with-select[construct STRUCT values] that appear as columns in the result.
Cloud Spanner requires STRUCT values appear in ARRAYs at the root level: `SELECT ARRAY(SELECT STRUCT(1 as val1, 2 as val2)) as pair FROM Users`.

Spring Data Cloud Spanner will attempt to read the column STRUCT values into a property that is an `Iterable` of an entity type compatible with the schema of the column STRUCT value.


For the previous array-select example, the following property can be mapped with the constructed `ARRAY<STRUCT>` column: `List<TwoInts> pair;` where the `TwoInts` type is defined:

[source, java]
----
class TwoInts {

  int val1;

  int val2;
}
----

==== Custom types

Custom converters can be used to extend the type support for user defined types.

. Converters need to implement the `org.springframework.core.convert.converter.Converter` interface in both directions.
. The user defined type needs to be mapped to one of the basic types supported by Spanner:

* `com.google.cloud.ByteArray`
* `com.google.cloud.Date`
* `com.google.cloud.Timestamp`
* `java.lang.Boolean`, `boolean`
* `java.lang.Double`, `double`
* `java.lang.Long`, `long`
* `java.lang.String`
* `double[]`
* `long[]`
* `boolean[]`
* `enum` types

. An instance of both Converters needs to be passed to a `ConverterAwareMappingSpannerEntityProcessor`, which then has to be made available as a `@Bean` for `SpannerEntityProcessor`.

For example:

We would like to have a field of type `Person` on our `Trade` POJO:
[source, java]
----

@Table(name = ""trades"")
public class Trade {
  //...
  Person person;
  //...
}
----

Where Person is a simple class:

[source, java]
----
public class Person {

  public String firstName;
  public String lastName;

}
----

We have to define the two converters:

[source, java]
----
  public class PersonWriteConverter implements Converter<Person, String> {

    @Override
    public String convert(Person person) {
      return person.firstName + "" "" + person.lastName;
    }
  }

  public class PersonReadConverter implements Converter<String, Person> {

    @Override
    public Person convert(String s) {
      Person person = new Person();
      person.firstName = s.split("" "")[0];
      person.lastName = s.split("" "")[1];
      return person;
    }
  }
----

That will be configured in our `@Configuration` file:

[source, java]
----
@Configuration
public class ConverterConfiguration {

	@Bean
	public SpannerEntityProcessor spannerEntityProcessor(SpannerMappingContext spannerMappingContext) {
		return new ConverterAwareMappingSpannerEntityProcessor(spannerMappingContext,
				Arrays.asList(new PersonWriteConverter()),
				Arrays.asList(new PersonReadConverter()));
	}
}
----

==== Custom Converter for Struct Array Columns
If a `Converter<Struct, A>` is provided, then properties of type `List<A>` can be used in your entity types.


=== Spanner Operations & Template

`SpannerOperations` and its implementation, `SpannerTemplate`, provides the Template pattern familiar to Spring developers.
It provides:

 - Resource management
 - One-stop-shop to Spanner operations with the Spring Data POJO mapping and conversion features
 - Exception conversion

Using the `autoconfigure` provided by our Spring Boot Starter for Spanner, your Spring application context will contain a fully configured `SpannerTemplate` object that you can easily autowire in your application:

[source,java]
----
@SpringBootApplication
public class SpannerTemplateExample {

	@Autowired
	SpannerTemplate spannerTemplate;

	public void doSomething() {
		this.spannerTemplate.delete(Trade.class, KeySet.all());
		//...
		Trade t = new Trade();
		//...
		this.spannerTemplate.insert(t);
		//...
		List<Trade> tradesByAction = spannerTemplate.findAll(Trade.class);
		//...
	}
}
----

The Template API provides convenience methods for:

- https://cloud.google.com/spanner/docs/reads[Reads], and by providing SpannerReadOptions and
SpannerQueryOptions
   ** Stale read
   ** Read with secondary indices
   ** Read with limits and offsets
   ** Read with sorting
- https://cloud.google.com/spanner/docs/reads#execute_a_query[Queries]
- DML operations (delete, insert, update, upsert)
- Partial reads
   ** You can define a set of columns to be read into your entity
- Partial writes
   ** Persist only a few properties from your entity
- Read-only transactions
- Locking read-write transactions

==== SQL Query

Cloud Spanner has SQL support for running read-only queries.
All the query related methods start with `query` on `SpannerTemplate`.
Using `SpannerTemplate` you can execute SQL queries that map to POJOs:

[source,java]
----
List<Trade> trades = this.spannerTemplate.query(Trade.class, Statement.of(""SELECT * FROM trades""));
----

==== Read

Spanner exposes a https://cloud.google.com/spanner/docs/reads[Read API] for reading single row or multiple rows in a table or in a secondary index.

Using `SpannerTemplate` you can execute reads, for example:

[source,java]
----
List<Trade> trades = this.spannerTemplate.readAll(Trade.class);
----

Main benefit of reads over queries is reading multiple rows of a certain pattern of keys is much easier using the features of the https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/google-cloud-spanner/src/main/java/com/google/cloud/spanner/KeySet.java[`KeySet`] class.


==== Advanced reads

===== Stale read

All reads and queries are *strong reads* by default.
A *strong read* is a read at a current time and is guaranteed to see all data that has been committed up until the start of this read.
An *exact staleness read* is read at a timestamp in the past.
Cloud Spanner allows you to determine how current the data should be when you read data.
With `SpannerTemplate` you can specify the `Timestamp` by setting it on `SpannerQueryOptions` or `SpannerReadOptions` to the appropriate read or query methods:

Reads:

[source,java]
----
// a read with options:
SpannerReadOptions spannerReadOptions = new SpannerReadOptions().setTimestamp(myTimestamp);
List<Trade> trades = this.spannerTemplate.readAll(Trade.class, spannerReadOptions);
----

Queries:

[source,java]
----
// a query with options:
SpannerQueryOptions spannerQueryOptions = new SpannerQueryOptions().setTimestamp(myTimestamp);
List<Trade> trades = this.spannerTemplate.query(Trade.class, Statement.of(""SELECT * FROM trades""), spannerQueryOptions);
----

You can also read with https://cloud.google.com/spanner/docs/timestamp-bounds[*bounded staleness*] by setting `.setTimestampBound(TimestampBound.ofMinReadTimestamp(myTimestamp))` on the query and read options objects.
Bounded staleness lets Cloud Spanner choose any point in time later than or equal to the given timestampBound, but it cannot be used inside transactions.


===== Read from a secondary index

Using a https://cloud.google.com/spanner/docs/secondary-indexes[secondary index] is available for Reads via the Template API and it is also implicitly available via SQL for Queries.

The following shows how to read rows from a table using a https://cloud.google.com/spanner/docs/secondary-indexes[secondary index] simply by setting `index` on `SpannerReadOptions`:

[source,java]
----
SpannerReadOptions spannerReadOptions = new SpannerReadOptions().setIndex(""TradesByTrader"");
List<Trade> trades = this.spannerTemplate.readAll(Trade.class, spannerReadOptions);
----


===== Read with offsets and limits

Limits and offsets are only supported by Queries.
The following will get only the first two rows of the query:

[source,java]
----
SpannerQueryOptions spannerQueryOptions = new SpannerQueryOptions().setLimit(2).setOffset(3);
List<Trade> trades = this.spannerTemplate.query(Trade.class, Statement.of(""SELECT * FROM trades""), spannerQueryOptions);
----

Note that the above is equivalent of executing `SELECT * FROM trades LIMIT 2 OFFSET 3`.

===== Sorting

Reads by keys do not support sorting.
However, queries on the Template API support sorting through standard SQL and also via Spring Data Sort API:

[source,java]
----
List<Trade> trades = this.spannerTemplate.queryAll(Trade.class, Sort.by(""action""));
----

If the provided sorted field name is that of a property of the domain type, then the column name corresponding to that property will be used in the query.
Otherwise, the given field name is assumed to be the name of the column in the Cloud Spanner table.
Sorting on columns of Cloud Spanner types STRING and BYTES can be done while ignoring case:

[source,java]
----
Sort.by(Order.desc(""action"").ignoreCase())
----

===== Partial read

Partial read is only possible when using Queries.
In case the rows returned by the query have fewer columns than the entity that it will be mapped to, Spring Data will map the returned columns only.
This setting also applies to nested structs and their corresponding nested POJO properties.

[source,java]
----
List<Trade> trades = this.spannerTemplate.query(Trade.class, Statement.of(""SELECT action, symbol FROM trades""),
    new SpannerQueryOptions().setAllowMissingResultSetColumns(true));
----

If the setting is set to `false`, then an exception will be thrown if there are missing columns in the query result.

===== Summary of options for Query vs Read

|===
| Feature | Query supports it | Read supports it
| SQL  | yes | no
| Partial read | yes | no
| Limits | yes | no
| Offsets | yes | no
| Secondary index | yes | yes
| Read using index range | no | yes
| Sorting | yes | no
|===

==== Write / Update

The write methods of `SpannerOperations` accept a POJO and writes all of its properties to Spanner.
The corresponding Spanner table and entity metadata is obtained from the given object's actual type.

If a POJO was retrieved from Spanner and its primary key properties values were changed and then written or updated, the operation will occur as if against a row with the new primary key values.
The row with the original primary key values will not be affected.

===== Insert

The `insert` method of `SpannerOperations` accepts a POJO and writes all of its properties to Spanner, which means the operation will fail if a row with the POJO's primary key already exists in the table.

[source, java]
----
Trade t = new Trade();
this.spannerTemplate.insert(t);
----

===== Update

The `update` method of `SpannerOperations` accepts a POJO and writes all of its properties to Spanner, which means the operation will fail if the POJO's primary key does not already exist in the table.

[source, java]
----
// t was retrieved from a previous operation
this.spannerTemplate.update(t);
----

===== Upsert

The `upsert` method of `SpannerOperations` accepts a POJO and writes all of its properties to Spanner using update-or-insert.

[source, java]
----
// t was retrieved from a previous operation or it's new
this.spannerTemplate.upsert(t);
----

===== Partial Update

The update methods of `SpannerOperations` operate by default on all properties within the given object, but also accept `String[]` and `Optional<Set<String>>` of column names.
If the `Optional` of set of column names is empty, then all columns are written to Spanner.
However, if the Optional is occupied by an empty set, then no columns will be written.


[source, java]
----
// t was retrieved from a previous operation or it's new
this.spannerTemplate.update(t, ""symbol"", ""action"");
----

==== DML

DML statements can be executed using `SpannerOperations.executeDmlStatement`.
Inserts, updates, and deletions can affect any number of rows and entities.

You can execute https://cloud.google.com/spanner/docs/dml-partitioned[partitioned DML] updates by using the `executePartitionedDmlStatement` method.
Partitioned DML queries have performance benefits but also have restrictions and cannot be used inside transactions.

==== Transactions

`SpannerOperations` provides methods to run `java.util.Function` objects within a single transaction while making available the read and write methods from `SpannerOperations`.

===== Read/Write Transaction

Read and write transactions are provided by `SpannerOperations` via the `performReadWriteTransaction` method:

[source,java]
----

@Autowired
SpannerOperations mySpannerOperations;

public String doWorkInsideTransaction() {
  return mySpannerOperations.performReadWriteTransaction(
    transActionSpannerOperations -> {
      // Work with transActionSpannerOperations here.
      // It is also a SpannerOperations object.

      return ""transaction completed"";
    }
  );
}
----

The `performReadWriteTransaction` method accepts a `Function` that is provided an instance of a `SpannerOperations` object.
The final returned value and type of the function is determined by the user.
You can use this object just as you would a regular `SpannerOperations` with a few exceptions:

- Its read functionality cannot perform stale reads, because all reads and writes happen at the single point in time of the transaction.
- It cannot perform sub-transactions via `performReadWriteTransaction` or `performReadOnlyTransaction`.

As these read-write transactions are locking, it is recommended that you use the `performReadOnlyTransaction` if your function does not perform any writes.

===== Read-only Transaction

The `performReadOnlyTransaction` method is used to perform read-only transactions using a `SpannerOperations`:

[source,java]
----

@Autowired
SpannerOperations mySpannerOperations;

public String doWorkInsideTransaction() {
  return mySpannerOperations.performReadOnlyTransaction(
    transActionSpannerOperations -> {
      // Work with transActionSpannerOperations here.
      // It is also a SpannerOperations object.

      return ""transaction completed"";
    }
  );
}
----

The `performReadOnlyTransaction` method accepts a `Function` that is provided an instance of a
`SpannerOperations` object.
This method also accepts a `ReadOptions` object, but the only attribute used is the timestamp used to determine the snapshot in time to perform the reads in the transaction.
If the timestamp is not set in the read options the transaction is run against the current state of the database.
The final returned value and type of the function is determined by the user.
You can use this object just as you would a regular `SpannerOperations` with
a few exceptions:

- Its read functionality cannot perform stale reads (other than the staleness set on the entire transaction), because all reads happen at the single point in time of the transaction.
- It cannot perform sub-transactions via `performReadWriteTransaction` or `performReadOnlyTransaction`
- It cannot perform any write operations.

Because read-only transactions are non-locking and can be performed on points in time in the past, these are recommended for functions that do not perform write operations.

===== Declarative Transactions with @Transactional Annotation

This feature requires a bean of `SpannerTransactionManager`, which is provided when using `spring-cloud-gcp-starter-data-spanner`.

`SpannerTemplate` and `SpannerRepository` support running methods with the `@Transactional` https://docs.spring.io/spring/docs/current/spring-framework-reference/data-access.html#transaction-declarative[annotation] as transactions.
If a method annotated with `@Transactional` calls another method also annotated, then both methods will work within the same transaction.
`performReadOnlyTransaction` and `performReadWriteTransaction` cannot be used in `@Transactional` annotated methods because Cloud Spanner does not support transactions within transactions.

==== DML Statements

`SpannerTemplate` supports https://cloud.google.com/spanner/docs/dml-tasks:[DML] `Statements`.
DML statements can also be executed in transactions via `performReadWriteTransaction` or using the `@Transactional` annotation.

=== Repositories

{spring-data-commons-ref}/#repositories[Spring Data Repositories] are a powerful abstraction that can save you a lot of boilerplate code.

For example:

[source,java]
----
public interface TraderRepository extends SpannerRepository<Trader, String> {
}
----

Spring Data generates a working implementation of the specified interface, which can be conveniently autowired into an application.

The `Trader` type parameter to `SpannerRepository` refers to the underlying domain type.
The second type parameter, `String` in this case, refers to the type of the key of the domain type.


For POJOs with a composite primary key, this ID type parameter can be any descendant of `Object[]` compatible with all primary key properties, any descendant of `Iterable`, or `com.google.cloud.spanner.Key`.
If the domain POJO type only has a single primary key column, then the primary key property type can be used or the `Key` type.

For example in case of Trades, that belong to a Trader, `TradeRepository` would look like this:

[source,java]
----
public interface TradeRepository extends SpannerRepository<Trade, String[]> {

}
----

[source,java]
----
public class MyApplication {

	@Autowired
	SpannerTemplate spannerTemplate;

	@Autowired
	StudentRepository studentRepository;

	public void demo() {

		this.tradeRepository.deleteAll();
		String traderId = ""demo_trader"";
		Trade t = new Trade();
		t.symbol = stock;
		t.action = action;
		t.traderId = traderId;
		t.price = 100.0;
		t.shares = 12345.6;
		this.spannerTemplate.insert(t);

		Iterable<Trade> allTrades = this.tradeRepository.findAll();

		int count = this.tradeRepository.countByAction(""BUY"");

	}
}

----

==== CRUD Repository

`CrudRepository` methods work as expected, with one thing Spanner specific: the `save` and `saveAll` methods work as update-or-insert.

==== Paging and Sorting Repository

You can also use `PagingAndSortingRepository` with Spanner Spring Data.
The sorting and pageable `findAll` methods available from this interface operate on the current state of the Spanner database.
As a result, beware that the state of the database (and the results) might change when moving page to page.

==== Spanner Repository

The `SpannerRepository` extends the `PagingAndSortingRepository`, but adds the read-only and the read-write transaction functionality provided by Spanner.
These transactions work very similarly to those of `SpannerOperations`, but is specific to the repository's domain type and provides repository functions instead of template functions.

For example, this is a read-only transaction:

[source,java]
----

@Autowired
SpannerRepository myRepo;

public String doWorkInsideTransaction() {
  return myRepo.performReadOnlyTransaction(
    transactionSpannerRepo -> {
      // Work with the single-transaction transactionSpannerRepo here.
      // This is a SpannerRepository object.

      return ""transaction completed"";
    }
  );
}
----

When creating custom repositories for your own domain types and query methods, you can extend `SpannerRepository` to access Cloud Spanner-specific features as well as all features from `PagingAndSortingRepository` and `CrudRepository`.

=== Query Methods

`SpannerRepository` supports Query Methods.
Described in the following sections, these are methods residing in your custom repository interfaces of which implementations are generated based on their names and annotations.
Query Methods can read, write, and delete entities in Cloud Spanner.
Parameters to these methods can be any Cloud Spanner data type supported directly or via custom configured converters.
Parameters can also be of type `Struct` or POJOs.
If a POJO is given as a parameter, it will be converted to a `Struct` with the same type-conversion logic as used to create write mutations.
Comparisons using Struct parameters are limited to https://cloud.google.com/spanner/docs/data-types#limited-comparisons-for-struct[what is available with Cloud Spanner].


==== Query methods by convention

[source, java]
----
public interface TradeRepository extends SpannerRepository<Trade, String[]> {
    List<Trade> findByAction(String action);

	int countByAction(String action);

	// Named methods are powerful, but can get unwieldy
	List<Trade> findTop3DistinctByActionAndSymbolIgnoreCaseOrTraderIdOrderBySymbolDesc(
  			String action, String symbol, String traderId);
}
----

In the example above, the {spring-data-commons-ref}/#repositories.query-methods[query methods] in `TradeRepository` are generated based on the name of the methods, using the {spring-data-commons-ref}#repositories.query-methods.query-creation[Spring Data Query creation naming convention].

`List<Trade> findByAction(String action)` would translate to a `SELECT * FROM trades WHERE action = ?`.

The function `List<Trade> findTop3DistinctByActionAndSymbolIgnoreCaseOrTraderIdOrderBySymbolDesc(String action, String symbol, String traderId);` will be translated as the equivalent of this SQL query:

[source, sql]
----
SELECT DISTINCT * FROM trades
WHERE ACTION = ? AND LOWER(SYMBOL) = LOWER(?) AND TRADER_ID = ?
ORDER BY SYMBOL DESC
LIMIT 3
----

The following filter options are supported:

* Equality
* Greater than or equals
* Greater than
* Less than or equals
* Less than
* Is null
* Is not null
* Is true
* Is false
* Like a string
* Not like a string
* Contains a string
* Not contains a string
* In
* Not in

Note that the phrase `SymbolIgnoreCase` is translated to `LOWER(SYMBOL) = LOWER(?)` indicating a non-case-sensitive matching.
The `IgnoreCase` phrase may only be appended to fields that correspond to columns of type STRING or BYTES.
The Spring Data ""AllIgnoreCase"" phrase appended at the end of the method name is not supported.

The `Like` or `NotLike` naming conventions:
[source, java]
----
List<Trade> findBySymbolLike(String symbolFragment);
----
The param `symbolFragment` can contain https://cloud.google.com/spanner/docs/functions-and-operators#comparison-operators[wildcard characters] for string matching such as `_` and `%`.

The `Contains` and `NotContains` naming conventions:
[source, java]
----
List<Trade> findBySymbolContains(String symbolFragment);
----
The param `symbolFragment` is a https://cloud.google.com/spanner/docs/functions-and-operators#regexp_contains[regular expression] that is checked for occurrences.

The `In` and `NotIn` keywords must be used with `Iterable` corresponding parameters.

Delete queries are also supported.
For example, query methods such as `deleteByAction` or `removeByAction` delete entities found by `findByAction`.
The delete operation happens in a single transaction.

Delete queries can have the following return types:
* An integer type that is the number of entities deleted
* A collection of entities that were deleted
* `void`

==== Custom SQL/DML query methods

The example above for `List<Trade> fetchByActionNamedQuery(String action)` does not match the {spring-data-commons-ref}#repositories.query-methods.query-creation[Spring Data Query creation naming convention], so we have to map a parametrized Spanner SQL query to it.

The SQL query for the method can be mapped to repository methods in one of two ways:

 * `namedQueries` properties file
 * using the `@Query` annotation

The names of the tags of the SQL correspond to the `@Param` annotated names of the method parameters.

Interleaved properties are loaded eagerly, unless they are annotated with `@Interleaved(lazy = true)`.

Custom SQL query methods can accept a single `Sort` or `Pageable` parameter that is applied on top of the specified custom query.
It is the recommended way to control the sort order of the results, which is not guaranteed by the `ORDER BY` clause in the SQL query.
This is due to the fact that the user-provided query is used as a sub-query, and Cloud Spanner doesn't preserve order in subquery results.

You might want to use `ORDER BY` with `LIMIT` to obtain the top records, according to a specified order.
However, to ensure the correct sort order of the final result set, sort options have to be passed in with a `Pageable`.

[source, java]
----
	@Query(""SELECT * FROM trades"") 
	List<Trade> fetchTrades(Pageable pageable);

	@Query(""SELECT * FROM trades ORDER BY price DESC LIMIT 1"")
 	Trade topTrade(Pageable pageable);

----

This can be used:

[source, java]
----
	List<Trade> customSortedTrades = tradeRepository.fetchTrades(PageRequest
  				.of(2, 2, org.springframework.data.domain.Sort.by(Order.asc(""id""))));
----

The results would be sorted by ""id"" in ascending order.

Your query method can also return non-entity types:
[source, java]
----
  	@Query(""SELECT COUNT(1) FROM trades WHERE action = @action"")
  	int countByActionQuery(String action);

  	@Query(""SELECT EXISTS(SELECT COUNT(1) FROM trades WHERE action = @action)"")
  	boolean existsByActionQuery(String action);

  	@Query(""SELECT action FROM trades WHERE action = @action LIMIT 1"")
  	String getFirstString(@Param(""action"") String action);

  	@Query(""SELECT action FROM trades WHERE action = @action"")
  	List<String> getFirstStringList(@Param(""action"") String action);
----

DML statements can also be executed by query methods, but the only possible return value is a `long` representing the number of affected rows.
The `dmlStatement` boolean setting must be set on `@Query` to indicate that the query method is executed as a DML statement.

[source, java]
----
  	@Query(value = ""DELETE FROM trades WHERE action = @action"", dmlStatement = true)
  	long deleteByActionQuery(String action);
----

===== Query methods with named queries properties

By default, the `namedQueriesLocation` attribute on `@EnableSpannerRepositories` points to the `META-INF/spanner-named-queries.properties` file.
You can specify the query for a method in the properties file by providing the SQL as the value for the ""interface.method"" property:

[source, properties]
----
Trade.fetchByActionNamedQuery=SELECT * FROM trades WHERE trades.action = @tag0
----

[source, java]
----
public interface TradeRepository extends SpannerRepository<Trade, String[]> {
	// This method uses the query from the properties file instead of one generated based on name.
	List<Trade> fetchByActionNamedQuery(@Param(""tag0"") String action);
}
----
===== Query methods with annotation

Using the `@Query` annotation:

[source, java]
----
public interface TradeRepository extends SpannerRepository<Trade, String[]> {
    @Query(""SELECT * FROM trades WHERE trades.action = @tag0"")
    List<Trade> fetchByActionNamedQuery(@Param(""tag0"") String action);
}
----

Table names can be used directly.
For example, ""trades"" in the above example.
Alternatively, table names can be resolved from the `@Table` annotation on domain classes as well.
In this case, the query should refer to table names with fully qualified class names between `:`
characters: `:fully.qualified.ClassName:`.
A full example would look like:

[source, java]
----
@Query(""SELECT * FROM :com.example.Trade: WHERE trades.action = @tag0"")
List<Trade> fetchByActionNamedQuery(String action);
----

This allows table names evaluated with SpEL to be used in custom queries.

SpEL can also be used to provide SQL parameters:

[source, java]
----
@Query(""SELECT * FROM :com.example.Trade: WHERE trades.action = @tag0
  AND price > #{#priceRadius * -1} AND price < #{#priceRadius * 2}"")
List<Trade> fetchByActionNamedQuery(String action, Double priceRadius);
----

When using the `IN` SQL clause, remember to use `IN UNNEST(@iterableParam)` to specify a single `Iterable` parameter.
You can also use a fixed number of singular parameters such as `IN (@stringParam1, @stringParam2)`.

==== Projections
Spring Data Spanner supports {spring-data-commons-ref}/#projections[projections].
You can define projection interfaces based on domain types and add query methods that return them in your repository:

[source, java]
----
public interface TradeProjection {

	String getAction();

	@Value(""#{target.symbol + ' ' + target.action}"")
	String getSymbolAndAction();
}

public interface TradeRepository extends SpannerRepository<Trade, Key> {

	List<Trade> findByTraderId(String traderId);

	List<TradeProjection> findByAction(String action);

	@Query(""SELECT action, symbol FROM trades WHERE action = @action"")
	List<TradeProjection> findByQuery(String action);
}
----

Projections can be provided by name-convention-based query methods as well as by custom SQL queries.
If using custom SQL queries, you can further restrict the columns retrieved from Spanner to just those required by the projection to improve performance.

Properties of projection types defined using SpEL use the fixed name `target` for the underlying domain object.
As a result accessing underlying properties take the form `target.<property-name>`.

==== Empty result handling in repository methods
Java `java.util.Optional` can be used to indicate the potential absence of a return value.

Alternatively, query methods can return the result without a wrapper.
In that case the absence of a query result is indicated by returning `null`.
Repository methods returning collections are guaranteed never to return `null` but rather the corresponding empty collection.

NOTE: You can enable nullability checks. For more details please see https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#null-safety[Spring Framework’s nullability docs].

==== REST Repositories

When running with Spring Boot, repositories can be exposed as REST services by simply adding this dependency to your pom file:
[source,xml]
----
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>
----

If you prefer to configure parameters (such as path), you can use `@RepositoryRestResource` annotation:
[source,java]
----
@RepositoryRestResource(collectionResourceRel = ""trades"", path = ""trades"")
public interface TradeRepository extends SpannerRepository<Trade, Key> {
}
----

NOTE: For classes that have composite keys (multiple `@PrimaryKey` fields), only the `Key` type is supported for the repository ID type.

For example, you can retrieve all `Trade` objects in the repository by using `curl \\http://<server>:<port>/trades`, or any specific trade via `curl \\http://<server>:<port>/trades/<trader_id>,<trade_id>`.

The separator between your primary key components, `id` and `trader_id` in this case, is a comma by default, but can be configured to any string not found in your key values by extending the `SpannerKeyIdConverter` class:

[source,java]
----
@Component
class MySpecialIdConverter extends SpannerKeyIdConverter {

    @Override
    protected String getUrlIdSeparator() {
        return "":"";
    }
}
----

You can also write trades using `curl -XPOST -H""Content-Type: application/json"" -d@test.json \\http://<server>:<port>/trades/` where the file `test.json` holds the JSON representation of a `Trade` object.

=== Database and Schema Admin

Databases and tables inside Spanner instances can be created automatically from `SpannerPersistentEntity` objects:

[source,java]
----
@Autowired
private SpannerSchemaUtils spannerSchemaUtils;

@Autowired
private SpannerDatabaseAdminTemplate spannerDatabaseAdminTemplate;

public void createTable(SpannerPersistentEntity entity) {
	if(!spannerDatabaseAdminTemplate.tableExists(entity.tableName()){

	  // The boolean parameter indicates that the database will be created if it does not exist.
	  spannerDatabaseAdminTemplate.executeDdlStrings(Arrays.asList(
            spannerSchemaUtils.getCreateTableDDLString(entity.getType())), true);
	}
}
----

Schemas can be generated for entire object hierarchies with interleaved relationships and composite keys.

=== Events

Spring Data Cloud Spanner publishes events extending the Spring Framework's `ApplicationEvent` to the context that can be received by `ApplicationListener` beans you register.

[options=""header""]
|===
| Type| Description | Contents
| `AfterReadEvent`|Published immediately after entities are read by key from Cloud Spanner by `SpannerTemplate`| The entities loaded. The read options and key-set originally specified for the load operation.
| `AfterQueryEvent`|Published immediately after entities are read by query from Cloud Spanner by `SpannerTemplate`| The entities loaded. The query options and query statement originally specified for the load operation.
| `BeforeExecuteDmlEvent`|Published immediately before DML statements are executed by `SpannerTemplate`| The DML statement to execute.
| `AfterExecuteDmlEvent`|Published immediately after DML statements are executed by `SpannerTemplate`| The DML statement to execute and the number of rows affected by the operation as reported by Cloud Spanner.
| `BeforeSaveEvent`|Published immediately before upsert/update/insert operations are executed by `SpannerTemplate`| The mutations to be sent to Cloud Spanner, the entities to be saved, and optionally the properties in those entities to save.
| `AfterSaveEvent`|Published immediately after upsert/update/insert operations are executed by `SpannerTemplate`| The mutations sent to Cloud Spanner, the entities to be saved, and optionally the properties in those entities to save.
| `BeforeDeleteEvent`|Published immediately before delete operations are executed by `SpannerTemplate`| The mutations to be sent to Cloud Spanner. The target entities, keys, or entity type originally specified for the delete operation.
| `AfterDeleteEvent`|Published immediately after delete operations are executed by `SpannerTemplate`| The mutations sent to Cloud Spanner. The target entities, keys, or entity type originally specified for the delete operation.
|===


=== Auditing

Spring Data Cloud Spanner supports the `@LastModifiedDate` and `@LastModifiedBy` auditing annotations for properties:

[source,java]
----
@Table
public class SimpleEntity {
    @PrimaryKey
    String id;

    @LastModifiedBy
    String lastUser;

    @LastModifiedDate
    DateTime lastTouched;
}
----

Upon insert, update, or save, these properties will be set automatically by the framework before mutations are generated and saved to Cloud Spanner.

To take advantage of these features, add the `@EnableSpannerAuditing` annotation to your configuration class and provide a bean for an `AuditorAware<A>` implementation where the type `A` is the desired property type annotated by `@LastModifiedBy`:

[source,java]
----
@Configuration
@EnableSpannerAuditing
public class Config {

    @Bean
    public AuditorAware<String> auditorProvider() {
        return () -> Optional.of(""YOUR_USERNAME_HERE"");
    }
}
----

The `AuditorAware` interface contains a single method that supplies the value for fields annotated by `@LastModifiedBy` and can be of any type.
One alternative is to use Spring Security's `User` type:

[source,java]
----
class SpringSecurityAuditorAware implements AuditorAware<User> {

  public Optional<User> getCurrentAuditor() {

    return Optional.ofNullable(SecurityContextHolder.getContext())
			  .map(SecurityContext::getAuthentication)
			  .filter(Authentication::isAuthenticated)
			  .map(Authentication::getPrincipal)
			  .map(User.class::cast);
  }
}
----

You can also set a custom provider for properties annotated `@LastModifiedDate` by providing a bean for `DateTimeProvider` and providing the bean name to `@EnableSpannerAuditing(dateTimeProviderRef = ""customDateTimeProviderBean"")`.

=== Multi-Instance Usage

Your application can be configured to use multiple Cloud Spanner instances or databases by providing a custom bean for `DatabaseIdProvider`.
The default bean uses the instance ID, database name, and project ID options you configured in `application.properties`.

[source,java]
----
    @Bean
    public DatabaseIdProvider databaseIdProvider() {
        // return custom connection options provider
    }
----

The `DatabaseId` given by this provider is used as the target database name and instance of each operation Spring Data Cloud Spanner executes.
By providing a custom implementation of this bean (for example, supplying a thread-local `DatabaseId`), you can direct your application to use multiple instances or databases.

Database administrative operations, such as creating tables using `SpannerDatabaseAdminTemplate`, will also utilize the provided `DatabaseId`.

If you would like to configure every aspect of each connection (such as pool size and retry settings), you can supply a bean for `Supplier<DatabaseClient>`.


=== Cloud Spanner Emulator

The https://cloud.google.com/sdk[Cloud SDK] provides a local, in-memory emulator for Cloud Spanner, which you can use to develop and test your application. As the emulator stores data only in memory, it will not persist data across runs. It is intended to help you use Cloud Spanner for local development and testing, not for production deployments.

In order to set up and start the emulator, you can follow https://cloud.google.com/spanner/docs/emulator[these steps].

This command can be used to create Cloud Spanner instances:

----
$ gcloud spanner instances create <instance-name> --config=emulator-config --description=""<description>"" --nodes=1
----

Once the Spanner emulator is running, ensure that the following properties are set in your `application.properties` of your Spring application:

----
spring.cloud.gcp.spanner.emulator.enabled=true
spring.cloud.gcp.spanner.emulator-host=${EMULATOR_HOSTPORT}
----

=== Sample

A https://github.com/spring-cloud/spring-cloud-gcp/tree/master/spring-cloud-gcp-samples/spring-cloud-gcp-data-spanner-sample[sample application] is available.
",12206,False,2020.2456148658177,median
"//========= Copyright Valve Corporation, All rights reserved. ============//
//
// Purpose: 
//
//=============================================================================//

#include ""cbase.h""
#include ""baseanimating.h""
#include ""studio.h""
#include ""physics.h""
#include ""physics_saverestore.h""
#include ""ai_basenpc.h""
#include ""vphysics/constraints.h""
#include ""datacache/imdlcache.h""
#include ""bone_setup.h""
#include ""physics_prop_ragdoll.h""
#include ""KeyValues.h""
#include ""props.h""
#include ""RagdollBoogie.h""
#include ""AI_Criteria.h""
#include ""ragdoll_shared.h""
#include ""hierarchy.h""
#ifdef MAPBASE
#include ""decals.h""
#endif

// memdbgon must be the last include file in a .cpp file!!!
#include ""tier0/memdbgon.h""

#ifdef MAPBASE
ConVar ragdoll_autointeractions(""ragdoll_autointeractions"", ""1"", FCVAR_NONE, ""Controls whether we should rely on hardcoded keyvalues or automatic flesh checks for ragdoll physgun interactions."");
#define IsBody() VPhysicsIsFlesh()
#endif

//-----------------------------------------------------------------------------
// Forward declarations
//-----------------------------------------------------------------------------
const char *GetMassEquivalent(float flMass);

#define RAGDOLL_VISUALIZE 0

//-----------------------------------------------------------------------------
// ThinkContext
//-----------------------------------------------------------------------------
const char *s_pFadeOutContext = ""RagdollFadeOutContext"";
const char *s_pDebrisContext = ""DebrisContext"";

const float ATTACHED_DAMPING_SCALE = 50.0f;

//-----------------------------------------------------------------------------
// Spawnflags
//-----------------------------------------------------------------------------
#define	SF_RAGDOLLPROP_DEBRIS		0x0004
#define SF_RAGDOLLPROP_USE_LRU_RETIREMENT	0x1000
#define	SF_RAGDOLLPROP_ALLOW_DISSOLVE		0x2000	// Allow this prop to be dissolved
#define	SF_RAGDOLLPROP_MOTIONDISABLED		0x4000
#define	SF_RAGDOLLPROP_ALLOW_STRETCH		0x8000
#define	SF_RAGDOLLPROP_STARTASLEEP			0x10000

//-----------------------------------------------------------------------------
// Networking
//-----------------------------------------------------------------------------
LINK_ENTITY_TO_CLASS( physics_prop_ragdoll, CRagdollProp );
LINK_ENTITY_TO_CLASS( prop_ragdoll, CRagdollProp );
EXTERN_SEND_TABLE(DT_Ragdoll)

IMPLEMENT_SERVERCLASS_ST(CRagdollProp, DT_Ragdoll)
	SendPropArray	(SendPropQAngles(SENDINFO_ARRAY(m_ragAngles), 13, 0 ), m_ragAngles),
	SendPropArray	(SendPropVector(SENDINFO_ARRAY(m_ragPos), -1, SPROP_COORD ), m_ragPos),
	SendPropEHandle(SENDINFO( m_hUnragdoll ) ),
	SendPropFloat(SENDINFO(m_flBlendWeight), 8, SPROP_ROUNDDOWN, 0.0f, 1.0f ),
	SendPropInt(SENDINFO(m_nOverlaySequence), 11),
END_SEND_TABLE()

#define DEFINE_RAGDOLL_ELEMENT( i ) \\
	DEFINE_FIELD( m_ragdoll.list[i].originParentSpace, FIELD_VECTOR ), \\
	DEFINE_PHYSPTR( m_ragdoll.list[i].pObject ), \\
	DEFINE_PHYSPTR( m_ragdoll.list[i].pConstraint ), \\
	DEFINE_FIELD( m_ragdoll.list[i].parentIndex, FIELD_INTEGER )

BEGIN_DATADESC(CRagdollProp)
//					m_ragdoll (custom handling)
	DEFINE_AUTO_ARRAY	( m_ragdoll.boneIndex,	FIELD_INTEGER	),
	DEFINE_AUTO_ARRAY	( m_ragPos,		FIELD_POSITION_VECTOR	),
	DEFINE_AUTO_ARRAY	( m_ragAngles,	FIELD_VECTOR	),
	DEFINE_KEYFIELD(m_anglesOverrideString,	FIELD_STRING, ""angleOverride"" ),
	DEFINE_FIELD( m_lastUpdateTickCount, FIELD_INTEGER ),
	DEFINE_FIELD( m_allAsleep, FIELD_BOOLEAN ),
	DEFINE_FIELD( m_hDamageEntity, FIELD_EHANDLE ),
	DEFINE_FIELD( m_hKiller, FIELD_EHANDLE ),

	DEFINE_KEYFIELD( m_bStartDisabled, FIELD_BOOLEAN, ""StartDisabled"" ),

#ifdef MAPBASE
	DEFINE_INPUTFUNC( FIELD_FLOAT, ""StartRagdollBoogie"", InputStartRadgollBoogie ),
#else
	DEFINE_INPUTFUNC( FIELD_VOID, ""StartRagdollBoogie"", InputStartRadgollBoogie ),
#endif
	DEFINE_INPUTFUNC( FIELD_VOID, ""EnableMotion"", InputEnableMotion ),
	DEFINE_INPUTFUNC( FIELD_VOID, ""DisableMotion"", InputDisableMotion ),
#ifdef MAPBASE
	DEFINE_INPUTFUNC( FIELD_VOID, ""Wake"", InputWake ),
	DEFINE_INPUTFUNC( FIELD_VOID, ""Sleep"", InputSleep ),
#endif
	DEFINE_INPUTFUNC( FIELD_VOID, ""Enable"",		InputTurnOn ),
	DEFINE_INPUTFUNC( FIELD_VOID, ""Disable"",	InputTurnOff ),
	DEFINE_INPUTFUNC( FIELD_FLOAT, ""FadeAndRemove"", InputFadeAndRemove ),

	DEFINE_FIELD( m_hUnragdoll, FIELD_EHANDLE ),
	DEFINE_FIELD( m_bFirstCollisionAfterLaunch, FIELD_BOOLEAN ),

	DEFINE_FIELD( m_flBlendWeight, FIELD_FLOAT ),
	DEFINE_FIELD( m_nOverlaySequence, FIELD_INTEGER ),
	DEFINE_AUTO_ARRAY( m_ragdollMins, FIELD_VECTOR ),
	DEFINE_AUTO_ARRAY( m_ragdollMaxs, FIELD_VECTOR ),

	// Physics Influence
	DEFINE_FIELD( m_hPhysicsAttacker, FIELD_EHANDLE ),
	DEFINE_FIELD( m_flLastPhysicsInfluenceTime, FIELD_TIME ),
	DEFINE_FIELD( m_flFadeOutStartTime, FIELD_TIME ),
	DEFINE_FIELD( m_flFadeTime,	FIELD_FLOAT),
	DEFINE_FIELD( m_strSourceClassName, FIELD_STRING ),
	DEFINE_FIELD( m_bHasBeenPhysgunned, FIELD_BOOLEAN ),

	// think functions
	DEFINE_THINKFUNC( SetDebrisThink ),
	DEFINE_THINKFUNC( ClearFlagsThink ),
	DEFINE_THINKFUNC( FadeOutThink ),

	DEFINE_FIELD( m_ragdoll.listCount, FIELD_INTEGER ),
	DEFINE_FIELD( m_ragdoll.allowStretch, FIELD_BOOLEAN ),
	DEFINE_PHYSPTR( m_ragdoll.pGroup ),
	DEFINE_FIELD( m_flDefaultFadeScale, FIELD_FLOAT ),

	//DEFINE_RAGDOLL_ELEMENT( 0 ),
	DEFINE_RAGDOLL_ELEMENT( 1 ),
	DEFINE_RAGDOLL_ELEMENT( 2 ),
	DEFINE_RAGDOLL_ELEMENT( 3 ),
	DEFINE_RAGDOLL_ELEMENT( 4 ),
	DEFINE_RAGDOLL_ELEMENT( 5 ),
	DEFINE_RAGDOLL_ELEMENT( 6 ),
	DEFINE_RAGDOLL_ELEMENT( 7 ),
	DEFINE_RAGDOLL_ELEMENT( 8 ),
	DEFINE_RAGDOLL_ELEMENT( 9 ),
	DEFINE_RAGDOLL_ELEMENT( 10 ),
	DEFINE_RAGDOLL_ELEMENT( 11 ),
	DEFINE_RAGDOLL_ELEMENT( 12 ),
	DEFINE_RAGDOLL_ELEMENT( 13 ),
	DEFINE_RAGDOLL_ELEMENT( 14 ),
	DEFINE_RAGDOLL_ELEMENT( 15 ),
	DEFINE_RAGDOLL_ELEMENT( 16 ),
	DEFINE_RAGDOLL_ELEMENT( 17 ),
	DEFINE_RAGDOLL_ELEMENT( 18 ),
	DEFINE_RAGDOLL_ELEMENT( 19 ),
	DEFINE_RAGDOLL_ELEMENT( 20 ),
	DEFINE_RAGDOLL_ELEMENT( 21 ),
	DEFINE_RAGDOLL_ELEMENT( 22 ),
	DEFINE_RAGDOLL_ELEMENT( 23 ),

END_DATADESC()

#ifdef MAPBASE_VSCRIPT
BEGIN_ENT_SCRIPTDESC( CRagdollProp, CBaseAnimating, ""Ragdoll physics prop."" )

	DEFINE_SCRIPTFUNC_NAMED( GetSourceClassNameAsCStr, ""GetSourceClassName"", ""Gets the ragdoll's source classname."" )
	DEFINE_SCRIPTFUNC( SetSourceClassName, ""Sets the ragdoll's source classname."" )
	DEFINE_SCRIPTFUNC( HasPhysgunInteraction, ""Checks if the ragdoll has the specified interaction."" )

	DEFINE_SCRIPTFUNC_NAMED( ScriptGetRagdollObject, ""GetRagdollObject"", ""Gets the ragdoll object of the specified index."" )
	DEFINE_SCRIPTFUNC_NAMED( ScriptGetRagdollObjectCount, ""GetRagdollObjectCount"", ""Gets the number of ragdoll objects on this ragdoll."" )

END_SCRIPTDESC()
#endif

//-----------------------------------------------------------------------------
// Disable auto fading under dx7 or when level fades are specified
//-----------------------------------------------------------------------------
void CRagdollProp::DisableAutoFade()
{
	m_flFadeScale = 0;
	m_flDefaultFadeScale = 0;
}

	
void CRagdollProp::Spawn( void )
{
	// Starts out as the default fade scale value
	m_flDefaultFadeScale = m_flFadeScale;

	// NOTE: If this fires, then the assert or the datadesc is wrong!  (see DEFINE_RAGDOLL_ELEMENT above)
	Assert( RAGDOLL_MAX_ELEMENTS == 24 );
	Precache();
	SetModel( STRING( GetModelName() ) );

	CStudioHdr *pStudioHdr = GetModelPtr( );
	if ( pStudioHdr->flags() & STUDIOHDR_FLAGS_NO_FORCED_FADE )
	{
		DisableAutoFade();
	}
	else
	{
		m_flFadeScale = m_flDefaultFadeScale;
	}

	matrix3x4_t pBoneToWorld[MAXSTUDIOBONES];
	BaseClass::SetupBones( pBoneToWorld, BONE_USED_BY_ANYTHING ); // FIXME: shouldn't this be a subset of the bones
	// this is useless info after the initial conditions are set
	SetAbsAngles( vec3_angle );
	int collisionGroup = (m_spawnflags & SF_RAGDOLLPROP_DEBRIS) ? COLLISION_GROUP_DEBRIS : COLLISION_GROUP_NONE;
	bool bWake = (m_spawnflags & SF_RAGDOLLPROP_STARTASLEEP) ? false : true;
	InitRagdoll( vec3_origin, 0, vec3_origin, pBoneToWorld, pBoneToWorld, 0, collisionGroup, true, bWake );
	m_lastUpdateTickCount = 0;
	m_flBlendWeight = 0.0f;
	m_nOverlaySequence = -1;

	// Unless specified, do not allow this to be dissolved
	if ( HasSpawnFlags( SF_RAGDOLLPROP_ALLOW_DISSOLVE ) == false )
	{
		AddEFlags( EFL_NO_DISSOLVE );
	}

	if ( HasSpawnFlags(SF_RAGDOLLPROP_MOTIONDISABLED) )
	{
		DisableMotion();
	}

	if( m_bStartDisabled )
	{
		AddEffects( EF_NODRAW );
	}
}

void CRagdollProp::SetSourceClassName( const char *pClassname )
{
	m_strSourceClassName = MAKE_STRING( pClassname );
}


void CRagdollProp::OnSave( IEntitySaveUtils *pUtils )
{
	if ( !m_ragdoll.listCount )
		return;

	// Don't save ragdoll element 0, base class saves the pointer in 
	// m_pPhysicsObject
	Assert( m_ragdoll.list[0].parentIndex == -1 );
	Assert( m_ragdoll.list[0].pConstraint == NULL );
	Assert( m_ragdoll.list[0].originParentSpace == vec3_origin );
	Assert( m_ragdoll.list[0].pObject != NULL );
	VPhysicsSetObject( NULL );	// squelch a warning message
	VPhysicsSetObject( m_ragdoll.list[0].pObject );	// make sure object zero is saved by CBaseEntity
	BaseClass::OnSave( pUtils );
}

void CRagdollProp::OnRestore()
{
	// rebuild element 0 since it isn't saved
	// NOTE: This breaks the rules - the pointer needs to get fixed in Restore()
	m_ragdoll.list[0].pObject = VPhysicsGetObject();
	m_ragdoll.list[0].parentIndex = -1;
	m_ragdoll.list[0].originParentSpace.Init();

	BaseClass::OnRestore();
	if ( !m_ragdoll.listCount )
		return;

	// JAY: Reset collision relationships
	RagdollSetupCollisions( m_ragdoll, modelinfo->GetVCollide( GetModelIndex() ), GetModelIndex() );
	VPhysicsUpdate( VPhysicsGetObject() );
}

void CRagdollProp::CalcRagdollSize( void )
{
	CollisionProp()->SetSurroundingBoundsType( USE_HITBOXES );
	CollisionProp()->RemoveSolidFlags( FSOLID_FORCE_WORLD_ALIGNED );
}

void CRagdollProp::UpdateOnRemove( void )
{
	for ( int i = 0; i < m_ragdoll.listCount; i++ )
	{
		if ( m_ragdoll.list[i].pObject )
		{
			g_pPhysSaveRestoreManager->ForgetModel( m_ragdoll.list[i].pObject );
		}
	}

	// Set to null so that the destructor's call to DestroyObject won't destroy
	//  m_pObjects[ 0 ] twice since that's the physics object for the prop
	VPhysicsSetObject( NULL );

	RagdollDestroy( m_ragdoll );
	// Chain to base after doing our own cleanup to mimic
	//  destructor unwind order
	BaseClass::UpdateOnRemove();
}

CRagdollProp::CRagdollProp( void )
{
	m_strSourceClassName = NULL_STRING;
	m_anglesOverrideString = NULL_STRING;
	m_ragdoll.listCount = 0;
	Assert( (1<<RAGDOLL_INDEX_BITS) >=RAGDOLL_MAX_ELEMENTS );
	m_allAsleep = false;
	m_flFadeScale = 1;
	m_flDefaultFadeScale = 1;
}

CRagdollProp::~CRagdollProp( void )
{
}

void CRagdollProp::Precache( void )
{
	PrecacheModel( STRING( GetModelName() ) );
	BaseClass::Precache();
}

int CRagdollProp::ObjectCaps()
{
	return BaseClass::ObjectCaps() | FCAP_WCEDIT_POSITION;
}

//-----------------------------------------------------------------------------
// Purpose: 
//-----------------------------------------------------------------------------
void CRagdollProp::InitRagdollAnimation()
{
	m_flAnimTime = gpGlobals->curtime;
	m_flPlaybackRate = 0.0;
	SetCycle( 0 );
	
	// put into ACT_DIERAGDOLL if it exists, otherwise use sequence 0
	int nSequence = SelectWeightedSequence( ACT_DIERAGDOLL );
	if ( nSequence < 0 )
	{
		ResetSequence( 0 );
	}
	else
	{
		ResetSequence( nSequence );
	}
}


//-----------------------------------------------------------------------------
// Response system stuff
//-----------------------------------------------------------------------------
IResponseSystem *CRagdollProp::GetResponseSystem()
{
	extern IResponseSystem *g_pResponseSystem;

	// Just use the general NPC response system; we often come from NPCs after all
	return g_pResponseSystem;
}


//-----------------------------------------------------------------------------
// Purpose: 
//-----------------------------------------------------------------------------
void CRagdollProp::ModifyOrAppendCriteria( AI_CriteriaSet& set )
{
	BaseClass::ModifyOrAppendCriteria( set );

	if ( m_strSourceClassName != NULL_STRING )
	{
		set.RemoveCriteria( ""classname"" );
		set.AppendCriteria( ""classname"", STRING(m_strSourceClassName) );
		set.AppendCriteria( ""ragdoll"", ""1"" );
	}
}


//-----------------------------------------------------------------------------
// Purpose: 
//-----------------------------------------------------------------------------
void CRagdollProp::OnPhysGunPickup( CBasePlayer *pPhysGunUser, PhysGunPickup_t reason )
{
	m_hPhysicsAttacker = pPhysGunUser;
	m_flLastPhysicsInfluenceTime = gpGlobals->curtime;

	// Clear out the classname if we've been physgunned before
	// so that the screams, etc. don't happen. Simulate that the first
	// major punt or throw has been enough to kill him.
	if ( m_bHasBeenPhysgunned )
	{
		m_strSourceClassName = NULL_STRING;
	}
	m_bHasBeenPhysgunned = true;

#ifdef MAPBASE
	if( (ragdoll_autointeractions.GetBool() == true && IsBody()) || HasPhysgunInteraction( ""onpickup"", ""boogie"" ) )
#else
	if( HasPhysgunInteraction( ""onpickup"", ""boogie"" ) )
#endif
	{
		if ( reason == PUNTED_BY_CANNON )
		{
			CRagdollBoogie::Create( this, 150, gpGlobals->curtime, 3.0f, SF_RAGDOLL_BOOGIE_ELECTRICAL );
		}
		else
		{
			CRagdollBoogie::Create( this, 150, gpGlobals->curtime, 2.0f, 0.0f );
		}
	}

	if ( HasSpawnFlags( SF_RAGDOLLPROP_USE_LRU_RETIREMENT ) )
	{
		s_RagdollLRU.MoveToTopOfLRU( this );
	}

	if ( !HasSpawnFlags( SF_PHYSPROP_ENABLE_ON_PHYSCANNON ) )
		return;

	ragdoll_t *pRagdollPhys = GetRagdoll( );
	for ( int j = 0; j < pRagdollPhys->listCount; ++j )
	{
		pRagdollPhys->list[j].pObject->Wake();
		pRagdollPhys->list[j].pObject->EnableMotion( true );
	}
}


//-----------------------------------------------------------------------------
// Purpose: 
//-----------------------------------------------------------------------------
void CRagdollProp::OnPhysGunDrop( CBasePlayer *pPhysGunUser, PhysGunDrop_t Reason )
{
	CDefaultPlayerPickupVPhysics::OnPhysGunDrop( pPhysGunUser, Reason );
	m_hPhysicsAttacker = pPhysGunUser;
	m_flLastPhysicsInfluenceTime = gpGlobals->curtime;

#ifdef MAPBASE
	if( (ragdoll_autointeractions.GetBool() == true && IsBody()) || HasPhysgunInteraction( ""onpickup"", ""boogie"" ) )
#else
	if( HasPhysgunInteraction( ""onpickup"", ""boogie"" ) )
#endif
	{
		CRagdollBoogie::Create( this, 150, gpGlobals->curtime, 3.0f, SF_RAGDOLL_BOOGIE_ELECTRICAL );
	}

	if ( HasSpawnFlags( SF_RAGDOLLPROP_USE_LRU_RETIREMENT ) )
	{
		s_RagdollLRU.MoveToTopOfLRU( this );
	}

	// Make sure it's interactive debris for at most 5 seconds
	if ( GetCollisionGroup() == COLLISION_GROUP_INTERACTIVE_DEBRIS )
	{
		SetContextThink( &CRagdollProp::SetDebrisThink, gpGlobals->curtime + 5, s_pDebrisContext );
	}

	if ( Reason != LAUNCHED_BY_CANNON )
		return;

#ifdef MAPBASE
	if( (ragdoll_autointeractions.GetBool() == true && IsBody()) || HasPhysgunInteraction( ""onlaunch"", ""spin_zaxis"" ) )
#else
	if( HasPhysgunInteraction( ""onlaunch"", ""spin_zaxis"" ) )
#endif
	{
		Vector vecAverageCenter( 0, 0, 0 );

		// Get the average position, apply forces to produce a spin
		int j;
		ragdoll_t *pRagdollPhys = GetRagdoll( );
		for ( j = 0; j < pRagdollPhys->listCount; ++j )
		{
			Vector vecCenter;
			pRagdollPhys->list[j].pObject->GetPosition( &vecCenter, NULL );
			vecAverageCenter += vecCenter;
		}

		vecAverageCenter /= pRagdollPhys->listCount;

		Vector vecZAxis( 0, 0, 1 );
		for ( j = 0; j < pRagdollPhys->listCount; ++j )
		{
			Vector vecDelta;
			pRagdollPhys->list[j].pObject->GetPosition( &vecDelta, NULL );
			vecDelta -= vecAverageCenter;

			Vector vecDir;
			CrossProduct( vecZAxis, vecDelta, vecDir );
			vecDir *= 100;
			pRagdollPhys->list[j].pObject->AddVelocity( &vecDir, NULL );
		}
	}

	PhysSetGameFlags( VPhysicsGetObject(), FVPHYSICS_WAS_THROWN );
	m_bFirstCollisionAfterLaunch = true;
}


//-----------------------------------------------------------------------------
// Physics attacker
//-----------------------------------------------------------------------------
CBasePlayer *CRagdollProp::HasPhysicsAttacker( float dt )
{
	if (gpGlobals->curtime - dt <= m_flLastPhysicsInfluenceTime)
	{
		return m_hPhysicsAttacker;
	}
	return NULL;
}


//-----------------------------------------------------------------------------
// Purpose: 
//-----------------------------------------------------------------------------
void CRagdollProp::VPhysicsCollision( int index, gamevcollisionevent_t *pEvent )
{
	BaseClass::VPhysicsCollision( index, pEvent );

	CBaseEntity *pHitEntity = pEvent->pEntities[!index];
	if ( pHitEntity == this )
		return;

	// Don't take physics damage from whoever's holding him with the physcannon.
	if ( VPhysicsGetObject() && (VPhysicsGetObject()->GetGameFlags() & FVPHYSICS_PLAYER_HELD) )
	{
		if ( pHitEntity && (pHitEntity == HasPhysicsAttacker( FLT_MAX )) )
			return;
	}

	// Don't bother taking damage from the physics attacker
	if ( pHitEntity && HasPhysicsAttacker( 0.5f ) == pHitEntity )
		return;

	if( m_bFirstCollisionAfterLaunch )
	{
		HandleFirstCollisionInteractions( index, pEvent );
	}
	
	if ( m_takedamage != DAMAGE_NO )
	{
		int damageType = 0;
		float damage = CalculateDefaultPhysicsDamage( index, pEvent, 1.0f, true, damageType );
		if ( damage > 0 )
		{
			// Take extra damage after we're punted by the physcannon
			if ( m_bFirstCollisionAfterLaunch )
			{
				damage *= 10;
			}

			CBaseEntity *pHitEntity = pEvent->pEntities[!index];
			if ( !pHitEntity )
			{
				// hit world
				pHitEntity = GetContainingEntity( INDEXENT(0) );
			}
			Vector damagePos;
			pEvent->pInternalData->GetContactPoint( damagePos );
			Vector damageForce = pEvent->postVelocity[index] * pEvent->pObjects[index]->GetMass();
			if ( damageForce == vec3_origin )
			{
				// This can happen if this entity is motion disabled, and can't move.
				// Use the velocity of the entity that hit us instead.
				damageForce = pEvent->postVelocity[!index] * pEvent->pObjects[!index]->GetMass();
			}

			// FIXME: this doesn't pass in who is responsible if some other entity ""caused"" this collision
			PhysCallbackDamage( this, CTakeDamageInfo( pHitEntity, pHitEntity, damageForce, damagePos, damage, damageType ), *pEvent, index );
		}
	}

	if ( m_bFirstCollisionAfterLaunch )
	{
		// Setup the think function to remove the flags
		SetThink( &CRagdollProp::ClearFlagsThink );
		SetNextThink( gpGlobals->curtime );
	}
}


//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
bool CRagdollProp::HasPhysgunInteraction( const char *pszKeyName, const char *pszValue )
{
	KeyValues *modelKeyValues = new KeyValues("""");
	if ( modelKeyValues->LoadFromBuffer( modelinfo->GetModelName( GetModel() ), modelinfo->GetModelKeyValueText( GetModel() ) ) )
	{
		KeyValues *pkvPropData = modelKeyValues->FindKey(""physgun_interactions"");
		if ( pkvPropData )
		{
			char const *pszBase = pkvPropData->GetString( pszKeyName );

			if ( pszBase && pszBase[0] && !stricmp( pszBase, pszValue ) )
			{
				modelKeyValues->deleteThis();
				return true;
			}
		}
	}

	modelKeyValues->deleteThis();
	return false;
}


//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
void CRagdollProp::HandleFirstCollisionInteractions( int index, gamevcollisionevent_t *pEvent )
{
	IPhysicsObject *pObj = VPhysicsGetObject();
	if ( !pObj)
		return;

	if( HasPhysgunInteraction( ""onfirstimpact"", ""break"" ) )
	{
		// Looks like it's best to break by having the object damage itself. 
		CTakeDamageInfo info;

		info.SetDamage( m_iHealth );
		info.SetAttacker( this );
		info.SetInflictor( this );
		info.SetDamageType( DMG_GENERIC );

		Vector vecPosition;
		Vector vecVelocity;

		VPhysicsGetObject()->GetVelocity( &vecVelocity, NULL );
		VPhysicsGetObject()->GetPosition( &vecPosition, NULL );

		info.SetDamageForce( vecVelocity );
		info.SetDamagePosition( vecPosition );

		TakeDamage( info );
		return;
	}

	if( HasPhysgunInteraction( ""onfirstimpact"", ""paintsplat"" ) )
	{
		IPhysicsObject *pObj = VPhysicsGetObject();
 
		Vector vecPos;
		pObj->GetPosition( &vecPos, NULL );
 
		trace_t tr;
		UTIL_TraceLine( vecPos, vecPos + pEvent->preVelocity[0] * 1.5, MASK_SHOT, this, COLLISION_GROUP_NONE, &tr );

		switch( random->RandomInt( 1, 3 ) )
		{
		case 1:
			UTIL_DecalTrace( &tr, ""PaintSplatBlue"" );
			break;

		case 2:
			UTIL_DecalTrace( &tr, ""PaintSplatGreen"" );
			break;

		case 3:
			UTIL_DecalTrace( &tr, ""PaintSplatPink"" );
			break;
		}
	}

#ifdef MAPBASE
	int iVPhysicsFlesh = VPhysicsGetFlesh();
	bool bRagdollAutoInt = (ragdoll_autointeractions.GetBool() == true && iVPhysicsFlesh);
	bool bAlienBloodSplat = HasPhysgunInteraction( ""onfirstimpact"", ""alienbloodsplat"" );
	if (bRagdollAutoInt && !bAlienBloodSplat)
	{
		// Alien blood?
		bAlienBloodSplat = (iVPhysicsFlesh == CHAR_TEX_ALIENFLESH || iVPhysicsFlesh == CHAR_TEX_ANTLION);
	}

	if( bRagdollAutoInt || bAlienBloodSplat || HasPhysgunInteraction( ""onfirstimpact"", ""bloodsplat"" ) )
#else
	bool bAlienBloodSplat = HasPhysgunInteraction( ""onfirstimpact"", ""alienbloodsplat"" );
	if( bAlienBloodSplat || HasPhysgunInteraction( ""onfirstimpact"", ""bloodsplat"" ) )
#endif
	{
		IPhysicsObject *pObj = VPhysicsGetObject();
 
		Vector vecPos;
		pObj->GetPosition( &vecPos, NULL );
 
		trace_t tr;
		UTIL_TraceLine( vecPos, vecPos + pEvent->preVelocity[0] * 1.5, MASK_SHOT, this, COLLISION_GROUP_NONE, &tr );

		UTIL_BloodDecalTrace( &tr, bAlienBloodSplat ? BLOOD_COLOR_GREEN : BLOOD_COLOR_RED );
	}
}


//-----------------------------------------------------------------------------
// Purpose: 
//-----------------------------------------------------------------------------
void CRagdollProp::ClearFlagsThink( void )
{
	PhysClearGameFlags( VPhysicsGetObject(), FVPHYSICS_WAS_THROWN );
	m_bFirstCollisionAfterLaunch = false;
	SetThink( NULL );
}


//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
AngularImpulse CRagdollProp::PhysGunLaunchAngularImpulse()
{
#ifdef MAPBASE
	if( (ragdoll_autointeractions.GetBool() == true && IsBody()) || HasPhysgunInteraction( ""onlaunch"", ""spin_zaxis"" ) )
#else
	if( HasPhysgunInteraction( ""onlaunch"", ""spin_zaxis"" ) )
#endif
	{
		// Don't add in random angular impulse if this object is supposed to spin in a specific way.
		AngularImpulse ang( 0, 0, 0 );
		return ang;
	}

	return CDefaultPlayerPickupVPhysics::PhysGunLaunchAngularImpulse();
}


//-----------------------------------------------------------------------------
// Purpose: 
// Input  : activity - 
//-----------------------------------------------------------------------------
void CRagdollProp::SetOverlaySequence( Activity activity )
{
	int seq = SelectWeightedSequence( activity );
	if ( seq < 0 )
	{
		m_nOverlaySequence = -1;
	}
	else
	{
		m_nOverlaySequence = seq;
	}
}

void CRagdollProp::InitRagdoll( const Vector &forceVector, int forceBone, const Vector &forcePos, matrix3x4_t *pPrevBones, matrix3x4_t *pBoneToWorld, float dt, int collisionGroup, bool activateRagdoll, bool bWakeRagdoll )
{
	SetCollisionGroup( collisionGroup );

	// Make sure it's interactive debris for at most 5 seconds
	if ( collisionGroup == COLLISION_GROUP_INTERACTIVE_DEBRIS )
	{
		SetContextThink( &CRagdollProp::SetDebrisThink, gpGlobals->curtime + 5, s_pDebrisContext );
	}

	SetMoveType( MOVETYPE_VPHYSICS );
	SetSolid( SOLID_VPHYSICS );
	AddSolidFlags( FSOLID_CUSTOMRAYTEST | FSOLID_CUSTOMBOXTEST );
	m_takedamage = DAMAGE_EVENTS_ONLY;

	ragdollparams_t params;
	params.pGameData = static_cast<void *>( static_cast<CBaseEntity *>(this) );
	params.modelIndex = GetModelIndex();
	params.pCollide = modelinfo->GetVCollide( params.modelIndex );
	params.pStudioHdr = GetModelPtr();
	params.forceVector = forceVector;
	params.forceBoneIndex = forceBone;
	params.forcePosition = forcePos;
	params.pCurrentBones = pBoneToWorld;
	params.jointFrictionScale = 1.0;
	params.allowStretch = HasSpawnFlags(SF_RAGDOLLPROP_ALLOW_STRETCH);
	params.fixedConstraints = false;
	RagdollCreate( m_ragdoll, params, physenv );
	RagdollApplyAnimationAsVelocity( m_ragdoll, pPrevBones, pBoneToWorld, dt );
	if ( m_anglesOverrideString != NULL_STRING && Q_strlen(m_anglesOverrideString.ToCStr()) > 0 )
	{
		char szToken[2048];
		const char *pStr = nexttoken(szToken, STRING(m_anglesOverrideString), ',', sizeof(szToken));
		// anglesOverride is index,angles,index,angles (e.g. ""1, 22.5 123.0 0.0, 2, 0 0 0, 3, 0 0 180.0"")
		while ( szToken[0] != 0 )
		{
			int objectIndex = atoi(szToken);
			// sanity check to make sure this token is an integer
			Assert( atof(szToken) == ((float)objectIndex) );
			pStr = nexttoken(szToken, pStr, ',', sizeof(szToken));
			Assert( szToken[0] );
			if ( objectIndex >= m_ragdoll.listCount )
			{
				Warning(""Bad ragdoll pose in entity %s, model (%s) at %s, model changed?\\n"", GetDebugName(), GetModelName().ToCStr(), VecToString(GetAbsOrigin()) );
			}
			else if ( szToken[0] != 0 )
			{
				QAngle angles;
				Assert( objectIndex >= 0 && objectIndex < RAGDOLL_MAX_ELEMENTS );
				UTIL_StringToVector( angles.Base(), szToken );
				int boneIndex = m_ragdoll.boneIndex[objectIndex];
				AngleMatrix( angles, pBoneToWorld[boneIndex] );
				const ragdollelement_t &element = m_ragdoll.list[objectIndex];
				Vector out;
				if ( element.parentIndex >= 0 )
				{
					int parentBoneIndex = m_ragdoll.boneIndex[element.parentIndex];
					VectorTransform( element.originParentSpace, pBoneToWorld[parentBoneIndex], out );
				}
				else
				{
					out = GetAbsOrigin();
				}
				MatrixSetColumn( out, 3, pBoneToWorld[boneIndex] );
				element.pObject->SetPositionMatrix( pBoneToWorld[boneIndex], true );
			}
			pStr = nexttoken(szToken, pStr, ',', sizeof(szToken));
		}
	}

	if ( activateRagdoll )
	{
		MEM_ALLOC_CREDIT();
		RagdollActivate( m_ragdoll, params.pCollide, GetModelIndex(), bWakeRagdoll );
	}

	for ( int i = 0; i < m_ragdoll.listCount; i++ )
	{
		UpdateNetworkDataFromVPhysics( m_ragdoll.list[i].pObject, i );
		g_pPhysSaveRestoreManager->AssociateModel( m_ragdoll.list[i].pObject, GetModelIndex() );
		physcollision->CollideGetAABB( &m_ragdollMins[i], &m_ragdollMaxs[i], m_ragdoll.list[i].pObject->GetCollide(), vec3_origin, vec3_angle );
	}
	VPhysicsSetObject( m_ragdoll.list[0].pObject );

	CalcRagdollSize();
}

void CRagdollProp::SetDebrisThink()
{
	SetCollisionGroup( COLLISION_GROUP_DEBRIS );
	RecheckCollisionFilter();
}

void CRagdollProp::SetDamageEntity( CBaseEntity *pEntity )
{
	// Damage passing
	m_hDamageEntity = pEntity;

	// Set our takedamage to match it
	if ( pEntity )
	{
		m_takedamage = pEntity->m_takedamage;
	}
	else
	{
		m_takedamage = DAMAGE_EVENTS_ONLY;
	}
}

//-----------------------------------------------------------------------------
// Purpose: 
//-----------------------------------------------------------------------------
int	CRagdollProp::OnTakeDamage( const CTakeDamageInfo &info )
{
	// If we have a damage entity, we want to pass damage to it. Add the
	// Never Ragdoll flag, on the assumption that if the entity dies, we'll
	// actually be taking the role of its ragdoll.
	if ( m_hDamageEntity.Get() )
	{
		CTakeDamageInfo subInfo = info;
		subInfo.AddDamageType( DMG_REMOVENORAGDOLL );
		return m_hDamageEntity->OnTakeDamage( subInfo );
	}

	return BaseClass::OnTakeDamage( info );
}

//-----------------------------------------------------------------------------
// Purpose: Force all the ragdoll's bone's physics objects to recheck their collision filters
//-----------------------------------------------------------------------------
void CRagdollProp::RecheckCollisionFilter( void )
{
	for ( int i = 0; i < m_ragdoll.listCount; i++ )
	{
		m_ragdoll.list[i].pObject->RecheckCollisionFilter();
	}
}


void CRagdollProp::TraceAttack( const CTakeDamageInfo &info, const Vector &dir, trace_t *ptr, CDmgAccumulator *pAccumulator )
{
	if ( ptr->physicsbone >= 0 && ptr->physicsbone < m_ragdoll.listCount )
	{
		VPhysicsSwapObject( m_ragdoll.list[ptr->physicsbone].pObject );
	}
	BaseClass::TraceAttack( info, dir, ptr, pAccumulator );
}

void CRagdollProp::SetupBones( matrix3x4_t *pBoneToWorld, int boneMask )
{
	// no ragdoll, fall through to base class 
	if ( !m_ragdoll.listCount )
	{
		BaseClass::SetupBones( pBoneToWorld, boneMask );
		return;
	}

	// Not really ideal, but it'll work for now
	UpdateModelScale();

	MDLCACHE_CRITICAL_SECTION();
	CStudioHdr *pStudioHdr = GetModelPtr( );
	bool sim[MAXSTUDIOBONES];
	memset( sim, 0, pStudioHdr->numbones() );

	int i;

	CBoneAccessor boneaccessor( pBoneToWorld );
	for ( i = 0; i < m_ragdoll.listCount; i++ )
	{
		// during restore this may be NULL
		if ( !m_ragdoll.list[i].pObject )
			continue;

		if ( RagdollGetBoneMatrix( m_ragdoll, boneaccessor, i ) )
		{
			sim[m_ragdoll.boneIndex[i]] = true;
		}
	}

	mstudiobone_t *pbones = pStudioHdr->pBone( 0 );
	for ( i = 0; i < pStudioHdr->numbones(); i++ )
	{
		if ( sim[i] )
			continue;
		
		if ( !(pStudioHdr->boneFlags(i) & boneMask) )
			continue;

		matrix3x4_t matBoneLocal;
		AngleMatrix( pbones[i].rot, pbones[i].pos, matBoneLocal );
		ConcatTransforms( pBoneToWorld[pbones[i].parent], matBoneLocal, pBoneToWorld[i]);
	}
}

bool CRagdollProp::TestCollision( const Ray_t &ray, unsigned int mask, trace_t& trace )
{
#if 0
	// PERFORMANCE: Use hitboxes for rays instead of vcollides if this is a performance problem
	if ( ray.m_IsRay )
	{
		return BaseClass::TestCollision( ray, mask, trace );
	}
#endif

	CStudioHdr *pStudioHdr = GetModelPtr( );
	if (!pStudioHdr)
		return false;

	// Just iterate all of the elements and trace the box against each one.
	// NOTE: This is pretty expensive for small/dense characters
	trace_t tr;
	for ( int i = 0; i < m_ragdoll.listCount; i++ )
	{
		Vector position;
		QAngle angles;

		if( m_ragdoll.list[i].pObject )
		{
			m_ragdoll.list[i].pObject->GetPosition( &position, &angles );
			physcollision->TraceBox( ray, m_ragdoll.list[i].pObject->GetCollide(), position, angles, &tr );

			if ( tr.fraction < trace.fraction )
			{
				tr.physicsbone = i;
				tr.surface.surfaceProps = m_ragdoll.list[i].pObject->GetMaterialIndex();
				trace = tr;
			}
		}
		else
		{
			DevWarning(""Bogus object in Ragdoll Prop's ragdoll list!\\n"");
		}
	}

	if ( trace.fraction >= 1 )
	{
		return false;
	}

	return true;
}


void CRagdollProp::Teleport( const Vector *newPosition, const QAngle *newAngles, const Vector *newVelocity )
{
	// newAngles is a relative transform for the entity
	// But a ragdoll entity has identity orientation by design
	// so we compute a relative transform here based on the previous transform
	matrix3x4_t startMatrixInv;
	MatrixInvert( EntityToWorldTransform(), startMatrixInv );
	matrix3x4_t endMatrix;
	MatrixCopy( EntityToWorldTransform(), endMatrix );
	if ( newAngles )
	{
		AngleMatrix( *newAngles, endMatrix );
	}
	if ( newPosition )
	{
		PositionMatrix( *newPosition, endMatrix );
	}
	// now endMatrix is the refernce matrix for the entity at the target position
	matrix3x4_t xform;
	ConcatTransforms( endMatrix, startMatrixInv, xform );
	// now xform is the relative transform the entity must undergo

	// we need to call the base class and it will teleport our vphysics object, 
	// so set object 0 up and compute the origin/angles for its new position (base implementation has side effects)
	VPhysicsSwapObject( m_ragdoll.list[0].pObject );
	matrix3x4_t obj0source, obj0Target;
	m_ragdoll.list[0].pObject->GetPositionMatrix( &obj0source );
	ConcatTransforms( xform, obj0source, obj0Target );
	Vector obj0Pos;
	QAngle obj0Angles;
	MatrixAngles( obj0Target, obj0Angles, obj0Pos );
	BaseClass::Teleport( &obj0Pos, &obj0Angles, newVelocity );
	
	for ( int i = 1; i < m_ragdoll.listCount; i++ )
	{
		matrix3x4_t matrix, newMatrix;
		m_ragdoll.list[i].pObject->GetPositionMatrix( &matrix );
		ConcatTransforms( xform, matrix, newMatrix );
		m_ragdoll.list[i].pObject->SetPositionMatrix( newMatrix, true );
		UpdateNetworkDataFromVPhysics( m_ragdoll.list[i].pObject, i );
	}
	// fixup/relink object 0
	UpdateNetworkDataFromVPhysics( m_ragdoll.list[0].pObject, 0 );
}

void CRagdollProp::VPhysicsUpdate( IPhysicsObject *pPhysics )
{
	if ( m_lastUpdateTickCount == (unsigned int)gpGlobals->tickcount )
		return;

	m_lastUpdateTickCount = gpGlobals->tickcount;
	//NetworkStateChanged();

	matrix3x4_t boneToWorld[MAXSTUDIOBONES];
	QAngle angles;
	Vector surroundingMins, surroundingMaxs;

	int i;
	for ( i = 0; i < m_ragdoll.listCount; i++ )
	{
		CBoneAccessor boneaccessor( boneToWorld );
		if ( RagdollGetBoneMatrix( m_ragdoll, boneaccessor, i ) )
		{
			Vector vNewPos;
			MatrixAngles( boneToWorld[m_ragdoll.boneIndex[i]], angles, vNewPos );
			m_ragPos.Set( i, vNewPos );
			m_ragAngles.Set( i, angles );
		}
		else
		{
			m_ragPos.GetForModify(i).Init();
			m_ragAngles.GetForModify(i).Init();
		}
	}

	// BUGBUG: Use the ragdollmins/maxs to do this instead of the collides
	m_allAsleep = RagdollIsAsleep( m_ragdoll );

	// Don't scream after you've come to rest
	if ( m_allAsleep )
	{
		m_strSourceClassName = NULL_STRING;
	}
	else
	{
		if ( m_ragdoll.pGroup->IsInErrorState() )
		{
			RagdollSolveSeparation( m_ragdoll, this );
		}
	}
	
	// Interactive debris converts back to debris when it comes to rest
	if ( m_allAsleep && GetCollisionGroup() == COLLISION_GROUP_INTERACTIVE_DEBRIS )
	{
		SetCollisionGroup( COLLISION_GROUP_DEBRIS );
		RecheckCollisionFilter();
		SetContextThink( NULL, gpGlobals->curtime, s_pDebrisContext );
	}

	Vector vecFullMins, vecFullMaxs;
	vecFullMins = m_ragPos[0];
	vecFullMaxs = m_ragPos[0];
	for ( i = 0; i < m_ragdoll.listCount; i++ )
	{
		Vector mins, maxs;
		matrix3x4_t update;
		if ( !m_ragdoll.list[i].pObject )
		{
			m_ragdollMins[i].Init();
			m_ragdollMaxs[i].Init();
			continue;
		}
		m_ragdoll.list[i].pObject->GetPositionMatrix( &update );
		TransformAABB( update, m_ragdollMins[i], m_ragdollMaxs[i], mins, maxs );
		for ( int j = 0; j < 3; j++ )
		{
			if ( mins[j] < vecFullMins[j] )
			{
				vecFullMins[j] = mins[j];
			}
			if ( maxs[j] > vecFullMaxs[j] )
			{
				vecFullMaxs[j] = maxs[j];
			}
		}
	}

	SetAbsOrigin( m_ragPos[0] );
	SetAbsAngles( vec3_angle );
	const Vector &vecOrigin = CollisionProp()->GetCollisionOrigin();
	CollisionProp()->AddSolidFlags( FSOLID_FORCE_WORLD_ALIGNED );
	CollisionProp()->SetSurroundingBoundsType( USE_COLLISION_BOUNDS_NEVER_VPHYSICS );
	SetCollisionBounds( vecFullMins - vecOrigin, vecFullMaxs - vecOrigin );
	CollisionProp()->MarkSurroundingBoundsDirty();

	PhysicsTouchTriggers();
}

int CRagdollProp::VPhysicsGetObjectList( IPhysicsObject **pList, int listMax )
{
	for ( int i = 0; i < m_ragdoll.listCount; i++ )
	{
		if ( i < listMax )
		{
			pList[i] = m_ragdoll.list[i].pObject;
		}
	}

	return m_ragdoll.listCount;
}

#ifdef MAPBASE
int CRagdollProp::VPhysicsGetFlesh()
{
	IPhysicsObject *pList[VPHYSICS_MAX_OBJECT_LIST_COUNT];
	int count = VPhysicsGetObjectList( pList, ARRAYSIZE(pList) );
	for ( int i = 0; i < count; i++ )
	{
		int material = pList[i]->GetMaterialIndex();
		const surfacedata_t *pSurfaceData = physprops->GetSurfaceData( material );
		// Is flesh ?, don't allow pickup
		if ( pSurfaceData->game.material == CHAR_TEX_ANTLION || pSurfaceData->game.material == CHAR_TEX_FLESH || pSurfaceData->game.material == CHAR_TEX_BLOODYFLESH || pSurfaceData->game.material == CHAR_TEX_ALIENFLESH )
			return pSurfaceData->game.material;
	}
	return 0;
}
#endif

void CRagdollProp::UpdateNetworkDataFromVPhysics( IPhysicsObject *pPhysics, int index )
{
	Assert(index < m_ragdoll.listCount);

	QAngle angles;
	Vector vPos;
	m_ragdoll.list[index].pObject->GetPosition( &vPos, &angles );
	m_ragPos.Set( index, vPos );
	m_ragAngles.Set( index, angles );

	// move/relink if root moved
	if ( index == 0 )
	{
		SetAbsOrigin( m_ragPos[0] );
		PhysicsTouchTriggers();
	}
}


//-----------------------------------------------------------------------------
// Fade out due to the LRU telling it do
//-----------------------------------------------------------------------------
#define FADE_OUT_LENGTH 0.5f

void CRagdollProp::FadeOut( float flDelay, float fadeTime ) 
{
	if ( IsFading() )
		return;

	m_flFadeTime = ( fadeTime == -1 ) ? FADE_OUT_LENGTH : fadeTime;

	m_flFadeOutStartTime = gpGlobals->curtime + flDelay;
	m_flFadeScale = 0;
	SetContextThink( &CRagdollProp::FadeOutThink, gpGlobals->curtime + flDelay + 0.01f, s_pFadeOutContext );
}

bool CRagdollProp::IsFading()
{
	return ( GetNextThink( s_pFadeOutContext ) >= gpGlobals->curtime );
}

void CRagdollProp::FadeOutThink(void) 
{
	float dt = gpGlobals->curtime - m_flFadeOutStartTime;
	if ( dt < 0 )
	{
		SetContextThink( &CRagdollProp::FadeOutThink, gpGlobals->curtime + 0.1, s_pFadeOutContext );
	}
	else if ( dt < m_flFadeTime )
	{
		float alpha = 1.0f - dt / m_flFadeTime;
		int nFade = (int)(alpha * 255.0f);
		m_nRenderMode = kRenderTransTexture;
		SetRenderColorA( nFade );
		NetworkStateChanged();
		SetContextThink( &CRagdollProp::FadeOutThink, gpGlobals->curtime + TICK_INTERVAL, s_pFadeOutContext );
	}
	else
	{
		// Necessary to cause it to do the appropriate death cleanup
		// Yeah, the player may have nothing to do with it, but
		// passing NULL to TakeDamage causes bad things to happen
		CBasePlayer *pPlayer = UTIL_GetLocalPlayer();
		CTakeDamageInfo info( pPlayer, pPlayer, 10000.0, DMG_GENERIC );
		TakeDamage( info );
		UTIL_Remove( this );
	}
}


//-----------------------------------------------------------------------------
// Purpose: Draw any debug text overlays
// Output : Current text offset from the top
//-----------------------------------------------------------------------------
int CRagdollProp::DrawDebugTextOverlays(void) 
{
	int text_offset = BaseClass::DrawDebugTextOverlays();

	if (m_debugOverlays & OVERLAY_TEXT_BIT) 
	{
		if (m_ragdoll.listCount)
		{
			float mass = 0;
			for ( int i = 0; i < m_ragdoll.listCount; i++ )
			{
				if ( m_ragdoll.list[i].pObject != NULL )
				{
					mass += m_ragdoll.list[i].pObject->GetMass();
				}
			}

			char tempstr[512];
			Q_snprintf(tempstr, sizeof(tempstr),""Mass: %.2f kg / %.2f lb (%s)"", mass, kg2lbs(mass), GetMassEquivalent(mass) );
			EntityText( text_offset, tempstr, 0);
			text_offset++;
		}
	}

	return text_offset;
}

void CRagdollProp::DrawDebugGeometryOverlays() 
{
	if (m_debugOverlays & OVERLAY_BBOX_BIT) 
	{
		DrawServerHitboxes();
	}
	if (m_debugOverlays & OVERLAY_PIVOT_BIT)
	{
		for ( int i = 0; i < m_ragdoll.listCount; i++ )
		{
			if ( m_ragdoll.list[i].pObject )
			{
				float mass = m_ragdoll.list[i].pObject->GetMass();
				Vector pos;
				m_ragdoll.list[i].pObject->GetPosition( &pos, NULL );
				CFmtStr str(""mass %.1f"", mass );
				NDebugOverlay::EntityTextAtPosition( pos, 0, str.Access(), 0, 0, 255, 0, 255 );
			}
		}
	} 
	BaseClass::DrawDebugGeometryOverlays();
}

//-----------------------------------------------------------------------------
// Purpose: 
// Input  : *pOther - 
//-----------------------------------------------------------------------------
void CRagdollProp::SetUnragdoll( CBaseAnimating *pOther )
{
	m_hUnragdoll = pOther;
}

//===============================================================================================================
// RagdollPropAttached
//===============================================================================================================
class CRagdollPropAttached : public CRagdollProp
{
	DECLARE_CLASS( CRagdollPropAttached, CRagdollProp );
public:

	CRagdollPropAttached()
	{
		m_bShouldDetach = false;
	}

	~CRagdollPropAttached()
	{
		physenv->DestroyConstraint( m_pAttachConstraint );
		m_pAttachConstraint = NULL;
	}

	void InitRagdollAttached( IPhysicsObject *pAttached, const Vector &forceVector, int forceBone, matrix3x4_t *pPrevBones, matrix3x4_t *pBoneToWorld, float dt, int collisionGroup, CBaseAnimating *pFollow, int boneIndexRoot, const Vector &boneLocalOrigin, int parentBoneAttach, const Vector &worldAttachOrigin );
	void DetachOnNextUpdate();
	void VPhysicsUpdate( IPhysicsObject *pPhysics );

	DECLARE_SERVERCLASS();
	DECLARE_DATADESC();

private:
	void Detach();
	CNetworkVar( int, m_boneIndexAttached );
	CNetworkVar( int, m_ragdollAttachedObjectIndex );
	CNetworkVector( m_attachmentPointBoneSpace );
	CNetworkVector( m_attachmentPointRagdollSpace );
	bool		m_bShouldDetach;
	IPhysicsConstraint	*m_pAttachConstraint;
};

LINK_ENTITY_TO_CLASS( prop_ragdoll_attached, CRagdollPropAttached );
EXTERN_SEND_TABLE(DT_Ragdoll_Attached)

IMPLEMENT_SERVERCLASS_ST(CRagdollPropAttached, DT_Ragdoll_Attached)
	SendPropInt( SENDINFO( m_boneIndexAttached ), MAXSTUDIOBONEBITS, SPROP_UNSIGNED ),
	SendPropInt( SENDINFO( m_ragdollAttachedObjectIndex ), RAGDOLL_INDEX_BITS, SPROP_UNSIGNED ),
	SendPropVector(SENDINFO(m_attachmentPointBoneSpace), -1,  SPROP_COORD ),
	SendPropVector(SENDINFO(m_attachmentPointRagdollSpace), -1,  SPROP_COORD ),
END_SEND_TABLE()

BEGIN_DATADESC(CRagdollPropAttached)
	DEFINE_FIELD( m_boneIndexAttached,	FIELD_INTEGER ),
	DEFINE_FIELD( m_ragdollAttachedObjectIndex, FIELD_INTEGER ),
	DEFINE_FIELD( m_attachmentPointBoneSpace,	FIELD_VECTOR ),
	DEFINE_FIELD( m_attachmentPointRagdollSpace, FIELD_VECTOR ),
	DEFINE_FIELD( m_bShouldDetach, FIELD_BOOLEAN ),
	DEFINE_PHYSPTR( m_pAttachConstraint ),
END_DATADESC()


static void SyncAnimatingWithPhysics( CBaseAnimating *pAnimating )
{
	IPhysicsObject *pPhysics = pAnimating->VPhysicsGetObject();
	if ( pPhysics )
	{
		Vector pos;
		pPhysics->GetShadowPosition( &pos, NULL );
		pAnimating->SetAbsOrigin( pos );
	}
}

	
CBaseAnimating *CreateServerRagdollSubmodel( CBaseAnimating *pOwner, const char *pModelName, const Vector &position, const QAngle &angles, int collisionGroup )
{
	CRagdollProp *pRagdoll = (CRagdollProp *)CBaseEntity::CreateNoSpawn( ""prop_ragdoll"", position, angles, pOwner );
	pRagdoll->SetModelName( AllocPooledString( pModelName ) );
	pRagdoll->SetModel( STRING(pRagdoll->GetModelName()) );
	matrix3x4_t pBoneToWorld[MAXSTUDIOBONES], pBoneToWorldNext[MAXSTUDIOBONES];
	pRagdoll->ResetSequence( 0 );

	// let bone merging do the work of copying everything over for us
	pRagdoll->SetParent( pOwner );
	pRagdoll->SetupBones( pBoneToWorld, BONE_USED_BY_ANYTHING );
	// HACKHACK: don't want this parent anymore
	pRagdoll->SetParent( NULL );

	memcpy( pBoneToWorldNext, pBoneToWorld, sizeof(pBoneToWorld) );

	pRagdoll->InitRagdoll( vec3_origin, -1, vec3_origin, pBoneToWorld, pBoneToWorldNext, 0.1, collisionGroup, true );
	return pRagdoll;
}


CBaseEntity *CreateServerRagdoll( CBaseAnimating *pAnimating, int forceBone, const CTakeDamageInfo &info, int collisionGroup, bool bUseLRURetirement )
{
	if ( info.GetDamageType() & (DMG_VEHICLE|DMG_CRUSH) )
	{
		// if the entity was killed by physics or a vehicle, move to the vphysics shadow position before creating the ragdoll.
		SyncAnimatingWithPhysics( pAnimating );
	}
	CRagdollProp *pRagdoll = (CRagdollProp *)CBaseEntity::CreateNoSpawn( ""prop_ragdoll"", pAnimating->GetAbsOrigin(), vec3_angle, NULL );
	pRagdoll->CopyAnimationDataFrom( pAnimating );
	pRagdoll->SetOwnerEntity( pAnimating );

	pRagdoll->InitRagdollAnimation();
	matrix3x4_t pBoneToWorld[MAXSTUDIOBONES], pBoneToWorldNext[MAXSTUDIOBONES];
	
	float dt = 0.1f;

	// Copy over dissolve state...
	if ( pAnimating->IsEFlagSet( EFL_NO_DISSOLVE ) )
	{
		pRagdoll->AddEFlags( EFL_NO_DISSOLVE );
	}

	// NOTE: This currently is only necessary to prevent manhacks from
	// colliding with server ragdolls they kill
	pRagdoll->SetKiller( info.GetInflictor() );
	pRagdoll->SetSourceClassName( pAnimating->GetClassname() );

	// NPC_STATE_DEAD npc's will have their COND_IN_PVS cleared, so this needs to force SetupBones to happen
	unsigned short fPrevFlags = pAnimating->GetBoneCacheFlags();
	pAnimating->SetBoneCacheFlags( BCF_NO_ANIMATION_SKIP );

	// UNDONE: Extract velocity from bones via animation (like we do on the client)
	// UNDONE: For now, just move each bone by the total entity velocity if set.
	// Get Bones positions before
	// Store current cycle
	float fSequenceDuration = pAnimating->SequenceDuration( pAnimating->GetSequence() );
	float fSequenceTime = pAnimating->GetCycle() * fSequenceDuration;		

	if( fSequenceTime <= dt && fSequenceTime > 0.0f )
	{
		// Avoid having negative cycle
		dt = fSequenceTime;
	}

	float fPreviousCycle = clamp(pAnimating->GetCycle()-( dt * ( 1 / fSequenceDuration ) ),0.f,1.f);
	float fCurCycle = pAnimating->GetCycle();
	// Get current bones positions
	pAnimating->SetupBones( pBoneToWorldNext, BONE_USED_BY_ANYTHING );
	// Get previous bones positions
	pAnimating->SetCycle( fPreviousCycle );
	pAnimating->SetupBones( pBoneToWorld, BONE_USED_BY_ANYTHING );		
	// Restore current cycle
	pAnimating->SetCycle( fCurCycle );

	// Reset previous bone flags
	pAnimating->ClearBoneCacheFlags( BCF_NO_ANIMATION_SKIP );
	pAnimating->SetBoneCacheFlags( fPrevFlags );

	Vector vel = pAnimating->GetAbsVelocity();
	if( ( vel.Length() == 0 ) && ( dt > 0 ) )
	{
		// Compute animation velocity
		CStudioHdr *pstudiohdr = pAnimating->GetModelPtr();
		if ( pstudiohdr )
		{
			Vector deltaPos;
			QAngle deltaAngles;
			if (Studio_SeqMovement( pstudiohdr, 
				pAnimating->GetSequence(), 
				fPreviousCycle, 
				pAnimating->GetCycle(), 
				pAnimating->GetPoseParameterArray(), 
				deltaPos, 
				deltaAngles ))
			{
				VectorRotate( deltaPos, pAnimating->EntityToWorldTransform(), vel );
				vel /= dt;
			}
		}
	}

	if ( vel.LengthSqr() > 0 )
	{
		int numbones = pAnimating->GetModelPtr()->numbones();
		vel *= dt;
		for ( int i = 0; i < numbones; i++ )
		{
			Vector pos;
			MatrixGetColumn( pBoneToWorld[i], 3, pos );
			pos -= vel;
			MatrixSetColumn( pos, 3, pBoneToWorld[i] );
		}
	}

#if RAGDOLL_VISUALIZE
	pAnimating->DrawRawSkeleton( pBoneToWorld, BONE_USED_BY_ANYTHING, true, 20, false );
	pAnimating->DrawRawSkeleton( pBoneToWorldNext, BONE_USED_BY_ANYTHING, true, 20, true );
#endif
	// Is this a vehicle / NPC collision?
	if ( (info.GetDamageType() & DMG_VEHICLE) && pAnimating->MyNPCPointer() )
	{
		// init the ragdoll with no forces
		pRagdoll->InitRagdoll( vec3_origin, -1, vec3_origin, pBoneToWorld, pBoneToWorldNext, dt, collisionGroup, true );

		// apply vehicle forces
		// Get a list of bones with hitboxes below the plane of impact
		int boxList[128];
		Vector normal(0,0,-1);
		int count = pAnimating->GetHitboxesFrontside( boxList, ARRAYSIZE(boxList), normal, DotProduct( normal, info.GetDamagePosition() ) );
		
		// distribute force over mass of entire character
		float massScale = Studio_GetMass(pAnimating->GetModelPtr());
		massScale = clamp( massScale, 1.f, 1.e4f );
		massScale = 1.f / massScale;

		// distribute the force
		// BUGBUG: This will hit the same bone twice if it has two hitboxes!!!!
		ragdoll_t *pRagInfo = pRagdoll->GetRagdoll();
		for ( int i = 0; i < count; i++ )
		{
			int physBone = pAnimating->GetPhysicsBone( pAnimating->GetHitboxBone( boxList[i] ) );
			IPhysicsObject *pPhysics = pRagInfo->list[physBone].pObject;
			pPhysics->ApplyForceCenter( info.GetDamageForce() * pPhysics->GetMass() * massScale );
		}
	}
	else
	{
		pRagdoll->InitRagdoll( info.GetDamageForce(), forceBone, info.GetDamagePosition(), pBoneToWorld, pBoneToWorldNext, dt, collisionGroup, true );
	}

	// Are we dissolving?
	if ( pAnimating->IsDissolving() )
	{
		pRagdoll->TransferDissolveFrom( pAnimating );
	}
	else if ( bUseLRURetirement )
	{
		pRagdoll->AddSpawnFlags( SF_RAGDOLLPROP_USE_LRU_RETIREMENT );
		s_RagdollLRU.MoveToTopOfLRU( pRagdoll );
	}

	// Tracker 22598:  If we don't set the OBB mins/maxs to something valid here, then the client will have a zero sized hull
	//  for the ragdoll for one frame until Vphysics updates the real obb bounds after the first simulation frame.  Having
	//  a zero sized hull makes the ragdoll think it should be faded/alpha'd to zero for a frame, so you get a blink where
	//  the ragdoll doesn't draw initially.
	Vector mins, maxs;
	mins = pAnimating->CollisionProp()->OBBMins();
	maxs = pAnimating->CollisionProp()->OBBMaxs();
	pRagdoll->CollisionProp()->SetCollisionBounds( mins, maxs );

#ifdef MAPBASE
	variant_t variant;
	variant.SetEntity(pRagdoll);
	pAnimating->FireNamedOutput(""OnServerRagdoll"", variant, pRagdoll, pAnimating);
#endif

	return pRagdoll;
}

void CRagdollPropAttached::DetachOnNextUpdate()
{
	m_bShouldDetach = true;
}

void CRagdollPropAttached::VPhysicsUpdate( IPhysicsObject *pPhysics )
{
	if ( m_bShouldDetach )
	{
		Detach();
		m_bShouldDetach = false;
	}
	BaseClass::VPhysicsUpdate( pPhysics );
}

void CRagdollPropAttached::Detach()
{
	SetParent(NULL);
	SetOwnerEntity( NULL );
	SetAbsAngles( vec3_angle );
	SetMoveType( MOVETYPE_VPHYSICS );
	RemoveSolidFlags( FSOLID_NOT_SOLID );
	physenv->DestroyConstraint( m_pAttachConstraint );
	m_pAttachConstraint = NULL;
	const float dampingScale = 1.0f / ATTACHED_DAMPING_SCALE;
	for ( int i = 0; i < m_ragdoll.listCount; i++ )
	{
		float damping, rotdamping;
		m_ragdoll.list[i].pObject->GetDamping( &damping, &rotdamping );
		damping *= dampingScale;
		rotdamping *= dampingScale;
		m_ragdoll.list[i].pObject->SetDamping( &damping, &damping );
	}

	// Go non-solid
	SetCollisionGroup( COLLISION_GROUP_DEBRIS );
	RecheckCollisionFilter();
}

void CRagdollPropAttached::InitRagdollAttached( 
	IPhysicsObject *pAttached, 
	const Vector &forceVector, 
	int forceBone, 
	matrix3x4_t *pPrevBones, 
	matrix3x4_t *pBoneToWorld, 
	float dt, 
	int collisionGroup, 
	CBaseAnimating *pFollow, 
	int boneIndexRoot, 
	const Vector &boneLocalOrigin, 
	int parentBoneAttach, 
	const Vector &worldAttachOrigin )
{
	int ragdollAttachedIndex = 0;
	if ( parentBoneAttach > 0 )
	{
		CStudioHdr *pStudioHdr = GetModelPtr();
		mstudiobone_t *pBone = pStudioHdr->pBone( parentBoneAttach );
		ragdollAttachedIndex = pBone->physicsbone;
	}

	InitRagdoll( forceVector, forceBone, vec3_origin, pPrevBones, pBoneToWorld, dt, collisionGroup, false );
	
	IPhysicsObject *pRefObject = m_ragdoll.list[ragdollAttachedIndex].pObject;

	Vector attachmentPointRagdollSpace;
	pRefObject->WorldToLocal( &attachmentPointRagdollSpace, worldAttachOrigin );

	constraint_ragdollparams_t constraint;
	constraint.Defaults();
	matrix3x4_t tmp, worldToAttached, worldToReference, constraintToWorld;

	Vector offsetWS;
	pAttached->LocalToWorld( &offsetWS, boneLocalOrigin );

	QAngle followAng = QAngle(0, pFollow->GetAbsAngles().y, 0 );
	AngleMatrix( followAng, offsetWS, constraintToWorld );

	constraint.axes[0].SetAxisFriction( -2, 2, 20 );
	constraint.axes[1].SetAxisFriction( 0, 0, 0 );
	constraint.axes[2].SetAxisFriction( -15, 15, 20 );

	// Exaggerate the bone's ability to pull the mass of the ragdoll around
	constraint.constraint.bodyMassScale[1] = 50.0f;

	pAttached->GetPositionMatrix( &tmp );
	MatrixInvert( tmp, worldToAttached );

	pRefObject->GetPositionMatrix( &tmp );
	MatrixInvert( tmp, worldToReference );

	ConcatTransforms( worldToReference, constraintToWorld, constraint.constraintToReference );
	ConcatTransforms( worldToAttached, constraintToWorld, constraint.constraintToAttached );

	// for now, just slam this to be the passed in value
	MatrixSetColumn( attachmentPointRagdollSpace, 3, constraint.constraintToReference );

	PhysDisableEntityCollisions( pAttached, m_ragdoll.list[0].pObject );
	m_pAttachConstraint = physenv->CreateRagdollConstraint( pRefObject, pAttached, m_ragdoll.pGroup, constraint );

	SetParent( pFollow );
	SetOwnerEntity( pFollow );

	RagdollActivate( m_ragdoll, modelinfo->GetVCollide( GetModelIndex() ), GetModelIndex() );

	// add a bunch of dampening to the ragdoll
	for ( int i = 0; i < m_ragdoll.listCount; i++ )
	{
		float damping, rotdamping;
		m_ragdoll.list[i].pObject->GetDamping( &damping, &rotdamping );
		damping *= ATTACHED_DAMPING_SCALE;
		rotdamping *= ATTACHED_DAMPING_SCALE;
		m_ragdoll.list[i].pObject->SetDamping( &damping, &rotdamping );
	}

	m_boneIndexAttached = boneIndexRoot;
	m_ragdollAttachedObjectIndex = ragdollAttachedIndex;
	m_attachmentPointBoneSpace = boneLocalOrigin;
	
	Vector vTemp;
	MatrixGetColumn( constraint.constraintToReference, 3, vTemp );
	m_attachmentPointRagdollSpace = vTemp;
}

CRagdollProp *CreateServerRagdollAttached( CBaseAnimating *pAnimating, const Vector &vecForce, int forceBone, int collisionGroup, IPhysicsObject *pAttached, CBaseAnimating *pParentEntity, int boneAttach, const Vector &originAttached, int parentBoneAttach, const Vector &boneOrigin )
{
	// Return immediately if the model doesn't have a vcollide
	if ( modelinfo->GetVCollide( pAnimating->GetModelIndex() ) == NULL )
		return NULL;

	CRagdollPropAttached *pRagdoll = (CRagdollPropAttached *)CBaseEntity::CreateNoSpawn( ""prop_ragdoll_attached"", pAnimating->GetAbsOrigin(), vec3_angle, NULL );
	pRagdoll->CopyAnimationDataFrom( pAnimating );

	pRagdoll->InitRagdollAnimation();
	matrix3x4_t pBoneToWorld[MAXSTUDIOBONES];
	pAnimating->SetupBones( pBoneToWorld, BONE_USED_BY_ANYTHING );
	pRagdoll->InitRagdollAttached( pAttached, vecForce, forceBone, pBoneToWorld, pBoneToWorld, 0.1, collisionGroup, pParentEntity, boneAttach, boneOrigin, parentBoneAttach, originAttached );
	
	return pRagdoll;
}

void DetachAttachedRagdoll( CBaseEntity *pRagdollIn )
{
	CRagdollPropAttached *pRagdoll = dynamic_cast<CRagdollPropAttached *>(pRagdollIn);

	if ( pRagdoll )
	{
		pRagdoll->DetachOnNextUpdate();
	}
}

void DetachAttachedRagdollsForEntity( CBaseEntity *pRagdollParent )
{
	CUtlVector<CBaseEntity *> list;
	GetAllChildren( pRagdollParent, list );
	for ( int i = list.Count()-1; i >= 0; --i )
	{
		DetachAttachedRagdoll( list[i] );
	}
}

bool Ragdoll_IsPropRagdoll( CBaseEntity *pEntity )
{
	if ( dynamic_cast<CRagdollProp *>(pEntity) != NULL )
		return true;
	return false;
}

ragdoll_t *Ragdoll_GetRagdoll( CBaseEntity *pEntity )
{
	CRagdollProp *pProp = dynamic_cast<CRagdollProp *>(pEntity);
	if ( pProp )
		return pProp->GetRagdoll();
	return NULL;
}

void CRagdollProp::GetAngleOverrideFromCurrentState( char *pOut, int size )
{
	pOut[0] = 0;
	for ( int i = 0; i < m_ragdoll.listCount; i++ )
	{
		if ( i != 0 )
		{
			Q_strncat( pOut, "","", size, COPY_ALL_CHARACTERS );

		}
		CFmtStr str(""%d,%.2f %.2f %.2f"", i, m_ragAngles[i].x, m_ragAngles[i].y, m_ragAngles[i].z );
		Q_strncat( pOut, str, size, COPY_ALL_CHARACTERS );
	}
}

void CRagdollProp::DisableMotion( void )
{
	for ( int iRagdoll = 0; iRagdoll < m_ragdoll.listCount; ++iRagdoll )
	{
		IPhysicsObject *pPhysicsObject = m_ragdoll.list[ iRagdoll ].pObject;
		if ( pPhysicsObject != NULL )
		{
			pPhysicsObject->EnableMotion( false );
		}
	}
}

void CRagdollProp::InputStartRadgollBoogie( inputdata_t &inputdata )
{
	float duration = inputdata.value.Float();

	if( duration <= 0.0f )
	{
		duration = 5.0f;
	}

	CRagdollBoogie::Create( this, 100, gpGlobals->curtime, duration, 0 );
}

//-----------------------------------------------------------------------------
// Purpose: Enable physics motion and collision response (on by default)
//-----------------------------------------------------------------------------
void CRagdollProp::InputEnableMotion( inputdata_t &inputdata )
{
	for ( int iRagdoll = 0; iRagdoll < m_ragdoll.listCount; ++iRagdoll )
	{
		IPhysicsObject *pPhysicsObject = m_ragdoll.list[ iRagdoll ].pObject;
		if ( pPhysicsObject != NULL )
		{
			pPhysicsObject->EnableMotion( true );
			pPhysicsObject->Wake();
		}
	}
}

//-----------------------------------------------------------------------------
// Purpose: Disable any physics motion or collision response
//-----------------------------------------------------------------------------
void CRagdollProp::InputDisableMotion( inputdata_t &inputdata )
{
	DisableMotion();
}

#ifdef MAPBASE
//-----------------------------------------------------------------------------
// Purpose: Input handler to start the physics prop simulating.
//-----------------------------------------------------------------------------
void CRagdollProp::InputWake( inputdata_t &inputdata )
{
	for ( int iRagdoll = 0; iRagdoll < m_ragdoll.listCount; ++iRagdoll )
	{
		IPhysicsObject *pPhysicsObject = m_ragdoll.list[ iRagdoll ].pObject;
		if ( pPhysicsObject != NULL )
		{
			pPhysicsObject->Wake();
		}
	}
}

//-----------------------------------------------------------------------------
// Purpose: Input handler to stop the physics prop simulating.
//-----------------------------------------------------------------------------
void CRagdollProp::InputSleep( inputdata_t &inputdata )
{
	for ( int iRagdoll = 0; iRagdoll < m_ragdoll.listCount; ++iRagdoll )
	{
		IPhysicsObject *pPhysicsObject = m_ragdoll.list[ iRagdoll ].pObject;
		if ( pPhysicsObject != NULL )
		{
			pPhysicsObject->Sleep();
		}
	}
}
#endif

void CRagdollProp::InputTurnOn( inputdata_t &inputdata )
{
	RemoveEffects( EF_NODRAW );
}

void CRagdollProp::InputTurnOff( inputdata_t &inputdata )
{
	AddEffects( EF_NODRAW );
}

void CRagdollProp::InputFadeAndRemove( inputdata_t &inputdata )
{
	float flFadeDuration = inputdata.value.Float();
	
	if( flFadeDuration == 0.0f )
		flFadeDuration = 1.0f;

	FadeOut( 0.0f, flFadeDuration );
}

#ifdef MAPBASE_VSCRIPT
HSCRIPT CRagdollProp::ScriptGetRagdollObject( int iIndex )
{
	if (iIndex < 0 || iIndex > m_ragdoll.listCount)
	{
		Warning(""%s GetRagdollObject: Index %i not valid (%i objects)\\n"", GetDebugName(), iIndex, m_ragdoll.listCount);
		return NULL;
	}

	return g_pScriptVM->RegisterInstance( m_ragdoll.list[iIndex].pObject );
}

int CRagdollProp::ScriptGetRagdollObjectCount()
{
	return m_ragdoll.listCount;
}
#endif

void Ragdoll_GetAngleOverrideString( char *pOut, int size, CBaseEntity *pEntity )
{
	CRagdollProp *pRagdoll = dynamic_cast<CRagdollProp *>(pEntity);
	if ( pRagdoll )
	{
		pRagdoll->GetAngleOverrideFromCurrentState( pOut, size );
	}
}
",16142,True,3022.6078546761646,median
"== FTP Component

*Available as of Camel version 1.1*

This component provides access to remote file systems over the FTP and
SFTP protocols.

When consuming from remote FTP server make sure you read the section titled _Default when consuming files_
further below for details related to consuming files.

Absolute path is *not* supported. *Camel 2.16* will translate absolute path to relative by trimming all
leading slashes from `directoryname`. There'll be WARN message printed
in the logs.

Maven users will need to add the following dependency to their `pom.xml`
for this component:

[source,xml]
-----------------------------------------------------------------------
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-ftp</artifactId>
    <version>x.x.x</version>See the documentation of the Apache Commons
    <!-- use the same version as your Camel core version -->
</dependency>
-----------------------------------------------------------------------


### URI format

[source,java]
---------------------------------------------------------
ftp://[username@]hostname[:port]/directoryname[?options]
sftp://[username@]hostname[:port]/directoryname[?options]
ftps://[username@]hostname[:port]/directoryname[?options]
---------------------------------------------------------

Where *directoryname* represents the underlying directory. The directory
name is a relative path. Absolute path's is *not* supported. The
relative path can contain nested folders, such as /inbox/us.

For Camel versions before *Camel 2.16*, the directoryName *must* exist
already as this component does not support the `autoCreate` option
(which the file component does). The reason is that its the FTP
administrator (FTP server) task to properly setup user accounts, and
home directories with the right file permissions etc.

For *Camel 2.16*, `autoCreate` option is supported. When consumer
starts, before polling is scheduled, there's additional FTP operation
performed to create the directory configured for endpoint. The default
value for `autoCreate` is `true`.

If no *username* is provided, then `anonymous` login is attempted using
no password. +
 If no *port* number is provided, Camel will provide default values
according to the protocol (ftp = 21, sftp = 22, ftps = 2222).

You can append query options to the URI in the following format,
`?option=value&option=value&...`

This component uses two different libraries for the actual FTP work. FTP
and FTPS uses http://commons.apache.org/net/[Apache Commons Net] while
SFTP uses http://www.jcraft.com/jsch/[JCraft JSCH].

The FTPS component is only available in Camel 2.2 or newer. +
 FTPS (also known as FTP Secure) is an extension to FTP that adds
support for the Transport Layer Security (TLS) and the Secure Sockets
Layer (SSL) cryptographic protocols.

### URI Options

The options below are exclusive for the FTP component.


// component options: START
The FTP component has no options.
// component options: END



// endpoint options: START
The FTP endpoint is configured using URI syntax:

----
ftp:host:port/directoryName
----

with the following path and query parameters:

==== Path Parameters (3 parameters):

[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *host* | *Required* Hostname of the FTP server |  | String
| *port* | Port of the FTP server |  | int
| *directoryName* | The starting directory |  | String
|===

==== Query Parameters (104 parameters):

[width=""100%"",cols=""2,5,^1,2"",options=""header""]
|===
| Name | Description | Default | Type
| *binary* (common) | Specifies the file transfer mode BINARY or ASCII. Default is ASCII (false). | false | boolean
| *charset* (common) | This option is used to specify the encoding of the file. You can use this on the consumer to specify the encodings of the files which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset so do not use this if you have big messages. |  | String
| *disconnect* (common) | Whether or not to disconnect from remote FTP server right after use. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop then you need to stop the consumer/route instead. | false | boolean
| *doneFileName* (common) | Producer: If provided then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only $file.name and $file.name.noext is supported as dynamic placeholders. |  | String
| *fileName* (common) | Use Expression such as File Language to dynamically set the filename. For consumers it's used as a filename filter. For producers it's used to evaluate the filename to write. If an expression is set it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type it is always evaluated using the File Language. If the expression is an Expression type the specified Expression type is used - this allows you for instance to use OGNL expressions. For the consumer you can use it to filter filenames so you can for instance consume today's file using the File Language syntax: mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards. |  | String
| *passiveMode* (common) | Sets passive mode connections. Default is active mode connections. | false | boolean
| *separator* (common) | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name | UNIX | PathSeparator
| *fastExistsCheck* (common) | If set this option to be true camel-ftp will use the list file directly to check if the file exists. Since some FTP server may not support to list the file directly if the option is false camel-ftp will use the old way to list the directory and check if the file exists. This option also influences readLock=changed to control whether it performs a fast check to update file information or not. This can be used to speed up the process if the FTP server has a lot of files. | false | boolean
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler which mean any exceptions occurred while the consumer is trying to pickup incoming messages or the likes will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions that will be logged at WARN or ERROR level and ignored. | false | boolean
| *delete* (consumer) | If true the file will be deleted after it is processed successfully. | false | boolean
| *moveFailed* (consumer) | Sets the move failure expression based on Simple language. For example to move files into a .error subdirectory use: .error. Note: When moving the files to the fail location Camel will handle the error and will not pick up the file again. |  | String
| *noop* (consumer) | If true the file is not moved or deleted in any way. This option is good for readonly data or for ETL type requirements. If noop=true Camel will set idempotent=true as well to avoid consuming the same files over and over again. | false | boolean
| *preMove* (consumer) | Expression (such as File Language) used to dynamically set the filename when moving it before processing. For example to move in-progress files into the order directory set this value to order. |  | String
| *preSort* (consumer) | When pre-sort is enabled then the consumer will sort the file and directory names during polling that was retrieved from the file system. You may want to do this in case you need to operate on the files in a sorted order. The pre-sort is executed before the consumer starts to filter and accept files to process by Camel. This option is default=false meaning disabled. | false | boolean
| *recursive* (consumer) | If a directory will look for files in all the sub-directories as well. | false | boolean
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files you can enable this option to send an empty message (no body) instead. | false | boolean
| *streamDownload* (consumer) | Sets the download method to use when not using a local working directory. If set to true the remote files are streamed to the route as they are read. When set to false the remote files are loaded into memory before being sent into the route. | false | boolean
| *directoryMustExist* (consumer) | Similar to startingDirectoryMustExist but this applies during polling recursive sub directories. | false | boolean
| *download* (consumer) | Whether the FTP consumer should download the file. If this option is set to false then the message body will be null but the consumer will still trigger a Camel Exchange that has details about the file such as file name file size etc. It's just that the file will not be downloaded. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. |  | ExchangePattern
| *handleDirectoryParser AbsoluteResult* (consumer) | Allows you to set how the consumer will handle subfolders and files in the path if the directory parser results in with absolute paths The reason for this is that some FTP servers may return file names with absolute paths and if so then the FTP component needs to handle this by converting the returned path into a relative path. | false | boolean
| *ignoreFileNotFoundOr PermissionError* (consumer) | Whether to ignore when trying to download a file which does not exist or due to permission error. By default when a file does not exists or insufficient permission then an exception is thrown. Setting this option to true allows to ignore that instead. | false | boolean
| *inProgressRepository* (consumer) | A pluggable in-progress repository org.apache.camel.spi.IdempotentRepository. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. |  | String>
| *localWorkDirectory* (consumer) | When consuming a local work directory can be used to store the remote file content directly in local files to avoid loading the content into memory. This is beneficial if you consume a very big remote file and thus can conserve memory. |  | String
| *onCompletionException Handler* (consumer) | To use a custom org.apache.camel.spi.ExceptionHandler to handle any thrown exceptions that happens during the file on completion process where the consumer does either a commit or rollback. The default implementation will log any exception at WARN level and ignore. |  | ExceptionHandler
| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. |  | PollingConsumerPoll Strategy
| *processStrategy* (consumer) | A pluggable org.apache.camel.component.file.GenericFileProcessStrategy allowing you to implement your own readLock option or similar. Can also be used when special conditions must be met before a file can be consumed such as a special ready file exists. If this option is set then the readLock option does not apply. |  | GenericFileProcess Strategy<T>
| *receiveBufferSize* (consumer) | The receive (download) buffer size Used only by FTPClient | 32768 | int
| *startingDirectoryMustExist* (consumer) | Whether the starting directory must exist. Mind that the autoCreate option is default enabled which means the starting directory is normally auto created if it doesn't exist. You can disable autoCreate and enable this to ensure the starting directory must exist. Will thrown an exception if the directory doesn't exist. | false | boolean
| *useList* (consumer) | Whether to allow using LIST command when downloading a file. Default is true. In some use cases you may want to download a specific file and are not allowed to use the LIST command and therefore you can set this option to false. Notice when using this option then the specific file to download does not include meta-data information such as file size timestamp permissions etc because those information is only possible to retrieve when LIST command is in use. | true | boolean
| *fileExist* (producer) | What to do if a file already exists with the same name. Override which is the default replaces the existing file. Append - adds content to the existing file. Fail - throws a GenericFileOperationException indicating that there is already an existing file. Ignore - silently ignores the problem and does not override the existing file but assumes everything is okay. Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file and there exists already an existing file otherwise causing the move operation to fail. The Move option will move any existing files before writing the target file. TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name without doing any exists check. This check may be faster on some file systems and especially FTP servers. | Override | GenericFileExist
| *flatten* (producer) | Flatten is used to flatten the file name path to strip any leading paths so it's just the file name. This allows you to consume recursively into sub-directories but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths. | false | boolean
| *moveExisting* (producer) | Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name file:name.ext file:name.noext file:onlyname file:onlyname.noext file:ext and file:parent. Notice the file:parent is not supported by the FTP component as the FTP component can only move any existing files to a relative directory based on current dir as base. |  | String
| *tempFileName* (producer) | The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. |  | String
| *tempPrefix* (producer) | This option is used to write the file using a temporary name and then after the write is complete rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files. |  | String
| *allowNullBody* (producer) | Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created when set to false and attempting to send a null body to the file component a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override' then the file will be truncated and if set to append the file will remain unchanged. | false | boolean
| *chmod* (producer) | Allows you to set chmod on the stored file. For example chmod=640. |  | String
| *disconnectOnBatchComplete* (producer) | Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server. | false | boolean
| *eagerDeleteTargetFile* (producer) | Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled and an existing file exists. If this option copyAndDeleteOnRenameFails false then an exception will be thrown if an existing file existed if its true then the existing file is deleted before the move operation. | true | boolean
| *keepLastModified* (producer) | Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers. | false | boolean
| *sendNoop* (producer) | Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid which allows to silently re-connect to be able to upload the file. However if this causes problems you can turn this option off. | true | boolean
| *activePortRange* (advanced) | Set the client side port range in active mode. The syntax is: minPort-maxPort Both port numbers are inclusive eg 10000-19999 to include all 1xxxx ports. |  | String
| *autoCreate* (advanced) | Automatically create missing directories in the file's pathname. For the file consumer that means creating the starting directory. For the file producer it means the directory the files should be written to. | true | boolean
| *bufferSize* (advanced) | Write buffer sized in bytes. | 131072 | int
| *connectTimeout* (advanced) | Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH | 10000 | int
| *ftpClient* (advanced) | To use a custom instance of FTPClient |  | FTPClient
| *ftpClientConfig* (advanced) | To use a custom instance of FTPClientConfig to configure the FTP client the endpoint should use. |  | FTPClientConfig
| *ftpClientConfigParameters* (advanced) | Used by FtpComponent to provide additional parameters for the FTPClientConfig |  | Map
| *ftpClientParameters* (advanced) | Used by FtpComponent to provide additional parameters for the FTPClient |  | Map
| *maximumReconnectAttempts* (advanced) | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. |  | int
| *reconnectDelay* (advanced) | Delay in millis Camel will wait before performing a reconnect attempt. |  | long
| *siteCommand* (advanced) | Sets optional site command(s) to be executed after successful login. Multiple site commands can be separated using a new line character. |  | String
| *soTimeout* (advanced) | Sets the so timeout Used only by FTPClient | 300000 | int
| *stepwise* (advanced) | Sets whether we should stepwise change directories while traversing file structures when downloading files or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. | true | boolean
| *synchronous* (advanced) | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). | false | boolean
| *throwExceptionOnConnect Failed* (advanced) | Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. | false | boolean
| *timeout* (advanced) | Sets the data timeout for waiting for reply Used only by FTPClient | 30000 | int
| *antExclude* (filter) | Ant style filter exclusion. If both antInclude and antExclude are used antExclude takes precedence over antInclude. Multiple exclusions may be specified in comma-delimited format. |  | String
| *antFilterCaseSensitive* (filter) | Sets case sensitive flag on ant fiter | true | boolean
| *antInclude* (filter) | Ant style filter inclusion. Multiple inclusions may be specified in comma-delimited format. |  | String
| *eagerMaxMessagesPerPoll* (filter) | Allows for controlling whether the limit from maxMessagesPerPoll is eager or not. If eager then the limit is during the scanning of files. Where as false would scan all files and then perform sorting. Setting this option to false allows for sorting all files first and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. | true | boolean
| *exclude* (filter) | Is used to exclude files if filename matches the regex pattern (matching is case in-senstive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris |  | String
| *filter* (filter) | Pluggable filter as a org.apache.camel.component.file.GenericFileFilter class. Will skip files if filter returns false in its accept() method. |  | GenericFileFilter<T>
| *filterDirectory* (filter) | Filters the directory based on Simple language. For example to filter on current date you can use a simple date pattern such as $date:now:yyyMMdd |  | String
| *filterFile* (filter) | Filters the file based on Simple language. For example to filter on file size you can use $file:size 5000 |  | String
| *idempotent* (filter) | Option to use the Idempotent Consumer EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If noop=true then idempotent will be enabled as well to avoid consuming the same files over and over again. | false | Boolean
| *idempotentKey* (filter) | To use a custom idempotent key. By default the absolute path of the file is used. You can use the File Language for example to use the file name and file size you can do: idempotentKey=$file:name-$file:size |  | String
| *idempotentRepository* (filter) | A pluggable repository org.apache.camel.spi.IdempotentRepository which by default use MemoryMessageIdRepository if none is specified and idempotent is true. |  | String>
| *include* (filter) | Is used to include files if filename matches the regex pattern (matching is case in-sensitive). Notice if you use symbols such as plus sign and others you would need to configure this using the RAW() syntax if configuring this as an endpoint uri. See more details at configuring endpoint uris |  | String
| *maxDepth* (filter) | The maximum depth to traverse when recursively processing a directory. | 2147483647 | int
| *maxMessagesPerPoll* (filter) | To define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. Notice: If this option is in use then the File and FTP components will limit before any sorting. For example if you have 100000 files and use maxMessagesPerPoll=500 then only the first 500 files will be picked up and then sorted. You can use the eagerMaxMessagesPerPoll option and set this to false to allow to scan all files first and then sort afterwards. |  | int
| *minDepth* (filter) | The minimum depth to start processing when recursively processing a directory. Using minDepth=1 means the base directory. Using minDepth=2 means the first sub directory. |  | int
| *move* (filter) | Expression (such as Simple Language) used to dynamically set the filename when moving it after processing. To move files into a .done subdirectory just enter .done. |  | String
| *exclusiveReadLockStrategy* (lock) | Pluggable read-lock as a org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy implementation. |  | GenericFileExclusive ReadLockStrategy<T>
| *readLock* (lock) | Used by consumer to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. This option provides the build in strategies: none - No read lock is in use markerFile - Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is not available for the FTP component changed - Changed is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec to determine this so this option cannot consume files as fast as the others but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option readLockCheckInterval can be used to set the check frequency. fileLock - is for using java.nio.channels.FileLock. This option is not avail for the FTP component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. rename - rename is for using a try to rename the file as a test if we can get exclusive read-lock. idempotent - (only for file component) idempotent is for using a idempotentRepository as the read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. idempotent-changed - (only for file component) idempotent-changed is for using a idempotentRepository and changed as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. idempotent-rename - (only for file component) idempotent-rename is for using a idempotentRepository and rename as the combined read-lock. This allows to use read locks that supports clustering if the idempotent repository implementation supports that. Notice: The various read locks is not all suited to work in clustered mode where concurrent consumers on different nodes is competing for the same files on a shared file system. The markerFile using a close to atomic operation to create the empty marker file but its not guaranteed to work in a cluster. The fileLock may work better but then the file system need to support distributed file locks and so on. Using the idempotent read lock can support clustering if the idempotent repository supports clustering such as Hazelcast Component or Infinispan. |  | String
| *readLockCheckInterval* (lock) | Interval in millis for the read-lock if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the changed read lock you can set a higher interval period to cater for slow writes. The default of 1 sec. may be too fast if the producer is very slow writing the file. Notice: For FTP the default readLockCheckInterval is 5000. The readLockTimeout value must be higher than readLockCheckInterval but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. | 1000 | long
| *readLockDeleteOrphanLock Files* (lock) | Whether or not read lock with marker files should upon startup delete any orphan read lock files which may have been left on the file system if Camel was not properly shutdown (such as a JVM crash). If turning this option to false then any orphaned lock file will cause Camel to not attempt to pickup that file this could also be due another node is concurrently reading files from the same shared directory. | true | boolean
| *readLockLoggingLevel* (lock) | Logging level used when a read lock could not be acquired. By default a WARN is logged. You can change this level for example to OFF to not have any logging. This option is only applicable for readLock of types: changed fileLock idempotent idempotent-changed idempotent-rename rename. | DEBUG | LoggingLevel
| *readLockMarkerFile* (lock) | Whether to use marker file with the changed rename or exclusive read lock types. By default a marker file is used as well to guard against other processes picking up the same files. This behavior can be turned off by setting this option to false. For example if you do not want to write marker files to the file systems by the Camel application. | true | boolean
| *readLockMinAge* (lock) | This option applied only for readLock=change. This option allows to specify a minimum age the file must be before attempting to acquire the read lock. For example use readLockMinAge=300s to require the file is at last 5 minutes old. This can speedup the changed read lock as it will only attempt to acquire files which are at least that given age. | 0 | long
| *readLockMinLength* (lock) | This option applied only for readLock=changed. This option allows you to configure a minimum file length. By default Camel expects the file to contain data and thus the default value is 1. You can set this option to zero to allow consuming zero-length files. | 1 | long
| *readLockRemoveOnCommit* (lock) | This option applied only for readLock=idempotent. This option allows to specify whether to remove the file name entry from the idempotent repository when processing the file is succeeded and a commit happens. By default the file is not removed which ensures that any race-condition do not occur so another active node may attempt to grab the file. Instead the idempotent repository may support eviction strategies that you can configure to evict the file name entry after X minutes - this ensures no problems with race conditions. | false | boolean
| *readLockRemoveOnRollback* (lock) | This option applied only for readLock=idempotent. This option allows to specify whether to remove the file name entry from the idempotent repository when processing the file failed and a rollback happens. If this option is false then the file name entry is confirmed (as if the file did a commit). | true | boolean
| *readLockTimeout* (lock) | Optional timeout in millis for the read-lock if supported by the read-lock. If the read-lock could not be granted and the timeout triggered then Camel will skip the file. At next poll Camel will try the file again and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. Currently fileLock changed and rename support the timeout. Notice: For FTP the default readLockTimeout value is 20000 instead of 10000. The readLockTimeout value must be higher than readLockCheckInterval but a rule of thumb is to have a timeout that is at least 2 or more times higher than the readLockCheckInterval. This is needed to ensure that amble time is allowed for the read lock process to try to grab the lock before the timeout was hit. | 10000 | long
| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |  | int
| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. |  | int
| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. |  | int
| *delay* (scheduler) | Milliseconds before the next poll. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 500 | long
| *greedy* (scheduler) | If greedy is enabled then the ScheduledPollConsumer will run immediately again if the previous run polled 1 or more messages. | false | boolean
| *initialDelay* (scheduler) | Milliseconds before the first poll starts. You can also specify time values using units such as 60s (60 seconds) 5m30s (5 minutes and 30 seconds) and 1h (1 hour). | 1000 | long
| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. | TRACE | LoggingLevel
| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. |  | ScheduledExecutor Service
| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz2 component | none | ScheduledPollConsumer Scheduler
| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz2 Spring based scheduler. |  | Map
| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. | MILLISECONDS | TimeUnit
| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
| *shuffle* (sort) | To shuffle the list of files (sort in random order) | false | boolean
| *sortBy* (sort) | Built-in sort by using the File Language. Supports nested sorts so you can have a sort by file name and as a 2nd group sort by modified date. |  | String
| *sorter* (sort) | Pluggable sorter as a java.util.Comparator class. |  | GenericFile<T>>
| *account* (security) | Account to use for login |  | String
| *password* (security) | Password to use for login |  | String
| *username* (security) | Username to use for login |  | String
|===
// endpoint options: END



### FTPS component default trust store

When using the `ftpClient.` properties related to SSL with the FTPS
component, the trust store accept all certificates. If you only want
trust selective certificates, you have to configure the trust store with
the `ftpClient.trustStore.xxx` options or by configuring a custom
`ftpClient`.

When using `sslContextParameters`, the trust store is managed by the
configuration of the provided SSLContextParameters instance.

You can configure additional options on the `ftpClient` and
`ftpClientConfig` from the URI directly by using the `ftpClient.` or
`ftpClientConfig.` prefix.

For example to set the `setDataTimeout` on the `FTPClient` to 30 seconds
you can do:

[source,java]
--------------------------------------------------------------------------------------
from(""ftp://foo@myserver?password=secret&ftpClient.dataTimeout=30000"").to(""bean:foo"");
--------------------------------------------------------------------------------------

You can mix and match and have use both prefixes, for example to
configure date format or timezones.

[source,java]
----------------------------------------------------------------------------------------------------------------------------
from(""ftp://foo@myserver?password=secret&ftpClient.dataTimeout=30000&ftpClientConfig.serverLanguageCode=fr"").to(""bean:foo"");
----------------------------------------------------------------------------------------------------------------------------

You can have as many of these options as you like.

See the documentation of the Apache Commons FTP FTPClientConfig for
possible options and more details. And as well for Apache Commons FTP
FTPClient.

If you do not like having many and long configuration in the url you can
refer to the `ftpClient` or `ftpClientConfig` to use by letting Camel
lookup in the link:registry.html[Registry] for it.

For example:

[source,java]
--------------------------------------------------------------------------
   <bean id=""myConfig"" class=""org.apache.commons.net.ftp.FTPClientConfig"">
       <property name=""lenientFutureDates"" value=""true""/>
       <property name=""serverLanguageCode"" value=""fr""/>
   </bean>
--------------------------------------------------------------------------

And then let Camel lookup this bean when you use the # notation in the
url.

[source,java]
------------------------------------------------------------------------------------
from(""ftp://foo@myserver?password=secret&ftpClientConfig=#myConfig"").to(""bean:foo"");
------------------------------------------------------------------------------------

### More URI options


### Examples

`ftp://someone@someftpserver.com/public/upload/images/holiday2008?password=secret&binary=true` +

`ftp://someoneelse@someotherftpserver.co.uk:12049/reports/2008/password=secret&binary=false` +
 `ftp://publicftpserver.com/download`

### Concurrency

FTP Consumer does not support concurrency

The FTP consumer (with the same endpoint) does not support concurrency
(the backing FTP client is not thread safe). +
 You can use multiple FTP consumers to poll from different endpoints. It
is only a single endpoint that does not support concurrent consumers.

The FTP producer does *not* have this issue, it supports concurrency.

### More information

This component is an extension of the link:file2.html[File] component.
So there are more samples and details on the link:file2.html[File]
component page.

====

### Default when consuming files

The link:ftp2.html[FTP] consumer will by default leave the consumed
files untouched on the remote FTP server. You have to configure it
explicitly if you want it to delete the files or move them to another
location. For example you can use `delete=true` to delete the files, or
use `move=.done` to move the files into a hidden done sub directory.

The regular link:file2.html[File] consumer is different as it will by
default move files to a `.camel` sub directory. The reason Camel does
*not* do this by default for the FTP consumer is that it may lack
permissions by default to be able to move or delete files.

#### limitations

The option *readLock* can be used to force Camel *not* to consume files
that is currently in the progress of being written. However, this option
is turned off by default, as it requires that the user has write access.
See the options table at link:file2.html[File2] for more details about
read locks. +
 There are other solutions to avoid consuming files that are currently
being written over FTP; for instance, you can write to a temporary
destination and move the file after it has been written.

When moving files using `move` or `preMove` option the files are
restricted to the FTP_ROOT folder. That prevents you from moving files
outside the FTP area. If you want to move files to another area you can
use soft links and move files into a soft linked folder.

### Message Headers

The following message headers can be used to affect the behavior of the
component

[width=""100%"",cols=""50%,50%"",options=""header"",]
|=======================================================================
|Header |Description

|`CamelFileName` |Specifies the output file name (relative to the endpoint directory) to
be used for the output message when sending to the endpoint. If this is
not present and no expression either, then a generated message ID is
used as the filename instead.

|`CamelFileNameProduced` |The actual filepath (path + name) for the output file that was written.
This header is set by Camel and its purpose is providing end-users the
name of the file that was written.

|`CamelFileIndex` |Current index out of total number of files being consumed in this batch.

|`CamelFileSize` |Total number of files being consumed in this batch.

|`CamelFileHost` |The remote hostname.

|`CamelFileLocalWorkPath` |Path to the local work file, if local work directory is used.
|=======================================================================

In addition the FTP/FTPS consumer and producer will enrich the Camel
`Message` with the following headers

[width=""100%"",cols=""50%,50%"",options=""header"",]
|=======================================================================
|Header |Description

|`CamelFtpReplyCode` |*Camel 2.11.1:* The FTP client reply code (the type is a integer)

|`CamelFtpReplyString` | *Camel 2.11.1:* The FTP client reply string
|=======================================================================

### About timeouts

The two set of libraries (see top) has different API for setting
timeout. You can use the `connectTimeout` option for both of them to set
a timeout in millis to establish a network connection. An individual
`soTimeout` can also be set on the FTP/FTPS, which corresponds to using
`ftpClient.soTimeout`. Notice SFTP will automatically use
`connectTimeout` as its `soTimeout`. The `timeout` option only applies
for FTP/FTSP as the data timeout, which corresponds to the
`ftpClient.dataTimeout` value. All timeout values are in millis.

### Using Local Work Directory

Camel supports consuming from remote FTP servers and downloading the
files directly into a local work directory. This avoids reading the
entire remote file content into memory as it is streamed directly into
the local file using `FileOutputStream`.

Camel will store to a local file with the same name as the remote file,
though with `.inprogress` as extension while the file is being
downloaded. Afterwards, the file is renamed to remove the `.inprogress`
suffix. And finally, when the link:exchange.html[Exchange] is complete
the local file is deleted.

So if you want to download files from a remote FTP server and store it
as files then you need to route to a file endpoint such as:

[source,java]
------------------------------------------------------------------------------------------------
from(""ftp://someone@someserver.com?password=secret&localWorkDirectory=/tmp"").to(""file://inbox"");
------------------------------------------------------------------------------------------------

[Tip]
====
 *Optimization by renaming work file*

The route above is ultra efficient as it avoids reading the entire file
content into memory. It will download the remote file directly to a
local file stream. The `java.io.File` handle is then used as the
link:exchange.html[Exchange] body. The file producer leverages this fact
and can work directly on the work file `java.io.File` handle and perform
a `java.io.File.rename` to the target filename. As Camel knows it's a
local work file, it can optimize and use a rename instead of a file
copy, as the work file is meant to be deleted anyway.

====

### Stepwise changing directories

Camel link:ftp2.html[FTP] can operate in two modes in terms of
traversing directories when consuming files (eg downloading) or
producing files (eg uploading)

* stepwise
* not stepwise

You may want to pick either one depending on your situation and security
issues. Some Camel end users can only download files if they use
stepwise, while others can only download if they do not. At least you
have the choice to pick (from Camel 2.6 onwards).

In Camel 2.0 - 2.5 there is only one mode and it is:

* before 2.5 not stepwise
* 2.5 stepwise

From Camel 2.6 onwards there is now an option `stepwise` you can use to
control the behavior.

Note that stepwise changing of directory will in most cases only work
when the user is confined to it's home directory and when the home
directory is reported as `""/""`.

The difference between the two of them is best illustrated with an
example. Suppose we have the following directory structure on the remote
FTP server we need to traverse and download files:

[source,java]
--------------
/
/one
/one/two
/one/two/sub-a
/one/two/sub-b
--------------

And that we have a file in each of sub-a (a.txt) and sub-b (b.txt)
folder.

#### Using stepwise=true (default mode)

[source,java]
----------------------------------------------------------
TYPE A
200 Type set to A
PWD
257 ""/"" is current directory.
CWD one
250 CWD successful. ""/one"" is current directory.
CWD two
250 CWD successful. ""/one/two"" is current directory.
SYST
215 UNIX emulated by FileZilla
PORT 127,0,0,1,17,94
200 Port command successful
LIST
150 Opening data channel for directory list.
226 Transfer OK
CWD sub-a
250 CWD successful. ""/one/two/sub-a"" is current directory.
PORT 127,0,0,1,17,95
200 Port command successful
LIST
150 Opening data channel for directory list.
226 Transfer OK
CDUP
200 CDUP successful. ""/one/two"" is current directory.
CWD sub-b
250 CWD successful. ""/one/two/sub-b"" is current directory.
PORT 127,0,0,1,17,96
200 Port command successful
LIST
150 Opening data channel for directory list.
226 Transfer OK
CDUP
200 CDUP successful. ""/one/two"" is current directory.
CWD /
250 CWD successful. ""/"" is current directory.
PWD
257 ""/"" is current directory.
CWD one
250 CWD successful. ""/one"" is current directory.
CWD two
250 CWD successful. ""/one/two"" is current directory.
PORT 127,0,0,1,17,97
200 Port command successful
RETR foo.txt
150 Opening data channel for file transfer.
226 Transfer OK
CWD /
250 CWD successful. ""/"" is current directory.
PWD
257 ""/"" is current directory.
CWD one
250 CWD successful. ""/one"" is current directory.
CWD two
250 CWD successful. ""/one/two"" is current directory.
CWD sub-a
250 CWD successful. ""/one/two/sub-a"" is current directory.
PORT 127,0,0,1,17,98
200 Port command successful
RETR a.txt
150 Opening data channel for file transfer.
226 Transfer OK
CWD /
250 CWD successful. ""/"" is current directory.
PWD
257 ""/"" is current directory.
CWD one
250 CWD successful. ""/one"" is current directory.
CWD two
250 CWD successful. ""/one/two"" is current directory.
CWD sub-b
250 CWD successful. ""/one/two/sub-b"" is current directory.
PORT 127,0,0,1,17,99
200 Port command successful
RETR b.txt
150 Opening data channel for file transfer.
226 Transfer OK
CWD /
250 CWD successful. ""/"" is current directory.
QUIT
221 Goodbye
disconnected.
----------------------------------------------------------

As you can see when stepwise is enabled, it will traverse the directory
structure using CD xxx.

#### Using stepwise=false

[source,java]
-------------------------------------------
230 Logged on
TYPE A
200 Type set to A
SYST
215 UNIX emulated by FileZilla
PORT 127,0,0,1,4,122
200 Port command successful
LIST one/two
150 Opening data channel for directory list
226 Transfer OK
PORT 127,0,0,1,4,123
200 Port command successful
LIST one/two/sub-a
150 Opening data channel for directory list
226 Transfer OK
PORT 127,0,0,1,4,124
200 Port command successful
LIST one/two/sub-b
150 Opening data channel for directory list
226 Transfer OK
PORT 127,0,0,1,4,125
200 Port command successful
RETR one/two/foo.txt
150 Opening data channel for file transfer.
226 Transfer OK
PORT 127,0,0,1,4,126
200 Port command successful
RETR one/two/sub-a/a.txt
150 Opening data channel for file transfer.
226 Transfer OK
PORT 127,0,0,1,4,127
200 Port command successful
RETR one/two/sub-b/b.txt
150 Opening data channel for file transfer.
226 Transfer OK
QUIT
221 Goodbye
disconnected.
-------------------------------------------

As you can see when not using stepwise, there are no CD operation
invoked at all.

### Samples

In the sample below we set up Camel to download all the reports from the
FTP server once every hour (60 min) as BINARY content and store it as
files on the local file system.

And the route using Spring DSL:

[source,xml]
------------------------------------------------------------------------------------------------------
  <route>
     <from uri=""ftp://scott@localhost/public/reports?password=tiger&amp;binary=true&amp;delay=60000""/>
     <to uri=""file://target/test-reports""/>
  </route>
------------------------------------------------------------------------------------------------------

#### Consuming a remote FTPS server (implicit SSL) and client authentication

[source,java]
--------------------------------------------------------------------------------------------------
from(""ftps://admin@localhost:2222/public/camel?password=admin&securityProtocol=SSL&isImplicit=true
      &ftpClient.keyStore.file=./src/test/resources/server.jks
      &ftpClient.keyStore.password=password&ftpClient.keyStore.keyPassword=password"")
  .to(""bean:foo"");
--------------------------------------------------------------------------------------------------

#### Consuming a remote FTPS server (explicit TLS) and a custom trust store configuration

[source,java]
----------------------------------------------------------------------------------------------------------------------------------------------------------------
from(""ftps://admin@localhost:2222/public/camel?password=admin&ftpClient.trustStore.file=./src/test/resources/server.jks&ftpClient.trustStore.password=password"")
  .to(""bean:foo"");
----------------------------------------------------------------------------------------------------------------------------------------------------------------

### Filter using `org.apache.camel.component.file.GenericFileFilter`

Camel supports pluggable filtering strategies. This strategy it to use
the build in `org.apache.camel.component.file.GenericFileFilter` in
Java. You can then configure the endpoint with such a filter to skip
certain filters before being processed.

In the sample we have built our own filter that only accepts files
starting with report in the filename.

And then we can configure our route using the *filter* attribute to
reference our filter (using `#` notation) that we have defined in the
spring XML file:

[source,xml]
---------------------------------------------------------------------------------------
   <!-- define our sorter as a plain spring bean -->
   <bean id=""myFilter"" class=""com.mycompany.MyFileFilter""/>

  <route>
    <from uri=""ftp://someuser@someftpserver.com?password=secret&amp;filter=#myFilter""/>
    <to uri=""bean:processInbox""/>
  </route>
---------------------------------------------------------------------------------------

### Filtering using ANT path matcher

The ANT path matcher is a filter that is shipped out-of-the-box in the
*camel-spring* jar. So you need to depend on *camel-spring* if you are
using Maven. +
 The reason is that we leverage Spring's
http://static.springsource.org/spring/docs/3.0.x/api/org/springframework/util/AntPathMatcher.html[AntPathMatcher]
to do the actual matching.

The file paths are matched with the following rules:

* `?` matches one character
* `*` matches zero or more characters
* `**` matches zero or more directories in a path

The sample below demonstrates how to use it:

### Using a proxy with SFTP

To use an HTTP proxy to connect to your remote host, you can configure
your route in the following way:

[source,xml]
-------------------------------------------------------------------------------------
<!-- define our sorter as a plain spring bean -->
<bean id=""proxy"" class=""com.jcraft.jsch.ProxyHTTP"">
  <constructor-arg value=""localhost""/>
  <constructor-arg value=""7777""/>
</bean>

<route>
  <from uri=""sftp://localhost:9999/root?username=admin&password=admin&proxy=#proxy""/>
  <to uri=""bean:processFile""/>
</route>
-------------------------------------------------------------------------------------

You can also assign a user name and password to the proxy, if necessary.
Please consult the documentation for `com.jcraft.jsch.Proxy` to discover
all options.

### Setting preferred SFTP authentication method

If you want to explicitly specify the list of authentication methods
that should be used by `sftp` component, use `preferredAuthentications`
option. If for example you would like Camel to attempt to authenticate
with private/public SSH key and fallback to user/password authentication
in the case when no public key is available, use the following route
configuration:

[source,java]
-------------------------------------------------------------------------------------------------------------
from(""sftp://localhost:9999/root?username=admin&password=admin&preferredAuthentications=publickey,password"").
  to(""bean:processFile"");
-------------------------------------------------------------------------------------------------------------

### Consuming a single file using a fixed name

When you want to download a single file and knows the file name, you can
use `fileName=myFileName.txt` to tell Camel the name of the file to
download. By default the consumer will still do a FTP LIST command to do
a directory listing and then filter these files based on the `fileName`
option. Though in this use-case it may be desirable to turn off the
directory listing by setting `useList=false`. For example the user
account used to login to the FTP server may not have permission to do a
FTP LIST command. So you can turn off this with `useList=false`, and
then provide the fixed name of the file to download with
`fileName=myFileName.txt`, then the FTP consumer can still download the
file. If the file for some reason does not exist, then Camel will by
default throw an exception, you can turn this off and ignore this by
setting `ignoreFileNotFoundOrPermissionError=true`.

For example to have a Camel route that pickup a single file, and delete
it after use you can do

[source,java]
-------------------------------------------------------------------------------------------------------------------------------------------------------------
from(""ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true"")
  .to(""activemq:queue:report"");
-------------------------------------------------------------------------------------------------------------------------------------------------------------

Notice that we have use all the options we talked above above.

You can also use this with `ConsumerTemplate`. For example to download a
single file (if it exists) and grab the file content as a String type:

[source,java]
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
String data = template.retrieveBodyNoWait(""ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true"", String.class);
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

### Debug logging

This component has log level *TRACE* that can be helpful if you have
problems.

### See Also

* link:configuring-camel.html[Configuring Camel]
* link:component.html[Component]
* link:endpoint.html[Endpoint]
* link:getting-started.html[Getting Started]

* link:file2.html[File2]
",12434,False,2135.3359136621402,median
"// Copyright 2017 the original author or authors.
//
// Licensed under the Apache License, Version 2.0 (the ""License"");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an ""AS IS"" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

[[native_software]]
= Building native software


[CAUTION]
====
The https://blog.gradle.org/state-and-future-of-the-gradle-software-model[software model] is being retired and the plugins mentioned in this chapter will eventually be deprecated and removed.
We recommend new projects looking to build C++ applications and libraries use the newer <<building_cpp_projects.adoc#,replacement plugins>>.
====

The native software plugins add support for building native software components, such as executables or shared libraries, from code written in C++, C and other languages. While many excellent build tools exist for this space of software development, Gradle offers developers its trademark power and flexibility together with dependency management practices more traditionally found in the JVM development space.

The native software plugins make use of the Gradle <<software_model.adoc#software_model,software model>>.


[[sec:native_features]]
== Features

The native software plugins provide:

* Support for building native libraries and applications on Windows, Linux, macOS and other platforms.
* Support for several source languages.
* Support for building different variants of the same software, for different architectures, operating systems, or for any purpose.
* Incremental parallel compilation, precompiled headers.
* Dependency management between native software components.
* Unit test execution.
* Generate Visual studio solution and project files.
* Deep integration with various tool chain, including discovery of installed tool chains.


[[sec:supported_languages]]
== Supported languages

The following source languages are currently supported:

* C
* C++
* Objective-C
* Objective-C++
* Assembly
* Windows resources


[[native-binaries:tool-chain-support]]
== Tool chain support

Gradle offers the ability to execute the same build using different tool chains. When you build a native binary, Gradle will attempt to locate a tool chain installed on your machine that can build the binary. You can fine tune exactly how this works, see <<#native_binaries:tool_chain,Tool chain support>> for details.

The following tool chains are supported:

[%header%autowidth,compact]
|===
| Operating System | Tool Chain | Notes

| Linux
| http://gcc.gnu.org/[GCC]
|

| Linux
| http://clang.llvm.org[Clang]
|

| macOS
| XCode
| Uses the Clang tool chain bundled with XCode.

| Windows
| https://visualstudio.microsoft.com/[Visual C++]
| Windows XP and later, Visual C++ 2010/2012/2013/2015/2017/2019.

| Windows
| http://gcc.gnu.org/[GCC] with http://cygwin.com[Cygwin 32 and Cygwin 64]
| Windows XP and later.

| Windows
| http://gcc.gnu.org/[GCC] with http://www.mingw.org/[MinGW] and https://mingw-w64.org/doku.php[MinGW64]
| Windows XP and later.
|===

The following tool chains are unofficially supported. They generally work fine, but are not tested continuously:

[%header%autowidth,compact]
|===
| Operating System | Tool Chain | Notes

| macOS
| http://gcc.gnu.org/[GCC] from Macports
|

| macOS
| http://clang.llvm.org[Clang] from Macports
|

| UNIX-like
| http://gcc.gnu.org/[GCC]
|

| UNIX-like
| http://clang.llvm.org[Clang]
|
|===


[[sec:tool_chain_installation]]
== Tool chain installation


[NOTE]
====

Note that if you are using GCC then you currently need to install support for C+\\+, even if you are not building from C++ source. This restriction will be removed in a future Gradle version.

====

To build native software, you will need to have a compatible tool chain installed:


[[sec:windows]]
=== Windows

To build on Windows, install a compatible version of Visual Studio. The native plugins will discover the Visual Studio installations and select the latest version. There is no need to mess around with environment variables or batch scripts. This works fine from a Cygwin shell or the Windows command-line.

Alternatively, you can install Cygwin with GCC or MinGW. Clang is currently not supported.

[[sec:macOS]]
=== macOS

To build on macOS, you should install XCode. The native plugins will discover the XCode installation using the system PATH.

The native plugins also work with GCC and Clang bundled with Macports. To use one of the Macports tool chains, you will need to make the tool chain the default using the `port select` command and add Macports to the system PATH.

[[sec:linux]]
=== Linux

To build on Linux, install a compatible version of GCC or Clang. The native plugins will discover GCC or Clang using the system PATH.

[[sec:native_software_model]]
== Native software model

The native software model builds on the base Gradle <<software_model_concepts.adoc#software_model_concepts,software model>>.

To build native software using Gradle, your project should define one or more _native components_. Each component represents either an executable or a library that Gradle should build. A project can define any number of components. Gradle does not define any components by default.

For each component, Gradle defines a _source set_ for each language that the component can be built from. A source set is essentially just a set of source directories containing source files. For example, when you apply the `c` plugin and define a library called `helloworld`, Gradle will define, by default, a source set containing the C source files in the `src/helloworld/c` directory. It will use these source files to build the `helloworld` library. This is described in more detail below.

For each component, Gradle defines one or more _binaries_ as output. To build a binary, Gradle will take the source files defined for the component, compile them as appropriate for the source language, and link the result into a binary file. For an executable component, Gradle can produce executable binary files. For a library component, Gradle can produce both static and shared library binary files. For example, when you define a library called `helloworld` and build on Linux, Gradle will, by default, produce `libhelloworld.so` and `libhelloworld.a` binaries.

In many cases, more than one binary can be produced for a component. These binaries may vary based on the tool chain used to build, the compiler/linker flags supplied, the dependencies provided, or additional source files provided. Each native binary produced for a component is referred to as a _variant_. Binary variants are discussed in detail below.

[[sec:parallel_compilation]]
== Parallel Compilation

Gradle uses the single build worker pool to concurrently compile and link native components, by default. No special configuration is required to enable concurrent building.

By default, the worker pool size is determined by the number of available processors on the build machine (as reported to the build JVM). To explicitly set the number of workers use the `--max-workers` command-line option or `org.gradle.workers.max` system property. There is generally no need to change this setting from its default.

The build worker pool is shared across all build tasks. This means that when using <<multi_project_builds.adoc#sec:parallel_execution,parallel project execution>>, the maximum number of concurrent individual compilation operations does not increase. For example, if the build machine has 4 processing cores and 10 projects are compiling in parallel, Gradle will only use 4 total workers, not 40.

[[sec:building_a_library]]
== Building a library

To build either a static or shared native library, you define a library component in the `components` container. The following sample defines a library called `hello`:

=== Example: Defining a library component

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/c/build.gradle[tag=libraries]
----

A library component is represented using link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]. Each library component can produce at least one shared library binary (link:{javadocPath}/org/gradle/nativeplatform/SharedLibraryBinarySpec.html[SharedLibraryBinarySpec]) and at least one static library binary (link:{javadocPath}/org/gradle/nativeplatform/StaticLibraryBinarySpec.html[StaticLibraryBinarySpec]).

[[sec:building_an_executable]]
== Building an executable

To build a native executable, you define an executable component in the `components` container. The following sample defines an executable called `main`:

=== Example: Defining executable components

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/c/build.gradle[tag=executables]
----

An executable component is represented using link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec]. Each executable component can produce at least one executable binary (link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableBinarySpec.html[NativeExecutableBinarySpec]).

For each component defined, Gradle adds a link:{javadocPath}/org/gradle/language/base/FunctionalSourceSet.html[FunctionalSourceSet] with the same name. Each of these functional source sets will contain a language-specific source set for each of the languages supported by the project.

[[sec:dependents]]
== Assembling or building dependents

Sometimes, you may need to _assemble_ (compile and link) or _build_ (compile, link and test) a component or binary and its _dependents_ (things that depend upon the component or binary). The native software model provides tasks that enable this capability. First, the _dependent components_ report gives insight about the relationships between each component. Second, the _build and assemble dependents_ tasks allow you to assemble or build a component and its dependents in one step.

In the following example, the build file defines `OpenSSL` as a dependency of `libUtil` and `libUtil` as a dependency of `LinuxApp` and `WindowsApp`. Test suites are treated similarly. Dependents can be thought of as reverse dependencies.

.Dependent Components Example
image::nativeDependents.png[]

[NOTE]
====
By following the dependencies backwards, you can see `LinuxApp` and `WindowsApp` are _dependents_ of `libUtil`. When `libUtil` is changed, Gradle will need to recompile or relink `LinuxApp` and `WindowsApp`.
====


When you _assemble_ dependents of a component, the component and all of its dependents are compiled and linked, including any test suite binaries. Gradle's up-to-date checks are used to only compile or link if something has changed. For instance, if you have changed source files in a way that do not affect the headers of your project, Gradle will be able to skip compilation for dependent components and only need to re-link with the new library. Tests are not run when assembling a component.

When you _build_ dependents of a component, the component and all of its dependent binaries are compiled, linked _and checked_. Checking components means running any <<#sec:check_tasks,check task>> including executing any test suites, so tests _are_ run when building a component.

In the following sections, we will demonstrate the usage of the `assembleDependents\\*`, `buildDependents*` and `dependentComponents` tasks with a sample build that contains a CUnit test suite. The build script for the sample is the following:

=== Example: Sample build

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/cunit/build.gradle[tag=terse-example]
----



[[sec:dependents_report]]
=== Dependent components report

Gradle provides a report that you can run from the command-line that shows a graph of components in your project and components that depend upon them. The following is an example of running `gradle dependentComponents` on the sample project:

=== Example: Dependent components report

.Output of **`gradle dependentComponents`**
----
> gradle dependentComponents
include::{snippetsPath}/native-binaries/cunit/dependentComponentsReport.out[]
----

[NOTE]
====
See link:{groovyDslPath}/org.gradle.api.reporting.dependents.DependentComponentsReport.html[DependentComponentsReport] API documentation for more details.
====

By default, non-buildable binaries and test suites are hidden from the report. The `dependentComponents` task provides options that allow you to see all dependents by using the `--all` option:

=== Example: Dependent components report

.Output of **`gradle dependentComponents --all`**
----
> gradle dependentComponents --all
include::{snippetsPath}/native-binaries/cunit/dependentComponentsReportAll.out[]
----

Here is the corresponding report for the `operators` component, showing dependents of all its binaries:

=== Example: Report of components that depends on the operators component

.Output of **`gradle dependentComponents --component operators`**
----
> gradle dependentComponents --component operators
include::{snippetsPath}/native-binaries/cunit/assembleDependentComponentsReport.out[]
----

Here is the corresponding report for the `operators` component, showing dependents of all its binaries, including test suites:

=== Example: Report of components that depends on the operators component, including test suites

.Output of **`gradle dependentComponents --test-suites --component operators`**
----
> gradle dependentComponents --test-suites --component operators
include::{snippetsPath}/native-binaries/cunit/buildDependentComponentsReport.out[]
----


[[sec:assemble_dependents]]
=== Assembling dependents

For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec], Gradle will create a task named `assembleDependents__${component.name}${binary.variant}__` that _assembles_ (compile and link) the binary and all of its dependent binaries.

For each link:{javadocPath}/org/gradle/nativeplatform/NativeComponentSpec.html[NativeComponentSpec], Gradle will create a task named `assembleDependents__${component.name}__` that _assembles_ all the binaries of the component and all of their dependent binaries.

For example, to assemble the dependents of the ""passing"" flavor of the ""static"" library binary of the ""operators"" component, you would run the `assembleDependentsOperatorsPassingStaticLibrary` task:

=== Example: Assemble components that depends on the passing/static binary of the operators component

.Output of **`gradle assembleDependentsOperatorsPassingStaticLibrary --max-workers=1`**
----
> gradle assembleDependentsOperatorsPassingStaticLibrary --max-workers=1
include::{snippetsPath}/native-binaries/cunit/assembleDependentComponents.out[]
----

In the output above, the targeted binary gets assembled as well as the test suite binary that depends on it.

You can also assemble _all_ of the dependents of a component (i.e. of all its binaries/variants) using the corresponding component task, e.g. `assembleDependentsOperators`. This is useful if you have many combinations of build types, flavors and platforms and want to assemble all of them.

[[sec:build_dependents]]
=== Building dependents

For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec], Gradle will create a task named `buildDependents__${component.name}${binary.variant}__` that _builds_ (compile, link and check) the binary and all of its dependent binaries.

For each link:{javadocPath}/org/gradle/nativeplatform/NativeComponentSpec.html[NativeComponentSpec], Gradle will create a task named `buildDependents__${component.name}__` that _builds_ all the binaries of the component and all of their dependent binaries.

For example, to build the dependents of the ""passing"" flavor of the ""static"" library binary of the ""operators"" component, you would run the `buildDependentsOperatorsPassingStaticLibrary` task:

=== Example: Build components that depends on the passing/static binary of the operators component

.Output of **`gradle buildDependentsOperatorsPassingStaticLibrary --max-workers=1`**
----
> gradle buildDependentsOperatorsPassingStaticLibrary --max-workers=1
include::{snippetsPath}/native-binaries/cunit/buildDependentComponents.out[]
----

In the output above, the targeted binary as well as the test suite binary that depends on it are built and the test suite has run.

You can also build _all_ of the dependents of a component (i.e. of all its binaries/variants) using the corresponding component task, e.g. `buildDependentsOperators`.

[[sec:native_tasks]]
== Tasks

For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] that can be produced by a build, a single _lifecycle task_ is constructed that can be used to create that binary, together with a set of other tasks that do the actual work of compiling, linking or assembling the binary.


`__${component.name}__Executable`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableBinarySpec.html[NativeExecutableBinarySpec]
  Location of created binary;;
    `__${project.buildDir}__/exe/__${component.name}__/__${component.name}__`

`__${component.name}__SharedLibrary`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/SharedLibraryBinarySpec.html[SharedLibraryBinarySpec]
  Location of created binary;;
    `__${project.buildDir}__/libs/__${component.name}__/shared/lib__${component.name}__.so`

`__${component.name}__StaticLibrary`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/StaticLibraryBinarySpec.html[StaticLibraryBinarySpec]
  Location of created binary;;
    `__${project.buildDir}__/libs/__${component.name}__/static/__${component.name}__.a`


[[sec:check_tasks]]
=== Check tasks

For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] that can be produced by a build, a single _check task_ is constructed that can be used to assemble and check that binary.

`check__${component.name}__Executable`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableBinarySpec.html[NativeExecutableBinarySpec]

`check__${component.name}__SharedLibrary`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/SharedLibraryBinarySpec.html[SharedLibraryBinarySpec]

`check__${component.name}__StaticLibrary`::
  Component Type;;
    link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec]
  Native Binary Type;;
    link:{javadocPath}/org/gradle/nativeplatform/SharedLibraryBinarySpec.html[SharedLibraryBinarySpec]

The built-in `check` task depends on all the _check tasks_ for binaries in the project. Without either <<#native_binaries:cunit,CUnit>> or <<#native_binaries:google_test,GoogleTest>> plugins, the binary check task only depends on the _lifecycle task_ that assembles the binary, see <<#sec:native_tasks,Native tasks>>.

When the <<#native_binaries:cunit,CUnit>> or <<#native_binaries:google_test,GoogleTest>> plugins are applied, the task that executes the test suites for a component are automatically wired to the appropriate _check task_.

You can also add custom check tasks as follows:

=== Example: Adding a custom check task

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/custom-check/build.gradle[tag=custom-check]
----



Now, running `check` or any of the _check tasks_ for the `hello` binaries will run the custom check task:

=== Example: Running checks for a given binary

.Output of **`gradle checkHelloSharedLibrary`**
----
> gradle checkHelloSharedLibrary
include::{snippetsPath}/native-binaries/custom-check/nativeComponentCustomCheckOutput.out[]
----


[[sec:working_with_shared_libraries]]
=== Working with shared libraries

For each executable binary produced, the `cpp` plugin provides an `install${binary.name}` task, which creates a development install of the executable, along with the shared libraries it requires. This allows you to run the executable without needing to install the shared libraries in their final locations.

[[sec:finding_out_more_about_your_project]]
== Finding out more about your project

Gradle provides a report that you can run from the command-line that shows some details about the components and binaries that your project produces. To use this report, just run `gradle components`. Below is an example of running this report for one of the sample projects:

=== Example: The components report

.Output of **`gradle components`**
----
> gradle components
include::{snippetsPath}/native-binaries/cpp/nativeComponentReport.out[]
----


[[native_binaries:languages]]
== Language support

Presently, Gradle supports building native software from any combination of source languages listed below. A native binary project will contain one or more named `FunctionalSourceSet` instances (e.g. 'main', 'test', etc), each of which can contain ``LanguageSourceSet``s containing source files, one for each language.

* C
* C++
* Objective-C
* Objective-C++
* Assembly
* Windows resources


[[sec:cpp_sources]]
=== C++ sources

C++ language support is provided by means of the `'cpp'` plugin.

=== Example: The 'cpp' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/cpp/build.gradle[tag=apply-plugin]
----

$$C++$$ sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.cpp.CppSourceSet.html[CppSourceSet], which defines a set of C++ source files and optionally a set of exported header files (for a library). By default, for any named component the link:{groovyDslPath}/org.gradle.language.cpp.CppSourceSet.html[CppSourceSet] contains `.cpp` source files in `src/${name}/cpp`, and header files in `src/${name}/headers`.

While the `cpp` plugin defines these default locations for each link:{groovyDslPath}/org.gradle.language.cpp.CppSourceSet.html[CppSourceSet], it is possible to extend or override these defaults to allow for a different project layout.

=== Example: C++ source set

[source.multi-language-sample,groovy,indent=0]
.build.gradle
----
include::{snippetsPath}/native-binaries/custom-layout/build.gradle[tag=cpp-sources]
----

For a library named 'main', header files in `src/main/headers` are considered the ""public"" or ""exported"" headers. Header files that should not be exported should be placed inside the `src/main/cpp` directory (though be aware that such header files should always be referenced in a manner relative to the file including them).

[[sec:c_sources]]
=== C sources

C language support is provided by means of the `'c'` plugin.

=== Example: The 'c' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/c/build.gradle[tag=apply-plugin]
----

C sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.c.CSourceSet.html[CSourceSet], which defines a set of C source files and optionally a set of exported header files (for a library). By default, for any named component the link:{groovyDslPath}/org.gradle.language.c.CSourceSet.html[CSourceSet] contains `.c` source files in `src/${name}/c`, and header files in `src/${name}/headers`.

While the `c` plugin defines these default locations for each link:{groovyDslPath}/org.gradle.language.c.CSourceSet.html[CSourceSet], it is possible to extend or override these defaults to allow for a different project layout.

=== Example: C source set

[source.multi-language-sample,groovy,indent=0]
.build.gradle
----
include::{snippetsPath}/native-binaries/custom-layout/build.gradle[tag=c-sources]
----

For a library named 'main', header files in `src/main/headers` are considered the ""public"" or ""exported"" headers. Header files that should not be exported should be placed inside the `src/main/c` directory (though be aware that such header files should always be referenced in a manner relative to the file including them).

[[sec:assembler_sources]]
=== Assembler sources

Assembly language support is provided by means of the `'assembler'` plugin.

=== Example: The 'assembler' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/assembler/build.gradle[tag=apply-plugin]
----

Assembler sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.assembler.AssemblerSourceSet.html[AssemblerSourceSet], which defines a set of Assembler source files. By default, for any named component the link:{groovyDslPath}/org.gradle.language.assembler.AssemblerSourceSet.html[AssemblerSourceSet] contains `.s` source files under `src/${name}/asm`.

[[sec:objectivec_sources]]
=== Objective-C sources

Objective-C language support is provided by means of the `'objective-c'` plugin.

=== Example: The 'objective-c' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/objective-c/build.gradle[tag=apply-plugin]
----

Objective-C sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.objectivec.ObjectiveCSourceSet.html[ObjectiveCSourceSet], which defines a set of Objective-C source files. By default, for any named component the link:{groovyDslPath}/org.gradle.language.objectivec.ObjectiveCSourceSet.html[ObjectiveCSourceSet] contains `.m` source files under `src/${name}/objectiveC`.

[[sec:objectivecpp_sources]]
=== Objective-C++ sources

Objective-C++ language support is provided by means of the `'objective-cpp'` plugin.

=== Example: The 'objective-cpp' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/objective-cpp/build.gradle[tag=apply-plugin]
----

Objective-C$$++$$ sources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.objectivecpp.ObjectiveCppSourceSet.html[ObjectiveCppSourceSet], which defines a set of Objective-C++ source files. By default, for any named component the link:{groovyDslPath}/org.gradle.language.objectivecpp.ObjectiveCppSourceSet.html[ObjectiveCppSourceSet] contains `.mm` source files under `src/${name}/objectiveCpp`.

[[sec:configuring_the_compiler_assembler_and_linker]]
== Configuring the compiler, assembler and linker

Each binary to be produced is associated with a set of compiler and linker settings, which include command-line arguments as well as macro definitions. These settings can be applied to all binaries, an individual binary, or selectively to a group of binaries based on some criteria.

=== Example: Settings that apply to all binaries

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/cpp/build.gradle[tag=all-binaries]
----

Each binary is associated with a particular link:{javadocPath}/org/gradle/nativeplatform/toolchain/NativeToolChain.html[NativeToolChain], allowing settings to be targeted based on this value.

It is easy to apply settings to all binaries of a particular type:

=== Example: Settings that apply to all shared libraries

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/c/build.gradle[tag=all-shared-libraries]
----

Furthermore, it is possible to specify settings that apply to all binaries produced for a particular `executable` or `library` component:

=== Example: Settings that apply to all binaries produced for the 'main' executable component

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/assembler/build.gradle[tag=assembler-args]
----

The example above will apply the supplied configuration to all `executable` binaries built.

Similarly, settings can be specified to target binaries for a component that are of a particular type: e.g. all shared libraries for the main library component.

=== Example: Settings that apply only to shared libraries produced for the 'main' library component

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/cpp-lib/build.gradle[tag=args]
----


[[native_binaries:windows-resources]]
== Windows Resources

When using the link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.VisualCpp.html[VisualCpp] tool chain, Gradle is able to compile Window Resource (`rc`) files and link them into a native binary. This functionality is provided by the `'windows-resources'` plugin.

=== Example: The 'windows-resources' plugin

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/windows-resources/build.gradle[tag=apply-plugin]
----

Windows resources to be included in a native binary are provided via a link:{groovyDslPath}/org.gradle.language.rc.WindowsResourceSet.html[WindowsResourceSet], which defines a set of Windows Resource source files. By default, for any named component the link:{groovyDslPath}/org.gradle.language.rc.WindowsResourceSet.html[WindowsResourceSet] contains `.rc` source files under `src/${name}/rc`.

As with other source types, you can configure the location of the windows resources that should be included in the binary.

=== Example: Configuring the location of Windows resource sources

[source.multi-language-sample,groovy,indent=0]
.build-resource-only-dll.gradle
----
include::{snippetsPath}/native-binaries/windows-resources/build-resource-only-dll.gradle[tag=windows-resource-set]
----

You are able to construct a resource-only library by providing Windows Resource sources with no other language sources, and configure the linker as appropriate:

=== Example: Building a resource-only dll

[source.multi-language-sample,groovy]
.build-resource-only-dll.gradle
----
include::{snippetsPath}/native-binaries/windows-resources/build-resource-only-dll.gradle[tag=resource-only-library]
----

The example above also demonstrates the mechanism of passing extra command-line arguments to the resource compiler. The `rcCompiler` extension is of type link:{javadocPath}/org/gradle/nativeplatform/PreprocessingTool.html[PreprocessingTool].

[[sec:library_dependencies]]
== Library Dependencies

Dependencies for native components are binary libraries that export header files. The header files are used during compilation, with the compiled binary dependency being used during linking and execution. Header files should be organized into subdirectories to prevent clashes of commonly named headers. For instance, if your `mylib` project has a `logging.h` header, it will make it less likely the wrong header is used if you include it as `""mylib/logging.h""` instead of `""logging.h""`.


[[sec:dependencies_within_the_same_project]]
=== Dependencies within the same project

A set of sources may depend on header files provided by another binary component within the same project. A common example is a native executable component that uses functions provided by a separate native library component.

Such a library dependency can be added to a source set associated with the `executable` component:

=== Example: Providing a library dependency to the source set

[source.multi-language-sample,groovy,indent=0]
.build.gradle
----
include::{snippetsPath}/native-binaries/cpp/build.gradle[tag=source-library]
----

Alternatively, a library dependency can be provided directly to the `NativeExecutableBinarySpec` for the `executable`.

=== Example: Providing a library dependency to the binary

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/custom-layout/build.gradle[tag=binary-library]
----


[[sec:project_dependencies]]
=== Project Dependencies

For a component produced in a different Gradle project, the notation is similar.

=== Example: Declaring project dependencies

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/multi-project/build.gradle[tag=project-dependencies]
----


[[native_binaries:preCompiledHeaders]]
== Precompiled Headers

Precompiled headers are a performance optimization that reduces the cost of compiling widely used headers multiple times. This feature _precompiles_ a header such that the compiled object file can be reused when compiling each source file rather than recompiling the header each time. This support is available for C, C+\\+, Objective-C, and Objective-C++ builds.

To configure a precompiled header, first a header file needs to be defined that includes all of the headers that should be precompiled. It must be specified as the first included header in every source file where the precompiled header should be used. It is assumed that this header file, and any headers it contains, make use of header guards so that they can be included in an idempotent manner. If header guards are not used in a header file, it is possible the header could be compiled more than once and could potentially lead to a broken build.

=== Example: Creating a precompiled header file

[source.multi-language-sample,c]
.src/hello/headers/pch.h
----
include::{snippetsPath}/native-binaries/pre-compiled-headers/src/hello/headers/pch.h[]
----

=== Example: Including a precompiled header file in a source file

[source.multi-language-sample,cpp]
.src/hello/cpp/hello.cpp
----
include::{snippetsPath}/native-binaries/pre-compiled-headers/src/hello/cpp/hello.cpp[]
----

Precompiled headers are specified on a source set. Only one precompiled header file can be specified on a given source set and will be applied to all source files that declare it as the first include. If a source files does not include this header file as the first header, the file will be compiled in the normal manner (without making use of the precompiled header object file). The string provided should be the same as that which is used in the ""#include"" directive in the source files.

=== Example: Configuring a precompiled header

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/pre-compiled-headers/build.gradle[tag=libraries]
----

A precompiled header must be included in the same way for all files that use it. Usually, this means the header file should exist in the source set ""headers"" directory or in a directory included on the compiler include path.

[[native_binaries:variants]]
== Native Binary Variants

For each executable or library defined, Gradle is able to build a number of different native binary variants. Examples of different variants include debug vs release binaries, 32-bit vs 64-bit binaries, and binaries produced with different custom preprocessor flags.

Binaries produced by Gradle can be differentiated on <<#native_binaries:build_type,build type>>, <<#native_binaries:platform,platform>>, and <<#native_binaries:flavor,flavor>>. For each of these 'variant dimensions', it is possible to specify a set of available values as well as target each component at one, some or all of these. For example, a plugin may define a range of support platforms, but you may choose to only target Windows-x86 for a particular component.


[[native_binaries:build_type]]
=== Build types

A `build type` determines various non-functional aspects of a binary, such as whether debug information is included, or what optimisation level the binary is compiled with. Typical build types are 'debug' and 'release', but a project is free to define any set of build types.

=== Example: Defining build types

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/variants/build.gradle[tag=build-types]
----

If no build types are defined in a project, then a single, default build type called 'debug' is added.

For a build type, a Gradle project will typically define a set of compiler/linker flags per tool chain.

=== Example: Configuring debug binaries

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/variants/build.gradle[tag=build-type-config]
----

[NOTE]
====
At this stage, it is completely up to the build script to configure the relevant compiler/linker flags for each build type. Future versions of Gradle will automatically include the appropriate debug flags for any 'debug' build type, and may be aware of various levels of optimisation as well.
====


[[native_binaries:platform]]
=== Platform

An executable or library can be built to run on different operating systems and cpu architectures, with a variant being produced for each platform. Gradle defines each OS/architecture combination as a link:{groovyDslPath}/org.gradle.nativeplatform.platform.NativePlatform.html[NativePlatform], and a project may define any number of platforms. If no platforms are defined in a project, then a single, default platform 'current' is added.

[NOTE]
====
Presently, a `Platform` consists of a defined operating system and architecture. As we continue to develop the native binary support in Gradle, the concept of Platform will be extended to include things like C-runtime version, Windows SDK, ABI, etc. Sophisticated builds may use the extensibility of Gradle to apply additional attributes to each platform, which can then be queried to specify particular includes, preprocessor macros or compiler arguments for a native binary.
====

=== Example: Defining platforms

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/variants/build.gradle[tag=platforms]
----

For a given variant, Gradle will attempt to find a link:{javadocPath}/org/gradle/nativeplatform/toolchain/NativeToolChain.html[NativeToolChain] that is able to build for the target platform. Available tool chains are searched in the order defined. See the <<#native_binaries:tool_chain,tool chains>> section below for more details.

[[native_binaries:flavor]]
=== Flavor

Each component can have a set of named `flavors`, and a separate binary variant can be produced for each flavor. While the `build type` and `target platform` variant dimensions have a defined meaning in Gradle, each project is free to define any number of flavors and apply meaning to them in any way.

An example of component flavors might differentiate between 'demo', 'paid' and 'enterprise' editions of the component, where the same set of sources is used to produce binaries with different functions.

=== Example: Defining flavors

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/flavors/build.gradle[tag=flavors]
----

In the example above, a library is defined with a 'english' and 'french' flavor. When compiling the 'french' variant, a separate macro is defined which leads to a different binary being produced.

If no flavor is defined for a component, then a single default flavor named 'default' is used.

[[sec:selecting_the_build_types_platforms_and_flavors_for_a_component]]
=== Selecting the build types, platforms and flavors for a component

For a default component, Gradle will attempt to create a native binary variant for each and every combination of `buildType` and `flavor` defined for the project. It is possible to override this on a per-component basis, by specifying the set of `targetBuildTypes` and/or `targetFlavors`. By default, Gradle will build for the default platform, see <<#native_binaries:platform,above>>, unless specified explicitly on a per-component basis by specifying a set of `targetPlatforms`.

=== Example: Targeting a component at particular platforms

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/variants/build.gradle[tag=target-platforms]
----

Here you can see that the link:{groovyDslPath}/org.gradle.nativeplatform.TargetedNativeComponent.html#org.gradle.nativeplatform.TargetedNativeComponent:targetPlatform(java.lang.String)[TargetedNativeComponent.targetPlatform(java.lang.String)] method is used to specify a platform that the `NativeExecutableSpec` named `main` should be built for.

A similar mechanism exists for selecting link:{groovyDslPath}/org.gradle.nativeplatform.TargetedNativeComponent.html#org.gradle.nativeplatform.TargetedNativeComponent:targetBuildTypes(java.lang.String++[]++)[TargetedNativeComponent.targetBuildTypes(java.lang.String...)] and link:{groovyDslPath}/org.gradle.nativeplatform.TargetedNativeComponent.html#org.gradle.nativeplatform.TargetedNativeComponent:targetFlavors(java.lang.String++[]++)[TargetedNativeComponent.targetFlavors(java.lang.String...)].

[[sec:building_all_possible_variants]]
=== Building all possible variants

When a set of build types, target platforms, and flavors is defined for a component, a link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] model element is created for every possible combination of these. However, in many cases it is not possible to build a particular variant, perhaps because no tool chain is available to build for a particular platform.

If a binary variant cannot be built for any reason, then the link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] associated with that variant will not be `buildable`. It is possible to use this property to create a task to generate all possible variants on a particular machine.

=== Example: Building all possible variants

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/tool-chains/build.gradle[tag=buildable]
----


[[native_binaries:tool_chain]]
== Tool chains

A single build may utilize different tool chains to build variants for different platforms. To this end, the core 'native-binary' plugins will attempt to locate and make available supported tool chains. However, the set of tool chains for a project may also be explicitly defined, allowing additional cross-compilers to be configured as well as allowing the install directories to be specified.


[[sec:defining_tool_chains]]
=== Defining tool chains

The supported tool chain types are:

* link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.Gcc.html[Gcc]
* link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.Clang.html[Clang]
* link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.VisualCpp.html[VisualCpp]

=== Example: Defining tool chains

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/tool-chains/build.gradle[tag=toolChains]
----

Each tool chain implementation allows for a certain degree of configuration (see the API documentation for more details).

[[sec:using_tool_chains]]
=== Using tool chains

It is not necessary or possible to specify the tool chain that should be used to build. For a given variant, Gradle will attempt to locate a link:{javadocPath}/org/gradle/nativeplatform/toolchain/NativeToolChain.html[NativeToolChain] that is able to build for the target platform. Available tool chains are searched in the order defined.

[NOTE]
====
When a platform does not define an architecture or operating system, the default target of the tool chain is assumed. So if a platform does not define a value for `operatingSystem`, Gradle will find the first available tool chain that can build for the specified `architecture`.
====

The core Gradle tool chains are able to target the following architectures out of the box. In each case, the tool chain will target the current operating system. See the next section for information on cross-compiling for other operating systems.

[cols=""a,a"", options=""header""]
|===
| Tool Chain
| Architectures

| GCC
| x86, x86_64

| Clang
| x86, x86_64

| Visual C++
| x86, x86_64, ia-64
|===

So for GCC running on linux, the supported target platforms are 'linux/x86' and 'linux/x86_64'. For GCC running on Windows via Cygwin, platforms 'windows/x86' and 'windows/x86_64' are supported. (The Cygwin POSIX runtime is not yet modelled as part of the platform, but will be in the future.)

If no target platforms are defined for a project, then all binaries are built to target a default platform named 'current'. This default platform does not specify any `architecture` or `operatingSystem` value, hence using the default values of the first available tool chain.

Gradle provides a _hook_ that allows the build author to control the exact set of arguments passed to a tool chain executable. This enables the build author to work around any limitations in Gradle, or assumptions that Gradle makes. The arguments hook should be seen as a 'last-resort' mechanism, with preference given to truly modelling the underlying domain.

=== Example: Reconfigure tool arguments

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/tool-chains/build.gradle[tag=withArguments]
----


[[sec:crosscompiling_with_gcc]]
=== Cross-compiling with GCC

Cross-compiling is possible with the link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.Gcc.html[Gcc] and link:{groovyDslPath}/org.gradle.nativeplatform.toolchain.Clang.html[Clang] tool chains, by adding support for additional target platforms. This is done by specifying a target platform for a toolchain. For each target platform a custom configuration can be specified.

=== Example: Defining target platforms

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/target-platforms/build.gradle[tag=targetplatforms]
----


[[native_binaries:visual_studio]]
== Visual Studio IDE integration

Gradle has the ability to generate Visual Studio project and solution files for the native components defined in your build. This ability is added by the `visual-studio` plugin. For a multi-project build, all projects with native components (and the root project) should have this plugin applied.

When the `visual-studio` plugin is applied to the root project, a task named `visualStudio` is created, which will generate a Visual Studio solution file containing all components in the build. This solution will include a Visual Studio project for each component, as well as configuring each component to build using Gradle.

A task named `openVisualStudio` is also created by the `visual-studio` plugin when the project is the root project. This task generates the Visual Studio solution and then opens the solution in Visual Studio. This means you can simply run `gradlew openVisualStudio` from the root project to generate and open the Visual Studio solution in one convenient step.

The content of the generated visual studio files can be modified via API hooks, provided by the `visualStudio` extension. Take a look at the 'visual-studio' sample, or see link:{groovyDslPath}/org.gradle.ide.visualstudio.VisualStudioExtension.html#org.gradle.ide.visualstudio.VisualStudioExtension:projects[VisualStudioExtension.getProjects()] and link:{groovyDslPath}/org.gradle.ide.visualstudio.VisualStudioRootExtension.html#org.gradle.ide.visualstudio.VisualStudioRootExtension:solution[VisualStudioRootExtension.getSolution()] in the API documentation for more details.

[[native_binaries:cunit]]
== CUnit support

The Gradle `cunit` plugin provides support for compiling and executing CUnit tests in your native-binary project. For each link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec] and link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec] defined in your project, Gradle will create a matching link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteSpec.html[CUnitTestSuiteSpec] component, named `${component.name}Test`.


[[sec:cunit_sources]]
=== CUnit sources

Gradle will create a link:{groovyDslPath}/org.gradle.language.c.CSourceSet.html[CSourceSet] named 'cunit' for each link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteSpec.html[CUnitTestSuiteSpec] component in the project. This source set should contain the cunit test files for the component under test. Source files can be located in the conventional location (`src/${component.name}Test/cunit`) or can be configured like any other source set.

Gradle initialises the CUnit test registry and executes the tests, utilising some generated CUnit launcher sources. Gradle will expect and call a function with the signature `void gradle_cunit_register()` that you can use to configure the actual CUnit suites and tests to execute.

=== Example: Registering CUnit tests

[source.multi-language-sample,c]
.suite_operators.c
----
include::{snippetsPath}/native-binaries/cunit/src/operatorsTest/c/suite_operators.c[]
----

[NOTE]
====
Due to this mechanism, your CUnit sources may not contain a `main` method since this will clash with the method provided by Gradle.
====


[[sec:building_cunit_executables]]
=== Building CUnit executables

A link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteSpec.html[CUnitTestSuiteSpec] component has an associated link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec] or link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec] component. For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] configured for the main component, a matching link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteBinarySpec.html[CUnitTestSuiteBinarySpec] will be configured on the test suite component. These test suite binaries can be configured in a similar way to any other binary instance:

=== Example: Configuring CUnit tests

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/cunit/build.gradle[tag=configure-test-binary]
----

[NOTE]
====
Both the CUnit sources provided by your project and the generated launcher require the core CUnit headers and libraries. Presently, this library dependency must be provided by your project for each link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteBinarySpec.html[CUnitTestSuiteBinarySpec].
====


[[sec:running_cunit_tests]]
=== Running CUnit tests

For each link:{groovyDslPath}/org.gradle.nativeplatform.test.cunit.CUnitTestSuiteBinarySpec.html[CUnitTestSuiteBinarySpec], Gradle will create a task to execute this binary, which will run all of the registered CUnit tests. Test results will be found in the `__${build.dir}__/test-results` directory.

=== Example: Running CUnit tests

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/cunit/build.gradle[tag=complete-example]
----

.Output of `gradle -q runOperatorsTestFailingCUnitExe`
----
> gradle -q runOperatorsTestFailingCUnitExe
include::{snippetsPath}/native-binaries/cunit/completeCUnitExample.out[]
----



[NOTE]
====

The current support for CUnit is quite rudimentary. Plans for future integration include:

* Allow tests to be declared with Javadoc-style annotations.
* Improved HTML reporting, similar to that available for JUnit.
* Real-time feedback for test execution.
* Support for additional test frameworks.

====


[[native_binaries:google_test]]
== GoogleTest support

The Gradle `google-test` plugin provides support for compiling and executing GoogleTest tests in your native-binary project. For each link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec] and link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec] defined in your project, Gradle will create a matching link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteSpec.html[GoogleTestTestSuiteSpec] component, named `${component.name}Test`.


[[sec:googletest_sources]]
=== GoogleTest sources

Gradle will create a link:{groovyDslPath}/org.gradle.language.cpp.CppSourceSet.html[CppSourceSet] named 'cpp' for each link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteSpec.html[GoogleTestTestSuiteSpec] component in the project. This source set should contain the GoogleTest test files for the component under test. Source files can be located in the conventional location (`src/${component.name}Test/cpp`) or can be configured like any other source set.

[[sec:building_googletest_executables]]
=== Building GoogleTest executables

A link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteSpec.html[GoogleTestTestSuiteSpec] component has an associated link:{javadocPath}/org/gradle/nativeplatform/NativeExecutableSpec.html[NativeExecutableSpec] or link:{javadocPath}/org/gradle/nativeplatform/NativeLibrarySpec.html[NativeLibrarySpec] component. For each link:{javadocPath}/org/gradle/nativeplatform/NativeBinarySpec.html[NativeBinarySpec] configured for the main component, a matching link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteBinarySpec.html[GoogleTestTestSuiteBinarySpec] will be configured on the test suite component. These test suite binaries can be configured in a similar way to any other binary instance:

=== Example: Registering GoogleTest tests

[source.multi-language-sample,groovy]
.build.gradle
----
include::{snippetsPath}/native-binaries/google-test/build.gradle[tag=configure-test-binary]
----


[NOTE]
====
The GoogleTest sources provided by your project require the core GoogleTest headers and libraries. Presently, this library dependency must be provided by your project for each link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteBinarySpec.html[GoogleTestTestSuiteBinarySpec].
====


[[sec:running_googletest_tests]]
=== Running GoogleTest tests

For each link:{groovyDslPath}/org.gradle.nativeplatform.test.googletest.GoogleTestTestSuiteBinarySpec.html[GoogleTestTestSuiteBinarySpec], Gradle will create a task to execute this binary, which will run all of the registered GoogleTest tests. Test results will be found in the `__${build.dir}__/test-results` directory.
[NOTE]
====

The current support for GoogleTest is quite rudimentary. Plans for future integration include:

* Improved HTML reporting, similar to that available for JUnit.
* Real-time feedback for test execution.
* Support for additional test frameworks.

====
",12044,False,2288.4654306054017,median
"/**
 * @file
 * @brief Реализация HTML редактора
 * @author Sergey N. Yatskevich <syatskevich@gmail.com>
 * @copyright SpectrumSoft. All rights reserved. This file is part of liboaf,
 *            distributed under the GNU GPL v2 with a Linking Exception. For
 *            full terms see the included COPYING file.
 */
#include <OAF/OAF.h>
#include <OAF/StreamUtils.h>
#include <OAF/Helpers.h>
#include <OAF/HelpersMIME.h>
#include <OAF/CNotifySource.h>

#include ""CHTMLEdit.h""

#include ""ui_CResizeDialog.h""
#include ""ui_CTableDialog.h""
#include ""ui_CInputDialog.h""
#include ""ui_CTableAppreance.h""

using namespace OAF::TXT;

//
// Запрашивает число у пользователя с помощью диалога
//
static int
askUserForNumber (QWidget* _parent, const QString& _title, const QString& _label, int _def_value = 1)
{
	//
	// Запрашиваем конкретное число строк с помощью диалога
	//
	QDialog dlg (_parent);
	Ui::CInputDialog input_dlg;
	input_dlg.setupUi (&dlg);
	dlg.setWindowTitle (_title);
	input_dlg.input_label->setText (_label);

	if (dlg.exec() != QDialog::Accepted)
		return (-1);

	bool ok = false;
	int res = input_dlg.data->text().toInt (&ok);
	if (!ok)
		res = _def_value;

	return res;
}

bool
CHTMLEdit::clipboardHasData ()
{
	if (const QMimeData* mime = QApplication::clipboard ()->mimeData ())
		return canInsertFromMimeData (mime);

	return false;
}

void
CHTMLEdit::mergeFormatOnWordOrSelection (const QTextCharFormat& _tcf)
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		if (!cursor.hasSelection ())
			cursor.select (QTextCursor::WordUnderCursor);
		cursor.mergeCharFormat (_tcf);
		mergeCurrentCharFormat (_tcf);
	}
}

void
CHTMLEdit::dropImage (const QImage& _image)
{
	// Максимальный размер в байтах изображения, которое можно вставить в редактор
	// в виде raw-data без получения тормозов
	// NOTE: это размер уже распакованных данных в памяти!
	// за счет сжатия, включенного например для png,
	// размер такого файла на диске будет заметно меньше - вплоть до двух раз и выше
	const int MAX_EMBED_SIZE = 300*1024;    // 300 КiB

	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		if (!_image.isNull ())
		{
			//
			// Предлагаем пользователю вставить изображение-переросток в качестве ссылки на файл,
			// для чего картинку придется предварительно сохранить на диск
			//
			if (_image.sizeInBytes () > MAX_EMBED_SIZE)
			{
				const QString msg = tr (""The image in the clipboard have too large size to be embedded in document directly.\\n""
										""Do you want to save this image as file and embed it as link?"");
				if (QMessageBox::question (this, tr (""Warning""), msg, QMessageBox::Save, QMessageBox::Cancel) == QMessageBox::Save)
				{
					QString file = QFileDialog::getSaveFileName (this, tr (""Select an image to insert""), ""."",
																 m_all_images_filter);
					if (!file.isEmpty())
					{
						if (_image.save (file))
							cursor.insertImage (OAF::fromLocalFile (file).toString ());
						else
							QMessageBox::warning (this, tr (""Warning""),
												  tr (""Could not save image in specified location"") + "" \\"""" + file + ""\\"""");
					}
				}
			}
			else
			{
				//
				// Создаём описатель raw данных
				//
				if (URef<OAF::IIODevice> d = OAF::createFromName<OAF::IIODevice> (""raw:""))
				{
					//
					// Открываем его на запись
					//
					if (d->device ()->open (QIODevice::WriteOnly))
					{
						//
						// Сохраняем в заданном описателе в формате PNG (данный формат сохраняет прозрачность)
						//
						if (_image.save (d->device (), ""PNG""))
						{
							//
							// Закрываем, чтобы гарантировать, что все данные записаны
							//
							d->device ()->close ();

							//
							// Сохраняем изображение в документе
							//
							cursor.insertImage (d->getInfo (OAF::IIODevice::PATH).toString ());
						}
					}
				}
			}
		}
	}
}

void
CHTMLEdit::dropTextFile (const QUrl& _url)
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		QFile file (OAF::toLocalFile (_url));
		if (file.open (QIODevice::ReadOnly | QIODevice::Text))
			cursor.insertText (file.readAll ());
	}
}

void
CHTMLEdit::fontChanged (const QFont& _f)
{
	m_font_list_widget->setCurrentFont (_f);
	m_size_list_widget->setCurrentIndex (m_size_list_widget->findText (QString::number (_f.pointSize ())));

	m_bold_action->setChecked (_f.bold ());
	m_italic_action->setChecked (_f.italic ());
	m_underline_action->setChecked (_f.underline ());
}

void
CHTMLEdit::colorChanged (const QColor& _c)
{
	QPixmap pix (16, 16);
	pix.fill (_c);
	m_color_action->setIcon (pix);
}

void
CHTMLEdit::alignmentChanged (Qt::Alignment _a)
{
	if (_a & Qt::AlignLeft)
		m_align_left_action->setChecked (true);
	else if (_a & Qt::AlignHCenter)
		m_align_center_action->setChecked (true);
	else if (_a & Qt::AlignRight)
		m_align_right_action->setChecked (true);
	else if (_a & Qt::AlignJustify)
		m_align_justify_action->setChecked (true);
}

void
CHTMLEdit::listStyleChanged (QTextListFormat::Style _style)
{
	int style_index = 0;
	switch (_style)
	{
		case QTextListFormat::ListDisc:
			style_index = 1;
			break;
		case QTextListFormat::ListCircle:
			style_index = 2;
			break;
		case QTextListFormat::ListSquare:
			style_index = 3;
			break;
		case QTextListFormat::ListDecimal:
			style_index = 4;
			break;
		case  QTextListFormat::ListLowerAlpha:
			style_index = 5;
			break;
		case QTextListFormat::ListUpperAlpha:
			style_index = 6;
			break;
		case QTextListFormat::ListLowerRoman:
			style_index = 7;
			break;
		case QTextListFormat::ListUpperRoman:
			style_index = 8;
			break;
		default:
			break;
	}

	m_list_style_widget->setCurrentIndex (style_index);
}

void
CHTMLEdit::createEditActions ()
{
	m_undo_action = new QAction (tr (""&Undo""), this);
	m_undo_action->setIcon (QIcon::fromTheme (""edit-undo"", QIcon ("":/liboaf-txt/icons/editundo.png"")));
	m_undo_action->setPriority (QAction::LowPriority);
	m_undo_action->setShortcut (QKeySequence::Undo);
	m_undo_action->setObjectName (""ui:htmledit:undo"");

	m_redo_action = new QAction (tr (""&Redo""), this);
	m_redo_action->setIcon (QIcon::fromTheme (""edit-redo"", QIcon ("":/liboaf-txt/icons/editredo.png"")));
	m_redo_action->setPriority (QAction::LowPriority);
	m_redo_action->setShortcut (QKeySequence::Redo);
	m_redo_action->setObjectName (""ui:htmledit:redo"");

	m_cut_action = new QAction (tr (""Cu&t""), this);
	m_cut_action->setIcon (QIcon::fromTheme (""edit-cut"", QIcon ("":/liboaf-txt/icons/editcut.png"")));
	m_cut_action->setPriority (QAction::LowPriority);
	m_cut_action->setShortcut (QKeySequence::Cut);
	m_cut_action->setObjectName (""ui:htmledit:cut"");

	m_copy_action = new QAction (tr (""&Copy""), this);
	m_copy_action->setIcon (QIcon::fromTheme (""edit-copy"", QIcon ("":/liboaf-txt/icons/editcopy.png"")));
	m_copy_action->setPriority (QAction::LowPriority);
	m_copy_action->setShortcut (QKeySequence::Copy);
	m_copy_action->setObjectName (""ui:htmledit:copy"");

	m_paste_action = new QAction (tr (""&Paste""), this);
	m_paste_action->setIcon (QIcon::fromTheme (""edit-paste"", QIcon ("":/liboaf-txt/icons/editpaste.png"")));
	m_paste_action->setPriority (QAction::LowPriority);
	m_paste_action->setShortcut (QKeySequence::Paste);
	m_paste_action->setObjectName (""ui:htmledit:paste"");
	m_paste_action->setEnabled (clipboardHasData ());

	m_delete_action = new QAction (tr (""Delete""), this);
	m_delete_action->setPriority (QAction::LowPriority);
	m_delete_action->setObjectName (""ui:htmledit:delete"");
	m_delete_action->setEnabled (m_document && !m_document->isEmpty ());

	m_select_all_action = new QAction (tr (""Select &All""), this);
	m_select_all_action->setPriority (QAction::LowPriority);
	m_select_all_action->setObjectName (""ui:htmledit:select_all"");
	m_select_all_action->setShortcut (QKeySequence::SelectAll);
	m_select_all_action->setEnabled (m_document && !m_document->isEmpty ());

	m_image_action = new QAction (tr(""&Insert image""), this);
	m_image_action->setIcon (QIcon::fromTheme (""insert-image"", QIcon ("":/liboaf-txt/icons/image_add.png"")));
	m_image_action->setPriority (QAction::LowPriority);
	//TODO: m_image_action->setShortcut(Qt::CTRL + Qt::Key_I);
	m_image_action->setObjectName (""ui:htmledit:insert_image"");

	m_resize_action = new QAction (tr(""Resize image""), this);
	m_resize_action->setIcon (QIcon::fromTheme (""resize-image"", QIcon ("":/liboaf-txt/icons/image_resize.png"")));
	m_resize_action->setPriority (QAction::LowPriority);
	//TODO: m_resize_action->setShortcut (Qt::CTRL + Qt::Key_R);
	m_resize_action->setObjectName (""ui:htmledit:resize_image"");
}

void
CHTMLEdit::createTextActions ()
{
	m_bold_action = new QAction (tr (""&Bold""), this);
	m_bold_action->setIcon (QIcon::fromTheme (""format-text-bold"", QIcon ("":/liboaf-txt/icons/textbold.png"")));
	m_bold_action->setShortcut (Qt::CTRL + Qt::Key_B);
	m_bold_action->setPriority (QAction::LowPriority);
	m_bold_action->setObjectName (""ui:htmledit:bold"");
	QFont bold_font;
	bold_font.setBold(true);
	m_bold_action->setFont (bold_font);
	m_bold_action->setCheckable (true);
	connect (m_bold_action, SIGNAL (triggered ()), this, SLOT (aboutTextBold ()));

	m_italic_action = new QAction (tr (""&Italic""), this);
	m_italic_action->setIcon (QIcon::fromTheme (""format-text-italic"", QIcon ("":/liboaf-txt/icons/textitalic.png"")));
	m_italic_action->setPriority (QAction::LowPriority);
	m_italic_action->setShortcut (Qt::CTRL + Qt::Key_I);
	m_italic_action->setObjectName (""ui:htmledit:italic"");
	QFont italic_font;
	italic_font.setItalic(true);
	m_italic_action->setFont (italic_font);
	m_italic_action->setCheckable(true);
	connect (m_italic_action, SIGNAL (triggered ()), this, SLOT (aboutTextItalic ()));

	m_underline_action = new QAction (tr (""&Underline""), this);
	m_underline_action->setIcon (QIcon::fromTheme (""format-text-underline"", QIcon ("":/liboaf-txt/icons/textunder.png"")));
	m_underline_action->setShortcut (Qt::CTRL + Qt::Key_U);
	m_underline_action->setPriority (QAction::LowPriority);
	m_underline_action->setObjectName (""ui:htmledit:underline"");
	QFont underline_font;
	underline_font.setUnderline (true);
	m_underline_action->setFont (underline_font);
	m_underline_action->setCheckable(true);
	connect (m_underline_action, SIGNAL (triggered ()), this, SLOT (aboutTextUnderline ()));

	m_alignment = new QActionGroup (this);
	m_alignment->setObjectName (""ui:htmledit:alignment"");
	connect (m_alignment, SIGNAL (triggered (QAction*)), this, SLOT (aboutTextAlign (QAction*)));

	m_align_left_action = new QAction (tr (""&Left""), m_alignment);
	m_align_left_action->setIcon (QIcon::fromTheme (""format-justify-left"", QIcon ("":/liboaf-txt/icons/textleft.png"")));
	m_align_left_action->setShortcut (Qt::CTRL + Qt::Key_L);
	m_align_left_action->setCheckable (true);
	m_align_left_action->setPriority (QAction::LowPriority);
	m_align_left_action->setObjectName (""ui:htmledit:alignment:left"");

	m_align_center_action = new QAction (tr (""C&enter""), m_alignment);
	m_align_center_action->setIcon (QIcon::fromTheme (""format-justify-center"", QIcon ("":/liboaf-txt/icons/textcenter.png"")));
	m_align_center_action->setShortcut (Qt::CTRL + Qt::Key_E);
	m_align_center_action->setCheckable (true);
	m_align_center_action->setPriority (QAction::LowPriority);
	m_align_center_action->setObjectName (""ui:htmledit:alignment:center"");

	m_align_right_action = new QAction (tr (""&Right""), m_alignment);
	m_align_right_action->setIcon (QIcon::fromTheme (""format-justify-right"", QIcon ("":/liboaf-txt/icons/textright.png"")));
	m_align_right_action->setShortcut (Qt::CTRL + Qt::Key_R);
	m_align_right_action->setCheckable (true);
	m_align_right_action->setPriority (QAction::LowPriority);
	m_align_right_action->setObjectName (""ui:htmledit:alignment:right"");

	m_align_justify_action = new QAction (tr (""&Justify""), m_alignment);
	m_align_justify_action->setIcon (QIcon::fromTheme(""format-justify-fill"", QIcon("":/liboaf-txt/icons/textjustify.png"")));
	m_align_justify_action->setShortcut (Qt::CTRL + Qt::Key_J);
	m_align_justify_action->setCheckable (true);
	m_align_justify_action->setPriority (QAction::LowPriority);
	m_align_justify_action->setObjectName (""ui:htmledit:alignment:justify"");

	QPixmap pix (16, 16);
	pix.fill (Qt::black);
	m_color_action = new QAction (pix, tr (""&Color ...""), this);
	m_color_action->setObjectName (""ui:htmledit:color"");
	connect (m_color_action, SIGNAL (triggered ()), this, SLOT (aboutTextColorChanged ()));
}

void
CHTMLEdit::createListActions ()
{
	m_inc_indent_action = new QAction (tr (""Increase Indent""), this);
	m_inc_indent_action->setIcon (QIcon::fromTheme (""format-indent-more"", QIcon ("":/liboaf-txt/icons/inc_indent.png"")));
	m_inc_indent_action->setShortcut (Qt::ALT + Qt::Key_Right);
	m_inc_indent_action->setPriority (QAction::LowPriority);
	m_inc_indent_action->setObjectName (""ui:htmledit:increase_indent"");
	connect (m_inc_indent_action, SIGNAL (triggered ()), this, SLOT (aboutIndentListMore ()));

	m_dec_indent_action = new QAction (tr (""Decrease Indent""), this);
	m_dec_indent_action->setIcon (QIcon::fromTheme (""format-indent-less"", QIcon ("":/liboaf-txt/icons/dec_indent.png"")));
	m_dec_indent_action->setShortcut (Qt::ALT + Qt::Key_Left);
	m_dec_indent_action->setPriority (QAction::LowPriority);
	m_dec_indent_action->setObjectName (""ui:htmledit:decrease_indent"");
	connect (m_dec_indent_action, SIGNAL (triggered ()), this, SLOT (aboutIndentListLess ()));
}

void
CHTMLEdit::createTableActions ()
{
	m_insert_table_action = new QAction (tr (""Insert Table""), this);
	m_insert_table_action->setIcon (QIcon::fromTheme (""format-insert-table"", QIcon ("":/liboaf-txt/icons/insert_table.png"")));
	//m_insert_table_action->setShortcut (Qt::ALT + Qt::Key_Right);
	m_insert_table_action->setPriority (QAction::LowPriority);
	m_insert_table_action->setObjectName (""ui:htmledit:insert_table"");
	connect (m_insert_table_action, SIGNAL (triggered ()), this, SLOT (aboutInsertTable ()));

	m_remove_row_action = new QAction (tr (""Remove current row""), this);
	m_remove_row_action->setObjectName (""ui:htmledit:remove_row"");
	m_remove_row_action->setEnabled (false);
	connect (m_remove_row_action, SIGNAL (triggered ()), this, SLOT (aboutRemoveRow ()));

	m_remove_col_action = new QAction (tr (""Remove current column""), this);
	m_remove_col_action->setObjectName (""ui:htmledit:remove_col"");
	m_remove_col_action->setEnabled (false);
	connect (m_remove_col_action, SIGNAL (triggered ()), this, SLOT (aboutRemoveCol ()));

	m_sig_mapper_row = new QSignalMapper (this);
	connect (m_sig_mapper_row, SIGNAL (mapped (int)), this, SLOT (aboutAddRow (int)));

	m_add_row_action_1 = new QAction (""1"", this);
	m_add_row_action_1->setObjectName (""ui:htmledit:add_1_row"");
	m_add_row_action_1->setEnabled (false);
	m_sig_mapper_row->setMapping (m_add_row_action_1, 1);
	connect (m_add_row_action_1, SIGNAL (triggered ()), m_sig_mapper_row, SLOT (map ()));

	m_add_row_action_2 = new QAction (""2"", this);
	m_add_row_action_2->setObjectName (""ui:htmledit:add_2_row"");
	m_add_row_action_2->setEnabled (false);
	m_sig_mapper_row->setMapping (m_add_row_action_2, 2);
	connect (m_add_row_action_2, SIGNAL (triggered ()), m_sig_mapper_row, SLOT (map ()));

	m_add_row_action_3 = new QAction (""3"", this);
	m_add_row_action_3->setObjectName (""ui:htmledit:add_3_row"");
	m_add_row_action_3->setEnabled (false);
	m_sig_mapper_row->setMapping (m_add_row_action_3, 3);
	connect (m_add_row_action_3, SIGNAL (triggered ()), m_sig_mapper_row, SLOT (map ()));

	m_add_row_action_4 = new QAction (""4"", this);
	m_add_row_action_4->setObjectName (""ui:htmledit:add_4_row"");
	m_add_row_action_4->setEnabled (false);
	m_sig_mapper_row->setMapping (m_add_row_action_4, 4);
	connect (m_add_row_action_4, SIGNAL (triggered ()), m_sig_mapper_row, SLOT (map ()));

	m_add_row_action_n = new QAction (tr (""Custom ...""), this);
	m_add_row_action_n->setObjectName (""ui:htmledit:add_n_row"");
	m_add_row_action_n->setEnabled (false);
	m_sig_mapper_row->setMapping (m_add_row_action_n, -1);
	connect (m_add_row_action_n, SIGNAL (triggered ()), m_sig_mapper_row, SLOT (map ()));

	m_sig_mapper_col = new QSignalMapper (this);
	connect (m_sig_mapper_col, SIGNAL (mapped (int)), this, SLOT (aboutAddCol (int)));

	m_add_col_action_1 = new QAction (""1"", this);
	m_add_col_action_1->setObjectName (""ui:htmledit:add_1_col"");
	m_add_col_action_1->setEnabled (false);
	m_sig_mapper_col->setMapping (m_add_col_action_1, 1);
	connect (m_add_col_action_1, SIGNAL (triggered ()), m_sig_mapper_col, SLOT (map ()));

	m_add_col_action_2 = new QAction (""2"", this);
	m_add_col_action_2->setObjectName (""ui:htmledit:add_2_col"");
	m_add_col_action_2->setEnabled (false);
	m_sig_mapper_col->setMapping (m_add_col_action_2, 2);
	connect (m_add_col_action_2, SIGNAL (triggered ()), m_sig_mapper_col, SLOT (map ()));

	m_add_col_action_3 = new QAction (""3"", this);
	m_add_col_action_3->setObjectName (""ui:htmledit:add_3_col"");
	m_add_col_action_3->setEnabled (false);
	m_sig_mapper_col->setMapping (m_add_col_action_3, 3);
	connect (m_add_col_action_3, SIGNAL (triggered ()), m_sig_mapper_col, SLOT (map ()));

	m_add_col_action_4 = new QAction (""4"", this);
	m_add_col_action_4->setObjectName (""ui:htmledit:add_4_col"");
	m_add_col_action_4->setEnabled (false);
	m_sig_mapper_col->setMapping (m_add_col_action_4, 4);
	connect (m_add_col_action_4, SIGNAL (triggered ()), m_sig_mapper_col, SLOT (map ()));

	m_add_col_action_n = new QAction (tr (""Custom ...""), this);
	m_add_col_action_n->setObjectName (""ui:htmledit:add_n_col"");
	m_add_col_action_n->setEnabled (false);
	m_sig_mapper_col->setMapping (m_add_col_action_n, -1);
	connect (m_add_col_action_n, SIGNAL (triggered ()), m_sig_mapper_col, SLOT (map ()));

	m_merge_adjacent_cells_action = new QAction (tr (""Merge two adjacent cells""), this);
	m_merge_adjacent_cells_action->setObjectName (""ui:htmledit:merge_cells"");
	m_merge_adjacent_cells_action->setEnabled (false);
	connect (m_merge_adjacent_cells_action, SIGNAL (triggered ()), this, SLOT (aboutMergeCells ()));

	m_split_cell_action = new QAction (tr (""Split the cell into two ones""), this);
	m_split_cell_action->setObjectName (""ui:htmledit:split_cells"");
	m_split_cell_action->setEnabled (false);
	connect (m_split_cell_action, SIGNAL(triggered ()), this, SLOT (aboutSplitCells ()));

	m_table_appreance_action = new QAction (tr (""Setup table appreance ...""), this);
	m_table_appreance_action->setObjectName (""ui:htmledit:table_appreance"");
	m_table_appreance_action->setEnabled (false);
	connect (m_table_appreance_action, SIGNAL(triggered ()), this, SLOT (aboutTableAppreance()));

	m_change_rows_height_action = new QAction (tr (""Change rows height ...""), this);
	m_change_rows_height_action->setObjectName (""ui:htmledit:rows_height"");
	m_change_rows_height_action->setEnabled (false);
	connect (m_change_rows_height_action, SIGNAL(triggered ()), this, SLOT (aboutRowsHeight ()));

	m_change_cols_width_action = new QAction (tr (""Change columns width ...""), this);
	m_change_cols_width_action->setObjectName (""ui:htmledit:cols_width"");
	m_change_cols_width_action->setEnabled (false);
	connect (m_change_cols_width_action, SIGNAL(triggered ()), this, SLOT (aboutColsWidth ()));
}

void
CHTMLEdit::createFontComboAction ()
{
	//
	// Создаём список шрифтов
	//
	m_font_list_widget = new QFontComboBox ();
	m_font_list_widget->setToolTip (tr (""Font of selected text""));

	QSizePolicy sp = m_font_list_widget->sizePolicy ();
	sp.setHorizontalPolicy (QSizePolicy::Maximum);
	m_font_list_widget->setSizePolicy (sp);
	m_font_list_widget->setSizeAdjustPolicy (QComboBox::AdjustToMinimumContentsLengthWithIcon);
	connect (m_font_list_widget, SIGNAL (activated (QString)), this, SLOT (aboutTextFamily (QString)));

	//
	// Создаём действие для добавления списка фонтов в панель инструментов.
	// Действие будет владеть виджетом и удалит его при своём удалении
	//
	m_font_list = new QWidgetAction (this);
	m_font_list->setDefaultWidget (m_font_list_widget);
	m_font_list->setObjectName (""ui:htmledit:fontlist"");
}

void
CHTMLEdit::createSizeComboAction ()
{
	//
	// Создаём список размеров
	//
	m_size_list_widget = new QComboBox ();
	m_size_list_widget->setToolTip (tr (""Size of selected text""));

	m_size_list_widget->setEditable (true);
	m_size_list_widget->setSizeAdjustPolicy (QComboBox::AdjustToContentsOnFirstShow);

	//
	// Добавляем все доступные в данной системе размеры шрифтов в соответствующий список.
	//
	QFontDatabase db;
	foreach (int size, db.standardSizes ())
		m_size_list_widget->addItem (QString::number (size));

	connect (m_size_list_widget, SIGNAL (activated (QString)), this, SLOT (aboutTextSize (QString)));

	//
	// Устанавливаем размер шрифта по умолчанию (запрашиваем у объекта приложения).
	//
	int default_pt_size = QApplication::font().pointSize();
	m_size_list_widget->setCurrentIndex (m_size_list_widget->findText (QString::number (default_pt_size)));

	//
	// Создаём экшен для добавления списка размеров в тулбар. Экшен будет владеть виджетом
	// и удалит его при своём удалении
	//
	m_size_list = new QWidgetAction (this);
	m_size_list->setDefaultWidget (m_size_list_widget);
	m_size_list->setObjectName (""ui:htmledit:fontsize"");
}

void
CHTMLEdit::createListComboAction ()
{
	//
	// Создаём список размеров
	//
	m_list_style_widget = new QComboBox ();
	m_list_style_widget->setToolTip (tr (""List style of selected text""));

	m_list_style_widget->addItem (tr (""Standard""));
	m_list_style_widget->addItem (tr (""Bullet List (Disc)""));
	m_list_style_widget->addItem (tr (""Bullet List (Circle)""));
	m_list_style_widget->addItem (tr (""Bullet List (Square)""));
	m_list_style_widget->addItem (tr (""Ordered List (Decimal)""));
	m_list_style_widget->addItem (tr (""Ordered List (Alpha lower)""));
	m_list_style_widget->addItem (tr (""Ordered List (Alpha upper)""));
	m_list_style_widget->addItem (tr (""Ordered List (Roman lower)""));
	m_list_style_widget->addItem (tr (""Ordered List (Roman upper)""));

	QSizePolicy sp = m_list_style_widget->sizePolicy ();
	sp.setHorizontalPolicy (QSizePolicy::Maximum);
	m_list_style_widget->setSizePolicy (sp);
	m_list_style_widget->setSizeAdjustPolicy (QComboBox::AdjustToContentsOnFirstShow);

	connect (m_list_style_widget, SIGNAL (activated (int)), this, SLOT (aboutListStyle (int)));

	//
	// Создаём экшен для добавления списка в тулбар. Экшен будет владеть виджетом
	// и удалит его при своём удалении
	//
	m_list_style = new QWidgetAction (this);
	m_list_style->setDefaultWidget (m_list_style_widget);
	m_list_style->setObjectName (""ui:htmledit:liststyle"");
}

void
CHTMLEdit::createContextMenu ()
{
	m_context_menu = new QMenu (this);

	m_context_menu->addAction (m_undo_action);
	m_context_menu->addAction (m_redo_action);

	m_context_menu->addSeparator ();
	m_context_menu->addAction (m_cut_action);
	m_context_menu->addAction (m_copy_action);
	m_context_menu->addAction (m_paste_action);
	m_context_menu->addAction (m_delete_action);

	m_context_menu->addSeparator ();
	m_context_menu->addAction (m_select_all_action);

	m_context_menu->addSeparator ();
	m_context_menu->addAction (m_remove_row_action);
	m_context_menu->addAction (m_remove_col_action);

	m_add_rows_submenu = m_context_menu->addMenu (tr (""Add rows before selected""));
	m_add_rows_submenu->addAction (m_add_row_action_1);
	m_add_rows_submenu->addAction (m_add_row_action_2);
	m_add_rows_submenu->addAction (m_add_row_action_3);
	m_add_rows_submenu->addAction (m_add_row_action_4);
	m_add_rows_submenu->addAction (m_add_row_action_n);

	m_add_cols_submenu = m_context_menu->addMenu (tr (""Add columns before selected""));
	m_add_cols_submenu->addAction (m_add_col_action_1);
	m_add_cols_submenu->addAction (m_add_col_action_2);
	m_add_cols_submenu->addAction (m_add_col_action_3);
	m_add_cols_submenu->addAction (m_add_col_action_4);
	m_add_cols_submenu->addAction (m_add_col_action_n);

	m_context_menu->addAction (m_merge_adjacent_cells_action);
	m_context_menu->addAction (m_split_cell_action);

	m_context_menu->addSeparator ();
	m_context_menu->addAction (m_table_appreance_action);
//	m_context_menu->addAction (m_change_rows_height_action);
	m_context_menu->addAction (m_change_cols_width_action);
}

void
CHTMLEdit::setupActions ()
{
	//
	// Ловим undo/redo от документа
	//
	connect (document (), SIGNAL (modificationChanged (bool)), this, SLOT (setWindowModified (bool)));
	connect (this, SIGNAL (undoAvailable (bool)), m_undo_action, SLOT (setEnabled (bool)));
	connect (this, SIGNAL (redoAvailable (bool)), m_redo_action, SLOT (setEnabled (bool)));

	m_undo_action->setEnabled (document ()->isUndoAvailable ());
	m_redo_action->setEnabled (document ()->isRedoAvailable ());

	connect (m_undo_action, SIGNAL (triggered ()), this, SLOT (undo ()));
	connect (m_redo_action, SIGNAL (triggered ()), this, SLOT (redo ()));

	//
	// Настраиваем действия вырезания/копирования/вставки
	//
	m_cut_action->setEnabled (false);
	m_copy_action->setEnabled (false);

	connect (m_cut_action, SIGNAL(triggered ()), this, SLOT (cut()));
	connect (m_copy_action, SIGNAL(triggered ()), this, SLOT (copy()));
	connect (m_paste_action, SIGNAL(triggered ()), this, SLOT (paste()));
	connect (m_delete_action, SIGNAL(triggered ()), this, SLOT (clear ()));
	connect (m_select_all_action, SIGNAL(triggered ()), this, SLOT (selectAll ()));

	connect (this, SIGNAL (copyAvailable (bool)), m_cut_action, SLOT (setEnabled (bool)));
	connect (this, SIGNAL (copyAvailable (bool)), m_copy_action, SLOT (setEnabled (bool)));

	//
	// Настраиваем вставку изображения и другие операции с ним
	//
	connect (m_image_action, SIGNAL (triggered ()), this, SLOT (aboutInsertImage ()));
	connect (m_resize_action, SIGNAL (triggered ()), this, SLOT (aboutResizeImage ()));
}

void
CHTMLEdit::enableTableActions (bool _enable)
{
	m_remove_row_action->setEnabled (_enable);
	m_remove_col_action->setEnabled (_enable);

	m_add_row_action_1->setEnabled (_enable);
	m_add_row_action_2->setEnabled (_enable);
	m_add_row_action_3->setEnabled (_enable);
	m_add_row_action_4->setEnabled (_enable);
	m_add_row_action_n->setEnabled (_enable);

	m_add_col_action_1->setEnabled (_enable);
	m_add_col_action_2->setEnabled (_enable);
	m_add_col_action_3->setEnabled (_enable);
	m_add_col_action_4->setEnabled (_enable);
	m_add_col_action_n->setEnabled (_enable);

	m_merge_adjacent_cells_action->setEnabled (_enable);
	m_split_cell_action->setEnabled (_enable);
	m_table_appreance_action->setEnabled (_enable);
	m_change_rows_height_action->setEnabled (_enable);
	m_change_cols_width_action->setEnabled (_enable);
}

void
CHTMLEdit::notify ( OAF::IInterface* _event, OAF::INotifySource* _source, OAF::INotifyListener* _origin)
{
	Q_UNUSED (_event);
	Q_UNUSED (_source);
	Q_UNUSED (_origin);

	//
	// Если документ пуст, то блокируем delete и select_all
	//
	m_delete_action->setEnabled (m_document && !m_document->isEmpty ());
	m_select_all_action->setEnabled (m_document && !m_document->isEmpty ());
}

void
CHTMLEdit::aboutTextBold ()
{
	QTextCharFormat fmt;
	fmt.setFontWeight (m_bold_action->isChecked() ? QFont::Bold : QFont::Normal);
	mergeFormatOnWordOrSelection (fmt);
}

void
CHTMLEdit::aboutTextItalic ()
{
	QTextCharFormat fmt;
	fmt.setFontItalic (m_italic_action->isChecked());
	mergeFormatOnWordOrSelection (fmt);
}

void
CHTMLEdit::aboutTextUnderline ()
{
	QTextCharFormat fmt;
	fmt.setFontUnderline (m_underline_action->isChecked());
	mergeFormatOnWordOrSelection (fmt);
}

void
CHTMLEdit::aboutTextFamily (const QString& _f)
{
	QTextCharFormat fmt;
	fmt.setFontFamily (_f);
	mergeFormatOnWordOrSelection (fmt);
}

void
CHTMLEdit::aboutTextSize (const QString& _p)
{
	qreal point_size = _p.toFloat();
	if (_p.toFloat() > 0)
	{
		QTextCharFormat fmt;
		fmt.setFontPointSize (point_size);
		mergeFormatOnWordOrSelection (fmt);
	}
}

void
CHTMLEdit::aboutListStyle (int _style_index)
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		if (_style_index != 0)
		{
			QTextListFormat::Style style = QTextListFormat::ListDisc;

			switch (_style_index)
			{
				case 1:
					style = QTextListFormat::ListDisc;
					break;
				case 2:
					style = QTextListFormat::ListCircle;
					break;
				case 3:
					style = QTextListFormat::ListSquare;
					break;
				case 4:
					style = QTextListFormat::ListDecimal;
					break;
				case 5:
					style = QTextListFormat::ListLowerAlpha;
					break;
				case 6:
					style = QTextListFormat::ListUpperAlpha;
					break;
				case 7:
					style = QTextListFormat::ListLowerRoman;
					break;
				case 8:
					style = QTextListFormat::ListUpperRoman;
					break;
				default:
					break;
			}

			cursor.beginEditBlock ();

			QTextBlockFormat block_fmt = cursor.blockFormat ();
			QTextListFormat list_fmt;
			if (cursor.currentList ())
			{
				list_fmt = cursor.currentList ()->format ();
			}
			else
			{
				list_fmt.setIndent(block_fmt.indent () + 1);
				block_fmt.setIndent (0);
				cursor.setBlockFormat (block_fmt);
			}
			list_fmt.setStyle (style);
			cursor.createList (list_fmt);
			cursor.endEditBlock ();
		}
		else
		{
			//
			// Если находимся на списке, то превращаем его обратно в обычный текст;
			// если текст уже обычный, то ничего и не делаем
			//
			QTextList* list = cursor.currentList ();
			if (list)
			{
				QTextBlockFormat block_def_format;
				block_def_format.setIndent (0);

				//
				// Либо берем все выделенные элементы списка,
				// либо текущий - на котором стоит курсор
				//
				if (cursor.hasSelection ())
				{
					int sel_start = cursor.selectionStart ();
					int sel_end   = cursor.selectionEnd ();

					QTextBlock sel_start_block = document()->findBlock (sel_start);
					QTextBlock sel_end_block   = document()->findBlock (sel_end);

					do
					{
						//
						// Удаляем очередной элемент из списка
						//
						int item_index = list->itemNumber (sel_start_block);
						if (item_index != -1)
							list->removeItem (item_index);

						//
						// Восстанавливаем отступ по умолчанию
						//
						cursor.mergeBlockFormat (block_def_format);

						sel_start_block = sel_start_block.next ();
						cursor.movePosition (QTextCursor::NextBlock, QTextCursor::KeepAnchor);
					}
					while (sel_start_block.isValid () && (sel_start_block != sel_end_block.next ()));
				}
				else
				{
					//
					// Получаем текущий элемент списка
					//
					QTextBlock item_block = cursor.block ();
					int item_index = list->itemNumber (item_block);
					if (item_index != -1)
						list->removeItem (item_index);

					//
					// Восстанавливаем отступ по умолчанию
					//
					cursor.mergeBlockFormat (block_def_format);
				}
			}
		}
	}
}

void
CHTMLEdit::aboutTextColorChanged ()
{
	QColor col = QColorDialog::getColor (textColor (), this);
	if (col.isValid ())
	{
		QTextCharFormat fmt;
		fmt.setForeground (col);
		mergeFormatOnWordOrSelection (fmt);
		colorChanged (col);
	}
}

void
CHTMLEdit::aboutTextAlign (QAction* _a)
{
	if (_a == m_align_left_action)
		setAlignment (Qt::AlignLeft | Qt::AlignAbsolute);
	else if (_a == m_align_center_action)
		setAlignment (Qt::AlignHCenter);
	else if (_a == m_align_right_action)
		setAlignment (Qt::AlignRight | Qt::AlignAbsolute);
	else if (_a == m_align_justify_action)
		setAlignment (Qt::AlignJustify);
}

void
CHTMLEdit::aboutIndentListLess ()
{
	QTextCursor cursor = textCursor ();
	QTextCursor working_cursor (cursor);
	working_cursor.setPosition (cursor.selectionStart ());
	working_cursor.beginEditBlock ();

	QTextCursor end_cursor (cursor);
	end_cursor.setPosition (cursor.selectionEnd ());

	bool move_succeeded;
	do
	{
		if (QTextList* text_list = working_cursor.currentList ())
		{
			QTextListFormat list_format = text_list->format ();

			if (list_format.indent () == 1)
			{
				if (! cursor.hasSelection ())
					aboutRemoveFromList (working_cursor);
			}
			else
			{
				list_format.setIndent (list_format.indent () - 1);

				QTextListFormat::Style list_style;
				switch (list_format.indent() % 3)
				{
					case 1:
						list_style = QTextListFormat::ListDisc;
						break;
					case 2:
						list_style = QTextListFormat::ListSquare;
						break;
					default:  // case 0:
						list_style = QTextListFormat::ListCircle;
						break;
				}

				list_format.setStyle (list_style);
				working_cursor.createList (list_format);
			}
		}

		move_succeeded = working_cursor.movePosition (QTextCursor::NextBlock);
	}
	while (working_cursor.position () <= end_cursor.block ().position () && move_succeeded);

	working_cursor.endEditBlock ();
}

void
CHTMLEdit::aboutIndentListMore ()
{
	QTextCursor cursor = textCursor ();
	QTextCursor working_cursor (cursor);
	working_cursor.setPosition (cursor.selectionStart ());
	working_cursor.beginEditBlock ();

	QTextCursor end_cursor (cursor);
	end_cursor.setPosition (cursor.selectionEnd ());

	bool move_succeeded;
	do
	{
		QTextListFormat list_format;

		if (QTextList* text_list = working_cursor.currentList ())
		{
			list_format = text_list->format ();
			list_format.setIndent (list_format.indent () + 1);
		}
		else
			list_format.setIndent (1);

		QTextListFormat::Style list_style;
		switch (list_format.indent () % 3)
		{
			case 1:
				list_style = QTextListFormat::ListDisc;
				break;
			case 2:
				list_style = QTextListFormat::ListSquare;
				break;
			default:  // case 0:
				list_style = QTextListFormat::ListCircle;
				break;
		}

		list_format.setStyle (list_style);
		working_cursor.createList (list_format);
		move_succeeded = working_cursor.movePosition (QTextCursor::NextBlock);
	}
	while (working_cursor.position () <= end_cursor.block ().position () && move_succeeded);

	working_cursor.endEditBlock ();
}

void
CHTMLEdit::aboutRemoveFromList (QTextCursor _cursor)
{
	if (_cursor.isNull())
		_cursor = textCursor ();

	if (QTextList* text_list = _cursor.currentList ())
	{
		_cursor.beginEditBlock ();

		QTextBlockFormat remove_indent_format;
		remove_indent_format.setIndent (0);
		text_list->remove (_cursor.block ());
		_cursor.mergeBlockFormat (remove_indent_format);

		_cursor.endEditBlock ();
	}
}

void
CHTMLEdit::aboutInsertTable ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		QDialog dlg (this);
		Ui::CTableDialog insert_dlg;
		insert_dlg.setupUi (&dlg);
		dlg.setWindowTitle (tr (""Insert table""));

		if (dlg.exec () == QDialog::Accepted)
		{
			bool ok = false;
			int rows_cnt = insert_dlg.row_count->text().toInt (&ok);
			if (!ok)
				return;
			int columns_cnt = insert_dlg.column_count->text().toInt (&ok);
			if (!ok)
				return;

			//
			// Делаем небольшой отступ между текстом в ячейке и границей (просто для красоты)
			//
			QTextTableFormat table_format;
			table_format.setCellPadding (5);
			// table_format.setHeight (50);

			//
			// Растягиваем таблицу на ширину документа, с одинаковой шириной для каждого столбца
			//
			QVector <QTextLength> col_widths;
			for (int i = 0; i < columns_cnt; ++i)
				col_widths << QTextLength (QTextLength::PercentageLength, 100.0 / columns_cnt);
			table_format.setColumnWidthConstraints (col_widths);

			//
			// Вставляем таблицу с указанным числом строк и столбцов
			//
			cursor.insertTable (rows_cnt, columns_cnt, table_format);
		}
	}
}

void
CHTMLEdit::aboutRemoveRow ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		//
		// Удаляем строку, на которой стоит курсор
		//
		if (QTextTable* t = cursor.currentTable ())
			t->removeRows (t->cellAt (cursor).row (), 1);
	}
}

void
CHTMLEdit::aboutRemoveCol ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		//
		// Удаляем столбец, на котором стоит курсор
		//
		if (QTextTable* t = cursor.currentTable ())
			t->removeColumns (t->cellAt (cursor).column (), 1);
	}
}

void
CHTMLEdit::aboutAddRow (int _count)
{
	if (_count > 4)
	{
		_count = askUserForNumber (this, tr (""Enter required number of rows""), tr (""Row count: ""));
		if (_count < 0)
			return;
	}

	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		//
		// Вставляем указанное число строк перед той, на которой стоит курсор
		//
		if (QTextTable* t = cursor.currentTable ())
			t->insertRows (t->cellAt (cursor).row (), _count);
	}
}

void
CHTMLEdit::aboutAddCol (int _count)
{
	if (_count > 4)
	{
		_count = askUserForNumber (this, tr (""Enter required number of columns""), tr (""Column count: ""));
		if (_count == -1)
			return;
	}

	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		//
		// Вставляем указанное число столбцов перед тем, на котором стоит курсор
		//
		if (QTextTable* t = cursor.currentTable ())
			t->insertColumns (t->cellAt (cursor).column (), _count);
	}
}

void
CHTMLEdit::aboutMergeCells ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		//
		// Объединяем текущую ячейку и ее соседа справа
		//
		if (QTextTable* t = cursor.currentTable ())
		{
			QTextTableCell tc = t->cellAt (cursor);

			t->mergeCells (tc.row (), tc.column (), 1, 2);
		}
	}
}

void
CHTMLEdit::aboutSplitCells ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		//
		// Разбиваем на две ячейку, на которой стоит курсор
		//
		// NOTE: разбивать можно только уже объединенные ячейки
		//
		if (QTextTable* t = cursor.currentTable ())
		{
			QTextTableCell tc = t->cellAt (cursor);

			t->splitCell (tc.row (), tc.column (), 1, 1);
		}
	}
}

void
CHTMLEdit::aboutTableAppreance ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		if (QTextTable* t = cursor.currentTable ())
		{
			//
			// Показываем диалог с настройками внешнего вида таблицы (границы и т.п.)
			//
			QDialog dlg (this);
			Ui::CTableAppreance appr_dlg;
			appr_dlg.setupUi (&dlg);
			dlg.setWindowTitle (tr (""Table appreance""));
			appr_dlg.border_width->setValue (t->format ().border ());
			appr_dlg.border_style->setCurrentIndex (t->format ().borderStyle ());

			if (dlg.exec() != QDialog::Accepted)
				return;

			//
			// NOTE: стили границы счастливым образом идут подряд в enum'е и он нуля
			//
			qreal border_width = appr_dlg.border_width->value ();
			int bs = appr_dlg.border_style->currentIndex ();

			QTextFrameFormat::BorderStyle border_style = QTextFrameFormat::BorderStyle (bs);

			QTextTableFormat fmt = t->format ();
			fmt.setBorder (border_width);
			fmt.setBorderStyle (border_style);

			t->setFormat (fmt);
		}
	}
}

void
CHTMLEdit::aboutRowsHeight ()
{
	// TODO: стандартными средствами QTextTable, QTextTableFormat невозможно изменить
	// высоту строк
}

void
CHTMLEdit::aboutColsWidth ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		if (QTextTable* t = cursor.currentTable ())
		{
			//
			// Показываем диалог для настройки ширины столбцов
			// TODO: пока одной для всех, а не индивидуально, т.к. сложноват интерфейс диалога получится
			//
			int new_col_width = askUserForNumber (this, tr (""Enter required width of columns""),
												   tr (""Width: ""));
			if (new_col_width == -1)
				return;

			QTextTableFormat fmt = t->format ();
			QVector <QTextLength> col_widths;
			for (int i = 0; i < t->columns (); ++i)
				col_widths << QTextLength (QTextLength::FixedLength, new_col_width);
			fmt.setColumnWidthConstraints (col_widths);

			t->setFormat (fmt);
		}
	}
}

void
CHTMLEdit::aboutInsertImage ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		QString file = QFileDialog::getOpenFileName (this, tr(""Select an image to insert""), ""."",
													 m_all_images_filter);
		if (!file.isEmpty())
			cursor.insertImage (OAF::fromLocalFile (file).toString ());
	}
}

void
CHTMLEdit::aboutResizeImage ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull () && cursor.hasSelection ())
	{
		int sel_start = cursor.selectionStart ();
		int sel_end   = cursor.selectionEnd ();

		QTextBlock sel_start_block = document()->findBlock (sel_start);
		QTextBlock sel_end_block   = document()->findBlock (sel_end);

		//
		// Сначала проверяем, что в выделенном блоке вообще есть изображения и
		// выясняем размеры первого из выделенных изображений. Эти размеры будут
		// размерами по умолчанию для диалога
		//
		int width  = 0;
		int height = 0;
		for (QTextBlock block = sel_start_block; block.isValid () && (block != sel_end_block.next ()); block = block.next ())
		{
			for (QTextBlock::iterator b = block.begin (); !b.atEnd (); ++b)
			{
				QTextFragment fragment = b.fragment ();
				if (fragment.isValid ())
				{
					if (fragment.charFormat ().isImageFormat ())
					{
						int img_pos = fragment.position();
						if ((img_pos >= sel_start) && (img_pos <= sel_end))
						{
							QTextImageFormat img_format = fragment.charFormat ().toImageFormat ();

							width  = img_format.width ();
							height = img_format.height ();

							//
							// Если ширина и высота явно не заданы, то выбираем их из самой картинки
							//
							if ((width == 0) || (height == 0))
							{
								//
								// Открываем устройство для чтения изображения
								//
								if (URef<OAF::IIODevice> d = OAF::createFromName<OAF::IIODevice> (img_format.name ()))
								{
									//
									// Если это устройство успешно открыто для чтения
									//
									if (d->device ()->open (QIODevice::ReadOnly))
									{
										//
										// Загружаем изображение
										//
										QImage img = QImageReader (d->device ()).read ();
										if (!img.isNull ())
										{
											if (width == 0)
												width = img.width ();
											if (height == 0)
												height = img.height ();
										}
									}
								}
							}

							break;
						}
					}
				}
			}

			//
			// Если изображение найдено, то прерываем цикл
			//
			if ((width > 0) && (height > 0))
				break;
		}

		//
		// Если изображений нет, то выдаём предупреждение и выходим
		//
		if ((width < 1) || (height < 1))
		{
			QMessageBox::warning (this, tr (""Warning""), tr (""No images found!""));
			return;
		}

		//
		// Запрашиваем у пользователя новые размеры изображения с помощью диалога
		//
		QDialog dlg (this);
		Ui::CResizeDialog resize_dlg;
		resize_dlg.setupUi (&dlg);
		dlg.setWindowTitle (tr(""Resize image""));
		resize_dlg.width->setText (QString::number (width));
		resize_dlg.height->setText (QString::number (height));

		if (dlg.exec() == QDialog::Accepted)
		{
			bool ok = false;

			width  = resize_dlg.width ->text().toDouble (&ok);
			height = resize_dlg.height->text().toDouble (&ok);

			//
			// То, что пользователь ввёл какой-то бред, не повод абортить программу на ASSERT'е
			//
			if (!ok)
			{
				QMessageBox::warning (this, tr(""Warning""), tr(""Can't set specified width or height!""));
				return;
			}

			if ((width < 1) || (height < 1))
			{
				QMessageBox::warning (this, tr(""Warning""), tr(""Minimal allowed size of image is 1x1 pixels!""));
				return;
			}

			//
			// Пробегаем по всем выделенным блокам текста и ищем в них изображения
			//
			do
			{
				for (QTextBlock::iterator b = sel_start_block.begin(); !b.atEnd(); ++b)
				{
					QTextFragment fragment = b.fragment ();
					if (fragment.isValid ())
					{
						if (fragment.charFormat ().isImageFormat ())
						{
							QTextImageFormat img_format = fragment.charFormat ().toImageFormat ();

							//
							// Устанавливаем новый размер изображения, указанный пользователем
							//
							if (img_format.isValid () && ((width != img_format.width ()) || (height != img_format.height ())))
							{
								img_format.setWidth  (width);
								img_format.setHeight (height);

								int img_pos = fragment.position();
								if ((img_pos >= sel_start) && (img_pos <= sel_end))
								{
									cursor.setPosition (img_pos);
									cursor.setPosition (img_pos + fragment.length(),
														QTextCursor::KeepAnchor);
									cursor.setCharFormat (img_format);
								}
							}
						}
					}
				}

				sel_start_block = sel_start_block.next ();
				cursor.movePosition (QTextCursor::NextBlock, QTextCursor::KeepAnchor);
			}
			while (sel_start_block.isValid () && (sel_start_block != sel_end_block.next ()));
		}
	}
}

void
CHTMLEdit::aboutCurrentCharFormatChanged (const QTextCharFormat& _tcf)
{
	fontChanged (_tcf.font ());
	colorChanged (_tcf.foreground().color ());
}

void
CHTMLEdit::aboutCursorPositionChanged ()
{
	QTextCursor cursor = textCursor ();
	if (!cursor.isNull ())
	{
		//
		// Отображаем выравнивание в новой позиции курсора
		//
		alignmentChanged (alignment ());

		//
		// Отображаем текущий стиль списка в новой позиции (если есть)
		//
		QTextListFormat::Style list_style = QTextListFormat::ListStyleUndefined;
		if (cursor.currentList ())
		{
			QTextListFormat list_fmt = cursor.currentList ()->format ();
			list_style = list_fmt.style();
		}
		listStyleChanged (list_style);

		//
		// Если курсор встал внутри таблицы, то активируем соответствующие пункты меню
		//
		enableTableActions (cursor.currentTable () != NULL);
	}
}

void
CHTMLEdit::aboutClipboardDataChanged ()
{
	m_paste_action->setEnabled (clipboardHasData ());
}

bool
CHTMLEdit::canInsertFromMimeData (const QMimeData* _source) const
{
	return _source->hasImage () || _source->hasUrls () || _source->hasText () || _source->hasHtml ();
}

void
CHTMLEdit::insertFromMimeData (const QMimeData* _source)
{
	if (_source->hasImage ())
	{
		dropImage (qvariant_cast<QImage> (_source->imageData ()));
	}
	else if (_source->hasUrls ())
	{
		foreach (QUrl url, _source->urls ())
		{
			QFileInfo info (OAF::toLocalFile (url));
			if (QImageReader::supportedImageFormats ().contains (info.suffix ().toLower ().toLatin1 ()))
				dropImage (QImage (info.filePath ()));
			else
				dropTextFile (url);
		}
	}
	else
		QTextEdit::insertFromMimeData (_source);
}

//
// Переопределяем, чтобы показать custom-меню для встроенной в текст таблицы
//
// TODO: вообще-то логичнее работать с выделенными ячейками/строками/столбцами,
// да только нужная для этого функция работать не хочет. Гугл на эту тему молчит, StackOverflow - тоже.
//int startRow, startCol, numRows, numCols;
//cursor.selectedTableCells(&startRow, &numRows, &startCol, &numCols);
void
CHTMLEdit::contextMenuEvent (QContextMenuEvent* event)
{
	QTextCursor cursor = cursorForPosition (event->pos ());
	if (!cursor.isNull ())
	{
		//
		// Проверяем, не кликнул ли пользователь внутри таблицы;
		// если да, то включаем соответствующие пункты меню
		//
		enableTableActions (cursor.currentTable () != NULL);

		//
		// Показываем модифицированное меню и ждем,
		// пока пользователь выберет какой-то его пункт (т.е. синхронно)
		//
		m_context_menu->exec (event->globalPos ());
	}
}

CHTMLEdit::CHTMLEdit (CFactory* _factory) : CUnknown (html_edit_cid), m_factory (_factory), m_uic (NULL),
	m_font_list_widget (NULL), m_size_list_widget (NULL), m_list_style_widget (NULL)
{
	setObjectName (""ui:htmledit"");

	//
	// Создаем и сохраняем в переменной фильтр для выбора изображений в QFileDialog
	//
	QStringList img_mimes;
	img_mimes << ""image/bmp"";
	img_mimes << ""image/tiff"";
	img_mimes << ""image/jpeg"";
	img_mimes << ""image/x-tga"";
	img_mimes << ""image/png"";
	img_mimes << ""video/x-mng"";
	img_mimes << ""image/x-xbitmap"";
	img_mimes << ""image/x-xpixmap"";
	img_mimes << ""image/x-portable-bitmap"";
	img_mimes << ""image/x-portable-graymap"";
	img_mimes << ""image/x-portable-pixmap"";
	m_all_images_filter = OAF::CMimeDatabase::instance ().filterFromMime (tr (""All Image Files""), img_mimes);

	//
	// Создаем стандартные объекты действий для WordPad-like текстового редактора
	//
	createEditActions ();
	createTextActions ();
	createListActions ();
	createTableActions ();
	createFontComboAction ();
	createSizeComboAction ();
	createListComboAction ();
	createContextMenu ();

	//
	// Реагируем на изменение формата выделенного текста
	//
	connect (this, SIGNAL (currentCharFormatChanged (const QTextCharFormat&)),
				  this, SLOT (aboutCurrentCharFormatChanged (const QTextCharFormat&)));
	connect (this, SIGNAL (cursorPositionChanged ()),
				  this, SLOT (aboutCursorPositionChanged ()));
	//
	// Инициализируем шрифт, цвет и выравнивание по умолчанию
	//
	fontChanged (font ());
	colorChanged (textColor ());
	alignmentChanged (alignment ());

	//
	// Связываем команды редактирования с документом
	//
	setupActions ();

	//
	// Ловим события об изменении буфера обмена
	//
	connect (QApplication::clipboard (), SIGNAL(dataChanged ()), this, SLOT(aboutClipboardDataChanged ()));

	//
	// Создаём пустой документ заданного класса для редактирования
	//
	setDocument (m_document = OAF::createFromName<QTextDocument> (""cid:OAF/TXT/CHTMLDocument:1.0""));
	OAF::subscribe (m_document.queryInterface<OAF::IInterface> (), this);
}

CHTMLEdit::~CHTMLEdit ()
{
	setDocument (NULL);
	OAF::unsubscribe (m_document.queryInterface<OAF::IInterface> (), this);

	disconnect (QApplication::clipboard (), SIGNAL(dataChanged ()), this, SLOT(aboutClipboardDataChanged ()));
}

OAF::URef<OAF::IUnknown>
CHTMLEdit::setExtendedObject (OAF::IUnknown* _o)
{
	//
	// Устанавливаем новый документ для редактирования
	//
	if (OAF::URef<QTextDocument> document = OAF::queryInterface<QTextDocument> (_o))
	{
		OAF::unsubscribe (m_document.queryInterface<OAF::IInterface> (), this);
		setDocument (NULL);
		m_document = document;
		setDocument (m_document);
		OAF::subscribe (m_document.queryInterface<OAF::IInterface> (), this);
	}

	//
	// Если документ пуст, то блокируем delete и select_all
	//
	m_delete_action->setEnabled (m_document && !m_document->isEmpty ());
	m_select_all_action->setEnabled (m_document && !m_document->isEmpty ());

	return this;
}

void
CHTMLEdit::setUILabel (const QString& _bag, const QString& _label)
{
	if (_bag == ""ui:main"")
		m_main_label = _label;
}

void
CHTMLEdit::setUIContainer (OAF::IUIContainer* _uic)
{
	//
	// Добавляем в интерфейс объект редактора rich-текста
	//

	static const char uidef[] =
		""<?xml version=\\""1.0\\""?>""
		""<uidef>""
			""<bag id=\\""ui:main\\"">""
				""<item id=\\""ui:htmledit\\"" label=\\""%1\\""/>""
			""</bag>""
		""</uidef>"";

	if (_uic)
	{
		m_uic = _uic;
		m_id  = m_uic->addUI (QString (uidef).arg (m_main_label.isEmpty () ? tr (""Text Edit"") : m_main_label), this);
	}
	else
	{
		m_id  = m_uic->removeUI (m_id);
		m_uic = _uic;
	}
}

OAF::IUIContainer*
CHTMLEdit::getUIContainer ()
{
	return m_uic;
}

void
CHTMLEdit::activate (bool _activate)
{
	static const QString menubar_edit_uidef =
			""<folder id=\\""ui:edit\\"" label=\\""%1\\"">""
				""<item id=\\""ui:htmledit:undo\\""/>""
				""<item id=\\""ui:htmledit:redo\\""/>""
				""<separator/>""
				""<item id=\\""ui:htmledit:cut\\""/>""
				""<item id=\\""ui:htmledit:copy\\""/>""
				""<item id=\\""ui:htmledit:paste\\""/>""
				""<item id=\\""ui:htmledit:delete\\""/>""
				""<separator/>""
				""<item id=\\""ui:htmledit:select_all\\""/>""
			""</folder>"";

	static const QString toolbar_edit_uidef =
			""<folder id=\\""ui:edit\\"" label=\\""%1\\"">""
				""<item id=\\""ui:htmledit:cut\\""/>""
				""<item id=\\""ui:htmledit:copy\\""/>""
				""<item id=\\""ui:htmledit:paste\\""/>""
				""<separator/>""
				""<item id=\\""ui:htmledit:undo\\""/>""
				""<item id=\\""ui:htmledit:redo\\""/>""
			""</folder>"";

	static const QString menubar_formatting_uidef =
			""<folder id=\\""ui:edit\\"" label=\\""%1\\"">""
				""<separator/>""
				""<item id=\\""ui:htmledit:bold\\""/>""
				""<item id=\\""ui:htmledit:italic\\""/>""
				""<item id=\\""ui:htmledit:underline\\""/>""
				""<separator/>""
				""<item id=\\""ui:htmledit:color\\"" label=\\""%2\\""/>""
			""</folder>"";

	static const QString toolbar_formatting_uidef =
			""<folder id=\\""ui:formatting\\"" label=\\""%1\\"">""
				""<item id=\\""ui:htmledit:liststyle\\""/>""
				""<item id=\\""ui:htmledit:fontlist\\""/>""
				""<item id=\\""ui:htmledit:fontsize\\""/>""
			""</folder>"";

	static const QString menubar_nestedlist_uidef =
			""<folder id=\\""ui:edit\\"" label=\\""%1\\"">""
				""<separator/>""
				""<item id=\\""ui:htmledit:increase_indent\\""/>""
				""<item id=\\""ui:htmledit:decrease_indent\\""/>""
			""</folder>"";

	static const QString menubar_alignment_uidef =
			""<folder id=\\""ui:edit\\"" label=\\""%1\\"">""
				""<separator/>""
				""<item id=\\""ui:htmledit:alignment:left\\""/>""
				""<item id=\\""ui:htmledit:alignment:center\\""/>""
				""<item id=\\""ui:htmledit:alignment:right\\""/>""
				""<item id=\\""ui:htmledit:alignment:justify\\""/>""
			""</folder>"";

	static const QString toolbar_alignment_uidef =
			""<folder id=\\""ui:htmledit:alignment\\"" label=\\""%1\\"">""
				""<item id=\\""ui:htmledit:alignment:left\\""/>""
				""<item id=\\""ui:htmledit:alignment:center\\""/>""
				""<item id=\\""ui:htmledit:alignment:right\\""/>""
				""<item id=\\""ui:htmledit:alignment:justify\\""/>""
			""</folder>"";

	static const QString menubar_image_uidef =
			""<folder id=\\""ui:edit\\"" label=\\""%1\\"">""
				""<separator/>""
				""<item id=\\""ui:htmledit:insert_image\\""/>""
				""<item id=\\""ui:htmledit:resize_image\\""/>""
			""</folder>"";

	static const QString menubar_table_uidef =
			""<folder id=\\""ui:table\\"" label=\\""%1\\"">""
				""<separator/>""
				""<item id=\\""ui:htmledit:insert_table\\""/>""
				""<item id=\\""ui:htmledit:remove_row\\"" />""
				""<item id=\\""ui:htmledit:remove_col\\"" />""
				""<folder id=\\""ui:add_row_menu\\"" label=\\""%2\\"">""
					""<item id=\\""ui:htmledit:add_1_row\\"" />""
					""<item id=\\""ui:htmledit:add_2_row\\"" />""
					""<item id=\\""ui:htmledit:add_3_row\\"" />""
					""<item id=\\""ui:htmledit:add_4_row\\"" />""
					""<item id=\\""ui:htmledit:add_n_row\\"" />""
				""</folder>""
				""<folder id=\\""ui:add_col_menu\\"" label=\\""%3\\"">""
					""<item id=\\""ui:htmledit:add_1_col\\"" />""
					""<item id=\\""ui:htmledit:add_2_col\\"" />""
					""<item id=\\""ui:htmledit:add_3_col\\"" />""
					""<item id=\\""ui:htmledit:add_4_col\\"" />""
					""<item id=\\""ui:htmledit:add_n_col\\"" />""
				""</folder>""
				""<item id=\\""ui:htmledit:merge_cells\\"" />""
				""<item id=\\""ui:htmledit:split_cells\\"" />""
				""<item id=\\""ui:htmledit:table_appreance\\"" />""
//				""<item id=\\""ui:htmledit:rows_height\\"" />""	// Не реализовано
				""<item id=\\""ui:htmledit:cols_width\\"" />""
			""</folder>"";

	static const QString uidef =
			""<?xml version=\\""1.0\\""?>""
			""<uidef>""
				""<bag id=\\""ui:menubar\\"">""
					+ menubar_edit_uidef.arg (tr (""Edit""))
					+ menubar_formatting_uidef.arg (tr (""Edit"")).arg (tr (""Font color""))
					+ menubar_nestedlist_uidef.arg (tr (""Indentation""))
					+ menubar_alignment_uidef.arg (tr (""Edit""))
					+ menubar_image_uidef.arg (tr (""Edit""))
					+ menubar_table_uidef.arg (tr (""Table""),
											   tr (""Insert rows before this""),
											   tr (""Insert columns before this"")) +
				""</bag>""
				""<bag id=\\""ui:toolbar\\"">""
					+ toolbar_edit_uidef.arg (tr (""Edit""))
					+ toolbar_formatting_uidef.arg (tr (""Format""))
					+ toolbar_alignment_uidef.arg (tr (""Alignment"")) +
				""</bag>""
			""</uidef>"";

	if (! _activate)
		m_id_active = m_uic->removeUI (m_id_active);

	if (_activate)
		m_id_active = m_uic->addUI (uidef, this);

	emit aboutCurrentCharFormatChanged (currentCharFormat ());
}

QObject*
CHTMLEdit::getUIItem (const QString& _id)
{
	if (_id == objectName ())
		return this;
	else if (_id == m_font_list->objectName ())
		return m_font_list;
	else if (_id == m_size_list->objectName ())
		return m_size_list;
	else if (_id == m_list_style->objectName ())
		return m_list_style;
	else if (_id == m_bold_action->objectName ())
		return m_bold_action;
	else if (_id == m_italic_action->objectName ())
		return m_italic_action;
	else if (_id == m_underline_action->objectName ())
		return m_underline_action;
	else if (_id == m_color_action->objectName ())
		return m_color_action;
	else if (_id == m_alignment->objectName ())
		return m_alignment;
	else if (_id == m_align_left_action->objectName ())
		return m_align_left_action;
	else if (_id == m_align_center_action->objectName ())
		return m_align_center_action;
	else if (_id == m_align_right_action->objectName ())
		return m_align_right_action;
	else if (_id == m_align_justify_action->objectName ())
		return m_align_justify_action;
	else if (_id == m_undo_action->objectName ())
		return m_undo_action;
	else if (_id == m_redo_action->objectName ())
		return m_redo_action;
	else if (_id == m_cut_action->objectName ())
		return m_cut_action;
	else if (_id == m_copy_action->objectName ())
		return m_copy_action;
	else if (_id == m_paste_action->objectName ())
		return m_paste_action;
	else if (_id == m_delete_action->objectName ())
		return m_delete_action;
	else if (_id == m_select_all_action->objectName ())
		return m_select_all_action;
	else if (_id == m_image_action->objectName ())
		return m_image_action;
	else if (_id == m_resize_action->objectName ())
		return m_resize_action;
	else if (_id == m_inc_indent_action->objectName ())
		return m_inc_indent_action;
	else if (_id == m_dec_indent_action->objectName ())
		return m_dec_indent_action;
	else if (_id == m_insert_table_action->objectName ())
		return m_insert_table_action;
	else if (_id == m_remove_row_action->objectName ())
		return m_remove_row_action;
	else if (_id == m_remove_col_action->objectName ())
		return m_remove_col_action;

	else if (_id == m_add_row_action_1->objectName ())
		return m_add_row_action_1;
	else if (_id == m_add_row_action_2->objectName ())
		return m_add_row_action_2;
	else if (_id == m_add_row_action_3->objectName ())
		return m_add_row_action_3;
	else if (_id == m_add_row_action_4->objectName ())
		return m_add_row_action_4;
	else if (_id == m_add_row_action_n->objectName ())
		return m_add_row_action_n;

	else if (_id == m_add_col_action_1->objectName ())
		return m_add_col_action_1;
	else if (_id == m_add_col_action_2->objectName ())
		return m_add_col_action_2;
	else if (_id == m_add_col_action_3->objectName ())
		return m_add_col_action_3;
	else if (_id == m_add_col_action_4->objectName ())
		return m_add_col_action_4;
	else if (_id == m_add_col_action_n->objectName ())
		return m_add_col_action_n;

	else if (_id == m_merge_adjacent_cells_action->objectName ())
		return m_merge_adjacent_cells_action;
	else if (_id == m_split_cell_action->objectName ())
		return m_split_cell_action;
	else if (_id == m_table_appreance_action->objectName ())
		return m_table_appreance_action;
	else if (_id == m_change_rows_height_action->objectName ())
		return m_change_rows_height_action;
	else if (_id == m_change_cols_width_action->objectName ())
		return m_change_cols_width_action;

	return NULL;
}
",16155,True,2950.3545311490825,median