Blame - gin/shell_runner.h - chromium/src

blob: 99b510ccdd844433caf3ef78ea9113148dfa3c89 [file] [log] [blame]

Avi Drissman	468e51b6	2022-09-13 20:47:01	[diff] [blame]	1	// Copyright 2014 The Chromium Authors
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	2	// Use of this source code is governed by a BSD-style license that can be
				3	// found in the LICENSE file.
				4
sky@chromium.org	df55d259	2014-02-27 19:49:39	[diff] [blame]	5	#ifndef GIN_SHELL_RUNNER_H_
				6	#define GIN_SHELL_RUNNER_H_
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	7
dcheng	18ec0b54	2016-04-26 19:28:53	[diff] [blame]	8	#include <memory>
				9
Keishi Hattori	0e45c02	2021-11-27 09:25:52	[diff] [blame]	10	#include "base/memory/raw_ptr.h"
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	11	#include "gin/runner.h"
				12
				13	namespace gin {
				14
				15	class ContextHolder;
				16	class ShellRunner;
				17	class TryCatch;
				18
				19	// Subclass ShellRunnerDelegate to customize the behavior of ShellRunner.
				20	// Typical embedders will want to subclass one of the specialized
				21	// ShellRunnerDelegates, such as ModuleRunnerDelegate.
				22	class GIN_EXPORT ShellRunnerDelegate {
				23	public:
				24	ShellRunnerDelegate();
				25	virtual ~ShellRunnerDelegate();
				26
				27	// Returns the template for the global object.
deepak.s	faaa1b6	2015-04-30 07:30:48	[diff] [blame]	28	virtual v8::Local<v8::ObjectTemplate> GetGlobalTemplate(
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	29	ShellRunner* runner,
				30	v8::Isolate* isolate);
				31	virtual void DidCreateContext(ShellRunner* runner);
				32	virtual void WillRunScript(ShellRunner* runner);
				33	virtual void DidRunScript(ShellRunner* runner);
				34	virtual void UnhandledException(ShellRunner* runner, TryCatch& try_catch);
				35	};
				36
				37	// ShellRunner executes the script/functions directly in a v8::Context.
				38	// ShellRunner owns a ContextHolder and v8::Context, both of which are destroyed
				39	// when the ShellRunner is deleted.
				40	class GIN_EXPORT ShellRunner : public Runner {
				41	public:
				42	ShellRunner(ShellRunnerDelegate* delegate, v8::Isolate* isolate);
Daniel Hosseinian	68c0798d	2021-04-16 08:16:07	[diff] [blame]	43	ShellRunner(const ShellRunner&) = delete;
				44	ShellRunner& operator=(const ShellRunner&) = delete;
dcheng	074c039	2014-10-23 19:08:25	[diff] [blame]	45	~ShellRunner() override;
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	46
				47	// Before running script in this context, you'll need to enter the runner's
				48	// context by creating an instance of Runner::Scope on the stack.
				49
				50	// Runner overrides:
Abhijith Nair	7447a431	2022-03-15 11:44:13	[diff] [blame]	51	v8::MaybeLocal<v8::Value> Run(const std::string& source,
				52	const std::string& resource_name) override;
dcheng	074c039	2014-10-23 19:08:25	[diff] [blame]	53	ContextHolder* GetContextHolder() override;
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	54
				55	private:
				56	friend class Scope;
				57
Abhijith Nair	7447a431	2022-03-15 11:44:13	[diff] [blame]	58	v8::MaybeLocal<v8::Value> Run(v8::Local<v8::Script> script);
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	59
Keishi Hattori	0e45c02	2021-11-27 09:25:52	[diff] [blame]	60	raw_ptr<ShellRunnerDelegate> delegate_;
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	61
dcheng	18ec0b54	2016-04-26 19:28:53	[diff] [blame]	62	std::unique_ptr<ContextHolder> context_holder_;
sky@chromium.org	1771610d	2014-02-27 06:08:24	[diff] [blame]	63	};
				64
				65	} // namespace gin
				66
sky@chromium.org	df55d259	2014-02-27 19:49:39	[diff] [blame]	67	#endif // GIN_SHELL_RUNNER_H_