xref: /third_party/node/deps/v8/include/v8.h (revision 1cb0ef41)
1// Copyright 2012 the V8 project authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5/** \mainpage V8 API Reference Guide
6 *
7 * V8 is Google's open source JavaScript engine.
8 *
9 * This set of documents provides reference material generated from the
10 * V8 header files in the include/ subdirectory.
11 *
12 * For other documentation see https://v8.dev/.
13 */
14
15#ifndef INCLUDE_V8_H_
16#define INCLUDE_V8_H_
17
18#include <stddef.h>
19#include <stdint.h>
20
21#include <memory>
22
23#include "cppgc/common.h"
24#include "v8-array-buffer.h"       // NOLINT(build/include_directory)
25#include "v8-container.h"          // NOLINT(build/include_directory)
26#include "v8-context.h"            // NOLINT(build/include_directory)
27#include "v8-data.h"               // NOLINT(build/include_directory)
28#include "v8-date.h"               // NOLINT(build/include_directory)
29#include "v8-debug.h"              // NOLINT(build/include_directory)
30#include "v8-exception.h"          // NOLINT(build/include_directory)
31#include "v8-extension.h"          // NOLINT(build/include_directory)
32#include "v8-external.h"           // NOLINT(build/include_directory)
33#include "v8-function.h"           // NOLINT(build/include_directory)
34#include "v8-initialization.h"     // NOLINT(build/include_directory)
35#include "v8-internal.h"           // NOLINT(build/include_directory)
36#include "v8-isolate.h"            // NOLINT(build/include_directory)
37#include "v8-json.h"               // NOLINT(build/include_directory)
38#include "v8-local-handle.h"       // NOLINT(build/include_directory)
39#include "v8-locker.h"             // NOLINT(build/include_directory)
40#include "v8-maybe.h"              // NOLINT(build/include_directory)
41#include "v8-memory-span.h"        // NOLINT(build/include_directory)
42#include "v8-message.h"            // NOLINT(build/include_directory)
43#include "v8-microtask-queue.h"    // NOLINT(build/include_directory)
44#include "v8-microtask.h"          // NOLINT(build/include_directory)
45#include "v8-object.h"             // NOLINT(build/include_directory)
46#include "v8-persistent-handle.h"  // NOLINT(build/include_directory)
47#include "v8-primitive-object.h"   // NOLINT(build/include_directory)
48#include "v8-primitive.h"          // NOLINT(build/include_directory)
49#include "v8-promise.h"            // NOLINT(build/include_directory)
50#include "v8-proxy.h"              // NOLINT(build/include_directory)
51#include "v8-regexp.h"             // NOLINT(build/include_directory)
52#include "v8-script.h"             // NOLINT(build/include_directory)
53#include "v8-snapshot.h"           // NOLINT(build/include_directory)
54#include "v8-statistics.h"         // NOLINT(build/include_directory)
55#include "v8-template.h"           // NOLINT(build/include_directory)
56#include "v8-traced-handle.h"      // NOLINT(build/include_directory)
57#include "v8-typed-array.h"        // NOLINT(build/include_directory)
58#include "v8-unwinder.h"           // NOLINT(build/include_directory)
59#include "v8-value-serializer.h"   // NOLINT(build/include_directory)
60#include "v8-value.h"              // NOLINT(build/include_directory)
61#include "v8-version.h"            // NOLINT(build/include_directory)
62#include "v8-wasm.h"               // NOLINT(build/include_directory)
63#include "v8config.h"              // NOLINT(build/include_directory)
64
65// We reserve the V8_* prefix for macros defined in V8 public API and
66// assume there are no name conflicts with the embedder's code.
67
68/**
69 * The v8 JavaScript engine.
70 */
71namespace v8 {
72
73class Platform;
74
75/**
76 * \example shell.cc
77 * A simple shell that takes a list of expressions on the
78 * command-line and executes them.
79 */
80
81/**
82 * \example process.cc
83 */
84
85
86}  // namespace v8
87
88#endif  // INCLUDE_V8_H_
89