diff options
Diffstat (limited to 'node_modules/node-addon-api/doc')
50 files changed, 8934 insertions, 0 deletions
diff --git a/node_modules/node-addon-api/doc/Doxyfile b/node_modules/node-addon-api/doc/Doxyfile new file mode 100644 index 0000000..995090d --- /dev/null +++ b/node_modules/node-addon-api/doc/Doxyfile @@ -0,0 +1,2450 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = N-API + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 1.3.0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "C++ wrapper classes for the ABI-stable C APIs for Node.js" + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if <section_label> ... \endif and \cond <section_label> +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = . + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = napi.h \ + README.md + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# <filter> <input-file> +# +# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use <access key> + S +# (what the <access key> is depends on the OS and browser, but it is typically +# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down +# key> to jump into the search results window, the results can be navigated +# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel +# the search. The filter options can be selected when the cursor is inside the +# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys> +# to select a filter and <Enter> or <escape> to activate or cancel the filter +# option. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a web server instead of a web client using Javascript. There +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SERVER_BASED_SEARCH = NO + +# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP +# script for searching. Instead the search results are written to an XML file +# which needs to be processed by an external indexer. Doxygen will invoke an +# external search engine pointed to by the SEARCHENGINE_URL option to obtain the +# search results. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: http://xapian.org/). +# +# See the section "External Indexing and Searching" for details. +# The default value is: NO. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH = NO + +# The SEARCHENGINE_URL should point to a search engine hosted by a web server +# which will return the search results when EXTERNAL_SEARCH is enabled. +# +# Doxygen ships with an example indexer (doxyindexer) and search engine +# (doxysearch.cgi) which are based on the open source search engine library +# Xapian (see: http://xapian.org/). See the section "External Indexing and +# Searching" for details. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHENGINE_URL = + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed +# search data is written to a file for indexing by an external tool. With the +# SEARCHDATA_FILE tag the name of this file can be specified. +# The default file is: searchdata.xml. +# This tag requires that the tag SEARCHENGINE is set to YES. + +SEARCHDATA_FILE = searchdata.xml + +# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the +# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is +# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple +# projects and redirect the results back to the right project. +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTERNAL_SEARCH_ID = + +# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen +# projects other than the one defined by this configuration file, but that are +# all added to the same external search index. Each project needs to have a +# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of +# to a relative location where the documentation can be found. The format is: +# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ... +# This tag requires that the tag SEARCHENGINE is set to YES. + +EXTRA_SEARCH_MAPPINGS = + +#--------------------------------------------------------------------------- +# Configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. +# The default value is: YES. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. +# +# Note that when enabling USE_PDFLATEX this option is only used for generating +# bitmaps for formulas in the HTML output, but not in the Makefile that is +# written to the output directory. +# The default file is: latex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate +# index for LaTeX. +# The default file is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used by the +# printer. +# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x +# 14 inches) and executive (7.25 x 10.5 inches). +# The default value is: a4. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} +# If left blank no extra packages will be included. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the +# generated LaTeX document. The header should contain everything until the first +# chapter. If it is left blank doxygen will generate a standard header. See +# section "Doxygen usage" for information on how to let doxygen write the +# default header to a separate file. +# +# Note: Only use a user-defined header if you know what you are doing! The +# following commands have a special meaning inside the header: $title, +# $datetime, $date, $doxygenversion, $projectname, $projectnumber, +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the +# generated LaTeX document. The footer should contain everything after the last +# chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. +# +# Note: Only use a user-defined footer if you know what you are doing! +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_FOOTER = + +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + +# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the LATEX_OUTPUT output +# directory. Note that the files will be copied as-is; there are no commands or +# markers available. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_FILES = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is +# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will +# contain links (just like the HTML output) instead of page references. This +# makes the output suitable for online browsing using a PDF viewer. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate +# the PDF file directly from the LaTeX files. Set this option to YES, to get a +# higher quality PDF documentation. +# The default value is: YES. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode +# command to the generated LaTeX files. This will instruct LaTeX to keep running +# if errors occur, instead of asking the user for help. This option is also used +# when generating formulas in HTML. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BATCHMODE = NO + +# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the +# index chapters (such as File Index, Compound Index, etc.) in the output. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_HIDE_INDICES = NO + +# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source +# code with syntax highlighting in the LaTeX output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_SOURCE_CODE = NO + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. See +# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# The default value is: plain. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_BIB_STYLE = plain + +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The +# RTF output is optimized for Word 97 and may not look too pretty with other RTF +# readers/editors. +# The default value is: NO. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: rtf. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF +# documents. This may be useful for small projects and may help to save some +# trees in general. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will +# contain hyperlink fields. The RTF file will contain links (just like the HTML +# output) instead of page references. This makes the output suitable for online +# browsing using Word or some other Word compatible readers that support those +# fields. +# +# Note: WordPad (write) and others do not support links. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's config +# file, i.e. a series of assignments. You only have to provide replacements, +# missing definitions are set to their default value. +# +# See also section "Doxygen usage" for information on how to generate the +# default style sheet that doxygen normally uses. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an RTF document. Syntax is +# similar to doxygen's config file. A template extensions file can be generated +# using doxygen -e rtf extensionFile. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_EXTENSIONS_FILE = + +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for +# classes and files. +# The default value is: NO. + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. A directory man3 will be created inside the directory specified by +# MAN_OUTPUT. +# The default directory is: man. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to the generated +# man pages. In case the manual section does not start with a number, the number +# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is +# optional. +# The default value is: .3. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_EXTENSION = .3 + +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + +# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it +# will generate one additional man file for each entity documented in the real +# man page(s). These additional files only source the real man page, but without +# them the man command would be unable to find the correct page. +# The default value is: NO. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that +# captures the structure of the code including all documentation. +# The default value is: NO. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: xml. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_OUTPUT = xml + +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program +# listings (including syntax highlighting and cross-referencing information) to +# the XML output. Note that enabling this will significantly increase the size +# of the XML output. +# The default value is: YES. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the DOCBOOK output +#--------------------------------------------------------------------------- + +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files +# that can be used to generate PDF. +# The default value is: NO. + +GENERATE_DOCBOOK = NO + +# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in +# front of it. +# The default directory is: docbook. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_OUTPUT = docbook + +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the +# program listings (including syntax highlighting and cross-referencing +# information) to the DOCBOOK output. Note that enabling this will significantly +# increase the size of the DOCBOOK output. +# The default value is: NO. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_PROGRAMLISTING = NO + +#--------------------------------------------------------------------------- +# Configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sf.net) file that captures the +# structure of the code including all documentation. Note that this feature is +# still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# Configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module +# file that captures the structure of the code including all documentation. +# +# Note that this feature is still experimental and incomplete at the moment. +# The default value is: NO. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary +# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI +# output from the Perl module output. +# The default value is: NO. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely +# formatted so it can be parsed by a human reader. This is useful if you want to +# understand what is going on. On the other hand, if this tag is set to NO, the +# size of the Perl module output will be much smaller and Perl will parse it +# just the same. +# The default value is: YES. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file are +# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful +# so different doxyrules.make files included by the same Makefile don't +# overwrite each other's variables. +# This tag requires that the tag GENERATE_PERLMOD is set to YES. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all +# C-preprocessor directives found in the sources and include files. +# The default value is: YES. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be +# performed. Macro expansion can be done in a controlled way by setting +# EXPAND_ONLY_PREDEF to YES. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then +# the macro expansion is limited to the macros specified with the PREDEFINED and +# EXPAND_AS_DEFINED tags. +# The default value is: NO. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES, the include files in the +# INCLUDE_PATH will be searched if a #include is found. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by the +# preprocessor. +# This tag requires that the tag SEARCH_INCLUDES is set to YES. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will be +# used. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that are +# defined before the preprocessor is started (similar to the -D option of e.g. +# gcc). The argument of the tag is a list of macros of the form: name or +# name=definition (no spaces). If the definition and the "=" are omitted, "=1" +# is assumed. To prevent a macro definition from being undefined via #undef or +# recursively expanded use the := operator instead of the = operator. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this +# tag can be used to specify a list of macro names that should be expanded. The +# macro definition that is found in the sources will be used. Use the PREDEFINED +# tag if you want to use a different macro definition that overrules the +# definition found in the source code. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will +# remove all references to function-like macros that are alone on a line, have +# an all uppercase name, and do not end with a semicolon. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not +# removed. +# The default value is: YES. +# This tag requires that the tag ENABLE_PREPROCESSING is set to YES. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES tag can be used to specify one or more tag files. For each tag +# file the location of the external documentation should be added. The format of +# a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where loc1 and loc2 can be relative or absolute paths or URLs. See the +# section "Linking to external documentation" for more information about the use +# of tag files. +# Note: Each tag file must have a unique name (where the name does NOT include +# the path). If a tag file is not located in the directory in which doxygen is +# run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create a +# tag file that is based on the input files it reads. See section "Linking to +# external documentation" for more information about the usage of tag files. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. +# The default value is: NO. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be +# listed. +# The default value is: YES. + +EXTERNAL_GROUPS = YES + +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in +# the related pages index. If set to NO, only the current project's pages will +# be listed. +# The default value is: YES. + +EXTERNAL_PAGES = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of 'which perl'). +# The default file (with absolute path) is: /usr/bin/perl. + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram +# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to +# NO turns the diagrams off. Note that this option also works with HAVE_DOT +# disabled, but it is recommended to install and use dot, since it yields more +# powerful graphs. +# The default value is: YES. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see: +# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# You can include diagrams made with dia in doxygen documentation. Doxygen will +# then run dia to produce the diagram and insert it in the documentation. The +# DIA_PATH tag allows you to specify the directory where the dia binary resides. +# If left empty dia is assumed to be found in the default search path. + +DIA_PATH = + +# If set to YES the inheritance and collaboration graphs will hide inheritance +# and usage relations if the target is undocumented or is not a class. +# The default value is: YES. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz (see: +# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent +# Bell Labs. The other options in this section have no effect if this option is +# set to NO +# The default value is: NO. + +HAVE_DOT = NO + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed +# to run in parallel. When set to 0 doxygen will base this on the number of +# processors available in the system. You can set it explicitly to a value +# larger than 0 to get control over the balance between CPU load and processing +# speed. +# Minimum value: 0, maximum value: 32, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_NUM_THREADS = 0 + +# When you want a differently looking font in the dot files that doxygen +# generates you can specify the font name using DOT_FONTNAME. You need to make +# sure dot is able to find the font, which can be done by putting it in a +# standard location or by setting the DOTFONTPATH environment variable or by +# setting DOT_FONTPATH to the directory containing the font. +# The default value is: Helvetica. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of +# dot graphs. +# Minimum value: 4, maximum value: 24, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the default font as specified with +# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set +# the path where dot can find it using this tag. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_FONTPATH = + +# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for +# each documented class showing the direct and indirect inheritance relations. +# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a +# graph for each documented class showing the direct and indirect implementation +# dependencies (inheritance, containment, and class references variables) of the +# class with other documented classes. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for +# groups, showing the direct groups dependencies. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LOOK = NO + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside the +# class node. If there are many fields or methods and many nodes the graph may +# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the +# number of items for each type to make the size more manageable. Set this to 0 +# for no limit. Note that the threshold may be exceeded by 50% before the limit +# is enforced. So when you set the threshold to 10, up to 15 fields may appear, +# but if the number exceeds 15, the total amount of fields shown is limited to +# 10. +# Minimum value: 0, maximum value: 100, default value: 10. +# This tag requires that the tag HAVE_DOT is set to YES. + +UML_LIMIT_NUM_FIELDS = 10 + +# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and +# collaboration graphs will show the relations between templates and their +# instances. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +TEMPLATE_RELATIONS = NO + +# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to +# YES then doxygen will generate a graph for each documented file showing the +# direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDE_GRAPH = YES + +# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are +# set to YES then doxygen will generate a graph for each documented file showing +# the direct and indirect include dependencies of the file with other documented +# files. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH tag is set to YES then doxygen will generate a call +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller +# dependency graph for every global function or class method. +# +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected +# functions only using the \callergraph command. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical +# hierarchy of all classes instead of a textual one. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the +# dependencies a directory has on other directories in a graphical way. The +# dependency relations are determined by the #include relations between the +# files in the directories. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). +# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order +# to make the SVG files visible in IE 9+ (other browsers do not have this +# requirement). +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. +# The default value is: png. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_IMAGE_FORMAT = png + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# +# Note that this requires a modern browser other than Internet Explorer. Tested +# and working are Firefox, Chrome, Safari, and Opera. +# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make +# the SVG files visible. Older versions of IE do not have SVG support. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +INTERACTIVE_SVG = NO + +# The DOT_PATH tag can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the \dotfile +# command). +# This tag requires that the tag HAVE_DOT is set to YES. + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the \mscfile +# command). + +MSCFILE_DIRS = + +# The DIAFILE_DIRS tag can be used to specify one or more directories that +# contain dia files that are included in the documentation (see the \diafile +# command). + +DIAFILE_DIRS = + +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes +# that will be shown in the graph. If the number of nodes in a graph becomes +# larger than this value, doxygen will truncate the graph, which is visualized +# by representing a node as a red box. Note that doxygen if the number of direct +# children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that +# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. +# Minimum value: 0, maximum value: 10000, default value: 50. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs +# generated by dot. A depth value of 3 means that only nodes reachable from the +# root by following a path via at most 3 edges will be shown. Nodes that lay +# further from the root node will be omitted. Note that setting this option to 1 +# or 2 may greatly reduce the computation time needed for large code bases. Also +# note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. +# Minimum value: 0, maximum value: 1000, default value: 0. +# This tag requires that the tag HAVE_DOT is set to YES. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not seem +# to support this out of the box. +# +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# read). +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) support +# this, this feature is disabled by default. +# The default value is: NO. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page +# explaining the meaning of the various boxes and arrows in the dot generated +# graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot +# files that are used to generate the various graphs. +# The default value is: YES. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_CLEANUP = YES diff --git a/node_modules/node-addon-api/doc/array_buffer.md b/node_modules/node-addon-api/doc/array_buffer.md new file mode 100644 index 0000000..ca9d45c --- /dev/null +++ b/node_modules/node-addon-api/doc/array_buffer.md @@ -0,0 +1,129 @@ +# ArrayBuffer + +The `Napi::ArrayBuffer` class corresponds to the +[JavaScript `ArrayBuffer`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer) +class. + +## Methods + +### New + +Allocates a new `Napi::ArrayBuffer` instance with a given length. + +```cpp +static Napi::ArrayBuffer Napi::ArrayBuffer::New(napi_env env, size_t byteLength); +``` + +- `[in] env`: The environment in which to create the `Napi::ArrayBuffer` instance. +- `[in] byteLength`: The length to be allocated, in bytes. + +Returns a new `Napi::ArrayBuffer` instance. + +### New + +Wraps the provided external data into a new `Napi::ArrayBuffer` instance. + +The `Napi::ArrayBuffer` instance does not assume ownership for the data and +expects it to be valid for the lifetime of the instance. Since the +`Napi::ArrayBuffer` is subject to garbage collection this overload is only +suitable for data which is static and never needs to be freed. + +```cpp +static Napi::ArrayBuffer Napi::ArrayBuffer::New(napi_env env, void* externalData, size_t byteLength); +``` + +- `[in] env`: The environment in which to create the `Napi::ArrayBuffer` instance. +- `[in] externalData`: The pointer to the external data to wrap. +- `[in] byteLength`: The length of the `externalData`, in bytes. + +Returns a new `Napi::ArrayBuffer` instance. + +### New + +Wraps the provided external data into a new `Napi::ArrayBuffer` instance. + +The `Napi::ArrayBuffer` instance does not assume ownership for the data and +expects it to be valid for the lifetime of the instance. The data can only be +freed once the `finalizeCallback` is invoked to indicate that the +`Napi::ArrayBuffer` has been released. + +```cpp +template <typename Finalizer> +static Napi::ArrayBuffer Napi::ArrayBuffer::New(napi_env env, + void* externalData, + size_t byteLength, + Finalizer finalizeCallback); +``` + +- `[in] env`: The environment in which to create the `Napi::ArrayBuffer` instance. +- `[in] externalData`: The pointer to the external data to wrap. +- `[in] byteLength`: The length of the `externalData`, in bytes. +- `[in] finalizeCallback`: A function to be called when the `Napi::ArrayBuffer` is + destroyed. It must implement `operator()`, accept a `void*` (which is the + `externalData` pointer), and return `void`. + +Returns a new `Napi::ArrayBuffer` instance. + +### New + +Wraps the provided external data into a new `Napi::ArrayBuffer` instance. + +The `Napi::ArrayBuffer` instance does not assume ownership for the data and expects it +to be valid for the lifetime of the instance. The data can only be freed once +the `finalizeCallback` is invoked to indicate that the `Napi::ArrayBuffer` has been +released. + +```cpp +template <typename Finalizer, typename Hint> +static Napi::ArrayBuffer Napi::ArrayBuffer::New(napi_env env, + void* externalData, + size_t byteLength, + Finalizer finalizeCallback, + Hint* finalizeHint); +``` + +- `[in] env`: The environment in which to create the `Napi::ArrayBuffer` instance. +- `[in] externalData`: The pointer to the external data to wrap. +- `[in] byteLength`: The length of the `externalData`, in bytes. +- `[in] finalizeCallback`: The function to be called when the `Napi::ArrayBuffer` is + destroyed. It must implement `operator()`, accept a `void*` (which is the + `externalData` pointer) and `Hint*`, and return `void`. +- `[in] finalizeHint`: The hint to be passed as the second parameter of the + finalize callback. + +Returns a new `Napi::ArrayBuffer` instance. + +### Constructor + +Initializes an empty instance of the `Napi::ArrayBuffer` class. + +```cpp +Napi::ArrayBuffer::ArrayBuffer(); +``` + +### Constructor + +Initializes a wrapper instance of an existing `Napi::ArrayBuffer` object. + +```cpp +Napi::ArrayBuffer::ArrayBuffer(napi_env env, napi_value value); +``` + +- `[in] env`: The environment in which to create the `Napi::ArrayBuffer` instance. +- `[in] value`: The `Napi::ArrayBuffer` reference to wrap. + +### ByteLength + +```cpp +size_t Napi::ArrayBuffer::ByteLength() const; +``` + +Returns the length of the wrapped data, in bytes. + +### Data + +```cpp +void* Napi::ArrayBuffer::Data() const; +``` + +Returns a pointer the wrapped data. diff --git a/node_modules/node-addon-api/doc/async_context.md b/node_modules/node-addon-api/doc/async_context.md new file mode 100644 index 0000000..8e1f481 --- /dev/null +++ b/node_modules/node-addon-api/doc/async_context.md @@ -0,0 +1,86 @@ +# AsyncContext + +The [Napi::AsyncWorker](async_worker.md) class may not be appropriate for every +scenario. When using any other async mechanism, introducing a new class +`Napi::AsyncContext` is necessary to ensure an async operation is properly +tracked by the runtime. The `Napi::AsyncContext` class can be passed to +[Napi::Function::MakeCallback()](function.md) method to properly restore the +correct async execution context. + +## Methods + +### Constructor + +Creates a new `Napi::AsyncContext`. + +```cpp +explicit Napi::AsyncContext::AsyncContext(napi_env env, const char* resource_name); +``` + +- `[in] env`: The environment in which to create the `Napi::AsyncContext`. +- `[in] resource_name`: Null-terminated strings that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the `async_hooks` API. + +### Constructor + +Creates a new `Napi::AsyncContext`. + +```cpp +explicit Napi::AsyncContext::AsyncContext(napi_env env, const char* resource_name, const Napi::Object& resource); +``` + +- `[in] env`: The environment in which to create the `Napi::AsyncContext`. +- `[in] resource_name`: Null-terminated strings that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the `async_hooks` API. +- `[in] resource`: Object associated with the asynchronous operation that +will be passed to possible `async_hooks`. + +### Destructor + +The `Napi::AsyncContext` to be destroyed. + +```cpp +virtual Napi::AsyncContext::~AsyncContext(); +``` + +### Env + +Requests the environment in which the async context has been initially created. + +```cpp +Napi::Env Env() const; +``` + +Returns the `Napi::Env` environment in which the async context has been created. + +## Operator + +```cpp +Napi::AsyncContext::operator napi_async_context() const; +``` + +Returns the N-API `napi_async_context` wrapped by the `Napi::AsyncContext` +object. This can be used to mix usage of the C N-API and node-addon-api. + +## Example + +```cpp +#include "napi.h" + +void MakeCallbackWithAsyncContext(const Napi::CallbackInfo& info) { + Napi::Function callback = info[0].As<Napi::Function>(); + Napi::Object resource = info[1].As<Napi::Object>(); + + // Creat a new async context instance. + Napi::AsyncContext context(info.Env(), "async_context_test", resource); + + // Invoke the callback with the async context instance. + callback.MakeCallback(Napi::Object::New(info.Env()), + std::initializer_list<napi_value>{}, context); + + // The async context instance is automatically destroyed here because it's + // block-scope like `Napi::HandleScope`. +} +``` diff --git a/node_modules/node-addon-api/doc/async_operations.md b/node_modules/node-addon-api/doc/async_operations.md new file mode 100644 index 0000000..064a9c5 --- /dev/null +++ b/node_modules/node-addon-api/doc/async_operations.md @@ -0,0 +1,31 @@ +# Asynchronous operations + +Node.js native add-ons often need to execute long running tasks and to avoid +blocking the **event loop** they have to run them asynchronously from the +**event loop**. +In the Node.js model of execution the event loop thread represents the thread +where JavaScript code is executing. The Node.js guidance is to avoid blocking +other work queued on the event loop thread. Therefore, we need to do this work on +another thread. + +All this means that native add-ons need to leverage async helpers from libuv as +part of their implementation. This allows them to schedule work to be executed +asynchronously so that their methods can return in advance of the work being +completed. + +Node Addon API provides an interface to support functions that cover +the most common asynchronous use cases. There is an abstract classes to implement +asynchronous operations: + +- **[`Napi::AsyncWorker`](async_worker.md)** + +These class helps manage asynchronous operations through an abstraction +of the concept of moving data between the **event loop** and **worker threads**. + +Also, the above class may not be appropriate for every scenario. When using any +other asynchronous mechanism, the following API is necessary to ensure an +asynchronous operation is properly tracked by the runtime: + +- **[AsyncContext](async_context.md)** + +- **[CallbackScope](callback_scope.md)** diff --git a/node_modules/node-addon-api/doc/async_progress_worker.md b/node_modules/node-addon-api/doc/async_progress_worker.md new file mode 100644 index 0000000..296b51b --- /dev/null +++ b/node_modules/node-addon-api/doc/async_progress_worker.md @@ -0,0 +1,344 @@ +# AsyncProgressWorker + +`Napi::AsyncProgressWorker` is an abstract class which implements `Napi::AsyncWorker` +while extending `Napi::AsyncWorker` internally with `Napi::ThreadSafeFunction` for +moving work progress reports from worker thread(s) to event loop threads. + +Like `Napi::AsyncWorker`, once created, execution is requested by calling +`Napi::AsyncProgressWorker::Queue`. When a thread is available for execution +the `Napi::AsyncProgressWorker::Execute` method will be invoked. During the +execution, `Napi::AsyncProgressWorker::ExecutionProgress::Send` can be used to +indicate execution process, which will eventually invoke `Napi::AsyncProgressWorker::OnProgress` +on the JavaScript thread to safely call into JavaScript. Once `Napi::AsyncProgressWorker::Execute` +completes either `Napi::AsyncProgressWorker::OnOK` or `Napi::AsyncProgressWorker::OnError` +will be invoked. Once the `Napi::AsyncProgressWorker::OnOK` or `Napi::AsyncProgressWorker::OnError` +methods are complete the `Napi::AsyncProgressWorker` instance is destructed. + +For the most basic use, only the `Napi::AsyncProgressWorker::Execute` and +`Napi::AsyncProgressWorker::OnProgress` method must be implemented in a subclass. + +## Methods + +[`Napi::AsyncWorker`][] provides detailed descriptions for most methods. + +### Execute + +This method is used to execute some tasks outside of the **event loop** on a libuv +worker thread. Subclasses must implement this method and the method is run on +a thread other than that running the main event loop. As the method is not +running on the main event loop, it must avoid calling any methods from node-addon-api +or running any code that might invoke JavaScript. Instead, once this method is +complete any interaction through node-addon-api with JavaScript should be implemented +in the `Napi::AsyncProgressWorker::OnOK` method and/or `Napi::AsyncProgressWorker::OnError` +which run on the main thread and are invoked when the `Napi::AsyncProgressWorker::Execute` +method completes. + +```cpp +virtual void Napi::AsyncProgressWorker::Execute(const ExecutionProgress& progress) = 0; +``` + +### OnOK + +This method is invoked when the computation in the `Execute` method ends. +The default implementation runs the `Callback` optionally provided when the +`AsyncProgressWorker` class was created. The `Callback` will by default receive no +arguments. Arguments to the callback can be provided by overriding the `GetResult()` +method. + +```cpp +virtual void Napi::AsyncProgressWorker::OnOK(); +``` + +### OnProgress + +This method is invoked when the computation in the `Napi::AsyncProgressWorker::ExecutionProcess::Send` +method was called during worker thread execution. + +```cpp +virtual void Napi::AsyncProgressWorker::OnProgress(const T* data, size_t count) +``` + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(const Napi::Function& callback); +``` + +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. + +Returns a `Napi::AsyncProgressWorker` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(const Napi::Function& callback, const char* resource_name); +``` + +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. + +Returns a `Napi::AsyncProgressWorker` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(const Napi::Function& callback, const char* resource_name, const Napi::Object& resource); +``` + +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. +- `[in] resource`: Object associated with the asynchronous operation that +will be passed to possible async_hooks. + +Returns a `Napi::AsyncProgressWorker` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(const Napi::Object& receiver, const Napi::Function& callback); +``` + +- `[in] receiver`: The `this` object passed to the called function. +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. + +Returns a `Napi::AsyncProgressWorker` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(const Napi::Object& receiver, const Napi::Function& callback, const char* resource_name); +``` + +- `[in] receiver`: The `this` object passed to the called function. +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. + +Returns a `Napi::AsyncWork` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(const Napi::Object& receiver, const Napi::Function& callback, const char* resource_name, const Napi::Object& resource); +``` + +- `[in] receiver`: The `this` object to be passed to the called function. +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. +- `[in] resource`: Object associated with the asynchronous operation that +will be passed to possible async_hooks. + +Returns a `Napi::AsyncWork` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(Napi::Env env); +``` + +- `[in] env`: The environment in which to create the `Napi::AsyncProgressWorker`. + +Returns an `Napi::AsyncProgressWorker` instance which can later be queued for execution by calling +`Napi::AsyncProgressWorker::Queue`. + +Available with `NAPI_VERSION` equal to or greater than 5. + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(Napi::Env env, const char* resource_name); +``` + +- `[in] env`: The environment in which to create the `Napi::AsyncProgressWorker`. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. + +Returns a `Napi::AsyncProgressWorker` instance which can later be queued for execution by +calling `Napi::AsyncProgressWorker::Queue`. + +Available with `NAPI_VERSION` equal to or greater than 5. + +### Constructor + +Creates a new `Napi::AsyncProgressWorker`. + +```cpp +explicit Napi::AsyncProgressWorker(Napi::Env env, const char* resource_name, const Napi::Object& resource); +``` + +- `[in] env`: The environment in which to create the `Napi::AsyncProgressWorker`. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. +- `[in] resource`: Object associated with the asynchronous operation that +will be passed to possible async_hooks. + +Returns a `Napi::AsyncProgressWorker` instance which can later be queued for execution by +calling `Napi::AsyncProgressWorker::Queue`. + +Available with `NAPI_VERSION` equal to or greater than 5. + +### Destructor + +Deletes the created work object that is used to execute logic asynchronously and +release the internal `Napi::ThreadSafeFunction`, which will be aborted to prevent +unexpected upcoming thread safe calls. + +```cpp +virtual Napi::AsyncProgressWorker::~AsyncProgressWorker(); +``` + +# AsyncProgressWorker::ExecutionProcess + +A bridge class created before the worker thread execution of `Napi::AsyncProgressWorker::Execute`. + +## Methods + +### Send + +`Napi::AsyncProgressWorker::ExecutionProcess::Send` takes two arguments, a pointer +to a generic type of data, and a `size_t` to indicate how many items the pointer is +pointing to. + +The data pointed to will be copied to internal slots of `Napi::AsyncProgressWorker` so +after the call to `Napi::AsyncProgressWorker::ExecutionProcess::Send` the data can +be safely released. + +Note that `Napi::AsyncProgressWorker::ExecutionProcess::Send` merely guarantees +**eventual** invocation of `Napi::AsyncProgressWorker::OnProgress`, which means +multiple send might be coalesced into single invocation of `Napi::AsyncProgressWorker::OnProgress` +with latest data. + +```cpp +void Napi::AsyncProgressWorker::ExecutionProcess::Send(const T* data, size_t count) const; +``` + +## Example + +The first step to use the `Napi::AsyncProgressWorker` class is to create a new class that +inherits from it and implement the `Napi::AsyncProgressWorker::Execute` abstract method. +Typically input to the worker will be saved within the class' fields generally +passed in through its constructor. + +During the worker thread execution, the first argument of `Napi::AsyncProgressWorker::Execute` +can be used to report the progress of the execution. + +When the `Napi::AsyncProgressWorker::Execute` method completes without errors the +`Napi::AsyncProgressWorker::OnOK` function callback will be invoked. In this function the +results of the computation will be reassembled and returned back to the initial +JavaScript context. + +`Napi::AsyncProgressWorker` ensures that all the code in the `Napi::AsyncProgressWorker::Execute` +function runs in the background out of the **event loop** thread and at the end +the `Napi::AsyncProgressWorker::OnOK` or `Napi::AsyncProgressWorker::OnError` function will be +called and are executed as part of the event loop. + +The code below shows a basic example of the `Napi::AsyncProgressWorker` implementation: + +```cpp +#include<napi.h> + +#include <chrono> +#include <thread> + +use namespace Napi; + +class EchoWorker : public AsyncProgressWorker<uint32_t> { + public: + EchoWorker(Function& callback, std::string& echo) + : AsyncProgressWorker(callback), echo(echo) {} + + ~EchoWorker() {} + // This code will be executed on the worker thread + void Execute(const ExecutionProgress& progress) { + // Need to simulate cpu heavy task + for (uint32_t i = 0; i < 100; ++i) { + progress.Send(&i, 1) + std::this_thread::sleep_for(std::chrono::seconds(1)); + } + } + + void OnOK() { + HandleScope scope(Env()); + Callback().Call({Env().Null(), String::New(Env(), echo)}); + } + + void OnProgress(const uint32_t* data, size_t /* count */) { + HandleScope scope(Env()); + Callback().Call({Env().Null(), Env().Null(), Number::New(Env(), *data)}); + } + + private: + std::string echo; +}; +``` + +The `EchoWorker`'s constructor calls the base class' constructor to pass in the +callback that the `Napi::AsyncProgressWorker` base class will store persistently. When +the work on the `Napi::AsyncProgressWorker::Execute` method is done the +`Napi::AsyncProgressWorker::OnOk` method is called and the results are return back to +JavaScript when the stored callback is invoked with its associated environment. + +The following code shows an example of how to create and use an `Napi::AsyncProgressWorker` + +```cpp +#include <napi.h> + +// Include EchoWorker class +// .. + +use namespace Napi; + +Value Echo(const CallbackInfo& info) { + // We need to validate the arguments here + Function cb = info[1].As<Function>(); + std::string in = info[0].As<String>(); + EchoWorker* wk = new EchoWorker(cb, in); + wk->Queue(); + return info.Env().Undefined(); +} +``` + +The implementation of a `Napi::AsyncProgressWorker` can be used by creating a +new instance and passing to its constructor the callback to execute when the +asynchronous task ends and other data needed for the computation. Once created, +the only other action needed is to call the `Napi::AsyncProgressWorker::Queue` +method that will queue the created worker for execution. + +[`Napi::AsyncWorker`]: ./async_worker.md diff --git a/node_modules/node-addon-api/doc/async_worker.md b/node_modules/node-addon-api/doc/async_worker.md new file mode 100644 index 0000000..88668af --- /dev/null +++ b/node_modules/node-addon-api/doc/async_worker.md @@ -0,0 +1,398 @@ +# AsyncWorker + +`Napi::AsyncWorker` is an abstract class that you can subclass to remove many of +the tedious tasks of moving data between the event loop and worker threads. This +class internally handles all the details of creating and executing an asynchronous +operation. + +Once created, execution is requested by calling `Napi::AsyncWorker::Queue`. When +a thread is available for execution the `Napi::AsyncWorker::Execute` method will +be invoked. Once `Napi::AsyncWorker::Execute` completes either +`Napi::AsyncWorker::OnOK` or `Napi::AsyncWorker::OnError` will be invoked. Once +the `Napi::AsyncWorker::OnOK` or `Napi::AsyncWorker::OnError` methods are +complete the `Napi::AsyncWorker` instance is destructed. + +For the most basic use, only the `Napi::AsyncWorker::Execute` method must be +implemented in a subclass. + +## Methods + +### Env + +Requests the environment in which the async worker has been initially created. + +```cpp +Napi::Env Napi::AsyncWorker::Env() const; +``` + +Returns the environment in which the async worker has been created. + +### Queue + +Requests that the work be queued for execution. + +```cpp +void Napi::AsyncWorker::Queue(); +``` + +### Cancel + +Cancels queued work if it has not yet been started. If it has already started +executing, it cannot be cancelled. If cancelled successfully neither +`OnOK` nor `OnError` will be called. + +```cpp +void Napi::AsyncWorker::Cancel(); +``` + +### Receiver + +```cpp +Napi::ObjectReference& Napi::AsyncWorker::Receiver(); +``` + +Returns the persistent object reference of the receiver object set when the async +worker was created. + +### Callback + +```cpp +Napi::FunctionReference& Napi::AsyncWorker::Callback(); +``` + +Returns the persistent function reference of the callback set when the async +worker was created. The returned function reference will receive the results of +the computation that happened in the `Napi::AsyncWorker::Execute` method, unless +the default implementation of `Napi::AsyncWorker::OnOK` or +`Napi::AsyncWorker::OnError` is overridden. + +### SuppressDestruct + +```cpp +void Napi::AsyncWorker::SuppressDestruct(); +``` + +Prevents the destruction of the `Napi::AsyncWorker` instance upon completion of +the `Napi::AsyncWorker::OnOK` callback. + +### SetError + +Sets the error message for the error that happened during the execution. Setting +an error message will cause the `Napi::AsyncWorker::OnError` method to be +invoked instead of `Napi::AsyncWorker::OnOK` once the +`Napi::AsyncWorker::Execute` method completes. + +```cpp +void Napi::AsyncWorker::SetError(const std::string& error); +``` + +- `[in] error`: The reference to the string that represent the message of the error. + +### Execute + +This method is used to execute some tasks outside of the **event loop** on a libuv +worker thread. Subclasses must implement this method and the method is run on +a thread other than that running the main event loop. As the method is not +running on the main event loop, it must avoid calling any methods from node-addon-api +or running any code that might invoke JavaScript. Instead, once this method is +complete any interaction through node-addon-api with JavaScript should be implemented +in the `Napi::AsyncWorker::OnOK` method and `Napi::AsyncWorker::OnError` which run +on the main thread and are invoked when the `Napi::AsyncWorker::Execute` method completes. + +```cpp +virtual void Napi::AsyncWorker::Execute() = 0; +``` + +### OnOK + +This method is invoked when the computation in the `Execute` method ends. +The default implementation runs the `Callback` optionally provided when the +`AsyncWorker` class was created. The `Callback` will by default receive no +arguments. The arguments to the `Callback` can be provided by overriding the +`GetResult()` method. + +```cpp +virtual void Napi::AsyncWorker::OnOK(); +``` +### GetResult + +This method returns the arguments passed to the `Callback` invoked by the default +`OnOK()` implementation. The default implementation returns an empty vector, +providing no arguments to the `Callback`. + +```cpp +virtual std::vector<napi_value> Napi::AsyncWorker::GetResult(Napi::Env env); +``` + +### OnError + +This method is invoked after `Napi::AsyncWorker::Execute` completes if an error +occurs while `Napi::AsyncWorker::Execute` is running and C++ exceptions are +enabled or if an error was set through a call to `Napi::AsyncWorker::SetError`. +The default implementation calls the `Callback` provided when the `Napi::AsyncWorker` +class was created, passing in the error as the first parameter. + +```cpp +virtual void Napi::AsyncWorker::OnError(const Napi::Error& e); +``` + +### Destroy + +This method is invoked when the instance must be deallocated. If +`SuppressDestruct()` was not called then this method will be called after either +`OnError()` or `OnOK()` complete. The default implementation of this method +causes the instance to delete itself using the `delete` operator. The method is +provided so as to ensure that instances allocated by means other than the `new` +operator can be deallocated upon work completion. + +```cpp +virtual void Napi::AsyncWorker::Destroy(); +``` + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(const Napi::Function& callback); +``` + +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. + +Returns a `Napi::AsyncWorker` instance which can later be queued for execution by calling +`Queue`. + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(const Napi::Function& callback, const char* resource_name); +``` + +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. + +Returns a `Napi::AsyncWorker` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(const Napi::Function& callback, const char* resource_name, const Napi::Object& resource); +``` + +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. +- `[in] resource`: Object associated with the asynchronous operation that +will be passed to possible async_hooks. + +Returns a `Napi::AsyncWorker` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(const Napi::Object& receiver, const Napi::Function& callback); +``` + +- `[in] receiver`: The `this` object passed to the called function. +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. + +Returns a `Napi::AsyncWorker` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(const Napi::Object& receiver, const Napi::Function& callback, const char* resource_name); +``` + +- `[in] receiver`: The `this` object passed to the called function. +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. + +Returns a `Napi::AsyncWork` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(const Napi::Object& receiver, const Napi::Function& callback, const char* resource_name, const Napi::Object& resource); +``` + +- `[in] receiver`: The `this` object passed to the called function. +- `[in] callback`: The function which will be called when an asynchronous +operations ends. The given function is called from the main event loop thread. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. +- `[in] resource`: Object associated with the asynchronous operation that +will be passed to possible async_hooks. + +Returns a `Napi::AsyncWork` instance which can later be queued for execution by +calling `Napi::AsyncWork::Queue`. + + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(Napi::Env env); +``` + +- `[in] env`: The environment in which to create the `Napi::AsyncWorker`. + +Returns an `Napi::AsyncWorker` instance which can later be queued for execution by calling +`Napi::AsyncWorker::Queue`. + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(Napi::Env env, const char* resource_name); +``` + +- `[in] env`: The environment in which to create the `Napi::AsyncWorker`. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. + +Returns a `Napi::AsyncWorker` instance which can later be queued for execution by +calling `Napi::AsyncWorker::Queue`. + +### Constructor + +Creates a new `Napi::AsyncWorker`. + +```cpp +explicit Napi::AsyncWorker(Napi::Env env, const char* resource_name, const Napi::Object& resource); +``` + +- `[in] env`: The environment in which to create the `Napi::AsyncWorker`. +- `[in] resource_name`: Null-terminated string that represents the +identifier for the kind of resource that is being provided for diagnostic +information exposed by the async_hooks API. +- `[in] resource`: Object associated with the asynchronous operation that +will be passed to possible async_hooks. + +Returns a `Napi::AsyncWorker` instance which can later be queued for execution by +calling `Napi::AsyncWorker::Queue`. + +### Destructor + +Deletes the created work object that is used to execute logic asynchronously. + +```cpp +virtual Napi::AsyncWorker::~AsyncWorker(); +``` + +## Operator + +```cpp +Napi::AsyncWorker::operator napi_async_work() const; +``` + +Returns the N-API napi_async_work wrapped by the `Napi::AsyncWorker` object. This +can be used to mix usage of the C N-API and node-addon-api. + +## Example + +The first step to use the `Napi::AsyncWorker` class is to create a new class that +inherits from it and implement the `Napi::AsyncWorker::Execute` abstract method. +Typically input to your worker will be saved within class' fields generally +passed in through its constructor. + +When the `Napi::AsyncWorker::Execute` method completes without errors the +`Napi::AsyncWorker::OnOK` function callback will be invoked. In this function the +results of the computation will be reassembled and returned back to the initial +JavaScript context. + +`Napi::AsyncWorker` ensures that all the code in the `Napi::AsyncWorker::Execute` +function runs in the background out of the **event loop** thread and at the end +the `Napi::AsyncWorker::OnOK` or `Napi::AsyncWorker::OnError` function will be +called and are executed as part of the event loop. + +The code below shows a basic example of `Napi::AsyncWorker` the implementation: + +```cpp +#include<napi.h> + +#include <chrono> +#include <thread> + +use namespace Napi; + +class EchoWorker : public AsyncWorker { + public: + EchoWorker(Function& callback, std::string& echo) + : AsyncWorker(callback), echo(echo) {} + + ~EchoWorker() {} + // This code will be executed on the worker thread + void Execute() { + // Need to simulate cpu heavy task + std::this_thread::sleep_for(std::chrono::seconds(1)); + } + + void OnOK() { + HandleScope scope(Env()); + Callback().Call({Env().Null(), String::New(Env(), echo)}); + } + + private: + std::string echo; +}; +``` + +The `EchoWorker`'s contructor calls the base class' constructor to pass in the +callback that the `Napi::AsyncWorker` base class will store persistently. When +the work on the `Napi::AsyncWorker::Execute` method is done the +`Napi::AsyncWorker::OnOk` method is called and the results return back to +JavaScript invoking the stored callback with its associated environment. + +The following code shows an example of how to create and use an `Napi::AsyncWorker`. + +```cpp +#include<napi.h> + +// Include EchoWorker class +// .. + +use namespace Napi; + +Value Echo(const CallbackInfo& info) { + // You need to validate the arguments here. + Function cb = info[1].As<Function>(); + std::string in = info[0].As<String>(); + EchoWorker* wk = new EchoWorker(cb, in); + wk->Queue(); + return info.Env().Undefined(); +``` + +Using the implementation of a `Napi::AsyncWorker` is straight forward. You only +need to create a new instance and pass to its constructor the callback you want to +execute when your asynchronous task ends and other data you need for your +computation. Once created the only other action you have to do is to call the +`Napi::AsyncWorker::Queue` method that will queue the created worker for execution. diff --git a/node_modules/node-addon-api/doc/basic_types.md b/node_modules/node-addon-api/doc/basic_types.md new file mode 100644 index 0000000..03ec14b --- /dev/null +++ b/node_modules/node-addon-api/doc/basic_types.md @@ -0,0 +1,423 @@ +# Basic Types + +Node Addon API consists of a few fundamental data types. These allow a user of +the API to create, convert and introspect fundamental JavaScript types, and +interoperate with their C++ counterparts. + +## Value + +`Napi::Value` is the base class of Node Addon API's fundamental object type hierarchy. +It represents a JavaScript value of an unknown type. It is a thin wrapper around +the N-API datatype `napi_value`. Methods on this class can be used to check +the JavaScript type of the underlying N-API `napi_value` and also to convert to +C++ types. + +### Constructor + +```cpp +Napi::Value::Value(); +``` + +Used to create a Node Addon API `Napi::Value` that represents an **empty** value. + +```cpp +Napi::Value::Value(napi_env env, napi_value value); +``` + +- `[in] env` - The `napi_env` environment in which to construct the `Napi::Value` +object. +- `[in] value` - The underlying JavaScript value that the `Napi::Value` instance +represents. + +Returns a Node.js Addon API `Napi::Value` that represents the `napi_value` passed +in. + +### Operators + +#### operator napi_value + +```cpp +Napi::Value::operator napi_value() const; +``` + +Returns the underlying N-API `napi_value`. If the instance is _empty_, this +returns `nullptr`. + +#### operator == + +```cpp +bool Napi::Value::operator ==(const Value& other) const; +``` + +Returns `true` if this value strictly equals another value, or `false` otherwise. + +#### operator != + +```cpp +bool Napi::Value::operator !=(const Value& other) const; +``` + +Returns `false` if this value strictly equals another value, or `true` otherwise. + +### Methods + +#### From +```cpp +template <typename T> +static Napi::Value Napi::Value::From(napi_env env, const T& value); +``` + +- `[in] env` - The `napi_env` environment in which to construct the `Napi::Value` object. +- `[in] value` - The C++ type to represent in JavaScript. + +Returns a `Napi::Value` representing the input C++ type in JavaScript. + +This method is used to convert from a C++ type to a JavaScript value. +Here, `value` may be any of: +- `bool` - returns a `Napi::Boolean`. +- Any integer type - returns a `Napi::Number`. +- Any floating point type - returns a `Napi::Number`. +- `const char*` (encoded using UTF-8, null-terminated) - returns a `Napi::String`. +- `const char16_t*` (encoded using UTF-16-LE, null-terminated) - returns a `Napi::String`. +- `std::string` (encoded using UTF-8) - returns a `Napi::String`. +- `std::u16string` - returns a `Napi::String`. +- `napi::Value` - returns a `Napi::Value`. +- `napi_value` - returns a `Napi::Value`. + +#### As +```cpp +template <typename T> T Napi::Value::As() const; +``` + +Returns the `Napi::Value` cast to a desired C++ type. + +Use this when the actual type is known or assumed. + +Note: +This conversion does NOT coerce the type. Calling any methods inappropriate for +the actual value type will throw `Napi::Error`. + +#### StrictEquals +```cpp +bool Napi::Value::StrictEquals(const Value& other) const; +``` + +- `[in] other` - The value to compare against. + +Returns true if the other `Napi::Value` is strictly equal to this one. + +#### Env +```cpp +Napi::Env Napi::Value::Env() const; +``` + +Returns the environment that the value is associated with. See +[`Napi::Env`](env.md) for more details about environments. + +#### IsEmpty +```cpp +bool Napi::Value::IsEmpty() const; +``` + +Returns `true` if the value is uninitialized. + +An empty value is invalid, and most attempts to perform an operation on an +empty value will result in an exception. An empty value is distinct from +JavaScript `null` or `undefined`, which are valid values. + +When C++ exceptions are disabled at compile time, a method with a `Napi::Value` +return type may return an empty value to indicate a pending exception. If C++ +exceptions are not being used, callers should check the result of +`Env::IsExceptionPending` before attempting to use the value. + +#### Type +```cpp +napi_valuetype Napi::Value::Type() const; +``` + +Returns the underlying N-API `napi_valuetype` of the value. + +#### IsUndefined +```cpp +bool Napi::Value::IsUndefined() const; +``` + +Returns `true` if the underlying value is a JavaScript `undefined` or `false` +otherwise. + +#### IsNull +```cpp +bool Napi::Value::IsNull() const; +``` + +Returns `true` if the underlying value is a JavaScript `null` or `false` +otherwise. + +#### IsBoolean +```cpp +bool Napi::Value::IsBoolean() const; +``` + +Returns `true` if the underlying value is a JavaScript `true` or JavaScript +`false`, or `false` if the value is not a `Napi::Boolean` value in JavaScript. + +#### IsNumber +```cpp +bool Napi::Value::IsNumber() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::Number` or `false` +otherwise. + +#### IsString +```cpp +bool Napi::Value::IsString() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::String` or `false` +otherwise. + +#### IsSymbol +```cpp +bool Napi::Value::IsSymbol() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::Symbol` or `false` +otherwise. + +#### IsArray +```cpp +bool Napi::Value::IsArray() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::Array` or `false` +otherwise. + +#### IsArrayBuffer +```cpp +bool Napi::Value::IsArrayBuffer() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::ArrayBuffer` or `false` +otherwise. + +#### IsTypedArray +```cpp +bool Napi::Value::IsTypedArray() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::TypedArray` or `false` +otherwise. + +#### IsObject +```cpp +bool Napi::Value::IsObject() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::Object` or `false` +otherwise. + +#### IsFunction +```cpp +bool Napi::Value::IsFunction() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::Function` or `false` +otherwise. + +#### IsPromise +```cpp +bool Napi::Value::IsPromise() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::Promise` or `false` +otherwise. + +#### IsDataView +```cpp +bool Napi::Value::IsDataView() const; +``` + +Returns `true` if the underlying value is a JavaScript `Napi::DataView` or `false` +otherwise. + +#### IsBuffer +```cpp +bool Napi::Value::IsBuffer() const; +``` + +Returns `true` if the underlying value is a Node.js `Napi::Buffer` or `false` +otherwise. + +#### IsExternal +```cpp +bool Napi::Value::IsExternal() const; +``` + +Returns `true` if the underlying value is a N-API external object or `false` +otherwise. + +#### IsDate +```cpp +bool Napi::Value::IsDate() const; +``` + +Returns `true` if the underlying value is a JavaScript `Date` or `false` +otherwise. + +#### ToBoolean +```cpp +Napi::Boolean Napi::Value::ToBoolean() const; +``` + +Returns a `Napi::Boolean` representing the `Napi::Value`. + +This is a wrapper around `napi_coerce_to_boolean`. This will throw a JavaScript +exception if the coercion fails. If C++ exceptions are not being used, callers +should check the result of `Env::IsExceptionPending` before attempting to use +the returned value. + +#### ToNumber +```cpp +Napi::Number Napi::Value::ToNumber() const; +``` + +Returns a `Napi::Number` representing the `Napi::Value`. + +Note: +This can cause script code to be executed according to JavaScript semantics. +This is a wrapper around `napi_coerce_to_number`. This will throw a JavaScript +exception if the coercion fails. If C++ exceptions are not being used, callers +should check the result of `Env::IsExceptionPending` before attempting to use +the returned value. + +#### ToString +```cpp +Napi::String Napi::Value::ToString() const; +``` + +Returns a `Napi::String` representing the `Napi::Value`. + +Note that this can cause script code to be executed according to JavaScript +semantics. This is a wrapper around `napi_coerce_to_string`. This will throw a +JavaScript exception if the coercion fails. If C++ exceptions are not being +used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +#### ToObject +```cpp +Napi::Object Napi::Value::ToObject() const; +``` + +Returns a `Napi::Object` representing the `Napi::Value`. + +This is a wrapper around `napi_coerce_to_object`. This will throw a JavaScript +exception if the coercion fails. If C++ exceptions are not being used, callers +should check the result of `Env::IsExceptionPending` before attempting to use +the returned value. + +## Name + +Names are JavaScript values that can be used as a property name. There are two +specialized types of names supported in Node.js Addon API [`Napi::String`](string.md) +and [`Napi::Symbol`](symbol.md). + +### Methods + +#### Constructor +```cpp +Napi::Name::Name(); +``` + +Returns an empty `Napi::Name`. + +```cpp +Napi::Name::Name(napi_env env, napi_value value); +``` +- `[in] env` - The environment in which to create the array. +- `[in] value` - The primitive to wrap. + +Returns a `Napi::Name` created from the JavaScript primitive. + +Note: +The value is not coerced to a string. + +## Array + +Arrays are native representations of JavaScript Arrays. `Napi::Array` is a wrapper +around `napi_value` representing a JavaScript Array. + +[`Napi::TypedArray`][] and [`Napi::ArrayBuffer`][] correspond to JavaScript data +types such as [`Int32Array`][] and [`ArrayBuffer`][], respectively, that can be +used for transferring large amounts of data from JavaScript to the native side. +An example illustrating the use of a JavaScript-provided `ArrayBuffer` in native +code is available [here](https://github.com/nodejs/node-addon-examples/tree/master/array_buffer_to_native/node-addon-api). + +### Constructor +```cpp +Napi::Array::Array(); +``` + +Returns an empty array. + +If an error occurs, a `Napi::Error` will be thrown. If C++ exceptions are not +being used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +```cpp +Napi::Array::Array(napi_env env, napi_value value); +``` +- `[in] env` - The environment in which to create the array. +- `[in] value` - The primitive to wrap. + +Returns a `Napi::Array` wrapping a `napi_value`. + +If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not +being used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +### Methods + +#### New +```cpp +static Napi::Array Napi::Array::New(napi_env env); +``` +- `[in] env` - The environment in which to create the array. + +Returns a new `Napi::Array`. + +If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not +being used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +#### New + +```cpp +static Napi::Array Napi::Array::New(napi_env env, size_t length); +``` +- `[in] env` - The environment in which to create the array. +- `[in] length` - The length of the array. + +Returns a new `Napi::Array` with the given length. + +If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not +being used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +#### Length +```cpp +uint32_t Napi::Array::Length() const; +``` + +Returns the length of the array. + +Note: +This can execute JavaScript code implicitly according to JavaScript semantics. +If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not +being used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +[`Napi::TypedArray`]: ./typed_array.md +[`Napi::ArrayBuffer`]: ./array_buffer.md +[`Int32Array`]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Int32Array +[`ArrayBuffer`]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer diff --git a/node_modules/node-addon-api/doc/bigint.md b/node_modules/node-addon-api/doc/bigint.md new file mode 100644 index 0000000..cc98104 --- /dev/null +++ b/node_modules/node-addon-api/doc/bigint.md @@ -0,0 +1,92 @@ +# BigInt + +A JavaScript BigInt value. + +## Methods + +### New + +```cpp +static Napi::BigInt Napi::BigInt::New(Napi::Env env, int64_t value); +``` + + - `[in] env`: The environment in which to construct the `Napi::BigInt` object. + - `[in] value`: The value the JavaScript `BigInt` will contain + +These APIs convert the C `int64_t` and `uint64_t` types to the JavaScript +`BigInt` type. + +```cpp +static Napi::BigInt Napi::BigInt::New(Napi::Env env, + int sign_bit, + size_t word_count, + const uint64_t* words); +``` + + - `[in] env`: The environment in which to construct the `Napi::BigInt` object. + - `[in] sign_bit`: Determines if the resulting `BigInt` will be positive or negative. + - `[in] word_count`: The length of the words array. + - `[in] words`: An array of `uint64_t` little-endian 64-bit words. + +This API converts an array of unsigned 64-bit words into a single `BigInt` +value. + +The resulting `BigInt` is calculated as: (–1)<sup>`sign_bit`</sup> (`words[0]` +× (2<sup>64</sup>)<sup>0</sup> + `words[1]` × (2<sup>64</sup>)<sup>1</sup> + …) + +Returns a new JavaScript `BigInt`. + +### Constructor + +```cpp +Napi::BigInt(); +``` + +Returns a new empty JavaScript `Napi::BigInt`. + +### Int64Value + +```cpp +int64_t Napi::BitInt::Int64Value(bool* lossless) const; +``` + + - `[out] lossless`: Indicates whether the `BigInt` value was converted losslessly. + +Returns the C `int64_t` primitive equivalent of the given JavaScript +`BigInt`. If needed it will truncate the value, setting lossless to false. + +### Uint64Value + +```cpp +uint64_t Napi::BigInt::Uint64Value(bool* lossless) const; +``` + + - `[out] lossless`: Indicates whether the `BigInt` value was converted + losslessly. + +Returns the C `uint64_t` primitive equivalent of the given JavaScript +`BigInt`. If needed it will truncate the value, setting lossless to false. + +### WordCount + +```cpp +size_t Napi::BigInt::WordCount() const; +``` + +Returns the number of words needed to store this `BigInt` value. + +### ToWords + +```cpp +void Napi::BigInt::ToWords(size_t* word_count, int* sign_bit, uint64_t* words); +``` + + - `[out] sign_bit`: Integer representing if the JavaScript `BigInt` is positive + or negative. + - `[in/out] word_count`: Must be initialized to the length of the words array. + Upon return, it will be set to the actual number of words that would be + needed to store this `BigInt`. + - `[out] words`: Pointer to a pre-allocated 64-bit word array. + +Returns a single `BigInt` value into a sign bit, 64-bit little-endian array, +and the number of elements in the array. diff --git a/node_modules/node-addon-api/doc/boolean.md b/node_modules/node-addon-api/doc/boolean.md new file mode 100644 index 0000000..01b6a4c --- /dev/null +++ b/node_modules/node-addon-api/doc/boolean.md @@ -0,0 +1,64 @@ +# Boolean + +`Napi::Boolean` class is a representation of the JavaScript `Boolean` object. The +`Napi::Boolean` class inherits its behavior from the `Napi::Value` class +(for more info see: [`Napi::Value`](value.md)). + +## Methods + +### Constructor + +Creates a new empty instance of an `Napi::Boolean` object. + +```cpp +Napi::Boolean::Boolean(); +``` + +Returns a new _empty_ `Napi::Boolean` object. + +### Contructor + +Creates a new instance of the `Napi::Boolean` object. + +```cpp +Napi::Boolean(napi_env env, napi_value value); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Boolean` object. +- `[in] value`: The `napi_value` which is a handle for a JavaScript `Boolean`. + +Returns a non-empty `Napi::Boolean` object. + +### New + +Initializes a new instance of the `Napi::Boolean` object. + +```cpp +Napi::Boolean Napi::Boolean::New(napi_env env, bool value); +``` +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Boolean` object. +- `[in] value`: The primitive boolean value (`true` or `false`). + +Returns a new instance of the `Napi::Boolean` object. + +### Value + +Converts a `Napi::Boolean` value to a boolean primitive. + +```cpp +bool Napi::Boolean::Value() const; +``` + +Returns the boolean primitive type of the corresponding `Napi::Boolean` object. + +## Operators + +### operator bool + +Converts a `Napi::Boolean` value to a boolean primitive. + +```cpp +Napi::Boolean::operator bool() const; +``` + +Returns the boolean primitive type of the corresponding `Napi::Boolean` object. diff --git a/node_modules/node-addon-api/doc/buffer.md b/node_modules/node-addon-api/doc/buffer.md new file mode 100644 index 0000000..8f76b20 --- /dev/null +++ b/node_modules/node-addon-api/doc/buffer.md @@ -0,0 +1,140 @@ +# Buffer + +The `Napi::Buffer` class creates a projection of raw data that can be consumed by +script. + +## Methods + +### New + +Allocates a new `Napi::Buffer` object with a given length. + +```cpp +static Napi::Buffer<T> Napi::Buffer::New(napi_env env, size_t length); +``` + +- `[in] env`: The environment in which to create the `Napi::Buffer` object. +- `[in] length`: The number of `T` elements to allocate. + +Returns a new `Napi::Buffer` object. + +### New + +Wraps the provided external data into a new `Napi::Buffer` object. + +The `Napi::Buffer` object does not assume ownership for the data and expects it to be +valid for the lifetime of the object. Since the `Napi::Buffer` is subject to garbage +collection this overload is only suitable for data which is static and never +needs to be freed. + +```cpp +static Napi::Buffer<T> Napi::Buffer::New(napi_env env, T* data, size_t length); +``` + +- `[in] env`: The environment in which to create the `Napi::Buffer` object. +- `[in] data`: The pointer to the external data to expose. +- `[in] length`: The number of `T` elements in the external data. + +Returns a new `Napi::Buffer` object. + +### New + +Wraps the provided external data into a new `Napi::Buffer` object. + +The `Napi::Buffer` object does not assume ownership for the data and expects it +to be valid for the lifetime of the object. The data can only be freed once the +`finalizeCallback` is invoked to indicate that the `Napi::Buffer` has been released. + +```cpp +template <typename Finalizer> +static Napi::Buffer<T> Napi::Buffer::New(napi_env env, + T* data, + size_t length, + Finalizer finalizeCallback); +``` + +- `[in] env`: The environment in which to create the `Napi::Buffer` object. +- `[in] data`: The pointer to the external data to expose. +- `[in] length`: The number of `T` elements in the external data. +- `[in] finalizeCallback`: The function to be called when the `Napi::Buffer` is + destroyed. It must implement `operator()`, accept a `T*` (which is the + external data pointer), and return `void`. + +Returns a new `Napi::Buffer` object. + +### New + +Wraps the provided external data into a new `Napi::Buffer` object. + +The `Napi::Buffer` object does not assume ownership for the data and expects it to be +valid for the lifetime of the object. The data can only be freed once the +`finalizeCallback` is invoked to indicate that the `Napi::Buffer` has been released. + +```cpp +template <typename Finalizer, typename Hint> +static Napi::Buffer<T> Napi::Buffer::New(napi_env env, + T* data, + size_t length, + Finalizer finalizeCallback, + Hint* finalizeHint); +``` + +- `[in] env`: The environment in which to create the `Napi::Buffer` object. +- `[in] data`: The pointer to the external data to expose. +- `[in] length`: The number of `T` elements in the external data. +- `[in] finalizeCallback`: The function to be called when the `Napi::Buffer` is + destroyed. It must implement `operator()`, accept a `T*` (which is the + external data pointer) and `Hint*`, and return `void`. +- `[in] finalizeHint`: The hint to be passed as the second parameter of the + finalize callback. + +Returns a new `Napi::Buffer` object. + +### Copy + +Allocates a new `Napi::Buffer` object and copies the provided external data into it. + +```cpp +static Napi::Buffer<T> Napi::Buffer::Copy(napi_env env, const T* data, size_t length); +``` + +- `[in] env`: The environment in which to create the `Napi::Buffer` object. +- `[in] data`: The pointer to the external data to copy. +- `[in] length`: The number of `T` elements in the external data. + +Returns a new `Napi::Buffer` object containing a copy of the data. + +### Constructor + +Initializes an empty instance of the `Napi::Buffer` class. + +```cpp +Napi::Buffer::Buffer(); +``` + +### Constructor + +Initializes the `Napi::Buffer` object using an existing Uint8Array. + +```cpp +Napi::Buffer::Buffer(napi_env env, napi_value value); +``` + +- `[in] env`: The environment in which to create the `Napi::Buffer` object. +- `[in] value`: The Uint8Array reference to wrap. + +### Data + +```cpp +T* Napi::Buffer::Data() const; +``` + +Returns a pointer the external data. + +### Length + +```cpp +size_t Napi::Buffer::Length() const; +``` + +Returns the number of `T` elements in the external data. diff --git a/node_modules/node-addon-api/doc/callback_scope.md b/node_modules/node-addon-api/doc/callback_scope.md new file mode 100644 index 0000000..35f0f8d --- /dev/null +++ b/node_modules/node-addon-api/doc/callback_scope.md @@ -0,0 +1,54 @@ +# CallbackScope + +There are cases (for example, resolving promises) where it is necessary to have +the equivalent of the scope associated with a callback in place when making +certain N-API calls. + +## Methods + +### Constructor + +Creates a new callback scope on the stack. + +```cpp +Napi::CallbackScope::CallbackScope(napi_env env, napi_callback_scope scope); +``` + +- `[in] env`: The environment in which to create the `Napi::CallbackScope`. +- `[in] scope`: The pre-existing `napi_callback_scope` or `Napi::CallbackScope`. + +### Constructor + +Creates a new callback scope on the stack. + +```cpp +Napi::CallbackScope::CallbackScope(napi_env env, napi_async_context context); +``` + +- `[in] env`: The environment in which to create the `Napi::CallbackScope`. +- `[in] async_context`: The pre-existing `napi_async_context` or `Napi::AsyncContext`. + +### Destructor + +Deletes the instance of `Napi::CallbackScope` object. + +```cpp +virtual Napi::CallbackScope::~CallbackScope(); +``` + +### Env + +```cpp +Napi::Env Napi::CallbackScope::Env() const; +``` + +Returns the `Napi::Env` associated with the `Napi::CallbackScope`. + +## Operator + +```cpp +Napi::CallbackScope::operator napi_callback_scope() const; +``` + +Returns the N-API `napi_callback_scope` wrapped by the `Napi::CallbackScope` +object. This can be used to mix usage of the C N-API and node-addon-api. diff --git a/node_modules/node-addon-api/doc/callbackinfo.md b/node_modules/node-addon-api/doc/callbackinfo.md new file mode 100644 index 0000000..0bf4e1a --- /dev/null +++ b/node_modules/node-addon-api/doc/callbackinfo.md @@ -0,0 +1,97 @@ +# CallbackInfo + +The object representing the components of the JavaScript request being made. + +The `Napi::CallbackInfo` object is usually created and passed by the Node.js runtime or node-addon-api infrastructure. + +The `Napi::CallbackInfo` object contains the arguments passed by the caller. The number of arguments is returned by the `Length` method. Each individual argument can be accessed using the `operator[]` method. + +The `SetData` and `Data` methods are used to set and retrieve the data pointer contained in the `Napi::CallbackInfo` object. + +## Methods + +### Constructor + +```cpp +Napi::CallbackInfo::CallbackInfo(napi_env env, napi_callback_info info); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::CallbackInfo` object. +- `[in] info`: The `napi_callback_info` data structure from which to construct the `Napi::CallbackInfo` object. + +### Env + +```cpp +Napi::Env Napi::CallbackInfo::Env() const; +``` + +Returns the `Env` object in which the request is being made. + +### NewTarget + +```cpp +Napi::Value Napi::CallbackInfo::NewTarget() const; +``` + +Returns the `new.target` value of the constructor call. If the function that was invoked (and for which the `Napi::NCallbackInfo` was passed) is not a constructor call, a call to `IsEmpty()` on the returned value returns true. + +### IsConstructCall + +```cpp +bool Napi::CallbackInfo::IsConstructCall() const; +``` + +Returns a `bool` indicating if the function that was invoked (and for which the `Napi::CallbackInfo` was passed) is a constructor call. + +### Length + +```cpp +size_t Napi::CallbackInfo::Length() const; +``` + +Returns the number of arguments passed in the `Napi::CallbackInfo` object. + +### operator [] + +```cpp +const Napi::Value operator [](size_t index) const; +``` + +- `[in] index`: The zero-based index of the requested argument. + +Returns a `Napi::Value` object containing the requested argument. + +### This + +```cpp +Napi::Value Napi::CallbackInfo::This() const; +``` + +Returns the JavaScript `this` value for the call + +### Data + +```cpp +void* Napi::CallbackInfo::Data() const; +``` + +Returns the data pointer for the callback. + +### SetData + +```cpp +void Napi::CallbackInfo::SetData(void* data); +``` + +- `[in] data`: The new data pointer to associate with this `Napi::CallbackInfo` object. + +Returns `void`. + +### Not documented here + +```cpp +Napi::CallbackInfo::~CallbackInfo(); +// Disallow copying to prevent multiple free of _dynamicArgs +Napi::CallbackInfo::CallbackInfo(CallbackInfo const &) = delete; +void Napi::CallbackInfo::operator=(CallbackInfo const &) = delete; +``` diff --git a/node_modules/node-addon-api/doc/checker-tool.md b/node_modules/node-addon-api/doc/checker-tool.md new file mode 100644 index 0000000..499d3ab --- /dev/null +++ b/node_modules/node-addon-api/doc/checker-tool.md @@ -0,0 +1,32 @@ +# Checker Tool + +**node-addon-api** provides a [checker tool][] that will inspect a given +directory tree, identifying all Node.js native addons therein, and further +indicating for each addon whether it is an N-API addon. + +## To use the checker tool: + + 1. Install the application with `npm install`. + + 2. If the application does not depend on **node-addon-api**, copy the + checker tool into the application's directory. + + 3. If the application does not depend on **node-addon-api**, run the checker + tool from the application's directory: + + ```sh + node ./check-napi.js + ``` + + Otherwise, the checker tool can be run from the application's + `node_modules/` subdirectory: + + ```sh + node ./node_modules/node-addon-api/tools/check-napi.js + ``` + +The tool accepts the root directory from which to start checking for Node.js +native addons as a single optional command line parameter. If ommitted it will +start checking from the current directory (`.`). + +[checker tool]: ../tools/check-napi.js diff --git a/node_modules/node-addon-api/doc/class_property_descriptor.md b/node_modules/node-addon-api/doc/class_property_descriptor.md new file mode 100644 index 0000000..bb492de --- /dev/null +++ b/node_modules/node-addon-api/doc/class_property_descriptor.md @@ -0,0 +1,117 @@ +# Class property and descriptor + +Property descriptor for use with `Napi::ObjectWrap::DefineClass()`. +This is different from the standalone `Napi::PropertyDescriptor` because it is +specific to each `Napi::ObjectWrap<T>` subclass. +This prevents using descriptors from a different class when defining a new class +(preventing the callbacks from having incorrect `this` pointers). + +## Example + +```cpp +#include <napi.h> + +class Example : public Napi::ObjectWrap<Example> { + public: + static Napi::Object Init(Napi::Env env, Napi::Object exports); + Example(const Napi::CallbackInfo &info); + + private: + static Napi::FunctionReference constructor; + double _value; + Napi::Value GetValue(const Napi::CallbackInfo &info); + void SetValue(const Napi::CallbackInfo &info, const Napi::Value &value); +}; + +Napi::Object Example::Init(Napi::Env env, Napi::Object exports) { + Napi::Function func = DefineClass(env, "Example", { + // Register a class instance accessor with getter and setter functions. + InstanceAccessor("value", &Example::GetValue, &Example::SetValue), + // We can also register a readonly accessor by passing nullptr as the setter. + InstanceAccessor("readOnlyProp", &Example::GetValue, nullptr) + }); + + constructor = Napi::Persistent(func); + constructor.SuppressDestruct(); + exports.Set("Example", func); + + return exports; +} + +Example::Example(const Napi::CallbackInfo &info) : Napi::ObjectWrap<Example>(info) { + Napi::Env env = info.Env(); + // ... + Napi::Number value = info[0].As<Napi::Number>(); + this->_value = value.DoubleValue(); +} + +Napi::FunctionReference Example::constructor; + +Napi::Value Example::GetValue(const Napi::CallbackInfo &info) { + Napi::Env env = info.Env(); + return Napi::Number::New(env, this->_value); +} + +void Example::SetValue(const Napi::CallbackInfo &info, const Napi::Value &value) { + Napi::Env env = info.Env(); + // ... + Napi::Number arg = value.As<Napi::Number>(); + this->_value = arg.DoubleValue(); +} + +// Initialize native add-on +Napi::Object Init (Napi::Env env, Napi::Object exports) { + Example::Init(env, exports); + return exports; +} + +// Register and initialize native add-on +NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init) +``` + +The above code can be used from JavaScript as follows: + +```js +'use strict'; + +const { Example } = require('bindings')('addon'); + +const example = new Example(11); +console.log(example.value); +// It prints 11 +example.value = 19; +console.log(example.value); +// It prints 19 +example.readOnlyProp = 500; +console.log(example.readOnlyProp); +// Unchanged. It prints 19 +``` + +## Methods + +### Constructor + +Creates new instance of `Napi::ClassPropertyDescriptor` descriptor object. + +```cpp +Napi::ClassPropertyDescriptor(napi_property_descriptor desc) : _desc(desc) {} +``` + +- `[in] desc`: The `napi_property_descriptor` + +Returns new instance of `Napi::ClassPropertyDescriptor` that is used as property descriptor +inside the `Napi::ObjectWrap<T>` class. + +### Operator + +```cpp +operator napi_property_descriptor&() { return _desc; } +``` + +Returns the original N-API `napi_property_descriptor` wrapped inside the `Napi::ClassPropertyDescriptor` + +```cpp +operator const napi_property_descriptor&() const { return _desc; } +``` + +Returns the original N-API `napi_property_descriptor` wrapped inside the `Napi::ClassPropertyDescriptor` diff --git a/node_modules/node-addon-api/doc/cmake-js.md b/node_modules/node-addon-api/doc/cmake-js.md new file mode 100644 index 0000000..08cd3ea --- /dev/null +++ b/node_modules/node-addon-api/doc/cmake-js.md @@ -0,0 +1,68 @@ +# CMake.js + +[**CMake.js**](https://github.com/cmake-js/cmake-js) is a build tool that allow native addon developers to compile their +C or C++ code into executable form. It works like **[node-gyp](node-gyp.md)** but +instead of Google's [**gyp**](https://gyp.gsrc.io) tool it is based on the [**CMake**](https://cmake.org) build system. + +## Quick Start + +### Install CMake + +CMake.js requires that CMake be installed. Installers for a variety of platforms can be found on the [CMake website](https://cmake.org). + +### Install CMake.js + +For developers, CMake.js is typically installed as a global package: + +```bash +npm install -g cmake-js +cmake-js --help +``` + +> For *users* of your native addon, CMake.js should be configured as a dependency in your `package.json` as described in the [CMake.js documentation](https://github.com/cmake-js/cmake-js). + +### CMakeLists.txt + +Your project will require a `CMakeLists.txt` file. The [CMake.js README file](https://github.com/cmake-js/cmake-js#usage) shows what's necessary. + +### NAPI_VERSION + +When building N-API addons, it's crucial to specify the N-API version your code is designed to work with. With CMake.js, this information is specified in the `CMakeLists.txt` file: + +``` +add_definitions(-DNAPI_VERSION=3) +``` + +Since N-API is ABI-stable, your N-API addon will work, without recompilation, with the N-API version you specify in `NAPI_VERSION` and all subsequent N-API versions. + +In the absence of a need for features available only in a specific N-API version, version 3 is a good choice as it is the version of N-API that was active when N-API left experimental status. + +### NAPI_EXPERIMENTAL + +The following line in the `CMakeLists.txt` file will enable N-API experimental features if your code requires them: + +``` +add_definitions(-DNAPI_EXPERIMENTAL) +``` + +### node-addon-api + +If your N-API native add-on uses the optional [**node-addon-api**](https://github.com/nodejs/node-addon-api#node-addon-api-module) C++ wrapper, the `CMakeLists.txt` file requires additional configuration information as described on the [CMake.js README file](https://github.com/cmake-js/cmake-js#n-api-and-node-addon-api). + +## Example + +A working example of an N-API native addon built using CMake.js can be found on the [node-addon-examples repository](https://github.com/nodejs/node-addon-examples/tree/master/build_with_cmake#building-n-api-addons-using-cmakejs). + +## **CMake** Reference + + - [Installation](https://github.com/cmake-js/cmake-js#installation) + - [How to use](https://github.com/cmake-js/cmake-js#usage) + - [Using N-API and node-addon-api](https://github.com/cmake-js/cmake-js#n-api-and-node-addon-api) + - [Tutorials](https://github.com/cmake-js/cmake-js#tutorials) + - [Use case in the works - ArrayFire.js](https://github.com/cmake-js/cmake-js#use-case-in-the-works---arrayfirejs) + +Sometimes finding the right settings is not easy so to accomplish at most +complicated task please refer to: + +- [CMake documentation](https://cmake.org/) +- [CMake.js wiki](https://github.com/cmake-js/cmake-js/wiki) diff --git a/node_modules/node-addon-api/doc/conversion-tool.md b/node_modules/node-addon-api/doc/conversion-tool.md new file mode 100644 index 0000000..3b50b9c --- /dev/null +++ b/node_modules/node-addon-api/doc/conversion-tool.md @@ -0,0 +1,28 @@ +# Conversion Tool + +To make the migration to **node-addon-api** easier, we have provided a script to +help complete some tasks. + +## To use the conversion script: + + 1. Go to your module directory + +``` +cd [module_path] +``` + + 2. Install node-addon-api module + +``` +npm install node-addon-api +``` + 3. Run node-addon-api conversion script + +``` +node ./node_modules/node-addon-api/tools/conversion.js ./ +``` + + 4. While this script makes conversion easier, it still cannot fully convert +the module. The next step is to try to build the module and complete the +remaining conversions necessary to allow it to compile and pass all of the +module's tests.
\ No newline at end of file diff --git a/node_modules/node-addon-api/doc/creating_a_release.md b/node_modules/node-addon-api/doc/creating_a_release.md new file mode 100644 index 0000000..bc9a859 --- /dev/null +++ b/node_modules/node-addon-api/doc/creating_a_release.md @@ -0,0 +1,62 @@ +# Creating a release + +Only collaborators in npm for **node-addon-api** can create releases. +If you want to be able to do releases ask one of the existing +collaborators to add you. If necessary you can ask the build +Working Group who manages the Node.js npm user to add you if +there are no other active collaborators. + +## Prerequisites + +Before to start creating a new release check if you have installed the following +tools: + +* [Changelog maker](https://www.npmjs.com/package/changelog-maker) + +If not please follow the instruction reported in the tool's documentation to +install it. + +## Publish new release + +These are the steps to follow to create a new release: + +* Open an issue in the **node-addon-api** repo documenting the intent to create a +new release. Give people some time to comment or suggest PRs that should land first. + +* Validate all tests pass by running npm test on master. + +* Update the version in **package.json** appropriately. + +* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md) +to show the new version as the latest. + +* Generate the changelog for the new version using **changelog maker** tool. From +the route folder of the repo launch the following command: + + ```bash + > changelog-maker + ``` +* Use the output generated by **changelog maker** to pdate the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md) +following the style used in publishing the previous release. + +* Add any new contributors to the "contributors" section in the package.json + +* Validate all tests pass by running npm test on master. + +* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/)** +to validate tests pass for latest 11, 10, 8, 6 releases (note there are still some issues on SmartOS and +Windows in the testing). + +* Do a clean checkout of node-addon-api. + +* Login and then run `npm publish`. + +* Create a release in Github (look at existing releases for an example). + +* Validate that you can run `npm install node-addon-api` successfully +and that the correct version is installed. + +* Comment on the issue opened in the first step that the release has been created +and close the issue. + +* Tweet that the release has been created. diff --git a/node_modules/node-addon-api/doc/dataview.md b/node_modules/node-addon-api/doc/dataview.md new file mode 100644 index 0000000..64b865b --- /dev/null +++ b/node_modules/node-addon-api/doc/dataview.md @@ -0,0 +1,244 @@ +# DataView + +The `Napi::DataView` class corresponds to the +[JavaScript `DataView`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) +class. + +## Methods + +### New + +Allocates a new `Napi::DataView` instance with a given `Napi::ArrayBuffer`. + +```cpp +static Napi::DataView Napi::DataView::New(napi_env env, Napi::ArrayBuffer arrayBuffer); +``` + +- `[in] env`: The environment in which to create the `Napi::DataView` instance. +- `[in] arrayBuffer` : `Napi::ArrayBuffer` underlying the `Napi::DataView`. + +Returns a new `Napi::DataView` instance. + +### New + +Allocates a new `Napi::DataView` instance with a given `Napi::ArrayBuffer`. + +```cpp +static Napi::DataView Napi::DataView::New(napi_env env, Napi::ArrayBuffer arrayBuffer, size_t byteOffset); +``` + +- `[in] env`: The environment in which to create the `Napi::DataView` instance. +- `[in] arrayBuffer` : `Napi::ArrayBuffer` underlying the `Napi::DataView`. +- `[in] byteOffset` : The byte offset within the `Napi::ArrayBuffer` from which to start projecting the `Napi::DataView`. + +Returns a new `Napi::DataView` instance. + +### New + +Allocates a new `Napi::DataView` instance with a given `Napi::ArrayBuffer`. + +```cpp +static Napi::DataView Napi::DataView::New(napi_env env, Napi::ArrayBuffer arrayBuffer, size_t byteOffset, size_t byteLength); +``` + +- `[in] env`: The environment in which to create the `Napi::DataView` instance. +- `[in] arrayBuffer` : `Napi::ArrayBuffer` underlying the `Napi::DataView`. +- `[in] byteOffset` : The byte offset within the `Napi::ArrayBuffer` from which to start projecting the `Napi::DataView`. +- `[in] byteLength` : Number of elements in the `Napi::DataView`. + +Returns a new `Napi::DataView` instance. + +### Constructor + +Initializes an empty instance of the `Napi::DataView` class. + +```cpp +Napi::DataView(); +``` + +### Constructor + +Initializes a wrapper instance of an existing `Napi::DataView` instance. + +```cpp +Napi::DataView(napi_env env, napi_value value); +``` + +- `[in] env`: The environment in which to create the `Napi::DataView` instance. +- `[in] value`: The `Napi::DataView` reference to wrap. + +### ArrayBuffer + +```cpp +Napi::ArrayBuffer Napi::DataView::ArrayBuffer() const; +``` + +Returns the backing array buffer. + +### ByteOffset + +```cpp +size_t Napi::DataView::ByteOffset() const; +``` + +Returns the offset into the `Napi::DataView` where the array starts, in bytes. + +### ByteLength + +```cpp +size_t Napi::DataView::ByteLength() const; +``` + +Returns the length of the array, in bytes. + +### GetFloat32 + +```cpp +float Napi::DataView::GetFloat32(size_t byteOffset) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. + +Returns a signed 32-bit float (float) at the specified byte offset from the start of the `Napi::DataView`. + +### GetFloat64 + +```cpp +double Napi::DataView::GetFloat64(size_t byteOffset) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. + +Returns a signed 64-bit float (double) at the specified byte offset from the start of the `Napi::DataView`. + +### GetInt8 + +```cpp +int8_t Napi::DataView::GetInt8(size_t byteOffset) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. + +Returns a signed 8-bit integer (byte) at the specified byte offset from the start of the `Napi::DataView`. + +### GetInt16 + +```cpp +int16_t Napi::DataView::GetInt16(size_t byteOffset) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. + +Returns a signed 16-bit integer (short) at the specified byte offset from the start of the `Napi::DataView`. + +### GetInt32 + +```cpp +int32_t Napi::DataView::GetInt32(size_t byteOffset) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. + +Returns a signed 32-bit integer (long) at the specified byte offset from the start of the `Napi::DataView`. + +### GetUint8 + +```cpp +uint8_t Napi::DataView::GetUint8(size_t byteOffset) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. + +Returns a unsigned 8-bit integer (unsigned byte) at the specified byte offset from the start of the `Napi::DataView`. + +### GetUint16 + +```cpp +uint16_t Napi::DataView::GetUint16(size_t byteOffset) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. + +Returns a unsigned 16-bit integer (unsigned short) at the specified byte offset from the start of the `Napi::DataView`. + +### GetUint32 + +```cpp +uint32_t Napi::DataView::GetUint32(size_t byteOffset) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. + +Returns a unsigned 32-bit integer (unsigned long) at the specified byte offset from the start of the `Napi::DataView`. + +### SetFloat32 + +```cpp +void Napi::DataView::SetFloat32(size_t byteOffset, float value) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. +- `[in] value`: The value to set. + +### SetFloat64 + +```cpp +void Napi::DataView::SetFloat64(size_t byteOffset, double value) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. +- `[in] value`: The value to set. + +### SetInt8 + +```cpp +void Napi::DataView::SetInt8(size_t byteOffset, int8_t value) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. +- `[in] value`: The value to set. + +### SetInt16 + +```cpp +void Napi::DataView::SetInt16(size_t byteOffset, int16_t value) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. +- `[in] value`: The value to set. + +### SetInt32 + +```cpp +void Napi::DataView::SetInt32(size_t byteOffset, int32_t value) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. +- `[in] value`: The value to set. + +### SetUint8 + +```cpp +void Napi::DataView::SetUint8(size_t byteOffset, uint8_t value) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. +- `[in] value`: The value to set. + +### SetUint16 + +```cpp +void Napi::DataView::SetUint16(size_t byteOffset, uint16_t value) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. +- `[in] value`: The value to set. + +### SetUint32 + +```cpp +void Napi::DataView::SetUint32(size_t byteOffset, uint32_t value) const; +``` + +- `[in] byteOffset`: The offset, in byte, from the start of the view where to read the data. +- `[in] value`: The value to set. diff --git a/node_modules/node-addon-api/doc/date.md b/node_modules/node-addon-api/doc/date.md new file mode 100644 index 0000000..959b4b9 --- /dev/null +++ b/node_modules/node-addon-api/doc/date.md @@ -0,0 +1,68 @@ +# Date + +`Napi::Date` class is a representation of the JavaScript `Date` object. The +`Napi::Date` class inherits its behavior from `Napi::Value` class +(for more info see [`Napi::Value`](value.md)) + +## Methods + +### Constructor + +Creates a new _empty_ instance of a `Napi::Date` object. + +```cpp +Napi::Date::Date(); +``` + +Creates a new _non-empty_ instance of a `Napi::Date` object. + +```cpp +Napi::Date::Date(napi_env env, napi_value value); +``` + + - `[in] env`: The environment in which to construct the `Napi::Date` object. + - `[in] value`: The `napi_value` which is a handle for a JavaScript `Date`. + +### New + +Creates a new instance of a `Napi::Date` object. + +```cpp +static Napi::Date Napi::Date::New(Napi::Env env, double value); +``` + + - `[in] env`: The environment in which to construct the `Napi::Date` object. + - `[in] value`: The time value the JavaScript `Date` will contain represented + as the number of milliseconds since 1 January 1970 00:00:00 UTC. + +Returns a new instance of `Napi::Date` object. + +### ValueOf + +```cpp +double Napi::Date::ValueOf() const; +``` + +Returns the time value as `double` primitive represented as the number of + milliseconds since 1 January 1970 00:00:00 UTC. + +## Operators + +### operator double + +Converts a `Napi::Date` value to a `double` primitive. + +```cpp +Napi::Date::operator double() const; +``` + +### Example + +The following shows an example of casting a `Napi::Date` value to a `double` + primitive. + +```cpp +double operatorVal = Napi::Date::New(Env(), 0); // Napi::Date to double +// or +auto instanceVal = info[0].As<Napi::Date>().ValueOf(); +``` diff --git a/node_modules/node-addon-api/doc/env.md b/node_modules/node-addon-api/doc/env.md new file mode 100644 index 0000000..9bde741 --- /dev/null +++ b/node_modules/node-addon-api/doc/env.md @@ -0,0 +1,63 @@ +# Env + +The opaque data structure containing the environment in which the request is being run. + +The Env object is usually created and passed by the Node.js runtime or node-addon-api infrastructure. + +## Methods + +### Constructor + +```cpp +Napi::Env::Env(napi_env env); +``` + +- `[in] env`: The `napi_env` environment from which to construct the `Napi::Env` object. + +### napi_env + +```cpp +operator napi_env() const; +``` + +Returns the `napi_env` opaque data structure representing the environment. + +### Global + +```cpp +Napi::Object Napi::Env::Global() const; +``` + +Returns the `Napi::Object` representing the environment's JavaScript Global Object. + +### Undefined + +```cpp +Napi::Value Napi::Env::Undefined() const; +``` + +Returns the `Napi::Value` representing the environment's JavaScript Undefined Object. + +### Null + +```cpp +Napi::Value Napi::Env::Null() const; +``` + +Returns the `Napi::Value` representing the environment's JavaScript Null Object. + +### IsExceptionPending + +```cpp +bool Napi::Env::IsExceptionPending() const; +``` + +Returns a `bool` indicating if an exception is pending in the environment. + +### GetAndClearPendingException + +```cpp +Napi::Error Napi::Env::GetAndClearPendingException(); +``` + +Returns an `Napi::Error` object representing the environment's pending exception, if any. diff --git a/node_modules/node-addon-api/doc/error.md b/node_modules/node-addon-api/doc/error.md new file mode 100644 index 0000000..1526bdd --- /dev/null +++ b/node_modules/node-addon-api/doc/error.md @@ -0,0 +1,115 @@ +# Error + +The `Napi::Error` class is a representation of the JavaScript `Error` object that is thrown +when runtime errors occur. The Error object can also be used as a base object for +user-defined exceptions. + +The `Napi::Error` class is a persistent reference to a JavaScript error object thus +inherits its behavior from the `Napi::ObjectReference` class (for more info see: [`Napi::ObjectReference`](object_reference.md)). + +If C++ exceptions are enabled (for more info see: [Setup](setup.md)), then the +`Napi::Error` class extends `std::exception` and enables integrated +error-handling for C++ exceptions and JavaScript exceptions. + +For more details about error handling refer to the section titled [Error handling](error_handling.md). + +## Methods + +### New + +Creates empty instance of an `Napi::Error` object for the specified environment. + +```cpp +Napi::Error::New(Napi::Env env); +``` + +- `[in] env`: The environment in which to construct the `Napi::Error` object. + +Returns an instance of `Napi::Error` object. + +### New + +Creates instance of an `Napi::Error` object. + +```cpp +Napi::Error::New(Napi::Env env, const char* message); +``` + +- `[in] env`: The environment in which to construct the `Napi::Error` object. +- `[in] message`: Null-terminated string to be used as the message for the `Napi::Error`. + +Returns instance of an `Napi::Error` object. + +### New + +Creates instance of an `Napi::Error` object + +```cpp +Napi::Error::New(Napi::Env env, const std::string& message); +``` + +- `[in] env`: The environment in which to construct the `Napi::Error` object. +- `[in] message`: Reference string to be used as the message for the `Napi::Error`. + +Returns instance of an `Napi::Error` object. + +### Fatal + +In case of an unrecoverable error in a native module, a fatal error can be thrown +to immediately terminate the process. + +```cpp +static NAPI_NO_RETURN void Napi::Error::Fatal(const char* location, const char* message); +``` + +The function call does not return, the process will be terminated. + +### Constructor + +Creates empty instance of an `Napi::Error`. + +```cpp +Napi::Error::Error(); +``` + +Returns an instance of `Napi::Error` object. + +### Constructor + +Initializes an `Napi::Error` instance from an existing JavaScript error object. + +```cpp +Napi::Error::Error(napi_env env, napi_value value); +``` + +- `[in] env`: The environment in which to construct the error object. +- `[in] value`: The `Napi::Error` reference to wrap. + +Returns instance of an `Napi::Error` object. + +### Message + +```cpp +std::string& Napi::Error::Message() const NAPI_NOEXCEPT; +``` + +Returns the reference to the string that represent the message of the error. + +### ThrowAsJavaScriptException + +Throw the error as JavaScript exception. + +```cpp +void Napi::Error::ThrowAsJavaScriptException() const; +``` + +Throws the error as a JavaScript exception. + +### what + +```cpp +const char* Napi::Error::what() const NAPI_NOEXCEPT override; +``` + +Returns a pointer to a null-terminated string that is used to identify the +exception. This method can be used only if the exception mechanism is enabled. diff --git a/node_modules/node-addon-api/doc/error_handling.md b/node_modules/node-addon-api/doc/error_handling.md new file mode 100644 index 0000000..9a0ef34 --- /dev/null +++ b/node_modules/node-addon-api/doc/error_handling.md @@ -0,0 +1,186 @@ +# Error handling + +Error handling represents one of the most important considerations when +implementing a Node.js native add-on. When an error occurs in your C++ code you +have to handle and dispatch it correctly. **node-addon-api** uses return values and +JavaScript exceptions for error handling. You can choose return values or +exception handling based on the mechanism that works best for your add-on. + +The `Napi::Error` is a persistent reference (for more info see: [`Napi::ObjectReference`](object_reference.md)) +to a JavaScript error object. Use of this class depends on whether C++ +exceptions are enabled at compile time. + +If C++ exceptions are enabled (for more info see: [Setup](setup.md)), then the +`Napi::Error` class extends `std::exception` and enables integrated +error-handling for C++ exceptions and JavaScript exceptions. + +The following sections explain the approach for each case: + +- [Handling Errors With C++ Exceptions](#exceptions) +- [Handling Errors Without C++ Exceptions](#noexceptions) + +<a name="exceptions"></a> + +In most cases when an error occurs, the addon should do whatever clean is possible +and then return to JavaScript so that they error can be propagated. In less frequent +cases the addon may be able to recover from the error, clear the error and then +continue. + +## Handling Errors With C++ Exceptions + +When C++ exceptions are enabled try/catch can be used to catch exceptions thrown +from calls to JavaScript and then they can either be handled or rethrown before +returning from a native method. + +If a node-addon-api call fails without executing any JavaScript code (for example due to +an invalid argument), then node-addon-api automatically converts and throws +the error as a C++ exception of type `Napi::Error`. + +If a JavaScript function called by C++ code via node-addon-api throws a JavaScript +exception, then node-addon-api automatically converts and throws it as a C++ +exception of type `Napi:Error` on return from the JavaScript code to the native +method. + +If a C++ exception of type `Napi::Error` escapes from a N-API C++ callback, then +the N-API wrapper automatically converts and throws it as a JavaScript exception. + +On return from a native method, node-addon-api will automatically convert a pending C++ +exception to a JavaScript exception. + +When C++ exceptions are enabled try/catch can be used to catch exceptions thrown +from calls to JavaScript and then they can either be handled or rethrown before +returning from a native method. + +## Examples with C++ exceptions enabled + +### Throwing a C++ exception + +```cpp +Env env = ... +throw Napi::Error::New(env, "Example exception"); +// other C++ statements +// ... +``` + +The statements following the throw statement will not be executed. The exception +will bubble up as a C++ exception of type `Napi::Error`, until it is either caught +while still in C++, or else automatically propagated as a JavaScript exception +when returning to JavaScript. + +### Propagating a N-API C++ exception + +```cpp +Napi::Function jsFunctionThatThrows = someObj.As<Napi::Function>(); +Napi::Value result = jsFunctionThatThrows({ arg1, arg2 }); +// other C++ statements +// ... +``` + +The C++ statements following the call to the JavaScript function will not be +executed. The exception will bubble up as a C++ exception of type `Napi::Error`, +until it is either caught while still in C++, or else automatically propagated as +a JavaScript exception when returning to JavaScript. + +### Handling a N-API C++ exception + +```cpp +Napi::Function jsFunctionThatThrows = someObj.As<Napi::Function>(); +Napi::Value result; +try { + result = jsFunctionThatThrows({ arg1, arg2 }); +} catch (const Error& e) { + cerr << "Caught JavaScript exception: " + e.what(); +} +``` + +Since the exception was caught here, it will not be propagated as a JavaScript +exception. + +<a name="noexceptions"></a> + +## Handling Errors Without C++ Exceptions + +If C++ exceptions are disabled (for more info see: [Setup](setup.md)), then the +`Napi::Error` class does not extend `std::exception`. This means that any calls to +node-addon-api function do not throw a C++ exceptions. Instead, it raises +_pending_ JavaScript exceptions and returns an _empty_ `Napi::Value`. +The calling code should check `env.IsExceptionPending()` before attempting to use a +returned value, and may use methods on the `Napi::Env` class +to check for, get, and clear a pending JavaScript exception (for more info see: [Env](env.md)). +If the pending exception is not cleared, it will be thrown when the native code +returns to JavaScript. + +## Examples with C++ exceptions disabled + +### Throwing a JS exception + +```cpp +Napi::Env env = ... +Napi::Error::New(env, "Example exception").ThrowAsJavaScriptException(); +return; +``` + +After throwing a JavaScript exception, the code should generally return +immediately from the native callback, after performing any necessary cleanup. + +### Propagating a N-API JS exception + +```cpp +Napi::Env env = ... +Napi::Function jsFunctionThatThrows = someObj.As<Napi::Function>(); +Napi::Value result = jsFunctionThatThrows({ arg1, arg2 }); +if (env.IsExceptionPending()) { + Error e = env.GetAndClearPendingException(); + return e.Value(); +} +``` + +If env.IsExceptionPending() returns true a JavaScript exception is pending. To +let the exception propagate, the code should generally return immediately from +the native callback, after performing any necessary cleanup. + +### Handling a N-API JS exception + +```cpp +Napi::Env env = ... +Napi::Function jsFunctionThatThrows = someObj.As<Napi::Function>(); +Napi::Value result = jsFunctionThatThrows({ arg1, arg2 }); +if (env.IsExceptionPending()) { + Napi::Error e = env.GetAndClearPendingException(); + cerr << "Caught JavaScript exception: " + e.Message(); +} +``` + +Since the exception was cleared here, it will not be propagated as a JavaScript +exception after the native callback returns. + +## Calling N-API directly from a **node-addon-api** addon + +**node-addon-api** provides macros for throwing errors in response to non-OK +`napi_status` results when calling [N-API](https://nodejs.org/docs/latest/api/n-api.html) +functions from within a native addon. These macros are defined differently +depending on whether C++ exceptions are enabled or not, but are available for +use in either case. + +### `NAPI_THROW(e, ...)` + +This macro accepts a `Napi::Error`, throws it, and returns the value given as +the last parameter. If C++ exceptions are enabled (by defining +`NAPI_CPP_EXCEPTIONS` during the build), the return value will be ignored. + +### `NAPI_THROW_IF_FAILED(env, status, ...)` + +This macro accepts a `Napi::Env` and a `napi_status`. It constructs an error +from the `napi_status`, throws it, and returns the value given as the last +parameter. If C++ exceptions are enabled (by defining `NAPI_CPP_EXCEPTIONS` +during the build), the return value will be ignored. + +### `NAPI_THROW_IF_FAILED_VOID(env, status)` + +This macro accepts a `Napi::Env` and a `napi_status`. It constructs an error +from the `napi_status`, throws it, and returns. + +### `NAPI_FATAL_IF_FAILED(status, location, message)` + +This macro accepts a `napi_status`, a C string indicating the location where the +error occurred, and a second C string for the message to display. diff --git a/node_modules/node-addon-api/doc/escapable_handle_scope.md b/node_modules/node-addon-api/doc/escapable_handle_scope.md new file mode 100644 index 0000000..978aab3 --- /dev/null +++ b/node_modules/node-addon-api/doc/escapable_handle_scope.md @@ -0,0 +1,82 @@ +# EscapableHandleScope + +The `Napi::EscapableHandleScope` class is used to manage the lifetime of object handles +which are created through the use of node-addon-api. These handles +keep an object alive in the heap in order to ensure that the objects +are not collected by the garbage collector while native code is using them. +A handle may be created when any new node-addon-api Value or one +of its subclasses is created or returned. + +The `Napi::EscapableHandleScope` is a special type of `Napi::HandleScope` +which allows a single handle to be "promoted" to an outer scope. + +For more details refer to the section titled +[Object lifetime management](object_lifetime_management.md). + +## Methods + +### Constructor + +Creates a new escapable handle scope. + +```cpp +Napi::EscapableHandleScope Napi::EscapableHandleScope::New(Napi:Env env); +``` + +- `[in] Env`: The environment in which to construct the `Napi::EscapableHandleScope` object. + +Returns a new `Napi::EscapableHandleScope` + +### Constructor + +Creates a new escapable handle scope. + +```cpp +Napi::EscapableHandleScope Napi::EscapableHandleScope::New(napi_env env, napi_handle_scope scope); +``` + +- `[in] env`: napi_env in which the scope passed in was created. +- `[in] scope`: pre-existing napi_handle_scope. + +Returns a new `Napi::EscapableHandleScope` instance which wraps the +napi_escapable_handle_scope handle passed in. This can be used +to mix usage of the C N-API and node-addon-api. + +operator EscapableHandleScope::napi_escapable_handle_scope + +```cpp +operator Napi::EscapableHandleScope::napi_escapable_handle_scope() const +``` + +Returns the N-API napi_escapable_handle_scope wrapped by the `Napi::EscapableHandleScope` object. +This can be used to mix usage of the C N-API and node-addon-api by allowing +the class to be used be converted to a napi_escapable_handle_scope. + +### Destructor +```cpp +Napi::EscapableHandleScope::~EscapableHandleScope(); +``` + +Deletes the `Napi::EscapableHandleScope` instance and allows any objects/handles created +in the scope to be collected by the garbage collector. There is no +guarantee as to when the gargbage collector will do this. + +### Escape + +```cpp +napi::Value Napi::EscapableHandleScope::Escape(napi_value escapee); +``` + +- `[in] escapee`: Napi::Value or napi_env to promote to the outer scope + +Returns `Napi::Value` which can be used in the outer scope. This method can +be called at most once on a given `Napi::EscapableHandleScope`. If it is called +more than once an exception will be thrown. + +### Env + +```cpp +Napi::Env Napi::EscapableHandleScope::Env() const; +``` + +Returns the `Napi::Env` associated with the `Napi::EscapableHandleScope`. diff --git a/node_modules/node-addon-api/doc/external.md b/node_modules/node-addon-api/doc/external.md new file mode 100644 index 0000000..4022b61 --- /dev/null +++ b/node_modules/node-addon-api/doc/external.md @@ -0,0 +1,59 @@ +# External (template) + +The `Napi::External` template class implements the ability to create a `Napi::Value` object with arbitrary C++ data. It is the user's responsibility to manage the memory for the arbitrary C++ data. + +`Napi::External` objects can be created with an optional Finalizer function and optional Hint value. The Finalizer function, if specified, is called when your `Napi::External` object is released by Node's garbage collector. It gives your code the opportunity to free any dynamically created data. If you specify a Hint value, it is passed to your Finalizer function. + +## Methods + +### New + +```cpp +template <typename T> +static Napi::External Napi::External::New(napi_env env, T* data); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::External` object. +- `[in] data`: The arbitrary C++ data to be held by the `Napi::External` object. + +Returns the created `Napi::External<T>` object. + +### New + +```cpp +template <typename T> +static Napi::External Napi::External::New(napi_env env, + T* data, + Finalizer finalizeCallback); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::External` object. +- `[in] data`: The arbitrary C++ data to be held by the `Napi::External` object. +- `[in] finalizeCallback`: A function called when the `Napi::External` object is released by the garbage collector accepting a T* and returning void. + +Returns the created `Napi::External<T>` object. + +### New + +```cpp +template <typename T> +static Napi::External Napi::External::New(napi_env env, + T* data, + Finalizer finalizeCallback, + Hint* finalizeHint); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::External` object. +- `[in] data`: The arbitrary C++ data to be held by the `Napi::External` object. +- `[in] finalizeCallback`: A function called when the `Napi::External` object is released by the garbage collector accepting T* and Hint* parameters and returning void. +- `[in] finalizeHint`: A hint value passed to the `finalizeCallback` function. + +Returns the created `Napi::External<T>` object. + +### Data + +```cpp +T* Napi::External::Data() const; +``` + +Returns a pointer to the arbitrary C++ data held by the `Napi::External` object. diff --git a/node_modules/node-addon-api/doc/function.md b/node_modules/node-addon-api/doc/function.md new file mode 100644 index 0000000..efc7ed4 --- /dev/null +++ b/node_modules/node-addon-api/doc/function.md @@ -0,0 +1,294 @@ +# Function + +The `Napi::Function` class provides a set of methods for creating a function object in +native code that can later be called from JavaScript. The created function is not +automatically visible from JavaScript. Instead it needs to be part of the add-on's +module exports or be returned by one of the module's exported functions. + +In addition the `Napi::Function` class also provides methods that can be used to call +functions that were created in JavaScript and passed to the native add-on. + +The `Napi::Function` class inherits its behavior from the `Napi::Object` class (for more info +see: [`Napi::Object`](object.md)). + +## Example + +```cpp +#include <napi.h> + +using namespace Napi; + +Value Fn(const CallbackInfo& info) { + Env env = info.Env(); + // ... + return String::New(env, "Hello World"); +} + +Object Init(Env env, Object exports) { + exports.Set(String::New(env, "fn"), Function::New(env, Fn)); +} + +NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init) +``` + +The above code can be used from JavaScript as follows: + +```js +const addon = require('./addon'); +addon.fn(); +``` + +With the `Napi::Function` class it is possible to call a JavaScript function object +from a native add-on with two different methods: `Call` and `MakeCallback`. +The API of these two methods is very similar, but they are used in different +contexts. The `MakeCallback` method is used to call from native code back into +JavaScript after returning from an [asynchronous operation](async_operations.md) +and in general in situations which don't have an existing JavaScript function on +the stack. The `Call` method is used when there is already a JavaScript function +on the stack (for example when running a native method called from JavaScript). + +## Methods + +### Constructor + +Creates a new empty instance of `Napi::Function`. + +```cpp +Napi::Function::Function(); +``` + +### Constructor + +Creates a new instance of the `Napi::Function` object. + +```cpp +Napi::Function::Function(napi_env env, napi_value value); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Function` object. +- `[in] value`: The `napi_value` which is a handle for a JavaScript function. + +Returns a non-empty `Napi::Function` instance. + +### New + +Creates an instance of a `Napi::Function` object. + +```cpp +template <typename Callable> +static Napi::Function Napi::Function::New(napi_env env, Callable cb, const char* utf8name = nullptr, void* data = nullptr); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Function` object. +- `[in] cb`: Object that implements `Callable`. +- `[in] utf8name`: Null-terminated string to be used as the name of the function. +- `[in] data`: User-provided data context. This will be passed back into the +function when invoked later. + +Returns an instance of a `Napi::Function` object. + +### New + +```cpp +template <typename Callable> +static Napi::Function Napi::Function::New(napi_env env, Callable cb, const std::string& utf8name, void* data = nullptr); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Function` object. +- `[in] cb`: Object that implements `Callable`. +- `[in] utf8name`: String to be used as the name of the function. +- `[in] data`: User-provided data context. This will be passed back into the +function when invoked later. + +Returns an instance of a `Napi::Function` object. + +### New + +Creates a new JavaScript value from one that represents the constructor for the +object. + +```cpp +Napi::Object Napi::Function::New(const std::initializer_list<napi_value>& args) const; +``` + +- `[in] args`: Initializer list of JavaScript values as `napi_value` representing +the arguments of the contructor function. + +Returns a new JavaScript object. + +### New + +Creates a new JavaScript value from one that represents the constructor for the +object. + +```cpp +Napi::Object Napi::Function::New(const std::vector<napi_value>& args) const; +``` + +- `[in] args`: Vector of JavaScript values as `napi_value` representing the +arguments of the constructor function. + +Returns a new JavaScript object. + +### New + +Creates a new JavaScript value from one that represents the constructor for the +object. + +```cpp +Napi::Object Napi::Function::New(size_t argc, const napi_value* args) const; +``` + +- `[in] argc`: The number of the arguments passed to the contructor function. +- `[in] args`: Array of JavaScript values as `napi_value` representing the +arguments of the constructor function. + +Returns a new JavaScript object. + +### Call + +Calls a Javascript function from a native add-on. + +```cpp +Napi::Value Napi::Function::Call(const std::initializer_list<napi_value>& args) const; +``` + +- `[in] args`: Initializer list of JavaScript values as `napi_value` representing +the arguments of the function. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +### Call + +Calls a JavaScript function from a native add-on. + +```cpp +Napi::Value Napi::Function::Call(const std::vector<napi_value>& args) const; +``` + +- `[in] args`: Vector of JavaScript values as `napi_value` representing the +arguments of the function. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +### Call + +Calls a Javascript function from a native add-on. + +```cpp +Napi::Value Napi::Function::Call(size_t argc, const napi_value* args) const; +``` + +- `[in] argc`: The number of the arguments passed to the function. +- `[in] args`: Array of JavaScript values as `napi_value` representing the +arguments of the function. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +### Call + +Calls a Javascript function from a native add-on. + +```cpp +Napi::Value Napi::Function::Call(napi_value recv, const std::initializer_list<napi_value>& args) const; +``` + +- `[in] recv`: The `this` object passed to the called function. +- `[in] args`: Initializer list of JavaScript values as `napi_value` representing +the arguments of the function. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +### Call + +Calls a Javascript function from a native add-on. + +```cpp +Napi::Value Napi::Function::Call(napi_value recv, const std::vector<napi_value>& args) const; +``` + +- `[in] recv`: The `this` object passed to the called function. +- `[in] args`: Vector of JavaScript values as `napi_value` representing the +arguments of the function. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +### Call + +Calls a Javascript function from a native add-on. + +```cpp +Napi::Value Napi::Function::Call(napi_value recv, size_t argc, const napi_value* args) const; +``` + +- `[in] recv`: The `this` object passed to the called function. +- `[in] argc`: The number of the arguments passed to the function. +- `[in] args`: Array of JavaScript values as `napi_value` representing the +arguments of the function. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +### MakeCallback + +Calls a Javascript function from a native add-on after an asynchronous operation. + +```cpp +Napi::Value Napi::Function::MakeCallback(napi_value recv, const std::initializer_list<napi_value>& args, napi_async_context context = nullptr) const; +``` + +- `[in] recv`: The `this` object passed to the called function. +- `[in] args`: Initializer list of JavaScript values as `napi_value` representing +the arguments of the function. +- `[in] context`: Context for the async operation that is invoking the callback. +This should normally be a value previously obtained from [Napi::AsyncContext](async_context.md). +However `nullptr` is also allowed, which indicates the current async context +(if any) is to be used for the callback. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +### MakeCallback + +Calls a Javascript function from a native add-on after an asynchronous operation. + +```cpp +Napi::Value Napi::Function::MakeCallback(napi_value recv, const std::vector<napi_value>& args, napi_async_context context = nullptr) const; +``` + +- `[in] recv`: The `this` object passed to the called function. +- `[in] args`: List of JavaScript values as `napi_value` representing the +arguments of the function. +- `[in] context`: Context for the async operation that is invoking the callback. +This should normally be a value previously obtained from [Napi::AsyncContext](async_context.md). +However `nullptr` is also allowed, which indicates the current async context +(if any) is to be used for the callback. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +### MakeCallback + +Calls a Javascript function from a native add-on after an asynchronous operation. + +```cpp +Napi::Value Napi::Function::MakeCallback(napi_value recv, size_t argc, const napi_value* args, napi_async_context context = nullptr) const; +``` + +- `[in] recv`: The `this` object passed to the called function. +- `[in] argc`: The number of the arguments passed to the function. +- `[in] args`: Array of JavaScript values as `napi_value` representing the +arguments of the function. +- `[in] context`: Context for the async operation that is invoking the callback. +This should normally be a value previously obtained from [Napi::AsyncContext](async_context.md). +However `nullptr` is also allowed, which indicates the current async context +(if any) is to be used for the callback. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. + +## Operator + +```cpp +Napi::Value Napi::Function::operator ()(const std::initializer_list<napi_value>& args) const; +``` + +- `[in] args`: Initializer list of JavaScript values as `napi_value`. + +Returns a `Napi::Value` representing the JavaScript value returned by the function. diff --git a/node_modules/node-addon-api/doc/function_reference.md b/node_modules/node-addon-api/doc/function_reference.md new file mode 100644 index 0000000..7b299b9 --- /dev/null +++ b/node_modules/node-addon-api/doc/function_reference.md @@ -0,0 +1,238 @@ +# FunctionReference + +`Napi::FunctionReference` is a subclass of [`Napi::Reference`](reference.md), and +is equivalent to an instance of `Napi::Reference<Napi::Function>`. This means +that a `Napi::FunctionReference` holds a [`Napi::Function`](function.md), and a +count of the number of references to that `Napi::Function`. When the count is +greater than 0, a `Napi::FunctionReference` is not eligible for garbage collection. +This ensures that the `Function` will remain accessible, even if the original +reference to it is no longer available. +`Napi::FunctionReference` allows the referenced JavaScript function object to be +called from a native add-on with two different methods: `Call` and `MakeCallback`. +See the documentation for [`Napi::Function`](function.md) for when `Call` should +be used instead of `MakeCallback` and vice-versa. + +The `Napi::FunctionReference` class inherits its behavior from the `Napi::Reference` +class (for more info see: [`Napi::Reference`](reference.md)). + +## Methods + +### Weak + +Creates a "weak" reference to the value, in that the initial reference count is +set to 0. + +```cpp +static Napi::FunctionReference Napi::Weak(const Napi::Function& value); +``` + +- `[in] value`: The value which is to be referenced. + +Returns the newly created reference. + +### Persistent + +Creates a "persistent" reference to the value, in that the initial reference +count is set to 1. + +```cpp +static Napi::FunctionReference Napi::Persistent(const Napi::Function& value); +``` + +- `[in] value`: The value which is to be referenced. + +Returns the newly created reference. + +### Constructor + +Creates a new empty instance of `Napi::FunctionReference`. + +```cpp +Napi::FunctionReference::FunctionReference(); +``` + +### Constructor + +Creates a new instance of the `Napi::FunctionReference`. + +```cpp +Napi::FunctionReference::FunctionReference(napi_env env, napi_ref ref); +``` + +- `[in] env`: The environment in which to construct the `Napi::FunctionReference` object. +- `[in] ref`: The N-API reference to be held by the `Napi::FunctionReference`. + +Returns a newly created `Napi::FunctionReference` object. + +### New + +Constructs a new instance by calling the constructor held by this reference. + +```cpp +Napi::Object Napi::FunctionReference::New(const std::initializer_list<napi_value>& args) const; +``` + +- `[in] args`: Initializer list of JavaScript values as `napi_value` representing +the arguments of the contructor function. + +Returns a new JavaScript object. + +### New + +Constructs a new instance by calling the constructor held by this reference. + +```cpp +Napi::Object Napi::FunctionReference::New(const std::vector<napi_value>& args) const; +``` + +- `[in] args`: Vector of JavaScript values as `napi_value` representing the +arguments of the constructor function. + +Returns a new JavaScript object. + +### Call + +Calls a referenced Javascript function from a native add-on. + +```cpp +Napi::Value Napi::FunctionReference::Call(const std::initializer_list<napi_value>& args) const; +``` + +- `[in] args`: Initializer list of JavaScript values as `napi_value` representing +the arguments of the referenced function. + +Returns a `Napi::Value` representing the JavaScript object returned by the referenced +function. + +### Call + +Calls a referenced JavaScript function from a native add-on. + +```cpp +Napi::Value Napi::FunctionReference::Call(const std::vector<napi_value>& args) const; +``` + +- `[in] args`: Vector of JavaScript values as `napi_value` representing the +arguments of the referenced function. + +Returns a `Napi::Value` representing the JavaScript object returned by the referenced +function. + +### Call + +Calls a referenced JavaScript function from a native add-on. + +```cpp +Napi::Value Napi::FunctionReference::Call(napi_value recv, const std::initializer_list<napi_value>& args) const; +``` + +- `[in] recv`: The `this` object passed to the referenced function when it's called. +- `[in] args`: Initializer list of JavaScript values as `napi_value` representing +the arguments of the referenced function. + +Returns a `Napi::Value` representing the JavaScript object returned by the referenced +function. + +### Call + +Calls a referenced JavaScript function from a native add-on. + +```cpp +Napi::Value Napi::FunctionReference::Call(napi_value recv, const std::vector<napi_value>& args) const; +``` + +- `[in] recv`: The `this` object passed to the referenced function when it's called. +- `[in] args`: Vector of JavaScript values as `napi_value` representing the +arguments of the referenced function. + +Returns a `Napi::Value` representing the JavaScript object returned by the referenced +function. + +### Call + +Calls a referenced JavaScript function from a native add-on. + +```cpp +Napi::Value Napi::FunctionReference::Call(napi_value recv, size_t argc, const napi_value* args) const; +``` + +- `[in] recv`: The `this` object passed to the referenced function when it's called. +- `[in] argc`: The number of arguments passed to the referenced function. +- `[in] args`: Array of JavaScript values as `napi_value` representing the +arguments of the referenced function. + +Returns a `Napi::Value` representing the JavaScript object returned by the referenced +function. + + +### MakeCallback + +Calls a referenced JavaScript function from a native add-on after an asynchronous +operation. + +```cpp +Napi::Value Napi::FunctionReference::MakeCallback(napi_value recv, const std::initializer_list<napi_value>& args, napi_async_context = nullptr) const; +``` + +- `[in] recv`: The `this` object passed to the referenced function when it's called. +- `[in] args`: Initializer list of JavaScript values as `napi_value` representing +the arguments of the referenced function. +- `[in] context`: Context for the async operation that is invoking the callback. +This should normally be a value previously obtained from [Napi::AsyncContext](async_context.md). +However `nullptr` is also allowed, which indicates the current async context +(if any) is to be used for the callback. + +Returns a `Napi::Value` representing the JavaScript object returned by the referenced +function. + +### MakeCallback + +Calls a referenced JavaScript function from a native add-on after an asynchronous +operation. + +```cpp +Napi::Value Napi::FunctionReference::MakeCallback(napi_value recv, const std::vector<napi_value>& args, napi_async_context context = nullptr) const; +``` + +- `[in] recv`: The `this` object passed to the referenced function when it's called. +- `[in] args`: Vector of JavaScript values as `napi_value` representing the +arguments of the referenced function. +- `[in] context`: Context for the async operation that is invoking the callback. +This should normally be a value previously obtained from [Napi::AsyncContext](async_context.md). +However `nullptr` is also allowed, which indicates the current async context +(if any) is to be used for the callback. + +Returns a `Napi::Value` representing the JavaScript object returned by the referenced +function. + +### MakeCallback + +Calls a referenced JavaScript function from a native add-on after an asynchronous +operation. + +```cpp +Napi::Value Napi::FunctionReference::MakeCallback(napi_value recv, size_t argc, const napi_value* args, napi_async_context context = nullptr) const; +``` + +- `[in] recv`: The `this` object passed to the referenced function when it's called. +- `[in] argc`: The number of arguments passed to the referenced function. +- `[in] args`: Array of JavaScript values as `napi_value` representing the +arguments of the referenced function. +- `[in] context`: Context for the async operation that is invoking the callback. +This should normally be a value previously obtained from [Napi::AsyncContext](async_context.md). +However `nullptr` is also allowed, which indicates the current async context +(if any) is to be used for the callback. + +Returns a `Napi::Value` representing the JavaScript object returned by the referenced +function. + +## Operator + +```cpp +Napi::Value operator ()(const std::initializer_list<napi_value>& args) const; +``` + +- `[in] args`: Initializer list of reference to JavaScript values as `napi_value` + +Returns a `Napi::Value` representing the JavaScript value returned by the referenced +function. diff --git a/node_modules/node-addon-api/doc/generator.md b/node_modules/node-addon-api/doc/generator.md new file mode 100644 index 0000000..9167480 --- /dev/null +++ b/node_modules/node-addon-api/doc/generator.md @@ -0,0 +1,13 @@ +# Generator + +## What is generator + +**[generator-napi-module](https://www.npmjs.com/package/generator-napi-module)** is a module to quickly generate a skeleton module using +**N-API**, the new API for Native addons. This module automatically sets up your +**gyp file** to use **node-addon-api**, the C++ wrappers for N-API and generates +a wrapper JS module. Optionally, it can even configure the generated project to +use **TypeScript** instead. + +## **generator-napi-module** reference + + - [Installation and usage](https://www.npmjs.com/package/generator-napi-module#installation) diff --git a/node_modules/node-addon-api/doc/handle_scope.md b/node_modules/node-addon-api/doc/handle_scope.md new file mode 100644 index 0000000..9b34fcf --- /dev/null +++ b/node_modules/node-addon-api/doc/handle_scope.md @@ -0,0 +1,65 @@ +# HandleScope + +The HandleScope class is used to manage the lifetime of object handles +which are created through the use of node-addon-api. These handles +keep an object alive in the heap in order to ensure that the objects +are not collected while native code is using them. +A handle may be created when any new node-addon-api Value or one +of its subclasses is created or returned. For more details refer to +the section titled [Object lifetime management](object_lifetime_management.md). + +## Methods + +### Constructor + +Creates a new handle scope on the stack. + +```cpp +Napi::HandleScope::HandleScope(Napi::Env env); +``` + +- `[in] env`: The environment in which to construct the `Napi::HandleScope` object. + +Returns a new `Napi::HandleScope` + +### Constructor + +Creates a new handle scope on the stack. + +```cpp +Napi::HandleScope::HandleScope(Napi::Env env, Napi::HandleScope scope); +``` + +- `[in] env`: `Napi::Env` in which the scope passed in was created. +- `[in] scope`: pre-existing `Napi::HandleScope`. + +Returns a new `Napi::HandleScope` instance which wraps the napi_handle_scope +handle passed in. This can be used to mix usage of the C N-API +and node-addon-api. + +operator HandleScope::napi_handle_scope + +```cpp +operator Napi::HandleScope::napi_handle_scope() const +``` + +Returns the N-API napi_handle_scope wrapped by the `Napi::EscapableHandleScope` object. +This can be used to mix usage of the C N-API and node-addon-api by allowing +the class to be used be converted to a napi_handle_scope. + +### Destructor +```cpp +Napi::HandleScope::~HandleScope(); +``` + +Deletes the `Napi::HandleScope` instance and allows any objects/handles created +in the scope to be collected by the garbage collector. There is no +guarantee as to when the gargbage collector will do this. + +### Env + +```cpp +Napi::Env Napi::HandleScope::Env() const; +``` + +Returns the `Napi::Env` associated with the `Napi::HandleScope`. diff --git a/node_modules/node-addon-api/doc/memory_management.md b/node_modules/node-addon-api/doc/memory_management.md new file mode 100644 index 0000000..afa6225 --- /dev/null +++ b/node_modules/node-addon-api/doc/memory_management.md @@ -0,0 +1,27 @@ +# MemoryManagement + +The `Napi::MemoryManagement` class contains functions that give the JavaScript engine +an indication of the amount of externally allocated memory that is kept alive by +JavaScript objects. + +## Methods + +### AdjustExternalMemory + +The function `AdjustExternalMemory` adjusts the amount of registered external +memory used to give the JavaScript engine an indication of the amount of externally +allocated memory that is kept alive by JavaScript objects. +The JavaScript engine uses this to decide when to perform global garbage collections. +Registering externally allocated memory will trigger global garbage collections +more often than it would otherwise in an attempt to garbage collect the JavaScript +objects that keep the externally allocated memory alive. + +```cpp +static int64_t Napi::MemoryManagement::AdjustExternalMemory(Napi::Env env, int64_t change_in_bytes); +``` + +- `[in] env`: The environment in which the API is invoked under. +- `[in] change_in_bytes`: The change in externally allocated memory that is kept +alive by JavaScript objects expressed in bytes. + +Returns the adjusted memory value. diff --git a/node_modules/node-addon-api/doc/node-gyp.md b/node_modules/node-addon-api/doc/node-gyp.md new file mode 100644 index 0000000..529aa0e --- /dev/null +++ b/node_modules/node-addon-api/doc/node-gyp.md @@ -0,0 +1,82 @@ +# node-gyp + +C++ code needs to be compiled into executable form whether it be as an object +file to linked with others, a shared library, or a standalone executable. + +The main reason for this is that we need to link to the Node.js dependencies and +headers correctly, another reason is that we need a cross platform way to build +C++ source into binary for the target platform. + +Until now **node-gyp** is the **de-facto** standard build tool for writing +Node.js addons. It's based on Google's **gyp** build tool, which abstract away +many of the tedious issues related to cross platform building. + +**node-gyp** uses a file called ```binding.gyp``` that is located on the root of +your addon project. + +```binding.gyp``` file, contains all building configurations organized with a +JSON like syntax. The most important parameter is the **target** that must be +set to the same value used on the initialization code of the addon as in the +examples reported below: + +### **binding.gyp** + +```gyp +{ + "targets": [ + { + # myModule is the name of your native addon + "target_name": "myModule", + "sources": ["src/my_module.cc", ...], + ... + ] +} +``` + +### **my_module.cc** + +```cpp +#include <napi.h> + +// ... + +/** +* This code is our entry-point. We receive two arguments here, the first is the +* environment that represent an independent instance of the JavaScript runtime, +* the second is exports, the same as module.exports in a .js file. +* You can either add properties to the exports object passed in or create your +* own exports object. In either case you must return the object to be used as +* the exports for the module when you return from the Init function. +*/ +Napi::Object Init(Napi::Env env, Napi::Object exports) { + + // ... + + return exports; +} + +/** +* This code defines the entry-point for the Node addon, it tells Node where to go +* once the library has been loaded into active memory. The first argument must +* match the "target" in our *binding.gyp*. Using NODE_GYP_MODULE_NAME ensures +* that the argument will be correct, as long as the module is built with +* node-gyp (which is the usual way of building modules). The second argument +* points to the function to invoke. The function must not be namespaced. +*/ +NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init) +``` + +## **node-gyp** reference + + - [Installation](https://www.npmjs.com/package/node-gyp#installation) + - [How to use](https://www.npmjs.com/package/node-gyp#how-to-use) + - [The binding.gyp file](https://www.npmjs.com/package/node-gyp#the-bindinggyp-file) + - [Commands](https://www.npmjs.com/package/node-gyp#commands) + - [Command options](https://www.npmjs.com/package/node-gyp#command-options) + - [Configuration](https://www.npmjs.com/package/node-gyp#configuration) + +Sometimes finding the right settings for ```binding.gyp``` is not easy so to +accomplish at most complicated task please refer to: + +- [GYP documentation](https://gyp.gsrc.io/index.md) +- [node-gyp wiki](https://github.com/nodejs/node-gyp/wiki) diff --git a/node_modules/node-addon-api/doc/number.md b/node_modules/node-addon-api/doc/number.md new file mode 100644 index 0000000..d603101 --- /dev/null +++ b/node_modules/node-addon-api/doc/number.md @@ -0,0 +1,163 @@ +# Number + +`Napi::Number` class is a representation of the JavaScript `Number` object. The +`Napi::Number` class inherits its behavior from `Napi::Value` class +(for more info see [`Napi::Value`](value.md)) + +## Methods + +### Constructor + +Creates a new _empty_ instance of a `Napi::Number` object. + +```cpp +Napi::Number(); +``` + +Returns a new _empty_ `Napi::Number` object. + +### Contructor + +Creates a new instance of a `Napi::Number` object. + +```cpp +Napi::Number(napi_env env, napi_value value); +``` + + - `[in] env`: The `napi_env` environment in which to construct the `Napi::Number` object. + - `[in] value`: The JavaScript value holding a number. + + Returns a non-empty `Napi::Number` object. + + ### New + + Creates a new instance of a `Napi::Number` object. + +```cpp +Napi::Number Napi::Number::New(napi_env env, double value); +``` + - `[in] env`: The `napi_env` environment in which to construct the `Napi::Number` object. + - `[in] value`: The C++ primitive from which to instantiate the `Napi::Number`. + +Creates a new instance of a `Napi::Number` object. + +### Int32Value + +Converts a `Napi::Number` value to a `int32_t` primitive type. + +```cpp +Napi::Number::Int32Value() const; +``` + +Returns the `int32_t` primitive type of the corresponding `Napi::Number` object. + +### Uint32Value + +Converts a `Napi::Number` value to a `uint32_t` primitive type. + +```cpp +Napi::Number::Uint32Value() const; +``` + +Returns the `uint32_t` primitive type of the corresponding `Napi::Number` object. + +### Int64Value + +Converts a `Napi::Number` value to a `int64_t` primitive type. + +```cpp +Napi::Number::Int64Value() const; +``` + +Returns the `int64_t` primitive type of the corresponding `Napi::Number` object. + +### FloatValue + +Converts a `Napi::Number` value to a `float` primitive type. + +```cpp +Napi::Number::FloatValue() const; +``` + +Returns the `float` primitive type of the corresponding `Napi::Number` object. + +### DoubleValue + +Converts a `Napi::Number` value to a `double` primitive type. + +```cpp +Napi::Number::DoubleValue() const; +``` + +Returns the `double` primitive type of the corresponding `Napi::Number` object. + +## Operators + +The `Napi::Number` class contains a set of operators to easily cast JavaScript +`Number` object to one of the following primitive types: + + - `int32_t` + - `uint32_t` + - `int64_t` + - `float` + - `double` + +### operator int32_t + +Converts a `Napi::Number` value to a `int32_t` primitive. + +```cpp +Napi::Number::operator int32_t() const; +``` + +Returns the `int32_t` primitive type of the corresponding `Napi::Number` object. + +### operator uint32_t + +Converts a `Napi::Number` value to a `uint32_t` primitive type. + +```cpp +Napi::Number::operator uint32_t() const; +``` + +Returns the `uint32_t` primitive type of the corresponding `Napi::Number` object. + +### operator int64_t + +Converts a `Napi::Number` value to a `int64_t` primitive type. + +```cpp +Napi::Number::operator int64_t() const; +``` + +Returns the `int64_t` primitive type of the corresponding `Napi::Number` object. + +### operator float + +Converts a `Napi::Number` value to a `float` primitive type. + +```cpp +Napi::Number::operator float() const; +``` + +Returns the `float` primitive type of the corresponding `Napi::Number` object. + +### operator double + +Converts a `Napi::Number` value to a `double` primitive type. + +```cpp +Napi::Number::operator double() const; +``` + +Returns the `double` primitive type of the corresponding `Napi::Number` object. + +### Example + +The following shows an example of casting a number to an `uint32_t` value. + +```cpp +uint32_t operatorVal = Napi::Number::New(Env(), 10.0); // Number to unsigned 32 bit integer +// or +auto instanceVal = info[0].As<Napi::Number>().Uint32Value(); +``` diff --git a/node_modules/node-addon-api/doc/object.md b/node_modules/node-addon-api/doc/object.md new file mode 100644 index 0000000..3241054 --- /dev/null +++ b/node_modules/node-addon-api/doc/object.md @@ -0,0 +1,236 @@ +# Object + +The `Napi::Object` class corresponds to a JavaScript object. It is extended by the following node-addon-api classes that you may use when working with more specific types: + +- [`Napi::Value`](value.md) and extends [`Napi::Array`](array.md) +- [`Napi::ArrayBuffer`](array_buffer.md) +- [`Napi::Buffer<T>`](buffer.md) +- [`Napi::Function`](function.md) +- [`Napi::TypedArray`](typed_array.md). + +This class provides a number of convenience methods, most of which are used to set or get properties on a JavaScript object. For example, Set() and Get(). + +## Example +```cpp +#include <napi.h> + +using namespace Napi; + +Void Init(Env env) { + + // Create a new instance + Object obj = Object::New(env); + + // Assign values to properties + obj.Set("hello", "world"); + obj.Set(uint32_t(42), "The Answer to Life, the Universe, and Everything"); + obj.Set("Douglas Adams", true); + + // Get properties + Value val1 = obj.Get("hello"); + Value val2 = obj.Get(uint32_t(42)); + Value val3 = obj.Get("Douglas Adams"); + + // Test if objects have properties. + bool obj1 = obj.Has("hello"); // true + bool obj2 = obj.Has("world"); // false + +} +``` + +## Methods + +### Empty Constructor + +```cpp +Napi::Object::Object(); +``` +Creates a new empty Object instance. + +### Constructor + +```cpp +Napi::Object::Object(napi_env env, napi_value value); +``` +- `[in] env`: The `napi_env` environment in which to construct the Value object. + +- `[in] value`: The C++ primitive from which to instantiate the Value. `value` may be any of: + - bool + - Any integer type + - Any floating point type + - const char* (encoded using UTF-8, null-terminated) + - const char16_t* (encoded using UTF-16-LE, null-terminated) + - std::string (encoded using UTF-8) + - std::u16string + - Napi::Value + - napi_value + +Creates a non-empty `Napi::Object` instance. + +### New() + +```cpp +Napi::Object Napi::Object::New(napi_env env); +``` +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Value` object. + +Creates a new `Napi::Object` value. + +### Set() + +```cpp +void Napi::Object::Set (____ key, ____ value); +``` +- `[in] key`: The name for the property being assigned. +- `[in] value`: The value being assigned to the property. + +Add a property with the specified key with the specified value to the object. + +The key can be any of the following types: +- `napi_value` +- [`Napi::Value`](value.md) +- `const char*` +- `const std::string&` +- `uint32_t` + +While the value must be any of the following types: +- `napi_value` +- [`Napi::Value`](value.md) +- `const char*` +- `std::string&` +- `bool` +- `double` + +### Get() + +```cpp +Napi::Value Napi::Object::Get(____ key); +``` +- `[in] key`: The name of the property to return the value for. + +Returns the [`Napi::Value`](value.md) associated with the key property. Returns the value *undefined* if the key does not exist. + +The `key` can be any of the following types: +- `napi_value` +- [`Napi::Value`](value.md) +- `const char *` +- `const std::string &` +- `uint32_t` + +### Has() + +```cpp +bool Napi::Object::Has (____ key) const; +``` +- `[in] key`: The name of the property to check. + +Returns a `bool` that is *true* if the object has a property named `key` and *false* otherwise. + +### InstanceOf() + +```cpp +bool Napi::Object::InstanceOf (const Function& constructor) const +``` +- `[in] constructor`: The constructor [`Napi::Function`](function.md) of the value that is being compared with the object. + +Returns a `bool` that is true if the `Napi::Object` is an instance created by the `constructor` and false otherwise. + +Note: This is equivalent to the JavaScript instanceof operator. + +### AddFinalizer() +```cpp +template <typename Finalizer, typename T> +inline void AddFinalizer(Finalizer finalizeCallback, T* data); +``` + +- `[in] finalizeCallback`: The function to call when the object is garbage-collected. +- `[in] data`: The data to associate with the object. + +Associates `data` with the object, calling `finalizeCallback` when the object is garbage-collected. `finalizeCallback` +has the signature +```cpp +void finalizeCallback(Napi::Env env, T* data); +``` +where `data` is the pointer that was passed into the call to `AddFinalizer()`. + +### AddFinalizer() +```cpp +template <typename Finalizer, typename T, typename Hint> +inline void AddFinalizer(Finalizer finalizeCallback, + T* data, + Hint* finalizeHint); +``` + +- `[in] data`: The data to associate with the object. +- `[in] finalizeCallback`: The function to call when the object is garbage-collected. + +Associates `data` with the object, calling `finalizeCallback` when the object is garbage-collected. An additional hint +may be given. It will also be passed to `finalizeCallback`, which has the signature +```cpp +void finalizeCallback(Napi::Env env, T* data, Hint* hint); +``` +where `data` and `hint` are the pointers that were passed into the call to `AddFinalizer()`. + +### DefineProperty() + +```cpp +void Napi::Object::DefineProperty (const Napi::PropertyDescriptor& property); +``` +- `[in] property`: A [`Napi::PropertyDescriptor`](property_descriptor.md). + +Define a property on the object. + +### DefineProperties() + +```cpp +void Napi::Object::DefineProperties (____ properties) +``` +- `[in] properties`: A list of [`Napi::PropertyDescriptor`](property_descriptor.md). Can be one of the following types: + - const std::initializer_list<Napi::PropertyDescriptor>& + - const std::vector<Napi::PropertyDescriptor>& + +Defines properties on the object. + +### Operator[]() + +```cpp +Napi::PropertyLValue<std::string> Napi::Object::operator[] (const char* utf8name); +``` +- `[in] utf8name`: UTF-8 encoded null-terminated property name. + +Returns a [`Napi::PropertyLValue`](propertylvalue.md) as the named property or sets the named property. + +```cpp +Napi::PropertyLValue<std::string> Napi::Object::operator[] (const std::string& utf8name); +``` +- `[in] utf8name`: UTF-8 encoded property name. + +Returns a [`Napi::PropertyLValue`](propertylvalue.md) as the named property or sets the named property. + +```cpp +Napi::PropertyLValue<uint32_t> Napi::Object::operator[] (uint32_t index); +``` +- `[in] index`: Element index. + +Returns a [`Napi::PropertyLValue`](propertylvalue.md) or sets an indexed property or array element. + +```cpp +Napi::Value Napi::Object::operator[] (const char* utf8name) const; +``` +- `[in] utf8name`: UTF-8 encoded null-terminated property name. + +Returns the named property as a [`Napi::Value`](value.md). + +```cpp +Napi::Value Napi::Object::operator[] (const std::string& utf8name) const; +``` +- `[in] utf8name`: UTF-8 encoded property name. + +Returns the named property as a [`Napi::Value`](value.md). + +```cpp +Napi::Value Napi::Object::operator[] (uint32_t index) const; +``` +- `[in] index`: Element index. + +Returns an indexed property or array element as a [`Napi::Value`](value.md). diff --git a/node_modules/node-addon-api/doc/object_lifetime_management.md b/node_modules/node-addon-api/doc/object_lifetime_management.md new file mode 100644 index 0000000..4ab19ec --- /dev/null +++ b/node_modules/node-addon-api/doc/object_lifetime_management.md @@ -0,0 +1,83 @@ +# Object lifetime management + +A handle may be created when any new node-addon-api Value and +its subclasses is created or returned. + +As the methods and classes within the node-addon-api are used, +handles to objects in the heap for the underlying +VM may be created. A handle may be created when any new +node-addon-api Value or one of its subclasses is created or returned. +These handles must hold the objects 'live' until they are no +longer required by the native code, otherwise the objects could be +collected by the garbage collector before the native code was +finished using them. + +As handles are created they are associated with a +'scope'. The lifespan for the default scope is tied to the lifespan +of the native method call. The result is that, by default, handles +remain valid and the objects associated with these handles will be +held live for the lifespan of the native method call. + +In many cases, however, it is necessary that the handles remain valid for +either a shorter or longer lifespan than that of the native method. +The sections which follow describe the node-addon-api classes and +methods that than can be used to change the handle lifespan from +the default. + +## Making handle lifespan shorter than that of the native method + +It is often necessary to make the lifespan of handles shorter than +the lifespan of a native method. For example, consider a native method +that has a loop which creates a number of values and does something +with each of the values, one at a time: + +```C++ +for (int i = 0; i < LOOP_MAX; i++) { + std::string name = std::string("inner-scope") + std::to_string(i); + Napi::Value newValue = Napi::String::New(info.Env(), name.c_str()); + // do something with newValue +}; +``` + +This would result in a large number of handles being created, consuming +substantial resources. In addition, even though the native code could only +use the most recently created value, all of the previously created +values would also be kept alive since they all share the same scope. + +To handle this case, node-addon-api provides the ability to establish +a new 'scope' to which newly created handles will be associated. Once those +handles are no longer required, the scope can be deleted and any handles +associated with the scope are invalidated. The `Napi::HandleScope` +and `Napi::EscapableHandleScope` classes are provided by node-addon-api for +creating additional scopes. + +node-addon-api only supports a single nested hierarchy of scopes. There is +only one active scope at any time, and all new handles will be associated +with that scope while it is active. Scopes must be deleted in the reverse +order from which they are opened. In addition, all scopes created within +a native method must be deleted before returning from that method. Since +`Napi::HandleScopes` are typically stack allocated the compiler will take care of +deletion, however, care must be taken to create the scope in the right +place such that you achieve the desired lifetime. + +Taking the earlier example, creating a `Napi::HandleScope` in the innner loop +would ensure that at most a single new value is held alive throughout the +execution of the loop: + +```C +for (int i = 0; i < LOOP_MAX; i++) { + Napi::HandleScope scope(info.Env()); + std::string name = std::string("inner-scope") + std::to_string(i); + Napi::Value newValue = Napi::String::New(info.Env(), name.c_str()); + // do something with neValue +}; +``` + +When nesting scopes, there are cases where a handle from an +inner scope needs to live beyond the lifespan of that scope. node-addon-api +provides the `Napi::EscapableHandleScope` with the `Escape` method +in order to support this case. An escapable scope +allows one object to be 'promoted' so that it 'escapes' the +current scope and the lifespan of the handle changes from the current +scope to that of the outer scope. The `Escape` method can only be called +once for a given `Napi::EscapableHandleScope`. diff --git a/node_modules/node-addon-api/doc/object_reference.md b/node_modules/node-addon-api/doc/object_reference.md new file mode 100644 index 0000000..6e579e2 --- /dev/null +++ b/node_modules/node-addon-api/doc/object_reference.md @@ -0,0 +1,117 @@ +# Object Reference + +`Napi::ObjectReference` is a subclass of [`Napi::Reference`](reference.md), and is equivalent to an instance of `Napi::Reference<Object>`. This means that a `Napi::ObjectReference` holds a [`Napi::Object`](object.md), and a count of the number of references to that Object. When the count is greater than 0, an ObjectReference is not eligible for garbage collection. This ensures that the Object being held as a value of the ObjectReference will remain accessible, even if the original Object no longer is. However, ObjectReference is unique from a Reference since properties can be set and get to the Object itself that can be accessed through the ObjectReference. + +For more general information on references, please consult [`Napi::Reference`](reference.md). + +## Example +```cpp +#include <napi.h> + +using namescape Napi; + +void Init(Env env) { + + // Create an empty ObjectReference that has an initial reference count of 2. + ObjectReference obj_ref = Reference<Object>::New(Object::New(env), 2); + + // Set a couple of different properties on the reference. + obj_ref.Set("hello", String::New(env, "world")); + obj_ref.Set(42, "The Answer to Life, the Universe, and Everything"); + + // Get the properties using the keys. + Value val1 = obj_ref.Get("hello"); + Value val2 = obj_ref.Get(42); +} +``` + +## Methods + +### Initialization + +```cpp +static Napi::ObjectReference Napi::ObjectReference::New(const Napi::Object& value, uint32_t initialRefcount = 0); +``` + +* `[in] value`: The `Napi::Object` which is to be referenced. + +* `[in] initialRefcount`: The initial reference count. + +Returns the newly created reference. + +```cpp +static Napi::ObjectReference Napi::Weak(const Napi::Object& value); +``` + +Creates a "weak" reference to the value, in that the initial count of number of references is set to 0. + +* `[in] value`: The value which is to be referenced. + +Returns the newly created reference. + +```cpp +static Napi::ObjectReference Napi::Persistent(const Napi::Object& value); +``` + +Creates a "persistent" reference to the value, in that the initial count of number of references is set to 1. + +* `[in] value`: The value which is to be referenced. + +Returns the newly created reference. + +### Empty Constructor + +```cpp +Napi::ObjectReference::ObjectReference(); +``` + +Returns a new _empty_ `Napi::ObjectReference` instance. + +### Constructor + +```cpp +Napi::ObjectReference::ObjectReference(napi_env env, napi_value value); +``` + +* `[in] env`: The `napi_env` environment in which to construct the `Napi::ObjectReference` object. + +* `[in] value`: The N-API primitive value to be held by the `Napi::ObjectReference`. + +Returns the newly created reference. + +### Set +```cpp +void Napi::ObjectReference::Set(___ key, ___ value); +``` + +* `[in] key`: The name for the property being assigned. + +* `[in] value`: The value being assigned to the property. + +The `key` can be any of the following types: +- `const char*` +- `const std::string` +- `uint32_t` + +The `value` can be any of the following types: +- `napi_value` +- `Napi::Value` +- `const char*` +- `bool` +- `double` + +### Get + +```cpp +Napi::Value Napi::ObjectReference::Get(___ key); +``` + +* `[in] key`: The name of the property to return the value for. + +Returns the [`Napi::Value`](value.md) associated with the key property. Returns NULL if no such key exists. + +The `key` can be any of the following types: +- `const char*` +- `const std::string` +- `uint32_t` + diff --git a/node_modules/node-addon-api/doc/object_wrap.md b/node_modules/node-addon-api/doc/object_wrap.md new file mode 100644 index 0000000..1db658a --- /dev/null +++ b/node_modules/node-addon-api/doc/object_wrap.md @@ -0,0 +1,557 @@ +# Object Wrap + +The `Napi::ObjectWrap` class is used to bind the lifetime of C++ code to a +JavaScript object. Once bound, each time an instance of the JavaScript object +is created, an instance of the C++ class will also be created. When a method +is called on the JavaScript object which is defined as an InstanceMethod, the +corresponding C++ method on the wrapped C++ class will be invoked. + +In order to create a wrapper it's necessary to extend the +`Napi::ObjectWrap`class which contains all the plumbing to connect JavaScript code +with a C++ object. Classes extending `Napi::ObjectWrap` can be instantiated from +JavaScript using the **new** operator, and their methods can be directly invoked +from JavaScript. The **wrap** word refers to a way of grouping methods and state +of the class because it will be necessary write custom code to bridge each of +your C++ class methods. + +## Example + +```cpp +#include <napi.h> + +class Example : public Napi::ObjectWrap<Example> { + public: + static Napi::Object Init(Napi::Env env, Napi::Object exports); + Example(const Napi::CallbackInfo &info); + + private: + static Napi::FunctionReference constructor; + double _value; + Napi::Value GetValue(const Napi::CallbackInfo &info); + Napi::Value SetValue(const Napi::CallbackInfo &info); +}; + +Napi::Object Example::Init(Napi::Env env, Napi::Object exports) { + // This method is used to hook the accessor and method callbacks + Napi::Function func = DefineClass(env, "Example", { + InstanceMethod("GetValue", &Example::GetValue), + InstanceMethod("SetValue", &Example::SetValue) + }); + + // Create a peristent reference to the class constructor. This will allow + // a function called on a class prototype and a function + // called on instance of a class to be distinguished from each other. + constructor = Napi::Persistent(func); + // Call the SuppressDestruct() method on the static data prevent the calling + // to this destructor to reset the reference when the environment is no longer + // available. + constructor.SuppressDestruct(); + exports.Set("Example", func); + return exports; +} + +Example::Example(const Napi::CallbackInfo &info) : Napi::ObjectWrap<Example>(info) { + Napi::Env env = info.Env(); + // ... + Napi::Number value = info[0].As<Napi::Number>(); + this->_value = value.DoubleValue(); +} + +Napi::FunctionReference Example::constructor; + +Napi::Value Example::GetValue(const Napi::CallbackInfo &info){ + Napi::Env env = info.Env(); + return Napi::Number::New(env, this->_value); +} + +Napi::Value Example::SetValue(const Napi::CallbackInfo &info){ + Napi::Env env = info.Env(); + // ... + Napi::Number value = info[0].As<Napi::Number>(); + this->_value = value.DoubleValue(); + return this->GetValue(info); +} + +// Initialize native add-on +Napi::Object Init (Napi::Env env, Napi::Object exports) { + Example::Init(env, exports); + return exports; +} + +// Register and initialize native add-on +NODE_API_MODULE(NODE_GYP_MODULE_NAME, Init) +``` + +The above code can be used from JavaScript as follows: + +```js +'use strict' + +const { Example } = require('bindings')('addon') + +const example = new Example(11) +console.log(example.GetValue()) +// It prints 11 +example.SetValue(19) +console.log(example.GetValue()); +// It prints 19 +``` + +At initialization time, the `Napi::ObjectWrap::DefineClass()` method must be used +to hook up the accessor and method callbacks. It takes a list of property +descriptors, which can be constructed via the various static methods on the base +class. + +When JavaScript code invokes the constructor, the constructor callback will create +a new C++ instance and "wrap" it into the newly created JavaScript object. + +When JavaScript code invokes a method or a property accessor on the class the +corresponding C++ callback function will be executed. + +For a wrapped object it could be difficult to distinguish between a function called +on a class prototype and a function called on instance of a class. Therefore it is +good practice to save a persistent reference to the class constructor. This allows +the two cases to be distinguished from each other by checking the this object +against the class constructor. + +## Methods + +### Constructor + +Creates a new instance of a JavaScript object that wraps native instance. + +```cpp +Napi::ObjectWrap(const Napi::CallbackInfo& callbackInfo); +``` + +- `[in] callbackInfo`: The object representing the components of the JavaScript +request being made. + +### Unwrap + +Retrieves a native instance wrapped in a JavaScript object. + +```cpp +static T* Napi::ObjectWrap::Unwrap(Napi::Object wrapper); +``` + +* `[in] wrapper`: The JavaScript object that wraps the native instance. + +Returns a native instace wrapped in a JavaScript object. Given the +Napi:Object, this allows a method to get a pointer to the wrapped +C++ object and then reference fields, call methods, etc. within that class. +In many cases calling Unwrap is not required, as methods can +use the `this` field for ObjectWrap when running in a method on a +class that extends ObjectWrap. + +### DefineClass + +Defnines a JavaScript class with constructor, static and instance properties and +methods. + +```cpp +static Napi::Function Napi::ObjectWrap::DefineClass(Napi::Env env, + const char* utf8name, + const std::initializer_list<PropertyDescriptor>& properties, + void* data = nullptr); +``` + +* `[in] env`: The environment in which to construct a JavaScript class. +* `[in] utf8name`: Null-terminated string that represents the name of the +JavaScript constructor function. +* `[in] properties`: Initializer list of class property descriptor describing +static and instance properties and methods of the class. +See: [`Class property and descriptor`](class_property_descriptor.md). +* `[in] data`: User-provided data passed to the constructor callback as `data` +property of the `Napi::CallbackInfo`. + +Returns a `Napi::Function` representing the constructor function for the class. + +### DefineClass + +Defnines a JavaScript class with constructor, static and instance properties and +methods. + +```cpp +static Napi::Function Napi::ObjectWrap::DefineClass(Napi::Env env, + const char* utf8name, + const std::vector<PropertyDescriptor>& properties, + void* data = nullptr); +``` + +* `[in] env`: The environment in which to construct a JavaScript class. +* `[in] utf8name`: Null-terminated string that represents the name of the +JavaScript constructor function. +* `[in] properties`: Vector of class property descriptor describing static and +instance properties and methods of the class. +See: [`Class property and descriptor`](class_property_descriptor.md). +* `[in] data`: User-provided data passed to the constructor callback as `data` +property of the `Napi::CallbackInfo`. + +Returns a `Napi::Function` representing the constructor function for the class. + +### Finalize + +Provides an opportunity to run cleanup code that requires access to the `Napi::Env` +before the wrapped native object instance is freed. Override to implement. + +```cpp +virtual void Finalize(Napi::Env env); +``` + +- `[in] env`: `Napi::Env`. + +### StaticMethod + +Creates property descriptor that represents a static method of a JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::StaticMethod(const char* utf8name, + StaticVoidMethodCallback method, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] utf8name`: Null-terminated string that represents the name of a static +method for the class. +- `[in] method`: The native function that represents a static method of a +JavaScript class. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into method when it is invoked. + +Returns `Napi::PropertyDescriptor` object that represents the static method of a +JavaScript class. + +### StaticMethod + +Creates property descriptor that represents a static method of a JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::StaticMethod(const char* utf8name, + StaticMethodCallback method, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] utf8name`: Null-terminated string that represents the name of a static +method for the class. +- `[in] method`: The native function that represents a static method of a +JavaScript class. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into method when it is invoked. + +Returns `Napi::PropertyDescriptor` object that represents a static method of a +JavaScript class. + +### StaticMethod + +Creates property descriptor that represents a static method of a JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::StaticMethod(Symbol name, + StaticVoidMethodCallback method, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] name`: Napi:Symbol that represents the name of a static +method for the class. +- `[in] method`: The native function that represents a static method of a +JavaScript class. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into method when it is invoked. + +Returns `Napi::PropertyDescriptor` object that represents the static method of a +JavaScript class. + +### StaticMethod + +Creates property descriptor that represents a static method of a JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::StaticMethod(Symbol name, + StaticMethodCallback method, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +method for the class. +- `[in] name`: Napi:Symbol that represents the name of a static. +- `[in] method`: The native function that represents a static method of a +JavaScript class. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into method when it is invoked. + +Returns `Napi::PropertyDescriptor` object that represents a static method of a +JavaScript class. + +### StaticAccessor + +Creates property descriptor that represents a static accessor property of a +JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::StaticAccessor(const char* utf8name, + StaticGetterCallback getter, + StaticSetterCallback setter, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] utf8name`: Null-terminated string that represents the name of a static +accessor property for the class. +- `[in] getter`: The native function to call when a get access to the property of +a JavaScript class is performed. +- `[in] setter`: The native function to call when a set access to the property of +a JavaScript class is performed. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into getter or setter when +is invoked. + +Returns `Napi::PropertyDescriptor` object that represents a static accessor +property of a JavaScript class. + +### StaticAccessor + +Creates property descriptor that represents a static accessor property of a +JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::StaticAccessor(Symbol name, + StaticGetterCallback getter, + StaticSetterCallback setter, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] name`: Napi:Symbol that represents the name of a static accessor. +- `[in] getter`: The native function to call when a get access to the property of +a JavaScript class is performed. +- `[in] setter`: The native function to call when a set access to the property of +a JavaScript class is performed. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into getter or setter when +is invoked. + +Returns `Napi::PropertyDescriptor` object that represents a static accessor +property of a JavaScript class. + +### InstanceMethod + +Creates property descriptor that represents an instance method of a JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::InstanceMethod(const char* utf8name, + InstanceVoidMethodCallback method, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] utf8name`: Null-terminated string that represents the name of an instance +method for the class. +- `[in] method`: The native function that represents an instance method of a +JavaScript class. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into method when it is invoked. + +Returns `Napi::PropertyDescriptor` object that represents an instance method of a +JavaScript class. + +### InstanceMethod + +Creates property descriptor that represents an instance method of a JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::InstanceMethod(const char* utf8name, + InstanceMethodCallback method, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] utf8name`: Null-terminated string that represents the name of an instance +method for the class. +- `[in] method`: The native function that represents an instance method of a +JavaScript class. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into method when it is invoked. + +Returns `Napi::PropertyDescriptor` object that represents an instance method of a +JavaScript class. + +### InstanceMethod + +Creates property descriptor that represents an instance method of a JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::InstanceMethod(Napi::Symbol name, + InstanceVoidMethodCallback method, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] name`: The `Napi::Symbol` object whose value is used to identify the +instance method for the class. +- `[in] method`: The native function that represents an instance method of a +JavaScript class. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into method when it is invoked. + +Returns `Napi::PropertyDescriptor` object that represents an instance method of a +JavaScript class. + +### InstanceMethod + +Creates property descriptor that represents an instance method of a JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::InstanceMethod(Napi::Symbol name, + InstanceMethodCallback method, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] name`: The `Napi::Symbol` object whose value is used to identify the +instance method for the class. +- `[in] method`: The native function that represents an instance method of a +JavaScript class. +- `[in] attributes`: The attributes associated with a particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into method when it is invoked. + +Returns `Napi::PropertyDescriptor` object that represents an instance method of a +JavaScript class. + +### InstanceAccessor + +Creates property descriptor that represents an instance accessor property of a +JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::InstanceAccessor(const char* utf8name, + InstanceGetterCallback getter, + InstanceSetterCallback setter, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] utf8name`: Null-terminated string that represents the name of an instance +accessor property for the class. +- `[in] getter`: The native function to call when a get access to the property of +a JavaScript class is performed. +- `[in] setter`: The native function to call when a set access to the property of +a JavaScript class is performed. +- `[in] attributes`: The attributes associated with the particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into getter or setter when this is invoked. + +Returns `Napi::PropertyDescriptor` object that represents an instance accessor +property of a JavaScript class. + +### InstanceAccessor + +Creates property descriptor that represents an instance accessor property of a +JavaScript class. + +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::InstanceAccessor(Symbol name, + InstanceGetterCallback getter, + InstanceSetterCallback setter, + napi_property_attributes attributes = napi_default, + void* data = nullptr); +``` + +- `[in] name`: The `Napi::Symbol` object whose value is used to identify the +instance accessor. +- `[in] getter`: The native function to call when a get access to the property of +a JavaScript class is performed. +- `[in] setter`: The native function to call when a set access to the property of +a JavaScript class is performed. +- `[in] attributes`: The attributes associated with the particular property. +One or more of `napi_property_attributes`. +- `[in] data`: User-provided data passed into getter or setter when this is invoked. + +Returns `Napi::PropertyDescriptor` object that represents an instance accessor +property of a JavaScript class. + +### StaticValue + +Creates property descriptor that represents an static value property of a +JavaScript class. +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::StaticValue(const char* utf8name, + Napi::Value value, + napi_property_attributes attributes = napi_default); +``` + +- `[in] utf8name`: Null-terminated string that represents the name of the static +property. +- `[in] value`: The value that's retrieved by a get access of the property. +- `[in] attributes`: The attributes to be associated with the property in addition +to the napi_static attribute. One or more of `napi_property_attributes`. + +Returns `Napi::PropertyDescriptor` object that represents an static value +property of a JavaScript class + +### StaticValue + +Creates property descriptor that represents an static value property of a +JavaScript class. +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::StaticValue(Symbol name, + Napi::Value value, + napi_property_attributes attributes = napi_default); +``` + +- `[in] name`: The `Napi::Symbol` object whose value is used to identify the +name of the static property. +- `[in] value`: The value that's retrieved by a get access of the property. +- `[in] attributes`: The attributes to be associated with the property in addition +to the napi_static attribute. One or more of `napi_property_attributes`. + +Returns `Napi::PropertyDescriptor` object that represents an static value +property of a JavaScript class + +### InstanceValue + +Creates property descriptor that represents an instance value property of a +JavaScript class. +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::InstanceValue(const char* utf8name, + Napi::Value value, + napi_property_attributes attributes = napi_default); +``` + +- `[in] utf8name`: Null-terminated string that represents the name of the property. +- `[in] value`: The value that's retrieved by a get access of the property. +- `[in] attributes`: The attributes to be associated with the property. +One or more of `napi_property_attributes`. + +Returns `Napi::PropertyDescriptor` object that represents an instance value +property of a JavaScript class. + +### InstanceValue + +Creates property descriptor that represents an instance value property of a +JavaScript class. +```cpp +static Napi::PropertyDescriptor Napi::ObjectWrap::InstanceValue(Symbol name, + Napi::Value value, + napi_property_attributes attributes = napi_default); +``` + +- `[in] name`: The `Napi::Symbol` object whose value is used to identify the +name of the property. +- `[in] value`: The value that's retrieved by a get access of the property. +- `[in] attributes`: The attributes to be associated with the property. +One or more of `napi_property_attributes`. + +Returns `Napi::PropertyDescriptor` object that represents an instance value diff --git a/node_modules/node-addon-api/doc/prebuild_tools.md b/node_modules/node-addon-api/doc/prebuild_tools.md new file mode 100644 index 0000000..573af68 --- /dev/null +++ b/node_modules/node-addon-api/doc/prebuild_tools.md @@ -0,0 +1,16 @@ +# Prebuild tools + +The distribution of a native add-on is just as important as its implementation. +In order to install a native add-on it's important to have all the necessary +dependencies installed and well configured (see the [setup](setup.md) section). +The end-user will need to compile the add-on when they will do an `npm install` +and in some cases this could create problems. To avoid the compilation process it's +possible to ditribute the native add-on in pre-built form for different platform +and architectures. The prebuild tools help to create and distrubute the pre-built +form of a native add-on. + +The following list report known tools that are compatible with **N-API**: + +- **[node-pre-gyp](https://www.npmjs.com/package/node-pre-gyp)** +- **[prebuild](https://www.npmjs.com/package/prebuild)** +- **[prebuildify](https://www.npmjs.com/package/prebuildify)** diff --git a/node_modules/node-addon-api/doc/promises.md b/node_modules/node-addon-api/doc/promises.md new file mode 100644 index 0000000..6252900 --- /dev/null +++ b/node_modules/node-addon-api/doc/promises.md @@ -0,0 +1,74 @@ +# Promise + +The `Napi::Promise` class, along with its `Napi::Promise::Deferred` class, implement the ability to create, resolve, and reject Promise objects. + +The basic approach is to create a `Napi::Promise::Deferred` object and return to your caller the value returned by the `Napi::Promise::Deferred::Promise` method. For example: + +```cpp +Napi::Value YourFunction(const Napi::CallbackInfo& info) { + // your code goes here... + Napi::Promise::Deferred deferred = Napi::Promise::Deferred::New(info.Env()); + // deferred needs to survive this call... + return deferred.Promise(); +} +``` + +Later, when the asynchronous process completes, call either the `Resolve` or `Reject` method on the `Napi::Promise::Deferred` object created earlier: + +```cpp + deferred.Resolve(String::New(info.Env(), "OK")); +``` + +## Promise::Deferred Methods + +### Factory Method + +```cpp +static Napi::Promise::Deferred Napi::Promise::Deferred::New(napi_env env); +``` + +* `[in] env`: The `napi_env` environment in which to create the `Napi::Promise::Deferred` object. + +### Constructor + +```cpp +Napi::Promise::Deferred(napi_env env); +``` + +* `[in] env`: The `napi_env` environment in which to construct the `Napi::Promise::Deferred` object. + +### Env + +```cpp +Napi::Env Napi::Promise::Deferred::Env() const; +``` + +Returns the Env environment this `Napi::Promise::Deferred` object is associated with. + +### Promise + +```cpp +Napi::Promise Napi::Promise::Deferred::Promise() const; +``` + +Returns the `Napi::Promise` object held by the `Napi::Promise::Deferred` object. + +### Resolve + +```cpp +void Napi::Promise::Deferred::Resolve(napi_value value) const; +``` + +Resolves the `Napi::Promise` object held by the `Napi::Promise::Deferred` object. + +* `[in] value`: The N-API primitive value with which to resolve the `Napi::Promise`. + +### Reject + +```cpp +void Napi::Promise::Deferred::Reject(napi_value value) const; +``` + +Rejects the Promise object held by the `Napi::Promise::Deferred` object. + +* `[in] value`: The N-API primitive value with which to reject the `Napi::Promise`. diff --git a/node_modules/node-addon-api/doc/property_descriptor.md b/node_modules/node-addon-api/doc/property_descriptor.md new file mode 100644 index 0000000..324b62f --- /dev/null +++ b/node_modules/node-addon-api/doc/property_descriptor.md @@ -0,0 +1,231 @@ +# Property Descriptor + +A [`Napi::Object`](object.md) can be assigned properites via its [`DefineProperty`](object.md#defineproperty) and [`DefineProperties`](object.md#defineproperties) functions, which take PropertyDescrptor(s) as their parameters. The `Napi::PropertyDescriptor` can contain either values or functions, which are then assigned to the `Napi::Object`. Note that a single instance of a `Napi::PropertyDescriptor` class can only contain either one value, or at most two functions. PropertyDescriptors can only be created through the class methods [`Accessor`](#accessor), [`Function`](#function), or [`Value`](#value), each of which return a new static instance of a `Napi::PropertyDescriptor`. + +## Example + +```cpp +#include <napi.h> + +using namespace Napi; + +Value TestGetter(const CallbackInfo& info) { + return Boolean::New(info.Env(), testValue); +} + +void TestSetter(const CallbackInfo& info) { + testValue = info[0].As<Boolean>(); +} + +Value TestFunction(const CallbackInfo& info) { + return Boolean::New(info.Env(), true); +} + +Void Init(Env env) { + // Create an object. + Object obj = Object::New(env); + + // Accessor + PropertyDescriptor pd1 = PropertyDescriptor::Accessor(env, + obj, + "pd1", + TestGetter); + PropertyDescriptor pd2 = PropertyDescriptor::Accessor(env, + obj, + "pd2", + TestGetter, + TestSetter); + // Function + PropertyDescriptor pd3 = PropertyDescriptor::Function(env, + "function", + TestFunction); + // Value + Boolean true_bool = Boolean::New(env, true); + PropertyDescriptor pd4 = + PropertyDescriptor::Value("boolean value", + Napi::Boolean::New(env, true), + napi_writable); + + // Assign properties to the object. + obj.DefineProperties({pd1, pd2, pd3, pd4}); +} +``` + +## Methods + +### Constructor + +```cpp +Napi::PropertyDescriptor::PropertyDescriptor (napi_property_descriptor desc); +``` + +* `[in] desc`: A PropertyDescriptor that is needed in order to create another PropertyDescriptor. + +### Accessor + +```cpp +static Napi::PropertyDescriptor Napi::PropertyDescriptor::Accessor (___ name, + Getter getter, + napi_property_attributes attributes = napi_default, + void *data = nullptr); +``` + +* `[in] name`: The name used for the getter function. +* `[in] getter`: A getter function. +* `[in] attributes`: Potential attributes for the getter function. +* `[in] data`: A pointer to data of any type, default is a null pointer. + +Returns a PropertyDescriptor that contains a function. + +The name of the property can be any of the following types: +- `const char*` +- `const std::string &` +- `napi_value value` +- `Napi::Name` + +**This signature is deprecated. It will result in a memory leak if used.** + +```cpp +static Napi::PropertyDescriptor Napi::PropertyDescriptor::Accessor ( + Napi::Env env, + Napi::Object object, + ___ name, + Getter getter, + napi_property_attributes attributes = napi_default, + void *data = nullptr); +``` + +* `[in] env`: The environemnt in which to create this accessor. +* `[in] object`: The object on which the accessor will be defined. +* `[in] name`: The name used for the getter function. +* `[in] getter`: A getter function. +* `[in] attributes`: Potential attributes for the getter function. +* `[in] data`: A pointer to data of any type, default is a null pointer. + +Returns a `Napi::PropertyDescriptor` that contains a `Getter` accessor. + +The name of the property can be any of the following types: +- `const char*` +- `const std::string &` +- `Napi::Name` + +```cpp +static Napi::PropertyDescriptor Napi::PropertyDescriptor::Accessor (___ name, + Getter getter, + Setter setter, + napi_property_attributes attributes = napi_default, + void *data = nullptr); +``` + +* `[in] name`: The name of the getter and setter function. +* `[in] getter`: The getter function. +* `[in] setter`: The setter function. +* `[in] attributes`: Potential attributes for the getter function. +* `[in] data`: A pointer to data of any type, default is a null pointer. + +Returns a `Napi::PropertyDescriptor` that contains a `Getter` and `Setter` function. + +The name of the property can be any of the following types: +- `const char*` +- `const std::string &` +- `napi_value value` +- `Napi::Name` + +**This signature is deprecated. It will result in a memory leak if used.** + +```cpp +static Napi::PropertyDescriptor Napi::PropertyDescriptor::Accessor ( + Napi::Env env, + Napi::Object object, + ___ name, + Getter getter, + Setter setter, + napi_property_attributes attributes = napi_default, + void *data = nullptr); +``` + +* `[in] env`: The environemnt in which to create this accessor. +* `[in] object`: The object on which the accessor will be defined. +* `[in] name`: The name of the getter and setter function. +* `[in] getter`: The getter function. +* `[in] setter`: The setter function. +* `[in] attributes`: Potential attributes for the getter function. +* `[in] data`: A pointer to data of any type, default is a null pointer. + +Returns a `Napi::PropertyDescriptor` that contains a `Getter` and `Setter` function. + +The name of the property can be any of the following types: +- `const char*` +- `const std::string &` +- `Napi::Name` + +### Function + +```cpp +static Napi::PropertyDescriptor Napi::PropertyDescriptor::Function (___ name, + Callable cb, + napi_property_attributes attributes = napi_default, + void *data = nullptr); +``` + +* `[in] name`: The name of the Callable function. +* `[in] cb`: The function +* `[in] attributes`: Potential attributes for the getter function. +* `[in] data`: A pointer to data of any type, default is a null pointer. + +Returns a `Napi::PropertyDescriptor` that contains a callable `Napi::Function`. + +The name of the property can be any of the following types: +- `const char*` +- `const std::string &` +- `napi_value value` +- `Napi::Name` + +**This signature is deprecated. It will result in a memory leak if used.** + +```cpp +static Napi::PropertyDescriptor Napi::PropertyDescriptor::Function ( + Napi::Env env, + ___ name, + Callable cb, + napi_property_attributes attributes = napi_default, + void *data = nullptr); +``` + +* `[in] env`: The environment in which to create this accessor. +* `[in] name`: The name of the Callable function. +* `[in] cb`: The function +* `[in] attributes`: Potential attributes for the getter function. +* `[in] data`: A pointer to data of any type, default is a null pointer. + +Returns a `Napi::PropertyDescriptor` that contains a callable `Napi::Function`. + +The name of the property can be any of the following types: +- `const char*` +- `const std::string &` +- `Napi::Name` + +### Value + +```cpp +static Napi::PropertyDescriptor Napi::PropertyDescriptor::Value (___ name, + napi_value value, + napi_property_attributes attributes = napi_default); +``` + +The name of the property can be any of the following types: +- `const char*` +- `const std::string &` +- `napi_value value` +- `Napi::Name` + +## Related Information + +### napi\_property\_attributes +`napi_property_attributes` are flags used to indicate to JavaScript certain permissions that the property is meant to have. The following are the flag options: +- napi\_default, +- napi\_writable, +- napi\_enumerable, +- napi\_configurable +For more information on the flags and on napi\_property\_attributes, please read the documentation [here](https://github.com/nodejs/node/blob/master/doc/api/n-api.md#napi_property_attributes). + diff --git a/node_modules/node-addon-api/doc/range_error.md b/node_modules/node-addon-api/doc/range_error.md new file mode 100644 index 0000000..e134a40 --- /dev/null +++ b/node_modules/node-addon-api/doc/range_error.md @@ -0,0 +1,59 @@ +# RangeError + +The `Napi::RangeError` class is a representation of the JavaScript `RangeError` that is +thrown when trying to pass a value as an argument to a function that does not allow +a range that includes the value. + +The `Napi::RangeError` class inherits its behaviors from the `Napi::Error` class (for +more info see: [`Napi::Error`](error.md)). + +For more details about error handling refer to the section titled [Error handling](error_handling.md). + +## Methods + +### New + +Creates a new instance of a `Napi::RangeError` object. + +```cpp +Napi::RangeError::New(Napi::Env env, const char* message); +``` + +- `[in] Env`: The environment in which to construct the `Napi::RangeError` object. +- `[in] message`: Null-terminated string to be used as the message for the `Napi::RangeError`. + +Returns an instance of a `Napi::RangeError` object. + +### New + +Creates a new instance of a `Napi::RangeError` object. + +```cpp +Napi::RangeError::New(Napi::Env env, const std::string& message); +``` + +- `[in] Env`: The environment in which to construct the `Napi::RangeError` object. +- `[in] message`: Reference string to be used as the message for the `Napi::RangeError`. + +Returns an instance of a `Napi::RangeError` object. + +### Constructor + +Creates a new empty instance of a `Napi::RangeError`. + +```cpp +Napi::RangeError::RangeError(); +``` + +### Constructor + +Initializes a `Napi::RangeError` instance from an existing Javascript error object. + +```cpp +Napi::RangeError::RangeError(napi_env env, napi_value value); +``` + +- `[in] Env`: The environment in which to construct the `Napi::RangeError` object. +- `[in] value`: The `Napi::Error` reference to wrap. + +Returns an instance of a `Napi::RangeError` object. diff --git a/node_modules/node-addon-api/doc/reference.md b/node_modules/node-addon-api/doc/reference.md new file mode 100644 index 0000000..108c009 --- /dev/null +++ b/node_modules/node-addon-api/doc/reference.md @@ -0,0 +1,111 @@ +# Reference (template) + +Holds a counted reference to a [`Napi::Value`](value.md) object; initially a weak reference unless otherwise specified, may be changed to/from a strong reference by adjusting the refcount. + +The referenced `Napi::Value` is not immediately destroyed when the reference count is zero; it is merely then eligible for garbage-collection if there are no other references to the `Napi::Value`. + +`Napi::Reference` objects allocated in static space, such as a global static instance, must call the `SuppressDestruct` method to prevent its destructor, running at program shutdown time, from attempting to reset the reference when the environment is no longer valid. + +The following classes inherit, either directly or indirectly, from `Napi::Reference`: + +* [`Napi::ObjectWrap`](object_wrap.md) +* [`Napi::ObjectReference`](object_reference.md) +* [`Napi::FunctionReference`](function_reference.md) + +## Methods + +### Factory Method + +```cpp +static Napi::Reference<T> Napi::Reference::New(const T& value, uint32_t initialRefcount = 0); +``` + +* `[in] value`: The value which is to be referenced. + +* `[in] initialRefcount`: The initial reference count. + +### Empty Constructor + +```cpp +Napi::Reference::Reference(); +``` + +Creates a new _empty_ `Napi::Reference` instance. + +### Constructor + +```cpp +Napi::Reference::Reference(napi_env env, napi_value value); +``` + +* `[in] env`: The `napi_env` environment in which to construct the `Napi::Reference` object. + +* `[in] value`: The N-API primitive value to be held by the `Napi::Reference`. + +### Env + +```cpp +Napi::Env Napi::Reference::Env() const; +``` + +Returns the `Napi::Env` value in which the `Napi::Reference` was instantiated. + +### IsEmpty + +```cpp +bool Napi::Reference::IsEmpty() const; +``` + +Determines whether the value held by the `Napi::Reference` is empty. + +### Value + +```cpp +T Napi::Reference::Value() const; +``` + +Returns the value held by the `Napi::Reference`. + +### Ref + +```cpp +uint32_t Napi::Reference::Ref(); +``` + +Increments the reference count for the `Napi::Reference` and returns the resulting reference count. Throws an error if the increment fails. + +### Unref + +```cpp +uint32_t Napi::Reference::Unref(); +``` + +Decrements the reference count for the `Napi::Reference` and returns the resulting reference count. Throws an error if the decrement fails. + +### Reset (Empty) + +```cpp +void Napi::Reference::Reset(); +``` + +Sets the value held by the `Napi::Reference` to be empty. + +### Reset + +```cpp +void Napi::Reference::Reset(const T& value, uint32_t refcount = 0); +``` + +* `[in] value`: The value which is to be referenced. + +* `[in] initialRefcount`: The initial reference count. + +Sets the value held by the `Napi::Reference`. + +### SuppressDestruct + +```cpp +void Napi::Reference::SuppressDestruct(); +``` + +Call this method on a `Napi::Reference` that is declared as static data to prevent its destructor, running at program shutdown time, from attempting to reset the reference when the environment is no longer valid. diff --git a/node_modules/node-addon-api/doc/setup.md b/node_modules/node-addon-api/doc/setup.md new file mode 100644 index 0000000..3135bf1 --- /dev/null +++ b/node_modules/node-addon-api/doc/setup.md @@ -0,0 +1,82 @@ +# Setup + +## Prerequisites + +Before starting to use **N-API** you need to assure you have the following +prerequisites: + +* **Node.JS** see: [Installing Node.js](https://nodejs.org/) + +* **Node.js native addon build tool** + + - **[node-gyp](node-gyp.md)** + +## Installation and usage + +To use **N-API** in a native module: + + 1. Add a dependency on this package to `package.json`: + +```json + "dependencies": { + "node-addon-api": "*", + } +``` + + 2. Reference this package's include directory and gyp file in `binding.gyp`: + +```gyp + 'include_dirs': ["<!@(node -p \"require('node-addon-api').include\")"], + 'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"], +``` + + 3. Decide whether the package will enable C++ exceptions in the N-API wrapper. + The base ABI-stable C APIs do not throw or handle C++ exceptions, but the + N-API C++ wrapper classes may _optionally_ + [integrate C++ and JavaScript exception-handling + ](https://nodejs.github.io/node-addon-api/class_napi_1_1_error.html). + To enable that capability, C++ exceptions must be enabled in `binding.gyp`: + +```gyp + 'cflags!': [ '-fno-exceptions' ], + 'cflags_cc!': [ '-fno-exceptions' ], + 'xcode_settings': { + 'GCC_ENABLE_CPP_EXCEPTIONS': 'YES', + 'CLANG_CXX_LIBRARY': 'libc++', + 'MACOSX_DEPLOYMENT_TARGET': '10.7', + }, + 'msvs_settings': { + 'VCCLCompilerTool': { 'ExceptionHandling': 1 }, + }, +``` + + Alternatively, disable use of C++ exceptions in N-API: + +```gyp + 'defines': [ 'NAPI_DISABLE_CPP_EXCEPTIONS' ], +``` + 4. If you would like your native addon to support OSX, please also add the + following settings in the `binding.gyp` file: + + ```gyp + ['OS=="mac"', { + 'cflags+': ['-fvisibility=hidden'], + 'xcode_settings': { + 'GCC_SYMBOLS_PRIVATE_EXTERN': 'YES', # -fvisibility=hidden + } + }] + ``` + + 5. Include `napi.h` in the native module code. + To ensure only ABI-stable APIs are used, DO NOT include + `node.h`, `nan.h`, or `v8.h`. + +```C++ +#include "napi.h" +``` + +At build time, the N-API back-compat library code will be used only when the +targeted node version *does not* have N-API built-in. + +The preprocessor directive `NODE_ADDON_API_DISABLE_DEPRECATED` can be defined at +compile time before including `napi.h` to skip the definition of deprecated APIs. diff --git a/node_modules/node-addon-api/doc/string.md b/node_modules/node-addon-api/doc/string.md new file mode 100644 index 0000000..bf78ac7 --- /dev/null +++ b/node_modules/node-addon-api/doc/string.md @@ -0,0 +1,89 @@ +# String + +## Constructor + +```cpp +Napi::String::String(); +``` + +Returns a new **empty** `Napi::String` instance. + +If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not +being used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +```cpp +Napi::String::String(napi_env env, napi_value value); ///< Wraps a N-API value primitive. +``` +- `[in] env` - The environment in which to create the string. +- `[in] value` - The primitive to wrap. + +Returns a `Napi::String` wrapping a `napi_value`. + +If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not +being used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +## Operators + +### operator std::string + +```cpp +Napi::String::operator std::string() const; +``` + +Returns a UTF-8 encoded C++ string. + +### operator std::u16string +```cpp +Napi::String::operator std::u16string() const; +``` + +Returns a UTF-16 encoded C++ string. + +## Methods + +### New +```cpp +Napi::String::New(); +``` + +Returns a new empty `Napi::String`. + +### New +```cpp +Napi::String::New(napi_env env, const std::string& value); +Napi::String::New(napi_env env, const std::u16::string& value); +Napi::String::New(napi_env env, const char* value); +Napi::String::New(napi_env env, const char16_t* value); +Napi::String::New(napi_env env, const char* value, size_t length); +Napi::String::New(napi_env env, const char16_t* value, size_t length); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Value` object. +- `[in] value`: The C++ primitive from which to instantiate the `Napi::Value`. `value` may be any of: + - `std::string&` - represents an ANSI string. + - `std::u16string&` - represents a UTF16-LE string. + - `const char*` - represents a UTF8 string. + - `const char16_t*` - represents a UTF16-LE string. +- `[in] length`: The length of the string (not necessarily null-terminated) in code units. + +Returns a new `Napi::String` that represents the passed in C++ string. + +If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not +being used, callers should check the result of `Env::IsExceptionPending` before +attempting to use the returned value. + +### Utf8Value +```cpp +std::string Napi::String::Utf8Value() const; +``` + +Returns a UTF-8 encoded C++ string. + +### Utf16Value +```cpp +std::u16string Napi::String::Utf16Value() const; +``` + +Returns a UTF-16 encoded C++ string. diff --git a/node_modules/node-addon-api/doc/symbol.md b/node_modules/node-addon-api/doc/symbol.md new file mode 100644 index 0000000..13abe3e --- /dev/null +++ b/node_modules/node-addon-api/doc/symbol.md @@ -0,0 +1,44 @@ +# Symbol + +## Methods + +### Constructor + +Instantiates a new `Napi::Symbol` value. + +```cpp +Napi::Symbol::Symbol(); +``` + +Returns a new empty `Napi::Symbol`. + +### New +```cpp +Napi::Symbol::New(napi_env env, const std::string& description); +Napi::Symbol::New(napi_env env, const char* description); +Napi::Symbol::New(napi_env env, Napi::String description); +Napi::Symbol::New(napi_env env, napi_value description); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Symbol` object. +- `[in] value`: The C++ primitive which represents the description hint for the `Napi::Symbol`. + `description` may be any of: + - `std::string&` - ANSI string description. + - `const char*` - represents a UTF8 string description. + - `String` - Node addon API String description. + - `napi_value` - N-API `napi_value` description. + +If an error occurs, a `Napi::Error` will get thrown. If C++ exceptions are not +being used, callers should check the result of `Napi::Env::IsExceptionPending` before +attempting to use the returned value. + +### Utf8Value +```cpp +static Napi::Symbol Napi::Symbol::WellKnown(napi_env env, const std::string& name); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Symbol` object. +- `[in] name`: The C++ string representing the `Napi::Symbol` to retrieve. + +Returns a `Napi::Symbol` representing a well-known `Symbol` from the +`Symbol` registry. diff --git a/node_modules/node-addon-api/doc/threadsafe_function.md b/node_modules/node-addon-api/doc/threadsafe_function.md new file mode 100644 index 0000000..2bd8b67 --- /dev/null +++ b/node_modules/node-addon-api/doc/threadsafe_function.md @@ -0,0 +1,320 @@ +# ThreadSafeFunction + +JavaScript functions can normally only be called from a native addon's main +thread. If an addon creates additional threads, then node-addon-api functions +that require a `Napi::Env`, `Napi::Value`, or `Napi::Reference` must not be +called from those threads. + +When an addon has additional threads and JavaScript functions need to be invoked +based on the processing completed by those threads, those threads must +communicate with the addon's main thread so that the main thread can invoke the +JavaScript function on their behalf. The thread-safe function APIs provide an +easy way to do this. + +These APIs provide the type `Napi::ThreadSafeFunction` as well as APIs to +create, destroy, and call objects of this type. +`Napi::ThreadSafeFunction::New()` creates a persistent reference that holds a +JavaScript function which can be called from multiple threads. The calls happen +asynchronously. This means that values with which the JavaScript callback is to +be called will be placed in a queue, and, for each value in the queue, a call +will eventually be made to the JavaScript function. + +`Napi::ThreadSafeFunction` objects are destroyed when every thread which uses +the object has called `Release()` or has received a return status of +`napi_closing` in response to a call to `BlockingCall()` or `NonBlockingCall()`. +The queue is emptied before the `Napi::ThreadSafeFunction` is destroyed. It is +important that `Release()` be the last API call made in conjunction with a given +`Napi::ThreadSafeFunction`, because after the call completes, there is no +guarantee that the `Napi::ThreadSafeFunction` is still allocated. For the same +reason it is also important that no more use be made of a thread-safe function +after receiving a return value of `napi_closing` in response to a call to +`BlockingCall()` or `NonBlockingCall()`. Data associated with the +`Napi::ThreadSafeFunction` can be freed in its `Finalizer` callback which was +passed to `ThreadSafeFunction::New()`. + +Once the number of threads making use of a `Napi::ThreadSafeFunction` reaches +zero, no further threads can start making use of it by calling `Acquire()`. In +fact, all subsequent API calls associated with it, except `Release()`, will +return an error value of `napi_closing`. + +## Methods + +### Constructor + +Creates a new empty instance of `Napi::ThreadSafeFunction`. + +```cpp +Napi::Function::ThreadSafeFunction(); +``` + +### Constructor + +Creates a new instance of the `Napi::ThreadSafeFunction` object. + +```cpp +Napi::ThreadSafeFunction::ThreadSafeFunction(napi_threadsafe_function tsfn); +``` + +- `tsfn`: The `napi_threadsafe_function` which is a handle for an existing + thread-safe function. + +Returns a non-empty `Napi::ThreadSafeFunction` instance. When using this +constructor, only use the `Blocking(void*)` / `NonBlocking(void*)` overloads; +the `Callback` and templated `data*` overloads should _not_ be used. See below +for additional details. + +### New + +Creates a new instance of the `Napi::ThreadSafeFunction` object. The `New` +function has several overloads for the various optional parameters: skip the +optional parameter for that specific overload. + +```cpp +New(napi_env env, + const Function& callback, + const Object& resource, + ResourceString resourceName, + size_t maxQueueSize, + size_t initialThreadCount, + ContextType* context, + Finalizer finalizeCallback, + FinalizerDataType* data); +``` + +- `env`: The `napi_env` environment in which to construct the + `Napi::ThreadSafeFunction` object. +- `callback`: The `Function` to call from another thread. +- `[optional] resource`: An object associated with the async work that will be + passed to possible async_hooks init hooks. +- `resourceName`: A JavaScript string to provide an identifier for the kind of + resource that is being provided for diagnostic information exposed by the + async_hooks API. +- `maxQueueSize`: Maximum size of the queue. `0` for no limit. +- `initialThreadCount`: The initial number of threads, including the main + thread, which will be making use of this function. +- `[optional] context`: Data to attach to the resulting `ThreadSafeFunction`. +- `[optional] finalizeCallback`: Function to call when the `ThreadSafeFunction` + is being destroyed. This callback will be invoked on the main thread when the + thread-safe function is about to be destroyed. It receives the context and the + finalize data given during construction (if given), and provides an + opportunity for cleaning up after the threads e.g. by calling + `uv_thread_join()`. It is important that, aside from the main loop thread, + there be no threads left using the thread-safe function after the finalize + callback completes. Must implement `void operator()(Env env, DataType* data, + Context* hint)`, skipping `data` or `hint` if they are not provided. + Can be retreived via `GetContext()`. +- `[optional] data`: Data to be passed to `finalizeCallback`. + +Returns a non-empty `Napi::ThreadSafeFunction` instance. + +### Acquire + +Add a thread to this thread-safe function object, indicating that a new thread +will start making use of the thread-safe function. + +```cpp +napi_status Napi::ThreadSafeFunction::Acquire() +``` + +Returns one of: +- `napi_ok`: The thread has successfully acquired the thread-safe function +for its use. +- `napi_closing`: The thread-safe function has been marked as closing via a +previous call to `Abort()`. + +### Release + +Indicate that an existing thread will stop making use of the thread-safe +function. A thread should call this API when it stops making use of this +thread-safe function. Using any thread-safe APIs after having called this API +has undefined results in the current thread, as it may have been destroyed. + +```cpp +napi_status Napi::ThreadSafeFunction::Release() +``` + +Returns one of: +- `napi_ok`: The thread-safe function has been successfully released. +- `napi_invalid_arg`: The thread-safe function's thread-count is zero. +- `napi_generic_failure`: A generic error occurred when attemping to release +the thread-safe function. + +### Abort + +"Abort" the thread-safe function. This will cause all subsequent APIs associated +with the thread-safe function except `Release()` to return `napi_closing` even +before its reference count reaches zero. In particular, `BlockingCall` and +`NonBlockingCall()` will return `napi_closing`, thus informing the threads that +it is no longer possible to make asynchronous calls to the thread-safe function. +This can be used as a criterion for terminating the thread. Upon receiving a +return value of `napi_closing` from a thread-safe function call a thread must +make no further use of the thread-safe function because it is no longer +guaranteed to be allocated. + +```cpp +napi_status Napi::ThreadSafeFunction::Abort() +``` + +Returns one of: +- `napi_ok`: The thread-safe function has been successfully aborted. +- `napi_invalid_arg`: The thread-safe function's thread-count is zero. +- `napi_generic_failure`: A generic error occurred when attemping to abort +the thread-safe function. + +### BlockingCall / NonBlockingCall + +Calls the Javascript function in either a blocking or non-blocking fashion. +- `BlockingCall()`: the API blocks until space becomes available in the queue. + Will never block if the thread-safe function was created with a maximum queue + size of `0`. +- `NonBlockingCall()`: will return `napi_queue_full` if the queue was full, + preventing data from being successfully added to the queue. + +There are several overloaded implementations of `BlockingCall()` and +`NonBlockingCall()` for use with optional parameters: skip the optional +parameter for that specific overload. + +**These specific function overloads should only be used on a `ThreadSafeFunction` +created via `ThreadSafeFunction::New`.** + +```cpp +napi_status Napi::ThreadSafeFunction::BlockingCall(DataType* data, Callback callback) const + +napi_status Napi::ThreadSafeFunction::NonBlockingCall(DataType* data, Callback callback) const +``` + +- `[optional] data`: Data to pass to `callback`. +- `[optional] callback`: C++ function that is invoked on the main thread. The + callback receives the `ThreadSafeFunction`'s JavaScript callback function to + call as an `Napi::Function` in its parameters and the `DataType*` data pointer + (if provided). Must implement `void operator()(Napi::Env env, Function + jsCallback, DataType* data)`, skipping `data` if not provided. It is not + necessary to call into JavaScript via `MakeCallback()` because N-API runs + `callback` in a context appropriate for callbacks. + +**These specific function overloads should only be used on a `ThreadSafeFunction` +created via `ThreadSafeFunction(napi_threadsafe_function)`.** + +```cpp +napi_status Napi::ThreadSafeFunction::BlockingCall(void* data) const + +napi_status Napi::ThreadSafeFunction::NonBlockingCall(void* data) const +``` +- `data`: Data to pass to `call_js_cb` specified when creating the thread-safe + function via `napi_create_threadsafe_function`. + +Returns one of: +- `napi_ok`: The call was successfully added to the queue. +- `napi_queue_full`: The queue was full when trying to call in a non-blocking + method. +- `napi_closing`: The thread-safe function is aborted and cannot accept more + calls. +- `napi_invalid_arg`: The thread-safe function is closed. +- `napi_generic_failure`: A generic error occurred when attemping to add to the + queue. + +## Example + +```cpp +#include <chrono> +#include <thread> +#include <napi.h> + +using namespace Napi; + +std::thread nativeThread; +ThreadSafeFunction tsfn; + +Value Start( const CallbackInfo& info ) +{ + Napi::Env env = info.Env(); + + if ( info.Length() < 2 ) + { + throw TypeError::New( env, "Expected two arguments" ); + } + else if ( !info[0].IsFunction() ) + { + throw TypeError::New( env, "Expected first arg to be function" ); + } + else if ( !info[1].IsNumber() ) + { + throw TypeError::New( env, "Expected second arg to be number" ); + } + + int count = info[1].As<Number>().Int32Value(); + + // Create a ThreadSafeFunction + tsfn = ThreadSafeFunction::New( + env, + info[0].As<Function>(), // JavaScript function called asynchronously + "Resource Name", // Name + 0, // Unlimited queue + 1, // Only one thread will use this initially + []( Napi::Env ) { // Finalizer used to clean threads up + nativeThread.join(); + } ); + + // Create a native thread + nativeThread = std::thread( [count] { + auto callback = []( Napi::Env env, Function jsCallback, int* value ) { + // Transform native data into JS data, passing it to the provided + // `jsCallback` -- the TSFN's JavaScript function. + jsCallback.Call( {Number::New( env, *value )} ); + + // We're finished with the data. + delete value; + }; + + for ( int i = 0; i < count; i++ ) + { + // Create new data + int* value = new int( clock() ); + + // Perform a blocking call + napi_status status = tsfn.BlockingCall( value, callback ); + if ( status != napi_ok ) + { + // Handle error + break; + } + + std::this_thread::sleep_for( std::chrono::seconds( 1 ) ); + } + + // Release the thread-safe function + tsfn.Release(); + } ); + + return Boolean::New(env, true); +} + +Napi::Object Init( Napi::Env env, Object exports ) +{ + exports.Set( "start", Function::New( env, Start ) ); + return exports; +} + +NODE_API_MODULE( clock, Init ) +``` + +The above code can be used from JavaScript as follows: + +```js +const { start } = require('bindings')('clock'); + +start(function () { + console.log("JavaScript callback called with arguments", Array.from(arguments)); +}, 5); +``` + +When executed, the output will show the value of `clock()` five times at one +second intervals: + +``` +JavaScript callback called with arguments [ 84745 ] +JavaScript callback called with arguments [ 103211 ] +JavaScript callback called with arguments [ 104516 ] +JavaScript callback called with arguments [ 105104 ] +JavaScript callback called with arguments [ 105691 ] +``` diff --git a/node_modules/node-addon-api/doc/type_error.md b/node_modules/node-addon-api/doc/type_error.md new file mode 100644 index 0000000..24bbf8e --- /dev/null +++ b/node_modules/node-addon-api/doc/type_error.md @@ -0,0 +1,59 @@ +# TypeError + +The `Napi::TypeError` class is a representation of the JavaScript `TypeError` that is +thrown when an operand or argument passed to a function is incompatible with the +type expected by the operator or function. + +The `Napi::TypeError` class inherits its behaviors from the `Napi::Error` class (for more info +see: [`Napi::Error`](error.md)). + +For more details about error handling refer to the section titled [Error handling](error_handling.md). + +## Methods + +### New + +Creates a new instance of the `Napi::TypeError` object. + +```cpp +Napi::TypeError::New(Napi:Env env, const char* message); +``` + +- `[in] Env`: The environment in which to construct the `Napi::TypeError` object. +- `[in] message`: Null-terminated string to be used as the message for the `Napi::TypeError`. + +Returns an instance of a `Napi::TypeError` object. + +### New + +Creates a new instance of a `Napi::TypeError` object. + +```cpp +Napi::TypeError::New(Napi:Env env, const std::string& message); +``` + +- `[in] Env`: The environment in which to construct the `Napi::TypeError` object. +- `[in] message`: Reference string to be used as the message for the `Napi::TypeError`. + +Returns an instance of a `Napi::TypeError` object. + +### Constructor + +Creates a new empty instance of a `Napi::TypeError`. + +```cpp +Napi::TypeError::TypeError(); +``` + +### Constructor + +Initializes a `Napi::TypeError` instance from an existing JavaScript error object. + +```cpp +Napi::TypeError::TypeError(napi_env env, napi_value value); +``` + +- `[in] Env`: The environment in which to construct the `Napi::TypeError` object. +- `[in] value`: The `Napi::Error` reference to wrap. + +Returns an instance of a `Napi::TypeError` object. diff --git a/node_modules/node-addon-api/doc/typed_array.md b/node_modules/node-addon-api/doc/typed_array.md new file mode 100644 index 0000000..ced67d8 --- /dev/null +++ b/node_modules/node-addon-api/doc/typed_array.md @@ -0,0 +1,74 @@ +# TypedArray + +The `Napi::TypedArray` class corresponds to the +[JavaScript `TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) +class. + +## Methods + +### Constructor + +Initializes an empty instance of the `Napi::TypedArray` class. + +```cpp +Napi::TypedArray::TypedArray(); +``` + +### Constructor + +Initializes a wrapper instance of an existing `Napi::TypedArray` instance. + +```cpp +Napi::TypedArray::TypedArray(napi_env env, napi_value value); +``` + +- `[in] env`: The environment in which to create the `Napi::TypedArray` instance. +- `[in] value`: The `Napi::TypedArray` reference to wrap. + +### TypedArrayType + +```cpp +napi_typedarray_type Napi::TypedArray::TypedArrayType() const; +``` + +Returns the type of this instance. + +### ArrayBuffer + +```cpp +Napi::ArrayBuffer Napi::TypedArray::ArrayBuffer() const; +``` + +Returns the backing array buffer. + +### ElementSize + +```cpp +uint8_t Napi::TypedArray::ElementSize() const; +``` + +Returns the size of one element, in bytes. + +### ElementLength + +```cpp +size_t Napi::TypedArray::ElementLength() const; +``` + +Returns the number of elements. + +### ByteOffset + +```cpp +size_t Napi::TypedArray::ByteOffset() const; +``` + +Returns the offset into the `Napi::ArrayBuffer` where the array starts, in bytes. + +### ByteLength + +```cpp +size_t Napi::TypedArray::ByteLength() const; +``` + +Returns the length of the array, in bytes. diff --git a/node_modules/node-addon-api/doc/typed_array_of.md b/node_modules/node-addon-api/doc/typed_array_of.md new file mode 100644 index 0000000..fc30218 --- /dev/null +++ b/node_modules/node-addon-api/doc/typed_array_of.md @@ -0,0 +1,133 @@ +# TypedArrayOf + +The `Napi::TypedArrayOf` class corresponds to the various +[JavaScript `TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) +classes. + +## Typedefs + +The common JavaScript `TypedArray` types are pre-defined for each of use: + +```cpp +typedef Napi::TypedArrayOf<int8_t> Int8Array; +typedef Napi::TypedArrayOf<uint8_t> Uint8Array; +typedef Napi::TypedArrayOf<int16_t> Int16Array; +typedef Napi::TypedArrayOf<uint16_t> Uint16Array; +typedef Napi::TypedArrayOf<int32_t> Int32Array; +typedef Napi::TypedArrayOf<uint32_t> Uint32Array; +typedef Napi::TypedArrayOf<float> Float32Array; +typedef Napi::TypedArrayOf<double> Float64Array; +``` + +The one exception is the `Uint8ClampedArray` which requires explicit +initialization: + +```cpp +Uint8Array::New(env, length, napi_uint8_clamped_array) +``` + +Note that while it's possible to create a "clamped" array the _clamping_ +behavior is only applied in JavaScript. + +## Methods + +### New + +Allocates a new `Napi::TypedArray` instance with a given length. The underlying +`Napi::ArrayBuffer` is allocated automatically to the desired number of elements. + +The array type parameter can normally be omitted (because it is inferred from +the template parameter T), except when creating a "clamped" array. + +```cpp +static Napi::TypedArrayOf Napi::TypedArrayOf::New(napi_env env, + size_t elementLength, + napi_typedarray_type type); +``` + +- `[in] env`: The environment in which to create the `Napi::TypedArrayOf` instance. +- `[in] elementLength`: The length to be allocated, in elements. +- `[in] type`: The type of array to allocate (optional). + +Returns a new `Napi::TypedArrayOf` instance. + +### New + +Wraps the provided `Napi::ArrayBuffer` into a new `Napi::TypedArray` instance. + +The array `type` parameter can normally be omitted (because it is inferred from +the template parameter `T`), except when creating a "clamped" array. + +```cpp +static Napi::TypedArrayOf Napi::TypedArrayOf::New(napi_env env, + size_t elementLength, + Napi::ArrayBuffer arrayBuffer, + size_t bufferOffset, + napi_typedarray_type type); +``` + +- `[in] env`: The environment in which to create the `Napi::TypedArrayOf` instance. +- `[in] elementLength`: The length to array, in elements. +- `[in] arrayBuffer`: The backing `Napi::ArrayBuffer` instance. +- `[in] bufferOffset`: The offset into the `Napi::ArrayBuffer` where the array starts, + in bytes. +- `[in] type`: The type of array to allocate (optional). + +Returns a new `Napi::TypedArrayOf` instance. + +### Constructor + +Initializes an empty instance of the `Napi::TypedArrayOf` class. + +```cpp +Napi::TypedArrayOf::TypedArrayOf(); +``` + +### Constructor + +Initializes a wrapper instance of an existing `Napi::TypedArrayOf` object. + +```cpp +Napi::TypedArrayOf::TypedArrayOf(napi_env env, napi_value value); +``` + +- `[in] env`: The environment in which to create the `Napi::TypedArrayOf` object. +- `[in] value`: The `Napi::TypedArrayOf` reference to wrap. + +### operator [] + +```cpp +T& Napi::TypedArrayOf::operator [](size_t index); +``` + +- `[in] index: The element index into the array. + +Returns the element found at the given index. + +### operator [] + +```cpp +const T& Napi::TypedArrayOf::operator [](size_t index) const; +``` + +- `[in] index: The element index into the array. + +Returns the element found at the given index. + +### Data + +```cpp +T* Napi::TypedArrayOf::Data() const; +``` + +Returns a pointer into the backing `Napi::ArrayBuffer` which is offset to point to the +start of the array. + +### Data + +```cpp +const T* Napi::TypedArrayOf::Data() const +``` + +Returns a pointer into the backing `Napi::ArrayBuffer` which is offset to point to the +start of the array. diff --git a/node_modules/node-addon-api/doc/value.md b/node_modules/node-addon-api/doc/value.md new file mode 100644 index 0000000..2d25eb7 --- /dev/null +++ b/node_modules/node-addon-api/doc/value.md @@ -0,0 +1,278 @@ +# Value + +`Napi::Value` is the C++ manifestation of a JavaScript value. + +Value is a the base class upon which other JavaScript values such as Number, Boolean, String, and Object are based. + +The following classes inherit, either directly or indirectly, from `Napi::Value`: + +- [`Napi::Array`](array.md) +- [`Napi::ArrayBuffer`](array_buffer.md) +- [`Napi::Boolean`](boolean.md) +- [`Napi::Buffer`](buffer.md) +- [`Napi::Date`](date.md) +- [`Napi::External`](external.md) +- [`Napi::Function`](function.md) +- [`Napi::Name`](name.md) +- [`Napi::Number`](number.md) +- [`Napi::Object`](object.md) +- [`Napi::String`](string.md) +- [`Napi::Symbol`](symbol.md) +- [`Napi::TypedArray`](typed_array.md) +- [`Napi::TypedArrayOf`](typed_array_of.md) + +## Methods + +### Empty Constructor + +```cpp +Napi::Value::Value(); +``` + +Creates a new *empty* `Napi::Value` instance. + +### Constructor + +```cpp +Napi::Value::Value(napi_env env, napi_value value); +``` + +- `[in] env`: The `napi_env` environment in which to construct the `Napi::Value` object. + +- `[in] value`: The C++ primitive from which to instantiate the `Napi::Value`. `value` may be any of: + - `bool` + - Any integer type + - Any floating point type + - `const char*` (encoded using UTF-8, null-terminated) + - `const char16_t*` (encoded using UTF-16-LE, null-terminated) + - `std::string` (encoded using UTF-8) + - `std::u16string` + - `Napi::Value` + - `napi_value` + +### From + +```cpp +template <typename T> static Napi::Value Napi::Value::From(napi_env env, const T& value); +``` + +- `[in] env`: The `napi_env` environment in which to create the `Napi::Value` object. + +- `[in] value`: The N-API primitive value from which to create the `Napi::Value` object. + +Returns a `Napi::Value` object from an N-API primitive value. + +### operator napi_value + +```cpp +operator napi_value() const; +``` + +Returns this Value's N-API value primitive. + +Returns `nullptr` if this `Napi::Value` is *empty*. + +### operator == + +```cpp + +bool Napi::Value::operator ==(const Napi::Value& other) const; +``` + +- `[in] other`: The `Napi::Value` object to be compared. + +Returns a `bool` indicating if this `Napi::Value` strictly equals another `Napi::Value`. + +### operator != + +```cpp +bool Napi::Value::operator !=(const Napi::Value& other) const; +``` + +- `[in] other`: The `Napi::Value` object to be compared. + +Returns a `bool` indicating if this `Napi::Value` does not strictly equal another `Napi::Value`. + +### StrictEquals + +```cpp +bool Napi::Value::StrictEquals(const Napi::Value& other) const; +``` +- `[in] other`: The `Napi::Value` object to be compared. + +Returns a `bool` indicating if this `Napi::Value` strictly equals another `Napi::Value`. + +### Env + +```cpp +Napi::Env Napi::Value::Env() const; +``` + +Returns the `Napi::Env` environment this value is associated with. + +### IsEmpty + +```cpp +bool Napi::Value::IsEmpty() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is *empty* (uninitialized). + +An empty `Napi::Value` is invalid, and most attempts to perform an operation on an empty Value will result in an exception. +Note an empty `Napi::Value` is distinct from JavaScript `null` or `undefined`, which are valid values. + +When C++ exceptions are disabled at compile time, a method with a `Napi::Value` return type may return an empty Value to indicate a pending exception. So when not using C++ exceptions, callers should check whether this `Napi::Value` is empty before attempting to use it. + +### Type + +```cpp +napi_valuetype Napi::Value::Type() const; +``` + +Returns the `napi_valuetype` type of the `Napi::Value`. + +### IsUndefined + +```cpp +bool Napi::Value::IsUndefined() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is an undefined JavaScript value. + +### IsNull + +```cpp +bool Napi::Value::IsNull() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a null JavaScript value. + +### IsBoolean + +```cpp +bool Napi::Value::IsBoolean() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript boolean. + +### IsNumber + +```cpp +bool Napi::Value::IsNumber() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript number. + +### IsString + +```cpp +bool Napi::Value::IsString() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript string. + +### IsSymbol + +```cpp +bool Napi::Value::IsSymbol() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript symbol. + +### IsArray + +```cpp +bool Napi::Value::IsArray() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript array. + +### IsArrayBuffer + +```cpp +bool Napi::Value::IsArrayBuffer() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript array buffer. + +### IsTypedArray + +```cpp +bool Napi::Value::IsTypedArray() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript typed array. + +### IsObject + +```cpp +bool Napi::Value::IsObject() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is JavaScript object. + +### IsFunction + +```cpp +bool Napi::Value::IsFunction() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript function. + +### IsBuffer + +```cpp +bool Napi::Value::IsBuffer() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a Node buffer. + +### IsDate + +```cpp +bool Napi::Value::IsDate() const; +``` + +Returns a `bool` indicating if this `Napi::Value` is a JavaScript date. + +### As + +```cpp +template <typename T> T Napi::Value::As() const; +``` + +Casts to another type of `Napi::Value`, when the actual type is known or assumed. + +This conversion does not coerce the type. Calling any methods inappropriate for the actual value type will throw `Napi::Error`. + +### ToBoolean + +```cpp +Napi::Boolean Napi::Value::ToBoolean() const; +``` + +Returns the `Napi::Value` coerced to a JavaScript boolean. + +### ToNumber + +```cpp +Napi::Number Napi::Value::ToNumber() const; +``` + +Returns the `Napi::Value` coerced to a JavaScript number. + +### ToString + +```cpp +Napi::String Napi::Value::ToString() const; +``` + +Returns the `Napi::Value` coerced to a JavaScript string. + +### ToObject + +```cpp +Napi::Object Napi::Value::ToObject() const; +``` + +Returns the `Napi::Value` coerced to a JavaScript object. diff --git a/node_modules/node-addon-api/doc/version_management.md b/node_modules/node-addon-api/doc/version_management.md new file mode 100644 index 0000000..6d6c7fa --- /dev/null +++ b/node_modules/node-addon-api/doc/version_management.md @@ -0,0 +1,43 @@ +# VersionManagement + +The `Napi::VersionManagement` class contains methods that allow information +to be retrieved about the version of N-API and Node.js. In some cases it is +important to make decisions based on different versions of the system. + +## Methods + +### GetNapiVersion + +Retrieves the highest N-API version supported by Node.js runtime. + +```cpp +static uint32_t Napi::VersionManagement::GetNapiVersion(Env env); +``` + +- `[in] env`: The environment in which the API is invoked under. + +Returns the highest N-API version supported by Node.js runtime. + +### GetNodeVersion + +Retrives information about Node.js version present on the system. All the +information is stored in the `napi_node_version` structrue that is defined as +shown below: + +```cpp +typedef struct { + uint32_t major; + uint32_t minor; + uint32_t patch; + const char* release; +} napi_node_version; +```` + +```cpp +static const napi_node_version* Napi::VersionManagement::GetNodeVersion(Env env); +``` + +- `[in] env`: The environment in which the API is invoked under. + +Returns the structure a pointer to the structure `napi_node_version` populated by +the version information of Node.js runtime. diff --git a/node_modules/node-addon-api/doc/working_with_javascript_values.md b/node_modules/node-addon-api/doc/working_with_javascript_values.md new file mode 100644 index 0000000..00dad25 --- /dev/null +++ b/node_modules/node-addon-api/doc/working_with_javascript_values.md @@ -0,0 +1,14 @@ +# Working with JavaScript Values + +`node-addon-api` provides a set of classes that allow to create and manage +JavaScript object: + +- [Function](function.md) + - [FunctionReference](function_reference.md) +- [ObjectWrap](object_wrap.md) + - [ClassPropertyDescriptor](class_property_descriptor.md) +- [Buffer](buffer.md) +- [ArrayBuffer](array_buffer.md) +- [TypedArray](typed_array.md) + - [TypedArrayOf](typed_array_of.md) +- [DataView](dataview.md) |